avr/command.c

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