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 /* Hardware specific includes. */
\r
97 #include <iorx62n.h>
\r
98 #include "typedefine.h"
\r
99 #include "r_ether.h"
\r
102 /* FreeRTOS includes. */
\r
103 #include "FreeRTOS.h"
\r
105 #include "semphr.h"
\r
107 /* uIP includes. */
\r
108 #include "net/uip.h"
\r
110 /* The time to wait between attempts to obtain a free buffer. */
\r
111 #define emacBUFFER_WAIT_DELAY_ms ( 3 / portTICK_PERIOD_MS )
\r
113 /* The number of times emacBUFFER_WAIT_DELAY_ms should be waited before giving
\r
114 up on attempting to obtain a free buffer all together. */
\r
115 #define emacBUFFER_WAIT_ATTEMPTS ( 30 )
\r
117 /* The number of Rx descriptors. */
\r
118 #define emacNUM_RX_DESCRIPTORS 8
\r
120 /* The number of Tx descriptors. When using uIP there is not point in having
\r
122 #define emacNUM_TX_BUFFERS 2
\r
124 /* The total number of EMAC buffers to allocate. */
\r
125 #define emacNUM_BUFFERS ( emacNUM_RX_DESCRIPTORS + emacNUM_TX_BUFFERS )
\r
127 /* The time to wait for the Tx descriptor to become free. */
\r
128 #define emacTX_WAIT_DELAY_ms ( 10 / portTICK_PERIOD_MS )
\r
130 /* The total number of times to wait emacTX_WAIT_DELAY_ms for the Tx descriptor to
\r
132 #define emacTX_WAIT_ATTEMPTS ( 50 )
\r
134 /* Only Rx end and Tx end interrupts are used by this driver. */
\r
135 #define emacTX_END_INTERRUPT ( 1UL << 21UL )
\r
136 #define emacRX_END_INTERRUPT ( 1UL << 18UL )
\r
138 /*-----------------------------------------------------------*/
\r
140 /* The buffers and descriptors themselves. */
\r
141 #pragma data_alignment=32
\r
142 volatile ethfifo xRxDescriptors[ emacNUM_RX_DESCRIPTORS ];
\r
144 #pragma data_alignment=32
\r
145 volatile ethfifo xTxDescriptors[ emacNUM_TX_BUFFERS ];
\r
147 #pragma data_alignment=32
\r
148 char xEthernetBuffers[ emacNUM_BUFFERS ][ UIP_BUFSIZE ];
\r
151 /* Used to indicate which buffers are free and which are in use. If an index
\r
152 contains 0 then the corresponding buffer in xEthernetBuffers is free, otherwise
\r
153 the buffer is in use or about to be used. */
\r
154 static unsigned char ucBufferInUse[ emacNUM_BUFFERS ];
\r
156 /*-----------------------------------------------------------*/
\r
159 * Initialise both the Rx and Tx descriptors.
\r
161 static void prvInitialiseDescriptors( void );
\r
164 * Return a pointer to a free buffer within xEthernetBuffers.
\r
166 static unsigned char *prvGetNextBuffer( void );
\r
169 * Return a buffer to the list of free buffers.
\r
171 static void prvReturnBuffer( unsigned char *pucBuffer );
\r
174 * Examine the status of the next Rx FIFO to see if it contains new data.
\r
176 static unsigned long prvCheckRxFifoStatus( void );
\r
179 * Setup the microcontroller for communication with the PHY.
\r
181 static void prvResetMAC( void );
\r
184 * Configure the Ethernet interface peripherals.
\r
186 static void prvConfigureEtherCAndEDMAC( void );
\r
189 * Something has gone wrong with the descriptor usage. Reset all the buffers
\r
192 static void prvResetEverything( void );
\r
194 /*-----------------------------------------------------------*/
\r
196 /* Points to the Rx descriptor currently in use. */
\r
197 static volatile ethfifo *pxCurrentRxDesc = NULL;
\r
199 /* The buffer used by the uIP stack to both receive and send. This points to
\r
200 one of the Ethernet buffers when its actually in use. */
\r
201 unsigned char *uip_buf = NULL;
\r
203 /*-----------------------------------------------------------*/
\r
205 void vInitEmac( void )
\r
207 /* Software reset. */
\r
210 /* Set the Rx and Tx descriptors into their initial state. */
\r
211 prvInitialiseDescriptors();
\r
213 /* Set the MAC address into the ETHERC */
\r
214 ETHERC.MAHR = ( ( unsigned long ) configMAC_ADDR0 << 24UL ) |
\r
215 ( ( unsigned long ) configMAC_ADDR1 << 16UL ) |
\r
216 ( ( unsigned long ) configMAC_ADDR2 << 8UL ) |
\r
217 ( unsigned long ) configMAC_ADDR3;
\r
219 ETHERC.MALR.BIT.MA = ( ( unsigned long ) configMAC_ADDR4 << 8UL ) |
\r
220 ( unsigned long ) configMAC_ADDR5;
\r
222 /* Perform rest of interface hardware configuration. */
\r
223 prvConfigureEtherCAndEDMAC();
\r
225 /* Nothing received yet, so uip_buf points nowhere. */
\r
228 /* Initialize the PHY */
\r
231 /*-----------------------------------------------------------*/
\r
233 void vEMACWrite( void )
\r
237 /* Wait until the second transmission of the last packet has completed. */
\r
238 for( x = 0; x < emacTX_WAIT_ATTEMPTS; x++ )
\r
240 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
242 /* Descriptor is still active. */
\r
243 vTaskDelay( emacTX_WAIT_DELAY_ms );
\r
251 /* Is the descriptor free after waiting for it? */
\r
252 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
254 /* Something has gone wrong. */
\r
255 prvResetEverything();
\r
258 /* Setup both descriptors to transmit the frame. */
\r
259 xTxDescriptors[ 0 ].buf_p = ( char * ) uip_buf;
\r
260 xTxDescriptors[ 0 ].bufsize = uip_len;
\r
261 xTxDescriptors[ 1 ].buf_p = ( char * ) uip_buf;
\r
262 xTxDescriptors[ 1 ].bufsize = uip_len;
\r
264 /* uip_buf is being sent by the Tx descriptor. Allocate a new buffer
\r
265 for use by the stack. */
\r
266 uip_buf = prvGetNextBuffer();
\r
268 /* Clear previous settings and go. */
\r
269 xTxDescriptors[0].status &= ~( FP1 | FP0 );
\r
270 xTxDescriptors[0].status |= ( FP1 | FP0 | ACT );
\r
271 xTxDescriptors[1].status &= ~( FP1 | FP0 );
\r
272 xTxDescriptors[1].status |= ( FP1 | FP0 | ACT );
\r
274 EDMAC.EDTRR.LONG = 0x00000001;
\r
276 /*-----------------------------------------------------------*/
\r
278 unsigned long ulEMACRead( void )
\r
280 unsigned long ulBytesReceived;
\r
282 ulBytesReceived = prvCheckRxFifoStatus();
\r
284 if( ulBytesReceived > 0 )
\r
286 /* Mark the pxDescriptor buffer as free as uip_buf is going to be set to
\r
287 the buffer that contains the received data. */
\r
288 prvReturnBuffer( uip_buf );
\r
290 /* Point uip_buf to the data about ot be processed. */
\r
291 uip_buf = ( void * ) pxCurrentRxDesc->buf_p;
\r
293 /* Allocate a new buffer to the descriptor, as uip_buf is now using it's
\r
295 pxCurrentRxDesc->buf_p = ( char * ) prvGetNextBuffer();
\r
297 /* Prepare the descriptor to go again. */
\r
298 pxCurrentRxDesc->status &= ~( FP1 | FP0 );
\r
299 pxCurrentRxDesc->status |= ACT;
\r
301 /* Move onto the next buffer in the ring. */
\r
302 pxCurrentRxDesc = pxCurrentRxDesc->next;
\r
304 if( EDMAC.EDRRR.LONG == 0x00000000L )
\r
306 /* Restart Ethernet if it has stopped */
\r
307 EDMAC.EDRRR.LONG = 0x00000001L;
\r
311 return ulBytesReceived;
\r
313 /*-----------------------------------------------------------*/
\r
315 long lEMACWaitForLink( void )
\r
319 /* Set the link status. */
\r
320 switch( phy_set_autonegotiate() )
\r
322 /* Half duplex link */
\r
323 case PHY_LINK_100H:
\r
324 ETHERC.ECMR.BIT.DM = 0;
\r
325 ETHERC.ECMR.BIT.RTM = 1;
\r
330 ETHERC.ECMR.BIT.DM = 0;
\r
331 ETHERC.ECMR.BIT.RTM = 0;
\r
336 /* Full duplex link */
\r
337 case PHY_LINK_100F:
\r
338 ETHERC.ECMR.BIT.DM = 1;
\r
339 ETHERC.ECMR.BIT.RTM = 1;
\r
344 ETHERC.ECMR.BIT.DM = 1;
\r
345 ETHERC.ECMR.BIT.RTM = 0;
\r
354 if( lReturn == pdPASS )
\r
356 /* Enable receive and transmit. */
\r
357 ETHERC.ECMR.BIT.RE = 1;
\r
358 ETHERC.ECMR.BIT.TE = 1;
\r
360 /* Enable EDMAC receive */
\r
361 EDMAC.EDRRR.LONG = 0x1;
\r
366 /*-----------------------------------------------------------*/
\r
368 static void prvInitialiseDescriptors( void )
\r
370 volatile ethfifo *pxDescriptor;
\r
373 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
375 /* Ensure none of the buffers are shown as in use at the start. */
\r
376 ucBufferInUse[ x ] = pdFALSE;
\r
379 /* Initialise the Rx descriptors. */
\r
380 for( x = 0; x < emacNUM_RX_DESCRIPTORS; x++ )
\r
382 pxDescriptor = &( xRxDescriptors[ x ] );
\r
383 pxDescriptor->buf_p = &( xEthernetBuffers[ x ][ 0 ] );
\r
385 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
386 pxDescriptor->size = 0;
\r
387 pxDescriptor->status = ACT;
\r
388 pxDescriptor->next = ( ethfifo * ) &xRxDescriptors[ x + 1 ];
\r
390 /* Mark this buffer as in use. */
\r
391 ucBufferInUse[ x ] = pdTRUE;
\r
394 /* The last descriptor points back to the start. */
\r
395 pxDescriptor->status |= DL;
\r
396 pxDescriptor->next = ( ethfifo * ) &xRxDescriptors[ 0 ];
\r
398 /* Initialise the Tx descriptors. */
\r
399 for( x = 0; x < emacNUM_TX_BUFFERS; x++ )
\r
401 pxDescriptor = &( xTxDescriptors[ x ] );
\r
403 /* A buffer is not allocated to the Tx descriptor until a send is
\r
404 actually required. */
\r
405 pxDescriptor->buf_p = NULL;
\r
407 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
408 pxDescriptor->size = 0;
\r
409 pxDescriptor->status = 0;
\r
410 pxDescriptor->next = ( ethfifo * ) &xTxDescriptors[ x + 1 ];
\r
413 /* The last descriptor points back to the start. */
\r
414 pxDescriptor->status |= DL;
\r
415 pxDescriptor->next = ( ethfifo * ) &( xTxDescriptors[ 0 ] );
\r
417 /* Use the first Rx descriptor to start with. */
\r
418 pxCurrentRxDesc = &( xRxDescriptors[ 0 ] );
\r
420 /*-----------------------------------------------------------*/
\r
422 static unsigned char *prvGetNextBuffer( void )
\r
425 unsigned char *pucReturn = NULL;
\r
426 unsigned long ulAttempts = 0;
\r
428 while( pucReturn == NULL )
\r
430 /* Look through the buffers to find one that is not in use by
\r
432 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
434 if( ucBufferInUse[ x ] == pdFALSE )
\r
436 ucBufferInUse[ x ] = pdTRUE;
\r
437 pucReturn = ( unsigned char * ) &( xEthernetBuffers[ x ][ 0 ] );
\r
442 /* Was a buffer found? */
\r
443 if( pucReturn == NULL )
\r
447 if( ulAttempts >= emacBUFFER_WAIT_ATTEMPTS )
\r
452 /* Wait then look again. */
\r
453 vTaskDelay( emacBUFFER_WAIT_DELAY_ms );
\r
459 /*-----------------------------------------------------------*/
\r
461 static void prvReturnBuffer( unsigned char *pucBuffer )
\r
465 /* Return a buffer to the pool of free buffers. */
\r
466 for( ul = 0; ul < emacNUM_BUFFERS; ul++ )
\r
468 if( &( xEthernetBuffers[ ul ][ 0 ] ) == ( void * ) pucBuffer )
\r
470 ucBufferInUse[ ul ] = pdFALSE;
\r
475 /*-----------------------------------------------------------*/
\r
477 static void prvResetEverything( void )
\r
479 /* Temporary code just to see if this gets called. This function has not
\r
480 been implemented. */
\r
481 portDISABLE_INTERRUPTS();
\r
484 /*-----------------------------------------------------------*/
\r
486 static unsigned long prvCheckRxFifoStatus( void )
\r
488 unsigned long ulReturn = 0;
\r
490 if( ( pxCurrentRxDesc->status & ACT ) != 0 )
\r
492 /* Current descriptor is still active. */
\r
494 else if( ( pxCurrentRxDesc->status & FE ) != 0 )
\r
496 /* Frame error. Clear the error. */
\r
497 pxCurrentRxDesc->status &= ~( FP1 | FP0 | FE );
\r
498 pxCurrentRxDesc->status &= ~( RMAF | RRF | RTLF | RTSF | PRE | CERF );
\r
499 pxCurrentRxDesc->status |= ACT;
\r
500 pxCurrentRxDesc = pxCurrentRxDesc->next;
\r
502 if( EDMAC.EDRRR.LONG == 0x00000000UL )
\r
504 /* Restart Ethernet if it has stopped. */
\r
505 EDMAC.EDRRR.LONG = 0x00000001UL;
\r
510 /* The descriptor contains a frame. Because of the size of the buffers
\r
511 the frame should always be complete. */
\r
512 if( ( pxCurrentRxDesc->status & FP0 ) == FP0 )
\r
514 ulReturn = pxCurrentRxDesc->size;
\r
518 /* Do not expect to get here. */
\r
519 prvResetEverything();
\r
525 /*-----------------------------------------------------------*/
\r
527 static void prvResetMAC( void )
\r
529 /* Ensure the EtherC and EDMAC are enabled. */
\r
530 SYSTEM.MSTPCRB.BIT.MSTPB15 = 0;
\r
531 vTaskDelay( 100 / portTICK_PERIOD_MS );
\r
533 EDMAC.EDMR.BIT.SWR = 1;
\r
535 /* Crude wait for reset to complete. */
\r
536 vTaskDelay( 500 / portTICK_PERIOD_MS );
\r
538 /*-----------------------------------------------------------*/
\r
540 static void prvConfigureEtherCAndEDMAC( void )
\r
542 /* Initialisation code taken from Renesas example project. */
\r
544 /* TODO: Check bit 5 */
\r
545 ETHERC.ECSR.LONG = 0x00000037; /* Clear all ETHERC statuS BFR, PSRTO, LCHNG, MPD, ICD */
\r
547 /* Set the EDMAC interrupt priority. */
\r
548 _IPR( _ETHER_EINT ) = configKERNEL_INTERRUPT_PRIORITY;
\r
550 /* TODO: Check bit 5 */
\r
551 /* Enable interrupts of interest only. */
\r
552 EDMAC.EESIPR.LONG = emacTX_END_INTERRUPT | emacRX_END_INTERRUPT;
\r
553 ETHERC.RFLR.LONG = 1518; /* Ether payload is 1500+ CRC */
\r
554 ETHERC.IPGR.LONG = 0x00000014; /* Intergap is 96-bit time */
\r
557 EDMAC.EESR.LONG = 0x47FF0F9F; /* Clear all ETHERC and EDMAC status bits */
\r
558 #if __LITTLE_ENDIAN__ == 1
\r
559 EDMAC.EDMR.BIT.DE = 1;
\r
561 EDMAC.RDLAR = ( void * ) pxCurrentRxDesc; /* Initialaize Rx Descriptor List Address */
\r
562 EDMAC.TDLAR = ( void * ) &( xTxDescriptors[ 0 ] );/* Initialaize Tx Descriptor List Address */
\r
563 EDMAC.TRSCER.LONG = 0x00000000; /* Copy-back status is RFE & TFE only */
\r
564 EDMAC.TFTR.LONG = 0x00000000; /* Threshold of Tx_FIFO */
\r
565 EDMAC.FDR.LONG = 0x00000000; /* Transmit fifo & receive fifo is 256 bytes */
\r
566 EDMAC.RMCR.LONG = 0x00000003; /* Receive function is normal mode(continued) */
\r
567 ETHERC.ECMR.BIT.PRM = 0; /* Ensure promiscuous mode is off. */
\r
569 /* Enable the interrupt... */
\r
570 _IEN( _ETHER_EINT ) = 1;
\r
572 /*-----------------------------------------------------------*/
\r
574 #pragma vector = VECT_ETHER_EINT
\r
575 __interrupt void vEMAC_ISR_Handler( void )
\r
577 unsigned long ul = EDMAC.EESR.LONG;
\r
578 long lHigherPriorityTaskWoken = pdFALSE;
\r
579 extern QueueHandle_t xEMACEventQueue;
\r
580 const unsigned long ulRxEvent = uipETHERNET_RX_EVENT;
\r
582 __enable_interrupt();
\r
584 /* Has a Tx end occurred? */
\r
585 if( ul & emacTX_END_INTERRUPT )
\r
587 /* Only return the buffer to the pool once both Txes have completed. */
\r
588 prvReturnBuffer( ( void * ) xTxDescriptors[ 0 ].buf_p );
\r
589 EDMAC.EESR.LONG = emacTX_END_INTERRUPT;
\r
592 /* Has an Rx end occurred? */
\r
593 if( ul & emacRX_END_INTERRUPT )
\r
595 /* Make sure the Ethernet task is not blocked waiting for a packet. */
\r
596 xQueueSendFromISR( xEMACEventQueue, &ulRxEvent, &lHigherPriorityTaskWoken );
\r
597 portYIELD_FROM_ISR( lHigherPriorityTaskWoken );
\r
598 EDMAC.EESR.LONG = emacRX_END_INTERRUPT;
\r