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