705 lines
26 KiB
C
705 lines
26 KiB
C
/**
|
|
* Copyright (c) 2017 - 2019, Nordic Semiconductor ASA
|
|
*
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without modification,
|
|
* are permitted provided that the following conditions are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright notice, this
|
|
* list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binary form, except as embedded into a Nordic
|
|
* Semiconductor ASA integrated circuit in a product or a software update for
|
|
* such product, must reproduce the above copyright notice, this list of
|
|
* conditions and the following disclaimer in the documentation and/or other
|
|
* materials provided with the distribution.
|
|
*
|
|
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
|
* contributors may be used to endorse or promote products derived from this
|
|
* software without specific prior written permission.
|
|
*
|
|
* 4. This software, with or without modification, must only be used with a
|
|
* Nordic Semiconductor ASA integrated circuit.
|
|
*
|
|
* 5. Any software provided in binary form under this license must not be reverse
|
|
* engineered, decompiled, modified and/or disassembled.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
|
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
|
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
|
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
*/
|
|
#ifndef NRF_CLI_H__
|
|
#define NRF_CLI_H__
|
|
|
|
#include "sdk_common.h"
|
|
#include "nrf_cli_types.h"
|
|
#include "nrf_section.h"
|
|
#include "nrf_log_backend_interface.h"
|
|
#include "nrf_queue.h"
|
|
#include "nrf_log_ctrl.h"
|
|
#include "app_util_platform.h"
|
|
#include "nrf_memobj.h"
|
|
|
|
#if NRF_MODULE_ENABLED(NRF_CLI_USES_TASK_MANAGER)
|
|
#include "task_manager.h"
|
|
#endif
|
|
|
|
#include "nrf_fprintf.h"
|
|
#include "nrf_fprintf_format.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#define NRF_CLI_RX_BUFF_SIZE 16
|
|
|
|
/* CLI reserves top task manager flags, bits 0...18 are available for application. */
|
|
#define NRF_CLI_TRANSPORT_TX_RDY_TASK_EVT (1UL << 19)
|
|
#define NRF_CLI_TRANSPORT_RX_RDY_TASK_EVT (1UL << 20)
|
|
#define NRF_CLI_LOG_PENDING_TASK_EVT (1UL << 21)
|
|
#define NRF_CLI_CMD_EXECUTE_EVT (1UL << 22)
|
|
#define NRF_CLI_KILL_TASK_EVT (1UL << 23)
|
|
|
|
#define NRF_CLI_TASK_EVTS (NRF_CLI_TRANSPORT_TX_RDY_TASK_EVT | \
|
|
NRF_CLI_TRANSPORT_RX_RDY_TASK_EVT | \
|
|
NRF_CLI_LOG_PENDING_TASK_EVT | \
|
|
NRF_CLI_CMD_EXECUTE_EVT | \
|
|
NRF_CLI_KILL_TASK_EVT)
|
|
/**
|
|
* @defgroup nrf_cli Command Line Interface
|
|
* @ingroup app_common
|
|
*
|
|
* @brief Module for unified command line handling.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief Aliases to: @ref nrf_cli, @ref nrf_cli_cmd_entry, and @ref nrf_cli_static_entry.
|
|
* Must be created here to satisfy module declaration order dependencies.
|
|
*/
|
|
typedef struct nrf_cli nrf_cli_t;
|
|
typedef struct nrf_cli_cmd_entry nrf_cli_cmd_entry_t;
|
|
typedef struct nrf_cli_static_entry nrf_cli_static_entry_t;
|
|
|
|
/**
|
|
* @brief CLI dynamic command descriptor.
|
|
*
|
|
* @details Function shall fill the received @ref nrf_cli_static_entry structure with requested (idx)
|
|
* dynamic subcommand data. If there is more than one dynamic subcommand available,
|
|
* the function shall ensure that the returned commands: p_static->p_syntax are sorted in
|
|
* alphabetical order. If idx exceeds the available dynamic subcommands, the function must write
|
|
* to p_static->p_syntax NULL value. This will indicate to the CLI module that
|
|
* there are no more dynamic commands to read.
|
|
*/
|
|
typedef void (*nrf_cli_dynamic_get)(size_t idx, nrf_cli_static_entry_t * p_static);
|
|
|
|
/**
|
|
* @brief CLI command descriptor.
|
|
*/
|
|
struct nrf_cli_cmd_entry
|
|
{
|
|
bool is_dynamic;
|
|
union
|
|
{
|
|
nrf_cli_dynamic_get p_dynamic_get; //!< Pointer to function returning dynamic commands.
|
|
nrf_cli_static_entry_t const * p_static; //!< Pointer to array of static commands.
|
|
} u;
|
|
};
|
|
|
|
/**
|
|
* @brief CLI command handler prototype.
|
|
*/
|
|
typedef void (*nrf_cli_cmd_handler)(nrf_cli_t const * p_cli, size_t argc, char **argv);
|
|
|
|
/**
|
|
* @brief CLI static command descriptor.
|
|
*/
|
|
struct nrf_cli_static_entry
|
|
{
|
|
char const * p_syntax; //!< Command syntax strings.
|
|
char const * p_help; //!< Command help string.
|
|
|
|
nrf_cli_cmd_entry_t const * p_subcmd; //!< Pointer to subcommand.
|
|
|
|
nrf_cli_cmd_handler handler; //!< Command handler.
|
|
};
|
|
|
|
/**
|
|
* @brief Macro for defining and adding a root command (level 0).
|
|
*
|
|
* @note Each root command shall have unique syntax.
|
|
*
|
|
* @param[in] p_syntax Command syntax (for example: history).
|
|
* @param[in] p_subcmd Pointer to a subcommands array.
|
|
* @param[in] p_help Pointer to a command help string.
|
|
* @param[in] p_handler Pointer to a function handler.
|
|
*/
|
|
#define NRF_CLI_CMD_REGISTER(p_syntax, p_subcmd, p_help, p_handler) \
|
|
nrf_cli_static_entry_t const CONCAT_3(nrf_cli_, p_syntax, _raw) = \
|
|
NRF_CLI_CMD(p_syntax, p_subcmd, p_help, p_handler); \
|
|
NRF_SECTION_ITEM_REGISTER(cli_command, \
|
|
nrf_cli_cmd_entry_t const CONCAT_3(nrf_cli_, p_syntax, _const)) = { \
|
|
.is_dynamic = false, \
|
|
.u = {.p_static = &CONCAT_3(nrf_cli_, p_syntax, _raw)} \
|
|
}; \
|
|
NRF_SECTION_ITEM_REGISTER(cli_sorted_cmd_ptrs, char const * CONCAT_2(p_syntax, _str_ptr))
|
|
|
|
/**
|
|
* @brief Macro for creating a subcommand set. It must be used outside of any function body.
|
|
*
|
|
* @param[in] name Name of the subcommand set.
|
|
*/
|
|
#define NRF_CLI_CREATE_STATIC_SUBCMD_SET(name) \
|
|
/*lint -save -e85 -e31*/ \
|
|
static nrf_cli_static_entry_t const CONCAT_2(name, _raw)[]; \
|
|
static nrf_cli_cmd_entry_t const name = { \
|
|
.is_dynamic = false, \
|
|
.u = {.p_static = CONCAT_2(name, _raw) } \
|
|
}; \
|
|
static nrf_cli_static_entry_t const CONCAT_2(name, _raw)[] = /*lint -restore*/
|
|
|
|
/**
|
|
* @brief Define ending subcommands set.
|
|
*
|
|
*/
|
|
#define NRF_CLI_SUBCMD_SET_END {NULL}
|
|
|
|
/**
|
|
* @brief Macro for creating a dynamic entry.
|
|
*
|
|
* @param[in] name Name of the dynamic entry.
|
|
* @param[in] p_get Pointer to the function returning dynamic commands array @ref nrf_cli_dynamic_get.
|
|
*/
|
|
#define NRF_CLI_CREATE_DYNAMIC_CMD(name, p_get) \
|
|
/*lint -save -e19*/ \
|
|
static nrf_cli_cmd_entry_t const name = { \
|
|
.is_dynamic = true, \
|
|
.u = { .p_dynamic_get = p_get } \
|
|
}; /*lint -restore*/
|
|
|
|
/** @brief Macro for creating subcommands when C++ compiler is used.
|
|
*
|
|
* Example usage:
|
|
* @code
|
|
* NRF_CLI_CPP_CREATE_STATIC_SUBCMD_SET(cmd_syntax,
|
|
* NRF_CLI_CMD(abc, ...),
|
|
* NRF_CLI_CMD(def, ...),
|
|
* NRF_CLI_SUBCMD_SET_END
|
|
* );
|
|
* @endcode
|
|
*/
|
|
#define NRF_CLI_CPP_CREATE_STATIC_SUBCMD_SET(name, ...) \
|
|
static nrf_cli_static_entry_t const CONCAT_2(name, _raw)[] = { \
|
|
__VA_ARGS__ \
|
|
}; \
|
|
static nrf_cli_cmd_entry_t const name = { \
|
|
.is_dynamic = false, \
|
|
.u = { .p_static = CONCAT_2(name, _raw) } \
|
|
}
|
|
|
|
/**
|
|
* @brief Initializes a CLI command (@ref nrf_cli_static_entry).
|
|
*
|
|
* @param[in] _p_syntax Command syntax (for example: history).
|
|
* @param[in] _p_subcmd Pointer to a subcommands array.
|
|
* @param[in] _p_help Pointer to a command help string.
|
|
* @param[in] _p_handler Pointer to a function handler.
|
|
*/
|
|
#define NRF_CLI_CMD(_p_syntax, _p_subcmd, _p_help, _p_handler) { \
|
|
.p_syntax = (const char *) STRINGIFY(_p_syntax), \
|
|
.p_help = (const char *) _p_help, \
|
|
.p_subcmd = _p_subcmd, \
|
|
.handler = _p_handler \
|
|
}
|
|
|
|
/**
|
|
* @internal @brief Internal CLI state in response to data received from the terminal.
|
|
*/
|
|
typedef enum
|
|
{
|
|
NRF_CLI_RECEIVE_DEFAULT,
|
|
NRF_CLI_RECEIVE_ESC,
|
|
NRF_CLI_RECEIVE_ESC_SEQ,
|
|
NRF_CLI_RECEIVE_TILDE_EXP
|
|
} nrf_cli_receive_t;
|
|
|
|
|
|
/**
|
|
* @internal @brief Internal CLI state.
|
|
*/
|
|
typedef enum
|
|
{
|
|
NRF_CLI_STATE_UNINITIALIZED, //!< State uninitialized.
|
|
NRF_CLI_STATE_INITIALIZED, //!< State initialized but not active.
|
|
NRF_CLI_STATE_ACTIVE, //!< State active.
|
|
NRF_CLI_STATE_PANIC_MODE_ACTIVE, //!< State panic mode activated.
|
|
NRF_CLI_STATE_PANIC_MODE_INACTIVE //!< State panic mode requested but not supported.
|
|
} nrf_cli_state_t;
|
|
|
|
/**
|
|
* @brief Event type from CLI transport.
|
|
*/
|
|
typedef enum
|
|
{
|
|
NRF_CLI_TRANSPORT_EVT_RX_RDY,
|
|
NRF_CLI_TRANSPORT_EVT_TX_RDY
|
|
} nrf_cli_transport_evt_t;
|
|
|
|
typedef void (*nrf_cli_transport_handler_t)(nrf_cli_transport_evt_t evt_type, void * p_context);
|
|
|
|
typedef struct nrf_cli_transport_s nrf_cli_transport_t;
|
|
|
|
/**
|
|
* @brief Unified CLI transport interface.
|
|
*/
|
|
typedef struct
|
|
{
|
|
/**
|
|
* @brief Function for initializing the CLI transport interface.
|
|
*
|
|
* @param[in] p_transport Pointer to the transfer instance.
|
|
* @param[in] p_config Pointer to instance configuration.
|
|
* @param[in] evt_handler Event handler.
|
|
* @param[in] p_context Pointer to the context passed to event handler.
|
|
*
|
|
* @return Standard error code.
|
|
*/
|
|
ret_code_t (*init)(nrf_cli_transport_t const * p_transport,
|
|
void const * p_config,
|
|
nrf_cli_transport_handler_t evt_handler,
|
|
void * p_context);
|
|
|
|
/**
|
|
* @brief Function for uninitializing the CLI transport interface.
|
|
*
|
|
* @param[in] p_transport Pointer to the transfer instance.
|
|
*
|
|
* @return Standard error code.
|
|
*/
|
|
ret_code_t (*uninit)(nrf_cli_transport_t const * p_transport);
|
|
|
|
/**
|
|
* @brief Function for reconfiguring the transport to work in blocking mode.
|
|
*
|
|
* @param p_transport Pointer to the transfer instance.
|
|
* @param blocking If true, the transport is enabled in blocking mode.
|
|
*
|
|
* @return NRF_SUCCESS on successful enabling, error otherwise (also if not supported).
|
|
*/
|
|
ret_code_t (*enable)(nrf_cli_transport_t const * p_transport,
|
|
bool blocking);
|
|
|
|
/**
|
|
* @brief Function for writing data to the transport interface.
|
|
*
|
|
* @param[in] p_transport Pointer to the transfer instance.
|
|
* @param[in] p_data Pointer to the source buffer.
|
|
* @param[in] length Source buffer length.
|
|
* @param[in] p_cnt Pointer to the sent bytes counter.
|
|
*
|
|
* @return Standard error code.
|
|
*/
|
|
ret_code_t (*write)(nrf_cli_transport_t const * p_transport,
|
|
const void * p_data,
|
|
size_t length,
|
|
size_t * p_cnt);
|
|
|
|
/**
|
|
* @brief Function for reading data from the transport interface.
|
|
*
|
|
* @param[in] p_transport Pointer to the transfer instance.
|
|
* @param[in] p_data Pointer to the destination buffer.
|
|
* @param[in] length Destination buffer length.
|
|
* @param[in] p_cnt Pointer to the received bytes counter.
|
|
*
|
|
* @return Standard error code.
|
|
*/
|
|
ret_code_t (*read)(nrf_cli_transport_t const * p_transport,
|
|
void * p_data,
|
|
size_t length,
|
|
size_t * p_cnt);
|
|
|
|
} nrf_cli_transport_api_t;
|
|
|
|
struct nrf_cli_transport_s
|
|
{
|
|
nrf_cli_transport_api_t const * p_api;
|
|
};
|
|
|
|
#if NRF_MODULE_ENABLED(NRF_CLI_HISTORY)
|
|
/**
|
|
* @brief CLI history object header.
|
|
*/
|
|
typedef PACKED_STRUCT
|
|
{
|
|
nrf_memobj_t * p_prev; //!< Pointer to the next object.
|
|
nrf_memobj_t * p_next; //!< Pointer to the previous object.
|
|
nrf_cli_cmd_len_t cmd_len; //!< Command length.
|
|
} nrf_cli_memobj_header_t;
|
|
#endif
|
|
|
|
#if NRF_MODULE_ENABLED(NRF_CLI_STATISTICS)
|
|
typedef struct
|
|
{
|
|
uint32_t log_lost_cnt; //!< Lost log counter.
|
|
} nrf_cli_statistics_t;
|
|
#endif
|
|
|
|
/**
|
|
* @internal @brief Flags for internal CLI usage.
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint32_t insert_mode : 1; //!< Enables or disables console insert mode for text introduction.
|
|
uint32_t show_help : 1; //!< Shows help if the command was called with -h or --help parameter.
|
|
uint32_t use_colors : 1; //!< Enables or disables colored syntax.
|
|
uint32_t echo : 1; //!< Enables or disables CLI echo.
|
|
uint32_t processing : 1; //!< CLI is executing process function.
|
|
uint32_t tx_rdy : 1;
|
|
uint32_t last_nl : 8; //!< The last received newline character.
|
|
} nrf_cli_flag_t;
|
|
STATIC_ASSERT(sizeof(nrf_cli_flag_t) == sizeof(uint32_t));
|
|
|
|
/**
|
|
* @internal @brief Union for internal CLI usage.
|
|
*/
|
|
typedef union
|
|
{
|
|
uint32_t value;
|
|
nrf_cli_flag_t flag;
|
|
} nrf_cli_internal_t;
|
|
|
|
/**
|
|
* @brief CLI instance context.
|
|
*/
|
|
typedef struct
|
|
{
|
|
nrf_cli_state_t state; //!< Internal module state.
|
|
nrf_cli_receive_t receive_state; //!< Escape sequence indicator.
|
|
|
|
nrf_cli_static_entry_t active_cmd; //!< Currently executed command
|
|
|
|
nrf_cli_vt100_ctx_t vt100_ctx; //!< VT100 color and cursor position, terminal width.
|
|
|
|
nrf_cli_cmd_len_t cmd_buff_len; //!< Command length.
|
|
nrf_cli_cmd_len_t cmd_buff_pos; //!< Command buffer cursor position.
|
|
|
|
#if NRF_MODULE_ENABLED(NRF_CLI_WILDCARD)
|
|
nrf_cli_cmd_len_t cmd_tmp_buff_len; //!< Command length in tmp buffer
|
|
#endif
|
|
|
|
char cmd_buff[NRF_CLI_CMD_BUFF_SIZE]; //!< Command input buffer.
|
|
char temp_buff[NRF_CLI_CMD_BUFF_SIZE]; //!< Temporary buffer used by various functions.
|
|
char printf_buff[NRF_CLI_PRINTF_BUFF_SIZE]; //!< Printf buffer size.
|
|
|
|
#if NRF_MODULE_ENABLED(NRF_CLI_STATISTICS)
|
|
nrf_cli_statistics_t statistics; //!< CLI statistics.
|
|
#endif
|
|
|
|
#if NRF_MODULE_ENABLED(NRF_CLI_USES_TASK_MANAGER)
|
|
task_id_t task_id;
|
|
#endif
|
|
|
|
#if NRF_MODULE_ENABLED(NRF_CLI_HISTORY)
|
|
nrf_memobj_t * p_cmd_list_head; //!< Pointer to the head of history list.
|
|
nrf_memobj_t * p_cmd_list_tail; //!< Pointer to the tail of history list.
|
|
nrf_memobj_t * p_cmd_list_element; //!< Pointer to an element of history list.
|
|
#endif
|
|
volatile nrf_cli_internal_t internal; //!< Internal CLI data
|
|
} nrf_cli_ctx_t;
|
|
|
|
extern const nrf_log_backend_api_t nrf_log_backend_cli_api;
|
|
|
|
typedef struct
|
|
{
|
|
nrf_queue_t const * p_queue;
|
|
void * p_context;
|
|
nrf_cli_t const * p_cli;
|
|
} nrf_cli_log_backend_t;
|
|
|
|
#if NRF_CLI_LOG_BACKEND && NRF_MODULE_ENABLED(NRF_LOG)
|
|
#define NRF_LOG_BACKEND_CLI_DEF(_name_, _queue_size_) \
|
|
NRF_QUEUE_DEF(nrf_log_entry_t, \
|
|
CONCAT_2(_name_, _queue),_queue_size_, NRF_QUEUE_MODE_NO_OVERFLOW); \
|
|
static nrf_cli_log_backend_t CONCAT_2(cli_log_backend,_name_) = { \
|
|
.p_queue = &CONCAT_2(_name_, _queue), \
|
|
}; \
|
|
NRF_LOG_BACKEND_DEF(_name_, nrf_log_backend_cli_api, &CONCAT_2(cli_log_backend,_name_))
|
|
|
|
#define NRF_CLI_BACKEND_PTR(_name_) &CONCAT_2(_name_, _log_backend)
|
|
#else
|
|
#define NRF_LOG_BACKEND_CLI_DEF(_name_, _queue_sz_)
|
|
#define NRF_CLI_BACKEND_PTR(_name_) NULL
|
|
#endif
|
|
|
|
#if NRF_MODULE_ENABLED(NRF_CLI_HISTORY)
|
|
/* Header consists memory for cmd length and pointer to: prev and next element. */
|
|
#define NRF_CLI_HISTORY_HEADER_SIZE (sizeof(nrf_cli_memobj_header_t))
|
|
|
|
#define NRF_CLI_HISTORY_MEM_OBJ(name) \
|
|
NRF_MEMOBJ_POOL_DEF(CONCAT_2(name, _cmd_hist_memobj), \
|
|
NRF_CLI_HISTORY_HEADER_SIZE + \
|
|
NRF_CLI_HISTORY_ELEMENT_SIZE, \
|
|
NRF_CLI_HISTORY_ELEMENT_COUNT)
|
|
|
|
#define NRF_CLI_MEMOBJ_PTR(_name_) &CONCAT_2(_name_, _cmd_hist_memobj)
|
|
#else
|
|
#define NRF_CLI_MEMOBJ_PTR(_name_) NULL
|
|
#define NRF_CLI_HISTORY_MEM_OBJ(name)
|
|
#endif
|
|
|
|
/**
|
|
* @brief CLI instance internals.
|
|
*
|
|
* @ref nrf_cli_t
|
|
*/
|
|
struct nrf_cli
|
|
{
|
|
char const * const p_name; //!< Terminal name.
|
|
|
|
nrf_cli_transport_t const * p_iface; //!< Transport interface.
|
|
nrf_cli_ctx_t * p_ctx; //!< Internal context.
|
|
nrf_log_backend_t const * p_log_backend; //!< Logger backend.
|
|
nrf_fprintf_ctx_t * p_fprintf_ctx; //!< fprintf context.
|
|
nrf_memobj_pool_t const * p_cmd_hist_mempool; //!< Memory reserved for commands history.
|
|
};
|
|
|
|
/**
|
|
* @brief Macro for defining a command line interface instance.
|
|
*
|
|
* @param[in] name Instance name.
|
|
* @param[in] cli_prefix CLI prefix string.
|
|
* @param[in] p_transport_iface Pointer to the transport interface.
|
|
* @param[in] newline_ch Deprecated parameter, not used any more. Any uint8_t value can be used.
|
|
* @param[in] log_queue_size Logger processing queue size.
|
|
*/
|
|
#define NRF_CLI_DEF(name, cli_prefix, p_transport_iface, newline_ch, log_queue_size) \
|
|
static nrf_cli_t const name; \
|
|
static nrf_cli_ctx_t CONCAT_2(name, _ctx); \
|
|
NRF_FPRINTF_DEF(CONCAT_2(name, _fprintf_ctx), \
|
|
&name, \
|
|
CONCAT_2(name, _ctx).printf_buff, \
|
|
NRF_CLI_PRINTF_BUFF_SIZE, \
|
|
false, \
|
|
nrf_cli_print_stream); \
|
|
NRF_LOG_BACKEND_CLI_DEF(CONCAT_2(name, _log_backend), log_queue_size); \
|
|
NRF_CLI_HISTORY_MEM_OBJ(name); \
|
|
/*lint -save -e31*/ \
|
|
static nrf_cli_t const name = { \
|
|
.p_name = cli_prefix, \
|
|
.p_iface = p_transport_iface, \
|
|
.p_ctx = &CONCAT_2(name, _ctx), \
|
|
.p_log_backend = NRF_CLI_BACKEND_PTR(name), \
|
|
.p_fprintf_ctx = &CONCAT_2(name, _fprintf_ctx), \
|
|
.p_cmd_hist_mempool = NRF_CLI_MEMOBJ_PTR(name), \
|
|
} /*lint -restore*/
|
|
|
|
/**
|
|
* @brief Function for initializing a transport layer and internal CLI state.
|
|
*
|
|
* @param[in] p_cli Pointer to CLI instance.
|
|
* @param[in] p_transport_config Configuration forwarded to the transport during initialization.
|
|
* @param[in] use_colors Enables colored prints.
|
|
* @param[in] log_backend If true, the console will be used as logger backend.
|
|
* @param[in] init_lvl Default severity level for the logger.
|
|
*
|
|
* @return Standard error code.
|
|
*/
|
|
ret_code_t nrf_cli_init(nrf_cli_t const * p_cli,
|
|
void const * p_transport_config,
|
|
bool use_colors,
|
|
bool log_backend,
|
|
nrf_log_severity_t init_lvl);
|
|
|
|
ret_code_t nrf_cli_task_create(nrf_cli_t const * p_cli);
|
|
|
|
/**
|
|
* @brief Function for uninitializing a transport layer and internal CLI state.
|
|
* If function returns NRF_ERROR_BUSY, you must call @ref nrf_cli_process before calling
|
|
* nrf_cli_uninit again.
|
|
*
|
|
* @param p_cli Pointer to CLI instance.
|
|
*
|
|
* @return Standard error code.
|
|
*/
|
|
ret_code_t nrf_cli_uninit(nrf_cli_t const * p_cli);
|
|
|
|
/**
|
|
* @brief Function for starting CLI processing.
|
|
*
|
|
* @param p_cli Pointer to the CLI instance.
|
|
*
|
|
* @return Standard error code.
|
|
*/
|
|
ret_code_t nrf_cli_start(nrf_cli_t const * p_cli);
|
|
|
|
/**
|
|
* @brief Function for stopping CLI processing.
|
|
*
|
|
* @param p_cli Pointer to CLI instance.
|
|
*
|
|
* @return Standard error code.
|
|
*/
|
|
ret_code_t nrf_cli_stop(nrf_cli_t const * p_cli);
|
|
|
|
/**
|
|
* @brief CLI colors for @ref nrf_cli_fprintf function.
|
|
*/
|
|
#define NRF_CLI_DEFAULT NRF_CLI_VT100_COLOR_DEFAULT /**< Turn off character attributes. */
|
|
#define NRF_CLI_NORMAL NRF_CLI_VT100_COLOR_WHITE /**< Normal color printf. */
|
|
#define NRF_CLI_INFO NRF_CLI_VT100_COLOR_GREEN /**< Info color printf. */
|
|
#define NRF_CLI_OPTION NRF_CLI_VT100_COLOR_CYAN /**< Option color printf. */
|
|
#define NRF_CLI_WARNING NRF_CLI_VT100_COLOR_YELLOW /**< Warning color printf. */
|
|
#define NRF_CLI_ERROR NRF_CLI_VT100_COLOR_RED /**< Error color printf. */
|
|
|
|
/**
|
|
* @brief Printf-like function which sends formatted data stream to the CLI.
|
|
* This function shall not be used outside of the CLI module or CLI command context.
|
|
*
|
|
* @param[in] p_cli Pointer to the CLI instance.
|
|
* @param[in] color Printf color.
|
|
* @param[in] p_fmt Format string.
|
|
* @param[in] ... List of parameters to print.
|
|
*/
|
|
void nrf_cli_fprintf(nrf_cli_t const * p_cli,
|
|
nrf_cli_vt100_color_t color,
|
|
char const * p_fmt,
|
|
...);
|
|
|
|
/**
|
|
* @brief Print an info message to the CLI.
|
|
*
|
|
* See @ref nrf_cli_fprintf.
|
|
*
|
|
* @param[in] _p_cli Pointer to the CLI instance.
|
|
* @param[in] _ft Format string.
|
|
* @param[in] ... List of parameters to print.
|
|
*/
|
|
#define nrf_cli_info(_p_cli, _ft, ...) \
|
|
nrf_cli_fprintf(_p_cli, NRF_CLI_INFO, _ft "\n", ##__VA_ARGS__)
|
|
|
|
/**
|
|
* @brief Print a normal message to the CLI.
|
|
*
|
|
* See @ref nrf_cli_fprintf.
|
|
*
|
|
* @param[in] _p_cli Pointer to the CLI instance.
|
|
* @param[in] _ft Format string.
|
|
* @param[in] ... List of parameters to print.
|
|
*/
|
|
#define nrf_cli_print(_p_cli, _ft, ...) \
|
|
nrf_cli_fprintf(_p_cli, NRF_CLI_DEFAULT, _ft "\n", ##__VA_ARGS__)
|
|
|
|
/**
|
|
* @brief Print a warning message to the CLI.
|
|
*
|
|
* See @ref nrf_cli_fprintf.
|
|
*
|
|
* @param[in] _p_cli Pointer to the CLI instance.
|
|
* @param[in] _ft Format string.
|
|
* @param[in] ... List of parameters to print.
|
|
*/
|
|
#define nrf_cli_warn(_p_cli, _ft, ...) \
|
|
nrf_cli_fprintf(_p_cli, NRF_CLI_WARNING, _ft "\n", ##__VA_ARGS__)
|
|
|
|
/**
|
|
* @brief Print an error message to the CLI.
|
|
*
|
|
* See @ref nrf_cli_fprintf.
|
|
*
|
|
* @param[in] _p_cli Pointer to the CLI instance.
|
|
* @param[in] _ft Format string.
|
|
* @param[in] ... List of parameters to print.
|
|
*/
|
|
#define nrf_cli_error(_p_cli, _ft, ...) \
|
|
nrf_cli_fprintf(_p_cli, NRF_CLI_ERROR, _ft "\n", ##__VA_ARGS__)
|
|
|
|
/**
|
|
* @brief Process function, which should be executed when data is ready in the transport interface.
|
|
*
|
|
* @param[in] p_cli Pointer to the CLI instance.
|
|
*/
|
|
void nrf_cli_process(nrf_cli_t const * p_cli);
|
|
|
|
|
|
/**
|
|
* @brief Option descriptor.
|
|
*/
|
|
typedef struct nrf_cli_getopt_option
|
|
{
|
|
char const * p_optname; //!< Option long name.
|
|
char const * p_optname_short; //!< Option short name.
|
|
char const * p_optname_help; //!< Option help string.
|
|
} nrf_cli_getopt_option_t;
|
|
|
|
|
|
/**
|
|
* @brief Option structure initializer @ref nrf_cli_getopt_option.
|
|
*
|
|
* @param[in] _p_optname Option name long.
|
|
* @param[in] _p_shortname Option name short.
|
|
* @param[in] _p_help Option help string.
|
|
*/
|
|
#define NRF_CLI_OPT(_p_optname, _p_shortname, _p_help) { \
|
|
.p_optname = _p_optname, \
|
|
.p_optname_short = _p_shortname, \
|
|
.p_optname_help = _p_help, \
|
|
}
|
|
|
|
/**
|
|
* @brief Informs that a command has been called with -h or --help option.
|
|
*
|
|
* @param[in] p_cli Pointer to the CLI instance.
|
|
*
|
|
* @return True if help has been requested.
|
|
*/
|
|
__STATIC_INLINE bool nrf_cli_help_requested(nrf_cli_t const * p_cli);
|
|
|
|
#ifndef SUPPRESS_INLINE_IMPLEMENTATION
|
|
__STATIC_INLINE bool nrf_cli_help_requested(nrf_cli_t const * p_cli)
|
|
{
|
|
return p_cli->p_ctx->internal.flag.show_help;
|
|
}
|
|
#endif
|
|
|
|
/**
|
|
* @brief Prints the current command help.
|
|
* @details Function will print a help string with: the currently entered command, its options,
|
|
* and subcommands (if they exist).
|
|
*
|
|
* @param[in] p_cli Pointer to the CLI instance.
|
|
* @param[in] p_opt Pointer to the optional option array.
|
|
* @param[in] opt_len Option array size.
|
|
*/
|
|
void nrf_cli_help_print(nrf_cli_t const * p_cli,
|
|
nrf_cli_getopt_option_t const * p_opt,
|
|
size_t opt_len);
|
|
|
|
/**
|
|
* @internal @brief This function shall not be used directly, it is required by the
|
|
* nrf_fprintf module.
|
|
*
|
|
* @param[in] p_user_ctx Pointer to the context for the CLI instance.
|
|
* @param[in] p_data Pointer to the data buffer.
|
|
* @param[in] data_len Data buffer size.
|
|
*/
|
|
void nrf_cli_print_stream(void const * p_user_ctx, char const * p_data, size_t data_len);
|
|
|
|
/** @} */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* NRF_CLI_H__ */
|