git.sur5r.net Git - freertos/blob - FreeRTOS-Plus/Demo/FreeRTOS_Plus_FAT_SL_and_CLI_Windows_Simulator/UDPCommandServer.c

   1 /*\r
   2     FreeRTOS V7.4.2 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32 \r
  33     >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
  34     distribute a combined work that includes FreeRTOS without being obliged to\r
  35     provide the source code for proprietary components outside of the FreeRTOS\r
  36     kernel.\r
  37 \r
  38     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  39     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  40     FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
  41     details. You should have received a copy of the GNU General Public License\r
  42     and the FreeRTOS license exception along with FreeRTOS; if not itcan be\r
  43     viewed here: http://www.freertos.org/a00114.html and also obtained by\r
  44     writing to Real Time Engineers Ltd., contact details for whom are available\r
  45     on the FreeRTOS WEB site.\r
  46 \r
  47     1 tab == 4 spaces!\r
  48 \r
  49     ***************************************************************************\r
  50      *                                                                       *\r
  51      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  52      *    not run, what could be wrong?"                                     *\r
  53      *                                                                       *\r
  54      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  55      *                                                                       *\r
  56     ***************************************************************************\r
  57 \r
  58 \r
  59     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  60     license and Real Time Engineers Ltd. contact details.\r
  61 \r
  62     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  63     including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
  64     fully thread aware and reentrant UDP/IP stack.\r
  65 \r
  66     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  67     Integrity Systems, who sell the code with commercial support,\r
  68     indemnification and middleware, under the OpenRTOS brand.\r
  69 \r
  70     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  71     engineered and independently SIL3 certified version for use in safety and\r
  72     mission critical applications that require provable dependability.\r
  73 */\r
  74 \r
  75 \r
  76 #pragma comment( lib, "ws2_32.lib" )\r
  77 \r
  78 /* Win32 includes. */\r
  79 #include <WinSock2.h>\r
  80 \r
  81 /* FreeRTOS includes. */\r
  82 #include "FreeRTOS.h"\r
  83 #include "task.h"\r
  84 \r
  85 /* Standard includes. */\r
  86 #include <stdint.h>\r
  87 #include <stdio.h>\r
  88 \r
  89 /* FreeRTOS+CLI includes. */\r
  90 #include "FreeRTOS_CLI.h"\r
  91 \r
  92 /* Dimensions the buffer into which input characters are placed. */\r
  93 #define cmdMAX_INPUT_SIZE       60\r
  94 \r
  95 /* Dimensions the buffer into which string outputs can be placed. */\r
  96 #define cmdMAX_OUTPUT_SIZE      1024\r
  97 \r
  98 /* Dimensions the buffer passed to the recvfrom() call. */\r
  99 #define cmdSOCKET_INPUT_BUFFER_SIZE 60\r
 100 \r
 101 /* DEL acts as a backspace. */\r
 102 #define cmdASCII_DEL            ( 0x7F )\r
 103 \r
 104 /*\r
 105  * Open and configure the UDP socket.\r
 106  */\r
 107 static SOCKET prvOpenUDPSocket( void );\r
 108 \r
 109 /*-----------------------------------------------------------*/\r
 110 \r
 111 /*\r
 112  * Task that provides the input and output for the FreeRTOS+CLI command\r
 113  * interpreter.  In this case a WinSock UDP port is used for convenience as this\r
 114  * demo runs in a simulated environment on a Windows PC.  See the URL in the\r
 115  * comments within main.c for the location of the online documentation.\r
 116  */\r
 117 void vUDPCommandInterpreterTask( void *pvParameters )\r
 118 {\r
 119 long lBytes, lByte;\r
 120 signed char cInChar, cInputIndex = 0;\r
 121 static signed char cInputString[ cmdMAX_INPUT_SIZE ], cOutputString[ cmdMAX_OUTPUT_SIZE ], cLocalBuffer[ cmdSOCKET_INPUT_BUFFER_SIZE ];\r
 122 portBASE_TYPE xMoreDataToFollow;\r
 123 volatile int iErrorCode = 0;\r
 124 struct sockaddr_in xClient;\r
 125 int xClientAddressLength = sizeof( struct sockaddr_in );\r
 126 SOCKET xSocket;\r
 127 \r
 128         /* Just to prevent compiler warnings. */\r
 129         ( void ) pvParameters;\r
 130 \r
 131         /* Attempt to open the socket. */\r
 132         xSocket = prvOpenUDPSocket();\r
 133 \r
 134         if( xSocket != INVALID_SOCKET )\r
 135         {\r
 136                 for( ;; )\r
 137                 {\r
 138                         /* Wait for incoming data on the opened socket. */\r
 139                         lBytes = recvfrom( xSocket, cLocalBuffer, sizeof( cLocalBuffer ), 0, ( struct sockaddr * ) &xClient, &xClientAddressLength );\r
 140 \r
 141                         if( lBytes == SOCKET_ERROR )\r
 142                         {\r
 143                                 /* Something went wrong, but it is not handled by this simple\r
 144                                 example. */\r
 145                                 iErrorCode = WSAGetLastError();\r
 146                         }\r
 147                         else\r
 148                         {\r
 149                                 /* Process each received byte in turn. */\r
 150                                 lByte = 0;\r
 151                                 while( lByte < lBytes )\r
 152                                 {\r
 153                                         /* The next character in the input buffer. */\r
 154                                         cInChar = cLocalBuffer[ lByte ];\r
 155                                         lByte++;\r
 156 \r
 157                                         /* Newline characters are taken as the end of the command\r
 158                                         string. */\r
 159                                         if( cInChar == '\n' )\r
 160                                         {\r
 161                                                 /* Process the input string received prior to the\r
 162                                                 newline. */\r
 163                                                 do\r
 164                                                 {\r
 165                                                         /* Pass the string to FreeRTOS+CLI. */\r
 166                                                         xMoreDataToFollow = FreeRTOS_CLIProcessCommand( cInputString, cOutputString, cmdMAX_OUTPUT_SIZE );\r
 167 \r
 168                                                         /* Send the output generated by the command's\r
 169                                                         implementation. */\r
 170                                                         sendto( xSocket, cOutputString,  strlen( cOutputString ), 0, ( SOCKADDR * ) &xClient, xClientAddressLength );\r
 171 \r
 172                                                 } while( xMoreDataToFollow != pdFALSE ); /* Until the command does not generate any more output. */\r
 173 \r
 174                                                 /* All the strings generated by the command processing\r
 175                                                 have been sent.  Clear the input string ready to receive\r
 176                                                 the next command. */\r
 177                                                 cInputIndex = 0;\r
 178                                                 memset( cInputString, 0x00, cmdMAX_INPUT_SIZE );\r
 179 \r
 180                                                 /* Transmit a spacer, just to make the command console\r
 181                                                 easier to read. */\r
 182                                                 sendto( xSocket, "\r\n",  strlen( "\r\n" ), 0, ( SOCKADDR * ) &xClient, xClientAddressLength );\r
 183                                         }\r
 184                                         else\r
 185                                         {\r
 186                                                 if( cInChar == '\r' )\r
 187                                                 {\r
 188                                                         /* Ignore the character.  Newlines are used to\r
 189                                                         detect the end of the input string. */\r
 190                                                 }\r
 191                                                 else if( ( cInChar == '\b' ) || ( cInChar == cmdASCII_DEL ) )\r
 192                                                 {\r
 193                                                         /* Backspace was pressed.  Erase the last character\r
 194                                                         in the string - if any. */\r
 195                                                         if( cInputIndex > 0 )\r
 196                                                         {\r
 197                                                                 cInputIndex--;\r
 198                                                                 cInputString[ cInputIndex ] = '\0';\r
 199                                                         }\r
 200                                                 }\r
 201                                                 else\r
 202                                                 {\r
 203                                                         /* A character was entered.  Add it to the string\r
 204                                                         entered so far.  When a \n is entered the complete\r
 205                                                         string will be passed to the command interpreter. */\r
 206                                                         if( cInputIndex < cmdMAX_INPUT_SIZE )\r
 207                                                         {\r
 208                                                                 cInputString[ cInputIndex ] = cInChar;\r
 209                                                                 cInputIndex++;\r
 210                                                         }\r
 211                                                 }\r
 212                                         }\r
 213                                 }\r
 214                         }\r
 215                 }\r
 216         }\r
 217         else\r
 218         {\r
 219                 /* The socket could not be opened. */\r
 220                 vTaskDelete( NULL );\r
 221         }\r
 222 }\r
 223 /*-----------------------------------------------------------*/\r
 224 \r
 225 static SOCKET prvOpenUDPSocket( void )\r
 226 {\r
 227 WSADATA xWSAData;\r
 228 WORD wVersionRequested;\r
 229 struct sockaddr_in xServer;\r
 230 SOCKET xSocket = INVALID_SOCKET;\r
 231 \r
 232         wVersionRequested = MAKEWORD( 2, 2 );\r
 233 \r
 234         /* Prepare to use WinSock. */\r
 235         if( WSAStartup( wVersionRequested, &xWSAData ) != 0 )\r
 236         {\r
 237                 fprintf( stderr, "Could not open Windows connection.\n" );\r
 238         }\r
 239         else\r
 240         {\r
 241                 xSocket = socket( AF_INET, SOCK_DGRAM, 0 );\r
 242                 if( xSocket == INVALID_SOCKET)\r
 243                 {\r
 244                         fprintf( stderr, "Could not create socket.\n" );\r
 245                         WSACleanup();\r
 246                 }\r
 247                 else\r
 248                 {\r
 249                         /* Zero out the server structure. */\r
 250                         memset( ( void * ) &xServer, 0x00, sizeof( struct sockaddr_in ) );\r
 251 \r
 252                         /* Set family and port. */\r
 253                         xServer.sin_family = AF_INET;\r
 254                         xServer.sin_port = htons( configUDP_CLI_PORT_NUMBER );\r
 255 \r
 256                         /* Assign the loopback address */\r
 257                         xServer.sin_addr.S_un.S_un_b.s_b1 = 127;\r
 258                         xServer.sin_addr.S_un.S_un_b.s_b2 = 0;\r
 259                         xServer.sin_addr.S_un.S_un_b.s_b3 = 0;\r
 260                         xServer.sin_addr.S_un.S_un_b.s_b4 = 1;\r
 261 \r
 262                         /* Bind the address to the socket. */\r
 263                         if( bind( xSocket, ( struct sockaddr * ) &xServer, sizeof( struct sockaddr_in ) ) == -1 )\r
 264                         {\r
 265                                 fprintf( stderr, "Could not socket to port %d.\n", configUDP_CLI_PORT_NUMBER );\r
 266                                 closesocket( xSocket );\r
 267                                 xSocket = INVALID_SOCKET;\r
 268                                 WSACleanup();\r
 269                         }\r
 270                 }\r
 271         }\r
 272 \r
 273         return xSocket;\r
 274 }\r
 275 \r
 276 \r