1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * (C) Copyright 2000-2009
4 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
8 * Definitions for Command Processor
13 #include <linker_lists.h>
19 /* Default to a width of 8 characters for help message command width */
20 #ifndef CONFIG_SYS_HELP_CMD_WIDTH
21 #define CONFIG_SYS_HELP_CMD_WIDTH 8
26 * Monitor Command Table
30 char *name; /* Command Name */
31 int maxargs; /* maximum number of arguments */
32 int repeatable; /* autorepeat allowed? */
33 /* Implementation function */
34 int (*cmd)(struct cmd_tbl_s *, int, int, char * const []);
35 char *usage; /* Usage message (short) */
36 #ifdef CONFIG_SYS_LONGHELP
37 char *help; /* Help message (long) */
39 #ifdef CONFIG_AUTO_COMPLETE
40 /* do auto completion on the arguments */
41 int (*complete)(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
45 typedef struct cmd_tbl_s cmd_tbl_t;
48 #if defined(CONFIG_CMD_RUN)
49 extern int do_run(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
52 /* common/command.c */
53 int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int
54 flag, int argc, char * const argv[]);
55 cmd_tbl_t *find_cmd(const char *cmd);
56 cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len);
57 int complete_subcmdv(cmd_tbl_t *cmdtp, int count, int argc,
58 char * const argv[], char last_char, int maxv,
61 extern int cmd_usage(const cmd_tbl_t *cmdtp);
63 #ifdef CONFIG_AUTO_COMPLETE
64 extern int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
65 extern int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp);
69 * cmd_process_error() - report and process a possible error
71 * @cmdtp: Command which caused the error
72 * @err: Error code (0 if none, -ve for error, like -EIO)
73 * @return 0 (CMD_RET_SUCCESS) if there is not error,
74 * 1 (CMD_RET_FAILURE) if an error is found
75 * -1 (CMD_RET_USAGE) if 'usage' error is found
77 int cmd_process_error(cmd_tbl_t *cmdtp, int err);
82 * All commands use a common argument format:
84 * void function (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
87 #if defined(CONFIG_CMD_MEMORY) || \
88 defined(CONFIG_CMD_I2C) || \
89 defined(CONFIG_CMD_ITEST) || \
90 defined(CONFIG_CMD_PCI)
92 extern int cmd_get_data_size(char* arg, int default_size);
95 #ifdef CONFIG_CMD_BOOTD
96 extern int do_bootd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
98 #ifdef CONFIG_CMD_BOOTM
99 extern int do_bootm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
100 extern int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd);
102 static inline int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd)
108 extern int do_bootz(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
110 extern int do_booti(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
112 extern int common_diskboot(cmd_tbl_t *cmdtp, const char *intf, int argc,
115 extern int do_reset(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
116 extern int do_poweroff(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
118 extern unsigned long do_go_exec(ulong (*entry)(int, char * const []), int argc,
119 char * const argv[]);
121 * Error codes that commands return to cmd_process(). We use the standard 0
122 * and 1 for success and failure, but add one more case - failure with a
123 * request to call cmd_usage(). But the cmd_process() function handles
124 * CMD_RET_USAGE itself and after calling cmd_usage() it will return 1.
125 * This is just a convenience for commands to avoid them having to call
126 * cmd_usage() all over the place.
129 CMD_RET_SUCCESS, /* 0 = Success */
130 CMD_RET_FAILURE, /* 1 = Failure */
131 CMD_RET_USAGE = -1, /* Failure, please report 'usage' error */
135 * Process a command with arguments. We look up the command and execute it
136 * if valid. Otherwise we print a usage message.
138 * @param flag Some flags normally 0 (see CMD_FLAG_.. above)
139 * @param argc Number of arguments (arg 0 must be the command text)
140 * @param argv Arguments
141 * @param repeatable This function sets this to 0 if the command is not
142 * repeatable. If the command is repeatable, the value
144 * @param ticks If ticks is not null, this function set it to the
145 * number of ticks the command took to complete.
146 * @return 0 if the command succeeded, 1 if it failed
148 int cmd_process(int flag, int argc, char * const argv[],
149 int *repeatable, unsigned long *ticks);
151 void fixup_cmdtable(cmd_tbl_t *cmdtp, int size);
154 * board_run_command() - Fallback function to execute a command
156 * When no command line features are enabled in U-Boot, this function is
157 * called to execute a command. Typically the function can look at the
158 * command and perform a few very specific tasks, such as booting the
159 * system in a particular way.
161 * This function is only used when CONFIG_CMDLINE is not enabled.
163 * In normal situations this function should not return, since U-Boot will
166 * @cmdline: Command line string to execute
167 * @return 0 if OK, 1 for error
169 int board_run_command(const char *cmdline);
170 #endif /* __ASSEMBLY__ */
175 #define CMD_FLAG_REPEAT 0x0001 /* repeat last command */
176 #define CMD_FLAG_BOOTD 0x0002 /* command is from bootd */
177 #define CMD_FLAG_ENV 0x0004 /* command is from the environment */
179 #ifdef CONFIG_AUTO_COMPLETE
180 # define _CMD_COMPLETE(x) x,
182 # define _CMD_COMPLETE(x)
184 #ifdef CONFIG_SYS_LONGHELP
185 # define _CMD_HELP(x) x,
187 # define _CMD_HELP(x)
190 #ifdef CONFIG_CMDLINE
191 #define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
192 _usage, _help, _comp) \
193 { #_name, _maxargs, _rep, _cmd, _usage, \
194 _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
196 #define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, _comp) \
197 ll_entry_declare(cmd_tbl_t, _name, cmd) = \
198 U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
199 _usage, _help, _comp);
202 #define U_BOOT_SUBCMD_START(name) static cmd_tbl_t name[] = {};
203 #define U_BOOT_SUBCMD_END
205 #define _CMD_REMOVE(_name, _cmd) \
206 int __remove_ ## _name(void) \
209 _cmd(NULL, 0, 0, NULL); \
212 #define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, \
214 { #_name, _maxargs, _rep, 0 ? _cmd : NULL, _usage, \
215 _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
217 #define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, \
219 _CMD_REMOVE(sub_ ## _name, _cmd)
221 #endif /* CONFIG_CMDLINE */
223 #define U_BOOT_CMD(_name, _maxargs, _rep, _cmd, _usage, _help) \
224 U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, NULL)
226 #define U_BOOT_CMD_MKENT(_name, _maxargs, _rep, _cmd, _usage, _help) \
227 U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
230 #endif /* __COMMAND_H */