wdenk | 78f6622 | 2002-08-27 10:27:51 +0000 | [diff] [blame] | 1 | /* |
Detlev Zundel | 2dce551 | 2009-03-25 17:27:52 +0100 | [diff] [blame] | 2 | * (C) Copyright 2000-2009 |
wdenk | 78f6622 | 2002-08-27 10:27:51 +0000 | [diff] [blame] | 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 | |
Stefan Roese | f2302d4 | 2008-08-06 14:05:38 +0200 | [diff] [blame] | 30 | #include <config.h> |
| 31 | |
wdenk | 78f6622 | 2002-08-27 10:27:51 +0000 | [diff] [blame] | 32 | #ifndef NULL |
| 33 | #define NULL 0 |
| 34 | #endif |
| 35 | |
Peter Tyser | 2fb2604 | 2009-01-27 18:03:12 -0600 | [diff] [blame] | 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 | |
wdenk | 78f6622 | 2002-08-27 10:27:51 +0000 | [diff] [blame] | 41 | #ifndef __ASSEMBLY__ |
| 42 | /* |
| 43 | * Monitor Command Table |
| 44 | */ |
| 45 | |
| 46 | struct cmd_tbl_s { |
| 47 | char *name; /* Command Name */ |
wdenk | 78f6622 | 2002-08-27 10:27:51 +0000 | [diff] [blame] | 48 | int maxargs; /* maximum number of arguments */ |
| 49 | int repeatable; /* autorepeat allowed? */ |
| 50 | /* Implementation function */ |
Wolfgang Denk | 54841ab | 2010-06-28 22:00:46 +0200 | [diff] [blame] | 51 | int (*cmd)(struct cmd_tbl_s *, int, int, char * const []); |
wdenk | 78f6622 | 2002-08-27 10:27:51 +0000 | [diff] [blame] | 52 | char *usage; /* Usage message (short) */ |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 53 | #ifdef CONFIG_SYS_LONGHELP |
wdenk | 78f6622 | 2002-08-27 10:27:51 +0000 | [diff] [blame] | 54 | char *help; /* Help message (long) */ |
| 55 | #endif |
wdenk | 04a85b3 | 2004-04-15 18:22:41 +0000 | [diff] [blame] | 56 | #ifdef CONFIG_AUTO_COMPLETE |
| 57 | /* do auto completion on the arguments */ |
Wolfgang Denk | 54841ab | 2010-06-28 22:00:46 +0200 | [diff] [blame] | 58 | int (*complete)(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]); |
wdenk | 04a85b3 | 2004-04-15 18:22:41 +0000 | [diff] [blame] | 59 | #endif |
wdenk | 78f6622 | 2002-08-27 10:27:51 +0000 | [diff] [blame] | 60 | }; |
| 61 | |
| 62 | typedef struct cmd_tbl_s cmd_tbl_t; |
| 63 | |
wdenk | 8bde7f7 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 64 | extern cmd_tbl_t __u_boot_cmd_start; |
| 65 | extern cmd_tbl_t __u_boot_cmd_end; |
wdenk | 78f6622 | 2002-08-27 10:27:51 +0000 | [diff] [blame] | 66 | |
wdenk | 78f6622 | 2002-08-27 10:27:51 +0000 | [diff] [blame] | 67 | |
| 68 | /* common/command.c */ |
Detlev Zundel | 2dce551 | 2009-03-25 17:27:52 +0100 | [diff] [blame] | 69 | int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int |
Wolfgang Denk | 54841ab | 2010-06-28 22:00:46 +0200 | [diff] [blame] | 70 | flag, int argc, char * const argv[]); |
wdenk | 78f6622 | 2002-08-27 10:27:51 +0000 | [diff] [blame] | 71 | cmd_tbl_t *find_cmd(const char *cmd); |
Kumar Gala | b799cb4 | 2008-09-23 10:05:02 -0500 | [diff] [blame] | 72 | cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len); |
wdenk | 78f6622 | 2002-08-27 10:27:51 +0000 | [diff] [blame] | 73 | |
Mike Frysinger | e84ffdd | 2011-04-23 23:43:24 +0000 | [diff] [blame^] | 74 | extern int cmd_usage(const cmd_tbl_t *cmdtp); |
Peter Tyser | 62c3ae7 | 2009-01-27 18:03:10 -0600 | [diff] [blame] | 75 | |
wdenk | 04a85b3 | 2004-04-15 18:22:41 +0000 | [diff] [blame] | 76 | #ifdef CONFIG_AUTO_COMPLETE |
Mike Frysinger | 722b061 | 2010-10-20 03:52:39 -0400 | [diff] [blame] | 77 | extern int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]); |
wdenk | 04a85b3 | 2004-04-15 18:22:41 +0000 | [diff] [blame] | 78 | extern int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp); |
| 79 | #endif |
| 80 | |
wdenk | 78f6622 | 2002-08-27 10:27:51 +0000 | [diff] [blame] | 81 | /* |
| 82 | * Monitor Command |
| 83 | * |
| 84 | * All commands use a common argument format: |
| 85 | * |
Wolfgang Denk | 54841ab | 2010-06-28 22:00:46 +0200 | [diff] [blame] | 86 | * void function (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); |
wdenk | 78f6622 | 2002-08-27 10:27:51 +0000 | [diff] [blame] | 87 | */ |
| 88 | |
Jean-Christophe PLAGNIOL-VILLARD | 8a40fb1 | 2008-09-10 22:48:05 +0200 | [diff] [blame] | 89 | #if defined(CONFIG_CMD_MEMORY) \ |
| 90 | || defined(CONFIG_CMD_I2C) \ |
| 91 | || defined(CONFIG_CMD_ITEST) \ |
| 92 | || defined(CONFIG_CMD_PCI) \ |
| 93 | || defined(CONFIG_CMD_PORTIO) |
| 94 | #define CMD_DATA_SIZE |
| 95 | extern int cmd_get_data_size(char* arg, int default_size); |
| 96 | #endif |
| 97 | |
Mike Frysinger | 7842fb7 | 2010-10-20 03:36:26 -0400 | [diff] [blame] | 98 | #ifdef CONFIG_CMD_BOOTD |
| 99 | extern int do_bootd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); |
| 100 | #endif |
Mike Frysinger | 67d668b | 2011-06-05 13:43:02 +0000 | [diff] [blame] | 101 | #ifdef CONFIG_CMD_BOOTM |
Mike Frysinger | 36ebb78 | 2010-10-20 03:35:39 -0400 | [diff] [blame] | 102 | extern int do_bootm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); |
Mike Frysinger | 67d668b | 2011-06-05 13:43:02 +0000 | [diff] [blame] | 103 | extern int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd); |
| 104 | #else |
| 105 | static inline int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd) |
| 106 | { |
| 107 | return 0; |
| 108 | } |
| 109 | #endif |
Mike Frysinger | 882b7d7 | 2010-10-20 03:41:17 -0400 | [diff] [blame] | 110 | extern int do_reset(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); |
Mike Frysinger | 36ebb78 | 2010-10-20 03:35:39 -0400 | [diff] [blame] | 111 | |
wdenk | 78f6622 | 2002-08-27 10:27:51 +0000 | [diff] [blame] | 112 | #endif /* __ASSEMBLY__ */ |
| 113 | |
| 114 | /* |
| 115 | * Command Flags: |
| 116 | */ |
| 117 | #define CMD_FLAG_REPEAT 0x0001 /* repeat last command */ |
| 118 | #define CMD_FLAG_BOOTD 0x0002 /* command is from bootd */ |
| 119 | |
wdenk | 8bde7f7 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 120 | #define Struct_Section __attribute__ ((unused,section (".u_boot_cmd"))) |
wdenk | 8bde7f7 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 121 | |
Mike Frysinger | 722b061 | 2010-10-20 03:52:39 -0400 | [diff] [blame] | 122 | #ifdef CONFIG_AUTO_COMPLETE |
| 123 | # define _CMD_COMPLETE(x) x, |
| 124 | #else |
| 125 | # define _CMD_COMPLETE(x) |
| 126 | #endif |
| 127 | #ifdef CONFIG_SYS_LONGHELP |
| 128 | # define _CMD_HELP(x) x, |
| 129 | #else |
| 130 | # define _CMD_HELP(x) |
| 131 | #endif |
wdenk | 8bde7f7 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 132 | |
Mike Frysinger | 722b061 | 2010-10-20 03:52:39 -0400 | [diff] [blame] | 133 | #define U_BOOT_CMD_MKENT_COMPLETE(name,maxargs,rep,cmd,usage,help,comp) \ |
| 134 | {#name, maxargs, rep, cmd, usage, _CMD_HELP(help) _CMD_COMPLETE(comp)} |
wdenk | 8bde7f7 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 135 | |
Kumar Gala | b799cb4 | 2008-09-23 10:05:02 -0500 | [diff] [blame] | 136 | #define U_BOOT_CMD_MKENT(name,maxargs,rep,cmd,usage,help) \ |
Mike Frysinger | 722b061 | 2010-10-20 03:52:39 -0400 | [diff] [blame] | 137 | U_BOOT_CMD_MKENT_COMPLETE(name,maxargs,rep,cmd,usage,help,NULL) |
Kumar Gala | b799cb4 | 2008-09-23 10:05:02 -0500 | [diff] [blame] | 138 | |
Mike Frysinger | 722b061 | 2010-10-20 03:52:39 -0400 | [diff] [blame] | 139 | #define U_BOOT_CMD_COMPLETE(name,maxargs,rep,cmd,usage,help,comp) \ |
| 140 | cmd_tbl_t __u_boot_cmd_##name Struct_Section = \ |
| 141 | U_BOOT_CMD_MKENT_COMPLETE(name,maxargs,rep,cmd,usage,help,comp) |
wdenk | 8bde7f7 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 142 | |
wdenk | 0d49839 | 2003-07-01 21:06:45 +0000 | [diff] [blame] | 143 | #define U_BOOT_CMD(name,maxargs,rep,cmd,usage,help) \ |
Mike Frysinger | 722b061 | 2010-10-20 03:52:39 -0400 | [diff] [blame] | 144 | U_BOOT_CMD_COMPLETE(name,maxargs,rep,cmd,usage,help,NULL) |
wdenk | 8bde7f7 | 2003-06-27 21:31:46 +0000 | [diff] [blame] | 145 | |
Wolfgang Denk | 2e5167c | 2010-10-28 20:00:11 +0200 | [diff] [blame] | 146 | #if defined(CONFIG_NEEDS_MANUAL_RELOC) |
Heiko Schocher | 620f1f6 | 2010-09-17 13:10:33 +0200 | [diff] [blame] | 147 | void fixup_cmdtable(cmd_tbl_t *cmdtp, int size); |
| 148 | #endif |
wdenk | 78f6622 | 2002-08-27 10:27:51 +0000 | [diff] [blame] | 149 | #endif /* __COMMAND_H */ |