]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS-Plus/Demo/FreeRTOS_Plus_CLI_with_Trace_Windows_Simulator/CLI-commands.c
Update version number in readiness for V10.3.0 release. Sync SVN with reviewed releas...
[freertos] / FreeRTOS-Plus / Demo / FreeRTOS_Plus_CLI_with_Trace_Windows_Simulator / CLI-commands.c
index 39e130088e9bf358656f7a6f06def17cf1476746..0a0774b1d47a8584ca52b1ddfdc6bf1cd1e356f1 100644 (file)
@@ -1,67 +1,29 @@
 /*\r
-    FreeRTOS V7.6.0 - Copyright (C) 2013 Real Time Engineers Ltd.\r
-    All rights reserved\r
-\r
-    VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
-\r
-    ***************************************************************************\r
-     *                                                                       *\r
-     *    FreeRTOS provides completely free yet professionally developed,    *\r
-     *    robust, strictly quality controlled, supported, and cross          *\r
-     *    platform software that has become a de facto standard.             *\r
-     *                                                                       *\r
-     *    Help yourself get started quickly and support the FreeRTOS         *\r
-     *    project by purchasing a FreeRTOS tutorial book, reference          *\r
-     *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
-     *                                                                       *\r
-     *    Thank you!                                                         *\r
-     *                                                                       *\r
-    ***************************************************************************\r
-\r
-    This file is part of the FreeRTOS distribution.\r
-\r
-    FreeRTOS is free software; you can redistribute it and/or modify it under\r
-    the terms of the GNU General Public License (version 2) as published by the\r
-    Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
-\r
-    >>! NOTE: The modification to the GPL is included to allow you to distribute\r
-    >>! a combined work that includes FreeRTOS without being obliged to provide\r
-    >>! the source code for proprietary components outside of the FreeRTOS\r
-    >>! kernel.\r
-\r
-    FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
-    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
-    FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
-    link: http://www.freertos.org/a00114.html\r
-\r
-    1 tab == 4 spaces!\r
-\r
-    ***************************************************************************\r
-     *                                                                       *\r
-     *    Having a problem?  Start by reading the FAQ "My application does   *\r
-     *    not run, what could be wrong?"                                     *\r
-     *                                                                       *\r
-     *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
-     *                                                                       *\r
-    ***************************************************************************\r
-\r
-    http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
-    license and Real Time Engineers Ltd. contact details.\r
-\r
-    http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
-    including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
-    compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
-\r
-    http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
-    Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
-    licenses offer ticketed support, indemnification and middleware.\r
-\r
-    http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
-    engineered and independently SIL3 certified version for use in safety and\r
-    mission critical applications that require provable dependability.\r
-\r
-    1 tab == 4 spaces!\r
-*/\r
+ * FreeRTOS Kernel V10.3.0\r
+ * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
+ *\r
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
+ * this software and associated documentation files (the "Software"), to deal in\r
+ * the Software without restriction, including without limitation the rights to\r
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
+ * the Software, and to permit persons to whom the Software is furnished to do so,\r
+ * subject to the following conditions:\r
+ *\r
+ * The above copyright notice and this permission notice shall be included in all\r
+ * copies or substantial portions of the Software.\r
+ *\r
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
+ *\r
+ * http://www.FreeRTOS.org\r
+ * http://aws.amazon.com/freertos\r
+ *\r
+ * 1 tab == 4 spaces!\r
+ */\r
 \r
 /* FreeRTOS includes. */\r
 #include "FreeRTOS.h"\r
@@ -70,9 +32,6 @@
 /* FreeRTOS+CLI includes. */\r
 #include "FreeRTOS_CLI.h"\r
 \r
-/* FreeRTOS+Trace includes. */\r
-#include "trcUser.h"\r
-\r
 /*\r
  * Writes trace data to a disk file when the trace recording is stopped.\r
  * This function will simply overwrite any trace files that already exist.\r
@@ -83,37 +42,37 @@ static void prvSaveTraceFile( void );
  * Defines a command that returns a table showing the state of each task at the\r
  * time the command is called.\r
  */\r
-static portBASE_TYPE prvTaskStatsCommand( int8_t *pcWriteBuffer, size_t xWriteBufferLen, const int8_t *pcCommandString );\r
+static BaseType_t prvTaskStatsCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );\r
 \r
 /*\r
  * Defines a command that returns a table showing how much time each task has\r
  * spent in the Running state.\r
  */\r
