]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS-Plus/Demo/FreeRTOS_Plus_FAT_SL_and_CLI_Windows_Simulator/Sample-CLI-commands.c
Update version number to 8.1.2 after moving the defaulting of configUSE_PORT_OPTIMISE...
[freertos] / FreeRTOS-Plus / Demo / FreeRTOS_Plus_FAT_SL_and_CLI_Windows_Simulator / Sample-CLI-commands.c
index 92cc1aa67f00e345ff2d3cd71e715f9a323a3947..1e1952b5019fd5df48c7db9266d504625f7ce6c5 100644 (file)
@@ -1,48 +1,38 @@
 /*\r
-    FreeRTOS V7.5.2 - Copyright (C) 2013 Real Time Engineers Ltd.\r
+    FreeRTOS V8.1.2 - Copyright (C) 2014 Real Time Engineers Ltd.\r
+    All rights reserved\r
 \r
-    FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
-    http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
+    VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
 \r
     ***************************************************************************\r
      *                                                                       *\r
-     *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
-     *    Complete, revised, and edited pdf reference manuals are also       *\r
-     *    available.                                                         *\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
-     *    Purchasing FreeRTOS documentation will not only help you, by       *\r
-     *    ensuring you get running as quickly as possible and with an        *\r
-     *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
-     *    the FreeRTOS project to continue with its mission of providing     *\r
-     *    professional grade, cross platform, de facto standard solutions    *\r
-     *    for microcontrollers - completely free of charge!                  *\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
-     *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
-     *                                                                       *\r
-     *    Thank you for using FreeRTOS, and thank you for your support!      *\r
+     *    Thank you!                                                         *\r
      *                                                                       *\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
+    Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
 \r
-    >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
-    distribute a combined work that includes FreeRTOS without being obliged to\r
-    provide the source code for proprietary components outside of the FreeRTOS\r
-    kernel.\r
+    >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
+    >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
+    >>!   obliged to provide the source code for proprietary components     !<<\r
+    >>!   outside of the FreeRTOS 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.  See the GNU General Public License for more\r
-    details. You should have received a copy of the GNU General Public License\r
-    and the FreeRTOS license exception along with FreeRTOS; if not itcan be\r
-    viewed here: http://www.freertos.org/a00114.html and also obtained by\r
-    writing to Real Time Engineers Ltd., contact details for whom are available\r
-    on the FreeRTOS WEB site.\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
 \r
-\r
-    http://www.FreeRTOS.org - Documentation, books, training, latest versions, \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, and our new\r
-    fully thread aware and reentrant UDP/IP stack.\r
-\r
-    http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High \r
-    Integrity Systems, who sell the code with commercial support, \r
-    indemnification and middleware, under the OpenRTOS brand.\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
+    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
 \r
  /******************************************************************************\r
 /*\r
  * Implements the run-time-stats command.\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
  * Implements the task-stats command.\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
  * Implements the echo-three-parameters command.\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
  * Implements the echo-parameters command.\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
  * Implements the "trace start" and "trace stop" commands;\r
  */\r
 #if configINCLUDE_TRACE_RELATED_CLI_COMMANDS == 1\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
 #endif\r
 \r
 /* Structure that defines the "run-time-stats" command line command.   This\r
 generates a table that shows how much run time each task has */\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
+       "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
        prvRunTimeStatsCommand, /* The function to run. */\r
        0 /* No parameters are expected. */\r
 };\r
@@ -138,8 +129,8 @@ static const CLI_Command_Definition_t xRunTimeStats =
 a table that gives information on each task in the system. */\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
+       "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
        prvTaskStatsCommand, /* The function to run. */\r
        0 /* No parameters are expected. */\r
 };\r
@@ -149,8 +140,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
+       "echo-3-parameters",\r
+       "\r\necho-3-parameters <param1> <param2> <param3>:\r\n Expects three parameters, echos each in turn\r\n",\r
        prvThreeParameterEchoCommand, /* The function to run. */\r
        3 /* Three parameters are expected, which can take any value. */\r
 };\r
