2 FreeRTOS V9.0.1 - Copyright (C) 2017 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 /* Hardware specific includes. */
\r
71 #include <iorx62n.h>
\r
72 #include "typedefine.h"
\r
73 #include "r_ether.h"
\r
76 /* FreeRTOS includes. */
\r
77 #include "FreeRTOS.h"
\r
82 #include "net/uip.h"
\r
84 /* The time to wait between attempts to obtain a free buffer. */
\r
85 #define emacBUFFER_WAIT_DELAY_ms ( 3 / portTICK_PERIOD_MS )
\r
87 /* The number of times emacBUFFER_WAIT_DELAY_ms should be waited before giving
\r
88 up on attempting to obtain a free buffer all together. */
\r
89 #define emacBUFFER_WAIT_ATTEMPTS ( 30 )
\r
91 /* The number of Rx descriptors. */
\r
92 #define emacNUM_RX_DESCRIPTORS 8
\r
94 /* The number of Tx descriptors. When using uIP there is not point in having
\r
96 #define emacNUM_TX_BUFFERS 2
\r
98 /* The total number of EMAC buffers to allocate. */
\r
99 #define emacNUM_BUFFERS ( emacNUM_RX_DESCRIPTORS + emacNUM_TX_BUFFERS )
\r
101 /* The time to wait for the Tx descriptor to become free. */
\r
102 #define emacTX_WAIT_DELAY_ms ( 10 / portTICK_PERIOD_MS )
\r
104 /* The total number of times to wait emacTX_WAIT_DELAY_ms for the Tx descriptor to
\r
106 #define emacTX_WAIT_ATTEMPTS ( 50 )
\r
108 /* Only Rx end and Tx end interrupts are used by this driver. */
\r
109 #define emacTX_END_INTERRUPT ( 1UL << 21UL )
\r
110 #define emacRX_END_INTERRUPT ( 1UL << 18UL )
\r
112 /*-----------------------------------------------------------*/
\r
114 /* The buffers and descriptors themselves. */
\r
115 #pragma data_alignment=32
\r
116 volatile ethfifo xRxDescriptors[ emacNUM_RX_DESCRIPTORS ];
\r
118 #pragma data_alignment=32
\r
119 volatile ethfifo xTxDescriptors[ emacNUM_TX_BUFFERS ];
\r
121 #pragma data_alignment=32
\r
122 char xEthernetBuffers[ emacNUM_BUFFERS ][ UIP_BUFSIZE ];
\r
125 /* Used to indicate which buffers are free and which are in use. If an index
\r
126 contains 0 then the corresponding buffer in xEthernetBuffers is free, otherwise
\r
127 the buffer is in use or about to be used. */
\r
128 static unsigned char ucBufferInUse[ emacNUM_BUFFERS ];
\r
130 /*-----------------------------------------------------------*/
\r
133 * Initialise both the Rx and Tx descriptors.
\r
135 static void prvInitialiseDescriptors( void );
\r
138 * Return a pointer to a free buffer within xEthernetBuffers.
\r
140 static unsigned char *prvGetNextBuffer( void );
\r
143 * Return a buffer to the list of free buffers.
\r
145 static void prvReturnBuffer( unsigned char *pucBuffer );
\r
148 * Examine the status of the next Rx FIFO to see if it contains new data.
\r
150 static unsigned long prvCheckRxFifoStatus( void );
\r
153 * Setup the microcontroller for communication with the PHY.
\r
155 static void prvResetMAC( void );
\r
158 * Configure the Ethernet interface peripherals.
\r
160 static void prvConfigureEtherCAndEDMAC( void );
\r
163 * Something has gone wrong with the descriptor usage. Reset all the buffers
\r
166 static void prvResetEverything( void );
\r
168 /*-----------------------------------------------------------*/
\r
170 /* Points to the Rx descriptor currently in use. */
\r
171 static volatile ethfifo *pxCurrentRxDesc = NULL;
\r
173 /* The buffer used by the uIP stack to both receive and send. This points to
\r
174 one of the Ethernet buffers when its actually in use. */
\r
175 unsigned char *uip_buf = NULL;
\r
177 /*-----------------------------------------------------------*/
\r
179 void vInitEmac( void )
\r
181 /* Software reset. */
\r
184 /* Set the Rx and Tx descriptors into their initial state. */
\r
185 prvInitialiseDescriptors();
\r
187 /* Set the MAC address into the ETHERC */
\r
188 ETHERC.MAHR = ( ( unsigned long ) configMAC_ADDR0 << 24UL ) |
\r
189 ( ( unsigned long ) configMAC_ADDR1 << 16UL ) |
\r
190 ( ( unsigned long ) configMAC_ADDR2 << 8UL ) |
\r
191 ( unsigned long ) configMAC_ADDR3;
\r
193 ETHERC.MALR.BIT.MA = ( ( unsigned long ) configMAC_ADDR4 << 8UL ) |
\r
194 ( unsigned long ) configMAC_ADDR5;
\r
196 /* Perform rest of interface hardware configuration. */
\r
197 prvConfigureEtherCAndEDMAC();
\r
199 /* Nothing received yet, so uip_buf points nowhere. */
\r
202 /* Initialize the PHY */
\r
205 /*-----------------------------------------------------------*/
\r
207 void vEMACWrite( void )
\r
211 /* Wait until the second transmission of the last packet has completed. */
\r
212 for( x = 0; x < emacTX_WAIT_ATTEMPTS; x++ )
\r
214 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
216 /* Descriptor is still active. */
\r
217 vTaskDelay( emacTX_WAIT_DELAY_ms );
\r
225 /* Is the descriptor free after waiting for it? */
\r
226 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
228 /* Something has gone wrong. */
\r
229 prvResetEverything();
\r
232 /* Setup both descriptors to transmit the frame. */
\r
233 xTxDescriptors[ 0 ].buf_p = ( char * ) uip_buf;
\r
234 xTxDescriptors[ 0 ].bufsize = uip_len;
\r
235 xTxDescriptors[ 1 ].buf_p = ( char * ) uip_buf;
\r
236 xTxDescriptors[ 1 ].bufsize = uip_len;
\r
238 /* uip_buf is being sent by the Tx descriptor. Allocate a new buffer
\r
239 for use by the stack. */
\r
240 uip_buf = prvGetNextBuffer();
\r
242 /* Clear previous settings and go. */
\r
243 xTxDescriptors[0].status &= ~( FP1 | FP0 );
\r
244 xTxDescriptors[0].status |= ( FP1 | FP0 | ACT );
\r
245 xTxDescriptors[1].status &= ~( FP1 | FP0 );
\r
246 xTxDescriptors[1].status |= ( FP1 | FP0 | ACT );
\r
248 EDMAC.EDTRR.LONG = 0x00000001;
\r
250 /*-----------------------------------------------------------*/
\r
252 unsigned long ulEMACRead( void )
\r
254 unsigned long ulBytesReceived;
\r
256 ulBytesReceived = prvCheckRxFifoStatus();
\r
258 if( ulBytesReceived > 0 )
\r
260 /* Mark the pxDescriptor buffer as free as uip_buf is going to be set to
\r
261 the buffer that contains the received data. */
\r
262 prvReturnBuffer( uip_buf );
\r
264 /* Point uip_buf to the data about ot be processed. */
\r
265 uip_buf = ( void * ) pxCurrentRxDesc->buf_p;
\r
267 /* Allocate a new buffer to the descriptor, as uip_buf is now using it's
\r
269 pxCurrentRxDesc->buf_p = ( char * ) prvGetNextBuffer();
\r
271 /* Prepare the descriptor to go again. */
\r
272 pxCurrentRxDesc->status &= ~( FP1 | FP0 );
\r
273 pxCurrentRxDesc->status |= ACT;
\r
275 /* Move onto the next buffer in the ring. */
\r
276 pxCurrentRxDesc = pxCurrentRxDesc->next;
\r
278 if( EDMAC.EDRRR.LONG == 0x00000000L )
\r
280 /* Restart Ethernet if it has stopped */
\r
281 EDMAC.EDRRR.LONG = 0x00000001L;
\r
285 return ulBytesReceived;
\r
287 /*-----------------------------------------------------------*/
\r
289 long lEMACWaitForLink( void )
\r
293 /* Set the link status. */
\r
294 switch( phy_set_autonegotiate() )
\r
296 /* Half duplex link */
\r
297 case PHY_LINK_100H:
\r
298 ETHERC.ECMR.BIT.DM = 0;
\r
299 ETHERC.ECMR.BIT.RTM = 1;
\r
304 ETHERC.ECMR.BIT.DM = 0;
\r
305 ETHERC.ECMR.BIT.RTM = 0;
\r
310 /* Full duplex link */
\r
311 case PHY_LINK_100F:
\r
312 ETHERC.ECMR.BIT.DM = 1;
\r
313 ETHERC.ECMR.BIT.RTM = 1;
\r
318 ETHERC.ECMR.BIT.DM = 1;
\r
319 ETHERC.ECMR.BIT.RTM = 0;
\r
328 if( lReturn == pdPASS )
\r
330 /* Enable receive and transmit. */
\r
331 ETHERC.ECMR.BIT.RE = 1;
\r
332 ETHERC.ECMR.BIT.TE = 1;
\r
334 /* Enable EDMAC receive */
\r
335 EDMAC.EDRRR.LONG = 0x1;
\r
340 /*-----------------------------------------------------------*/
\r
342 static void prvInitialiseDescriptors( void )
\r
344 volatile ethfifo *pxDescriptor;
\r
347 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
349 /* Ensure none of the buffers are shown as in use at the start. */
\r
350 ucBufferInUse[ x ] = pdFALSE;
\r
353 /* Initialise the Rx descriptors. */
\r
354 for( x = 0; x < emacNUM_RX_DESCRIPTORS; x++ )
\r
356 pxDescriptor = &( xRxDescriptors[ x ] );
\r
357 pxDescriptor->buf_p = &( xEthernetBuffers[ x ][ 0 ] );
\r
359 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
360 pxDescriptor->size = 0;
\r
361 pxDescriptor->status = ACT;
\r
362 pxDescriptor->next = ( ethfifo * ) &xRxDescriptors[ x + 1 ];
\r
364 /* Mark this buffer as in use. */
\r
365 ucBufferInUse[ x ] = pdTRUE;
\r
368 /* The last descriptor points back to the start. */
\r
369 pxDescriptor->status |= DL;
\r
370 pxDescriptor->next = ( ethfifo * ) &xRxDescriptors[ 0 ];
\r
372 /* Initialise the Tx descriptors. */
\r
373 for( x = 0; x < emacNUM_TX_BUFFERS; x++ )
\r
375 pxDescriptor = &( xTxDescriptors[ x ] );
\r
377 /* A buffer is not allocated to the Tx descriptor until a send is
\r
378 actually required. */
\r
379 pxDescriptor->buf_p = NULL;
\r
381 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
382 pxDescriptor->size = 0;
\r
383 pxDescriptor->status = 0;
\r
384 pxDescriptor->next = ( ethfifo * ) &xTxDescriptors[ x + 1 ];
\r
387 /* The last descriptor points back to the start. */
\r
388 pxDescriptor->status |= DL;
\r
389 pxDescriptor->next = ( ethfifo * ) &( xTxDescriptors[ 0 ] );
\r
391 /* Use the first Rx descriptor to start with. */
\r
392 pxCurrentRxDesc = &( xRxDescriptors[ 0 ] );
\r
394 /*-----------------------------------------------------------*/
\r
396 static unsigned char *prvGetNextBuffer( void )
\r
399 unsigned char *pucReturn = NULL;
\r
400 unsigned long ulAttempts = 0;
\r
402 while( pucReturn == NULL )
\r
404 /* Look through the buffers to find one that is not in use by
\r
406 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
408 if( ucBufferInUse[ x ] == pdFALSE )
\r
410 ucBufferInUse[ x ] = pdTRUE;
\r
411 pucReturn = ( unsigned char * ) &( xEthernetBuffers[ x ][ 0 ] );
\r
416 /* Was a buffer found? */
\r
417 if( pucReturn == NULL )
\r
421 if( ulAttempts >= emacBUFFER_WAIT_ATTEMPTS )
\r
426 /* Wait then look again. */
\r
427 vTaskDelay( emacBUFFER_WAIT_DELAY_ms );
\r
433 /*-----------------------------------------------------------*/
\r
435 static void prvReturnBuffer( unsigned char *pucBuffer )
\r
439 /* Return a buffer to the pool of free buffers. */
\r
440 for( ul = 0; ul < emacNUM_BUFFERS; ul++ )
\r
442 if( &( xEthernetBuffers[ ul ][ 0 ] ) == ( void * ) pucBuffer )
\r
444 ucBufferInUse[ ul ] = pdFALSE;
\r
449 /*-----------------------------------------------------------*/
\r
451 static void prvResetEverything( void )
\r
453 /* Temporary code just to see if this gets called. This function has not
\r
454 been implemented. */
\r
455 portDISABLE_INTERRUPTS();
\r
458 /*-----------------------------------------------------------*/
\r
460 static unsigned long prvCheckRxFifoStatus( void )
\r
462 unsigned long ulReturn = 0;
\r
464 if( ( pxCurrentRxDesc->status & ACT ) != 0 )
\r
466 /* Current descriptor is still active. */
\r
468 else if( ( pxCurrentRxDesc->status & FE ) != 0 )
\r
470 /* Frame error. Clear the error. */
\r
471 pxCurrentRxDesc->status &= ~( FP1 | FP0 | FE );
\r
472 pxCurrentRxDesc->status &= ~( RMAF | RRF | RTLF | RTSF | PRE | CERF );
\r
473 pxCurrentRxDesc->status |= ACT;
\r
474 pxCurrentRxDesc = pxCurrentRxDesc->next;
\r
476 if( EDMAC.EDRRR.LONG == 0x00000000UL )
\r
478 /* Restart Ethernet if it has stopped. */
\r
479 EDMAC.EDRRR.LONG = 0x00000001UL;
\r
484 /* The descriptor contains a frame. Because of the size of the buffers
\r
485 the frame should always be complete. */
\r
486 if( ( pxCurrentRxDesc->status & FP0 ) == FP0 )
\r
488 ulReturn = pxCurrentRxDesc->size;
\r
492 /* Do not expect to get here. */
\r
493 prvResetEverything();
\r
499 /*-----------------------------------------------------------*/
\r
501 static void prvResetMAC( void )
\r
503 /* Ensure the EtherC and EDMAC are enabled. */
\r
504 SYSTEM.MSTPCRB.BIT.MSTPB15 = 0;
\r
505 vTaskDelay( 100 / portTICK_PERIOD_MS );
\r
507 EDMAC.EDMR.BIT.SWR = 1;
\r
509 /* Crude wait for reset to complete. */
\r
510 vTaskDelay( 500 / portTICK_PERIOD_MS );
\r
512 /*-----------------------------------------------------------*/
\r
514 static void prvConfigureEtherCAndEDMAC( void )
\r
516 /* Initialisation code taken from Renesas example project. */
\r
518 /* TODO: Check bit 5 */
\r
519 ETHERC.ECSR.LONG = 0x00000037; /* Clear all ETHERC statuS BFR, PSRTO, LCHNG, MPD, ICD */
\r
521 /* Set the EDMAC interrupt priority. */
\r
522 _IPR( _ETHER_EINT ) = configKERNEL_INTERRUPT_PRIORITY;
\r
524 /* TODO: Check bit 5 */
\r
525 /* Enable interrupts of interest only. */
\r
526 EDMAC.EESIPR.LONG = emacTX_END_INTERRUPT | emacRX_END_INTERRUPT;
\r
527 ETHERC.RFLR.LONG = 1518; /* Ether payload is 1500+ CRC */
\r
528 ETHERC.IPGR.LONG = 0x00000014; /* Intergap is 96-bit time */
\r
531 EDMAC.EESR.LONG = 0x47FF0F9F; /* Clear all ETHERC and EDMAC status bits */
\r
532 #if __LITTLE_ENDIAN__ == 1
\r
533 EDMAC.EDMR.BIT.DE = 1;
\r
535 EDMAC.RDLAR = ( void * ) pxCurrentRxDesc; /* Initialaize Rx Descriptor List Address */
\r
536 EDMAC.TDLAR = ( void * ) &( xTxDescriptors[ 0 ] );/* Initialaize Tx Descriptor List Address */
\r
537 EDMAC.TRSCER.LONG = 0x00000000; /* Copy-back status is RFE & TFE only */
\r
538 EDMAC.TFTR.LONG = 0x00000000; /* Threshold of Tx_FIFO */
\r
539 EDMAC.FDR.LONG = 0x00000000; /* Transmit fifo & receive fifo is 256 bytes */
\r
540 EDMAC.RMCR.LONG = 0x00000003; /* Receive function is normal mode(continued) */
\r
541 ETHERC.ECMR.BIT.PRM = 0; /* Ensure promiscuous mode is off. */
\r
543 /* Enable the interrupt... */
\r
544 _IEN( _ETHER_EINT ) = 1;
\r
546 /*-----------------------------------------------------------*/
\r
548 #pragma vector = VECT_ETHER_EINT
\r
549 __interrupt void vEMAC_ISR_Handler( void )
\r
551 unsigned long ul = EDMAC.EESR.LONG;
\r
552 long lHigherPriorityTaskWoken = pdFALSE;
\r
553 extern QueueHandle_t xEMACEventQueue;
\r
554 const unsigned long ulRxEvent = uipETHERNET_RX_EVENT;
\r
556 __enable_interrupt();
\r
558 /* Has a Tx end occurred? */
\r
559 if( ul & emacTX_END_INTERRUPT )
\r
561 /* Only return the buffer to the pool once both Txes have completed. */
\r
562 prvReturnBuffer( ( void * ) xTxDescriptors[ 0 ].buf_p );
\r
563 EDMAC.EESR.LONG = emacTX_END_INTERRUPT;
\r
566 /* Has an Rx end occurred? */
\r
567 if( ul & emacRX_END_INTERRUPT )
\r
569 /* Make sure the Ethernet task is not blocked waiting for a packet. */
\r
570 xQueueSendFromISR( xEMACEventQueue, &ulRxEvent, &lHigherPriorityTaskWoken );
\r
571 portYIELD_FROM_ISR( lHigherPriorityTaskWoken );
\r
572 EDMAC.EESR.LONG = emacRX_END_INTERRUPT;
\r