git.sur5r.net Git - freertos/blob - FreeRTOS-Plus/Demo/FreeRTOS_Plus_UDP_and_CLI_Windows_Simulator/DemoTasks/UDPCommandServer.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 <stdint.h>\r
  98 #include <stdio.h>\r
  99 \r
 100 /* FreeRTOS includes. */\r
 101 #include "FreeRTOS.h"\r
 102 #include "task.h"\r
 103 \r
 104 /* FreeRTOS+CLI includes. */\r
 105 #include "FreeRTOS_CLI.h"\r
 106 \r
 107 /* FreeRTOS+UDP includes. */\r
 108 #include "FreeRTOS_UDP_IP.h"\r
 109 #include "FreeRTOS_Sockets.h"\r
 110 \r
 111 /* Demo app includes. */\r
 112 #include "UDPCommandInterpreter.h"\r
 113 \r
 114 /* Dimensions the buffer into which input characters are placed. */\r
 115 #define cmdMAX_INPUT_SIZE       60\r
 116 \r
 117 /* Dimensions the buffer into which string outputs can be placed. */\r
 118 #define cmdMAX_OUTPUT_SIZE      1024\r
 119 \r
 120 /* Dimensions the buffer passed to the recvfrom() call. */\r
 121 #define cmdSOCKET_INPUT_BUFFER_SIZE 60\r
 122 \r
 123 /*\r
 124  * The task that runs FreeRTOS+CLI.\r
 125  */\r
 126 void vUDPCommandInterpreterTask( void *pvParameters );\r
 127 \r
 128 /*\r
 129  * Open and configure the UDP socket.\r
 130  */\r
 131 static xSocket_t prvOpenUDPServerSocket( uint16_t usPort );\r
 132 \r
 133 /*-----------------------------------------------------------*/\r
 134 \r
 135 void vStartUDPCommandInterpreterTask( uint16_t usStackSize, uint32_t ulPort, UBaseType_t uxPriority )\r
 136 {\r
 137         xTaskCreate( vUDPCommandInterpreterTask, "CLI", usStackSize, ( void * ) ulPort, uxPriority, NULL );\r
 138 }\r
 139 /*-----------------------------------------------------------*/\r
 140 \r
 141 /*\r
 142  * Task that provides the input and output for the FreeRTOS+CLI command\r
 143  * interpreter.  In this case a UDP port is used.  See the URL in the comments\r
 144  * within main.c for the location of the online documentation.\r
 145  */\r
 146 void vUDPCommandInterpreterTask( void *pvParameters )\r
 147 {\r
 148 long lBytes, lByte;\r
 149 signed char cInChar, cInputIndex = 0;\r
 150 static signed char cInputString[ cmdMAX_INPUT_SIZE ], cOutputString[ cmdMAX_OUTPUT_SIZE ], cLocalBuffer[ cmdSOCKET_INPUT_BUFFER_SIZE ];\r
 151 BaseType_t xMoreDataToFollow;\r
 152 struct freertos_sockaddr xClient;\r
 153 socklen_t xClientAddressLength = 0; /* This is required as a parameter to maintain the sendto() Berkeley sockets API - but it is not actually used so can take any value. */\r
 154 xSocket_t xSocket;\r
 155 extern const uint8_t ucIPAddress[ 4 ];\r
 156 extern const uint8_t ucMACAddress[ 6 ];\r
 157 \r
 158         /* Just to prevent compiler warnings. */\r
 159         ( void ) pvParameters;\r
 160 \r
 161         /* Attempt to open the socket.  The port number is passed in the task\r
 162         parameter.  The strange casting is to remove compiler warnings on 32-bit\r
 163         machines. */\r
 164         xSocket = prvOpenUDPServerSocket( ( uint16_t ) ( ( uint32_t ) pvParameters ) & 0xffffUL );\r
 165 \r
 166         if( xSocket != FREERTOS_INVALID_SOCKET )\r
 167         {\r
 168                 for( ;; )\r
 169                 {\r
 170                         /* Wait for incoming data on the opened socket. */\r
 171                         lBytes = FreeRTOS_recvfrom( xSocket, ( void * ) cLocalBuffer, sizeof( cLocalBuffer ), 0, &xClient, &xClientAddressLength );\r
 172 \r
 173                         if( lBytes != FREERTOS_SOCKET_ERROR )\r
 174                         {\r
 175                                 /* Process each received byte in turn. */\r
 176                                 lByte = 0;\r
 177                                 while( lByte < lBytes )\r
 178                                 {\r
 179                                         /* The next character in the input buffer. */\r
 180                                         cInChar = cLocalBuffer[ lByte ];\r
 181                                         lByte++;\r
 182 \r
 183                                         /* Newline characters are taken as the end of the command\r
 184                                         string. */\r
 185                                         if( cInChar == '\n' )\r
 186                                         {\r
 187                                                 /* Process the input string received prior to the\r
 188                                                 newline. */\r
 189                                                 do\r
 190                                                 {\r
 191                                                         /* Pass the string to FreeRTOS+CLI. */\r
 192                                                         xMoreDataToFollow = FreeRTOS_CLIProcessCommand( cInputString, cOutputString, cmdMAX_OUTPUT_SIZE );\r
 193 \r
 194                                                         /* Send the output generated by the command's\r
 195                                                         implementation. */\r
 196                                                         FreeRTOS_sendto( xSocket, cOutputString,  strlen( cOutputString ), 0, &xClient, xClientAddressLength );\r
 197 \r
 198                                                 } while( xMoreDataToFollow != pdFALSE ); /* Until the command does not generate any more output. */\r
 199 \r
 200                                                 /* All the strings generated by the command processing\r
 201                                                 have been sent.  Clear the input string ready to receive\r
 202                                                 the next command. */\r
 203                                                 cInputIndex = 0;\r
 204                                                 memset( cInputString, 0x00, cmdMAX_INPUT_SIZE );\r
 205 \r
 206                                                 /* Transmit a spacer, just to make the command console\r
 207                                                 easier to read. */\r
 208                                                 FreeRTOS_sendto( xSocket, "\r\n",  strlen( "\r\n" ), 0, &xClient, xClientAddressLength );\r
 209                                         }\r
 210                                         else\r
 211                                         {\r
 212                                                 if( cInChar == '\r' )\r
 213                                                 {\r
 214                                                         /* Ignore the character.  Newlines are used to\r
 215                                                         detect the end of the input string. */\r
 216                                                 }\r
 217                                                 else if( cInChar == '\b' )\r
 218                                                 {\r
 219                                                         /* Backspace was pressed.  Erase the last character\r
 220                                                         in the string - if any. */\r
 221                                                         if( cInputIndex > 0 )\r
 222                                                         {\r
 223                                                                 cInputIndex--;\r
 224                                                                 cInputString[ cInputIndex ] = '\0';\r
 225                                                         }\r
 226                                                 }\r
 227                                                 else\r
 228                                                 {\r
 229                                                         /* A character was entered.  Add it to the string\r
 230                                                         entered so far.  When a \n is entered the complete\r
 231                                                         string will be passed to the command interpreter. */\r
 232                                                         if( cInputIndex < cmdMAX_INPUT_SIZE )\r
 233                                                         {\r
 234                                                                 cInputString[ cInputIndex ] = cInChar;\r
 235                                                                 cInputIndex++;\r
 236                                                         }\r
 237                                                 }\r
 238                                         }\r
 239                                 }\r
 240                         }\r
 241                 }\r
 242         }\r
 243         else\r
 244         {\r
 245                 /* The socket could not be opened. */\r
 246                 vTaskDelete( NULL );\r
 247         }\r
 248 }\r
 249 /*-----------------------------------------------------------*/\r
 250 \r
 251 static xSocket_t prvOpenUDPServerSocket( uint16_t usPort )\r
 252 {\r
 253 struct freertos_sockaddr xServer;\r
 254 xSocket_t xSocket = FREERTOS_INVALID_SOCKET;\r
 255 \r
 256         xSocket = FreeRTOS_socket( FREERTOS_AF_INET, FREERTOS_SOCK_DGRAM, FREERTOS_IPPROTO_UDP );\r
 257         if( xSocket != FREERTOS_INVALID_SOCKET)\r
 258         {\r
 259                 /* Zero out the server structure. */\r
 260                 memset( ( void * ) &xServer, 0x00, sizeof( xServer ) );\r
 261 \r
 262                 /* Set family and port. */\r
 263                 xServer.sin_port = FreeRTOS_htons( usPort );\r
 264 \r
 265                 /* Bind the address to the socket. */\r
 266                 if( FreeRTOS_bind( xSocket, &xServer, sizeof( xServer ) ) == -1 )\r
 267                 {\r
 268                         FreeRTOS_closesocket( xSocket );\r
 269                         xSocket = FREERTOS_INVALID_SOCKET;\r
 270                 }\r
 271         }\r
 272 \r
 273         return xSocket;\r
 274 }\r
 275 \r
 276 \r