2 FreeRTOS V7.1.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 "platform.h"
\r
56 #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 8
\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 ( 50 )
\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 *pxCurrentRxDesc = 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 /* Mark the pxDescriptor buffer as free as uip_buf is going to be set to
\r
249 the buffer that contains the received data. */
\r
250 prvReturnBuffer( uip_buf );
\r
252 /* Point uip_buf to the data about ot be processed. */
\r
253 uip_buf = ( void * ) pxCurrentRxDesc->buf_p;
\r
255 /* Allocate a new buffer to the descriptor, as uip_buf is now using it's
\r
257 pxCurrentRxDesc->buf_p = prvGetNextBuffer();
\r
259 /* Prepare the descriptor to go again. */
\r
260 pxCurrentRxDesc->status &= ~( FP1 | FP0 );
\r
261 pxCurrentRxDesc->status |= ACT;
\r
263 /* Move onto the next buffer in the ring. */
\r
264 pxCurrentRxDesc = pxCurrentRxDesc->next;
\r
266 if( EDMAC.EDRRR.LONG == 0x00000000L )
\r
268 /* Restart Ethernet if it has stopped */
\r
269 EDMAC.EDRRR.LONG = 0x00000001L;
\r
273 return ulBytesReceived;
\r
275 /*-----------------------------------------------------------*/
\r
277 long lEMACWaitForLink( void )
\r
281 /* Set the link status. */
\r
282 switch( phy_set_autonegotiate() )
\r
284 /* Half duplex link */
\r
285 case PHY_LINK_100H:
\r
286 ETHERC.ECMR.BIT.DM = 0;
\r
287 ETHERC.ECMR.BIT.RTM = 1;
\r
292 ETHERC.ECMR.BIT.DM = 0;
\r
293 ETHERC.ECMR.BIT.RTM = 0;
\r
298 /* Full duplex link */
\r
299 case PHY_LINK_100F:
\r
300 ETHERC.ECMR.BIT.DM = 1;
\r
301 ETHERC.ECMR.BIT.RTM = 1;
\r
306 ETHERC.ECMR.BIT.DM = 1;
\r
307 ETHERC.ECMR.BIT.RTM = 0;
\r
316 if( lReturn == pdPASS )
\r
318 /* Enable receive and transmit. */
\r
319 ETHERC.ECMR.BIT.RE = 1;
\r
320 ETHERC.ECMR.BIT.TE = 1;
\r
322 /* Enable EDMAC receive */
\r
323 EDMAC.EDRRR.LONG = 0x1;
\r
328 /*-----------------------------------------------------------*/
\r
330 static void prvInitialiseDescriptors( void )
\r
332 ethfifo *pxDescriptor;
\r
335 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
337 /* Ensure none of the buffers are shown as in use at the start. */
\r
338 ucBufferInUse[ x ] = pdFALSE;
\r
341 /* Initialise the Rx descriptors. */
\r
342 for( x = 0; x < emacNUM_RX_DESCRIPTORS; x++ )
\r
344 pxDescriptor = &( xRxDescriptors[ x ] );
\r
345 pxDescriptor->buf_p = &( xEthernetBuffers.cBuffer[ x ][ 0 ] );
\r
347 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
348 pxDescriptor->size = 0;
\r
349 pxDescriptor->status = ACT;
\r
350 pxDescriptor->next = &xRxDescriptors[ x + 1 ];
\r
352 /* Mark this buffer as in use. */
\r
353 ucBufferInUse[ x ] = pdTRUE;
\r
356 /* The last descriptor points back to the start. */
\r
357 pxDescriptor->status |= DL;
\r
358 pxDescriptor->next = &xRxDescriptors[ 0 ];
\r
360 /* Initialise the Tx descriptors. */
\r
361 for( x = 0; x < emacNUM_TX_BUFFERS; x++ )
\r
363 pxDescriptor = &( xTxDescriptors[ x ] );
\r
365 /* A buffer is not allocated to the Tx descriptor until a send is
\r
366 actually required. */
\r
367 pxDescriptor->buf_p = NULL;
\r
369 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
370 pxDescriptor->size = 0;
\r
371 pxDescriptor->status = 0;
\r
372 pxDescriptor->next = &xTxDescriptors[ x + 1 ];
\r
375 /* The last descriptor points back to the start. */
\r
376 pxDescriptor->status |= DL;
\r
377 pxDescriptor->next = &( xTxDescriptors[ 0 ] );
\r
379 /* Use the first Rx descriptor to start with. */
\r
380 pxCurrentRxDesc = &( xRxDescriptors[ 0 ] );
\r
382 /*-----------------------------------------------------------*/
\r
384 static unsigned char *prvGetNextBuffer( void )
\r
387 unsigned char *pucReturn = NULL;
\r
388 unsigned long ulAttempts = 0;
\r
390 while( pucReturn == NULL )
\r
392 /* Look through the buffers to find one that is not in use by
\r
394 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
396 if( ucBufferInUse[ x ] == pdFALSE )
\r
398 ucBufferInUse[ x ] = pdTRUE;
\r
399 pucReturn = ( unsigned char * ) &( xEthernetBuffers.cBuffer[ x ][ 0 ] );
\r
404 /* Was a buffer found? */
\r
405 if( pucReturn == NULL )
\r
409 if( ulAttempts >= emacBUFFER_WAIT_ATTEMPTS )
\r
414 /* Wait then look again. */
\r
415 vTaskDelay( emacBUFFER_WAIT_DELAY_ms );
\r
421 /*-----------------------------------------------------------*/
\r
423 static void prvReturnBuffer( unsigned char *pucBuffer )
\r
427 /* Return a buffer to the pool of free buffers. */
\r
428 for( ul = 0; ul < emacNUM_BUFFERS; ul++ )
\r
430 if( &( xEthernetBuffers.cBuffer[ ul ][ 0 ] ) == ( void * ) pucBuffer )
\r
432 ucBufferInUse[ ul ] = pdFALSE;
\r
437 /*-----------------------------------------------------------*/
\r
439 static void prvResetEverything( void )
\r
441 /* Temporary code just to see if this gets called. This function has not
\r
442 been implemented. */
\r
443 portDISABLE_INTERRUPTS();
\r
446 /*-----------------------------------------------------------*/
\r
448 static unsigned long prvCheckRxFifoStatus( void )
\r
450 unsigned long ulReturn = 0;
\r
452 if( ( pxCurrentRxDesc->status & ACT ) != 0 )
\r
454 /* Current descriptor is still active. */
\r
456 else if( ( pxCurrentRxDesc->status & FE ) != 0 )
\r
458 /* Frame error. Clear the error. */
\r
459 pxCurrentRxDesc->status &= ~( FP1 | FP0 | FE );
\r
460 pxCurrentRxDesc->status &= ~( RMAF | RRF | RTLF | RTSF | PRE | CERF );
\r
461 pxCurrentRxDesc->status |= ACT;
\r
462 pxCurrentRxDesc = pxCurrentRxDesc->next;
\r
464 if( EDMAC.EDRRR.LONG == 0x00000000UL )
\r
466 /* Restart Ethernet if it has stopped. */
\r
467 EDMAC.EDRRR.LONG = 0x00000001UL;
\r
472 /* The descriptor contains a frame. Because of the size of the buffers
\r
473 the frame should always be complete. */
\r
474 if( ( pxCurrentRxDesc->status & FP0 ) == FP0 )
\r
476 ulReturn = pxCurrentRxDesc->size;
\r
480 /* Do not expect to get here. */
\r
481 prvResetEverything();
\r
487 /*-----------------------------------------------------------*/
\r
489 static void prvResetMAC( void )
\r
491 /* Ensure the EtherC and EDMAC are enabled. */
\r
492 SYSTEM.MSTPCRB.BIT.MSTPB15 = 0;
\r
493 vTaskDelay( 100 / portTICK_RATE_MS );
\r
495 EDMAC.EDMR.BIT.SWR = 1;
\r
497 /* Crude wait for reset to complete. */
\r
498 vTaskDelay( 500 / portTICK_RATE_MS );
\r
500 /*-----------------------------------------------------------*/
\r
502 static void prvConfigureEtherCAndEDMAC( void )
\r
504 /* Initialisation code taken from Renesas example project. */
\r
506 /* TODO: Check bit 5 */
\r
507 ETHERC.ECSR.LONG = 0x00000037; /* Clear all ETHERC statuS BFR, PSRTO, LCHNG, MPD, ICD */
\r
509 /* Set the EDMAC interrupt priority. */
\r
510 _IPR( _ETHER_EINT ) = configKERNEL_INTERRUPT_PRIORITY;
\r
512 /* TODO: Check bit 5 */
\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