-static portBASE_TYPE prvRunTimeStatsCommand( int8_t *pcWriteBuffer, size_t xWriteBufferLen, const int8_t *pcCommandString );\r
+static BaseType_t prvRunTimeStatsCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );\r
 \r
 /*\r
  * Defines a command that expects exactly three parameters.  Each of the three\r
  * parameter are echoed back one at a time.\r
  */\r
-static portBASE_TYPE prvThreeParameterEchoCommand( int8_t *pcWriteBuffer, size_t xWriteBufferLen, const int8_t *pcCommandString );\r
+static BaseType_t prvThreeParameterEchoCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );\r
 \r
 /*\r
  * Defines a command that can take a variable number of parameters.  Each\r
  * parameter is echoes back one at a time.\r
  */\r
-static portBASE_TYPE prvParameterEchoCommand( int8_t *pcWriteBuffer, size_t xWriteBufferLen, const int8_t *pcCommandString );\r
+static BaseType_t prvParameterEchoCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );\r
 \r
 /*\r
  * Defines a command that starts/stops events being recorded for offline viewing\r
  * in FreeRTOS+Trace.\r
  */\r
-static portBASE_TYPE prvStartStopTraceCommand( int8_t *pcWriteBuffer, size_t xWriteBufferLen, const int8_t *pcCommandString );\r
+static BaseType_t prvStartStopTraceCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );\r
 \r
 /* Structure that defines the "run-time-stats" command line command. */\r
 static const CLI_Command_Definition_t xRunTimeStats =\r
 {\r
-       ( const int8_t * const ) "run-time-stats", /* The command string to type. */\r
-       ( const int8_t * const ) "\r\nrun-time-stats:\r\n Displays a table showing how much processing time each FreeRTOS task has used\r\n\r\n",\r
+       "run-time-stats", /* The command string to type. */\r
+       "\r\nrun-time-stats:\r\n Displays a table showing how much processing time each FreeRTOS task has used\r\n\r\n",\r
        prvRunTimeStatsCommand, /* The function to run. */\r
        0 /* No parameters are expected. */\r
 };\r
@@ -121,8 +80,8 @@ static const CLI_Command_Definition_t xRunTimeStats =
 /* Structure that defines the "task-stats" command line command. */\r
 static const CLI_Command_Definition_t xTaskStats =\r
 {\r
-       ( const int8_t * const ) "task-stats", /* The command string to type. */\r
-       ( const int8_t * const ) "\r\ntask-stats:\r\n Displays a table showing the state of each FreeRTOS task\r\n\r\n",\r
+       "task-stats", /* The command string to type. */\r
+       "\r\ntask-stats:\r\n Displays a table showing the state of each FreeRTOS task\r\n\r\n",\r
        prvTaskStatsCommand, /* The function to run. */\r
        0 /* No parameters are expected. */\r
 };\r
@@ -132,8 +91,8 @@ takes exactly three parameters that the command simply echos back one at a
 time. */\r
 static const CLI_Command_Definition_t xThreeParameterEcho =\r
 {\r
-       ( const int8_t * const ) "echo_3_parameters",\r
-       ( const int8_t * const ) "\r\necho_3_parameters <param1> <param2> <param3>:\r\n Expects three parameters, echos each in turn\r\n\r\n",\r
+       "echo_3_parameters",\r
+       "\r\necho_3_parameters <param1> <param2> <param3>:\r\n Expects three parameters, echos each in turn\r\n\r\n",\r
        prvThreeParameterEchoCommand, /* The function to run. */\r
        3 /* Three parameters are expected, which can take any value. */\r
 };\r
@@ -143,8 +102,8 @@ takes a variable number of parameters that the command simply echos back one at
 a time. */\r
 static const CLI_Command_Definition_t xParameterEcho =\r
 {\r
-       ( const int8_t * const ) "echo_parameters",\r
-       ( const int8_t * const ) "\r\necho_parameters <...>:\r\n Take variable number of parameters, echos each in turn\r\n\r\n",\r
+       "echo_parameters",\r
+       "\r\necho_parameters <...>:\r\n Take variable number of parameters, echos each in turn\r\n\r\n",\r
        prvParameterEchoCommand, /* The function to run. */\r
        -1 /* The user can enter any number of commands. */\r
 };\r
