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