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