2 FreeRTOS V7.4.0 - Copyright (C) 2013 Real Time Engineers Ltd.
\r
4 FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME. PLEASE VISIT
\r
5 http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 ***************************************************************************
\r
9 * FreeRTOS tutorial books are available in pdf and paperback. *
\r
10 * Complete, revised, and edited pdf reference manuals are also *
\r
13 * Purchasing FreeRTOS documentation will not only help you, by *
\r
14 * ensuring you get running as quickly as possible and with an *
\r
15 * in-depth knowledge of how to use FreeRTOS, it will also help *
\r
16 * the FreeRTOS project to continue with its mission of providing *
\r
17 * professional grade, cross platform, de facto standard solutions *
\r
18 * for microcontrollers - completely free of charge! *
\r
20 * >>> See http://www.FreeRTOS.org/Documentation for details. <<< *
\r
22 * Thank you for using FreeRTOS, and thank you for your support! *
\r
24 ***************************************************************************
\r
27 This file is part of the FreeRTOS distribution.
\r
29 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
30 the terms of the GNU General Public License (version 2) as published by the
\r
31 Free Software Foundation AND MODIFIED BY the FreeRTOS exception.
\r
33 >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to
\r
34 distribute a combined work that includes FreeRTOS without being obliged to
\r
35 provide the source code for proprietary components outside of the FreeRTOS
\r
38 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
39 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
40 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
\r
41 details. You should have received a copy of the GNU General Public License
\r
42 and the FreeRTOS license exception along with FreeRTOS; if not itcan be
\r
43 viewed here: http://www.freertos.org/a00114.html and also obtained by
\r
44 writing to Real Time Engineers Ltd., contact details for whom are available
\r
45 on the FreeRTOS WEB site.
\r
49 ***************************************************************************
\r
51 * Having a problem? Start by reading the FAQ "My application does *
\r
52 * not run, what could be wrong?" *
\r
54 * http://www.FreeRTOS.org/FAQHelp.html *
\r
56 ***************************************************************************
\r
59 http://www.FreeRTOS.org - Documentation, books, training, latest versions,
\r
60 license and Real Time Engineers Ltd. contact details.
\r
62 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
63 including FreeRTOS+Trace - an indispensable productivity tool, and our new
\r
64 fully thread aware and reentrant UDP/IP stack.
\r
66 http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High
\r
67 Integrity Systems, who sell the code with commercial support,
\r
68 indemnification and middleware, under the OpenRTOS brand.
\r
70 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
71 engineered and independently SIL3 certified version for use in safety and
\r
72 mission critical applications that require provable dependability.
\r
75 /* Hardware specific includes. */
\r
76 #include "platform.h"
\r
77 #include "r_ether.h"
\r
80 /* FreeRTOS includes. */
\r
81 #include "FreeRTOS.h"
\r
86 #include "net/uip.h"
\r
88 /* The time to wait between attempts to obtain a free buffer. */
\r
89 #define emacBUFFER_WAIT_DELAY_ms ( 3 / portTICK_PERIOD_MS )
\r
91 /* The number of times emacBUFFER_WAIT_DELAY_ms should be waited before giving
\r
92 up on attempting to obtain a free buffer all together. */
\r
93 #define emacBUFFER_WAIT_ATTEMPTS ( 30 )
\r
95 /* The number of Rx descriptors. */
\r
96 #define emacNUM_RX_DESCRIPTORS 8
\r
98 /* The number of Tx descriptors. When using uIP there is not point in having
\r
100 #define emacNUM_TX_BUFFERS 2
\r
102 /* The total number of EMAC buffers to allocate. */
\r
103 #define emacNUM_BUFFERS ( emacNUM_RX_DESCRIPTORS + emacNUM_TX_BUFFERS )
\r
105 /* The time to wait for the Tx descriptor to become free. */
\r
106 #define emacTX_WAIT_DELAY_ms ( 10 / portTICK_PERIOD_MS )
\r
108 /* The total number of times to wait emacTX_WAIT_DELAY_ms for the Tx descriptor to
\r
110 #define emacTX_WAIT_ATTEMPTS ( 50 )
\r
112 /* Only Rx end and Tx end interrupts are used by this driver. */
\r
113 #define emacTX_END_INTERRUPT ( 1UL << 21UL )
\r
114 #define emacRX_END_INTERRUPT ( 1UL << 18UL )
\r
116 /*-----------------------------------------------------------*/
\r
118 /* The buffers and descriptors themselves. */
\r
119 #pragma section _RX_DESC
\r
120 volatile ethfifo xRxDescriptors[ emacNUM_RX_DESCRIPTORS ];
\r
121 #pragma section _TX_DESC
\r
122 volatile ethfifo xTxDescriptors[ emacNUM_TX_BUFFERS ];
\r
123 #pragma section _ETHERNET_BUFFERS
\r
126 unsigned long ulAlignmentVariable;
\r
127 char cBuffer[ emacNUM_BUFFERS ][ UIP_BUFSIZE ];
\r
128 } xEthernetBuffers;
\r
134 /* Used to indicate which buffers are free and which are in use. If an index
\r
135 contains 0 then the corresponding buffer in xEthernetBuffers is free, otherwise
\r
136 the buffer is in use or about to be used. */
\r
137 static unsigned char ucBufferInUse[ emacNUM_BUFFERS ];
\r
139 /*-----------------------------------------------------------*/
\r
142 * Initialise both the Rx and Tx descriptors.
\r
144 static void prvInitialiseDescriptors( void );
\r
147 * Return a pointer to a free buffer within xEthernetBuffers.
\r
149 static unsigned char *prvGetNextBuffer( void );
\r
152 * Return a buffer to the list of free buffers.
\r
154 static void prvReturnBuffer( unsigned char *pucBuffer );
\r
157 * Examine the status of the next Rx FIFO to see if it contains new data.
\r
159 static unsigned long prvCheckRxFifoStatus( void );
\r
162 * Setup the microcontroller for communication with the PHY.
\r
164 static void prvResetMAC( void );
\r
167 * Configure the Ethernet interface peripherals.
\r
169 static void prvConfigureEtherCAndEDMAC( void );
\r
172 * Something has gone wrong with the descriptor usage. Reset all the buffers
\r
175 static void prvResetEverything( void );
\r
177 /*-----------------------------------------------------------*/
\r
179 /* Points to the Rx descriptor currently in use. */
\r
180 static ethfifo *pxCurrentRxDesc = NULL;
\r
182 /* The buffer used by the uIP stack to both receive and send. This points to
\r
183 one of the Ethernet buffers when its actually in use. */
\r
184 unsigned char *uip_buf = NULL;
\r
186 /*-----------------------------------------------------------*/
\r
188 void vInitEmac( void )
\r
190 /* Software reset. */
\r
193 /* Set the Rx and Tx descriptors into their initial state. */
\r
194 prvInitialiseDescriptors();
\r
196 /* Set the MAC address into the ETHERC */
\r
197 ETHERC.MAHR = ( ( unsigned long ) configMAC_ADDR0 << 24UL ) |
\r
198 ( ( unsigned long ) configMAC_ADDR1 << 16UL ) |
\r
199 ( ( unsigned long ) configMAC_ADDR2 << 8UL ) |
\r
200 ( unsigned long ) configMAC_ADDR3;
\r
202 ETHERC.MALR.BIT.MA = ( ( unsigned long ) configMAC_ADDR4 << 8UL ) |
\r
203 ( unsigned long ) configMAC_ADDR5;
\r
205 /* Perform rest of interface hardware configuration. */
\r
206 prvConfigureEtherCAndEDMAC();
\r
208 /* Nothing received yet, so uip_buf points nowhere. */
\r
211 /* Initialize the PHY */
\r
214 /*-----------------------------------------------------------*/
\r
216 void vEMACWrite( void )
\r
220 /* Wait until the second transmission of the last packet has completed. */
\r
221 for( x = 0; x < emacTX_WAIT_ATTEMPTS; x++ )
\r
223 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
225 /* Descriptor is still active. */
\r
226 vTaskDelay( emacTX_WAIT_DELAY_ms );
\r
234 /* Is the descriptor free after waiting for it? */
\r
235 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
237 /* Something has gone wrong. */
\r
238 prvResetEverything();
\r
241 /* Setup both descriptors to transmit the frame. */
\r
242 xTxDescriptors[ 0 ].buf_p = ( char * ) uip_buf;
\r
243 xTxDescriptors[ 0 ].bufsize = uip_len;
\r
244 xTxDescriptors[ 1 ].buf_p = ( char * ) uip_buf;
\r
245 xTxDescriptors[ 1 ].bufsize = uip_len;
\r
247 /* uip_buf is being sent by the Tx descriptor. Allocate a new buffer
\r
248 for use by the stack. */
\r
249 uip_buf = prvGetNextBuffer();
\r
251 /* Clear previous settings and go. */
\r
252 xTxDescriptors[0].status &= ~( FP1 | FP0 );
\r
253 xTxDescriptors[0].status |= ( FP1 | FP0 | ACT );
\r
254 xTxDescriptors[1].status &= ~( FP1 | FP0 );
\r
255 xTxDescriptors[1].status |= ( FP1 | FP0 | ACT );
\r
257 EDMAC.EDTRR.LONG = 0x00000001;
\r
259 /*-----------------------------------------------------------*/
\r
261 unsigned long ulEMACRead( void )
\r
263 unsigned long ulBytesReceived;
\r
265 ulBytesReceived = prvCheckRxFifoStatus();
\r
267 if( ulBytesReceived > 0 )
\r
269 /* Mark the pxDescriptor buffer as free as uip_buf is going to be set to
\r
270 the buffer that contains the received data. */
\r
271 prvReturnBuffer( uip_buf );
\r
273 /* Point uip_buf to the data about ot be processed. */
\r
274 uip_buf = ( void * ) pxCurrentRxDesc->buf_p;
\r
276 /* Allocate a new buffer to the descriptor, as uip_buf is now using it's
\r
278 pxCurrentRxDesc->buf_p = prvGetNextBuffer();
\r
280 /* Prepare the descriptor to go again. */
\r
281 pxCurrentRxDesc->status &= ~( FP1 | FP0 );
\r
282 pxCurrentRxDesc->status |= ACT;
\r
284 /* Move onto the next buffer in the ring. */
\r
285 pxCurrentRxDesc = pxCurrentRxDesc->next;
\r
287 if( EDMAC.EDRRR.LONG == 0x00000000L )
\r
289 /* Restart Ethernet if it has stopped */
\r
290 EDMAC.EDRRR.LONG = 0x00000001L;
\r
294 return ulBytesReceived;
\r
296 /*-----------------------------------------------------------*/
\r
298 long lEMACWaitForLink( void )
\r
302 /* Set the link status. */
\r
303 switch( phy_set_autonegotiate() )
\r
305 /* Half duplex link */
\r
306 case PHY_LINK_100H:
\r
307 ETHERC.ECMR.BIT.DM = 0;
\r
308 ETHERC.ECMR.BIT.RTM = 1;
\r
313 ETHERC.ECMR.BIT.DM = 0;
\r
314 ETHERC.ECMR.BIT.RTM = 0;
\r
319 /* Full duplex link */
\r
320 case PHY_LINK_100F:
\r
321 ETHERC.ECMR.BIT.DM = 1;
\r
322 ETHERC.ECMR.BIT.RTM = 1;
\r
327 ETHERC.ECMR.BIT.DM = 1;
\r
328 ETHERC.ECMR.BIT.RTM = 0;
\r
337 if( lReturn == pdPASS )
\r
339 /* Enable receive and transmit. */
\r
340 ETHERC.ECMR.BIT.RE = 1;
\r
341 ETHERC.ECMR.BIT.TE = 1;
\r
343 /* Enable EDMAC receive */
\r
344 EDMAC.EDRRR.LONG = 0x1;
\r
349 /*-----------------------------------------------------------*/
\r
351 static void prvInitialiseDescriptors( void )
\r
353 ethfifo *pxDescriptor;
\r
356 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
358 /* Ensure none of the buffers are shown as in use at the start. */
\r
359 ucBufferInUse[ x ] = pdFALSE;
\r
362 /* Initialise the Rx descriptors. */
\r
363 for( x = 0; x < emacNUM_RX_DESCRIPTORS; x++ )
\r
365 pxDescriptor = &( xRxDescriptors[ x ] );
\r
366 pxDescriptor->buf_p = &( xEthernetBuffers.cBuffer[ x ][ 0 ] );
\r
368 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
369 pxDescriptor->size = 0;
\r
370 pxDescriptor->status = ACT;
\r
371 pxDescriptor->next = &xRxDescriptors[ x + 1 ];
\r
373 /* Mark this buffer as in use. */
\r
374 ucBufferInUse[ x ] = pdTRUE;
\r
377 /* The last descriptor points back to the start. */
\r
378 pxDescriptor->status |= DL;
\r
379 pxDescriptor->next = &xRxDescriptors[ 0 ];
\r
381 /* Initialise the Tx descriptors. */
\r
382 for( x = 0; x < emacNUM_TX_BUFFERS; x++ )
\r
384 pxDescriptor = &( xTxDescriptors[ x ] );
\r
386 /* A buffer is not allocated to the Tx descriptor until a send is
\r
387 actually required. */
\r
388 pxDescriptor->buf_p = NULL;
\r
390 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
391 pxDescriptor->size = 0;
\r
392 pxDescriptor->status = 0;
\r
393 pxDescriptor->next = &xTxDescriptors[ x + 1 ];
\r
396 /* The last descriptor points back to the start. */
\r
397 pxDescriptor->status |= DL;
\r
398 pxDescriptor->next = &( xTxDescriptors[ 0 ] );
\r
400 /* Use the first Rx descriptor to start with. */
\r
401 pxCurrentRxDesc = &( xRxDescriptors[ 0 ] );
\r
403 /*-----------------------------------------------------------*/
\r
405 static unsigned char *prvGetNextBuffer( void )
\r
408 unsigned char *pucReturn = NULL;
\r
409 unsigned long ulAttempts = 0;
\r
411 while( pucReturn == NULL )
\r
413 /* Look through the buffers to find one that is not in use by
\r
415 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
417 if( ucBufferInUse[ x ] == pdFALSE )
\r
419 ucBufferInUse[ x ] = pdTRUE;
\r
420 pucReturn = ( unsigned char * ) &( xEthernetBuffers.cBuffer[ x ][ 0 ] );
\r
425 /* Was a buffer found? */
\r
426 if( pucReturn == NULL )
\r
430 if( ulAttempts >= emacBUFFER_WAIT_ATTEMPTS )
\r
435 /* Wait then look again. */
\r
436 vTaskDelay( emacBUFFER_WAIT_DELAY_ms );
\r
442 /*-----------------------------------------------------------*/
\r
444 static void prvReturnBuffer( unsigned char *pucBuffer )
\r
448 /* Return a buffer to the pool of free buffers. */
\r
449 for( ul = 0; ul < emacNUM_BUFFERS; ul++ )
\r
451 if( &( xEthernetBuffers.cBuffer[ ul ][ 0 ] ) == ( void * ) pucBuffer )
\r
453 ucBufferInUse[ ul ] = pdFALSE;
\r
458 /*-----------------------------------------------------------*/
\r
460 static void prvResetEverything( void )
\r
462 /* Temporary code just to see if this gets called. This function has not
\r
463 been implemented. */
\r
464 portDISABLE_INTERRUPTS();
\r
467 /*-----------------------------------------------------------*/
\r
469 static unsigned long prvCheckRxFifoStatus( void )
\r
471 unsigned long ulReturn = 0;
\r
473 if( ( pxCurrentRxDesc->status & ACT ) != 0 )
\r
475 /* Current descriptor is still active. */
\r
477 else if( ( pxCurrentRxDesc->status & FE ) != 0 )
\r
479 /* Frame error. Clear the error. */
\r
480 pxCurrentRxDesc->status &= ~( FP1 | FP0 | FE );
\r
481 pxCurrentRxDesc->status &= ~( RMAF | RRF | RTLF | RTSF | PRE | CERF );
\r
482 pxCurrentRxDesc->status |= ACT;
\r
483 pxCurrentRxDesc = pxCurrentRxDesc->next;
\r
485 if( EDMAC.EDRRR.LONG == 0x00000000UL )
\r
487 /* Restart Ethernet if it has stopped. */
\r
488 EDMAC.EDRRR.LONG = 0x00000001UL;
\r
493 /* The descriptor contains a frame. Because of the size of the buffers
\r
494 the frame should always be complete. */
\r
495 if( ( pxCurrentRxDesc->status & FP0 ) == FP0 )
\r
497 ulReturn = pxCurrentRxDesc->size;
\r
501 /* Do not expect to get here. */
\r
502 prvResetEverything();
\r
508 /*-----------------------------------------------------------*/
\r
510 static void prvResetMAC( void )
\r
512 /* Ensure the EtherC and EDMAC are enabled. */
\r
513 SYSTEM.MSTPCRB.BIT.MSTPB15 = 0;
\r
514 vTaskDelay( 100 / portTICK_PERIOD_MS );
\r
516 EDMAC.EDMR.BIT.SWR = 1;
\r
518 /* Crude wait for reset to complete. */
\r
519 vTaskDelay( 500 / portTICK_PERIOD_MS );
\r
521 /*-----------------------------------------------------------*/
\r
523 static void prvConfigureEtherCAndEDMAC( void )
\r
525 /* Initialisation code taken from Renesas example project. */
\r
527 /* TODO: Check bit 5 */
\r
528 ETHERC.ECSR.LONG = 0x00000037; /* Clear all ETHERC statuS BFR, PSRTO, LCHNG, MPD, ICD */
\r
530 /* Set the EDMAC interrupt priority. */
\r
531 _IPR( _ETHER_EINT ) = configKERNEL_INTERRUPT_PRIORITY;
\r
533 /* TODO: Check bit 5 */
\r
534 /* Enable interrupts of interest only. */
\r
535 EDMAC.EESIPR.LONG = emacTX_END_INTERRUPT | emacRX_END_INTERRUPT;
\r
536 ETHERC.RFLR.LONG = 1518; /* Ether payload is 1500+ CRC */
\r
537 ETHERC.IPGR.LONG = 0x00000014; /* Intergap is 96-bit time */
\r
540 EDMAC.EESR.LONG = 0x47FF0F9F; /* Clear all ETHERC and EDMAC status bits */
\r
542 EDMAC.EDMR.BIT.DE = 1;
\r
544 EDMAC.RDLAR = ( void * ) pxCurrentRxDesc; /* Initialaize Rx Descriptor List Address */
\r
545 EDMAC.TDLAR = &( xTxDescriptors[ 0 ] ); /* Initialaize Tx Descriptor List Address */
\r
546 EDMAC.TRSCER.LONG = 0x00000000; /* Copy-back status is RFE & TFE only */
\r
547 EDMAC.TFTR.LONG = 0x00000000; /* Threshold of Tx_FIFO */
\r
548 EDMAC.FDR.LONG = 0x00000000; /* Transmit fifo & receive fifo is 256 bytes */
\r
549 EDMAC.RMCR.LONG = 0x00000003; /* Receive function is normal mode(continued) */
\r
550 ETHERC.ECMR.BIT.PRM = 0; /* Ensure promiscuous mode is off. */
\r
552 /* Enable the interrupt... */
\r
553 _IEN( _ETHER_EINT ) = 1;
\r
555 /*-----------------------------------------------------------*/
\r
557 #pragma interrupt ( vEMAC_ISR_Handler( vect = VECT_ETHER_EINT, enable ) )
\r
558 void vEMAC_ISR_Handler( void )
\r
560 unsigned long ul = EDMAC.EESR.LONG;
\r
561 long lHigherPriorityTaskWoken = pdFALSE;
\r
562 extern QueueHandle_t xEMACEventQueue;
\r
563 const unsigned long ulRxEvent = uipETHERNET_RX_EVENT;
\r
565 /* Has a Tx end occurred? */
\r
566 if( ul & emacTX_END_INTERRUPT )
\r
568 /* Only return the buffer to the pool once both Txes have completed. */
\r
569 prvReturnBuffer( ( void * ) xTxDescriptors[ 0 ].buf_p );
\r
570 EDMAC.EESR.LONG = emacTX_END_INTERRUPT;
\r
573 /* Has an Rx end occurred? */
\r
574 if( ul & emacRX_END_INTERRUPT )
\r
576 /* Make sure the Ethernet task is not blocked waiting for a packet. */
\r
577 xQueueSendFromISR( xEMACEventQueue, &ulRxEvent, &lHigherPriorityTaskWoken );
\r
578 portYIELD_FROM_ISR( lHigherPriorityTaskWoken );
\r
579 EDMAC.EESR.LONG = emacRX_END_INTERRUPT;
\r