123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389 |
- /* SPDX-License-Identifier: GPL-2.0+ */
- /*
- * (C) Copyright 2000-2009
- * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
- */
- /*
- * Definitions for Command Processor
- */
- #ifndef __COMMAND_H
- #define __COMMAND_H
- #include <env.h>
- #include <linker_lists.h>
- #ifndef NULL
- #define NULL 0
- #endif
- /* Default to a width of 8 characters for help message command width */
- #ifndef CONFIG_SYS_HELP_CMD_WIDTH
- #define CONFIG_SYS_HELP_CMD_WIDTH 10
- #endif
- #ifndef __ASSEMBLY__
- /*
- * Monitor Command Table
- */
- struct cmd_tbl {
- char *name; /* Command Name */
- int maxargs; /* maximum number of arguments */
- /*
- * Same as ->cmd() except the command
- * tells us if it can be repeated.
- * Replaces the old ->repeatable field
- * which was not able to make
- * repeatable property different for
- * the main command and sub-commands.
- */
- int (*cmd_rep)(struct cmd_tbl *cmd, int flags, int argc,
- char *const argv[], int *repeatable);
- /* Implementation function */
- int (*cmd)(struct cmd_tbl *cmd, int flags, int argc,
- char *const argv[]);
- char *usage; /* Usage message (short) */
- #ifdef CONFIG_SYS_LONGHELP
- char *help; /* Help message (long) */
- #endif
- #ifdef CONFIG_AUTO_COMPLETE
- /* do auto completion on the arguments */
- int (*complete)(int argc, char *const argv[],
- char last_char, int maxv, char *cmdv[]);
- #endif
- };
- #if defined(CONFIG_CMD_RUN)
- extern int do_run(struct cmd_tbl *cmdtp, int flag, int argc,
- char *const argv[]);
- #endif
- /* common/command.c */
- int _do_help(struct cmd_tbl *cmd_start, int cmd_items, struct cmd_tbl *cmdtp,
- int flag, int argc, char *const argv[]);
- struct cmd_tbl *find_cmd(const char *cmd);
- struct cmd_tbl *find_cmd_tbl(const char *cmd, struct cmd_tbl *table,
- int table_len);
- int complete_subcmdv(struct cmd_tbl *cmdtp, int count, int argc,
- char *const argv[], char last_char, int maxv,
- char *cmdv[]);
- extern int cmd_usage(const struct cmd_tbl *cmdtp);
- /* Dummy ->cmd and ->cmd_rep wrappers. */
- int cmd_always_repeatable(struct cmd_tbl *cmdtp, int flag, int argc,
- char *const argv[], int *repeatable);
- int cmd_never_repeatable(struct cmd_tbl *cmdtp, int flag, int argc,
- char *const argv[], int *repeatable);
- int cmd_discard_repeatable(struct cmd_tbl *cmdtp, int flag, int argc,
- char *const argv[]);
- static inline bool cmd_is_repeatable(struct cmd_tbl *cmdtp)
- {
- return cmdtp->cmd_rep == cmd_always_repeatable;
- }
- #ifdef CONFIG_AUTO_COMPLETE
- extern int var_complete(int argc, char *const argv[], char last_char, int maxv,
- char *cmdv[]);
- extern int cmd_auto_complete(const char *const prompt, char *buf, int *np,
- int *colp);
- #endif
- /**
- * cmd_process_error() - report and process a possible error
- *
- * @cmdtp: Command which caused the error
- * @err: Error code (0 if none, -ve for error, like -EIO)
- * @return 0 (CMD_RET_SUCCESS) if there is not error,
- * 1 (CMD_RET_FAILURE) if an error is found
- * -1 (CMD_RET_USAGE) if 'usage' error is found
- */
- int cmd_process_error(struct cmd_tbl *cmdtp, int err);
- /*
- * Monitor Command
- *
- * All commands use a common argument format:
- *
- * void function(struct cmd_tbl *cmdtp, int flag, int argc,
- * char *const argv[]);
- */
- #if defined(CONFIG_CMD_MEMORY) || \
- defined(CONFIG_CMD_I2C) || \
- defined(CONFIG_CMD_ITEST) || \
- defined(CONFIG_CMD_PCI) || \
- defined(CONFIG_CMD_SETEXPR)
- #define CMD_DATA_SIZE
- extern int cmd_get_data_size(char* arg, int default_size);
- #endif
- #ifdef CONFIG_CMD_BOOTD
- extern int do_bootd(struct cmd_tbl *cmdtp, int flag, int argc,
- char *const argv[]);
- #endif
- #ifdef CONFIG_CMD_BOOTM
- extern int do_bootm(struct cmd_tbl *cmdtp, int flag, int argc,
- char *const argv[]);
- extern int bootm_maybe_autostart(struct cmd_tbl *cmdtp, const char *cmd);
- #else
- static inline int bootm_maybe_autostart(struct cmd_tbl *cmdtp, const char *cmd)
- {
- return 0;
- }
- #endif
- extern int do_bootz(struct cmd_tbl *cmdtp, int flag, int argc,
- char *const argv[]);
- extern int do_booti(struct cmd_tbl *cmdtp, int flag, int argc,
- char *const argv[]);
- extern int common_diskboot(struct cmd_tbl *cmdtp, const char *intf, int argc,
- char *const argv[]);
- extern int do_reset(struct cmd_tbl *cmdtp, int flag, int argc,
- char *const argv[]);
- extern int do_poweroff(struct cmd_tbl *cmdtp, int flag, int argc,
- char *const argv[]);
- extern unsigned long do_go_exec(ulong (*entry)(int, char * const []), int argc,
- char *const argv[]);
- #if defined(CONFIG_CMD_NVEDIT_EFI)
- extern int do_env_print_efi(struct cmd_tbl *cmdtp, int flag, int argc,
- char *const argv[]);
- extern int do_env_set_efi(struct cmd_tbl *cmdtp, int flag, int argc,
- char *const argv[]);
- #endif
- /*
- * Error codes that commands return to cmd_process(). We use the standard 0
- * and 1 for success and failure, but add one more case - failure with a
- * request to call cmd_usage(). But the cmd_process() function handles
- * CMD_RET_USAGE itself and after calling cmd_usage() it will return 1.
- * This is just a convenience for commands to avoid them having to call
- * cmd_usage() all over the place.
- */
- enum command_ret_t {
- CMD_RET_SUCCESS, /* 0 = Success */
- CMD_RET_FAILURE, /* 1 = Failure */
- CMD_RET_USAGE = -1, /* Failure, please report 'usage' error */
- };
- /**
- * Process a command with arguments. We look up the command and execute it
- * if valid. Otherwise we print a usage message.
- *
- * @param flag Some flags normally 0 (see CMD_FLAG_.. above)
- * @param argc Number of arguments (arg 0 must be the command text)
- * @param argv Arguments
- * @param repeatable This function sets this to 0 if the command is not
- * repeatable. If the command is repeatable, the value
- * is left unchanged.
- * @param ticks If ticks is not null, this function set it to the
- * number of ticks the command took to complete.
- * @return 0 if the command succeeded, 1 if it failed
- */
- int cmd_process(int flag, int argc, char *const argv[], int *repeatable,
- unsigned long *ticks);
- void fixup_cmdtable(struct cmd_tbl *cmdtp, int size);
- /**
- * board_run_command() - Fallback function to execute a command
- *
- * When no command line features are enabled in U-Boot, this function is
- * called to execute a command. Typically the function can look at the
- * command and perform a few very specific tasks, such as booting the
- * system in a particular way.
- *
- * This function is only used when CONFIG_CMDLINE is not enabled.
- *
- * In normal situations this function should not return, since U-Boot will
- * simply hang.
- *
- * @cmdline: Command line string to execute
- * @return 0 if OK, 1 for error
- */
- int board_run_command(const char *cmdline);
- int run_command(const char *cmd, int flag);
- int run_command_repeatable(const char *cmd, int flag);
- /**
- * Run a list of commands separated by ; or even \0
- *
- * Note that if 'len' is not -1, then the command does not need to be nul
- * terminated, Memory will be allocated for the command in that case.
- *
- * @param cmd List of commands to run, each separated bu semicolon
- * @param len Length of commands excluding terminator if known (-1 if not)
- * @param flag Execution flags (CMD_FLAG_...)
- * @return 0 on success, or != 0 on error.
- */
- int run_command_list(const char *cmd, int len, int flag);
- #endif /* __ASSEMBLY__ */
- /*
- * Command Flags:
- */
- #define CMD_FLAG_REPEAT 0x0001 /* repeat last command */
- #define CMD_FLAG_BOOTD 0x0002 /* command is from bootd */
- #define CMD_FLAG_ENV 0x0004 /* command is from the environment */
- #ifdef CONFIG_AUTO_COMPLETE
- # define _CMD_COMPLETE(x) x,
- #else
- # define _CMD_COMPLETE(x)
- #endif
- #ifdef CONFIG_SYS_LONGHELP
- # define _CMD_HELP(x) x,
- #else
- # define _CMD_HELP(x)
- #endif
- #ifdef CONFIG_NEEDS_MANUAL_RELOC
- #define U_BOOT_SUBCMDS_RELOC(_cmdname) \
- static void _cmdname##_subcmds_reloc(void) \
- { \
- static int relocated; \
- \
- if (relocated) \
- return; \
- \
- fixup_cmdtable(_cmdname##_subcmds, \
- ARRAY_SIZE(_cmdname##_subcmds)); \
- relocated = 1; \
- }
- #else
- #define U_BOOT_SUBCMDS_RELOC(_cmdname) \
- static void _cmdname##_subcmds_reloc(void) { }
- #endif
- #define U_BOOT_SUBCMDS_DO_CMD(_cmdname) \
- static int do_##_cmdname(struct cmd_tbl *cmdtp, int flag, \
- int argc, char *const argv[], \
- int *repeatable) \
- { \
- struct cmd_tbl *subcmd; \
- \
- _cmdname##_subcmds_reloc(); \
- \
- /* We need at least the cmd and subcmd names. */ \
- if (argc < 2 || argc > CONFIG_SYS_MAXARGS) \
- return CMD_RET_USAGE; \
- \
- subcmd = find_cmd_tbl(argv[1], _cmdname##_subcmds, \
- ARRAY_SIZE(_cmdname##_subcmds)); \
- if (!subcmd || argc - 1 > subcmd->maxargs) \
- return CMD_RET_USAGE; \
- \
- if (flag == CMD_FLAG_REPEAT && \
- !cmd_is_repeatable(subcmd)) \
- return CMD_RET_SUCCESS; \
- \
- return subcmd->cmd_rep(subcmd, flag, argc - 1, \
- argv + 1, repeatable); \
- }
- #ifdef CONFIG_AUTO_COMPLETE
- #define U_BOOT_SUBCMDS_COMPLETE(_cmdname) \
- static int complete_##_cmdname(int argc, char *const argv[], \
- char last_char, int maxv, \
- char *cmdv[]) \
- { \
- return complete_subcmdv(_cmdname##_subcmds, \
- ARRAY_SIZE(_cmdname##_subcmds), \
- argc - 1, argv + 1, last_char, \
- maxv, cmdv); \
- }
- #else
- #define U_BOOT_SUBCMDS_COMPLETE(_cmdname)
- #endif
- #define U_BOOT_SUBCMDS(_cmdname, ...) \
- static struct cmd_tbl _cmdname##_subcmds[] = { __VA_ARGS__ }; \
- U_BOOT_SUBCMDS_RELOC(_cmdname) \
- U_BOOT_SUBCMDS_DO_CMD(_cmdname) \
- U_BOOT_SUBCMDS_COMPLETE(_cmdname)
- #ifdef CONFIG_CMDLINE
- #define U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep, \
- _usage, _help, _comp) \
- { #_name, _maxargs, _cmd_rep, cmd_discard_repeatable, \
- _usage, _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
- #define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
- _usage, _help, _comp) \
- { #_name, _maxargs, \
- _rep ? cmd_always_repeatable : cmd_never_repeatable, \
- _cmd, _usage, _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
- #define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, _comp) \
- ll_entry_declare(struct cmd_tbl, _name, cmd) = \
- U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
- _usage, _help, _comp);
- #define U_BOOT_CMDREP_COMPLETE(_name, _maxargs, _cmd_rep, _usage, \
- _help, _comp) \
- ll_entry_declare(struct cmd_tbl, _name, cmd) = \
- U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep, \
- _usage, _help, _comp)
- #else
- #define U_BOOT_SUBCMD_START(name) static struct cmd_tbl name[] = {};
- #define U_BOOT_SUBCMD_END
- #define _CMD_REMOVE(_name, _cmd) \
- int __remove_ ## _name(void) \
- { \
- if (0) \
- _cmd(NULL, 0, 0, NULL); \
- return 0; \
- }
- #define U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep, \
- _usage, _help, _comp) \
- { #_name, _maxargs, 0 ? _cmd_rep : NULL, NULL, _usage, \
- _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
- #define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, \
- _help, _comp) \
- { #_name, _maxargs, NULL, 0 ? _cmd : NULL, _usage, \
- _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
- #define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, \
- _comp) \
- _CMD_REMOVE(sub_ ## _name, _cmd)
- #define U_BOOT_CMDREP_COMPLETE(_name, _maxargs, _cmd_rep, _usage, \
- _help, _comp) \
- _CMD_REMOVE(sub_ ## _name, _cmd_rep)
- #endif /* CONFIG_CMDLINE */
- #define U_BOOT_CMD(_name, _maxargs, _rep, _cmd, _usage, _help) \
- U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, NULL)
- #define U_BOOT_CMD_MKENT(_name, _maxargs, _rep, _cmd, _usage, _help) \
- U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
- _usage, _help, NULL)
- #define U_BOOT_SUBCMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd, \
- _comp) \
- U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd, \
- "", "", _comp)
- #define U_BOOT_SUBCMD_MKENT(_name, _maxargs, _rep, _do_cmd) \
- U_BOOT_SUBCMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd, \
- NULL)
- #define U_BOOT_CMD_WITH_SUBCMDS(_name, _usage, _help, ...) \
- U_BOOT_SUBCMDS(_name, __VA_ARGS__) \
- U_BOOT_CMDREP_COMPLETE(_name, CONFIG_SYS_MAXARGS, do_##_name, \
- _usage, _help, complete_##_name)
- #endif /* __COMMAND_H */
|