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_array[cmd_items];
 170                 cmd_tbl_t *tp = tbl_start;
 171                 uint_fast8_t max_len = 0;
 172
 173                 /* Make array of commands from .uboot_cmd section */
 174                 for (int i = 0; i < cmd_items; i++) {
 175                         cmd_array[i] = tp++;
 176                         uint_fast8_t l = strlen_P(cmd_array[i]->name);
 177                         if (l > max_len)
 178                                 max_len = l;
 179                 }
 180
 181                 /* Sort command list */
 182                 qsort(cmd_array, cmd_items, sizeof (cmd_tbl_t *), cmpstring_PP);
 183
 184                 /* print short help (usage) */
 185                 for (int i = 0; i < cmd_items; i++) {
 186                         if (opt_debug || !(cmd_array[i]->flags & CTBL_DBG)) {
 187                                 const FLASH char *usage = cmd_array[i]->usage;
 188
 189                                 /* allow user abort */
 190                                 if (ctrlc ())
 191                                         return CMD_RET_FAILURE;
 192                                 if (usage == NULL)
 193                                         continue;
 194 #if defined(GCC_BUG_61443) || 1
 195                                 print_usage_line(cmd_array[i]->name, max_len, usage);
 196 #else
 197                                 printf_P(PSTR("%-" stringify(8) /*FIXME*/ "S - %S\n"),
 198                                                 cmd_array[i]->name, usage);
 199 #endif
 200                         }
 201                 }
 202                 return CMD_RET_SUCCESS;
 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)) != NULL &&
 210                                         (opt_debug || cmdtp->name[0] != '!')) {
 211                         cmd_usage(cmdtp);
 212                 } else {
 213                         printf_P(PSTR("Unknown command '%s' - try 'help'"
 214                                 " without arguments.\n\n"), argv[i]
 215                                 );
 216                         return CMD_RET_FAILURE;
 217                 }
 218         }
 219
 220         return CMD_RET_SUCCESS;
 221 }
 222
 223
 224 command_ret_t cmd_usage(const FLASH cmd_tbl_t *cmdtp)
 225 {
 226 //      printf("%s - %s\n\n", cmdtp->name, cmdtp->usage);
 227         print_usage_line(cmdtp->name, 0, cmdtp->usage);
 228 #if 0
 229         my_puts_P(cmdtp->name);
 230         print_blanks(/*FIXME*/ 8 - strlen_P(cmdtp->name));
 231         my_puts_P(PSTR(" - "));
 232         my_puts_P(cmdtp->usage);
 233         my_puts_P(PSTR("\n\n"));
 234 #endif
 235 #ifdef  CONFIG_SYS_LONGHELP
 236 //      printf("Usage:\n%s ", cmdtp->name);
 237         my_puts_P(PSTR("Usage:\n"));
 238         my_puts_P(cmdtp->name);
 239         my_puts_P(PSTR(" "));
 240
 241         if (!cmdtp->help) {
 242                 my_puts_P(PSTR(" - No additional help available.\n"));
 243                 return CMD_RET_FAILURE;
 244         }
 245
 246         my_puts_P(cmdtp->help);
 247         my_puts_P(PSTR("\n"));
 248 #endif  /* CONFIG_SYS_LONGHELP */
 249         return CMD_RET_FAILURE;
 250 }
 251
 252 #ifdef CONFIG_AUTO_COMPLETE
 253
 254 int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[])
 255 {
 256         static char tmp_buf[CONFIG_SYS_CBSIZE];
 257         int space;
 258
 259         space = last_char == '\0' || isblank(last_char);
 260
 261         if (space && argc == 1)
 262                 return env_complete("", maxv, cmdv, sizeof(tmp_buf), tmp_buf);
 263
 264         if (!space && argc == 2)
 265                 return env_complete(argv[1], maxv, cmdv, sizeof(tmp_buf), tmp_buf);
 266
 267         return 0;
 268 }
 269
 270 /*************************************************************************************/
 271
 272 /* TODO: cmdtp points to FLASH */
 273
 274 static int complete_cmdv(int argc, char * const argv[], char last_char, int maxv, char *cmdv[])
 275 {
 276         cmd_tbl_t *cmdtp = cmd_tbl;
 277 //      const int count = ARRAY_SIZE(cmd_tbl);
 278 //      const cmd_tbl_t *cmdend = cmdtp + count;
 279 //      const char *p;
 280         int len, clen;
 281         int n_found = 0;
 282         const char *cmd;
 283
 284         /* sanity? */
 285         if (maxv < 2)
 286                 return -2;
 287
 288         cmdv[0] = NULL;
 289
 290         if (argc == 0) {
 291                 /* output full list of commands */
 292                 for (; cmdtp->name[0] != '\0'; cmdtp++) {
 293                         if (n_found >= maxv - 2) {
 294                                 cmdv[n_found++] = "...";
 295                                 break;
 296                         }
 297                         cmdv[n_found++] = cmdtp->name;
 298                 }
 299                 cmdv[n_found] = NULL;
 300                 return n_found;
 301         }
 302
 303         /* more than one arg or one but the start of the next */
 304         if (argc > 1 || (last_char == '\0' || isblank(last_char))) {
 305                 cmdtp = find_cmd(argv[0], cmd_tbl);
 306                 if (cmdtp == NULL || cmdtp->complete == NULL) {
 307                         cmdv[0] = NULL;
 308                         return 0;
 309                 }
 310                 return (*cmdtp->complete)(argc, argv, last_char, maxv, cmdv);
 311         }
 312
 313         cmd = argv[0];
 314
 315         len = strlen(cmd);
 316
 317         /* return the partial matches */
 318         for (; cmdtp->name[0] != '\0'; cmdtp++) {
 319
 320                 clen = strlen(cmdtp->name);
 321                 if (clen < len)
 322                         continue;
 323
 324                 if (memcmp(cmd, cmdtp->name, len) != 0)
 325                         continue;
 326
 327                 /* too many! */
 328                 if (n_found >= maxv - 2) {
 329                         cmdv[n_found++] = "...";
 330                         break;
 331                 }
 332
 333                 cmdv[n_found++] = cmdtp->name;
 334         }
 335
 336         cmdv[n_found] = NULL;
 337         return n_found;
 338 }
 339
 340 static int make_argv(char *s, int argvsz, char *argv[])
 341 {
 342         int argc = 0;
 343
 344         /* split into argv */
 345         while (argc < argvsz - 1) {
 346
 347                 /* skip any white space */
 348                 while (isblank(*s))
 349                         ++s;
 350
 351                 if (*s == '\0') /* end of s, no more args       */
 352                         break;
 353
 354                 argv[argc++] = s;       /* begin of argument string     */
 355
 356                 /* find end of string */
 357                 while (*s && !isblank(*s))
 358                         ++s;
 359
 360                 if (*s == '\0')         /* end of s, no more args       */
 361                         break;
 362
 363                 *s++ = '\0';            /* terminate current arg         */
 364         }
 365         argv[argc] = NULL;
 366
 367         return argc;
 368 }
 369
 370 static void print_argv(const char *banner, const char *leader, const char *sep, int linemax, char * const argv[])
 371 {
 372         int ll = leader != NULL ? strlen(leader) : 0;
 373         int sl = sep != NULL ? strlen(sep) : 0;
 374         int len, i;
 375
 376         if (banner) {
 377                 my_puts_P(PSTR("\n"));
 378                 my_puts(banner);
 379         }
 380
 381         i = linemax;    /* force leader and newline */
 382         while (*argv != NULL) {
 383                 len = strlen(*argv) + sl;
 384                 if (i + len >= linemax) {
 385                         my_puts_P(PSTR("\n"));
 386                         if (leader)
 387                                 my_puts(leader);
 388                         i = ll - sl;
 389                 } else if (sep)
 390                         my_puts(sep);
 391                 my_puts(*argv++);
 392                 i += len;
 393         }
 394         my_puts_P(PSTR("\n"));
 395 }
 396
 397 static int find_common_prefix(char * const argv[])
 398 {
 399         int i, len;
 400         char *anchor, *s, *t;
 401
 402         if (*argv == NULL)
 403                 return 0;
 404
 405         /* begin with max */
 406         anchor = *argv++;
 407         len = strlen(anchor);
 408         while ((t = *argv++) != NULL) {
 409                 s = anchor;
 410                 for (i = 0; i < len; i++, t++, s++) {
 411                         if (*t != *s)
 412                                 break;
 413                 }
 414                 len = s - anchor;
 415         }
 416         return len;
 417 }
 418
 419 static char tmp_buf[CONFIG_SYS_CBSIZE]; /* copy of console I/O buffer   */
 420
 421
 422 int cmd_auto_complete(const FLASH char *const prompt, char *buf, int *np, int *colp)
 423 {
 424         int n = *np, col = *colp;
 425         char *argv[CONFIG_SYS_MAXARGS + 1];             /* NULL terminated      */
 426         char *cmdv[20];
 427         char *s, *t;
 428         const char *sep;
 429         int i, j, k, len, seplen, argc;
 430         int cnt;
 431         char last_char;
 432
 433         if (strcmp_PP(prompt, CONFIG_SYS_PROMPT) != 0)
 434                 return 0;       /* not in normal console */
 435
 436         cnt = strlen(buf);
 437         if (cnt >= 1)
 438                 last_char = buf[cnt - 1];
 439         else
 440                 last_char = '\0';
 441
 442         /* copy to secondary buffer which will be affected */
 443         strcpy(tmp_buf, buf);
 444
 445         /* separate into argv */
 446         argc = make_argv(tmp_buf, sizeof(argv)/sizeof(argv[0]), argv);
 447
 448         /* do the completion and return the possible completions */
 449         i = complete_cmdv(argc, argv, last_char, sizeof(cmdv)/sizeof(cmdv[0]), cmdv);
 450
 451         /* no match; bell and out */
 452         if (i == 0) {
 453                 if (argc > 1)   /* allow tab for non command */
 454                         return 0;
 455                 putchar('\a');
 456                 return 1;
 457         }
 458
 459         s = NULL;
 460         len = 0;
 461         sep = NULL;
 462         seplen = 0;
 463         if (i == 1) { /* one match; perfect */
 464                 k = strlen(argv[argc - 1]);
 465                 s = cmdv[0] + k;
 466                 len = strlen(s);
 467                 sep = " ";
 468                 seplen = 1;
 469         } else if (i > 1 && (j = find_common_prefix(cmdv)) != 0) {      /* more */
 470                 k = strlen(argv[argc - 1]);
 471                 j -= k;
 472                 if (j > 0) {
 473                         s = cmdv[0] + k;
 474                         len = j;
 475                 }
 476         }
 477
 478         if (s != NULL) {
 479                 k = len + seplen;
 480                 /* make sure it fits */
 481                 if (n + k >= CONFIG_SYS_CBSIZE - 2) {
 482                         putchar('\a');
 483                         return 1;
 484                 }
 485
 486                 t = buf + cnt;
 487                 for (i = 0; i < len; i++)
 488                         *t++ = *s++;
 489                 if (sep != NULL)
 490                         for (i = 0; i < seplen; i++)
 491                                 *t++ = sep[i];
 492                 *t = '\0';
 493                 n += k;
 494                 col += k;
 495                 my_puts(t - k);
 496                 if (sep == NULL)
 497                         putchar('\a');
 498                 *np = n;
 499                 *colp = col;
 500         } else {
 501                 print_argv(NULL, "  ", " ", 78, cmdv);
 502
 503                 my_puts_P(prompt);
 504                 my_puts(buf);
 505         }
 506         return 1;
 507 }
 508
 509 #endif /* CONFIG_AUTO_COMPLETE */
 510
 511
 512
 513 /**
 514  * Call a command function. This should be the only route in U-Boot to call
 515  * a command, so that we can track whether we are waiting for input or
 516  * executing a command.
 517  *
 518  * @param cmdtp         Pointer to the command to execute
 519  * @param flag          Some flags normally 0 (see CMD_FLAG_.. above)
 520  * @param argc          Number of arguments (arg 0 must be the command text)
 521  * @param argv          Arguments
 522  * @return 0 if command succeeded, else non-zero (CMD_RET_...)
 523  */
 524 command_ret_t cmd_call(cmd_tbl_t *cmdtp, uint_fast8_t flag, int argc, char * const argv[])
 525 {
 526         command_ret_t result;
 527
 528         result = (cmdtp->cmd)(cmdtp, flag, argc, argv);
 529 //      if (result != CMD_RET_SUCCESS)
 530 //              debug("Command failed, result=%d\n", result);
 531         return result;
 532 }
 533
 534 #pragma GCC diagnostic ignored "-Wclobbered"
 535
 536 command_ret_t cmd_process(uint_fast8_t flag, int argc, char * const argv[],
 537                                uint_fast8_t *repeatable)
 538 {
 539         command_ret_t rc = CMD_RET_SUCCESS;
 540         cmd_tbl_t *cmdtp;
 541         uint_fast8_t cmdlevel;
 542
 543         /* Look up command in command table */
 544         cmdtp = find_cmd(argv[0], cmd_tbl, &cmdlevel);
 545         if (cmdtp != NULL) {
 546                 /* Check if this command has subcommands */
 547                 if (cmdtp->subcmd && argc > 1) {
 548
 549                         /* Look up subcommand in subcommand table */
 550                         cmd_tbl_t *cmdtpsub = find_cmd(argv[1], cmdtp->subcmd, &cmdlevel);
 551                         if (cmdtpsub == NULL) {
 552                                 printf_P(PSTR("Unknown '%s' subcommand '%s' - try '%s help'\n"), argv[0], argv[1], argv[0]);
 553                                 return CMD_RET_FAILURE;
 554                         }
 555                         cmdtp = cmdtpsub;
 556                         --argc;
 557                         ++argv;
 558                 }
 559         }
 560 #if 0
 561          else {
 562                 /* Search subcommands */
 563                 cmdtp = find_cmd_sub(argv[0], cmd_tbl, &cmdlevel);
 564         }
 565 #endif
 566
 567         if (cmdtp == NULL) {
 568                 printf_P(PSTR("Unknown command '%s' - try 'help'\n"), argv[0]);
 569                 return CMD_RET_FAILURE;
 570         }
 571
 572         /* found - check max args */
 573         if (argc > cmdtp->maxargs)
 574                 rc = CMD_RET_USAGE;
 575
 576 #if defined(CONFIG_CMD_BOOTD)
 577         /* avoid "bootd" recursion */
 578         else if (cmdtp->cmd == do_bootd) {
 579                 if (flag & CMD_FLAG_BOOTD) {
 580                         my_puts_P(PSTR("'bootd' recursion detected\n"));
 581                         rc = CMD_RET_FAILURE;
 582                 } else {
 583                         flag |= CMD_FLAG_BOOTD;
 584                 }
 585         }
 586 #endif
 587
 588         if (setjmp(cmd_jbuf) != 0)
 589                 return CMD_RET_FAILURE;
 590
 591         /* If OK so far, then do the command */
 592         if (!rc) {
 593                 rc = cmd_call(cmdtp, flag, argc, argv);
 594                 *repeatable &= (cmdtp->flags & CTBL_RPT) != 0;
 595         }
 596         if (rc == CMD_RET_USAGE)
 597                 rc = cmd_usage(cmdtp);
 598         return rc;
 599 }
 600
 601 int cmd_process_error(cmd_tbl_t *cmdtp, int err)
 602 {
 603         char buf[strlen_P(cmdtp->name) + 1];
 604         strcpy_P(buf, cmdtp->name);
 605
 606         if (err) {
 607                 printf_P(PSTR("Command '%s' failed: Error %d\n"), buf, err);
 608                 return 1;
 609         }
 610
 611         return 0;
 612 }