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