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
59 /* FreeRTOS includes. */
\r
60 #include "FreeRTOS.h"
\r
65 #include "net/uip.h"
\r
67 /* The time to wait between attempts to obtain a free buffer. */
\r
68 #define emacBUFFER_WAIT_DELAY_ms ( 3 / portTICK_RATE_MS )
\r
70 /* The number of times emacBUFFER_WAIT_DELAY_ms should be waited before giving
\r
71 up on attempting to obtain a free buffer all together. */
\r
72 #define emacBUFFER_WAIT_ATTEMPTS ( 30 )
\r
74 /* The number of Rx descriptors. */
\r
75 #define emacNUM_RX_DESCRIPTORS 3
\r
77 /* The number of Tx descriptors. When using uIP there is not point in having
\r
79 #define emacNUM_TX_BUFFERS 2
\r
81 /* The total number of EMAC buffers to allocate. */
\r
82 #define emacNUM_BUFFERS ( emacNUM_RX_DESCRIPTORS + emacNUM_TX_BUFFERS )
\r
84 /* The time to wait for the Tx descriptor to become free. */
\r
85 #define emacTX_WAIT_DELAY_ms ( 10 / portTICK_RATE_MS )
\r
87 /* The total number of times to wait emacTX_WAIT_DELAY_ms for the Tx descriptor to
\r
89 #define emacTX_WAIT_ATTEMPTS ( 5 )
\r
91 /* Only Rx end and Tx end interrupts are used by this driver. */
\r
92 #define emacTX_END_INTERRUPT ( 1UL << 21UL )
\r
93 #define emacRX_END_INTERRUPT ( 1UL << 18UL )
\r
95 /*-----------------------------------------------------------*/
\r
97 /* The buffers and descriptors themselves. */
\r
98 #pragma section _RX_DESC
\r
99 volatile ethfifo xRxDescriptors[ emacNUM_RX_DESCRIPTORS ];
\r
100 #pragma section _TX_DESC
\r
101 volatile ethfifo xTxDescriptors[ emacNUM_TX_BUFFERS ];
\r
102 #pragma section _ETHERNET_BUFFERS
\r
105 unsigned long ulAlignmentVariable;
\r
106 char cBuffer[ emacNUM_BUFFERS ][ UIP_BUFSIZE ];
\r
107 } xEthernetBuffers;
\r
113 /* Used to indicate which buffers are free and which are in use. If an index
\r
114 contains 0 then the corresponding buffer in xEthernetBuffers is free, otherwise
\r
115 the buffer is in use or about to be used. */
\r
116 static unsigned char ucBufferInUse[ emacNUM_BUFFERS ];
\r
118 /*-----------------------------------------------------------*/
\r
121 * Initialise both the Rx and Tx descriptors.
\r
123 static void prvInitialiseDescriptors( void );
\r
126 * Return a pointer to a free buffer within xEthernetBuffers.
\r
128 static unsigned char *prvGetNextBuffer( void );
\r
131 * Return a buffer to the list of free buffers.
\r
133 static void prvReturnBuffer( unsigned char *pucBuffer );
\r
136 * Examine the status of the next Rx FIFO to see if it contains new data.
\r
138 static unsigned long prvCheckRxFifoStatus( void );
\r
141 * Setup the microcontroller for communication with the PHY.
\r
143 static void prvResetMAC( void );
\r
146 * Configure the Ethernet interface peripherals.
\r
148 static void prvConfigureEtherCAndEDMAC( void );
\r
151 * Something has gone wrong with the descriptor usage. Reset all the buffers
\r
154 static void prvResetEverything( void );
\r
156 /*-----------------------------------------------------------*/
\r
158 /* Points to the Rx descriptor currently in use. */
\r
159 static ethfifo *xCurrentRxDesc = NULL;
\r
161 /* The buffer used by the uIP stack to both receive and send. This points to
\r
162 one of the Ethernet buffers when its actually in use. */
\r
163 unsigned char *uip_buf = NULL;
\r
165 /*-----------------------------------------------------------*/
\r
167 void vInitEmac( void )
\r
169 /* Software reset. */
\r
172 /* Set the Rx and Tx descriptors into their initial state. */
\r
173 prvInitialiseDescriptors();
\r
175 /* Set the MAC address into the ETHERC */
\r
176 ETHERC.MAHR = ( ( unsigned long ) configMAC_ADDR0 << 24UL ) |
\r
177 ( ( unsigned long ) configMAC_ADDR1 << 16UL ) |
\r
178 ( ( unsigned long ) configMAC_ADDR2 << 8UL ) |
\r
179 ( unsigned long ) configMAC_ADDR3;
\r
181 ETHERC.MALR.BIT.MA = ( ( unsigned long ) configMAC_ADDR4 << 8UL ) |
\r
182 ( unsigned long ) configMAC_ADDR5;
\r
184 /* Perform rest of interface hardware configuration. */
\r
185 prvConfigureEtherCAndEDMAC();
\r
187 /* Nothing received yet, so uip_buf points nowhere. */
\r
190 /* Initialize the PHY */
\r
193 /*-----------------------------------------------------------*/
\r
195 void vEMACWrite( void )
\r
199 /* Wait until the second transmission of the last packet has completed. */
\r
200 for( x = 0; x < emacTX_WAIT_ATTEMPTS; x++ )
\r
202 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
204 /* Descriptor is still active. */
\r
205 vTaskDelay( emacTX_WAIT_DELAY_ms );
\r
213 /* Is the descriptor free after waiting for it? */
\r
214 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
216 /* Something has gone wrong. */
\r
217 prvResetEverything();
\r
220 /* Setup both descriptors to transmit the frame. */
\r
221 xTxDescriptors[ 0 ].buf_p = ( char * ) uip_buf;
\r
222 xTxDescriptors[ 0 ].bufsize = uip_len;
\r
223 xTxDescriptors[ 1 ].buf_p = ( char * ) uip_buf;
\r
224 xTxDescriptors[ 1 ].bufsize = uip_len;
\r
226 /* uip_buf is being sent by the Tx descriptor. Allocate a new buffer
\r
227 for use by the stack. */
\r
228 uip_buf = prvGetNextBuffer();
\r
230 /* Clear previous settings and go. */
\r
231 xTxDescriptors[0].status &= ~( FP1 | FP0 );
\r
232 xTxDescriptors[0].status |= ( FP1 | FP0 | ACT );
\r
233 xTxDescriptors[1].status &= ~( FP1 | FP0 );
\r
234 xTxDescriptors[1].status |= ( FP1 | FP0 | ACT );
\r
236 EDMAC.EDTRR.LONG = 0x00000001;
\r
238 /*-----------------------------------------------------------*/
\r
240 unsigned long ulEMACRead( void )
\r
242 unsigned long ulBytesReceived;
\r
244 ulBytesReceived = prvCheckRxFifoStatus();
\r
246 if( ulBytesReceived > 0 )
\r
248 xCurrentRxDesc->status &= ~( FP1 | FP0 );
\r
249 xCurrentRxDesc->status |= ACT;
\r
251 if( EDMAC.EDRRR.LONG == 0x00000000L )
\r
253 /* Restart Ethernet if it has stopped */
\r
254 EDMAC.EDRRR.LONG = 0x00000001L;
\r
257 /* Mark the pxDescriptor buffer as free as uip_buf is going to be set to
\r
258 the buffer that contains the received data. */
\r
259 prvReturnBuffer( uip_buf );
\r
261 uip_buf = ( void * ) xCurrentRxDesc->buf_p;
\r
263 /* Move onto the next buffer in the ring. */
\r
264 xCurrentRxDesc = xCurrentRxDesc->next;
\r
267 return ulBytesReceived;
\r
269 /*-----------------------------------------------------------*/
\r
271 long lEMACWaitForLink( void )
\r
275 /* Set the link status. */
\r
276 switch( phy_set_autonegotiate() )
\r
278 /* Half duplex link */
\r
279 case PHY_LINK_100H:
\r
280 ETHERC.ECMR.BIT.DM = 0;
\r
281 ETHERC.ECMR.BIT.RTM = 1;
\r
286 ETHERC.ECMR.BIT.DM = 0;
\r
287 ETHERC.ECMR.BIT.RTM = 0;
\r
292 /* Full duplex link */
\r
293 case PHY_LINK_100F:
\r
294 ETHERC.ECMR.BIT.DM = 1;
\r
295 ETHERC.ECMR.BIT.RTM = 1;
\r
300 ETHERC.ECMR.BIT.DM = 1;
\r
301 ETHERC.ECMR.BIT.RTM = 0;
\r
310 if( lReturn == pdPASS )
\r
312 /* Enable receive and transmit. */
\r
313 ETHERC.ECMR.BIT.RE = 1;
\r
314 ETHERC.ECMR.BIT.TE = 1;
\r
316 /* Enable EDMAC receive */
\r
317 EDMAC.EDRRR.LONG = 0x1;
\r
322 /*-----------------------------------------------------------*/
\r
324 static void prvInitialiseDescriptors( void )
\r
326 ethfifo *pxDescriptor;
\r
329 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
331 /* Ensure none of the buffers are shown as in use at the start. */
\r
332 ucBufferInUse[ x ] = pdFALSE;
\r
335 /* Initialise the Rx descriptors. */
\r
336 for( x = 0; x < emacNUM_RX_DESCRIPTORS; x++ )
\r
338 pxDescriptor = &( xRxDescriptors[ x ] );
\r
339 pxDescriptor->buf_p = &( xEthernetBuffers.cBuffer[ x ][ 0 ] );
\r
341 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
342 pxDescriptor->size = 0;
\r
343 pxDescriptor->status = ACT;
\r
344 pxDescriptor->next = &xRxDescriptors[ x + 1 ];
\r
346 /* Mark this buffer as in use. */
\r
347 ucBufferInUse[ x ] = pdTRUE;
\r
350 /* The last descriptor points back to the start. */
\r
351 pxDescriptor->status |= DL;
\r
352 pxDescriptor->next = &xRxDescriptors[ 0 ];
\r
354 /* Initialise the Tx descriptors. */
\r
355 for( x = 0; x < emacNUM_TX_BUFFERS; x++ )
\r
357 pxDescriptor = &( xTxDescriptors[ x ] );
\r
359 /* A buffer is not allocated to the Tx descriptor until a send is
\r
360 actually required. */
\r
361 pxDescriptor->buf_p = NULL;
\r
363 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
364 pxDescriptor->size = 0;
\r
365 pxDescriptor->status = 0;
\r
366 pxDescriptor->next = &xTxDescriptors[ x + 1 ];
\r
369 /* The last descriptor points back to the start. */
\r
370 pxDescriptor->status |= DL;
\r
371 pxDescriptor->next = &( xTxDescriptors[ 0 ] );
\r
373 /* Use the first Rx descriptor to start with. */
\r
374 xCurrentRxDesc = &( xRxDescriptors[ 0 ] );
\r
376 /*-----------------------------------------------------------*/
\r
378 static unsigned char *prvGetNextBuffer( void )
\r
381 unsigned char *pucReturn = NULL;
\r
382 unsigned long ulAttempts = 0;
\r
384 while( pucReturn == NULL )
\r
386 /* Look through the buffers to find one that is not in use by
\r
388 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
390 if( ucBufferInUse[ x ] == pdFALSE )
\r
392 ucBufferInUse[ x ] = pdTRUE;
\r
393 pucReturn = ( unsigned char * ) &( xEthernetBuffers.cBuffer[ x ][ 0 ] );
\r
398 /* Was a buffer found? */
\r
399 if( pucReturn == NULL )
\r
403 if( ulAttempts >= emacBUFFER_WAIT_ATTEMPTS )
\r
408 /* Wait then look again. */
\r
409 vTaskDelay( emacBUFFER_WAIT_DELAY_ms );
\r
415 /*-----------------------------------------------------------*/
\r
417 static void prvReturnBuffer( unsigned char *pucBuffer )
\r
421 /* Return a buffer to the pool of free buffers. */
\r
422 for( ul = 0; ul < emacNUM_BUFFERS; ul++ )
\r
424 if( &( xEthernetBuffers.cBuffer[ ul ][ 0 ] ) == ( void * ) pucBuffer )
\r
426 ucBufferInUse[ ul ] = pdFALSE;
\r
431 /*-----------------------------------------------------------*/
\r
433 static void prvResetEverything( void )
\r
435 /* Temporary code just to see if this gets called. This function has not
\r
436 been implemented. */
\r
437 portDISABLE_INTERRUPTS();
\r
440 /*-----------------------------------------------------------*/
\r
442 static unsigned long prvCheckRxFifoStatus( void )
\r
444 unsigned long ulReturn = 0;
\r
446 if( ( xCurrentRxDesc->status & ACT ) != 0 )
\r
448 /* Current descriptor is still active. */
\r
450 else if( ( xCurrentRxDesc->status & FE ) != 0 )
\r
452 /* Frame error. Clear the error. */
\r
453 xCurrentRxDesc->status &= ~( FP1 | FP0 | FE );
\r
454 xCurrentRxDesc->status &= ~( RMAF | RRF | RTLF | RTSF | PRE | CERF );
\r
455 xCurrentRxDesc->status |= ACT;
\r
456 xCurrentRxDesc = xCurrentRxDesc->next;
\r
458 if( EDMAC.EDRRR.LONG == 0x00000000UL )
\r
460 /* Restart Ethernet if it has stopped. */
\r
461 EDMAC.EDRRR.LONG = 0x00000001UL;
\r
466 /* The descriptor contains a frame. Because of the size of the buffers
\r
467 the frame should always be complete. */
\r
468 if( (xCurrentRxDesc->status & FP0) == FP0 )
\r
470 ulReturn = xCurrentRxDesc->size;
\r
474 /* Do not expect to get here. */
\r
475 prvResetEverything();
\r
481 /*-----------------------------------------------------------*/
\r
483 static void prvResetMAC( void )
\r
485 /* Ensure the EtherC and EDMAC are enabled. */
\r
486 SYSTEM.MSTPCRB.BIT.MSTPB15 = 0;
\r
487 vTaskDelay( 100 / portTICK_RATE_MS );
\r
489 EDMAC.EDMR.BIT.SWR = 1;
\r
491 /* Crude wait for reset to complete. */
\r
492 vTaskDelay( 500 / portTICK_RATE_MS );
\r
494 /*-----------------------------------------------------------*/
\r
496 static void prvConfigureEtherCAndEDMAC( void )
\r
498 /* Initialisation code taken from Renesas example project. */
\r
500 /* TODO: Check bit 5 */
\r
501 ETHERC.ECSR.LONG = 0x00000037; /* Clear all ETHERC statuS BFR, PSRTO, LCHNG, MPD, ICD */
\r
503 /* Set the EDMAC interrupt priority. */
\r
504 _IPR( _ETHER_EINT ) = configKERNEL_INTERRUPT_PRIORITY;
\r
506 /* TODO: Check bit 5 */
\r
507 /* Enable interrupts of interest only. */
\r
508 EDMAC.EESIPR.LONG = emacTX_END_INTERRUPT | emacRX_END_INTERRUPT;
\r
509 ETHERC.RFLR.LONG = 1518; /* Ether payload is 1500+ CRC */
\r
510 ETHERC.IPGR.LONG = 0x00000014; /* Intergap is 96-bit time */
\r
513 EDMAC.EESR.LONG = 0x47FF0F9F; /* Clear all ETHERC and EDMAC status bits */
\r
515 EDMAC.EDMR.BIT.DE = 1;
\r
517 EDMAC.RDLAR = ( void * ) xCurrentRxDesc; /* Initialaize Rx Descriptor List Address */
\r
518 EDMAC.TDLAR = &( xTxDescriptors[ 0 ] ); /* Initialaize Tx Descriptor List Address */
\r
519 EDMAC.TRSCER.LONG = 0x00000000; /* Copy-back status is RFE & TFE only */
\r
520 EDMAC.TFTR.LONG = 0x00000000; /* Threshold of Tx_FIFO */
\r
521 EDMAC.FDR.LONG = 0x00000000; /* Transmit fifo & receive fifo is 256 bytes */
\r
522 EDMAC.RMCR.LONG = 0x00000003; /* Receive function is normal mode(continued) */
\r
524 /* Enable the interrupt... */
\r
525 _IEN( _ETHER_EINT ) = 1;
\r
527 /*-----------------------------------------------------------*/
\r
529 #pragma interrupt ( vEMAC_ISR_Handler( vect = VECT_ETHER_EINT, enable ) )
\r
530 void vEMAC_ISR_Handler( void )
\r
532 unsigned long ul = EDMAC.EESR.LONG;
\r
533 long lHigherPriorityTaskWoken = pdFALSE;
\r
534 extern xSemaphoreHandle xEMACSemaphore;
\r
535 static long ulTxEndInts = 0;
\r
537 /* Has a Tx end occurred? */
\r
538 if( ul & emacTX_END_INTERRUPT )
\r
541 if( ulTxEndInts >= 2 )
\r
543 /* Only return the buffer to the pool once both Txes have completed. */
\r
544 prvReturnBuffer( ( void * ) xTxDescriptors[ 0 ].buf_p );
\r
547 EDMAC.EESR.LONG = emacTX_END_INTERRUPT;
\r
550 /* Has an Rx end occurred? */
\r
551 if( ul & emacRX_END_INTERRUPT )
\r
553 /* Make sure the Ethernet task is not blocked waiting for a packet. */
\r
554 xSemaphoreGiveFromISR( xEMACSemaphore, &lHigherPriorityTaskWoken );
\r
555 portYIELD_FROM_ISR( lHigherPriorityTaskWoken );
\r
556 EDMAC.EESR.LONG = emacRX_END_INTERRUPT;
\r