• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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  *  Command Processor Table
9  */
10 
11 #include <common.h>
12 #include <command.h>
13 #include <console.h>
14 #include <linux/ctype.h>
15 
16 /*
17  * Use puts() instead of printf() to avoid printf buffer overflow
18  * for long help messages
19  */
20 
_do_help(cmd_tbl_t * cmd_start,int cmd_items,cmd_tbl_t * cmdtp,int flag,int argc,char * const argv[])21 int _do_help(cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t *cmdtp, int flag,
22 	     int argc, char * const argv[])
23 {
24 	int i;
25 	int rcode = 0;
26 
27 	if (argc == 1) {	/* show list of commands */
28 		cmd_tbl_t *cmd_array[cmd_items];
29 		int i, j, swaps;
30 
31 		/* Make array of commands from .uboot_cmd section */
32 		cmdtp = cmd_start;
33 		for (i = 0; i < cmd_items; i++) {
34 			cmd_array[i] = cmdtp++;
35 		}
36 
37 		/* Sort command list (trivial bubble sort) */
38 		for (i = cmd_items - 1; i > 0; --i) {
39 			swaps = 0;
40 			for (j = 0; j < i; ++j) {
41 				if (strcmp(cmd_array[j]->name,
42 					   cmd_array[j + 1]->name) > 0) {
43 					cmd_tbl_t *tmp;
44 					tmp = cmd_array[j];
45 					cmd_array[j] = cmd_array[j + 1];
46 					cmd_array[j + 1] = tmp;
47 					++swaps;
48 				}
49 			}
50 			if (!swaps)
51 				break;
52 		}
53 
54 		/* print short help (usage) */
55 		for (i = 0; i < cmd_items; i++) {
56 			const char *usage = cmd_array[i]->usage;
57 
58 			/* allow user abort */
59 			if (ctrlc())
60 				return 1;
61 			if (usage == NULL)
62 				continue;
63 			printf("%-*s- %s\n", CONFIG_SYS_HELP_CMD_WIDTH,
64 			       cmd_array[i]->name, usage);
65 		}
66 		return 0;
67 	}
68 	/*
69 	 * command help (long version)
70 	 */
71 	for (i = 1; i < argc; ++i) {
72 		cmdtp = find_cmd_tbl(argv[i], cmd_start, cmd_items);
73 		if (cmdtp != NULL) {
74 			rcode |= cmd_usage(cmdtp);
75 		} else {
76 			printf("Unknown command '%s' - try 'help' without arguments for list of all known commands\n\n",
77 			       argv[i]);
78 			rcode = 1;
79 		}
80 	}
81 	return rcode;
82 }
83 
84 /* find command table entry for a command */
find_cmd_tbl(const char * cmd,cmd_tbl_t * table,int table_len)85 cmd_tbl_t *find_cmd_tbl(const char *cmd, cmd_tbl_t *table, int table_len)
86 {
87 #ifdef CONFIG_CMDLINE
88 	cmd_tbl_t *cmdtp;
89 	cmd_tbl_t *cmdtp_temp = table;	/* Init value */
90 	const char *p;
91 	int len;
92 	int n_found = 0;
93 
94 	if (!cmd)
95 		return NULL;
96 	/*
97 	 * Some commands allow length modifiers (like "cp.b");
98 	 * compare command name only until first dot.
99 	 */
100 	len = ((p = strchr(cmd, '.')) == NULL) ? strlen (cmd) : (p - cmd);
101 
102 	for (cmdtp = table; cmdtp != table + table_len; cmdtp++) {
103 		if (strncmp(cmd, cmdtp->name, len) == 0) {
104 			if (len == strlen(cmdtp->name))
105 				return cmdtp;	/* full match */
106 
107 			cmdtp_temp = cmdtp;	/* abbreviated command ? */
108 			n_found++;
109 		}
110 	}
111 	if (n_found == 1) {			/* exactly one match */
112 		return cmdtp_temp;
113 	}
114 #endif /* CONFIG_CMDLINE */
115 
116 	return NULL;	/* not found or ambiguous command */
117 }
118 
find_cmd(const char * cmd)119 cmd_tbl_t *find_cmd(const char *cmd)
120 {
121 	cmd_tbl_t *start = ll_entry_start(cmd_tbl_t, cmd);
122 	const int len = ll_entry_count(cmd_tbl_t, cmd);
123 	return find_cmd_tbl(cmd, start, len);
124 }
125 
cmd_usage(const cmd_tbl_t * cmdtp)126 int cmd_usage(const cmd_tbl_t *cmdtp)
127 {
128 	printf("%s - %s\n\n", cmdtp->name, cmdtp->usage);
129 
130 #ifdef	CONFIG_SYS_LONGHELP
131 	printf("Usage:\n%s ", cmdtp->name);
132 
133 	if (!cmdtp->help) {
134 		puts ("- No additional help available.\n");
135 		return 1;
136 	}
137 
138 	puts(cmdtp->help);
139 	putc('\n');
140 #endif	/* CONFIG_SYS_LONGHELP */
141 	return 1;
142 }
143 
144 #ifdef CONFIG_AUTO_COMPLETE
145 
var_complete(int argc,char * const argv[],char last_char,int maxv,char * cmdv[])146 int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[])
147 {
148 	static char tmp_buf[512];
149 	int space;
150 
151 	space = last_char == '\0' || isblank(last_char);
152 
153 	if (space && argc == 1)
154 		return env_complete("", maxv, cmdv, sizeof(tmp_buf), tmp_buf);
155 
156 	if (!space && argc == 2)
157 		return env_complete(argv[1], maxv, cmdv, sizeof(tmp_buf), tmp_buf);
158 
159 	return 0;
160 }
161 
162 /*************************************************************************************/
163 
complete_cmdv(int argc,char * const argv[],char last_char,int maxv,char * cmdv[])164 static int complete_cmdv(int argc, char * const argv[], char last_char, int maxv, char *cmdv[])
165 {
166 #ifdef CONFIG_CMDLINE
167 	cmd_tbl_t *cmdtp = ll_entry_start(cmd_tbl_t, cmd);
168 	const int count = ll_entry_count(cmd_tbl_t, cmd);
169 	const cmd_tbl_t *cmdend = cmdtp + count;
170 	const char *p;
171 	int len, clen;
172 	int n_found = 0;
173 	const char *cmd;
174 
175 	/* sanity? */
176 	if (maxv < 2)
177 		return -2;
178 
179 	cmdv[0] = NULL;
180 
181 	if (argc == 0) {
182 		/* output full list of commands */
183 		for (; cmdtp != cmdend; cmdtp++) {
184 			if (n_found >= maxv - 2) {
185 				cmdv[n_found++] = "...";
186 				break;
187 			}
188 			cmdv[n_found++] = cmdtp->name;
189 		}
190 		cmdv[n_found] = NULL;
191 		return n_found;
192 	}
193 
194 	/* more than one arg or one but the start of the next */
195 	if (argc > 1 || last_char == '\0' || isblank(last_char)) {
196 		cmdtp = find_cmd(argv[0]);
197 		if (cmdtp == NULL || cmdtp->complete == NULL) {
198 			cmdv[0] = NULL;
199 			return 0;
200 		}
201 		return (*cmdtp->complete)(argc, argv, last_char, maxv, cmdv);
202 	}
203 
204 	cmd = argv[0];
205 	/*
206 	 * Some commands allow length modifiers (like "cp.b");
207 	 * compare command name only until first dot.
208 	 */
209 	p = strchr(cmd, '.');
210 	if (p == NULL)
211 		len = strlen(cmd);
212 	else
213 		len = p - cmd;
214 
215 	/* return the partial matches */
216 	for (; cmdtp != cmdend; cmdtp++) {
217 
218 		clen = strlen(cmdtp->name);
219 		if (clen < len)
220 			continue;
221 
222 		if (memcmp(cmd, cmdtp->name, len) != 0)
223 			continue;
224 
225 		/* too many! */
226 		if (n_found >= maxv - 2) {
227 			cmdv[n_found++] = "...";
228 			break;
229 		}
230 
231 		cmdv[n_found++] = cmdtp->name;
232 	}
233 
234 	cmdv[n_found] = NULL;
235 	return n_found;
236 #else
237 	return 0;
238 #endif
239 }
240 
make_argv(char * s,int argvsz,char * argv[])241 static int make_argv(char *s, int argvsz, char *argv[])
242 {
243 	int argc = 0;
244 
245 	/* split into argv */
246 	while (argc < argvsz - 1) {
247 
248 		/* skip any white space */
249 		while (isblank(*s))
250 			++s;
251 
252 		if (*s == '\0')	/* end of s, no more args	*/
253 			break;
254 
255 		argv[argc++] = s;	/* begin of argument string	*/
256 
257 		/* find end of string */
258 		while (*s && !isblank(*s))
259 			++s;
260 
261 		if (*s == '\0')		/* end of s, no more args	*/
262 			break;
263 
264 		*s++ = '\0';		/* terminate current arg	 */
265 	}
266 	argv[argc] = NULL;
267 
268 	return argc;
269 }
270 
print_argv(const char * banner,const char * leader,const char * sep,int linemax,char * const argv[])271 static void print_argv(const char *banner, const char *leader, const char *sep, int linemax, char * const argv[])
272 {
273 	int ll = leader != NULL ? strlen(leader) : 0;
274 	int sl = sep != NULL ? strlen(sep) : 0;
275 	int len, i;
276 
277 	if (banner) {
278 		puts("\n");
279 		puts(banner);
280 	}
281 
282 	i = linemax;	/* force leader and newline */
283 	while (*argv != NULL) {
284 		len = strlen(*argv) + sl;
285 		if (i + len >= linemax) {
286 			puts("\n");
287 			if (leader)
288 				puts(leader);
289 			i = ll - sl;
290 		} else if (sep)
291 			puts(sep);
292 		puts(*argv++);
293 		i += len;
294 	}
295 	printf("\n");
296 }
297 
find_common_prefix(char * const argv[])298 static int find_common_prefix(char * const argv[])
299 {
300 	int i, len;
301 	char *anchor, *s, *t;
302 
303 	if (*argv == NULL)
304 		return 0;
305 
306 	/* begin with max */
307 	anchor = *argv++;
308 	len = strlen(anchor);
309 	while ((t = *argv++) != NULL) {
310 		s = anchor;
311 		for (i = 0; i < len; i++, t++, s++) {
312 			if (*t != *s)
313 				break;
314 		}
315 		len = s - anchor;
316 	}
317 	return len;
318 }
319 
320 static char tmp_buf[CONFIG_SYS_CBSIZE + 1];	/* copy of console I/O buffer */
321 
cmd_auto_complete(const char * const prompt,char * buf,int * np,int * colp)322 int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp)
323 {
324 	int n = *np, col = *colp;
325 	char *argv[CONFIG_SYS_MAXARGS + 1];		/* NULL terminated	*/
326 	char *cmdv[20];
327 	char *s, *t;
328 	const char *sep;
329 	int i, j, k, len, seplen, argc;
330 	int cnt;
331 	char last_char;
332 
333 	if (strcmp(prompt, CONFIG_SYS_PROMPT) != 0)
334 		return 0;	/* not in normal console */
335 
336 	cnt = strlen(buf);
337 	if (cnt >= 1)
338 		last_char = buf[cnt - 1];
339 	else
340 		last_char = '\0';
341 
342 	/* copy to secondary buffer which will be affected */
343 	strcpy(tmp_buf, buf);
344 
345 	/* separate into argv */
346 	argc = make_argv(tmp_buf, sizeof(argv)/sizeof(argv[0]), argv);
347 
348 	/* do the completion and return the possible completions */
349 	i = complete_cmdv(argc, argv, last_char,
350 			  sizeof(cmdv) / sizeof(cmdv[0]), cmdv);
351 
352 	/* no match; bell and out */
353 	if (i == 0) {
354 		if (argc > 1)	/* allow tab for non command */
355 			return 0;
356 		putc('\a');
357 		return 1;
358 	}
359 
360 	s = NULL;
361 	len = 0;
362 	sep = NULL;
363 	seplen = 0;
364 	if (i == 1) { /* one match; perfect */
365 		k = strlen(argv[argc - 1]);
366 		s = cmdv[0] + k;
367 		len = strlen(s);
368 		sep = " ";
369 		seplen = 1;
370 	} else if (i > 1 && (j = find_common_prefix(cmdv)) != 0) { /* more */
371 		k = strlen(argv[argc - 1]);
372 		j -= k;
373 		if (j > 0) {
374 			s = cmdv[0] + k;
375 			len = j;
376 		}
377 	}
378 
379 	if (s != NULL) {
380 		k = len + seplen;
381 		/* make sure it fits */
382 		if (n + k >= CONFIG_SYS_CBSIZE - 2) {
383 			putc('\a');
384 			return 1;
385 		}
386 
387 		t = buf + cnt;
388 		for (i = 0; i < len; i++)
389 			*t++ = *s++;
390 		if (sep != NULL)
391 			for (i = 0; i < seplen; i++)
392 				*t++ = sep[i];
393 		*t = '\0';
394 		n += k;
395 		col += k;
396 		puts(t - k);
397 		if (sep == NULL)
398 			putc('\a');
399 		*np = n;
400 		*colp = col;
401 	} else {
402 		print_argv(NULL, "  ", " ", 78, cmdv);
403 
404 		puts(prompt);
405 		puts(buf);
406 	}
407 	return 1;
408 }
409 
410 #endif
411 
412 #ifdef CMD_DATA_SIZE
cmd_get_data_size(char * arg,int default_size)413 int cmd_get_data_size(char* arg, int default_size)
414 {
415 	/* Check for a size specification .b, .w or .l.
416 	 */
417 	int len = strlen(arg);
418 	if (len > 2 && arg[len-2] == '.') {
419 		switch (arg[len-1]) {
420 		case 'b':
421 			return 1;
422 		case 'w':
423 			return 2;
424 		case 'l':
425 			return 4;
426 #ifdef CONFIG_SYS_SUPPORT_64BIT_DATA
427 		case 'q':
428 			return 8;
429 #endif
430 		case 's':
431 			return -2;
432 		default:
433 			return -1;
434 		}
435 	}
436 	return default_size;
437 }
438 #endif
439 
440 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
441 DECLARE_GLOBAL_DATA_PTR;
442 
fixup_cmdtable(cmd_tbl_t * cmdtp,int size)443 void fixup_cmdtable(cmd_tbl_t *cmdtp, int size)
444 {
445 	int	i;
446 
447 	if (gd->reloc_off == 0)
448 		return;
449 
450 	for (i = 0; i < size; i++) {
451 		ulong addr;
452 
453 		addr = (ulong)(cmdtp->cmd) + gd->reloc_off;
454 #ifdef DEBUG_COMMANDS
455 		printf("Command \"%s\": 0x%08lx => 0x%08lx\n",
456 		       cmdtp->name, (ulong)(cmdtp->cmd), addr);
457 #endif
458 		cmdtp->cmd =
459 			(int (*)(struct cmd_tbl_s *, int, int, char * const []))addr;
460 		addr = (ulong)(cmdtp->name) + gd->reloc_off;
461 		cmdtp->name = (char *)addr;
462 		if (cmdtp->usage) {
463 			addr = (ulong)(cmdtp->usage) + gd->reloc_off;
464 			cmdtp->usage = (char *)addr;
465 		}
466 #ifdef	CONFIG_SYS_LONGHELP
467 		if (cmdtp->help) {
468 			addr = (ulong)(cmdtp->help) + gd->reloc_off;
469 			cmdtp->help = (char *)addr;
470 		}
471 #endif
472 #ifdef CONFIG_AUTO_COMPLETE
473 		if (cmdtp->complete) {
474 			addr = (ulong)(cmdtp->complete) + gd->reloc_off;
475 			cmdtp->complete =
476 				(int (*)(int, char * const [], char, int, char * []))addr;
477 		}
478 #endif
479 		cmdtp++;
480 	}
481 }
482 #endif
483 
484 /**
485  * Call a command function. This should be the only route in U-Boot to call
486  * a command, so that we can track whether we are waiting for input or
487  * executing a command.
488  *
489  * @param cmdtp		Pointer to the command to execute
490  * @param flag		Some flags normally 0 (see CMD_FLAG_.. above)
491  * @param argc		Number of arguments (arg 0 must be the command text)
492  * @param argv		Arguments
493  * @return 0 if command succeeded, else non-zero (CMD_RET_...)
494  */
cmd_call(cmd_tbl_t * cmdtp,int flag,int argc,char * const argv[])495 static int cmd_call(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
496 {
497 	int result;
498 
499 	result = (cmdtp->cmd)(cmdtp, flag, argc, argv);
500 	if (result)
501 		debug("Command failed, result=%d\n", result);
502 	return result;
503 }
504 
cmd_process(int flag,int argc,char * const argv[],int * repeatable,ulong * ticks)505 enum command_ret_t cmd_process(int flag, int argc, char * const argv[],
506 			       int *repeatable, ulong *ticks)
507 {
508 	enum command_ret_t rc = CMD_RET_SUCCESS;
509 	cmd_tbl_t *cmdtp;
510 
511 	/* Look up command in command table */
512 	cmdtp = find_cmd(argv[0]);
513 	if (cmdtp == NULL) {
514 		printf("Unknown command '%s' - try 'help'\n", argv[0]);
515 		return 1;
516 	}
517 
518 	/* found - check max args */
519 	if (argc > cmdtp->maxargs)
520 		rc = CMD_RET_USAGE;
521 
522 #if defined(CONFIG_CMD_BOOTD)
523 	/* avoid "bootd" recursion */
524 	else if (cmdtp->cmd == do_bootd) {
525 		if (flag & CMD_FLAG_BOOTD) {
526 			puts("'bootd' recursion detected\n");
527 			rc = CMD_RET_FAILURE;
528 		} else {
529 			flag |= CMD_FLAG_BOOTD;
530 		}
531 	}
532 #endif
533 
534 	/* If OK so far, then do the command */
535 	if (!rc) {
536 		if (ticks)
537 			*ticks = get_timer(0);
538 		rc = cmd_call(cmdtp, flag, argc, argv);
539 		if (ticks)
540 			*ticks = get_timer(*ticks);
541 		*repeatable &= cmdtp->repeatable;
542 	}
543 	if (rc == CMD_RET_USAGE)
544 		rc = cmd_usage(cmdtp);
545 	return rc;
546 }
547 
cmd_process_error(cmd_tbl_t * cmdtp,int err)548 int cmd_process_error(cmd_tbl_t *cmdtp, int err)
549 {
550 	if (err) {
551 		printf("Command '%s' failed: Error %d\n", cmdtp->name, err);
552 		return 1;
553 	}
554 
555 	return 0;
556 }
557