1 /* 2 * (C) Copyright 2000-2009 3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de. 4 * 5 * See file CREDITS for list of people who contributed to this 6 * project. 7 * 8 * This program is free software; you can redistribute it and/or 9 * modify it under the terms of the GNU General Public License as 10 * published by the Free Software Foundation; either version 2 of 11 * the License, or (at your option) any later version. 12 * 13 * This program is distributed in the hope that it will be useful, 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 * GNU General Public License for more details. 17 * 18 * You should have received a copy of the GNU General Public License 19 * along with this program; if not, write to the Free Software 20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, 21 * MA 02111-1307 USA 22 */ 23 24 /* 25 * Definitions for Command Processor 26 */ 27 #ifndef __COMMAND_H 28 #define __COMMAND_H 29 30 #include <config.h> 31 #include <linker_lists.h> 32 33 #ifndef NULL 34 #define NULL 0 35 #endif 36 37 /* Default to a width of 8 characters for help message command width */ 38 #ifndef CONFIG_SYS_HELP_CMD_WIDTH 39 #define CONFIG_SYS_HELP_CMD_WIDTH 8 40 #endif 41 42 #ifndef __ASSEMBLY__ 43 /* 44 * Monitor Command Table 45 */ 46 47 struct cmd_tbl_s { 48 char *name; /* Command Name */ 49 int maxargs; /* maximum number of arguments */ 50 int repeatable; /* autorepeat allowed? */ 51 /* Implementation function */ 52 int (*cmd)(struct cmd_tbl_s *, int, int, char * const []); 53 char *usage; /* Usage message (short) */ 54 #ifdef CONFIG_SYS_LONGHELP 55 char *help; /* Help message (long) */ 56 #endif 57 #ifdef CONFIG_AUTO_COMPLETE 58 /* do auto completion on the arguments */ 59 int (*complete)(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]); 60 #endif 61 }; 62 63 typedef struct cmd_tbl_s cmd_tbl_t; 64 65 66 #if defined(CONFIG_CMD_RUN) 67 extern int do_run(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); 68 #endif 69 70 /* common/command.c */ 71 int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int 72 flag, int argc, char * const argv[]); 73 cmd_tbl_t *find_cmd(const char *cmd); 74 cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len); 75 76 extern int cmd_usage(const cmd_tbl_t *cmdtp); 77 78 #ifdef CONFIG_AUTO_COMPLETE 79 extern int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]); 80 extern int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp); 81 #endif 82 83 /* 84 * Monitor Command 85 * 86 * All commands use a common argument format: 87 * 88 * void function (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); 89 */ 90 91 #if defined(CONFIG_CMD_MEMORY) \ 92 || defined(CONFIG_CMD_I2C) \ 93 || defined(CONFIG_CMD_ITEST) \ 94 || defined(CONFIG_CMD_PCI) \ 95 || defined(CONFIG_CMD_PORTIO) 96 #define CMD_DATA_SIZE 97 extern int cmd_get_data_size(char* arg, int default_size); 98 #endif 99 100 #ifdef CONFIG_CMD_BOOTD 101 extern int do_bootd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); 102 #endif 103 #ifdef CONFIG_CMD_BOOTM 104 extern int do_bootm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); 105 extern int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd); 106 #else 107 static inline int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd) 108 { 109 return 0; 110 } 111 #endif 112 113 extern int common_diskboot(cmd_tbl_t *cmdtp, const char *intf, int argc, 114 char *const argv[]); 115 116 extern int do_reset(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); 117 118 /* 119 * Error codes that commands return to cmd_process(). We use the standard 0 120 * and 1 for success and failure, but add one more case - failure with a 121 * request to call cmd_usage(). But the cmd_process() function handles 122 * CMD_RET_USAGE itself and after calling cmd_usage() it will return 1. 123 * This is just a convenience for commands to avoid them having to call 124 * cmd_usage() all over the place. 125 */ 126 enum command_ret_t { 127 CMD_RET_SUCCESS, /* 0 = Success */ 128 CMD_RET_FAILURE, /* 1 = Failure */ 129 CMD_RET_USAGE = -1, /* Failure, please report 'usage' error */ 130 }; 131 132 /** 133 * Process a command with arguments. We look up the command and execute it 134 * if valid. Otherwise we print a usage message. 135 * 136 * @param flag Some flags normally 0 (see CMD_FLAG_.. above) 137 * @param argc Number of arguments (arg 0 must be the command text) 138 * @param argv Arguments 139 * @param repeatable This function sets this to 0 if the command is not 140 * repeatable. If the command is repeatable, the value 141 * is left unchanged. 142 * @param ticks If ticks is not null, this function set it to the 143 * number of ticks the command took to complete. 144 * @return 0 if the command succeeded, 1 if it failed 145 */ 146 int cmd_process(int flag, int argc, char * const argv[], 147 int *repeatable, unsigned long *ticks); 148 149 #endif /* __ASSEMBLY__ */ 150 151 /* 152 * Command Flags: 153 */ 154 #define CMD_FLAG_REPEAT 0x0001 /* repeat last command */ 155 #define CMD_FLAG_BOOTD 0x0002 /* command is from bootd */ 156 157 #ifdef CONFIG_AUTO_COMPLETE 158 # define _CMD_COMPLETE(x) x, 159 #else 160 # define _CMD_COMPLETE(x) 161 #endif 162 #ifdef CONFIG_SYS_LONGHELP 163 # define _CMD_HELP(x) x, 164 #else 165 # define _CMD_HELP(x) 166 #endif 167 168 #define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \ 169 _usage, _help, _comp) \ 170 { #_name, _maxargs, _rep, _cmd, _usage, \ 171 _CMD_HELP(_help) _CMD_COMPLETE(_comp) } 172 173 #define U_BOOT_CMD_MKENT(_name, _maxargs, _rep, _cmd, _usage, _help) \ 174 U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \ 175 _usage, _help, NULL) 176 177 #define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, _comp) \ 178 ll_entry_declare(cmd_tbl_t, _name, cmd) = \ 179 U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \ 180 _usage, _help, _comp); 181 182 #define U_BOOT_CMD(_name, _maxargs, _rep, _cmd, _usage, _help) \ 183 U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, NULL) 184 185 #if defined(CONFIG_NEEDS_MANUAL_RELOC) 186 void fixup_cmdtable(cmd_tbl_t *cmdtp, int size); 187 #endif 188 189 #endif /* __COMMAND_H */ 190