2 FreeRTOS V6.1.0 - 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 books - available as PDF or paperback *
\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 static volatile ethfifo xRxDescriptors[ emacNUM_RX_DESCRIPTORS ] __attribute__((aligned(16)));
\r
100 static volatile ethfifo xTxDescriptors[ emacNUM_TX_BUFFERS ] __attribute__((aligned(16)));
\r
101 static char xEthernetBuffers[ emacNUM_BUFFERS ][ UIP_BUFSIZE ] __attribute__((aligned(16)));
\r
103 /* Used to indicate which buffers are free and which are in use. If an index
\r
104 contains 0 then the corresponding buffer in xEthernetBuffers is free, otherwise
\r
105 the buffer is in use or about to be used. */
\r
106 static unsigned char ucBufferInUse[ emacNUM_BUFFERS ];
\r
108 /*-----------------------------------------------------------*/
\r
111 * Initialise both the Rx and Tx descriptors.
\r
113 static void prvInitialiseDescriptors( void );
\r
116 * Return a pointer to a free buffer within xEthernetBuffers.
\r
118 static unsigned char *prvGetNextBuffer( void );
\r
121 * Return a buffer to the list of free buffers.
\r
123 static void prvReturnBuffer( unsigned char *pucBuffer );
\r
126 * Examine the status of the next Rx FIFO to see if it contains new data.
\r
128 static unsigned long prvCheckRxFifoStatus( void );
\r
131 * Setup the microcontroller for communication with the PHY.
\r
133 static void prvResetMAC( void );
\r
136 * Configure the Ethernet interface peripherals.
\r
138 static void prvConfigureEtherCAndEDMAC( void );
\r
141 * Something has gone wrong with the descriptor usage. Reset all the buffers
\r
144 static void prvResetEverything( void );
\r
147 * Handler for the EMAC peripheral. See the documentation for this
\r
148 * port on http://www.FreeRTOS.org for more information on defining interrupt
\r
151 void vEMAC_ISR_Handler( void ) __attribute__((interrupt));
\r
153 /*-----------------------------------------------------------*/
\r
155 /* Points to the Rx descriptor currently in use. */
\r
156 static ethfifo *pxCurrentRxDesc = NULL;
\r
158 /* The buffer used by the uIP stack to both receive and send. This points to
\r
159 one of the Ethernet buffers when its actually in use. */
\r
160 unsigned char *uip_buf = NULL;
\r
162 /*-----------------------------------------------------------*/
\r
164 void vInitEmac( void )
\r
166 /* Software reset. */
\r
169 /* Set the Rx and Tx descriptors into their initial state. */
\r
170 prvInitialiseDescriptors();
\r
172 /* Set the MAC address into the ETHERC */
\r
173 ETHERC.MAHR = ( ( unsigned long ) configMAC_ADDR0 << 24UL ) |
\r
174 ( ( unsigned long ) configMAC_ADDR1 << 16UL ) |
\r
175 ( ( unsigned long ) configMAC_ADDR2 << 8UL ) |
\r
176 ( unsigned long ) configMAC_ADDR3;
\r
178 ETHERC.MALR.BIT.MA = ( ( unsigned long ) configMAC_ADDR4 << 8UL ) |
\r
179 ( unsigned long ) configMAC_ADDR5;
\r
181 /* Perform rest of interface hardware configuration. */
\r
182 prvConfigureEtherCAndEDMAC();
\r
184 /* Nothing received yet, so uip_buf points nowhere. */
\r
187 /* Initialize the PHY */
\r
190 /*-----------------------------------------------------------*/
\r
192 void vEMACWrite( void )
\r
196 /* Wait until the second transmission of the last packet has completed. */
\r
197 for( x = 0; x < emacTX_WAIT_ATTEMPTS; x++ )
\r
199 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
201 /* Descriptor is still active. */
\r
202 vTaskDelay( emacTX_WAIT_DELAY_ms );
\r
210 /* Is the descriptor free after waiting for it? */
\r
211 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
213 /* Something has gone wrong. */
\r
214 prvResetEverything();
\r
217 /* Setup both descriptors to transmit the frame. */
\r
218 xTxDescriptors[ 0 ].buf_p = ( char * ) uip_buf;
\r
219 xTxDescriptors[ 0 ].bufsize = uip_len;
\r
220 xTxDescriptors[ 1 ].buf_p = ( char * ) uip_buf;
\r
221 xTxDescriptors[ 1 ].bufsize = uip_len;
\r
223 /* uip_buf is being sent by the Tx descriptor. Allocate a new buffer
\r
224 for use by the stack. */
\r
225 uip_buf = prvGetNextBuffer();
\r
227 /* Clear previous settings and go. */
\r
228 xTxDescriptors[0].status &= ~( FP1 | FP0 );
\r
229 xTxDescriptors[0].status |= ( FP1 | FP0 | ACT );
\r
230 xTxDescriptors[1].status &= ~( FP1 | FP0 );
\r
231 xTxDescriptors[1].status |= ( FP1 | FP0 | ACT );
\r
233 EDMAC.EDTRR.LONG = 0x00000001;
\r
235 /*-----------------------------------------------------------*/
\r
237 unsigned long ulEMACRead( void )
\r
239 unsigned long ulBytesReceived;
\r
241 ulBytesReceived = prvCheckRxFifoStatus();
\r
243 if( ulBytesReceived > 0 )
\r
245 pxCurrentRxDesc->status &= ~( FP1 | FP0 );
\r
246 pxCurrentRxDesc->status |= ACT;
\r
248 if( EDMAC.EDRRR.LONG == 0x00000000L )
\r
250 /* Restart Ethernet if it has stopped */
\r
251 EDMAC.EDRRR.LONG = 0x00000001L;
\r
254 /* Mark the pxDescriptor buffer as free as uip_buf is going to be set to
\r
255 the buffer that contains the received data. */
\r
256 prvReturnBuffer( uip_buf );
\r
258 uip_buf = ( void * ) pxCurrentRxDesc->buf_p;
\r
260 /* Move onto the next buffer in the ring. */
\r
261 pxCurrentRxDesc = pxCurrentRxDesc->next;
\r
264 return ulBytesReceived;
\r
266 /*-----------------------------------------------------------*/
\r
268 long lEMACWaitForLink( void )
\r
272 /* Set the link status. */
\r
273 switch( phy_set_autonegotiate() )
\r
275 /* Half duplex link */
\r
276 case PHY_LINK_100H:
\r
277 ETHERC.ECMR.BIT.DM = 0;
\r
278 ETHERC.ECMR.BIT.RTM = 1;
\r
283 ETHERC.ECMR.BIT.DM = 0;
\r
284 ETHERC.ECMR.BIT.RTM = 0;
\r
289 /* Full duplex link */
\r
290 case PHY_LINK_100F:
\r
291 ETHERC.ECMR.BIT.DM = 1;
\r
292 ETHERC.ECMR.BIT.RTM = 1;
\r
297 ETHERC.ECMR.BIT.DM = 1;
\r
298 ETHERC.ECMR.BIT.RTM = 0;
\r
307 if( lReturn == pdPASS )
\r
309 /* Enable receive and transmit. */
\r
310 ETHERC.ECMR.BIT.RE = 1;
\r
311 ETHERC.ECMR.BIT.TE = 1;
\r
313 /* Enable EDMAC receive */
\r
314 EDMAC.EDRRR.LONG = 0x1;
\r
319 /*-----------------------------------------------------------*/
\r
321 static void prvInitialiseDescriptors( void )
\r
323 volatile ethfifo *pxDescriptor;
\r
326 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
328 /* Ensure none of the buffers are shown as in use at the start. */
\r
329 ucBufferInUse[ x ] = pdFALSE;
\r
332 /* Initialise the Rx descriptors. */
\r
333 for( x = 0; x < emacNUM_RX_DESCRIPTORS; x++ )
\r
335 pxDescriptor = &( xRxDescriptors[ x ] );
\r
336 pxDescriptor->buf_p = &( xEthernetBuffers[ x ][ 0 ] );
\r
338 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
339 pxDescriptor->size = 0;
\r
340 pxDescriptor->status = ACT;
\r
341 pxDescriptor->next = ( struct Descriptor * ) &xRxDescriptors[ x + 1 ];
\r
343 /* Mark this buffer as in use. */
\r
344 ucBufferInUse[ x ] = pdTRUE;
\r
347 /* The last descriptor points back to the start. */
\r
348 pxDescriptor->status |= DL;
\r
349 pxDescriptor->next = ( struct Descriptor * ) &xRxDescriptors[ 0 ];
\r
351 /* Initialise the Tx descriptors. */
\r
352 for( x = 0; x < emacNUM_TX_BUFFERS; x++ )
\r
354 pxDescriptor = &( xTxDescriptors[ x ] );
\r
356 /* A buffer is not allocated to the Tx descriptor until a send is
\r
357 actually required. */
\r
358 pxDescriptor->buf_p = NULL;
\r
360 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
361 pxDescriptor->size = 0;
\r
362 pxDescriptor->status = 0;
\r
363 pxDescriptor->next = ( struct Descriptor * ) &xTxDescriptors[ x + 1 ];
\r
366 /* The last descriptor points back to the start. */
\r
367 pxDescriptor->status |= DL;
\r
368 pxDescriptor->next = ( struct Descriptor * ) &( xTxDescriptors[ 0 ] );
\r
370 /* Use the first Rx descriptor to start with. */
\r
371 pxCurrentRxDesc = ( struct Descriptor * ) &( xRxDescriptors[ 0 ] );
\r
373 /*-----------------------------------------------------------*/
\r
375 static unsigned char *prvGetNextBuffer( void )
\r
378 unsigned char *pucReturn = NULL;
\r
379 unsigned long ulAttempts = 0;
\r
381 while( pucReturn == NULL )
\r
383 /* Look through the buffers to find one that is not in use by
\r
385 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
387 if( ucBufferInUse[ x ] == pdFALSE )
\r
389 ucBufferInUse[ x ] = pdTRUE;
\r
390 pucReturn = ( unsigned char * ) &( xEthernetBuffers[ x ][ 0 ] );
\r
395 /* Was a buffer found? */
\r
396 if( pucReturn == NULL )
\r
400 if( ulAttempts >= emacBUFFER_WAIT_ATTEMPTS )
\r
405 /* Wait then look again. */
\r
406 vTaskDelay( emacBUFFER_WAIT_DELAY_ms );
\r
412 /*-----------------------------------------------------------*/
\r
414 static void prvReturnBuffer( unsigned char *pucBuffer )
\r
418 /* Return a buffer to the pool of free buffers. */
\r
419 for( ul = 0; ul < emacNUM_BUFFERS; ul++ )
\r
421 if( &( xEthernetBuffers[ ul ][ 0 ] ) == ( void * ) pucBuffer )
\r
423 ucBufferInUse[ ul ] = pdFALSE;
\r
428 /*-----------------------------------------------------------*/
\r
430 static void prvResetEverything( void )
\r
432 /* Temporary code just to see if this gets called. This function has not
\r
433 been implemented. */
\r
434 portDISABLE_INTERRUPTS();
\r
437 /*-----------------------------------------------------------*/
\r
439 static unsigned long prvCheckRxFifoStatus( void )
\r
441 unsigned long ulReturn = 0;
\r
443 if( ( pxCurrentRxDesc->status & ACT ) != 0 )
\r
445 /* Current descriptor is still active. */
\r
447 else if( ( pxCurrentRxDesc->status & FE ) != 0 )
\r
449 /* Frame error. Clear the error. */
\r
450 pxCurrentRxDesc->status &= ~( FP1 | FP0 | FE );
\r
451 pxCurrentRxDesc->status &= ~( RMAF | RRF | RTLF | RTSF | PRE | CERF );
\r
452 pxCurrentRxDesc->status |= ACT;
\r
453 pxCurrentRxDesc = pxCurrentRxDesc->next;
\r
455 if( EDMAC.EDRRR.LONG == 0x00000000UL )
\r
457 /* Restart Ethernet if it has stopped. */
\r
458 EDMAC.EDRRR.LONG = 0x00000001UL;
\r
463 /* The descriptor contains a frame. Because of the size of the buffers
\r
464 the frame should always be complete. */
\r
465 if( ( pxCurrentRxDesc->status & FP0 ) == FP0 )
\r
467 ulReturn = pxCurrentRxDesc->size;
\r
471 /* Do not expect to get here. */
\r
472 prvResetEverything();
\r
478 /*-----------------------------------------------------------*/
\r
480 static void prvResetMAC( void )
\r
482 /* Ensure the EtherC and EDMAC are enabled. */
\r
483 SYSTEM.MSTPCRB.BIT.MSTPB15 = 0;
\r
484 vTaskDelay( 100 / portTICK_RATE_MS );
\r
486 EDMAC.EDMR.BIT.SWR = 1;
\r
488 /* Crude wait for reset to complete. */
\r
489 vTaskDelay( 500 / portTICK_RATE_MS );
\r
491 /*-----------------------------------------------------------*/
\r
493 static void prvConfigureEtherCAndEDMAC( void )
\r
495 /* Initialisation code taken from Renesas example project. */
\r
497 /* TODO: Check bit 5 */
\r
498 ETHERC.ECSR.LONG = 0x00000037; /* Clear all ETHERC statuS BFR, PSRTO, LCHNG, MPD, ICD */
\r
500 /* Set the EDMAC interrupt priority. */
\r
501 _IPR( _ETHER_EINT ) = configKERNEL_INTERRUPT_PRIORITY;
\r
503 /* TODO: Check bit 5 */
\r
504 /* Enable interrupts of interest only. */
\r
505 EDMAC.EESIPR.LONG = emacTX_END_INTERRUPT | emacRX_END_INTERRUPT;
\r
506 ETHERC.RFLR.LONG = 1518; /* Ether payload is 1500+ CRC */
\r
507 ETHERC.IPGR.LONG = 0x00000014; /* Intergap is 96-bit time */
\r
510 EDMAC.EESR.LONG = 0x47FF0F9F; /* Clear all ETHERC and EDMAC status bits */
\r
511 #ifdef __RX_LITTLE_ENDIAN__
\r
512 EDMAC.EDMR.BIT.DE = 1;
\r
514 EDMAC.RDLAR = ( void * ) pxCurrentRxDesc; /* Initialaize Rx Descriptor List Address */
\r
515 EDMAC.TDLAR = ( void * ) &( xTxDescriptors[ 0 ] ); /* Initialaize Tx Descriptor List Address */
\r
516 EDMAC.TRSCER.LONG = 0x00000000; /* Copy-back status is RFE & TFE only */
\r
517 EDMAC.TFTR.LONG = 0x00000000; /* Threshold of Tx_FIFO */
\r
518 EDMAC.FDR.LONG = 0x00000000; /* Transmit fifo & receive fifo is 256 bytes */
\r
519 EDMAC.RMCR.LONG = 0x00000003; /* Receive function is normal mode(continued) */
\r
521 /* Enable the interrupt... */
\r
522 _IEN( _ETHER_EINT ) = 1;
\r
524 /*-----------------------------------------------------------*/
\r
526 void vEMAC_ISR_Handler( void )
\r
528 unsigned long ul = EDMAC.EESR.LONG;
\r
529 long lHigherPriorityTaskWoken = pdFALSE;
\r
530 extern xSemaphoreHandle xEMACSemaphore;
\r
531 static long ulTxEndInts = 0;
\r
533 /* Re-enabled interrupts. */
\r
534 __asm volatile( "SETPSW I" );
\r
536 /* Has a Tx end occurred? */
\r
537 if( ul & emacTX_END_INTERRUPT )
\r
540 if( ulTxEndInts >= 2 )
\r
542 /* Only return the buffer to the pool once both Txes have completed. */
\r
543 prvReturnBuffer( ( void * ) xTxDescriptors[ 0 ].buf_p );
\r
546 EDMAC.EESR.LONG = emacTX_END_INTERRUPT;
\r
549 /* Has an Rx end occurred? */
\r
550 if( ul & emacRX_END_INTERRUPT )
\r
552 /* Make sure the Ethernet task is not blocked waiting for a packet. */
\r
553 xSemaphoreGiveFromISR( xEMACSemaphore, &lHigherPriorityTaskWoken );
\r
554 portYIELD_FROM_ISR( lHigherPriorityTaskWoken );
\r
555 EDMAC.EESR.LONG = emacRX_END_INTERRUPT;
\r