git.sur5r.net Git - freertos/blob - FreeRTOS-Plus/Demo/Common/FreeRTOS_Plus_CLI_Demos/UARTCommandConsole.c

   1 /*\r
   2     FreeRTOS V8.2.0 - Copyright (C) 2015 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         ***************************************************************************\r
  14     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  15     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  16     >>!   obliged to provide the source code for proprietary components     !<<\r
  17     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  18         ***************************************************************************\r
  19 \r
  20     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  21     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  22     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  23     link: http://www.freertos.org/a00114.html\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    FreeRTOS provides completely free yet professionally developed,    *\r
  28      *    robust, strictly quality controlled, supported, and cross          *\r
  29      *    platform software that is more than just the market leader, it     *\r
  30      *    is the industry's de facto standard.                               *\r
  31      *                                                                       *\r
  32      *    Help yourself get started quickly while simultaneously helping     *\r
  33      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  34      *    tutorial book, reference manual, or both:                          *\r
  35      *    http://www.FreeRTOS.org/Documentation                              *\r
  36      *                                                                       *\r
  37     ***************************************************************************\r
  38 \r
  39     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
  40         the FAQ page "My application does not run, what could be wrong?".  Have you\r
  41         defined configASSERT()?\r
  42 \r
  43         http://www.FreeRTOS.org/support - In return for receiving this top quality\r
  44         embedded software for free we request you assist our global community by\r
  45         participating in the support forum.\r
  46 \r
  47         http://www.FreeRTOS.org/training - Investing in training allows your team to\r
  48         be as productive as possible as early as possible.  Now you can receive\r
  49         FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
  50         Ltd, and the world's leading authority on the world's leading RTOS.\r
  51 \r
  52     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  53     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  54     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  55 \r
  56     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  57     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  58 \r
  59     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
  60     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  61     licenses offer ticketed support, indemnification and commercial middleware.\r
  62 \r
  63     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  64     engineered and independently SIL3 certified version for use in safety and\r
  65     mission critical applications that require provable dependability.\r
  66 \r
  67     1 tab == 4 spaces!\r
  68 */\r
  69 \r
  70 /*\r
  71  * NOTE:  This file uses a third party USB CDC driver.\r
  72  */\r
  73 \r
  74 /* Standard includes. */\r
  75 #include "string.h"\r
  76 #include "stdio.h"\r
  77 \r
  78 /* FreeRTOS includes. */\r
  79 #include "FreeRTOS.h"\r
  80 #include "task.h"\r
  81 #include "semphr.h"\r
  82 \r
  83 /* Example includes. */\r
  84 #include "FreeRTOS_CLI.h"\r
  85 \r
  86 /* Demo application includes. */\r
  87 #include "serial.h"\r
  88 \r
  89 /* Dimensions the buffer into which input characters are placed. */\r
  90 #define cmdMAX_INPUT_SIZE               50\r
  91 \r
  92 #define cmdQUEUE_LENGTH                 25\r
  93 \r
  94 /* DEL acts as a backspace. */\r
  95 #define cmdASCII_DEL            ( 0x7F )\r
  96 \r
  97 #define cmdMAX_MUTEX_WAIT               ( ( ( TickType_t ) 300 ) / ( portTICK_PERIOD_MS ) )\r
  98 \r
  99 #ifndef configCLI_BAUD_RATE\r
 100         #define configCLI_BAUD_RATE     115200\r
 101 #endif\r
 102 \r
 103 /*-----------------------------------------------------------*/\r
 104 \r
 105 /*\r
 106  * The task that implements the command console processing.\r
 107  */\r
 108 static void prvUARTCommandConsoleTask( void *pvParameters );\r
 109 void vUARTCommandConsoleStart( uint16_t usStackSize, UBaseType_t uxPriority );\r
 110 \r
 111 /*-----------------------------------------------------------*/\r
 112 \r
 113 /* Const messages output by the command console. */\r
 114 static const char * const pcWelcomeMessage = "FreeRTOS command server.\r\nType Help to view a list of registered commands.\r\n\r\n>";\r
 115 static const char * const pcEndOfOutputMessage = "\r\n[Press ENTER to execute the previous command again]\r\n>";\r
 116 static const char * const pcNewLine = "\r\n";\r
 117 \r
 118 SemaphoreHandle_t xTxMutex = NULL;\r
 119 static xComPortHandle xPort = 0;\r
 120 \r
 121 /*-----------------------------------------------------------*/\r
 122 \r
 123 void vUARTCommandConsoleStart( uint16_t usStackSize, UBaseType_t uxPriority )\r
 124 {\r
 125         /* Create the semaphore used to access the UART Tx. */\r
 126         xTxMutex = xSemaphoreCreateMutex();\r
 127         configASSERT( xTxMutex );\r
 128 \r
 129         /* Create that task that handles the console itself. */\r
 130         xTaskCreate(    prvUARTCommandConsoleTask,      /* The task that implements the command console. */\r
 131                                         "CLI",                                          /* Text name assigned to the task.  This is just to assist debugging.  The kernel does not use this name itself. */\r
 132                                         usStackSize,                            /* The size of the stack allocated to the task. */\r
 133                                         NULL,                                           /* The parameter is not used, so NULL is passed. */\r
 134                                         uxPriority,                                     /* The priority allocated to the task. */\r
 135                                         NULL );                                         /* A handle is not required, so just pass NULL. */\r
 136 }\r
 137 /*-----------------------------------------------------------*/\r
 138 \r
 139 static void prvUARTCommandConsoleTask( void *pvParameters )\r
 140 {\r
 141 signed char cRxedChar;\r
 142 uint8_t ucInputIndex = 0;\r
 143 char *pcOutputString;\r
 144 static char cInputString[ cmdMAX_INPUT_SIZE ], cLastInputString[ cmdMAX_INPUT_SIZE ];\r
 145 BaseType_t xReturned;\r
 146 xComPortHandle xPort;\r
 147 \r
 148         ( void ) pvParameters;\r
 149 \r
 150         /* Obtain the address of the output buffer.  Note there is no mutual\r
 151         exclusion on this buffer as it is assumed only one command console interface\r
 152         will be used at any one time. */\r
 153         pcOutputString = FreeRTOS_CLIGetOutputBuffer();\r
 154 \r
 155         /* Initialise the UART. */\r
 156         xPort = xSerialPortInitMinimal( configCLI_BAUD_RATE, cmdQUEUE_LENGTH );\r
 157 \r
 158         /* Send the welcome message. */\r
 159         vSerialPutString( xPort, ( signed char * ) pcWelcomeMessage, strlen( pcWelcomeMessage ) );\r
 160 \r
 161         for( ;; )\r
 162         {\r
 163                 /* Wait for the next character.  The while loop is used in case\r
 164                 INCLUDE_vTaskSuspend is not set to 1 - in which case portMAX_DELAY will\r
 165                 be a genuine block time rather than an infinite block time. */\r
 166                 while( xSerialGetChar( xPort, &cRxedChar, portMAX_DELAY ) != pdPASS );\r
 167 \r
 168                 /* Ensure exclusive access to the UART Tx. */\r
 169                 if( xSemaphoreTake( xTxMutex, cmdMAX_MUTEX_WAIT ) == pdPASS )\r
 170                 {\r
 171                         /* Echo the character back. */\r
 172                         xSerialPutChar( xPort, cRxedChar, portMAX_DELAY );\r
 173 \r
 174                         /* Was it the end of the line? */\r
 175                         if( cRxedChar == '\n' || cRxedChar == '\r' )\r
 176                         {\r
 177                                 /* Just to space the output from the input. */\r
 178                                 vSerialPutString( xPort, ( signed char * ) pcNewLine, strlen( pcNewLine ) );\r
 179 \r
 180                                 /* See if the command is empty, indicating that the last command\r
 181                                 is to be executed again. */\r
 182                                 if( ucInputIndex == 0 )\r
 183                                 {\r
 184                                         /* Copy the last command back into the input string. */\r
 185                                         strcpy( cInputString, cLastInputString );\r
 186                                 }\r
 187 \r
 188                                 /* Pass the received command to the command interpreter.  The\r
 189                                 command interpreter is called repeatedly until it returns\r
 190                                 pdFALSE (indicating there is no more output) as it might\r
 191                                 generate more than one string. */\r
 192                                 do\r
 193                                 {\r
 194                                         /* Get the next output string from the command interpreter. */\r
 195                                         xReturned = FreeRTOS_CLIProcessCommand( cInputString, pcOutputString, configCOMMAND_INT_MAX_OUTPUT_SIZE );\r
 196 \r
 197                                         /* Write the generated string to the UART. */\r
 198                                         vSerialPutString( xPort, ( signed char * ) pcOutputString, strlen( pcOutputString ) );\r
 199 \r
 200                                 } while( xReturned != pdFALSE );\r
 201 \r
 202                                 /* All the strings generated by the input command have been\r
 203                                 sent.  Clear the input string ready to receive the next command.\r
 204                                 Remember the command that was just processed first in case it is\r
 205                                 to be processed again. */\r
 206                                 strcpy( cLastInputString, cInputString );\r
 207                                 ucInputIndex = 0;\r
 208                                 memset( cInputString, 0x00, cmdMAX_INPUT_SIZE );\r
 209 \r
 210                                 vSerialPutString( xPort, ( signed char * ) pcEndOfOutputMessage, strlen( pcEndOfOutputMessage ) );\r
 211                         }\r
 212                         else\r
 213                         {\r
 214                                 if( cRxedChar == '\r' )\r
 215                                 {\r
 216                                         /* Ignore the character. */\r
 217                                 }\r
 218                                 else if( ( cRxedChar == '\b' ) || ( cRxedChar == cmdASCII_DEL ) )\r
 219                                 {\r
 220                                         /* Backspace was pressed.  Erase the last character in the\r
 221                                         string - if any. */\r
 222                                         if( ucInputIndex > 0 )\r
 223                                         {\r
 224                                                 ucInputIndex--;\r
 225                                                 cInputString[ ucInputIndex ] = '\0';\r
 226                                         }\r
 227                                 }\r
 228                                 else\r
 229                                 {\r
 230                                         /* A character was entered.  Add it to the string entered so\r
 231                                         far.  When a \n is entered the complete string will be\r
 232                                         passed to the command interpreter. */\r
 233                                         if( ( cRxedChar >= ' ' ) && ( cRxedChar <= '~' ) )\r
 234                                         {\r
 235                                                 if( ucInputIndex < cmdMAX_INPUT_SIZE )\r
 236                                                 {\r
 237                                                         cInputString[ ucInputIndex ] = cRxedChar;\r
 238                                                         ucInputIndex++;\r
 239                                                 }\r
 240                                         }\r
 241                                 }\r
 242                         }\r
 243 \r
 244                         /* Must ensure to give the mutex back. */\r
 245                         xSemaphoreGive( xTxMutex );\r
 246                 }\r
 247         }\r
 248 }\r
 249 /*-----------------------------------------------------------*/\r
 250 \r
 251 void vOutputString( const char * const pcMessage )\r
 252 {\r
 253         if( xSemaphoreTake( xTxMutex, cmdMAX_MUTEX_WAIT ) == pdPASS )\r
 254         {\r
 255                 vSerialPutString( xPort, ( signed char * ) pcMessage, strlen( pcMessage ) );\r
 256                 xSemaphoreGive( xTxMutex );\r
 257         }\r
 258 }\r
 259 /*-----------------------------------------------------------*/\r
 260 \r