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