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