common/command.c

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