git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_Kinetis_K60_Tower_IAR/uIP_Task.c

   1 /*\r
   2     FreeRTOS V8.2.0rc1 - Copyright (C) 2014 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     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  14     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  15     >>!   obliged to provide the source code for proprietary components     !<<\r
  16     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  17 \r
  18     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  19     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  20     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  21     link: http://www.freertos.org/a00114.html\r
  22 \r
  23     1 tab == 4 spaces!\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  28      *    not run, what could be wrong?".  Have you defined configASSERT()?  *\r
  29      *                                                                       *\r
  30      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  31      *                                                                       *\r
  32     ***************************************************************************\r
  33 \r
  34     ***************************************************************************\r
  35      *                                                                       *\r
  36      *    FreeRTOS provides completely free yet professionally developed,    *\r
  37      *    robust, strictly quality controlled, supported, and cross          *\r
  38      *    platform software that is more than just the market leader, it     *\r
  39      *    is the industry's de facto standard.                               *\r
  40      *                                                                       *\r
  41      *    Help yourself get started quickly while simultaneously helping     *\r
  42      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  43      *    tutorial book, reference manual, or both:                          *\r
  44      *    http://www.FreeRTOS.org/Documentation                              *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     ***************************************************************************\r
  49      *                                                                       *\r
  50      *   Investing in training allows your team to be as productive as       *\r
  51      *   possible as early as possible, lowering your overall development    *\r
  52      *   cost, and enabling you to bring a more robust product to market     *\r
  53      *   earlier than would otherwise be possible.  Richard Barry is both    *\r
  54      *   the architect and key author of FreeRTOS, and so also the world's   *\r
  55      *   leading authority on what is the world's most popular real time     *\r
  56      *   kernel for deeply embedded MCU designs.  Obtaining your training    *\r
  57      *   from Richard ensures your team will gain directly from his in-depth *\r
  58      *   product knowledge and years of usage experience.  Contact Real Time *\r
  59      *   Engineers Ltd to enquire about the FreeRTOS Masterclass, presented  *\r
  60      *   by Richard Barry:  http://www.FreeRTOS.org/contact\r
  61      *                                                                       *\r
  62     ***************************************************************************\r
  63 \r
  64     ***************************************************************************\r
  65      *                                                                       *\r
  66      *    You are receiving this top quality software for free.  Please play *\r
  67      *    fair and reciprocate by reporting any suspected issues and         *\r
  68      *    participating in the community forum:                              *\r
  69      *    http://www.FreeRTOS.org/support                                    *\r
  70      *                                                                       *\r
  71      *    Thank you!                                                         *\r
  72      *                                                                       *\r
  73     ***************************************************************************\r
  74 \r
  75     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  76     license and Real Time Engineers Ltd. contact details.\r
  77 \r
  78     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  79     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  80     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  81 \r
  82     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  83     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  84 \r
  85     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  86     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  87     licenses offer ticketed support, indemnification and commercial middleware.\r
  88 \r
  89     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  90     engineered and independently SIL3 certified version for use in safety and\r
  91     mission critical applications that require provable dependability.\r
  92 \r
  93     1 tab == 4 spaces!\r
  94 */\r
  95 \r
  96 /* Standard includes. */\r
  97 #include <string.h>\r
  98 \r
  99 /* Scheduler includes. */\r
 100 #include "FreeRTOS.h"\r
 101 #include "task.h"\r
 102 #include "queue.h"\r
 103 #include "timers.h"\r
 104 \r
 105 /* uip includes. */\r
 106 #include "net/uip.h"\r
 107 #include "net/uip_arp.h"\r
 108 #include "apps/httpd/httpd.h"\r
 109 #include "sys/timer.h"\r
 110 #include "net/clock-arch.h"\r
 111 #include "emac.h"\r
 112 \r
 113 /* Demo includes. */\r
 114 #include "ParTest.h"\r
 115 \r
 116 /* The buffer used by the uIP stack to both receive and send.  In this case,\r
 117 because the Ethernet driver is implemented to be zero copy - the uip_buf\r
 118 variable is just a pointer to an Ethernet buffer, and not a buffer in its own\r
 119 right. */\r
 120 extern unsigned char *uip_buf;\r
 121 \r
 122 /* The ARP timer and the periodic timer share a callback function, so the\r
 123 respective timer IDs are used to determine which timer actually expired.  These\r
 124 constants are assigned to the timer IDs. */\r
 125 #define uipARP_TIMER                            0\r
 126 #define uipPERIODIC_TIMER                       1\r
 127 \r
 128 /* The length of the queue used to send events from timers or the Ethernet\r
 129 driver to the uIP stack. */\r
 130 #define uipEVENT_QUEUE_LENGTH           10\r
 131 \r
 132 /* A block time of zero simply means "don't block". */\r
 133 #define uipDONT_BLOCK                           0UL\r
 134 \r
 135 /* Shortcut to the header within the Rx buffer. */\r
 136 #define xHeader ((struct uip_eth_hdr *) &uip_buf[ 0 ])\r
 137 \r
 138 /*-----------------------------------------------------------*/\r
 139 \r
 140 /*\r
 141  * Setup the MAC address in the MAC itself, and in the uIP stack.\r
 142  */\r
 143 static void prvSetMACAddress( void );\r
 144 \r
 145 /*\r
 146  * Perform any uIP initialisation required to ready the stack for http\r
 147  * processing.\r
 148  */\r
 149 static void prvInitialise_uIP( void );\r
 150 \r
 151 /*\r
 152  * The callback function that is assigned to both the periodic timer and the\r
 153  * ARP timer.\r
 154  */\r
 155 static void prvUIPTimerCallback( TimerHandle_t xTimer );\r
 156 \r
 157 /*\r
 158  * Port functions required by the uIP stack.\r
 159  */\r
 160 clock_time_t clock_time( void );\r
 161 \r
 162 /*-----------------------------------------------------------*/\r
 163 \r
 164 /* The queue used to send TCP/IP events to the uIP stack. */\r
 165 QueueHandle_t xEMACEventQueue = NULL;\r
 166 \r
 167 /*-----------------------------------------------------------*/\r
 168 \r
 169 clock_time_t clock_time( void )\r
 170 {\r
 171         return xTaskGetTickCount();\r
 172 }\r
 173 /*-----------------------------------------------------------*/\r
 174 \r
 175 void vuIP_Task( void *pvParameters )\r
 176 {\r
 177 long i;\r
 178 unsigned long ulNewEvent = 0UL, ulUIP_Events = 0UL;\r
 179 unsigned short usPacketLength;\r
 180 \r
 181         /* Just to prevent compiler warnings about the unused parameter. */\r
 182         ( void ) pvParameters;\r
 183 \r
 184         /* Initialise the uIP stack, configuring for web server usage. */\r
 185         prvInitialise_uIP();\r
 186 \r
 187         /* Initialise the MAC and PHY. */\r
 188         vEMACInit();\r
 189 \r
 190         for( ;; )\r
 191         {\r
 192                 /* Is there received data ready to be processed? */\r
 193                 usPacketLength = usEMACRead();\r
 194 \r
 195                 /* Statements to be executed if data has been received on the Ethernet. */\r
 196                 if( ( usPacketLength > 0U ) && ( uip_buf != NULL ) )\r
 197                 {\r
 198                         uip_len = usPacketLength;\r
 199 \r
 200                         if( xHeader->type == htons( UIP_ETHTYPE_IP ) )\r
 201                         {\r
 202                                 uip_arp_ipin();\r
 203                                 uip_input();\r
 204 \r
 205                                 /* If the above function invocation resulted in data that\r
 206                                 should be sent out on the network, the global variable\r
 207                                 uip_len is set to a value > 0. */\r
 208                                 if( uip_len > 0 )\r
 209                                 {\r
 210                                         uip_arp_out();\r
 211                                         vEMACWrite();\r
 212                                 }\r
 213                         }\r
 214                         else if( xHeader->type == htons( UIP_ETHTYPE_ARP ) )\r
 215                         {\r
 216                                 uip_arp_arpin();\r
 217 \r
 218                                 /* If the above function invocation resulted in data that\r
 219                                 should be sent out on the network, the global variable\r
 220                                 uip_len is set to a value > 0. */\r
 221                                 if( uip_len > 0 )\r
 222                                 {\r
 223                                         vEMACWrite();\r
 224                                 }\r
 225                         }\r
 226                 }\r
 227                 else\r
 228                 {\r
 229                         /* Clear the RX event latched in ulUIP_Events - if one was latched. */\r
 230                         ulUIP_Events &= ~uipETHERNET_RX_EVENT;\r
 231                 }\r
 232 \r
 233                 /* Statements to be executed if the TCP/IP period timer has expired. */\r
 234                 if( ( ulUIP_Events & uipPERIODIC_TIMER_EVENT ) != 0UL )\r
 235                 {\r
 236                         ulUIP_Events &= ~uipPERIODIC_TIMER_EVENT;\r
 237 \r
 238                         if( uip_buf != NULL )\r
 239                         {\r
 240                                 for( i = 0; i < UIP_CONNS; i++ )\r
 241                                 {\r
 242                                         uip_periodic( i );\r
 243 \r
 244                                         /* If the above function invocation resulted in data that\r
 245                                         should be sent out on the network, the global variable\r
 246                                         uip_len is set to a value > 0. */\r
 247                                         if( uip_len > 0 )\r
 248                                         {\r
 249                                                 uip_arp_out();\r
 250                                                 vEMACWrite();\r
 251                                         }\r
 252                                 }\r
 253                         }\r
 254                 }\r
 255 \r
 256                 /* Statements to be executed if the ARP timer has expired. */\r
 257                 if( ( ulUIP_Events & uipARP_TIMER_EVENT ) != 0 )\r
 258                 {\r
 259                         ulUIP_Events &= ~uipARP_TIMER_EVENT;\r
 260                         uip_arp_timer();\r
 261                 }\r
 262 \r
 263                 /* If all latched events have been cleared - block until another event\r
 264                 occurs. */\r
 265                 if( ulUIP_Events == pdFALSE )\r
 266                 {\r
 267                         xQueueReceive( xEMACEventQueue, &ulNewEvent, portMAX_DELAY );\r
 268                         ulUIP_Events |= ulNewEvent;\r
 269                 }\r
 270         }\r
 271 }\r
 272 /*-----------------------------------------------------------*/\r
 273 \r
 274 static void prvSetMACAddress( void )\r
 275 {\r
 276 struct uip_eth_addr xAddr;\r
 277 \r
 278         /* Configure the MAC address in the uIP stack. */\r
 279         xAddr.addr[ 0 ] = configMAC_ADDR0;\r
 280         xAddr.addr[ 1 ] = configMAC_ADDR1;\r
 281         xAddr.addr[ 2 ] = configMAC_ADDR2;\r
 282         xAddr.addr[ 3 ] = configMAC_ADDR3;\r
 283         xAddr.addr[ 4 ] = configMAC_ADDR4;\r
 284         xAddr.addr[ 5 ] = configMAC_ADDR5;\r
 285         uip_setethaddr( xAddr );\r
 286 }\r
 287 /*-----------------------------------------------------------*/\r
 288 \r
 289 static void prvInitialise_uIP( void )\r
 290 {\r
 291 uip_ipaddr_t xIPAddr;\r
 292 TimerHandle_t xARPTimer, xPeriodicTimer;\r
 293 \r
 294         uip_init();\r
 295         uip_ipaddr( &xIPAddr, configIP_ADDR0, configIP_ADDR1, configIP_ADDR2, configIP_ADDR3 );\r
 296         uip_sethostaddr( &xIPAddr );\r
 297         uip_ipaddr( &xIPAddr, configNET_MASK0, configNET_MASK1, configNET_MASK2, configNET_MASK3 );\r
 298         uip_setnetmask( &xIPAddr );\r
 299         prvSetMACAddress();\r
 300         httpd_init();\r
 301 \r
 302         /* Create the queue used to sent TCP/IP events to the uIP stack. */\r
 303         xEMACEventQueue = xQueueCreate( uipEVENT_QUEUE_LENGTH, sizeof( unsigned long ) );\r
 304 \r
 305         /* Create and start the uIP timers. */\r
 306         xARPTimer = xTimerCreate(       "ARPTimer", /* Just a name that is helpful for debugging, not used by the kernel. */\r
 307                                                                 ( 10000UL / portTICK_PERIOD_MS ), /* Timer period. */\r
 308                                                                 pdTRUE, /* Autor-reload. */\r
 309                                                                 ( void * ) uipARP_TIMER,\r
 310                                                                 prvUIPTimerCallback\r
 311                                                         );\r
 312 \r
 313         xPeriodicTimer = xTimerCreate(  "PeriodicTimer",\r
 314                                                                         ( 500UL / portTICK_PERIOD_MS ),\r
 315                                                                         pdTRUE, /* Autor-reload. */\r
 316                                                                         ( void * ) uipPERIODIC_TIMER,\r
 317                                                                         prvUIPTimerCallback\r
 318                                                                 );\r
 319 \r
 320         /* Sanity check that the timers were indeed created. */\r
 321         configASSERT( xARPTimer );\r
 322         configASSERT( xPeriodicTimer );\r
 323         configASSERT( xEMACEventQueue );\r
 324 \r
 325         /* These commands will block indefinitely until they succeed, so there is\r
 326         no point in checking their return values. */\r
 327         xTimerStart( xARPTimer, portMAX_DELAY );\r
 328         xTimerStart( xPeriodicTimer, portMAX_DELAY );\r
 329 }\r
 330 /*-----------------------------------------------------------*/\r
 331 \r
 332 static void prvUIPTimerCallback( TimerHandle_t xTimer )\r
 333 {\r
 334 static const unsigned long ulARPTimerExpired = uipARP_TIMER_EVENT;\r
 335 static const unsigned long ulPeriodicTimerExpired = uipPERIODIC_TIMER_EVENT;\r
 336 \r
 337         /* This is a time callback, so calls to xQueueSend() must not attempt to\r
 338         block.  As this callback is assigned to both the ARP and Periodic timers, the\r
 339         first thing to do is ascertain which timer it was that actually expired. */\r
 340         switch( ( int ) pvTimerGetTimerID( xTimer ) )\r
 341         {\r
 342                 case uipARP_TIMER               :       xQueueSend( xEMACEventQueue, &ulARPTimerExpired, uipDONT_BLOCK );\r
 343                                                                         break;\r
 344 \r
 345                 case uipPERIODIC_TIMER  :       xQueueSend( xEMACEventQueue, &ulPeriodicTimerExpired, uipDONT_BLOCK );\r
 346                                                                         break;\r
 347 \r
 348                 default                                 :       /* Should not get here. */\r
 349                                                                         break;\r
 350         }\r
 351 }\r
 352 /*-----------------------------------------------------------*/\r
 353 \r
 354 void vApplicationProcessFormInput( char *pcInputString )\r
 355 {\r
 356 char *c;\r
 357 const unsigned long ulYellowLED = 2UL;\r
 358 \r
 359         /* Only interested in processing form input if this is the IO page. */\r
 360         c = strstr( pcInputString, "io.shtml" );\r
 361 \r
 362         if( c )\r
 363         {\r
 364                 /* Is there a command in the string? */\r
 365                 c = strstr( pcInputString, "?" );\r
 366             if( c )\r
 367             {\r
 368                         /* Turn the LEDs on or off in accordance with the check box status. */\r
 369                         if( strstr( c, "LED0=1" ) != NULL )\r
 370                         {\r
 371                                 /* Turn the LEDs on. */\r
 372                                 vParTestSetLED( ulYellowLED, pdTRUE );\r
 373                         }\r
 374                         else\r
 375                         {\r
 376                                 /* Turn the LEDs off. */\r
 377                                 vParTestSetLED( ulYellowLED, pdFALSE );\r
 378                         }\r
 379             }\r
 380                 else\r
 381                 {\r
 382                         /* Some browsers will only imply that a check box is off. */\r
 383                         vParTestSetLED( ulYellowLED, pdFALSE );\r
 384                 }\r
 385         }\r
 386 }\r
 387 /*-----------------------------------------------------------*/\r