2 FreeRTOS V8.0.0:rc1 - Copyright (C) 2014 Real Time Engineers Ltd.
\r
5 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 ***************************************************************************
\r
9 * FreeRTOS provides completely free yet professionally developed, *
\r
10 * robust, strictly quality controlled, supported, and cross *
\r
11 * platform software that has become a de facto standard. *
\r
13 * Help yourself get started quickly and support the FreeRTOS *
\r
14 * project by purchasing a FreeRTOS tutorial book, reference *
\r
15 * manual, or both from: http://www.FreeRTOS.org/Documentation *
\r
19 ***************************************************************************
\r
21 This file is part of the FreeRTOS distribution.
\r
23 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
24 the terms of the GNU General Public License (version 2) as published by the
\r
25 Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.
\r
27 >>! NOTE: The modification to the GPL is included to allow you to distribute
\r
28 >>! a combined work that includes FreeRTOS without being obliged to provide
\r
29 >>! the source code for proprietary components outside of the FreeRTOS
\r
32 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
33 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
34 FOR A PARTICULAR PURPOSE. Full license text is available from the following
\r
35 link: http://www.freertos.org/a00114.html
\r
39 ***************************************************************************
\r
41 * Having a problem? Start by reading the FAQ "My application does *
\r
42 * not run, what could be wrong?" *
\r
44 * http://www.FreeRTOS.org/FAQHelp.html *
\r
46 ***************************************************************************
\r
48 http://www.FreeRTOS.org - Documentation, books, training, latest versions,
\r
49 license and Real Time Engineers Ltd. contact details.
\r
51 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
52 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
53 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
55 http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High
\r
56 Integrity Systems to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
57 licenses offer ticketed support, indemnification and middleware.
\r
59 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
60 engineered and independently SIL3 certified version for use in safety and
\r
61 mission critical applications that require provable dependability.
\r
66 /* Originally adapted from file written by Andreas Dannenberg. Supplied with permission. */
\r
68 /* Kernel includes. */
\r
69 #include "FreeRTOS.h"
\r
73 /* Hardware specific includes. */
\r
74 #include "EthDev_LPC17xx.h"
\r
76 /* Time to wait between each inspection of the link status. */
\r
77 #define emacWAIT_FOR_LINK_TO_ESTABLISH ( 500 / portTICK_PERIOD_MS )
\r
79 /* Short delay used in several places during the initialisation process. */
\r
80 #define emacSHORT_DELAY ( 2 )
\r
82 /* Hardware specific bit definitions. */
\r
83 #define emacLINK_ESTABLISHED ( 0x0020)
\r
84 #define emacFULL_DUPLEX_ENABLED ( 0x0010 )
\r
85 #define emac10BASE_T_MODE ( 0x0004 )
\r
86 #define emacPINSEL2_VALUE ( 0x50150105 )
\r
87 #define emacDIV_44 ( 0x28 )
\r
89 /* If no buffers are available, then wait this long before looking again.... */
\r
90 #define emacBUFFER_WAIT_DELAY ( 3 / portTICK_PERIOD_MS )
\r
92 /* ...and don't look more than this many times. */
\r
93 #define emacBUFFER_WAIT_ATTEMPTS ( 30 )
\r
95 /* Index to the Tx descriptor that is always used first for every Tx. The second
\r
96 descriptor is then used to re-send in order to speed up the uIP Tx process. */
\r
97 #define emacTX_DESC_INDEX ( 0 )
\r
99 /*-----------------------------------------------------------*/
\r
102 * Configure both the Rx and Tx descriptors during the init process.
\r
104 static void prvInitDescriptors( void );
\r
107 * Setup the IO and peripherals required for Ethernet communication.
\r
109 static void prvSetupEMACHardware( void );
\r
112 * Control the auto negotiate process.
\r
114 static void prvConfigurePHY( void );
\r
117 * Wait for a link to be established, then setup the PHY according to the link
\r
120 static long prvSetupLinkStatus( void );
\r
123 * Search the pool of buffers to find one that is free. If a buffer is found
\r
124 * mark it as in use before returning its address.
\r
126 static unsigned char *prvGetNextBuffer( void );
\r
129 * Return an allocated buffer to the pool of free buffers.
\r
131 static void prvReturnBuffer( unsigned char *pucBuffer );
\r
134 * Send lValue to the lPhyReg within the PHY.
\r
136 static long prvWritePHY( long lPhyReg, long lValue );
\r
139 * Read a value from ucPhyReg within the PHY. *plStatus will be set to
\r
140 * pdFALSE if there is an error.
\r
142 static unsigned short prvReadPHY( unsigned char ucPhyReg, long *plStatus );
\r
144 /*-----------------------------------------------------------*/
\r
146 /* The semaphore used to wake the uIP task when data arrives. */
\r
147 extern SemaphoreHandle_t xEMACSemaphore;
\r
149 /* Each ucBufferInUse index corresponds to a position in the pool of buffers.
\r
150 If the index contains a 1 then the buffer within pool is in use, if it
\r
151 contains a 0 then the buffer is free. */
\r
152 static unsigned char ucBufferInUse[ ETH_NUM_BUFFERS ] = { pdFALSE };
\r
154 /* The uip_buffer is not a fixed array, but instead gets pointed to the buffers
\r
155 allocated within this file. */
\r
156 unsigned char * uip_buf;
\r
158 /* Store the length of the data being sent so the data can be sent twice. The
\r
159 value will be set back to 0 once the data has been sent twice. */
\r
160 static unsigned short usSendLen = 0;
\r
162 /*-----------------------------------------------------------*/
\r
164 long lEMACInit( void )
\r
166 long lReturn = pdPASS;
\r
167 unsigned long ulID1, ulID2;
\r
169 /* Reset peripherals, configure port pins and registers. */
\r
170 prvSetupEMACHardware();
\r
172 /* Check the PHY part number is as expected. */
\r
173 ulID1 = prvReadPHY( PHY_REG_IDR1, &lReturn );
\r
174 ulID2 = prvReadPHY( PHY_REG_IDR2, &lReturn );
\r
175 if( ( (ulID1 << 16UL ) | ( ulID2 & 0xFFFFUL ) ) == KS8721_ID )
\r
177 /* Set the Ethernet MAC Address registers */
\r
178 EMAC->SA0 = ( configMAC_ADDR0 << 8 ) | configMAC_ADDR1;
\r
179 EMAC->SA1 = ( configMAC_ADDR2 << 8 ) | configMAC_ADDR3;
\r
180 EMAC->SA2 = ( configMAC_ADDR4 << 8 ) | configMAC_ADDR5;
\r
182 /* Initialize Tx and Rx DMA Descriptors */
\r
183 prvInitDescriptors();
\r
185 /* Receive broadcast and perfect match packets */
\r
186 EMAC->RxFilterCtrl = RFC_UCAST_EN | RFC_BCAST_EN | RFC_PERFECT_EN;
\r
188 /* Setup the PHY. */
\r
196 /* Check the link status. */
\r
197 if( lReturn == pdPASS )
\r
199 lReturn = prvSetupLinkStatus();
\r
202 if( lReturn == pdPASS )
\r
204 /* Initialise uip_buf to ensure it points somewhere valid. */
\r
205 uip_buf = prvGetNextBuffer();
\r
207 /* Reset all interrupts */
\r
208 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
210 /* Enable receive and transmit mode of MAC Ethernet core */
\r
211 EMAC->Command |= ( CR_RX_EN | CR_TX_EN );
\r
212 EMAC->MAC1 |= MAC1_REC_EN;
\r
217 /*-----------------------------------------------------------*/
\r
219 static unsigned char *prvGetNextBuffer( void )
\r
222 unsigned char *pucReturn = NULL;
\r
223 unsigned long ulAttempts = 0;
\r
225 while( pucReturn == NULL )
\r
227 /* Look through the buffers to find one that is not in use by
\r
229 for( x = 0; x < ETH_NUM_BUFFERS; x++ )
\r
231 if( ucBufferInUse[ x ] == pdFALSE )
\r
233 ucBufferInUse[ x ] = pdTRUE;
\r
234 pucReturn = ( unsigned char * ) ETH_BUF( x );
\r
239 /* Was a buffer found? */
\r
240 if( pucReturn == NULL )
\r
244 if( ulAttempts >= emacBUFFER_WAIT_ATTEMPTS )
\r
249 /* Wait then look again. */
\r
250 vTaskDelay( emacBUFFER_WAIT_DELAY );
\r
256 /*-----------------------------------------------------------*/
\r
258 static void prvInitDescriptors( void )
\r
260 long x, lNextBuffer = 0;
\r
262 for( x = 0; x < NUM_RX_FRAG; x++ )
\r
264 /* Allocate the next Ethernet buffer to this descriptor. */
\r
265 RX_DESC_PACKET( x ) = ETH_BUF( lNextBuffer );
\r
266 RX_DESC_CTRL( x ) = RCTRL_INT | ( ETH_FRAG_SIZE - 1 );
\r
267 RX_STAT_INFO( x ) = 0;
\r
268 RX_STAT_HASHCRC( x ) = 0;
\r
270 /* The Ethernet buffer is now in use. */
\r
271 ucBufferInUse[ lNextBuffer ] = pdTRUE;
\r
275 /* Set EMAC Receive Descriptor Registers. */
\r
276 EMAC->RxDescriptor = RX_DESC_BASE;
\r
277 EMAC->RxStatus = RX_STAT_BASE;
\r
278 EMAC->RxDescriptorNumber = NUM_RX_FRAG - 1;
\r
280 /* Rx Descriptors Point to 0 */
\r
281 EMAC->RxConsumeIndex = 0;
\r
283 /* A buffer is not allocated to the Tx descriptors until they are actually
\r
285 for( x = 0; x < NUM_TX_FRAG; x++ )
\r
287 TX_DESC_PACKET( x ) = ( unsigned long ) NULL;
\r
288 TX_DESC_CTRL( x ) = 0;
\r
289 TX_STAT_INFO( x ) = 0;
\r
292 /* Set EMAC Transmit Descriptor Registers. */
\r
293 EMAC->TxDescriptor = TX_DESC_BASE;
\r
294 EMAC->TxStatus = TX_STAT_BASE;
\r
295 EMAC->TxDescriptorNumber = NUM_TX_FRAG - 1;
\r
297 /* Tx Descriptors Point to 0 */
\r
298 EMAC->TxProduceIndex = 0;
\r
300 /*-----------------------------------------------------------*/
\r
302 static void prvSetupEMACHardware( void )
\r
307 /* Enable P1 Ethernet Pins. */
\r
308 PINCON->PINSEL2 = emacPINSEL2_VALUE;
\r
309 PINCON->PINSEL3 = ( PINCON->PINSEL3 & ~0x0000000F ) | 0x00000005;
\r
311 /* Power Up the EMAC controller. */
\r
312 SC->PCONP |= PCONP_PCENET;
\r
313 vTaskDelay( emacSHORT_DELAY );
\r
315 /* Reset all EMAC internal modules. */
\r
316 EMAC->MAC1 = MAC1_RES_TX | MAC1_RES_MCS_TX | MAC1_RES_RX | MAC1_RES_MCS_RX | MAC1_SIM_RES | MAC1_SOFT_RES;
\r
317 EMAC->Command = CR_REG_RES | CR_TX_RES | CR_RX_RES | CR_PASS_RUNT_FRM;
\r
319 /* A short delay after reset. */
\r
320 vTaskDelay( emacSHORT_DELAY );
\r
322 /* Initialize MAC control registers. */
\r
323 EMAC->MAC1 = MAC1_PASS_ALL;
\r
324 EMAC->MAC2 = MAC2_CRC_EN | MAC2_PAD_EN;
\r
325 EMAC->MAXF = ETH_MAX_FLEN;
\r
326 EMAC->CLRT = CLRT_DEF;
\r
327 EMAC->IPGR = IPGR_DEF;
\r
328 EMAC->MCFG = emacDIV_44;
\r
330 /* Enable Reduced MII interface. */
\r
331 EMAC->Command = CR_RMII | CR_PASS_RUNT_FRM;
\r
333 /* Reset Reduced MII Logic. */
\r
334 EMAC->SUPP = SUPP_RES_RMII;
\r
335 vTaskDelay( emacSHORT_DELAY );
\r
338 /* Put the PHY in reset mode */
\r
339 prvWritePHY( PHY_REG_BMCR, MCFG_RES_MII );
\r
340 prvWritePHY( PHY_REG_BMCR, MCFG_RES_MII );
\r
342 /* Wait for hardware reset to end. */
\r
343 for( x = 0; x < 100; x++ )
\r
345 vTaskDelay( emacSHORT_DELAY * 5 );
\r
346 us = prvReadPHY( PHY_REG_BMCR, &lDummy );
\r
347 if( !( us & MCFG_RES_MII ) )
\r
349 /* Reset complete */
\r
354 /*-----------------------------------------------------------*/
\r
356 static void prvConfigurePHY( void )
\r
361 /* Auto negotiate the configuration. */
\r
362 if( prvWritePHY( PHY_REG_BMCR, PHY_AUTO_NEG ) )
\r
364 vTaskDelay( emacSHORT_DELAY * 5 );
\r
366 for( x = 0; x < 10; x++ )
\r
368 us = prvReadPHY( PHY_REG_BMSR, &lDummy );
\r
370 if( us & PHY_AUTO_NEG_COMPLETE )
\r
375 vTaskDelay( emacWAIT_FOR_LINK_TO_ESTABLISH );
\r
379 /*-----------------------------------------------------------*/
\r
381 static long prvSetupLinkStatus( void )
\r
383 long lReturn = pdFAIL, x;
\r
384 unsigned short usLinkStatus;
\r
386 /* Wait with timeout for the link to be established. */
\r
387 for( x = 0; x < 10; x++ )
\r
389 usLinkStatus = prvReadPHY( PHY_CTRLER, &lReturn );
\r
390 if( usLinkStatus != 0x00 )
\r
392 /* Link is established. */
\r
397 vTaskDelay( emacWAIT_FOR_LINK_TO_ESTABLISH );
\r
400 if( lReturn == pdPASS )
\r
402 /* Configure Full/Half Duplex mode. */
\r
403 if( usLinkStatus & emacFULL_DUPLEX_ENABLED )
\r
405 /* Full duplex is enabled. */
\r
406 EMAC->MAC2 |= MAC2_FULL_DUP;
\r
407 EMAC->Command |= CR_FULL_DUP;
\r
408 EMAC->IPGT = IPGT_FULL_DUP;
\r
412 /* Half duplex mode. */
\r
413 EMAC->IPGT = IPGT_HALF_DUP;
\r
416 /* Configure 100MBit/10MBit mode. */
\r
417 if( usLinkStatus & emac10BASE_T_MODE )
\r
424 /* 100MBit mode. */
\r
425 EMAC->SUPP = SUPP_SPEED;
\r
431 /*-----------------------------------------------------------*/
\r
433 static void prvReturnBuffer( unsigned char *pucBuffer )
\r
437 /* Return a buffer to the pool of free buffers. */
\r
438 for( ul = 0; ul < ETH_NUM_BUFFERS; ul++ )
\r
440 if( ETH_BUF( ul ) == ( unsigned long ) pucBuffer )
\r
442 ucBufferInUse[ ul ] = pdFALSE;
\r
447 /*-----------------------------------------------------------*/
\r
449 unsigned long ulGetEMACRxData( void )
\r
451 unsigned long ulLen = 0;
\r
454 if( EMAC->RxProduceIndex != EMAC->RxConsumeIndex )
\r
456 /* Mark the current buffer as free as uip_buf is going to be set to
\r
457 the buffer that contains the received data. */
\r
458 prvReturnBuffer( uip_buf );
\r
460 ulLen = ( RX_STAT_INFO( EMAC->RxConsumeIndex ) & RINFO_SIZE ) - 3;
\r
461 uip_buf = ( unsigned char * ) RX_DESC_PACKET( EMAC->RxConsumeIndex );
\r
463 /* Allocate a new buffer to the descriptor. */
\r
464 RX_DESC_PACKET( EMAC->RxConsumeIndex ) = ( unsigned long ) prvGetNextBuffer();
\r
466 /* Move the consume index onto the next position, ensuring it wraps to
\r
467 the beginning at the appropriate place. */
\r
468 lIndex = EMAC->RxConsumeIndex;
\r
471 if( lIndex >= NUM_RX_FRAG )
\r
476 EMAC->RxConsumeIndex = lIndex;
\r
481 /*-----------------------------------------------------------*/
\r
483 void vSendEMACTxData( unsigned short usTxDataLen )
\r
485 unsigned long ulAttempts = 0UL;
\r
487 /* Check to see if the Tx descriptor is free, indicated by its buffer being
\r
489 while( TX_DESC_PACKET( emacTX_DESC_INDEX ) != ( unsigned long ) NULL )
\r
491 /* Wait for the Tx descriptor to become available. */
\r
492 vTaskDelay( emacBUFFER_WAIT_DELAY );
\r
495 if( ulAttempts > emacBUFFER_WAIT_ATTEMPTS )
\r
497 /* Something has gone wrong as the Tx descriptor is still in use.
\r
498 Clear it down manually, the data it was sending will probably be
\r
500 prvReturnBuffer( ( unsigned char * ) TX_DESC_PACKET( emacTX_DESC_INDEX ) );
\r
505 /* Setup the Tx descriptor for transmission. Remember the length of the
\r
506 data being sent so the second descriptor can be used to send it again from
\r
508 usSendLen = usTxDataLen;
\r
509 TX_DESC_PACKET( emacTX_DESC_INDEX ) = ( unsigned long ) uip_buf;
\r
510 TX_DESC_CTRL( emacTX_DESC_INDEX ) = ( usTxDataLen | TCTRL_LAST | TCTRL_INT );
\r
511 EMAC->TxProduceIndex = ( emacTX_DESC_INDEX + 1 );
\r
513 /* uip_buf is being sent by the Tx descriptor. Allocate a new buffer. */
\r
514 uip_buf = prvGetNextBuffer();
\r
516 /*-----------------------------------------------------------*/
\r
518 static long prvWritePHY( long lPhyReg, long lValue )
\r
520 const long lMaxTime = 10;
\r
523 EMAC->MADR = KS8721_DEF_ADR | lPhyReg;
\r
524 EMAC->MWTD = lValue;
\r
527 for( x = 0; x < lMaxTime; x++ )
\r
529 if( ( EMAC->MIND & MIND_BUSY ) == 0 )
\r
531 /* Operation has finished. */
\r
535 vTaskDelay( emacSHORT_DELAY );
\r
547 /*-----------------------------------------------------------*/
\r
549 static unsigned short prvReadPHY( unsigned char ucPhyReg, long *plStatus )
\r
552 const long lMaxTime = 10;
\r
554 EMAC->MADR = KS8721_DEF_ADR | ucPhyReg;
\r
555 EMAC->MCMD = MCMD_READ;
\r
557 for( x = 0; x < lMaxTime; x++ )
\r
559 /* Operation has finished. */
\r
560 if( ( EMAC->MIND & MIND_BUSY ) == 0 )
\r
565 vTaskDelay( emacSHORT_DELAY );
\r
570 if( x >= lMaxTime )
\r
572 *plStatus = pdFAIL;
\r
575 return( EMAC->MRDD );
\r
577 /*-----------------------------------------------------------*/
\r
579 void vEMAC_ISR( void )
\r
581 unsigned long ulStatus;
\r
582 long lHigherPriorityTaskWoken = pdFALSE;
\r
584 ulStatus = EMAC->IntStatus;
\r
586 /* Clear the interrupt. */
\r
587 EMAC->IntClear = ulStatus;
\r
589 if( ulStatus & INT_RX_DONE )
\r
591 /* Ensure the uIP task is not blocked as data has arrived. */
\r
592 xSemaphoreGiveFromISR( xEMACSemaphore, &lHigherPriorityTaskWoken );
\r
595 if( ulStatus & INT_TX_DONE )
\r
597 if( usSendLen > 0 )
\r
599 /* Send the data again, using the second descriptor. As there are
\r
600 only two descriptors the index is set back to 0. */
\r
601 TX_DESC_PACKET( ( emacTX_DESC_INDEX + 1 ) ) = TX_DESC_PACKET( emacTX_DESC_INDEX );
\r
602 TX_DESC_CTRL( ( emacTX_DESC_INDEX + 1 ) ) = ( usSendLen | TCTRL_LAST | TCTRL_INT );
\r
603 EMAC->TxProduceIndex = ( emacTX_DESC_INDEX );
\r
605 /* This is the second Tx so set usSendLen to 0 to indicate that the
\r
606 Tx descriptors will be free again. */
\r
611 /* The Tx buffer is no longer required. */
\r
612 prvReturnBuffer( ( unsigned char * ) TX_DESC_PACKET( emacTX_DESC_INDEX ) );
\r
613 TX_DESC_PACKET( emacTX_DESC_INDEX ) = ( unsigned long ) NULL;
\r
617 portEND_SWITCHING_ISR( lHigherPriorityTaskWoken );
\r