2 FreeRTOS.org V5.4.0 - Copyright (C) 2003-2009 Richard Barry.
\r
4 This file is part of the FreeRTOS.org distribution.
\r
6 FreeRTOS.org is free software; you can redistribute it and/or modify it
\r
7 under the terms of the GNU General Public License (version 2) as published
\r
8 by the Free Software Foundation and modified by the FreeRTOS exception.
\r
9 **NOTE** The exception to the GPL is included to allow you to distribute a
\r
10 combined work that includes FreeRTOS.org without being obliged to provide
\r
11 the source code for any proprietary components. Alternative commercial
\r
12 license and support terms are also available upon request. See the
\r
13 licensing section of http://www.FreeRTOS.org for full details.
\r
15 FreeRTOS.org is distributed in the hope that it will be useful, but WITHOUT
\r
16 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
\r
17 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
\r
20 You should have received a copy of the GNU General Public License along
\r
21 with FreeRTOS.org; if not, write to the Free Software Foundation, Inc., 59
\r
22 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
\r
25 ***************************************************************************
\r
27 * Get the FreeRTOS eBook! See http://www.FreeRTOS.org/Documentation *
\r
29 * This is a concise, step by step, 'hands on' guide that describes both *
\r
30 * general multitasking concepts and FreeRTOS specifics. It presents and *
\r
31 * explains numerous examples that are written using the FreeRTOS API. *
\r
32 * Full source code for all the examples is provided in an accompanying *
\r
35 ***************************************************************************
\r
39 Please ensure to read the configuration and relevant port sections of the
\r
40 online documentation.
\r
42 http://www.FreeRTOS.org - Documentation, latest information, license and
\r
45 http://www.SafeRTOS.com - A version that is certified for use in safety
\r
48 http://www.OpenRTOS.com - Commercial support, development, porting,
\r
49 licensing and training services.
\r
52 /* Originally adapted from file written by Andreas Dannenberg. Supplied with permission. */
\r
54 /* Kernel includes. */
\r
55 #include "FreeRTOS.h"
\r
59 /* Hardware specific includes. */
\r
60 #include "EthDev_LPC17xx.h"
\r
62 /* Time to wait between each inspection of the link status. */
\r
63 #define emacWAIT_FOR_LINK_TO_ESTABLISH ( 500 / portTICK_RATE_MS )
\r
65 /* Short delay used in several places during the initialisation process. */
\r
66 #define emacSHORT_DELAY ( 2 )
\r
68 /* Hardware specific bit definitions. */
\r
69 #define emacLINK_ESTABLISHED ( 0x0001 )
\r
70 #define emacFULL_DUPLEX_ENABLED ( 0x0004 )
\r
71 #define emac10BASE_T_MODE ( 0x0002 )
\r
72 #define emacPINSEL2_VALUE 0x50150105
\r
74 /* If no buffers are available, then wait this long before looking again.... */
\r
75 #define emacBUFFER_WAIT_DELAY ( 3 / portTICK_RATE_MS )
\r
77 /* ...and don't look more than this many times. */
\r
78 #define emacBUFFER_WAIT_ATTEMPTS ( 30 )
\r
80 /* Index to the Tx descriptor that is always used first for every Tx. The second
\r
81 descriptor is then used to re-send in order to speed up the uIP Tx process. */
\r
82 #define emacTX_DESC_INDEX ( 0 )
\r
84 /*-----------------------------------------------------------*/
\r
87 * Configure both the Rx and Tx descriptors during the init process.
\r
89 static void prvInitDescriptors( void );
\r
92 * Setup the IO and peripherals required for Ethernet communication.
\r
94 static void prvSetupEMACHardware( void );
\r
97 * Control the auto negotiate process.
\r
99 static void prvConfigurePHY( void );
\r
102 * Wait for a link to be established, then setup the PHY according to the link
\r
105 static long prvSetupLinkStatus( void );
\r
108 * Search the pool of buffers to find one that is free. If a buffer is found
\r
109 * mark it as in use before returning its address.
\r
111 static unsigned char *prvGetNextBuffer( void );
\r
114 * Return an allocated buffer to the pool of free buffers.
\r
116 static void prvReturnBuffer( unsigned char *pucBuffer );
\r
119 * Send lValue to the lPhyReg within the PHY.
\r
121 static long prvWritePHY( long lPhyReg, long lValue );
\r
124 * Read a value from ucPhyReg within the PHY. *plStatus will be set to
\r
125 * pdFALSE if there is an error.
\r
127 static unsigned short prvReadPHY( unsigned char ucPhyReg, long *plStatus );
\r
129 /*-----------------------------------------------------------*/
\r
131 /* The semaphore used to wake the uIP task when data arrives. */
\r
132 extern xSemaphoreHandle xEMACSemaphore;
\r
134 /* Each ucBufferInUse index corresponds to a position in the pool of buffers.
\r
135 If the index contains a 1 then the buffer within pool is in use, if it
\r
136 contains a 0 then the buffer is free. */
\r
137 static unsigned char ucBufferInUse[ ETH_NUM_BUFFERS ] = { pdFALSE };
\r
139 /* The uip_buffer is not a fixed array, but instead gets pointed to the buffers
\r
140 allocated within this file. */
\r
141 unsigned char * uip_buf;
\r
143 /* Store the length of the data being sent so the data can be sent twice. The
\r
144 value will be set back to 0 once the data has been sent twice. */
\r
145 static unsigned short usSendLen = 0;
\r
147 /*-----------------------------------------------------------*/
\r
149 long lEMACInit( void )
\r
151 long lReturn = pdPASS;
\r
152 unsigned long ulID1, ulID2;
\r
154 /* Reset peripherals, configure port pins and registers. */
\r
155 prvSetupEMACHardware();
\r
157 /* Check the PHY part number is as expected. */
\r
158 ulID1 = prvReadPHY( PHY_REG_IDR1, &lReturn );
\r
159 ulID2 = prvReadPHY( PHY_REG_IDR2, &lReturn );
\r
160 if( ( (ulID1 << 16UL ) | ( ulID2 & 0xFFF0UL ) ) == DP83848C_ID )
\r
162 /* Set the Ethernet MAC Address registers */
\r
163 EMAC->SA0 = ( configMAC_ADDR0 << 8 ) | configMAC_ADDR1;
\r
164 EMAC->SA1 = ( configMAC_ADDR2 << 8 ) | configMAC_ADDR3;
\r
165 EMAC->SA2 = ( configMAC_ADDR4 << 8 ) | configMAC_ADDR5;
\r
167 /* Initialize Tx and Rx DMA Descriptors */
\r
168 prvInitDescriptors();
\r
170 /* Receive broadcast and perfect match packets */
\r
171 EMAC->RxFilterCtrl = RFC_UCAST_EN | RFC_BCAST_EN | RFC_PERFECT_EN;
\r
173 /* Setup the PHY. */
\r
181 /* Check the link status. */
\r
182 if( lReturn == pdPASS )
\r
184 lReturn = prvSetupLinkStatus();
\r
187 if( lReturn == pdPASS )
\r
189 /* Initialise uip_buf to ensure it points somewhere valid. */
\r
190 uip_buf = prvGetNextBuffer();
\r
192 /* Reset all interrupts */
\r
193 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
195 /* Enable receive and transmit mode of MAC Ethernet core */
\r
196 EMAC->Command |= ( CR_RX_EN | CR_TX_EN );
\r
197 EMAC->MAC1 |= MAC1_REC_EN;
\r
202 /*-----------------------------------------------------------*/
\r
204 static unsigned char *prvGetNextBuffer( void )
\r
207 unsigned char *pucReturn = NULL;
\r
208 unsigned long ulAttempts = 0;
\r
210 while( pucReturn == NULL )
\r
212 /* Look through the buffers to find one that is not in use by
\r
214 for( x = 0; x < ETH_NUM_BUFFERS; x++ )
\r
216 if( ucBufferInUse[ x ] == pdFALSE )
\r
218 ucBufferInUse[ x ] = pdTRUE;
\r
219 pucReturn = ( unsigned char * ) ETH_BUF( x );
\r
224 /* Was a buffer found? */
\r
225 if( pucReturn == NULL )
\r
229 if( ulAttempts >= emacBUFFER_WAIT_ATTEMPTS )
\r
234 /* Wait then look again. */
\r
235 vTaskDelay( emacBUFFER_WAIT_DELAY );
\r
241 /*-----------------------------------------------------------*/
\r
243 static void prvInitDescriptors( void )
\r
245 long x, lNextBuffer = 0;
\r
247 for( x = 0; x < NUM_RX_FRAG; x++ )
\r
249 /* Allocate the next Ethernet buffer to this descriptor. */
\r
250 RX_DESC_PACKET( x ) = ETH_BUF( lNextBuffer );
\r
251 RX_DESC_CTRL( x ) = RCTRL_INT | ( ETH_FRAG_SIZE - 1 );
\r
252 RX_STAT_INFO( x ) = 0;
\r
253 RX_STAT_HASHCRC( x ) = 0;
\r
255 /* The Ethernet buffer is now in use. */
\r
256 ucBufferInUse[ lNextBuffer ] = pdTRUE;
\r
260 /* Set EMAC Receive Descriptor Registers. */
\r
261 EMAC->RxDescriptor = RX_DESC_BASE;
\r
262 EMAC->RxStatus = RX_STAT_BASE;
\r
263 EMAC->RxDescriptorNumber = NUM_RX_FRAG - 1;
\r
265 /* Rx Descriptors Point to 0 */
\r
266 EMAC->RxConsumeIndex = 0;
\r
268 /* A buffer is not allocated to the Tx descriptors until they are actually
\r
270 for( x = 0; x < NUM_TX_FRAG; x++ )
\r
272 TX_DESC_PACKET( x ) = NULL;
\r
273 TX_DESC_CTRL( x ) = 0;
\r
274 TX_STAT_INFO( x ) = 0;
\r
277 /* Set EMAC Transmit Descriptor Registers. */
\r
278 EMAC->TxDescriptor = TX_DESC_BASE;
\r
279 EMAC->TxStatus = TX_STAT_BASE;
\r
280 EMAC->TxDescriptorNumber = NUM_TX_FRAG - 1;
\r
282 /* Tx Descriptors Point to 0 */
\r
283 EMAC->TxProduceIndex = 0;
\r
285 /*-----------------------------------------------------------*/
\r
287 static void prvSetupEMACHardware( void )
\r
292 /* Enable P1 Ethernet Pins. */
\r
293 PINCON->PINSEL2 = emacPINSEL2_VALUE;
\r
294 PINCON->PINSEL3 = ( PINCON->PINSEL3 & ~0x0000000F ) | 0x00000005;
\r
296 /* Power Up the EMAC controller. */
\r
297 SC->PCONP |= PCONP_PCENET;
\r
298 vTaskDelay( emacSHORT_DELAY );
\r
300 /* Reset all EMAC internal modules. */
\r
301 EMAC->MAC1 = MAC1_RES_TX | MAC1_RES_MCS_TX | MAC1_RES_RX | MAC1_RES_MCS_RX | MAC1_SIM_RES | MAC1_SOFT_RES;
\r
302 EMAC->Command = CR_REG_RES | CR_TX_RES | CR_RX_RES | CR_PASS_RUNT_FRM;
\r
304 /* A short delay after reset. */
\r
305 vTaskDelay( emacSHORT_DELAY );
\r
307 /* Initialize MAC control registers. */
\r
308 EMAC->MAC1 = MAC1_PASS_ALL;
\r
309 EMAC->MAC2 = MAC2_CRC_EN | MAC2_PAD_EN;
\r
310 EMAC->MAXF = ETH_MAX_FLEN;
\r
311 EMAC->CLRT = CLRT_DEF;
\r
312 EMAC->IPGR = IPGR_DEF;
\r
314 /* Enable Reduced MII interface. */
\r
315 EMAC->Command = CR_RMII | CR_PASS_RUNT_FRM;
\r
317 /* Reset Reduced MII Logic. */
\r
318 EMAC->SUPP = SUPP_RES_RMII;
\r
319 vTaskDelay( emacSHORT_DELAY );
\r
322 /* Put the PHY in reset mode */
\r
323 prvWritePHY( PHY_REG_BMCR, MCFG_RES_MII );
\r
324 prvWritePHY( PHY_REG_BMCR, MCFG_RES_MII );
\r
326 /* Wait for hardware reset to end. */
\r
327 for( x = 0; x < 100; x++ )
\r
329 vTaskDelay( emacSHORT_DELAY * 5 );
\r
330 us = prvReadPHY( PHY_REG_BMCR, &lDummy );
\r
331 if( !( us & MCFG_RES_MII ) )
\r
333 /* Reset complete */
\r
338 /*-----------------------------------------------------------*/
\r
340 static void prvConfigurePHY( void )
\r
345 /* Auto negotiate the configuration. */
\r
346 if( prvWritePHY( PHY_REG_BMCR, PHY_AUTO_NEG ) )
\r
348 vTaskDelay( emacSHORT_DELAY * 5 );
\r
350 for( x = 0; x < 10; x++ )
\r
352 us = prvReadPHY( PHY_REG_BMSR, &lDummy );
\r
354 if( us & PHY_AUTO_NEG_COMPLETE )
\r
359 vTaskDelay( emacWAIT_FOR_LINK_TO_ESTABLISH );
\r
363 /*-----------------------------------------------------------*/
\r
365 static long prvSetupLinkStatus( void )
\r
367 long lReturn = pdFAIL, x;
\r
368 unsigned short usLinkStatus;
\r
370 /* Wait with timeout for the link to be established. */
\r
371 for( x = 0; x < 10; x++ )
\r
373 usLinkStatus = prvReadPHY( PHY_REG_STS, &lReturn );
\r
374 if( usLinkStatus & emacLINK_ESTABLISHED )
\r
376 /* Link is established. */
\r
381 vTaskDelay( emacWAIT_FOR_LINK_TO_ESTABLISH );
\r
384 if( lReturn == pdPASS )
\r
386 /* Configure Full/Half Duplex mode. */
\r
387 if( usLinkStatus & emacFULL_DUPLEX_ENABLED )
\r
389 /* Full duplex is enabled. */
\r
390 EMAC->MAC2 |= MAC2_FULL_DUP;
\r
391 EMAC->Command |= CR_FULL_DUP;
\r
392 EMAC->IPGT = IPGT_FULL_DUP;
\r
396 /* Half duplex mode. */
\r
397 EMAC->IPGT = IPGT_HALF_DUP;
\r
400 /* Configure 100MBit/10MBit mode. */
\r
401 if( usLinkStatus & emac10BASE_T_MODE )
\r
408 /* 100MBit mode. */
\r
409 EMAC->SUPP = SUPP_SPEED;
\r
415 /*-----------------------------------------------------------*/
\r
417 static void prvReturnBuffer( unsigned char *pucBuffer )
\r
421 /* Mark a buffer as free for use. */
\r
422 for( ul = 0; ul < ETH_NUM_BUFFERS; ul++ )
\r
424 if( ETH_BUF( ul ) == ( unsigned long ) pucBuffer )
\r
426 ucBufferInUse[ ul ] = pdFALSE;
\r
431 /*-----------------------------------------------------------*/
\r
433 unsigned long ulGetEMACRxData( void )
\r
435 unsigned long ulLen = 0;
\r
438 if( EMAC->RxProduceIndex != EMAC->RxConsumeIndex )
\r
440 /* Mark the current buffer as free as uip_buf is going to be set to
\r
441 the buffer that contains the received data. */
\r
442 prvReturnBuffer( uip_buf );
\r
444 ulLen = ( RX_STAT_INFO( EMAC->RxConsumeIndex ) & RINFO_SIZE ) - 3;
\r
445 uip_buf = ( unsigned char * ) RX_DESC_PACKET( EMAC->RxConsumeIndex );
\r
447 /* Allocate a new buffer to the descriptor. */
\r
448 RX_DESC_PACKET( EMAC->RxConsumeIndex ) = ( unsigned long ) prvGetNextBuffer();
\r
450 /* Move the consume index onto the next position, ensuring it wraps to
\r
451 the beginning at the appropriate place. */
\r
452 lIndex = EMAC->RxConsumeIndex;
\r
455 if( lIndex >= NUM_RX_FRAG )
\r
460 EMAC->RxConsumeIndex = lIndex;
\r
465 /*-----------------------------------------------------------*/
\r
467 void vSendEMACTxData( unsigned short usTxDataLen )
\r
469 unsigned long ulAttempts = 0UL;
\r
471 /* Check to see if the Tx descriptor is free, indicated by its buffer being
\r
473 while( TX_DESC_PACKET( emacTX_DESC_INDEX ) != NULL )
\r
475 /* Wait for the Tx descriptor to become available. */
\r
476 vTaskDelay( emacBUFFER_WAIT_DELAY );
\r
479 if( ulAttempts > emacBUFFER_WAIT_ATTEMPTS )
\r
481 /* Something has gone wrong as the Tx descriptor is still in use.
\r
482 Clear it down manually, the data it was sending will probably be
\r
484 prvReturnBuffer( ( unsigned char * ) TX_DESC_PACKET( emacTX_DESC_INDEX ) );
\r
489 /* Setup the Tx descriptor for transmission. Remember the length of the
\r
490 data being sent so the second descriptor can be used to send it again from
\r
492 usSendLen = usTxDataLen;
\r
493 TX_DESC_PACKET( emacTX_DESC_INDEX ) = ( unsigned long ) uip_buf;
\r
494 TX_DESC_CTRL( emacTX_DESC_INDEX ) = ( usTxDataLen | TCTRL_LAST | TCTRL_INT );
\r
495 EMAC->TxProduceIndex = ( emacTX_DESC_INDEX + 1 );
\r
497 /* uip_buf is being sent by the Tx descriptor. Allocate a new buffer. */
\r
498 uip_buf = prvGetNextBuffer();
\r
500 /*-----------------------------------------------------------*/
\r
502 static long prvWritePHY( long lPhyReg, long lValue )
\r
504 const long lMaxTime = 10;
\r
507 EMAC->MADR = DP83848C_DEF_ADR | lPhyReg;
\r
508 EMAC->MWTD = lValue;
\r
511 for( x = 0; x < lMaxTime; x++ )
\r
513 if( ( EMAC->MIND & MIND_BUSY ) == 0 )
\r
515 /* Operation has finished. */
\r
519 vTaskDelay( emacSHORT_DELAY );
\r
531 /*-----------------------------------------------------------*/
\r
533 static unsigned short prvReadPHY( unsigned char ucPhyReg, long *plStatus )
\r
536 const long lMaxTime = 10;
\r
538 EMAC->MADR = DP83848C_DEF_ADR | ucPhyReg;
\r
539 EMAC->MCMD = MCMD_READ;
\r
541 for( x = 0; x < lMaxTime; x++ )
\r
543 /* Operation has finished. */
\r
544 if( ( EMAC->MIND & MIND_BUSY ) == 0 )
\r
549 vTaskDelay( emacSHORT_DELAY );
\r
554 if( x >= lMaxTime )
\r
556 *plStatus = pdFAIL;
\r
559 return( EMAC->MRDD );
\r
561 /*-----------------------------------------------------------*/
\r
563 void vEMAC_ISR( void )
\r
565 unsigned long ulStatus;
\r
566 long lHigherPriorityTaskWoken = pdFALSE;
\r
568 ulStatus = EMAC->IntStatus;
\r
570 /* Clear the interrupt. */
\r
571 EMAC->IntClear = ulStatus;
\r
573 if( ulStatus & INT_RX_DONE )
\r
575 /* Ensure the uIP task is not blocked as data has arrived. */
\r
576 xSemaphoreGiveFromISR( xEMACSemaphore, &lHigherPriorityTaskWoken );
\r
579 if( ulStatus & INT_TX_DONE )
\r
581 if( usSendLen > 0 )
\r
583 /* Send the data again, using the second descriptor. As there are
\r
584 only two descriptors the index is set back to 0. */
\r
585 TX_DESC_PACKET( ( emacTX_DESC_INDEX + 1 ) ) = TX_DESC_PACKET( emacTX_DESC_INDEX );
\r
586 TX_DESC_CTRL( ( emacTX_DESC_INDEX + 1 ) ) = ( usSendLen | TCTRL_LAST | TCTRL_INT );
\r
587 EMAC->TxProduceIndex = ( emacTX_DESC_INDEX );
\r
589 /* This is the second Tx so set usSendLen to 0 to indicate that the
\r
590 Tx descriptors will be free again. */
\r
595 /* The Tx buffer is no longer required. */
\r
596 prvReturnBuffer( ( unsigned char * ) TX_DESC_PACKET( emacTX_DESC_INDEX ) );
\r
597 TX_DESC_PACKET( emacTX_DESC_INDEX ) = NULL;
\r
601 portEND_SWITCHING_ISR( lHigherPriorityTaskWoken );
\r