Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 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 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 | /* 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_s { 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_s *cmd, int flags, int argc, char * const argv[], int *repeatable); /* Implementation function */ int (*cmd)(struct cmd_tbl_s *, int, int, char * const []); 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 }; typedef struct cmd_tbl_s cmd_tbl_t; #if defined(CONFIG_CMD_RUN) extern int do_run(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); #endif /* common/command.c */ int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[]); cmd_tbl_t *find_cmd(const char *cmd); cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len); int complete_subcmdv(cmd_tbl_t *cmdtp, int count, int argc, char * const argv[], char last_char, int maxv, char *cmdv[]); extern int cmd_usage(const cmd_tbl_t *cmdtp); /* 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; } #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(cmd_tbl_t *cmdtp, int err); /* * Monitor Command * * All commands use a common argument format: * * void function (cmd_tbl_t *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(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); #endif #ifdef CONFIG_CMD_BOOTM extern int do_bootm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); 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 extern int do_bootz(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); extern int do_booti(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); extern int common_diskboot(cmd_tbl_t *cmdtp, const char *intf, int argc, char *const argv[]); extern int do_reset(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); extern int do_poweroff(cmd_tbl_t *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(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 /* * 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(cmd_tbl_t *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(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) #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(cmd_tbl_t, _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(cmd_tbl_t, _name, cmd) = \ U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep, \ _usage, _help, _comp) #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; \ } #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 */ |