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 #define XMK_STR(x)      #x
  75 #define MK_STR(x)       XMK_STR(x)
  76
  77 /*
  78  * Maximum expected input data size for import command
  79  */
  80 #define MAX_ENV_SIZE    (1 << 20)       /* 1 MiB */
  81
  82 ulong load_addr = CONFIG_SYS_LOAD_ADDR; /* Default Load Address */
  83 ulong save_addr;                        /* Default Save Address */
  84 ulong save_size;                        /* Default Save Size (in bytes) */
  85
  86 /*
  87  * Table with supported baudrates (defined in config_xyz.h)
  88  */
  89 static const unsigned long baudrate_table[] = CONFIG_SYS_BAUDRATE_TABLE;
  90 #define N_BAUDRATES (sizeof(baudrate_table) / sizeof(baudrate_table[0]))
  91
  92 /*
  93  * This variable is incremented on each do_env_set(), so it can
  94  * be used via get_env_id() as an indication, if the environment
  95  * has changed or not. So it is possible to reread an environment
  96  * variable only if the environment was changed ... done so for
  97  * example in NetInitLoop()
  98  */
  99 static int env_id = 1;
 100
 101 int get_env_id(void)
 102 {
 103         return env_id;
 104 }
 105
 106 #ifndef CONFIG_SPL_BUILD
 107 /*
 108  * Command interface: print one or all environment variables
 109  *
 110  * Returns 0 in case of error, or length of printed string
 111  */
 112 static int env_print(char *name)
 113 {
 114         char *res = NULL;
 115         size_t len;
 116
 117         if (name) {             /* print a single name */
 118                 ENTRY e, *ep;
 119
 120                 e.key = name;
 121                 e.data = NULL;
 122                 hsearch_r(e, FIND, &ep, &env_htab);
 123                 if (ep == NULL)
 124                         return 0;
 125                 len = printf("%s=%s\n", ep->key, ep->data);
 126                 return len;
 127         }
 128
 129         /* print whole list */
 130         len = hexport_r(&env_htab, '\n', &res, 0, 0, NULL);
 131
 132         if (len > 0) {
 133                 puts(res);
 134                 free(res);
 135                 return len;
 136         }
 137
 138         /* should never happen */
 139         return 0;
 140 }
 141
 142 int do_env_print (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 143 {
 144         int i;
 145         int rcode = 0;
 146
 147         if (argc == 1) {
 148                 /* print all env vars */
 149                 rcode = env_print(NULL);
 150                 if (!rcode)
 151                         return 1;
 152                 printf("\nEnvironment size: %d/%ld bytes\n",
 153                         rcode, (ulong)ENV_SIZE);
 154                 return 0;
 155         }
 156
 157         /* print selected env vars */
 158         for (i = 1; i < argc; ++i) {
 159                 int rc = env_print(argv[i]);
 160                 if (!rc) {
 161                         printf("## Error: \"%s\" not defined\n", argv[i]);
 162                         ++rcode;
 163                 }
 164         }
 165
 166         return rcode;
 167 }
 168
 169 #ifdef CONFIG_CMD_GREPENV
 170 static int do_env_grep(cmd_tbl_t *cmdtp, int flag,
 171                        int argc, char * const argv[])
 172 {
 173         ENTRY *match;
 174         unsigned char matched[env_htab.size / 8];
 175         int rcode = 1, arg = 1, idx;
 176
 177         if (argc < 2)
 178                 return CMD_RET_USAGE;
 179
 180         memset(matched, 0, env_htab.size / 8);
 181
 182         while (arg <= argc) {
 183                 idx = 0;
 184                 while ((idx = hstrstr_r(argv[arg], idx, &match, &env_htab))) {
 185                         if (!(matched[idx / 8] & (1 << (idx & 7)))) {
 186                                 puts(match->key);
 187                                 puts("=");
 188                                 puts(match->data);
 189                                 puts("\n");
 190                         }
 191                         matched[idx / 8] |= 1 << (idx & 7);
 192                         rcode = 0;
 193                 }
 194                 arg++;
 195         }
 196
 197         return rcode;
 198 }
 199 #endif
 200 #endif /* CONFIG_SPL_BUILD */
 201
 202 /*
 203  * Perform consistency checking before setting, replacing, or deleting an
 204  * environment variable, then (if successful) apply the changes to internals so
 205  * to make them effective.  Code for this function was taken out of
 206  * _do_env_set(), which now calls it instead.
 207  * Also called as a callback function by himport_r().
 208  * Returns 0 in case of success, 1 in case of failure.
 209  * When (flag & H_FORCE) is set, do not print out any error message and force
 210  * overwriting of write-once variables.
 211  */
 212
 213 int env_check_apply(const char *name, const char *oldval,
 214                         const char *newval, int flag)
 215 {
 216         int   console = -1;
 217
 218         /* Check for console redirection */
 219         if (strcmp(name, "stdin") == 0)
 220                 console = stdin;
 221         else if (strcmp(name, "stdout") == 0)
 222                 console = stdout;
 223         else if (strcmp(name, "stderr") == 0)
 224                 console = stderr;
 225
 226         if (console != -1) {
 227                 if ((newval == NULL) || (*newval == '\0')) {
 228                         /* We cannot delete stdin/stdout/stderr */
 229                         if ((flag & H_FORCE) == 0)
 230                                 printf("Can't delete \"%s\"\n", name);
 231                         return 1;
 232                 }
 233
 234 #ifdef CONFIG_CONSOLE_MUX
 235                 if (iomux_doenv(console, newval))
 236                         return 1;
 237 #else
 238                 /* Try assigning specified device */
 239                 if (console_assign(console, newval) < 0)
 240                         return 1;
 241
 242 #ifdef CONFIG_SERIAL_MULTI
 243                 if (serial_assign(newval) < 0)
 244                         return 1;
 245 #endif
 246 #endif /* CONFIG_CONSOLE_MUX */
 247         }
 248
 249         /*
 250          * Some variables like "ethaddr" and "serial#" can be set only once and
 251          * cannot be deleted, unless CONFIG_ENV_OVERWRITE is defined.
 252          */
 253 #ifndef CONFIG_ENV_OVERWRITE
 254         if (oldval != NULL &&                   /* variable exists */
 255                 (flag & H_FORCE) == 0) {        /* and we are not forced */
 256                 if (strcmp(name, "serial#") == 0 ||
 257                     (strcmp(name, "ethaddr") == 0
 258 #if defined(CONFIG_OVERWRITE_ETHADDR_ONCE) && defined(CONFIG_ETHADDR)
 259                      && strcmp(oldval, MK_STR(CONFIG_ETHADDR)) != 0
 260 #endif  /* CONFIG_OVERWRITE_ETHADDR_ONCE && CONFIG_ETHADDR */
 261                         )) {
 262                         printf("Can't overwrite \"%s\"\n", name);
 263                         return 1;
 264                 }
 265         }
 266 #endif
 267         /*
 268          * When we change baudrate, or we are doing an env default -a
 269          * (which will erase all variables prior to calling this),
 270          * we want the baudrate to actually change - for real.
 271          */
 272         if (oldval != NULL ||                   /* variable exists */
 273                 (flag & H_NOCLEAR) == 0) {      /* or env is clear */
 274                 /*
 275                  * Switch to new baudrate if new baudrate is supported
 276                  */
 277                 if (strcmp(name, "baudrate") == 0) {
 278                         int baudrate = simple_strtoul(newval, NULL, 10);
 279                         int i;
 280                         for (i = 0; i < N_BAUDRATES; ++i) {
 281                                 if (baudrate == baudrate_table[i])
 282                                         break;
 283                         }
 284                         if (i == N_BAUDRATES) {
 285                                 if ((flag & H_FORCE) == 0)
 286                                         printf("## Baudrate %d bps not "
 287                                                 "supported\n", baudrate);
 288                                 return 1;
 289                         }
 290                         if (gd->baudrate == baudrate) {
 291                                 /* If unchanged, we just say it's OK */
 292                                 return 0;
 293                         }
 294                         printf("## Switch baudrate to %d bps and"
 295                                 "press ENTER ...\n", baudrate);
 296                         udelay(50000);
 297                         gd->baudrate = baudrate;
 298 #if defined(CONFIG_PPC) || defined(CONFIG_MCF52x2)
 299                         gd->bd->bi_baudrate = baudrate;
 300 #endif
 301
 302                         serial_setbrg();
 303                         udelay(50000);
 304                         while (getc() != '\r')
 305                                 ;
 306                 }
 307         }
 308
 309         /*
 310          * Some variables should be updated when the corresponding
 311          * entry in the environment is changed
 312          */
 313         if (strcmp(name, "loadaddr") == 0) {
 314                 load_addr = simple_strtoul(newval, NULL, 16);
 315                 return 0;
 316         }
 317 #if defined(CONFIG_CMD_NET)
 318         else if (strcmp(name, "bootfile") == 0) {
 319                 copy_filename(BootFile, newval, sizeof(BootFile));
 320                 return 0;
 321         }
 322 #endif
 323         return 0;
 324 }
 325
 326 /*
 327  * Set a new environment variable,
 328  * or replace or delete an existing one.
 329 */
 330 int _do_env_set(int flag, int argc, char * const argv[])
 331 {
 332         int   i, len;
 333         char  *name, *value, *s;
 334         ENTRY e, *ep;
 335
 336         name = argv[1];
 337         value = argv[2];
 338
 339         if (strchr(name, '=')) {
 340                 printf("## Error: illegal character '='"
 341                        "in variable name \"%s\"\n", name);
 342                 return 1;
 343         }
 344
 345         env_id++;
 346         /*
 347          * search if variable with this name already exists
 348          */
 349         e.key = name;
 350         e.data = NULL;
 351         hsearch_r(e, FIND, &ep, &env_htab);
 352
 353         /*
 354          * Perform requested checks. Notice how since we are overwriting
 355          * a single variable, we need to set H_NOCLEAR
 356          */
 357         if (env_check_apply(name, ep ? ep->data : NULL, value, H_NOCLEAR)) {
 358                 debug("check function did not approve, refusing\n");
 359                 return 1;
 360         }
 361
 362         /* Delete only ? */
 363         if (argc < 3 || argv[2] == NULL) {
 364                 int rc = hdelete_r(name, &env_htab, 0);
 365                 return !rc;
 366         }
 367
 368         /*
 369          * Insert / replace new value
 370          */
 371         for (i = 2, len = 0; i < argc; ++i)
 372                 len += strlen(argv[i]) + 1;
 373
 374         value = malloc(len);
 375         if (value == NULL) {
 376                 printf("## Can't malloc %d bytes\n", len);
 377                 return 1;
 378         }
 379         for (i = 2, s = value; i < argc; ++i) {
 380                 char *v = argv[i];
 381
 382                 while ((*s++ = *v++) != '\0')
 383                         ;
 384                 *(s - 1) = ' ';
 385         }
 386         if (s != value)
 387                 *--s = '\0';
 388
 389         e.key   = name;
 390         e.data  = value;
 391         hsearch_r(e, ENTER, &ep, &env_htab);
 392         free(value);
 393         if (!ep) {
 394                 printf("## Error inserting \"%s\" variable, errno=%d\n",
 395                         name, errno);
 396                 return 1;
 397         }
 398
 399         return 0;
 400 }
 401
 402 int setenv(const char *varname, const char *varvalue)
 403 {
 404         const char * const argv[4] = { "setenv", varname, varvalue, NULL };
 405
 406         if (varvalue == NULL || varvalue[0] == '\0')
 407                 return _do_env_set(0, 2, (char * const *)argv);
 408         else
 409                 return _do_env_set(0, 3, (char * const *)argv);
 410 }
 411
 412 /**
 413  * Set an environment variable to an integer value
 414  *
 415  * @param varname       Environmet variable to set
 416  * @param value         Value to set it to
 417  * @return 0 if ok, 1 on error
 418  */
 419 int setenv_ulong(const char *varname, ulong value)
 420 {
 421         /* TODO: this should be unsigned */
 422         char *str = simple_itoa(value);
 423
 424         return setenv(varname, str);
 425 }
 426
 427 /**
 428  * Set an environment variable to an address in hex
 429  *
 430  * @param varname       Environmet variable to set
 431  * @param addr          Value to set it to
 432  * @return 0 if ok, 1 on error
 433  */
 434 int setenv_addr(const char *varname, const void *addr)
 435 {
 436         char str[17];
 437
 438         sprintf(str, "%lx", (uintptr_t)addr);
 439         return setenv(varname, str);
 440 }
 441
 442 #ifndef CONFIG_SPL_BUILD
 443 int do_env_set(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 444 {
 445         if (argc < 2)
 446                 return CMD_RET_USAGE;
 447
 448         return _do_env_set(flag, argc, argv);
 449 }
 450
 451 /*
 452  * Prompt for environment variable
 453  */
 454 #if defined(CONFIG_CMD_ASKENV)
 455 int do_env_ask(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 456 {
 457         char message[CONFIG_SYS_CBSIZE];
 458         int size = CONFIG_SYS_CBSIZE - 1;
 459         int i, len, pos;
 460         char *local_args[4];
 461
 462         local_args[0] = argv[0];
 463         local_args[1] = argv[1];
 464         local_args[2] = NULL;
 465         local_args[3] = NULL;
 466
 467         /* Check the syntax */
 468         switch (argc) {
 469         case 1:
 470                 return CMD_RET_USAGE;
 471
 472         case 2:         /* env_ask envname */
 473                 sprintf(message, "Please enter '%s':", argv[1]);
 474                 break;
 475
 476         case 3:         /* env_ask envname size */
 477                 sprintf(message, "Please enter '%s':", argv[1]);
 478                 size = simple_strtoul(argv[2], NULL, 10);
 479                 break;
 480
 481         default:        /* env_ask envname message1 ... messagen size */
 482                 for (i = 2, pos = 0; i < argc - 1; i++) {
 483                         if (pos)
 484                                 message[pos++] = ' ';
 485
 486                         strcpy(message + pos, argv[i]);
 487                         pos += strlen(argv[i]);
 488                 }
 489
 490                 message[pos] = '\0';
 491                 size = simple_strtoul(argv[argc - 1], NULL, 10);
 492                 break;
 493         }
 494
 495         if (size >= CONFIG_SYS_CBSIZE)
 496                 size = CONFIG_SYS_CBSIZE - 1;
 497
 498         if (size <= 0)
 499                 return 1;
 500
 501         /* prompt for input */
 502         len = readline(message);
 503
 504         if (size < len)
 505                 console_buffer[size] = '\0';
 506
 507         len = 2;
 508         if (console_buffer[0] != '\0') {
 509                 local_args[2] = console_buffer;
 510                 len = 3;
 511         }
 512
 513         /* Continue calling setenv code */
 514         return _do_env_set(flag, len, local_args);
 515 }
 516 #endif
 517
 518 /*
 519  * Interactively edit an environment variable
 520  */
 521 #if defined(CONFIG_CMD_EDITENV)
 522 int do_env_edit(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 523 {
 524         char buffer[CONFIG_SYS_CBSIZE];
 525         char *init_val;
 526
 527         if (argc < 2)
 528                 return CMD_RET_USAGE;
 529
 530         /* Set read buffer to initial value or empty sting */
 531         init_val = getenv(argv[1]);
 532         if (init_val)
 533                 sprintf(buffer, "%s", init_val);
 534         else
 535                 buffer[0] = '\0';
 536
 537         readline_into_buffer("edit: ", buffer, 0);
 538
 539         return setenv(argv[1], buffer);
 540 }
 541 #endif /* CONFIG_CMD_EDITENV */
 542 #endif /* CONFIG_SPL_BUILD */
 543
 544 /*
 545  * Look up variable from environment,
 546  * return address of storage for that variable,
 547  * or NULL if not found
 548  */
 549 char *getenv(const char *name)
 550 {
 551         if (gd->flags & GD_FLG_ENV_READY) { /* after import into hashtable */
 552                 ENTRY e, *ep;
 553
 554                 WATCHDOG_RESET();
 555
 556                 e.key   = name;
 557                 e.data  = NULL;
 558                 hsearch_r(e, FIND, &ep, &env_htab);
 559
 560                 return ep ? ep->data : NULL;
 561         }
 562
 563         /* restricted capabilities before import */
 564         if (getenv_f(name, (char *)(gd->env_buf), sizeof(gd->env_buf)) > 0)
 565                 return (char *)(gd->env_buf);
 566
 567         return NULL;
 568 }
 569
 570 /*
 571  * Look up variable from environment for restricted C runtime env.
 572  */
 573 int getenv_f(const char *name, char *buf, unsigned len)
 574 {
 575         int i, nxt;
 576
 577         for (i = 0; env_get_char(i) != '\0'; i = nxt + 1) {
 578                 int val, n;
 579
 580                 for (nxt = i; env_get_char(nxt) != '\0'; ++nxt) {
 581                         if (nxt >= CONFIG_ENV_SIZE)
 582                                 return -1;
 583                 }
 584
 585                 val = envmatch((uchar *)name, i);
 586                 if (val < 0)
 587                         continue;
 588
 589                 /* found; copy out */
 590                 for (n = 0; n < len; ++n, ++buf) {
 591                         *buf = env_get_char(val++);
 592                         if (*buf == '\0')
 593                                 return n;
 594                 }
 595
 596                 if (n)
 597                         *--buf = '\0';
 598
 599                 printf("env_buf [%d bytes] too small for value of \"%s\"\n",
 600                         len, name);
 601
 602                 return n;
 603         }
 604
 605         return -1;
 606 }
 607
 608 /**
 609  * Decode the integer value of an environment variable and return it.
 610  *
 611  * @param name          Name of environemnt variable
 612  * @param base          Number base to use (normally 10, or 16 for hex)
 613  * @param default_val   Default value to return if the variable is not
 614  *                      found
 615  * @return the decoded value, or default_val if not found
 616  */
 617 ulong getenv_ulong(const char *name, int base, ulong default_val)
 618 {
 619         /*
 620          * We can use getenv() here, even before relocation, since the
 621          * environment variable value is an integer and thus short.
 622          */
 623         const char *str = getenv(name);
 624
 625         return str ? simple_strtoul(str, NULL, base) : default_val;
 626 }
 627
 628 #ifndef CONFIG_SPL_BUILD
 629 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
 630 int do_env_save(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 631 {
 632         printf("Saving Environment to %s...\n", env_name_spec);
 633
 634         return saveenv() ? 1 : 0;
 635 }
 636
 637 U_BOOT_CMD(
 638         saveenv, 1, 0,  do_env_save,
 639         "save environment variables to persistent storage",
 640         ""
 641 );
 642 #endif
 643 #endif /* CONFIG_SPL_BUILD */
 644
 645
 646 /*
 647  * Match a name / name=value pair
 648  *
 649  * s1 is either a simple 'name', or a 'name=value' pair.
 650  * i2 is the environment index for a 'name2=value2' pair.
 651  * If the names match, return the index for the value2, else -1.
 652  */
 653 int envmatch(uchar *s1, int i2)
 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 /* do_apply */) == 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 U_BOOT_CMD(
1026         env, CONFIG_SYS_MAXARGS, 1, do_env,
1027         "environment handling commands",
1028 #if defined(CONFIG_CMD_ASKENV)
1029         "ask name [message] [size] - ask for environment variable\nenv "
1030 #endif
1031         "default [-f] -a - [forcibly] reset default environment\n"
1032         "env default [-f] var [...] - [forcibly] reset variable(s) to their default values\n"
1033 #if defined(CONFIG_CMD_EDITENV)
1034         "env edit name - edit environment variable\n"
1035 #endif
1036 #if defined(CONFIG_CMD_EXPORTENV)
1037         "env export [-t | -b | -c] [-s size] addr [var ...] - export environment\n"
1038 #endif
1039 #if defined(CONFIG_CMD_GREPENV)
1040         "env grep string [...] - search environment\n"
1041 #endif
1042 #if defined(CONFIG_CMD_IMPORTENV)
1043         "env import [-d] [-t | -b | -c] addr [size] - import environment\n"
1044 #endif
1045         "env print [name ...] - print environment\n"
1046 #if defined(CONFIG_CMD_RUN)
1047         "env run var [...] - run commands in an environment variable\n"
1048 #endif
1049 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
1050         "env save - save environment\n"
1051 #endif
1052         "env set [-f] name [arg ...]\n"
1053 );
1054
1055 /*
1056  * Old command line interface, kept for compatibility
1057  */
1058
1059 #if defined(CONFIG_CMD_EDITENV)
1060 U_BOOT_CMD_COMPLETE(
1061         editenv, 2, 0,  do_env_edit,
1062         "edit environment variable",
1063         "name\n"
1064         "    - edit environment variable 'name'",
1065         var_complete
1066 );
1067 #endif
1068
1069 U_BOOT_CMD_COMPLETE(
1070         printenv, CONFIG_SYS_MAXARGS, 1,        do_env_print,
1071         "print environment variables",
1072         "\n    - print values of all environment variables\n"
1073         "printenv name ...\n"
1074         "    - print value of environment variable 'name'",
1075         var_complete
1076 );
1077
1078 #ifdef CONFIG_CMD_GREPENV
1079 U_BOOT_CMD_COMPLETE(
1080         grepenv, CONFIG_SYS_MAXARGS, 0,  do_env_grep,
1081         "search environment variables",
1082         "string ...\n"
1083         "    - list environment name=value pairs matching 'string'",
1084         var_complete
1085 );
1086 #endif
1087
1088 U_BOOT_CMD_COMPLETE(
1089         setenv, CONFIG_SYS_MAXARGS, 0,  do_env_set,
1090         "set environment variables",
1091         "name value ...\n"
1092         "    - set environment variable 'name' to 'value ...'\n"
1093         "setenv name\n"
1094         "    - delete environment variable 'name'",
1095         var_complete
1096 );
1097
1098 #if defined(CONFIG_CMD_ASKENV)
1099
1100 U_BOOT_CMD(
1101         askenv, CONFIG_SYS_MAXARGS,     1,      do_env_ask,
1102         "get environment variables from stdin",
1103         "name [message] [size]\n"
1104         "    - get environment variable 'name' from stdin (max 'size' chars)\n"
1105         "askenv name\n"
1106         "    - get environment variable 'name' from stdin\n"
1107         "askenv name size\n"
1108         "    - get environment variable 'name' from stdin (max 'size' chars)\n"
1109         "askenv name [message] size\n"
1110         "    - display 'message' string and get environment variable 'name'"
1111         "from stdin (max 'size' chars)"
1112 );
1113 #endif
1114
1115 #if defined(CONFIG_CMD_RUN)
1116 U_BOOT_CMD_COMPLETE(
1117         run,    CONFIG_SYS_MAXARGS,     1,      do_run,
1118         "run commands in an environment variable",
1119         "var [...]\n"
1120         "    - run the commands in the environment variable(s) 'var'",
1121         var_complete
1122 );
1123 #endif
1124 #endif /* CONFIG_SPL_BUILD */