2 * FreeRTOS Kernel V10.1.1
\r
3 * Copyright (C) 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
\r
5 * Permission is hereby granted, free of charge, to any person obtaining a copy of
\r
6 * this software and associated documentation files (the "Software"), to deal in
\r
7 * the Software without restriction, including without limitation the rights to
\r
8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
\r
9 * the Software, and to permit persons to whom the Software is furnished to do so,
\r
10 * subject to the following conditions:
\r
12 * The above copyright notice and this permission notice shall be included in all
\r
13 * copies or substantial portions of the Software.
\r
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
\r
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
\r
17 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
\r
18 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
\r
19 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
\r
20 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\r
22 * http://www.FreeRTOS.org
\r
23 * http://aws.amazon.com/freertos
\r
25 * 1 tab == 4 spaces!
\r
28 /* Originally adapted from file written by Andreas Dannenberg. Supplied with permission. */
\r
30 /* Kernel includes. */
\r
31 #include "FreeRTOS.h"
\r
35 /* Hardware specific includes. */
\r
36 #include "EthDev_LPC17xx.h"
\r
38 /* Time to wait between each inspection of the link status. */
\r
39 #define emacWAIT_FOR_LINK_TO_ESTABLISH ( 500 / portTICK_PERIOD_MS )
\r
41 /* Short delay used in several places during the initialisation process. */
\r
42 #define emacSHORT_DELAY ( 2 )
\r
44 /* Hardware specific bit definitions. */
\r
45 #define emacLINK_ESTABLISHED ( 0x0001 )
\r
46 #define emacFULL_DUPLEX_ENABLED ( 0x0004 )
\r
47 #define emac10BASE_T_MODE ( 0x0002 )
\r
48 #define emacPINSEL2_VALUE ( 0x50150105 )
\r
50 /* If no buffers are available, then wait this long before looking again.... */
\r
51 #define emacBUFFER_WAIT_DELAY ( 3 / portTICK_PERIOD_MS )
\r
53 /* ...and don't look more than this many times. */
\r
54 #define emacBUFFER_WAIT_ATTEMPTS ( 30 )
\r
56 /* Index to the Tx descriptor that is always used first for every Tx. The second
\r
57 descriptor is then used to re-send in order to speed up the uIP Tx process. */
\r
58 #define emacTX_DESC_INDEX ( 0 )
\r
60 /*-----------------------------------------------------------*/
\r
63 * Configure both the Rx and Tx descriptors during the init process.
\r
65 static void prvInitDescriptors( void );
\r
68 * Setup the IO and peripherals required for Ethernet communication.
\r
70 static void prvSetupEMACHardware( void );
\r
73 * Control the auto negotiate process.
\r
75 static void prvConfigurePHY( void );
\r
78 * Wait for a link to be established, then setup the PHY according to the link
\r
81 static long prvSetupLinkStatus( void );
\r
84 * Search the pool of buffers to find one that is free. If a buffer is found
\r
85 * mark it as in use before returning its address.
\r
87 static unsigned char *prvGetNextBuffer( void );
\r
90 * Return an allocated buffer to the pool of free buffers.
\r
92 static void prvReturnBuffer( unsigned char *pucBuffer );
\r
95 * Send lValue to the lPhyReg within the PHY.
\r
97 static long prvWritePHY( long lPhyReg, long lValue );
\r
100 * Read a value from ucPhyReg within the PHY. *plStatus will be set to
\r
101 * pdFALSE if there is an error.
\r
103 static unsigned short prvReadPHY( unsigned char ucPhyReg, long *plStatus );
\r
105 /*-----------------------------------------------------------*/
\r
107 /* The semaphore used to wake the uIP task when data arrives. */
\r
108 extern SemaphoreHandle_t xEMACSemaphore;
\r
110 /* Each ucBufferInUse index corresponds to a position in the pool of buffers.
\r
111 If the index contains a 1 then the buffer within pool is in use, if it
\r
112 contains a 0 then the buffer is free. */
\r
113 static unsigned char ucBufferInUse[ ETH_NUM_BUFFERS ] = { pdFALSE };
\r
115 /* The uip_buffer is not a fixed array, but instead gets pointed to the buffers
\r
116 allocated within this file. */
\r
117 unsigned char * uip_buf;
\r
119 /* Store the length of the data being sent so the data can be sent twice. The
\r
120 value will be set back to 0 once the data has been sent twice. */
\r
121 static unsigned short usSendLen = 0;
\r
123 /*-----------------------------------------------------------*/
\r
125 long lEMACInit( void )
\r
127 long lReturn = pdPASS;
\r
128 unsigned long ulID1, ulID2;
\r
130 /* Reset peripherals, configure port pins and registers. */
\r
131 prvSetupEMACHardware();
\r
133 /* Check the PHY part number is as expected. */
\r
134 ulID1 = prvReadPHY( PHY_REG_IDR1, &lReturn );
\r
135 ulID2 = prvReadPHY( PHY_REG_IDR2, &lReturn );
\r
136 if( ( (ulID1 << 16UL ) | ( ulID2 & 0xFFF0UL ) ) == DP83848C_ID )
\r
138 /* Set the Ethernet MAC Address registers */
\r
139 EMAC->SA0 = ( configMAC_ADDR0 << 8 ) | configMAC_ADDR1;
\r
140 EMAC->SA1 = ( configMAC_ADDR2 << 8 ) | configMAC_ADDR3;
\r
141 EMAC->SA2 = ( configMAC_ADDR4 << 8 ) | configMAC_ADDR5;
\r
143 /* Initialize Tx and Rx DMA Descriptors */
\r
144 prvInitDescriptors();
\r
146 /* Receive broadcast and perfect match packets */
\r
147 EMAC->RxFilterCtrl = RFC_UCAST_EN | RFC_BCAST_EN | RFC_PERFECT_EN;
\r
149 /* Setup the PHY. */
\r
157 /* Check the link status. */
\r
158 if( lReturn == pdPASS )
\r
160 lReturn = prvSetupLinkStatus();
\r
163 if( lReturn == pdPASS )
\r
165 /* Initialise uip_buf to ensure it points somewhere valid. */
\r
166 uip_buf = prvGetNextBuffer();
\r
168 /* Reset all interrupts */
\r
169 EMAC->IntClear = ( INT_RX_OVERRUN | INT_RX_ERR | INT_RX_FIN | INT_RX_DONE | INT_TX_UNDERRUN | INT_TX_ERR | INT_TX_FIN | INT_TX_DONE | INT_SOFT_INT | INT_WAKEUP );
\r
171 /* Enable receive and transmit mode of MAC Ethernet core */
\r
172 EMAC->Command |= ( CR_RX_EN | CR_TX_EN );
\r
173 EMAC->MAC1 |= MAC1_REC_EN;
\r
178 /*-----------------------------------------------------------*/
\r
180 static unsigned char *prvGetNextBuffer( void )
\r
183 unsigned char *pucReturn = NULL;
\r
184 unsigned long ulAttempts = 0;
\r
186 while( pucReturn == NULL )
\r
188 /* Look through the buffers to find one that is not in use by
\r
190 for( x = 0; x < ETH_NUM_BUFFERS; x++ )
\r
192 if( ucBufferInUse[ x ] == pdFALSE )
\r
194 ucBufferInUse[ x ] = pdTRUE;
\r
195 pucReturn = ( unsigned char * ) ETH_BUF( x );
\r
200 /* Was a buffer found? */
\r
201 if( pucReturn == NULL )
\r
205 if( ulAttempts >= emacBUFFER_WAIT_ATTEMPTS )
\r
210 /* Wait then look again. */
\r
211 vTaskDelay( emacBUFFER_WAIT_DELAY );
\r
217 /*-----------------------------------------------------------*/
\r
219 static void prvInitDescriptors( void )
\r
221 long x, lNextBuffer = 0;
\r
223 for( x = 0; x < NUM_RX_FRAG; x++ )
\r
225 /* Allocate the next Ethernet buffer to this descriptor. */
\r
226 RX_DESC_PACKET( x ) = ETH_BUF( lNextBuffer );
\r
227 RX_DESC_CTRL( x ) = RCTRL_INT | ( ETH_FRAG_SIZE - 1 );
\r
228 RX_STAT_INFO( x ) = 0;
\r
229 RX_STAT_HASHCRC( x ) = 0;
\r
231 /* The Ethernet buffer is now in use. */
\r
232 ucBufferInUse[ lNextBuffer ] = pdTRUE;
\r
236 /* Set EMAC Receive Descriptor Registers. */
\r
237 EMAC->RxDescriptor = RX_DESC_BASE;
\r
238 EMAC->RxStatus = RX_STAT_BASE;
\r
239 EMAC->RxDescriptorNumber = NUM_RX_FRAG - 1;
\r
241 /* Rx Descriptors Point to 0 */
\r
242 EMAC->RxConsumeIndex = 0;
\r
244 /* A buffer is not allocated to the Tx descriptors until they are actually
\r
246 for( x = 0; x < NUM_TX_FRAG; x++ )
\r
248 TX_DESC_PACKET( x ) = ( unsigned long ) NULL;
\r
249 TX_DESC_CTRL( x ) = 0;
\r
250 TX_STAT_INFO( x ) = 0;
\r
253 /* Set EMAC Transmit Descriptor Registers. */
\r
254 EMAC->TxDescriptor = TX_DESC_BASE;
\r
255 EMAC->TxStatus = TX_STAT_BASE;
\r
256 EMAC->TxDescriptorNumber = NUM_TX_FRAG - 1;
\r
258 /* Tx Descriptors Point to 0 */
\r
259 EMAC->TxProduceIndex = 0;
\r
261 /*-----------------------------------------------------------*/
\r
263 static void prvSetupEMACHardware( void )
\r
268 /* Enable P1 Ethernet Pins. */
\r
269 PINCON->PINSEL2 = emacPINSEL2_VALUE;
\r
270 PINCON->PINSEL3 = ( PINCON->PINSEL3 & ~0x0000000F ) | 0x00000005;
\r
272 /* Power Up the EMAC controller. */
\r
273 SC->PCONP |= PCONP_PCENET;
\r
274 vTaskDelay( emacSHORT_DELAY );
\r
276 /* Reset all EMAC internal modules. */
\r
277 EMAC->MAC1 = MAC1_RES_TX | MAC1_RES_MCS_TX | MAC1_RES_RX | MAC1_RES_MCS_RX | MAC1_SIM_RES | MAC1_SOFT_RES;
\r
278 EMAC->Command = CR_REG_RES | CR_TX_RES | CR_RX_RES | CR_PASS_RUNT_FRM;
\r
280 /* A short delay after reset. */
\r
281 vTaskDelay( emacSHORT_DELAY );
\r
283 /* Initialize MAC control registers. */
\r
284 EMAC->MAC1 = MAC1_PASS_ALL;
\r
285 EMAC->MAC2 = MAC2_CRC_EN | MAC2_PAD_EN;
\r
286 EMAC->MAXF = ETH_MAX_FLEN;
\r
287 EMAC->CLRT = CLRT_DEF;
\r
288 EMAC->IPGR = IPGR_DEF;
\r
290 /* Enable Reduced MII interface. */
\r
291 EMAC->Command = CR_RMII | CR_PASS_RUNT_FRM;
\r
293 /* Reset Reduced MII Logic. */
\r
294 EMAC->SUPP = SUPP_RES_RMII;
\r
295 vTaskDelay( emacSHORT_DELAY );
\r
298 /* Put the PHY in reset mode */
\r
299 prvWritePHY( PHY_REG_BMCR, MCFG_RES_MII );
\r
300 prvWritePHY( PHY_REG_BMCR, MCFG_RES_MII );
\r
302 /* Wait for hardware reset to end. */
\r
303 for( x = 0; x < 100; x++ )
\r
305 vTaskDelay( emacSHORT_DELAY * 5 );
\r
306 us = prvReadPHY( PHY_REG_BMCR, &lDummy );
\r
307 if( !( us & MCFG_RES_MII ) )
\r
309 /* Reset complete */
\r
314 /*-----------------------------------------------------------*/
\r
316 static void prvConfigurePHY( void )
\r
321 /* Auto negotiate the configuration. */
\r
322 if( prvWritePHY( PHY_REG_BMCR, PHY_AUTO_NEG ) )
\r
324 vTaskDelay( emacSHORT_DELAY * 5 );
\r
326 for( x = 0; x < 10; x++ )
\r
328 us = prvReadPHY( PHY_REG_BMSR, &lDummy );
\r
330 if( us & PHY_AUTO_NEG_COMPLETE )
\r
335 vTaskDelay( emacWAIT_FOR_LINK_TO_ESTABLISH );
\r
339 /*-----------------------------------------------------------*/
\r
341 static long prvSetupLinkStatus( void )
\r
343 long lReturn = pdFAIL, x;
\r
344 unsigned short usLinkStatus;
\r
346 /* Wait with timeout for the link to be established. */
\r
347 for( x = 0; x < 10; x++ )
\r
349 usLinkStatus = prvReadPHY( PHY_REG_STS, &lReturn );
\r
350 if( usLinkStatus & emacLINK_ESTABLISHED )
\r
352 /* Link is established. */
\r
357 vTaskDelay( emacWAIT_FOR_LINK_TO_ESTABLISH );
\r
360 if( lReturn == pdPASS )
\r
362 /* Configure Full/Half Duplex mode. */
\r
363 if( usLinkStatus & emacFULL_DUPLEX_ENABLED )
\r
365 /* Full duplex is enabled. */
\r
366 EMAC->MAC2 |= MAC2_FULL_DUP;
\r
367 EMAC->Command |= CR_FULL_DUP;
\r
368 EMAC->IPGT = IPGT_FULL_DUP;
\r
372 /* Half duplex mode. */
\r
373 EMAC->IPGT = IPGT_HALF_DUP;
\r
376 /* Configure 100MBit/10MBit mode. */
\r
377 if( usLinkStatus & emac10BASE_T_MODE )
\r
384 /* 100MBit mode. */
\r
385 EMAC->SUPP = SUPP_SPEED;
\r
391 /*-----------------------------------------------------------*/
\r
393 static void prvReturnBuffer( unsigned char *pucBuffer )
\r
397 /* Return a buffer to the pool of free buffers. */
\r
398 for( ul = 0; ul < ETH_NUM_BUFFERS; ul++ )
\r
400 if( ETH_BUF( ul ) == ( unsigned long ) pucBuffer )
\r
402 ucBufferInUse[ ul ] = pdFALSE;
\r
407 /*-----------------------------------------------------------*/
\r
409 unsigned long ulGetEMACRxData( void )
\r
411 unsigned long ulLen = 0;
\r
414 if( EMAC->RxProduceIndex != EMAC->RxConsumeIndex )
\r
416 /* Mark the current buffer as free as uip_buf is going to be set to
\r
417 the buffer that contains the received data. */
\r
418 prvReturnBuffer( uip_buf );
\r
420 ulLen = ( RX_STAT_INFO( EMAC->RxConsumeIndex ) & RINFO_SIZE ) - 3;
\r
421 uip_buf = ( unsigned char * ) RX_DESC_PACKET( EMAC->RxConsumeIndex );
\r
423 /* Allocate a new buffer to the descriptor. */
\r
424 RX_DESC_PACKET( EMAC->RxConsumeIndex ) = ( unsigned long ) prvGetNextBuffer();
\r
426 /* Move the consume index onto the next position, ensuring it wraps to
\r
427 the beginning at the appropriate place. */
\r
428 lIndex = EMAC->RxConsumeIndex;
\r
431 if( lIndex >= NUM_RX_FRAG )
\r
436 EMAC->RxConsumeIndex = lIndex;
\r
441 /*-----------------------------------------------------------*/
\r
443 void vSendEMACTxData( unsigned short usTxDataLen )
\r
445 unsigned long ulAttempts = 0UL;
\r
447 /* Check to see if the Tx descriptor is free, indicated by its buffer being
\r
449 while( TX_DESC_PACKET( emacTX_DESC_INDEX ) != ( unsigned long ) NULL )
\r
451 /* Wait for the Tx descriptor to become available. */
\r
452 vTaskDelay( emacBUFFER_WAIT_DELAY );
\r
455 if( ulAttempts > emacBUFFER_WAIT_ATTEMPTS )
\r
457 /* Something has gone wrong as the Tx descriptor is still in use.
\r
458 Clear it down manually, the data it was sending will probably be
\r
460 prvReturnBuffer( ( unsigned char * ) TX_DESC_PACKET( emacTX_DESC_INDEX ) );
\r
465 /* Setup the Tx descriptor for transmission. Remember the length of the
\r
466 data being sent so the second descriptor can be used to send it again from
\r
468 usSendLen = usTxDataLen;
\r
469 TX_DESC_PACKET( emacTX_DESC_INDEX ) = ( unsigned long ) uip_buf;
\r
470 TX_DESC_CTRL( emacTX_DESC_INDEX ) = ( usTxDataLen | TCTRL_LAST | TCTRL_INT );
\r
471 EMAC->TxProduceIndex = ( emacTX_DESC_INDEX + 1 );
\r
473 /* uip_buf is being sent by the Tx descriptor. Allocate a new buffer. */
\r
474 uip_buf = prvGetNextBuffer();
\r
476 /*-----------------------------------------------------------*/
\r
478 static long prvWritePHY( long lPhyReg, long lValue )
\r
480 const long lMaxTime = 10;
\r
483 EMAC->MADR = DP83848C_DEF_ADR | lPhyReg;
\r
484 EMAC->MWTD = lValue;
\r
487 for( x = 0; x < lMaxTime; x++ )
\r
489 if( ( EMAC->MIND & MIND_BUSY ) == 0 )
\r
491 /* Operation has finished. */
\r
495 vTaskDelay( emacSHORT_DELAY );
\r
507 /*-----------------------------------------------------------*/
\r
509 static unsigned short prvReadPHY( unsigned char ucPhyReg, long *plStatus )
\r
512 const long lMaxTime = 10;
\r
514 EMAC->MADR = DP83848C_DEF_ADR | ucPhyReg;
\r
515 EMAC->MCMD = MCMD_READ;
\r
517 for( x = 0; x < lMaxTime; x++ )
\r
519 /* Operation has finished. */
\r
520 if( ( EMAC->MIND & MIND_BUSY ) == 0 )
\r
525 vTaskDelay( emacSHORT_DELAY );
\r
530 if( x >= lMaxTime )
\r
532 *plStatus = pdFAIL;
\r
535 return( EMAC->MRDD );
\r
537 /*-----------------------------------------------------------*/
\r
539 void vEMAC_ISR( void )
\r
541 unsigned long ulStatus;
\r
542 long lHigherPriorityTaskWoken = pdFALSE;
\r
544 ulStatus = EMAC->IntStatus;
\r
546 /* Clear the interrupt. */
\r
547 EMAC->IntClear = ulStatus;
\r
549 if( ulStatus & INT_RX_DONE )
\r
551 /* Ensure the uIP task is not blocked as data has arrived. */
\r
552 xSemaphoreGiveFromISR( xEMACSemaphore, &lHigherPriorityTaskWoken );
\r
555 if( ulStatus & INT_TX_DONE )
\r
557 if( usSendLen > 0 )
\r
559 /* Send the data again, using the second descriptor. As there are
\r
560 only two descriptors the index is set back to 0. */
\r
561 TX_DESC_PACKET( ( emacTX_DESC_INDEX + 1 ) ) = TX_DESC_PACKET( emacTX_DESC_INDEX );
\r
562 TX_DESC_CTRL( ( emacTX_DESC_INDEX + 1 ) ) = ( usSendLen | TCTRL_LAST | TCTRL_INT );
\r
563 EMAC->TxProduceIndex = ( emacTX_DESC_INDEX );
\r
565 /* This is the second Tx so set usSendLen to 0 to indicate that the
\r
566 Tx descriptors will be free again. */
\r
571 /* The Tx buffer is no longer required. */
\r
572 prvReturnBuffer( ( unsigned char * ) TX_DESC_PACKET( emacTX_DESC_INDEX ) );
\r
573 TX_DESC_PACKET( emacTX_DESC_INDEX ) = ( unsigned long ) NULL;
\r
577 portEND_SWITCHING_ISR( lHigherPriorityTaskWoken );
\r