2 FreeRTOS V8.2.0rc1 - Copyright (C) 2014 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 >>! NOTE: The modification to the GPL is included to allow you to !<<
\r
14 >>! distribute a combined work that includes FreeRTOS without being !<<
\r
15 >>! obliged to provide the source code for proprietary components !<<
\r
16 >>! outside of the FreeRTOS kernel. !<<
\r
18 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
19 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
20 FOR A PARTICULAR PURPOSE. Full license text is available on the following
\r
21 link: http://www.freertos.org/a00114.html
\r
25 ***************************************************************************
\r
27 * Having a problem? Start by reading the FAQ "My application does *
\r
28 * not run, what could be wrong?". Have you defined configASSERT()? *
\r
30 * http://www.FreeRTOS.org/FAQHelp.html *
\r
32 ***************************************************************************
\r
34 ***************************************************************************
\r
36 * FreeRTOS provides completely free yet professionally developed, *
\r
37 * robust, strictly quality controlled, supported, and cross *
\r
38 * platform software that is more than just the market leader, it *
\r
39 * is the industry's de facto standard. *
\r
41 * Help yourself get started quickly while simultaneously helping *
\r
42 * to support the FreeRTOS project by purchasing a FreeRTOS *
\r
43 * tutorial book, reference manual, or both: *
\r
44 * http://www.FreeRTOS.org/Documentation *
\r
46 ***************************************************************************
\r
48 ***************************************************************************
\r
50 * Investing in training allows your team to be as productive as *
\r
51 * possible as early as possible, lowering your overall development *
\r
52 * cost, and enabling you to bring a more robust product to market *
\r
53 * earlier than would otherwise be possible. Richard Barry is both *
\r
54 * the architect and key author of FreeRTOS, and so also the world's *
\r
55 * leading authority on what is the world's most popular real time *
\r
56 * kernel for deeply embedded MCU designs. Obtaining your training *
\r
57 * from Richard ensures your team will gain directly from his in-depth *
\r
58 * product knowledge and years of usage experience. Contact Real Time *
\r
59 * Engineers Ltd to enquire about the FreeRTOS Masterclass, presented *
\r
60 * by Richard Barry: http://www.FreeRTOS.org/contact
\r
62 ***************************************************************************
\r
64 ***************************************************************************
\r
66 * You are receiving this top quality software for free. Please play *
\r
67 * fair and reciprocate by reporting any suspected issues and *
\r
68 * participating in the community forum: *
\r
69 * http://www.FreeRTOS.org/support *
\r
73 ***************************************************************************
\r
75 http://www.FreeRTOS.org - Documentation, books, training, latest versions,
\r
76 license and Real Time Engineers Ltd. contact details.
\r
78 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
79 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
80 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
82 http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
\r
83 Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.
\r
85 http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High
\r
86 Integrity Systems ltd. to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
87 licenses offer ticketed support, indemnification and commercial middleware.
\r
89 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
90 engineered and independently SIL3 certified version for use in safety and
\r
91 mission critical applications that require provable dependability.
\r
96 /* Originally adapted from file written by Andreas Dannenberg. Supplied with permission. */
\r
98 /* Kernel includes. */
\r
99 #include "FreeRTOS.h"
\r
101 #include "semphr.h"
\r
103 /* Hardware specific includes. */
\r
104 #include "EthDev_LPC17xx.h"
\r
106 /* Time to wait between each inspection of the link status. */
\r
107 #define emacWAIT_FOR_LINK_TO_ESTABLISH ( 500 / portTICK_PERIOD_MS )
\r
109 /* Short delay used in several places during the initialisation process. */
\r
110 #define emacSHORT_DELAY ( 2 )
\r
112 /* Hardware specific bit definitions. */
\r
113 #define emacLINK_ESTABLISHED ( 0x0020)
\r
114 #define emacFULL_DUPLEX_ENABLED ( 0x0010 )
\r
115 #define emac10BASE_T_MODE ( 0x0004 )
\r
116 #define emacPINSEL2_VALUE ( 0x50150105 )
\r
117 #define emacDIV_44 ( 0x28 )
\r
119 /* If no buffers are available, then wait this long before looking again.... */
\r
120 #define emacBUFFER_WAIT_DELAY ( 3 / portTICK_PERIOD_MS )
\r
122 /* ...and don't look more than this many times. */
\r
123 #define emacBUFFER_WAIT_ATTEMPTS ( 30 )
\r
125 /* Index to the Tx descriptor that is always used first for every Tx. The second
\r
126 descriptor is then used to re-send in order to speed up the uIP Tx process. */
\r
127 #define emacTX_DESC_INDEX ( 0 )
\r
129 /*-----------------------------------------------------------*/
\r
132 * Configure both the Rx and Tx descriptors during the init process.
\r
134 static void prvInitDescriptors( void );
\r
137 * Setup the IO and peripherals required for Ethernet communication.
\r
139 static void prvSetupEMACHardware( void );
\r
142 * Control the auto negotiate process.
\r
144 static void prvConfigurePHY( void );
\r
147 * Wait for a link to be established, then setup the PHY according to the link
\r
150 static long prvSetupLinkStatus( void );
\r
153 * Search the pool of buffers to find one that is free. If a buffer is found
\r
154 * mark it as in use before returning its address.
\r
156 static unsigned char *prvGetNextBuffer( void );
\r
159 * Return an allocated buffer to the pool of free buffers.
\r
161 static void prvReturnBuffer( unsigned char *pucBuffer );
\r
164 * Send lValue to the lPhyReg within the PHY.
\r
166 static long prvWritePHY( long lPhyReg, long lValue );
\r
169 * Read a value from ucPhyReg within the PHY. *plStatus will be set to
\r
170 * pdFALSE if there is an error.
\r
172 static unsigned short prvReadPHY( unsigned char ucPhyReg, long *plStatus );
\r
174 /*-----------------------------------------------------------*/
\r
176 /* The semaphore used to wake the uIP task when data arrives. */
\r
177 extern SemaphoreHandle_t xEMACSemaphore;
\r
179 /* Each ucBufferInUse index corresponds to a position in the pool of buffers.
\r
180 If the index contains a 1 then the buffer within pool is in use, if it
\r
181 contains a 0 then the buffer is free. */
\r
182 static unsigned char ucBufferInUse[ ETH_NUM_BUFFERS ] = { pdFALSE };
\r
184 /* The uip_buffer is not a fixed array, but instead gets pointed to the buffers
\r
185 allocated within this file. */
\r
186 unsigned char * uip_buf;
\r
188 /* Store the length of the data being sent so the data can be sent twice. The
\r
189 value will be set back to 0 once the data has been sent twice. */
\r
190 static unsigned short usSendLen = 0;
\r
192 /*-----------------------------------------------------------*/
\r
194 long lEMACInit( void )
\r
196 long lReturn = pdPASS;
\r
197 unsigned long ulID1, ulID2;
\r
199 /* Reset peripherals, configure port pins and registers. */
\r
200 prvSetupEMACHardware();
\r
202 /* Check the PHY part number is as expected. */
\r
203 ulID1 = prvReadPHY( PHY_REG_IDR1, &lReturn );
\r
204 ulID2 = prvReadPHY( PHY_REG_IDR2, &lReturn );
\r
205 if( ( (ulID1 << 16UL ) | ( ulID2 & 0xFFFFUL ) ) == KS8721_ID )
\r
207 /* Set the Ethernet MAC Address registers */
\r
208 EMAC->SA0 = ( configMAC_ADDR0 << 8 ) | configMAC_ADDR1;
\r
209 EMAC->SA1 = ( configMAC_ADDR2 << 8 ) | configMAC_ADDR3;
\r
210 EMAC->SA2 = ( configMAC_ADDR4 << 8 ) | configMAC_ADDR5;
\r
212 /* Initialize Tx and Rx DMA Descriptors */
\r
213 prvInitDescriptors();
\r
215 /* Receive broadcast and perfect match packets */
\r
216 EMAC->RxFilterCtrl = RFC_UCAST_EN | RFC_BCAST_EN | RFC_PERFECT_EN;
\r
218 /* Setup the PHY. */
\r
226 /* Check the link status. */
\r
227 if( lReturn == pdPASS )
\r
229 lReturn = prvSetupLinkStatus();
\r
232 if( lReturn == pdPASS )
\r
234 /* Initialise uip_buf to ensure it points somewhere valid. */
\r
235 uip_buf = prvGetNextBuffer();
\r
237 /* Reset all interrupts */
\r
238 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
240 /* Enable receive and transmit mode of MAC Ethernet core */
\r
241 EMAC->Command |= ( CR_RX_EN | CR_TX_EN );
\r
242 EMAC->MAC1 |= MAC1_REC_EN;
\r
247 /*-----------------------------------------------------------*/
\r
249 static unsigned char *prvGetNextBuffer( void )
\r
252 unsigned char *pucReturn = NULL;
\r
253 unsigned long ulAttempts = 0;
\r
255 while( pucReturn == NULL )
\r
257 /* Look through the buffers to find one that is not in use by
\r
259 for( x = 0; x < ETH_NUM_BUFFERS; x++ )
\r
261 if( ucBufferInUse[ x ] == pdFALSE )
\r
263 ucBufferInUse[ x ] = pdTRUE;
\r
264 pucReturn = ( unsigned char * ) ETH_BUF( x );
\r
269 /* Was a buffer found? */
\r
270 if( pucReturn == NULL )
\r
274 if( ulAttempts >= emacBUFFER_WAIT_ATTEMPTS )
\r
279 /* Wait then look again. */
\r
280 vTaskDelay( emacBUFFER_WAIT_DELAY );
\r
286 /*-----------------------------------------------------------*/
\r
288 static void prvInitDescriptors( void )
\r
290 long x, lNextBuffer = 0;
\r
292 for( x = 0; x < NUM_RX_FRAG; x++ )
\r
294 /* Allocate the next Ethernet buffer to this descriptor. */
\r
295 RX_DESC_PACKET( x ) = ETH_BUF( lNextBuffer );
\r
296 RX_DESC_CTRL( x ) = RCTRL_INT | ( ETH_FRAG_SIZE - 1 );
\r
297 RX_STAT_INFO( x ) = 0;
\r
298 RX_STAT_HASHCRC( x ) = 0;
\r
300 /* The Ethernet buffer is now in use. */
\r
301 ucBufferInUse[ lNextBuffer ] = pdTRUE;
\r
305 /* Set EMAC Receive Descriptor Registers. */
\r
306 EMAC->RxDescriptor = RX_DESC_BASE;
\r
307 EMAC->RxStatus = RX_STAT_BASE;
\r
308 EMAC->RxDescriptorNumber = NUM_RX_FRAG - 1;
\r
310 /* Rx Descriptors Point to 0 */
\r
311 EMAC->RxConsumeIndex = 0;
\r
313 /* A buffer is not allocated to the Tx descriptors until they are actually
\r
315 for( x = 0; x < NUM_TX_FRAG; x++ )
\r
317 TX_DESC_PACKET( x ) = ( unsigned long ) NULL;
\r
318 TX_DESC_CTRL( x ) = 0;
\r
319 TX_STAT_INFO( x ) = 0;
\r
322 /* Set EMAC Transmit Descriptor Registers. */
\r
323 EMAC->TxDescriptor = TX_DESC_BASE;
\r
324 EMAC->TxStatus = TX_STAT_BASE;
\r
325 EMAC->TxDescriptorNumber = NUM_TX_FRAG - 1;
\r
327 /* Tx Descriptors Point to 0 */
\r
328 EMAC->TxProduceIndex = 0;
\r
330 /*-----------------------------------------------------------*/
\r
332 static void prvSetupEMACHardware( void )
\r
337 /* Enable P1 Ethernet Pins. */
\r
338 PINCON->PINSEL2 = emacPINSEL2_VALUE;
\r
339 PINCON->PINSEL3 = ( PINCON->PINSEL3 & ~0x0000000F ) | 0x00000005;
\r
341 /* Power Up the EMAC controller. */
\r
342 SC->PCONP |= PCONP_PCENET;
\r
343 vTaskDelay( emacSHORT_DELAY );
\r
345 /* Reset all EMAC internal modules. */
\r
346 EMAC->MAC1 = MAC1_RES_TX | MAC1_RES_MCS_TX | MAC1_RES_RX | MAC1_RES_MCS_RX | MAC1_SIM_RES | MAC1_SOFT_RES;
\r
347 EMAC->Command = CR_REG_RES | CR_TX_RES | CR_RX_RES | CR_PASS_RUNT_FRM;
\r
349 /* A short delay after reset. */
\r
350 vTaskDelay( emacSHORT_DELAY );
\r
352 /* Initialize MAC control registers. */
\r
353 EMAC->MAC1 = MAC1_PASS_ALL;
\r
354 EMAC->MAC2 = MAC2_CRC_EN | MAC2_PAD_EN;
\r
355 EMAC->MAXF = ETH_MAX_FLEN;
\r
356 EMAC->CLRT = CLRT_DEF;
\r
357 EMAC->IPGR = IPGR_DEF;
\r
358 EMAC->MCFG = emacDIV_44;
\r
360 /* Enable Reduced MII interface. */
\r
361 EMAC->Command = CR_RMII | CR_PASS_RUNT_FRM;
\r
363 /* Reset Reduced MII Logic. */
\r
364 EMAC->SUPP = SUPP_RES_RMII;
\r
365 vTaskDelay( emacSHORT_DELAY );
\r
368 /* Put the PHY in reset mode */
\r
369 prvWritePHY( PHY_REG_BMCR, MCFG_RES_MII );
\r
370 prvWritePHY( PHY_REG_BMCR, MCFG_RES_MII );
\r
372 /* Wait for hardware reset to end. */
\r
373 for( x = 0; x < 100; x++ )
\r
375 vTaskDelay( emacSHORT_DELAY * 5 );
\r
376 us = prvReadPHY( PHY_REG_BMCR, &lDummy );
\r
377 if( !( us & MCFG_RES_MII ) )
\r
379 /* Reset complete */
\r
384 /*-----------------------------------------------------------*/
\r
386 static void prvConfigurePHY( void )
\r
391 /* Auto negotiate the configuration. */
\r
392 if( prvWritePHY( PHY_REG_BMCR, PHY_AUTO_NEG ) )
\r
394 vTaskDelay( emacSHORT_DELAY * 5 );
\r
396 for( x = 0; x < 10; x++ )
\r
398 us = prvReadPHY( PHY_REG_BMSR, &lDummy );
\r
400 if( us & PHY_AUTO_NEG_COMPLETE )
\r
405 vTaskDelay( emacWAIT_FOR_LINK_TO_ESTABLISH );
\r
409 /*-----------------------------------------------------------*/
\r
411 static long prvSetupLinkStatus( void )
\r
413 long lReturn = pdFAIL, x;
\r
414 unsigned short usLinkStatus;
\r
416 /* Wait with timeout for the link to be established. */
\r
417 for( x = 0; x < 10; x++ )
\r
419 usLinkStatus = prvReadPHY( PHY_CTRLER, &lReturn );
\r
420 if( usLinkStatus != 0x00 )
\r
422 /* Link is established. */
\r
427 vTaskDelay( emacWAIT_FOR_LINK_TO_ESTABLISH );
\r
430 if( lReturn == pdPASS )
\r
432 /* Configure Full/Half Duplex mode. */
\r
433 if( usLinkStatus & emacFULL_DUPLEX_ENABLED )
\r
435 /* Full duplex is enabled. */
\r
436 EMAC->MAC2 |= MAC2_FULL_DUP;
\r
437 EMAC->Command |= CR_FULL_DUP;
\r
438 EMAC->IPGT = IPGT_FULL_DUP;
\r
442 /* Half duplex mode. */
\r
443 EMAC->IPGT = IPGT_HALF_DUP;
\r
446 /* Configure 100MBit/10MBit mode. */
\r
447 if( usLinkStatus & emac10BASE_T_MODE )
\r
454 /* 100MBit mode. */
\r
455 EMAC->SUPP = SUPP_SPEED;
\r
461 /*-----------------------------------------------------------*/
\r
463 static void prvReturnBuffer( unsigned char *pucBuffer )
\r
467 /* Return a buffer to the pool of free buffers. */
\r
468 for( ul = 0; ul < ETH_NUM_BUFFERS; ul++ )
\r
470 if( ETH_BUF( ul ) == ( unsigned long ) pucBuffer )
\r
472 ucBufferInUse[ ul ] = pdFALSE;
\r
477 /*-----------------------------------------------------------*/
\r
479 unsigned long ulGetEMACRxData( void )
\r
481 unsigned long ulLen = 0;
\r
484 if( EMAC->RxProduceIndex != EMAC->RxConsumeIndex )
\r
486 /* Mark the current buffer as free as uip_buf is going to be set to
\r
487 the buffer that contains the received data. */
\r
488 prvReturnBuffer( uip_buf );
\r
490 ulLen = ( RX_STAT_INFO( EMAC->RxConsumeIndex ) & RINFO_SIZE ) - 3;
\r
491 uip_buf = ( unsigned char * ) RX_DESC_PACKET( EMAC->RxConsumeIndex );
\r
493 /* Allocate a new buffer to the descriptor. */
\r
494 RX_DESC_PACKET( EMAC->RxConsumeIndex ) = ( unsigned long ) prvGetNextBuffer();
\r
496 /* Move the consume index onto the next position, ensuring it wraps to
\r
497 the beginning at the appropriate place. */
\r
498 lIndex = EMAC->RxConsumeIndex;
\r
501 if( lIndex >= NUM_RX_FRAG )
\r
506 EMAC->RxConsumeIndex = lIndex;
\r
511 /*-----------------------------------------------------------*/
\r
513 void vSendEMACTxData( unsigned short usTxDataLen )
\r
515 unsigned long ulAttempts = 0UL;
\r
517 /* Check to see if the Tx descriptor is free, indicated by its buffer being
\r
519 while( TX_DESC_PACKET( emacTX_DESC_INDEX ) != ( unsigned long ) NULL )
\r
521 /* Wait for the Tx descriptor to become available. */
\r
522 vTaskDelay( emacBUFFER_WAIT_DELAY );
\r
525 if( ulAttempts > emacBUFFER_WAIT_ATTEMPTS )
\r
527 /* Something has gone wrong as the Tx descriptor is still in use.
\r
528 Clear it down manually, the data it was sending will probably be
\r
530 prvReturnBuffer( ( unsigned char * ) TX_DESC_PACKET( emacTX_DESC_INDEX ) );
\r
535 /* Setup the Tx descriptor for transmission. Remember the length of the
\r
536 data being sent so the second descriptor can be used to send it again from
\r
538 usSendLen = usTxDataLen;
\r
539 TX_DESC_PACKET( emacTX_DESC_INDEX ) = ( unsigned long ) uip_buf;
\r
540 TX_DESC_CTRL( emacTX_DESC_INDEX ) = ( usTxDataLen | TCTRL_LAST | TCTRL_INT );
\r
541 EMAC->TxProduceIndex = ( emacTX_DESC_INDEX + 1 );
\r
543 /* uip_buf is being sent by the Tx descriptor. Allocate a new buffer. */
\r
544 uip_buf = prvGetNextBuffer();
\r
546 /*-----------------------------------------------------------*/
\r
548 static long prvWritePHY( long lPhyReg, long lValue )
\r
550 const long lMaxTime = 10;
\r
553 EMAC->MADR = KS8721_DEF_ADR | lPhyReg;
\r
554 EMAC->MWTD = lValue;
\r
557 for( x = 0; x < lMaxTime; x++ )
\r
559 if( ( EMAC->MIND & MIND_BUSY ) == 0 )
\r
561 /* Operation has finished. */
\r
565 vTaskDelay( emacSHORT_DELAY );
\r
577 /*-----------------------------------------------------------*/
\r
579 static unsigned short prvReadPHY( unsigned char ucPhyReg, long *plStatus )
\r
582 const long lMaxTime = 10;
\r
584 EMAC->MADR = KS8721_DEF_ADR | ucPhyReg;
\r
585 EMAC->MCMD = MCMD_READ;
\r
587 for( x = 0; x < lMaxTime; x++ )
\r
589 /* Operation has finished. */
\r
590 if( ( EMAC->MIND & MIND_BUSY ) == 0 )
\r
595 vTaskDelay( emacSHORT_DELAY );
\r
600 if( x >= lMaxTime )
\r
602 *plStatus = pdFAIL;
\r
605 return( EMAC->MRDD );
\r
607 /*-----------------------------------------------------------*/
\r
609 void vEMAC_ISR( void )
\r
611 unsigned long ulStatus;
\r
612 long lHigherPriorityTaskWoken = pdFALSE;
\r
614 ulStatus = EMAC->IntStatus;
\r
616 /* Clear the interrupt. */
\r
617 EMAC->IntClear = ulStatus;
\r
619 if( ulStatus & INT_RX_DONE )
\r
621 /* Ensure the uIP task is not blocked as data has arrived. */
\r
622 xSemaphoreGiveFromISR( xEMACSemaphore, &lHigherPriorityTaskWoken );
\r
625 if( ulStatus & INT_TX_DONE )
\r
627 if( usSendLen > 0 )
\r
629 /* Send the data again, using the second descriptor. As there are
\r
630 only two descriptors the index is set back to 0. */
\r
631 TX_DESC_PACKET( ( emacTX_DESC_INDEX + 1 ) ) = TX_DESC_PACKET( emacTX_DESC_INDEX );
\r
632 TX_DESC_CTRL( ( emacTX_DESC_INDEX + 1 ) ) = ( usSendLen | TCTRL_LAST | TCTRL_INT );
\r
633 EMAC->TxProduceIndex = ( emacTX_DESC_INDEX );
\r
635 /* This is the second Tx so set usSendLen to 0 to indicate that the
\r
636 Tx descriptors will be free again. */
\r
641 /* The Tx buffer is no longer required. */
\r
642 prvReturnBuffer( ( unsigned char * ) TX_DESC_PACKET( emacTX_DESC_INDEX ) );
\r
643 TX_DESC_PACKET( emacTX_DESC_INDEX ) = ( unsigned long ) NULL;
\r
647 portEND_SWITCHING_ISR( lHigherPriorityTaskWoken );
\r