blob: 08f04867ddf6846fe3354b6cbb2503c41b076fa3 [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 *
Wolfgang Denk1a459662013-07-08 09:37:19 +02005 * SPDX-License-Identifier: GPL-2.0+
wdenk78f66222002-08-27 10:27:51 +00006 */
7
8/*
9 * Definitions for Command Processor
10 */
11#ifndef __COMMAND_H
12#define __COMMAND_H
13
Marek Vasut6c7c9462012-10-12 10:27:04 +000014#include <linker_lists.h>
Stefan Roesef2302d42008-08-06 14:05:38 +020015
wdenk78f66222002-08-27 10:27:51 +000016#ifndef NULL
17#define NULL 0
18#endif
19
Peter Tyser2fb26042009-01-27 18:03:12 -060020/* Default to a width of 8 characters for help message command width */
21#ifndef CONFIG_SYS_HELP_CMD_WIDTH
22#define CONFIG_SYS_HELP_CMD_WIDTH 8
23#endif
24
wdenk78f66222002-08-27 10:27:51 +000025#ifndef __ASSEMBLY__
26/*
27 * Monitor Command Table
28 */
29
30struct cmd_tbl_s {
31 char *name; /* Command Name */
wdenk78f66222002-08-27 10:27:51 +000032 int maxargs; /* maximum number of arguments */
33 int repeatable; /* autorepeat allowed? */
34 /* Implementation function */
Wolfgang Denk54841ab2010-06-28 22:00:46 +020035 int (*cmd)(struct cmd_tbl_s *, int, int, char * const []);
wdenk78f66222002-08-27 10:27:51 +000036 char *usage; /* Usage message (short) */
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020037#ifdef CONFIG_SYS_LONGHELP
wdenk78f66222002-08-27 10:27:51 +000038 char *help; /* Help message (long) */
39#endif
wdenk04a85b32004-04-15 18:22:41 +000040#ifdef CONFIG_AUTO_COMPLETE
41 /* do auto completion on the arguments */
Wolfgang Denk54841ab2010-06-28 22:00:46 +020042 int (*complete)(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
wdenk04a85b32004-04-15 18:22:41 +000043#endif
wdenk78f66222002-08-27 10:27:51 +000044};
45
46typedef struct cmd_tbl_s cmd_tbl_t;
47
wdenk78f66222002-08-27 10:27:51 +000048
Igor Grinbergd09b1782011-11-07 01:13:59 +000049#if defined(CONFIG_CMD_RUN)
50extern int do_run(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
51#endif
wdenk78f66222002-08-27 10:27:51 +000052
53/* common/command.c */
Detlev Zundel2dce5512009-03-25 17:27:52 +010054int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int
Wolfgang Denk54841ab2010-06-28 22:00:46 +020055 flag, int argc, char * const argv[]);
wdenk78f66222002-08-27 10:27:51 +000056cmd_tbl_t *find_cmd(const char *cmd);
Kumar Galab799cb42008-09-23 10:05:02 -050057cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len);
wdenk78f66222002-08-27 10:27:51 +000058
Mike Frysingere84ffdd2011-04-23 23:43:24 +000059extern int cmd_usage(const cmd_tbl_t *cmdtp);
Peter Tyser62c3ae72009-01-27 18:03:10 -060060
wdenk04a85b32004-04-15 18:22:41 +000061#ifdef CONFIG_AUTO_COMPLETE
Mike Frysinger722b0612010-10-20 03:52:39 -040062extern int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
wdenk04a85b32004-04-15 18:22:41 +000063extern int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp);
64#endif
65
Simon Glass16ff9902014-02-26 15:59:15 -070066/**
67 * cmd_process_error() - report and process a possible error
68 *
69 * @cmdtp: Command which caused the error
70 * @err: Error code (0 if none, -ve for error, like -EIO)
71 * @return 0 if there is not error, 1 (CMD_RET_FAILURE) if an error is found
72 */
73int cmd_process_error(cmd_tbl_t *cmdtp, int err);
74
wdenk78f66222002-08-27 10:27:51 +000075/*
76 * Monitor Command
77 *
78 * All commands use a common argument format:
79 *
Wolfgang Denk54841ab2010-06-28 22:00:46 +020080 * void function (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
wdenk78f66222002-08-27 10:27:51 +000081 */
82
Jean-Christophe PLAGNIOL-VILLARD8a40fb12008-09-10 22:48:05 +020083#if defined(CONFIG_CMD_MEMORY) \
Vadim Bendebury9ad557b2012-12-05 14:46:42 +000084 || defined(CONFIG_CMD_I2C) \
85 || defined(CONFIG_CMD_ITEST) \
86 || defined(CONFIG_CMD_PCI) \
87 || defined(CONFIG_CMD_PORTIO)
Jean-Christophe PLAGNIOL-VILLARD8a40fb12008-09-10 22:48:05 +020088#define CMD_DATA_SIZE
89extern int cmd_get_data_size(char* arg, int default_size);
90#endif
91
Mike Frysinger7842fb72010-10-20 03:36:26 -040092#ifdef CONFIG_CMD_BOOTD
93extern int do_bootd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
94#endif
Mike Frysinger67d668b2011-06-05 13:43:02 +000095#ifdef CONFIG_CMD_BOOTM
Mike Frysinger36ebb782010-10-20 03:35:39 -040096extern int do_bootm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
Mike Frysinger67d668b2011-06-05 13:43:02 +000097extern int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd);
98#else
99static inline int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd)
100{
101 return 0;
102}
103#endif
Rob Herring7405a132012-09-21 04:02:30 +0000104
Rob Herringda620222012-12-02 21:00:23 -0600105extern int do_bootz(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
106
Stephen Warren8b5c7382015-07-21 17:49:41 -0600107extern int do_booti(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
108
Rob Herring7405a132012-09-21 04:02:30 +0000109extern int common_diskboot(cmd_tbl_t *cmdtp, const char *intf, int argc,
110 char *const argv[]);
111
Mike Frysinger882b7d72010-10-20 03:41:17 -0400112extern int do_reset(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
Michael van Slingerland4e42e292016-01-13 19:31:17 +0100113extern int do_poweroff(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
Mike Frysinger36ebb782010-10-20 03:35:39 -0400114
Simon Glass9d12d5d2012-02-14 19:59:25 +0000115/*
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 */
123enum 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.
Richard Genoud34765e82012-12-03 06:28:28 +0000139 * @param ticks If ticks is not null, this function set it to the
140 * number of ticks the command took to complete.
Simon Glass9d12d5d2012-02-14 19:59:25 +0000141 * @return 0 if the command succeeded, 1 if it failed
142 */
143int cmd_process(int flag, int argc, char * const argv[],
Richard Genoud34765e82012-12-03 06:28:28 +0000144 int *repeatable, unsigned long *ticks);
Simon Glassbdf8e342012-02-14 19:59:23 +0000145
Tom Rinicbb2df22015-12-07 08:23:29 -0500146void fixup_cmdtable(cmd_tbl_t *cmdtp, int size);
Simon Glassf8bb6962016-03-19 02:18:38 -0600147
148/**
149 * board_run_command() - Fallback function to execute a command
150 *
151 * When no command line features are enabled in U-Boot, this function is
152 * called to execute a command. Typically the function can look at the
153 * command and perform a few very specific tasks, such as booting the
154 * system in a particular way.
155 *
156 * This function is only used when CONFIG_CMDLINE is not enabled.
157 *
158 * In normal situations this function should not return, since U-Boot will
159 * simply hang.
160 *
161 * @cmdline: Command line string to execute
162 * @return 0 if OK, 1 for error
163 */
164int board_run_command(const char *cmdline);
wdenk78f66222002-08-27 10:27:51 +0000165#endif /* __ASSEMBLY__ */
166
167/*
168 * Command Flags:
169 */
170#define CMD_FLAG_REPEAT 0x0001 /* repeat last command */
171#define CMD_FLAG_BOOTD 0x0002 /* command is from bootd */
Simon Glass87b63982014-10-07 13:59:43 -0600172#define CMD_FLAG_ENV 0x0004 /* command is from the environment */
wdenk78f66222002-08-27 10:27:51 +0000173
Mike Frysinger722b0612010-10-20 03:52:39 -0400174#ifdef CONFIG_AUTO_COMPLETE
175# define _CMD_COMPLETE(x) x,
176#else
177# define _CMD_COMPLETE(x)
178#endif
179#ifdef CONFIG_SYS_LONGHELP
180# define _CMD_HELP(x) x,
181#else
182# define _CMD_HELP(x)
183#endif
wdenk8bde7f72003-06-27 21:31:46 +0000184
Simon Glassfb241122016-03-13 19:07:33 -0600185#ifdef CONFIG_CMDLINE
Marek Vasut6c7c9462012-10-12 10:27:04 +0000186#define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
187 _usage, _help, _comp) \
188 { #_name, _maxargs, _rep, _cmd, _usage, \
189 _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
wdenk8bde7f72003-06-27 21:31:46 +0000190
Marek Vasut6c7c9462012-10-12 10:27:04 +0000191#define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, _comp) \
Albert ARIBAUDef123c52013-02-25 00:59:00 +0000192 ll_entry_declare(cmd_tbl_t, _name, cmd) = \
Marek Vasut6c7c9462012-10-12 10:27:04 +0000193 U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
194 _usage, _help, _comp);
wdenk8bde7f72003-06-27 21:31:46 +0000195
Simon Glassfb241122016-03-13 19:07:33 -0600196#else
197#define U_BOOT_SUBCMD_START(name) static cmd_tbl_t name[] = {};
198#define U_BOOT_SUBCMD_END
199
200#define _CMD_REMOVE(_name, _cmd) \
201 int __remove_ ## _name(void) \
202 { \
203 if (0) \
204 _cmd(NULL, 0, 0, NULL); \
205 return 0; \
206 }
207#define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, \
208 _help, _comp) \
209 { #_name, _maxargs, _rep, 0 ? _cmd : NULL, _usage, \
210 _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
211
212#define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, \
213 _comp) \
214 _CMD_REMOVE(sub_ ## _name, _cmd)
215
216#endif /* CONFIG_CMDLINE */
217
Marek Vasut6c7c9462012-10-12 10:27:04 +0000218#define U_BOOT_CMD(_name, _maxargs, _rep, _cmd, _usage, _help) \
219 U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, NULL)
wdenk8bde7f72003-06-27 21:31:46 +0000220
Simon Glassfb241122016-03-13 19:07:33 -0600221#define U_BOOT_CMD_MKENT(_name, _maxargs, _rep, _cmd, _usage, _help) \
222 U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
223 _usage, _help, NULL)
224
wdenk78f66222002-08-27 10:27:51 +0000225#endif /* __COMMAND_H */