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