common/cmd_nvedit.c

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