2 FreeRTOS V6.0.5 - Copyright (C) 2010 Real Time Engineers Ltd.
\r
4 ***************************************************************************
\r
8 * + New to FreeRTOS, *
\r
9 * + Wanting to learn FreeRTOS or multitasking in general quickly *
\r
10 * + Looking for basic training, *
\r
11 * + Wanting to improve your FreeRTOS skills and productivity *
\r
13 * then take a look at the FreeRTOS eBook *
\r
15 * "Using the FreeRTOS Real Time Kernel - a Practical Guide" *
\r
16 * http://www.FreeRTOS.org/Documentation *
\r
18 * A pdf reference manual is also available. Both are usually delivered *
\r
19 * to your inbox within 20 minutes to two hours when purchased between 8am *
\r
20 * and 8pm GMT (although please allow up to 24 hours in case of *
\r
21 * exceptional circumstances). Thank you for your support! *
\r
23 ***************************************************************************
\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 exception to the GPL is included to allow you to distribute
\r
31 a combined work that includes FreeRTOS without being obliged to provide the
\r
32 source code for proprietary components outside of the FreeRTOS kernel.
\r
33 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT
\r
34 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
\r
35 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 pxCurrentRxDesc->status &= ~( FP1 | FP0 );
\r
250 pxCurrentRxDesc->status |= ACT;
\r
252 if( EDMAC.EDRRR.LONG == 0x00000000L )
\r
254 /* Restart Ethernet if it has stopped */
\r
255 EDMAC.EDRRR.LONG = 0x00000001L;
\r
258 /* Mark the pxDescriptor buffer as free as uip_buf is going to be set to
\r
259 the buffer that contains the received data. */
\r
260 prvReturnBuffer( uip_buf );
\r
262 uip_buf = ( void * ) pxCurrentRxDesc->buf_p;
\r
264 /* Move onto the next buffer in the ring. */
\r
265 pxCurrentRxDesc = pxCurrentRxDesc->next;
\r
268 return ulBytesReceived;
\r
270 /*-----------------------------------------------------------*/
\r
272 long lEMACWaitForLink( void )
\r
276 /* Set the link status. */
\r
277 switch( phy_set_autonegotiate() )
\r
279 /* Half duplex link */
\r
280 case PHY_LINK_100H:
\r
281 ETHERC.ECMR.BIT.DM = 0;
\r
282 ETHERC.ECMR.BIT.RTM = 1;
\r
287 ETHERC.ECMR.BIT.DM = 0;
\r
288 ETHERC.ECMR.BIT.RTM = 0;
\r
293 /* Full duplex link */
\r
294 case PHY_LINK_100F:
\r
295 ETHERC.ECMR.BIT.DM = 1;
\r
296 ETHERC.ECMR.BIT.RTM = 1;
\r
301 ETHERC.ECMR.BIT.DM = 1;
\r
302 ETHERC.ECMR.BIT.RTM = 0;
\r
311 if( lReturn == pdPASS )
\r
313 /* Enable receive and transmit. */
\r
314 ETHERC.ECMR.BIT.RE = 1;
\r
315 ETHERC.ECMR.BIT.TE = 1;
\r
317 /* Enable EDMAC receive */
\r
318 EDMAC.EDRRR.LONG = 0x1;
\r
323 /*-----------------------------------------------------------*/
\r
325 static void prvInitialiseDescriptors( void )
\r
327 ethfifo *pxDescriptor;
\r
330 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
332 /* Ensure none of the buffers are shown as in use at the start. */
\r
333 ucBufferInUse[ x ] = pdFALSE;
\r
336 /* Initialise the Rx descriptors. */
\r
337 for( x = 0; x < emacNUM_RX_DESCRIPTORS; x++ )
\r
339 pxDescriptor = &( xRxDescriptors[ x ] );
\r
340 pxDescriptor->buf_p = &( xEthernetBuffers.cBuffer[ x ][ 0 ] );
\r
342 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
343 pxDescriptor->size = 0;
\r
344 pxDescriptor->status = ACT;
\r
345 pxDescriptor->next = &xRxDescriptors[ x + 1 ];
\r
347 /* Mark this buffer as in use. */
\r
348 ucBufferInUse[ x ] = pdTRUE;
\r
351 /* The last descriptor points back to the start. */
\r
352 pxDescriptor->status |= DL;
\r
353 pxDescriptor->next = &xRxDescriptors[ 0 ];
\r
355 /* Initialise the Tx descriptors. */
\r
356 for( x = 0; x < emacNUM_TX_BUFFERS; x++ )
\r
358 pxDescriptor = &( xTxDescriptors[ x ] );
\r
360 /* A buffer is not allocated to the Tx descriptor until a send is
\r
361 actually required. */
\r
362 pxDescriptor->buf_p = NULL;
\r
364 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
365 pxDescriptor->size = 0;
\r
366 pxDescriptor->status = 0;
\r
367 pxDescriptor->next = &xTxDescriptors[ x + 1 ];
\r
370 /* The last descriptor points back to the start. */
\r
371 pxDescriptor->status |= DL;
\r
372 pxDescriptor->next = &( xTxDescriptors[ 0 ] );
\r
374 /* Use the first Rx descriptor to start with. */
\r
375 pxCurrentRxDesc = &( xRxDescriptors[ 0 ] );
\r
377 /*-----------------------------------------------------------*/
\r
379 static unsigned char *prvGetNextBuffer( void )
\r
382 unsigned char *pucReturn = NULL;
\r
383 unsigned long ulAttempts = 0;
\r
385 while( pucReturn == NULL )
\r
387 /* Look through the buffers to find one that is not in use by
\r
389 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
391 if( ucBufferInUse[ x ] == pdFALSE )
\r
393 ucBufferInUse[ x ] = pdTRUE;
\r
394 pucReturn = ( unsigned char * ) &( xEthernetBuffers.cBuffer[ x ][ 0 ] );
\r
399 /* Was a buffer found? */
\r
400 if( pucReturn == NULL )
\r
404 if( ulAttempts >= emacBUFFER_WAIT_ATTEMPTS )
\r
409 /* Wait then look again. */
\r
410 vTaskDelay( emacBUFFER_WAIT_DELAY_ms );
\r
416 /*-----------------------------------------------------------*/
\r
418 static void prvReturnBuffer( unsigned char *pucBuffer )
\r
422 /* Return a buffer to the pool of free buffers. */
\r
423 for( ul = 0; ul < emacNUM_BUFFERS; ul++ )
\r
425 if( &( xEthernetBuffers.cBuffer[ ul ][ 0 ] ) == ( void * ) pucBuffer )
\r
427 ucBufferInUse[ ul ] = pdFALSE;
\r
432 /*-----------------------------------------------------------*/
\r
434 static void prvResetEverything( void )
\r
436 /* Temporary code just to see if this gets called. This function has not
\r
437 been implemented. */
\r
438 portDISABLE_INTERRUPTS();
\r
441 /*-----------------------------------------------------------*/
\r
443 static unsigned long prvCheckRxFifoStatus( void )
\r
445 unsigned long ulReturn = 0;
\r
447 if( ( pxCurrentRxDesc->status & ACT ) != 0 )
\r
449 /* Current descriptor is still active. */
\r
451 else if( ( pxCurrentRxDesc->status & FE ) != 0 )
\r
453 /* Frame error. Clear the error. */
\r
454 pxCurrentRxDesc->status &= ~( FP1 | FP0 | FE );
\r
455 pxCurrentRxDesc->status &= ~( RMAF | RRF | RTLF | RTSF | PRE | CERF );
\r
456 pxCurrentRxDesc->status |= ACT;
\r
457 pxCurrentRxDesc = pxCurrentRxDesc->next;
\r
459 if( EDMAC.EDRRR.LONG == 0x00000000UL )
\r
461 /* Restart Ethernet if it has stopped. */
\r
462 EDMAC.EDRRR.LONG = 0x00000001UL;
\r
467 /* The descriptor contains a frame. Because of the size of the buffers
\r
468 the frame should always be complete. */
\r
469 if( ( pxCurrentRxDesc->status & FP0 ) == FP0 )
\r
471 ulReturn = pxCurrentRxDesc->size;
\r
475 /* Do not expect to get here. */
\r
476 prvResetEverything();
\r
482 /*-----------------------------------------------------------*/
\r
484 static void prvResetMAC( void )
\r
486 /* Ensure the EtherC and EDMAC are enabled. */
\r
487 SYSTEM.MSTPCRB.BIT.MSTPB15 = 0;
\r
488 vTaskDelay( 100 / portTICK_RATE_MS );
\r
490 EDMAC.EDMR.BIT.SWR = 1;
\r
492 /* Crude wait for reset to complete. */
\r
493 vTaskDelay( 500 / portTICK_RATE_MS );
\r
495 /*-----------------------------------------------------------*/
\r
497 static void prvConfigureEtherCAndEDMAC( void )
\r
499 /* Initialisation code taken from Renesas example project. */
\r
501 /* TODO: Check bit 5 */
\r
502 ETHERC.ECSR.LONG = 0x00000037; /* Clear all ETHERC statuS BFR, PSRTO, LCHNG, MPD, ICD */
\r
504 /* Set the EDMAC interrupt priority. */
\r
505 _IPR( _ETHER_EINT ) = configKERNEL_INTERRUPT_PRIORITY;
\r
507 /* TODO: Check bit 5 */
\r
508 /* Enable interrupts of interest only. */
\r
509 EDMAC.EESIPR.LONG = emacTX_END_INTERRUPT | emacRX_END_INTERRUPT;
\r
510 ETHERC.RFLR.LONG = 1518; /* Ether payload is 1500+ CRC */
\r
511 ETHERC.IPGR.LONG = 0x00000014; /* Intergap is 96-bit time */
\r
514 EDMAC.EESR.LONG = 0x47FF0F9F; /* Clear all ETHERC and EDMAC status bits */
\r
516 EDMAC.EDMR.BIT.DE = 1;
\r
518 EDMAC.RDLAR = ( void * ) pxCurrentRxDesc; /* Initialaize Rx Descriptor List Address */
\r
519 EDMAC.TDLAR = &( xTxDescriptors[ 0 ] ); /* Initialaize Tx Descriptor List Address */
\r
520 EDMAC.TRSCER.LONG = 0x00000000; /* Copy-back status is RFE & TFE only */
\r
521 EDMAC.TFTR.LONG = 0x00000000; /* Threshold of Tx_FIFO */
\r
522 EDMAC.FDR.LONG = 0x00000000; /* Transmit fifo & receive fifo is 256 bytes */
\r
523 EDMAC.RMCR.LONG = 0x00000003; /* Receive function is normal mode(continued) */
\r
525 /* Enable the interrupt... */
\r
526 _IEN( _ETHER_EINT ) = 1;
\r
528 /*-----------------------------------------------------------*/
\r
530 #pragma interrupt ( vEMAC_ISR_Handler( vect = VECT_ETHER_EINT, enable ) )
\r
531 void vEMAC_ISR_Handler( void )
\r
533 unsigned long ul = EDMAC.EESR.LONG;
\r
534 long lHigherPriorityTaskWoken = pdFALSE;
\r
535 extern xSemaphoreHandle xEMACSemaphore;
\r
536 static long ulTxEndInts = 0;
\r
538 /* Has a Tx end occurred? */
\r
539 if( ul & emacTX_END_INTERRUPT )
\r
542 if( ulTxEndInts >= 2 )
\r
544 /* Only return the buffer to the pool once both Txes have completed. */
\r
545 prvReturnBuffer( ( void * ) xTxDescriptors[ 0 ].buf_p );
\r
548 EDMAC.EESR.LONG = emacTX_END_INTERRUPT;
\r
551 /* Has an Rx end occurred? */
\r
552 if( ul & emacRX_END_INTERRUPT )
\r
554 /* Make sure the Ethernet task is not blocked waiting for a packet. */
\r
555 xSemaphoreGiveFromISR( xEMACSemaphore, &lHigherPriorityTaskWoken );
\r
556 portYIELD_FROM_ISR( lHigherPriorityTaskWoken );
\r
557 EDMAC.EESR.LONG = emacRX_END_INTERRUPT;
\r