git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_SmartFusion2_M2S050_SoftConsole/RTOSDemo/Full-Demo/Sample-CLI-commands.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  /******************************************************************************\r
  97  *\r
  98  * See the following URL for information on the commands defined in this file:\r
  99  * http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_UDP/Embedded_Ethernet_Examples/Ethernet_Related_CLI_Commands.shtml\r
 100  *\r
 101  ******************************************************************************/\r
 102 \r
 103 \r
 104 /* FreeRTOS includes. */\r
 105 #include "FreeRTOS.h"\r
 106 #include "task.h"\r
 107 \r
 108 /* Standard includes. */\r
 109 #include <stdint.h>\r
 110 #include <stdio.h>\r
 111 #include <string.h>\r
 112 \r
 113 /* FreeRTOS+CLI includes. */\r
 114 #include "FreeRTOS_CLI.h"\r
 115 \r
 116 #ifndef  configINCLUDE_TRACE_RELATED_CLI_COMMANDS\r
 117         #define configINCLUDE_TRACE_RELATED_CLI_COMMANDS 0\r
 118 #endif\r
 119 \r
 120 \r
 121 /*\r
 122  * Implements the run-time-stats command.\r
 123  */\r
 124 static portBASE_TYPE prvTaskStatsCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );\r
 125 \r
 126 /*\r
 127  * Implements the task-stats command.\r
 128  */\r
 129 static portBASE_TYPE prvRunTimeStatsCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );\r
 130 \r
 131 /*\r
 132  * Implements the echo-three-parameters command.\r
 133  */\r
 134 static portBASE_TYPE prvThreeParameterEchoCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );\r
 135 \r
 136 /*\r
 137  * Implements the echo-parameters command.\r
 138  */\r
 139 static portBASE_TYPE prvParameterEchoCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );\r
 140 \r
 141 /*\r
 142  * Implements the "trace start" and "trace stop" commands;\r
 143  */\r
 144 #if configINCLUDE_TRACE_RELATED_CLI_COMMANDS == 1\r
 145         static portBASE_TYPE prvStartStopTraceCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );\r
 146 #endif\r
 147 \r
 148 /* Structure that defines the "run-time-stats" command line command.   This\r
 149 generates a table that shows how much run time each task has */\r
 150 static const CLI_Command_Definition_t xRunTimeStats =\r
 151 {\r
 152         "run-time-stats", /* The command string to type. */\r
 153         "\r\nrun-time-stats:\r\n Displays a table showing how much processing time each FreeRTOS task has used\r\n",\r
 154         prvRunTimeStatsCommand, /* The function to run. */\r
 155         0 /* No parameters are expected. */\r
 156 };\r
 157 \r
 158 /* Structure that defines the "task-stats" command line command.  This generates\r
 159 a table that gives information on each task in the system. */\r
 160 static const CLI_Command_Definition_t xTaskStats =\r
 161 {\r
 162         "task-stats", /* The command string to type. */\r
 163         "\r\ntask-stats:\r\n Displays a table showing the state of each FreeRTOS task\r\n",\r
 164         prvTaskStatsCommand, /* The function to run. */\r
 165         0 /* No parameters are expected. */\r
 166 };\r
 167 \r
 168 /* Structure that defines the "echo_3_parameters" command line command.  This\r
 169 takes exactly three parameters that the command simply echos back one at a\r
 170 time. */\r
 171 static const CLI_Command_Definition_t xThreeParameterEcho =\r
 172 {\r
 173         "echo-3-parameters",\r
 174         "\r\necho-3-parameters <param1> <param2> <param3>:\r\n Expects three parameters, echos each in turn\r\n",\r
 175         prvThreeParameterEchoCommand, /* The function to run. */\r
 176         3 /* Three parameters are expected, which can take any value. */\r
 177 };\r
 178 \r
 179 /* Structure that defines the "echo_parameters" command line command.  This\r
 180 takes a variable number of parameters that the command simply echos back one at\r
 181 a time. */\r
 182 static const CLI_Command_Definition_t xParameterEcho =\r
 183 {\r
 184         "echo-parameters",\r
 185         "\r\necho-parameters <...>:\r\n Take variable number of parameters, echos each in turn\r\n",\r
 186         prvParameterEchoCommand, /* The function to run. */\r
 187         -1 /* The user can enter any number of commands. */\r
 188 };\r
 189 \r
 190 #if configINCLUDE_TRACE_RELATED_CLI_COMMANDS == 1\r
 191         /* Structure that defines the "trace" command line command.  This takes a single\r
 192         parameter, which can be either "start" or "stop". */\r
 193         static const CLI_Command_Definition_t xStartStopTrace =\r
 194         {\r
 195                 "trace",\r
 196                 "\r\ntrace [start | stop]:\r\n Starts or stops a trace recording for viewing in FreeRTOS+Trace\r\n",\r
 197                 prvStartStopTraceCommand, /* The function to run. */\r
 198                 1 /* One parameter is expected.  Valid values are "start" and "stop". */\r
 199         };\r
 200 #endif /* configINCLUDE_TRACE_RELATED_CLI_COMMANDS */\r
 201 \r
 202 /*-----------------------------------------------------------*/\r
 203 \r
 204 void vRegisterSampleCLICommands( void )\r
 205 {\r
 206         /* Register all the command line commands defined immediately above. */\r
 207         FreeRTOS_CLIRegisterCommand( &xTaskStats );\r
 208         FreeRTOS_CLIRegisterCommand( &xRunTimeStats );\r
 209         FreeRTOS_CLIRegisterCommand( &xThreeParameterEcho );\r
 210         FreeRTOS_CLIRegisterCommand( &xParameterEcho );\r
 211 \r
 212         #if( configINCLUDE_TRACE_RELATED_CLI_COMMANDS == 1 )\r
 213         {\r
 214                 FreeRTOS_CLIRegisterCommand( & xStartStopTrace );\r
 215         }\r
 216         #endif\r
 217 }\r
 218 /*-----------------------------------------------------------*/\r
 219 \r
 220 static portBASE_TYPE prvTaskStatsCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )\r
 221 {\r
 222 const char *const pcHeader = "Task          State  Priority  Stack      #\r\n************************************************\r\n";\r
 223 \r
 224         /* Remove compile time warnings about unused parameters, and check the\r
 225         write buffer is not NULL.  NOTE - for simplicity, this example assumes the\r
 226         write buffer length is adequate, so does not check for buffer overflows. */\r
 227         ( void ) pcCommandString;\r
 228         ( void ) xWriteBufferLen;\r
 229         configASSERT( pcWriteBuffer );\r
 230 \r
 231         /* Generate a table of task stats. */\r
 232         strcpy( pcWriteBuffer, pcHeader );\r
 233         vTaskList( pcWriteBuffer + strlen( pcHeader ) );\r
 234 \r
 235         /* There is no more data to return after this single string, so return\r
 236         pdFALSE. */\r
 237         return pdFALSE;\r
 238 }\r
 239 /*-----------------------------------------------------------*/\r
 240 \r
 241 static portBASE_TYPE prvRunTimeStatsCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )\r
 242 {\r
 243 const char * const pcHeader = "Task            Abs Time      % Time\r\n****************************************\r\n";\r
 244 \r
 245         /* Remove compile time warnings about unused parameters, and check the\r
 246         write buffer is not NULL.  NOTE - for simplicity, this example assumes the\r
 247         write buffer length is adequate, so does not check for buffer overflows. */\r
 248         ( void ) pcCommandString;\r
 249         ( void ) xWriteBufferLen;\r
 250         configASSERT( pcWriteBuffer );\r
 251 \r
 252         /* Generate a table of task stats. */\r
 253         strcpy( pcWriteBuffer, pcHeader );\r
 254         vTaskGetRunTimeStats( ( char * ) pcWriteBuffer + strlen( pcHeader ) );\r
 255 \r
 256         /* There is no more data to return after this single string, so return\r
 257         pdFALSE. */\r
 258         return pdFALSE;\r
 259 }\r
 260 /*-----------------------------------------------------------*/\r
 261 \r
 262 static portBASE_TYPE prvThreeParameterEchoCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )\r
 263 {\r
 264 const char *pcParameter;\r
 265 portBASE_TYPE xParameterStringLength, xReturn;\r
 266 static portBASE_TYPE lParameterNumber = 0;\r
 267 \r
 268         /* Remove compile time warnings about unused parameters, and check the\r
 269         write buffer is not NULL.  NOTE - for simplicity, this example assumes the\r
 270         write buffer length is adequate, so does not check for buffer overflows. */\r
 271         ( void ) pcCommandString;\r
 272         ( void ) xWriteBufferLen;\r
 273         configASSERT( pcWriteBuffer );\r
 274 \r
 275         if( lParameterNumber == 0 )\r
 276         {\r
 277                 /* The first time the function is called after the command has been\r
 278                 entered just a header string is returned. */\r
 279                 sprintf( pcWriteBuffer, "The three parameters were:\r\n" );\r
 280 \r
 281                 /* Next time the function is called the first parameter will be echoed\r
 282                 back. */\r
 283                 lParameterNumber = 1L;\r
 284 \r
 285                 /* There is more data to be returned as no parameters have been echoed\r
 286                 back yet. */\r
 287                 xReturn = pdPASS;\r
 288         }\r
 289         else\r
 290         {\r
 291                 /* Obtain the parameter string. */\r
 292                 pcParameter = FreeRTOS_CLIGetParameter\r
 293                                                 (\r
 294                                                         pcCommandString,                /* The command string itself. */\r
 295                                                         lParameterNumber,               /* Return the next parameter. */\r
 296                                                         &xParameterStringLength /* Store the parameter string length. */\r
 297                                                 );\r
 298 \r
 299                 /* Sanity check something was returned. */\r
 300                 configASSERT( pcParameter );\r
 301 \r
 302                 /* Return the parameter string. */\r
 303                 memset( pcWriteBuffer, 0x00, xWriteBufferLen );\r
 304                 sprintf( pcWriteBuffer, "%d: ", ( int ) lParameterNumber );\r
 305                 strncat( pcWriteBuffer, pcParameter, xParameterStringLength );\r
 306                 strncat( pcWriteBuffer, "\r\n", strlen( "\r\n" ) );\r
 307 \r
 308                 /* If this is the last of the three parameters then there are no more\r
 309                 strings to return after this one. */\r
 310                 if( lParameterNumber == 3L )\r
 311                 {\r
 312                         /* If this is the last of the three parameters then there are no more\r
 313                         strings to return after this one. */\r
 314                         xReturn = pdFALSE;\r
 315                         lParameterNumber = 0L;\r
 316                 }\r
 317                 else\r
 318                 {\r
 319                         /* There are more parameters to return after this one. */\r
 320                         xReturn = pdTRUE;\r
 321                         lParameterNumber++;\r
 322                 }\r
 323         }\r
 324 \r
 325         return xReturn;\r
 326 }\r
 327 /*-----------------------------------------------------------*/\r
 328 \r
 329 static portBASE_TYPE prvParameterEchoCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )\r
 330 {\r
 331 const char *pcParameter;\r
 332 portBASE_TYPE xParameterStringLength, xReturn;\r
 333 static portBASE_TYPE lParameterNumber = 0;\r
 334 \r
 335         /* Remove compile time warnings about unused parameters, and check the\r
 336         write buffer is not NULL.  NOTE - for simplicity, this example assumes the\r
 337         write buffer length is adequate, so does not check for buffer overflows. */\r
 338         ( void ) pcCommandString;\r
 339         ( void ) xWriteBufferLen;\r
 340         configASSERT( pcWriteBuffer );\r
 341 \r
 342         if( lParameterNumber == 0 )\r
 343         {\r
 344                 /* The first time the function is called after the command has been\r
 345                 entered just a header string is returned. */\r
 346                 sprintf( pcWriteBuffer, "The parameters were:\r\n" );\r
 347 \r
 348                 /* Next time the function is called the first parameter will be echoed\r
 349                 back. */\r
 350                 lParameterNumber = 1L;\r
 351 \r
 352                 /* There is more data to be returned as no parameters have been echoed\r
 353                 back yet. */\r
 354                 xReturn = pdPASS;\r
 355         }\r
 356         else\r
 357         {\r
 358                 /* Obtain the parameter string. */\r
 359                 pcParameter = FreeRTOS_CLIGetParameter\r
 360                                                 (\r
 361                                                         pcCommandString,                /* The command string itself. */\r
 362                                                         lParameterNumber,               /* Return the next parameter. */\r
 363                                                         &xParameterStringLength /* Store the parameter string length. */\r
 364                                                 );\r
 365 \r
 366                 if( pcParameter != NULL )\r
 367                 {\r
 368                         /* Return the parameter string. */\r
 369                         memset( pcWriteBuffer, 0x00, xWriteBufferLen );\r
 370                         sprintf( pcWriteBuffer, "%d: ", ( int ) lParameterNumber );\r
 371                         strncat( pcWriteBuffer, pcParameter, xParameterStringLength );\r
 372                         strncat( pcWriteBuffer, "\r\n", strlen( "\r\n" ) );\r
 373 \r
 374                         /* There might be more parameters to return after this one. */\r
 375                         xReturn = pdTRUE;\r
 376                         lParameterNumber++;\r
 377                 }\r
 378                 else\r
 379                 {\r
 380                         /* No more parameters were found.  Make sure the write buffer does\r
 381                         not contain a valid string. */\r
 382                         pcWriteBuffer[ 0 ] = 0x00;\r
 383 \r
 384                         /* No more data to return. */\r
 385                         xReturn = pdFALSE;\r
 386 \r
 387                         /* Start over the next time this command is executed. */\r
 388                         lParameterNumber = 0;\r
 389                 }\r
 390         }\r
 391 \r
 392         return xReturn;\r
 393 }\r
 394 /*-----------------------------------------------------------*/\r
 395 \r
 396 #if configINCLUDE_TRACE_RELATED_CLI_COMMANDS == 1\r
 397 \r
 398         static portBASE_TYPE prvStartStopTraceCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )\r
 399         {\r
 400         const char *pcParameter;\r
 401         portBASE_TYPE lParameterStringLength;\r
 402 \r
 403                 /* Remove compile time warnings about unused parameters, and check the\r
 404                 write buffer is not NULL.  NOTE - for simplicity, this example assumes the\r
 405                 write buffer length is adequate, so does not check for buffer overflows. */\r
 406                 ( void ) pcCommandString;\r
 407                 ( void ) xWriteBufferLen;\r
 408                 configASSERT( pcWriteBuffer );\r
 409 \r
 410                 /* Obtain the parameter string. */\r
 411                 pcParameter = FreeRTOS_CLIGetParameter\r
 412                                                 (\r
 413                                                         pcCommandString,                /* The command string itself. */\r
 414                                                         1,                                              /* Return the first parameter. */\r
 415                                                         &lParameterStringLength /* Store the parameter string length. */\r
 416                                                 );\r
 417 \r
 418                 /* Sanity check something was returned. */\r
 419                 configASSERT( pcParameter );\r
 420 \r
 421                 /* There are only two valid parameter values. */\r
 422                 if( strncmp( pcParameter, "start", strlen( "start" ) ) == 0 )\r
 423                 {\r
 424                         /* Start or restart the trace. */\r
 425                         vTraceStop();\r
 426                         vTraceClear();\r
 427                         vTraceStart();\r
 428 \r
 429                         sprintf( pcWriteBuffer, "Trace recording (re)started.\r\n" );\r
 430                 }\r
 431                 else if( strncmp( pcParameter, "stop", strlen( "stop" ) ) == 0 )\r
 432                 {\r
 433                         /* End the trace, if one is running. */\r
 434                         vTraceStop();\r
 435                         sprintf( pcWriteBuffer, "Stopping trace recording.\r\n" );\r
 436                 }\r
 437                 else\r
 438                 {\r
 439                         sprintf( pcWriteBuffer, "Valid parameters are 'start' and 'stop'.\r\n" );\r
 440                 }\r
 441 \r
 442                 /* There is no more data to return after this single string, so return\r
 443                 pdFALSE. */\r
 444                 return pdFALSE;\r
 445         }\r
 446 \r
 447 #endif /* configINCLUDE_TRACE_RELATED_CLI_COMMANDS */\r