include/command.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * (C) Copyright 2000-2009
   4  * Wolfgang Denk, DENX Software Engineering, [email protected].
   5  */
   6
   7 /*
   8  *  Definitions for Command Processor
   9  */
  10 #ifndef __COMMAND_H
  11 #define __COMMAND_H
  12
  13 #include <env.h>
  14 #include <linker_lists.h>
  15
  16 #include <linux/compiler_attributes.h>
  17
  18 #ifndef NULL
  19 #define NULL    0
  20 #endif
  21
  22 /* Default to a width of 8 characters for help message command width */
  23 #ifndef CFG_SYS_HELP_CMD_WIDTH
  24 #define CFG_SYS_HELP_CMD_WIDTH  10
  25 #endif
  26
  27 #ifndef __ASSEMBLY__
  28 /*
  29  * Monitor Command Table
  30  */
  31
  32 struct cmd_tbl {
  33         char            *name;          /* Command Name                 */
  34         int             maxargs;        /* maximum number of arguments  */
  35                                         /*
  36                                          * Same as ->cmd() except the command
  37                                          * tells us if it can be repeated.
  38                                          * Replaces the old ->repeatable field
  39                                          * which was not able to make
  40                                          * repeatable property different for
  41                                          * the main command and sub-commands.
  42                                          */
  43         int             (*cmd_rep)(struct cmd_tbl *cmd, int flags, int argc,
  44                                    char *const argv[], int *repeatable);
  45                                         /* Implementation function      */
  46         int             (*cmd)(struct cmd_tbl *cmd, int flags, int argc,
  47                                char *const argv[]);
  48         char            *usage;         /* Usage message        (short) */
  49 #ifdef  CONFIG_SYS_LONGHELP
  50         const char      *help;          /* Help  message        (long)  */
  51 #endif
  52 #ifdef CONFIG_AUTO_COMPLETE
  53         /* do auto completion on the arguments */
  54         int             (*complete)(int argc, char *const argv[],
  55                                     char last_char, int maxv, char *cmdv[]);
  56 #endif
  57 };
  58
  59 #if defined(CONFIG_CMD_RUN)
  60 int do_run(struct cmd_tbl *cmdtp, int flag, int argc,
  61            char *const argv[]);
  62 #endif
  63
  64 /* common/command.c */
  65 int _do_help(struct cmd_tbl *cmd_start, int cmd_items, struct cmd_tbl *cmdtp,
  66              int flag, int argc, char *const argv[]);
  67 struct cmd_tbl *find_cmd(const char *cmd);
  68 struct cmd_tbl *find_cmd_tbl(const char *cmd, struct cmd_tbl *table,
  69                              int table_len);
  70 int complete_subcmdv(struct cmd_tbl *cmdtp, int count, int argc,
  71                      char *const argv[], char last_char, int maxv,
  72                      char *cmdv[]);
  73
  74 int cmd_usage(const struct cmd_tbl *cmdtp);
  75
  76 /* Dummy ->cmd and ->cmd_rep wrappers. */
  77 int cmd_always_repeatable(struct cmd_tbl *cmdtp, int flag, int argc,
  78                           char *const argv[], int *repeatable);
  79 int cmd_never_repeatable(struct cmd_tbl *cmdtp, int flag, int argc,
  80                          char *const argv[], int *repeatable);
  81 int cmd_discard_repeatable(struct cmd_tbl *cmdtp, int flag, int argc,
  82                            char *const argv[]);
  83
  84 static inline bool cmd_is_repeatable(struct cmd_tbl *cmdtp)
  85 {
  86         return cmdtp->cmd_rep == cmd_always_repeatable;
  87 }
  88
  89 #ifdef CONFIG_AUTO_COMPLETE
  90 int var_complete(int argc, char *const argv[], char last_char, int maxv,
  91                  char *cmdv[]);
  92 int cmd_auto_complete(const char *const prompt, char *buf, int *np,
  93                       int *colp);
  94 #endif
  95
  96 /**
  97  * cmd_process_error() - report and process a possible error
  98  *
  99  * @cmdtp: Command which caused the error
 100  * @err: Error code (0 if none, -ve for error, like -EIO)
 101  * Return: 0 (CMD_RET_SUCCESS) if there is not error,
 102  *         1 (CMD_RET_FAILURE) if an error is found
 103  *         -1 (CMD_RET_USAGE) if 'usage' error is found
 104  */
 105 int cmd_process_error(struct cmd_tbl *cmdtp, int err);
 106
 107 /*
 108  * Monitor Command
 109  *
 110  * All commands use a common argument format:
 111  *
 112  * void function(struct cmd_tbl *cmdtp, int flag, int argc,
 113  *               char *const argv[]);
 114  */
 115
 116 #if defined(CONFIG_CMD_MEMORY) || \
 117         defined(CONFIG_CMD_I2C) || \
 118         defined(CONFIG_CMD_ITEST) || \
 119         defined(CONFIG_CMD_PCI) || \
 120         defined(CONFIG_CMD_SETEXPR)
 121 #define CMD_DATA_SIZE
 122 #define CMD_DATA_SIZE_ERR       (-1)
 123 #define CMD_DATA_SIZE_STR       (-2)
 124
 125 /**
 126  * cmd_get_data_size() - Get the data-size specifier from a command
 127  *
 128  * This reads a '.x' size specifier appended to a command. For example 'md.b'
 129  * is the 'md' command with a '.b' specifier, meaning that the command should
 130  * use bytes.
 131  *
 132  * Valid characters are:
 133  *
 134  *      b - byte
 135  *      w - word (16 bits)
 136  *      l - long (32 bits)
 137  *      q - quad (64 bits)
 138  *      s - string
 139  *
 140  * @arg: Pointers to the command to check. If a valid specifier is present it
 141  *      will be the last character of the string, following a '.'
 142  * @default_size: Default size to return if there is no specifier
 143  * Return: data size in bytes (1, 2, 4, 8) or CMD_DATA_SIZE_ERR for an invalid
 144  *      character, or CMD_DATA_SIZE_STR for a string
 145  */
 146 int cmd_get_data_size(char *arg, int default_size);
 147 #endif
 148
 149 #ifdef CONFIG_CMD_BOOTD
 150 int do_bootd(struct cmd_tbl *cmdtp, int flag, int argc,
 151              char *const argv[]);
 152 #endif
 153 int do_bootm(struct cmd_tbl *cmdtp, int flag, int argc,
 154              char *const argv[]);
 155 #ifdef CONFIG_CMD_BOOTM
 156 int bootm_maybe_autostart(struct cmd_tbl *cmdtp, const char *cmd);
 157 #else
 158 static inline int bootm_maybe_autostart(struct cmd_tbl *cmdtp, const char *cmd)
 159 {
 160         return 0;
 161 }
 162 #endif
 163
 164 int do_bootz(struct cmd_tbl *cmdtp, int flag, int argc,
 165              char *const argv[]);
 166
 167 int do_booti(struct cmd_tbl *cmdtp, int flag, int argc,
 168              char *const argv[]);
 169
 170 int do_zboot_parent(struct cmd_tbl *cmdtp, int flag, int argc,
 171                     char *const argv[], int *repeatable);
 172
 173 int common_diskboot(struct cmd_tbl *cmdtp, const char *intf, int argc,
 174                     char *const argv[]);
 175
 176 int do_reset(struct cmd_tbl *cmdtp, int flag, int argc,
 177              char *const argv[]);
 178 int do_poweroff(struct cmd_tbl *cmdtp, int flag, int argc,
 179                 char *const argv[]);
 180
 181 unsigned long do_go_exec(ulong (*entry)(int, char * const []), int argc,
 182                          char *const argv[]);
 183
 184 #if defined(CONFIG_CMD_NVEDIT_EFI)
 185 int do_env_print_efi(struct cmd_tbl *cmdtp, int flag, int argc,
 186                      char *const argv[]);
 187 int do_env_set_efi(struct cmd_tbl *cmdtp, int flag, int argc,
 188                    char *const argv[]);
 189 #endif
 190
 191 /**
 192  * setexpr_regex_sub() - Replace a regex pattern with a string
 193  *
 194  * @data: Buffer containing the string to update
 195  * @data_size: Size of buffer (must be large enough for the new string)
 196  * @nbuf: Back-reference buffer
 197  * @nbuf_size: Size of back-reference buffer (must be larger enough for @s plus
 198  *      all back-reference expansions)
 199  * @r: Regular expression to find
 200  * @s: String to replace with
 201  * @global: true to replace all matches in @data, false to replace just the
 202  *      first
 203  * Return: 0 if OK, 1 on error
 204  */
 205 int setexpr_regex_sub(char *data, uint data_size, char *nbuf, uint nbuf_size,
 206                       const char *r, const char *s, bool global);
 207
 208 /*
 209  * Error codes that commands return to cmd_process(). We use the standard 0
 210  * and 1 for success and failure, but add one more case - failure with a
 211  * request to call cmd_usage(). But the cmd_process() function handles
 212  * CMD_RET_USAGE itself and after calling cmd_usage() it will return 1.
 213  * This is just a convenience for commands to avoid them having to call
 214  * cmd_usage() all over the place.
 215  */
 216 enum command_ret_t {
 217         CMD_RET_SUCCESS,        /* 0 = Success */
 218         CMD_RET_FAILURE,        /* 1 = Failure */
 219         CMD_RET_USAGE = -1,     /* Failure, please report 'usage' error */
 220 };
 221
 222 /**
 223  * Process a command with arguments. We look up the command and execute it
 224  * if valid. Otherwise we print a usage message.
 225  *
 226  * @param flag          Some flags normally 0 (see CMD_FLAG_.. above)
 227  * @param argc          Number of arguments (arg 0 must be the command text)
 228  * @param argv          Arguments
 229  * @param repeatable    This function sets this to 0 if the command is not
 230  *                      repeatable. If the command is repeatable, the value
 231  *                      is left unchanged.
 232  * @param ticks         If ticks is not null, this function set it to the
 233  *                      number of ticks the command took to complete.
 234  * Return: 0 if command succeeded, else non-zero (CMD_RET_...)
 235  */
 236 enum command_ret_t cmd_process(int flag, int argc, char *const argv[],
 237                                int *repeatable, unsigned long *ticks);
 238
 239 void fixup_cmdtable(struct cmd_tbl *cmdtp, int size);
 240
 241 /**
 242  * board_run_command() - Fallback function to execute a command
 243  *
 244  * When no command line features are enabled in U-Boot, this function is
 245  * called to execute a command. Typically the function can look at the
 246  * command and perform a few very specific tasks, such as booting the
 247  * system in a particular way.
 248  *
 249  * This function is only used when CONFIG_CMDLINE is not enabled.
 250  *
 251  * In normal situations this function should not return, since U-Boot will
 252  * simply hang.
 253  *
 254  * @cmdline:    Command line string to execute
 255  * Return: 0 if OK, 1 for error
 256  */
 257 int board_run_command(const char *cmdline);
 258
 259 int run_command(const char *cmd, int flag);
 260 int run_command_repeatable(const char *cmd, int flag);
 261
 262 /**
 263  * run_commandf() - Run a command created by a format string
 264  *
 265  * @fmt: printf() format string
 266  * @...: Arguments to use (flag is always 0)
 267  *
 268  * The command cannot be larger than (CONFIG_SYS_CBSIZE - 1) characters.
 269  *
 270  * Return:
 271  * Returns 0 on success, -EIO if internal output error occurred, -ENOSPC in
 272  *      case of 'fmt' string truncation, or != 0 on error, specific for
 273  *      run_command().
 274  */
 275 int run_commandf(const char *fmt, ...) __printf(1, 2);
 276
 277 /**
 278  * Run a list of commands separated by ; or even \0
 279  *
 280  * Note that if 'len' is not -1, then the command does not need to be nul
 281  * terminated, Memory will be allocated for the command in that case.
 282  *
 283  * @param cmd   List of commands to run, each separated bu semicolon
 284  * @param len   Length of commands excluding terminator if known (-1 if not)
 285  * @param flag  Execution flags (CMD_FLAG_...)
 286  * Return: 0 on success, or != 0 on error.
 287  */
 288 int run_command_list(const char *cmd, int len, int flag);
 289
 290 /**
 291  * cmd_source_script() - Execute a script
 292  *
 293  * Executes a U-Boot script at a particular address in memory. The script should
 294  * have a header (FIT or legacy) with the script type (IH_TYPE_SCRIPT).
 295  *
 296  * @addr: Address of script
 297  * @fit_uname: FIT subimage name
 298  * Return: result code (enum command_ret_t)
 299  */
 300 int cmd_source_script(ulong addr, const char *fit_uname, const char *confname);
 301 #endif  /* __ASSEMBLY__ */
 302
 303 /*
 304  * Command Flags:
 305  */
 306 #define CMD_FLAG_REPEAT         0x0001  /* repeat last command          */
 307 #define CMD_FLAG_BOOTD          0x0002  /* command is from bootd        */
 308 #define CMD_FLAG_ENV            0x0004  /* command is from the environment */
 309
 310 #ifdef CONFIG_AUTO_COMPLETE
 311 # define _CMD_COMPLETE(x) x,
 312 #else
 313 # define _CMD_COMPLETE(x)
 314 #endif
 315 #ifdef CONFIG_SYS_LONGHELP
 316 # define _CMD_HELP(x) x,
 317 #else
 318 # define _CMD_HELP(x)
 319 #endif
 320
 321 #define U_BOOT_SUBCMDS_DO_CMD(_cmdname)                                 \
 322         static int do_##_cmdname(struct cmd_tbl *cmdtp, int flag,       \
 323                                  int argc, char *const argv[],          \
 324                                  int *repeatable)                       \
 325         {                                                               \
 326                 struct cmd_tbl *subcmd;                                 \
 327                                                                         \
 328                 /* We need at least the cmd and subcmd names. */        \
 329                 if (argc < 2 || argc > CONFIG_SYS_MAXARGS)              \
 330                         return CMD_RET_USAGE;                           \
 331                                                                         \
 332                 subcmd = find_cmd_tbl(argv[1], _cmdname##_subcmds,      \
 333                                       ARRAY_SIZE(_cmdname##_subcmds));  \
 334                 if (!subcmd || argc - 1 > subcmd->maxargs)              \
 335                         return CMD_RET_USAGE;                           \
 336                                                                         \
 337                 if (flag == CMD_FLAG_REPEAT &&                          \
 338                     !cmd_is_repeatable(subcmd))                         \
 339                         return CMD_RET_SUCCESS;                         \
 340                                                                         \
 341                 return subcmd->cmd_rep(subcmd, flag, argc - 1,          \
 342                                        argv + 1, repeatable);           \
 343         }
 344
 345 #ifdef CONFIG_AUTO_COMPLETE
 346 #define U_BOOT_SUBCMDS_COMPLETE(_cmdname)                               \
 347         static int complete_##_cmdname(int argc, char *const argv[],    \
 348                                        char last_char, int maxv,        \
 349                                        char *cmdv[])                    \
 350         {                                                               \
 351                 return complete_subcmdv(_cmdname##_subcmds,             \
 352                                         ARRAY_SIZE(_cmdname##_subcmds), \
 353                                         argc - 1, argv + 1, last_char,  \
 354                                         maxv, cmdv);                    \
 355         }
 356 #else
 357 #define U_BOOT_SUBCMDS_COMPLETE(_cmdname)
 358 #endif
 359
 360 #define U_BOOT_SUBCMDS(_cmdname, ...)                                   \
 361         static struct cmd_tbl _cmdname##_subcmds[] = { __VA_ARGS__ };   \
 362         U_BOOT_SUBCMDS_DO_CMD(_cmdname)                                 \
 363         U_BOOT_SUBCMDS_COMPLETE(_cmdname)
 364
 365 #if CONFIG_IS_ENABLED(CMDLINE)
 366 #define U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep,         \
 367                                      _usage, _help, _comp)              \
 368                 { #_name, _maxargs, _cmd_rep, cmd_discard_repeatable,   \
 369                   _usage, _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
 370
 371 #define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd,          \
 372                                 _usage, _help, _comp)                   \
 373                 { #_name, _maxargs,                                     \
 374                  _rep ? cmd_always_repeatable : cmd_never_repeatable,   \
 375                  _cmd, _usage, _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
 376
 377 #define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, _comp) \
 378         ll_entry_declare(struct cmd_tbl, _name, cmd) =                  \
 379                 U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd,  \
 380                                                 _usage, _help, _comp);
 381
 382 #define U_BOOT_CMDREP_COMPLETE(_name, _maxargs, _cmd_rep, _usage,       \
 383                                _help, _comp)                            \
 384         ll_entry_declare(struct cmd_tbl, _name, cmd) =                  \
 385                 U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep, \
 386                                              _usage, _help, _comp)
 387
 388 #else
 389 #define U_BOOT_SUBCMD_START(name)       static struct cmd_tbl name[] = {};
 390 #define U_BOOT_SUBCMD_END
 391
 392 #define _CMD_REMOVE(_name, _cmd)                                        \
 393         int __remove_ ## _name(void)                                    \
 394         {                                                               \
 395                 if (0)                                                  \
 396                         _cmd(NULL, 0, 0, NULL);                         \
 397                 return 0;                                               \
 398         }
 399
 400 #define _CMD_REMOVE_REP(_name, _cmd)                                    \
 401         int __remove_ ## _name(void)                                    \
 402         {                                                               \
 403                 if (0)                                                  \
 404                         _cmd(NULL, 0, 0, NULL, NULL);                   \
 405                 return 0;                                               \
 406         }
 407
 408 #define U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep,         \
 409                                      _usage, _help, _comp)              \
 410                 { #_name, _maxargs, 0 ? _cmd_rep : NULL, NULL, _usage,  \
 411                         _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
 412
 413 #define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, _usage,  \
 414                                   _help, _comp)                         \
 415                 { #_name, _maxargs, NULL, 0 ? _cmd : NULL, _usage,      \
 416                         _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
 417
 418 #define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, \
 419                             _comp)                              \
 420         _CMD_REMOVE(sub_ ## _name, _cmd)
 421
 422 #define U_BOOT_CMDREP_COMPLETE(_name, _maxargs, _cmd_rep, _usage,       \
 423                                _help, _comp)                            \
 424         _CMD_REMOVE_REP(sub_ ## _name, _cmd_rep)
 425
 426 #endif /* CONFIG_CMDLINE */
 427
 428 #define U_BOOT_CMD(_name, _maxargs, _rep, _cmd, _usage, _help)          \
 429         U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, NULL)
 430
 431 #define U_BOOT_CMD_MKENT(_name, _maxargs, _rep, _cmd, _usage, _help)    \
 432         U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd,          \
 433                                         _usage, _help, NULL)
 434
 435 #define U_BOOT_SUBCMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd,    \
 436                                      _comp)                             \
 437         U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd,       \
 438                                   "", "", _comp)
 439
 440 #define U_BOOT_SUBCMD_MKENT(_name, _maxargs, _rep, _do_cmd)             \
 441         U_BOOT_SUBCMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd,    \
 442                                      NULL)
 443
 444 #define U_BOOT_CMD_WITH_SUBCMDS(_name, _usage, _help, ...)              \
 445         U_BOOT_SUBCMDS(_name, __VA_ARGS__)                              \
 446         U_BOOT_CMDREP_COMPLETE(_name, CONFIG_SYS_MAXARGS, do_##_name,   \
 447                                _usage, _help, complete_##_name)
 448
 449 #endif  /* __COMMAND_H */