2 FreeRTOS V7.0.0 - Copyright (C) 2011 Real Time Engineers Ltd.
\r
5 ***************************************************************************
\r
7 * FreeRTOS tutorial books are available in pdf and paperback. *
\r
8 * Complete, revised, and edited pdf reference manuals are also *
\r
11 * Purchasing FreeRTOS documentation will not only help you, by *
\r
12 * ensuring you get running as quickly as possible and with an *
\r
13 * in-depth knowledge of how to use FreeRTOS, it will also help *
\r
14 * the FreeRTOS project to continue with its mission of providing *
\r
15 * professional grade, cross platform, de facto standard solutions *
\r
16 * for microcontrollers - completely free of charge! *
\r
18 * >>> See http://www.FreeRTOS.org/Documentation for details. <<< *
\r
20 * Thank you for using FreeRTOS, and thank you for your support! *
\r
22 ***************************************************************************
\r
25 This file is part of the FreeRTOS distribution.
\r
27 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
28 the terms of the GNU General Public License (version 2) as published by the
\r
29 Free Software Foundation AND MODIFIED BY the FreeRTOS exception.
\r
30 >>>NOTE<<< The modification to the GPL is included to allow you to
\r
31 distribute a combined work that includes FreeRTOS without being obliged to
\r
32 provide the source code for proprietary components outside of the FreeRTOS
\r
33 kernel. FreeRTOS is distributed in the hope that it will be useful, but
\r
34 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
\r
35 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
\r
36 more details. You should have received a copy of the GNU General Public
\r
37 License and the FreeRTOS license exception along with FreeRTOS; if not it
\r
38 can be viewed here: http://www.freertos.org/a00114.html and also obtained
\r
39 by writing to Richard Barry, contact details for whom are available on the
\r
44 http://www.FreeRTOS.org - Documentation, latest information, license and
\r
47 http://www.SafeRTOS.com - A version that is certified for use in safety
\r
50 http://www.OpenRTOS.com - Commercial support, development, porting,
\r
51 licensing and training services.
\r
54 /* Hardware specific includes. */
\r
55 #include "iodefine.h"
\r
56 #include "typedefine.h"
\r
57 #include "r_ether.h"
\r
60 /* FreeRTOS includes. */
\r
61 #include "FreeRTOS.h"
\r
66 #include "net/uip.h"
\r
68 /* The time to wait between attempts to obtain a free buffer. */
\r
69 #define emacBUFFER_WAIT_DELAY_ms ( 3 / portTICK_RATE_MS )
\r
71 /* The number of times emacBUFFER_WAIT_DELAY_ms should be waited before giving
\r
72 up on attempting to obtain a free buffer all together. */
\r
73 #define emacBUFFER_WAIT_ATTEMPTS ( 30 )
\r
75 /* The number of Rx descriptors. */
\r
76 #define emacNUM_RX_DESCRIPTORS 8
\r
78 /* The number of Tx descriptors. When using uIP there is not point in having
\r
80 #define emacNUM_TX_BUFFERS 2
\r
82 /* The total number of EMAC buffers to allocate. */
\r
83 #define emacNUM_BUFFERS ( emacNUM_RX_DESCRIPTORS + emacNUM_TX_BUFFERS )
\r
85 /* The time to wait for the Tx descriptor to become free. */
\r
86 #define emacTX_WAIT_DELAY_ms ( 10 / portTICK_RATE_MS )
\r
88 /* The total number of times to wait emacTX_WAIT_DELAY_ms for the Tx descriptor to
\r
90 #define emacTX_WAIT_ATTEMPTS ( 50 )
\r
92 /* Only Rx end and Tx end interrupts are used by this driver. */
\r
93 #define emacTX_END_INTERRUPT ( 1UL << 21UL )
\r
94 #define emacRX_END_INTERRUPT ( 1UL << 18UL )
\r
96 /*-----------------------------------------------------------*/
\r
98 /* The buffers and descriptors themselves. */
\r
99 #pragma section _RX_DESC
\r
100 volatile ethfifo xRxDescriptors[ emacNUM_RX_DESCRIPTORS ];
\r
101 #pragma section _TX_DESC
\r
102 volatile ethfifo xTxDescriptors[ emacNUM_TX_BUFFERS ];
\r
103 #pragma section _ETHERNET_BUFFERS
\r
106 unsigned long ulAlignmentVariable;
\r
107 char cBuffer[ emacNUM_BUFFERS ][ UIP_BUFSIZE ];
\r
108 } xEthernetBuffers;
\r
114 /* Used to indicate which buffers are free and which are in use. If an index
\r
115 contains 0 then the corresponding buffer in xEthernetBuffers is free, otherwise
\r
116 the buffer is in use or about to be used. */
\r
117 static unsigned char ucBufferInUse[ emacNUM_BUFFERS ];
\r
119 /*-----------------------------------------------------------*/
\r
122 * Initialise both the Rx and Tx descriptors.
\r
124 static void prvInitialiseDescriptors( void );
\r
127 * Return a pointer to a free buffer within xEthernetBuffers.
\r
129 static unsigned char *prvGetNextBuffer( void );
\r
132 * Return a buffer to the list of free buffers.
\r
134 static void prvReturnBuffer( unsigned char *pucBuffer );
\r
137 * Examine the status of the next Rx FIFO to see if it contains new data.
\r
139 static unsigned long prvCheckRxFifoStatus( void );
\r
142 * Setup the microcontroller for communication with the PHY.
\r
144 static void prvResetMAC( void );
\r
147 * Configure the Ethernet interface peripherals.
\r
149 static void prvConfigureEtherCAndEDMAC( void );
\r
152 * Something has gone wrong with the descriptor usage. Reset all the buffers
\r
155 static void prvResetEverything( void );
\r
157 /*-----------------------------------------------------------*/
\r
159 /* Points to the Rx descriptor currently in use. */
\r
160 static ethfifo *pxCurrentRxDesc = NULL;
\r
162 /* The buffer used by the uIP stack to both receive and send. This points to
\r
163 one of the Ethernet buffers when its actually in use. */
\r
164 unsigned char *uip_buf = NULL;
\r
166 /*-----------------------------------------------------------*/
\r
168 void vInitEmac( void )
\r
170 /* Software reset. */
\r
173 /* Set the Rx and Tx descriptors into their initial state. */
\r
174 prvInitialiseDescriptors();
\r
176 /* Set the MAC address into the ETHERC */
\r
177 ETHERC.MAHR = ( ( unsigned long ) configMAC_ADDR0 << 24UL ) |
\r
178 ( ( unsigned long ) configMAC_ADDR1 << 16UL ) |
\r
179 ( ( unsigned long ) configMAC_ADDR2 << 8UL ) |
\r
180 ( unsigned long ) configMAC_ADDR3;
\r
182 ETHERC.MALR.BIT.MA = ( ( unsigned long ) configMAC_ADDR4 << 8UL ) |
\r
183 ( unsigned long ) configMAC_ADDR5;
\r
185 /* Perform rest of interface hardware configuration. */
\r
186 prvConfigureEtherCAndEDMAC();
\r
188 /* Nothing received yet, so uip_buf points nowhere. */
\r
191 /* Initialize the PHY */
\r
194 /*-----------------------------------------------------------*/
\r
196 void vEMACWrite( void )
\r
200 /* Wait until the second transmission of the last packet has completed. */
\r
201 for( x = 0; x < emacTX_WAIT_ATTEMPTS; x++ )
\r
203 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
205 /* Descriptor is still active. */
\r
206 vTaskDelay( emacTX_WAIT_DELAY_ms );
\r
214 /* Is the descriptor free after waiting for it? */
\r
215 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
217 /* Something has gone wrong. */
\r
218 prvResetEverything();
\r
221 /* Setup both descriptors to transmit the frame. */
\r
222 xTxDescriptors[ 0 ].buf_p = ( char * ) uip_buf;
\r
223 xTxDescriptors[ 0 ].bufsize = uip_len;
\r
224 xTxDescriptors[ 1 ].buf_p = ( char * ) uip_buf;
\r
225 xTxDescriptors[ 1 ].bufsize = uip_len;
\r
227 /* uip_buf is being sent by the Tx descriptor. Allocate a new buffer
\r
228 for use by the stack. */
\r
229 uip_buf = prvGetNextBuffer();
\r
231 /* Clear previous settings and go. */
\r
232 xTxDescriptors[0].status &= ~( FP1 | FP0 );
\r
233 xTxDescriptors[0].status |= ( FP1 | FP0 | ACT );
\r
234 xTxDescriptors[1].status &= ~( FP1 | FP0 );
\r
235 xTxDescriptors[1].status |= ( FP1 | FP0 | ACT );
\r
237 EDMAC.EDTRR.LONG = 0x00000001;
\r
239 /*-----------------------------------------------------------*/
\r
241 unsigned long ulEMACRead( void )
\r
243 unsigned long ulBytesReceived;
\r
245 ulBytesReceived = prvCheckRxFifoStatus();
\r
247 if( ulBytesReceived > 0 )
\r
249 /* Mark the pxDescriptor buffer as free as uip_buf is going to be set to
\r
250 the buffer that contains the received data. */
\r
251 prvReturnBuffer( uip_buf );
\r
253 /* Point uip_buf to the data about ot be processed. */
\r
254 uip_buf = ( void * ) pxCurrentRxDesc->buf_p;
\r
256 /* Allocate a new buffer to the descriptor, as uip_buf is now using it's
\r
258 pxCurrentRxDesc->buf_p = prvGetNextBuffer();
\r
260 /* Prepare the descriptor to go again. */
\r
261 pxCurrentRxDesc->status &= ~( FP1 | FP0 );
\r
262 pxCurrentRxDesc->status |= ACT;
\r
264 /* Move onto the next buffer in the ring. */
\r
265 pxCurrentRxDesc = pxCurrentRxDesc->next;
\r
267 if( EDMAC.EDRRR.LONG == 0x00000000L )
\r
269 /* Restart Ethernet if it has stopped */
\r
270 EDMAC.EDRRR.LONG = 0x00000001L;
\r
274 return ulBytesReceived;
\r
276 /*-----------------------------------------------------------*/
\r
278 long lEMACWaitForLink( void )
\r
282 /* Set the link status. */
\r
283 switch( phy_set_autonegotiate() )
\r
285 /* Half duplex link */
\r
286 case PHY_LINK_100H:
\r
287 ETHERC.ECMR.BIT.DM = 0;
\r
288 ETHERC.ECMR.BIT.RTM = 1;
\r
293 ETHERC.ECMR.BIT.DM = 0;
\r
294 ETHERC.ECMR.BIT.RTM = 0;
\r
299 /* Full duplex link */
\r
300 case PHY_LINK_100F:
\r
301 ETHERC.ECMR.BIT.DM = 1;
\r
302 ETHERC.ECMR.BIT.RTM = 1;
\r
307 ETHERC.ECMR.BIT.DM = 1;
\r
308 ETHERC.ECMR.BIT.RTM = 0;
\r
317 if( lReturn == pdPASS )
\r
319 /* Enable receive and transmit. */
\r
320 ETHERC.ECMR.BIT.RE = 1;
\r
321 ETHERC.ECMR.BIT.TE = 1;
\r
323 /* Enable EDMAC receive */
\r
324 EDMAC.EDRRR.LONG = 0x1;
\r
329 /*-----------------------------------------------------------*/
\r
331 static void prvInitialiseDescriptors( void )
\r
333 ethfifo *pxDescriptor;
\r
336 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
338 /* Ensure none of the buffers are shown as in use at the start. */
\r
339 ucBufferInUse[ x ] = pdFALSE;
\r
342 /* Initialise the Rx descriptors. */
\r
343 for( x = 0; x < emacNUM_RX_DESCRIPTORS; x++ )
\r
345 pxDescriptor = &( xRxDescriptors[ x ] );
\r
346 pxDescriptor->buf_p = &( xEthernetBuffers.cBuffer[ x ][ 0 ] );
\r
348 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
349 pxDescriptor->size = 0;
\r
350 pxDescriptor->status = ACT;
\r
351 pxDescriptor->next = &xRxDescriptors[ x + 1 ];
\r
353 /* Mark this buffer as in use. */
\r
354 ucBufferInUse[ x ] = pdTRUE;
\r
357 /* The last descriptor points back to the start. */
\r
358 pxDescriptor->status |= DL;
\r
359 pxDescriptor->next = &xRxDescriptors[ 0 ];
\r
361 /* Initialise the Tx descriptors. */
\r
362 for( x = 0; x < emacNUM_TX_BUFFERS; x++ )
\r
364 pxDescriptor = &( xTxDescriptors[ x ] );
\r
366 /* A buffer is not allocated to the Tx descriptor until a send is
\r
367 actually required. */
\r
368 pxDescriptor->buf_p = NULL;
\r
370 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
371 pxDescriptor->size = 0;
\r
372 pxDescriptor->status = 0;
\r
373 pxDescriptor->next = &xTxDescriptors[ x + 1 ];
\r
376 /* The last descriptor points back to the start. */
\r
377 pxDescriptor->status |= DL;
\r
378 pxDescriptor->next = &( xTxDescriptors[ 0 ] );
\r
380 /* Use the first Rx descriptor to start with. */
\r
381 pxCurrentRxDesc = &( xRxDescriptors[ 0 ] );
\r
383 /*-----------------------------------------------------------*/
\r
385 static unsigned char *prvGetNextBuffer( void )
\r
388 unsigned char *pucReturn = NULL;
\r
389 unsigned long ulAttempts = 0;
\r
391 while( pucReturn == NULL )
\r
393 /* Look through the buffers to find one that is not in use by
\r
395 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
397 if( ucBufferInUse[ x ] == pdFALSE )
\r
399 ucBufferInUse[ x ] = pdTRUE;
\r
400 pucReturn = ( unsigned char * ) &( xEthernetBuffers.cBuffer[ x ][ 0 ] );
\r
405 /* Was a buffer found? */
\r
406 if( pucReturn == NULL )
\r
410 if( ulAttempts >= emacBUFFER_WAIT_ATTEMPTS )
\r
415 /* Wait then look again. */
\r
416 vTaskDelay( emacBUFFER_WAIT_DELAY_ms );
\r
422 /*-----------------------------------------------------------*/
\r
424 static void prvReturnBuffer( unsigned char *pucBuffer )
\r
428 /* Return a buffer to the pool of free buffers. */
\r
429 for( ul = 0; ul < emacNUM_BUFFERS; ul++ )
\r
431 if( &( xEthernetBuffers.cBuffer[ ul ][ 0 ] ) == ( void * ) pucBuffer )
\r
433 ucBufferInUse[ ul ] = pdFALSE;
\r
438 /*-----------------------------------------------------------*/
\r
440 static void prvResetEverything( void )
\r
442 /* Temporary code just to see if this gets called. This function has not
\r
443 been implemented. */
\r
444 portDISABLE_INTERRUPTS();
\r
447 /*-----------------------------------------------------------*/
\r
449 static unsigned long prvCheckRxFifoStatus( void )
\r
451 unsigned long ulReturn = 0;
\r
453 if( ( pxCurrentRxDesc->status & ACT ) != 0 )
\r
455 /* Current descriptor is still active. */
\r
457 else if( ( pxCurrentRxDesc->status & FE ) != 0 )
\r
459 /* Frame error. Clear the error. */
\r
460 pxCurrentRxDesc->status &= ~( FP1 | FP0 | FE );
\r
461 pxCurrentRxDesc->status &= ~( RMAF | RRF | RTLF | RTSF | PRE | CERF );
\r
462 pxCurrentRxDesc->status |= ACT;
\r
463 pxCurrentRxDesc = pxCurrentRxDesc->next;
\r
465 if( EDMAC.EDRRR.LONG == 0x00000000UL )
\r
467 /* Restart Ethernet if it has stopped. */
\r
468 EDMAC.EDRRR.LONG = 0x00000001UL;
\r
473 /* The descriptor contains a frame. Because of the size of the buffers
\r
474 the frame should always be complete. */
\r
475 if( ( pxCurrentRxDesc->status & FP0 ) == FP0 )
\r
477 ulReturn = pxCurrentRxDesc->size;
\r
481 /* Do not expect to get here. */
\r
482 prvResetEverything();
\r
488 /*-----------------------------------------------------------*/
\r
490 static void prvResetMAC( void )
\r
492 /* Ensure the EtherC and EDMAC are enabled. */
\r
493 SYSTEM.MSTPCRB.BIT.MSTPB15 = 0;
\r
494 vTaskDelay( 100 / portTICK_RATE_MS );
\r
496 EDMAC.EDMR.BIT.SWR = 1;
\r
498 /* Crude wait for reset to complete. */
\r
499 vTaskDelay( 500 / portTICK_RATE_MS );
\r
501 /*-----------------------------------------------------------*/
\r
503 static void prvConfigureEtherCAndEDMAC( void )
\r
505 /* Initialisation code taken from Renesas example project. */
\r
507 /* TODO: Check bit 5 */
\r
508 ETHERC.ECSR.LONG = 0x00000037; /* Clear all ETHERC statuS BFR, PSRTO, LCHNG, MPD, ICD */
\r
510 /* Set the EDMAC interrupt priority. */
\r
511 _IPR( _ETHER_EINT ) = configKERNEL_INTERRUPT_PRIORITY;
\r
513 /* Enable interrupts of interest only. */
\r
514 EDMAC.EESIPR.LONG = emacTX_END_INTERRUPT | emacRX_END_INTERRUPT;
\r
515 ETHERC.RFLR.LONG = 1518; /* Ether payload is 1500+ CRC */
\r
516 ETHERC.IPGR.LONG = 0x00000014; /* Intergap is 96-bit time */
\r
519 EDMAC.EESR.LONG = 0x47FF0F9F; /* Clear all ETHERC and EDMAC status bits */
\r
521 EDMAC.EDMR.BIT.DE = 1;
\r
523 EDMAC.RDLAR = ( void * ) pxCurrentRxDesc; /* Initialaize Rx Descriptor List Address */
\r
524 EDMAC.TDLAR = &( xTxDescriptors[ 0 ] ); /* Initialaize Tx Descriptor List Address */
\r
525 EDMAC.TRSCER.LONG = 0x00000000; /* Copy-back status is RFE & TFE only */
\r
526 EDMAC.TFTR.LONG = 0x00000000; /* Threshold of Tx_FIFO */
\r
527 EDMAC.FDR.LONG = 0x00000000; /* Transmit fifo & receive fifo is 256 bytes */
\r
528 EDMAC.RMCR.LONG = 0x00000003; /* Receive function is normal mode(continued) */
\r
529 ETHERC.ECMR.BIT.PRM = 0; /* Ensure promiscuous mode is off. */
\r
531 /* Enable the interrupt... */
\r
532 _IEN( _ETHER_EINT ) = 1;
\r
534 /*-----------------------------------------------------------*/
\r
536 #pragma interrupt ( vEMAC_ISR_Handler( vect = VECT_ETHER_EINT, enable ) )
\r
537 void vEMAC_ISR_Handler( void )
\r
539 unsigned long ul = EDMAC.EESR.LONG;
\r
540 long lHigherPriorityTaskWoken = pdFALSE;
\r
541 extern xQueueHandle xEMACEventQueue;
\r
542 const unsigned long ulRxEvent = uipETHERNET_RX_EVENT;
\r
544 /* Has a Tx end occurred? */
\r
545 if( ul & emacTX_END_INTERRUPT )
\r
547 /* Only return the buffer to the pool once both Txes have completed. */
\r
548 prvReturnBuffer( ( void * ) xTxDescriptors[ 0 ].buf_p );
\r
549 EDMAC.EESR.LONG = emacTX_END_INTERRUPT;
\r
552 /* Has an Rx end occurred? */
\r
553 if( ul & emacRX_END_INTERRUPT )
\r
555 /* Make sure the Ethernet task is not blocked waiting for a packet. */
\r
556 xQueueSendFromISR( xEMACEventQueue, &ulRxEvent, &lHigherPriorityTaskWoken );
\r
557 portYIELD_FROM_ISR( lHigherPriorityTaskWoken );
\r
558 EDMAC.EESR.LONG = emacRX_END_INTERRUPT;
\r