common/command.c

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