git.sur5r.net Git - freertos/blob - Demo/Common/Utils/CommandInterpreter.c

   1 /*\r
   2     FreeRTOS V7.0.1 - Copyright (C) 2011 Real Time Engineers Ltd.\r
   3         \r
   4 \r
   5     ***************************************************************************\r
   6      *                                                                       *\r
   7      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
   8      *    Complete, revised, and edited pdf reference manuals are also       *\r
   9      *    available.                                                         *\r
  10      *                                                                       *\r
  11      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  12      *    ensuring you get running as quickly as possible and with an        *\r
  13      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  14      *    the FreeRTOS project to continue with its mission of providing     *\r
  15      *    professional grade, cross platform, de facto standard solutions    *\r
  16      *    for microcontrollers - completely free of charge!                  *\r
  17      *                                                                       *\r
  18      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  19      *                                                                       *\r
  20      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  21      *                                                                       *\r
  22     ***************************************************************************\r
  23 \r
  24 \r
  25     This file is part of the FreeRTOS distribution.\r
  26 \r
  27     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  28     the terms of the GNU General Public License (version 2) as published by the\r
  29     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  30     >>>NOTE<<< The modification to the GPL is included to allow you to\r
  31     distribute a combined work that includes FreeRTOS without being obliged to\r
  32     provide the source code for proprietary components outside of the FreeRTOS\r
  33     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  34     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  35     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  36     more details. You should have received a copy of the GNU General Public\r
  37     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
  38     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
  39     by writing to Richard Barry, contact details for whom are available on the\r
  40     FreeRTOS WEB site.\r
  41 \r
  42     1 tab == 4 spaces!\r
  43 \r
  44     http://www.FreeRTOS.org - Documentation, latest information, license and\r
  45     contact details.\r
  46 \r
  47     http://www.SafeRTOS.com - A version that is certified for use in safety\r
  48     critical systems.\r
  49 \r
  50     http://www.OpenRTOS.com - Commercial support, development, porting,\r
  51     licensing and training services.\r
  52 */\r
  53 \r
  54 /* Standard includes. */\r
  55 #include <string.h>\r
  56 \r
  57 /* FreeRTOS includes. */\r
  58 #include "FreeRTOS.h"\r
  59 #include "task.h"\r
  60 \r
  61 /* Utils includes. */\r
  62 #include "CommandInterpreter.h"\r
  63 \r
  64 typedef struct xCOMMAND_INPUT_LIST\r
  65 {\r
  66         const xCommandLineInput *pxCommandLineDefinition;\r
  67         struct xCOMMAND_INPUT_LIST *pxNext;\r
  68 } xCommandLineInputListItem;\r
  69 \r
  70 /*\r
  71  * The callback function that is executed when "help" is entered.  This is the\r
  72  * only default command that is always present.\r
  73  */\r
  74 static portBASE_TYPE prvHelpCommand( signed char *pcWriteBuffer, size_t xWriteBufferLen );\r
  75 \r
  76 /* The definition of the "help" command.  This command is always at the front\r
  77 of the list of registered commands. */\r
  78 static const xCommandLineInput xHelpCommand = \r
  79 {\r
  80         ( const signed char * const ) "help",\r
  81         ( const signed char * const ) "help: Lists all the registered commands\r\n",\r
  82         prvHelpCommand\r
  83 };\r
  84 \r
  85 /* The definition of the list of commands.  Commands that are registered are\r
  86 added to this list. */\r
  87 static xCommandLineInputListItem xRegisteredCommands =\r
  88 {       \r
  89         &xHelpCommand,  /* The first command in the list is always the help command, defined in this file. */\r
  90         NULL                    /* The next pointer is initialised to NULL, as there are no other registered commands yet. */\r
  91 };\r
  92 \r
  93 /*-----------------------------------------------------------*/\r
  94 \r
  95 portBASE_TYPE xCmdIntRegisterCommand( const xCommandLineInput * const pxCommandToRegister )\r
  96 {\r
  97 static xCommandLineInputListItem *pxLastCommandInList = &xRegisteredCommands;\r
  98 xCommandLineInputListItem *pxNewListItem;\r
  99 portBASE_TYPE xReturn = pdFAIL;\r
 100 \r
 101         /* Check the parameter is not NULL. */\r
 102         configASSERT( pxCommandToRegister );\r
 103 \r
 104         /* Create a new list item that will reference the command being registered. */\r
 105         pxNewListItem = ( xCommandLineInputListItem * ) pvPortMalloc( sizeof( xCommandLineInputListItem ) );\r
 106         configASSERT( pxNewListItem );\r
 107 \r
 108         if( pxNewListItem != NULL )\r
 109         {\r
 110                 taskENTER_CRITICAL();\r
 111                 {\r
 112                         /* Reference the command being registered from the newly created \r
 113                         list item. */\r
 114                         pxNewListItem->pxCommandLineDefinition = pxCommandToRegister;\r
 115 \r
 116                         /* The new list item will get added to the end of the list, so \r
 117                         pxNext has nowhere to point. */\r
 118                         pxNewListItem->pxNext = NULL;\r
 119 \r
 120                         /* Add the newly created list item to the end of the already existing\r
 121                         list. */\r
 122                         pxLastCommandInList->pxNext = pxNewListItem;\r
 123 \r
 124                         /* Set the end of list marker to the new list item. */\r
 125                         pxLastCommandInList = pxNewListItem;\r
 126                 }\r
 127                 \r
 128                 xReturn = pdPASS;\r
 129         }\r
 130 \r
 131         return xReturn;\r
 132 }\r
 133 /*-----------------------------------------------------------*/\r
 134 \r
 135 portBASE_TYPE xCmdIntProcessCommand( const signed char * const pcCommandInput, signed char * pcWriteBuffer, size_t xWriteBufferLen  )\r
 136 {\r
 137 static const xCommandLineInputListItem *pxCommand = NULL;\r
 138 portBASE_TYPE xReturn;\r
 139 \r
 140         /* Note:  This function is not re-entrant.  It must not be called from more\r
 141         thank one task. */\r
 142 \r
 143         if( pxCommand == NULL )\r
 144         {\r
 145                 /* Search for the command string in the list of registered commands. */\r
 146                 for( pxCommand = &xRegisteredCommands; pxCommand != NULL; pxCommand = pxCommand->pxNext )\r
 147                 {\r
 148                         if( strcmp( ( const char * ) pcCommandInput, ( const char * ) pxCommand->pxCommandLineDefinition->pcCommand ) == 0 )\r
 149                         {\r
 150                                 /* The command has been found, the loop can exit so the command\r
 151                                 can be executed. */\r
 152                                 break;\r
 153                         }\r
 154                 }\r
 155         }\r
 156 \r
 157         if( pxCommand != NULL )\r
 158         {\r
 159                 /* Call the callback function that is registered to this command. */\r
 160                 xReturn = pxCommand->pxCommandLineDefinition->pxCommandInterpreter( pcWriteBuffer, xWriteBufferLen );\r
 161 \r
 162                 /* If xReturn is pdFALSE, then no further strings will be returned\r
 163                 after this one, and     pxCommand can be reset to NULL ready to search \r
 164                 for the next entered command. */\r
 165                 if( xReturn == pdFALSE )\r
 166                 {\r
 167                         pxCommand = NULL;\r
 168                 }\r
 169         }\r
 170         else\r
 171         {\r
 172                 strncpy( ( char * ) pcWriteBuffer, ( const char * const ) "Command not recognised.  Enter \"help\" to view a list of available commands.\r\n\r\n", xWriteBufferLen );\r
 173                 xReturn = pdFALSE;\r
 174         }\r
 175 \r
 176         return xReturn;\r
 177 }\r
 178 /*-----------------------------------------------------------*/\r
 179 \r
 180 static portBASE_TYPE prvHelpCommand( signed char *pcWriteBuffer, size_t xWriteBufferLen )\r
 181 {\r
 182 static const xCommandLineInputListItem * pxCommand = NULL;\r
 183 signed portBASE_TYPE xReturn;\r
 184 \r
 185         if( pxCommand == NULL )\r
 186         {\r
 187                 /* Reset the pxCommand pointer back to the start of the list. */\r
 188                 pxCommand = &xRegisteredCommands;\r
 189         }\r
 190 \r
 191         /* Return the next command help string, before moving the pointer on to\r
 192         the next command in the list. */\r
 193         strncpy( ( char * ) pcWriteBuffer, ( const char * ) pxCommand->pxCommandLineDefinition->pcHelpString, xWriteBufferLen );\r
 194         pxCommand = pxCommand->pxNext;\r
 195 \r
 196         if( pxCommand == NULL )\r
 197         {\r
 198                 /* There are no more commands in the list, so there will be no more\r
 199                 strings to return after this one and pdFALSE should be returned. */\r
 200                 xReturn = pdFALSE;\r
 201         }\r
 202         else\r
 203         {\r
 204                 xReturn = pdTRUE;\r
 205         }\r
 206 \r
 207         return xReturn;\r
 208 }\r