]>
Commit | Line | Data |
---|---|---|
35edb766 | 1 | /* |
04f84937 | 2 | * (C) Copyright 2014-2016, 2018 Leo C. <erbl259-lmu@yahoo.de> |
35edb766 L |
3 | * |
4 | * (C) Copyright 2000-2009 | |
5 | * Wolfgang Denk, DENX Software Engineering, wd@denx.de. | |
6 | * | |
04b3ea0e | 7 | * SPDX-License-Identifier: GPL-2.0 |
35edb766 | 8 | */ |
d684c216 L |
9 | |
10 | /* | |
11 | * Definitions for Command Processor | |
12 | */ | |
13 | #ifndef __COMMAND_H | |
14 | #define __COMMAND_H | |
15 | ||
16 | #include "common.h" | |
17 | #include "config.h" | |
fcd2239e | 18 | #include <setjmp.h> |
d684c216 L |
19 | |
20 | #ifndef NULL | |
21 | #define NULL 0 | |
22 | #endif | |
23 | ||
24 | /* Default to a width of 8 characters for help message command width */ | |
25 | #ifndef CONFIG_SYS_HELP_CMD_WIDTH | |
26 | #define CONFIG_SYS_HELP_CMD_WIDTH 8 | |
27 | #endif | |
28 | ||
d0581f88 L |
29 | /* |
30 | * Error codes that commands return to cmd_process(). We use the standard 0 | |
31 | * and 1 for success and failure, but add one more case - failure with a | |
32 | * request to call cmd_usage(). But the cmd_process() function handles | |
33 | * CMD_RET_USAGE itself and after calling cmd_usage() it will return 1. | |
34 | * This is just a convenience for commands to avoid them having to call | |
35 | * cmd_usage() all over the place. | |
36 | */ | |
37 | typedef enum { | |
889202c4 L |
38 | CMD_RET_SUCCESS = 0, /* Success */ |
39 | CMD_RET_FAILURE = 1, /* Failure */ | |
d0581f88 L |
40 | CMD_RET_USAGE = -1, /* Failure, please report 'usage' error */ |
41 | } command_ret_t; | |
42 | ||
d684c216 L |
43 | /* |
44 | * Monitor Command Table | |
45 | */ | |
46 | ||
8da60ec5 | 47 | typedef const FLASH struct cmd_tbl_s cmd_tbl_t; |
d684c216 L |
48 | struct cmd_tbl_s { |
49 | const FLASH char *name; /* Command Name */ | |
fcf1d5b3 L |
50 | uint8_t maxargs; /* maximum number of arguments */ |
51 | uint8_t flags; /* autorepeat allowed? */ | |
35edb766 | 52 | /* Implementation function */ |
04f84937 | 53 | command_ret_t (*cmd)(cmd_tbl_t *, uint_fast8_t, int, char * const []); |
35edb766 | 54 | const FLASH char *usage; /* Usage message (short) */ |
d684c216 L |
55 | #ifdef CONFIG_SYS_LONGHELP |
56 | const FLASH char *help; /* Help message (long) */ | |
57 | #endif | |
8da60ec5 | 58 | cmd_tbl_t *subcmd; |
d684c216 L |
59 | #ifdef CONFIG_AUTO_COMPLETE |
60 | /* do auto completion on the arguments */ | |
61 | int (*complete)(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]); | |
62 | #endif | |
63 | }; | |
64 | ||
d0581f88 L |
65 | /** |
66 | * Process a command with arguments. We look up the command and execute it | |
67 | * if valid. Otherwise we print a usage message. | |
68 | * | |
69 | * @param flag Some flags normally 0 (see CMD_FLAG_.. above) | |
70 | * @param argc Number of arguments (arg 0 must be the command text) | |
71 | * @param argv Arguments | |
72 | * @param repeatable This function sets this to 0 if the command is not | |
73 | * repeatable. If the command is repeatable, the value | |
74 | * is left unchanged. | |
75 | * @return 0 if the command succeeded, 1 if it failed | |
76 | */ | |
77 | command_ret_t | |
fcf1d5b3 | 78 | cmd_process(uint_fast8_t flag, int argc, char * const argv[], uint_fast8_t *repeatable); |
d0581f88 | 79 | |
d684c216 L |
80 | |
81 | /* command.c */ | |
5caa8c2b | 82 | command_ret_t do_help(cmd_tbl_t *cmdtp, uint_fast8_t flag, int argc, char * const argv[]); |
d684c216 | 83 | |
d0581f88 | 84 | command_ret_t cmd_usage(cmd_tbl_t *cmdtp); |
d684c216 L |
85 | |
86 | #ifdef CONFIG_AUTO_COMPLETE | |
87 | extern int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]); | |
dea9a315 | 88 | extern int cmd_auto_complete(const FLASH char *const prompt, char *buf, int *np, int *colp); |
d684c216 L |
89 | #endif |
90 | ||
91 | /** | |
92 | * cmd_process_error() - report and process a possible error | |
93 | * | |
94 | * @cmdtp: Command which caused the error | |
95 | * @err: Error code (0 if none, -ve for error, like -EIO) | |
96 | * @return 0 if there is not error, 1 (CMD_RET_FAILURE) if an error is found | |
97 | */ | |
98 | int cmd_process_error(cmd_tbl_t *cmdtp, int err); | |
99 | ||
022330eb L |
100 | /** |
101 | * cmd_error() - print error message | |
102 | * | |
103 | * @fmt: | |
104 | */ | |
414caa77 | 105 | void cmd_error(int status, int errnum, const char *fmt, ...); |
022330eb | 106 | |
d684c216 L |
107 | /* |
108 | * Monitor Command | |
109 | * | |
110 | * All commands use a common argument format: | |
111 | * | |
fcf1d5b3 | 112 | * void function (cmd_tbl_t *cmdtp, uint_fast8_t flag, int argc, char * const argv[]); |
d684c216 L |
113 | */ |
114 | ||
115 | ||
116 | #ifdef CONFIG_CMD_BOOTD | |
fcf1d5b3 | 117 | extern command_ret_t do_bootd(cmd_tbl_t *cmdtp, uint_fast8_t flag, int argc, char * const argv[]); |
d684c216 L |
118 | #endif |
119 | #ifdef CONFIG_CMD_BOOTM | |
fcf1d5b3 | 120 | extern command_ret_t do_bootm(cmd_tbl_t *cmdtp, uint_fast8_t flag, int argc, char * const argv[]); |
d684c216 L |
121 | extern int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd); |
122 | #else | |
fcf1d5b3 | 123 | static inline int bootm_maybe_autostart(cmd_tbl_t *cmdtp UNUSED, const char *cmd UNUSED) |
d684c216 | 124 | { |
d684c216 L |
125 | return 0; |
126 | } | |
127 | #endif | |
128 | ||
129 | extern int common_diskboot(cmd_tbl_t *cmdtp, const char *intf, int argc, | |
130 | char *const argv[]); | |
131 | ||
d684c216 L |
132 | /* |
133 | * Command Flags: | |
134 | */ | |
fcf1d5b3 L |
135 | #define CMD_FLAG_REPEAT 0x01 /* repeat last command */ |
136 | #define CMD_FLAG_BOOTD 0x02 /* command is from bootd */ | |
137 | ||
138 | /* | |
139 | * Flags for command table: | |
140 | */ | |
7a1ed620 | 141 | #define CTBL_RPT 0x01 /* command is repeatable */ |
fcf1d5b3 | 142 | #define CTBL_SUBCMD 0x02 /* command has subcommands */ |
7a1ed620 L |
143 | #define CTBL_SUBCMDAUTO 0x04 /* execute subcommands whithout prefix */ |
144 | #define CTBL_DBG 0x08 /* command is only for debugging */ | |
d684c216 L |
145 | |
146 | #ifdef CONFIG_AUTO_COMPLETE | |
147 | # define _CMD_COMPLETE(x) x, | |
148 | #else | |
149 | # define _CMD_COMPLETE(x) | |
150 | #endif | |
151 | #ifdef CONFIG_SYS_LONGHELP | |
152 | # define _CMD_HELP(x) x, | |
153 | #else | |
154 | # define _CMD_HELP(x) | |
155 | #endif | |
156 | ||
157 | ||
8da60ec5 L |
158 | #define CMD_TBL_ITEM_FULL(_name, _maxargs, _rep, _cmd, \ |
159 | _usage, _help, _subtbl, _comp) \ | |
160 | { FSTR(#_name), _maxargs, _rep, _cmd, FSTR(_usage), \ | |
161 | _CMD_HELP(FSTR(_help)) _subtbl, _CMD_COMPLETE(_comp) } | |
162 | ||
163 | #define CMD_TBL_ITEM_COMPLETE(_name, _maxargs, _rep, _cmd, \ | |
164 | _usage, _help, _comp) \ | |
165 | { FSTR(#_name), _maxargs, _rep, _cmd, FSTR(_usage), \ | |
166 | _CMD_HELP(FSTR(_help)) NULL, _CMD_COMPLETE(_comp) } | |
167 | ||
168 | #define CMD_TBL_ITEM(_name, _maxargs, _rep, _cmd, _usage, _help) \ | |
169 | CMD_TBL_ITEM_FULL(_name, _maxargs, _rep, _cmd, \ | |
170 | _usage, _help, NULL, NULL) | |
d684c216 | 171 | |
8da60ec5 L |
172 | #define CMD_TBL_ITEM_TOP(_name, _maxargs, _rep, _cmd, _usage, _help, _subtbl) \ |
173 | CMD_TBL_ITEM_FULL(_name, _maxargs, _rep, _cmd, \ | |
174 | _usage, _help, _subtbl, NULL) | |
d684c216 | 175 | |
5caa8c2b L |
176 | #define CMD_TBL_END(_table_start) { .subcmd = _table_start } |
177 | ||
fcf1d5b3 | 178 | typedef command_ret_t (*do_cmd_t)(cmd_tbl_t *, uint_fast8_t, int, char * const []); |
d684c216 L |
179 | |
180 | extern cmd_tbl_t cmd_tbl[]; | |
181 | ||
fcd2239e L |
182 | extern jmp_buf cmd_jbuf; |
183 | ||
d684c216 L |
184 | |
185 | #endif /* __COMMAND_H */ |