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