2 FreeRTOS V7.4.1 - 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 it can 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 "iodefine.h"
\r
77 #include "typedefine.h"
\r
78 #include "r_ether.h"
\r
81 /* FreeRTOS includes. */
\r
82 #include "FreeRTOS.h"
\r
87 #include "net/uip.h"
\r
89 /* The time to wait between attempts to obtain a free buffer. */
\r
90 #define emacBUFFER_WAIT_DELAY_ms ( 3 / portTICK_RATE_MS )
\r
92 /* The number of times emacBUFFER_WAIT_DELAY_ms should be waited before giving
\r
93 up on attempting to obtain a free buffer all together. */
\r
94 #define emacBUFFER_WAIT_ATTEMPTS ( 30 )
\r
96 /* The number of Rx descriptors. */
\r
97 #define emacNUM_RX_DESCRIPTORS 8
\r
99 /* The number of Tx descriptors. When using uIP there is not point in having
\r
101 #define emacNUM_TX_BUFFERS 2
\r
103 /* The total number of EMAC buffers to allocate. */
\r
104 #define emacNUM_BUFFERS ( emacNUM_RX_DESCRIPTORS + emacNUM_TX_BUFFERS )
\r
106 /* The time to wait for the Tx descriptor to become free. */
\r
107 #define emacTX_WAIT_DELAY_ms ( 10 / portTICK_RATE_MS )
\r
109 /* The total number of times to wait emacTX_WAIT_DELAY_ms for the Tx descriptor to
\r
111 #define emacTX_WAIT_ATTEMPTS ( 50 )
\r
113 /* Only Rx end and Tx end interrupts are used by this driver. */
\r
114 #define emacTX_END_INTERRUPT ( 1UL << 21UL )
\r
115 #define emacRX_END_INTERRUPT ( 1UL << 18UL )
\r
117 /*-----------------------------------------------------------*/
\r
119 /* The buffers and descriptors themselves. */
\r
120 static volatile ethfifo xRxDescriptors[ emacNUM_RX_DESCRIPTORS ] __attribute__((aligned(16)));
\r
121 static volatile ethfifo xTxDescriptors[ emacNUM_TX_BUFFERS ] __attribute__((aligned(16)));
\r
122 static char xEthernetBuffers[ emacNUM_BUFFERS ][ UIP_BUFSIZE ] __attribute__((aligned(16)));
\r
124 /* Used to indicate which buffers are free and which are in use. If an index
\r
125 contains 0 then the corresponding buffer in xEthernetBuffers is free, otherwise
\r
126 the buffer is in use or about to be used. */
\r
127 static unsigned char ucBufferInUse[ emacNUM_BUFFERS ];
\r
129 /*-----------------------------------------------------------*/
\r
132 * Initialise both the Rx and Tx descriptors.
\r
134 static void prvInitialiseDescriptors( void );
\r
137 * Return a pointer to a free buffer within xEthernetBuffers.
\r
139 static unsigned char *prvGetNextBuffer( void );
\r
142 * Return a buffer to the list of free buffers.
\r
144 static void prvReturnBuffer( unsigned char *pucBuffer );
\r
147 * Examine the status of the next Rx FIFO to see if it contains new data.
\r
149 static unsigned long prvCheckRxFifoStatus( void );
\r
152 * Setup the microcontroller for communication with the PHY.
\r
154 static void prvResetMAC( void );
\r
157 * Configure the Ethernet interface peripherals.
\r
159 static void prvConfigureEtherCAndEDMAC( void );
\r
162 * Something has gone wrong with the descriptor usage. Reset all the buffers
\r
165 static void prvResetEverything( void );
\r
168 * Handler for the EMAC peripheral. See the documentation for this
\r
169 * port on http://www.FreeRTOS.org for more information on defining interrupt
\r
172 void vEMAC_ISR_Handler( void ) __attribute__((interrupt));
\r
174 /*-----------------------------------------------------------*/
\r
176 /* Points to the Rx descriptor currently in use. */
\r
177 static ethfifo *pxCurrentRxDesc = NULL;
\r
179 /* The buffer used by the uIP stack to both receive and send. This points to
\r
180 one of the Ethernet buffers when its actually in use. */
\r
181 unsigned char *uip_buf = NULL;
\r
183 /*-----------------------------------------------------------*/
\r
185 void vInitEmac( void )
\r
187 /* Software reset. */
\r
190 /* Set the Rx and Tx descriptors into their initial state. */
\r
191 prvInitialiseDescriptors();
\r
193 /* Set the MAC address into the ETHERC */
\r
194 ETHERC.MAHR = ( ( unsigned long ) configMAC_ADDR0 << 24UL ) |
\r
195 ( ( unsigned long ) configMAC_ADDR1 << 16UL ) |
\r
196 ( ( unsigned long ) configMAC_ADDR2 << 8UL ) |
\r
197 ( unsigned long ) configMAC_ADDR3;
\r
199 ETHERC.MALR.BIT.MA = ( ( unsigned long ) configMAC_ADDR4 << 8UL ) |
\r
200 ( unsigned long ) configMAC_ADDR5;
\r
202 /* Perform rest of interface hardware configuration. */
\r
203 prvConfigureEtherCAndEDMAC();
\r
205 /* Nothing received yet, so uip_buf points nowhere. */
\r
208 /* Initialize the PHY */
\r
211 /*-----------------------------------------------------------*/
\r
213 void vEMACWrite( void )
\r
217 /* Wait until the second transmission of the last packet has completed. */
\r
218 for( x = 0; x < emacTX_WAIT_ATTEMPTS; x++ )
\r
220 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
222 /* Descriptor is still active. */
\r
223 vTaskDelay( emacTX_WAIT_DELAY_ms );
\r
231 /* Is the descriptor free after waiting for it? */
\r
232 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
234 /* Something has gone wrong. */
\r
235 prvResetEverything();
\r
238 /* Setup both descriptors to transmit the frame. */
\r
239 xTxDescriptors[ 0 ].buf_p = ( char * ) uip_buf;
\r
240 xTxDescriptors[ 0 ].bufsize = uip_len;
\r
241 xTxDescriptors[ 1 ].buf_p = ( char * ) uip_buf;
\r
242 xTxDescriptors[ 1 ].bufsize = uip_len;
\r
244 /* uip_buf is being sent by the Tx descriptor. Allocate a new buffer
\r
245 for use by the stack. */
\r
246 uip_buf = prvGetNextBuffer();
\r
248 /* Clear previous settings and go. */
\r
249 xTxDescriptors[0].status &= ~( FP1 | FP0 );
\r
250 xTxDescriptors[0].status |= ( FP1 | FP0 | ACT );
\r
251 xTxDescriptors[1].status &= ~( FP1 | FP0 );
\r
252 xTxDescriptors[1].status |= ( FP1 | FP0 | ACT );
\r
254 EDMAC.EDTRR.LONG = 0x00000001;
\r
256 /*-----------------------------------------------------------*/
\r
258 unsigned long ulEMACRead( void )
\r
260 unsigned long ulBytesReceived;
\r
262 ulBytesReceived = prvCheckRxFifoStatus();
\r
264 if( ulBytesReceived > 0 )
\r
266 /* Mark the pxDescriptor buffer as free as uip_buf is going to be set to
\r
267 the buffer that contains the received data. */
\r
268 prvReturnBuffer( uip_buf );
\r
270 /* Point uip_buf to the data about ot be processed. */
\r
271 uip_buf = ( void * ) pxCurrentRxDesc->buf_p;
\r
273 /* Allocate a new buffer to the descriptor, as uip_buf is now using it's
\r
275 pxCurrentRxDesc->buf_p = ( char * ) prvGetNextBuffer();
\r
277 /* Prepare the descriptor to go again. */
\r
278 pxCurrentRxDesc->status &= ~( FP1 | FP0 );
\r
279 pxCurrentRxDesc->status |= ACT;
\r
281 /* Move onto the next buffer in the ring. */
\r
282 pxCurrentRxDesc = pxCurrentRxDesc->next;
\r
284 if( EDMAC.EDRRR.LONG == 0x00000000L )
\r
286 /* Restart Ethernet if it has stopped */
\r
287 EDMAC.EDRRR.LONG = 0x00000001L;
\r
291 return ulBytesReceived;
\r
293 /*-----------------------------------------------------------*/
\r
295 long lEMACWaitForLink( void )
\r
299 /* Set the link status. */
\r
300 switch( phy_set_autonegotiate() )
\r
302 /* Half duplex link */
\r
303 case PHY_LINK_100H:
\r
304 ETHERC.ECMR.BIT.DM = 0;
\r
305 ETHERC.ECMR.BIT.RTM = 1;
\r
310 ETHERC.ECMR.BIT.DM = 0;
\r
311 ETHERC.ECMR.BIT.RTM = 0;
\r
316 /* Full duplex link */
\r
317 case PHY_LINK_100F:
\r
318 ETHERC.ECMR.BIT.DM = 1;
\r
319 ETHERC.ECMR.BIT.RTM = 1;
\r
324 ETHERC.ECMR.BIT.DM = 1;
\r
325 ETHERC.ECMR.BIT.RTM = 0;
\r
334 if( lReturn == pdPASS )
\r
336 /* Enable receive and transmit. */
\r
337 ETHERC.ECMR.BIT.RE = 1;
\r
338 ETHERC.ECMR.BIT.TE = 1;
\r
340 /* Enable EDMAC receive */
\r
341 EDMAC.EDRRR.LONG = 0x1;
\r
346 /*-----------------------------------------------------------*/
\r
348 static void prvInitialiseDescriptors( void )
\r
350 volatile ethfifo *pxDescriptor;
\r
353 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
355 /* Ensure none of the buffers are shown as in use at the start. */
\r
356 ucBufferInUse[ x ] = pdFALSE;
\r
359 /* Initialise the Rx descriptors. */
\r
360 for( x = 0; x < emacNUM_RX_DESCRIPTORS; x++ )
\r
362 pxDescriptor = &( xRxDescriptors[ x ] );
\r
363 pxDescriptor->buf_p = &( xEthernetBuffers[ x ][ 0 ] );
\r
365 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
366 pxDescriptor->size = 0;
\r
367 pxDescriptor->status = ACT;
\r
368 pxDescriptor->next = ( struct Descriptor * ) &xRxDescriptors[ x + 1 ];
\r
370 /* Mark this buffer as in use. */
\r
371 ucBufferInUse[ x ] = pdTRUE;
\r
374 /* The last descriptor points back to the start. */
\r
375 pxDescriptor->status |= DL;
\r
376 pxDescriptor->next = ( struct Descriptor * ) &xRxDescriptors[ 0 ];
\r
378 /* Initialise the Tx descriptors. */
\r
379 for( x = 0; x < emacNUM_TX_BUFFERS; x++ )
\r
381 pxDescriptor = &( xTxDescriptors[ x ] );
\r
383 /* A buffer is not allocated to the Tx descriptor until a send is
\r
384 actually required. */
\r
385 pxDescriptor->buf_p = NULL;
\r
387 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
388 pxDescriptor->size = 0;
\r
389 pxDescriptor->status = 0;
\r
390 pxDescriptor->next = ( struct Descriptor * ) &xTxDescriptors[ x + 1 ];
\r
393 /* The last descriptor points back to the start. */
\r
394 pxDescriptor->status |= DL;
\r
395 pxDescriptor->next = ( struct Descriptor * ) &( xTxDescriptors[ 0 ] );
\r
397 /* Use the first Rx descriptor to start with. */
\r
398 pxCurrentRxDesc = ( struct Descriptor * ) &( xRxDescriptors[ 0 ] );
\r
400 /*-----------------------------------------------------------*/
\r
402 static unsigned char *prvGetNextBuffer( void )
\r
405 unsigned char *pucReturn = NULL;
\r
406 unsigned long ulAttempts = 0;
\r
408 while( pucReturn == NULL )
\r
410 /* Look through the buffers to find one that is not in use by
\r
412 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
414 if( ucBufferInUse[ x ] == pdFALSE )
\r
416 ucBufferInUse[ x ] = pdTRUE;
\r
417 pucReturn = ( unsigned char * ) &( xEthernetBuffers[ x ][ 0 ] );
\r
422 /* Was a buffer found? */
\r
423 if( pucReturn == NULL )
\r
427 if( ulAttempts >= emacBUFFER_WAIT_ATTEMPTS )
\r
432 /* Wait then look again. */
\r
433 vTaskDelay( emacBUFFER_WAIT_DELAY_ms );
\r
439 /*-----------------------------------------------------------*/
\r
441 static void prvReturnBuffer( unsigned char *pucBuffer )
\r
445 /* Return a buffer to the pool of free buffers. */
\r
446 for( ul = 0; ul < emacNUM_BUFFERS; ul++ )
\r
448 if( &( xEthernetBuffers[ ul ][ 0 ] ) == ( void * ) pucBuffer )
\r
450 ucBufferInUse[ ul ] = pdFALSE;
\r
455 /*-----------------------------------------------------------*/
\r
457 static void prvResetEverything( void )
\r
459 /* Temporary code just to see if this gets called. This function has not
\r
460 been implemented. */
\r
461 portDISABLE_INTERRUPTS();
\r
464 /*-----------------------------------------------------------*/
\r
466 static unsigned long prvCheckRxFifoStatus( void )
\r
468 unsigned long ulReturn = 0;
\r
470 if( ( pxCurrentRxDesc->status & ACT ) != 0 )
\r
472 /* Current descriptor is still active. */
\r
474 else if( ( pxCurrentRxDesc->status & FE ) != 0 )
\r
476 /* Frame error. Clear the error. */
\r
477 pxCurrentRxDesc->status &= ~( FP1 | FP0 | FE );
\r
478 pxCurrentRxDesc->status &= ~( RMAF | RRF | RTLF | RTSF | PRE | CERF );
\r
479 pxCurrentRxDesc->status |= ACT;
\r
480 pxCurrentRxDesc = pxCurrentRxDesc->next;
\r
482 if( EDMAC.EDRRR.LONG == 0x00000000UL )
\r
484 /* Restart Ethernet if it has stopped. */
\r
485 EDMAC.EDRRR.LONG = 0x00000001UL;
\r
490 /* The descriptor contains a frame. Because of the size of the buffers
\r
491 the frame should always be complete. */
\r
492 if( ( pxCurrentRxDesc->status & FP0 ) == FP0 )
\r
494 ulReturn = pxCurrentRxDesc->size;
\r
498 /* Do not expect to get here. */
\r
499 prvResetEverything();
\r
505 /*-----------------------------------------------------------*/
\r
507 static void prvResetMAC( void )
\r
509 /* Ensure the EtherC and EDMAC are enabled. */
\r
510 SYSTEM.MSTPCRB.BIT.MSTPB15 = 0;
\r
511 vTaskDelay( 100 / portTICK_RATE_MS );
\r
513 EDMAC.EDMR.BIT.SWR = 1;
\r
515 /* Crude wait for reset to complete. */
\r
516 vTaskDelay( 500 / portTICK_RATE_MS );
\r
518 /*-----------------------------------------------------------*/
\r
520 static void prvConfigureEtherCAndEDMAC( void )
\r
522 /* Initialisation code taken from Renesas example project. */
\r
524 /* TODO: Check bit 5 */
\r
525 ETHERC.ECSR.LONG = 0x00000037; /* Clear all ETHERC statuS BFR, PSRTO, LCHNG, MPD, ICD */
\r
527 /* Set the EDMAC interrupt priority. */
\r
528 _IPR( _ETHER_EINT ) = configKERNEL_INTERRUPT_PRIORITY;
\r
530 /* TODO: Check bit 5 */
\r
531 /* Enable interrupts of interest only. */
\r
532 EDMAC.EESIPR.LONG = emacTX_END_INTERRUPT | emacRX_END_INTERRUPT;
\r
533 ETHERC.RFLR.LONG = 1518; /* Ether payload is 1500+ CRC */
\r
534 ETHERC.IPGR.LONG = 0x00000014; /* Intergap is 96-bit time */
\r
537 EDMAC.EESR.LONG = 0x47FF0F9F; /* Clear all ETHERC and EDMAC status bits */
\r
538 #ifdef __RX_LITTLE_ENDIAN__
\r
539 EDMAC.EDMR.BIT.DE = 1;
\r
541 EDMAC.RDLAR = ( void * ) pxCurrentRxDesc; /* Initialaize Rx Descriptor List Address */
\r
542 EDMAC.TDLAR = ( void * ) &( xTxDescriptors[ 0 ] ); /* Initialaize Tx Descriptor List Address */
\r
543 EDMAC.TRSCER.LONG = 0x00000000; /* Copy-back status is RFE & TFE only */
\r
544 EDMAC.TFTR.LONG = 0x00000000; /* Threshold of Tx_FIFO */
\r
545 EDMAC.FDR.LONG = 0x00000000; /* Transmit fifo & receive fifo is 256 bytes */
\r
546 EDMAC.RMCR.LONG = 0x00000003; /* Receive function is normal mode(continued) */
\r
547 ETHERC.ECMR.BIT.PRM = 0; /* Ensure promiscuous mode is off. */
\r
549 /* Enable the interrupt... */
\r
550 _IEN( _ETHER_EINT ) = 1;
\r
552 /*-----------------------------------------------------------*/
\r
554 void vEMAC_ISR_Handler( void )
\r
556 unsigned long ul = EDMAC.EESR.LONG;
\r
557 long lHigherPriorityTaskWoken = pdFALSE;
\r
558 extern xQueueHandle xEMACEventQueue;
\r
559 const unsigned long ulRxEvent = uipETHERNET_RX_EVENT;
\r
561 /* Re-enabled interrupts. */
\r
562 __asm volatile( "SETPSW I" );
\r
564 /* Has a Tx end occurred? */
\r
565 if( ul & emacTX_END_INTERRUPT )
\r
567 /* Only return the buffer to the pool once both Txes have completed. */
\r
568 prvReturnBuffer( ( void * ) xTxDescriptors[ 0 ].buf_p );
\r
569 EDMAC.EESR.LONG = emacTX_END_INTERRUPT;
\r
572 /* Has an Rx end occurred? */
\r
573 if( ul & emacRX_END_INTERRUPT )
\r
575 /* Make sure the Ethernet task is not blocked waiting for a packet. */
\r
576 xQueueSendFromISR( xEMACEventQueue, &ulRxEvent, &lHigherPriorityTaskWoken );
\r
577 portYIELD_FROM_ISR( lHigherPriorityTaskWoken );
\r
578 EDMAC.EESR.LONG = emacRX_END_INTERRUPT;
\r