blob: 0020eacf5c46fe8d8da0617e4c449df03ad9e757 [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 *
5 * See file CREDITS for list of people who contributed to this
6 * project.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License as
10 * published by the Free Software Foundation; either version 2 of
11 * the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21 * MA 02111-1307 USA
22 */
23
24/*
25 * Command Processor Table
26 */
27
28#include <common.h>
29#include <command.h>
wdenk5dfa25f2002-10-19 19:42:10 +000030
wdenk5dfa25f2002-10-19 19:42:10 +000031/*
32 * Use puts() instead of printf() to avoid printf buffer overflow
33 * for long help messages
34 */
Detlev Zundel2dce5512009-03-25 17:27:52 +010035
36int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int
Wolfgang Denk54841ab2010-06-28 22:00:46 +020037 flag, int argc, char * const argv[])
wdenk5dfa25f2002-10-19 19:42:10 +000038{
39 int i;
40 int rcode = 0;
41
wdenk8bde7f72003-06-27 21:31:46 +000042 if (argc == 1) { /*show list of commands */
wdenk9d2b18a2003-06-28 23:11:04 +000043 cmd_tbl_t *cmd_array[cmd_items];
44 int i, j, swaps;
wdenk8bde7f72003-06-27 21:31:46 +000045
wdenk9d2b18a2003-06-28 23:11:04 +000046 /* Make array of commands from .uboot_cmd section */
Detlev Zundel2dce5512009-03-25 17:27:52 +010047 cmdtp = cmd_start;
wdenk9d2b18a2003-06-28 23:11:04 +000048 for (i = 0; i < cmd_items; i++) {
49 cmd_array[i] = cmdtp++;
wdenk8bde7f72003-06-27 21:31:46 +000050 }
wdenk8bde7f72003-06-27 21:31:46 +000051
wdenk9d2b18a2003-06-28 23:11:04 +000052 /* Sort command list (trivial bubble sort) */
53 for (i = cmd_items - 1; i > 0; --i) {
54 swaps = 0;
55 for (j = 0; j < i; ++j) {
56 if (strcmp (cmd_array[j]->name,
57 cmd_array[j + 1]->name) > 0) {
58 cmd_tbl_t *tmp;
59 tmp = cmd_array[j];
60 cmd_array[j] = cmd_array[j + 1];
61 cmd_array[j + 1] = tmp;
62 ++swaps;
63 }
wdenk8bde7f72003-06-27 21:31:46 +000064 }
wdenk9d2b18a2003-06-28 23:11:04 +000065 if (!swaps)
66 break;
wdenk8bde7f72003-06-27 21:31:46 +000067 }
68
69 /* print short help (usage) */
wdenk9d2b18a2003-06-28 23:11:04 +000070 for (i = 0; i < cmd_items; i++) {
71 const char *usage = cmd_array[i]->usage;
72
wdenk5dfa25f2002-10-19 19:42:10 +000073 /* allow user abort */
wdenk8bde7f72003-06-27 21:31:46 +000074 if (ctrlc ())
wdenk5dfa25f2002-10-19 19:42:10 +000075 return 1;
wdenk9d2b18a2003-06-28 23:11:04 +000076 if (usage == NULL)
wdenk5dfa25f2002-10-19 19:42:10 +000077 continue;
Peter Tyser2fb26042009-01-27 18:03:12 -060078 printf("%-*s- %s\n", CONFIG_SYS_HELP_CMD_WIDTH,
79 cmd_array[i]->name, usage);
wdenk5dfa25f2002-10-19 19:42:10 +000080 }
wdenk5dfa25f2002-10-19 19:42:10 +000081 return 0;
82 }
wdenk5dfa25f2002-10-19 19:42:10 +000083 /*
84 * command help (long version)
85 */
wdenk8bde7f72003-06-27 21:31:46 +000086 for (i = 1; i < argc; ++i) {
Detlev Zundel2dce5512009-03-25 17:27:52 +010087 if ((cmdtp = find_cmd_tbl (argv[i], cmd_start, cmd_items )) != NULL) {
Wolfgang Denk94796d82009-05-24 19:17:29 +020088 rcode |= cmd_usage(cmdtp);
wdenk71f95112003-06-15 22:40:42 +000089 } else {
wdenk5dfa25f2002-10-19 19:42:10 +000090 printf ("Unknown command '%s' - try 'help'"
91 " without arguments for list of all"
wdenk8bde7f72003-06-27 21:31:46 +000092 " known commands\n\n", argv[i]
93 );
wdenk5dfa25f2002-10-19 19:42:10 +000094 rcode = 1;
95 }
96 }
97 return rcode;
98}
99
100/***************************************************************************
101 * find command table entry for a command
102 */
Kumar Galab799cb42008-09-23 10:05:02 -0500103cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len)
wdenk5dfa25f2002-10-19 19:42:10 +0000104{
105 cmd_tbl_t *cmdtp;
Kumar Galab799cb42008-09-23 10:05:02 -0500106 cmd_tbl_t *cmdtp_temp = table; /*Init value */
wdenk9d2b18a2003-06-28 23:11:04 +0000107 const char *p;
108 int len;
109 int n_found = 0;
wdenk8bde7f72003-06-27 21:31:46 +0000110
wdenk9d2b18a2003-06-28 23:11:04 +0000111 /*
112 * Some commands allow length modifiers (like "cp.b");
113 * compare command name only until first dot.
114 */
115 len = ((p = strchr(cmd, '.')) == NULL) ? strlen (cmd) : (p - cmd);
116
Kumar Galab799cb42008-09-23 10:05:02 -0500117 for (cmdtp = table;
118 cmdtp != table + table_len;
wdenk9d2b18a2003-06-28 23:11:04 +0000119 cmdtp++) {
120 if (strncmp (cmd, cmdtp->name, len) == 0) {
121 if (len == strlen (cmdtp->name))
122 return cmdtp; /* full match */
123
124 cmdtp_temp = cmdtp; /* abbreviated command ? */
125 n_found++;
126 }
wdenk5dfa25f2002-10-19 19:42:10 +0000127 }
wdenk9d2b18a2003-06-28 23:11:04 +0000128 if (n_found == 1) { /* exactly one match */
wdenk8bde7f72003-06-27 21:31:46 +0000129 return cmdtp_temp;
wdenk9d2b18a2003-06-28 23:11:04 +0000130 }
wdenk8bde7f72003-06-27 21:31:46 +0000131
wdenk9d2b18a2003-06-28 23:11:04 +0000132 return NULL; /* not found or ambiguous command */
wdenk5dfa25f2002-10-19 19:42:10 +0000133}
wdenk04a85b32004-04-15 18:22:41 +0000134
Kumar Galab799cb42008-09-23 10:05:02 -0500135cmd_tbl_t *find_cmd (const char *cmd)
136{
137 int len = &__u_boot_cmd_end - &__u_boot_cmd_start;
138 return find_cmd_tbl(cmd, &__u_boot_cmd_start, len);
139}
140
Wolfgang Denk94796d82009-05-24 19:17:29 +0200141int cmd_usage(cmd_tbl_t *cmdtp)
Peter Tyser62c3ae72009-01-27 18:03:10 -0600142{
Wolfgang Denk94796d82009-05-24 19:17:29 +0200143 printf("%s - %s\n\n", cmdtp->name, cmdtp->usage);
144
145#ifdef CONFIG_SYS_LONGHELP
146 printf("Usage:\n%s ", cmdtp->name);
147
148 if (!cmdtp->help) {
149 puts ("- No additional help available.\n");
150 return 1;
151 }
152
153 puts (cmdtp->help);
154 putc ('\n');
155#endif /* CONFIG_SYS_LONGHELP */
Wolfgang Denk47e26b12010-07-17 01:06:04 +0200156 return 1;
Peter Tyser62c3ae72009-01-27 18:03:10 -0600157}
158
wdenk04a85b32004-04-15 18:22:41 +0000159#ifdef CONFIG_AUTO_COMPLETE
160
Wolfgang Denk54841ab2010-06-28 22:00:46 +0200161int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[])
wdenk04a85b32004-04-15 18:22:41 +0000162{
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200163#if 0 /* need to reimplement */
wdenk04a85b32004-04-15 18:22:41 +0000164 static char tmp_buf[512];
165 int space;
166
167 space = last_char == '\0' || last_char == ' ' || last_char == '\t';
168
169 if (space && argc == 1)
170 return env_complete("", maxv, cmdv, sizeof(tmp_buf), tmp_buf);
171
172 if (!space && argc == 2)
173 return env_complete(argv[1], maxv, cmdv, sizeof(tmp_buf), tmp_buf);
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200174#endif
wdenk04a85b32004-04-15 18:22:41 +0000175 return 0;
176}
177
178static void install_auto_complete_handler(const char *cmd,
Wolfgang Denk54841ab2010-06-28 22:00:46 +0200179 int (*complete)(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]))
wdenk04a85b32004-04-15 18:22:41 +0000180{
181 cmd_tbl_t *cmdtp;
182
183 cmdtp = find_cmd(cmd);
184 if (cmdtp == NULL)
185 return;
186
187 cmdtp->complete = complete;
188}
189
190void install_auto_complete(void)
191{
Trübenbach, Ralf39f7aac2010-04-14 11:15:16 +0200192#if defined(CONFIG_CMD_EDITENV)
193 install_auto_complete_handler("editenv", var_complete);
194#endif
wdenk04a85b32004-04-15 18:22:41 +0000195 install_auto_complete_handler("printenv", var_complete);
196 install_auto_complete_handler("setenv", var_complete);
Jon Loeligerc3517f92007-07-08 18:10:08 -0500197#if defined(CONFIG_CMD_RUN)
wdenk04a85b32004-04-15 18:22:41 +0000198 install_auto_complete_handler("run", var_complete);
199#endif
200}
201
202/*************************************************************************************/
203
Wolfgang Denk54841ab2010-06-28 22:00:46 +0200204static int complete_cmdv(int argc, char * const argv[], char last_char, int maxv, char *cmdv[])
wdenk04a85b32004-04-15 18:22:41 +0000205{
206 cmd_tbl_t *cmdtp;
207 const char *p;
208 int len, clen;
209 int n_found = 0;
210 const char *cmd;
211
212 /* sanity? */
213 if (maxv < 2)
214 return -2;
215
216 cmdv[0] = NULL;
217
218 if (argc == 0) {
219 /* output full list of commands */
220 for (cmdtp = &__u_boot_cmd_start; cmdtp != &__u_boot_cmd_end; cmdtp++) {
221 if (n_found >= maxv - 2) {
222 cmdv[n_found++] = "...";
223 break;
224 }
225 cmdv[n_found++] = cmdtp->name;
226 }
227 cmdv[n_found] = NULL;
228 return n_found;
229 }
230
231 /* more than one arg or one but the start of the next */
232 if (argc > 1 || (last_char == '\0' || last_char == ' ' || last_char == '\t')) {
233 cmdtp = find_cmd(argv[0]);
234 if (cmdtp == NULL || cmdtp->complete == NULL) {
235 cmdv[0] = NULL;
236 return 0;
237 }
238 return (*cmdtp->complete)(argc, argv, last_char, maxv, cmdv);
239 }
240
241 cmd = argv[0];
242 /*
243 * Some commands allow length modifiers (like "cp.b");
244 * compare command name only until first dot.
245 */
246 p = strchr(cmd, '.');
247 if (p == NULL)
248 len = strlen(cmd);
249 else
250 len = p - cmd;
251
252 /* return the partial matches */
253 for (cmdtp = &__u_boot_cmd_start; cmdtp != &__u_boot_cmd_end; cmdtp++) {
254
255 clen = strlen(cmdtp->name);
256 if (clen < len)
257 continue;
258
259 if (memcmp(cmd, cmdtp->name, len) != 0)
260 continue;
261
262 /* too many! */
263 if (n_found >= maxv - 2) {
264 cmdv[n_found++] = "...";
265 break;
266 }
267
268 cmdv[n_found++] = cmdtp->name;
269 }
270
271 cmdv[n_found] = NULL;
272 return n_found;
273}
274
275static int make_argv(char *s, int argvsz, char *argv[])
276{
277 int argc = 0;
278
279 /* split into argv */
280 while (argc < argvsz - 1) {
281
282 /* skip any white space */
283 while ((*s == ' ') || (*s == '\t'))
284 ++s;
285
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200286 if (*s == '\0') /* end of s, no more args */
wdenk04a85b32004-04-15 18:22:41 +0000287 break;
288
289 argv[argc++] = s; /* begin of argument string */
290
291 /* find end of string */
292 while (*s && (*s != ' ') && (*s != '\t'))
293 ++s;
294
295 if (*s == '\0') /* end of s, no more args */
296 break;
297
298 *s++ = '\0'; /* terminate current arg */
299 }
300 argv[argc] = NULL;
301
302 return argc;
303}
304
Wolfgang Denk54841ab2010-06-28 22:00:46 +0200305static void print_argv(const char *banner, const char *leader, const char *sep, int linemax, char * const argv[])
wdenk04a85b32004-04-15 18:22:41 +0000306{
307 int ll = leader != NULL ? strlen(leader) : 0;
308 int sl = sep != NULL ? strlen(sep) : 0;
309 int len, i;
310
311 if (banner) {
312 puts("\n");
313 puts(banner);
314 }
315
316 i = linemax; /* force leader and newline */
317 while (*argv != NULL) {
318 len = strlen(*argv) + sl;
319 if (i + len >= linemax) {
320 puts("\n");
321 if (leader)
322 puts(leader);
323 i = ll - sl;
324 } else if (sep)
325 puts(sep);
326 puts(*argv++);
327 i += len;
328 }
329 printf("\n");
330}
331
Wolfgang Denk54841ab2010-06-28 22:00:46 +0200332static int find_common_prefix(char * const argv[])
wdenk04a85b32004-04-15 18:22:41 +0000333{
334 int i, len;
335 char *anchor, *s, *t;
336
337 if (*argv == NULL)
338 return 0;
339
340 /* begin with max */
341 anchor = *argv++;
342 len = strlen(anchor);
343 while ((t = *argv++) != NULL) {
344 s = anchor;
345 for (i = 0; i < len; i++, t++, s++) {
346 if (*t != *s)
347 break;
348 }
349 len = s - anchor;
350 }
351 return len;
352}
353
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200354static char tmp_buf[CONFIG_SYS_CBSIZE]; /* copy of console I/O buffer */
wdenk04a85b32004-04-15 18:22:41 +0000355
356int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp)
357{
358 int n = *np, col = *colp;
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200359 char *argv[CONFIG_SYS_MAXARGS + 1]; /* NULL terminated */
wdenk04a85b32004-04-15 18:22:41 +0000360 char *cmdv[20];
361 char *s, *t;
362 const char *sep;
363 int i, j, k, len, seplen, argc;
364 int cnt;
365 char last_char;
366
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200367 if (strcmp(prompt, CONFIG_SYS_PROMPT) != 0)
wdenk04a85b32004-04-15 18:22:41 +0000368 return 0; /* not in normal console */
369
370 cnt = strlen(buf);
371 if (cnt >= 1)
372 last_char = buf[cnt - 1];
373 else
374 last_char = '\0';
375
376 /* copy to secondary buffer which will be affected */
377 strcpy(tmp_buf, buf);
378
379 /* separate into argv */
380 argc = make_argv(tmp_buf, sizeof(argv)/sizeof(argv[0]), argv);
381
382 /* do the completion and return the possible completions */
383 i = complete_cmdv(argc, argv, last_char, sizeof(cmdv)/sizeof(cmdv[0]), cmdv);
384
385 /* no match; bell and out */
386 if (i == 0) {
387 if (argc > 1) /* allow tab for non command */
388 return 0;
389 putc('\a');
390 return 1;
391 }
392
393 s = NULL;
394 len = 0;
395 sep = NULL;
396 seplen = 0;
397 if (i == 1) { /* one match; perfect */
398 k = strlen(argv[argc - 1]);
399 s = cmdv[0] + k;
400 len = strlen(s);
401 sep = " ";
402 seplen = 1;
403 } else if (i > 1 && (j = find_common_prefix(cmdv)) != 0) { /* more */
404 k = strlen(argv[argc - 1]);
405 j -= k;
406 if (j > 0) {
407 s = cmdv[0] + k;
408 len = j;
409 }
410 }
411
412 if (s != NULL) {
413 k = len + seplen;
414 /* make sure it fits */
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200415 if (n + k >= CONFIG_SYS_CBSIZE - 2) {
wdenk04a85b32004-04-15 18:22:41 +0000416 putc('\a');
417 return 1;
418 }
419
420 t = buf + cnt;
421 for (i = 0; i < len; i++)
422 *t++ = *s++;
423 if (sep != NULL)
424 for (i = 0; i < seplen; i++)
425 *t++ = sep[i];
426 *t = '\0';
427 n += k;
428 col += k;
429 puts(t - k);
430 if (sep == NULL)
431 putc('\a');
432 *np = n;
433 *colp = col;
434 } else {
435 print_argv(NULL, " ", " ", 78, cmdv);
436
437 puts(prompt);
438 puts(buf);
439 }
440 return 1;
441}
442
443#endif
Jean-Christophe PLAGNIOL-VILLARD8a40fb12008-09-10 22:48:05 +0200444
445#ifdef CMD_DATA_SIZE
446int cmd_get_data_size(char* arg, int default_size)
447{
448 /* Check for a size specification .b, .w or .l.
449 */
450 int len = strlen(arg);
451 if (len > 2 && arg[len-2] == '.') {
452 switch(arg[len-1]) {
453 case 'b':
454 return 1;
455 case 'w':
456 return 2;
457 case 'l':
458 return 4;
459 case 's':
460 return -2;
461 default:
462 return -1;
463 }
464 }
465 return default_size;
466}
467#endif
Heiko Schocher620f1f62010-09-17 13:10:33 +0200468
Wolfgang Denk2e5167c2010-10-28 20:00:11 +0200469#if defined(CONFIG_NEEDS_MANUAL_RELOC)
Heiko Schocher620f1f62010-09-17 13:10:33 +0200470DECLARE_GLOBAL_DATA_PTR;
471
472void fixup_cmdtable(cmd_tbl_t *cmdtp, int size)
473{
474 int i;
475
476 if (gd->reloc_off == 0)
477 return;
478
479 for (i = 0; i < size; i++) {
480 ulong addr;
481
482 addr = (ulong) (cmdtp->cmd) + gd->reloc_off;
483#if DEBUG_COMMANDS
484 printf("Command \"%s\": 0x%08lx => 0x%08lx\n",
485 cmdtp->name, (ulong) (cmdtp->cmd), addr);
486#endif
487 cmdtp->cmd =
488 (int (*)(struct cmd_tbl_s *, int, int, char * const []))addr;
489 addr = (ulong)(cmdtp->name) + gd->reloc_off;
490 cmdtp->name = (char *)addr;
491 if (cmdtp->usage) {
492 addr = (ulong)(cmdtp->usage) + gd->reloc_off;
493 cmdtp->usage = (char *)addr;
494 }
495#ifdef CONFIG_SYS_LONGHELP
496 if (cmdtp->help) {
497 addr = (ulong)(cmdtp->help) + gd->reloc_off;
498 cmdtp->help = (char *)addr;
499 }
500#endif
501 cmdtp++;
502 }
503}
504#endif