command.c 14 KB

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