2 FreeRTOS V9.0.0rc2 - Copyright (C) 2016 Real Time Engineers Ltd.
\r
5 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 This file is part of the FreeRTOS distribution.
\r
9 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
10 the terms of the GNU General Public License (version 2) as published by the
\r
11 Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.
\r
13 ***************************************************************************
\r
14 >>! NOTE: The modification to the GPL is included to allow you to !<<
\r
15 >>! distribute a combined work that includes FreeRTOS without being !<<
\r
16 >>! obliged to provide the source code for proprietary components !<<
\r
17 >>! outside of the FreeRTOS kernel. !<<
\r
18 ***************************************************************************
\r
20 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
21 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
22 FOR A PARTICULAR PURPOSE. Full license text is available on the following
\r
23 link: http://www.freertos.org/a00114.html
\r
25 ***************************************************************************
\r
27 * FreeRTOS provides completely free yet professionally developed, *
\r
28 * robust, strictly quality controlled, supported, and cross *
\r
29 * platform software that is more than just the market leader, it *
\r
30 * is the industry's de facto standard. *
\r
32 * Help yourself get started quickly while simultaneously helping *
\r
33 * to support the FreeRTOS project by purchasing a FreeRTOS *
\r
34 * tutorial book, reference manual, or both: *
\r
35 * http://www.FreeRTOS.org/Documentation *
\r
37 ***************************************************************************
\r
39 http://www.FreeRTOS.org/FAQHelp.html - Having a problem? Start by reading
\r
40 the FAQ page "My application does not run, what could be wrong?". Have you
\r
41 defined configASSERT()?
\r
43 http://www.FreeRTOS.org/support - In return for receiving this top quality
\r
44 embedded software for free we request you assist our global community by
\r
45 participating in the support forum.
\r
47 http://www.FreeRTOS.org/training - Investing in training allows your team to
\r
48 be as productive as possible as early as possible. Now you can receive
\r
49 FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers
\r
50 Ltd, and the world's leading authority on the world's leading RTOS.
\r
52 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
53 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
54 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
56 http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
\r
57 Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.
\r
59 http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High
\r
60 Integrity Systems ltd. to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
61 licenses offer ticketed support, indemnification and commercial middleware.
\r
63 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
64 engineered and independently SIL3 certified version for use in safety and
\r
65 mission critical applications that require provable dependability.
\r
70 /* Originally adapted from file written by Andreas Dannenberg. Supplied with permission. */
\r
72 /* Kernel includes. */
\r
73 #include "FreeRTOS.h"
\r
77 /* Hardware specific includes. */
\r
78 #include "EthDev_LPC17xx.h"
\r
80 /* Time to wait between each inspection of the link status. */
\r
81 #define emacWAIT_FOR_LINK_TO_ESTABLISH ( 500 / portTICK_PERIOD_MS )
\r
83 /* Short delay used in several places during the initialisation process. */
\r
84 #define emacSHORT_DELAY ( 2 )
\r
86 /* Hardware specific bit definitions. */
\r
87 #define emacLINK_ESTABLISHED ( 0x0001 )
\r
88 #define emacFULL_DUPLEX_ENABLED ( 0x0004 )
\r
89 #define emac10BASE_T_MODE ( 0x0002 )
\r
90 #define emacPINSEL2_VALUE ( 0x50150105 )
\r
92 /* If no buffers are available, then wait this long before looking again.... */
\r
93 #define emacBUFFER_WAIT_DELAY ( 3 / portTICK_PERIOD_MS )
\r
95 /* ...and don't look more than this many times. */
\r
96 #define emacBUFFER_WAIT_ATTEMPTS ( 30 )
\r
98 /* Index to the Tx descriptor that is always used first for every Tx. The second
\r
99 descriptor is then used to re-send in order to speed up the uIP Tx process. */
\r
100 #define emacTX_DESC_INDEX ( 0 )
\r
102 /*-----------------------------------------------------------*/
\r
105 * Configure both the Rx and Tx descriptors during the init process.
\r
107 static void prvInitDescriptors( void );
\r
110 * Setup the IO and peripherals required for Ethernet communication.
\r
112 static void prvSetupEMACHardware( void );
\r
115 * Control the auto negotiate process.
\r
117 static void prvConfigurePHY( void );
\r
120 * Wait for a link to be established, then setup the PHY according to the link
\r
123 static long prvSetupLinkStatus( void );
\r
126 * Search the pool of buffers to find one that is free. If a buffer is found
\r
127 * mark it as in use before returning its address.
\r
129 static unsigned char *prvGetNextBuffer( void );
\r
132 * Return an allocated buffer to the pool of free buffers.
\r
134 static void prvReturnBuffer( unsigned char *pucBuffer );
\r
137 * Send lValue to the lPhyReg within the PHY.
\r
139 static long prvWritePHY( long lPhyReg, long lValue );
\r
142 * Read a value from ucPhyReg within the PHY. *plStatus will be set to
\r
143 * pdFALSE if there is an error.
\r
145 static unsigned short prvReadPHY( unsigned char ucPhyReg, long *plStatus );
\r
147 /*-----------------------------------------------------------*/
\r
149 /* The semaphore used to wake the uIP task when data arrives. */
\r
150 extern SemaphoreHandle_t xEMACSemaphore;
\r
152 /* Each ucBufferInUse index corresponds to a position in the pool of buffers.
\r
153 If the index contains a 1 then the buffer within pool is in use, if it
\r
154 contains a 0 then the buffer is free. */
\r
155 static unsigned char ucBufferInUse[ ETH_NUM_BUFFERS ] = { pdFALSE };
\r
157 /* The uip_buffer is not a fixed array, but instead gets pointed to the buffers
\r
158 allocated within this file. */
\r
159 unsigned char * uip_buf;
\r
161 /* Store the length of the data being sent so the data can be sent twice. The
\r
162 value will be set back to 0 once the data has been sent twice. */
\r
163 static unsigned short usSendLen = 0;
\r
165 /*-----------------------------------------------------------*/
\r
167 long lEMACInit( void )
\r
169 long lReturn = pdPASS;
\r
170 unsigned long ulID1, ulID2;
\r
172 /* Reset peripherals, configure port pins and registers. */
\r
173 prvSetupEMACHardware();
\r
175 /* Check the PHY part number is as expected. */
\r
176 ulID1 = prvReadPHY( PHY_REG_IDR1, &lReturn );
\r
177 ulID2 = prvReadPHY( PHY_REG_IDR2, &lReturn );
\r
178 if( ( (ulID1 << 16UL ) | ( ulID2 & 0xFFF0UL ) ) == DP83848C_ID )
\r
180 /* Set the Ethernet MAC Address registers */
\r
181 EMAC->SA0 = ( configMAC_ADDR0 << 8 ) | configMAC_ADDR1;
\r
182 EMAC->SA1 = ( configMAC_ADDR2 << 8 ) | configMAC_ADDR3;
\r
183 EMAC->SA2 = ( configMAC_ADDR4 << 8 ) | configMAC_ADDR5;
\r
185 /* Initialize Tx and Rx DMA Descriptors */
\r
186 prvInitDescriptors();
\r
188 /* Receive broadcast and perfect match packets */
\r
189 EMAC->RxFilterCtrl = RFC_UCAST_EN | RFC_BCAST_EN | RFC_PERFECT_EN;
\r
191 /* Setup the PHY. */
\r
199 /* Check the link status. */
\r
200 if( lReturn == pdPASS )
\r
202 lReturn = prvSetupLinkStatus();
\r
205 if( lReturn == pdPASS )
\r
207 /* Initialise uip_buf to ensure it points somewhere valid. */
\r
208 uip_buf = prvGetNextBuffer();
\r
210 /* Reset all interrupts */
\r
211 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
213 /* Enable receive and transmit mode of MAC Ethernet core */
\r
214 EMAC->Command |= ( CR_RX_EN | CR_TX_EN );
\r
215 EMAC->MAC1 |= MAC1_REC_EN;
\r
220 /*-----------------------------------------------------------*/
\r
222 static unsigned char *prvGetNextBuffer( void )
\r
225 unsigned char *pucReturn = NULL;
\r
226 unsigned long ulAttempts = 0;
\r
228 while( pucReturn == NULL )
\r
230 /* Look through the buffers to find one that is not in use by
\r
232 for( x = 0; x < ETH_NUM_BUFFERS; x++ )
\r
234 if( ucBufferInUse[ x ] == pdFALSE )
\r
236 ucBufferInUse[ x ] = pdTRUE;
\r
237 pucReturn = ( unsigned char * ) ETH_BUF( x );
\r
242 /* Was a buffer found? */
\r
243 if( pucReturn == NULL )
\r
247 if( ulAttempts >= emacBUFFER_WAIT_ATTEMPTS )
\r
252 /* Wait then look again. */
\r
253 vTaskDelay( emacBUFFER_WAIT_DELAY );
\r
259 /*-----------------------------------------------------------*/
\r
261 static void prvInitDescriptors( void )
\r
263 long x, lNextBuffer = 0;
\r
265 for( x = 0; x < NUM_RX_FRAG; x++ )
\r
267 /* Allocate the next Ethernet buffer to this descriptor. */
\r
268 RX_DESC_PACKET( x ) = ETH_BUF( lNextBuffer );
\r
269 RX_DESC_CTRL( x ) = RCTRL_INT | ( ETH_FRAG_SIZE - 1 );
\r
270 RX_STAT_INFO( x ) = 0;
\r
271 RX_STAT_HASHCRC( x ) = 0;
\r
273 /* The Ethernet buffer is now in use. */
\r
274 ucBufferInUse[ lNextBuffer ] = pdTRUE;
\r
278 /* Set EMAC Receive Descriptor Registers. */
\r
279 EMAC->RxDescriptor = RX_DESC_BASE;
\r
280 EMAC->RxStatus = RX_STAT_BASE;
\r
281 EMAC->RxDescriptorNumber = NUM_RX_FRAG - 1;
\r
283 /* Rx Descriptors Point to 0 */
\r
284 EMAC->RxConsumeIndex = 0;
\r
286 /* A buffer is not allocated to the Tx descriptors until they are actually
\r
288 for( x = 0; x < NUM_TX_FRAG; x++ )
\r
290 TX_DESC_PACKET( x ) = ( unsigned long ) NULL;
\r
291 TX_DESC_CTRL( x ) = 0;
\r
292 TX_STAT_INFO( x ) = 0;
\r
295 /* Set EMAC Transmit Descriptor Registers. */
\r
296 EMAC->TxDescriptor = TX_DESC_BASE;
\r
297 EMAC->TxStatus = TX_STAT_BASE;
\r
298 EMAC->TxDescriptorNumber = NUM_TX_FRAG - 1;
\r
300 /* Tx Descriptors Point to 0 */
\r
301 EMAC->TxProduceIndex = 0;
\r
303 /*-----------------------------------------------------------*/
\r
305 static void prvSetupEMACHardware( void )
\r
310 /* Enable P1 Ethernet Pins. */
\r
311 PINCON->PINSEL2 = emacPINSEL2_VALUE;
\r
312 PINCON->PINSEL3 = ( PINCON->PINSEL3 & ~0x0000000F ) | 0x00000005;
\r
314 /* Power Up the EMAC controller. */
\r
315 SC->PCONP |= PCONP_PCENET;
\r
316 vTaskDelay( emacSHORT_DELAY );
\r
318 /* Reset all EMAC internal modules. */
\r
319 EMAC->MAC1 = MAC1_RES_TX | MAC1_RES_MCS_TX | MAC1_RES_RX | MAC1_RES_MCS_RX | MAC1_SIM_RES | MAC1_SOFT_RES;
\r
320 EMAC->Command = CR_REG_RES | CR_TX_RES | CR_RX_RES | CR_PASS_RUNT_FRM;
\r
322 /* A short delay after reset. */
\r
323 vTaskDelay( emacSHORT_DELAY );
\r
325 /* Initialize MAC control registers. */
\r
326 EMAC->MAC1 = MAC1_PASS_ALL;
\r
327 EMAC->MAC2 = MAC2_CRC_EN | MAC2_PAD_EN;
\r
328 EMAC->MAXF = ETH_MAX_FLEN;
\r
329 EMAC->CLRT = CLRT_DEF;
\r
330 EMAC->IPGR = IPGR_DEF;
\r
332 /* Enable Reduced MII interface. */
\r
333 EMAC->Command = CR_RMII | CR_PASS_RUNT_FRM;
\r
335 /* Reset Reduced MII Logic. */
\r
336 EMAC->SUPP = SUPP_RES_RMII;
\r
337 vTaskDelay( emacSHORT_DELAY );
\r
340 /* Put the PHY in reset mode */
\r
341 prvWritePHY( PHY_REG_BMCR, MCFG_RES_MII );
\r
342 prvWritePHY( PHY_REG_BMCR, MCFG_RES_MII );
\r
344 /* Wait for hardware reset to end. */
\r
345 for( x = 0; x < 100; x++ )
\r
347 vTaskDelay( emacSHORT_DELAY * 5 );
\r
348 us = prvReadPHY( PHY_REG_BMCR, &lDummy );
\r
349 if( !( us & MCFG_RES_MII ) )
\r
351 /* Reset complete */
\r
356 /*-----------------------------------------------------------*/
\r
358 static void prvConfigurePHY( void )
\r
363 /* Auto negotiate the configuration. */
\r
364 if( prvWritePHY( PHY_REG_BMCR, PHY_AUTO_NEG ) )
\r
366 vTaskDelay( emacSHORT_DELAY * 5 );
\r
368 for( x = 0; x < 10; x++ )
\r
370 us = prvReadPHY( PHY_REG_BMSR, &lDummy );
\r
372 if( us & PHY_AUTO_NEG_COMPLETE )
\r
377 vTaskDelay( emacWAIT_FOR_LINK_TO_ESTABLISH );
\r
381 /*-----------------------------------------------------------*/
\r
383 static long prvSetupLinkStatus( void )
\r
385 long lReturn = pdFAIL, x;
\r
386 unsigned short usLinkStatus;
\r
388 /* Wait with timeout for the link to be established. */
\r
389 for( x = 0; x < 10; x++ )
\r
391 usLinkStatus = prvReadPHY( PHY_REG_STS, &lReturn );
\r
392 if( usLinkStatus & emacLINK_ESTABLISHED )
\r
394 /* Link is established. */
\r
399 vTaskDelay( emacWAIT_FOR_LINK_TO_ESTABLISH );
\r
402 if( lReturn == pdPASS )
\r
404 /* Configure Full/Half Duplex mode. */
\r
405 if( usLinkStatus & emacFULL_DUPLEX_ENABLED )
\r
407 /* Full duplex is enabled. */
\r
408 EMAC->MAC2 |= MAC2_FULL_DUP;
\r
409 EMAC->Command |= CR_FULL_DUP;
\r
410 EMAC->IPGT = IPGT_FULL_DUP;
\r
414 /* Half duplex mode. */
\r
415 EMAC->IPGT = IPGT_HALF_DUP;
\r
418 /* Configure 100MBit/10MBit mode. */
\r
419 if( usLinkStatus & emac10BASE_T_MODE )
\r
426 /* 100MBit mode. */
\r
427 EMAC->SUPP = SUPP_SPEED;
\r
433 /*-----------------------------------------------------------*/
\r
435 static void prvReturnBuffer( unsigned char *pucBuffer )
\r
439 /* Return a buffer to the pool of free buffers. */
\r
440 for( ul = 0; ul < ETH_NUM_BUFFERS; ul++ )
\r
442 if( ETH_BUF( ul ) == ( unsigned long ) pucBuffer )
\r
444 ucBufferInUse[ ul ] = pdFALSE;
\r
449 /*-----------------------------------------------------------*/
\r
451 unsigned long ulGetEMACRxData( void )
\r
453 unsigned long ulLen = 0;
\r
456 if( EMAC->RxProduceIndex != EMAC->RxConsumeIndex )
\r
458 /* Mark the current buffer as free as uip_buf is going to be set to
\r
459 the buffer that contains the received data. */
\r
460 prvReturnBuffer( uip_buf );
\r
462 ulLen = ( RX_STAT_INFO( EMAC->RxConsumeIndex ) & RINFO_SIZE ) - 3;
\r
463 uip_buf = ( unsigned char * ) RX_DESC_PACKET( EMAC->RxConsumeIndex );
\r
465 /* Allocate a new buffer to the descriptor. */
\r
466 RX_DESC_PACKET( EMAC->RxConsumeIndex ) = ( unsigned long ) prvGetNextBuffer();
\r
468 /* Move the consume index onto the next position, ensuring it wraps to
\r
469 the beginning at the appropriate place. */
\r
470 lIndex = EMAC->RxConsumeIndex;
\r
473 if( lIndex >= NUM_RX_FRAG )
\r
478 EMAC->RxConsumeIndex = lIndex;
\r
483 /*-----------------------------------------------------------*/
\r
485 void vSendEMACTxData( unsigned short usTxDataLen )
\r
487 unsigned long ulAttempts = 0UL;
\r
489 /* Check to see if the Tx descriptor is free, indicated by its buffer being
\r
491 while( TX_DESC_PACKET( emacTX_DESC_INDEX ) != ( unsigned long ) NULL )
\r
493 /* Wait for the Tx descriptor to become available. */
\r
494 vTaskDelay( emacBUFFER_WAIT_DELAY );
\r
497 if( ulAttempts > emacBUFFER_WAIT_ATTEMPTS )
\r
499 /* Something has gone wrong as the Tx descriptor is still in use.
\r
500 Clear it down manually, the data it was sending will probably be
\r
502 prvReturnBuffer( ( unsigned char * ) TX_DESC_PACKET( emacTX_DESC_INDEX ) );
\r
507 /* Setup the Tx descriptor for transmission. Remember the length of the
\r
508 data being sent so the second descriptor can be used to send it again from
\r
510 usSendLen = usTxDataLen;
\r
511 TX_DESC_PACKET( emacTX_DESC_INDEX ) = ( unsigned long ) uip_buf;
\r
512 TX_DESC_CTRL( emacTX_DESC_INDEX ) = ( usTxDataLen | TCTRL_LAST | TCTRL_INT );
\r
513 EMAC->TxProduceIndex = ( emacTX_DESC_INDEX + 1 );
\r
515 /* uip_buf is being sent by the Tx descriptor. Allocate a new buffer. */
\r
516 uip_buf = prvGetNextBuffer();
\r
518 /*-----------------------------------------------------------*/
\r
520 static long prvWritePHY( long lPhyReg, long lValue )
\r
522 const long lMaxTime = 10;
\r
525 EMAC->MADR = DP83848C_DEF_ADR | lPhyReg;
\r
526 EMAC->MWTD = lValue;
\r
529 for( x = 0; x < lMaxTime; x++ )
\r
531 if( ( EMAC->MIND & MIND_BUSY ) == 0 )
\r
533 /* Operation has finished. */
\r
537 vTaskDelay( emacSHORT_DELAY );
\r
549 /*-----------------------------------------------------------*/
\r
551 static unsigned short prvReadPHY( unsigned char ucPhyReg, long *plStatus )
\r
554 const long lMaxTime = 10;
\r
556 EMAC->MADR = DP83848C_DEF_ADR | ucPhyReg;
\r
557 EMAC->MCMD = MCMD_READ;
\r
559 for( x = 0; x < lMaxTime; x++ )
\r
561 /* Operation has finished. */
\r
562 if( ( EMAC->MIND & MIND_BUSY ) == 0 )
\r
567 vTaskDelay( emacSHORT_DELAY );
\r
572 if( x >= lMaxTime )
\r
574 *plStatus = pdFAIL;
\r
577 return( EMAC->MRDD );
\r
579 /*-----------------------------------------------------------*/
\r
581 void vEMAC_ISR( void )
\r
583 unsigned long ulStatus;
\r
584 long lHigherPriorityTaskWoken = pdFALSE;
\r
586 ulStatus = EMAC->IntStatus;
\r
588 /* Clear the interrupt. */
\r
589 EMAC->IntClear = ulStatus;
\r
591 if( ulStatus & INT_RX_DONE )
\r
593 /* Ensure the uIP task is not blocked as data has arrived. */
\r
594 xSemaphoreGiveFromISR( xEMACSemaphore, &lHigherPriorityTaskWoken );
\r
597 if( ulStatus & INT_TX_DONE )
\r
599 if( usSendLen > 0 )
\r
601 /* Send the data again, using the second descriptor. As there are
\r
602 only two descriptors the index is set back to 0. */
\r
603 TX_DESC_PACKET( ( emacTX_DESC_INDEX + 1 ) ) = TX_DESC_PACKET( emacTX_DESC_INDEX );
\r
604 TX_DESC_CTRL( ( emacTX_DESC_INDEX + 1 ) ) = ( usSendLen | TCTRL_LAST | TCTRL_INT );
\r
605 EMAC->TxProduceIndex = ( emacTX_DESC_INDEX );
\r
607 /* This is the second Tx so set usSendLen to 0 to indicate that the
\r
608 Tx descriptors will be free again. */
\r
613 /* The Tx buffer is no longer required. */
\r
614 prvReturnBuffer( ( unsigned char * ) TX_DESC_PACKET( emacTX_DESC_INDEX ) );
\r
615 TX_DESC_PACKET( emacTX_DESC_INDEX ) = ( unsigned long ) NULL;
\r
619 portEND_SWITCHING_ISR( lHigherPriorityTaskWoken );
\r