git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_A2F200_IAR_and_Keil/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 \r
 112 /* Demo includes. */\r
 113 #include "ParTest.h"\r
 114 \r
 115 /* Hardware driver includes. */\r
 116 #include "mss_ethernet_mac_regs.h"\r
 117 #include "mss_ethernet_mac.h"\r
 118 \r
 119 /* The buffer used by the uIP stack to both receive and send.  In this case,\r
 120 because the Ethernet driver has been modified to be zero copy - the uip_buf\r
 121 variable is just a pointer to an Ethernet buffer, and not a buffer in its own\r
 122 right. */\r
 123 extern unsigned char *uip_buf;\r
 124 \r
 125 /* The ARP timer and the periodic timer share a callback function, so the\r
 126 respective timer IDs are used to determine which timer actually expired.  These\r
 127 constants are assigned to the timer IDs. */\r
 128 #define uipARP_TIMER                            0\r
 129 #define uipPERIODIC_TIMER                       1\r
 130 \r
 131 /* The length of the queue used to send events from timers or the Ethernet\r
 132 driver to the uIP stack. */\r
 133 #define uipEVENT_QUEUE_LENGTH           10\r
 134 \r
 135 /* A block time of zero simply means "don't block". */\r
 136 #define uipDONT_BLOCK                           0UL\r
 137 \r
 138 /* How long to wait before attempting to connect the MAC again. */\r
 139 #define uipINIT_WAIT    ( 100 / portTICK_PERIOD_MS )\r
 140 \r
 141 /* Shortcut to the header within the Rx buffer. */\r
 142 #define xHeader ((struct uip_eth_hdr *) &uip_buf[ 0 ])\r
 143 \r
 144 /* Standard constant. */\r
 145 #define uipTOTAL_FRAME_HEADER_SIZE      54\r
 146 \r
 147 /*-----------------------------------------------------------*/\r
 148 \r
 149 /*\r
 150  * Setup the MAC address in the MAC itself, and in the uIP stack.\r
 151  */\r
 152 static void prvSetMACAddress( void );\r
 153 \r
 154 /*\r
 155  * Perform any uIP initialisation required to ready the stack for http\r
 156  * processing.\r
 157  */\r
 158 static void prvInitialise_uIP( void );\r
 159 \r
 160 /*\r
 161  * Handles Ethernet interrupt events.\r
 162  */\r
 163 static void prvEMACEventListener( unsigned long ulISREvents );\r
 164 \r
 165 /*\r
 166  * The callback function that is assigned to both the periodic timer and the\r
 167  * ARP timer.\r
 168  */\r
 169 static void prvUIPTimerCallback( TimerHandle_t xTimer );\r
 170 \r
 171 /*\r
 172  * Initialise the MAC hardware.\r
 173  */\r
 174 static void prvInitEmac( void );\r
 175 \r
 176 /*\r
 177  * Write data to the Ethener.  Note that this actually writes data twice for the\r
 178  * to get around delayed ack issues when communicating with a non real-time\r
 179  * peer (for example, a Windows machine).\r
 180  */\r
 181 void vEMACWrite( void );\r
 182 \r
 183 /*\r
 184  * Port functions required by the uIP stack.\r
 185  */\r
 186 clock_time_t clock_time( void );\r
 187 \r
 188 /*-----------------------------------------------------------*/\r
 189 \r
 190 /* The queue used to send TCP/IP events to the uIP stack. */\r
 191 QueueHandle_t xEMACEventQueue = NULL;\r
 192 \r
 193 /*-----------------------------------------------------------*/\r
 194 \r
 195 clock_time_t clock_time( void )\r
 196 {\r
 197         return xTaskGetTickCount();\r
 198 }\r
 199 /*-----------------------------------------------------------*/\r
 200 \r
 201 void vuIP_Task( void *pvParameters )\r
 202 {\r
 203 portBASE_TYPE i;\r
 204 unsigned long ulNewEvent = 0UL, ulUIP_Events = 0UL;\r
 205 long lPacketLength;\r
 206 \r
 207         /* Just to prevent compiler warnings about the unused parameter. */\r
 208         ( void ) pvParameters;\r
 209 \r
 210         /* Initialise the uIP stack, configuring for web server usage. */\r
 211         prvInitialise_uIP();\r
 212 \r
 213         /* Initialise the MAC and PHY. */\r
 214         prvInitEmac();\r
 215 \r
 216         for( ;; )\r
 217         {\r
 218                 /* Is there received data ready to be processed? */\r
 219                 lPacketLength = MSS_MAC_rx_packet();\r
 220 \r
 221                 /* Statements to be executed if data has been received on the Ethernet. */\r
 222                 if( ( lPacketLength > 0 ) && ( uip_buf != NULL ) )\r
 223                 {\r
 224                         uip_len = ( u16_t ) lPacketLength;\r
 225                         \r
 226                         /* Standard uIP loop taken from the uIP manual. */\r
 227                         if( xHeader->type == htons( UIP_ETHTYPE_IP ) )\r
 228                         {\r
 229                                 uip_arp_ipin();\r
 230                                 uip_input();\r
 231 \r
 232                                 /* If the above function invocation resulted in data that\r
 233                                 should be sent out on the network, the global variable\r
 234                                 uip_len is set to a value > 0. */\r
 235                                 if( uip_len > 0 )\r
 236                                 {\r
 237                                         uip_arp_out();\r
 238                                         vEMACWrite();\r
 239                                 }\r
 240                         }\r
 241                         else if( xHeader->type == htons( UIP_ETHTYPE_ARP ) )\r
 242                         {\r
 243                                 uip_arp_arpin();\r
 244 \r
 245                                 /* If the above function invocation resulted in data that\r
 246                                 should be sent out on the network, the global variable\r
 247                                 uip_len is set to a value > 0. */\r
 248                                 if( uip_len > 0 )\r
 249                                 {\r
 250                                         vEMACWrite();\r
 251                                 }\r
 252                         }\r
 253                 }\r
 254                 else\r
 255                 {\r
 256                         /* Clear the RX event latched in ulUIP_Events - if one was latched. */\r
 257                         ulUIP_Events &= ~uipETHERNET_RX_EVENT;\r
 258                 }\r
 259 \r
 260                 /* Statements to be executed if the TCP/IP period timer has expired. */\r
 261                 if( ( ulUIP_Events & uipPERIODIC_TIMER_EVENT ) != 0UL )\r
 262                 {\r
 263                         ulUIP_Events &= ~uipPERIODIC_TIMER_EVENT;\r
 264 \r
 265                         if( uip_buf != NULL )\r
 266                         {\r
 267                                 for( i = 0; i < UIP_CONNS; i++ )\r
 268                                 {\r
 269                                         uip_periodic( i );\r
 270         \r
 271                                         /* If the above function invocation resulted in data that\r
 272                                         should be sent out on the network, the global variable\r
 273                                         uip_len is set to a value > 0. */\r
 274                                         if( uip_len > 0 )\r
 275                                         {\r
 276                                                 uip_arp_out();\r
 277                                                 vEMACWrite();\r
 278                                         }\r
 279                                 }\r
 280                         }\r
 281                 }\r
 282 \r
 283                 /* Statements to be executed if the ARP timer has expired. */\r
 284                 if( ( ulUIP_Events & uipARP_TIMER_EVENT ) != 0 )\r
 285                 {\r
 286                         ulUIP_Events &= ~uipARP_TIMER_EVENT;\r
 287                         uip_arp_timer();\r
 288                 }\r
 289 \r
 290                 /* If all latched events have been cleared - block until another event\r
 291                 occurs. */\r
 292                 if( ulUIP_Events == pdFALSE )\r
 293                 {\r
 294                         xQueueReceive( xEMACEventQueue, &ulNewEvent, portMAX_DELAY );\r
 295                         ulUIP_Events |= ulNewEvent;\r
 296                 }\r
 297         }\r
 298 }\r
 299 /*-----------------------------------------------------------*/\r
 300 \r
 301 static void prvSetMACAddress( void )\r
 302 {\r
 303 struct uip_eth_addr xAddr;\r
 304 \r
 305         /* Configure the MAC address in the uIP stack. */\r
 306         xAddr.addr[ 0 ] = configMAC_ADDR0;\r
 307         xAddr.addr[ 1 ] = configMAC_ADDR1;\r
 308         xAddr.addr[ 2 ] = configMAC_ADDR2;\r
 309         xAddr.addr[ 3 ] = configMAC_ADDR3;\r
 310         xAddr.addr[ 4 ] = configMAC_ADDR4;\r
 311         xAddr.addr[ 5 ] = configMAC_ADDR5;\r
 312         uip_setethaddr( xAddr );\r
 313 }\r
 314 /*-----------------------------------------------------------*/\r
 315 \r
 316 static void prvInitialise_uIP( void )\r
 317 {\r
 318 uip_ipaddr_t xIPAddr;\r
 319 TimerHandle_t xARPTimer, xPeriodicTimer;\r
 320 \r
 321         uip_init();\r
 322         uip_ipaddr( &xIPAddr, configIP_ADDR0, configIP_ADDR1, configIP_ADDR2, configIP_ADDR3 );\r
 323         uip_sethostaddr( &xIPAddr );\r
 324         uip_ipaddr( &xIPAddr, configNET_MASK0, configNET_MASK1, configNET_MASK2, configNET_MASK3 );\r
 325         uip_setnetmask( &xIPAddr );\r
 326         prvSetMACAddress();\r
 327         httpd_init();\r
 328 \r
 329         /* Create the queue used to sent TCP/IP events to the uIP stack. */\r
 330         xEMACEventQueue = xQueueCreate( uipEVENT_QUEUE_LENGTH, sizeof( unsigned long ) );\r
 331 \r
 332         /* Create and start the uIP timers. */\r
 333         xARPTimer = xTimerCreate(       "ARPTimer",                                     /* Just a name that is helpful for debugging, not used by the kernel. */\r
 334                                                                 ( 10000UL / portTICK_PERIOD_MS ), /* Timer period. */\r
 335                                                                 pdTRUE, /* Autor-reload. */\r
 336                                                                 ( void * ) uipARP_TIMER,\r
 337                                                                 prvUIPTimerCallback\r
 338                                                         );\r
 339 \r
 340         xPeriodicTimer = xTimerCreate(  "PeriodicTimer",\r
 341                                                                         ( 500UL / portTICK_PERIOD_MS ),\r
 342                                                                         pdTRUE, /* Autor-reload. */\r
 343                                                                         ( void * ) uipPERIODIC_TIMER,\r
 344                                                                         prvUIPTimerCallback\r
 345                                                                 );\r
 346 \r
 347         /* Sanity check that the timers were indeed created. */\r
 348         configASSERT( xARPTimer );\r
 349         configASSERT( xPeriodicTimer );\r
 350 \r
 351         /* These commands will block indefinitely until they succeed, so there is\r
 352         no point in checking their return values. */\r
 353         xTimerStart( xARPTimer, portMAX_DELAY );\r
 354         xTimerStart( xPeriodicTimer, portMAX_DELAY );\r
 355 }\r
 356 /*-----------------------------------------------------------*/\r
 357 \r
 358 static void prvEMACEventListener( unsigned long ulISREvents )\r
 359 {\r
 360 long lHigherPriorityTaskWoken = pdFALSE;\r
 361 const unsigned long ulRxEvent = uipETHERNET_RX_EVENT;\r
 362 \r
 363         /* Sanity check that the event queue was indeed created. */\r
 364         configASSERT( xEMACEventQueue );\r
 365 \r
 366         if( ( ulISREvents & MSS_MAC_EVENT_PACKET_SEND ) != 0UL )\r
 367         {\r
 368                 /* An Ethernet Tx event has occurred. */\r
 369                 MSS_MAC_FreeTxBuffers();\r
 370         }\r
 371 \r
 372         if( ( ulISREvents & MSS_MAC_EVENT_PACKET_RECEIVED ) != 0UL )\r
 373         {\r
 374                 /* An Ethernet Rx event has occurred. */\r
 375                 xQueueSendFromISR( xEMACEventQueue, &ulRxEvent, &lHigherPriorityTaskWoken );\r
 376         }\r
 377 \r
 378         portEND_SWITCHING_ISR( lHigherPriorityTaskWoken );\r
 379 }\r
 380 /*-----------------------------------------------------------*/\r
 381 \r
 382 static void prvInitEmac( void )\r
 383 {\r
 384 const unsigned char ucPHYAddress = 1;\r
 385 \r
 386         /* Initialise the MAC and PHY hardware. */\r
 387         MSS_MAC_init( ucPHYAddress );\r
 388 \r
 389         /* Register the event listener.  The Ethernet interrupt handler will call\r
 390         this listener whenever an Rx or a Tx interrupt occurs. */\r
 391         MSS_MAC_set_callback( ( MSS_MAC_callback_t ) prvEMACEventListener );\r
 392 \r
 393     /* Setup the EMAC and the NVIC for MAC interrupts. */\r
 394     NVIC_SetPriority( EthernetMAC_IRQn, configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY );\r
 395     NVIC_EnableIRQ( EthernetMAC_IRQn );\r
 396 }\r
 397 /*-----------------------------------------------------------*/\r
 398 \r
 399 void vEMACWrite( void )\r
 400 {\r
 401 const long lMaxAttempts = 10;\r
 402 long lAttempt;\r
 403 const TickType_t xShortDelay = ( 5 / portTICK_PERIOD_MS );\r
 404 \r
 405         /* Try to send data to the Ethernet.  Keep trying for a while if data cannot\r
 406         be sent immediately.  Note that this will actually cause the data to be sent\r
 407         twice to get around delayed ACK problems when communicating with non real-\r
 408         time TCP/IP stacks (such as a Windows machine). */\r
 409         for( lAttempt = 0; lAttempt < lMaxAttempts; lAttempt++ )\r
 410         {\r
 411                 if( MSS_MAC_tx_packet( uip_len ) != 0 )\r
 412                 {\r
 413                         break;\r
 414                 }\r
 415                 else\r
 416                 {\r
 417                         vTaskDelay( xShortDelay );\r
 418                 }\r
 419         }\r
 420 }\r
 421 /*-----------------------------------------------------------*/\r
 422 \r
 423 static void prvUIPTimerCallback( TimerHandle_t xTimer )\r
 424 {\r
 425 static const unsigned long ulARPTimerExpired = uipARP_TIMER_EVENT;\r
 426 static const unsigned long ulPeriodicTimerExpired = uipPERIODIC_TIMER_EVENT;\r
 427 \r
 428         /* This is a time callback, so calls to xQueueSend() must not attempt to\r
 429         block.  As this callback is assigned to both the ARP and Periodic timers, the\r
 430         first thing to do is ascertain which timer it was that actually expired. */\r
 431         switch( ( int ) pvTimerGetTimerID( xTimer ) )\r
 432         {\r
 433                 case uipARP_TIMER               :       xQueueSend( xEMACEventQueue, &ulARPTimerExpired, uipDONT_BLOCK );\r
 434                                                                         break;\r
 435 \r
 436                 case uipPERIODIC_TIMER  :       xQueueSend( xEMACEventQueue, &ulPeriodicTimerExpired, uipDONT_BLOCK );\r
 437                                                                         break;\r
 438 \r
 439                 default                                 :       /* Should not get here. */\r
 440                                                                         break;\r
 441         }\r
 442 }\r
 443 /*-----------------------------------------------------------*/\r
 444 \r
 445 void vApplicationProcessFormInput( char *pcInputString )\r
 446 {\r
 447 char *c;\r
 448 \r
 449         /* Only interested in processing form input if this is the IO page. */\r
 450         c = strstr( pcInputString, "io.shtml" );\r
 451         \r
 452         if( c )\r
 453         {\r
 454                 /* Is there a command in the string? */\r
 455                 c = strstr( pcInputString, "?" );\r
 456             if( c )\r
 457             {\r
 458                         /* Turn the LED's on or off in accordance with the check box status. */\r
 459                         if( strstr( c, "LED0=1" ) != NULL )\r
 460                         {\r
 461                                 /* Turn the LEDs on. */\r
 462                                 vParTestSetLED( 3, 1 );\r
 463                                 vParTestSetLED( 4, 1 );\r
 464                         }\r
 465                         else\r
 466                         {\r
 467                                 /* Turn the LEDs off. */\r
 468                                 vParTestSetLED( 3, 0 );\r
 469                                 vParTestSetLED( 4, 0 );\r
 470                         }\r
 471             }\r
 472                 else\r
 473                 {\r
 474                         /* Commands to turn LEDs off are not always explicit. */\r
 475                         vParTestSetLED( 3, 0 );\r
 476                         vParTestSetLED( 4, 0 );\r
 477                 }\r
 478         }\r
 479 }\r
 480 /*-----------------------------------------------------------*/\r