@@ -160,8 +151,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
+       "echo-parameters",\r
+       "\r\necho-parameters <...>:\r\n Take variable number of parameters, echos each in turn\r\n",\r
        prvParameterEchoCommand, /* The function to run. */\r
        -1 /* The user can enter any number of commands. */\r
 };\r
@@ -171,8 +162,8 @@ static const CLI_Command_Definition_t xParameterEcho =
        parameter, which can be either "start" or "stop". */\r
        static const CLI_Command_Definition_t xStartStopTrace =\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
+               "trace",\r
+               "\r\ntrace [start | stop]:\r\n Starts or stops a trace recording for viewing in FreeRTOS+Trace\r\n",\r
                prvStartStopTraceCommand, /* The function to run. */\r
                1 /* One parameter is expected.  Valid values are "start" and "stop". */\r
        };\r
@@ -196,9 +187,9 @@ void vRegisterSampleCLICommands( 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
@@ -208,8 +199,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( 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
@@ -217,9 +208,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
@@ -229,8 +220,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( 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
@@ -238,11 +229,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 xParameterStringLength, xReturn;\r
-static portBASE_TYPE lParameterNumber = 0;\r
+const char *pcParameter;\r
+BaseType_t xParameterStringLength, 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
@@ -255,7 +246,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
@@ -268,21 +259,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
-                                                                               &xParameterStringLength /* Store the parameter string length. */\r
-                                                                       );\r
+               pcParameter = FreeRTOS_CLIGetParameter\r
+                                               (\r
+                                                       pcCommandString,                /* The command string itself. */\r
+                                                       lParameterNumber,               /* Return the next parameter. */\r
+                                                       &xParameterStringLength /* 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: ", ( int ) lParameterNumber );\r
-               strncat( ( char * ) pcWriteBuffer, ( const char * ) pcParameter, xParameterStringLength );\r
-               strncat( ( char * ) pcWriteBuffer, "\r\n", strlen( "\r\n" ) );\r
+               sprintf( pcWriteBuffer, "%d: ", ( int ) lParameterNumber );\r
+               strncat( pcWriteBuffer, pcParameter, xParameterStringLength );\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
@@ -305,11 +296,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 xParameterStringLength, xReturn;\r
-static portBASE_TYPE lParameterNumber = 0;\r
+const char *pcParameter;\r
+BaseType_t xParameterStringLength, 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
@@ -322,7 +313,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
@@ -335,20 +326,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
-                                                                               &xParameterStringLength /* Store the parameter string length. */\r
-                                                                       );\r
+               pcParameter = FreeRTOS_CLIGetParameter\r
+                                               (\r
+                                                       pcCommandString,                /* The command string itself. */\r
+                                                       lParameterNumber,               /* Return the next parameter. */\r
+                                                       &xParameterStringLength /* 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: ", ( int ) lParameterNumber );\r
-                       strncat( ( char * ) pcWriteBuffer, ( const char * ) pcParameter, xParameterStringLength );\r
-                       strncat( ( char * ) pcWriteBuffer, "\r\n", strlen( "\r\n" ) );\r
+                       sprintf( pcWriteBuffer, "%d: ", ( int ) lParameterNumber );\r
+                       strncat( pcWriteBuffer, pcParameter, xParameterStringLength );\r
+                       strncat( pcWriteBuffer, "\r\n", strlen( "\r\n" ) );\r
 \r
                        /* There might be more parameters to return after this one. */\r
                        xReturn = pdTRUE;\r
@@ -374,10 +365,10 @@ static portBASE_TYPE lParameterNumber = 0;
 \r
 #if configINCLUDE_TRACE_RELATED_CLI_COMMANDS == 1\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
@@ -387,35 +378,35 @@ static portBASE_TYPE lParameterNumber = 0;
                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
                        vTraceStart();\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.\r\n" );\r
+                       sprintf( pcWriteBuffer, "Stopping trace recording.\r\n" );\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