1 /* 2 * (C) Copyright 2000-2009 3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de. 4 * 5 * SPDX-License-Identifier: GPL-2.0+ 6 */ 7 8 /* 9 * Definitions for Command Processor 10 */ 11 #ifndef __COMMAND_H 12 #define __COMMAND_H 13 14 #include <linker_lists.h> 15 16 #ifndef NULL 17 #define NULL 0 18 #endif 19 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 23 #endif 24 25 #ifndef __ASSEMBLY__ 26 /* 27 * Monitor Command Table 28 */ 29 30 struct cmd_tbl_s { 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) */ 39 #endif 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[]); 43 #endif 44 }; 45 46 typedef struct cmd_tbl_s cmd_tbl_t; 47 48 49 #if defined(CONFIG_CMD_RUN) 50 extern int do_run(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); 51 #endif 52 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); 58 59 extern int cmd_usage(const cmd_tbl_t *cmdtp); 60 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); 64 #endif 65 66 /** 67 * cmd_process_error() - report and process a possible error 68 * 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 72 */ 73 int cmd_process_error(cmd_tbl_t *cmdtp, int err); 74 75 /* 76 * Monitor Command 77 * 78 * All commands use a common argument format: 79 * 80 * void function (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); 81 */ 82 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) 88 #define CMD_DATA_SIZE 89 extern int cmd_get_data_size(char* arg, int default_size); 90 #endif 91 92 #ifdef CONFIG_CMD_BOOTD 93 extern int do_bootd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); 94 #endif 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); 98 #else 99 static inline int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd) 100 { 101 return 0; 102 } 103 #endif 104 105 extern int do_bootz(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); 106 107 extern int do_booti(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); 108 109 extern int common_diskboot(cmd_tbl_t *cmdtp, const char *intf, int argc, 110 char *const argv[]); 111 112 extern int do_reset(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); 113 114 /* 115 * Error codes that commands return to cmd_process(). We use the standard 0 116 * and 1 for success and failure, but add one more case - failure with a 117 * request to call cmd_usage(). But the cmd_process() function handles 118 * CMD_RET_USAGE itself and after calling cmd_usage() it will return 1. 119 * This is just a convenience for commands to avoid them having to call 120 * cmd_usage() all over the place. 121 */ 122 enum command_ret_t { 123 CMD_RET_SUCCESS, /* 0 = Success */ 124 CMD_RET_FAILURE, /* 1 = Failure */ 125 CMD_RET_USAGE = -1, /* Failure, please report 'usage' error */ 126 }; 127 128 /** 129 * Process a command with arguments. We look up the command and execute it 130 * if valid. Otherwise we print a usage message. 131 * 132 * @param flag Some flags normally 0 (see CMD_FLAG_.. above) 133 * @param argc Number of arguments (arg 0 must be the command text) 134 * @param argv Arguments 135 * @param repeatable This function sets this to 0 if the command is not 136 * repeatable. If the command is repeatable, the value 137 * is left unchanged. 138 * @param ticks If ticks is not null, this function set it to the 139 * number of ticks the command took to complete. 140 * @return 0 if the command succeeded, 1 if it failed 141 */ 142 int cmd_process(int flag, int argc, char * const argv[], 143 int *repeatable, unsigned long *ticks); 144 145 void fixup_cmdtable(cmd_tbl_t *cmdtp, int size); 146 #endif /* __ASSEMBLY__ */ 147 148 /* 149 * Command Flags: 150 */ 151 #define CMD_FLAG_REPEAT 0x0001 /* repeat last command */ 152 #define CMD_FLAG_BOOTD 0x0002 /* command is from bootd */ 153 #define CMD_FLAG_ENV 0x0004 /* command is from the environment */ 154 155 #ifdef CONFIG_AUTO_COMPLETE 156 # define _CMD_COMPLETE(x) x, 157 #else 158 # define _CMD_COMPLETE(x) 159 #endif 160 #ifdef CONFIG_SYS_LONGHELP 161 # define _CMD_HELP(x) x, 162 #else 163 # define _CMD_HELP(x) 164 #endif 165 166 #define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \ 167 _usage, _help, _comp) \ 168 { #_name, _maxargs, _rep, _cmd, _usage, \ 169 _CMD_HELP(_help) _CMD_COMPLETE(_comp) } 170 171 #define U_BOOT_CMD_MKENT(_name, _maxargs, _rep, _cmd, _usage, _help) \ 172 U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \ 173 _usage, _help, NULL) 174 175 #define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, _comp) \ 176 ll_entry_declare(cmd_tbl_t, _name, cmd) = \ 177 U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \ 178 _usage, _help, _comp); 179 180 #define U_BOOT_CMD(_name, _maxargs, _rep, _cmd, _usage, _help) \ 181 U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, NULL) 182 183 #endif /* __COMMAND_H */ 184