git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_LM3Sxxxx_Rowley/webserver/emac.c

   1 /*\r
   2     FreeRTOS V8.2.3 - Copyright (C) 2015 Real Time Engineers Ltd.\r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     This file is part of the FreeRTOS distribution.\r
   8 \r
   9     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  10     the terms of the GNU General Public License (version 2) as published by the\r
  11     Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.\r
  12 \r
  13     ***************************************************************************\r
  14     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  15     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  16     >>!   obliged to provide the source code for proprietary components     !<<\r
  17     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  18     ***************************************************************************\r
  19 \r
  20     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  21     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  22     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  23     link: http://www.freertos.org/a00114.html\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    FreeRTOS provides completely free yet professionally developed,    *\r
  28      *    robust, strictly quality controlled, supported, and cross          *\r
  29      *    platform software that is more than just the market leader, it     *\r
  30      *    is the industry's de facto standard.                               *\r
  31      *                                                                       *\r
  32      *    Help yourself get started quickly while simultaneously helping     *\r
  33      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  34      *    tutorial book, reference manual, or both:                          *\r
  35      *    http://www.FreeRTOS.org/Documentation                              *\r
  36      *                                                                       *\r
  37     ***************************************************************************\r
  38 \r
  39     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
  40     the FAQ page "My application does not run, what could be wrong?".  Have you\r
  41     defined configASSERT()?\r
  42 \r
  43     http://www.FreeRTOS.org/support - In return for receiving this top quality\r
  44     embedded software for free we request you assist our global community by\r
  45     participating in the support forum.\r
  46 \r
  47     http://www.FreeRTOS.org/training - Investing in training allows your team to\r
  48     be as productive as possible as early as possible.  Now you can receive\r
  49     FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
  50     Ltd, and the world's leading authority on the world's leading RTOS.\r
  51 \r
  52     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  53     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  54     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  55 \r
  56     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  57     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  58 \r
  59     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
  60     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  61     licenses offer ticketed support, indemnification and commercial middleware.\r
  62 \r
  63     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  64     engineered and independently SIL3 certified version for use in safety and\r
  65     mission critical applications that require provable dependability.\r
  66 \r
  67     1 tab == 4 spaces!\r
  68 */\r
  69 \r
  70 /* Kernel includes. */\r
  71 #include "FreeRTOS.h"\r
  72 #include "semphr.h"\r
  73 #include "task.h"\r
  74 \r
  75 /* Demo includes. */\r
  76 #include "emac.h"\r
  77 \r
  78 /* uIP includes. */\r
  79 #include "uip.h"\r
  80 \r
  81 /* Hardware library includes. */\r
  82 #include "hw_types.h"\r
  83 #include "hw_memmap.h"\r
  84 #include "hw_ints.h"\r
  85 #include "hw_ethernet.h"\r
  86 #include "ethernet.h"\r
  87 #include "interrupt.h"\r
  88 \r
  89 #define emacNUM_RX_BUFFERS              5\r
  90 #define emacFRAM_SIZE_BYTES     2\r
  91 #define macNEGOTIATE_DELAY              2000\r
  92 #define macWAIT_SEND_TIME               ( 10 )\r
  93 \r
  94 /* The task that handles the MAC peripheral.  This is created at a high\r
  95 priority and is effectively a deferred interrupt handler.  The peripheral\r
  96 handling is deferred to a task to prevent the entire FIFO having to be read\r
  97 from within an ISR. */\r
  98 void vMACHandleTask( void *pvParameters );\r
  99 \r
 100 /*-----------------------------------------------------------*/\r
 101 \r
 102 /* The semaphore used to wake the uIP task when data arrives. */\r
 103 SemaphoreHandle_t xEMACSemaphore = NULL;\r
 104 \r
 105 /* The semaphore used to wake the interrupt handler task.  The peripheral\r
 106 is processed at the task level to prevent the need to read the entire FIFO from\r
 107 within the ISR itself. */\r
 108 SemaphoreHandle_t xMACInterruptSemaphore = NULL;\r
 109 \r
 110 /* The buffer used by the uIP stack.  In this case the pointer is used to\r
 111 point to one of the Rx buffers. */\r
 112 unsigned char *uip_buf;\r
 113 \r
 114 /* Buffers into which Rx data is placed. */\r
 115 static unsigned char ucRxBuffers[ emacNUM_RX_BUFFERS ][ UIP_BUFSIZE + ( 4 * emacFRAM_SIZE_BYTES ) ] __attribute__((aligned(4)));\r
 116 \r
 117 /* The length of the data within each of the Rx buffers. */\r
 118 static unsigned long ulRxLength[ emacNUM_RX_BUFFERS ];\r
 119 \r
 120 /* Used to keep a track of the number of bytes to transmit. */\r
 121 static unsigned long ulNextTxSpace;\r
 122 \r
 123 /*-----------------------------------------------------------*/\r
 124 \r
 125 portBASE_TYPE vInitEMAC( void )\r
 126 {\r
 127 unsigned long ulTemp;\r
 128 portBASE_TYPE xReturn;\r
 129 \r
 130         /* Ensure all interrupts are disabled. */\r
 131         EthernetIntDisable( ETH_BASE, ( ETH_INT_PHY | ETH_INT_MDIO | ETH_INT_RXER | ETH_INT_RXOF | ETH_INT_TX | ETH_INT_TXER | ETH_INT_RX));\r
 132 \r
 133         /* Clear any interrupts that were already pending. */\r
 134     ulTemp = EthernetIntStatus( ETH_BASE, pdFALSE );\r
 135     EthernetIntClear( ETH_BASE, ulTemp );\r
 136 \r
 137         /* Initialise the MAC and connect. */\r
 138     EthernetInit( ETH_BASE );\r
 139     EthernetConfigSet( ETH_BASE, ( ETH_CFG_TX_DPLXEN | ETH_CFG_TX_CRCEN | ETH_CFG_TX_PADEN ) );\r
 140     EthernetEnable( ETH_BASE );\r
 141 \r
 142         /* Mark each Rx buffer as empty. */\r
 143         for( ulTemp = 0; ulTemp < emacNUM_RX_BUFFERS; ulTemp++ )\r
 144         {\r
 145                 ulRxLength[ ulTemp ] = 0;\r
 146         }\r
 147 \r
 148         /* Create the queue and task used to defer the MAC processing to the\r
 149         task level. */\r
 150         vSemaphoreCreateBinary( xMACInterruptSemaphore );\r
 151         xSemaphoreTake( xMACInterruptSemaphore, 0 );\r
 152         xReturn = xTaskCreate( vMACHandleTask, "MAC", configMINIMAL_STACK_SIZE, NULL, configMAX_PRIORITIES - 1, NULL );\r
 153         vTaskDelay( macNEGOTIATE_DELAY );\r
 154 \r
 155         /* We are only interested in Rx interrupts. */\r
 156         IntPrioritySet( INT_ETH, configKERNEL_INTERRUPT_PRIORITY );\r
 157     IntEnable( INT_ETH );\r
 158     EthernetIntEnable(ETH_BASE, ETH_INT_RX);\r
 159 \r
 160         return xReturn;\r
 161 }\r
 162 /*-----------------------------------------------------------*/\r
 163 \r
 164 unsigned int uiGetEMACRxData( unsigned char *ucBuffer )\r
 165 {\r
 166 static unsigned long ulNextRxBuffer = 0;\r
 167 unsigned int iLen;\r
 168 \r
 169         iLen = ulRxLength[ ulNextRxBuffer ];\r
 170 \r
 171         if( iLen != 0 )\r
 172         {\r
 173                 /* Leave room for the size at the start of the buffer. */\r
 174                 uip_buf = &( ucRxBuffers[ ulNextRxBuffer ][ 2 ] );\r
 175 \r
 176                 ulRxLength[ ulNextRxBuffer ] = 0;\r
 177 \r
 178                 ulNextRxBuffer++;\r
 179                 if( ulNextRxBuffer >= emacNUM_RX_BUFFERS )\r
 180                 {\r
 181                         ulNextRxBuffer = 0;\r
 182                 }\r
 183         }\r
 184 \r
 185     return iLen;\r
 186 }\r
 187 /*-----------------------------------------------------------*/\r
 188 \r
 189 void vInitialiseSend( void )\r
 190 {\r
 191         /* Set the index to the first byte to send - skipping over the size\r
 192         bytes. */\r
 193         ulNextTxSpace = 2;\r
 194 }\r
 195 /*-----------------------------------------------------------*/\r
 196 \r
 197 void vIncrementTxLength( unsigned long ulLength )\r
 198 {\r
 199         ulNextTxSpace += ulLength;\r
 200 }\r
 201 /*-----------------------------------------------------------*/\r
 202 \r
 203 void vSendBufferToMAC( void )\r
 204 {\r
 205 unsigned long *pulSource;\r
 206 unsigned short * pus;\r
 207 unsigned long ulNextWord;\r
 208 \r
 209         /* Locate the data to be send. */\r
 210         pus = ( unsigned short * ) uip_buf;\r
 211 \r
 212         /* Add in the size of the data. */\r
 213         pus--;\r
 214         *pus = ulNextTxSpace;\r
 215 \r
 216         /* Wait for data to be sent if there is no space immediately. */\r
 217     while( !EthernetSpaceAvail( ETH_BASE ) )\r
 218     {\r
 219                 vTaskDelay( macWAIT_SEND_TIME );\r
 220     }\r
 221 \r
 222         pulSource = ( unsigned long * ) pus;\r
 223 \r
 224         for( ulNextWord = 0; ulNextWord < ulNextTxSpace; ulNextWord += sizeof( unsigned long ) )\r
 225         {\r
 226         HWREG(ETH_BASE + MAC_O_DATA) = *pulSource;\r
 227                 pulSource++;\r
 228         }\r
 229 \r
 230         /* Go. */\r
 231     HWREG( ETH_BASE + MAC_O_TR ) = MAC_TR_NEWTX;\r
 232 }\r
 233 /*-----------------------------------------------------------*/\r
 234 \r
 235 void vEMAC_ISR( void )\r
 236 {\r
 237 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 238 unsigned long ulTemp;\r
 239 \r
 240         /* Clear the interrupt. */\r
 241         ulTemp = EthernetIntStatus( ETH_BASE, pdFALSE );\r
 242         EthernetIntClear( ETH_BASE, ulTemp );\r
 243 \r
 244         /* Was it an Rx interrupt? */\r
 245         if( ulTemp & ETH_INT_RX )\r
 246         {\r
 247                 xSemaphoreGiveFromISR( xMACInterruptSemaphore, &xHigherPriorityTaskWoken );\r
 248                 EthernetIntDisable( ETH_BASE, ETH_INT_RX );\r
 249         }\r
 250 \r
 251     /* Switch to the uIP task. */\r
 252         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 253 }\r
 254 /*-----------------------------------------------------------*/\r
 255 \r
 256 void vMACHandleTask( void *pvParameters )\r
 257 {\r
 258 unsigned long i;\r
 259 unsigned long ulLength, ulInt;\r
 260 unsigned long *pulBuffer;\r
 261 static unsigned long ulNextRxBuffer = 0;\r
 262 \r
 263         for( ;; )\r
 264         {\r
 265                 /* Wait for something to do. */\r
 266                 xSemaphoreTake( xMACInterruptSemaphore, portMAX_DELAY );\r
 267 \r
 268                 while( ( ulInt = ( EthernetIntStatus( ETH_BASE, pdFALSE ) & ETH_INT_RX ) ) != 0 )\r
 269                 {\r
 270                         ulLength = HWREG( ETH_BASE + MAC_O_DATA );\r
 271 \r
 272                         /* Leave room at the start of the buffer for the size. */\r
 273                         pulBuffer = ( unsigned long * ) &( ucRxBuffers[ ulNextRxBuffer ][ 2 ] );\r
 274                         *pulBuffer = ( ulLength >> 16 );\r
 275 \r
 276                         /* Get the size of the data. */\r
 277                         pulBuffer = ( unsigned long * ) &( ucRxBuffers[ ulNextRxBuffer ][ 4 ] );\r
 278                         ulLength &= 0xFFFF;\r
 279 \r
 280                         if( ulLength > 4 )\r
 281                         {\r
 282                                 ulLength -= 4;\r
 283 \r
 284                                 if( ulLength >= UIP_BUFSIZE )\r
 285                                 {\r
 286                                         /* The data won't fit in our buffer.  Ensure we don't\r
 287                                         try to write into the buffer. */\r
 288                                         ulLength = 0;\r
 289                                 }\r
 290 \r
 291                                 /* Read out the data into our buffer. */\r
 292                                 for( i = 0; i < ulLength; i += sizeof( unsigned long ) )\r
 293                                 {\r
 294                                         *pulBuffer = HWREG( ETH_BASE + MAC_O_DATA );\r
 295                                         pulBuffer++;\r
 296                                 }\r
 297 \r
 298                                 /* Store the length of the data into the separate array. */\r
 299                                 ulRxLength[ ulNextRxBuffer ] = ulLength;\r
 300 \r
 301                                 /* Use the next buffer the next time through. */\r
 302                                 ulNextRxBuffer++;\r
 303                                 if( ulNextRxBuffer >= emacNUM_RX_BUFFERS )\r
 304                                 {\r
 305                                         ulNextRxBuffer = 0;\r
 306                                 }\r
 307 \r
 308                                 /* Ensure the uIP task is not blocked as data has arrived. */\r
 309                                 xSemaphoreGive( xEMACSemaphore );\r
 310                         }\r
 311                 }\r
 312 \r
 313                 EthernetIntEnable( ETH_BASE, ETH_INT_RX );\r
 314         }\r
 315 }\r
 316 \r