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