avr/command.c

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