command.c 13 KB

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