command.c 11 KB

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