git.sur5r.net Git - freertos/blob - FreeRTOS-Plus/Source/FreeRTOS-Plus-TCP/portable/NetworkInterface/Zynq/NetworkInterface.c

   1 /*\r
   2  * FreeRTOS+TCP V2.0.0\r
   3  * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software. If you wish to use our Amazon\r
  14  * FreeRTOS name, please do so in a fair use way that does not cause confusion.\r
  15  *\r
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  18  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  19  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  20  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  21  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  22  *\r
  23  * http://www.FreeRTOS.org\r
  24  * http://aws.amazon.com/freertos\r
  25  *\r
  26  * 1 tab == 4 spaces!\r
  27  */\r
  28 \r
  29 /* Standard includes. */\r
  30 #include <stdint.h>\r
  31 #include <stdio.h>\r
  32 #include <stdlib.h>\r
  33 \r
  34 /* FreeRTOS includes. */\r
  35 #include "FreeRTOS.h"\r
  36 #include "task.h"\r
  37 #include "queue.h"\r
  38 #include "semphr.h"\r
  39 \r
  40 /* FreeRTOS+TCP includes. */\r
  41 #include "FreeRTOS_IP.h"\r
  42 #include "FreeRTOS_Sockets.h"\r
  43 #include "FreeRTOS_IP_Private.h"\r
  44 #include "NetworkBufferManagement.h"\r
  45 #include "NetworkInterface.h"\r
  46 \r
  47 /* Xilinx library files. */\r
  48 #include <xemacps.h>\r
  49 #include "Zynq/x_topology.h"\r
  50 #include "Zynq/x_emacpsif.h"\r
  51 #include "Zynq/x_emacpsif_hw.h"\r
  52 \r
  53 /* Provided memory configured as uncached. */\r
  54 #include "uncached_memory.h"\r
  55 \r
  56 #ifndef BMSR_LINK_STATUS\r
  57         #define BMSR_LINK_STATUS            0x0004UL\r
  58 #endif\r
  59 \r
  60 #ifndef PHY_LS_HIGH_CHECK_TIME_MS\r
  61         /* Check if the LinkSStatus in the PHY is still high after 15 seconds of not\r
  62         receiving packets. */\r
  63         #define PHY_LS_HIGH_CHECK_TIME_MS       15000\r
  64 #endif\r
  65 \r
  66 #ifndef PHY_LS_LOW_CHECK_TIME_MS\r
  67         /* Check if the LinkSStatus in the PHY is still low every second. */\r
  68         #define PHY_LS_LOW_CHECK_TIME_MS        1000\r
  69 #endif\r
  70 \r
  71 /* The size of each buffer when BufferAllocation_1 is used:\r
  72 http://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/Embedded_Ethernet_Buffer_Management.html */\r
  73 #define niBUFFER_1_PACKET_SIZE          1536\r
  74 \r
  75 /* Naming and numbering of PHY registers. */\r
  76 #define PHY_REG_01_BMSR                 0x01    /* Basic mode status register */\r
  77 \r
  78 #ifndef iptraceEMAC_TASK_STARTING\r
  79         #define iptraceEMAC_TASK_STARTING()     do { } while( 0 )\r
  80 #endif\r
  81 \r
  82 /* Default the size of the stack used by the EMAC deferred handler task to twice\r
  83 the size of the stack used by the idle task - but allow this to be overridden in\r
  84 FreeRTOSConfig.h as configMINIMAL_STACK_SIZE is a user definable constant. */\r
  85 #ifndef configEMAC_TASK_STACK_SIZE\r
  86         #define configEMAC_TASK_STACK_SIZE ( 2 * configMINIMAL_STACK_SIZE )\r
  87 #endif\r
  88 \r
  89 /*-----------------------------------------------------------*/\r
  90 \r
  91 /*\r
  92  * Look for the link to be up every few milliseconds until either xMaxTime time\r
  93  * has passed or a link is found.\r
  94  */\r
  95 static BaseType_t prvGMACWaitLS( TickType_t xMaxTime );\r
  96 \r
  97 /*\r
  98  * A deferred interrupt handler for all MAC/DMA interrupt sources.\r
  99  */\r
 100 static void prvEMACHandlerTask( void *pvParameters );\r
 101 \r
 102 /*-----------------------------------------------------------*/\r
 103 \r
 104 /* EMAC data/descriptions. */\r
 105 static xemacpsif_s xEMACpsif;\r
 106 struct xtopology_t xXTopology =\r
 107 {\r
 108         .emac_baseaddr = XPAR_PS7_ETHERNET_0_BASEADDR,\r
 109         .emac_type = xemac_type_emacps,\r
 110         .intc_baseaddr = 0x0,\r
 111         .intc_emac_intr = 0x0,\r
 112         .scugic_baseaddr = XPAR_PS7_SCUGIC_0_BASEADDR,\r
 113         .scugic_emac_intr = 0x36,\r
 114 };\r
 115 \r
 116 XEmacPs_Config mac_config =\r
 117 {\r
 118         .DeviceId = XPAR_PS7_ETHERNET_0_DEVICE_ID,      /**< Unique ID  of device */\r
 119         .BaseAddress = XPAR_PS7_ETHERNET_0_BASEADDR /**< Physical base address of IPIF registers */\r
 120 };\r
 121 \r
 122 extern int phy_detected;\r
 123 \r
 124 /* A copy of PHY register 1: 'PHY_REG_01_BMSR' */\r
 125 static uint32_t ulPHYLinkStatus = 0;\r
 126 \r
 127 #if( ipconfigUSE_LLMNR == 1 )\r
 128         static const uint8_t xLLMNR_MACAddress[] = { 0x01, 0x00, 0x5E, 0x00, 0x00, 0xFC };\r
 129 #endif\r
 130 \r
 131 /* ucMACAddress as it appears in main.c */\r
 132 extern const uint8_t ucMACAddress[ 6 ];\r
 133 \r
 134 /* Holds the handle of the task used as a deferred interrupt processor.  The\r
 135 handle is used so direct notifications can be sent to the task for all EMAC/DMA\r
 136 related interrupts. */\r
 137 TaskHandle_t xEMACTaskHandle = NULL;\r
 138 \r
 139 /*-----------------------------------------------------------*/\r
 140 \r
 141 BaseType_t xNetworkInterfaceInitialise( void )\r
 142 {\r
 143 uint32_t ulLinkSpeed, ulDMAReg;\r
 144 BaseType_t xStatus, xLinkStatus;\r
 145 XEmacPs *pxEMAC_PS;\r
 146 const TickType_t xWaitLinkDelay = pdMS_TO_TICKS( 7000UL ), xWaitRelinkDelay = pdMS_TO_TICKS( 1000UL );\r
 147 \r
 148         /* Guard against the init function being called more than once. */\r
 149         if( xEMACTaskHandle == NULL )\r
 150         {\r
 151                 pxEMAC_PS = &( xEMACpsif.emacps );\r
 152                 memset( &xEMACpsif, '\0', sizeof( xEMACpsif ) );\r
 153 \r
 154                 xStatus = XEmacPs_CfgInitialize( pxEMAC_PS, &mac_config, mac_config.BaseAddress);\r
 155                 if( xStatus != XST_SUCCESS )\r
 156                 {\r
 157                         FreeRTOS_printf( ( "xEMACInit: EmacPs Configuration Failed....\n" ) );\r
 158                 }\r
 159 \r
 160                 /* Initialize the mac and set the MAC address. */\r
 161                 XEmacPs_SetMacAddress( pxEMAC_PS, ( void * ) ucMACAddress, 1 );\r
 162 \r
 163                 #if( ipconfigUSE_LLMNR == 1 )\r
 164                 {\r
 165                         /* Also add LLMNR multicast MAC address. */\r
 166                         XEmacPs_SetMacAddress( pxEMAC_PS, ( void * )xLLMNR_MACAddress, 2 );\r
 167                 }\r
 168                 #endif  /* ipconfigUSE_LLMNR == 1 */\r
 169 \r
 170                 XEmacPs_SetMdioDivisor( pxEMAC_PS, MDC_DIV_224 );\r
 171                 ulLinkSpeed = Phy_Setup( pxEMAC_PS );\r
 172                 XEmacPs_SetOperatingSpeed( pxEMAC_PS, ulLinkSpeed);\r
 173 \r
 174                 /* Setting the operating speed of the MAC needs a delay. */\r
 175                 vTaskDelay( pdMS_TO_TICKS( 25UL ) );\r
 176 \r
 177                 ulDMAReg = XEmacPs_ReadReg( pxEMAC_PS->Config.BaseAddress, XEMACPS_DMACR_OFFSET);\r
 178 \r
 179                 /* DISC_WHEN_NO_AHB: when set, the GEM DMA will automatically discard receive\r
 180                 packets from the receiver packet buffer memory when no AHB resource is available. */\r
 181                 XEmacPs_WriteReg( pxEMAC_PS->Config.BaseAddress, XEMACPS_DMACR_OFFSET,\r
 182                         ulDMAReg | XEMACPS_DMACR_DISC_WHEN_NO_AHB_MASK);\r
 183 \r
 184                 setup_isr( &xEMACpsif );\r
 185                 init_dma( &xEMACpsif );\r
 186                 start_emacps( &xEMACpsif );\r
 187 \r
 188                 prvGMACWaitLS( xWaitLinkDelay );\r
 189 \r
 190                 /* The deferred interrupt handler task is created at the highest\r
 191                 possible priority to ensure the interrupt handler can return directly\r
 192                 to it.  The task's handle is stored in xEMACTaskHandle so interrupts can\r
 193                 notify the task when there is something to process. */\r
 194                 xTaskCreate( prvEMACHandlerTask, "EMAC", configEMAC_TASK_STACK_SIZE, NULL, configMAX_PRIORITIES - 1, &xEMACTaskHandle );\r
 195         }\r
 196         else\r
 197         {\r
 198                 /* Initialisation was already performed, just wait for the link. */\r
 199                 prvGMACWaitLS( xWaitRelinkDelay );\r
 200         }\r
 201 \r
 202         /* Only return pdTRUE when the Link Status of the PHY is high, otherwise the\r
 203         DHCP process and all other communication will fail. */\r
 204         xLinkStatus = xGetPhyLinkStatus();\r
 205 \r
 206         return ( xLinkStatus != pdFALSE );\r
 207 }\r
 208 /*-----------------------------------------------------------*/\r
 209 \r
 210 BaseType_t xNetworkInterfaceOutput( NetworkBufferDescriptor_t * const pxBuffer, BaseType_t bReleaseAfterSend )\r
 211 {\r
 212         if( ( ulPHYLinkStatus & BMSR_LINK_STATUS ) != 0 )\r
 213         {\r
 214                 iptraceNETWORK_INTERFACE_TRANSMIT();\r
 215                 emacps_send_message( &xEMACpsif, pxBuffer, bReleaseAfterSend );\r
 216         }\r
 217         else if( bReleaseAfterSend != pdFALSE )\r
 218         {\r
 219                 /* No link. */\r
 220                 vReleaseNetworkBufferAndDescriptor( pxBuffer );\r
 221         }\r
 222 \r
 223         return pdTRUE;\r
 224 }\r
 225 /*-----------------------------------------------------------*/\r
 226 \r
 227 static inline unsigned long ulReadMDIO( unsigned ulRegister )\r
 228 {\r
 229 uint16_t usValue;\r
 230 \r
 231         XEmacPs_PhyRead( &( xEMACpsif.emacps ), phy_detected, ulRegister, &usValue );\r
 232         return usValue;\r
 233 }\r
 234 /*-----------------------------------------------------------*/\r
 235 \r
 236 static BaseType_t prvGMACWaitLS( TickType_t xMaxTime )\r
 237 {\r
 238 TickType_t xStartTime, xEndTime;\r
 239 const TickType_t xShortDelay = pdMS_TO_TICKS( 20UL );\r
 240 BaseType_t xReturn;\r
 241 \r
 242         xStartTime = xTaskGetTickCount();\r
 243 \r
 244         for( ;; )\r
 245         {\r
 246                 xEndTime = xTaskGetTickCount();\r
 247 \r
 248                 if( xEndTime - xStartTime > xMaxTime )\r
 249                 {\r
 250                         xReturn = pdFALSE;\r
 251                         break;\r
 252                 }\r
 253                 ulPHYLinkStatus = ulReadMDIO( PHY_REG_01_BMSR );\r
 254 \r
 255                 if( ( ulPHYLinkStatus & BMSR_LINK_STATUS ) != 0 )\r
 256                 {\r
 257                         xReturn = pdTRUE;\r
 258                         break;\r
 259                 }\r
 260 \r
 261                 vTaskDelay( xShortDelay );\r
 262         }\r
 263 \r
 264         return xReturn;\r
 265 }\r
 266 /*-----------------------------------------------------------*/\r
 267 \r
 268 void vNetworkInterfaceAllocateRAMToBuffers( NetworkBufferDescriptor_t pxNetworkBuffers[ ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS ] )\r
 269 {\r
 270 static uint8_t ucNetworkPackets[ ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS * niBUFFER_1_PACKET_SIZE ] __attribute__ ( ( aligned( 32 ) ) );\r
 271 uint8_t *ucRAMBuffer = ucNetworkPackets;\r
 272 uint32_t ul;\r
 273 \r
 274         for( ul = 0; ul < ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS; ul++ )\r
 275         {\r
 276                 pxNetworkBuffers[ ul ].pucEthernetBuffer = ucRAMBuffer + ipBUFFER_PADDING;\r
 277                 *( ( unsigned * ) ucRAMBuffer ) = ( unsigned ) ( &( pxNetworkBuffers[ ul ] ) );\r
 278                 ucRAMBuffer += niBUFFER_1_PACKET_SIZE;\r
 279         }\r
 280 }\r
 281 /*-----------------------------------------------------------*/\r
 282 \r
 283 BaseType_t xGetPhyLinkStatus( void )\r
 284 {\r
 285 BaseType_t xReturn;\r
 286 \r
 287         if( ( ulPHYLinkStatus & BMSR_LINK_STATUS ) == 0 )\r
 288         {\r
 289                 xReturn = pdFALSE;\r
 290         }\r
 291         else\r
 292         {\r
 293                 xReturn = pdTRUE;\r
 294         }\r
 295 \r
 296         return xReturn;\r
 297 }\r
 298 /*-----------------------------------------------------------*/\r
 299 \r
 300 static void prvEMACHandlerTask( void *pvParameters )\r
 301 {\r
 302 TimeOut_t xPhyTime;\r
 303 TickType_t xPhyRemTime;\r
 304 UBaseType_t uxLastMinBufferCount = 0;\r
 305 UBaseType_t uxCurrentCount;\r
 306 BaseType_t xResult = 0;\r
 307 uint32_t xStatus;\r
 308 const TickType_t ulMaxBlockTime = pdMS_TO_TICKS( 100UL );\r
 309 \r
 310         /* Remove compiler warnings about unused parameters. */\r
 311         ( void ) pvParameters;\r
 312 \r
 313         /* A possibility to set some additional task properties like calling\r
 314         portTASK_USES_FLOATING_POINT() */\r
 315         iptraceEMAC_TASK_STARTING();\r
 316 \r
 317         vTaskSetTimeOutState( &xPhyTime );\r
 318         xPhyRemTime = pdMS_TO_TICKS( PHY_LS_LOW_CHECK_TIME_MS );\r
 319 \r
 320         for( ;; )\r
 321         {\r
 322                 uxCurrentCount = uxGetMinimumFreeNetworkBuffers();\r
 323                 if( uxLastMinBufferCount != uxCurrentCount )\r
 324                 {\r
 325                         /* The logging produced below may be helpful\r
 326                         while tuning +TCP: see how many buffers are in use. */\r
 327                         uxLastMinBufferCount = uxCurrentCount;\r
 328                         FreeRTOS_printf( ( "Network buffers: %lu lowest %lu\n",\r
 329                                 uxGetNumberOfFreeNetworkBuffers(), uxCurrentCount ) );\r
 330                 }\r
 331 \r
 332                 #if( ipconfigCHECK_IP_QUEUE_SPACE != 0 )\r
 333                 {\r
 334                 static UBaseType_t uxLastMinQueueSpace = 0;\r
 335 \r
 336                         uxCurrentCount = uxGetMinimumIPQueueSpace();\r
 337                         if( uxLastMinQueueSpace != uxCurrentCount )\r
 338                         {\r
 339                                 /* The logging produced below may be helpful\r
 340                                 while tuning +TCP: see how many buffers are in use. */\r
 341                                 uxLastMinQueueSpace = uxCurrentCount;\r
 342                                 FreeRTOS_printf( ( "Queue space: lowest %lu\n", uxCurrentCount ) );\r
 343                         }\r
 344                 }\r
 345                 #endif /* ipconfigCHECK_IP_QUEUE_SPACE */\r
 346 \r
 347                 if( ( xEMACpsif.isr_events & EMAC_IF_ALL_EVENT ) == 0 )\r
 348                 {\r
 349                         /* No events to process now, wait for the next. */\r
 350                         ulTaskNotifyTake( pdFALSE, ulMaxBlockTime );\r
 351                 }\r
 352 \r
 353                 if( ( xEMACpsif.isr_events & EMAC_IF_RX_EVENT ) != 0 )\r
 354                 {\r
 355                         xEMACpsif.isr_events &= ~EMAC_IF_RX_EVENT;\r
 356                         xResult = emacps_check_rx( &xEMACpsif );\r
 357                 }\r
 358 \r
 359                 if( ( xEMACpsif.isr_events & EMAC_IF_TX_EVENT ) != 0 )\r
 360                 {\r
 361                         xEMACpsif.isr_events &= ~EMAC_IF_TX_EVENT;\r
 362                         emacps_check_tx( &xEMACpsif );\r
 363                 }\r
 364 \r
 365                 if( ( xEMACpsif.isr_events & EMAC_IF_ERR_EVENT ) != 0 )\r
 366                 {\r
 367                         xEMACpsif.isr_events &= ~EMAC_IF_ERR_EVENT;\r
 368                         emacps_check_errors( &xEMACpsif );\r
 369                 }\r
 370 \r
 371                 if( xResult > 0 )\r
 372                 {\r
 373                         /* A packet was received. No need to check for the PHY status now,\r
 374                         but set a timer to check it later on. */\r
 375                         vTaskSetTimeOutState( &xPhyTime );\r
 376                         xPhyRemTime = pdMS_TO_TICKS( PHY_LS_HIGH_CHECK_TIME_MS );\r
 377                         xResult = 0;\r
 378                 }\r
 379                 else if( xTaskCheckForTimeOut( &xPhyTime, &xPhyRemTime ) != pdFALSE )\r
 380                 {\r
 381                         xStatus = ulReadMDIO( PHY_REG_01_BMSR );\r
 382 \r
 383                         if( ( ulPHYLinkStatus & BMSR_LINK_STATUS ) != ( xStatus & BMSR_LINK_STATUS ) )\r
 384                         {\r
 385                                 ulPHYLinkStatus = xStatus;\r
 386                                 FreeRTOS_printf( ( "prvEMACHandlerTask: PHY LS now %d\n", ( ulPHYLinkStatus & BMSR_LINK_STATUS ) != 0 ) );\r
 387                         }\r
 388 \r
 389                         vTaskSetTimeOutState( &xPhyTime );\r
 390                         if( ( ulPHYLinkStatus & BMSR_LINK_STATUS ) != 0 )\r
 391                         {\r
 392                                 xPhyRemTime = pdMS_TO_TICKS( PHY_LS_HIGH_CHECK_TIME_MS );\r
 393                         }\r
 394                         else\r
 395                         {\r
 396                                 xPhyRemTime = pdMS_TO_TICKS( PHY_LS_LOW_CHECK_TIME_MS );\r
 397                         }\r
 398                 }\r
 399         }\r
 400 }\r
 401 /*-----------------------------------------------------------*/\r