blob: 597ab4cb4d83493e1c90d96a85da0669a48a4b8a [file] [log] [blame]
wdenk5dfa25f2002-10-19 19:42:10 +00001/*
Detlev Zundel2dce5512009-03-25 17:27:52 +01002 * (C) Copyright 2000-2009
wdenk5dfa25f2002-10-19 19:42:10 +00003 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 *
Wolfgang Denk1a459662013-07-08 09:37:19 +02005 * SPDX-License-Identifier: GPL-2.0+
wdenk5dfa25f2002-10-19 19:42:10 +00006 */
7
8/*
9 * Command Processor Table
10 */
11
12#include <common.h>
13#include <command.h>
Jason Hobbs4d91a6e2011-08-23 11:06:54 +000014#include <linux/ctype.h>
wdenk5dfa25f2002-10-19 19:42:10 +000015
wdenk5dfa25f2002-10-19 19:42:10 +000016/*
17 * Use puts() instead of printf() to avoid printf buffer overflow
18 * for long help messages
19 */
Detlev Zundel2dce5512009-03-25 17:27:52 +010020
21int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int
Wolfgang Denk54841ab2010-06-28 22:00:46 +020022 flag, int argc, char * const argv[])
wdenk5dfa25f2002-10-19 19:42:10 +000023{
24 int i;
25 int rcode = 0;
26
wdenk8bde7f72003-06-27 21:31:46 +000027 if (argc == 1) { /*show list of commands */
Anatolij Gustschin22b6fcb2012-11-08 12:40:17 +010028 cmd_tbl_t *cmd_array[cmd_items];
wdenk9d2b18a2003-06-28 23:11:04 +000029 int i, j, swaps;
wdenk8bde7f72003-06-27 21:31:46 +000030
wdenk9d2b18a2003-06-28 23:11:04 +000031 /* Make array of commands from .uboot_cmd section */
Detlev Zundel2dce5512009-03-25 17:27:52 +010032 cmdtp = cmd_start;
wdenk9d2b18a2003-06-28 23:11:04 +000033 for (i = 0; i < cmd_items; i++) {
34 cmd_array[i] = cmdtp++;
wdenk8bde7f72003-06-27 21:31:46 +000035 }
wdenk8bde7f72003-06-27 21:31:46 +000036
wdenk9d2b18a2003-06-28 23:11:04 +000037 /* 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 }
wdenk8bde7f72003-06-27 21:31:46 +000049 }
wdenk9d2b18a2003-06-28 23:11:04 +000050 if (!swaps)
51 break;
wdenk8bde7f72003-06-27 21:31:46 +000052 }
53
54 /* print short help (usage) */
wdenk9d2b18a2003-06-28 23:11:04 +000055 for (i = 0; i < cmd_items; i++) {
56 const char *usage = cmd_array[i]->usage;
57
wdenk5dfa25f2002-10-19 19:42:10 +000058 /* allow user abort */
wdenk8bde7f72003-06-27 21:31:46 +000059 if (ctrlc ())
wdenk5dfa25f2002-10-19 19:42:10 +000060 return 1;
wdenk9d2b18a2003-06-28 23:11:04 +000061 if (usage == NULL)
wdenk5dfa25f2002-10-19 19:42:10 +000062 continue;
Peter Tyser2fb26042009-01-27 18:03:12 -060063 printf("%-*s- %s\n", CONFIG_SYS_HELP_CMD_WIDTH,
64 cmd_array[i]->name, usage);
wdenk5dfa25f2002-10-19 19:42:10 +000065 }
wdenk5dfa25f2002-10-19 19:42:10 +000066 return 0;
67 }
wdenk5dfa25f2002-10-19 19:42:10 +000068 /*
69 * command help (long version)
70 */
wdenk8bde7f72003-06-27 21:31:46 +000071 for (i = 1; i < argc; ++i) {
Detlev Zundel2dce5512009-03-25 17:27:52 +010072 if ((cmdtp = find_cmd_tbl (argv[i], cmd_start, cmd_items )) != NULL) {
Wolfgang Denk94796d82009-05-24 19:17:29 +020073 rcode |= cmd_usage(cmdtp);
wdenk71f95112003-06-15 22:40:42 +000074 } else {
wdenk5dfa25f2002-10-19 19:42:10 +000075 printf ("Unknown command '%s' - try 'help'"
76 " without arguments for list of all"
wdenk8bde7f72003-06-27 21:31:46 +000077 " known commands\n\n", argv[i]
78 );
wdenk5dfa25f2002-10-19 19:42:10 +000079 rcode = 1;
80 }
81 }
82 return rcode;
83}
84
85/***************************************************************************
86 * find command table entry for a command
87 */
Kumar Galab799cb42008-09-23 10:05:02 -050088cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len)
wdenk5dfa25f2002-10-19 19:42:10 +000089{
90 cmd_tbl_t *cmdtp;
Kumar Galab799cb42008-09-23 10:05:02 -050091 cmd_tbl_t *cmdtp_temp = table; /*Init value */
wdenk9d2b18a2003-06-28 23:11:04 +000092 const char *p;
93 int len;
94 int n_found = 0;
wdenk8bde7f72003-06-27 21:31:46 +000095
Thomas Weber7013c062010-11-24 13:07:51 +010096 if (!cmd)
97 return NULL;
wdenk9d2b18a2003-06-28 23:11:04 +000098 /*
99 * Some commands allow length modifiers (like "cp.b");
100 * compare command name only until first dot.
101 */
102 len = ((p = strchr(cmd, '.')) == NULL) ? strlen (cmd) : (p - cmd);
103
Kumar Galab799cb42008-09-23 10:05:02 -0500104 for (cmdtp = table;
105 cmdtp != table + table_len;
wdenk9d2b18a2003-06-28 23:11:04 +0000106 cmdtp++) {
107 if (strncmp (cmd, cmdtp->name, len) == 0) {
108 if (len == strlen (cmdtp->name))
109 return cmdtp; /* full match */
110
111 cmdtp_temp = cmdtp; /* abbreviated command ? */
112 n_found++;
113 }
wdenk5dfa25f2002-10-19 19:42:10 +0000114 }
wdenk9d2b18a2003-06-28 23:11:04 +0000115 if (n_found == 1) { /* exactly one match */
wdenk8bde7f72003-06-27 21:31:46 +0000116 return cmdtp_temp;
wdenk9d2b18a2003-06-28 23:11:04 +0000117 }
wdenk8bde7f72003-06-27 21:31:46 +0000118
wdenk9d2b18a2003-06-28 23:11:04 +0000119 return NULL; /* not found or ambiguous command */
wdenk5dfa25f2002-10-19 19:42:10 +0000120}
wdenk04a85b32004-04-15 18:22:41 +0000121
Kumar Galab799cb42008-09-23 10:05:02 -0500122cmd_tbl_t *find_cmd (const char *cmd)
123{
Marek Vasut6c7c9462012-10-12 10:27:04 +0000124 cmd_tbl_t *start = ll_entry_start(cmd_tbl_t, cmd);
125 const int len = ll_entry_count(cmd_tbl_t, cmd);
126 return find_cmd_tbl(cmd, start, len);
Kumar Galab799cb42008-09-23 10:05:02 -0500127}
128
Mike Frysingere84ffdd2011-04-23 23:43:24 +0000129int cmd_usage(const cmd_tbl_t *cmdtp)
Peter Tyser62c3ae72009-01-27 18:03:10 -0600130{
Wolfgang Denk94796d82009-05-24 19:17:29 +0200131 printf("%s - %s\n\n", cmdtp->name, cmdtp->usage);
132
133#ifdef CONFIG_SYS_LONGHELP
134 printf("Usage:\n%s ", cmdtp->name);
135
136 if (!cmdtp->help) {
137 puts ("- No additional help available.\n");
138 return 1;
139 }
140
141 puts (cmdtp->help);
142 putc ('\n');
143#endif /* CONFIG_SYS_LONGHELP */
Wolfgang Denk47e26b12010-07-17 01:06:04 +0200144 return 1;
Peter Tyser62c3ae72009-01-27 18:03:10 -0600145}
146
wdenk04a85b32004-04-15 18:22:41 +0000147#ifdef CONFIG_AUTO_COMPLETE
148
Wolfgang Denk54841ab2010-06-28 22:00:46 +0200149int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[])
wdenk04a85b32004-04-15 18:22:41 +0000150{
151 static char tmp_buf[512];
152 int space;
153
Jason Hobbs4d91a6e2011-08-23 11:06:54 +0000154 space = last_char == '\0' || isblank(last_char);
wdenk04a85b32004-04-15 18:22:41 +0000155
156 if (space && argc == 1)
157 return env_complete("", maxv, cmdv, sizeof(tmp_buf), tmp_buf);
158
159 if (!space && argc == 2)
160 return env_complete(argv[1], maxv, cmdv, sizeof(tmp_buf), tmp_buf);
Mike Frysinger560d4242010-12-17 16:51:59 -0500161
wdenk04a85b32004-04-15 18:22:41 +0000162 return 0;
163}
164
wdenk04a85b32004-04-15 18:22:41 +0000165/*************************************************************************************/
166
Wolfgang Denk54841ab2010-06-28 22:00:46 +0200167static int complete_cmdv(int argc, char * const argv[], char last_char, int maxv, char *cmdv[])
wdenk04a85b32004-04-15 18:22:41 +0000168{
Marek Vasut6c7c9462012-10-12 10:27:04 +0000169 cmd_tbl_t *cmdtp = ll_entry_start(cmd_tbl_t, cmd);
170 const int count = ll_entry_count(cmd_tbl_t, cmd);
171 const cmd_tbl_t *cmdend = cmdtp + count;
wdenk04a85b32004-04-15 18:22:41 +0000172 const char *p;
173 int len, clen;
174 int n_found = 0;
175 const char *cmd;
176
177 /* sanity? */
178 if (maxv < 2)
179 return -2;
180
181 cmdv[0] = NULL;
182
183 if (argc == 0) {
184 /* output full list of commands */
Marek Vasut6c7c9462012-10-12 10:27:04 +0000185 for (; cmdtp != cmdend; cmdtp++) {
wdenk04a85b32004-04-15 18:22:41 +0000186 if (n_found >= maxv - 2) {
Andrew Gabbasov9b438942013-12-27 10:05:14 -0600187 cmdv[n_found++] = "...";
wdenk04a85b32004-04-15 18:22:41 +0000188 break;
189 }
Andrew Gabbasov9b438942013-12-27 10:05:14 -0600190 cmdv[n_found++] = cmdtp->name;
wdenk04a85b32004-04-15 18:22:41 +0000191 }
192 cmdv[n_found] = NULL;
193 return n_found;
194 }
195
196 /* more than one arg or one but the start of the next */
Jason Hobbs4d91a6e2011-08-23 11:06:54 +0000197 if (argc > 1 || (last_char == '\0' || isblank(last_char))) {
wdenk04a85b32004-04-15 18:22:41 +0000198 cmdtp = find_cmd(argv[0]);
199 if (cmdtp == NULL || cmdtp->complete == NULL) {
200 cmdv[0] = NULL;
201 return 0;
202 }
203 return (*cmdtp->complete)(argc, argv, last_char, maxv, cmdv);
204 }
205
206 cmd = argv[0];
207 /*
208 * Some commands allow length modifiers (like "cp.b");
209 * compare command name only until first dot.
210 */
211 p = strchr(cmd, '.');
212 if (p == NULL)
213 len = strlen(cmd);
214 else
215 len = p - cmd;
216
217 /* return the partial matches */
Marek Vasut6c7c9462012-10-12 10:27:04 +0000218 for (; cmdtp != cmdend; cmdtp++) {
wdenk04a85b32004-04-15 18:22:41 +0000219
220 clen = strlen(cmdtp->name);
221 if (clen < len)
222 continue;
223
224 if (memcmp(cmd, cmdtp->name, len) != 0)
225 continue;
226
227 /* too many! */
228 if (n_found >= maxv - 2) {
229 cmdv[n_found++] = "...";
230 break;
231 }
232
233 cmdv[n_found++] = cmdtp->name;
234 }
235
236 cmdv[n_found] = NULL;
237 return n_found;
238}
239
240static int make_argv(char *s, int argvsz, char *argv[])
241{
242 int argc = 0;
243
244 /* split into argv */
245 while (argc < argvsz - 1) {
246
247 /* skip any white space */
Jason Hobbs4d91a6e2011-08-23 11:06:54 +0000248 while (isblank(*s))
wdenk04a85b32004-04-15 18:22:41 +0000249 ++s;
250
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200251 if (*s == '\0') /* end of s, no more args */
wdenk04a85b32004-04-15 18:22:41 +0000252 break;
253
254 argv[argc++] = s; /* begin of argument string */
255
256 /* find end of string */
Jason Hobbs4d91a6e2011-08-23 11:06:54 +0000257 while (*s && !isblank(*s))
wdenk04a85b32004-04-15 18:22:41 +0000258 ++s;
259
260 if (*s == '\0') /* end of s, no more args */
261 break;
262
263 *s++ = '\0'; /* terminate current arg */
264 }
265 argv[argc] = NULL;
266
267 return argc;
268}
269
Wolfgang Denk54841ab2010-06-28 22:00:46 +0200270static void print_argv(const char *banner, const char *leader, const char *sep, int linemax, char * const argv[])
wdenk04a85b32004-04-15 18:22:41 +0000271{
272 int ll = leader != NULL ? strlen(leader) : 0;
273 int sl = sep != NULL ? strlen(sep) : 0;
274 int len, i;
275
276 if (banner) {
277 puts("\n");
278 puts(banner);
279 }
280
281 i = linemax; /* force leader and newline */
282 while (*argv != NULL) {
283 len = strlen(*argv) + sl;
284 if (i + len >= linemax) {
285 puts("\n");
286 if (leader)
287 puts(leader);
288 i = ll - sl;
289 } else if (sep)
290 puts(sep);
291 puts(*argv++);
292 i += len;
293 }
294 printf("\n");
295}
296
Wolfgang Denk54841ab2010-06-28 22:00:46 +0200297static int find_common_prefix(char * const argv[])
wdenk04a85b32004-04-15 18:22:41 +0000298{
299 int i, len;
300 char *anchor, *s, *t;
301
302 if (*argv == NULL)
303 return 0;
304
305 /* begin with max */
306 anchor = *argv++;
307 len = strlen(anchor);
308 while ((t = *argv++) != NULL) {
309 s = anchor;
310 for (i = 0; i < len; i++, t++, s++) {
311 if (*t != *s)
312 break;
313 }
314 len = s - anchor;
315 }
316 return len;
317}
318
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200319static char tmp_buf[CONFIG_SYS_CBSIZE]; /* copy of console I/O buffer */
wdenk04a85b32004-04-15 18:22:41 +0000320
321int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp)
322{
323 int n = *np, col = *colp;
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200324 char *argv[CONFIG_SYS_MAXARGS + 1]; /* NULL terminated */
wdenk04a85b32004-04-15 18:22:41 +0000325 char *cmdv[20];
326 char *s, *t;
327 const char *sep;
328 int i, j, k, len, seplen, argc;
329 int cnt;
330 char last_char;
331
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200332 if (strcmp(prompt, CONFIG_SYS_PROMPT) != 0)
wdenk04a85b32004-04-15 18:22:41 +0000333 return 0; /* not in normal console */
334
335 cnt = strlen(buf);
336 if (cnt >= 1)
337 last_char = buf[cnt - 1];
338 else
339 last_char = '\0';
340
341 /* copy to secondary buffer which will be affected */
342 strcpy(tmp_buf, buf);
343
344 /* separate into argv */
345 argc = make_argv(tmp_buf, sizeof(argv)/sizeof(argv[0]), argv);
346
347 /* do the completion and return the possible completions */
348 i = complete_cmdv(argc, argv, last_char, sizeof(cmdv)/sizeof(cmdv[0]), cmdv);
349
350 /* no match; bell and out */
351 if (i == 0) {
352 if (argc > 1) /* allow tab for non command */
353 return 0;
354 putc('\a');
355 return 1;
356 }
357
358 s = NULL;
359 len = 0;
360 sep = NULL;
361 seplen = 0;
362 if (i == 1) { /* one match; perfect */
363 k = strlen(argv[argc - 1]);
364 s = cmdv[0] + k;
365 len = strlen(s);
366 sep = " ";
367 seplen = 1;
368 } else if (i > 1 && (j = find_common_prefix(cmdv)) != 0) { /* more */
369 k = strlen(argv[argc - 1]);
370 j -= k;
371 if (j > 0) {
372 s = cmdv[0] + k;
373 len = j;
374 }
375 }
376
377 if (s != NULL) {
378 k = len + seplen;
379 /* make sure it fits */
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200380 if (n + k >= CONFIG_SYS_CBSIZE - 2) {
wdenk04a85b32004-04-15 18:22:41 +0000381 putc('\a');
382 return 1;
383 }
384
385 t = buf + cnt;
386 for (i = 0; i < len; i++)
387 *t++ = *s++;
388 if (sep != NULL)
389 for (i = 0; i < seplen; i++)
390 *t++ = sep[i];
391 *t = '\0';
392 n += k;
393 col += k;
394 puts(t - k);
395 if (sep == NULL)
396 putc('\a');
397 *np = n;
398 *colp = col;
399 } else {
400 print_argv(NULL, " ", " ", 78, cmdv);
401
402 puts(prompt);
403 puts(buf);
404 }
405 return 1;
406}
407
408#endif
Jean-Christophe PLAGNIOL-VILLARD8a40fb12008-09-10 22:48:05 +0200409
410#ifdef CMD_DATA_SIZE
411int cmd_get_data_size(char* arg, int default_size)
412{
413 /* Check for a size specification .b, .w or .l.
414 */
415 int len = strlen(arg);
416 if (len > 2 && arg[len-2] == '.') {
417 switch(arg[len-1]) {
418 case 'b':
419 return 1;
420 case 'w':
421 return 2;
422 case 'l':
423 return 4;
424 case 's':
425 return -2;
426 default:
427 return -1;
428 }
429 }
430 return default_size;
431}
432#endif
Heiko Schocher620f1f62010-09-17 13:10:33 +0200433
Wolfgang Denk2e5167c2010-10-28 20:00:11 +0200434#if defined(CONFIG_NEEDS_MANUAL_RELOC)
Heiko Schocher620f1f62010-09-17 13:10:33 +0200435DECLARE_GLOBAL_DATA_PTR;
436
437void fixup_cmdtable(cmd_tbl_t *cmdtp, int size)
438{
439 int i;
440
441 if (gd->reloc_off == 0)
442 return;
443
444 for (i = 0; i < size; i++) {
445 ulong addr;
446
447 addr = (ulong) (cmdtp->cmd) + gd->reloc_off;
448#if DEBUG_COMMANDS
449 printf("Command \"%s\": 0x%08lx => 0x%08lx\n",
450 cmdtp->name, (ulong) (cmdtp->cmd), addr);
451#endif
452 cmdtp->cmd =
453 (int (*)(struct cmd_tbl_s *, int, int, char * const []))addr;
454 addr = (ulong)(cmdtp->name) + gd->reloc_off;
455 cmdtp->name = (char *)addr;
456 if (cmdtp->usage) {
457 addr = (ulong)(cmdtp->usage) + gd->reloc_off;
458 cmdtp->usage = (char *)addr;
459 }
460#ifdef CONFIG_SYS_LONGHELP
461 if (cmdtp->help) {
462 addr = (ulong)(cmdtp->help) + gd->reloc_off;
463 cmdtp->help = (char *)addr;
464 }
465#endif
Daniel Schwierzeckfa28bd22011-10-13 06:07:39 +0000466#ifdef CONFIG_AUTO_COMPLETE
467 if (cmdtp->complete) {
468 addr = (ulong)(cmdtp->complete) + gd->reloc_off;
Daniel Schwierzeck3668d8f2011-10-18 11:12:22 +0000469 cmdtp->complete =
470 (int (*)(int, char * const [], char, int, char * []))addr;
Daniel Schwierzeckfa28bd22011-10-13 06:07:39 +0000471 }
472#endif
Heiko Schocher620f1f62010-09-17 13:10:33 +0200473 cmdtp++;
474 }
475}
476#endif
Simon Glassbdf8e342012-02-14 19:59:23 +0000477
478/**
479 * Call a command function. This should be the only route in U-Boot to call
480 * a command, so that we can track whether we are waiting for input or
481 * executing a command.
482 *
483 * @param cmdtp Pointer to the command to execute
484 * @param flag Some flags normally 0 (see CMD_FLAG_.. above)
485 * @param argc Number of arguments (arg 0 must be the command text)
486 * @param argv Arguments
487 * @return 0 if command succeeded, else non-zero (CMD_RET_...)
488 */
Simon Glass9d12d5d2012-02-14 19:59:25 +0000489static int cmd_call(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
Simon Glassbdf8e342012-02-14 19:59:23 +0000490{
491 int result;
492
493 result = (cmdtp->cmd)(cmdtp, flag, argc, argv);
494 if (result)
495 debug("Command failed, result=%d", result);
496 return result;
497}
Simon Glass9d12d5d2012-02-14 19:59:25 +0000498
499enum command_ret_t cmd_process(int flag, int argc, char * const argv[],
Richard Genoud34765e82012-12-03 06:28:28 +0000500 int *repeatable, ulong *ticks)
Simon Glass9d12d5d2012-02-14 19:59:25 +0000501{
502 enum command_ret_t rc = CMD_RET_SUCCESS;
503 cmd_tbl_t *cmdtp;
504
505 /* Look up command in command table */
506 cmdtp = find_cmd(argv[0]);
507 if (cmdtp == NULL) {
508 printf("Unknown command '%s' - try 'help'\n", argv[0]);
509 return 1;
510 }
511
512 /* found - check max args */
513 if (argc > cmdtp->maxargs)
514 rc = CMD_RET_USAGE;
515
516#if defined(CONFIG_CMD_BOOTD)
517 /* avoid "bootd" recursion */
518 else if (cmdtp->cmd == do_bootd) {
519 if (flag & CMD_FLAG_BOOTD) {
520 puts("'bootd' recursion detected\n");
521 rc = CMD_RET_FAILURE;
522 } else {
523 flag |= CMD_FLAG_BOOTD;
524 }
525 }
526#endif
527
528 /* If OK so far, then do the command */
529 if (!rc) {
Richard Genoud34765e82012-12-03 06:28:28 +0000530 if (ticks)
531 *ticks = get_timer(0);
Simon Glass9d12d5d2012-02-14 19:59:25 +0000532 rc = cmd_call(cmdtp, flag, argc, argv);
Richard Genoud34765e82012-12-03 06:28:28 +0000533 if (ticks)
534 *ticks = get_timer(*ticks);
Simon Glass9d12d5d2012-02-14 19:59:25 +0000535 *repeatable &= cmdtp->repeatable;
536 }
537 if (rc == CMD_RET_USAGE)
538 rc = cmd_usage(cmdtp);
539 return rc;
540}