Blame view

common/cli.c 5.67 KB
83d290c56   Tom Rini   SPDX: Convert all...
1
  // SPDX-License-Identifier: GPL-2.0+
30354978f   Simon Glass   Move command line...
2
3
4
5
6
7
8
  /*
   * (C) Copyright 2000
   * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   *
   * Add to readline cmdline-editing by
   * (C) Copyright 2005
   * JinHua Luo, GuangDong Linux Center, <luo.jinhua@gd-linux.com>
30354978f   Simon Glass   Move command line...
9
10
11
12
13
   */
  
  #include <common.h>
  #include <cli.h>
  #include <cli_hush.h>
288b29e44   Simon Glass   common: Move comm...
14
  #include <command.h>
24b852a7a   Simon Glass   Move console defi...
15
  #include <console.h>
7b51b576d   Simon Glass   env: Move env_get...
16
  #include <env.h>
affb21562   Simon Glass   main: Make the ex...
17
  #include <fdtdec.h>
db41d65a9   Simon Glass   common: Move hang...
18
  #include <hang.h>
30354978f   Simon Glass   Move command line...
19
  #include <malloc.h>
affb21562   Simon Glass   main: Make the ex...
20
  DECLARE_GLOBAL_DATA_PTR;
f8bb69643   Simon Glass   Drop command-proc...
21
  #ifdef CONFIG_CMDLINE
30354978f   Simon Glass   Move command line...
22
23
24
25
26
27
28
29
30
  /*
   * Run a command using the selected parser.
   *
   * @param cmd	Command to run
   * @param flag	Execution flags (CMD_FLAG_...)
   * @return 0 on success, or != 0 on error.
   */
  int run_command(const char *cmd, int flag)
  {
2dd468dbe   Andrew F. Davis   dfu: Remove depen...
31
  #if !CONFIG_IS_ENABLED(HUSH_PARSER)
30354978f   Simon Glass   Move command line...
32
33
34
35
36
37
38
39
40
  	/*
  	 * cli_run_command can return 0 or 1 for success, so clean up
  	 * its result.
  	 */
  	if (cli_simple_run_command(cmd, flag) == -1)
  		return 1;
  
  	return 0;
  #else
87b6398b4   Simon Glass   cli: hush: Adjust...
41
42
43
44
45
  	int hush_flags = FLAG_PARSE_SEMICOLON | FLAG_EXIT_FROM_LOOP;
  
  	if (flag & CMD_FLAG_ENV)
  		hush_flags |= FLAG_CONT_ON_NEWLINE;
  	return parse_string_outer(cmd, hush_flags);
30354978f   Simon Glass   Move command line...
46
47
  #endif
  }
1d43bfd2d   Thomas Betker   Add run_command_r...
48
49
50
51
52
53
54
55
56
  /*
   * Run a command using the selected parser, and check if it is repeatable.
   *
   * @param cmd	Command to run
   * @param flag	Execution flags (CMD_FLAG_...)
   * @return 0 (not repeatable) or 1 (repeatable) on success, -1 on error.
   */
  int run_command_repeatable(const char *cmd, int flag)
  {
f1f9d4fac   Masahiro Yamada   hush: complete re...
57
  #ifndef CONFIG_HUSH_PARSER
1d43bfd2d   Thomas Betker   Add run_command_r...
58
59
60
61
62
63
64
65
66
67
68
69
70
  	return cli_simple_run_command(cmd, flag);
  #else
  	/*
  	 * parse_string_outer() returns 1 for failure, so clean up
  	 * its result.
  	 */
  	if (parse_string_outer(cmd,
  			       FLAG_PARSE_SEMICOLON | FLAG_EXIT_FROM_LOOP))
  		return -1;
  
  	return 0;
  #endif
  }
