avr/command.c

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