]> git.ipfire.org Git - thirdparty/u-boot.git/blame - common/cli.c
Revert "Merge patch series "arm: dts: am62-beagleplay: Fix Beagleplay Ethernet""
[thirdparty/u-boot.git] / common / cli.c
CommitLineData
83d290c5 1// SPDX-License-Identifier: GPL-2.0+
30354978
SG
2/*
3 * (C) Copyright 2000
4 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 *
6 * Add to readline cmdline-editing by
7 * (C) Copyright 2005
8 * JinHua Luo, GuangDong Linux Center, <luo.jinhua@gd-linux.com>
30354978
SG
9 */
10
26f923c7
EB
11#define pr_fmt(fmt) "cli: %s: " fmt, __func__
12
d678a59d 13#include <common.h>
d2e4b2fa 14#include <ansi.h>
52f24238 15#include <bootstage.h>
30354978
SG
16#include <cli.h>
17#include <cli_hush.h>
288b29e4 18#include <command.h>
24b852a7 19#include <console.h>
7b51b576 20#include <env.h>
affb2156 21#include <fdtdec.h>
db41d65a 22#include <hang.h>
30354978 23#include <malloc.h>
401d1c4f 24#include <asm/global_data.h>
7de8bd03 25#include <dm/ofnode.h>
26f923c7 26#include <linux/errno.h>
affb2156 27
f8bb6964 28#ifdef CONFIG_CMDLINE
3ea3c57e
FL
29
30static inline bool use_hush_old(void)
31{
32 return IS_ENABLED(CONFIG_HUSH_SELECTABLE) ?
33 gd->flags & GD_FLG_HUSH_OLD_PARSER :
34 IS_ENABLED(CONFIG_HUSH_OLD_PARSER);
35}
36
30354978
SG
37/*
38 * Run a command using the selected parser.
39 *
40 * @param cmd Command to run
41 * @param flag Execution flags (CMD_FLAG_...)
185f812c 42 * Return: 0 on success, or != 0 on error.
30354978
SG
43 */
44int run_command(const char *cmd, int flag)
45{
b84d23d0 46#if !IS_ENABLED(CONFIG_HUSH_PARSER)
30354978
SG
47 /*
48 * cli_run_command can return 0 or 1 for success, so clean up
49 * its result.
50 */
51 if (cli_simple_run_command(cmd, flag) == -1)
52 return 1;
53
54 return 0;
3ea3c57e
FL
55#else
56 if (use_hush_old()) {
57 int hush_flags = FLAG_PARSE_SEMICOLON | FLAG_EXIT_FROM_LOOP;
58
59 if (flag & CMD_FLAG_ENV)
60 hush_flags |= FLAG_CONT_ON_NEWLINE;
61 return parse_string_outer(cmd, hush_flags);
62 }
63 /*
64 * Possible values for flags are the following:
65 * FLAG_EXIT_FROM_LOOP: This flags ensures we exit from loop in
66 * parse_and_run_stream() after first iteration while normal
67 * behavior, * i.e. when called from cli_loop(), is to loop
68 * infinitely.
69 * FLAG_PARSE_SEMICOLON: modern Hush parses ';' and does not stop
70 * first time it sees one. So, I think we do not need this flag.
71 * FLAG_REPARSING: For the moment, I do not understand the goal
72 * of this flag.
73 * FLAG_CONT_ON_NEWLINE: This flag seems to be used to continue
74 * parsing even when reading '\n' when coming from
75 * run_command(). In this case, modern Hush reads until it finds
76 * '\0'. So, I think we do not need this flag.
77 */
78 return parse_string_outer_modern(cmd, FLAG_EXIT_FROM_LOOP);
30354978
SG
79#endif
80}
81
1d43bfd2
TB
82/*
83 * Run a command using the selected parser, and check if it is repeatable.
84 *
85 * @param cmd Command to run
86 * @param flag Execution flags (CMD_FLAG_...)
185f812c 87 * Return: 0 (not repeatable) or 1 (repeatable) on success, -1 on error.
1d43bfd2
TB
88 */
89int run_command_repeatable(const char *cmd, int flag)
90{
f1f9d4fa 91#ifndef CONFIG_HUSH_PARSER
1d43bfd2
TB
92 return cli_simple_run_command(cmd, flag);
93#else
3ea3c57e
FL
94 int ret;
95
96 if (use_hush_old()) {
97 ret = parse_string_outer(cmd,
98 FLAG_PARSE_SEMICOLON
99 | FLAG_EXIT_FROM_LOOP);
100 } else {
101 ret = parse_string_outer_modern(cmd,
102 FLAG_PARSE_SEMICOLON
103 | FLAG_EXIT_FROM_LOOP);
104 }
105
1d43bfd2
TB
106 /*
107 * parse_string_outer() returns 1 for failure, so clean up
108 * its result.
109 */
3ea3c57e 110 if (ret)
1d43bfd2
TB
111 return -1;
112
113 return 0;
114#endif
115}
19464f4f
SA
116#else
117__weak int board_run_command(const char *cmdline)
118{
119 printf("## Commands are disabled. Please enable CONFIG_CMDLINE.\n");
120
121 return 1;
122}
f8bb6964 123#endif /* CONFIG_CMDLINE */
1d43bfd2 124
30354978
SG
125int run_command_list(const char *cmd, int len, int flag)
126{
127 int need_buff = 1;
128 char *buff = (char *)cmd; /* cast away const */
129 int rcode = 0;
130
131 if (len == -1) {
132 len = strlen(cmd);
f1f9d4fa 133#ifdef CONFIG_HUSH_PARSER
30354978
SG
134 /* hush will never change our string */
135 need_buff = 0;
136#else
137 /* the built-in parser will change our string if it sees \n */
138 need_buff = strchr(cmd, '\n') != NULL;
139#endif
140 }
141 if (need_buff) {
142 buff = malloc(len + 1);
143 if (!buff)
144 return 1;
145 memcpy(buff, cmd, len);
146 buff[len] = '\0';
147 }
f1f9d4fa 148#ifdef CONFIG_HUSH_PARSER
3ea3c57e
FL
149 if (use_hush_old()) {
150 rcode = parse_string_outer(buff, FLAG_PARSE_SEMICOLON);
151 } else {
152 rcode = parse_string_outer_modern(buff, FLAG_PARSE_SEMICOLON);
153 }
30354978
SG
154#else
155 /*
156 * This function will overwrite any \n it sees with a \0, which
157 * is why it can't work with a const char *. Here we are making
158 * using of internal knowledge of this function, to avoid always
159 * doing a malloc() which is actually required only in a case that
160 * is pretty rare.
161 */
f8bb6964 162#ifdef CONFIG_CMDLINE
30354978 163 rcode = cli_simple_run_command_list(buff, flag);
f8bb6964
SG
164#else
165 rcode = board_run_command(buff);
166#endif
09a78862 167#endif
30354978
SG
168 if (need_buff)
169 free(buff);
30354978
SG
170
171 return rcode;
172}
173
74724484
SG
174int run_commandf(const char *fmt, ...)
175{
176 va_list args;
26f923c7 177 int nbytes;
74724484
SG
178
179 va_start(args, fmt);
26f923c7
EB
180 /*
181 * Limit the console_buffer space being used to CONFIG_SYS_CBSIZE,
182 * because its last byte is used to fit the replacement of \0 by \n\0
183 * in underlying hush parser
184 */
185 nbytes = vsnprintf(console_buffer, CONFIG_SYS_CBSIZE, fmt, args);
74724484
SG
186 va_end(args);
187
26f923c7
EB
188 if (nbytes < 0) {
189 pr_debug("I/O internal error occurred.\n");
190 return -EIO;
191 } else if (nbytes >= CONFIG_SYS_CBSIZE) {
192 pr_debug("'fmt' size:%d exceeds the limit(%d)\n",
193 nbytes, CONFIG_SYS_CBSIZE);
194 return -ENOSPC;
195 }
196 return run_command(console_buffer, 0);
74724484
SG
197}
198
30354978
SG
199/****************************************************************************/
200
201#if defined(CONFIG_CMD_RUN)
09140113 202int do_run(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
30354978 203{
721307eb 204 int i, ret;
30354978
SG
205
206 if (argc < 2)
207 return CMD_RET_USAGE;
208
209 for (i = 1; i < argc; ++i) {
210 char *arg;
211
00caae6d 212 arg = env_get(argv[i]);
30354978
SG
213 if (arg == NULL) {
214 printf("## Error: \"%s\" not defined\n", argv[i]);
215 return 1;
216 }
217
721307eb
MV
218 ret = run_command(arg, flag | CMD_FLAG_ENV);
219 if (ret)
220 return ret;
30354978
SG
221 }
222 return 0;
223}
224#endif
c1bb2cd0 225
0f925822 226#if CONFIG_IS_ENABLED(OF_CONTROL)
affb2156
SG
227bool cli_process_fdt(const char **cmdp)
228{
229 /* Allow the fdt to override the boot command */
7de8bd03 230 const char *env = ofnode_conf_read_str("bootcmd");
affb2156
SG
231 if (env)
232 *cmdp = env;
233 /*
234 * If the bootsecure option was chosen, use secure_boot_cmd().
235 * Always use 'env' in this case, since bootsecure requres that the
236 * bootcmd was specified in the FDT too.
237 */
7de8bd03 238 return ofnode_conf_read_int("bootsecure", 0);
affb2156
SG
239}
240
241/*
242 * Runs the given boot command securely. Specifically:
243 * - Doesn't run the command with the shell (run_command or parse_string_outer),
244 * since that's a lot of code surface that an attacker might exploit.
245 * Because of this, we don't do any argument parsing--the secure boot command
246 * has to be a full-fledged u-boot command.
247 * - Doesn't check for keypresses before booting, since that could be a
248 * security hole; also disables Ctrl-C.
249 * - Doesn't allow the command to return.
250 *
251 * Upon any failures, this function will drop into an infinite loop after
252 * printing the error message to console.
253 */
254void cli_secure_boot_cmd(const char *cmd)
255{
f8bb6964 256#ifdef CONFIG_CMDLINE
09140113 257 struct cmd_tbl *cmdtp;
f8bb6964 258#endif
affb2156
SG
259 int rc;
260
261 if (!cmd) {
262 printf("## Error: Secure boot command not specified\n");
263 goto err;
264 }
265
266 /* Disable Ctrl-C just in case some command is used that checks it. */
267 disable_ctrlc(1);
268
269 /* Find the command directly. */
f8bb6964 270#ifdef CONFIG_CMDLINE
affb2156
SG
271 cmdtp = find_cmd(cmd);
272 if (!cmdtp) {
273 printf("## Error: \"%s\" not defined\n", cmd);
274 goto err;
275 }
276
277 /* Run the command, forcing no flags and faking argc and argv. */
278 rc = (cmdtp->cmd)(cmdtp, 0, 1, (char **)&cmd);
279
f8bb6964
SG
280#else
281 rc = board_run_command(cmd);
282#endif
283
affb2156
SG
284 /* Shouldn't ever return from boot command. */
285 printf("## Error: \"%s\" returned (code %d)\n", cmd, rc);
286
287err:
288 /*
289 * Not a whole lot to do here. Rebooting won't help much, since we'll
290 * just end up right back here. Just loop.
291 */
292 hang();
293}
0f925822 294#endif /* CONFIG_IS_ENABLED(OF_CONTROL) */
affb2156 295
c1bb2cd0
SG
296void cli_loop(void)
297{
b07cc48c 298 bootstage_mark(BOOTSTAGE_ID_ENTER_CLI_LOOP);
9a068377
FL
299#if CONFIG_IS_ENABLED(HUSH_PARSER)
300 if (gd->flags & GD_FLG_HUSH_MODERN_PARSER)
301 parse_and_run_file();
302 else if (gd->flags & GD_FLG_HUSH_OLD_PARSER)
303 parse_file_outer();
304
305 printf("Problem\n");
c1bb2cd0
SG
306 /* This point is never reached */
307 for (;;);
30eae26b 308#elif defined(CONFIG_CMDLINE)
c1bb2cd0 309 cli_simple_loop();
f8bb6964
SG
310#else
311 printf("## U-Boot command line is disabled. Please enable CONFIG_CMDLINE\n");
f1f9d4fa 312#endif /*CONFIG_HUSH_PARSER*/
c1bb2cd0
SG
313}
314
315void cli_init(void)
316{
f1f9d4fa 317#ifdef CONFIG_HUSH_PARSER
9a068377 318 /* This if block is used to initialize hush parser gd flag. */
6bb39f5d 319 if (!(gd->flags & GD_FLG_HUSH_OLD_PARSER)
9a068377
FL
320 && !(gd->flags & GD_FLG_HUSH_MODERN_PARSER)) {
321 if (CONFIG_IS_ENABLED(HUSH_OLD_PARSER))
322 gd->flags |= GD_FLG_HUSH_OLD_PARSER;
323 else if (CONFIG_IS_ENABLED(HUSH_MODERN_PARSER))
324 gd->flags |= GD_FLG_HUSH_MODERN_PARSER;
325 }
326
327 if (gd->flags & GD_FLG_HUSH_OLD_PARSER) {
328 u_boot_hush_start();
329 } else if (gd->flags & GD_FLG_HUSH_MODERN_PARSER) {
330 u_boot_hush_start_modern();
331 } else {
332 printf("No valid hush parser to use, cli will not initialized!\n");
333 return;
334 }
c1bb2cd0
SG
335#endif
336
337#if defined(CONFIG_HUSH_INIT_VAR)
338 hush_init_var();
339#endif
d2e4b2fa
HS
340
341 if (CONFIG_IS_ENABLED(VIDEO_ANSI))
342 printf(ANSI_CURSOR_SHOW "\n");
c1bb2cd0 343}