@@ -153,8 +112,8 @@ static const CLI_Command_Definition_t xParameterEcho =
 parameter, which can be either "start" or "stop". */\r
 static const CLI_Command_Definition_t xStartTrace =\r
 {\r
-       ( const int8_t * const ) "trace",\r
-       ( const int8_t * const ) "\r\ntrace [start | stop]:\r\n Starts or stops a trace recording for viewing in FreeRTOS+Trace\r\n\r\n",\r
+       "trace",\r
+       "\r\ntrace [start | stop]:\r\n Starts or stops a trace recording for viewing in FreeRTOS+Trace\r\n\r\n",\r
        prvStartStopTraceCommand, /* The function to run. */\r
        1 /* One parameter is expected.  Valid values are "start" and "stop". */\r
 };\r
@@ -172,9 +131,9 @@ void vRegisterCLICommands( void )
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-static portBASE_TYPE prvTaskStatsCommand( int8_t *pcWriteBuffer, size_t xWriteBufferLen, const int8_t *pcCommandString )\r
+static BaseType_t prvTaskStatsCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )\r
 {\r
-const int8_t *const pcHeader = ( int8_t * ) "Task          State  Priority  Stack      #\r\n************************************************\r\n";\r
+const char *const pcHeader = "Task          State  Priority  Stack     #\r\n************************************************\r\n";\r
 \r
        /* Remove compile time warnings about unused parameters, and check the\r
        write buffer is not NULL.  NOTE - for simplicity, this example assumes the\r
@@ -184,8 +143,8 @@ const int8_t *const pcHeader = ( int8_t * ) "Task          State  Priority  Stac
        configASSERT( pcWriteBuffer );\r
 \r
        /* Generate a table of task stats. */\r
-       strcpy( ( char * ) pcWriteBuffer, ( char * ) pcHeader );\r
-       vTaskList( ( char * ) pcWriteBuffer + strlen( ( char * ) pcHeader ) );\r
+       strcpy( pcWriteBuffer, pcHeader );\r
+       vTaskList( pcWriteBuffer + strlen( pcHeader ) );\r
 \r
        /* There is no more data to return after this single string, so return\r
        pdFALSE. */\r
@@ -193,9 +152,9 @@ const int8_t *const pcHeader = ( int8_t * ) "Task          State  Priority  Stac
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-static portBASE_TYPE prvRunTimeStatsCommand( int8_t *pcWriteBuffer, size_t xWriteBufferLen, const int8_t *pcCommandString )\r
+static BaseType_t prvRunTimeStatsCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )\r
 {\r
-const int8_t * const pcHeader = ( int8_t * ) "Task            Abs Time      % Time\r\n****************************************\r\n";\r
+const char * const pcHeader = "Task            Abs Time      % Time\r\n****************************************\r\n";\r
 \r
        /* Remove compile time warnings about unused parameters, and check the\r
        write buffer is not NULL.  NOTE - for simplicity, this example assumes the\r
@@ -205,8 +164,8 @@ const int8_t * const pcHeader = ( int8_t * ) "Task            Abs Time      % Ti
        configASSERT( pcWriteBuffer );\r
 \r
        /* Generate a table of task stats. */\r
-       strcpy( ( char * ) pcWriteBuffer, ( char * ) pcHeader );\r
-       vTaskGetRunTimeStats( ( char * ) pcWriteBuffer + strlen( ( char * ) pcHeader ) );\r
+       strcpy( pcWriteBuffer, pcHeader );\r
+       vTaskGetRunTimeStats( pcWriteBuffer + strlen( pcHeader ) );\r
 \r
        /* There is no more data to return after this single string, so return\r
        pdFALSE. */\r
@@ -214,11 +173,11 @@ const int8_t * const pcHeader = ( int8_t * ) "Task            Abs Time      % Ti
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-static portBASE_TYPE prvThreeParameterEchoCommand( int8_t *pcWriteBuffer, size_t xWriteBufferLen, const int8_t *pcCommandString )\r
+static BaseType_t prvThreeParameterEchoCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )\r
 {\r
-int8_t *pcParameter;\r
-portBASE_TYPE lParameterStringLength, xReturn;\r
-static portBASE_TYPE lParameterNumber = 0;\r
+const char *pcParameter;\r
+BaseType_t lParameterStringLength, xReturn;\r
+static BaseType_t lParameterNumber = 0;\r
 \r
        /* Remove compile time warnings about unused parameters, and check the\r
        write buffer is not NULL.  NOTE - for simplicity, this example assumes the\r
@@ -231,7 +190,7 @@ static portBASE_TYPE lParameterNumber = 0;
        {\r
                /* The first time the function is called after the command has been\r
                entered just a header string is returned. */\r
-               sprintf( ( char * ) pcWriteBuffer, "The three parameters were:\r\n" );\r
+               sprintf( pcWriteBuffer, "The three parameters were:\r\n" );\r
 \r
                /* Next time the function is called the first parameter will be echoed\r
                back. */\r
@@ -244,21 +203,21 @@ static portBASE_TYPE lParameterNumber = 0;
        else\r
        {\r
                /* Obtain the parameter string. */\r
-               pcParameter = ( int8_t * ) FreeRTOS_CLIGetParameter\r
-                                                                       (\r
-                                                                               pcCommandString,                /* The command string itself. */\r
-                                                                               lParameterNumber,               /* Return the next parameter. */\r
-                                                                               &lParameterStringLength /* Store the parameter string length. */\r
-                                                                       );\r
+               pcParameter = FreeRTOS_CLIGetParameter\r
+                                               (\r
+                                                       pcCommandString,                /* The command string itself. */\r
+                                                       lParameterNumber,               /* Return the next parameter. */\r
+                                                       &lParameterStringLength /* Store the parameter string length. */\r
+                                               );\r
 \r
                /* Sanity check something was returned. */\r
                configASSERT( pcParameter );\r
 \r
                /* Return the parameter string. */\r
                memset( pcWriteBuffer, 0x00, xWriteBufferLen );\r
-               sprintf( ( char * ) pcWriteBuffer, "%d: ", lParameterNumber );\r
-               strncat( ( char * ) pcWriteBuffer, ( const char * ) pcParameter, lParameterStringLength );\r
-               strncat( ( char * ) pcWriteBuffer, "\r\n", strlen( "\r\n" ) );\r
+               sprintf( pcWriteBuffer, "%d: ", lParameterNumber );\r
+               strncat( pcWriteBuffer, pcParameter, lParameterStringLength );\r
+               strncat( pcWriteBuffer, "\r\n", strlen( "\r\n" ) );\r
 \r
                /* If this is the last of the three parameters then there are no more\r
                strings to return after this one. */\r
@@ -281,11 +240,11 @@ static portBASE_TYPE lParameterNumber = 0;
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-static portBASE_TYPE prvParameterEchoCommand( int8_t *pcWriteBuffer, size_t xWriteBufferLen, const int8_t *pcCommandString )\r
+static BaseType_t prvParameterEchoCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )\r
 {\r
-int8_t *pcParameter;\r
-portBASE_TYPE lParameterStringLength, xReturn;\r
-static portBASE_TYPE lParameterNumber = 0;\r
+const char *pcParameter;\r
+BaseType_t lParameterStringLength, xReturn;\r
+static BaseType_t lParameterNumber = 0;\r
 \r
        /* Remove compile time warnings about unused parameters, and check the\r
        write buffer is not NULL.  NOTE - for simplicity, this example assumes the\r
@@ -298,7 +257,7 @@ static portBASE_TYPE lParameterNumber = 0;
        {\r
                /* The first time the function is called after the command has been\r
                entered just a header string is returned. */\r
-               sprintf( ( char * ) pcWriteBuffer, "The parameters were:\r\n" );\r
+               sprintf( pcWriteBuffer, "The parameters were:\r\n" );\r
 \r
                /* Next time the function is called the first parameter will be echoed\r
                back. */\r
@@ -311,20 +270,20 @@ static portBASE_TYPE lParameterNumber = 0;
        else\r
        {\r
                /* Obtain the parameter string. */\r
-               pcParameter = ( int8_t * ) FreeRTOS_CLIGetParameter\r
-                                                                       (\r
-                                                                               pcCommandString,                /* The command string itself. */\r
-                                                                               lParameterNumber,               /* Return the next parameter. */\r
-                                                                               &lParameterStringLength /* Store the parameter string length. */\r
-                                                                       );\r
+               pcParameter = FreeRTOS_CLIGetParameter\r
+                                               (\r
+                                                       pcCommandString,                /* The command string itself. */\r
+                                                       lParameterNumber,               /* Return the next parameter. */\r
+                                                       &lParameterStringLength /* Store the parameter string length. */\r
+                                               );\r
 \r
                if( pcParameter != NULL )\r
                {\r
                        /* Return the parameter string. */\r
                        memset( pcWriteBuffer, 0x00, xWriteBufferLen );\r
-                       sprintf( ( char * ) pcWriteBuffer, "%d: ", lParameterNumber );\r
-                       strncat( ( char * ) pcWriteBuffer, ( const char * ) pcParameter, lParameterStringLength );\r
-                       strncat( ( char * ) pcWriteBuffer, "\r\n", strlen( "\r\n" ) );\r
+                       sprintf( pcWriteBuffer, "%d: ", lParameterNumber );\r
+                       strncat( pcWriteBuffer, pcParameter, lParameterStringLength );\r
+                       strncat( pcWriteBuffer, "\r\n", strlen( "\r\n" ) );\r
 \r
                        /* There might be more parameters to return after this one. */\r
                        xReturn = pdTRUE;\r
@@ -348,10 +307,10 @@ static portBASE_TYPE lParameterNumber = 0;
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-static portBASE_TYPE prvStartStopTraceCommand( int8_t *pcWriteBuffer, size_t xWriteBufferLen, const int8_t *pcCommandString )\r
+static BaseType_t prvStartStopTraceCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )\r
 {\r
-int8_t *pcParameter;\r
-portBASE_TYPE lParameterStringLength;\r
+const char *pcParameter;\r
+BaseType_t lParameterStringLength;\r
 \r
        /* Remove compile time warnings about unused parameters, and check the\r
        write buffer is not NULL.  NOTE - for simplicity, this example assumes the\r
@@ -361,36 +320,36 @@ portBASE_TYPE lParameterStringLength;
        configASSERT( pcWriteBuffer );\r
 \r
        /* Obtain the parameter string. */\r
-       pcParameter = ( int8_t * ) FreeRTOS_CLIGetParameter\r
-                                                               (\r
-                                                                       pcCommandString,                /* The command string itself. */\r
-                                                                       1,                                              /* Return the first parameter. */\r
-                                                                       &lParameterStringLength /* Store the parameter string length. */\r
-                                                               );\r
+       pcParameter = FreeRTOS_CLIGetParameter\r
+                                       (\r
+                                               pcCommandString,                /* The command string itself. */\r
+                                               1,                                              /* Return the first parameter. */\r
+                                               &lParameterStringLength /* Store the parameter string length. */\r
+                                       );\r
 \r
        /* Sanity check something was returned. */\r
        configASSERT( pcParameter );\r
 \r
        /* There are only two valid parameter values. */\r
-       if( strncmp( ( const char * ) pcParameter, "start", strlen( "start" ) ) == 0 )\r
+       if( strncmp( pcParameter, "start", strlen( "start" ) ) == 0 )\r
        {\r
                /* Start or restart the trace. */\r
                vTraceStop();\r
                vTraceClear();\r
                uiTraceStart();\r
 \r
-               sprintf( ( char * ) pcWriteBuffer, "Trace recording (re)started.\r\n" );\r
+               sprintf( pcWriteBuffer, "Trace recording (re)started.\r\n" );\r
        }\r
-       else if( strncmp( ( const char * ) pcParameter, "stop", strlen( "stop" ) ) == 0 )\r
+       else if( strncmp( pcParameter, "stop", strlen( "stop" ) ) == 0 )\r
        {\r
                /* End the trace, if one is running. */\r
                vTraceStop();\r
-               sprintf( ( char * ) pcWriteBuffer, "Stopping trace recording and dumping log to disk.\r\n" );\r
+               sprintf( pcWriteBuffer, "Stopping trace recording and dumping log to disk.\r\n" );\r
                prvSaveTraceFile();\r
        }\r
        else\r
        {\r
-               sprintf( ( char * ) pcWriteBuffer, "Valid parameters are 'start' and 'stop'.\r\n" );\r
+               sprintf( pcWriteBuffer, "Valid parameters are 'start' and 'stop'.\r\n" );\r
        }\r
 \r
        /* There is no more data to return after this single string, so return\r