git.sur5r.net Git - freertos/blob

   1 /*\r
   2  * FreeRTOS+UDP V1.0.0 (C) 2013 Real Time Engineers ltd.\r
   3  *\r
   4  * This file is part of the FreeRTOS+UDP distribution.  The FreeRTOS+UDP license\r
   5  * terms are different to the FreeRTOS license terms.\r
   6  *\r
   7  * FreeRTOS+UDP uses a dual license model that allows the software to be used\r
   8  * under a pure GPL open source license (as opposed to the modified GPL license\r
   9  * under which FreeRTOS is distributed) or a commercial license.  Details of\r
  10  * both license options follow:\r
  11  *\r
  12  * - Open source licensing -\r
  13  * FreeRTOS+UDP is a free download and may be used, modified, evaluated and\r
  14  * distributed without charge provided the user adheres to version two of the\r
  15  * GNU General Public License (GPL) and does not remove the copyright notice or\r
  16  * this text.  The GPL V2 text is available on the gnu.org web site, and on the\r
  17  * following URL: http://www.FreeRTOS.org/gpl-2.0.txt.\r
  18  *\r
  19  * - Commercial licensing -\r
  20  * Businesses and individuals that for commercial or other reasons cannot comply\r
  21  * with the terms of the GPL V2 license must obtain a commercial license before \r
  22  * incorporating FreeRTOS+UDP into proprietary software for distribution in any \r
  23  * form.  Commercial licenses can be purchased from http://shop.freertos.org/udp \r
  24  * and do not require any source files to be changed.\r
  25  *\r
  26  * FreeRTOS+UDP is distributed in the hope that it will be useful.  You cannot\r
  27  * use FreeRTOS+UDP unless you agree that you use the software 'as is'.\r
  28  * FreeRTOS+UDP is provided WITHOUT ANY WARRANTY; without even the implied\r
  29  * warranties of NON-INFRINGEMENT, MERCHANTABILITY or FITNESS FOR A PARTICULAR\r
  30  * PURPOSE. Real Time Engineers Ltd. disclaims all conditions and terms, be they\r
  31  * implied, expressed, or statutory.\r
  32  *\r
  33  * 1 tab == 4 spaces!\r
  34  *\r
  35  * http://www.FreeRTOS.org\r
  36  * http://www.FreeRTOS.org/udp\r
  37  *\r
  38  */\r
  39 \r
  40 /* Standard includes. */\r
  41 #include <stdint.h>\r
  42 \r
  43 /* FreeRTOS includes. */\r
  44 #include "FreeRTOS.h"\r
  45 #include "task.h"\r
  46 #include "queue.h"\r
  47 #include "semphr.h"\r
  48 \r
  49 /* FreeRTOS+UDP includes. */\r
  50 #include "FreeRTOS_UDP_IP.h"\r
  51 #include "FreeRTOS_IP_Private.h"\r
  52 #include "FreeRTOS_Sockets.h"\r
  53 #include "NetworkBufferManagement.h"\r
  54 \r
  55 /* Driver includes. */\r
  56 #include "lpc18xx_emac.h"\r
  57 \r
  58 /* Demo includes. */\r
  59 #include "NetworkInterface.h"\r
  60 \r
  61 #if configMAC_INTERRUPT_PRIORITY > configMAC_INTERRUPT_PRIORITY\r
  62         #error configMAC_INTERRUPT_PRIORITY must be greater than or equal to configMAC_INTERRUPT_PRIORITY (higher numbers mean lower logical priority)\r
  63 #endif\r
  64 \r
  65 #ifndef configNUM_RX_ETHERNET_DMA_DESCRIPTORS\r
  66         #error configNUM_RX_ETHERNET_DMA_DESCRIPTORS must be defined in FreeRTOSConfig.h to set the number of RX DMA descriptors\r
  67 #endif\r
  68 \r
  69 #ifndef configNUM_TX_ETHERNET_DMA_DESCRIPTORS\r
  70         #error configNUM_TX_ETHERNET_DMA_DESCRIPTORS must be defined in FreeRTOSConfig.h to set the number of TX DMA descriptors\r
  71 #endif\r
  72 \r
  73 /* If a packet cannot be sent immediately then the task performing the send\r
  74 operation will be held in the Blocked state (so other tasks can execute) for\r
  75 niTX_BUFFER_FREE_WAIT ticks.  It will do this a maximum of niMAX_TX_ATTEMPTS\r
  76 before giving up. */\r
  77 #define niTX_BUFFER_FREE_WAIT   ( ( portTickType ) 2UL / portTICK_RATE_MS )\r
  78 #define niMAX_TX_ATTEMPTS               ( 5 )\r
  79 \r
  80 /*-----------------------------------------------------------*/\r
  81 \r
  82 /*\r
  83  * A deferred interrupt handler task that processes received frames.\r
  84  */\r
  85 static void prvEMACDeferredInterruptHandlerTask( void *pvParameters );\r
  86 \r
  87 /*-----------------------------------------------------------*/\r
  88 \r
  89 /* The queue used to communicate Ethernet events to the IP task. */\r
  90 extern xQueueHandle xNetworkEventQueue;\r
  91 \r
  92 /* The semaphore used to wake the deferred interrupt handler task when an Rx\r
  93 interrupt is received. */\r
  94 static xSemaphoreHandle xEMACRxEventSemaphore = NULL;\r
  95 \r
  96 /*-----------------------------------------------------------*/\r
  97 \r
  98 portBASE_TYPE xNetworkInterfaceInitialise( void )\r
  99 {\r
 100 EMAC_CFG_Type Emac_Config;\r
 101 portBASE_TYPE xReturn;\r
 102 extern uint8_t ucMACAddress[ 6 ];\r
 103 \r
 104         Emac_Config.pbEMAC_Addr = ucMACAddress;\r
 105         xReturn = EMAC_Init( &Emac_Config );\r
 106 \r
 107         if( xReturn == pdPASS )\r
 108         {\r
 109                 LPC_ETHERNET->DMA_INT_EN =  DMA_INT_NOR_SUM | DMA_INT_RECEIVE;\r
 110 \r
 111                 /* Create the event semaphore if it has not already been created. */\r
 112                 if( xEMACRxEventSemaphore == NULL )\r
 113                 {\r
 114                         vSemaphoreCreateBinary( xEMACRxEventSemaphore );\r
 115                         #if ipconfigINCLUDE_EXAMPLE_FREERTOS_PLUS_TRACE_CALLS == 1\r
 116                         {\r
 117                                 /* If the trace recorder code is included name the semaphore for\r
 118                                 viewing in FreeRTOS+Trace. */\r
 119                                 vTraceSetQueueName( xEMACRxEventSemaphore, "MAC_RX" );\r
 120                         }\r
 121                         #endif /*  ipconfigINCLUDE_EXAMPLE_FREERTOS_PLUS_TRACE_CALLS == 1 */\r
 122                 }\r
 123 \r
 124                 configASSERT( xEMACRxEventSemaphore );\r
 125 \r
 126                 /* The Rx deferred interrupt handler task is created at the highest\r
 127                 possible priority to ensure the interrupt handler can return directly to\r
 128                 it no matter which task was running when the interrupt occurred. */\r
 129                 xTaskCreate(    prvEMACDeferredInterruptHandlerTask,            /* The function that implements the task. */\r
 130                                                 ( const signed char * const ) "MACTsk",\r
 131                                                 configMINIMAL_STACK_SIZE,       /* Stack allocated to the task (defined in words, not bytes). */\r
 132                                                 NULL,                                           /* The task parameter is not used. */\r
 133                                                 configMAX_PRIORITIES - 1,       /* The priority assigned to the task. */\r
 134                                                 NULL );                                         /* The handle is not required, so NULL is passed. */\r
 135 \r
 136                 /* Enable the interrupt and set its priority as configured.  THIS\r
 137                 DRIVER REQUIRES configMAC_INTERRUPT_PRIORITY TO BE DEFINED, PREFERABLY\r
 138                 IN FreeRTOSConfig.h. */\r
 139                 NVIC_SetPriority( ETHERNET_IRQn, configMAC_INTERRUPT_PRIORITY );\r
 140                 NVIC_EnableIRQ( ETHERNET_IRQn );\r
 141         }\r
 142 \r
 143         return xReturn;\r
 144 }\r
 145 /*-----------------------------------------------------------*/\r
 146 \r
 147 portBASE_TYPE xNetworkInterfaceOutput( xNetworkBufferDescriptor_t * const pxNetworkBuffer )\r
 148 {\r
 149 portBASE_TYPE xReturn = pdFAIL;\r
 150 int32_t x;\r
 151 \r
 152         /* Attempt to obtain access to a Tx descriptor. */\r
 153         for( x = 0; x < niMAX_TX_ATTEMPTS; x++ )\r
 154         {\r
 155                 if( EMAC_CheckTransmitIndex() == TRUE )\r
 156                 {\r
 157                         /* Assign the buffer being transmitted to the Tx descriptor. */\r
 158                         EMAC_SetNextPacketToSend( pxNetworkBuffer->pucEthernetBuffer );\r
 159 \r
 160                         /* The EMAC now owns the buffer and will free it when it has been\r
 161                         transmitted.  Set pucBuffer to NULL to ensure the buffer is not\r
 162                         freed when the network buffer structure is returned to the pool\r
 163                         of network buffers. */\r
 164                         pxNetworkBuffer->pucEthernetBuffer = NULL;\r
 165 \r
 166                         /* Initiate the Tx. */\r
 167                         EMAC_StartTransmitNextBuffer( pxNetworkBuffer->xDataLength );\r
 168                         iptraceNETWORK_INTERFACE_TRANSMIT();\r
 169 \r
 170                         /* The Tx has been initiated. */\r
 171                         xReturn = pdPASS;\r
 172 \r
 173                         break;\r
 174                 }\r
 175                 else\r
 176                 {\r
 177                         iptraceWAITING_FOR_TX_DMA_DESCRIPTOR();\r
 178                         vTaskDelay( niTX_BUFFER_FREE_WAIT );\r
 179                 }\r
 180         }\r
 181 \r
 182         /* Finished with the network buffer. */\r
 183         vNetworkBufferRelease( pxNetworkBuffer );\r
 184 \r
 185         return xReturn;\r
 186 }\r
 187 /*-----------------------------------------------------------*/\r
 188 \r
 189 void ETH_IRQHandler( void )\r
 190 {\r
 191 uint32_t ulInterruptCause;\r
 192 \r
 193         ulInterruptCause = LPC_ETHERNET->DMA_STAT ;\r
 194 \r
 195         /* Clear the interrupt. */\r
 196         LPC_ETHERNET->DMA_STAT |= ( DMA_INT_NOR_SUM | DMA_INT_RECEIVE );\r
 197 \r
 198         /* Clear fatal error conditions.  NOTE:  The driver does not clear all\r
 199         errors, only those actually experienced.  For future reference, range\r
 200         errors are not actually errors so can be ignored. */\r
 201         if( ( ulInterruptCause & ( 1 << 13 ) ) != 0U )\r
 202         {\r
 203                 LPC_ETHERNET->DMA_STAT |= ( 1 << 13 );\r
 204         }\r
 205 \r
 206         /* Unblock the deferred interrupt handler task if the event was an Rx. */\r
 207         if( ( ulInterruptCause & DMA_INT_RECEIVE ) != 0UL )\r
 208         {\r
 209                 xSemaphoreGiveFromISR( xEMACRxEventSemaphore, NULL );\r
 210         }\r
 211 \r
 212         /* ulInterruptCause is used for convenience here.  A context switch is\r
 213         wanted, but coding portEND_SWITCHING_ISR( 1 ) would likely result in a\r
 214         compiler warning. */\r
 215         portEND_SWITCHING_ISR( ulInterruptCause );\r
 216 }\r
 217 /*-----------------------------------------------------------*/\r
 218 \r
 219 static void prvEMACDeferredInterruptHandlerTask( void *pvParameters )\r
 220 {\r
 221 xNetworkBufferDescriptor_t *pxNetworkBuffer;\r
 222 xIPStackEvent_t xRxEvent = { eEthernetRxEvent, NULL };\r
 223 \r
 224         ( void ) pvParameters;\r
 225         configASSERT( xEMACRxEventSemaphore );\r
 226 \r
 227         for( ;; )\r
 228         {\r
 229                 /* Wait for the EMAC interrupt to indicate that another packet has been\r
 230                 received.  The while() loop is only needed if INCLUDE_vTaskSuspend is\r
 231                 set to 0 in FreeRTOSConfig.h.  If INCLUDE_vTaskSuspend is set to 1\r
 232                 then portMAX_DELAY would be an indefinite block time and\r
 233                 xSemaphoreTake() would only return when the semaphore was actually\r
 234                 obtained. */\r
 235                 while( xSemaphoreTake( xEMACRxEventSemaphore, portMAX_DELAY ) == pdFALSE );\r
 236 \r
 237                 /* At least one packet has been received. */\r
 238                 while( EMAC_CheckReceiveIndex() != FALSE )\r
 239                 {\r
 240                         /* The buffer filled by the DMA is going to be passed into the IP\r
 241                         stack.  Allocate another buffer for the DMA descriptor. */\r
 242                         pxNetworkBuffer = pxNetworkBufferGet( ipTOTAL_ETHERNET_FRAME_SIZE, ( portTickType ) 0 );\r
 243 \r
 244                         if( pxNetworkBuffer != NULL )\r
 245                         {\r
 246                                 /* Swap the buffer just allocated and referenced from the\r
 247                                 pxNetworkBuffer with the buffer that has already been filled by\r
 248                                 the DMA.  pxNetworkBuffer will then hold a reference to the\r
 249                                 buffer that already contains the data without any data having\r
 250                                 been copied between buffers. */\r
 251                                 EMAC_NextPacketToRead( pxNetworkBuffer );\r
 252 \r
 253                                 #if ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES == 1\r
 254                                 {\r
 255                                         if( pxNetworkBuffer->xDataLength > 0 )\r
 256                                         {\r
 257                                                 /* If the frame would not be processed by the IP stack then\r
 258                                                 don't even bother sending it to the IP stack. */\r
 259                                                 if( eConsiderFrameForProcessing( pxNetworkBuffer->pucEthernetBuffer ) != eProcessBuffer )\r
 260                                                 {\r
 261                                                         pxNetworkBuffer->xDataLength = 0;\r
 262                                                 }\r
 263                                         }\r
 264                                 }\r
 265                                 #endif\r
 266 \r
 267                                 if( pxNetworkBuffer->xDataLength > 0 )\r
 268                                 {\r
 269                                         /* Store a pointer to the network buffer structure in the\r
 270                                         padding space that was left in front of the Ethernet frame.\r
 271                                         The pointer     is needed to ensure the network buffer structure\r
 272                                         can be located when it is time for it to be freed if the\r
 273                                         Ethernet frame gets     used as a zero copy buffer. */\r
 274                                         *( ( xNetworkBufferDescriptor_t ** ) ( ( pxNetworkBuffer->pucEthernetBuffer - ipBUFFER_PADDING ) ) ) = pxNetworkBuffer;\r
 275 \r
 276                                         /* Data was received and stored.  Send it to the IP task\r
 277                                         for processing. */\r
 278                                         xRxEvent.pvData = ( void * ) pxNetworkBuffer;\r
 279                                         if( xQueueSendToBack( xNetworkEventQueue, &xRxEvent, ( portTickType ) 0 ) == pdFALSE )\r
 280                                         {\r
 281                                                 /* The buffer could not be sent to the IP task so the\r
 282                                                 buffer must be released. */\r
 283                                                 vNetworkBufferRelease( pxNetworkBuffer );\r
 284                                                 iptraceETHERNET_RX_EVENT_LOST();\r
 285                                         }\r
 286                                         else\r
 287                                         {\r
 288                                                 iptraceNETWORK_INTERFACE_RECEIVE();\r
 289                                         }\r
 290                                 }\r
 291                                 else\r
 292                                 {\r
 293                                         /* The buffer does not contain any data so there is no\r
 294                                         point sending it to the IP task.  Just release it. */\r
 295                                         vNetworkBufferRelease( pxNetworkBuffer );\r
 296                                         iptraceETHERNET_RX_EVENT_LOST();\r
 297                                 }\r
 298                         }\r
 299                         else\r
 300                         {\r
 301                                 iptraceETHERNET_RX_EVENT_LOST();\r
 302                         }\r
 303 \r
 304                         /* Release the descriptor. */\r
 305                         EMAC_UpdateRxConsumeIndex();\r
 306                 }\r
 307         }\r
 308 }\r
 309 /*-----------------------------------------------------------*/\r
 310 \r