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 #include "FreeRTOS.h"\r
  55 #include "task.h"\r
  56 #include "CommandInterpreter.h"\r
  57 \r
  58 typedef struct xCOMMAND_INPUT_LIST\r
  59 {\r
  60         const xCommandLineInput *pxCommandLineDefinition;\r
  61         struct xCOMMAND_INPUT_LIST *pxNext;\r
  62 } xCommandLineInputListItem;\r
  63 \r
  64 /*\r
  65  * The callback function that is executed when "help" is entered.  This is the\r
  66  * only default command that is always present.\r
  67  */\r
  68 static const signed char *prvHelpCommand( void );\r
  69 \r
  70 /* The definition of the "help" command.  This command is always at the front\r
  71 of the list of registered commands. */\r
  72 static const xCommandLineInput xHelpCommand = \r
  73 {\r
  74         "help",\r
  75         "help: Lists all the registered commands\r\n",\r
  76         prvHelpCommand\r
  77 };\r
  78 \r
  79 /* The definition of the list of commands.  Commands that are registered are\r
  80 added to this list. */\r
  81 static xCommandLineInputListItem xRegisteredCommands =\r
  82 {       \r
  83         &xHelpCommand,  /* The first command in the list is always the help command, defined in this file. */\r
  84         NULL                    /* The next pointer is initialised to NULL, as there are no other registered commands yet. */\r
  85 };\r
  86 \r
  87 /*-----------------------------------------------------------*/\r
  88 \r
  89 portBASE_TYPE xCmdIntRegisterCommand( const xCommandLineInput * const pxCommandToRegister )\r
  90 {\r
  91 static xCommandLineInputListItem *pxLastCommandInList = &xRegisteredCommands;\r
  92 xCommandLineInputListItem *pxNewListItem;\r
  93 portBASE_TYPE xReturn = pdFAIL;\r
  94 \r
  95         /* Check the parameter is not NULL. */\r
  96         configASSERT( pxCommandToRegister );\r
  97 \r
  98         /* Create a new list item that will reference the command being registered. */\r
  99         pxNewListItem = ( xCommandLineInputListItem * ) pvPortMalloc( sizeof( xCommandLineInputListItem ) );\r
 100         configASSERT( pxNewListItem );\r
 101 \r
 102         if( pxNewListItem != NULL )\r
 103         {\r
 104                 taskENTER_CRITICAL();\r
 105                 {\r
 106                         /* Reference the command being registered from the newly created \r
 107                         list item. */\r
 108                         pxNewListItem->pxCommandLineDefinition = pxCommandToRegister;\r
 109 \r
 110                         /* The new list item will get added to the end of the list, so \r
 111                         pxNext has nowhere to point. */\r
 112                         pxNewListItem->pxNext = NULL;\r
 113 \r
 114                         /* Add the newly created list item to the end of the already existing\r
 115                         list. */\r
 116                         pxLastCommandInList->pxNext = pxNewListItem;\r
 117 \r
 118                         /* Set the end of list marker to the new list item. */\r
 119                         pxLastCommandInList = pxNewListItem;\r
 120                 }\r
 121                 \r
 122                 xReturn = pdPASS;\r
 123         }\r
 124 \r
 125         return xReturn;\r
 126 }\r
 127 /*-----------------------------------------------------------*/\r
 128 \r
 129 const signed char *pcCmdIntProcessCommand( const signed char * const pcCommandInput )\r
 130 {\r
 131 static const xCommandLineInputListItem *pxCommand = NULL;\r
 132 signed const char *pcReturn = NULL;\r
 133 \r
 134         /* Note:  This function is not re-entrant.  It must not be called from more\r
 135         thank one task. */\r
 136 \r
 137         if( pxCommand == NULL )\r
 138         {\r
 139                 /* Search for the command string in the list of registered commands. */\r
 140                 for( pxCommand = &xRegisteredCommands; pxCommand != NULL; pxCommand = pxCommand->pxNext )\r
 141                 {\r
 142                         if( strcmp( ( const char * ) pcCommandInput, ( const char * ) pxCommand->pxCommandLineDefinition->pcCommand ) == 0 )\r
 143                         {\r
 144                                 /* The command has been found, the loop can exit so the command\r
 145                                 can be executed. */\r
 146                                 break;\r
 147                         }\r
 148                 }\r
 149         }\r
 150 \r
 151         if( pxCommand != NULL )\r
 152         {\r
 153                 pcReturn = pxCommand->pxCommandLineDefinition->pxCommandInterpreter();\r
 154 \r
 155                 /* If no strings were returned, then all the strings that are going to\r
 156                 be returned by the current command have already been returned, and\r
 157                 pxCommand can be reset to NULL ready to search for the next entered\r
 158                 command. */\r
 159                 if( pcReturn == NULL )\r
 160                 {\r
 161                         pxCommand = NULL;\r
 162                 }\r
 163         }\r
 164         else\r
 165         {\r
 166                 pcReturn = "Command not recognised.  Available commands are listed below.\r\n\r\n";\r
 167 \r
 168                 /* Print out the help string. */\r
 169                 pxCommand = &xRegisteredCommands;\r
 170         }\r
 171 \r
 172         return pcReturn;\r
 173 }\r
 174 /*-----------------------------------------------------------*/\r
 175 \r
 176 static const signed char *prvHelpCommand( void )\r
 177 {\r
 178 static const xCommandLineInputListItem * pxCommand = &xRegisteredCommands;\r
 179 signed const char *pcReturn;\r
 180 \r
 181         /* pxCommand will be NULL if all the commands in the list have already been\r
 182         returned. */\r
 183         if( pxCommand != NULL )\r
 184         {\r
 185                 /* Return the next command help string, before moving the pointer on to\r
 186                 the next command in the list. */\r
 187                 pcReturn = pxCommand->pxCommandLineDefinition->pcHelpString;\r
 188                 pxCommand = pxCommand->pxNext;\r
 189         }\r
 190         else\r
 191         {\r
 192                 /* Reset the pointer back to the start of the list. */\r
 193                 pxCommand = &xRegisteredCommands;\r
 194 \r
 195                 /* Return NULL to show that there are no more strings to return. */\r
 196                 pcReturn = NULL;\r
 197         }\r
 198         \r
 199         return pcReturn;\r
 200 }\r
 201 \r