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