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