]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS-Labs/Demo/FreeRTOS_Plus_TCP_and_FAT_Windows_Simulator/CLI-commands.c
Add the Labs projects provided in the V10.2.1_191129 zip file.
[freertos] / FreeRTOS-Labs / Demo / FreeRTOS_Plus_TCP_and_FAT_Windows_Simulator / CLI-commands.c
diff --git a/FreeRTOS-Labs/Demo/FreeRTOS_Plus_TCP_and_FAT_Windows_Simulator/CLI-commands.c b/FreeRTOS-Labs/Demo/FreeRTOS_Plus_TCP_and_FAT_Windows_Simulator/CLI-commands.c
new file mode 100644 (file)
index 0000000..033e667
--- /dev/null
@@ -0,0 +1,716 @@
+/*\r
+    FreeRTOS V9.0.0 - Copyright (C) 2016 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
+    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
+    ***************************************************************************\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
+\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 on the following\r
+    link: http://www.freertos.org/a00114.html\r
+\r
+    ***************************************************************************\r
+     *                                                                       *\r
+     *    FreeRTOS provides completely free yet professionally developed,    *\r
+     *    robust, strictly quality controlled, supported, and cross          *\r
+     *    platform software that is more than just the market leader, it     *\r
+     *    is the industry's de facto standard.                               *\r
+     *                                                                       *\r
+     *    Help yourself get started quickly while simultaneously helping     *\r
+     *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
+     *    tutorial book, reference manual, or both:                          *\r
+     *    http://www.FreeRTOS.org/Documentation                              *\r
+     *                                                                       *\r
+    ***************************************************************************\r
+\r
+    http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
+    the FAQ page "My application does not run, what could be wrong?".  Have you\r
+    defined configASSERT()?\r
+\r
+    http://www.FreeRTOS.org/support - In return for receiving this top quality\r
+    embedded software for free we request you assist our global community by\r
+    participating in the support forum.\r
+\r
+    http://www.FreeRTOS.org/training - Investing in training allows your team to\r
+    be as productive as possible as early as possible.  Now you can receive\r
+    FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
+    Ltd, and the world's leading authority on the world's leading RTOS.\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.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
+    Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
+\r
+    http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
+    Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
+    licenses offer ticketed support, indemnification and commercial 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
+/* Standard includes. */\r
+#include <stdint.h>\r
+#include <stdio.h>\r
+#include <stdlib.h>\r
+\r
+/* FreeRTOS includes. */\r
+#include "FreeRTOS.h"\r
+#include "task.h"\r
+\r
+/* FreeRTOS+CLI includes. */\r
+#include "FreeRTOS_CLI.h"\r
+\r
+/* FreeRTOS+TCP includes, just to make the stats available to the CLI\r
+commands. */\r
+#include "FreeRTOS_IP.h"\r
+#include "FreeRTOS_Sockets.h"\r
+\r
+#ifndef  configINCLUDE_TRACE_RELATED_CLI_COMMANDS\r
+       #define configINCLUDE_TRACE_RELATED_CLI_COMMANDS 0\r
+#endif\r
+\r
+\r
+/*\r
+ * Implements the run-time-stats command.\r
+ */\r
+static BaseType_t prvTaskStatsCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );\r
+\r
+/*\r
+ * Implements the task-stats command.\r
+ */\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 BaseType_t prvThreeParameterEchoCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );\r
+\r
+/*\r
+ * Implements the echo-parameters command.\r
+ */\r
+static BaseType_t prvParameterEchoCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );\r
+\r
+/*\r
+ * Defines a command that prints out IP address information.\r
+ */\r
+static BaseType_t prvDisplayIPConfig( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );\r
+\r
+/*\r
+ * Defines a command that prints out the gathered demo debug stats.\r
+ */\r
+static BaseType_t prvDisplayIPDebugStats( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );\r
+\r
+/*\r
+ * Defines a command that sends an ICMP ping request to an IP address.\r
+ */\r
+static BaseType_t prvPingCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );\r
+\r
+/*\r
+ * Defines a command that calls FreeRTOS_netstat().\r
+ */\r
+static BaseType_t prvNetStatCommand( 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 BaseType_t prvStartStopTraceCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );\r
+#endif\r
+\r
+/* Structure that defines the "ip-config" command line command. */\r
+static const CLI_Command_Definition_t xIPConfig =\r
+{\r
+       "ip-config",\r
+       "ip-config:\r\n Displays IP address configuration\r\n\r\n",\r
+       prvDisplayIPConfig,\r
+       0\r
+};\r
+\r
+#if configINCLUDE_DEMO_DEBUG_STATS != 0\r
+       /* Structure that defines the "ip-debug-stats" command line command. */\r
+       static const CLI_Command_Definition_t xIPDebugStats =\r
+       {\r
+               "ip-debug-stats", /* The command string to type. */\r
+               "ip-debug-stats:\r\n Shows some IP stack stats useful for debug - an example only.\r\n\r\n",\r
+               prvDisplayIPDebugStats, /* The function to run. */\r
+               0 /* No parameters are expected. */\r
+       };\r
+#endif /* configINCLUDE_DEMO_DEBUG_STATS */\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
+       "run-time-stats", /* The command string to type. */\r
+       "run-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
+\r
+/* Structure that defines the "task-stats" command line command.  This generates\r
+a table that gives information on each task in the system. */\r
+static const CLI_Command_Definition_t xTaskStats =\r
+{\r
+       "task-stats", /* The command string to type. */\r
+       "task-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
+\r
+/* Structure that defines the "echo_3_parameters" command line command.  This\r
+takes exactly three parameters that the command simply echos back one at a\r
+time. */\r
+static const CLI_Command_Definition_t xThreeParameterEcho =\r
+{\r
+       "echo-3-parameters",\r
+       "echo-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
+\r
+/* Structure that defines the "echo_parameters" command line command.  This\r
+takes a variable number of parameters that the command simply echos back one at\r
+a time. */\r
+static const CLI_Command_Definition_t xParameterEcho =\r
+{\r
+       "echo-parameters",\r
+       "echo-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
+\r
+#ifdef ipconfigUSE_TCP\r
+       #if( ipconfigUSE_TCP == 1 )\r
+               /* Structure that defines the "task-stats" command line command.  This generates\r
+               a table that gives information on each task in the system. */\r
+               static const CLI_Command_Definition_t xNetStats =\r
+               {\r
+                       "net-stats", /* The command string to type. */\r
+                       "net-stats:\r\n Calls FreeRTOS_netstat()\r\n\r\n",\r
+                       prvNetStatCommand, /* The function to run. */\r
+                       0 /* No parameters are expected. */\r
+               };\r
+       #endif /* ipconfigUSE_TCP == 1 */\r
+#endif /* ifdef ipconfigUSE_TCP */\r
+\r
+#if ipconfigSUPPORT_OUTGOING_PINGS == 1\r
+\r
+       /* Structure that defines the "ping" command line command.  This takes an IP\r
+       address or host name and (optionally) the number of bytes to ping as\r
+       parameters. */\r
+       static const CLI_Command_Definition_t xPing =\r
+       {\r
+               "ping",\r
+               "ping <ipaddress> <optional:bytes to send>:\r\n for example, ping 192.168.0.3 8, or ping www.example.com\r\n\r\n",\r
+               prvPingCommand, /* The function to run. */\r
+               -1 /* Ping can take either one or two parameter, so the number of parameters has to be determined by the ping command implementation. */\r
+       };\r
+\r
+#endif /* ipconfigSUPPORT_OUTGOING_PINGS */\r
+\r
+#if configINCLUDE_TRACE_RELATED_CLI_COMMANDS == 1\r
+       /* Structure that defines the "trace" command line command.  This takes a single\r
+       parameter, which can be either "start" or "stop". */\r
+       static const CLI_Command_Definition_t xStartStopTrace =\r
+       {\r
+               "trace",\r
+               "trace [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
+#endif /* configINCLUDE_TRACE_RELATED_CLI_COMMANDS */\r
+\r
+/*-----------------------------------------------------------*/\r
+\r
+void vRegisterCLICommands( void )\r
+{\r
+static BaseType_t xCommandRegistered = pdFALSE;\r
+\r
+       /* Prevent commands being registered more than once. */\r
+       if( xCommandRegistered == pdFALSE )\r
+       {\r
+               /* Register all the command line commands defined immediately above. */\r
+               FreeRTOS_CLIRegisterCommand( &xTaskStats );\r
+               FreeRTOS_CLIRegisterCommand( &xRunTimeStats );\r
+               FreeRTOS_CLIRegisterCommand( &xThreeParameterEcho );\r
+               FreeRTOS_CLIRegisterCommand( &xParameterEcho );\r
+               FreeRTOS_CLIRegisterCommand( &xIPDebugStats );\r
+               FreeRTOS_CLIRegisterCommand( &xIPConfig );\r
+\r
+               #if ipconfigSUPPORT_OUTGOING_PINGS == 1\r
+               {\r
+                       FreeRTOS_CLIRegisterCommand( &xPing );\r
+               }\r
+               #endif /* ipconfigSUPPORT_OUTGOING_PINGS */\r
+\r
+               #ifdef ipconfigUSE_TCP\r
+               {\r
+                       #if ipconfigUSE_TCP == 1\r
+                       {\r
+                               FreeRTOS_CLIRegisterCommand( &xNetStats );\r
+                       }\r
+                       #endif /* ipconfigUSE_TCP == 1 */\r
+               }\r
+               #endif /* ifdef ipconfigUSE_TCP */\r
+\r
+               #if configINCLUDE_TRACE_RELATED_CLI_COMMANDS == 1\r
+               {\r
+                       FreeRTOS_CLIRegisterCommand( & xStartStopTrace );\r
+               }\r
+               #endif\r
+\r
+               xCommandRegistered = pdTRUE;\r
+       }\r
+}\r
+/*-----------------------------------------------------------*/\r
+\r
+static BaseType_t prvTaskStatsCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )\r
+{\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
+       write buffer length is adequate, so does not check for buffer overflows. */\r
+       ( void ) pcCommandString;\r
+       ( void ) xWriteBufferLen;\r
+       configASSERT( pcWriteBuffer );\r
+\r
+       /* Generate a table of task stats. */\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
+       return pdFALSE;\r
+}\r
+/*-----------------------------------------------------------*/\r
+\r
+static BaseType_t prvRunTimeStatsCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )\r
+{\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
+       write buffer length is adequate, so does not check for buffer overflows. */\r
+       ( void ) pcCommandString;\r
+       ( void ) xWriteBufferLen;\r
+       configASSERT( pcWriteBuffer );\r
+\r
+       /* Generate a table of task stats. */\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
+       return pdFALSE;\r
+}\r
+/*-----------------------------------------------------------*/\r
+\r
+static BaseType_t prvThreeParameterEchoCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )\r
+{\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
+       write buffer length is adequate, so does not check for buffer overflows. */\r
+       ( void ) pcCommandString;\r
+       configASSERT( pcWriteBuffer );\r
+\r
+       if( lParameterNumber == 0 )\r
+       {\r
+               /* The first time the function is called after the command has been\r
+               entered just a header string is returned. */\r
+               snprintf( pcWriteBuffer, xWriteBufferLen, "The three parameters were:\r\n" );\r
+\r
+               /* Next time the function is called the first parameter will be echoed\r
+               back. */\r
+               lParameterNumber = 1L;\r
+\r
+               /* There is more data to be returned as no parameters have been echoed\r
+               back yet. */\r
+               xReturn = pdPASS;\r
+       }\r
+       else\r
+       {\r
+               /* Obtain the parameter string. */\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
+               snprintf( pcWriteBuffer, xWriteBufferLen, "%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
+               if( lParameterNumber == 3L )\r
+               {\r
+                       /* If this is the last of the three parameters then there are no more\r
+                       strings to return after this one. */\r
+                       xReturn = pdFALSE;\r
+                       lParameterNumber = 0L;\r
+               }\r
+               else\r
+               {\r
+                       /* There are more parameters to return after this one. */\r
+                       xReturn = pdTRUE;\r
+                       lParameterNumber++;\r
+               }\r
+       }\r
+\r
+       return xReturn;\r
+}\r
+/*-----------------------------------------------------------*/\r
+\r
+static BaseType_t prvParameterEchoCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )\r
+{\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
+       write buffer length is adequate, so does not check for buffer overflows. */\r
+       ( void ) pcCommandString;\r
+       configASSERT( pcWriteBuffer );\r
+\r
+       if( lParameterNumber == 0 )\r
+       {\r
+               /* The first time the function is called after the command has been\r
+               entered just a header string is returned. */\r
+               snprintf( pcWriteBuffer, xWriteBufferLen, "The parameters were:\r\n" );\r
+\r
+               /* Next time the function is called the first parameter will be echoed\r
+               back. */\r
+               lParameterNumber = 1L;\r
+\r
+               /* There is more data to be returned as no parameters have been echoed\r
+               back yet. */\r
+               xReturn = pdPASS;\r
+       }\r
+       else\r
+       {\r
+               /* Obtain the parameter string. */\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
+                       snprintf( pcWriteBuffer, xWriteBufferLen, "%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
+                       lParameterNumber++;\r
+               }\r
+               else\r
+               {\r
+                       /* No more parameters were found.  Make sure the write buffer does\r
+                       not contain a valid string. */\r
+                       pcWriteBuffer[ 0 ] = 0x00;\r
+\r
+                       /* No more data to return. */\r
+                       xReturn = pdFALSE;\r
+\r
+                       /* Start over the next time this command is executed. */\r
+                       lParameterNumber = 0;\r
+               }\r
+       }\r
+\r
+       return xReturn;\r
+}\r
+/*-----------------------------------------------------------*/\r
+\r
+#ifdef ipconfigUSE_TCP\r
+\r
+       #if ipconfigUSE_TCP == 1\r
+\r
+               static BaseType_t prvNetStatCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )\r
+               {\r
+                       ( void ) pcWriteBuffer;\r
+                       ( void ) xWriteBufferLen;\r
+                       ( void ) pcCommandString;\r
+\r
+                       FreeRTOS_netstat();\r
+                       snprintf( pcWriteBuffer, xWriteBufferLen, "FreeRTOS_netstat() called - output uses FreeRTOS_printf\r\n" );\r
+                       return pdFALSE;\r
+               }\r
+\r
+       #endif /* ipconfigUSE_TCP == 1 */\r
+\r
+#endif /* ifdef ipconfigUSE_TCP */\r
+/*-----------------------------------------------------------*/\r
+\r
+#if ipconfigSUPPORT_OUTGOING_PINGS == 1\r
+\r
+       static BaseType_t prvPingCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )\r
+       {\r
+       char * pcParameter;\r
+       BaseType_t lParameterStringLength, xReturn;\r
+       uint32_t ulIPAddress, ulBytesToPing;\r
+       const uint32_t ulDefaultBytesToPing = 8UL;\r
+       char cBuffer[ 16 ];\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
+               write buffer length is adequate, so does not check for buffer overflows. */\r
+               ( void ) pcCommandString;\r
+               configASSERT( pcWriteBuffer );\r
+\r
+               /* Start with an empty string. */\r
+               pcWriteBuffer[ 0 ] = 0x00;\r
+\r
+               /* Obtain the number of bytes to ping. */\r
+               pcParameter = ( char * ) FreeRTOS_CLIGetParameter\r
+                                                               (\r
+                                                                       pcCommandString,                /* The command string itself. */\r
+                                                                       2,                                              /* Return the second parameter. */\r
+                                                                       &lParameterStringLength /* Store the parameter string length. */\r
+                                                               );\r
+\r
+               if( pcParameter == NULL )\r
+               {\r
+                       /* The number of bytes was not specified, so default it. */\r
+                       ulBytesToPing = ulDefaultBytesToPing;\r
+               }\r
+               else\r
+               {\r
+                       ulBytesToPing = atol( pcParameter );\r
+               }\r
+\r
+               /* Obtain the IP address string. */\r
+               pcParameter = ( char * ) 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
+               /* Attempt to obtain the IP address.   If the first character is not a\r
+               digit, assume the host name has been passed in. */\r
+               if( ( *pcParameter >= '0' ) && ( *pcParameter <= '9' ) )\r
+               {\r
+                       ulIPAddress = FreeRTOS_inet_addr( pcParameter );\r
+               }\r
+               else\r
+               {\r
+                       /* Terminate the host name. */\r
+                       pcParameter[ lParameterStringLength ] = 0x00;\r
+\r
+                       /* Attempt to resolve host. */\r
+                       ulIPAddress = FreeRTOS_gethostbyname( pcParameter );\r
+               }\r
+\r
+               /* Convert IP address, which may have come from a DNS lookup, to string. */\r
+               FreeRTOS_inet_ntoa( ulIPAddress, cBuffer );\r
+\r
+               if( ulIPAddress != 0 )\r
+               {\r
+                       xReturn = FreeRTOS_SendPingRequest( ulIPAddress, ( uint16_t ) ulBytesToPing, portMAX_DELAY );\r
+               }\r
+               else\r
+               {\r
+                       xReturn = pdFALSE;\r
+               }\r
+\r
+               if( xReturn == pdFALSE )\r
+               {\r
+                       snprintf( pcWriteBuffer, xWriteBufferLen, "%s", "Could not send ping request\r\n" );\r
+               }\r
+               else\r
+               {\r
+                       snprintf( pcWriteBuffer, xWriteBufferLen, "Ping sent to %s with identifier %d\r\n", cBuffer, xReturn );\r
+               }\r
+\r
+               return pdFALSE;\r
+       }\r
+       /*-----------------------------------------------------------*/\r
+\r
+#endif /* ipconfigSUPPORT_OUTGOING_PINGS */\r
+\r
+#if configINCLUDE_DEMO_DEBUG_STATS != 0\r
+\r
+       static BaseType_t prvDisplayIPDebugStats( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )\r
+       {\r
+       static BaseType_t xIndex = -1;\r
+       extern ExampleDebugStatEntry_t xIPTraceValues[];\r
+       BaseType_t xReturn;\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
+               write buffer length is adequate, so does not check for buffer overflows. */\r
+               ( void ) pcCommandString;\r
+               configASSERT( pcWriteBuffer );\r
+\r
+               xIndex++;\r
+\r
+               if( xIndex < xExampleDebugStatEntries() )\r
+               {\r
+                       snprintf( pcWriteBuffer, xWriteBufferLen, "%s %d\r\n", xIPTraceValues[ xIndex ].pucDescription, ( int ) xIPTraceValues[ xIndex ].ulData );\r
+                       xReturn = pdPASS;\r
+               }\r
+               else\r
+               {\r
+                       /* Reset the index for the next time it is called. */\r
+                       xIndex = -1;\r
+\r
+                       /* Ensure nothing remains in the write buffer. */\r
+                       pcWriteBuffer[ 0 ] = 0x00;\r
+                       xReturn = pdFALSE;\r
+               }\r
+\r
+               return xReturn;\r
+       }\r
+       /*-----------------------------------------------------------*/\r
+\r
+#endif /* configINCLUDE_DEMO_DEBUG_STATS */\r
+\r
+static BaseType_t prvDisplayIPConfig( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )\r
+{\r
+static BaseType_t xIndex = 0;\r
+BaseType_t xReturn;\r
+uint32_t ulAddress;\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
+       write buffer length is adequate, so does not check for buffer overflows. */\r
+       ( void ) pcCommandString;\r
+       configASSERT( pcWriteBuffer );\r
+\r
+       switch( xIndex )\r
+       {\r
+               case 0 :\r
+                       FreeRTOS_GetAddressConfiguration( &ulAddress, NULL, NULL, NULL );\r
+                       snprintf( pcWriteBuffer, xWriteBufferLen, "\r\nIP address " );\r
+                       xReturn = pdTRUE;\r
+                       xIndex++;\r
+                       break;\r
+\r
+               case 1 :\r
+                       FreeRTOS_GetAddressConfiguration( NULL, &ulAddress, NULL, NULL );\r
+                       snprintf( pcWriteBuffer, xWriteBufferLen, "\r\nNet mask " );\r
+                       xReturn = pdTRUE;\r
+                       xIndex++;\r
+                       break;\r
+\r
+               case 2 :\r
+                       FreeRTOS_GetAddressConfiguration( NULL, NULL, &ulAddress, NULL );\r
+                       snprintf( pcWriteBuffer, xWriteBufferLen, "\r\nGateway address " );\r
+                       xReturn = pdTRUE;\r
+                       xIndex++;\r
+                       break;\r
+\r
+               case 3 :\r
+                       FreeRTOS_GetAddressConfiguration( NULL, NULL, NULL, &ulAddress );\r
+                       snprintf( pcWriteBuffer, xWriteBufferLen, "\r\nDNS server address " );\r
+                       xReturn = pdTRUE;\r
+                       xIndex++;\r
+                       break;\r
+\r
+               default :\r
+                       ulAddress = 0;\r
+                       snprintf( pcWriteBuffer, xWriteBufferLen, "\r\n\r\n" );\r
+                       xReturn = pdFALSE;\r
+                       xIndex = 0;\r
+                       break;\r
+       }\r
+\r
+       if( ulAddress != 0 )\r
+       {\r
+               FreeRTOS_inet_ntoa( ulAddress,  &( pcWriteBuffer[ strlen( pcWriteBuffer ) ] ) );\r
+       }\r
+\r
+       return xReturn;\r
+}\r
+/*-----------------------------------------------------------*/\r
+\r
+#if configINCLUDE_TRACE_RELATED_CLI_COMMANDS == 1\r
+\r
+       static BaseType_t prvStartStopTraceCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )\r
+       {\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
+               write buffer length is adequate, so does not check for buffer overflows. */\r
+               ( void ) pcCommandString;\r
+               configASSERT( pcWriteBuffer );\r
+\r
+               /* Obtain the parameter string. */\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( pcParameter, "start", strlen( "start" ) ) == 0 )\r
+               {\r
+                       /* Start or restart the trace. */\r
+                       vTraceStop();\r
+                       vTraceClear();\r
+                       vTraceStart();\r
+\r
+                       snprintf( pcWriteBuffer, xWriteBufferLen, "Trace recording (re)started.\r\n" );\r
+               }\r
+               else if( strncmp( pcParameter, "stop", strlen( "stop" ) ) == 0 )\r
+               {\r
+                       /* End the trace, if one is running. */\r
+                       vTraceStop();\r
+                       snprintf( pcWriteBuffer, xWriteBufferLen, "Stopping trace recording.\r\n" );\r
+               }\r
+               else\r
+               {\r
+                       snprintf( pcWriteBuffer, xWriteBufferLen, "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
+               pdFALSE. */\r
+               return pdFALSE;\r
+       }\r
+\r
+#endif /* configINCLUDE_TRACE_RELATED_CLI_COMMANDS */\r