blob: 3785eb987f4863352d7de87fa3853725ad819b4d [file] [log] [blame]
wdenk78f66222002-08-27 10:27:51 +00001/*
Detlev Zundel2dce5512009-03-25 17:27:52 +01002 * (C) Copyright 2000-2009
wdenk78f66222002-08-27 10:27:51 +00003 * 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 Roesef2302d42008-08-06 14:05:38 +020030#include <config.h>
Marek Vasut6c7c9462012-10-12 10:27:04 +000031#include <linker_lists.h>
Stefan Roesef2302d42008-08-06 14:05:38 +020032
wdenk78f66222002-08-27 10:27:51 +000033#ifndef NULL
34#define NULL 0
35#endif
36
Peter Tyser2fb26042009-01-27 18:03:12 -060037/* 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
wdenk78f66222002-08-27 10:27:51 +000042#ifndef __ASSEMBLY__
43/*
44 * Monitor Command Table
45 */
46
47struct cmd_tbl_s {
48 char *name; /* Command Name */
wdenk78f66222002-08-27 10:27:51 +000049 int maxargs; /* maximum number of arguments */
50 int repeatable; /* autorepeat allowed? */
51 /* Implementation function */
Wolfgang Denk54841ab2010-06-28 22:00:46 +020052 int (*cmd)(struct cmd_tbl_s *, int, int, char * const []);
wdenk78f66222002-08-27 10:27:51 +000053 char *usage; /* Usage message (short) */
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020054#ifdef CONFIG_SYS_LONGHELP
wdenk78f66222002-08-27 10:27:51 +000055 char *help; /* Help message (long) */
56#endif
wdenk04a85b32004-04-15 18:22:41 +000057#ifdef CONFIG_AUTO_COMPLETE
58 /* do auto completion on the arguments */
Wolfgang Denk54841ab2010-06-28 22:00:46 +020059 int (*complete)(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
wdenk04a85b32004-04-15 18:22:41 +000060#endif
wdenk78f66222002-08-27 10:27:51 +000061};
62
63typedef struct cmd_tbl_s cmd_tbl_t;
64
wdenk78f66222002-08-27 10:27:51 +000065
Igor Grinbergd09b1782011-11-07 01:13:59 +000066#if defined(CONFIG_CMD_RUN)
67extern int do_run(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
68#endif
wdenk78f66222002-08-27 10:27:51 +000069
70/* common/command.c */
Detlev Zundel2dce5512009-03-25 17:27:52 +010071int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int
Wolfgang Denk54841ab2010-06-28 22:00:46 +020072 flag, int argc, char * const argv[]);
wdenk78f66222002-08-27 10:27:51 +000073cmd_tbl_t *find_cmd(const char *cmd);
Kumar Galab799cb42008-09-23 10:05:02 -050074cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len);
wdenk78f66222002-08-27 10:27:51 +000075
Mike Frysingere84ffdd2011-04-23 23:43:24 +000076extern int cmd_usage(const cmd_tbl_t *cmdtp);
Peter Tyser62c3ae72009-01-27 18:03:10 -060077
wdenk04a85b32004-04-15 18:22:41 +000078#ifdef CONFIG_AUTO_COMPLETE
Mike Frysinger722b0612010-10-20 03:52:39 -040079extern int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
wdenk04a85b32004-04-15 18:22:41 +000080extern int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp);
81#endif
82
wdenk78f66222002-08-27 10:27:51 +000083/*
84 * Monitor Command
85 *
86 * All commands use a common argument format:
87 *
Wolfgang Denk54841ab2010-06-28 22:00:46 +020088 * void function (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
wdenk78f66222002-08-27 10:27:51 +000089 */
90
Jean-Christophe PLAGNIOL-VILLARD8a40fb12008-09-10 22:48:05 +020091#if defined(CONFIG_CMD_MEMORY) \
Vadim Bendebury9ad557b2012-12-05 14:46:42 +000092 || defined(CONFIG_CMD_I2C) \
93 || defined(CONFIG_CMD_ITEST) \
94 || defined(CONFIG_CMD_PCI) \
95 || defined(CONFIG_CMD_PORTIO)
Jean-Christophe PLAGNIOL-VILLARD8a40fb12008-09-10 22:48:05 +020096#define CMD_DATA_SIZE
97extern int cmd_get_data_size(char* arg, int default_size);
98#endif
99
Mike Frysinger7842fb72010-10-20 03:36:26 -0400100#ifdef CONFIG_CMD_BOOTD
101extern int do_bootd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
102#endif
Mike Frysinger67d668b2011-06-05 13:43:02 +0000103#ifdef CONFIG_CMD_BOOTM
Mike Frysinger36ebb782010-10-20 03:35:39 -0400104extern int do_bootm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
Mike Frysinger67d668b2011-06-05 13:43:02 +0000105extern int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd);
106#else
107static inline int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd)
108{
109 return 0;
110}
111#endif
Rob Herring7405a132012-09-21 04:02:30 +0000112
113extern int common_diskboot(cmd_tbl_t *cmdtp, const char *intf, int argc,
114 char *const argv[]);
115
Mike Frysinger882b7d72010-10-20 03:41:17 -0400116extern int do_reset(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
Mike Frysinger36ebb782010-10-20 03:35:39 -0400117
Simon Glass9d12d5d2012-02-14 19:59:25 +0000118/*
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 */
126enum 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.
Richard Genoud34765e82012-12-03 06:28:28 +0000142 * @param ticks If ticks is not null, this function set it to the
143 * number of ticks the command took to complete.
Simon Glass9d12d5d2012-02-14 19:59:25 +0000144 * @return 0 if the command succeeded, 1 if it failed
145 */
146int cmd_process(int flag, int argc, char * const argv[],
Richard Genoud34765e82012-12-03 06:28:28 +0000147 int *repeatable, unsigned long *ticks);
Simon Glassbdf8e342012-02-14 19:59:23 +0000148
wdenk78f66222002-08-27 10:27:51 +0000149#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
Mike Frysinger722b0612010-10-20 03:52:39 -0400157#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
wdenk8bde7f72003-06-27 21:31:46 +0000167
Marek Vasut6c7c9462012-10-12 10:27:04 +0000168#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) }
wdenk8bde7f72003-06-27 21:31:46 +0000172
Marek Vasut6c7c9462012-10-12 10:27:04 +0000173#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)
Kumar Galab799cb42008-09-23 10:05:02 -0500176
Marek Vasut6c7c9462012-10-12 10:27:04 +0000177#define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, _comp) \
178 ll_entry_declare(cmd_tbl_t, _name, cmd, cmd) = \
179 U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
180 _usage, _help, _comp);
wdenk8bde7f72003-06-27 21:31:46 +0000181
Marek Vasut6c7c9462012-10-12 10:27:04 +0000182#define U_BOOT_CMD(_name, _maxargs, _rep, _cmd, _usage, _help) \
183 U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, NULL)
wdenk8bde7f72003-06-27 21:31:46 +0000184
Wolfgang Denk2e5167c2010-10-28 20:00:11 +0200185#if defined(CONFIG_NEEDS_MANUAL_RELOC)
Heiko Schocher620f1f62010-09-17 13:10:33 +0200186void fixup_cmdtable(cmd_tbl_t *cmdtp, int size);
187#endif
Simon Glassbdf8e342012-02-14 19:59:23 +0000188
wdenk78f66222002-08-27 10:27:51 +0000189#endif /* __COMMAND_H */