2 FreeRTOS V8.2.2 - Copyright (C) 2015 Real Time Engineers Ltd.
\r
5 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 This file is part of the FreeRTOS distribution.
\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
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
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
25 ***************************************************************************
\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
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
37 ***************************************************************************
\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
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
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
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
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
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
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
71 /******************************************************************************
\r
73 * http://www.FreeRTOS.org/cli
\r
75 ******************************************************************************/
\r
78 /* FreeRTOS includes. */
\r
79 #include "FreeRTOS.h"
\r
82 /* Standard includes. */
\r
88 /* FreeRTOS+CLI includes. */
\r
89 #include "FreeRTOS_CLI.h"
\r
91 #ifndef configINCLUDE_TRACE_RELATED_CLI_COMMANDS
\r
92 #define configINCLUDE_TRACE_RELATED_CLI_COMMANDS 0
\r
95 #ifndef configINCLUDE_QUERY_HEAP_COMMAND
\r
96 #define configINCLUDE_QUERY_HEAP_COMMAND 0
\r
100 * The function that registers the commands that are defined within this file.
\r
102 void vRegisterSampleCLICommands( void );
\r
105 * Implements the task-stats command.
\r
107 static BaseType_t prvTaskStatsCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );
\r
110 * Implements the run-time-stats command.
\r
112 #if( configGENERATE_RUN_TIME_STATS == 1 )
\r
113 static BaseType_t prvRunTimeStatsCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );
\r
114 #endif /* configGENERATE_RUN_TIME_STATS */
\r
117 * Implements the echo-three-parameters command.
\r
119 static BaseType_t prvThreeParameterEchoCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );
\r
122 * Implements the echo-parameters command.
\r
124 static BaseType_t prvParameterEchoCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );
\r
127 * Implements the "query heap" command.
\r
129 #if( configINCLUDE_QUERY_HEAP_COMMAND == 1 )
\r
130 static BaseType_t prvQueryHeapCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );
\r
134 * Implements the "trace start" and "trace stop" commands;
\r
136 #if( configINCLUDE_TRACE_RELATED_CLI_COMMANDS == 1 )
\r
137 static BaseType_t prvStartStopTraceCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );
\r
140 /* Structure that defines the "task-stats" command line command. This generates
\r
141 a table that gives information on each task in the system. */
\r
142 static const CLI_Command_Definition_t xTaskStats =
\r
144 "task-stats", /* The command string to type. */
\r
145 "\r\ntask-stats:\r\n Displays a table showing the state of each FreeRTOS task\r\n",
\r
146 prvTaskStatsCommand, /* The function to run. */
\r
147 0 /* No parameters are expected. */
\r
150 /* Structure that defines the "echo_3_parameters" command line command. This
\r
151 takes exactly three parameters that the command simply echos back one at a
\r
153 static const CLI_Command_Definition_t xThreeParameterEcho =
\r
155 "echo-3-parameters",
\r
156 "\r\necho-3-parameters <param1> <param2> <param3>:\r\n Expects three parameters, echos each in turn\r\n",
\r
157 prvThreeParameterEchoCommand, /* The function to run. */
\r
158 3 /* Three parameters are expected, which can take any value. */
\r
161 /* Structure that defines the "echo_parameters" command line command. This
\r
162 takes a variable number of parameters that the command simply echos back one at
\r
164 static const CLI_Command_Definition_t xParameterEcho =
\r
167 "\r\necho-parameters <...>:\r\n Take variable number of parameters, echos each in turn\r\n",
\r
168 prvParameterEchoCommand, /* The function to run. */
\r
169 -1 /* The user can enter any number of commands. */
\r
172 #if( configGENERATE_RUN_TIME_STATS == 1 )
\r
173 /* Structure that defines the "run-time-stats" command line command. This
\r
174 generates a table that shows how much run time each task has */
\r
175 static const CLI_Command_Definition_t xRunTimeStats =
\r
177 "run-time-stats", /* The command string to type. */
\r
178 "\r\nrun-time-stats:\r\n Displays a table showing how much processing time each FreeRTOS task has used\r\n",
\r
179 prvRunTimeStatsCommand, /* The function to run. */
\r
180 0 /* No parameters are expected. */
\r
182 #endif /* configGENERATE_RUN_TIME_STATS */
\r
184 #if( configINCLUDE_QUERY_HEAP_COMMAND == 1 )
\r
185 /* Structure that defines the "query_heap" command line command. */
\r
186 static const CLI_Command_Definition_t xQueryHeap =
\r
189 "\r\nquery-heap:\r\n Displays the free heap space, and minimum ever free heap space.\r\n",
\r
190 prvQueryHeapCommand, /* The function to run. */
\r
191 0 /* The user can enter any number of commands. */
\r
193 #endif /* configQUERY_HEAP_COMMAND */
\r
195 #if configINCLUDE_TRACE_RELATED_CLI_COMMANDS == 1
\r
196 /* Structure that defines the "trace" command line command. This takes a single
\r
197 parameter, which can be either "start" or "stop". */
\r
198 static const CLI_Command_Definition_t xStartStopTrace =
\r
201 "\r\ntrace [start | stop]:\r\n Starts or stops a trace recording for viewing in FreeRTOS+Trace\r\n",
\r
202 prvStartStopTraceCommand, /* The function to run. */
\r
203 1 /* One parameter is expected. Valid values are "start" and "stop". */
\r
205 #endif /* configINCLUDE_TRACE_RELATED_CLI_COMMANDS */
\r
207 /*-----------------------------------------------------------*/
\r
209 void vRegisterSampleCLICommands( void )
\r
211 /* Register all the command line commands defined immediately above. */
\r
212 FreeRTOS_CLIRegisterCommand( &xTaskStats );
\r
213 FreeRTOS_CLIRegisterCommand( &xThreeParameterEcho );
\r
214 FreeRTOS_CLIRegisterCommand( &xParameterEcho );
\r
216 #if( configGENERATE_RUN_TIME_STATS == 1 )
\r
218 FreeRTOS_CLIRegisterCommand( &xRunTimeStats );
\r
222 #if( configINCLUDE_QUERY_HEAP_COMMAND == 1 )
\r
224 FreeRTOS_CLIRegisterCommand( &xQueryHeap );
\r
228 #if( configINCLUDE_TRACE_RELATED_CLI_COMMANDS == 1 )
\r
230 FreeRTOS_CLIRegisterCommand( &xStartStopTrace );
\r
234 /*-----------------------------------------------------------*/
\r
236 static BaseType_t prvTaskStatsCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )
\r
238 const char *const pcHeader = " State Priority Stack #\r\n************************************************\r\n";
\r
239 BaseType_t xSpacePadding;
\r
241 /* Remove compile time warnings about unused parameters, and check the
\r
242 write buffer is not NULL. NOTE - for simplicity, this example assumes the
\r
243 write buffer length is adequate, so does not check for buffer overflows. */
\r
244 ( void ) pcCommandString;
\r
245 ( void ) xWriteBufferLen;
\r
246 configASSERT( pcWriteBuffer );
\r
248 /* Generate a table of task stats. */
\r
249 strcpy( pcWriteBuffer, "Task" );
\r
250 pcWriteBuffer += strlen( pcWriteBuffer );
\r
252 /* Minus three for the null terminator and half the number of characters in
\r
253 "Task" so the column lines up with the centre of the heading. */
\r
254 configASSERT( configMAX_TASK_NAME_LEN > 3 );
\r
255 for( xSpacePadding = strlen( "Task" ); xSpacePadding < ( configMAX_TASK_NAME_LEN - 3 ); xSpacePadding++ )
\r
257 /* Add a space to align columns after the task's name. */
\r
258 *pcWriteBuffer = ' ';
\r
261 /* Ensure always terminated. */
\r
262 *pcWriteBuffer = 0x00;
\r
264 strcpy( pcWriteBuffer, pcHeader );
\r
265 vTaskList( pcWriteBuffer + strlen( pcHeader ) );
\r
267 /* There is no more data to return after this single string, so return
\r
271 /*-----------------------------------------------------------*/
\r
273 #if( configINCLUDE_QUERY_HEAP_COMMAND == 1 )
\r
275 static BaseType_t prvQueryHeapCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )
\r
277 /* Remove compile time warnings about unused parameters, and check the
\r
278 write buffer is not NULL. NOTE - for simplicity, this example assumes the
\r
279 write buffer length is adequate, so does not check for buffer overflows. */
\r
280 ( void ) pcCommandString;
\r
281 ( void ) xWriteBufferLen;
\r
282 configASSERT( pcWriteBuffer );
\r
284 sprintf( pcWriteBuffer, "Current free heap %d bytes, minimum ever free heap %d bytes\r\n", ( int ) xPortGetFreeHeapSize(), ( int ) xPortGetMinimumEverFreeHeapSize() );
\r
286 /* There is no more data to return after this single string, so return
\r
291 #endif /* configINCLUDE_QUERY_HEAP */
\r
292 /*-----------------------------------------------------------*/
\r
294 #if( configGENERATE_RUN_TIME_STATS == 1 )
\r
296 static BaseType_t prvRunTimeStatsCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )
\r
298 const char * const pcHeader = " Abs Time % Time\r\n****************************************\r\n";
\r
299 BaseType_t xSpacePadding;
\r
301 /* Remove compile time warnings about unused parameters, and check the
\r
302 write buffer is not NULL. NOTE - for simplicity, this example assumes the
\r
303 write buffer length is adequate, so does not check for buffer overflows. */
\r
304 ( void ) pcCommandString;
\r
305 ( void ) xWriteBufferLen;
\r
306 configASSERT( pcWriteBuffer );
\r
308 /* Generate a table of task stats. */
\r
309 strcpy( pcWriteBuffer, "Task" );
\r
310 pcWriteBuffer += strlen( pcWriteBuffer );
\r
312 /* Pad the string "task" with however many bytes necessary to make it the
\r
313 length of a task name. Minus three for the null terminator and half the
\r
314 number of characters in "Task" so the column lines up with the centre of
\r
316 for( xSpacePadding = strlen( "Task" ); xSpacePadding < ( configMAX_TASK_NAME_LEN - 3 ); xSpacePadding++ )
\r
318 /* Add a space to align columns after the task's name. */
\r
319 *pcWriteBuffer = ' ';
\r
322 /* Ensure always terminated. */
\r
323 *pcWriteBuffer = 0x00;
\r
326 strcpy( pcWriteBuffer, pcHeader );
\r
327 vTaskGetRunTimeStats( pcWriteBuffer + strlen( pcHeader ) );
\r
329 /* There is no more data to return after this single string, so return
\r
334 #endif /* configGENERATE_RUN_TIME_STATS */
\r
335 /*-----------------------------------------------------------*/
\r
337 static BaseType_t prvThreeParameterEchoCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )
\r
339 const char *pcParameter;
\r
340 BaseType_t xParameterStringLength, xReturn;
\r
341 static UBaseType_t uxParameterNumber = 0;
\r
343 /* Remove compile time warnings about unused parameters, and check the
\r
344 write buffer is not NULL. NOTE - for simplicity, this example assumes the
\r
345 write buffer length is adequate, so does not check for buffer overflows. */
\r
346 ( void ) pcCommandString;
\r
347 ( void ) xWriteBufferLen;
\r
348 configASSERT( pcWriteBuffer );
\r
350 if( uxParameterNumber == 0 )
\r
352 /* The first time the function is called after the command has been
\r
353 entered just a header string is returned. */
\r
354 sprintf( pcWriteBuffer, "The three parameters were:\r\n" );
\r
356 /* Next time the function is called the first parameter will be echoed
\r
358 uxParameterNumber = 1U;
\r
360 /* There is more data to be returned as no parameters have been echoed
\r
366 /* Obtain the parameter string. */
\r
367 pcParameter = FreeRTOS_CLIGetParameter
\r
369 pcCommandString, /* The command string itself. */
\r
370 uxParameterNumber, /* Return the next parameter. */
\r
371 &xParameterStringLength /* Store the parameter string length. */
\r
374 /* Sanity check something was returned. */
\r
375 configASSERT( pcParameter );
\r
377 /* Return the parameter string. */
\r
378 memset( pcWriteBuffer, 0x00, xWriteBufferLen );
\r
379 sprintf( pcWriteBuffer, "%d: ", ( int ) uxParameterNumber );
\r
380 strncat( pcWriteBuffer, pcParameter, ( size_t ) xParameterStringLength );
\r
381 strncat( pcWriteBuffer, "\r\n", strlen( "\r\n" ) );
\r
383 /* If this is the last of the three parameters then there are no more
\r
384 strings to return after this one. */
\r
385 if( uxParameterNumber == 3U )
\r
387 /* If this is the last of the three parameters then there are no more
\r
388 strings to return after this one. */
\r
390 uxParameterNumber = 0;
\r
394 /* There are more parameters to return after this one. */
\r
396 uxParameterNumber++;
\r
402 /*-----------------------------------------------------------*/
\r
404 static BaseType_t prvParameterEchoCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )
\r
406 const char *pcParameter;
\r
407 BaseType_t xParameterStringLength, xReturn;
\r
408 static UBaseType_t uxParameterNumber = 0;
\r
410 /* Remove compile time warnings about unused parameters, and check the
\r
411 write buffer is not NULL. NOTE - for simplicity, this example assumes the
\r
412 write buffer length is adequate, so does not check for buffer overflows. */
\r
413 ( void ) pcCommandString;
\r
414 ( void ) xWriteBufferLen;
\r
415 configASSERT( pcWriteBuffer );
\r
417 if( uxParameterNumber == 0 )
\r
419 /* The first time the function is called after the command has been
\r
420 entered just a header string is returned. */
\r
421 sprintf( pcWriteBuffer, "The parameters were:\r\n" );
\r
423 /* Next time the function is called the first parameter will be echoed
\r
425 uxParameterNumber = 1U;
\r
427 /* There is more data to be returned as no parameters have been echoed
\r
433 /* Obtain the parameter string. */
\r
434 pcParameter = FreeRTOS_CLIGetParameter
\r
436 pcCommandString, /* The command string itself. */
\r
437 uxParameterNumber, /* Return the next parameter. */
\r
438 &xParameterStringLength /* Store the parameter string length. */
\r
441 if( pcParameter != NULL )
\r
443 /* Return the parameter string. */
\r
444 memset( pcWriteBuffer, 0x00, xWriteBufferLen );
\r
445 sprintf( pcWriteBuffer, "%d: ", ( int ) uxParameterNumber );
\r
446 strncat( pcWriteBuffer, ( char * ) pcParameter, ( size_t ) xParameterStringLength );
\r
447 strncat( pcWriteBuffer, "\r\n", strlen( "\r\n" ) );
\r
449 /* There might be more parameters to return after this one. */
\r
451 uxParameterNumber++;
\r
455 /* No more parameters were found. Make sure the write buffer does
\r
456 not contain a valid string. */
\r
457 pcWriteBuffer[ 0 ] = 0x00;
\r
459 /* No more data to return. */
\r
462 /* Start over the next time this command is executed. */
\r
463 uxParameterNumber = 0;
\r
469 /*-----------------------------------------------------------*/
\r
471 #if configINCLUDE_TRACE_RELATED_CLI_COMMANDS == 1
\r
473 static BaseType_t prvStartStopTraceCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )
\r
475 const char *pcParameter;
\r
476 BaseType_t lParameterStringLength;
\r
478 /* Remove compile time warnings about unused parameters, and check the
\r
479 write buffer is not NULL. NOTE - for simplicity, this example assumes the
\r
480 write buffer length is adequate, so does not check for buffer overflows. */
\r
481 ( void ) pcCommandString;
\r
482 ( void ) xWriteBufferLen;
\r
483 configASSERT( pcWriteBuffer );
\r
485 /* Obtain the parameter string. */
\r
486 pcParameter = FreeRTOS_CLIGetParameter
\r
488 pcCommandString, /* The command string itself. */
\r
489 1, /* Return the first parameter. */
\r
490 &lParameterStringLength /* Store the parameter string length. */
\r
493 /* Sanity check something was returned. */
\r
494 configASSERT( pcParameter );
\r
496 /* There are only two valid parameter values. */
\r
497 if( strncmp( pcParameter, "start", strlen( "start" ) ) == 0 )
\r
499 /* Start or restart the trace. */
\r
504 sprintf( pcWriteBuffer, "Trace recording (re)started.\r\n" );
\r
506 else if( strncmp( pcParameter, "stop", strlen( "stop" ) ) == 0 )
\r
508 /* End the trace, if one is running. */
\r
510 sprintf( pcWriteBuffer, "Stopping trace recording.\r\n" );
\r
514 sprintf( pcWriteBuffer, "Valid parameters are 'start' and 'stop'.\r\n" );
\r
517 /* There is no more data to return after this single string, so return
\r
522 #endif /* configINCLUDE_TRACE_RELATED_CLI_COMMANDS */
\r