git.sur5r.net Git - freertos/blob - FreeRTOS-Plus/Source/FreeRTOS-Plus-UDP/portable/NetworkInterface/SAM4E/NetworkInterface.c

   1 /*\r
   2  * FreeRTOS+UDP V1.0.3 (C) 2014 Real Time Engineers ltd.\r
   3  * All rights reserved\r
   4  *\r
   5  * This file is part of the FreeRTOS+UDP distribution.  The FreeRTOS+UDP license\r
   6  * terms are different to the FreeRTOS license terms.\r
   7  *\r
   8  * FreeRTOS+UDP uses a dual license model that allows the software to be used\r
   9  * under a pure GPL open source license (as opposed to the modified GPL license\r
  10  * under which FreeRTOS is distributed) or a commercial license.  Details of\r
  11  * both license options follow:\r
  12  *\r
  13  * - Open source licensing -\r
  14  * FreeRTOS+UDP is a free download and may be used, modified, evaluated and\r
  15  * distributed without charge provided the user adheres to version two of the\r
  16  * GNU General Public License (GPL) and does not remove the copyright notice or\r
  17  * this text.  The GPL V2 text is available on the gnu.org web site, and on the\r
  18  * following URL: http://www.FreeRTOS.org/gpl-2.0.txt.\r
  19  *\r
  20  * - Commercial licensing -\r
  21  * Businesses and individuals that for commercial or other reasons cannot comply\r
  22  * with the terms of the GPL V2 license must obtain a commercial license before\r
  23  * incorporating FreeRTOS+UDP into proprietary software for distribution in any\r
  24  * form.  Commercial licenses can be purchased from http://shop.freertos.org/udp\r
  25  * and do not require any source files to be changed.\r
  26  *\r
  27  * FreeRTOS+UDP is distributed in the hope that it will be useful.  You cannot\r
  28  * use FreeRTOS+UDP unless you agree that you use the software 'as is'.\r
  29  * FreeRTOS+UDP is provided WITHOUT ANY WARRANTY; without even the implied\r
  30  * warranties of NON-INFRINGEMENT, MERCHANTABILITY or FITNESS FOR A PARTICULAR\r
  31  * PURPOSE. Real Time Engineers Ltd. disclaims all conditions and terms, be they\r
  32  * implied, expressed, or statutory.\r
  33  *\r
  34  * 1 tab == 4 spaces!\r
  35  *\r
  36  * http://www.FreeRTOS.org\r
  37  * http://www.FreeRTOS.org/udp\r
  38  *\r
  39  */\r
  40 \r
  41 /* Standard includes. */\r
  42 #include <stdint.h>\r
  43 #include <limits.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 \r
  57 /* Demo includes. */\r
  58 #include "NetworkInterface.h"\r
  59 \r
  60 /* If a packet cannot be sent immediately then the task performing the send\r
  61 operation will be held in the Blocked state (so other tasks can execute) for\r
  62 niTX_BUFFER_FREE_WAIT ticks.  It will do this a maximum of niMAX_TX_ATTEMPTS\r
  63 before giving up. */\r
  64 #define niTX_BUFFER_FREE_WAIT   ( ( portTickType ) 2UL / portTICK_RATE_MS )\r
  65 #define niMAX_TX_ATTEMPTS               ( 5 )\r
  66 \r
  67 /*-----------------------------------------------------------*/\r
  68 \r
  69 /*\r
  70  * A deferred interrupt handler task that processes received frames.\r
  71  */\r
  72 static void prvGMACDeferredInterruptHandlerTask( void *pvParameters );\r
  73 \r
  74 /*\r
  75  * Called by the ASF GMAC driver when a packet is received.\r
  76  */\r
  77 static void prvGMACRxCallback( uint32_t ulStatus );\r
  78 \r
  79 /*-----------------------------------------------------------*/\r
  80 \r
  81 /* The queue used to communicate Ethernet events to the IP task. */\r
  82 extern xQueueHandle xNetworkEventQueue;\r
  83 \r
  84 /* The semaphore used to wake the deferred interrupt handler task when an Rx\r
  85 interrupt is received. */\r
  86 static xSemaphoreHandle xGMACRxEventSemaphore = NULL;\r
  87 \r
  88 /* The GMAC driver instance. */\r
  89 static gmac_device_t xGMACStruct;\r
  90 \r
  91 /*-----------------------------------------------------------*/\r
  92 \r
  93 portBASE_TYPE xNetworkInterfaceInitialise( void )\r
  94 {\r
  95 gmac_options_t xGMACOptions;\r
  96 extern uint8_t ucMACAddress[ 6 ];\r
  97 const portTickType xPHYDelay_400ms = 400UL;\r
  98 portBASE_TYPE xReturn = pdFALSE;\r
  99 \r
 100         /* Ensure PHY is ready. */\r
 101         vTaskDelay( xPHYDelay_400ms / portTICK_RATE_MS );\r
 102 \r
 103         /* Enable GMAC clock. */\r
 104         pmc_enable_periph_clk( ID_GMAC );\r
 105 \r
 106         /* Fill in GMAC options */\r
 107         xGMACOptions.uc_copy_all_frame = 0;\r
 108         xGMACOptions.uc_no_boardcast = 0;\r
 109         memcpy( xGMACOptions.uc_mac_addr, ucMACAddress, sizeof( ucMACAddress ) );\r
 110 \r
 111         xGMACStruct.p_hw = GMAC;\r
 112 \r
 113         /* Init GMAC driver structure. */\r
 114         gmac_dev_init( GMAC, &xGMACStruct, &xGMACOptions );\r
 115 \r
 116         /* Init MAC PHY driver. */\r
 117         if( ethernet_phy_init( GMAC, BOARD_GMAC_PHY_ADDR, sysclk_get_cpu_hz() ) == GMAC_OK )\r
 118         {\r
 119                 /* Auto Negotiate, work in RMII mode. */\r
 120                 if( ethernet_phy_auto_negotiate( GMAC, BOARD_GMAC_PHY_ADDR ) == GMAC_OK )\r
 121                 {\r
 122                         /* Establish Ethernet link. */\r
 123                         vTaskDelay( xPHYDelay_400ms * 2UL );\r
 124                         if( ethernet_phy_set_link( GMAC, BOARD_GMAC_PHY_ADDR, 1 ) == GMAC_OK )\r
 125                         {\r
 126                                 /* Create the event semaphore if it has not already been\r
 127                                 created. */\r
 128                                 if( xGMACRxEventSemaphore == NULL )\r
 129                                 {\r
 130                                         xGMACRxEventSemaphore = xSemaphoreCreateCounting( ULONG_MAX, 0 );\r
 131                                         #if ipconfigINCLUDE_EXAMPLE_FREERTOS_PLUS_TRACE_CALLS == 1\r
 132                                         {\r
 133                                                 /* If the trace recorder code is included name the semaphore for\r
 134                                                 viewing in FreeRTOS+Trace. */\r
 135                                                 vTraceSetQueueName( xGMACRxEventSemaphore, "MAC_RX" );\r
 136                                         }\r
 137                                         #endif /*  ipconfigINCLUDE_EXAMPLE_FREERTOS_PLUS_TRACE_CALLS == 1 */\r
 138                                 }\r
 139 \r
 140                                 /* Register the callbacks. */\r
 141                                 gmac_dev_set_rx_callback( &xGMACStruct, prvGMACRxCallback );\r
 142 \r
 143                                 /* The Rx deferred interrupt handler task is created at the\r
 144                                 highest possible priority to ensure the interrupt handler can\r
 145                                 return directly to it no matter which task was running when the\r
 146                                 interrupt occurred. */\r
 147                                 xTaskCreate(    prvGMACDeferredInterruptHandlerTask,/* The function that implements the task. */\r
 148                                                                 "MACTsk",\r
 149                                                                 configMINIMAL_STACK_SIZE,       /* Stack allocated to the task (defined in words, not bytes). */\r
 150                                                                 NULL,                                           /* The task parameter is not used. */\r
 151                                                                 configMAX_PRIORITIES - 1,       /* The priority assigned to the task. */\r
 152                                                                 NULL );                                         /* The handle is not required, so NULL is passed. */\r
 153 \r
 154                                 /* Enable the interrupt and set its priority as configured.\r
 155                                 THIS DRIVER REQUIRES configMAC_INTERRUPT_PRIORITY TO BE DEFINED,\r
 156                                 PREFERABLY IN FreeRTOSConfig.h. */\r
 157                                 NVIC_SetPriority( GMAC_IRQn, configMAC_INTERRUPT_PRIORITY );\r
 158                                 NVIC_EnableIRQ( GMAC_IRQn );\r
 159                                 xReturn = pdPASS;\r
 160                         }\r
 161                 }\r
 162         }\r
 163 \r
 164         return xReturn;\r
 165 }\r
 166 /*-----------------------------------------------------------*/\r
 167 \r
 168 static void prvGMACRxCallback( uint32_t ulStatus )\r
 169 {\r
 170 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 171 \r
 172         /* Unblock the deferred interrupt handler task if the event was an Rx. */\r
 173         if( ulStatus == GMAC_RSR_REC )\r
 174         {\r
 175                 xSemaphoreGiveFromISR( xGMACRxEventSemaphore, &xHigherPriorityTaskWoken );\r
 176         }\r
 177 \r
 178         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 179 }\r
 180 /*-----------------------------------------------------------*/\r
 181 \r
 182 portBASE_TYPE xNetworkInterfaceOutput( xNetworkBufferDescriptor_t * const pxNetworkBuffer )\r
 183 {\r
 184 portBASE_TYPE xReturn = pdFAIL;\r
 185 int32_t x;\r
 186 \r
 187         /* Attempt to obtain access to a Tx descriptor. */\r
 188         for( x = 0; x < niMAX_TX_ATTEMPTS; x++ )\r
 189         {\r
 190                 if( gmac_dev_write( &xGMACStruct, pxNetworkBuffer->pucEthernetBuffer, ( uint32_t ) pxNetworkBuffer->xDataLength, NULL ) == GMAC_OK )\r
 191                 {\r
 192                         /* The Tx has been initiated. */\r
 193                         xReturn = pdPASS;\r
 194                         break;\r
 195                 }\r
 196                 else\r
 197                 {\r
 198                         iptraceWAITING_FOR_TX_DMA_DESCRIPTOR();\r
 199                         vTaskDelay( niTX_BUFFER_FREE_WAIT );\r
 200                 }\r
 201         }\r
 202 \r
 203         /* Finished with the network buffer. */\r
 204         vNetworkBufferRelease( pxNetworkBuffer );\r
 205 \r
 206         return xReturn;\r
 207 }\r
 208 /*-----------------------------------------------------------*/\r
 209 \r
 210 void GMAC_Handler( void )\r
 211 {\r
 212         gmac_handler( &xGMACStruct );\r
 213 }\r
 214 /*-----------------------------------------------------------*/\r
 215 \r
 216 static void prvGMACDeferredInterruptHandlerTask( void *pvParameters )\r
 217 {\r
 218 xNetworkBufferDescriptor_t *pxNetworkBuffer;\r
 219 xIPStackEvent_t xRxEvent = { eEthernetRxEvent, NULL };\r
 220 static const portTickType xBufferWaitDelay = 1500UL / portTICK_RATE_MS;\r
 221 uint32_t ulReturned;\r
 222 \r
 223         ( void ) pvParameters;\r
 224         configASSERT( xGMACRxEventSemaphore );\r
 225 \r
 226         for( ;; )\r
 227         {\r
 228                 /* Wait for the GMAC interrupt to indicate that another packet has been\r
 229                 received.  The while() loop is only needed if INCLUDE_vTaskSuspend is\r
 230                 set to 0 in FreeRTOSConfig.h.  If INCLUDE_vTaskSuspend is set to 1\r
 231                 then portMAX_DELAY would be an indefinite block time and\r
 232                 xSemaphoreTake() would only return when the semaphore was actually\r
 233                 obtained. */\r
 234                 while( xSemaphoreTake( xGMACRxEventSemaphore, portMAX_DELAY ) == pdFALSE );\r
 235 \r
 236                 /* Allocate a buffer to hold the data. */\r
 237                 pxNetworkBuffer = pxNetworkBufferGet( ipTOTAL_ETHERNET_FRAME_SIZE, xBufferWaitDelay );\r
 238 \r
 239                 if( pxNetworkBuffer != NULL )\r
 240                 {\r
 241                         /* At least one packet has been received. */\r
 242                         ulReturned = gmac_dev_read( &xGMACStruct, pxNetworkBuffer->pucEthernetBuffer, ipTOTAL_ETHERNET_FRAME_SIZE, ( uint32_t * ) &( pxNetworkBuffer->xDataLength ) );\r
 243                         if( ulReturned == GMAC_OK )\r
 244                         {\r
 245                                 #if ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES == 1\r
 246                                 {\r
 247                                         if( pxNetworkBuffer->xDataLength > 0 )\r
 248                                         {\r
 249                                                 /* If the frame would not be processed by the IP stack then\r
 250                                                 don't even bother sending it to the IP stack. */\r
 251                                                 if( eConsiderFrameForProcessing( pxNetworkBuffer->pucEthernetBuffer ) != eProcessBuffer )\r
 252                                                 {\r
 253                                                         pxNetworkBuffer->xDataLength = 0;\r
 254                                                 }\r
 255                                         }\r
 256                                 }\r
 257                                 #endif\r
 258 \r
 259                                 if( pxNetworkBuffer->xDataLength > 0 )\r
 260                                 {\r
 261                                         /* Store a pointer to the network buffer structure in the\r
 262                                         padding space that was left in front of the Ethernet frame.\r
 263                                         The pointer     is needed to ensure the network buffer structure\r
 264                                         can be located when it is time for it to be freed if the\r
 265                                         Ethernet frame gets     used as a zero copy buffer. */\r
 266                                         *( ( xNetworkBufferDescriptor_t ** ) ( ( pxNetworkBuffer->pucEthernetBuffer - ipBUFFER_PADDING ) ) ) = pxNetworkBuffer;\r
 267 \r
 268                                         /* Data was received and stored.  Send it to the IP task\r
 269                                         for processing. */\r
 270                                         xRxEvent.pvData = ( void * ) pxNetworkBuffer;\r
 271                                         if( xQueueSendToBack( xNetworkEventQueue, &xRxEvent, ( portTickType ) 0 ) == pdFALSE )\r
 272                                         {\r
 273                                                 /* The buffer could not be sent to the IP task so the\r
 274                                                 buffer must be released. */\r
 275                                                 vNetworkBufferRelease( pxNetworkBuffer );\r
 276                                                 iptraceETHERNET_RX_EVENT_LOST();\r
 277                                         }\r
 278                                         else\r
 279                                         {\r
 280                                                 iptraceNETWORK_INTERFACE_RECEIVE();\r
 281                                         }\r
 282                                 }\r
 283                                 else\r
 284                                 {\r
 285                                         /* The buffer does not contain any data so there is no\r
 286                                         point sending it to the IP task.  Just release it. */\r
 287                                         vNetworkBufferRelease( pxNetworkBuffer );\r
 288                                         iptraceETHERNET_RX_EVENT_LOST();\r
 289                                 }\r
 290                         }\r
 291                         else\r
 292                         {\r
 293                                 vNetworkBufferRelease( pxNetworkBuffer );\r
 294                                 iptraceETHERNET_RX_EVENT_LOST();\r
 295                         }\r
 296                 }\r
 297                 else\r
 298                 {\r
 299                         /* Left a frame in the driver as a buffer was not available. */\r
 300                         gmac_dev_reset( &xGMACStruct );\r
 301                 }\r
 302         }\r
 303 }\r
 304 /*-----------------------------------------------------------*/\r
 305 \r