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 32 #ifndef NULL 33 #define NULL 0 34 #endif 35 36 /* Default to a width of 8 characters for help message command width */ 37 #ifndef CONFIG_SYS_HELP_CMD_WIDTH 38 #define CONFIG_SYS_HELP_CMD_WIDTH 8 39 #endif 40 41 #ifndef __ASSEMBLY__ 42 /* 43 * Monitor Command Table 44 */ 45 46 struct cmd_tbl_s { 47 char *name; /* Command Name */ 48 int maxargs; /* maximum number of arguments */ 49 int repeatable; /* autorepeat allowed? */ 50 /* Implementation function */ 51 int (*cmd)(struct cmd_tbl_s *, int, int, char * const []); 52 char *usage; /* Usage message (short) */ 53 #ifdef CONFIG_SYS_LONGHELP 54 char *help; /* Help message (long) */ 55 #endif 56 #ifdef CONFIG_AUTO_COMPLETE 57 /* do auto completion on the arguments */ 58 int (*complete)(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]); 59 #endif 60 }; 61 62 typedef struct cmd_tbl_s cmd_tbl_t; 63 64 extern cmd_tbl_t __u_boot_cmd_start; 65 extern cmd_tbl_t __u_boot_cmd_end; 66 67 68 /* common/command.c */ 69 int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int 70 flag, int argc, char * const argv[]); 71 cmd_tbl_t *find_cmd(const char *cmd); 72 cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len); 73 74 extern int cmd_usage(cmd_tbl_t *cmdtp); 75 76 #ifdef CONFIG_AUTO_COMPLETE 77 extern void install_auto_complete(void); 78 extern int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp); 79 #endif 80 81 /* 82 * Monitor Command 83 * 84 * All commands use a common argument format: 85 * 86 * void function (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); 87 */ 88 89 typedef void command_t (cmd_tbl_t *, int, int, char *[]); 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 #endif /* __ASSEMBLY__ */ 101 102 /* 103 * Command Flags: 104 */ 105 #define CMD_FLAG_REPEAT 0x0001 /* repeat last command */ 106 #define CMD_FLAG_BOOTD 0x0002 /* command is from bootd */ 107 108 #define Struct_Section __attribute__ ((unused,section (".u_boot_cmd"))) 109 110 #ifdef CONFIG_SYS_LONGHELP 111 112 #define U_BOOT_CMD(name,maxargs,rep,cmd,usage,help) \ 113 cmd_tbl_t __u_boot_cmd_##name Struct_Section = {#name, maxargs, rep, cmd, usage, help} 114 115 #define U_BOOT_CMD_MKENT(name,maxargs,rep,cmd,usage,help) \ 116 {#name, maxargs, rep, cmd, usage, help} 117 118 #else /* no long help info */ 119 120 #define U_BOOT_CMD(name,maxargs,rep,cmd,usage,help) \ 121 cmd_tbl_t __u_boot_cmd_##name Struct_Section = {#name, maxargs, rep, cmd, usage} 122 123 #define U_BOOT_CMD_MKENT(name,maxargs,rep,cmd,usage,help) \ 124 {#name, maxargs, rep, cmd, usage} 125 126 #endif /* CONFIG_SYS_LONGHELP */ 127 128 #endif /* __COMMAND_H */ 129