19464f4fe   Sean Anderson   cli: Make the san...
71
72
73
74
75
76
77
78
  #else
  __weak int board_run_command(const char *cmdline)
  {
  	printf("## Commands are disabled. Please enable CONFIG_CMDLINE.
  ");
  
  	return 1;
  }
f8bb69643   Simon Glass   Drop command-proc...
79
  #endif /* CONFIG_CMDLINE */
1d43bfd2d   Thomas Betker   Add run_command_r...
80

30354978f   Simon Glass   Move command line...
81
82
83
84
85
86
87
88
  int run_command_list(const char *cmd, int len, int flag)
  {
  	int need_buff = 1;
  	char *buff = (char *)cmd;	/* cast away const */
  	int rcode = 0;
  
  	if (len == -1) {
  		len = strlen(cmd);
f1f9d4fac   Masahiro Yamada   hush: complete re...
89
  #ifdef CONFIG_HUSH_PARSER
30354978f   Simon Glass   Move command line...
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
  		/* hush will never change our string */
  		need_buff = 0;
  #else
  		/* the built-in parser will change our string if it sees 
   */
  		need_buff = strchr(cmd, '
  ') != NULL;
  #endif
  	}
  	if (need_buff) {
  		buff = malloc(len + 1);
  		if (!buff)
  			return 1;
  		memcpy(buff, cmd, len);
  		buff[len] = '\0';
  	}
f1f9d4fac   Masahiro Yamada   hush: complete re...
106
  #ifdef CONFIG_HUSH_PARSER
30354978f   Simon Glass   Move command line...
107
108
109
110
111
112
113
114
115
116
  	rcode = parse_string_outer(buff, FLAG_PARSE_SEMICOLON);
  #else
  	/*
  	 * This function will overwrite any 
   it sees with a \0, which
  	 * is why it can't work with a const char *. Here we are making
  	 * using of internal knowledge of this function, to avoid always
  	 * doing a malloc() which is actually required only in a case that
  	 * is pretty rare.
  	 */
f8bb69643   Simon Glass   Drop command-proc...
117
  #ifdef CONFIG_CMDLINE
30354978f   Simon Glass   Move command line...
118
  	rcode = cli_simple_run_command_list(buff, flag);
f8bb69643   Simon Glass   Drop command-proc...
119
120
121
  #else
  	rcode = board_run_command(buff);
  #endif
09a788624   Peng Fan   common: cli: avoi...
122
  #endif
30354978f   Simon Glass   Move command line...
123
124
  	if (need_buff)
  		free(buff);
30354978f   Simon Glass   Move command line...
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
  
  	return rcode;
  }
  
  /****************************************************************************/
  
  #if defined(CONFIG_CMD_RUN)
  int do_run(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
  {
  	int i;
  
  	if (argc < 2)
  		return CMD_RET_USAGE;
  
  	for (i = 1; i < argc; ++i) {
  		char *arg;
00caae6d4   Simon Glass   env: Rename geten...
141
  		arg = env_get(argv[i]);
30354978f   Simon Glass   Move command line...
142
143
144
145
146
  		if (arg == NULL) {
  			printf("## Error: \"%s\" not defined
  ", argv[i]);
  			return 1;
  		}
87b6398b4   Simon Glass   cli: hush: Adjust...
147
  		if (run_command(arg, flag | CMD_FLAG_ENV) != 0)
30354978f   Simon Glass   Move command line...
148
149
150
151
152
  			return 1;
  	}
  	return 0;
  }
  #endif
c1bb2cd0b   Simon Glass   main: Hide the hu...
153

0f9258228   Masahiro Yamada   of: clean up OF_C...
154
  #if CONFIG_IS_ENABLED(OF_CONTROL)
affb21562   Simon Glass   main: Make the ex...
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
  bool cli_process_fdt(const char **cmdp)
  {
  	/* Allow the fdt to override the boot command */
  	char *env = fdtdec_get_config_string(gd->fdt_blob, "bootcmd");
  	if (env)
  		*cmdp = env;
  	/*
  	 * If the bootsecure option was chosen, use secure_boot_cmd().
  	 * Always use 'env' in this case, since bootsecure requres that the
  	 * bootcmd was specified in the FDT too.
  	 */
  	return fdtdec_get_config_int(gd->fdt_blob, "bootsecure", 0) != 0;
  }
  
  /*
   * Runs the given boot command securely.  Specifically:
   * - Doesn't run the command with the shell (run_command or parse_string_outer),
   *   since that's a lot of code surface that an attacker might exploit.
   *   Because of this, we don't do any argument parsing--the secure boot command
   *   has to be a full-fledged u-boot command.
   * - Doesn't check for keypresses before booting, since that could be a
   *   security hole; also disables Ctrl-C.
   * - Doesn't allow the command to return.
   *
   * Upon any failures, this function will drop into an infinite loop after
   * printing the error message to console.
   */
  void cli_secure_boot_cmd(const char *cmd)
  {
f8bb69643   Simon Glass   Drop command-proc...
184
  #ifdef CONFIG_CMDLINE
affb21562   Simon Glass   main: Make the ex...
185
  	cmd_tbl_t *cmdtp;
f8bb69643   Simon Glass   Drop command-proc...
186
  #endif
affb21562   Simon Glass   main: Make the ex...
187
188
189
190
191
192
193
194
195
196
197
198
  	int rc;
  
  	if (!cmd) {
  		printf("## Error: Secure boot command not specified
  ");
  		goto err;
  	}
  
  	/* Disable Ctrl-C just in case some command is used that checks it. */
  	disable_ctrlc(1);
  
  	/* Find the command directly. */
f8bb69643   Simon Glass   Drop command-proc...
199
  #ifdef CONFIG_CMDLINE
affb21562   Simon Glass   main: Make the ex...
200
201
202
203
204
205
206
207
208
  	cmdtp = find_cmd(cmd);
  	if (!cmdtp) {
  		printf("## Error: \"%s\" not defined
  ", cmd);
  		goto err;
  	}
  
  	/* Run the command, forcing no flags and faking argc and argv. */
  	rc = (cmdtp->cmd)(cmdtp, 0, 1, (char **)&cmd);
f8bb69643   Simon Glass   Drop command-proc...
209
210
211
  #else
  	rc = board_run_command(cmd);
  #endif
affb21562   Simon Glass   main: Make the ex...
212
213
214
215
216
217
218
219
220
221
222
  	/* Shouldn't ever return from boot command. */
  	printf("## Error: \"%s\" returned (code %d)
  ", cmd, rc);
  
  err:
  	/*
  	 * Not a whole lot to do here.  Rebooting won't help much, since we'll
  	 * just end up right back here.  Just loop.
  	 */
  	hang();
  }
0f9258228   Masahiro Yamada   of: clean up OF_C...
223
  #endif /* CONFIG_IS_ENABLED(OF_CONTROL) */
affb21562   Simon Glass   main: Make the ex...
224

c1bb2cd0b   Simon Glass   main: Hide the hu...
225
226
  void cli_loop(void)
  {
b07cc48ca   Heiko Schocher   main: add new boo...
227
  	bootstage_mark(BOOTSTAGE_ID_ENTER_CLI_LOOP);
f1f9d4fac   Masahiro Yamada   hush: complete re...
228
  #ifdef CONFIG_HUSH_PARSER
c1bb2cd0b   Simon Glass   main: Hide the hu...
229
230
231
  	parse_file_outer();
  	/* This point is never reached */
  	for (;;);
30eae26b5   Stefan Roese   common: cli: Fix ...
232
  #elif defined(CONFIG_CMDLINE)
c1bb2cd0b   Simon Glass   main: Hide the hu...
233
  	cli_simple_loop();
f8bb69643   Simon Glass   Drop command-proc...
234
235
236
  #else
  	printf("## U-Boot command line is disabled. Please enable CONFIG_CMDLINE
  ");
f1f9d4fac   Masahiro Yamada   hush: complete re...
237
  #endif /*CONFIG_HUSH_PARSER*/
c1bb2cd0b   Simon Glass   main: Hide the hu...
238
239
240
241
  }
  
  void cli_init(void)
  {
f1f9d4fac   Masahiro Yamada   hush: complete re...
242
  #ifdef CONFIG_HUSH_PARSER
c1bb2cd0b   Simon Glass   main: Hide the hu...
243
244
245
246
247
248
249
  	u_boot_hush_start();
  #endif
  
  #if defined(CONFIG_HUSH_INIT_VAR)
  	hush_init_var();
  #endif
  }