common/cmd_nvedit.c

   1 /*
   2  * (C) Copyright 2000-2010
   3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   4  *
   5  * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
   6  * Andreas Heppel <aheppel@sysgo.de>
   7  *
   8  * Copyright 2011 Freescale Semiconductor, Inc.
   9  *
  10  * See file CREDITS for list of people who contributed to this
  11  * project.
  12  *
  13  * This program is free software; you can redistribute it and/or
  14  * modify it under the terms of the GNU General Public License as
  15  * published by the Free Software Foundation; either version 2 of
  16  * the License, or (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with this program; if not, write to the Free Software
  25  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  26  * MA 02111-1307 USA
  27  */
  28
  29 /*
  30  * Support for persistent environment data
  31  *
  32  * The "environment" is stored on external storage as a list of '\0'
  33  * terminated "name=value" strings. The end of the list is marked by
  34  * a double '\0'. The environment is preceeded by a 32 bit CRC over
  35  * the data part and, in case of redundant environment, a byte of
  36  * flags.
  37  *
  38  * This linearized representation will also be used before
  39  * relocation, i. e. as long as we don't have a full C runtime
  40  * environment. After that, we use a hash table.
  41  */
  42
  43 #include <common.h>
  44 #include <command.h>
  45 #include <environment.h>
  46 #include <search.h>
  47 #include <errno.h>
  48 #include <malloc.h>
  49 #include <watchdog.h>
  50 #include <serial.h>
  51 #include <linux/stddef.h>
  52 #include <asm/byteorder.h>
  53
  54 DECLARE_GLOBAL_DATA_PTR;
  55
  56 #if     !defined(CONFIG_ENV_IS_IN_EEPROM)       && \
  57         !defined(CONFIG_ENV_IS_IN_FLASH)        && \
  58         !defined(CONFIG_ENV_IS_IN_DATAFLASH)    && \
  59         !defined(CONFIG_ENV_IS_IN_MMC)          && \
  60         !defined(CONFIG_ENV_IS_IN_FAT)          && \
  61         !defined(CONFIG_ENV_IS_IN_NAND)         && \
  62         !defined(CONFIG_ENV_IS_IN_NVRAM)        && \
  63         !defined(CONFIG_ENV_IS_IN_ONENAND)      && \
  64         !defined(CONFIG_ENV_IS_IN_SPI_FLASH)    && \
  65         !defined(CONFIG_ENV_IS_IN_REMOTE)       && \
  66         !defined(CONFIG_ENV_IS_NOWHERE)
  67 # error Define one of CONFIG_ENV_IS_IN_{EEPROM|FLASH|DATAFLASH|ONENAND|\
  68 SPI_FLASH|NVRAM|MMC|FAT|REMOTE} or CONFIG_ENV_IS_NOWHERE
  69 #endif
  70
  71 /*
  72  * Maximum expected input data size for import command
  73  */
  74 #define MAX_ENV_SIZE    (1 << 20)       /* 1 MiB */
  75
  76 ulong load_addr = CONFIG_SYS_LOAD_ADDR; /* Default Load Address */
  77 ulong save_addr;                        /* Default Save Address */
  78 ulong save_size;                        /* Default Save Size (in bytes) */
  79
  80 /*
  81  * Table with supported baudrates (defined in config_xyz.h)
  82  */
  83 static const unsigned long baudrate_table[] = CONFIG_SYS_BAUDRATE_TABLE;
  84 #define N_BAUDRATES (sizeof(baudrate_table) / sizeof(baudrate_table[0]))
  85
  86 /*
  87  * This variable is incremented on each do_env_set(), so it can
  88  * be used via get_env_id() as an indication, if the environment
  89  * has changed or not. So it is possible to reread an environment
  90  * variable only if the environment was changed ... done so for
  91  * example in NetInitLoop()
  92  */
  93 static int env_id = 1;
  94
  95 int get_env_id(void)
  96 {
  97         return env_id;
  98 }
  99
 100 #ifndef CONFIG_SPL_BUILD
 101 /*
 102  * Command interface: print one or all environment variables
 103  *
 104  * Returns 0 in case of error, or length of printed string
 105  */
 106 static int env_print(char *name, int flag)
 107 {
 108         char *res = NULL;
 109         size_t len;
 110
 111         if (name) {             /* print a single name */
 112                 ENTRY e, *ep;
 113
 114                 e.key = name;
 115                 e.data = NULL;
 116                 hsearch_r(e, FIND, &ep, &env_htab, flag);
 117                 if (ep == NULL)
 118                         return 0;
 119                 len = printf("%s=%s\n", ep->key, ep->data);
 120                 return len;
 121         }
 122
 123         /* print whole list */
 124         len = hexport_r(&env_htab, '\n', flag, &res, 0, 0, NULL);
 125
 126         if (len > 0) {
 127                 puts(res);
 128                 free(res);
 129                 return len;
 130         }
 131
 132         /* should never happen */
 133         return 0;
 134 }
 135
 136 static int do_env_print(cmd_tbl_t *cmdtp, int flag, int argc,
 137                         char * const argv[])
 138 {
 139         int i;
 140         int rcode = 0;
 141         int env_flag = H_HIDE_DOT;
 142
 143         if (argc > 1 && argv[1][0] == '-' && argv[1][1] == 'a') {
 144                 argc--;
 145                 argv++;
 146                 env_flag &= ~H_HIDE_DOT;
 147         }
 148
 149         if (argc == 1) {
 150                 /* print all env vars */
 151                 rcode = env_print(NULL, env_flag);
 152                 if (!rcode)
 153                         return 1;
 154                 printf("\nEnvironment size: %d/%ld bytes\n",
 155                         rcode, (ulong)ENV_SIZE);
 156                 return 0;
 157         }
 158
 159         /* print selected env vars */
 160         env_flag &= ~H_HIDE_DOT;
 161         for (i = 1; i < argc; ++i) {
 162                 int rc = env_print(argv[i], env_flag);
 163                 if (!rc) {
 164                         printf("## Error: \"%s\" not defined\n", argv[i]);
 165                         ++rcode;
 166                 }
 167         }
 168
 169         return rcode;
 170 }
 171
 172 #ifdef CONFIG_CMD_GREPENV
 173 static int do_env_grep(cmd_tbl_t *cmdtp, int flag,
 174                        int argc, char * const argv[])
 175 {
 176         ENTRY *match;
 177         unsigned char matched[env_htab.size / 8];
 178         int rcode = 1, arg = 1, idx;
 179
 180         if (argc < 2)
 181                 return CMD_RET_USAGE;
 182
 183         memset(matched, 0, env_htab.size / 8);
 184
 185         while (arg <= argc) {
 186                 idx = 0;
 187                 while ((idx = hstrstr_r(argv[arg], idx, &match, &env_htab))) {
 188                         if (!(matched[idx / 8] & (1 << (idx & 7)))) {
 189                                 puts(match->key);
 190                                 puts("=");
 191                                 puts(match->data);
 192                                 puts("\n");
 193                         }
 194                         matched[idx / 8] |= 1 << (idx & 7);
 195                         rcode = 0;
 196                 }
 197                 arg++;
 198         }
 199
 200         return rcode;
 201 }
 202 #endif
 203 #endif /* CONFIG_SPL_BUILD */
 204
 205 /*
 206  * Perform consistency checking before setting, replacing, or deleting an
 207  * environment variable, then (if successful) apply the changes to internals so
 208  * to make them effective.  Code for this function was taken out of
 209  * _do_env_set(), which now calls it instead.
 210  * Also called as a callback function by himport_r().
 211  * Returns 0 in case of success, 1 in case of failure.
 212  * When (flag & H_FORCE) is set, do not print out any error message and force
 213  * overwriting of write-once variables.
 214  */
 215
 216 int env_change_ok(const ENTRY *item, const char *newval, enum env_op op,
 217         int flag)
 218 {
 219         int   console = -1;
 220         const char *name;
 221 #if !defined(CONFIG_ENV_OVERWRITE) && defined(CONFIG_OVERWRITE_ETHADDR_ONCE) \
 222 && defined(CONFIG_ETHADDR)
 223         const char *oldval = NULL;
 224
 225         if (op != env_op_create)
 226                 oldval = item->data;
 227 #endif
 228
 229         name = item->key;
 230
 231         /* Default value for NULL to protect string-manipulating functions */
 232         newval = newval ? : "";
 233
 234         /* Check for console redirection */
 235         if (strcmp(name, "stdin") == 0)
 236                 console = stdin;
 237         else if (strcmp(name, "stdout") == 0)
 238                 console = stdout;
 239         else if (strcmp(name, "stderr") == 0)
 240                 console = stderr;
 241
 242         if (console != -1 && (gd->flags & GD_FLG_DEVINIT) != 0) {
 243                 if ((newval == NULL) || (*newval == '\0')) {
 244                         /* We cannot delete stdin/stdout/stderr */
 245                         if ((flag & H_FORCE) == 0)
 246                                 printf("Can't delete \"%s\"\n", name);
 247                         return 1;
 248                 }
 249
 250 #ifdef CONFIG_CONSOLE_MUX
 251                 if (iomux_doenv(console, newval))
 252                         return 1;
 253 #else
 254                 /* Try assigning specified device */
 255                 if (console_assign(console, newval) < 0)
 256                         return 1;
 257 #endif /* CONFIG_CONSOLE_MUX */
 258         }
 259
 260 #ifndef CONFIG_ENV_OVERWRITE
 261         /*
 262          * Some variables like "ethaddr" and "serial#" can be set only once and
 263          * cannot be deleted, unless CONFIG_ENV_OVERWRITE is defined.
 264          */
 265         if (op != env_op_create &&              /* variable exists */
 266                 (flag & H_FORCE) == 0) {        /* and we are not forced */
 267                 if (strcmp(name, "serial#") == 0 ||
 268                     (strcmp(name, "ethaddr") == 0
 269 #if defined(CONFIG_OVERWRITE_ETHADDR_ONCE) && defined(CONFIG_ETHADDR)
 270                      && strcmp(oldval, __stringify(CONFIG_ETHADDR)) != 0
 271 #endif  /* CONFIG_OVERWRITE_ETHADDR_ONCE && CONFIG_ETHADDR */
 272                         )) {
 273                         printf("Can't overwrite \"%s\"\n", name);
 274                         return 1;
 275                 }
 276         }
 277 #endif
 278         /*
 279          * When we change baudrate, or we are doing an env default -a
 280          * (which will erase all variables prior to calling this),
 281          * we want the baudrate to actually change - for real.
 282          */
 283         if (op != env_op_create ||              /* variable exists */
 284                 (flag & H_NOCLEAR) == 0) {      /* or env is clear */
 285                 /*
 286                  * Switch to new baudrate if new baudrate is supported
 287                  */
 288                 if (strcmp(name, "baudrate") == 0) {
 289                         int baudrate = simple_strtoul(newval, NULL, 10);
 290                         int i;
 291                         for (i = 0; i < N_BAUDRATES; ++i) {
 292                                 if (baudrate == baudrate_table[i])
 293                                         break;
 294                         }
 295                         if (i == N_BAUDRATES) {
 296                                 if ((flag & H_FORCE) == 0)
 297                                         printf("## Baudrate %d bps not "
 298                                                 "supported\n", baudrate);
 299                                 return 1;
 300                         }
 301                         if (gd->baudrate == baudrate) {
 302                                 /* If unchanged, we just say it's OK */
 303                                 return 0;
 304                         }
 305                         printf("## Switch baudrate to %d bps and"
 306                                 "press ENTER ...\n", baudrate);
 307                         udelay(50000);
 308                         gd->baudrate = baudrate;
 309 #if defined(CONFIG_PPC) || defined(CONFIG_MCF52x2)
 310                         gd->bd->bi_baudrate = baudrate;
 311 #endif
 312
 313                         serial_setbrg();
 314                         udelay(50000);
 315                         while (getc() != '\r')
 316                                 ;
 317                 }
 318         }
 319
 320         /*
 321          * Some variables should be updated when the corresponding
 322          * entry in the environment is changed
 323          */
 324         if (strcmp(name, "loadaddr") == 0) {
 325                 load_addr = simple_strtoul(newval, NULL, 16);
 326                 return 0;
 327         }
 328         return 0;
 329 }
 330
 331 /*
 332  * Set a new environment variable,
 333  * or replace or delete an existing one.
 334 */
 335 static int _do_env_set(int flag, int argc, char * const argv[])
 336 {
 337         int   i, len;
 338         char  *name, *value, *s;
 339         ENTRY e, *ep;
 340
 341         name = argv[1];
 342         value = argv[2];
 343
 344         if (strchr(name, '=')) {
 345                 printf("## Error: illegal character '='"
 346                        "in variable name \"%s\"\n", name);
 347                 return 1;
 348         }
 349
 350         env_id++;
 351
 352         /* Delete only ? */
 353         if (argc < 3 || argv[2] == NULL) {
 354                 int rc = hdelete_r(name, &env_htab, H_INTERACTIVE);
 355                 return !rc;
 356         }
 357
 358         /*
 359          * Insert / replace new value
 360          */
 361         for (i = 2, len = 0; i < argc; ++i)
 362                 len += strlen(argv[i]) + 1;
 363
 364         value = malloc(len);
 365         if (value == NULL) {
 366                 printf("## Can't malloc %d bytes\n", len);
 367                 return 1;
 368         }
 369         for (i = 2, s = value; i < argc; ++i) {
 370                 char *v = argv[i];
 371
 372                 while ((*s++ = *v++) != '\0')
 373                         ;
 374                 *(s - 1) = ' ';
 375         }
 376         if (s != value)
 377                 *--s = '\0';
 378
 379         e.key   = name;
 380         e.data  = value;
 381         hsearch_r(e, ENTER, &ep, &env_htab, H_INTERACTIVE);
 382         free(value);
 383         if (!ep) {
 384                 printf("## Error inserting \"%s\" variable, errno=%d\n",
 385                         name, errno);
 386                 return 1;
 387         }
 388
 389         return 0;
 390 }
 391
 392 int setenv(const char *varname, const char *varvalue)
 393 {
 394         const char * const argv[4] = { "setenv", varname, varvalue, NULL };
 395
 396         if (varvalue == NULL || varvalue[0] == '\0')
 397                 return _do_env_set(0, 2, (char * const *)argv);
 398         else
 399                 return _do_env_set(0, 3, (char * const *)argv);
 400 }
 401
 402 /**
 403  * Set an environment variable to an integer value
 404  *
 405  * @param varname       Environmet variable to set
 406  * @param value         Value to set it to
 407  * @return 0 if ok, 1 on error
 408  */
 409 int setenv_ulong(const char *varname, ulong value)
 410 {
 411         /* TODO: this should be unsigned */
 412         char *str = simple_itoa(value);
 413
 414         return setenv(varname, str);
 415 }
 416
 417 /**
 418  * Set an environment variable to an address in hex
 419  *
 420  * @param varname       Environmet variable to set
 421  * @param addr          Value to set it to
 422  * @return 0 if ok, 1 on error
 423  */
 424 int setenv_addr(const char *varname, const void *addr)
 425 {
 426         char str[17];
 427
 428         sprintf(str, "%lx", (uintptr_t)addr);
 429         return setenv(varname, str);
 430 }
 431
 432 #ifndef CONFIG_SPL_BUILD
 433 static int do_env_set(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 434 {
 435         if (argc < 2)
 436                 return CMD_RET_USAGE;
 437
 438         return _do_env_set(flag, argc, argv);
 439 }
 440
 441 /*
 442  * Prompt for environment variable
 443  */
 444 #if defined(CONFIG_CMD_ASKENV)
 445 int do_env_ask(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 446 {
 447         char message[CONFIG_SYS_CBSIZE];
 448         int size = CONFIG_SYS_CBSIZE - 1;
 449         int i, len, pos;
 450         char *local_args[4];
 451
 452         local_args[0] = argv[0];
 453         local_args[1] = argv[1];
 454         local_args[2] = NULL;
 455         local_args[3] = NULL;
 456
 457         /* Check the syntax */
 458         switch (argc) {
 459         case 1:
 460                 return CMD_RET_USAGE;
 461
 462         case 2:         /* env_ask envname */
 463                 sprintf(message, "Please enter '%s':", argv[1]);
 464                 break;
 465
 466         case 3:         /* env_ask envname size */
 467                 sprintf(message, "Please enter '%s':", argv[1]);
 468                 size = simple_strtoul(argv[2], NULL, 10);
 469                 break;
 470
 471         default:        /* env_ask envname message1 ... messagen size */
 472                 for (i = 2, pos = 0; i < argc - 1; i++) {
 473                         if (pos)
 474                                 message[pos++] = ' ';
 475
 476                         strcpy(message + pos, argv[i]);
 477                         pos += strlen(argv[i]);
 478                 }
 479
 480                 message[pos] = '\0';
 481                 size = simple_strtoul(argv[argc - 1], NULL, 10);
 482                 break;
 483         }
 484
 485         if (size >= CONFIG_SYS_CBSIZE)
 486                 size = CONFIG_SYS_CBSIZE - 1;
 487
 488         if (size <= 0)
 489                 return 1;
 490
 491         /* prompt for input */
 492         len = readline(message);
 493
 494         if (size < len)
 495                 console_buffer[size] = '\0';
 496
 497         len = 2;
 498         if (console_buffer[0] != '\0') {
 499                 local_args[2] = console_buffer;
 500                 len = 3;
 501         }
 502
 503         /* Continue calling setenv code */
 504         return _do_env_set(flag, len, local_args);
 505 }
 506 #endif
 507
 508 #if defined(CONFIG_CMD_ENV_CALLBACK)
 509 static int print_static_binding(const char *var_name, const char *callback_name)
 510 {
 511         printf("\t%-20s %-20s\n", var_name, callback_name);
 512
 513         return 0;
 514 }
 515
 516 static int print_active_callback(ENTRY *entry)
 517 {
 518         struct env_clbk_tbl *clbkp;
 519         int i;
 520         int num_callbacks;
 521
 522         if (entry->callback == NULL)
 523                 return 0;
 524
 525         /* look up the callback in the linker-list */
 526         num_callbacks = ll_entry_count(struct env_clbk_tbl, env_clbk);
 527         for (i = 0, clbkp = ll_entry_start(struct env_clbk_tbl, env_clbk);
 528              i < num_callbacks;
 529              i++, clbkp++) {
 530 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
 531                 if (entry->callback == clbkp->callback + gd->reloc_off)
 532 #else
 533                 if (entry->callback == clbkp->callback)
 534 #endif
 535                         break;
 536         }
 537
 538         if (i == num_callbacks)
 539                 /* this should probably never happen, but just in case... */
 540                 printf("\t%-20s %p\n", entry->key, entry->callback);
 541         else
 542                 printf("\t%-20s %-20s\n", entry->key, clbkp->name);
 543
 544         return 0;
 545 }
 546
 547 /*
 548  * Print the callbacks available and what they are bound to
 549  */
 550 int do_env_callback(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 551 {
 552         struct env_clbk_tbl *clbkp;
 553         int i;
 554         int num_callbacks;
 555
 556         /* Print the available callbacks */
 557         puts("Available callbacks:\n");
 558         puts("\tCallback Name\n");
 559         puts("\t-------------\n");
 560         num_callbacks = ll_entry_count(struct env_clbk_tbl, env_clbk);
 561         for (i = 0, clbkp = ll_entry_start(struct env_clbk_tbl, env_clbk);
 562              i < num_callbacks;
 563              i++, clbkp++)
 564                 printf("\t%s\n", clbkp->name);
 565         puts("\n");
 566
 567         /* Print the static bindings that may exist */
 568         puts("Static callback bindings:\n");
 569         printf("\t%-20s %-20s\n", "Variable Name", "Callback Name");
 570         printf("\t%-20s %-20s\n", "-------------", "-------------");
 571         env_attr_walk(ENV_CALLBACK_LIST_STATIC, print_static_binding);
 572         puts("\n");
 573
 574         /* walk through each variable and print the callback if it has one */
 575         puts("Active callback bindings:\n");
 576         printf("\t%-20s %-20s\n", "Variable Name", "Callback Name");
 577         printf("\t%-20s %-20s\n", "-------------", "-------------");
 578         hwalk_r(&env_htab, print_active_callback);
 579         return 0;
 580 }
 581 #endif
 582
 583 /*
 584  * Interactively edit an environment variable
 585  */
 586 #if defined(CONFIG_CMD_EDITENV)
 587 static int do_env_edit(cmd_tbl_t *cmdtp, int flag, int argc,
 588                        char * const argv[])
 589 {
 590         char buffer[CONFIG_SYS_CBSIZE];
 591         char *init_val;
 592
 593         if (argc < 2)
 594                 return CMD_RET_USAGE;
 595
 596         /* Set read buffer to initial value or empty sting */
 597         init_val = getenv(argv[1]);
 598         if (init_val)
 599                 sprintf(buffer, "%s", init_val);
 600         else
 601                 buffer[0] = '\0';
 602
 603         readline_into_buffer("edit: ", buffer, 0);
 604
 605         return setenv(argv[1], buffer);
 606 }
 607 #endif /* CONFIG_CMD_EDITENV */
 608 #endif /* CONFIG_SPL_BUILD */
 609
 610 /*
 611  * Look up variable from environment,
 612  * return address of storage for that variable,
 613  * or NULL if not found
 614  */
 615 char *getenv(const char *name)
 616 {
 617         if (gd->flags & GD_FLG_ENV_READY) { /* after import into hashtable */
 618                 ENTRY e, *ep;
 619
 620                 WATCHDOG_RESET();
 621
 622                 e.key   = name;
 623                 e.data  = NULL;
 624                 hsearch_r(e, FIND, &ep, &env_htab, 0);
 625
 626                 return ep ? ep->data : NULL;
 627         }
 628
 629         /* restricted capabilities before import */
 630         if (getenv_f(name, (char *)(gd->env_buf), sizeof(gd->env_buf)) > 0)
 631                 return (char *)(gd->env_buf);
 632
 633         return NULL;
 634 }
 635
 636 /*
 637  * Look up variable from environment for restricted C runtime env.
 638  */
 639 int getenv_f(const char *name, char *buf, unsigned len)
 640 {
 641         int i, nxt;
 642
 643         for (i = 0; env_get_char(i) != '\0'; i = nxt + 1) {
 644                 int val, n;
 645
 646                 for (nxt = i; env_get_char(nxt) != '\0'; ++nxt) {
 647                         if (nxt >= CONFIG_ENV_SIZE)
 648                                 return -1;
 649                 }
 650
 651                 val = envmatch((uchar *)name, i);
 652                 if (val < 0)
 653                         continue;
 654
 655                 /* found; copy out */
 656                 for (n = 0; n < len; ++n, ++buf) {
 657                         *buf = env_get_char(val++);
 658                         if (*buf == '\0')
 659                                 return n;
 660                 }
 661
 662                 if (n)
 663                         *--buf = '\0';
 664
 665                 printf("env_buf [%d bytes] too small for value of \"%s\"\n",
 666                         len, name);
 667
 668                 return n;
 669         }
 670
 671         return -1;
 672 }
 673
 674 /**
 675  * Decode the integer value of an environment variable and return it.
 676  *
 677  * @param name          Name of environemnt variable
 678  * @param base          Number base to use (normally 10, or 16 for hex)
 679  * @param default_val   Default value to return if the variable is not
 680  *                      found
 681  * @return the decoded value, or default_val if not found
 682  */
 683 ulong getenv_ulong(const char *name, int base, ulong default_val)
 684 {
 685         /*
 686          * We can use getenv() here, even before relocation, since the
 687          * environment variable value is an integer and thus short.
 688          */
 689         const char *str = getenv(name);
 690
 691         return str ? simple_strtoul(str, NULL, base) : default_val;
 692 }
 693
 694 #ifndef CONFIG_SPL_BUILD
 695 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
 696 static int do_env_save(cmd_tbl_t *cmdtp, int flag, int argc,
 697                        char * const argv[])
 698 {
 699         printf("Saving Environment to %s...\n", env_name_spec);
 700
 701         return saveenv() ? 1 : 0;
 702 }
 703
 704 U_BOOT_CMD(
 705         saveenv, 1, 0,  do_env_save,
 706         "save environment variables to persistent storage",
 707         ""
 708 );
 709 #endif
 710 #endif /* CONFIG_SPL_BUILD */
 711
 712
 713 /*
 714  * Match a name / name=value pair
 715  *
 716  * s1 is either a simple 'name', or a 'name=value' pair.
 717  * i2 is the environment index for a 'name2=value2' pair.
 718  * If the names match, return the index for the value2, else -1.
 719  */
 720 int envmatch(uchar *s1, int i2)
 721 {
 722         if (s1 == NULL)
 723                 return -1;
 724
 725         while (*s1 == env_get_char(i2++))
 726                 if (*s1++ == '=')
 727                         return i2;
 728
 729         if (*s1 == '\0' && env_get_char(i2-1) == '=')
 730                 return i2;
 731
 732         return -1;
 733 }
 734
 735 #ifndef CONFIG_SPL_BUILD
 736 static int do_env_default(cmd_tbl_t *cmdtp, int __flag,
 737                           int argc, char * const argv[])
 738 {
 739         int all = 0, flag = 0;
 740
 741         debug("Initial value for argc=%d\n", argc);
 742         while (--argc > 0 && **++argv == '-') {
 743                 char *arg = *argv;
 744
 745                 while (*++arg) {
 746                         switch (*arg) {
 747                         case 'a':               /* default all */
 748                                 all = 1;
 749                                 break;
 750                         case 'f':               /* force */
 751                                 flag |= H_FORCE;
 752                                 break;
 753                         default:
 754                                 return cmd_usage(cmdtp);
 755                         }
 756                 }
 757         }
 758         debug("Final value for argc=%d\n", argc);
 759         if (all && (argc == 0)) {
 760                 /* Reset the whole environment */
 761                 set_default_env("## Resetting to default environment\n");
 762                 return 0;
 763         }
 764         if (!all && (argc > 0)) {
 765                 /* Reset individual variables */
 766                 set_default_vars(argc, argv);
 767                 return 0;
 768         }
 769
 770         return cmd_usage(cmdtp);
 771 }
 772
 773 static int do_env_delete(cmd_tbl_t *cmdtp, int flag,
 774                          int argc, char * const argv[])
 775 {
 776         printf("Not implemented yet\n");
 777         return 0;
 778 }
 779
 780 #ifdef CONFIG_CMD_EXPORTENV
 781 /*
 782  * env export [-t | -b | -c] [-s size] addr [var ...]
 783  *      -t:     export as text format; if size is given, data will be
 784  *              padded with '\0' bytes; if not, one terminating '\0'
 785  *              will be added (which is included in the "filesize"
 786  *              setting so you can for exmple copy this to flash and
 787  *              keep the termination).
 788  *      -b:     export as binary format (name=value pairs separated by
 789  *              '\0', list end marked by double "\0\0")
 790  *      -c:     export as checksum protected environment format as
 791  *              used for example by "saveenv" command
 792  *      -s size:
 793  *              size of output buffer
 794  *      addr:   memory address where environment gets stored
 795  *      var...  List of variable names that get included into the
 796  *              export. Without arguments, the whole environment gets
 797  *              exported.
 798  *
 799  * With "-c" and size is NOT given, then the export command will
 800  * format the data as currently used for the persistent storage,
 801  * i. e. it will use CONFIG_ENV_SECT_SIZE as output block size and
 802  * prepend a valid CRC32 checksum and, in case of resundant
 803  * environment, a "current" redundancy flag. If size is given, this
 804  * value will be used instead of CONFIG_ENV_SECT_SIZE; again, CRC32
 805  * checksum and redundancy flag will be inserted.
 806  *
 807  * With "-b" and "-t", always only the real data (including a
 808  * terminating '\0' byte) will be written; here the optional size
 809  * argument will be used to make sure not to overflow the user
 810  * provided buffer; the command will abort if the size is not
 811  * sufficient. Any remainign space will be '\0' padded.
 812  *
 813  * On successful return, the variable "filesize" will be set.
 814  * Note that filesize includes the trailing/terminating '\0' byte(s).
 815  *
 816  * Usage szenario:  create a text snapshot/backup of the current settings:
 817  *
 818  *      => env export -t 100000
 819  *      => era ${backup_addr} +${filesize}
 820  *      => cp.b 100000 ${backup_addr} ${filesize}
 821  *
 822  * Re-import this snapshot, deleting all other settings:
 823  *
 824  *      => env import -d -t ${backup_addr}
 825  */
 826 static int do_env_export(cmd_tbl_t *cmdtp, int flag,
 827                          int argc, char * const argv[])
 828 {
 829         char    buf[32];
 830         char    *addr, *cmd, *res;
 831         size_t  size = 0;
 832         ssize_t len;
 833         env_t   *envp;
 834         char    sep = '\n';
 835         int     chk = 0;
 836         int     fmt = 0;
 837
 838         cmd = *argv;
 839
 840         while (--argc > 0 && **++argv == '-') {
 841                 char *arg = *argv;
 842                 while (*++arg) {
 843                         switch (*arg) {
 844                         case 'b':               /* raw binary format */
 845                                 if (fmt++)
 846                                         goto sep_err;
 847                                 sep = '\0';
 848                                 break;
 849                         case 'c':               /* external checksum format */
 850                                 if (fmt++)
 851                                         goto sep_err;
 852                                 sep = '\0';
 853                                 chk = 1;
 854                                 break;
 855                         case 's':               /* size given */
 856                                 if (--argc <= 0)
 857                                         return cmd_usage(cmdtp);
 858                                 size = simple_strtoul(*++argv, NULL, 16);
 859                                 goto NXTARG;
 860                         case 't':               /* text format */
 861                                 if (fmt++)
 862                                         goto sep_err;
 863                                 sep = '\n';
 864                                 break;
 865                         default:
 866                                 return CMD_RET_USAGE;
 867                         }
 868                 }
 869 NXTARG:         ;
 870         }
 871
 872         if (argc < 1)
 873                 return CMD_RET_USAGE;
 874
 875         addr = (char *)simple_strtoul(argv[0], NULL, 16);
 876
 877         if (size)
 878                 memset(addr, '\0', size);
 879
 880         argc--;
 881         argv++;
 882
 883         if (sep) {              /* export as text file */
 884                 len = hexport_r(&env_htab, sep, 0, &addr, size, argc, argv);
 885                 if (len < 0) {
 886                         error("Cannot export environment: errno = %d\n", errno);
 887                         return 1;
 888                 }
 889                 sprintf(buf, "%zX", (size_t)len);
 890                 setenv("filesize", buf);
 891
 892                 return 0;
 893         }
 894
 895         envp = (env_t *)addr;
 896
 897         if (chk)                /* export as checksum protected block */
 898                 res = (char *)envp->data;
 899         else                    /* export as raw binary data */
 900                 res = addr;
 901
 902         len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, argc, argv);
 903         if (len < 0) {
 904                 error("Cannot export environment: errno = %d\n", errno);
 905                 return 1;
 906         }
 907
 908         if (chk) {
 909                 envp->crc = crc32(0, envp->data, ENV_SIZE);
 910 #ifdef CONFIG_ENV_ADDR_REDUND
 911                 envp->flags = ACTIVE_FLAG;
 912 #endif
 913         }
 914         sprintf(buf, "%zX", (size_t)(len + offsetof(env_t, data)));
 915         setenv("filesize", buf);
 916
 917         return 0;
 918
 919 sep_err:
 920         printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n", cmd);
 921         return 1;
 922 }
 923 #endif
 924
 925 #ifdef CONFIG_CMD_IMPORTENV
 926 /*
 927  * env import [-d] [-t | -b | -c] addr [size]
 928  *      -d:     delete existing environment before importing;
 929  *              otherwise overwrite / append to existion definitions
 930  *      -t:     assume text format; either "size" must be given or the
 931  *              text data must be '\0' terminated
 932  *      -b:     assume binary format ('\0' separated, "\0\0" terminated)
 933  *      -c:     assume checksum protected environment format
 934  *      addr:   memory address to read from
 935  *      size:   length of input data; if missing, proper '\0'
 936  *              termination is mandatory
 937  */
 938 static int do_env_import(cmd_tbl_t *cmdtp, int flag,
 939                          int argc, char * const argv[])
 940 {
 941         char    *cmd, *addr;
 942         char    sep = '\n';
 943         int     chk = 0;
 944         int     fmt = 0;
 945         int     del = 0;
 946         size_t  size;
 947
 948         cmd = *argv;
 949
 950         while (--argc > 0 && **++argv == '-') {
 951                 char *arg = *argv;
 952                 while (*++arg) {
 953                         switch (*arg) {
 954                         case 'b':               /* raw binary format */
 955                                 if (fmt++)
 956                                         goto sep_err;
 957                                 sep = '\0';
 958                                 break;
 959                         case 'c':               /* external checksum format */
 960                                 if (fmt++)
 961                                         goto sep_err;
 962                                 sep = '\0';
 963                                 chk = 1;
 964                                 break;
 965                         case 't':               /* text format */
 966                                 if (fmt++)
 967                                         goto sep_err;
 968                                 sep = '\n';
 969                                 break;
 970                         case 'd':
 971                                 del = 1;
 972                                 break;
 973                         default:
 974                                 return CMD_RET_USAGE;
 975                         }
 976                 }
 977         }
 978
 979         if (argc < 1)
 980                 return CMD_RET_USAGE;
 981
 982         if (!fmt)
 983                 printf("## Warning: defaulting to text format\n");
 984
 985         addr = (char *)simple_strtoul(argv[0], NULL, 16);
 986
 987         if (argc == 2) {
 988                 size = simple_strtoul(argv[1], NULL, 16);
 989         } else {
 990                 char *s = addr;
 991
 992                 size = 0;
 993
 994                 while (size < MAX_ENV_SIZE) {
 995                         if ((*s == sep) && (*(s+1) == '\0'))
 996                                 break;
 997                         ++s;
 998                         ++size;
 999                 }
1000                 if (size == MAX_ENV_SIZE) {
1001                         printf("## Warning: Input data exceeds %d bytes"
1002                                 " - truncated\n", MAX_ENV_SIZE);
1003                 }
1004                 size += 2;
1005                 printf("## Info: input data size = %zu = 0x%zX\n", size, size);
1006         }
1007
1008         if (chk) {
1009                 uint32_t crc;
1010                 env_t *ep = (env_t *)addr;
1011
1012                 size -= offsetof(env_t, data);
1013                 memcpy(&crc, &ep->crc, sizeof(crc));
1014
1015                 if (crc32(0, ep->data, size) != crc) {
1016                         puts("## Error: bad CRC, import failed\n");
1017                         return 1;
1018                 }
1019                 addr = (char *)ep->data;
1020         }
1021
1022         if (himport_r(&env_htab, addr, size, sep, del ? 0 : H_NOCLEAR,
1023                         0, NULL) == 0) {
1024                 error("Environment import failed: errno = %d\n", errno);
1025                 return 1;
1026         }
1027         gd->flags |= GD_FLG_ENV_READY;
1028
1029         return 0;
1030
1031 sep_err:
1032         printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n",
1033                 cmd);
1034         return 1;
1035 }
1036 #endif
1037
1038 /*
1039  * New command line interface: "env" command with subcommands
1040  */
1041 static cmd_tbl_t cmd_env_sub[] = {
1042 #if defined(CONFIG_CMD_ASKENV)
1043         U_BOOT_CMD_MKENT(ask, CONFIG_SYS_MAXARGS, 1, do_env_ask, "", ""),
1044 #endif
1045         U_BOOT_CMD_MKENT(default, 1, 0, do_env_default, "", ""),
1046         U_BOOT_CMD_MKENT(delete, 2, 0, do_env_delete, "", ""),
1047 #if defined(CONFIG_CMD_EDITENV)
1048         U_BOOT_CMD_MKENT(edit, 2, 0, do_env_edit, "", ""),
1049 #endif
1050 #if defined(CONFIG_CMD_ENV_CALLBACK)
1051         U_BOOT_CMD_MKENT(callbacks, 1, 0, do_env_callback, "", ""),
1052 #endif
1053 #if defined(CONFIG_CMD_EXPORTENV)
1054         U_BOOT_CMD_MKENT(export, 4, 0, do_env_export, "", ""),
1055 #endif
1056 #if defined(CONFIG_CMD_GREPENV)
1057         U_BOOT_CMD_MKENT(grep, CONFIG_SYS_MAXARGS, 1, do_env_grep, "", ""),
1058 #endif
1059 #if defined(CONFIG_CMD_IMPORTENV)
1060         U_BOOT_CMD_MKENT(import, 5, 0, do_env_import, "", ""),
1061 #endif
1062         U_BOOT_CMD_MKENT(print, CONFIG_SYS_MAXARGS, 1, do_env_print, "", ""),
1063 #if defined(CONFIG_CMD_RUN)
1064         U_BOOT_CMD_MKENT(run, CONFIG_SYS_MAXARGS, 1, do_run, "", ""),
1065 #endif
1066 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
1067         U_BOOT_CMD_MKENT(save, 1, 0, do_env_save, "", ""),
1068 #endif
1069         U_BOOT_CMD_MKENT(set, CONFIG_SYS_MAXARGS, 0, do_env_set, "", ""),
1070 };
1071
1072 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
1073 void env_reloc(void)
1074 {
1075         fixup_cmdtable(cmd_env_sub, ARRAY_SIZE(cmd_env_sub));
1076 }
1077 #endif
1078
1079 static int do_env(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1080 {
1081         cmd_tbl_t *cp;
1082
1083         if (argc < 2)
1084                 return CMD_RET_USAGE;
1085
1086         /* drop initial "env" arg */
1087         argc--;
1088         argv++;
1089
1090         cp = find_cmd_tbl(argv[0], cmd_env_sub, ARRAY_SIZE(cmd_env_sub));
1091
1092         if (cp)
1093                 return cp->cmd(cmdtp, flag, argc, argv);
1094
1095         return CMD_RET_USAGE;
1096 }
1097
1098 #ifdef CONFIG_SYS_LONGHELP
1099 static char env_help_text[] =
1100 #if defined(CONFIG_CMD_ASKENV)
1101         "ask name [message] [size] - ask for environment variable\nenv "
1102 #endif
1103 #if defined(CONFIG_CMD_ENV_CALLBACK)
1104         "callbacks - print callbacks and their associated variables\nenv "
1105 #endif
1106         "default [-f] -a - [forcibly] reset default environment\n"
1107         "env default [-f] var [...] - [forcibly] reset variable(s) to their default values\n"
1108 #if defined(CONFIG_CMD_EDITENV)
1109         "env edit name - edit environment variable\n"
1110 #endif
1111 #if defined(CONFIG_CMD_EXPORTENV)
1112         "env export [-t | -b | -c] [-s size] addr [var ...] - export environment\n"
1113 #endif
1114 #if defined(CONFIG_CMD_GREPENV)
1115         "env grep string [...] - search environment\n"
1116 #endif
1117 #if defined(CONFIG_CMD_IMPORTENV)
1118         "env import [-d] [-t | -b | -c] addr [size] - import environment\n"
1119 #endif
1120         "env print [-a | name ...] - print environment\n"
1121 #if defined(CONFIG_CMD_RUN)
1122         "env run var [...] - run commands in an environment variable\n"
1123 #endif
1124 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
1125         "env save - save environment\n"
1126 #endif
1127         "env set [-f] name [arg ...]\n";
1128 #endif
1129
1130 U_BOOT_CMD(
1131         env, CONFIG_SYS_MAXARGS, 1, do_env,
1132         "environment handling commands", env_help_text
1133 );
1134
1135 /*
1136  * Old command line interface, kept for compatibility
1137  */
1138
1139 #if defined(CONFIG_CMD_EDITENV)
1140 U_BOOT_CMD_COMPLETE(
1141         editenv, 2, 0,  do_env_edit,
1142         "edit environment variable",
1143         "name\n"
1144         "    - edit environment variable 'name'",
1145         var_complete
1146 );
1147 #endif
1148
1149 U_BOOT_CMD_COMPLETE(
1150         printenv, CONFIG_SYS_MAXARGS, 1,        do_env_print,
1151         "print environment variables",
1152         "[-a]\n    - print [all] values of all environment variables\n"
1153         "printenv name ...\n"
1154         "    - print value of environment variable 'name'",
1155         var_complete
1156 );
1157
1158 #ifdef CONFIG_CMD_GREPENV
1159 U_BOOT_CMD_COMPLETE(
1160         grepenv, CONFIG_SYS_MAXARGS, 0,  do_env_grep,
1161         "search environment variables",
1162         "string ...\n"
1163         "    - list environment name=value pairs matching 'string'",
1164         var_complete
1165 );
1166 #endif
1167
1168 U_BOOT_CMD_COMPLETE(
1169         setenv, CONFIG_SYS_MAXARGS, 0,  do_env_set,
1170         "set environment variables",
1171         "name value ...\n"
1172         "    - set environment variable 'name' to 'value ...'\n"
1173         "setenv name\n"
1174         "    - delete environment variable 'name'",
1175         var_complete
1176 );
1177
1178 #if defined(CONFIG_CMD_ASKENV)
1179
1180 U_BOOT_CMD(
1181         askenv, CONFIG_SYS_MAXARGS,     1,      do_env_ask,
1182         "get environment variables from stdin",
1183         "name [message] [size]\n"
1184         "    - get environment variable 'name' from stdin (max 'size' chars)\n"
1185         "askenv name\n"
1186         "    - get environment variable 'name' from stdin\n"
1187         "askenv name size\n"
1188         "    - get environment variable 'name' from stdin (max 'size' chars)\n"
1189         "askenv name [message] size\n"
1190         "    - display 'message' string and get environment variable 'name'"
1191         "from stdin (max 'size' chars)"
1192 );
1193 #endif
1194
1195 #if defined(CONFIG_CMD_RUN)
1196 U_BOOT_CMD_COMPLETE(
1197         run,    CONFIG_SYS_MAXARGS,     1,      do_run,
1198         "run commands in an environment variable",
1199         "var [...]\n"
1200         "    - run the commands in the environment variable(s) 'var'",
1201         var_complete
1202 );
1203 #endif
1204 #endif /* CONFIG_SPL_BUILD */