include/command.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * (C) Copyright 2000-2009
   4  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   5  */
   6
   7 /*
   8  *  Definitions for Command Processor
   9  */
  10 #ifndef __COMMAND_H
  11 #define __COMMAND_H
  12
  13 #include <linker_lists.h>
  14
  15 #ifndef NULL
  16 #define NULL    0
  17 #endif
  18
  19 /* Default to a width of 8 characters for help message command width */
  20 #ifndef CONFIG_SYS_HELP_CMD_WIDTH
  21 #define CONFIG_SYS_HELP_CMD_WIDTH       10
  22 #endif
  23
  24 #ifndef __ASSEMBLY__
  25 /*
  26  * Monitor Command Table
  27  */
  28
  29 struct cmd_tbl_s {
  30         char            *name;          /* Command Name                 */
  31         int             maxargs;        /* maximum number of arguments  */
  32                                         /*
  33                                          * Same as ->cmd() except the command
  34                                          * tells us if it can be repeated.
  35                                          * Replaces the old ->repeatable field
  36                                          * which was not able to make
  37                                          * repeatable property different for
  38                                          * the main command and sub-commands.
  39                                          */
  40         int             (*cmd_rep)(struct cmd_tbl_s *cmd, int flags, int argc,
  41                                    char * const argv[], int *repeatable);
  42                                         /* Implementation function      */
  43         int             (*cmd)(struct cmd_tbl_s *, int, int, char * const []);
  44         char            *usage;         /* Usage message        (short) */
  45 #ifdef  CONFIG_SYS_LONGHELP
  46         char            *help;          /* Help  message        (long)  */
  47 #endif
  48 #ifdef CONFIG_AUTO_COMPLETE
  49         /* do auto completion on the arguments */
  50         int             (*complete)(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
  51 #endif
  52 };
  53
  54 typedef struct cmd_tbl_s        cmd_tbl_t;
  55
  56
  57 #if defined(CONFIG_CMD_RUN)
  58 extern int do_run(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
  59 #endif
  60
  61 /* common/command.c */
  62 int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int
  63               flag, int argc, char * const argv[]);
  64 cmd_tbl_t *find_cmd(const char *cmd);
  65 cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len);
  66 int complete_subcmdv(cmd_tbl_t *cmdtp, int count, int argc,
  67                      char * const argv[], char last_char, int maxv,
  68                      char *cmdv[]);
  69
  70 extern int cmd_usage(const cmd_tbl_t *cmdtp);
  71
  72 /* Dummy ->cmd and ->cmd_rep wrappers. */
  73 int cmd_always_repeatable(cmd_tbl_t *cmdtp, int flag, int argc,
  74                           char * const argv[], int *repeatable);
  75 int cmd_never_repeatable(cmd_tbl_t *cmdtp, int flag, int argc,
  76                          char * const argv[], int *repeatable);
  77 int cmd_discard_repeatable(cmd_tbl_t *cmdtp, int flag, int argc,
  78                            char * const argv[]);
  79
  80 static inline bool cmd_is_repeatable(cmd_tbl_t *cmdtp)
  81 {
  82         return cmdtp->cmd_rep == cmd_always_repeatable;
  83 }
  84
  85 #ifdef CONFIG_AUTO_COMPLETE
  86 extern int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
  87 extern int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp);
  88 #endif
  89
  90 /**
  91  * cmd_process_error() - report and process a possible error
  92  *
  93  * @cmdtp: Command which caused the error
  94  * @err: Error code (0 if none, -ve for error, like -EIO)
  95  * @return 0 (CMD_RET_SUCCESS) if there is not error,
  96  *         1 (CMD_RET_FAILURE) if an error is found
  97  *         -1 (CMD_RET_USAGE) if 'usage' error is found
  98  */
  99 int cmd_process_error(cmd_tbl_t *cmdtp, int err);
 100
 101 /*
 102  * Monitor Command
 103  *
 104  * All commands use a common argument format:
 105  *
 106  * void function (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 107  */
 108
 109 #if defined(CONFIG_CMD_MEMORY) || \
 110         defined(CONFIG_CMD_I2C) || \
 111         defined(CONFIG_CMD_ITEST) || \
 112         defined(CONFIG_CMD_PCI)
 113 #define CMD_DATA_SIZE
 114 extern int cmd_get_data_size(char* arg, int default_size);
 115 #endif
 116
 117 #ifdef CONFIG_CMD_BOOTD
 118 extern int do_bootd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 119 #endif
 120 #ifdef CONFIG_CMD_BOOTM
 121 extern int do_bootm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 122 extern int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd);
 123 #else
 124 static inline int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd)
 125 {
 126         return 0;
 127 }
 128 #endif
 129
 130 extern int do_bootz(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 131
 132 extern int do_booti(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 133
 134 extern int common_diskboot(cmd_tbl_t *cmdtp, const char *intf, int argc,
 135                            char *const argv[]);
 136
 137 extern int do_reset(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 138 extern int do_poweroff(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 139
 140 extern unsigned long do_go_exec(ulong (*entry)(int, char * const []), int argc,
 141                                 char * const argv[]);
 142
 143 #if defined(CONFIG_CMD_NVEDIT_EFI)
 144 extern int do_env_print_efi(cmd_tbl_t *cmdtp, int flag, int argc,
 145                             char * const argv[]);
 146 extern int do_env_set_efi(cmd_tbl_t *cmdtp, int flag, int argc,
 147                           char * const argv[]);
 148 #endif
 149
 150 /*
 151  * Error codes that commands return to cmd_process(). We use the standard 0
 152  * and 1 for success and failure, but add one more case - failure with a
 153  * request to call cmd_usage(). But the cmd_process() function handles
 154  * CMD_RET_USAGE itself and after calling cmd_usage() it will return 1.
 155  * This is just a convenience for commands to avoid them having to call
 156  * cmd_usage() all over the place.
 157  */
 158 enum command_ret_t {
 159         CMD_RET_SUCCESS,        /* 0 = Success */
 160         CMD_RET_FAILURE,        /* 1 = Failure */
 161         CMD_RET_USAGE = -1,     /* Failure, please report 'usage' error */
 162 };
 163
 164 /**
 165  * Process a command with arguments. We look up the command and execute it
 166  * if valid. Otherwise we print a usage message.
 167  *
 168  * @param flag          Some flags normally 0 (see CMD_FLAG_.. above)
 169  * @param argc          Number of arguments (arg 0 must be the command text)
 170  * @param argv          Arguments
 171  * @param repeatable    This function sets this to 0 if the command is not
 172  *                      repeatable. If the command is repeatable, the value
 173  *                      is left unchanged.
 174  * @param ticks         If ticks is not null, this function set it to the
 175  *                      number of ticks the command took to complete.
 176  * @return 0 if the command succeeded, 1 if it failed
 177  */
 178 int cmd_process(int flag, int argc, char * const argv[],
 179                                int *repeatable, unsigned long *ticks);
 180
 181 void fixup_cmdtable(cmd_tbl_t *cmdtp, int size);
 182
 183 /**
 184  * board_run_command() - Fallback function to execute a command
 185  *
 186  * When no command line features are enabled in U-Boot, this function is
 187  * called to execute a command. Typically the function can look at the
 188  * command and perform a few very specific tasks, such as booting the
 189  * system in a particular way.
 190  *
 191  * This function is only used when CONFIG_CMDLINE is not enabled.
 192  *
 193  * In normal situations this function should not return, since U-Boot will
 194  * simply hang.
 195  *
 196  * @cmdline:    Command line string to execute
 197  * @return 0 if OK, 1 for error
 198  */
 199 int board_run_command(const char *cmdline);
 200 #endif  /* __ASSEMBLY__ */
 201
 202 /*
 203  * Command Flags:
 204  */
 205 #define CMD_FLAG_REPEAT         0x0001  /* repeat last command          */
 206 #define CMD_FLAG_BOOTD          0x0002  /* command is from bootd        */
 207 #define CMD_FLAG_ENV            0x0004  /* command is from the environment */
 208
 209 #ifdef CONFIG_AUTO_COMPLETE
 210 # define _CMD_COMPLETE(x) x,
 211 #else
 212 # define _CMD_COMPLETE(x)
 213 #endif
 214 #ifdef CONFIG_SYS_LONGHELP
 215 # define _CMD_HELP(x) x,
 216 #else
 217 # define _CMD_HELP(x)
 218 #endif
 219
 220 #ifdef CONFIG_NEEDS_MANUAL_RELOC
 221 #define U_BOOT_SUBCMDS_RELOC(_cmdname)                                  \
 222         static void _cmdname##_subcmds_reloc(void)                      \
 223         {                                                               \
 224                 static int relocated;                                   \
 225                                                                         \
 226                 if (relocated)                                          \
 227                         return;                                         \
 228                                                                         \
 229                 fixup_cmdtable(_cmdname##_subcmds,                      \
 230                                ARRAY_SIZE(_cmdname##_subcmds));         \
 231                 relocated = 1;                                          \
 232         }
 233 #else
 234 #define U_BOOT_SUBCMDS_RELOC(_cmdname)                                  \
 235         static void _cmdname##_subcmds_reloc(void) { }
 236 #endif
 237
 238 #define U_BOOT_SUBCMDS_DO_CMD(_cmdname)                                 \
 239         static int do_##_cmdname(cmd_tbl_t *cmdtp, int flag, int argc,  \
 240                                  char * const argv[], int *repeatable)  \
 241         {                                                               \
 242                 cmd_tbl_t *subcmd;                                      \
 243                                                                         \
 244                 _cmdname##_subcmds_reloc();                             \
 245                                                                         \
 246                 /* We need at least the cmd and subcmd names. */        \
 247                 if (argc < 2 || argc > CONFIG_SYS_MAXARGS)              \
 248                         return CMD_RET_USAGE;                           \
 249                                                                         \
 250                 subcmd = find_cmd_tbl(argv[1], _cmdname##_subcmds,      \
 251                                       ARRAY_SIZE(_cmdname##_subcmds));  \
 252                 if (!subcmd || argc - 1 > subcmd->maxargs)              \
 253                         return CMD_RET_USAGE;                           \
 254                                                                         \
 255                 if (flag == CMD_FLAG_REPEAT &&                          \
 256                     !cmd_is_repeatable(subcmd))                         \
 257                         return CMD_RET_SUCCESS;                         \
 258                                                                         \
 259                 return subcmd->cmd_rep(subcmd, flag, argc - 1,          \
 260                                        argv + 1, repeatable);           \
 261         }
 262
 263 #ifdef CONFIG_AUTO_COMPLETE
 264 #define U_BOOT_SUBCMDS_COMPLETE(_cmdname)                               \
 265         static int complete_##_cmdname(int argc, char * const argv[],   \
 266                                        char last_char, int maxv,        \
 267                                        char *cmdv[])                    \
 268         {                                                               \
 269                 return complete_subcmdv(_cmdname##_subcmds,             \
 270                                         ARRAY_SIZE(_cmdname##_subcmds), \
 271                                         argc - 1, argv + 1, last_char,  \
 272                                         maxv, cmdv);                    \
 273         }
 274 #else
 275 #define U_BOOT_SUBCMDS_COMPLETE(_cmdname)
 276 #endif
 277
 278 #define U_BOOT_SUBCMDS(_cmdname, ...)                                   \
 279         static cmd_tbl_t _cmdname##_subcmds[] = { __VA_ARGS__ };        \
 280         U_BOOT_SUBCMDS_RELOC(_cmdname)                                  \
 281         U_BOOT_SUBCMDS_DO_CMD(_cmdname)                                 \
 282         U_BOOT_SUBCMDS_COMPLETE(_cmdname)
 283
 284 #ifdef CONFIG_CMDLINE
 285 #define U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep,         \
 286                                      _usage, _help, _comp)              \
 287                 { #_name, _maxargs, _cmd_rep, cmd_discard_repeatable,   \
 288                   _usage, _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
 289
 290 #define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd,          \
 291                                 _usage, _help, _comp)                   \
 292                 { #_name, _maxargs,                                     \
 293                  _rep ? cmd_always_repeatable : cmd_never_repeatable,   \
 294                  _cmd, _usage, _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
 295
 296 #define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, _comp) \
 297         ll_entry_declare(cmd_tbl_t, _name, cmd) =                       \
 298                 U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd,  \
 299                                                 _usage, _help, _comp);
 300
 301 #define U_BOOT_CMDREP_COMPLETE(_name, _maxargs, _cmd_rep, _usage,       \
 302                                _help, _comp)                            \
 303         ll_entry_declare(cmd_tbl_t, _name, cmd) =                       \
 304                 U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep, \
 305                                              _usage, _help, _comp)
 306
 307 #else
 308 #define U_BOOT_SUBCMD_START(name)       static cmd_tbl_t name[] = {};
 309 #define U_BOOT_SUBCMD_END
 310
 311 #define _CMD_REMOVE(_name, _cmd)                                        \
 312         int __remove_ ## _name(void)                                    \
 313         {                                                               \
 314                 if (0)                                                  \
 315                         _cmd(NULL, 0, 0, NULL);                         \
 316                 return 0;                                               \
 317         }
 318
 319 #define U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep,         \
 320                                      _usage, _help, _comp)              \
 321                 { #_name, _maxargs, 0 ? _cmd_rep : NULL, NULL, _usage,  \
 322                         _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
 323
 324 #define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, _usage,  \
 325                                   _help, _comp)                         \
 326                 { #_name, _maxargs, NULL, 0 ? _cmd : NULL, _usage,      \
 327                         _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
 328
 329 #define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, \
 330                             _comp)                              \
 331         _CMD_REMOVE(sub_ ## _name, _cmd)
 332
 333 #define U_BOOT_CMDREP_COMPLETE(_name, _maxargs, _cmd_rep, _usage,       \
 334                                _help, _comp)                            \
 335         _CMD_REMOVE(sub_ ## _name, _cmd_rep)
 336
 337 #endif /* CONFIG_CMDLINE */
 338
 339 #define U_BOOT_CMD(_name, _maxargs, _rep, _cmd, _usage, _help)          \
 340         U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, NULL)
 341
 342 #define U_BOOT_CMD_MKENT(_name, _maxargs, _rep, _cmd, _usage, _help)    \
 343         U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd,          \
 344                                         _usage, _help, NULL)
 345
 346 #define U_BOOT_SUBCMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd,    \
 347                                      _comp)                             \
 348         U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd,       \
 349                                   "", "", _comp)
 350
 351 #define U_BOOT_SUBCMD_MKENT(_name, _maxargs, _rep, _do_cmd)             \
 352         U_BOOT_SUBCMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd,    \
 353                                      NULL)
 354
 355 #define U_BOOT_CMD_WITH_SUBCMDS(_name, _usage, _help, ...)              \
 356         U_BOOT_SUBCMDS(_name, __VA_ARGS__)                              \
 357         U_BOOT_CMDREP_COMPLETE(_name, CONFIG_SYS_MAXARGS, do_##_name,   \
 358                                _usage, _help, complete_##_name)
 359
 360 #endif  /* __COMMAND_H */