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