command.c 14 KB

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