include/command.h

   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 #if defined(CONFIG_CMD_RUN)
  68 extern int do_run(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
  69 #endif
  70
  71 /* common/command.c */
  72 int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int
  73               flag, int argc, char * const argv[]);
  74 cmd_tbl_t *find_cmd(const char *cmd);
  75 cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len);
  76
  77 extern int cmd_usage(const cmd_tbl_t *cmdtp);
  78
  79 #ifdef CONFIG_AUTO_COMPLETE
  80 extern int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
  81 extern int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp);
  82 #endif
  83
  84 /*
  85  * Monitor Command
  86  *
  87  * All commands use a common argument format:
  88  *
  89  * void function (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
  90  */
  91
  92 #if defined(CONFIG_CMD_MEMORY)          \
  93     || defined(CONFIG_CMD_I2C)          \
  94     || defined(CONFIG_CMD_ITEST)        \
  95     || defined(CONFIG_CMD_PCI)          \
  96     || defined(CONFIG_CMD_PORTIO)
  97 #define CMD_DATA_SIZE
  98 extern int cmd_get_data_size(char* arg, int default_size);
  99 #endif
 100
 101 #ifdef CONFIG_CMD_BOOTD
 102 extern int do_bootd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 103 #endif
 104 #ifdef CONFIG_CMD_BOOTM
 105 extern int do_bootm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 106 extern int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd);
 107 #else
 108 static inline int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd)
 109 {
 110         return 0;
 111 }
 112 #endif
 113 extern int do_reset(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 114
 115 /*
 116  * Error codes that commands return to cmd_process(). We use the standard 0
 117  * and 1 for success and failure, but add one more case - failure with a
 118  * request to call cmd_usage(). But the cmd_process() function handles
 119  * CMD_RET_USAGE itself and after calling cmd_usage() it will return 1.
 120  * This is just a convenience for commands to avoid them having to call
 121  * cmd_usage() all over the place.
 122  */
 123 enum command_ret_t {
 124         CMD_RET_SUCCESS,        /* 0 = Success */
 125         CMD_RET_FAILURE,        /* 1 = Failure */
 126         CMD_RET_USAGE = -1,     /* Failure, please report 'usage' error */
 127 };
 128
 129 /**
 130  * Process a command with arguments. We look up the command and execute it
 131  * if valid. Otherwise we print a usage message.
 132  *
 133  * @param flag          Some flags normally 0 (see CMD_FLAG_.. above)
 134  * @param argc          Number of arguments (arg 0 must be the command text)
 135  * @param argv          Arguments
 136  * @param repeatable    This function sets this to 0 if the command is not
 137  *                      repeatable. If the command is repeatable, the value
 138  *                      is left unchanged.
 139  * @return 0 if the command succeeded, 1 if it failed
 140  */
 141 int cmd_process(int flag, int argc, char * const argv[],
 142                                int *repeatable);
 143
 144 #endif  /* __ASSEMBLY__ */
 145
 146 /*
 147  * Command Flags:
 148  */
 149 #define CMD_FLAG_REPEAT         0x0001  /* repeat last command          */
 150 #define CMD_FLAG_BOOTD          0x0002  /* command is from bootd        */
 151
 152 #define Struct_Section  __attribute__((unused, section(".u_boot_cmd"), \
 153                 aligned(4)))
 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,usage,help,comp) \
 167         {#name, maxargs, rep, cmd, usage, _CMD_HELP(help) _CMD_COMPLETE(comp)}
 168
 169 #define U_BOOT_CMD_MKENT(name,maxargs,rep,cmd,usage,help) \
 170         U_BOOT_CMD_MKENT_COMPLETE(name,maxargs,rep,cmd,usage,help,NULL)
 171
 172 #define U_BOOT_CMD_COMPLETE(name,maxargs,rep,cmd,usage,help,comp) \
 173         cmd_tbl_t __u_boot_cmd_##name Struct_Section = \
 174                 U_BOOT_CMD_MKENT_COMPLETE(name,maxargs,rep,cmd,usage,help,comp)
 175
 176 #define U_BOOT_CMD(name,maxargs,rep,cmd,usage,help) \
 177         U_BOOT_CMD_COMPLETE(name,maxargs,rep,cmd,usage,help,NULL)
 178
 179 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
 180 void fixup_cmdtable(cmd_tbl_t *cmdtp, int size);
 181 #endif
 182
 183 #endif  /* __COMMAND_H */