2 FreeRTOS V7.5.1 - Copyright (C) 2013 Real Time Engineers Ltd.
\r
4 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
6 ***************************************************************************
\r
8 * FreeRTOS provides completely free yet professionally developed, *
\r
9 * robust, strictly quality controlled, supported, and cross *
\r
10 * platform software that has become a de facto standard. *
\r
12 * Help yourself get started quickly and support the FreeRTOS *
\r
13 * project by purchasing a FreeRTOS tutorial book, reference *
\r
14 * manual, or both from: http://www.FreeRTOS.org/Documentation *
\r
18 ***************************************************************************
\r
20 This file is part of the FreeRTOS distribution.
\r
22 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
23 the terms of the GNU General Public License (version 2) as published by the
\r
24 Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.
\r
26 >>! NOTE: The modification to the GPL is included to allow you to distribute
\r
27 >>! a combined work that includes FreeRTOS without being obliged to provide
\r
28 >>! the source code for proprietary components outside of the FreeRTOS
\r
31 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
32 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
33 FOR A PARTICULAR PURPOSE. Full license text is available from the following
\r
34 link: http://www.freertos.org/a00114.html
\r
38 ***************************************************************************
\r
40 * Having a problem? Start by reading the FAQ "My application does *
\r
41 * not run, what could be wrong?" *
\r
43 * http://www.FreeRTOS.org/FAQHelp.html *
\r
45 ***************************************************************************
\r
47 http://www.FreeRTOS.org - Documentation, books, training, latest versions,
\r
48 license and Real Time Engineers Ltd. contact details.
\r
50 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
51 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
52 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
54 http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High
\r
55 Integrity Systems to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
56 licenses offer ticketed support, indemnification and middleware.
\r
58 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
59 engineered and independently SIL3 certified version for use in safety and
\r
60 mission critical applications that require provable dependability.
\r
65 /* Hardware specific includes. */
\r
66 #include <iorx62n.h>
\r
67 #include "typedefine.h"
\r
68 #include "r_ether.h"
\r
71 /* FreeRTOS includes. */
\r
72 #include "FreeRTOS.h"
\r
77 #include "net/uip.h"
\r
79 /* The time to wait between attempts to obtain a free buffer. */
\r
80 #define emacBUFFER_WAIT_DELAY_ms ( 3 / portTICK_RATE_MS )
\r
82 /* The number of times emacBUFFER_WAIT_DELAY_ms should be waited before giving
\r
83 up on attempting to obtain a free buffer all together. */
\r
84 #define emacBUFFER_WAIT_ATTEMPTS ( 30 )
\r
86 /* The number of Rx descriptors. */
\r
87 #define emacNUM_RX_DESCRIPTORS 8
\r
89 /* The number of Tx descriptors. When using uIP there is not point in having
\r
91 #define emacNUM_TX_BUFFERS 2
\r
93 /* The total number of EMAC buffers to allocate. */
\r
94 #define emacNUM_BUFFERS ( emacNUM_RX_DESCRIPTORS + emacNUM_TX_BUFFERS )
\r
96 /* The time to wait for the Tx descriptor to become free. */
\r
97 #define emacTX_WAIT_DELAY_ms ( 10 / portTICK_RATE_MS )
\r
99 /* The total number of times to wait emacTX_WAIT_DELAY_ms for the Tx descriptor to
\r
101 #define emacTX_WAIT_ATTEMPTS ( 50 )
\r
103 /* Only Rx end and Tx end interrupts are used by this driver. */
\r
104 #define emacTX_END_INTERRUPT ( 1UL << 21UL )
\r
105 #define emacRX_END_INTERRUPT ( 1UL << 18UL )
\r
107 /*-----------------------------------------------------------*/
\r
109 /* The buffers and descriptors themselves. */
\r
110 #pragma data_alignment=32
\r
111 volatile ethfifo xRxDescriptors[ emacNUM_RX_DESCRIPTORS ];
\r
113 #pragma data_alignment=32
\r
114 volatile ethfifo xTxDescriptors[ emacNUM_TX_BUFFERS ];
\r
116 #pragma data_alignment=32
\r
117 char xEthernetBuffers[ emacNUM_BUFFERS ][ UIP_BUFSIZE ];
\r
120 /* Used to indicate which buffers are free and which are in use. If an index
\r
121 contains 0 then the corresponding buffer in xEthernetBuffers is free, otherwise
\r
122 the buffer is in use or about to be used. */
\r
123 static unsigned char ucBufferInUse[ emacNUM_BUFFERS ];
\r
125 /*-----------------------------------------------------------*/
\r
128 * Initialise both the Rx and Tx descriptors.
\r
130 static void prvInitialiseDescriptors( void );
\r
133 * Return a pointer to a free buffer within xEthernetBuffers.
\r
135 static unsigned char *prvGetNextBuffer( void );
\r
138 * Return a buffer to the list of free buffers.
\r
140 static void prvReturnBuffer( unsigned char *pucBuffer );
\r
143 * Examine the status of the next Rx FIFO to see if it contains new data.
\r
145 static unsigned long prvCheckRxFifoStatus( void );
\r
148 * Setup the microcontroller for communication with the PHY.
\r
150 static void prvResetMAC( void );
\r
153 * Configure the Ethernet interface peripherals.
\r
155 static void prvConfigureEtherCAndEDMAC( void );
\r
158 * Something has gone wrong with the descriptor usage. Reset all the buffers
\r
161 static void prvResetEverything( void );
\r
163 /*-----------------------------------------------------------*/
\r
165 /* Points to the Rx descriptor currently in use. */
\r
166 static volatile ethfifo *pxCurrentRxDesc = NULL;
\r
168 /* The buffer used by the uIP stack to both receive and send. This points to
\r
169 one of the Ethernet buffers when its actually in use. */
\r
170 unsigned char *uip_buf = NULL;
\r
172 /*-----------------------------------------------------------*/
\r
174 void vInitEmac( void )
\r
176 /* Software reset. */
\r
179 /* Set the Rx and Tx descriptors into their initial state. */
\r
180 prvInitialiseDescriptors();
\r
182 /* Set the MAC address into the ETHERC */
\r
183 ETHERC.MAHR = ( ( unsigned long ) configMAC_ADDR0 << 24UL ) |
\r
184 ( ( unsigned long ) configMAC_ADDR1 << 16UL ) |
\r
185 ( ( unsigned long ) configMAC_ADDR2 << 8UL ) |
\r
186 ( unsigned long ) configMAC_ADDR3;
\r
188 ETHERC.MALR.BIT.MA = ( ( unsigned long ) configMAC_ADDR4 << 8UL ) |
\r
189 ( unsigned long ) configMAC_ADDR5;
\r
191 /* Perform rest of interface hardware configuration. */
\r
192 prvConfigureEtherCAndEDMAC();
\r
194 /* Nothing received yet, so uip_buf points nowhere. */
\r
197 /* Initialize the PHY */
\r
200 /*-----------------------------------------------------------*/
\r
202 void vEMACWrite( void )
\r
206 /* Wait until the second transmission of the last packet has completed. */
\r
207 for( x = 0; x < emacTX_WAIT_ATTEMPTS; x++ )
\r
209 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
211 /* Descriptor is still active. */
\r
212 vTaskDelay( emacTX_WAIT_DELAY_ms );
\r
220 /* Is the descriptor free after waiting for it? */
\r
221 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
223 /* Something has gone wrong. */
\r
224 prvResetEverything();
\r
227 /* Setup both descriptors to transmit the frame. */
\r
228 xTxDescriptors[ 0 ].buf_p = ( char * ) uip_buf;
\r
229 xTxDescriptors[ 0 ].bufsize = uip_len;
\r
230 xTxDescriptors[ 1 ].buf_p = ( char * ) uip_buf;
\r
231 xTxDescriptors[ 1 ].bufsize = uip_len;
\r
233 /* uip_buf is being sent by the Tx descriptor. Allocate a new buffer
\r
234 for use by the stack. */
\r
235 uip_buf = prvGetNextBuffer();
\r
237 /* Clear previous settings and go. */
\r
238 xTxDescriptors[0].status &= ~( FP1 | FP0 );
\r
239 xTxDescriptors[0].status |= ( FP1 | FP0 | ACT );
\r
240 xTxDescriptors[1].status &= ~( FP1 | FP0 );
\r
241 xTxDescriptors[1].status |= ( FP1 | FP0 | ACT );
\r
243 EDMAC.EDTRR.LONG = 0x00000001;
\r
245 /*-----------------------------------------------------------*/
\r
247 unsigned long ulEMACRead( void )
\r
249 unsigned long ulBytesReceived;
\r
251 ulBytesReceived = prvCheckRxFifoStatus();
\r
253 if( ulBytesReceived > 0 )
\r
255 /* Mark the pxDescriptor buffer as free as uip_buf is going to be set to
\r
256 the buffer that contains the received data. */
\r
257 prvReturnBuffer( uip_buf );
\r
259 /* Point uip_buf to the data about ot be processed. */
\r
260 uip_buf = ( void * ) pxCurrentRxDesc->buf_p;
\r
262 /* Allocate a new buffer to the descriptor, as uip_buf is now using it's
\r
264 pxCurrentRxDesc->buf_p = ( char * ) prvGetNextBuffer();
\r
266 /* Prepare the descriptor to go again. */
\r
267 pxCurrentRxDesc->status &= ~( FP1 | FP0 );
\r
268 pxCurrentRxDesc->status |= ACT;
\r
270 /* Move onto the next buffer in the ring. */
\r
271 pxCurrentRxDesc = pxCurrentRxDesc->next;
\r
273 if( EDMAC.EDRRR.LONG == 0x00000000L )
\r
275 /* Restart Ethernet if it has stopped */
\r
276 EDMAC.EDRRR.LONG = 0x00000001L;
\r
280 return ulBytesReceived;
\r
282 /*-----------------------------------------------------------*/
\r
284 long lEMACWaitForLink( void )
\r
288 /* Set the link status. */
\r
289 switch( phy_set_autonegotiate() )
\r
291 /* Half duplex link */
\r
292 case PHY_LINK_100H:
\r
293 ETHERC.ECMR.BIT.DM = 0;
\r
294 ETHERC.ECMR.BIT.RTM = 1;
\r
299 ETHERC.ECMR.BIT.DM = 0;
\r
300 ETHERC.ECMR.BIT.RTM = 0;
\r
305 /* Full duplex link */
\r
306 case PHY_LINK_100F:
\r
307 ETHERC.ECMR.BIT.DM = 1;
\r
308 ETHERC.ECMR.BIT.RTM = 1;
\r
313 ETHERC.ECMR.BIT.DM = 1;
\r
314 ETHERC.ECMR.BIT.RTM = 0;
\r
323 if( lReturn == pdPASS )
\r
325 /* Enable receive and transmit. */
\r
326 ETHERC.ECMR.BIT.RE = 1;
\r
327 ETHERC.ECMR.BIT.TE = 1;
\r
329 /* Enable EDMAC receive */
\r
330 EDMAC.EDRRR.LONG = 0x1;
\r
335 /*-----------------------------------------------------------*/
\r
337 static void prvInitialiseDescriptors( void )
\r
339 volatile ethfifo *pxDescriptor;
\r
342 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
344 /* Ensure none of the buffers are shown as in use at the start. */
\r
345 ucBufferInUse[ x ] = pdFALSE;
\r
348 /* Initialise the Rx descriptors. */
\r
349 for( x = 0; x < emacNUM_RX_DESCRIPTORS; x++ )
\r
351 pxDescriptor = &( xRxDescriptors[ x ] );
\r
352 pxDescriptor->buf_p = &( xEthernetBuffers[ x ][ 0 ] );
\r
354 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
355 pxDescriptor->size = 0;
\r
356 pxDescriptor->status = ACT;
\r
357 pxDescriptor->next = ( ethfifo * ) &xRxDescriptors[ x + 1 ];
\r
359 /* Mark this buffer as in use. */
\r
360 ucBufferInUse[ x ] = pdTRUE;
\r
363 /* The last descriptor points back to the start. */
\r
364 pxDescriptor->status |= DL;
\r
365 pxDescriptor->next = ( ethfifo * ) &xRxDescriptors[ 0 ];
\r
367 /* Initialise the Tx descriptors. */
\r
368 for( x = 0; x < emacNUM_TX_BUFFERS; x++ )
\r
370 pxDescriptor = &( xTxDescriptors[ x ] );
\r
372 /* A buffer is not allocated to the Tx descriptor until a send is
\r
373 actually required. */
\r
374 pxDescriptor->buf_p = NULL;
\r
376 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
377 pxDescriptor->size = 0;
\r
378 pxDescriptor->status = 0;
\r
379 pxDescriptor->next = ( ethfifo * ) &xTxDescriptors[ x + 1 ];
\r
382 /* The last descriptor points back to the start. */
\r
383 pxDescriptor->status |= DL;
\r
384 pxDescriptor->next = ( ethfifo * ) &( xTxDescriptors[ 0 ] );
\r
386 /* Use the first Rx descriptor to start with. */
\r
387 pxCurrentRxDesc = &( xRxDescriptors[ 0 ] );
\r
389 /*-----------------------------------------------------------*/
\r
391 static unsigned char *prvGetNextBuffer( void )
\r
394 unsigned char *pucReturn = NULL;
\r
395 unsigned long ulAttempts = 0;
\r
397 while( pucReturn == NULL )
\r
399 /* Look through the buffers to find one that is not in use by
\r
401 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
403 if( ucBufferInUse[ x ] == pdFALSE )
\r
405 ucBufferInUse[ x ] = pdTRUE;
\r
406 pucReturn = ( unsigned char * ) &( xEthernetBuffers[ x ][ 0 ] );
\r
411 /* Was a buffer found? */
\r
412 if( pucReturn == NULL )
\r
416 if( ulAttempts >= emacBUFFER_WAIT_ATTEMPTS )
\r
421 /* Wait then look again. */
\r
422 vTaskDelay( emacBUFFER_WAIT_DELAY_ms );
\r
428 /*-----------------------------------------------------------*/
\r
430 static void prvReturnBuffer( unsigned char *pucBuffer )
\r
434 /* Return a buffer to the pool of free buffers. */
\r
435 for( ul = 0; ul < emacNUM_BUFFERS; ul++ )
\r
437 if( &( xEthernetBuffers[ ul ][ 0 ] ) == ( void * ) pucBuffer )
\r
439 ucBufferInUse[ ul ] = pdFALSE;
\r
444 /*-----------------------------------------------------------*/
\r
446 static void prvResetEverything( void )
\r
448 /* Temporary code just to see if this gets called. This function has not
\r
449 been implemented. */
\r
450 portDISABLE_INTERRUPTS();
\r
453 /*-----------------------------------------------------------*/
\r
455 static unsigned long prvCheckRxFifoStatus( void )
\r
457 unsigned long ulReturn = 0;
\r
459 if( ( pxCurrentRxDesc->status & ACT ) != 0 )
\r
461 /* Current descriptor is still active. */
\r
463 else if( ( pxCurrentRxDesc->status & FE ) != 0 )
\r
465 /* Frame error. Clear the error. */
\r
466 pxCurrentRxDesc->status &= ~( FP1 | FP0 | FE );
\r
467 pxCurrentRxDesc->status &= ~( RMAF | RRF | RTLF | RTSF | PRE | CERF );
\r
468 pxCurrentRxDesc->status |= ACT;
\r
469 pxCurrentRxDesc = pxCurrentRxDesc->next;
\r
471 if( EDMAC.EDRRR.LONG == 0x00000000UL )
\r
473 /* Restart Ethernet if it has stopped. */
\r
474 EDMAC.EDRRR.LONG = 0x00000001UL;
\r
479 /* The descriptor contains a frame. Because of the size of the buffers
\r
480 the frame should always be complete. */
\r
481 if( ( pxCurrentRxDesc->status & FP0 ) == FP0 )
\r
483 ulReturn = pxCurrentRxDesc->size;
\r
487 /* Do not expect to get here. */
\r
488 prvResetEverything();
\r
494 /*-----------------------------------------------------------*/
\r
496 static void prvResetMAC( void )
\r
498 /* Ensure the EtherC and EDMAC are enabled. */
\r
499 SYSTEM.MSTPCRB.BIT.MSTPB15 = 0;
\r
500 vTaskDelay( 100 / portTICK_RATE_MS );
\r
502 EDMAC.EDMR.BIT.SWR = 1;
\r
504 /* Crude wait for reset to complete. */
\r
505 vTaskDelay( 500 / portTICK_RATE_MS );
\r
507 /*-----------------------------------------------------------*/
\r
509 static void prvConfigureEtherCAndEDMAC( void )
\r
511 /* Initialisation code taken from Renesas example project. */
\r
513 /* TODO: Check bit 5 */
\r
514 ETHERC.ECSR.LONG = 0x00000037; /* Clear all ETHERC statuS BFR, PSRTO, LCHNG, MPD, ICD */
\r
516 /* Set the EDMAC interrupt priority. */
\r
517 _IPR( _ETHER_EINT ) = configKERNEL_INTERRUPT_PRIORITY;
\r
519 /* TODO: Check bit 5 */
\r
520 /* Enable interrupts of interest only. */
\r
521 EDMAC.EESIPR.LONG = emacTX_END_INTERRUPT | emacRX_END_INTERRUPT;
\r
522 ETHERC.RFLR.LONG = 1518; /* Ether payload is 1500+ CRC */
\r
523 ETHERC.IPGR.LONG = 0x00000014; /* Intergap is 96-bit time */
\r
526 EDMAC.EESR.LONG = 0x47FF0F9F; /* Clear all ETHERC and EDMAC status bits */
\r
527 #if __LITTLE_ENDIAN__ == 1
\r
528 EDMAC.EDMR.BIT.DE = 1;
\r
530 EDMAC.RDLAR = ( void * ) pxCurrentRxDesc; /* Initialaize Rx Descriptor List Address */
\r
531 EDMAC.TDLAR = ( void * ) &( xTxDescriptors[ 0 ] );/* Initialaize Tx Descriptor List Address */
\r
532 EDMAC.TRSCER.LONG = 0x00000000; /* Copy-back status is RFE & TFE only */
\r
533 EDMAC.TFTR.LONG = 0x00000000; /* Threshold of Tx_FIFO */
\r
534 EDMAC.FDR.LONG = 0x00000000; /* Transmit fifo & receive fifo is 256 bytes */
\r
535 EDMAC.RMCR.LONG = 0x00000003; /* Receive function is normal mode(continued) */
\r
536 ETHERC.ECMR.BIT.PRM = 0; /* Ensure promiscuous mode is off. */
\r
538 /* Enable the interrupt... */
\r
539 _IEN( _ETHER_EINT ) = 1;
\r
541 /*-----------------------------------------------------------*/
\r
543 #pragma vector = VECT_ETHER_EINT
\r
544 __interrupt void vEMAC_ISR_Handler( void )
\r
546 unsigned long ul = EDMAC.EESR.LONG;
\r
547 long lHigherPriorityTaskWoken = pdFALSE;
\r
548 extern xQueueHandle xEMACEventQueue;
\r
549 const unsigned long ulRxEvent = uipETHERNET_RX_EVENT;
\r
551 __enable_interrupt();
\r
553 /* Has a Tx end occurred? */
\r
554 if( ul & emacTX_END_INTERRUPT )
\r
556 /* Only return the buffer to the pool once both Txes have completed. */
\r
557 prvReturnBuffer( ( void * ) xTxDescriptors[ 0 ].buf_p );
\r
558 EDMAC.EESR.LONG = emacTX_END_INTERRUPT;
\r
561 /* Has an Rx end occurred? */
\r
562 if( ul & emacRX_END_INTERRUPT )
\r
564 /* Make sure the Ethernet task is not blocked waiting for a packet. */
\r
565 xQueueSendFromISR( xEMACEventQueue, &ulRxEvent, &lHigherPriorityTaskWoken );
\r
566 portYIELD_FROM_ISR( lHigherPriorityTaskWoken );
\r
567 EDMAC.EESR.LONG = emacRX_END_INTERRUPT;
\r