]> git.sur5r.net Git - u-boot/blob - include/command.h
rockchip: dts: rk3399-evb: Change the tx/rx delay value for transmission quality
[u-boot] / include / command.h
1 /*
2  * (C) Copyright 2000-2009
3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4  *
5  * SPDX-License-Identifier:     GPL-2.0+
6  */
7
8 /*
9  *  Definitions for Command Processor
10  */
11 #ifndef __COMMAND_H
12 #define __COMMAND_H
13
14 #include <linker_lists.h>
15
16 #ifndef NULL
17 #define NULL    0
18 #endif
19
20 /* 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
25 #ifndef __ASSEMBLY__
26 /*
27  * Monitor Command Table
28  */
29
30 struct cmd_tbl_s {
31         char            *name;          /* Command Name                 */
32         int             maxargs;        /* maximum number of arguments  */
33         int             repeatable;     /* autorepeat allowed?          */
34                                         /* Implementation function      */
35         int             (*cmd)(struct cmd_tbl_s *, int, int, char * const []);
36         char            *usage;         /* Usage message        (short) */
37 #ifdef  CONFIG_SYS_LONGHELP
38         char            *help;          /* Help  message        (long)  */
39 #endif
40 #ifdef CONFIG_AUTO_COMPLETE
41         /* do auto completion on the arguments */
42         int             (*complete)(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
43 #endif
44 };
45
46 typedef struct cmd_tbl_s        cmd_tbl_t;
47
48
49 #if defined(CONFIG_CMD_RUN)
50 extern int do_run(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
51 #endif
52
53 /* common/command.c */
54 int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int
55               flag, int argc, char * const argv[]);
56 cmd_tbl_t *find_cmd(const char *cmd);
57 cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len);
58
59 extern int cmd_usage(const cmd_tbl_t *cmdtp);
60
61 #ifdef CONFIG_AUTO_COMPLETE
62 extern int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
63 extern int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp);
64 #endif
65
66 /**
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  */
73 int cmd_process_error(cmd_tbl_t *cmdtp, int err);
74
75 /*
76  * Monitor Command
77  *
78  * All commands use a common argument format:
79  *
80  * void function (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
81  */
82
83 #if defined(CONFIG_CMD_MEMORY) || \
84         defined(CONFIG_CMD_I2C) || \
85         defined(CONFIG_CMD_ITEST) || \
86         defined(CONFIG_CMD_PCI)
87 #define CMD_DATA_SIZE
88 extern int cmd_get_data_size(char* arg, int default_size);
89 #endif
90
91 #ifdef CONFIG_CMD_BOOTD
92 extern int do_bootd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
93 #endif
94 #ifdef CONFIG_CMD_BOOTM
95 extern int do_bootm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
96 extern int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd);
97 #else
98 static inline int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd)
99 {
100         return 0;
101 }
102 #endif
103
104 extern int do_bootz(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
105
106 extern int do_booti(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
107
108 extern int common_diskboot(cmd_tbl_t *cmdtp, const char *intf, int argc,
109                            char *const argv[]);
110
111 extern int do_reset(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
112 extern int do_poweroff(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
113
114 /*
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  */
122 enum 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.
138  * @param ticks         If ticks is not null, this function set it to the
139  *                      number of ticks the command took to complete.
140  * @return 0 if the command succeeded, 1 if it failed
141  */
142 int cmd_process(int flag, int argc, char * const argv[],
143                                int *repeatable, unsigned long *ticks);
144
145 void fixup_cmdtable(cmd_tbl_t *cmdtp, int size);
146
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  */
163 int board_run_command(const char *cmdline);
164 #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        */
171 #define CMD_FLAG_ENV            0x0004  /* command is from the environment */
172
173 #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
183
184 #ifdef CONFIG_CMDLINE
185 #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) }
189
190 #define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, _comp) \
191         ll_entry_declare(cmd_tbl_t, _name, cmd) =                       \
192                 U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd,  \
193                                                 _usage, _help, _comp);
194
195 #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
217 #define U_BOOT_CMD(_name, _maxargs, _rep, _cmd, _usage, _help)          \
218         U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, NULL)
219
220 #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
224 #endif  /* __COMMAND_H */