68 lines
2.7 KiB
C
68 lines
2.7 KiB
C
/*
|
|
* FreeRTOS+CLI V1.0.4
|
|
* Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
* this software and associated documentation files (the "Software"), to deal in
|
|
* the Software without restriction, including without limitation the rights to
|
|
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
* the Software, and to permit persons to whom the Software is furnished to do so,
|
|
* subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in all
|
|
* copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*
|
|
* http://www.FreeRTOS.org
|
|
* http://aws.amazon.com/freertos
|
|
*
|
|
* 1 tab == 4 spaces!
|
|
*/
|
|
|
|
#ifndef FREERTOS_CLI_H_
|
|
#define FREERTOS_CLI_H_
|
|
|
|
#if CONFIG_OS
|
|
#include "portmacro.h"
|
|
|
|
#define CLI_ENTER_CRITICAL() portENTER_CRITICAL()
|
|
#define CLI_EXIT_CRITICAL() portEXIT_CRITICAL()
|
|
#else
|
|
#define CLI_ENTER_CRITICAL()
|
|
#define CLI_EXIT_CRITICAL()
|
|
#endif
|
|
|
|
/*
|
|
* 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.
|
|
*/
|
|
int CLIRegisterCommand( CLI_Command_Definition_t * pxCommandToRegister );
|
|
|
|
/*
|
|
* Runs the command interpreter for the command string "pcCommandInput". Any
|
|
* output generated by running the command will be placed into pcWriteBuffer.
|
|
* xWriteBufferLen must indicate the size, in bytes, of the buffer pointed to
|
|
* by pcWriteBuffer.
|
|
*
|
|
* CLIProcessCommand should be called repeatedly until it returns pdFALSE.
|
|
*
|
|
* 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.
|
|
*/
|
|
int CLIProcessCommand( const char * const pcCommandInput, char * pcWriteBuffer, size_t xWriteBufferLen );
|
|
|
|
/*
|
|
* Return a pointer to the xParameterNumber'th word in pcCommandString.
|
|
*/
|
|
const char *CLIGetParameter( const char *pcCommandString, uint32_t uxWantedParameter, int *pxParameterStringLength );
|
|
|
|
#endif /* FREERTOS_CLI_H_ */
|