2 * FreeRTOS Kernel V10.3.0
\r
3 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
\r
5 * Permission is hereby granted, free of charge, to any person obtaining a copy of
\r
6 * this software and associated documentation files (the "Software"), to deal in
\r
7 * the Software without restriction, including without limitation the rights to
\r
8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
\r
9 * the Software, and to permit persons to whom the Software is furnished to do so,
\r
10 * subject to the following conditions:
\r
12 * The above copyright notice and this permission notice shall be included in all
\r
13 * copies or substantial portions of the Software.
\r
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
\r
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
\r
17 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
\r
18 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
\r
19 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
\r
20 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\r
22 * http://www.FreeRTOS.org
\r
23 * http://aws.amazon.com/freertos
\r
25 * 1 tab == 4 spaces!
\r
28 /* FreeRTOS includes. */
\r
29 #include "FreeRTOS.h"
\r
33 /* Hardware specific includes. */
\r
34 #include "r_ether.h"
\r
38 #include "net/uip.h"
\r
40 /* The time to wait between attempts to obtain a free buffer. */
\r
41 #define emacBUFFER_WAIT_DELAY_ms ( 3 / portTICK_PERIOD_MS )
\r
43 /* The number of times emacBUFFER_WAIT_DELAY_ms should be waited before giving
\r
44 up on attempting to obtain a free buffer all together. */
\r
45 #define emacBUFFER_WAIT_ATTEMPTS ( 30 )
\r
47 /* The number of Rx descriptors. */
\r
48 #define emacNUM_RX_DESCRIPTORS 8
\r
50 /* The number of Tx descriptors. When using uIP there is not point in having
\r
52 #define emacNUM_TX_BUFFERS 2
\r
54 /* The total number of EMAC buffers to allocate. */
\r
55 #define emacNUM_BUFFERS ( emacNUM_RX_DESCRIPTORS + emacNUM_TX_BUFFERS )
\r
57 /* The time to wait for the Tx descriptor to become free. */
\r
58 #define emacTX_WAIT_DELAY_ms ( 10 / portTICK_PERIOD_MS )
\r
60 /* The total number of times to wait emacTX_WAIT_DELAY_ms for the Tx descriptor to
\r
62 #define emacTX_WAIT_ATTEMPTS ( 50 )
\r
64 /* Only Rx end and Tx end interrupts are used by this driver. */
\r
65 #define emacTX_END_INTERRUPT ( 1UL << 21UL )
\r
66 #define emacRX_END_INTERRUPT ( 1UL << 18UL )
\r
68 /*-----------------------------------------------------------*/
\r
70 /* The buffers and descriptors themselves. */
\r
71 #pragma section _RX_DESC
\r
72 volatile ethfifo xRxDescriptors[ emacNUM_RX_DESCRIPTORS ];
\r
73 #pragma section _TX_DESC
\r
74 volatile ethfifo xTxDescriptors[ emacNUM_TX_BUFFERS ];
\r
75 #pragma section _ETHERNET_BUFFERS
\r
78 unsigned long ulAlignmentVariable;
\r
79 char cBuffer[ emacNUM_BUFFERS ][ UIP_BUFSIZE ];
\r
86 /* Used to indicate which buffers are free and which are in use. If an index
\r
87 contains 0 then the corresponding buffer in xEthernetBuffers is free, otherwise
\r
88 the buffer is in use or about to be used. */
\r
89 static unsigned char ucBufferInUse[ emacNUM_BUFFERS ];
\r
91 /*-----------------------------------------------------------*/
\r
94 * Initialise both the Rx and Tx descriptors.
\r
96 static void prvInitialiseDescriptors( void );
\r
99 * Return a pointer to a free buffer within xEthernetBuffers.
\r
101 static unsigned char *prvGetNextBuffer( void );
\r
104 * Return a buffer to the list of free buffers.
\r
106 static void prvReturnBuffer( unsigned char *pucBuffer );
\r
109 * Examine the status of the next Rx FIFO to see if it contains new data.
\r
111 static unsigned long prvCheckRxFifoStatus( void );
\r
114 * Setup the microcontroller for communication with the PHY.
\r
116 static void prvResetMAC( void );
\r
119 * Configure the Ethernet interface peripherals.
\r
121 static void prvConfigureEtherCAndEDMAC( void );
\r
124 * Something has gone wrong with the descriptor usage. Reset all the buffers
\r
127 static void prvResetEverything( void );
\r
129 /*-----------------------------------------------------------*/
\r
131 /* Points to the Rx descriptor currently in use. */
\r
132 static ethfifo *pxCurrentRxDesc = NULL;
\r
134 /* The buffer used by the uIP stack to both receive and send. This points to
\r
135 one of the Ethernet buffers when its actually in use. */
\r
136 unsigned char *uip_buf = NULL;
\r
138 /*-----------------------------------------------------------*/
\r
140 void vInitEmac( void )
\r
142 /* Software reset. */
\r
145 /* Set the Rx and Tx descriptors into their initial state. */
\r
146 prvInitialiseDescriptors();
\r
148 /* Set the MAC address into the ETHERC */
\r
149 ETHERC.MAHR = ( ( unsigned long ) configMAC_ADDR0 << 24UL ) |
\r
150 ( ( unsigned long ) configMAC_ADDR1 << 16UL ) |
\r
151 ( ( unsigned long ) configMAC_ADDR2 << 8UL ) |
\r
152 ( unsigned long ) configMAC_ADDR3;
\r
154 ETHERC.MALR.BIT.MA = ( ( unsigned long ) configMAC_ADDR4 << 8UL ) |
\r
155 ( unsigned long ) configMAC_ADDR5;
\r
157 /* Perform rest of interface hardware configuration. */
\r
158 prvConfigureEtherCAndEDMAC();
\r
160 /* Nothing received yet, so uip_buf points nowhere. */
\r
163 /* Initialize the PHY */
\r
164 configASSERT( phy_init() == R_PHY_OK );
\r
166 /*-----------------------------------------------------------*/
\r
168 void vEMACWrite( void )
\r
172 /* Wait until the second transmission of the last packet has completed. */
\r
173 for( x = 0; x < emacTX_WAIT_ATTEMPTS; x++ )
\r
175 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
177 /* Descriptor is still active. */
\r
178 vTaskDelay( emacTX_WAIT_DELAY_ms );
\r
186 /* Is the descriptor free after waiting for it? */
\r
187 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
189 /* Something has gone wrong. */
\r
190 prvResetEverything();
\r
193 /* Setup both descriptors to transmit the frame. */
\r
194 xTxDescriptors[ 0 ].buf_p = ( char * ) uip_buf;
\r
195 xTxDescriptors[ 0 ].bufsize = uip_len;
\r
196 xTxDescriptors[ 1 ].buf_p = ( char * ) uip_buf;
\r
197 xTxDescriptors[ 1 ].bufsize = uip_len;
\r
199 /* uip_buf is being sent by the Tx descriptor. Allocate a new buffer
\r
200 for use by the stack. */
\r
201 uip_buf = prvGetNextBuffer();
\r
203 /* Clear previous settings and go. */
\r
204 xTxDescriptors[0].status &= ~( FP1 | FP0 );
\r
205 xTxDescriptors[0].status |= ( FP1 | FP0 | ACT );
\r
206 xTxDescriptors[1].status &= ~( FP1 | FP0 );
\r
207 xTxDescriptors[1].status |= ( FP1 | FP0 | ACT );
\r
209 EDMAC.EDTRR.LONG = 0x00000001;
\r
211 /*-----------------------------------------------------------*/
\r
213 unsigned long ulEMACRead( void )
\r
215 unsigned long ulBytesReceived;
\r
217 ulBytesReceived = prvCheckRxFifoStatus();
\r
219 if( ulBytesReceived > 0 )
\r
221 /* Mark the pxDescriptor buffer as free as uip_buf is going to be set to
\r
222 the buffer that contains the received data. */
\r
223 prvReturnBuffer( uip_buf );
\r
225 /* Point uip_buf to the data about ot be processed. */
\r
226 uip_buf = ( void * ) pxCurrentRxDesc->buf_p;
\r
228 /* Allocate a new buffer to the descriptor, as uip_buf is now using it's
\r
230 pxCurrentRxDesc->buf_p = prvGetNextBuffer();
\r
232 /* Prepare the descriptor to go again. */
\r
233 pxCurrentRxDesc->status &= ~( FP1 | FP0 );
\r
234 pxCurrentRxDesc->status |= ACT;
\r
236 /* Move onto the next buffer in the ring. */
\r
237 pxCurrentRxDesc = pxCurrentRxDesc->next;
\r
239 if( EDMAC.EDRRR.LONG == 0x00000000L )
\r
241 /* Restart Ethernet if it has stopped */
\r
242 EDMAC.EDRRR.LONG = 0x00000001L;
\r
246 return ulBytesReceived;
\r
248 /*-----------------------------------------------------------*/
\r
250 long lEMACWaitForLink( void )
\r
254 /* Set the link status. */
\r
255 switch( phy_set_autonegotiate() )
\r
257 /* Half duplex link */
\r
258 case PHY_LINK_100H:
\r
259 ETHERC.ECMR.BIT.DM = 0;
\r
260 ETHERC.ECMR.BIT.RTM = 1;
\r
265 ETHERC.ECMR.BIT.DM = 0;
\r
266 ETHERC.ECMR.BIT.RTM = 0;
\r
271 /* Full duplex link */
\r
272 case PHY_LINK_100F:
\r
273 ETHERC.ECMR.BIT.DM = 1;
\r
274 ETHERC.ECMR.BIT.RTM = 1;
\r
279 ETHERC.ECMR.BIT.DM = 1;
\r
280 ETHERC.ECMR.BIT.RTM = 0;
\r
289 if( lReturn == pdPASS )
\r
291 /* Enable receive and transmit. */
\r
292 ETHERC.ECMR.BIT.RE = 1;
\r
293 ETHERC.ECMR.BIT.TE = 1;
\r
295 /* Enable EDMAC receive */
\r
296 EDMAC.EDRRR.LONG = 0x1;
\r
301 /*-----------------------------------------------------------*/
\r
303 static void prvInitialiseDescriptors( void )
\r
305 ethfifo *pxDescriptor;
\r
308 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
310 /* Ensure none of the buffers are shown as in use at the start. */
\r
311 ucBufferInUse[ x ] = pdFALSE;
\r
314 /* Initialise the Rx descriptors. */
\r
315 for( x = 0; x < emacNUM_RX_DESCRIPTORS; x++ )
\r
317 pxDescriptor = &( xRxDescriptors[ x ] );
\r
318 pxDescriptor->buf_p = &( xEthernetBuffers.cBuffer[ x ][ 0 ] );
\r
320 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
321 pxDescriptor->size = 0;
\r
322 pxDescriptor->status = ACT;
\r
323 pxDescriptor->next = &xRxDescriptors[ x + 1 ];
\r
325 /* Mark this buffer as in use. */
\r
326 ucBufferInUse[ x ] = pdTRUE;
\r
329 /* The last descriptor points back to the start. */
\r
330 pxDescriptor->status |= DL;
\r
331 pxDescriptor->next = &xRxDescriptors[ 0 ];
\r
333 /* Initialise the Tx descriptors. */
\r
334 for( x = 0; x < emacNUM_TX_BUFFERS; x++ )
\r
336 pxDescriptor = &( xTxDescriptors[ x ] );
\r
338 /* A buffer is not allocated to the Tx descriptor until a send is
\r
339 actually required. */
\r
340 pxDescriptor->buf_p = NULL;
\r
342 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
343 pxDescriptor->size = 0;
\r
344 pxDescriptor->status = 0;
\r
345 pxDescriptor->next = &xTxDescriptors[ x + 1 ];
\r
348 /* The last descriptor points back to the start. */
\r
349 pxDescriptor->status |= DL;
\r
350 pxDescriptor->next = &( xTxDescriptors[ 0 ] );
\r
352 /* Use the first Rx descriptor to start with. */
\r
353 pxCurrentRxDesc = &( xRxDescriptors[ 0 ] );
\r
355 /*-----------------------------------------------------------*/
\r
357 static unsigned char *prvGetNextBuffer( void )
\r
360 unsigned char *pucReturn = NULL;
\r
361 unsigned long ulAttempts = 0;
\r
363 while( pucReturn == NULL )
\r
365 /* Look through the buffers to find one that is not in use by
\r
367 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
369 if( ucBufferInUse[ x ] == pdFALSE )
\r
371 ucBufferInUse[ x ] = pdTRUE;
\r
372 pucReturn = ( unsigned char * ) &( xEthernetBuffers.cBuffer[ x ][ 0 ] );
\r
377 /* Was a buffer found? */
\r
378 if( pucReturn == NULL )
\r
382 if( ulAttempts >= emacBUFFER_WAIT_ATTEMPTS )
\r
387 /* Wait then look again. */
\r
388 vTaskDelay( emacBUFFER_WAIT_DELAY_ms );
\r
394 /*-----------------------------------------------------------*/
\r
396 static void prvReturnBuffer( unsigned char *pucBuffer )
\r
400 /* Return a buffer to the pool of free buffers. */
\r
401 for( ul = 0; ul < emacNUM_BUFFERS; ul++ )
\r
403 if( &( xEthernetBuffers.cBuffer[ ul ][ 0 ] ) == ( void * ) pucBuffer )
\r
405 ucBufferInUse[ ul ] = pdFALSE;
\r
410 /*-----------------------------------------------------------*/
\r
412 static void prvResetEverything( void )
\r
414 /* Temporary code just to see if this gets called. This function has not
\r
415 been implemented. */
\r
416 portDISABLE_INTERRUPTS();
\r
419 /*-----------------------------------------------------------*/
\r
421 static unsigned long prvCheckRxFifoStatus( void )
\r
423 unsigned long ulReturn = 0;
\r
425 if( ( pxCurrentRxDesc->status & ACT ) != 0 )
\r
427 /* Current descriptor is still active. */
\r
429 else if( ( pxCurrentRxDesc->status & FE ) != 0 )
\r
431 /* Frame error. Clear the error. */
\r
432 pxCurrentRxDesc->status &= ~( FP1 | FP0 | FE );
\r
433 pxCurrentRxDesc->status &= ~( RMAF | RRF | RTLF | RTSF | PRE | CERF );
\r
434 pxCurrentRxDesc->status |= ACT;
\r
435 pxCurrentRxDesc = pxCurrentRxDesc->next;
\r
437 if( EDMAC.EDRRR.LONG == 0x00000000UL )
\r
439 /* Restart Ethernet if it has stopped. */
\r
440 EDMAC.EDRRR.LONG = 0x00000001UL;
\r
445 /* The descriptor contains a frame. Because of the size of the buffers
\r
446 the frame should always be complete. */
\r
447 if( ( pxCurrentRxDesc->status & FP0 ) == FP0 )
\r
449 ulReturn = pxCurrentRxDesc->size;
\r
453 /* Do not expect to get here. */
\r
454 prvResetEverything();
\r
460 /*-----------------------------------------------------------*/
\r
462 static void prvResetMAC( void )
\r
464 /* Ensure the EtherC and EDMAC are enabled. */
\r
465 SYSTEM.MSTPCRB.BIT.MSTPB15 = 0;
\r
466 vTaskDelay( 100 / portTICK_PERIOD_MS );
\r
468 EDMAC.EDMR.BIT.SWR = 1;
\r
470 /* Crude wait for reset to complete. */
\r
471 vTaskDelay( 500 / portTICK_PERIOD_MS );
\r
473 /*-----------------------------------------------------------*/
\r
475 static void prvConfigureEtherCAndEDMAC( void )
\r
477 /* Initialisation code taken from Renesas example project. */
\r
479 /* TODO: Check bit 5 */
\r
480 ETHERC.ECSR.LONG = 0x00000037; /* Clear all ETHERC statuS BFR, PSRTO, LCHNG, MPD, ICD */
\r
482 /* Set the EDMAC interrupt priority. */
\r
483 _IPR( _ETHER_EINT ) = configKERNEL_INTERRUPT_PRIORITY;
\r
485 /* TODO: Check bit 5 */
\r
486 /* Enable interrupts of interest only. */
\r
487 EDMAC.EESIPR.LONG = emacTX_END_INTERRUPT | emacRX_END_INTERRUPT;
\r
488 ETHERC.RFLR.LONG = 1518; /* Ether payload is 1500+ CRC */
\r
489 ETHERC.IPGR.LONG = 0x00000014; /* Intergap is 96-bit time */
\r
492 EDMAC.EESR.LONG = 0x47FF0F9F; /* Clear all ETHERC and EDMAC status bits */
\r
494 EDMAC.EDMR.BIT.DE = 1;
\r
496 EDMAC.RDLAR = ( void * ) pxCurrentRxDesc; /* Initialaize Rx Descriptor List Address */
\r
497 EDMAC.TDLAR = &( xTxDescriptors[ 0 ] ); /* Initialaize Tx Descriptor List Address */
\r
498 EDMAC.TRSCER.LONG = 0x00000000; /* Copy-back status is RFE & TFE only */
\r
499 EDMAC.TFTR.LONG = 0x00000000; /* Threshold of Tx_FIFO */
\r
500 EDMAC.FDR.LONG = 0x00000000; /* Transmit fifo & receive fifo is 256 bytes */
\r
501 EDMAC.RMCR.LONG = 0x00000003; /* Receive function is normal mode(continued) */
\r
502 ETHERC.ECMR.BIT.PRM = 0; /* Ensure promiscuous mode is off. */
\r
504 /* Enable the interrupt... */
\r
505 _IEN( _ETHER_EINT ) = 1;
\r
507 /*-----------------------------------------------------------*/
\r
509 #pragma interrupt ( vEMAC_ISR_Handler( vect = VECT_ETHER_EINT, enable ) )
\r
510 void vEMAC_ISR_Handler( void )
\r
512 unsigned long ul = EDMAC.EESR.LONG;
\r
513 long lHigherPriorityTaskWoken = pdFALSE;
\r
514 extern QueueHandle_t xEMACEventQueue;
\r
515 const unsigned long ulRxEvent = uipETHERNET_RX_EVENT;
\r
517 /* Has a Tx end occurred? */
\r
518 if( ul & emacTX_END_INTERRUPT )
\r
520 /* Only return the buffer to the pool once both Txes have completed. */
\r
521 prvReturnBuffer( ( void * ) xTxDescriptors[ 0 ].buf_p );
\r
522 EDMAC.EESR.LONG = emacTX_END_INTERRUPT;
\r
525 /* Has an Rx end occurred? */
\r
526 if( ul & emacRX_END_INTERRUPT )
\r
528 /* Make sure the Ethernet task is not blocked waiting for a packet. */
\r
529 xQueueSendFromISR( xEMACEventQueue, &ulRxEvent, &lHigherPriorityTaskWoken );
\r
530 portYIELD_FROM_ISR( lHigherPriorityTaskWoken );
\r
531 EDMAC.EESR.LONG = emacRX_END_INTERRUPT;
\r