michaelh/zephyr
1
0
Fork 0
Code Releases Activity

shell: internal api update in shell.h

Browse source 
Add Z_ prefix for internal macros.
Remove obsolete defines.

Signed-off-by: Jakub Rzeszutko <jakub.rzeszutko@nordicsemi.no>
This commit is contained in:
Jakub Rzeszutko 2020-12-07 12:32:18 +01:00 • committed by Carles Cufí
commit 52c999210f
3 changed files with 11 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

21
include/shell/shell.h
View file

@ -20,8 +20,6 @@
extern "C" { extern "C" {
#endif #endif
#define SHELL_RX_BUFF_SIZE 16
#ifndef CONFIG_SHELL_CMD_BUFF_SIZE #ifndef CONFIG_SHELL_CMD_BUFF_SIZE
#define CONFIG_SHELL_CMD_BUFF_SIZE 0 #define CONFIG_SHELL_CMD_BUFF_SIZE 0
#endif #endif
@ -34,7 +32,7 @@ extern "C" {
#define CONFIG_SHELL_HISTORY_BUFFER 0 #define CONFIG_SHELL_HISTORY_BUFFER 0
#endif #endif
#define SHELL_CMD_ROOT_LVL (0u) #define Z_SHELL_CMD_ROOT_LVL (0u)
#define SHELL_HEXDUMP_BYTES_IN_LINE 16 #define SHELL_HEXDUMP_BYTES_IN_LINE 16
@ -413,7 +411,7 @@ struct shell_static_entry {
SHELL_EXPR_CMD_ARG(_expr, _syntax, _subcmd, _help, _handler, 0, 0) SHELL_EXPR_CMD_ARG(_expr, _syntax, _subcmd, _help, _handler, 0, 0)
/* Internal macro used for creating handlers for dictionary commands. */ /* Internal macro used for creating handlers for dictionary commands. */
#define SHELL_CMD_DICT_HANDLER_CREATE(_data, _handler) \ #define Z_SHELL_CMD_DICT_HANDLER_CREATE(_data, _handler) \
static int UTIL_CAT(cmd_dict_, GET_ARG_N(1, __DEBRACKET _data))( \ static int UTIL_CAT(cmd_dict_, GET_ARG_N(1, __DEBRACKET _data))( \
const struct shell *shell, size_t argc, char **argv) \ const struct shell *shell, size_t argc, char **argv) \
{ \ { \
@ -457,7 +455,7 @@ static int UTIL_CAT(cmd_dict_, GET_ARG_N(1, __DEBRACKET _data))( \
* SHELL_CMD_REGISTER(dictionary, &sub_dict_cmds, NULL, NULL); * SHELL_CMD_REGISTER(dictionary, &sub_dict_cmds, NULL, NULL);
*/ */
#define SHELL_SUBCMD_DICT_SET_CREATE(_name, _handler, ...) \ #define SHELL_SUBCMD_DICT_SET_CREATE(_name, _handler, ...) \
FOR_EACH_FIXED_ARG(SHELL_CMD_DICT_HANDLER_CREATE, (), \ FOR_EACH_FIXED_ARG(Z_SHELL_CMD_DICT_HANDLER_CREATE, (), \
_handler, __VA_ARGS__) \ _handler, __VA_ARGS__) \
SHELL_STATIC_SUBCMD_SET_CREATE(_name, \ SHELL_STATIC_SUBCMD_SET_CREATE(_name, \
FOR_EACH(SHELL_CMD_DICT_CREATE, (,), __VA_ARGS__), \ FOR_EACH(SHELL_CMD_DICT_CREATE, (,), __VA_ARGS__), \
@ -591,11 +589,11 @@ struct shell_stats {
}; };
#ifdef CONFIG_SHELL_STATS #ifdef CONFIG_SHELL_STATS
#define SHELL_STATS_DEFINE(_name) static struct shell_stats _name##_stats #define Z_SHELL_STATS_DEFINE(_name) static struct shell_stats _name##_stats
#define SHELL_STATS_PTR(_name) (&(_name##_stats)) #define Z_SHELL_STATS_PTR(_name) (&(_name##_stats))
#else #else
#define SHELL_STATS_DEFINE(_name) #define Z_SHELL_STATS_DEFINE(_name)
#define SHELL_STATS_PTR(_name) NULL #define Z_SHELL_STATS_PTR(_name) NULL
#endif /* CONFIG_SHELL_STATS */ #endif /* CONFIG_SHELL_STATS */
/** /**
@ -617,7 +615,6 @@ struct shell_flags {
BUILD_ASSERT((sizeof(struct shell_flags) == sizeof(uint32_t)), BUILD_ASSERT((sizeof(struct shell_flags) == sizeof(uint32_t)),
"Structure must fit in 4 bytes"); "Structure must fit in 4 bytes");
/** /**
* @internal @brief Union for internal shell usage. * @internal @brief Union for internal shell usage.
*/ */
@ -739,7 +736,7 @@ extern void z_shell_print_stream(const void *user_ctx, const char *data,
CONFIG_SHELL_PRINTF_BUFF_SIZE, \ CONFIG_SHELL_PRINTF_BUFF_SIZE, \
true, z_shell_print_stream); \ true, z_shell_print_stream); \
LOG_INSTANCE_REGISTER(shell, _name, CONFIG_SHELL_LOG_LEVEL); \ LOG_INSTANCE_REGISTER(shell, _name, CONFIG_SHELL_LOG_LEVEL); \
SHELL_STATS_DEFINE(_name); \ Z_SHELL_STATS_DEFINE(_name); \
static K_KERNEL_STACK_DEFINE(_name##_stack, CONFIG_SHELL_STACK_SIZE); \ static K_KERNEL_STACK_DEFINE(_name##_stack, CONFIG_SHELL_STACK_SIZE); \
static struct k_thread _name##_thread; \ static struct k_thread _name##_thread; \
static const Z_STRUCT_SECTION_ITERABLE(shell, _name) = { \ static const Z_STRUCT_SECTION_ITERABLE(shell, _name) = { \
@ -750,7 +747,7 @@ extern void z_shell_print_stream(const void *user_ctx, const char *data,
&_name##_history : NULL, \ &_name##_history : NULL, \
.shell_flag = _shell_flag, \ .shell_flag = _shell_flag, \
.fprintf_ctx = &_name##_fprintf, \ .fprintf_ctx = &_name##_fprintf, \
.stats = SHELL_STATS_PTR(_name), \ .stats = Z_SHELL_STATS_PTR(_name), \
.log_backend = Z_SHELL_LOG_BACKEND_PTR(_name), \ .log_backend = Z_SHELL_LOG_BACKEND_PTR(_name), \
LOG_INSTANCE_PTR_INIT(log, shell, _name) \ LOG_INSTANCE_PTR_INIT(log, shell, _name) \
.thread_name = STRINGIFY(_name), \ .thread_name = STRINGIFY(_name), \

2
subsys/shell/shell.c
View file

@ -280,7 +280,7 @@ static bool tab_prepare(const struct shell *shell,
/* root command completion */ /* root command completion */
if ((*argc == 0) || ((space == 0) && (*argc == 1))) { if ((*argc == 0) || ((space == 0) && (*argc == 1))) {
*complete_arg_idx = SHELL_CMD_ROOT_LVL; *complete_arg_idx = Z_SHELL_CMD_ROOT_LVL;
*cmd = selected_cmd_get(shell); *cmd = selected_cmd_get(shell);
return true; return true;
} }

2
subsys/shell/shell_utils.c
View file

@ -310,7 +310,7 @@ const struct shell_static_entry *shell_get_last_command(
{ {
const struct shell_static_entry *prev_entry = NULL; const struct shell_static_entry *prev_entry = NULL;
*match_arg = SHELL_CMD_ROOT_LVL; *match_arg = Z_SHELL_CMD_ROOT_LVL;
while (*match_arg < argc) { while (*match_arg < argc) {