163 lines
4.0 KiB
C
163 lines
4.0 KiB
C
/* shell.h - Shell header */
|
|
|
|
/*
|
|
* Copyright (c) 2015 Intel Corporation
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#ifndef _SHELL_H_
|
|
#define _SHELL_H_
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
|
|
struct device;
|
|
|
|
/** @brief Callback called when command is entered.
|
|
*
|
|
* @param argc Number of parameters passed.
|
|
* @param argv Array of option strings. First option is always command name.
|
|
*
|
|
* @return 0 in case of success or negative value in case of error.
|
|
*/
|
|
typedef int (*shell_cmd_function_t)(int argc, char *argv[]);
|
|
|
|
struct shell_cmd {
|
|
const char *cmd_name;
|
|
shell_cmd_function_t cb;
|
|
const char *help;
|
|
};
|
|
|
|
/** @brief Callback to get the current prompt.
|
|
*
|
|
* @returns Current prompt string.
|
|
*/
|
|
typedef const char *(*shell_prompt_function_t)(void);
|
|
|
|
struct shell_module {
|
|
const char *module_name;
|
|
const struct shell_cmd *commands;
|
|
shell_prompt_function_t prompt;
|
|
};
|
|
|
|
|
|
/**
|
|
* @brief Kernel Shell API
|
|
* @defgroup _shell_api_functions Shell API Functions
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @def SHELL_REGISTER
|
|
*
|
|
* @brief Create shell_module object and set it up for boot time initialization.
|
|
*
|
|
* @details This macro defines a shell_module object that is automatically
|
|
* configured by the kernel during system initialization.
|
|
*
|
|
* @param _name Module name to be entered in shell console.
|
|
* @param _commands Array of commands to register.
|
|
* Shell array entries must be packed to calculate array size correctly.
|
|
*/
|
|
|
|
/**
|
|
* @def SHELL_REGISTER_WITH_PROMPT
|
|
*
|
|
* @brief Create shell_module object and set it up for boot time initialization.
|
|
*
|
|
* @details This macro defines a shell_module object that is automatically
|
|
* configured by the kernel during system initialization, in addition to that
|
|
* this also enables setting a custom prompt handler when the module is
|
|
* selected.
|
|
*
|
|
* @param _name Module name to be entered in shell console.
|
|
* @param _commands Array of commands to register.
|
|
* Shell array entries must be packed to calculate array size correctly.
|
|
* @param _prompt Optional prompt handler to be set when module is selected.
|
|
*/
|
|
#ifdef CONFIG_CONSOLE_SHELL
|
|
#define SHELL_REGISTER(_name, _commands) \
|
|
SHELL_REGISTER_WITH_PROMPT(_name, _commands, NULL)
|
|
|
|
#define SHELL_REGISTER_WITH_PROMPT(_name, _commands, _prompt) \
|
|
\
|
|
static struct shell_module (__shell__name) __used \
|
|
__attribute__((__section__(".shell_"))) = { \
|
|
.module_name = _name, \
|
|
.commands = _commands, \
|
|
.prompt = _prompt \
|
|
}
|
|
#else
|
|
#define SHELL_REGISTER(_name, _commands)
|
|
#define SHELL_REGISTER_WITH_PROMPT(_name, _commands, _prompt)
|
|
#endif
|
|
|
|
/** @brief Initialize shell with optional prompt, NULL in case no prompt is
|
|
* needed.
|
|
*
|
|
* @param prompt Prompt to be printed on serial console.
|
|
*/
|
|
void shell_init(const char *prompt);
|
|
|
|
/** @brief Optionally register an app default cmd handler.
|
|
*
|
|
* @param handler To be called if no cmd found in cmds registered with
|
|
* shell_init.
|
|
*/
|
|
void shell_register_app_cmd_handler(shell_cmd_function_t handler);
|
|
|
|
/** @brief Optionally register a custom prompt callback.
|
|
*
|
|
* @param handler To be called to get the current prompt.
|
|
*/
|
|
void shell_register_prompt_handler(shell_prompt_function_t handler);
|
|
|
|
/** @brief Optionally register a default module, to eliminate typing it in
|
|
* shell console or for backwards compatibility.
|
|
*
|
|
* @param name Module name.
|
|
*/
|
|
void shell_register_default_module(const char *name);
|
|
|
|
/** @brief Execute command line.
|
|
*
|
|
* Pass command line to shell to execute. The line cannot be a C string literal
|
|
* since it will be modified in place, instead a variable can be used:
|
|
*
|
|
* char cmd[] = "command";
|
|
* shell_exec(cmd);
|
|
*
|
|
* Note: This by no means makes any of the commands a stable interface, so
|
|
* this function should only be used for debugging/diagnostic.
|
|
*
|
|
* @param line Command line to be executed
|
|
* @returns Result of the execution
|
|
*/
|
|
int shell_exec(char *line);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
|
|
#ifdef CONFIG_CONSOLE_SHELL
|
|
int shell_run(struct device *dev);
|
|
#else
|
|
static inline int shell_run(struct device *dev)
|
|
{
|
|
ARG_UNUSED(dev);
|
|
|
|
return 0;
|
|
}
|
|
#endif
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _SHELL_H_ */
|