1 /* 2 * (C) Copyright 2000 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 #ifndef __ASSEMBLY__ 37 /* 38 * Monitor Command Table 39 */ 40 41 struct cmd_tbl_s { 42 char *name; /* Command Name */ 43 int maxargs; /* maximum number of arguments */ 44 int repeatable; /* autorepeat allowed? */ 45 /* Implementation function */ 46 int (*cmd)(struct cmd_tbl_s *, int, int, char *[]); 47 char *usage; /* Usage message (short) */ 48 #ifdef CONFIG_SYS_LONGHELP 49 char *help; /* Help message (long) */ 50 #endif 51 #ifdef CONFIG_AUTO_COMPLETE 52 /* do auto completion on the arguments */ 53 int (*complete)(int argc, char *argv[], char last_char, int maxv, char *cmdv[]); 54 #endif 55 }; 56 57 typedef struct cmd_tbl_s cmd_tbl_t; 58 59 extern cmd_tbl_t __u_boot_cmd_start; 60 extern cmd_tbl_t __u_boot_cmd_end; 61 62 63 /* common/command.c */ 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 67 #ifdef CONFIG_AUTO_COMPLETE 68 extern void install_auto_complete(void); 69 extern int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp); 70 #endif 71 72 /* 73 * Monitor Command 74 * 75 * All commands use a common argument format: 76 * 77 * void function (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[]); 78 */ 79 80 typedef void command_t (cmd_tbl_t *, int, int, char *[]); 81 82 #if defined(CONFIG_CMD_MEMORY) \ 83 || defined(CONFIG_CMD_I2C) \ 84 || defined(CONFIG_CMD_ITEST) \ 85 || defined(CONFIG_CMD_PCI) \ 86 || defined(CONFIG_CMD_PORTIO) 87 #define CMD_DATA_SIZE 88 extern int cmd_get_data_size(char* arg, int default_size); 89 #endif 90 91 #endif /* __ASSEMBLY__ */ 92 93 /* 94 * Command Flags: 95 */ 96 #define CMD_FLAG_REPEAT 0x0001 /* repeat last command */ 97 #define CMD_FLAG_BOOTD 0x0002 /* command is from bootd */ 98 99 #define Struct_Section __attribute__ ((unused,section (".u_boot_cmd"))) 100 101 #ifdef CONFIG_SYS_LONGHELP 102 103 #define U_BOOT_CMD(name,maxargs,rep,cmd,usage,help) \ 104 cmd_tbl_t __u_boot_cmd_##name Struct_Section = {#name, maxargs, rep, cmd, usage, help} 105 106 #define U_BOOT_CMD_MKENT(name,maxargs,rep,cmd,usage,help) \ 107 {#name, maxargs, rep, cmd, usage, help} 108 109 #else /* no long help info */ 110 111 #define U_BOOT_CMD(name,maxargs,rep,cmd,usage,help) \ 112 cmd_tbl_t __u_boot_cmd_##name Struct_Section = {#name, maxargs, rep, cmd, usage} 113 114 #define U_BOOT_CMD_MKENT(name,maxargs,rep,cmd,usage,help) \ 115 {#name, maxargs, rep, cmd, usage} 116 117 #endif /* CONFIG_SYS_LONGHELP */ 118 119 #endif /* __COMMAND_H */ 120