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