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