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
14 #include <linker_lists.h>
20 /* Default to a width of 8 characters for help message command width */
21 #ifndef CFG_SYS_HELP_CMD_WIDTH
22 #define CFG_SYS_HELP_CMD_WIDTH 10
27 * Monitor Command Table
31 char *name; /* Command Name */
32 int maxargs; /* maximum number of arguments */
34 * Same as ->cmd() except the command
35 * tells us if it can be repeated.
36 * Replaces the old ->repeatable field
37 * which was not able to make
38 * repeatable property different for
39 * the main command and sub-commands.
41 int (*cmd_rep)(struct cmd_tbl *cmd, int flags, int argc,
42 char *const argv[], int *repeatable);
43 /* Implementation function */
44 int (*cmd)(struct cmd_tbl *cmd, int flags, int argc,
46 char *usage; /* Usage message (short) */
47 #ifdef CONFIG_SYS_LONGHELP
48 const char *help; /* Help message (long) */
50 #ifdef CONFIG_AUTO_COMPLETE
51 /* do auto completion on the arguments */
52 int (*complete)(int argc, char *const argv[],
53 char last_char, int maxv, char *cmdv[]);
57 #if defined(CONFIG_CMD_RUN)
58 int do_run(struct cmd_tbl *cmdtp, int flag, int argc,
62 /* common/command.c */
63 int _do_help(struct cmd_tbl *cmd_start, int cmd_items, struct cmd_tbl *cmdtp,
64 int flag, int argc, char *const argv[]);
65 struct cmd_tbl *find_cmd(const char *cmd);
66 struct cmd_tbl *find_cmd_tbl(const char *cmd, struct cmd_tbl *table,
68 int complete_subcmdv(struct cmd_tbl *cmdtp, int count, int argc,
69 char *const argv[], char last_char, int maxv,
72 int cmd_usage(const struct cmd_tbl *cmdtp);
74 /* Dummy ->cmd and ->cmd_rep wrappers. */
75 int cmd_always_repeatable(struct cmd_tbl *cmdtp, int flag, int argc,
76 char *const argv[], int *repeatable);
77 int cmd_never_repeatable(struct cmd_tbl *cmdtp, int flag, int argc,
78 char *const argv[], int *repeatable);
79 int cmd_discard_repeatable(struct cmd_tbl *cmdtp, int flag, int argc,
82 static inline bool cmd_is_repeatable(struct cmd_tbl *cmdtp)
84 return cmdtp->cmd_rep == cmd_always_repeatable;
87 #ifdef CONFIG_AUTO_COMPLETE
88 int var_complete(int argc, char *const argv[], char last_char, int maxv,
90 int cmd_auto_complete(const char *const prompt, char *buf, int *np,
95 * cmd_process_error() - report and process a possible error
97 * @cmdtp: Command which caused the error
98 * @err: Error code (0 if none, -ve for error, like -EIO)
99 * Return: 0 (CMD_RET_SUCCESS) if there is not error,
100 * 1 (CMD_RET_FAILURE) if an error is found
101 * -1 (CMD_RET_USAGE) if 'usage' error is found
103 int cmd_process_error(struct cmd_tbl *cmdtp, int err);
108 * All commands use a common argument format:
110 * void function(struct cmd_tbl *cmdtp, int flag, int argc,
111 * char *const argv[]);
114 #if defined(CONFIG_CMD_MEMORY) || \
115 defined(CONFIG_CMD_I2C) || \
116 defined(CONFIG_CMD_ITEST) || \
117 defined(CONFIG_CMD_PCI) || \
118 defined(CONFIG_CMD_SETEXPR)
119 #define CMD_DATA_SIZE
120 #define CMD_DATA_SIZE_ERR (-1)
121 #define CMD_DATA_SIZE_STR (-2)
124 * cmd_get_data_size() - Get the data-size specifier from a command
126 * This reads a '.x' size specifier appended to a command. For example 'md.b'
127 * is the 'md' command with a '.b' specifier, meaning that the command should
130 * Valid characters are:
138 * @arg: Pointers to the command to check. If a valid specifier is present it
139 * will be the last character of the string, following a '.'
140 * @default_size: Default size to return if there is no specifier
141 * Return: data size in bytes (1, 2, 4, 8) or CMD_DATA_SIZE_ERR for an invalid
142 * character, or CMD_DATA_SIZE_STR for a string
144 int cmd_get_data_size(char *arg, int default_size);
147 #ifdef CONFIG_CMD_BOOTD
148 int do_bootd(struct cmd_tbl *cmdtp, int flag, int argc,
151 int do_bootm(struct cmd_tbl *cmdtp, int flag, int argc,
153 #ifdef CONFIG_CMD_BOOTM
154 int bootm_maybe_autostart(struct cmd_tbl *cmdtp, const char *cmd);
156 static inline int bootm_maybe_autostart(struct cmd_tbl *cmdtp, const char *cmd)
162 int do_bootz(struct cmd_tbl *cmdtp, int flag, int argc,
165 int do_booti(struct cmd_tbl *cmdtp, int flag, int argc,
168 int do_zboot_parent(struct cmd_tbl *cmdtp, int flag, int argc,
169 char *const argv[], int *repeatable);
171 int common_diskboot(struct cmd_tbl *cmdtp, const char *intf, int argc,
174 int do_reset(struct cmd_tbl *cmdtp, int flag, int argc,
176 int do_poweroff(struct cmd_tbl *cmdtp, int flag, int argc,
179 unsigned long do_go_exec(ulong (*entry)(int, char * const []), int argc,
182 #if defined(CONFIG_CMD_NVEDIT_EFI)
183 int do_env_print_efi(struct cmd_tbl *cmdtp, int flag, int argc,
185 int do_env_set_efi(struct cmd_tbl *cmdtp, int flag, int argc,
190 * setexpr_regex_sub() - Replace a regex pattern with a string
192 * @data: Buffer containing the string to update
193 * @data_size: Size of buffer (must be large enough for the new string)
194 * @nbuf: Back-reference buffer
195 * @nbuf_size: Size of back-reference buffer (must be larger enough for @s plus
196 * all back-reference expansions)
197 * @r: Regular expression to find
198 * @s: String to replace with
199 * @global: true to replace all matches in @data, false to replace just the
201 * Return: 0 if OK, 1 on error
203 int setexpr_regex_sub(char *data, uint data_size, char *nbuf, uint nbuf_size,
204 const char *r, const char *s, bool global);
207 * Error codes that commands return to cmd_process(). We use the standard 0
208 * and 1 for success and failure, but add one more case - failure with a
209 * request to call cmd_usage(). But the cmd_process() function handles
210 * CMD_RET_USAGE itself and after calling cmd_usage() it will return 1.
211 * This is just a convenience for commands to avoid them having to call
212 * cmd_usage() all over the place.
215 CMD_RET_SUCCESS, /* 0 = Success */
216 CMD_RET_FAILURE, /* 1 = Failure */
217 CMD_RET_USAGE = -1, /* Failure, please report 'usage' error */
221 * Process a command with arguments. We look up the command and execute it
222 * if valid. Otherwise we print a usage message.
224 * @param flag Some flags normally 0 (see CMD_FLAG_.. above)
225 * @param argc Number of arguments (arg 0 must be the command text)
226 * @param argv Arguments
227 * @param repeatable This function sets this to 0 if the command is not
228 * repeatable. If the command is repeatable, the value
230 * @param ticks If ticks is not null, this function set it to the
231 * number of ticks the command took to complete.
232 * Return: 0 if command succeeded, else non-zero (CMD_RET_...)
234 enum command_ret_t cmd_process(int flag, int argc, char *const argv[],
235 int *repeatable, unsigned long *ticks);
237 void fixup_cmdtable(struct cmd_tbl *cmdtp, int size);
240 * board_run_command() - Fallback function to execute a command
242 * When no command line features are enabled in U-Boot, this function is
243 * called to execute a command. Typically the function can look at the
244 * command and perform a few very specific tasks, such as booting the
245 * system in a particular way.
247 * This function is only used when CONFIG_CMDLINE is not enabled.
249 * In normal situations this function should not return, since U-Boot will
252 * @cmdline: Command line string to execute
253 * Return: 0 if OK, 1 for error
255 int board_run_command(const char *cmdline);
257 int run_command(const char *cmd, int flag);
258 int run_command_repeatable(const char *cmd, int flag);
261 * run_commandf() - Run a command created by a format string
263 * The command cannot be larger than 127 characters
265 * @fmt: printf() format string
266 * @...: Arguments to use (flag is always 0)
268 int run_commandf(const char *fmt, ...);
271 * Run a list of commands separated by ; or even \0
273 * Note that if 'len' is not -1, then the command does not need to be nul
274 * terminated, Memory will be allocated for the command in that case.
276 * @param cmd List of commands to run, each separated bu semicolon
277 * @param len Length of commands excluding terminator if known (-1 if not)
278 * @param flag Execution flags (CMD_FLAG_...)
279 * Return: 0 on success, or != 0 on error.
281 int run_command_list(const char *cmd, int len, int flag);
284 * cmd_source_script() - Execute a script
286 * Executes a U-Boot script at a particular address in memory. The script should
287 * have a header (FIT or legacy) with the script type (IH_TYPE_SCRIPT).
289 * @addr: Address of script
290 * @fit_uname: FIT subimage name
291 * Return: result code (enum command_ret_t)
293 int cmd_source_script(ulong addr, const char *fit_uname, const char *confname);
294 #endif /* __ASSEMBLY__ */
299 #define CMD_FLAG_REPEAT 0x0001 /* repeat last command */
300 #define CMD_FLAG_BOOTD 0x0002 /* command is from bootd */
301 #define CMD_FLAG_ENV 0x0004 /* command is from the environment */
303 #ifdef CONFIG_AUTO_COMPLETE
304 # define _CMD_COMPLETE(x) x,
306 # define _CMD_COMPLETE(x)
308 #ifdef CONFIG_SYS_LONGHELP
309 # define _CMD_HELP(x) x,
311 # define _CMD_HELP(x)
314 #ifdef CONFIG_NEEDS_MANUAL_RELOC
315 #define U_BOOT_SUBCMDS_RELOC(_cmdname) \
316 static void _cmdname##_subcmds_reloc(void) \
318 static int relocated; \
323 fixup_cmdtable(_cmdname##_subcmds, \
324 ARRAY_SIZE(_cmdname##_subcmds)); \
328 #define U_BOOT_SUBCMDS_RELOC(_cmdname) \
329 static void _cmdname##_subcmds_reloc(void) { }
332 #define U_BOOT_SUBCMDS_DO_CMD(_cmdname) \
333 static int do_##_cmdname(struct cmd_tbl *cmdtp, int flag, \
334 int argc, char *const argv[], \
337 struct cmd_tbl *subcmd; \
339 _cmdname##_subcmds_reloc(); \
341 /* We need at least the cmd and subcmd names. */ \
342 if (argc < 2 || argc > CONFIG_SYS_MAXARGS) \
343 return CMD_RET_USAGE; \
345 subcmd = find_cmd_tbl(argv[1], _cmdname##_subcmds, \
346 ARRAY_SIZE(_cmdname##_subcmds)); \
347 if (!subcmd || argc - 1 > subcmd->maxargs) \
348 return CMD_RET_USAGE; \
350 if (flag == CMD_FLAG_REPEAT && \
351 !cmd_is_repeatable(subcmd)) \
352 return CMD_RET_SUCCESS; \
354 return subcmd->cmd_rep(subcmd, flag, argc - 1, \
355 argv + 1, repeatable); \
358 #ifdef CONFIG_AUTO_COMPLETE
359 #define U_BOOT_SUBCMDS_COMPLETE(_cmdname) \
360 static int complete_##_cmdname(int argc, char *const argv[], \
361 char last_char, int maxv, \
364 return complete_subcmdv(_cmdname##_subcmds, \
365 ARRAY_SIZE(_cmdname##_subcmds), \
366 argc - 1, argv + 1, last_char, \
370 #define U_BOOT_SUBCMDS_COMPLETE(_cmdname)
373 #define U_BOOT_SUBCMDS(_cmdname, ...) \
374 static struct cmd_tbl _cmdname##_subcmds[] = { __VA_ARGS__ }; \
375 U_BOOT_SUBCMDS_RELOC(_cmdname) \
376 U_BOOT_SUBCMDS_DO_CMD(_cmdname) \
377 U_BOOT_SUBCMDS_COMPLETE(_cmdname)
379 #if CONFIG_IS_ENABLED(CMDLINE)
380 #define U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep, \
381 _usage, _help, _comp) \
382 { #_name, _maxargs, _cmd_rep, cmd_discard_repeatable, \
383 _usage, _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
385 #define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
386 _usage, _help, _comp) \
387 { #_name, _maxargs, \
388 _rep ? cmd_always_repeatable : cmd_never_repeatable, \
389 _cmd, _usage, _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
391 #define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, _comp) \
392 ll_entry_declare(struct cmd_tbl, _name, cmd) = \
393 U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
394 _usage, _help, _comp);
396 #define U_BOOT_CMDREP_COMPLETE(_name, _maxargs, _cmd_rep, _usage, \
398 ll_entry_declare(struct cmd_tbl, _name, cmd) = \
399 U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep, \
400 _usage, _help, _comp)
403 #define U_BOOT_SUBCMD_START(name) static struct cmd_tbl name[] = {};
404 #define U_BOOT_SUBCMD_END
406 #define _CMD_REMOVE(_name, _cmd) \
407 int __remove_ ## _name(void) \
410 _cmd(NULL, 0, 0, NULL); \
414 #define _CMD_REMOVE_REP(_name, _cmd) \
415 int __remove_ ## _name(void) \
418 _cmd(NULL, 0, 0, NULL, NULL); \
422 #define U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep, \
423 _usage, _help, _comp) \
424 { #_name, _maxargs, 0 ? _cmd_rep : NULL, NULL, _usage, \
425 _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
427 #define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, \
429 { #_name, _maxargs, NULL, 0 ? _cmd : NULL, _usage, \
430 _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
432 #define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, \
434 _CMD_REMOVE(sub_ ## _name, _cmd)
436 #define U_BOOT_CMDREP_COMPLETE(_name, _maxargs, _cmd_rep, _usage, \
438 _CMD_REMOVE_REP(sub_ ## _name, _cmd_rep)
440 #endif /* CONFIG_CMDLINE */
442 #define U_BOOT_CMD(_name, _maxargs, _rep, _cmd, _usage, _help) \
443 U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, NULL)
445 #define U_BOOT_CMD_MKENT(_name, _maxargs, _rep, _cmd, _usage, _help) \
446 U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
449 #define U_BOOT_SUBCMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd, \
451 U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd, \
454 #define U_BOOT_SUBCMD_MKENT(_name, _maxargs, _rep, _do_cmd) \
455 U_BOOT_SUBCMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd, \
458 #define U_BOOT_CMD_WITH_SUBCMDS(_name, _usage, _help, ...) \
459 U_BOOT_SUBCMDS(_name, __VA_ARGS__) \
460 U_BOOT_CMDREP_COMPLETE(_name, CONFIG_SYS_MAXARGS, do_##_name, \
461 _usage, _help, complete_##_name)
463 #endif /* __COMMAND_H */