FreeRTOS_CLI.h File Reference

Data Structures
struct	xCOMMAND_LINE_INPUT

Macros
#define	xCommandLineInput   CLI_Command_Definition_t

Typedefs
typedef struct xCOMMAND_LINE_INPUT	CLI_Command_Definition_t
typedef portBASE_TYPE(*	pdCOMMAND_LINE_CALLBACK )(int8_t *pcWriteBuffer, size_t xWriteBufferLen, const int8_t *pcCommandString)

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)

#define xCommandLineInput   CLI_Command_Definition_t

typedef struct xCOMMAND_LINE_INPUT CLI_Command_Definition_t

typedef portBASE_TYPE(* pdCOMMAND_LINE_CALLBACK)(int8_t *pcWriteBuffer, size_t xWriteBufferLen, const int8_t *pcCommandString)

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, xCOMMAND_INPUT_LIST::pxNext, and strncpy().

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.