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