Zephyr Project API 4.2.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
shell.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2018 Nordic Semiconductor ASA
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#ifndef SHELL_H__
8#define SHELL_H__
9
10#include <zephyr/kernel.h>
17#include <zephyr/logging/log.h>
19#include <zephyr/sys/util.h>
20#include <zephyr/toolchain.h>
21
22#if defined CONFIG_SHELL_GETOPT
23#include <getopt.h>
24#endif
25
26#ifdef __cplusplus
27extern "C" {
28#endif
29
30#ifndef CONFIG_SHELL_PROMPT_BUFF_SIZE
31#define CONFIG_SHELL_PROMPT_BUFF_SIZE 0
32#endif
33
34#ifndef CONFIG_SHELL_CMD_BUFF_SIZE
35#define CONFIG_SHELL_CMD_BUFF_SIZE 0
36#endif
37
38#ifndef CONFIG_SHELL_PRINTF_BUFF_SIZE
39#define CONFIG_SHELL_PRINTF_BUFF_SIZE 0
40#endif
41
42#ifndef CONFIG_SHELL_HISTORY_BUFFER
43#define CONFIG_SHELL_HISTORY_BUFFER 0
44#endif
45
46#define Z_SHELL_CMD_ROOT_LVL (0u)
47
48#define SHELL_HEXDUMP_BYTES_IN_LINE 16
49
61#define SHELL_OPT_ARG_RAW (0xFE)
62
66#define SHELL_OPT_ARG_CHECK_SKIP (0xFF)
67
72#define SHELL_OPT_ARG_MAX (0xFD)
73
84
96typedef void (*shell_dynamic_get)(size_t idx,
97 struct shell_static_entry *entry);
98
109
110struct shell;
111
116
132const struct device *shell_device_lookup(size_t idx,
133 const char *prefix);
134
151const struct device *shell_device_lookup_all(size_t idx,
152 const char *prefix);
153
169const struct device *shell_device_lookup_non_ready(size_t idx,
170 const char *prefix);
171
182typedef bool (*shell_device_filter_t)(const struct device *dev);
183
197const struct device *shell_device_filter(size_t idx,
198 shell_device_filter_t filter);
199
220const struct device *shell_device_get_binding(const char *name);
221
237const struct device *shell_device_get_binding_all(const char *name);
238
251typedef int (*shell_cmd_handler)(const struct shell *sh,
252 size_t argc, char **argv);
253
267typedef int (*shell_dict_cmd_handler)(const struct shell *sh, size_t argc,
268 char **argv, void *data);
269
270/* When entries are added to the memory section a padding is applied for
271 * the posix architecture with 64bits builds and x86_64 targets. Adding padding to allow handle data
272 * in the memory section as array.
273 */
274#if (defined(CONFIG_ARCH_POSIX) && defined(CONFIG_64BIT)) || defined(CONFIG_X86_64)
275#define Z_SHELL_STATIC_ENTRY_PADDING 24
276#else
277#define Z_SHELL_STATIC_ENTRY_PADDING 0
278#endif
279
280/*
281 * @brief Shell static command descriptor.
282 */
284 const char *syntax;
285 const char *help;
286 const union shell_cmd_entry *subcmd;
289 uint8_t padding[Z_SHELL_STATIC_ENTRY_PADDING];
290};
291
300 /* @cond INTERNAL_HIDDEN */
301 uint32_t magic;
302 /* @endcond */
303 const char *description;
304 const char *usage;
305};
306
315#define SHELL_STRUCTURED_HELP_MAGIC 0x86D20BC4
316
327static inline bool shell_help_is_structured(const char *help)
328{
329 const struct shell_cmd_help *structured = (const struct shell_cmd_help *)help;
330
331 return structured != NULL && IS_PTR_ALIGNED(structured, struct shell_cmd_help) &&
332 structured->magic == SHELL_STRUCTURED_HELP_MAGIC;
333}
334
335#if defined(CONFIG_SHELL_HELP) || defined(__DOXYGEN__)
359#define SHELL_HELP(_description, _usage) \
360 ((const char *)&(const struct shell_cmd_help){ \
361 .magic = SHELL_STRUCTURED_HELP_MAGIC, \
362 .description = (_description), \
363 .usage = (_usage), \
364 })
365#else
366#define SHELL_HELP(_description, _usage) NULL
367#endif /* CONFIG_SHELL_HELP */
368
384#define SHELL_CMD_ARG_REGISTER(syntax, subcmd, help, handler, \
385 mandatory, optional) \
386 static const struct shell_static_entry UTIL_CAT(_shell_, syntax) = \
387 SHELL_CMD_ARG(syntax, subcmd, help, handler, mandatory, optional); \
388 static const TYPE_SECTION_ITERABLE(union shell_cmd_entry, \
389 UTIL_CAT(shell_cmd_, syntax), shell_root_cmds, \
390 UTIL_CAT(shell_cmd_, syntax) \
391 ) = { \
392 .entry = &UTIL_CAT(_shell_, syntax) \
393 }
394
415#define SHELL_COND_CMD_ARG_REGISTER(flag, syntax, subcmd, help, handler, \
416 mandatory, optional) \
417 COND_CODE_1(\
418 flag, \
419 (\
420 SHELL_CMD_ARG_REGISTER(syntax, subcmd, help, handler, \
421 mandatory, optional) \
422 ), \
423 (\
424 static shell_cmd_handler dummy_##syntax##_handler __unused = \
425 handler;\
426 static const union shell_cmd_entry *dummy_subcmd_##syntax \
427 __unused = subcmd\
428 ) \
429 )
441#define SHELL_CMD_REGISTER(syntax, subcmd, help, handler) \
442 SHELL_CMD_ARG_REGISTER(syntax, subcmd, help, handler, 0, 0)
443
457#define SHELL_COND_CMD_REGISTER(flag, syntax, subcmd, help, handler) \
458 SHELL_COND_CMD_ARG_REGISTER(flag, syntax, subcmd, help, handler, 0, 0)
459
478#define SHELL_STATIC_SUBCMD_SET_CREATE(name, ...) \
479 static const struct shell_static_entry shell_##name[] = { \
480 __VA_ARGS__ \
481 }; \
482 static const union shell_cmd_entry name = { \
483 .entry = shell_##name \
484 }
485
486#define Z_SHELL_UNDERSCORE(x) _##x
487#define Z_SHELL_SUBCMD_NAME(...) \
488 UTIL_CAT(shell_subcmds, MACRO_MAP_CAT(Z_SHELL_UNDERSCORE, __VA_ARGS__))
489#define Z_SHELL_SUBCMD_SECTION_TAG(...) MACRO_MAP_CAT(Z_SHELL_UNDERSCORE, __VA_ARGS__)
490#define Z_SHELL_SUBCMD_SET_SECTION_TAG(x) \
491 Z_SHELL_SUBCMD_SECTION_TAG(NUM_VA_ARGS_LESS_1 x, __DEBRACKET x)
492#define Z_SHELL_SUBCMD_ADD_SECTION_TAG(x, y) \
493 Z_SHELL_SUBCMD_SECTION_TAG(NUM_VA_ARGS_LESS_1 x, __DEBRACKET x, y)
494
507#define SHELL_SUBCMD_SET_CREATE(_name, _parent) \
508 static const TYPE_SECTION_ITERABLE(struct shell_static_entry, _name, shell_subcmds, \
509 Z_SHELL_SUBCMD_SET_SECTION_TAG(_parent))
510
511
531#define SHELL_SUBCMD_COND_ADD(_flag, _parent, _syntax, _subcmd, _help, _handler, \
532 _mand, _opt) \
533 COND_CODE_1(_flag, \
534 (static const TYPE_SECTION_ITERABLE(struct shell_static_entry, \
535 Z_SHELL_SUBCMD_NAME(__DEBRACKET _parent, _syntax), \
536 shell_subcmds, \
537 Z_SHELL_SUBCMD_ADD_SECTION_TAG(_parent, _syntax)) = \
538 SHELL_EXPR_CMD_ARG(1, _syntax, _subcmd, _help, \
539 _handler, _mand, _opt)\
540 ), \
541 (static shell_cmd_handler dummy_handler_##_syntax __unused = _handler;\
542 static const union shell_cmd_entry dummy_subcmd_##_syntax __unused = { \
543 .entry = (const struct shell_static_entry *)_subcmd\
544 } \
545 ) \
546 )
547
560#define SHELL_SUBCMD_ADD(_parent, _syntax, _subcmd, _help, _handler, _mand, _opt) \
561 SHELL_SUBCMD_COND_ADD(1, _parent, _syntax, _subcmd, _help, _handler, _mand, _opt)
562
567#define SHELL_SUBCMD_SET_END {0}
568
575#define SHELL_DYNAMIC_CMD_CREATE(name, get) \
576 static const TYPE_SECTION_ITERABLE(union shell_cmd_entry, name, \
577 shell_dynamic_subcmds, name) = \
578 { \
579 .dynamic_get = get \
580 }
581
595#define SHELL_CMD_ARG(syntax, subcmd, help, handler, mand, opt) \
596 SHELL_EXPR_CMD_ARG(1, syntax, subcmd, help, handler, mand, opt)
597
617#define SHELL_COND_CMD_ARG(flag, syntax, subcmd, help, handler, mand, opt) \
618 SHELL_EXPR_CMD_ARG(IS_ENABLED(flag), syntax, subcmd, help, \
619 handler, mand, opt)
620
640#define SHELL_EXPR_CMD_ARG(_expr, _syntax, _subcmd, _help, _handler, \
641 _mand, _opt) \
642 { \
643 .syntax = (_expr) ? (const char *)STRINGIFY(_syntax) : "", \
644 .help = (_expr) ? (const char *)_help : NULL, \
645 .subcmd = (const union shell_cmd_entry *)((_expr) ? \
646 _subcmd : NULL), \
647 .handler = (shell_cmd_handler)((_expr) ? _handler : NULL), \
648 .args = { .mandatory = _mand, .optional = _opt} \
649 }
650
659#define SHELL_CMD(_syntax, _subcmd, _help, _handler) \
660 SHELL_CMD_ARG(_syntax, _subcmd, _help, _handler, 0, 0)
661
674#define SHELL_COND_CMD(_flag, _syntax, _subcmd, _help, _handler) \
675 SHELL_COND_CMD_ARG(_flag, _syntax, _subcmd, _help, _handler, 0, 0)
676
690#define SHELL_EXPR_CMD(_expr, _syntax, _subcmd, _help, _handler) \
691 SHELL_EXPR_CMD_ARG(_expr, _syntax, _subcmd, _help, _handler, 0, 0)
692
693/* Internal macro used for creating handlers for dictionary commands. */
694#define Z_SHELL_CMD_DICT_HANDLER_CREATE(_data, _handler) \
695static int UTIL_CAT(UTIL_CAT(cmd_dict_, UTIL_CAT(_handler, _)), \
696 GET_ARG_N(1, __DEBRACKET _data))( \
697 const struct shell *sh, size_t argc, char **argv) \
698{ \
699 return _handler(sh, argc, argv, \
700 (void *)GET_ARG_N(2, __DEBRACKET _data)); \
701}
702
703/* Internal macro used for creating dictionary commands. */
704#define SHELL_CMD_DICT_CREATE(_data, _handler) \
705 SHELL_CMD_ARG(GET_ARG_N(1, __DEBRACKET _data), NULL, GET_ARG_N(3, __DEBRACKET _data), \
706 UTIL_CAT(UTIL_CAT(cmd_dict_, UTIL_CAT(_handler, _)), \
707 GET_ARG_N(1, __DEBRACKET _data)), 1, 0)
708
742#define SHELL_SUBCMD_DICT_SET_CREATE(_name, _handler, ...) \
743 FOR_EACH_FIXED_ARG(Z_SHELL_CMD_DICT_HANDLER_CREATE, (), \
744 _handler, __VA_ARGS__) \
745 SHELL_STATIC_SUBCMD_SET_CREATE(_name, \
746 FOR_EACH_FIXED_ARG(SHELL_CMD_DICT_CREATE, (,), _handler, __VA_ARGS__), \
747 SHELL_SUBCMD_SET_END \
748 )
749
760
771
777
779 void *context);
780
781
782typedef void (*shell_uninit_cb_t)(const struct shell *sh, int res);
783
790typedef void (*shell_bypass_cb_t)(const struct shell *sh,
791 uint8_t *data,
792 size_t len);
793
794struct shell_transport;
795
812 int (*init)(const struct shell_transport *transport,
813 const void *config,
814 shell_transport_handler_t evt_handler,
815 void *context);
816
824 int (*uninit)(const struct shell_transport *transport);
825
838 int (*enable)(const struct shell_transport *transport,
839 bool blocking_tx);
840
851 int (*write)(const struct shell_transport *transport,
852 const void *data, size_t length, size_t *cnt);
853
864 int (*read)(const struct shell_transport *transport,
865 void *data, size_t length, size_t *cnt);
866
874 void (*update)(const struct shell_transport *transport);
875
876};
877
880 void *ctx;
881};
882
889
890#ifdef CONFIG_SHELL_STATS
891#define Z_SHELL_STATS_DEFINE(_name) static struct shell_stats _name##_stats
892#define Z_SHELL_STATS_PTR(_name) (&(_name##_stats))
893#else
894#define Z_SHELL_STATS_DEFINE(_name)
895#define Z_SHELL_STATS_PTR(_name) NULL
896#endif /* CONFIG_SHELL_STATS */
897
909
910BUILD_ASSERT((sizeof(struct shell_backend_config_flags) == sizeof(uint32_t)),
911 "Structure must fit in 4 bytes");
912
916#define SHELL_DEFAULT_BACKEND_CONFIG_FLAGS \
917{ \
918 .insert_mode = 0, \
919 .echo = 1, \
920 .obscure = IS_ENABLED(CONFIG_SHELL_START_OBSCURED), \
921 .mode_delete = 1, \
922 .use_colors = 1, \
923 .use_vt100 = 1, \
924};
925
936
937BUILD_ASSERT((sizeof(struct shell_backend_ctx_flags) == sizeof(uint32_t)),
938 "Structure must fit in 4 bytes");
939
947
955
962
966struct shell_ctx {
967#if defined(CONFIG_SHELL_PROMPT_CHANGE) && CONFIG_SHELL_PROMPT_CHANGE
969#else
970 const char *prompt;
971#endif
972
978
981
984
989
992
995
996#if defined CONFIG_SHELL_GETOPT
998 struct getopt_state getopt;
999#endif
1000
1008
1011
1014
1015 volatile union shell_backend_cfg cfg;
1016 volatile union shell_backend_ctx ctx;
1017
1019
1023};
1024
1025extern const struct log_backend_api log_backend_shell_api;
1026
1034
1038struct shell {
1039 const char *default_prompt;
1041 const struct shell_transport *iface;
1042 struct shell_ctx *ctx;
1045
1047
1049
1051
1053
1055
1056 const char *name;
1059};
1060
1061extern void z_shell_print_stream(const void *user_ctx, const char *data,
1062 size_t data_len);
1063
1076#define Z_SHELL_DEFINE(_name, _prompt, _transport_iface, _out_buf, _log_backend, _shell_flag) \
1077 static const struct shell _name; \
1078 static struct shell_ctx UTIL_CAT(_name, _ctx); \
1079 Z_SHELL_HISTORY_DEFINE(_name##_history, CONFIG_SHELL_HISTORY_BUFFER); \
1080 Z_SHELL_FPRINTF_DEFINE(_name##_fprintf, &_name, _out_buf, CONFIG_SHELL_PRINTF_BUFF_SIZE, \
1081 IS_ENABLED(CONFIG_SHELL_PRINTF_AUTOFLUSH), z_shell_print_stream); \
1082 LOG_INSTANCE_REGISTER(shell, _name, CONFIG_SHELL_LOG_LEVEL); \
1083 Z_SHELL_STATS_DEFINE(_name); \
1084 static K_KERNEL_STACK_DEFINE(_name##_stack, CONFIG_SHELL_STACK_SIZE); \
1085 static struct k_thread _name##_thread; \
1086 static const STRUCT_SECTION_ITERABLE(shell, _name) = { \
1087 .default_prompt = _prompt, \
1088 .iface = _transport_iface, \
1089 .ctx = &UTIL_CAT(_name, _ctx), \
1090 .history = IS_ENABLED(CONFIG_SHELL_HISTORY) ? &_name##_history : NULL, \
1091 .shell_flag = _shell_flag, \
1092 .fprintf_ctx = &_name##_fprintf, \
1093 .stats = Z_SHELL_STATS_PTR(_name), \
1094 .log_backend = _log_backend, \
1095 LOG_INSTANCE_PTR_INIT(log, shell, _name).name = \
1096 STRINGIFY(_name), .thread = &_name##_thread, .stack = _name##_stack}
1097
1111#define SHELL_DEFINE(_name, _prompt, _transport_iface, _log_queue_size, _log_timeout, _shell_flag) \
1112 static uint8_t _name##_out_buffer[CONFIG_SHELL_PRINTF_BUFF_SIZE]; \
1113 Z_SHELL_LOG_BACKEND_DEFINE(_name, _name##_out_buffer, CONFIG_SHELL_PRINTF_BUFF_SIZE, \
1114 _log_queue_size, _log_timeout); \
1115 Z_SHELL_DEFINE(_name, _prompt, _transport_iface, _name##_out_buffer, \
1116 Z_SHELL_LOG_BACKEND_PTR(_name), _shell_flag)
1117
1131int shell_init(const struct shell *sh, const void *transport_config,
1132 struct shell_backend_config_flags cfg_flags,
1133 bool log_backend, uint32_t init_log_level);
1134
1141void shell_uninit(const struct shell *sh, shell_uninit_cb_t cb);
1142
1150int shell_start(const struct shell *sh);
1151
1159int shell_stop(const struct shell *sh);
1160
1164#define SHELL_NORMAL SHELL_VT100_COLOR_DEFAULT
1165
1169#define SHELL_INFO SHELL_VT100_COLOR_GREEN
1170
1174#define SHELL_OPTION SHELL_VT100_COLOR_CYAN
1175
1179#define SHELL_WARNING SHELL_VT100_COLOR_YELLOW
1180
1184#define SHELL_ERROR SHELL_VT100_COLOR_RED
1185
1197void __printf_like(3, 4) shell_fprintf_impl(const struct shell *sh, enum shell_vt100_color color,
1198 const char *fmt, ...);
1199
1200#define shell_fprintf(sh, color, fmt, ...) shell_fprintf_impl(sh, color, fmt, ##__VA_ARGS__)
1201
1214void shell_vfprintf(const struct shell *sh, enum shell_vt100_color color,
1215 const char *fmt, va_list args);
1216
1232void shell_hexdump_line(const struct shell *sh, unsigned int offset,
1233 const uint8_t *data, size_t len);
1234
1242void shell_hexdump(const struct shell *sh, const uint8_t *data, size_t len);
1243
1253#define shell_info(_sh, _ft, ...) \
1254 shell_fprintf_info(_sh, _ft "\n", ##__VA_ARGS__)
1255void __printf_like(2, 3) shell_fprintf_info(const struct shell *sh, const char *fmt, ...);
1256
1266#define shell_print(_sh, _ft, ...) \
1267 shell_fprintf_normal(_sh, _ft "\n", ##__VA_ARGS__)
1268void __printf_like(2, 3) shell_fprintf_normal(const struct shell *sh, const char *fmt, ...);
1269
1279#define shell_warn(_sh, _ft, ...) \
1280 shell_fprintf_warn(_sh, _ft "\n", ##__VA_ARGS__)
1281void __printf_like(2, 3) shell_fprintf_warn(const struct shell *sh, const char *fmt, ...);
1282
1292#define shell_error(_sh, _ft, ...) \
1293 shell_fprintf_error(_sh, _ft "\n", ##__VA_ARGS__)
1294void __printf_like(2, 3) shell_fprintf_error(const struct shell *sh, const char *fmt, ...);
1295
1302void shell_process(const struct shell *sh);
1303
1313int shell_prompt_change(const struct shell *sh, const char *prompt);
1314
1323void shell_help(const struct shell *sh);
1324
1326#define SHELL_CMD_HELP_PRINTED (1)
1327
1345int shell_execute_cmd(const struct shell *sh, const char *cmd);
1346
1358int shell_set_root_cmd(const char *cmd);
1359
1368void shell_set_bypass(const struct shell *sh, shell_bypass_cb_t bypass);
1369
1377bool shell_ready(const struct shell *sh);
1378
1389int shell_insert_mode_set(const struct shell *sh, bool val);
1390
1402int shell_use_colors_set(const struct shell *sh, bool val);
1403
1414int shell_use_vt100_set(const struct shell *sh, bool val);
1415
1426int shell_echo_set(const struct shell *sh, bool val);
1427
1439int shell_obscure_set(const struct shell *sh, bool obscure);
1440
1452int shell_mode_delete_set(const struct shell *sh, bool val);
1453
1461int shell_get_return_value(const struct shell *sh);
1462
1467#ifdef __cplusplus
1468}
1469#endif
1470
1471#ifdef CONFIG_SHELL_CUSTOM_HEADER
1472/* This include must always be at the end of shell.h */
1473#include <zephyr_custom_shell.h>
1474#endif
1475
1476#endif /* SHELL_H__ */
struct z_thread_stack_element k_thread_stack_t
Typedef of struct z_thread_stack_element.
Definition arch_interface.h:46
long atomic_t
Definition atomic_types.h:15
static void cmd(uint32_t command)
Execute a display list command by co-processor engine.
Definition ft8xx_reference_api.h:153
static bool shell_help_is_structured(const char *help)
Check if help string is structured help.
Definition shell.h:327
void shell_uninit(const struct shell *sh, shell_uninit_cb_t cb)
Uninitializes the transport layer and the internal shell state.
void(* shell_uninit_cb_t)(const struct shell *sh, int res)
Definition shell.h:782
void shell_hexdump_line(const struct shell *sh, unsigned int offset, const uint8_t *data, size_t len)
Print a line of data in hexadecimal format.
int(* shell_dict_cmd_handler)(const struct shell *sh, size_t argc, char **argv, void *data)
Shell dictionary command handler prototype.
Definition shell.h:267
int shell_prompt_change(const struct shell *sh, const char *prompt)
Change displayed shell prompt.
void(* shell_transport_handler_t)(enum shell_transport_evt evt, void *context)
Definition shell.h:778
int shell_mode_delete_set(const struct shell *sh, bool val)
Allow application to control whether the delete key backspaces or deletes.
void shell_fprintf_info(const struct shell *sh, const char *fmt,...)
int(* shell_cmd_handler)(const struct shell *sh, size_t argc, char **argv)
Shell command handler prototype.
Definition shell.h:251
void shell_fprintf_error(const struct shell *sh, const char *fmt,...)
int shell_get_return_value(const struct shell *sh)
Retrieve return value of most recently executed shell command.
shell_flag
Flags for setting shell output newline sequence.
Definition shell.h:1030
const struct device * shell_device_lookup(size_t idx, const char *prefix)
Get by index a device that matches .
shell_signal
Definition shell.h:956
void shell_fprintf_normal(const struct shell *sh, const char *fmt,...)
void shell_vfprintf(const struct shell *sh, enum shell_vt100_color color, const char *fmt, va_list args)
vprintf-like function which sends formatted data stream to the shell.
void shell_set_bypass(const struct shell *sh, shell_bypass_cb_t bypass)
Set bypass callback.
int shell_set_root_cmd(const char *cmd)
Set root command for all shell instances.
bool shell_ready(const struct shell *sh)
Get shell readiness to execute commands.
int shell_use_colors_set(const struct shell *sh, bool val)
Allow application to control whether terminal output uses colored syntax.
void shell_process(const struct shell *sh)
Process function, which should be executed when data is ready in the transport interface.
const struct device * shell_device_get_binding(const char *name)
Get a device reference from its device::name field or label.
int shell_use_vt100_set(const struct shell *sh, bool val)
Allow application to control whether terminal is using vt100 commands.
void shell_fprintf_impl(const struct shell *sh, enum shell_vt100_color color, const char *fmt,...)
printf-like function which sends formatted data stream to the shell.
int shell_obscure_set(const struct shell *sh, bool obscure)
Allow application to control whether user input is obscured with asterisks – useful for implementing ...
int shell_init(const struct shell *sh, const void *transport_config, struct shell_backend_config_flags cfg_flags, bool log_backend, uint32_t init_log_level)
Function for initializing a transport layer and internal shell state.
shell_receive_state
Definition shell.h:754
const struct device * shell_device_lookup_all(size_t idx, const char *prefix)
Get by index a device that matches .
const struct device * shell_device_get_binding_all(const char *name)
Get a device reference from its device::name field or label.
void shell_fprintf_warn(const struct shell *sh, const char *fmt,...)
const struct device * shell_device_lookup_non_ready(size_t idx, const char *prefix)
Get by index a non-initialized device that matches .
bool(* shell_device_filter_t)(const struct device *dev)
Filter callback type, for use with shell_device_lookup_filter.
Definition shell.h:182
void(* shell_bypass_cb_t)(const struct shell *sh, uint8_t *data, size_t len)
Bypass callback.
Definition shell.h:790
int shell_execute_cmd(const struct shell *sh, const char *cmd)
Execute command.
void shell_help(const struct shell *sh)
Prints the current command help.
int shell_stop(const struct shell *sh)
Function for stopping shell processing.
int shell_start(const struct shell *sh)
Function for starting shell processing.
int shell_echo_set(const struct shell *sh, bool val)
Allow application to control whether user input is echoed back.
const struct log_backend_api log_backend_shell_api
const struct device * shell_device_filter(size_t idx, shell_device_filter_t filter)
Get a device by index and filter.
shell_transport_evt
Shell transport event.
Definition shell.h:773
void shell_hexdump(const struct shell *sh, const uint8_t *data, size_t len)
Print data in hexadecimal format.
int shell_insert_mode_set(const struct shell *sh, bool val)
Allow application to control text insert mode.
shell_state
Definition shell.h:764
void(* shell_dynamic_get)(size_t idx, struct shell_static_entry *entry)
Shell dynamic command descriptor.
Definition shell.h:96
@ SHELL_FLAG_CRLF_DEFAULT
Do not map CR or LF.
Definition shell.h:1031
@ SHELL_FLAG_OLF_CRLF
Map LF to CRLF on output.
Definition shell.h:1032
@ SHELL_SIGNAL_TXDONE
Definition shell.h:960
@ SHELL_SIGNAL_RXRDY
Definition shell.h:957
@ SHELL_SIGNAL_LOG_MSG
Definition shell.h:958
@ SHELL_SIGNAL_KILL
Definition shell.h:959
@ SHELL_RECEIVE_DEFAULT
Definition shell.h:755
@ SHELL_RECEIVE_ESC_SEQ
Definition shell.h:757
@ SHELL_RECEIVE_ESC
Definition shell.h:756
@ SHELL_RECEIVE_TILDE_EXP
Definition shell.h:758
@ SHELL_TRANSPORT_EVT_TX_RDY
Definition shell.h:775
@ SHELL_TRANSPORT_EVT_RX_RDY
Definition shell.h:774
@ SHELL_STATE_UNINITIALIZED
Definition shell.h:765
@ SHELL_STATE_PANIC_MODE_INACTIVE
Panic requested, not supported.
Definition shell.h:769
@ SHELL_STATE_ACTIVE
Definition shell.h:767
@ SHELL_STATE_PANIC_MODE_ACTIVE
Panic activated.
Definition shell.h:768
@ SHELL_STATE_INITIALIZED
Definition shell.h:766
#define BIT(n)
Unsigned integer with bit position n set (signed in assembly language).
Definition util_macro.h:44
#define NULL
Definition iar_missing_defs.h:20
#define IS_PTR_ALIGNED(ptr, type)
Definition common.h:232
Public kernel APIs.
flags
Definition parser.h:97
#define CONFIG_SHELL_PROMPT_BUFF_SIZE
Definition shell.h:31
#define CONFIG_SHELL_CMD_BUFF_SIZE
Definition shell.h:35
#define CONFIG_SHELL_PRINTF_BUFF_SIZE
Definition shell.h:39
shell_vt100_color
Definition shell_types.h:14
#define bool
Definition stdbool.h:13
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
Runtime device structure (in ROM) per driver instance.
Definition device.h:510
const char * name
Name of the device instance.
Definition device.h:512
Event Structure.
Definition kernel.h:2356
Semaphore structure.
Definition kernel.h:3275
Thread Structure.
Definition thread.h:262
Logger backend API.
Definition log_backend.h:63
Logger backend structure.
Definition log_backend.h:95
Definition shell.h:901
uint32_t use_vt100
Controls VT100 commands usage in shell.
Definition shell.h:907
uint32_t mode_delete
Operation mode of backspace key.
Definition shell.h:905
uint32_t echo
Controls shell echo.
Definition shell.h:903
uint32_t insert_mode
Controls insert mode for text introduction.
Definition shell.h:902
uint32_t obscure
If echo on, print asterisk instead.
Definition shell.h:904
uint32_t use_colors
Controls colored syntax.
Definition shell.h:906
Definition shell.h:926
uint32_t print_noinit
Print request from not initialized shell.
Definition shell.h:932
uint32_t sync_mode
Shell in synchronous mode.
Definition shell.h:933
uint32_t tx_rdy
Definition shell.h:928
uint32_t handle_log
Shell is handling logger backend.
Definition shell.h:934
uint32_t processing
Shell is executing process function.
Definition shell.h:927
uint32_t last_nl
Last received new line character.
Definition shell.h:930
uint32_t history_exit
Request to exit history mode.
Definition shell.h:929
uint32_t cmd_ctx
Shell is executing command.
Definition shell.h:931
Shell structured help descriptor.
Definition shell.h:299
const char * usage
Command usage string.
Definition shell.h:304
const char * description
Command description.
Definition shell.h:303
Shell instance context.
Definition shell.h:966
const struct shell_static_entry * selected_cmd
New root command.
Definition shell.h:980
shell_uninit_cb_t uninit_cb
Callback called from shell thread context when unitialization is completed just before aborting shell...
Definition shell.h:988
struct k_event signal_event
Definition shell.h:1018
struct shell_vt100_ctx vt100_ctx
VT100 color and cursor position, terminal width.
Definition shell.h:983
const char * prompt
Definition shell.h:970
k_tid_t tid
Definition shell.h:1021
char temp_buff[0]
Command temporary buffer.
Definition shell.h:1010
char cmd_buff[0]
Command input buffer.
Definition shell.h:1007
struct shell_static_entry active_cmd
Currently executed command.
Definition shell.h:977
uint32_t log_level
Definition shell.h:994
volatile union shell_backend_cfg cfg
Definition shell.h:1015
uint16_t cmd_tmp_buff_len
Command length in tmp buffer.
Definition shell.h:1004
enum shell_state state
Internal module state.
Definition shell.h:973
shell_bypass_cb_t bypass
When bypass is set, all incoming data is passed to the callback.
Definition shell.h:991
uint16_t cmd_buff_len
Command length.
Definition shell.h:1001
uint16_t cmd_buff_pos
Command buffer cursor position.
Definition shell.h:1002
int ret_val
Definition shell.h:1022
char printf_buff[0]
Printf buffer size.
Definition shell.h:1013
enum shell_receive_state receive_state
Escape sequence indicator.
Definition shell.h:974
volatile union shell_backend_ctx ctx
Definition shell.h:1016
struct k_sem lock_sem
Definition shell.h:1020
fprintf context
Definition shell_fprintf.h:29
Definition shell_history.h:21
Shell log backend instance structure (RO data).
Definition shell_log_backend.h:36
Definition shell.h:112
uint8_t mandatory
Number of mandatory arguments.
Definition shell.h:113
uint8_t optional
Number of optional arguments.
Definition shell.h:114
Definition shell.h:283
const union shell_cmd_entry * subcmd
Pointer to subcommand.
Definition shell.h:286
uint8_t padding[0]
Definition shell.h:289
shell_cmd_handler handler
Command handler.
Definition shell.h:287
struct shell_static_args args
Command arguments.
Definition shell.h:288
const char * help
Command help string.
Definition shell.h:285
const char * syntax
Command syntax strings.
Definition shell.h:284
Shell statistics structure.
Definition shell.h:886
atomic_t log_lost_cnt
Lost log counter.
Definition shell.h:887
Unified shell transport interface.
Definition shell.h:800
void(* update)(const struct shell_transport *transport)
Function called in shell thread loop.
Definition shell.h:874
int(* init)(const struct shell_transport *transport, const void *config, shell_transport_handler_t evt_handler, void *context)
Function for initializing the shell transport interface.
Definition shell.h:812
int(* write)(const struct shell_transport *transport, const void *data, size_t length, size_t *cnt)
Function for writing data to the transport interface.
Definition shell.h:851
int(* uninit)(const struct shell_transport *transport)
Function for uninitializing the shell transport interface.
Definition shell.h:824
int(* enable)(const struct shell_transport *transport, bool blocking_tx)
Function for enabling transport in given TX mode.
Definition shell.h:838
int(* read)(const struct shell_transport *transport, void *data, size_t length, size_t *cnt)
Function for reading data from the transport interface.
Definition shell.h:864
Definition shell.h:878
void * ctx
Definition shell.h:880
const struct shell_transport_api * api
Definition shell.h:879
Definition shell_types.h:44
Shell instance internals.
Definition shell.h:1038
struct k_thread * thread
Definition shell.h:1057
LOG_INSTANCE_PTR_DECLARE(log)
enum shell_flag shell_flag
Definition shell.h:1046
const struct shell_log_backend * log_backend
Definition shell.h:1052
struct shell_history * history
Definition shell.h:1044
struct shell_stats * stats
Definition shell.h:1050
const char * name
Definition shell.h:1056
const char * default_prompt
shell default prompt.
Definition shell.h:1039
const struct shell_fprintf * fprintf_ctx
Definition shell.h:1048
struct shell_ctx * ctx
Internal context.
Definition shell.h:1042
const struct shell_transport * iface
Transport interface.
Definition shell.h:1041
k_thread_stack_t * stack
Definition shell.h:1058
Misc utilities.
Macros to abstract toolchain specific capabilities.
Definition shell.h:943
atomic_t value
Definition shell.h:944
Definition shell.h:951
uint32_t value
Definition shell.h:952
Shell command descriptor.
Definition shell.h:102
const struct shell_static_entry * entry
Pointer to array of static commands.
Definition shell.h:107
shell_dynamic_get dynamic_get
Pointer to function returning dynamic commands.
Definition shell.h:104