2 FreeRTOS V7.5.2 - Copyright (C) 2013 Real Time Engineers Ltd.
\r
4 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
6 ***************************************************************************
\r
8 * FreeRTOS provides completely free yet professionally developed, *
\r
9 * robust, strictly quality controlled, supported, and cross *
\r
10 * platform software that has become a de facto standard. *
\r
12 * Help yourself get started quickly and support the FreeRTOS *
\r
13 * project by purchasing a FreeRTOS tutorial book, reference *
\r
14 * manual, or both from: http://www.FreeRTOS.org/Documentation *
\r
18 ***************************************************************************
\r
20 This file is part of the FreeRTOS distribution.
\r
22 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
23 the terms of the GNU General Public License (version 2) as published by the
\r
24 Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.
\r
26 >>! NOTE: The modification to the GPL is included to allow you to distribute
\r
27 >>! a combined work that includes FreeRTOS without being obliged to provide
\r
28 >>! the source code for proprietary components outside of the FreeRTOS
\r
31 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
32 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
33 FOR A PARTICULAR PURPOSE. Full license text is available from the following
\r
34 link: http://www.freertos.org/a00114.html
\r
38 ***************************************************************************
\r
40 * Having a problem? Start by reading the FAQ "My application does *
\r
41 * not run, what could be wrong?" *
\r
43 * http://www.FreeRTOS.org/FAQHelp.html *
\r
45 ***************************************************************************
\r
47 http://www.FreeRTOS.org - Documentation, books, training, latest versions,
\r
48 license and Real Time Engineers Ltd. contact details.
\r
50 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
51 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
52 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
54 http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High
\r
55 Integrity Systems to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
56 licenses offer ticketed support, indemnification and middleware.
\r
58 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
59 engineered and independently SIL3 certified version for use in safety and
\r
60 mission critical applications that require provable dependability.
\r
65 /* Freescale includes. */
\r
67 #include "eth_phy.h"
\r
71 /* FreeRTOS includes. */
\r
72 #include "FreeRTOS.h"
\r
77 #include "net/uip.h"
\r
79 /* The time to wait between attempts to obtain a free buffer. */
\r
80 #define emacBUFFER_WAIT_DELAY_ms ( 3 / portTICK_RATE_MS )
\r
82 /* The number of times emacBUFFER_WAIT_DELAY_ms should be waited before giving
\r
83 up on attempting to obtain a free buffer all together. */
\r
84 #define emacBUFFER_WAIT_ATTEMPTS ( 30 )
\r
86 /* The number of Rx descriptors. */
\r
87 #define emacNUM_RX_DESCRIPTORS 8
\r
89 /* The number of Tx descriptors. When using uIP there is not point in having
\r
91 #define emacNUM_TX_BUFFERS 2
\r
93 /* The total number of EMAC buffers to allocate. */
\r
94 #define emacNUM_BUFFERS ( emacNUM_RX_DESCRIPTORS + emacNUM_TX_BUFFERS )
\r
96 /* The time to wait for the Tx descriptor to become free. */
\r
97 #define emacTX_WAIT_DELAY_ms ( 10 / portTICK_RATE_MS )
\r
99 /* The total number of times to wait emacTX_WAIT_DELAY_ms for the Tx descriptor to
\r
101 #define emacTX_WAIT_ATTEMPTS ( 50 )
\r
103 /* Constants used for set up and initialisation. */
\r
104 #define emacTX_INTERRUPT_NO ( 76 )
\r
105 #define emacRX_INTERRUPT_NO ( 77 )
\r
106 #define emacERROR_INTERRUPT_NO ( 78 )
\r
107 #define emacLINK_DELAY ( 500 / portTICK_RATE_MS )
\r
108 #define emacPHY_STATUS ( 0x1F )
\r
109 #define emacPHY_DUPLEX_STATUS ( 4 << 2 )
\r
110 #define emacPHY_SPEED_STATUS ( 1 << 2 )
\r
112 /*-----------------------------------------------------------*/
\r
115 * Initialise both the Rx and Tx descriptors.
\r
117 static void prvInitialiseDescriptors( void );
\r
120 * Return a pointer to a free buffer within xEthernetBuffers.
\r
122 static unsigned char *prvGetNextBuffer( void );
\r
125 * Return a buffer to the list of free buffers.
\r
127 static void prvReturnBuffer( unsigned char *pucBuffer );
\r
130 * Examine the status of the next Rx descriptor to see if it contains new data.
\r
132 static unsigned short prvCheckRxStatus( void );
\r
135 * Something has gone wrong with the descriptor usage. Reset all the buffers
\r
138 static void prvResetEverything( void );
\r
140 /*-----------------------------------------------------------*/
\r
142 /* The buffers and descriptors themselves. */
\r
143 #pragma data_alignment=16
\r
144 volatile NBUF xRxDescriptors[ emacNUM_RX_DESCRIPTORS ];
\r
146 #pragma data_alignment=16
\r
147 volatile NBUF xTxDescriptors[ emacNUM_TX_BUFFERS ];
\r
149 #pragma data_alignment=16
\r
150 char xEthernetBuffers[ emacNUM_BUFFERS ][ UIP_BUFSIZE ];
\r
152 /* Used to indicate which buffers are free and which are in use. If an index
\r
153 contains 0 then the corresponding buffer in xEthernetBuffers is free, otherwise
\r
154 the buffer is in use or about to be used. */
\r
155 static unsigned char ucBufferInUse[ emacNUM_BUFFERS ];
\r
157 /* Points to the Rx descriptor currently in use. */
\r
158 static volatile NBUF *pxCurrentRxDesc = NULL;
\r
160 /* pxCurrentRxDesc points to descriptor within the xRxDescriptors array that
\r
161 has an index defined by ulRxDescriptorIndex. */
\r
162 static unsigned long ulRxDescriptorIndex = 0UL;
\r
164 /* The buffer used by the uIP stack to both receive and send. This points to
\r
165 one of the Ethernet buffers when its actually in use. */
\r
166 unsigned char *uip_buf = NULL;
\r
168 /*-----------------------------------------------------------*/
\r
170 void vEMACInit( void )
\r
173 extern int periph_clk_khz;
\r
174 const unsigned portCHAR ucMACAddress[] =
\r
176 configMAC_ADDR0, configMAC_ADDR1, configMAC_ADDR2, configMAC_ADDR3, configMAC_ADDR4, configMAC_ADDR5
\r
179 /* Enable the ENET clock. */
\r
180 SIM_SCGC2 |= SIM_SCGC2_ENET_MASK;
\r
182 /* Allow concurrent access to MPU controller to avoid bus errors. */
\r
185 prvInitialiseDescriptors();
\r
187 /* Reset and enable. */
\r
188 ENET_ECR = ENET_ECR_RESET_MASK;
\r
190 /* Wait at least 8 clock cycles */
\r
193 /* Start the MII interface*/
\r
194 mii_init( 0, periph_clk_khz / 1000L );
\r
196 /* Configure the transmit interrupt. */
\r
197 set_irq_priority( emacTX_INTERRUPT_NO, configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY );
\r
198 enable_irq( emacTX_INTERRUPT_NO );
\r
200 /* Configure the receive interrupt. */
\r
201 set_irq_priority( emacRX_INTERRUPT_NO, configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY );
\r
202 enable_irq( emacRX_INTERRUPT_NO );
\r
204 /* Configure the error interrupt. */
\r
205 set_irq_priority( emacERROR_INTERRUPT_NO, configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY );
\r
206 enable_irq( emacERROR_INTERRUPT_NO );
\r
208 /* Configure the pins to the PHY - RMII mode used. */
\r
209 PORTB_PCR0 = PORT_PCR_MUX( 4 ); /* RMII0_MDIO / MII0_MDIO. */
\r
210 PORTB_PCR1 = PORT_PCR_MUX( 4 ); /* RMII0_MDC / MII0_MDC */
\r
211 PORTA_PCR14 = PORT_PCR_MUX( 4 ); /* RMII0_CRS_DV / MII0_RXDV */
\r
212 PORTA_PCR12 = PORT_PCR_MUX( 4 ); /* RMII0_RXD1 / MII0_RXD1 */
\r
213 PORTA_PCR13 = PORT_PCR_MUX( 4 ); /* RMII0_RXD0/MII0_RXD0 */
\r
214 PORTA_PCR15 = PORT_PCR_MUX( 4 ); /* RMII0_TXEN/MII0_TXEN */
\r
215 PORTA_PCR16 = PORT_PCR_MUX( 4 ); /* RMII0_TXD0/MII0_TXD0 */
\r
216 PORTA_PCR17 = PORT_PCR_MUX( 4 ); /* RMII0_TXD1/MII0_TXD1 */
\r
218 /* Is there communication with the PHY? */
\r
221 vTaskDelay( emacLINK_DELAY );
\r
223 mii_read( 0, configPHY_ADDRESS, PHY_PHYIDR1, &iData );
\r
225 } while( iData == 0xFFFF );
\r
227 /* Start to auto negotiate. */
\r
228 mii_write( 0, configPHY_ADDRESS, PHY_BMCR, ( PHY_BMCR_AN_RESTART | PHY_BMCR_AN_ENABLE ) );
\r
230 /* Wait for auto negotiate to complete. */
\r
233 vTaskDelay( emacLINK_DELAY );
\r
234 mii_read( 0, configPHY_ADDRESS, PHY_BMSR, &iData );
\r
236 } while( !( iData & PHY_BMSR_AN_COMPLETE ) );
\r
238 /* A link has been established. What was negotiated? */
\r
240 mii_read( 0, configPHY_ADDRESS, emacPHY_STATUS, &iData );
\r
242 /* Clear the Individual and Group Address Hash registers */
\r
248 /* Set the Physical Address for the selected ENET */
\r
249 enet_set_address( 0, ucMACAddress );
\r
251 ENET_RCR = ENET_RCR_MAX_FL( UIP_BUFSIZE ) | ENET_RCR_MII_MODE_MASK | ENET_RCR_CRCFWD_MASK | ENET_RCR_RMII_MODE_MASK;
\r
253 /* Clear the control registers. */
\r
256 if( iData & emacPHY_DUPLEX_STATUS )
\r
259 ENET_RCR &= ( unsigned long )~ENET_RCR_DRT_MASK;
\r
260 ENET_TCR |= ENET_TCR_FDEN_MASK;
\r
265 ENET_RCR |= ENET_RCR_DRT_MASK;
\r
266 ENET_TCR &= (unsigned portLONG)~ENET_TCR_FDEN_MASK;
\r
269 if( iData & emacPHY_SPEED_STATUS )
\r
272 ENET_RCR |= ENET_RCR_RMII_10T_MASK;
\r
275 ENET_ECR = ENET_ECR_EN1588_MASK;
\r
277 /* Store and forward checksum. */
\r
278 ENET_TFWR = ENET_TFWR_STRFWD_MASK;
\r
280 /* Set Rx Buffer Size */
\r
281 ENET_MRBR = ( unsigned short ) UIP_BUFSIZE;
\r
283 /* Point to the start of the circular Rx buffer descriptor queue */
\r
284 ENET_RDSR = ( unsigned long ) &( xRxDescriptors[ 0 ] );
\r
286 /* Point to the start of the circular Tx buffer descriptor queue */
\r
287 ENET_TDSR = ( unsigned long ) &( xTxDescriptors[ 0 ] );
\r
289 /* Clear all ENET interrupt events */
\r
290 ENET_EIR = ( unsigned long ) -1;
\r
292 /* Enable interrupts. */
\r
295 | ENET_EIMR_RXF_MASK/* only for complete frame, not partial buffer descriptor | ENET_EIMR_RXB_MASK*/
\r
297 | ENET_EIMR_TXF_MASK/* only for complete frame, not partial buffer descriptor | ENET_EIMR_TXB_MASK*/
\r
299 | ENET_EIMR_UN_MASK | ENET_EIMR_RL_MASK | ENET_EIMR_LC_MASK | ENET_EIMR_BABT_MASK | ENET_EIMR_BABR_MASK | ENET_EIMR_EBERR_MASK
\r
302 /* Enable the MAC itself. */
\r
303 ENET_ECR |= ENET_ECR_ETHEREN_MASK;
\r
305 /* Indicate that there have been empty receive buffers produced */
\r
306 ENET_RDAR = ENET_RDAR_RDAR_MASK;
\r
308 /*-----------------------------------------------------------*/
\r
310 static void prvInitialiseDescriptors( void )
\r
312 volatile NBUF *pxDescriptor;
\r
315 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
317 /* Ensure none of the buffers are shown as in use at the start. */
\r
318 ucBufferInUse[ x ] = pdFALSE;
\r
321 /* Initialise the Rx descriptors. */
\r
322 for( x = 0; x < emacNUM_RX_DESCRIPTORS; x++ )
\r
324 pxDescriptor = &( xRxDescriptors[ x ] );
\r
325 pxDescriptor->data = ( uint8_t* ) &( xEthernetBuffers[ x ][ 0 ] );
\r
326 pxDescriptor->data = ( uint8_t* ) __REV( ( unsigned long ) pxDescriptor->data );
\r
327 pxDescriptor->length = 0;
\r
328 pxDescriptor->status = RX_BD_E;
\r
329 pxDescriptor->bdu = 0;
\r
330 pxDescriptor->ebd_status = RX_BD_INT;
\r
332 /* Mark this buffer as in use. */
\r
333 ucBufferInUse[ x ] = pdTRUE;
\r
336 /* The last descriptor points back to the start. */
\r
337 pxDescriptor->status |= RX_BD_W;
\r
339 /* Initialise the Tx descriptors. */
\r
340 for( x = 0; x < emacNUM_TX_BUFFERS; x++ )
\r
342 pxDescriptor = &( xTxDescriptors[ x ] );
\r
344 /* A buffer is not allocated to the Tx descriptor until a send is
\r
345 actually required. */
\r
346 pxDescriptor->data = NULL;
\r
347 pxDescriptor->length = 0;
\r
348 pxDescriptor->status = TX_BD_TC;
\r
349 pxDescriptor->ebd_status = TX_BD_INT;
\r
352 /* The last descriptor points back to the start. */
\r
353 pxDescriptor->status |= TX_BD_W;
\r
355 /* Use the first Rx descriptor to start with. */
\r
356 ulRxDescriptorIndex = 0UL;
\r
357 pxCurrentRxDesc = &( xRxDescriptors[ 0 ] );
\r
359 /*-----------------------------------------------------------*/
\r
361 void vEMACWrite( void )
\r
365 /* Wait until the second transmission of the last packet has completed. */
\r
366 for( x = 0; x < emacTX_WAIT_ATTEMPTS; x++ )
\r
368 if( ( xTxDescriptors[ 1 ].status & TX_BD_R ) != 0 )
\r
370 /* Descriptor is still active. */
\r
371 vTaskDelay( emacTX_WAIT_DELAY_ms );
\r
379 /* Is the descriptor free after waiting for it? */
\r
380 if( ( xTxDescriptors[ 1 ].status & TX_BD_R ) != 0 )
\r
382 /* Something has gone wrong. */
\r
383 prvResetEverything();
\r
386 /* Setup both descriptors to transmit the frame. */
\r
387 xTxDescriptors[ 0 ].data = ( uint8_t * ) __REV( ( unsigned long ) uip_buf );
\r
388 xTxDescriptors[ 0 ].length = __REVSH( uip_len );
\r
389 xTxDescriptors[ 1 ].data = ( uint8_t * ) __REV( ( unsigned long ) uip_buf );
\r
390 xTxDescriptors[ 1 ].length = __REVSH( uip_len );
\r
392 /* uip_buf is being sent by the Tx descriptor. Allocate a new buffer
\r
393 for use by the stack. */
\r
394 uip_buf = prvGetNextBuffer();
\r
396 /* Clear previous settings and go. */
\r
397 xTxDescriptors[ 0 ].status |= ( TX_BD_R | TX_BD_L );
\r
398 xTxDescriptors[ 1 ].status |= ( TX_BD_R | TX_BD_L );
\r
400 /* Start the Tx. */
\r
401 ENET_TDAR = ENET_TDAR_TDAR_MASK;
\r
403 /*-----------------------------------------------------------*/
\r
405 static unsigned char *prvGetNextBuffer( void )
\r
408 unsigned char *pucReturn = NULL;
\r
409 unsigned long ulAttempts = 0;
\r
411 while( pucReturn == NULL )
\r
413 /* Look through the buffers to find one that is not in use by
\r
415 for( x = 0; x < emacNUM_BUFFERS; x++ )
\r
417 if( ucBufferInUse[ x ] == pdFALSE )
\r
419 ucBufferInUse[ x ] = pdTRUE;
\r
420 pucReturn = ( unsigned char * ) &( xEthernetBuffers[ x ][ 0 ] );
\r
425 /* Was a buffer found? */
\r
426 if( pucReturn == NULL )
\r
430 if( ulAttempts >= emacBUFFER_WAIT_ATTEMPTS )
\r
435 /* Wait then look again. */
\r
436 vTaskDelay( emacBUFFER_WAIT_DELAY_ms );
\r
442 /*-----------------------------------------------------------*/
\r
444 static void prvResetEverything( void )
\r
446 /* Temporary code just to see if this gets called. This function has not
\r
447 been implemented. */
\r
448 portDISABLE_INTERRUPTS();
\r
451 /*-----------------------------------------------------------*/
\r
453 unsigned short usEMACRead( void )
\r
455 unsigned short usBytesReceived;
\r
457 usBytesReceived = prvCheckRxStatus();
\r
458 usBytesReceived = __REVSH( usBytesReceived );
\r
460 if( usBytesReceived > 0 )
\r
462 /* Mark the pxDescriptor buffer as free as uip_buf is going to be set to
\r
463 the buffer that contains the received data. */
\r
464 prvReturnBuffer( uip_buf );
\r
466 /* Point uip_buf to the data about to be processed. */
\r
467 uip_buf = ( void * ) pxCurrentRxDesc->data;
\r
468 uip_buf = ( void * ) __REV( ( unsigned long ) uip_buf );
\r
470 /* Allocate a new buffer to the descriptor, as uip_buf is now using it's
\r
472 pxCurrentRxDesc->data = ( uint8_t * ) prvGetNextBuffer();
\r
473 pxCurrentRxDesc->data = ( uint8_t* ) __REV( ( unsigned long ) pxCurrentRxDesc->data );
\r
475 /* Prepare the descriptor to go again. */
\r
476 pxCurrentRxDesc->status |= RX_BD_E;
\r
478 /* Move onto the next buffer in the ring. */
\r
479 ulRxDescriptorIndex++;
\r
480 if( ulRxDescriptorIndex >= emacNUM_RX_DESCRIPTORS )
\r
482 ulRxDescriptorIndex = 0UL;
\r
484 pxCurrentRxDesc = &( xRxDescriptors[ ulRxDescriptorIndex ] );
\r
486 /* Restart Ethernet if it has stopped */
\r
487 ENET_RDAR = ENET_RDAR_RDAR_MASK;
\r
490 return usBytesReceived;
\r
492 /*-----------------------------------------------------------*/
\r
494 static void prvReturnBuffer( unsigned char *pucBuffer )
\r
498 /* Return a buffer to the pool of free buffers. */
\r
499 for( ul = 0; ul < emacNUM_BUFFERS; ul++ )
\r
501 if( &( xEthernetBuffers[ ul ][ 0 ] ) == ( void * ) pucBuffer )
\r
503 ucBufferInUse[ ul ] = pdFALSE;
\r
508 /*-----------------------------------------------------------*/
\r
510 static unsigned short prvCheckRxStatus( void )
\r
512 unsigned long usReturn = 0;
\r
514 if( ( pxCurrentRxDesc->status & RX_BD_E ) != 0 )
\r
516 /* Current descriptor is still active. */
\r
520 /* The descriptor contains a frame. Because of the size of the buffers
\r
521 the frame should always be complete. */
\r
522 usReturn = pxCurrentRxDesc->length;
\r
527 /*-----------------------------------------------------------*/
\r
529 void vEMAC_TxISRHandler( void )
\r
531 /* Clear the interrupt. */
\r
532 ENET_EIR = ENET_EIR_TXF_MASK;
\r
534 /* Check the buffers have not already been freed in the first of the
\r
535 two Tx interrupts - which could potentially happen if the second Tx completed
\r
536 during the interrupt for the first Tx. */
\r
537 if( xTxDescriptors[ 0 ].data != NULL )
\r
539 if( ( ( xTxDescriptors[ 0 ].status & TX_BD_R ) == 0 ) && ( ( xTxDescriptors[ 0 ].status & TX_BD_R ) == 0 ) )
\r
541 configASSERT( xTxDescriptors[ 0 ].data == xTxDescriptors[ 1 ].data );
\r
543 xTxDescriptors[ 0 ].data = ( uint8_t* ) __REV( ( unsigned long ) xTxDescriptors[ 0 ].data );
\r
544 prvReturnBuffer( xTxDescriptors[ 0 ].data );
\r
546 /* Just to mark the fact that the buffer has already been released. */
\r
547 xTxDescriptors[ 0 ].data = NULL;
\r
551 /*-----------------------------------------------------------*/
\r
553 void vEMAC_RxISRHandler( void )
\r
555 const unsigned long ulRxEvent = uipETHERNET_RX_EVENT;
\r
556 long lHigherPriorityTaskWoken = pdFALSE;
\r
557 extern xQueueHandle xEMACEventQueue;
\r
559 /* Clear the interrupt. */
\r
560 ENET_EIR = ENET_EIR_RXF_MASK;
\r
562 /* An Ethernet Rx event has occurred. */
\r
563 xQueueSendFromISR( xEMACEventQueue, &ulRxEvent, &lHigherPriorityTaskWoken );
\r
564 portEND_SWITCHING_ISR( lHigherPriorityTaskWoken );
\r
566 /*-----------------------------------------------------------*/
\r
568 void vEMAC_ErrorISRHandler( void )
\r
570 /* Clear the interrupt. */
\r
571 ENET_EIR = ENET_EIR & ENET_EIMR;
\r
573 /* Attempt recovery. Not very sophisticated. */
\r
574 prvInitialiseDescriptors();
\r
575 ENET_RDAR = ENET_RDAR_RDAR_MASK;
\r
577 /*-----------------------------------------------------------*/
\r