2 FreeRTOS V8.2.0rc1 - Copyright (C) 2014 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 >>! NOTE: The modification to the GPL is included to allow you to !<<
\r
14 >>! distribute a combined work that includes FreeRTOS without being !<<
\r
15 >>! obliged to provide the source code for proprietary components !<<
\r
16 >>! outside of the FreeRTOS kernel. !<<
\r
18 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
19 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
20 FOR A PARTICULAR PURPOSE. Full license text is available on the following
\r
21 link: http://www.freertos.org/a00114.html
\r
25 ***************************************************************************
\r
27 * Having a problem? Start by reading the FAQ "My application does *
\r
28 * not run, what could be wrong?". Have you defined configASSERT()? *
\r
30 * http://www.FreeRTOS.org/FAQHelp.html *
\r
32 ***************************************************************************
\r
34 ***************************************************************************
\r
36 * FreeRTOS provides completely free yet professionally developed, *
\r
37 * robust, strictly quality controlled, supported, and cross *
\r
38 * platform software that is more than just the market leader, it *
\r
39 * is the industry's de facto standard. *
\r
41 * Help yourself get started quickly while simultaneously helping *
\r
42 * to support the FreeRTOS project by purchasing a FreeRTOS *
\r
43 * tutorial book, reference manual, or both: *
\r
44 * http://www.FreeRTOS.org/Documentation *
\r
46 ***************************************************************************
\r
48 ***************************************************************************
\r
50 * Investing in training allows your team to be as productive as *
\r
51 * possible as early as possible, lowering your overall development *
\r
52 * cost, and enabling you to bring a more robust product to market *
\r
53 * earlier than would otherwise be possible. Richard Barry is both *
\r
54 * the architect and key author of FreeRTOS, and so also the world's *
\r
55 * leading authority on what is the world's most popular real time *
\r
56 * kernel for deeply embedded MCU designs. Obtaining your training *
\r
57 * from Richard ensures your team will gain directly from his in-depth *
\r
58 * product knowledge and years of usage experience. Contact Real Time *
\r
59 * Engineers Ltd to enquire about the FreeRTOS Masterclass, presented *
\r
60 * by Richard Barry: http://www.FreeRTOS.org/contact
\r
62 ***************************************************************************
\r
64 ***************************************************************************
\r
66 * You are receiving this top quality software for free. Please play *
\r
67 * fair and reciprocate by reporting any suspected issues and *
\r
68 * participating in the community forum: *
\r
69 * http://www.FreeRTOS.org/support *
\r
73 ***************************************************************************
\r
75 http://www.FreeRTOS.org - Documentation, books, training, latest versions,
\r
76 license and Real Time Engineers Ltd. contact details.
\r
78 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
79 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
80 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
82 http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
\r
83 Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.
\r
85 http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High
\r
86 Integrity Systems ltd. to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
87 licenses offer ticketed support, indemnification and commercial middleware.
\r
89 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
90 engineered and independently SIL3 certified version for use in safety and
\r
91 mission critical applications that require provable dependability.
\r
96 /* FreeRTOS includes. */
\r
97 #include "FreeRTOS.h"
\r
101 /* Hardware specific includes. */
\r
102 #include "r_ether.h"
\r
105 /* uIP includes. */
\r
106 #include "net/uip.h"
\r
108 /* The time to wait between attempts to obtain a free buffer. */
\r
109 #define emacBUFFER_WAIT_DELAY_ms ( 3 / portTICK_PERIOD_MS )
\r
111 /* The number of times emacBUFFER_WAIT_DELAY_ms should be waited before giving
\r
112 up on attempting to obtain a free buffer all together. */
\r
113 #define emacBUFFER_WAIT_ATTEMPTS ( 30 )
\r
115 /* The number of Rx descriptors. */
\r
116 #define emacNUM_RX_DESCRIPTORS 8
\r
118 /* The number of Tx descriptors. When using uIP there is not point in having
\r
120 #define emacNUM_TX_BUFFERS 2
\r
122 /* The total number of EMAC buffers to allocate. */
\r
123 #define emacNUM_BUFFERS ( emacNUM_RX_DESCRIPTORS + emacNUM_TX_BUFFERS )
\r
125 /* The time to wait for the Tx descriptor to become free. */
\r
126 #define emacTX_WAIT_DELAY_ms ( 10 / portTICK_PERIOD_MS )
\r
128 /* The total number of times to wait emacTX_WAIT_DELAY_ms for the Tx descriptor to
\r
130 #define emacTX_WAIT_ATTEMPTS ( 50 )
\r
132 /* Only Rx end and Tx end interrupts are used by this driver. */
\r
133 #define emacTX_END_INTERRUPT ( 1UL << 21UL )
\r
134 #define emacRX_END_INTERRUPT ( 1UL << 18UL )
\r
136 /*-----------------------------------------------------------*/
\r
138 /* The buffers and descriptors themselves. */
\r
139 #pragma section _RX_DESC
\r
140 volatile ethfifo xRxDescriptors[ emacNUM_RX_DESCRIPTORS ];
\r
141 #pragma section _TX_DESC
\r
142 volatile ethfifo xTxDescriptors[ emacNUM_TX_BUFFERS ];
\r
143 #pragma section _ETHERNET_BUFFERS
\r
146 unsigned long ulAlignmentVariable;
\r
147 char cBuffer[ emacNUM_BUFFERS ][ UIP_BUFSIZE ];
\r
148 } xEthernetBuffers;
\r
154 /* Used to indicate which buffers are free and which are in use. If an index
\r
155 contains 0 then the corresponding buffer in xEthernetBuffers is free, otherwise
\r
156 the buffer is in use or about to be used. */
\r
157 static unsigned char ucBufferInUse[ emacNUM_BUFFERS ];
\r
159 /*-----------------------------------------------------------*/
\r
162 * Initialise both the Rx and Tx descriptors.
\r
164 static void prvInitialiseDescriptors( void );
\r
167 * Return a pointer to a free buffer within xEthernetBuffers.
\r
169 static unsigned char *prvGetNextBuffer( void );
\r
172 * Return a buffer to the list of free buffers.
\r
174 static void prvReturnBuffer( unsigned char *pucBuffer );
\r
177 * Examine the status of the next Rx FIFO to see if it contains new data.
\r
179 static unsigned long prvCheckRxFifoStatus( void );
\r
182 * Setup the microcontroller for communication with the PHY.
\r
184 static void prvResetMAC( void );
\r
187 * Configure the Ethernet interface peripherals.
\r
189 static void prvConfigureEtherCAndEDMAC( void );
\r
192 * Something has gone wrong with the descriptor usage. Reset all the buffers
\r
195 static void prvResetEverything( void );
\r
197 /*-----------------------------------------------------------*/
\r
199 /* Points to the Rx descriptor currently in use. */
\r
200 static ethfifo *pxCurrentRxDesc = NULL;
\r
202 /* The buffer used by the uIP stack to both receive and send. This points to
\r
203 one of the Ethernet buffers when its actually in use. */
\r
204 unsigned char *uip_buf = NULL;
\r
206 /*-----------------------------------------------------------*/
\r
208 void vInitEmac( void )
\r
210 /* Software reset. */
\r
213 /* Set the Rx and Tx descriptors into their initial state. */
\r
214 prvInitialiseDescriptors();
\r
216 /* Set the MAC address into the ETHERC */
\r
217 ETHERC.MAHR = ( ( unsigned long ) configMAC_ADDR0 << 24UL ) |
\r
218 ( ( unsigned long ) configMAC_ADDR1 << 16UL ) |
\r
219 ( ( unsigned long ) configMAC_ADDR2 << 8UL ) |
\r
220 ( unsigned long ) configMAC_ADDR3;
\r
222 ETHERC.MALR.BIT.MA = ( ( unsigned long ) configMAC_ADDR4 << 8UL ) |
\r
223 ( unsigned long ) configMAC_ADDR5;
\r
225 /* Perform rest of interface hardware configuration. */
\r
226 prvConfigureEtherCAndEDMAC();
\r
228 /* Nothing received yet, so uip_buf points nowhere. */
\r
231 /* Initialize the PHY */
\r
232 configASSERT( phy_init() == R_PHY_OK );
\r
234 /*-----------------------------------------------------------*/
\r
236 void vEMACWrite( void )
\r
240 /* Wait until the second transmission of the last packet has completed. */
\r
241 for( x = 0; x < emacTX_WAIT_ATTEMPTS; x++ )
\r
243 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
245 /* Descriptor is still active. */
\r
246 vTaskDelay( emacTX_WAIT_DELAY_ms );
\r
254 /* Is the descriptor free after waiting for it? */
\r
255 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
257 /* Something has gone wrong. */
\r
258 prvResetEverything();
\r
261 /* Setup both descriptors to transmit the frame. */
\r
262 xTxDescriptors[ 0 ].buf_p = ( char * ) uip_buf;
\r
263 xTxDescriptors[ 0 ].bufsize = uip_len;
\r
264 xTxDescriptors[ 1 ].buf_p = ( char * ) uip_buf;
\r
265 xTxDescriptors[ 1 ].bufsize = uip_len;
\r
267 /* uip_buf is being sent by the Tx descriptor. Allocate a new buffer
\r
268 for use by the stack. */
\r
269 uip_buf = prvGetNextBuffer();
\r
271 /* Clear previous settings and go. */
\r
272 xTxDescriptors[0].status &= ~( FP1 | FP0 );
\r
273 xTxDescriptors[0].status |= ( FP1 | FP0 | ACT );
\r
274 xTxDescriptors[1].status &= ~( FP1 | FP0 );
\r
275 xTxDescriptors[1].status |= ( FP1 | FP0 | ACT );
\r
277 EDMAC.EDTRR.LONG = 0x00000001;
\r
279 /*-----------------------------------------------------------*/
\r
281 unsigned long ulEMACRead( void )
\r
283 unsigned long ulBytesReceived;
\r
285 ulBytesReceived = prvCheckRxFifoStatus();
\r
287 if( ulBytesReceived > 0 )
\r
289 /* Mark the pxDescriptor buffer as free as uip_buf is going to be set to
\r
290 the buffer that contains the received data. */
\r
291 prvReturnBuffer( uip_buf );
\r
293 /* Point uip_buf to the data about ot be processed. */
\r
294 uip_buf = ( void * ) pxCurrentRxDesc->buf_p;
\r
296 /* Allocate a new buffer to the descriptor, as uip_buf is now using it's
\r
298 pxCurrentRxDesc->buf_p = prvGetNextBuffer();
\r
300 /* Prepare the descriptor to go again. */
\r
301 pxCurrentRxDesc->status &= ~( FP1 | FP0 );
\r
302 pxCurrentRxDesc->status |= ACT;
\r
304 /* Move onto the next buffer in the ring. */
\r
305 pxCurrentRxDesc = pxCurrentRxDesc->next;
\r
307 if( EDMAC.EDRRR.LONG == 0x00000000L )
\r
309 /* Restart Ethernet if it has stopped */
\r
310 EDMAC.EDRRR.LONG = 0x00000001L;
\r
314 return ulBytesReceived;
\r
316 /*-----------------------------------------------------------*/
\r
318 long lEMACWaitForLink( void )
\r
322 /* Set the link status. */
\r
323 switch( phy_set_autonegotiate() )
\r
325 /* Half duplex link */
\r
326 case PHY_LINK_100H:
\r
327 ETHERC.ECMR.BIT.DM = 0;
\r
328 ETHERC.ECMR.BIT.RTM = 1;
\r
333 ETHERC.ECMR.BIT.DM = 0;
\r
334 ETHERC.ECMR.BIT.RTM = 0;
\r
339 /* Full duplex link */
\r
340 case PHY_LINK_100F:
\r
341 ETHERC.ECMR.BIT.DM = 1;
\r
342 ETHERC.ECMR.BIT.RTM = 1;
\r
347 ETHERC.ECMR.BIT.DM = 1;
\r
348 ETHERC.ECMR.BIT.RTM = 0;
\r
357 if( lReturn == pdPASS )
\r
359 /* Enable receive and transmit. */
\r
360 ETHERC.ECMR.BIT.RE = 1;
\r
361 ETHERC.ECMR.BIT.TE = 1;
\r
363 /* Enable EDMAC receive */
\r
364 EDMAC.EDRRR.LONG = 0x1;
\r
369 /*-----------------------------------------------------------*/
\r
371 static void prvInitialiseDescriptors( void )
\r
373 ethfifo *pxDescriptor;
\r
376 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
378 /* Ensure none of the buffers are shown as in use at the start. */
\r
379 ucBufferInUse[ x ] = pdFALSE;
\r
382 /* Initialise the Rx descriptors. */
\r
383 for( x = 0; x < emacNUM_RX_DESCRIPTORS; x++ )
\r
385 pxDescriptor = &( xRxDescriptors[ x ] );
\r
386 pxDescriptor->buf_p = &( xEthernetBuffers.cBuffer[ x ][ 0 ] );
\r
388 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
389 pxDescriptor->size = 0;
\r
390 pxDescriptor->status = ACT;
\r
391 pxDescriptor->next = &xRxDescriptors[ x + 1 ];
\r
393 /* Mark this buffer as in use. */
\r
394 ucBufferInUse[ x ] = pdTRUE;
\r
397 /* The last descriptor points back to the start. */
\r
398 pxDescriptor->status |= DL;
\r
399 pxDescriptor->next = &xRxDescriptors[ 0 ];
\r
401 /* Initialise the Tx descriptors. */
\r
402 for( x = 0; x < emacNUM_TX_BUFFERS; x++ )
\r
404 pxDescriptor = &( xTxDescriptors[ x ] );
\r
406 /* A buffer is not allocated to the Tx descriptor until a send is
\r
407 actually required. */
\r
408 pxDescriptor->buf_p = NULL;
\r
410 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
411 pxDescriptor->size = 0;
\r
412 pxDescriptor->status = 0;
\r
413 pxDescriptor->next = &xTxDescriptors[ x + 1 ];
\r
416 /* The last descriptor points back to the start. */
\r
417 pxDescriptor->status |= DL;
\r
418 pxDescriptor->next = &( xTxDescriptors[ 0 ] );
\r
420 /* Use the first Rx descriptor to start with. */
\r
421 pxCurrentRxDesc = &( xRxDescriptors[ 0 ] );
\r
423 /*-----------------------------------------------------------*/
\r
425 static unsigned char *prvGetNextBuffer( void )
\r
428 unsigned char *pucReturn = NULL;
\r
429 unsigned long ulAttempts = 0;
\r
431 while( pucReturn == NULL )
\r
433 /* Look through the buffers to find one that is not in use by
\r
435 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
437 if( ucBufferInUse[ x ] == pdFALSE )
\r
439 ucBufferInUse[ x ] = pdTRUE;
\r
440 pucReturn = ( unsigned char * ) &( xEthernetBuffers.cBuffer[ x ][ 0 ] );
\r
445 /* Was a buffer found? */
\r
446 if( pucReturn == NULL )
\r
450 if( ulAttempts >= emacBUFFER_WAIT_ATTEMPTS )
\r
455 /* Wait then look again. */
\r
456 vTaskDelay( emacBUFFER_WAIT_DELAY_ms );
\r
462 /*-----------------------------------------------------------*/
\r
464 static void prvReturnBuffer( unsigned char *pucBuffer )
\r
468 /* Return a buffer to the pool of free buffers. */
\r
469 for( ul = 0; ul < emacNUM_BUFFERS; ul++ )
\r
471 if( &( xEthernetBuffers.cBuffer[ ul ][ 0 ] ) == ( void * ) pucBuffer )
\r
473 ucBufferInUse[ ul ] = pdFALSE;
\r
478 /*-----------------------------------------------------------*/
\r
480 static void prvResetEverything( void )
\r
482 /* Temporary code just to see if this gets called. This function has not
\r
483 been implemented. */
\r
484 portDISABLE_INTERRUPTS();
\r
487 /*-----------------------------------------------------------*/
\r
489 static unsigned long prvCheckRxFifoStatus( void )
\r
491 unsigned long ulReturn = 0;
\r
493 if( ( pxCurrentRxDesc->status & ACT ) != 0 )
\r
495 /* Current descriptor is still active. */
\r
497 else if( ( pxCurrentRxDesc->status & FE ) != 0 )
\r
499 /* Frame error. Clear the error. */
\r
500 pxCurrentRxDesc->status &= ~( FP1 | FP0 | FE );
\r
501 pxCurrentRxDesc->status &= ~( RMAF | RRF | RTLF | RTSF | PRE | CERF );
\r
502 pxCurrentRxDesc->status |= ACT;
\r
503 pxCurrentRxDesc = pxCurrentRxDesc->next;
\r
505 if( EDMAC.EDRRR.LONG == 0x00000000UL )
\r
507 /* Restart Ethernet if it has stopped. */
\r
508 EDMAC.EDRRR.LONG = 0x00000001UL;
\r
513 /* The descriptor contains a frame. Because of the size of the buffers
\r
514 the frame should always be complete. */
\r
515 if( ( pxCurrentRxDesc->status & FP0 ) == FP0 )
\r
517 ulReturn = pxCurrentRxDesc->size;
\r
521 /* Do not expect to get here. */
\r
522 prvResetEverything();
\r
528 /*-----------------------------------------------------------*/
\r
530 static void prvResetMAC( void )
\r
532 /* Ensure the EtherC and EDMAC are enabled. */
\r
533 SYSTEM.MSTPCRB.BIT.MSTPB15 = 0;
\r
534 vTaskDelay( 100 / portTICK_PERIOD_MS );
\r
536 EDMAC.EDMR.BIT.SWR = 1;
\r
538 /* Crude wait for reset to complete. */
\r
539 vTaskDelay( 500 / portTICK_PERIOD_MS );
\r
541 /*-----------------------------------------------------------*/
\r
543 static void prvConfigureEtherCAndEDMAC( void )
\r
545 /* Initialisation code taken from Renesas example project. */
\r
547 /* TODO: Check bit 5 */
\r
548 ETHERC.ECSR.LONG = 0x00000037; /* Clear all ETHERC statuS BFR, PSRTO, LCHNG, MPD, ICD */
\r
550 /* Set the EDMAC interrupt priority. */
\r
551 _IPR( _ETHER_EINT ) = configKERNEL_INTERRUPT_PRIORITY;
\r
553 /* TODO: Check bit 5 */
\r
554 /* Enable interrupts of interest only. */
\r
555 EDMAC.EESIPR.LONG = emacTX_END_INTERRUPT | emacRX_END_INTERRUPT;
\r
556 ETHERC.RFLR.LONG = 1518; /* Ether payload is 1500+ CRC */
\r
557 ETHERC.IPGR.LONG = 0x00000014; /* Intergap is 96-bit time */
\r
560 EDMAC.EESR.LONG = 0x47FF0F9F; /* Clear all ETHERC and EDMAC status bits */
\r
562 EDMAC.EDMR.BIT.DE = 1;
\r
564 EDMAC.RDLAR = ( void * ) pxCurrentRxDesc; /* Initialaize Rx Descriptor List Address */
\r
565 EDMAC.TDLAR = &( xTxDescriptors[ 0 ] ); /* Initialaize Tx Descriptor List Address */
\r
566 EDMAC.TRSCER.LONG = 0x00000000; /* Copy-back status is RFE & TFE only */
\r
567 EDMAC.TFTR.LONG = 0x00000000; /* Threshold of Tx_FIFO */
\r
568 EDMAC.FDR.LONG = 0x00000000; /* Transmit fifo & receive fifo is 256 bytes */
\r
569 EDMAC.RMCR.LONG = 0x00000003; /* Receive function is normal mode(continued) */
\r
570 ETHERC.ECMR.BIT.PRM = 0; /* Ensure promiscuous mode is off. */
\r
572 /* Enable the interrupt... */
\r
573 _IEN( _ETHER_EINT ) = 1;
\r
575 /*-----------------------------------------------------------*/
\r
577 #pragma interrupt ( vEMAC_ISR_Handler( vect = VECT_ETHER_EINT, enable ) )
\r
578 void vEMAC_ISR_Handler( void )
\r
580 unsigned long ul = EDMAC.EESR.LONG;
\r
581 long lHigherPriorityTaskWoken = pdFALSE;
\r
582 extern QueueHandle_t xEMACEventQueue;
\r
583 const unsigned long ulRxEvent = uipETHERNET_RX_EVENT;
\r
585 /* Has a Tx end occurred? */
\r
586 if( ul & emacTX_END_INTERRUPT )
\r
588 /* Only return the buffer to the pool once both Txes have completed. */
\r
589 prvReturnBuffer( ( void * ) xTxDescriptors[ 0 ].buf_p );
\r
590 EDMAC.EESR.LONG = emacTX_END_INTERRUPT;
\r
593 /* Has an Rx end occurred? */
\r
594 if( ul & emacRX_END_INTERRUPT )
\r
596 /* Make sure the Ethernet task is not blocked waiting for a packet. */
\r
597 xQueueSendFromISR( xEMACEventQueue, &ulRxEvent, &lHigherPriorityTaskWoken );
\r
598 portYIELD_FROM_ISR( lHigherPriorityTaskWoken );
\r
599 EDMAC.EESR.LONG = emacRX_END_INTERRUPT;
\r