blob: 767cabb3df09752e36d46987b32b774a716061e1 [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
Simon Glass6f62d7c2017-08-04 16:34:38 -060083#if defined(CONFIG_CMD_MEMORY) || \
84 defined(CONFIG_CMD_I2C) || \
85 defined(CONFIG_CMD_ITEST) || \
86 defined(CONFIG_CMD_PCI)
Jean-Christophe PLAGNIOL-VILLARD8a40fb12008-09-10 22:48:05 +020087#define CMD_DATA_SIZE
88extern int cmd_get_data_size(char* arg, int default_size);
89#endif
90
Mike Frysinger7842fb72010-10-20 03:36:26 -040091#ifdef CONFIG_CMD_BOOTD
92extern int do_bootd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
93#endif
Mike Frysinger67d668b2011-06-05 13:43:02 +000094#ifdef CONFIG_CMD_BOOTM
Mike Frysinger36ebb782010-10-20 03:35:39 -040095extern int do_bootm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
Mike Frysinger67d668b2011-06-05 13:43:02 +000096extern int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd);
97#else
98static inline int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd)
99{
100 return 0;
101}
102#endif
Rob Herring7405a132012-09-21 04:02:30 +0000103
Rob Herringda620222012-12-02 21:00:23 -0600104extern int do_bootz(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
105
Stephen Warren8b5c7382015-07-21 17:49:41 -0600106extern int do_booti(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
107
Rob Herring7405a132012-09-21 04:02:30 +0000108extern int common_diskboot(cmd_tbl_t *cmdtp, const char *intf, int argc,
109 char *const argv[]);
110
Mike Frysinger882b7d72010-10-20 03:41:17 -0400111extern int do_reset(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
Michael van Slingerland4e42e292016-01-13 19:31:17 +0100112extern int do_poweroff(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
Mike Frysinger36ebb782010-10-20 03:35:39 -0400113
Simon Glass9d12d5d2012-02-14 19:59:25 +0000114/*
115 * Error codes that commands return to cmd_process(). We use the standard 0
116 * and 1 for success and failure, but add one more case - failure with a
117 * request to call cmd_usage(). But the cmd_process() function handles
118 * CMD_RET_USAGE itself and after calling cmd_usage() it will return 1.
119 * This is just a convenience for commands to avoid them having to call
120 * cmd_usage() all over the place.
121 */
122enum command_ret_t {
123 CMD_RET_SUCCESS, /* 0 = Success */
124 CMD_RET_FAILURE, /* 1 = Failure */
125 CMD_RET_USAGE = -1, /* Failure, please report 'usage' error */
126};
127
128/**
129 * Process a command with arguments. We look up the command and execute it
130 * if valid. Otherwise we print a usage message.
131 *
132 * @param flag Some flags normally 0 (see CMD_FLAG_.. above)
133 * @param argc Number of arguments (arg 0 must be the command text)
134 * @param argv Arguments
135 * @param repeatable This function sets this to 0 if the command is not
136 * repeatable. If the command is repeatable, the value
137 * is left unchanged.
Richard Genoud34765e82012-12-03 06:28:28 +0000138 * @param ticks If ticks is not null, this function set it to the
139 * number of ticks the command took to complete.
Simon Glass9d12d5d2012-02-14 19:59:25 +0000140 * @return 0 if the command succeeded, 1 if it failed
141 */
142int cmd_process(int flag, int argc, char * const argv[],
Richard Genoud34765e82012-12-03 06:28:28 +0000143 int *repeatable, unsigned long *ticks);
Simon Glassbdf8e342012-02-14 19:59:23 +0000144
Tom Rinicbb2df22015-12-07 08:23:29 -0500145void fixup_cmdtable(cmd_tbl_t *cmdtp, int size);
Simon Glassf8bb6962016-03-19 02:18:38 -0600146
147/**
148 * board_run_command() - Fallback function to execute a command
149 *
150 * When no command line features are enabled in U-Boot, this function is
151 * called to execute a command. Typically the function can look at the
152 * command and perform a few very specific tasks, such as booting the
153 * system in a particular way.
154 *
155 * This function is only used when CONFIG_CMDLINE is not enabled.
156 *
157 * In normal situations this function should not return, since U-Boot will
158 * simply hang.
159 *
160 * @cmdline: Command line string to execute
161 * @return 0 if OK, 1 for error
162 */
163int board_run_command(const char *cmdline);
wdenk78f66222002-08-27 10:27:51 +0000164#endif /* __ASSEMBLY__ */
165
166/*
167 * Command Flags:
168 */
169#define CMD_FLAG_REPEAT 0x0001 /* repeat last command */
170#define CMD_FLAG_BOOTD 0x0002 /* command is from bootd */
Simon Glass87b63982014-10-07 13:59:43 -0600171#define CMD_FLAG_ENV 0x0004 /* command is from the environment */
wdenk78f66222002-08-27 10:27:51 +0000172
Mike Frysinger722b0612010-10-20 03:52:39 -0400173#ifdef CONFIG_AUTO_COMPLETE
174# define _CMD_COMPLETE(x) x,
175#else
176# define _CMD_COMPLETE(x)
177#endif
178#ifdef CONFIG_SYS_LONGHELP
179# define _CMD_HELP(x) x,
180#else
181# define _CMD_HELP(x)
182#endif
wdenk8bde7f72003-06-27 21:31:46 +0000183
Simon Glassfb241122016-03-13 19:07:33 -0600184#ifdef CONFIG_CMDLINE
Marek Vasut6c7c9462012-10-12 10:27:04 +0000185#define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
186 _usage, _help, _comp) \
187 { #_name, _maxargs, _rep, _cmd, _usage, \
188 _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
wdenk8bde7f72003-06-27 21:31:46 +0000189
Marek Vasut6c7c9462012-10-12 10:27:04 +0000190#define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, _comp) \
Albert ARIBAUDef123c52013-02-25 00:59:00 +0000191 ll_entry_declare(cmd_tbl_t, _name, cmd) = \
Marek Vasut6c7c9462012-10-12 10:27:04 +0000192 U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
193 _usage, _help, _comp);
wdenk8bde7f72003-06-27 21:31:46 +0000194
Simon Glassfb241122016-03-13 19:07:33 -0600195#else
196#define U_BOOT_SUBCMD_START(name) static cmd_tbl_t name[] = {};
197#define U_BOOT_SUBCMD_END
198
199#define _CMD_REMOVE(_name, _cmd) \
200 int __remove_ ## _name(void) \
201 { \
202 if (0) \
203 _cmd(NULL, 0, 0, NULL); \
204 return 0; \
205 }
206#define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, \
207 _help, _comp) \
208 { #_name, _maxargs, _rep, 0 ? _cmd : NULL, _usage, \
209 _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
210
211#define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, \
212 _comp) \
213 _CMD_REMOVE(sub_ ## _name, _cmd)
214
215#endif /* CONFIG_CMDLINE */
216
Marek Vasut6c7c9462012-10-12 10:27:04 +0000217#define U_BOOT_CMD(_name, _maxargs, _rep, _cmd, _usage, _help) \
218 U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, NULL)
wdenk8bde7f72003-06-27 21:31:46 +0000219
Simon Glassfb241122016-03-13 19:07:33 -0600220#define U_BOOT_CMD_MKENT(_name, _maxargs, _rep, _cmd, _usage, _help) \
221 U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
222 _usage, _help, NULL)
223
wdenk78f66222002-08-27 10:27:51 +0000224#endif /* __COMMAND_H */