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