2 FreeRTOS V8.2.2 - Copyright (C) 2015 Real Time Engineers Ltd.
\r
5 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 This file is part of the FreeRTOS distribution.
\r
9 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
10 the terms of the GNU General Public License (version 2) as published by the
\r
11 Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.
\r
13 ***************************************************************************
\r
14 >>! NOTE: The modification to the GPL is included to allow you to !<<
\r
15 >>! distribute a combined work that includes FreeRTOS without being !<<
\r
16 >>! obliged to provide the source code for proprietary components !<<
\r
17 >>! outside of the FreeRTOS kernel. !<<
\r
18 ***************************************************************************
\r
20 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
21 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
22 FOR A PARTICULAR PURPOSE. Full license text is available on the following
\r
23 link: http://www.freertos.org/a00114.html
\r
25 ***************************************************************************
\r
27 * FreeRTOS provides completely free yet professionally developed, *
\r
28 * robust, strictly quality controlled, supported, and cross *
\r
29 * platform software that is more than just the market leader, it *
\r
30 * is the industry's de facto standard. *
\r
32 * Help yourself get started quickly while simultaneously helping *
\r
33 * to support the FreeRTOS project by purchasing a FreeRTOS *
\r
34 * tutorial book, reference manual, or both: *
\r
35 * http://www.FreeRTOS.org/Documentation *
\r
37 ***************************************************************************
\r
39 http://www.FreeRTOS.org/FAQHelp.html - Having a problem? Start by reading
\r
40 the FAQ page "My application does not run, what could be wrong?". Have you
\r
41 defined configASSERT()?
\r
43 http://www.FreeRTOS.org/support - In return for receiving this top quality
\r
44 embedded software for free we request you assist our global community by
\r
45 participating in the support forum.
\r
47 http://www.FreeRTOS.org/training - Investing in training allows your team to
\r
48 be as productive as possible as early as possible. Now you can receive
\r
49 FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers
\r
50 Ltd, and the world's leading authority on the world's leading RTOS.
\r
52 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
53 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
54 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
56 http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
\r
57 Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.
\r
59 http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High
\r
60 Integrity Systems ltd. to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
61 licenses offer ticketed support, indemnification and commercial middleware.
\r
63 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
64 engineered and independently SIL3 certified version for use in safety and
\r
65 mission critical applications that require provable dependability.
\r
70 /* FreeRTOS includes. */
\r
71 #include "FreeRTOS.h"
\r
75 /* Hardware specific includes. */
\r
76 #include "r_ether.h"
\r
80 #include "net/uip.h"
\r
82 /* The time to wait between attempts to obtain a free buffer. */
\r
83 #define emacBUFFER_WAIT_DELAY_ms ( 3 / portTICK_PERIOD_MS )
\r
85 /* The number of times emacBUFFER_WAIT_DELAY_ms should be waited before giving
\r
86 up on attempting to obtain a free buffer all together. */
\r
87 #define emacBUFFER_WAIT_ATTEMPTS ( 30 )
\r
89 /* The number of Rx descriptors. */
\r
90 #define emacNUM_RX_DESCRIPTORS 8
\r
92 /* The number of Tx descriptors. When using uIP there is not point in having
\r
94 #define emacNUM_TX_BUFFERS 2
\r
96 /* The total number of EMAC buffers to allocate. */
\r
97 #define emacNUM_BUFFERS ( emacNUM_RX_DESCRIPTORS + emacNUM_TX_BUFFERS )
\r
99 /* The time to wait for the Tx descriptor to become free. */
\r
100 #define emacTX_WAIT_DELAY_ms ( 10 / portTICK_PERIOD_MS )
\r
102 /* The total number of times to wait emacTX_WAIT_DELAY_ms for the Tx descriptor to
\r
104 #define emacTX_WAIT_ATTEMPTS ( 50 )
\r
106 /* Only Rx end and Tx end interrupts are used by this driver. */
\r
107 #define emacTX_END_INTERRUPT ( 1UL << 21UL )
\r
108 #define emacRX_END_INTERRUPT ( 1UL << 18UL )
\r
110 /*-----------------------------------------------------------*/
\r
112 /* The buffers and descriptors themselves. */
\r
113 #pragma section _RX_DESC
\r
114 volatile ethfifo xRxDescriptors[ emacNUM_RX_DESCRIPTORS ];
\r
115 #pragma section _TX_DESC
\r
116 volatile ethfifo xTxDescriptors[ emacNUM_TX_BUFFERS ];
\r
117 #pragma section _ETHERNET_BUFFERS
\r
120 unsigned long ulAlignmentVariable;
\r
121 char cBuffer[ emacNUM_BUFFERS ][ UIP_BUFSIZE ];
\r
122 } xEthernetBuffers;
\r
128 /* Used to indicate which buffers are free and which are in use. If an index
\r
129 contains 0 then the corresponding buffer in xEthernetBuffers is free, otherwise
\r
130 the buffer is in use or about to be used. */
\r
131 static unsigned char ucBufferInUse[ emacNUM_BUFFERS ];
\r
133 /*-----------------------------------------------------------*/
\r
136 * Initialise both the Rx and Tx descriptors.
\r
138 static void prvInitialiseDescriptors( void );
\r
141 * Return a pointer to a free buffer within xEthernetBuffers.
\r
143 static unsigned char *prvGetNextBuffer( void );
\r
146 * Return a buffer to the list of free buffers.
\r
148 static void prvReturnBuffer( unsigned char *pucBuffer );
\r
151 * Examine the status of the next Rx FIFO to see if it contains new data.
\r
153 static unsigned long prvCheckRxFifoStatus( void );
\r
156 * Setup the microcontroller for communication with the PHY.
\r
158 static void prvResetMAC( void );
\r
161 * Configure the Ethernet interface peripherals.
\r
163 static void prvConfigureEtherCAndEDMAC( void );
\r
166 * Something has gone wrong with the descriptor usage. Reset all the buffers
\r
169 static void prvResetEverything( void );
\r
171 /*-----------------------------------------------------------*/
\r
173 /* Points to the Rx descriptor currently in use. */
\r
174 static ethfifo *pxCurrentRxDesc = NULL;
\r
176 /* The buffer used by the uIP stack to both receive and send. This points to
\r
177 one of the Ethernet buffers when its actually in use. */
\r
178 unsigned char *uip_buf = NULL;
\r
180 /*-----------------------------------------------------------*/
\r
182 void vInitEmac( void )
\r
184 /* Software reset. */
\r
187 /* Set the Rx and Tx descriptors into their initial state. */
\r
188 prvInitialiseDescriptors();
\r
190 /* Set the MAC address into the ETHERC */
\r
191 ETHERC.MAHR = ( ( unsigned long ) configMAC_ADDR0 << 24UL ) |
\r
192 ( ( unsigned long ) configMAC_ADDR1 << 16UL ) |
\r
193 ( ( unsigned long ) configMAC_ADDR2 << 8UL ) |
\r
194 ( unsigned long ) configMAC_ADDR3;
\r
196 ETHERC.MALR.BIT.MA = ( ( unsigned long ) configMAC_ADDR4 << 8UL ) |
\r
197 ( unsigned long ) configMAC_ADDR5;
\r
199 /* Perform rest of interface hardware configuration. */
\r
200 prvConfigureEtherCAndEDMAC();
\r
202 /* Nothing received yet, so uip_buf points nowhere. */
\r
205 /* Initialize the PHY */
\r
206 configASSERT( phy_init() == R_PHY_OK );
\r
208 /*-----------------------------------------------------------*/
\r
210 void vEMACWrite( void )
\r
214 /* Wait until the second transmission of the last packet has completed. */
\r
215 for( x = 0; x < emacTX_WAIT_ATTEMPTS; x++ )
\r
217 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
219 /* Descriptor is still active. */
\r
220 vTaskDelay( emacTX_WAIT_DELAY_ms );
\r
228 /* Is the descriptor free after waiting for it? */
\r
229 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
231 /* Something has gone wrong. */
\r
232 prvResetEverything();
\r
235 /* Setup both descriptors to transmit the frame. */
\r
236 xTxDescriptors[ 0 ].buf_p = ( char * ) uip_buf;
\r
237 xTxDescriptors[ 0 ].bufsize = uip_len;
\r
238 xTxDescriptors[ 1 ].buf_p = ( char * ) uip_buf;
\r
239 xTxDescriptors[ 1 ].bufsize = uip_len;
\r
241 /* uip_buf is being sent by the Tx descriptor. Allocate a new buffer
\r
242 for use by the stack. */
\r
243 uip_buf = prvGetNextBuffer();
\r
245 /* Clear previous settings and go. */
\r
246 xTxDescriptors[0].status &= ~( FP1 | FP0 );
\r
247 xTxDescriptors[0].status |= ( FP1 | FP0 | ACT );
\r
248 xTxDescriptors[1].status &= ~( FP1 | FP0 );
\r
249 xTxDescriptors[1].status |= ( FP1 | FP0 | ACT );
\r
251 EDMAC.EDTRR.LONG = 0x00000001;
\r
253 /*-----------------------------------------------------------*/
\r
255 unsigned long ulEMACRead( void )
\r
257 unsigned long ulBytesReceived;
\r
259 ulBytesReceived = prvCheckRxFifoStatus();
\r
261 if( ulBytesReceived > 0 )
\r
263 /* Mark the pxDescriptor buffer as free as uip_buf is going to be set to
\r
264 the buffer that contains the received data. */
\r
265 prvReturnBuffer( uip_buf );
\r
267 /* Point uip_buf to the data about ot be processed. */
\r
268 uip_buf = ( void * ) pxCurrentRxDesc->buf_p;
\r
270 /* Allocate a new buffer to the descriptor, as uip_buf is now using it's
\r
272 pxCurrentRxDesc->buf_p = prvGetNextBuffer();
\r
274 /* Prepare the descriptor to go again. */
\r
275 pxCurrentRxDesc->status &= ~( FP1 | FP0 );
\r
276 pxCurrentRxDesc->status |= ACT;
\r
278 /* Move onto the next buffer in the ring. */
\r
279 pxCurrentRxDesc = pxCurrentRxDesc->next;
\r
281 if( EDMAC.EDRRR.LONG == 0x00000000L )
\r
283 /* Restart Ethernet if it has stopped */
\r
284 EDMAC.EDRRR.LONG = 0x00000001L;
\r
288 return ulBytesReceived;
\r
290 /*-----------------------------------------------------------*/
\r
292 long lEMACWaitForLink( void )
\r
296 /* Set the link status. */
\r
297 switch( phy_set_autonegotiate() )
\r
299 /* Half duplex link */
\r
300 case PHY_LINK_100H:
\r
301 ETHERC.ECMR.BIT.DM = 0;
\r
302 ETHERC.ECMR.BIT.RTM = 1;
\r
307 ETHERC.ECMR.BIT.DM = 0;
\r
308 ETHERC.ECMR.BIT.RTM = 0;
\r
313 /* Full duplex link */
\r
314 case PHY_LINK_100F:
\r
315 ETHERC.ECMR.BIT.DM = 1;
\r
316 ETHERC.ECMR.BIT.RTM = 1;
\r
321 ETHERC.ECMR.BIT.DM = 1;
\r
322 ETHERC.ECMR.BIT.RTM = 0;
\r
331 if( lReturn == pdPASS )
\r
333 /* Enable receive and transmit. */
\r
334 ETHERC.ECMR.BIT.RE = 1;
\r
335 ETHERC.ECMR.BIT.TE = 1;
\r
337 /* Enable EDMAC receive */
\r
338 EDMAC.EDRRR.LONG = 0x1;
\r
343 /*-----------------------------------------------------------*/
\r
345 static void prvInitialiseDescriptors( void )
\r
347 ethfifo *pxDescriptor;
\r
350 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
352 /* Ensure none of the buffers are shown as in use at the start. */
\r
353 ucBufferInUse[ x ] = pdFALSE;
\r
356 /* Initialise the Rx descriptors. */
\r
357 for( x = 0; x < emacNUM_RX_DESCRIPTORS; x++ )
\r
359 pxDescriptor = &( xRxDescriptors[ x ] );
\r
360 pxDescriptor->buf_p = &( xEthernetBuffers.cBuffer[ x ][ 0 ] );
\r
362 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
363 pxDescriptor->size = 0;
\r
364 pxDescriptor->status = ACT;
\r
365 pxDescriptor->next = &xRxDescriptors[ x + 1 ];
\r
367 /* Mark this buffer as in use. */
\r
368 ucBufferInUse[ x ] = pdTRUE;
\r
371 /* The last descriptor points back to the start. */
\r
372 pxDescriptor->status |= DL;
\r
373 pxDescriptor->next = &xRxDescriptors[ 0 ];
\r
375 /* Initialise the Tx descriptors. */
\r
376 for( x = 0; x < emacNUM_TX_BUFFERS; x++ )
\r
378 pxDescriptor = &( xTxDescriptors[ x ] );
\r
380 /* A buffer is not allocated to the Tx descriptor until a send is
\r
381 actually required. */
\r
382 pxDescriptor->buf_p = NULL;
\r
384 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
385 pxDescriptor->size = 0;
\r
386 pxDescriptor->status = 0;
\r
387 pxDescriptor->next = &xTxDescriptors[ x + 1 ];
\r
390 /* The last descriptor points back to the start. */
\r
391 pxDescriptor->status |= DL;
\r
392 pxDescriptor->next = &( xTxDescriptors[ 0 ] );
\r
394 /* Use the first Rx descriptor to start with. */
\r
395 pxCurrentRxDesc = &( xRxDescriptors[ 0 ] );
\r
397 /*-----------------------------------------------------------*/
\r
399 static unsigned char *prvGetNextBuffer( void )
\r
402 unsigned char *pucReturn = NULL;
\r
403 unsigned long ulAttempts = 0;
\r
405 while( pucReturn == NULL )
\r
407 /* Look through the buffers to find one that is not in use by
\r
409 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
411 if( ucBufferInUse[ x ] == pdFALSE )
\r
413 ucBufferInUse[ x ] = pdTRUE;
\r
414 pucReturn = ( unsigned char * ) &( xEthernetBuffers.cBuffer[ x ][ 0 ] );
\r
419 /* Was a buffer found? */
\r
420 if( pucReturn == NULL )
\r
424 if( ulAttempts >= emacBUFFER_WAIT_ATTEMPTS )
\r
429 /* Wait then look again. */
\r
430 vTaskDelay( emacBUFFER_WAIT_DELAY_ms );
\r
436 /*-----------------------------------------------------------*/
\r
438 static void prvReturnBuffer( unsigned char *pucBuffer )
\r
442 /* Return a buffer to the pool of free buffers. */
\r
443 for( ul = 0; ul < emacNUM_BUFFERS; ul++ )
\r
445 if( &( xEthernetBuffers.cBuffer[ ul ][ 0 ] ) == ( void * ) pucBuffer )
\r
447 ucBufferInUse[ ul ] = pdFALSE;
\r
452 /*-----------------------------------------------------------*/
\r
454 static void prvResetEverything( void )
\r
456 /* Temporary code just to see if this gets called. This function has not
\r
457 been implemented. */
\r
458 portDISABLE_INTERRUPTS();
\r
461 /*-----------------------------------------------------------*/
\r
463 static unsigned long prvCheckRxFifoStatus( void )
\r
465 unsigned long ulReturn = 0;
\r
467 if( ( pxCurrentRxDesc->status & ACT ) != 0 )
\r
469 /* Current descriptor is still active. */
\r
471 else if( ( pxCurrentRxDesc->status & FE ) != 0 )
\r
473 /* Frame error. Clear the error. */
\r
474 pxCurrentRxDesc->status &= ~( FP1 | FP0 | FE );
\r
475 pxCurrentRxDesc->status &= ~( RMAF | RRF | RTLF | RTSF | PRE | CERF );
\r
476 pxCurrentRxDesc->status |= ACT;
\r
477 pxCurrentRxDesc = pxCurrentRxDesc->next;
\r
479 if( EDMAC.EDRRR.LONG == 0x00000000UL )
\r
481 /* Restart Ethernet if it has stopped. */
\r
482 EDMAC.EDRRR.LONG = 0x00000001UL;
\r
487 /* The descriptor contains a frame. Because of the size of the buffers
\r
488 the frame should always be complete. */
\r
489 if( ( pxCurrentRxDesc->status & FP0 ) == FP0 )
\r
491 ulReturn = pxCurrentRxDesc->size;
\r
495 /* Do not expect to get here. */
\r
496 prvResetEverything();
\r
502 /*-----------------------------------------------------------*/
\r
504 static void prvResetMAC( void )
\r
506 /* Ensure the EtherC and EDMAC are enabled. */
\r
507 SYSTEM.MSTPCRB.BIT.MSTPB15 = 0;
\r
508 vTaskDelay( 100 / portTICK_PERIOD_MS );
\r
510 EDMAC.EDMR.BIT.SWR = 1;
\r
512 /* Crude wait for reset to complete. */
\r
513 vTaskDelay( 500 / portTICK_PERIOD_MS );
\r
515 /*-----------------------------------------------------------*/
\r
517 static void prvConfigureEtherCAndEDMAC( void )
\r
519 /* Initialisation code taken from Renesas example project. */
\r
521 /* TODO: Check bit 5 */
\r
522 ETHERC.ECSR.LONG = 0x00000037; /* Clear all ETHERC statuS BFR, PSRTO, LCHNG, MPD, ICD */
\r
524 /* Set the EDMAC interrupt priority. */
\r
525 _IPR( _ETHER_EINT ) = configKERNEL_INTERRUPT_PRIORITY;
\r
527 /* TODO: Check bit 5 */
\r
528 /* Enable interrupts of interest only. */
\r
529 EDMAC.EESIPR.LONG = emacTX_END_INTERRUPT | emacRX_END_INTERRUPT;
\r
530 ETHERC.RFLR.LONG = 1518; /* Ether payload is 1500+ CRC */
\r
531 ETHERC.IPGR.LONG = 0x00000014; /* Intergap is 96-bit time */
\r
534 EDMAC.EESR.LONG = 0x47FF0F9F; /* Clear all ETHERC and EDMAC status bits */
\r
536 EDMAC.EDMR.BIT.DE = 1;
\r
538 EDMAC.RDLAR = ( void * ) pxCurrentRxDesc; /* Initialaize Rx Descriptor List Address */
\r
539 EDMAC.TDLAR = &( xTxDescriptors[ 0 ] ); /* Initialaize Tx Descriptor List Address */
\r
540 EDMAC.TRSCER.LONG = 0x00000000; /* Copy-back status is RFE & TFE only */
\r
541 EDMAC.TFTR.LONG = 0x00000000; /* Threshold of Tx_FIFO */
\r
542 EDMAC.FDR.LONG = 0x00000000; /* Transmit fifo & receive fifo is 256 bytes */
\r
543 EDMAC.RMCR.LONG = 0x00000003; /* Receive function is normal mode(continued) */
\r
544 ETHERC.ECMR.BIT.PRM = 0; /* Ensure promiscuous mode is off. */
\r
546 /* Enable the interrupt... */
\r
547 _IEN( _ETHER_EINT ) = 1;
\r
549 /*-----------------------------------------------------------*/
\r
551 #pragma interrupt ( vEMAC_ISR_Handler( vect = VECT_ETHER_EINT, enable ) )
\r
552 void vEMAC_ISR_Handler( void )
\r
554 unsigned long ul = EDMAC.EESR.LONG;
\r
555 long lHigherPriorityTaskWoken = pdFALSE;
\r
556 extern QueueHandle_t xEMACEventQueue;
\r
557 const unsigned long ulRxEvent = uipETHERNET_RX_EVENT;
\r
559 /* Has a Tx end occurred? */
\r
560 if( ul & emacTX_END_INTERRUPT )
\r
562 /* Only return the buffer to the pool once both Txes have completed. */
\r
563 prvReturnBuffer( ( void * ) xTxDescriptors[ 0 ].buf_p );
\r
564 EDMAC.EESR.LONG = emacTX_END_INTERRUPT;
\r
567 /* Has an Rx end occurred? */
\r
568 if( ul & emacRX_END_INTERRUPT )
\r
570 /* Make sure the Ethernet task is not blocked waiting for a packet. */
\r
571 xQueueSendFromISR( xEMACEventQueue, &ulRxEvent, &lHigherPriorityTaskWoken );
\r
572 portYIELD_FROM_ISR( lHigherPriorityTaskWoken );
\r
573 EDMAC.EESR.LONG = emacRX_END_INTERRUPT;
\r