FreeRTOS_CLI.c File Reference

#include <string.h>
#include <stdint.h>
#include "include/FreeRTOS.h"
#include "include/task.h"
#include "include/FreeRTOS_CLI.h"

Data Structures
struct	xCOMMAND_INPUT_LIST

Typedefs
typedef struct xCOMMAND_INPUT_LIST	CLI_Definition_List_Item_t

Functions
int8_t *	FreeRTOS_CLIGetOutputBuffer (void)
const int8_t *	FreeRTOS_CLIGetParameter (const int8_t *pcCommandString, unsigned portBASE_TYPE uxWantedParameter, portBASE_TYPE *pxParameterStringLength)
portBASE_TYPE	FreeRTOS_CLIProcessCommand (const int8_t *const pcCommandInput, int8_t *pcWriteBuffer, size_t xWriteBufferLen)
portBASE_TYPE	FreeRTOS_CLIRegisterCommand (const CLI_Command_Definition_t *const pxCommandToRegister)
static int8_t	prvGetNumberOfParameters (const int8_t *pcCommandString)
static portBASE_TYPE	prvHelpCommand (int8_t *pcWriteBuffer, size_t xWriteBufferLen, const int8_t *pcCommandString)

Variables
static int8_t	cOutputBuffer [configCOMMAND_INT_MAX_OUTPUT_SIZE]
static const CLI_Command_Definition_t	xHelpCommand
static CLI_Definition_List_Item_t	xRegisteredCommands

typedef struct xCOMMAND_INPUT_LIST CLI_Definition_List_Item_t

int8_t* FreeRTOS_CLIGetOutputBuffer

(

void

)

References cOutputBuffer.

const int8_t* FreeRTOS_CLIGetParameter	(	const int8_t *	pcCommandString,
		unsigned portBASE_TYPE	uxWantedParameter,
		portBASE_TYPE *	pxParameterStringLength
	)

References NULL.

portBASE_TYPE FreeRTOS_CLIProcessCommand	(	const int8_t *const	pcCommandInput,
		int8_t *	pcWriteBuffer,
		size_t	xWriteBufferLen
	)

References xCOMMAND_LINE_INPUT::cExpectedNumberOfParameters, NULL, xCOMMAND_LINE_INPUT::pcCommand, pdFALSE, pdTRUE, prvGetNumberOfParameters(), xCOMMAND_LINE_INPUT::pxCommandInterpreter, xCOMMAND_INPUT_LIST::pxCommandLineDefinition, and xCOMMAND_INPUT_LIST::pxNext.

portBASE_TYPE FreeRTOS_CLIRegisterCommand

(

const CLI_Command_Definition_t *const

pxCommandToRegister

)

References configASSERT, NULL, pdFAIL, pdPASS, pvPortMalloc(), xCOMMAND_INPUT_LIST::pxCommandLineDefinition, xCOMMAND_INPUT_LIST::pxNext, taskENTER_CRITICAL, taskEXIT_CRITICAL, and xRegisteredCommands.

static int8_t prvGetNumberOfParameters ( const int8_t *  pcCommandString )

static

References pdFALSE, and pdTRUE.

Referenced by FreeRTOS_CLIProcessCommand().

static portBASE_TYPE prvHelpCommand ( int8_t *  pcWriteBuffer, size_t  xWriteBufferLen, const int8_t *  pcCommandString  )

static

References NULL, xCOMMAND_LINE_INPUT::pcHelpString, pdFALSE, pdTRUE, xCOMMAND_INPUT_LIST::pxCommandLineDefinition, xCOMMAND_INPUT_LIST::pxNext, and xRegisteredCommands.

int8_t cOutputBuffer[configCOMMAND_INT_MAX_OUTPUT_SIZE]

static

Referenced by FreeRTOS_CLIGetOutputBuffer().

const CLI_Command_Definition_t xHelpCommand

static

Initial value:

=
{
    ( const int8_t * const ) "help",
    ( const int8_t * const ) "\r\nhelp:\r\n Lists all the registered commands\r\n\r\n",
    prvHelpCommand,
    0
}

CLI_Definition_List_Item_t xRegisteredCommands

static

Initial value:

=
{
    &xHelpCommand,  
    NULL            
}

Referenced by FreeRTOS_CLIRegisterCommand(), and prvHelpCommand().