command.c 14 KB

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