Blame view
include/command.h
12 KB
83d290c56 SPDX: Convert all... |
1 |
/* SPDX-License-Identifier: GPL-2.0+ */ |
78f6622a1 Initial revision |
2 |
/* |
2dce551e1 command.c: Expose... |
3 |
* (C) Copyright 2000-2009 |
78f6622a1 Initial revision |
4 |
* Wolfgang Denk, DENX Software Engineering, wd@denx.de. |
78f6622a1 Initial revision |
5 6 7 8 9 10 11 |
*/ /* * Definitions for Command Processor */ #ifndef __COMMAND_H #define __COMMAND_H |
9fb625ce0 env: Move env_set... |
12 |
#include <env.h> |
6c7c946ca common: Convert t... |
13 |
#include <linker_lists.h> |
f2302d443 Fix merge problems |
14 |
|
78f6622a1 Initial revision |
15 16 17 |
#ifndef NULL #define NULL 0 #endif |
2fb2604d5 Command usage cle... |
18 19 |
/* Default to a width of 8 characters for help message command width */ #ifndef CONFIG_SYS_HELP_CMD_WIDTH |
9eebaba2a cmd: set CONFIG_S... |
20 |
#define CONFIG_SYS_HELP_CMD_WIDTH 10 |
2fb2604d5 Command usage cle... |
21 |
#endif |
78f6622a1 Initial revision |
22 23 24 25 26 27 28 |
#ifndef __ASSEMBLY__ /* * Monitor Command Table */ struct cmd_tbl_s { char *name; /* Command Name */ |
78f6622a1 Initial revision |
29 |
int maxargs; /* maximum number of arguments */ |
80a48dd47 common: command: ... |
30 31 32 33 34 35 36 37 38 39 |
/* * 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_s *cmd, int flags, int argc, char * const argv[], int *repeatable); |
78f6622a1 Initial revision |
40 |
/* Implementation function */ |
54841ab50 Make sure that ar... |
41 |
int (*cmd)(struct cmd_tbl_s *, int, int, char * const []); |
78f6622a1 Initial revision |
42 |
char *usage; /* Usage message (short) */ |
6d0f6bcf3 rename CFG_ macro... |
43 |
#ifdef CONFIG_SYS_LONGHELP |
78f6622a1 Initial revision |
44 45 |
char *help; /* Help message (long) */ #endif |
04a85b3b3 * Patches by Pant... |
46 47 |
#ifdef CONFIG_AUTO_COMPLETE /* do auto completion on the arguments */ |
54841ab50 Make sure that ar... |
48 |
int (*complete)(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]); |
04a85b3b3 * Patches by Pant... |
49 |
#endif |
78f6622a1 Initial revision |
50 51 52 |
}; typedef struct cmd_tbl_s cmd_tbl_t; |
78f6622a1 Initial revision |
53 |
|
d09b1787a env: clean cmd_nv... |
54 55 56 |
#if defined(CONFIG_CMD_RUN) extern int do_run(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); #endif |
78f6622a1 Initial revision |
57 58 |
/* common/command.c */ |
2dce551e1 command.c: Expose... |
59 |
int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int |
54841ab50 Make sure that ar... |
60 |
flag, int argc, char * const argv[]); |
78f6622a1 Initial revision |
61 |
cmd_tbl_t *find_cmd(const char *cmd); |
b799cb4c0 Expose command ta... |
62 |
cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len); |
6fb61445b common: command: ... |
63 64 65 |
int complete_subcmdv(cmd_tbl_t *cmdtp, int count, int argc, char * const argv[], char last_char, int maxv, char *cmdv[]); |
78f6622a1 Initial revision |
66 |
|
e84ffddbc cmd_usage: constify |
67 |
extern int cmd_usage(const cmd_tbl_t *cmdtp); |
62c3ae7c6 Standardize comma... |
68 |
|
80a48dd47 common: command: ... |
69 70 71 72 73 74 75 76 77 78 79 80 |
/* Dummy ->cmd and ->cmd_rep wrappers. */ int cmd_always_repeatable(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[], int *repeatable); int cmd_never_repeatable(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[], int *repeatable); int cmd_discard_repeatable(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); static inline bool cmd_is_repeatable(cmd_tbl_t *cmdtp) { return cmdtp->cmd_rep == cmd_always_repeatable; } |
04a85b3b3 * Patches by Pant... |
81 |
#ifdef CONFIG_AUTO_COMPLETE |
722b061b6 autocomplete: rem... |
82 |
extern int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]); |
04a85b3b3 * Patches by Pant... |
83 84 |
extern int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp); #endif |
16ff99024 Add cmd_process_e... |
85 86 87 88 89 |
/** * 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) |
8a3d734b1 common: command: ... |
90 |
* @return 0 (CMD_RET_SUCCESS) if there is not error, |
27eb7bce3 common: command: ... |
91 92 |
* 1 (CMD_RET_FAILURE) if an error is found * -1 (CMD_RET_USAGE) if 'usage' error is found |
16ff99024 Add cmd_process_e... |
93 94 |
*/ int cmd_process_error(cmd_tbl_t *cmdtp, int err); |
78f6622a1 Initial revision |
95 96 97 98 99 |
/* * Monitor Command * * All commands use a common argument format: * |
54841ab50 Make sure that ar... |
100 |
* void function (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); |
78f6622a1 Initial revision |
101 |
*/ |
6f62d7c4f Kconfig: Drop CON... |
102 103 104 |
#if defined(CONFIG_CMD_MEMORY) || \ defined(CONFIG_CMD_I2C) || \ defined(CONFIG_CMD_ITEST) || \ |
75846445e cmd: define CMD_D... |
105 106 |
defined(CONFIG_CMD_PCI) || \ defined(CONFIG_CMD_SETEXPR) |
8a40fb148 move cmd_get_data... |
107 108 109 |
#define CMD_DATA_SIZE extern int cmd_get_data_size(char* arg, int default_size); #endif |
7842fb7c4 do_bootd: unify d... |
110 111 112 |
#ifdef CONFIG_CMD_BOOTD extern int do_bootd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); #endif |
67d668bf9 autostart: unify ... |
113 |
#ifdef CONFIG_CMD_BOOTM |
36ebb7877 do_bootm: unify d... |
114 |
extern int do_bootm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); |
67d668bf9 autostart: unify ... |
115 116 117 118 119 120 121 |
extern int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd); #else static inline int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd) { return 0; } #endif |
7405a1331 combine block dev... |
122 |
|
da620222f bootz: un-statici... |
123 |
extern int do_bootz(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); |
8b5c738b8 pxe: add AArch64 ... |
124 |
extern int do_booti(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); |
7405a1331 combine block dev... |
125 126 |
extern int common_diskboot(cmd_tbl_t *cmdtp, const char *intf, int argc, char *const argv[]); |
882b7d726 do_reset: unify d... |
127 |
extern int do_reset(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); |
4e42e29fd cmd_boot: Add a p... |
128 |
extern int do_poweroff(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); |
36ebb7877 do_bootm: unify d... |
129 |
|
51916864b arm64: zynqmp: Ad... |
130 131 |
extern unsigned long do_go_exec(ulong (*entry)(int, char * const []), int argc, char * const argv[]); |
49d81fdfb cmd: env: add "-e... |
132 133 134 135 136 137 138 |
#if defined(CONFIG_CMD_NVEDIT_EFI) extern int do_env_print_efi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); extern int do_env_set_efi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); #endif |
9f99e9de1 MLK-18591-3 andro... |
139 140 141 |
#ifdef CONFIG_CMD_READ int do_raw_read(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); #endif |
9d12d5d41 Add cmd_process()... |
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 |
/* * 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. |
34765e885 cmd_time: merge r... |
166 167 |
* @param ticks If ticks is not null, this function set it to the * number of ticks the command took to complete. |
9d12d5d41 Add cmd_process()... |
168 169 170 |
* @return 0 if the command succeeded, 1 if it failed */ int cmd_process(int flag, int argc, char * const argv[], |
34765e885 cmd_time: merge r... |
171 |
int *repeatable, unsigned long *ticks); |
bdf8e34b9 Create a single c... |
172 |
|
cbb2df201 CONFIG_NEEDS_MANU... |
173 |
void fixup_cmdtable(cmd_tbl_t *cmdtp, int size); |
f8bb69643 Drop command-proc... |
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 |
/** * 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); |
288b29e44 common: Move comm... |
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 |
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); |
78f6622a1 Initial revision |
208 209 210 211 212 213 214 |
#endif /* __ASSEMBLY__ */ /* * Command Flags: */ #define CMD_FLAG_REPEAT 0x0001 /* repeat last command */ #define CMD_FLAG_BOOTD 0x0002 /* command is from bootd */ |
87b6398b4 cli: hush: Adjust... |
215 |
#define CMD_FLAG_ENV 0x0004 /* command is from the environment */ |
78f6622a1 Initial revision |
216 |
|
722b061b6 autocomplete: rem... |
217 218 219 220 221 222 223 224 225 226 |
#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 |
8bde7f776 * Code cleanup: |
227 |
|
c0cf06e52 command: commands... |
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
#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(cmd_tbl_t *cmdtp, int flag, int argc, \ char * const argv[], int *repeatable) \ { \ cmd_tbl_t *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 cmd_tbl_t _cmdname##_subcmds[] = { __VA_ARGS__ }; \ U_BOOT_SUBCMDS_RELOC(_cmdname) \ U_BOOT_SUBCMDS_DO_CMD(_cmdname) \ U_BOOT_SUBCMDS_COMPLETE(_cmdname) |
fb24112c1 Allow command cod... |
291 |
#ifdef CONFIG_CMDLINE |
80a48dd47 common: command: ... |
292 293 294 295 |
#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) } |
6c7c946ca common: Convert t... |
296 297 |
#define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \ _usage, _help, _comp) \ |
80a48dd47 common: command: ... |
298 299 300 |
{ #_name, _maxargs, \ _rep ? cmd_always_repeatable : cmd_never_repeatable, \ _cmd, _usage, _CMD_HELP(_help) _CMD_COMPLETE(_comp) } |
8bde7f776 * Code cleanup: |
301 |
|
6c7c946ca common: Convert t... |
302 |
#define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, _comp) \ |
ef123c525 Refactor linker-g... |
303 |
ll_entry_declare(cmd_tbl_t, _name, cmd) = \ |
6c7c946ca common: Convert t... |
304 305 |
U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \ _usage, _help, _comp); |
8bde7f776 * Code cleanup: |
306 |
|
80a48dd47 common: command: ... |
307 308 309 310 311 |
#define U_BOOT_CMDREP_COMPLETE(_name, _maxargs, _cmd_rep, _usage, \ _help, _comp) \ ll_entry_declare(cmd_tbl_t, _name, cmd) = \ U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep, \ _usage, _help, _comp) |
fb24112c1 Allow command cod... |
312 313 314 315 316 317 318 319 320 321 322 |
#else #define U_BOOT_SUBCMD_START(name) static cmd_tbl_t name[] = {}; #define U_BOOT_SUBCMD_END #define _CMD_REMOVE(_name, _cmd) \ int __remove_ ## _name(void) \ { \ if (0) \ _cmd(NULL, 0, 0, NULL); \ return 0; \ } |
80a48dd47 common: command: ... |
323 324 325 326 327 |
#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) } |
fb24112c1 Allow command cod... |
328 329 |
#define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, \ _help, _comp) \ |
80a48dd47 common: command: ... |
330 |
{ #_name, _maxargs, NULL, 0 ? _cmd : NULL, _usage, \ |
fb24112c1 Allow command cod... |
331 332 333 334 335 |
_CMD_HELP(_help) _CMD_COMPLETE(_comp) } #define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, \ _comp) \ _CMD_REMOVE(sub_ ## _name, _cmd) |
80a48dd47 common: command: ... |
336 337 338 |
#define U_BOOT_CMDREP_COMPLETE(_name, _maxargs, _cmd_rep, _usage, \ _help, _comp) \ _CMD_REMOVE(sub_ ## _name, _cmd_rep) |
fb24112c1 Allow command cod... |
339 |
#endif /* CONFIG_CMDLINE */ |
6c7c946ca common: Convert t... |
340 341 |
#define U_BOOT_CMD(_name, _maxargs, _rep, _cmd, _usage, _help) \ U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, NULL) |
8bde7f776 * Code cleanup: |
342 |
|
fb24112c1 Allow command cod... |
343 344 345 |
#define U_BOOT_CMD_MKENT(_name, _maxargs, _rep, _cmd, _usage, _help) \ U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \ _usage, _help, NULL) |
c0cf06e52 command: commands... |
346 347 348 349 350 351 352 353 354 355 356 357 358 |
#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) |
78f6622a1 Initial revision |
359 |
#endif /* __COMMAND_H */ |