Update a few util functions in the common demo area.
Richard Barry
14 years ago
parent
a548ef34f8
commit
1aa52c2a7a
@ -0,0 +1,155 @@
|
||||
/*
|
||||
FreeRTOS V7.0.1 - Copyright (C) 2011 Real Time Engineers Ltd.
|
||||
|
||||
|
||||
***************************************************************************
|
||||
* *
|
||||
* FreeRTOS tutorial books are available in pdf and paperback. *
|
||||
* Complete, revised, and edited pdf reference manuals are also *
|
||||
* available. *
|
||||
* *
|
||||
* Purchasing FreeRTOS documentation will not only help you, by *
|
||||
* ensuring you get running as quickly as possible and with an *
|
||||
* in-depth knowledge of how to use FreeRTOS, it will also help *
|
||||
* the FreeRTOS project to continue with its mission of providing *
|
||||
* professional grade, cross platform, de facto standard solutions *
|
||||
* for microcontrollers - completely free of charge! *
|
||||
* *
|
||||
* >>> See http://www.FreeRTOS.org/Documentation for details. <<< *
|
||||
* *
|
||||
* Thank you for using FreeRTOS, and thank you for your support! *
|
||||
* *
|
||||
***************************************************************************
|
||||
|
||||
|
||||
This file is part of the FreeRTOS distribution.
|
||||
|
||||
FreeRTOS is free software; you can redistribute it and/or modify it under
|
||||
the terms of the GNU General Public License (version 2) as published by the
|
||||
Free Software Foundation AND MODIFIED BY the FreeRTOS exception.
|
||||
>>>NOTE<<< The modification to the GPL is included to allow you to
|
||||
distribute a combined work that includes FreeRTOS without being obliged to
|
||||
provide the source code for proprietary components outside of the FreeRTOS
|
||||
kernel. FreeRTOS is distributed in the hope that it will be useful, but
|
||||
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
||||
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||||
more details. You should have received a copy of the GNU General Public
|
||||
License and the FreeRTOS license exception along with FreeRTOS; if not it
|
||||
can be viewed here: http://www.freertos.org/a00114.html and also obtained
|
||||
by writing to Richard Barry, contact details for whom are available on the
|
||||
FreeRTOS WEB site.
|
||||
|
||||
1 tab == 4 spaces!
|
||||
|
||||
http://www.FreeRTOS.org - Documentation, latest information, license and
|
||||
contact details.
|
||||
|
||||
http://www.SafeRTOS.com - A version that is certified for use in safety
|
||||
critical systems.
|
||||
|
||||
http://www.OpenRTOS.com - Commercial support, development, porting,
|
||||
licensing and training services.
|
||||
*/
|
||||
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
#include "CommandInterpreter.h"
|
||||
|
||||
/*
|
||||
* The callback function that is executed when "help" is entered. This is the
|
||||
* only default command that is always present.
|
||||
*/
|
||||
static const signed char *prvHelpCommand( void );
|
||||
|
||||
/* The definition of the "help" command. This command is always at the front
|
||||
of the list of registered commands. */
|
||||
const xCommandLineInput xHelpCommand =
|
||||
{
|
||||
"help",
|
||||
"help: Lists all the registered commands\r\n",
|
||||
prvHelpCommand,
|
||||
NULL
|
||||
};
|
||||
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
void vCmdIntRegisterCommand( const xCommandLineInput *pxCommandToRegister )
|
||||
{
|
||||
/* Used to point to the last command in the list of registered command, just to
|
||||
make registering commands faster. */
|
||||
static xCommandLineInput *pxLastCommandInList = &xHelpCommand;
|
||||
|
||||
configASSERT( pxLastCommandInList );
|
||||
pxLastCommandInList->pxNext = pxCommandToRegister;
|
||||
pxLastCommandInLIst = pxCommandToRegister;
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
const signed char *pcCmdIntProcessCommand( const signed char *pcCommandInput )
|
||||
{
|
||||
static const xCommandLineInput *pxCommand = NULL;
|
||||
signed const char *pcReturn = NULL;
|
||||
|
||||
if( pxCommand == NULL )
|
||||
{
|
||||
/* Search for the command string in the list of registered commands. */
|
||||
for( pxCommand = &xHelpCommand; pxCommand != NULL; pxCommand = pxCommand->pxNext )
|
||||
{
|
||||
if( strcmp( ( const char * ) pcCommandInput, ( const char * ) pxCommand->pcCommand ) == 0 )
|
||||
{
|
||||
/* The command has been found, the loop can exit so the command
|
||||
can be executed. */
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if( pxCommand != NULL )
|
||||
{
|
||||
pcReturn = pxCommand->pxCommandInterpreter();
|
||||
|
||||
/* If no strings were returned, then all the strings that are going to
|
||||
be returned by the current command have already been returned, and
|
||||
pxCommand can be reset to NULL ready to search for the next entered
|
||||
command. */
|
||||
if( pcReturn == NULL )
|
||||
{
|
||||
pxCommand = NULL;
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
pcReturn = "Command not recognised\r\n\r\n";
|
||||
pxCommand = &xHelpCommand;
|
||||
}
|
||||
|
||||
return pcReturn;
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
static const signed char *prvHelpCommand( void )
|
||||
{
|
||||
static const xCommandLineInput * pxCommand = &xHelpCommand;
|
||||
signed const char *pcReturn;
|
||||
|
||||
/* pxCommand will be NULL if all the commands in the list have already been
|
||||
returned. */
|
||||
if( pxCommand != NULL )
|
||||
{
|
||||
/* Return the next command help string, before moving the pointer on to
|
||||
the next command in the list. */
|
||||
pcReturn = pxCommand->pcHelpString;
|
||||
pxCommand = pxCommand->pxNext;
|
||||
}
|
||||
else
|
||||
{
|
||||
/* Reset the pointer back to the start of the list. */
|
||||
pxCommand = &xHelpCommand;
|
||||
|
||||
/* Return NULL to show that there are no more strings to return. */
|
||||
pcReturn = NULL;
|
||||
}
|
||||
|
||||
return pcReturn;
|
||||
}
|
||||
|
||||
@ -0,0 +1,107 @@
|
||||
/*
|
||||
FreeRTOS V7.0.1 - Copyright (C) 2011 Real Time Engineers Ltd.
|
||||
|
||||
|
||||
***************************************************************************
|
||||
* *
|
||||
* FreeRTOS tutorial books are available in pdf and paperback. *
|
||||
* Complete, revised, and edited pdf reference manuals are also *
|
||||
* available. *
|
||||
* *
|
||||
* Purchasing FreeRTOS documentation will not only help you, by *
|
||||
* ensuring you get running as quickly as possible and with an *
|
||||
* in-depth knowledge of how to use FreeRTOS, it will also help *
|
||||
* the FreeRTOS project to continue with its mission of providing *
|
||||
* professional grade, cross platform, de facto standard solutions *
|
||||
* for microcontrollers - completely free of charge! *
|
||||
* *
|
||||
* >>> See http://www.FreeRTOS.org/Documentation for details. <<< *
|
||||
* *
|
||||
* Thank you for using FreeRTOS, and thank you for your support! *
|
||||
* *
|
||||
***************************************************************************
|
||||
|
||||
|
||||
This file is part of the FreeRTOS distribution.
|
||||
|
||||
FreeRTOS is free software; you can redistribute it and/or modify it under
|
||||
the terms of the GNU General Public License (version 2) as published by the
|
||||
Free Software Foundation AND MODIFIED BY the FreeRTOS exception.
|
||||
>>>NOTE<<< The modification to the GPL is included to allow you to
|
||||
distribute a combined work that includes FreeRTOS without being obliged to
|
||||
provide the source code for proprietary components outside of the FreeRTOS
|
||||
kernel. FreeRTOS is distributed in the hope that it will be useful, but
|
||||
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
||||
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||||
more details. You should have received a copy of the GNU General Public
|
||||
License and the FreeRTOS license exception along with FreeRTOS; if not it
|
||||
can be viewed here: http://www.freertos.org/a00114.html and also obtained
|
||||
by writing to Richard Barry, contact details for whom are available on the
|
||||
FreeRTOS WEB site.
|
||||
|
||||
1 tab == 4 spaces!
|
||||
|
||||
http://www.FreeRTOS.org - Documentation, latest information, license and
|
||||
contact details.
|
||||
|
||||
http://www.SafeRTOS.com - A version that is certified for use in safety
|
||||
critical systems.
|
||||
|
||||
http://www.OpenRTOS.com - Commercial support, development, porting,
|
||||
licensing and training services.
|
||||
*/
|
||||
|
||||
#ifndef COMMAND_INTERPRETER_H
|
||||
#define COMMAND_INTERPRETER_H
|
||||
|
||||
/* The prototype to which callback functions used to process command line
|
||||
commands must comply. This type will change when commands with parameters
|
||||
are included. */
|
||||
typedef const signed char * (*pdCOMMAND_LINE_CALLBACK)( void );
|
||||
|
||||
/* The structure that defines command line commands. A command line command
|
||||
should be defined by declaring a const structure of this type. */
|
||||
typedef struct xCOMMAND_LINE_INPUT
|
||||
{
|
||||
const signed char * const pcCommand; /* The command that causes pxCommandInterpreter to be executed. For example "help". Must be all lower case. */
|
||||
const signed char * const pcHelpString; /* String that describes how to use the command. Should start with the command itself, and end with "\r\n". For exxample "help: Returns a list of all the commands\r\n". */
|
||||
pdCOMMAND_LINE_CALLBACK pxCommandInterpreter; /* A pointer to the callback function that will return the output generated by the command. */
|
||||
const struct xCOMMAND_LINE_INPUT *pxNext; /* A pointer to the next xCommandLinInput structure. This should be NULL when the command is defined. It will get filled in automatically when the command is registered. */
|
||||
} xCommandLineInput;
|
||||
|
||||
/*
|
||||
* Register the command passed in using the pxCommandToRegister parameter.
|
||||
* Registering a command adds the command to the list of commands that are
|
||||
* handled by the command interpreter. Once a command has been registered it
|
||||
* can be executed from the command line.
|
||||
*/
|
||||
void vCmdIntRegisterCommand( const xCommandLineInput *pxCommandToRegister );
|
||||
|
||||
/*
|
||||
* Runns the command interpreter for the command string "pcCommandInput". If
|
||||
* pcCommandInput is valid (the command has been registered) a string will be
|
||||
* returned, and pcCmdIntProcessCommand must then be called repeatedly until
|
||||
* NULL is returned. If pcCommand pcCommandInput is not valid (the command is
|
||||
* not recognised as a registered command) then an error message will be
|
||||
* returned - and again pcCmdIntProcessCommand() must be called repeatedly
|
||||
* until NULL is returned.
|
||||
*
|
||||
* pcCmdIntProcessCommand is not reentrant. It must not be called from more
|
||||
* than one task - or at least - by more than one task at a time.
|
||||
*/
|
||||
const signed char *pcCmdIntProcessCommand( const signed char *pcCommandInput );
|
||||
|
||||
#endif /* COMMAND_INTERPRETER_H */
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Loading…
Reference in New Issue