2 * (C) Copyright 2000-2009
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 * SPDX-License-Identifier: GPL-2.0+
9 * Definitions for Command Processor
14 #include <linker_lists.h>
20 /* Default to a width of 8 characters for help message command width */
21 #ifndef CONFIG_SYS_HELP_CMD_WIDTH
22 #define CONFIG_SYS_HELP_CMD_WIDTH 8
27 * Monitor Command Table
31 char *name; /* Command Name */
32 int maxargs; /* maximum number of arguments */
33 int repeatable; /* autorepeat allowed? */
34 /* Implementation function */
35 int (*cmd)(struct cmd_tbl_s *, int, int, char * const []);
36 char *usage; /* Usage message (short) */
37 #ifdef CONFIG_SYS_LONGHELP
38 char *help; /* Help message (long) */
40 #ifdef CONFIG_AUTO_COMPLETE
41 /* do auto completion on the arguments */
42 int (*complete)(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
46 typedef struct cmd_tbl_s cmd_tbl_t;
49 #if defined(CONFIG_CMD_RUN)
50 extern int do_run(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
53 /* common/command.c */
54 int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int
55 flag, int argc, char * const argv[]);
56 cmd_tbl_t *find_cmd(const char *cmd);
57 cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len);
59 extern int cmd_usage(const cmd_tbl_t *cmdtp);
61 #ifdef CONFIG_AUTO_COMPLETE
62 extern int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
63 extern int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp);
67 * cmd_process_error() - report and process a possible error
69 * @cmdtp: Command which caused the error
70 * @err: Error code (0 if none, -ve for error, like -EIO)
71 * @return 0 if there is not error, 1 (CMD_RET_FAILURE) if an error is found
73 int cmd_process_error(cmd_tbl_t *cmdtp, int err);
78 * All commands use a common argument format:
80 * void function (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
83 #if defined(CONFIG_CMD_MEMORY) \
84 || defined(CONFIG_CMD_I2C) \
85 || defined(CONFIG_CMD_ITEST) \
86 || defined(CONFIG_CMD_PCI) \
87 || defined(CONFIG_CMD_PORTIO)
89 extern int cmd_get_data_size(char* arg, int default_size);
92 #ifdef CONFIG_CMD_BOOTD
93 extern int do_bootd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
95 #ifdef CONFIG_CMD_BOOTM
96 extern int do_bootm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
97 extern int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd);
99 static inline int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd)
105 extern int do_bootz(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
107 extern int do_booti(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
109 extern int common_diskboot(cmd_tbl_t *cmdtp, const char *intf, int argc,
112 extern int do_reset(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
113 extern int do_poweroff(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
116 * Error codes that commands return to cmd_process(). We use the standard 0
117 * and 1 for success and failure, but add one more case - failure with a
118 * request to call cmd_usage(). But the cmd_process() function handles
119 * CMD_RET_USAGE itself and after calling cmd_usage() it will return 1.
120 * This is just a convenience for commands to avoid them having to call
121 * cmd_usage() all over the place.
124 CMD_RET_SUCCESS, /* 0 = Success */
125 CMD_RET_FAILURE, /* 1 = Failure */
126 CMD_RET_USAGE = -1, /* Failure, please report 'usage' error */
130 * Process a command with arguments. We look up the command and execute it
131 * if valid. Otherwise we print a usage message.
133 * @param flag Some flags normally 0 (see CMD_FLAG_.. above)
134 * @param argc Number of arguments (arg 0 must be the command text)
135 * @param argv Arguments
136 * @param repeatable This function sets this to 0 if the command is not
137 * repeatable. If the command is repeatable, the value
139 * @param ticks If ticks is not null, this function set it to the
140 * number of ticks the command took to complete.
141 * @return 0 if the command succeeded, 1 if it failed
143 int cmd_process(int flag, int argc, char * const argv[],
144 int *repeatable, unsigned long *ticks);
146 void fixup_cmdtable(cmd_tbl_t *cmdtp, int size);
147 #endif /* __ASSEMBLY__ */
152 #define CMD_FLAG_REPEAT 0x0001 /* repeat last command */
153 #define CMD_FLAG_BOOTD 0x0002 /* command is from bootd */
154 #define CMD_FLAG_ENV 0x0004 /* command is from the environment */
156 #ifdef CONFIG_AUTO_COMPLETE
157 # define _CMD_COMPLETE(x) x,
159 # define _CMD_COMPLETE(x)
161 #ifdef CONFIG_SYS_LONGHELP
162 # define _CMD_HELP(x) x,
164 # define _CMD_HELP(x)
167 #define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
168 _usage, _help, _comp) \
169 { #_name, _maxargs, _rep, _cmd, _usage, \
170 _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
172 #define U_BOOT_CMD_MKENT(_name, _maxargs, _rep, _cmd, _usage, _help) \
173 U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
176 #define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, _comp) \
177 ll_entry_declare(cmd_tbl_t, _name, cmd) = \
178 U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
179 _usage, _help, _comp);
181 #define U_BOOT_CMD(_name, _maxargs, _rep, _cmd, _usage, _help) \
182 U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, NULL)
184 #endif /* __COMMAND_H */