xref: /openbmc/u-boot/include/command.h (revision 358fd21f)
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * (C) Copyright 2000-2009
4  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5  */
6 
7 /*
8  *  Definitions for Command Processor
9  */
10 #ifndef __COMMAND_H
11 #define __COMMAND_H
12 
13 #include <linker_lists.h>
14 
15 #ifndef NULL
16 #define NULL	0
17 #endif
18 
19 /* Default to a width of 8 characters for help message command width */
20 #ifndef CONFIG_SYS_HELP_CMD_WIDTH
21 #define CONFIG_SYS_HELP_CMD_WIDTH	8
22 #endif
23 
24 #ifndef	__ASSEMBLY__
25 /*
26  * Monitor Command Table
27  */
28 
29 struct cmd_tbl_s {
30 	char		*name;		/* Command Name			*/
31 	int		maxargs;	/* maximum number of arguments	*/
32 	int		repeatable;	/* autorepeat allowed?		*/
33 					/* Implementation function	*/
34 	int		(*cmd)(struct cmd_tbl_s *, int, int, char * const []);
35 	char		*usage;		/* Usage message	(short)	*/
36 #ifdef	CONFIG_SYS_LONGHELP
37 	char		*help;		/* Help  message	(long)	*/
38 #endif
39 #ifdef CONFIG_AUTO_COMPLETE
40 	/* do auto completion on the arguments */
41 	int		(*complete)(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
42 #endif
43 };
44 
45 typedef struct cmd_tbl_s	cmd_tbl_t;
46 
47 
48 #if defined(CONFIG_CMD_RUN)
49 extern int do_run(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
50 #endif
51 
52 /* common/command.c */
53 int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int
54 	      flag, int argc, char * const argv[]);
55 cmd_tbl_t *find_cmd(const char *cmd);
56 cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len);
57 
58 extern int cmd_usage(const cmd_tbl_t *cmdtp);
59 
60 #ifdef CONFIG_AUTO_COMPLETE
61 extern int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
62 extern int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp);
63 #endif
64 
65 /**
66  * cmd_process_error() - report and process a possible error
67  *
68  * @cmdtp: Command which caused the error
69  * @err: Error code (0 if none, -ve for error, like -EIO)
70  * @return 0 (CMD_RET_SUCCESS) if there is not error,
71  *	   1 (CMD_RET_FAILURE) if an error is found
72  *	   -1 (CMD_RET_USAGE) if 'usage' error is found
73  */
74 int cmd_process_error(cmd_tbl_t *cmdtp, int err);
75 
76 /*
77  * Monitor Command
78  *
79  * All commands use a common argument format:
80  *
81  * void function (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
82  */
83 
84 #if defined(CONFIG_CMD_MEMORY) || \
85 	defined(CONFIG_CMD_I2C) || \
86 	defined(CONFIG_CMD_ITEST) || \
87 	defined(CONFIG_CMD_PCI)
88 #define CMD_DATA_SIZE
89 extern int cmd_get_data_size(char* arg, int default_size);
90 #endif
91 
92 #ifdef CONFIG_CMD_BOOTD
93 extern int do_bootd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
94 #endif
95 #ifdef CONFIG_CMD_BOOTM
96 extern int do_bootm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
97 extern int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd);
98 #else
99 static inline int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd)
100 {
101 	return 0;
102 }
103 #endif
104 
105 extern int do_bootz(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
106 
107 extern int do_booti(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
108 
109 extern int common_diskboot(cmd_tbl_t *cmdtp, const char *intf, int argc,
110 			   char *const argv[]);
111 
112 extern int do_reset(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
113 extern int do_poweroff(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
114 
115 extern unsigned long do_go_exec(ulong (*entry)(int, char * const []), int argc,
116 				char * const argv[]);
117 /*
118  * Error codes that commands return to cmd_process(). We use the standard 0
119  * and 1 for success and failure, but add one more case - failure with a
120  * request to call cmd_usage(). But the cmd_process() function handles
121  * CMD_RET_USAGE itself and after calling cmd_usage() it will return 1.
122  * This is just a convenience for commands to avoid them having to call
123  * cmd_usage() all over the place.
124  */
125 enum command_ret_t {
126 	CMD_RET_SUCCESS,	/* 0 = Success */
127 	CMD_RET_FAILURE,	/* 1 = Failure */
128 	CMD_RET_USAGE = -1,	/* Failure, please report 'usage' error */
129 };
130 
131 /**
132  * Process a command with arguments. We look up the command and execute it
133  * if valid. Otherwise we print a usage message.
134  *
135  * @param flag		Some flags normally 0 (see CMD_FLAG_.. above)
136  * @param argc		Number of arguments (arg 0 must be the command text)
137  * @param argv		Arguments
138  * @param repeatable	This function sets this to 0 if the command is not
139  *			repeatable. If the command is repeatable, the value
140  *			is left unchanged.
141  * @param ticks		If ticks is not null, this function set it to the
142  *			number of ticks the command took to complete.
143  * @return 0 if the command succeeded, 1 if it failed
144  */
145 int cmd_process(int flag, int argc, char * const argv[],
146 			       int *repeatable, unsigned long *ticks);
147 
148 void fixup_cmdtable(cmd_tbl_t *cmdtp, int size);
149 
150 /**
151  * board_run_command() - Fallback function to execute a command
152  *
153  * When no command line features are enabled in U-Boot, this function is
154  * called to execute a command. Typically the function can look at the
155  * command and perform a few very specific tasks, such as booting the
156  * system in a particular way.
157  *
158  * This function is only used when CONFIG_CMDLINE is not enabled.
159  *
160  * In normal situations this function should not return, since U-Boot will
161  * simply hang.
162  *
163  * @cmdline:	Command line string to execute
164  * @return 0 if OK, 1 for error
165  */
166 int board_run_command(const char *cmdline);
167 #endif	/* __ASSEMBLY__ */
168 
169 /*
170  * Command Flags:
171  */
172 #define CMD_FLAG_REPEAT		0x0001	/* repeat last command		*/
173 #define CMD_FLAG_BOOTD		0x0002	/* command is from bootd	*/
174 #define CMD_FLAG_ENV		0x0004	/* command is from the environment */
175 
176 #ifdef CONFIG_AUTO_COMPLETE
177 # define _CMD_COMPLETE(x) x,
178 #else
179 # define _CMD_COMPLETE(x)
180 #endif
181 #ifdef CONFIG_SYS_LONGHELP
182 # define _CMD_HELP(x) x,
183 #else
184 # define _CMD_HELP(x)
185 #endif
186 
187 #ifdef CONFIG_CMDLINE
188 #define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd,		\
189 				_usage, _help, _comp)			\
190 		{ #_name, _maxargs, _rep, _cmd, _usage,			\
191 			_CMD_HELP(_help) _CMD_COMPLETE(_comp) }
192 
193 #define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, _comp) \
194 	ll_entry_declare(cmd_tbl_t, _name, cmd) =			\
195 		U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd,	\
196 						_usage, _help, _comp);
197 
198 #else
199 #define U_BOOT_SUBCMD_START(name)	static cmd_tbl_t name[] = {};
200 #define U_BOOT_SUBCMD_END
201 
202 #define _CMD_REMOVE(_name, _cmd)					\
203 	int __remove_ ## _name(void)					\
204 	{								\
205 		if (0)							\
206 			_cmd(NULL, 0, 0, NULL);				\
207 		return 0;						\
208 	}
209 #define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, _usage,	\
210 				  _help, _comp)				\
211 		{ #_name, _maxargs, _rep, 0 ? _cmd : NULL, _usage,	\
212 			_CMD_HELP(_help) _CMD_COMPLETE(_comp) }
213 
214 #define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help,	\
215 			    _comp)				\
216 	_CMD_REMOVE(sub_ ## _name, _cmd)
217 
218 #endif /* CONFIG_CMDLINE */
219 
220 #define U_BOOT_CMD(_name, _maxargs, _rep, _cmd, _usage, _help)		\
221 	U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, NULL)
222 
223 #define U_BOOT_CMD_MKENT(_name, _maxargs, _rep, _cmd, _usage, _help)	\
224 	U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd,		\
225 					_usage, _help, NULL)
226 
227 #endif	/* __COMMAND_H */
228