2 FreeRTOS V6.0.2 - Copyright (C) 2010 Real Time Engineers Ltd.
\r
4 ***************************************************************************
\r
8 * + New to FreeRTOS, *
\r
9 * + Wanting to learn FreeRTOS or multitasking in general quickly *
\r
10 * + Looking for basic training, *
\r
11 * + Wanting to improve your FreeRTOS skills and productivity *
\r
13 * then take a look at the FreeRTOS eBook *
\r
15 * "Using the FreeRTOS Real Time Kernel - a Practical Guide" *
\r
16 * http://www.FreeRTOS.org/Documentation *
\r
18 * A pdf reference manual is also available. Both are usually delivered *
\r
19 * to your inbox within 20 minutes to two hours when purchased between 8am *
\r
20 * and 8pm GMT (although please allow up to 24 hours in case of *
\r
21 * exceptional circumstances). Thank you for your support! *
\r
23 ***************************************************************************
\r
25 This file is part of the FreeRTOS distribution.
\r
27 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
28 the terms of the GNU General Public License (version 2) as published by the
\r
29 Free Software Foundation AND MODIFIED BY the FreeRTOS exception.
\r
30 ***NOTE*** The exception to the GPL is included to allow you to distribute
\r
31 a combined work that includes FreeRTOS without being obliged to provide the
\r
32 source code for proprietary components outside of the FreeRTOS kernel.
\r
33 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT
\r
34 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
\r
35 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
\r
36 more details. You should have received a copy of the GNU General Public
\r
37 License and the FreeRTOS license exception along with FreeRTOS; if not it
\r
38 can be viewed here: http://www.freertos.org/a00114.html and also obtained
\r
39 by writing to Richard Barry, contact details for whom are available on the
\r
44 http://www.FreeRTOS.org - Documentation, latest information, license and
\r
47 http://www.SafeRTOS.com - A version that is certified for use in safety
\r
50 http://www.OpenRTOS.com - Commercial support, development, porting,
\r
51 licensing and training services.
\r
54 /* Hardware specific includes. */
\r
55 #include "iodefine.h"
\r
56 #include "hwEthernet.h"
\r
57 #include "hwEthernetPhy.h"
\r
59 /* FreeRTOS includes. */
\r
60 #include "FreeRTOS.h"
\r
65 #include "net/uip.h"
\r
67 /* The time to wait between attempts to obtain a free buffer. */
\r
68 #define emacBUFFER_WAIT_DELAY_ms ( 3 / portTICK_RATE_MS )
\r
70 /* The number of times emacBUFFER_WAIT_DELAY_ms should be waited before giving
\r
71 up on attempting to obtain a free buffer all together. */
\r
72 #define emacBUFFER_WAIT_ATTEMPTS ( 30 )
\r
74 /* The number of Rx descriptors. */
\r
75 #define emacNUM_RX_DESCRIPTORS 3
\r
77 /* The number of Tx descriptors. When using uIP there is not point in having
\r
79 #define emacNUM_TX_BUFFERS 2
\r
81 /* The total number of EMAC buffers to allocate. */
\r
82 #define emacNUM_BUFFERS ( emacNUM_RX_DESCRIPTORS + emacNUM_TX_BUFFERS )
\r
84 /* The time to wait for the Tx descriptor to become free. */
\r
85 #define emacTX_WAIT_DELAY_ms ( 10 / portTICK_RATE_MS )
\r
87 /* The total number of times to wait emacTX_WAIT_DELAY_ms for the Tx descriptor to
\r
89 #define emacTX_WAIT_ATTEMPTS ( 5 )
\r
91 /* Only Rx end and Tx end interrupts are used by this driver. */
\r
92 #define emacTX_END_INTERRUPT ( 1UL << 21UL )
\r
93 #define emacRX_END_INTERRUPT ( 1UL << 18UL )
\r
95 /*-----------------------------------------------------------*/
\r
97 /* The buffers and descriptors themselves. */
\r
98 #pragma section RX_DESCR
\r
99 ethfifo xRxDescriptors[ emacNUM_RX_DESCRIPTORS ];
\r
100 #pragma section TX_DESCR
\r
101 ethfifo xTxDescriptors[ emacNUM_TX_BUFFERS ];
\r
102 #pragma section _ETHERNET_BUFFERS
\r
103 char xEthernetBuffers[ emacNUM_BUFFERS ][ UIP_BUFSIZE ];
\r
106 /* Used to indicate which buffers are free and which are in use. If an index
\r
107 contains 0 then the corresponding buffer in xEthernetBuffers is free, otherwise
\r
108 the buffer is in use or about to be used. */
\r
109 static unsigned char ucBufferInUse[ emacNUM_BUFFERS ];
\r
111 /*-----------------------------------------------------------*/
\r
114 * Initialise both the Rx and Tx descriptors.
\r
116 static void prvInitialiseDescriptors( void );
\r
119 * Return a pointer to a free buffer within xEthernetBuffers.
\r
121 static unsigned char *prvGetNextBuffer( void );
\r
124 * Return a buffer to the list of free buffers.
\r
126 static void prvReturnBuffer( unsigned char *pucBuffer );
\r
129 * Examine the status of the next Rx FIFO to see if it contains new data.
\r
131 static unsigned long prvCheckRxFifoStatus( void );
\r
134 * Setup the microcontroller for communication with the PHY.
\r
136 static void prvSetupPortPinsAndReset( void );
\r
139 * Configure the Ethernet interface peripherals.
\r
141 static void prvConfigureEtherCAndEDMAC( void );
\r
144 * Something has gone wrong with the descriptor usage. Reset all the buffers
\r
147 static void prvResetEverything( void );
\r
149 /*-----------------------------------------------------------*/
\r
151 /* Points to the Rx descriptor currently in use. */
\r
152 static ethfifo *xCurrentRxDesc = NULL;
\r
154 /* The buffer used by the uIP stack to both receive and send. This points to
\r
155 one of the Ethernet buffers when its actually in use. */
\r
156 unsigned char *uip_buf = NULL;
\r
158 /*-----------------------------------------------------------*/
\r
160 void vInitEmac( void )
\r
162 /* Setup the SH hardware for MII communications. */
\r
163 prvSetupPortPinsAndReset();
\r
165 /* Set the Rx and Tx descriptors into their initial state. */
\r
166 prvInitialiseDescriptors();
\r
168 /* Set the MAC address into the ETHERC */
\r
169 EtherC.MAHR = ( ( unsigned long ) configMAC_ADDR0 << 24UL ) |
\r
170 ( ( unsigned long ) configMAC_ADDR1 << 16UL ) |
\r
171 ( ( unsigned long ) configMAC_ADDR2 << 8UL ) |
\r
172 ( unsigned long ) configMAC_ADDR3;
\r
174 EtherC.MALR.BIT.MA = ( ( unsigned long ) configMAC_ADDR4 << 8UL ) |
\r
175 ( unsigned long ) configMAC_ADDR5;
\r
177 /* Perform rest of interface hardware configuration. */
\r
178 prvConfigureEtherCAndEDMAC();
\r
180 /* Nothing received yet, so uip_buf points nowhere. */
\r
183 /* Initialize the PHY */
\r
186 /*-----------------------------------------------------------*/
\r
188 void vEMACWrite( void )
\r
192 /* Wait until the second transmission of the last packet has completed. */
\r
193 for( x = 0; x < emacTX_WAIT_ATTEMPTS; x++ )
\r
195 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
197 /* Descriptor is still active. */
\r
198 vTaskDelay( emacTX_WAIT_DELAY_ms );
\r
206 /* Is the descriptor free after waiting for it? */
\r
207 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
209 /* Something has gone wrong. */
\r
210 prvResetEverything();
\r
213 /* Setup both descriptors to transmit the frame. */
\r
214 xTxDescriptors[ 0 ].buf_p = uip_buf;
\r
215 xTxDescriptors[ 0 ].bufsize = uip_len;
\r
216 xTxDescriptors[ 1 ].buf_p = uip_buf;
\r
217 xTxDescriptors[ 1 ].bufsize = uip_len;
\r
219 /* uip_buf is being sent by the Tx descriptor. Allocate a new buffer
\r
220 for use by the stack. */
\r
221 uip_buf = prvGetNextBuffer();
\r
223 /* Clear previous settings and go. */
\r
224 xTxDescriptors[0].status &= ~( FP1 | FP0 );
\r
225 xTxDescriptors[0].status |= ( FP1 | FP0 | ACT );
\r
226 xTxDescriptors[1].status &= ~( FP1 | FP0 );
\r
227 xTxDescriptors[1].status |= ( FP1 | FP0 | ACT );
\r
229 EDMAC.EDTRR.LONG = 0x00000001;
\r
231 /*-----------------------------------------------------------*/
\r
233 unsigned long ulEMACRead( void )
\r
235 unsigned long ulBytesReceived;
\r
237 ulBytesReceived = prvCheckRxFifoStatus();
\r
239 if( ulBytesReceived > 0 )
\r
241 xCurrentRxDesc->status &= ~( FP1 | FP0 );
\r
242 xCurrentRxDesc->status |= ACT;
\r
244 if( EDMAC.EDRRR.LONG == 0x00000000L )
\r
246 /* Restart Ethernet if it has stopped */
\r
247 EDMAC.EDRRR.LONG = 0x00000001L;
\r
250 /* Mark the pxDescriptor buffer as free as uip_buf is going to be set to
\r
251 the buffer that contains the received data. */
\r
252 prvReturnBuffer( uip_buf );
\r
254 uip_buf = ( void * ) xCurrentRxDesc->buf_p;
\r
256 /* Move onto the next buffer in the ring. */
\r
257 xCurrentRxDesc = xCurrentRxDesc->next;
\r
260 return ulBytesReceived;
\r
262 /*-----------------------------------------------------------*/
\r
264 long lEMACWaitForLink( void )
\r
268 /* Set the link status. */
\r
269 switch( phyStatus() )
\r
271 /* Half duplex link */
\r
272 case PHY_LINK_100H:
\r
274 EtherC.ECMR.BIT.DM = 0;
\r
278 /* Full duplex link */
\r
279 case PHY_LINK_100F:
\r
281 EtherC.ECMR.BIT.DM = 1;
\r
290 if( lReturn == pdPASS )
\r
292 /* Enable receive and transmit. */
\r
293 EtherC.ECMR.BIT.RE = 1;
\r
294 EtherC.ECMR.BIT.TE = 1;
\r
296 /* Enable EDMAC receive */
\r
297 EDMAC.EDRRR.LONG = 0x1;
\r
300 /*-----------------------------------------------------------*/
\r
302 static void prvInitialiseDescriptors( void )
\r
304 ethfifo *pxDescriptor;
\r
307 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
309 /* Ensure none of the buffers are shown as in use at the start. */
\r
310 ucBufferInUse[ x ] = pdFALSE;
\r
313 /* Initialise the Rx descriptors. */
\r
314 for( x = 0; x < emacNUM_RX_DESCRIPTORS; x++ )
\r
316 pxDescriptor = &xRxDescriptors[ x ];
\r
317 pxDescriptor->buf_p = &( xEthernetBuffers[ x ][ 0 ] );
\r
319 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
320 pxDescriptor->size = 0;
\r
321 pxDescriptor->status = ACT;
\r
322 pxDescriptor->next = &xRxDescriptors[ x + 1 ];
\r
324 /* Mark this buffer as in use. */
\r
325 ucBufferInUse[ x ] = pdTRUE;
\r
328 /* The last descriptor points back to the start. */
\r
329 pxDescriptor->status |= DL;
\r
330 pxDescriptor->next = &xRxDescriptors[ 0 ];
\r
332 /* Initialise the Tx descriptors. */
\r
333 for( x = 0; x < emacNUM_TX_BUFFERS; x++ )
\r
335 pxDescriptor = &( xTxDescriptors[ x ] );
\r
337 /* A buffer is not allocated to the Tx descriptor until a send is
\r
338 actually required. */
\r
339 pxDescriptor->buf_p = NULL;
\r
341 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
342 pxDescriptor->size = 0;
\r
343 pxDescriptor->status = 0;
\r
344 pxDescriptor->next = &xTxDescriptors[ x + 1 ];
\r
347 /* The last descriptor points back to the start. */
\r
348 pxDescriptor->status |= DL;
\r
349 pxDescriptor->next = &( xTxDescriptors[ 0 ] );
\r
351 /* Use the first Rx descriptor to start with. */
\r
352 xCurrentRxDesc = &( xRxDescriptors[ 0 ] );
\r
354 /*-----------------------------------------------------------*/
\r
356 static unsigned char *prvGetNextBuffer( void )
\r
359 unsigned char *pucReturn = NULL;
\r
360 unsigned long ulAttempts = 0;
\r
362 while( pucReturn == NULL )
\r
364 /* Look through the buffers to find one that is not in use by
\r
366 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
368 if( ucBufferInUse[ x ] == pdFALSE )
\r
370 ucBufferInUse[ x ] = pdTRUE;
\r
371 pucReturn = ( unsigned char * ) &( xEthernetBuffers[ x ][ 0 ] );
\r
376 /* Was a buffer found? */
\r
377 if( pucReturn == NULL )
\r
381 if( ulAttempts >= emacBUFFER_WAIT_ATTEMPTS )
\r
386 /* Wait then look again. */
\r
387 vTaskDelay( emacBUFFER_WAIT_DELAY_ms );
\r
393 /*-----------------------------------------------------------*/
\r
395 static void prvReturnBuffer( unsigned char *pucBuffer )
\r
399 /* Return a buffer to the pool of free buffers. */
\r
400 for( ul = 0; ul < emacNUM_BUFFERS; ul++ )
\r
402 if( &( xEthernetBuffers[ ul ][ 0 ] ) == ( void * ) pucBuffer )
\r
404 ucBufferInUse[ ul ] = pdFALSE;
\r
409 /*-----------------------------------------------------------*/
\r
411 static void prvResetEverything( void )
\r
413 /* Temporary code just to see if this gets called. This function has not
\r
414 been implemented. */
\r
415 portDISABLE_INTERRUPTS();
\r
418 /*-----------------------------------------------------------*/
\r
420 static unsigned long prvCheckRxFifoStatus( void )
\r
422 unsigned long ulReturn = 0;
\r
424 if( ( xCurrentRxDesc->status & ACT ) != 0 )
\r
426 /* Current descriptor is still active. */
\r
428 else if( ( xCurrentRxDesc->status & FE ) != 0 )
\r
430 /* Frame error. Clear the error. */
\r
431 xCurrentRxDesc->status &= ~( FP1 | FP0 | FE );
\r
432 xCurrentRxDesc->status &= ~( RMAF | RRF | RTLF | RTSF | PRE | CERF );
\r
433 xCurrentRxDesc->status |= ACT;
\r
434 xCurrentRxDesc = xCurrentRxDesc->next;
\r
436 if( EDMAC.EDRRR.LONG == 0x00000000UL )
\r
438 /* Restart Ethernet if it has stopped. */
\r
439 EDMAC.EDRRR.LONG = 0x00000001UL;
\r
444 /* The descriptor contains a frame. Because of the size of the buffers
\r
445 the frame should always be complete. */
\r
446 if( (xCurrentRxDesc->status & FP0) == FP0 )
\r
448 ulReturn = xCurrentRxDesc->size;
\r
452 /* Do not expect to get here. */
\r
453 prvResetEverything();
\r
459 /*-----------------------------------------------------------*/
\r
461 static void prvSetupPortPinsAndReset( void )
\r
463 /* Initialisation code taken from Renesas example project. */
\r
465 PFC.PACRL4.BIT.PA12MD = 0x7; /* Set TX_CLK input (EtherC) */
\r
466 PFC.PACRL3.BIT.PA11MD = 0x7; /* Set TX_EN output (EtherC) */
\r
467 PFC.PACRL3.BIT.PA10MD = 0x7; /* Set MII_TXD0 output (EtherC) */
\r
468 PFC.PACRL3.BIT.PA9MD = 0x7; /* Set MII_TXD1 output (EtherC) */
\r
469 PFC.PACRL3.BIT.PA8MD = 0x7; /* Set MII_TXD2 output (EtherC) */
\r
470 PFC.PACRL2.BIT.PA7MD = 0x7; /* Set MII_TXD3 output (EtherC) */
\r
471 PFC.PACRL2.BIT.PA6MD = 0x7; /* Set TX_ER output (EtherC) */
\r
472 PFC.PDCRH4.BIT.PD31MD = 0x7; /* Set RX_DV input (EtherC) */
\r
473 PFC.PDCRH4.BIT.PD30MD = 0x7; /* Set RX_ER input (EtherC) */
\r
474 PFC.PDCRH4.BIT.PD29MD = 0x7; /* Set MII_RXD3 input (EtherC) */
\r
475 PFC.PDCRH4.BIT.PD28MD = 0x7; /* Set MII_RXD2 input (EtherC) */
\r
476 PFC.PDCRH3.BIT.PD27MD = 0x7; /* Set MII_RXD1 input (EtherC) */
\r
477 PFC.PDCRH3.BIT.PD26MD = 0x7; /* Set MII_RXD0 input (EtherC) */
\r
478 PFC.PDCRH3.BIT.PD25MD = 0x7; /* Set RX_CLK input (EtherC) */
\r
479 PFC.PDCRH3.BIT.PD24MD = 0x7; /* Set CRS input (EtherC) */
\r
480 PFC.PDCRH2.BIT.PD23MD = 0x7; /* Set COL input (EtherC) */
\r
481 PFC.PDCRH2.BIT.PD22MD = 0x7; /* Set WOL output (EtherC) */
\r
482 PFC.PDCRH2.BIT.PD21MD = 0x7; /* Set EXOUT output (EtherC) */
\r
483 PFC.PDCRH2.BIT.PD20MD = 0x7; /* Set MDC output (EtherC) */
\r
484 PFC.PDCRH1.BIT.PD19MD = 0x7; /* Set LINKSTA input (EtherC) */
\r
485 PFC.PDCRH1.BIT.PD18MD = 0x7; /* Set MDIO input/output (EtherC) */
\r
487 STB.CR4.BIT._ETHER = 0x0;
\r
488 EDMAC.EDMR.BIT.SWR = 1;
\r
490 /* Crude wait for reset to complete. */
\r
491 vTaskDelay( 500 / portTICK_RATE_MS );
\r
493 /*-----------------------------------------------------------*/
\r
495 static void prvConfigureEtherCAndEDMAC( void )
\r
497 /* Initialisation code taken from Renesas example project. */
\r
499 /* TODO: Check bit 5 */
\r
500 EtherC.ECSR.LONG = 0x00000037; /* Clear all EtherC statuS BFR, PSRTO, LCHNG, MPD, ICD */
\r
502 /* TODO: Check bit 5 */
\r
503 EtherC.ECSIPR.LONG = 0x00000020; /* Disable EtherC status change interrupt */
\r
504 EtherC.RFLR.LONG = 1518; /* Ether payload is 1500+ CRC */
\r
505 EtherC.IPGR.LONG = 0x00000014; /* Intergap is 96-bit time */
\r
508 EDMAC.EESR.LONG = 0x47FF0F9F; /* Clear all EtherC and EDMAC status bits */
\r
509 EDMAC.RDLAR = ( void * ) xCurrentRxDesc; /* Initialaize Rx Descriptor List Address */
\r
510 EDMAC.TDLAR = &( xTxDescriptors[ 0 ] ); /* Initialaize Tx Descriptor List Address */
\r
511 EDMAC.TRSCER.LONG = 0x00000000; /* Copy-back status is RFE & TFE only */
\r
512 EDMAC.TFTR.LONG = 0x00000000; /* Threshold of Tx_FIFO */
\r
513 EDMAC.FDR.LONG = 0x00000000; /* Transmit fifo & receive fifo is 256 bytes */
\r
514 EDMAC.RMCR.LONG = 0x00000003; /* Receive function is normal mode(continued) */
\r
516 /* Set the EDMAC interrupt priority - the interrupt priority must be
\r
517 configKERNEL_INTERRUPT_PRIORITY no matter which peripheral is used to
\r
518 generate the tick interrupt. */
\r
519 INTC.IPR19.BIT._EDMAC = portKERNEL_INTERRUPT_PRIORITY;
\r
520 EDMAC.EESIPR.LONG = emacTX_END_INTERRUPT | emacRX_END_INTERRUPT; /* Enable Rx and Tx end interrupts. */
\r
522 /* Clear the interrupt flag. */
\r
523 CMT0.CMCSR.BIT.CMF = 0;
\r
525 /*-----------------------------------------------------------*/
\r
527 void vEMAC_ISR_Handler( void )
\r
529 unsigned long ul = EDMAC.EESR.LONG;
\r
530 long lHigherPriorityTaskWoken = pdFALSE;
\r
531 extern xSemaphoreHandle xEMACSemaphore;
\r
532 static long ulTxEndInts = 0;
\r
534 /* Has a Tx end occurred? */
\r
535 if( ul & emacTX_END_INTERRUPT )
\r
538 if( ulTxEndInts >= 2 )
\r
540 /* Only return the buffer to the pool once both Txes have completed. */
\r
541 prvReturnBuffer( ( void * ) xTxDescriptors[ 0 ].buf_p );
\r
544 EDMAC.EESR.LONG = emacTX_END_INTERRUPT;
\r
547 /* Has an Rx end occurred? */
\r
548 if( ul & emacRX_END_INTERRUPT )
\r
550 /* Make sure the Ethernet task is not blocked waiting for a packet. */
\r
551 xSemaphoreGiveFromISR( xEMACSemaphore, &lHigherPriorityTaskWoken );
\r
552 portYIELD_FROM_ISR( lHigherPriorityTaskWoken );
\r
553 EDMAC.EESR.LONG = emacRX_END_INTERRUPT;
\r