2 * FreeRTOS Kernel V10.3.0
\r
3 * Copyright (C) 2020 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 #define PCONP_PCENET 0x40000000
\r
61 /*-----------------------------------------------------------*/
\r
64 * Configure both the Rx and Tx descriptors during the init process.
\r
66 static void prvInitDescriptors( void );
\r
69 * Setup the IO and peripherals required for Ethernet communication.
\r
71 static void prvSetupEMACHardware( void );
\r
74 * Control the auto negotiate process.
\r
76 static void prvConfigurePHY( void );
\r
79 * Wait for a link to be established, then setup the PHY according to the link
\r
82 static long prvSetupLinkStatus( void );
\r
85 * Search the pool of buffers to find one that is free. If a buffer is found
\r
86 * mark it as in use before returning its address.
\r
88 static unsigned char *prvGetNextBuffer( void );
\r
91 * Return an allocated buffer to the pool of free buffers.
\r
93 static void prvReturnBuffer( unsigned char *pucBuffer );
\r
96 * Send lValue to the lPhyReg within the PHY.
\r
98 static long prvWritePHY( long lPhyReg, long lValue );
\r
101 * Read a value from ucPhyReg within the PHY. *plStatus will be set to
\r
102 * pdFALSE if there is an error.
\r
104 static unsigned short prvReadPHY( unsigned char ucPhyReg, long *plStatus );
\r
106 /*-----------------------------------------------------------*/
\r
108 /* The semaphore used to wake the uIP task when data arrives. */
\r
109 extern SemaphoreHandle_t xEMACSemaphore;
\r
111 /* Each ucBufferInUse index corresponds to a position in the pool of buffers.
\r
112 If the index contains a 1 then the buffer within pool is in use, if it
\r
113 contains a 0 then the buffer is free. */
\r
114 static unsigned char ucBufferInUse[ ETH_NUM_BUFFERS ] = { pdFALSE };
\r
116 /* The uip_buffer is not a fixed array, but instead gets pointed to the buffers
\r
117 allocated within this file. */
\r
118 unsigned char * uip_buf;
\r
120 /* Store the length of the data being sent so the data can be sent twice. The
\r
121 value will be set back to 0 once the data has been sent twice. */
\r
122 static unsigned short usSendLen = 0;
\r
124 /*-----------------------------------------------------------*/
\r
126 long lEMACInit( void )
\r
128 long lReturn = pdPASS;
\r
129 unsigned long ulID1, ulID2;
\r
131 /* Reset peripherals, configure port pins and registers. */
\r
132 prvSetupEMACHardware();
\r
134 /* Check the PHY part number is as expected. */
\r
135 ulID1 = prvReadPHY( PHY_REG_IDR1, &lReturn );
\r
136 ulID2 = prvReadPHY( PHY_REG_IDR2, &lReturn );
\r
137 if( ( (ulID1 << 16UL ) | ( ulID2 & 0xFFF0UL ) ) == DP83848C_ID )
\r
139 /* Set the Ethernet MAC Address registers */
\r
140 LPC_EMAC->SA0 = ( configMAC_ADDR0 << 8 ) | configMAC_ADDR1;
\r
141 LPC_EMAC->SA1 = ( configMAC_ADDR2 << 8 ) | configMAC_ADDR3;
\r
142 LPC_EMAC->SA2 = ( configMAC_ADDR4 << 8 ) | configMAC_ADDR5;
\r
144 /* Initialize Tx and Rx DMA Descriptors */
\r
145 prvInitDescriptors();
\r
147 /* Receive broadcast and perfect match packets */
\r
148 LPC_EMAC->RxFilterCtrl = RFC_UCAST_EN | RFC_BCAST_EN | RFC_PERFECT_EN;
\r
150 /* Setup the PHY. */
\r
158 /* Check the link status. */
\r
159 if( lReturn == pdPASS )
\r
161 lReturn = prvSetupLinkStatus();
\r
164 if( lReturn == pdPASS )
\r
166 /* Initialise uip_buf to ensure it points somewhere valid. */
\r
167 uip_buf = prvGetNextBuffer();
\r
169 /* Reset all interrupts */
\r
170 LPC_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
172 /* Enable receive and transmit mode of MAC Ethernet core */
\r
173 LPC_EMAC->Command |= ( CR_RX_EN | CR_TX_EN );
\r
174 LPC_EMAC->MAC1 |= MAC1_REC_EN;
\r
179 /*-----------------------------------------------------------*/
\r
181 static unsigned char *prvGetNextBuffer( void )
\r
184 unsigned char *pucReturn = NULL;
\r
185 unsigned long ulAttempts = 0;
\r
187 while( pucReturn == NULL )
\r
189 /* Look through the buffers to find one that is not in use by
\r
191 for( x = 0; x < ETH_NUM_BUFFERS; x++ )
\r
193 if( ucBufferInUse[ x ] == pdFALSE )
\r
195 ucBufferInUse[ x ] = pdTRUE;
\r
196 pucReturn = ( unsigned char * ) ETH_BUF( x );
\r
201 /* Was a buffer found? */
\r
202 if( pucReturn == NULL )
\r
206 if( ulAttempts >= emacBUFFER_WAIT_ATTEMPTS )
\r
211 /* Wait then look again. */
\r
212 vTaskDelay( emacBUFFER_WAIT_DELAY );
\r
218 /*-----------------------------------------------------------*/
\r
220 static void prvInitDescriptors( void )
\r
222 long x, lNextBuffer = 0;
\r
224 for( x = 0; x < NUM_RX_FRAG; x++ )
\r
226 /* Allocate the next Ethernet buffer to this descriptor. */
\r
227 RX_DESC_PACKET( x ) = ETH_BUF( lNextBuffer );
\r
228 RX_DESC_CTRL( x ) = RCTRL_INT | ( ETH_FRAG_SIZE - 1 );
\r
229 RX_STAT_INFO( x ) = 0;
\r
230 RX_STAT_HASHCRC( x ) = 0;
\r
232 /* The Ethernet buffer is now in use. */
\r
233 ucBufferInUse[ lNextBuffer ] = pdTRUE;
\r
237 /* Set EMAC Receive Descriptor Registers. */
\r
238 LPC_EMAC->RxDescriptor = RX_DESC_BASE;
\r
239 LPC_EMAC->RxStatus = RX_STAT_BASE;
\r
240 LPC_EMAC->RxDescriptorNumber = NUM_RX_FRAG - 1;
\r
242 /* Rx Descriptors Point to 0 */
\r
243 LPC_EMAC->RxConsumeIndex = 0;
\r
245 /* A buffer is not allocated to the Tx descriptors until they are actually
\r
247 for( x = 0; x < NUM_TX_FRAG; x++ )
\r
249 TX_DESC_PACKET( x ) = ( unsigned long ) NULL;
\r
250 TX_DESC_CTRL( x ) = 0;
\r
251 TX_STAT_INFO( x ) = 0;
\r
254 /* Set EMAC Transmit Descriptor Registers. */
\r
255 LPC_EMAC->TxDescriptor = TX_DESC_BASE;
\r
256 LPC_EMAC->TxStatus = TX_STAT_BASE;
\r
257 LPC_EMAC->TxDescriptorNumber = NUM_TX_FRAG - 1;
\r
259 /* Tx Descriptors Point to 0 */
\r
260 LPC_EMAC->TxProduceIndex = 0;
\r
262 /*-----------------------------------------------------------*/
\r
264 static void prvSetupEMACHardware( void )
\r
269 /* Enable P1 Ethernet Pins. */
\r
270 LPC_PINCON->PINSEL2 = emacPINSEL2_VALUE;
\r
271 LPC_PINCON->PINSEL3 = ( LPC_PINCON->PINSEL3 & ~0x0000000F ) | 0x00000005;
\r
273 /* Power Up the EMAC controller. */
\r
274 LPC_SC->PCONP |= PCONP_PCENET;
\r
275 vTaskDelay( emacSHORT_DELAY );
\r
277 /* Reset all EMAC internal modules. */
\r
278 LPC_EMAC->MAC1 = MAC1_RES_TX | MAC1_RES_MCS_TX | MAC1_RES_RX | MAC1_RES_MCS_RX | MAC1_SIM_RES | MAC1_SOFT_RES;
\r
279 LPC_EMAC->Command = CR_REG_RES | CR_TX_RES | CR_RX_RES | CR_PASS_RUNT_FRM;
\r
281 /* A short delay after reset. */
\r
282 vTaskDelay( emacSHORT_DELAY );
\r
284 /* Initialize MAC control registers. */
\r
285 LPC_EMAC->MAC1 = MAC1_PASS_ALL;
\r
286 LPC_EMAC->MAC2 = MAC2_CRC_EN | MAC2_PAD_EN;
\r
287 LPC_EMAC->MAXF = ETH_MAX_FLEN;
\r
288 LPC_EMAC->CLRT = CLRT_DEF;
\r
289 LPC_EMAC->IPGR = IPGR_DEF;
\r
291 /* Enable Reduced MII interface. */
\r
292 LPC_EMAC->Command = CR_RMII | CR_PASS_RUNT_FRM;
\r
294 /* Reset Reduced MII Logic. */
\r
295 LPC_EMAC->SUPP = SUPP_RES_RMII;
\r
296 vTaskDelay( emacSHORT_DELAY );
\r
297 LPC_EMAC->SUPP = 0;
\r
299 /* Put the PHY in reset mode */
\r
300 prvWritePHY( PHY_REG_BMCR, MCFG_RES_MII );
\r
301 prvWritePHY( PHY_REG_BMCR, MCFG_RES_MII );
\r
303 /* Wait for hardware reset to end. */
\r
304 for( x = 0; x < 100; x++ )
\r
306 vTaskDelay( emacSHORT_DELAY * 5 );
\r
307 us = prvReadPHY( PHY_REG_BMCR, &lDummy );
\r
308 if( !( us & MCFG_RES_MII ) )
\r
310 /* Reset complete */
\r
315 /*-----------------------------------------------------------*/
\r
317 static void prvConfigurePHY( void )
\r
322 /* Auto negotiate the configuration. */
\r
323 if( prvWritePHY( PHY_REG_BMCR, PHY_AUTO_NEG ) )
\r
325 vTaskDelay( emacSHORT_DELAY * 5 );
\r
327 for( x = 0; x < 10; x++ )
\r
329 us = prvReadPHY( PHY_REG_BMSR, &lDummy );
\r
331 if( us & PHY_AUTO_NEG_COMPLETE )
\r
336 vTaskDelay( emacWAIT_FOR_LINK_TO_ESTABLISH );
\r
340 /*-----------------------------------------------------------*/
\r
342 static long prvSetupLinkStatus( void )
\r
344 long lReturn = pdFAIL, x;
\r
345 unsigned short usLinkStatus;
\r
347 /* Wait with timeout for the link to be established. */
\r
348 for( x = 0; x < 10; x++ )
\r
350 usLinkStatus = prvReadPHY( PHY_REG_STS, &lReturn );
\r
351 if( usLinkStatus & emacLINK_ESTABLISHED )
\r
353 /* Link is established. */
\r
358 vTaskDelay( emacWAIT_FOR_LINK_TO_ESTABLISH );
\r
361 if( lReturn == pdPASS )
\r
363 /* Configure Full/Half Duplex mode. */
\r
364 if( usLinkStatus & emacFULL_DUPLEX_ENABLED )
\r
366 /* Full duplex is enabled. */
\r
367 LPC_EMAC->MAC2 |= MAC2_FULL_DUP;
\r
368 LPC_EMAC->Command |= CR_FULL_DUP;
\r
369 LPC_EMAC->IPGT = IPGT_FULL_DUP;
\r
373 /* Half duplex mode. */
\r
374 LPC_EMAC->IPGT = IPGT_HALF_DUP;
\r
377 /* Configure 100MBit/10MBit mode. */
\r
378 if( usLinkStatus & emac10BASE_T_MODE )
\r
381 LPC_EMAC->SUPP = 0;
\r
385 /* 100MBit mode. */
\r
386 LPC_EMAC->SUPP = SUPP_SPEED;
\r
392 /*-----------------------------------------------------------*/
\r
394 static void prvReturnBuffer( unsigned char *pucBuffer )
\r
398 /* Return a buffer to the pool of free buffers. */
\r
399 for( ul = 0; ul < ETH_NUM_BUFFERS; ul++ )
\r
401 if( ETH_BUF( ul ) == ( unsigned long ) pucBuffer )
\r
403 ucBufferInUse[ ul ] = pdFALSE;
\r
408 /*-----------------------------------------------------------*/
\r
410 unsigned long ulGetEMACRxData( void )
\r
412 unsigned long ulLen = 0;
\r
415 if( LPC_EMAC->RxProduceIndex != LPC_EMAC->RxConsumeIndex )
\r
417 /* Mark the current buffer as free as uip_buf is going to be set to
\r
418 the buffer that contains the received data. */
\r
419 prvReturnBuffer( uip_buf );
\r
421 ulLen = ( RX_STAT_INFO( LPC_EMAC->RxConsumeIndex ) & RINFO_SIZE ) - 3;
\r
422 uip_buf = ( unsigned char * ) RX_DESC_PACKET( LPC_EMAC->RxConsumeIndex );
\r
424 /* Allocate a new buffer to the descriptor. */
\r
425 RX_DESC_PACKET( LPC_EMAC->RxConsumeIndex ) = ( unsigned long ) prvGetNextBuffer();
\r
427 /* Move the consume index onto the next position, ensuring it wraps to
\r
428 the beginning at the appropriate place. */
\r
429 lIndex = LPC_EMAC->RxConsumeIndex;
\r
432 if( lIndex >= NUM_RX_FRAG )
\r
437 LPC_EMAC->RxConsumeIndex = lIndex;
\r
442 /*-----------------------------------------------------------*/
\r
444 void vSendEMACTxData( unsigned short usTxDataLen )
\r
446 unsigned long ulAttempts = 0UL;
\r
448 /* Check to see if the Tx descriptor is free, indicated by its buffer being
\r
450 while( TX_DESC_PACKET( emacTX_DESC_INDEX ) != ( unsigned long ) NULL )
\r
452 /* Wait for the Tx descriptor to become available. */
\r
453 vTaskDelay( emacBUFFER_WAIT_DELAY );
\r
456 if( ulAttempts > emacBUFFER_WAIT_ATTEMPTS )
\r
458 /* Something has gone wrong as the Tx descriptor is still in use.
\r
459 Clear it down manually, the data it was sending will probably be
\r
461 prvReturnBuffer( ( unsigned char * ) TX_DESC_PACKET( emacTX_DESC_INDEX ) );
\r
466 /* Setup the Tx descriptor for transmission. Remember the length of the
\r
467 data being sent so the second descriptor can be used to send it again from
\r
469 usSendLen = usTxDataLen;
\r
470 TX_DESC_PACKET( emacTX_DESC_INDEX ) = ( unsigned long ) uip_buf;
\r
471 TX_DESC_CTRL( emacTX_DESC_INDEX ) = ( usTxDataLen | TCTRL_LAST | TCTRL_INT );
\r
472 LPC_EMAC->TxProduceIndex = ( emacTX_DESC_INDEX + 1 );
\r
474 /* uip_buf is being sent by the Tx descriptor. Allocate a new buffer. */
\r
475 uip_buf = prvGetNextBuffer();
\r
477 /*-----------------------------------------------------------*/
\r
479 static long prvWritePHY( long lPhyReg, long lValue )
\r
481 const long lMaxTime = 10;
\r
484 LPC_EMAC->MADR = DP83848C_DEF_ADR | lPhyReg;
\r
485 LPC_EMAC->MWTD = lValue;
\r
488 for( x = 0; x < lMaxTime; x++ )
\r
490 if( ( LPC_EMAC->MIND & MIND_BUSY ) == 0 )
\r
492 /* Operation has finished. */
\r
496 vTaskDelay( emacSHORT_DELAY );
\r
508 /*-----------------------------------------------------------*/
\r
510 static unsigned short prvReadPHY( unsigned char ucPhyReg, long *plStatus )
\r
513 const long lMaxTime = 10;
\r
515 LPC_EMAC->MADR = DP83848C_DEF_ADR | ucPhyReg;
\r
516 LPC_EMAC->MCMD = MCMD_READ;
\r
518 for( x = 0; x < lMaxTime; x++ )
\r
520 /* Operation has finished. */
\r
521 if( ( LPC_EMAC->MIND & MIND_BUSY ) == 0 )
\r
526 vTaskDelay( emacSHORT_DELAY );
\r
529 LPC_EMAC->MCMD = 0;
\r
531 if( x >= lMaxTime )
\r
533 *plStatus = pdFAIL;
\r
536 return( LPC_EMAC->MRDD );
\r
538 /*-----------------------------------------------------------*/
\r
540 void vEMAC_ISR( void )
\r
542 unsigned long ulStatus;
\r
543 long lHigherPriorityTaskWoken = pdFALSE;
\r
545 ulStatus = LPC_EMAC->IntStatus;
\r
547 /* Clear the interrupt. */
\r
548 LPC_EMAC->IntClear = ulStatus;
\r
550 if( ulStatus & INT_RX_DONE )
\r
552 /* Ensure the uIP task is not blocked as data has arrived. */
\r
553 xSemaphoreGiveFromISR( xEMACSemaphore, &lHigherPriorityTaskWoken );
\r
556 if( ulStatus & INT_TX_DONE )
\r
558 if( usSendLen > 0 )
\r
560 /* Send the data again, using the second descriptor. As there are
\r
561 only two descriptors the index is set back to 0. */
\r
562 TX_DESC_PACKET( ( emacTX_DESC_INDEX + 1 ) ) = TX_DESC_PACKET( emacTX_DESC_INDEX );
\r
563 TX_DESC_CTRL( ( emacTX_DESC_INDEX + 1 ) ) = ( usSendLen | TCTRL_LAST | TCTRL_INT );
\r
564 LPC_EMAC->TxProduceIndex = ( emacTX_DESC_INDEX );
\r
566 /* This is the second Tx so set usSendLen to 0 to indicate that the
\r
567 Tx descriptors will be free again. */
\r
572 /* The Tx buffer is no longer required. */
\r
573 prvReturnBuffer( ( unsigned char * ) TX_DESC_PACKET( emacTX_DESC_INDEX ) );
\r
574 TX_DESC_PACKET( emacTX_DESC_INDEX ) = ( unsigned long ) NULL;
\r
578 portEND_SWITCHING_ISR( lHigherPriorityTaskWoken );
\r