]>
cloudbase.mooo.com Git - z180-stamp.git/blob - include/command.h
2 * (C) Copyright 2014-2016 Leo C. <erbl259-lmu@yahoo.de>
4 * (C) Copyright 2000-2009
5 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
7 * SPDX-License-Identifier: GPL-2.0
11 * Definitions for Command Processor
24 /* Default to a width of 8 characters for help message command width */
25 #ifndef CONFIG_SYS_HELP_CMD_WIDTH
26 #define CONFIG_SYS_HELP_CMD_WIDTH 8
30 * Error codes that commands return to cmd_process(). We use the standard 0
31 * and 1 for success and failure, but add one more case - failure with a
32 * request to call cmd_usage(). But the cmd_process() function handles
33 * CMD_RET_USAGE itself and after calling cmd_usage() it will return 1.
34 * This is just a convenience for commands to avoid them having to call
35 * cmd_usage() all over the place.
38 CMD_RET_SUCCESS
= 0, /* Success */
39 CMD_RET_FAILURE
= 1, /* Failure */
40 CMD_RET_USAGE
= -1, /* Failure, please report 'usage' error */
44 * Monitor Command Table
47 typedef const FLASH
struct cmd_tbl_s cmd_tbl_t
;
49 const FLASH
char *name
; /* Command Name */
50 uint8_t maxargs
; /* maximum number of arguments */
51 uint8_t flags
; /* autorepeat allowed? */
52 /* Implementation function */
53 command_ret_t (*cmd
)(const FLASH
struct cmd_tbl_s
*, uint_fast8_t, int, char * const []);
54 const FLASH
char *usage
; /* Usage message (short) */
55 #ifdef CONFIG_SYS_LONGHELP
56 const FLASH
char *help
; /* Help message (long) */
59 // const FLASH struct cmd_tbl_s *subcommands;
60 #ifdef CONFIG_AUTO_COMPLETE
61 /* do auto completion on the arguments */
62 int (*complete
)(int argc
, char * const argv
[], char last_char
, int maxv
, char *cmdv
[]);
67 * Process a command with arguments. We look up the command and execute it
68 * if valid. Otherwise we print a usage message.
70 * @param flag Some flags normally 0 (see CMD_FLAG_.. above)
71 * @param argc Number of arguments (arg 0 must be the command text)
72 * @param argv Arguments
73 * @param repeatable This function sets this to 0 if the command is not
74 * repeatable. If the command is repeatable, the value
76 * @return 0 if the command succeeded, 1 if it failed
79 cmd_process(uint_fast8_t flag
, int argc
, char * const argv
[], uint_fast8_t *repeatable
);
83 command_ret_t
do_help(cmd_tbl_t
*cmdtp
, uint_fast8_t flag
, int argc
, char * const argv
[]);
85 int cmd_tbl_item_count(cmd_tbl_t
*p
);
86 command_ret_t
cmd_usage(cmd_tbl_t
*cmdtp
);
88 #ifdef CONFIG_AUTO_COMPLETE
89 extern int var_complete(int argc
, char * const argv
[], char last_char
, int maxv
, char *cmdv
[]);
90 extern int cmd_auto_complete(const FLASH
char *const prompt
, char *buf
, int *np
, int *colp
);
94 * cmd_process_error() - report and process a possible error
96 * @cmdtp: Command which caused the error
97 * @err: Error code (0 if none, -ve for error, like -EIO)
98 * @return 0 if there is not error, 1 (CMD_RET_FAILURE) if an error is found
100 int cmd_process_error(cmd_tbl_t
*cmdtp
, int err
);
105 * All commands use a common argument format:
107 * void function (cmd_tbl_t *cmdtp, uint_fast8_t flag, int argc, char * const argv[]);
111 #ifdef CONFIG_CMD_BOOTD
112 extern command_ret_t
do_bootd(cmd_tbl_t
*cmdtp
, uint_fast8_t flag
, int argc
, char * const argv
[]);
114 #ifdef CONFIG_CMD_BOOTM
115 extern command_ret_t
do_bootm(cmd_tbl_t
*cmdtp
, uint_fast8_t flag
, int argc
, char * const argv
[]);
116 extern int bootm_maybe_autostart(cmd_tbl_t
*cmdtp
, const char *cmd
);
118 static inline int bootm_maybe_autostart(cmd_tbl_t
*cmdtp UNUSED
, const char *cmd UNUSED
)
124 extern int common_diskboot(cmd_tbl_t
*cmdtp
, const char *intf
, int argc
,
130 #define CMD_FLAG_REPEAT 0x01 /* repeat last command */
131 #define CMD_FLAG_BOOTD 0x02 /* command is from bootd */
134 * Flags for command table:
136 #define CTBL_RPT 0x01 /* command is repeatable */
137 #define CTBL_SUBCMD 0x02 /* command has subcommands */
138 #define CTBL_SUBCMDAUTO 0x04 /* execute subcommands whithout prefix */
139 #define CTBL_DBG 0x08 /* command is only for debugging */
141 #ifdef CONFIG_AUTO_COMPLETE
142 # define _CMD_COMPLETE(x) x,
144 # define _CMD_COMPLETE(x)
146 #ifdef CONFIG_SYS_LONGHELP
147 # define _CMD_HELP(x) x,
149 # define _CMD_HELP(x)
153 #define CMD_TBL_ITEM_FULL(_name, _maxargs, _rep, _cmd, \
154 _usage, _help, _subtbl, _comp) \
155 { FSTR(#_name), _maxargs, _rep, _cmd, FSTR(_usage), \
156 _CMD_HELP(FSTR(_help)) _subtbl, _CMD_COMPLETE(_comp) }
158 #define CMD_TBL_ITEM_COMPLETE(_name, _maxargs, _rep, _cmd, \
159 _usage, _help, _comp) \
160 { FSTR(#_name), _maxargs, _rep, _cmd, FSTR(_usage), \
161 _CMD_HELP(FSTR(_help)) NULL, _CMD_COMPLETE(_comp) }
163 #define CMD_TBL_ITEM(_name, _maxargs, _rep, _cmd, _usage, _help) \
164 CMD_TBL_ITEM_FULL(_name, _maxargs, _rep, _cmd, \
165 _usage, _help, NULL, NULL)
167 #define CMD_TBL_ITEM_TOP(_name, _maxargs, _rep, _cmd, _usage, _help, _subtbl) \
168 CMD_TBL_ITEM_FULL(_name, _maxargs, _rep, _cmd, \
169 _usage, _help, _subtbl, NULL)
171 #define CMD_TBL_END(_table_start) { .subcmd = _table_start }
173 typedef command_ret_t (*do_cmd_t
)(cmd_tbl_t
*, uint_fast8_t, int, char * const []);
175 extern cmd_tbl_t cmd_tbl
[];
177 extern jmp_buf cmd_jbuf
;
180 #endif /* __COMMAND_H */