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 "iodefine.h"
\r
98 #include "typedefine.h"
\r
99 #include "hwEthernet.h"
\r
100 #include "hwEthernetPhy.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 3
\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 ( 5 )
\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 section RX_DESCR
\r
142 ethfifo xRxDescriptors[ emacNUM_RX_DESCRIPTORS ];
\r
143 #pragma section TX_DESCR
\r
144 ethfifo xTxDescriptors[ emacNUM_TX_BUFFERS ];
\r
145 #pragma section _ETHERNET_BUFFERS
\r
146 char xEthernetBuffers[ emacNUM_BUFFERS ][ UIP_BUFSIZE ];
\r
149 /* Used to indicate which buffers are free and which are in use. If an index
\r
150 contains 0 then the corresponding buffer in xEthernetBuffers is free, otherwise
\r
151 the buffer is in use or about to be used. */
\r
152 static unsigned char ucBufferInUse[ emacNUM_BUFFERS ];
\r
154 /*-----------------------------------------------------------*/
\r
157 * Initialise both the Rx and Tx descriptors.
\r
159 static void prvInitialiseDescriptors( void );
\r
162 * Return a pointer to a free buffer within xEthernetBuffers.
\r
164 static unsigned char *prvGetNextBuffer( void );
\r
167 * Return a buffer to the list of free buffers.
\r
169 static void prvReturnBuffer( unsigned char *pucBuffer );
\r
172 * Examine the status of the next Rx FIFO to see if it contains new data.
\r
174 static unsigned long prvCheckRxFifoStatus( void );
\r
177 * Setup the microcontroller for communication with the PHY.
\r
179 static void prvSetupPortPinsAndReset( void );
\r
182 * Configure the Ethernet interface peripherals.
\r
184 static void prvConfigureEtherCAndEDMAC( void );
\r
187 * Something has gone wrong with the descriptor usage. Reset all the buffers
\r
190 static void prvResetEverything( void );
\r
192 /*-----------------------------------------------------------*/
\r
194 /* Points to the Rx descriptor currently in use. */
\r
195 static ethfifo *xCurrentRxDesc = NULL;
\r
197 /* The buffer used by the uIP stack to both receive and send. This points to
\r
198 one of the Ethernet buffers when its actually in use. */
\r
199 unsigned char *uip_buf = NULL;
\r
201 /*-----------------------------------------------------------*/
\r
203 void vInitEmac( void )
\r
205 /* Setup the SH hardware for MII communications. */
\r
206 prvSetupPortPinsAndReset();
\r
208 /* Set the Rx and Tx descriptors into their initial state. */
\r
209 prvInitialiseDescriptors();
\r
211 /* Set the MAC address into the ETHERC */
\r
212 EtherC.MAHR = ( ( unsigned long ) configMAC_ADDR0 << 24UL ) |
\r
213 ( ( unsigned long ) configMAC_ADDR1 << 16UL ) |
\r
214 ( ( unsigned long ) configMAC_ADDR2 << 8UL ) |
\r
215 ( unsigned long ) configMAC_ADDR3;
\r
217 EtherC.MALR.BIT.MA = ( ( unsigned long ) configMAC_ADDR4 << 8UL ) |
\r
218 ( unsigned long ) configMAC_ADDR5;
\r
220 /* Perform rest of interface hardware configuration. */
\r
221 prvConfigureEtherCAndEDMAC();
\r
223 /* Nothing received yet, so uip_buf points nowhere. */
\r
226 /* Initialize the PHY */
\r
229 /*-----------------------------------------------------------*/
\r
231 void vEMACWrite( void )
\r
235 /* Wait until the second transmission of the last packet has completed. */
\r
236 for( x = 0; x < emacTX_WAIT_ATTEMPTS; x++ )
\r
238 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
240 /* Descriptor is still active. */
\r
241 vTaskDelay( emacTX_WAIT_DELAY_ms );
\r
249 /* Is the descriptor free after waiting for it? */
\r
250 if( ( xTxDescriptors[ 1 ].status & ACT ) != 0 )
\r
252 /* Something has gone wrong. */
\r
253 prvResetEverything();
\r
256 /* Setup both descriptors to transmit the frame. */
\r
257 xTxDescriptors[ 0 ].buf_p = ( char * ) uip_buf;
\r
258 xTxDescriptors[ 0 ].bufsize = uip_len;
\r
259 xTxDescriptors[ 1 ].buf_p = ( char * ) uip_buf;
\r
260 xTxDescriptors[ 1 ].bufsize = uip_len;
\r
262 /* uip_buf is being sent by the Tx descriptor. Allocate a new buffer
\r
263 for use by the stack. */
\r
264 uip_buf = prvGetNextBuffer();
\r
266 /* Clear previous settings and go. */
\r
267 xTxDescriptors[0].status &= ~( FP1 | FP0 );
\r
268 xTxDescriptors[0].status |= ( FP1 | FP0 | ACT );
\r
269 xTxDescriptors[1].status &= ~( FP1 | FP0 );
\r
270 xTxDescriptors[1].status |= ( FP1 | FP0 | ACT );
\r
272 EDMAC.EDTRR.LONG = 0x00000001;
\r
274 /*-----------------------------------------------------------*/
\r
276 unsigned long ulEMACRead( void )
\r
278 unsigned long ulBytesReceived;
\r
280 ulBytesReceived = prvCheckRxFifoStatus();
\r
282 if( ulBytesReceived > 0 )
\r
284 xCurrentRxDesc->status &= ~( FP1 | FP0 );
\r
285 xCurrentRxDesc->status |= ACT;
\r
287 if( EDMAC.EDRRR.LONG == 0x00000000L )
\r
289 /* Restart Ethernet if it has stopped */
\r
290 EDMAC.EDRRR.LONG = 0x00000001L;
\r
293 /* Mark the pxDescriptor buffer as free as uip_buf is going to be set to
\r
294 the buffer that contains the received data. */
\r
295 prvReturnBuffer( uip_buf );
\r
297 uip_buf = ( void * ) xCurrentRxDesc->buf_p;
\r
299 /* Move onto the next buffer in the ring. */
\r
300 xCurrentRxDesc = xCurrentRxDesc->next;
\r
303 return ulBytesReceived;
\r
305 /*-----------------------------------------------------------*/
\r
307 long lEMACWaitForLink( void )
\r
311 /* Set the link status. */
\r
312 switch( phyStatus() )
\r
314 /* Half duplex link */
\r
315 case PHY_LINK_100H:
\r
317 EtherC.ECMR.BIT.DM = 0;
\r
321 /* Full duplex link */
\r
322 case PHY_LINK_100F:
\r
324 EtherC.ECMR.BIT.DM = 1;
\r
333 if( lReturn == pdPASS )
\r
335 /* Enable receive and transmit. */
\r
336 EtherC.ECMR.BIT.RE = 1;
\r
337 EtherC.ECMR.BIT.TE = 1;
\r
339 /* Enable EDMAC receive */
\r
340 EDMAC.EDRRR.LONG = 0x1;
\r
345 /*-----------------------------------------------------------*/
\r
347 static void prvInitialiseDescriptors( void )
\r
349 ethfifo *pxDescriptor;
\r
352 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
354 /* Ensure none of the buffers are shown as in use at the start. */
\r
355 ucBufferInUse[ x ] = pdFALSE;
\r
358 /* Initialise the Rx descriptors. */
\r
359 for( x = 0; x < emacNUM_RX_DESCRIPTORS; x++ )
\r
361 pxDescriptor = &( xRxDescriptors[ x ] );
\r
362 pxDescriptor->buf_p = &( xEthernetBuffers[ x ][ 0 ] );
\r
364 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
365 pxDescriptor->size = 0;
\r
366 pxDescriptor->status = ACT;
\r
367 pxDescriptor->next = &xRxDescriptors[ x + 1 ];
\r
369 /* Mark this buffer as in use. */
\r
370 ucBufferInUse[ x ] = pdTRUE;
\r
373 /* The last descriptor points back to the start. */
\r
374 pxDescriptor->status |= DL;
\r
375 pxDescriptor->next = &xRxDescriptors[ 0 ];
\r
377 /* Initialise the Tx descriptors. */
\r
378 for( x = 0; x < emacNUM_TX_BUFFERS; x++ )
\r
380 pxDescriptor = &( xTxDescriptors[ x ] );
\r
382 /* A buffer is not allocated to the Tx descriptor until a send is
\r
383 actually required. */
\r
384 pxDescriptor->buf_p = NULL;
\r
386 pxDescriptor->bufsize = UIP_BUFSIZE;
\r
387 pxDescriptor->size = 0;
\r
388 pxDescriptor->status = 0;
\r
389 pxDescriptor->next = &xTxDescriptors[ x + 1 ];
\r
392 /* The last descriptor points back to the start. */
\r
393 pxDescriptor->status |= DL;
\r
394 pxDescriptor->next = &( xTxDescriptors[ 0 ] );
\r
396 /* Use the first Rx descriptor to start with. */
\r
397 xCurrentRxDesc = &( xRxDescriptors[ 0 ] );
\r
399 /*-----------------------------------------------------------*/
\r
401 static unsigned char *prvGetNextBuffer( void )
\r
404 unsigned char *pucReturn = NULL;
\r
405 unsigned long ulAttempts = 0;
\r
407 while( pucReturn == NULL )
\r
409 /* Look through the buffers to find one that is not in use by
\r
411 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
413 if( ucBufferInUse[ x ] == pdFALSE )
\r
415 ucBufferInUse[ x ] = pdTRUE;
\r
416 pucReturn = ( unsigned char * ) &( xEthernetBuffers[ x ][ 0 ] );
\r
421 /* Was a buffer found? */
\r
422 if( pucReturn == NULL )
\r
426 if( ulAttempts >= emacBUFFER_WAIT_ATTEMPTS )
\r
431 /* Wait then look again. */
\r
432 vTaskDelay( emacBUFFER_WAIT_DELAY_ms );
\r
438 /*-----------------------------------------------------------*/
\r
440 static void prvReturnBuffer( unsigned char *pucBuffer )
\r
444 /* Return a buffer to the pool of free buffers. */
\r
445 for( ul = 0; ul < emacNUM_BUFFERS; ul++ )
\r
447 if( &( xEthernetBuffers[ ul ][ 0 ] ) == ( void * ) pucBuffer )
\r
449 ucBufferInUse[ ul ] = pdFALSE;
\r
454 /*-----------------------------------------------------------*/
\r
456 static void prvResetEverything( void )
\r
458 /* Temporary code just to see if this gets called. This function has not
\r
459 been implemented. */
\r
460 portDISABLE_INTERRUPTS();
\r
463 /*-----------------------------------------------------------*/
\r
465 static unsigned long prvCheckRxFifoStatus( void )
\r
467 unsigned long ulReturn = 0;
\r
469 if( ( xCurrentRxDesc->status & ACT ) != 0 )
\r
471 /* Current descriptor is still active. */
\r
473 else if( ( xCurrentRxDesc->status & FE ) != 0 )
\r
475 /* Frame error. Clear the error. */
\r
476 xCurrentRxDesc->status &= ~( FP1 | FP0 | FE );
\r
477 xCurrentRxDesc->status &= ~( RMAF | RRF | RTLF | RTSF | PRE | CERF );
\r
478 xCurrentRxDesc->status |= ACT;
\r
479 xCurrentRxDesc = xCurrentRxDesc->next;
\r
481 if( EDMAC.EDRRR.LONG == 0x00000000UL )
\r
483 /* Restart Ethernet if it has stopped. */
\r
484 EDMAC.EDRRR.LONG = 0x00000001UL;
\r
489 /* The descriptor contains a frame. Because of the size of the buffers
\r
490 the frame should always be complete. */
\r
491 if( (xCurrentRxDesc->status & FP0) == FP0 )
\r
493 ulReturn = xCurrentRxDesc->size;
\r
497 /* Do not expect to get here. */
\r
498 prvResetEverything();
\r
504 /*-----------------------------------------------------------*/
\r
506 static void prvSetupPortPinsAndReset( void )
\r
508 /* Initialisation code taken from Renesas example project. */
\r
510 PFC.PACRL4.BIT.PA12MD = 0x7; /* Set TX_CLK input (EtherC) */
\r
511 PFC.PACRL3.BIT.PA11MD = 0x7; /* Set TX_EN output (EtherC) */
\r
512 PFC.PACRL3.BIT.PA10MD = 0x7; /* Set MII_TXD0 output (EtherC) */
\r
513 PFC.PACRL3.BIT.PA9MD = 0x7; /* Set MII_TXD1 output (EtherC) */
\r
514 PFC.PACRL3.BIT.PA8MD = 0x7; /* Set MII_TXD2 output (EtherC) */
\r
515 PFC.PACRL2.BIT.PA7MD = 0x7; /* Set MII_TXD3 output (EtherC) */
\r
516 PFC.PACRL2.BIT.PA6MD = 0x7; /* Set TX_ER output (EtherC) */
\r
517 PFC.PDCRH4.BIT.PD31MD = 0x7; /* Set RX_DV input (EtherC) */
\r
518 PFC.PDCRH4.BIT.PD30MD = 0x7; /* Set RX_ER input (EtherC) */
\r
519 PFC.PDCRH4.BIT.PD29MD = 0x7; /* Set MII_RXD3 input (EtherC) */
\r
520 PFC.PDCRH4.BIT.PD28MD = 0x7; /* Set MII_RXD2 input (EtherC) */
\r
521 PFC.PDCRH3.BIT.PD27MD = 0x7; /* Set MII_RXD1 input (EtherC) */
\r
522 PFC.PDCRH3.BIT.PD26MD = 0x7; /* Set MII_RXD0 input (EtherC) */
\r
523 PFC.PDCRH3.BIT.PD25MD = 0x7; /* Set RX_CLK input (EtherC) */
\r
524 PFC.PDCRH3.BIT.PD24MD = 0x7; /* Set CRS input (EtherC) */
\r
525 PFC.PDCRH2.BIT.PD23MD = 0x7; /* Set COL input (EtherC) */
\r
526 PFC.PDCRH2.BIT.PD22MD = 0x7; /* Set WOL output (EtherC) */
\r
527 PFC.PDCRH2.BIT.PD21MD = 0x7; /* Set EXOUT output (EtherC) */
\r
528 PFC.PDCRH2.BIT.PD20MD = 0x7; /* Set MDC output (EtherC) */
\r
529 PFC.PDCRH1.BIT.PD19MD = 0x7; /* Set LINKSTA input (EtherC) */
\r
530 PFC.PDCRH1.BIT.PD18MD = 0x7; /* Set MDIO input/output (EtherC) */
\r
532 STB.CR4.BIT._ETHER = 0x0;
\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 /* TODO: Check bit 5 */
\r
548 EtherC.ECSIPR.LONG = 0x00000020; /* Disable EtherC status change interrupt */
\r
549 EtherC.RFLR.LONG = 1518; /* Ether payload is 1500+ CRC */
\r
550 EtherC.IPGR.LONG = 0x00000014; /* Intergap is 96-bit time */
\r
553 EDMAC.EESR.LONG = 0x47FF0F9F; /* Clear all EtherC and EDMAC status bits */
\r
554 EDMAC.RDLAR = ( void * ) xCurrentRxDesc; /* Initialaize Rx Descriptor List Address */
\r
555 EDMAC.TDLAR = &( xTxDescriptors[ 0 ] ); /* Initialaize Tx Descriptor List Address */
\r
556 EDMAC.TRSCER.LONG = 0x00000000; /* Copy-back status is RFE & TFE only */
\r
557 EDMAC.TFTR.LONG = 0x00000000; /* Threshold of Tx_FIFO */
\r
558 EDMAC.FDR.LONG = 0x00000000; /* Transmit fifo & receive fifo is 256 bytes */
\r
559 EDMAC.RMCR.LONG = 0x00000003; /* Receive function is normal mode(continued) */
\r
561 /* Set the EDMAC interrupt priority - the interrupt priority must be
\r
562 configKERNEL_INTERRUPT_PRIORITY no matter which peripheral is used to
\r
563 generate the tick interrupt. */
\r
564 INTC.IPR19.BIT._EDMAC = portKERNEL_INTERRUPT_PRIORITY;
\r
565 EDMAC.EESIPR.LONG = emacTX_END_INTERRUPT | emacRX_END_INTERRUPT; /* Enable Rx and Tx end interrupts. */
\r
567 /* Clear the interrupt flag. */
\r
568 CMT0.CMCSR.BIT.CMF = 0;
\r
570 /*-----------------------------------------------------------*/
\r
572 void vEMAC_ISR_Handler( void )
\r
574 unsigned long ul = EDMAC.EESR.LONG;
\r
575 long lHigherPriorityTaskWoken = pdFALSE;
\r
576 extern SemaphoreHandle_t xEMACSemaphore;
\r
577 static long ulTxEndInts = 0;
\r
579 /* Has a Tx end occurred? */
\r
580 if( ul & emacTX_END_INTERRUPT )
\r
583 if( ulTxEndInts >= 2 )
\r
585 /* Only return the buffer to the pool once both Txes have completed. */
\r
586 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 xSemaphoreGiveFromISR( xEMACSemaphore, &lHigherPriorityTaskWoken );
\r
597 portYIELD_FROM_ISR( lHigherPriorityTaskWoken );
\r
598 EDMAC.EESR.LONG = emacRX_END_INTERRUPT;
\r