common/cmd_nvedit.c

   1 /*
   2  * (C) Copyright 2000-2013
   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  * SPDX-License-Identifier:     GPL-2.0+
  11  */
  12
  13 /*
  14  * Support for persistent environment data
  15  *
  16  * The "environment" is stored on external storage as a list of '\0'
  17  * terminated "name=value" strings. The end of the list is marked by
  18  * a double '\0'. The environment is preceeded by a 32 bit CRC over
  19  * the data part and, in case of redundant environment, a byte of
  20  * flags.
  21  *
  22  * This linearized representation will also be used before
  23  * relocation, i. e. as long as we don't have a full C runtime
  24  * environment. After that, we use a hash table.
  25  */
  26
  27 #include <common.h>
  28 #include <command.h>
  29 #include <environment.h>
  30 #include <search.h>
  31 #include <errno.h>
  32 #include <malloc.h>
  33 #include <watchdog.h>
  34 #include <linux/stddef.h>
  35 #include <asm/byteorder.h>
  36 #include <asm/io.h>
  37
  38 DECLARE_GLOBAL_DATA_PTR;
  39
  40 #if     !defined(CONFIG_ENV_IS_IN_EEPROM)       && \
  41         !defined(CONFIG_ENV_IS_IN_FLASH)        && \
  42         !defined(CONFIG_ENV_IS_IN_DATAFLASH)    && \
  43         !defined(CONFIG_ENV_IS_IN_MMC)          && \
  44         !defined(CONFIG_ENV_IS_IN_FAT)          && \
  45         !defined(CONFIG_ENV_IS_IN_NAND)         && \
  46         !defined(CONFIG_ENV_IS_IN_NVRAM)        && \
  47         !defined(CONFIG_ENV_IS_IN_ONENAND)      && \
  48         !defined(CONFIG_ENV_IS_IN_SPI_FLASH)    && \
  49         !defined(CONFIG_ENV_IS_IN_REMOTE)       && \
  50         !defined(CONFIG_ENV_IS_IN_UBI)          && \
  51         !defined(CONFIG_ENV_IS_NOWHERE)
  52 # error Define one of CONFIG_ENV_IS_IN_{EEPROM|FLASH|DATAFLASH|ONENAND|\
  53 SPI_FLASH|NVRAM|MMC|FAT|REMOTE|UBI} or CONFIG_ENV_IS_NOWHERE
  54 #endif
  55
  56 /*
  57  * Maximum expected input data size for import command
  58  */
  59 #define MAX_ENV_SIZE    (1 << 20)       /* 1 MiB */
  60
  61 /*
  62  * This variable is incremented on each do_env_set(), so it can
  63  * be used via get_env_id() as an indication, if the environment
  64  * has changed or not. So it is possible to reread an environment
  65  * variable only if the environment was changed ... done so for
  66  * example in NetInitLoop()
  67  */
  68 static int env_id = 1;
  69
  70 int get_env_id(void)
  71 {
  72         return env_id;
  73 }
  74
  75 #ifndef CONFIG_SPL_BUILD
  76 /*
  77  * Command interface: print one or all environment variables
  78  *
  79  * Returns 0 in case of error, or length of printed string
  80  */
  81 static int env_print(char *name, int flag)
  82 {
  83         char *res = NULL;
  84         ssize_t len;
  85
  86         if (name) {             /* print a single name */
  87                 ENTRY e, *ep;
  88
  89                 e.key = name;
  90                 e.data = NULL;
  91                 hsearch_r(e, FIND, &ep, &env_htab, flag);
  92                 if (ep == NULL)
  93                         return 0;
  94                 len = printf("%s=%s\n", ep->key, ep->data);
  95                 return len;
  96         }
  97
  98         /* print whole list */
  99         len = hexport_r(&env_htab, '\n', flag, &res, 0, 0, NULL);
 100
 101         if (len > 0) {
 102                 puts(res);
 103                 free(res);
 104                 return len;
 105         }
 106
 107         /* should never happen */
 108         printf("## Error: cannot export environment\n");
 109         return 0;
 110 }
 111
 112 static int do_env_print(cmd_tbl_t *cmdtp, int flag, int argc,
 113                         char * const argv[])
 114 {
 115         int i;
 116         int rcode = 0;
 117         int env_flag = H_HIDE_DOT;
 118
 119         if (argc > 1 && argv[1][0] == '-' && argv[1][1] == 'a') {
 120                 argc--;
 121                 argv++;
 122                 env_flag &= ~H_HIDE_DOT;
 123         }
 124
 125         if (argc == 1) {
 126                 /* print all env vars */
 127                 rcode = env_print(NULL, env_flag);
 128                 if (!rcode)
 129                         return 1;
 130                 printf("\nEnvironment size: %d/%ld bytes\n",
 131                         rcode, (ulong)ENV_SIZE);
 132                 return 0;
 133         }
 134
 135         /* print selected env vars */
 136         env_flag &= ~H_HIDE_DOT;
 137         for (i = 1; i < argc; ++i) {
 138                 int rc = env_print(argv[i], env_flag);
 139                 if (!rc) {
 140                         printf("## Error: \"%s\" not defined\n", argv[i]);
 141                         ++rcode;
 142                 }
 143         }
 144
 145         return rcode;
 146 }
 147
 148 #ifdef CONFIG_CMD_GREPENV
 149 static int do_env_grep(cmd_tbl_t *cmdtp, int flag,
 150                        int argc, char * const argv[])
 151 {
 152         char *res = NULL;
 153         int len, grep_how, grep_what;
 154
 155         if (argc < 2)
 156                 return CMD_RET_USAGE;
 157
 158         grep_how  = H_MATCH_SUBSTR;     /* default: substring search    */
 159         grep_what = H_MATCH_BOTH;       /* default: grep names and values */
 160
 161         while (--argc > 0 && **++argv == '-') {
 162                 char *arg = *argv;
 163                 while (*++arg) {
 164                         switch (*arg) {
 165 #ifdef CONFIG_REGEX
 166                         case 'e':               /* use regex matching */
 167                                 grep_how  = H_MATCH_REGEX;
 168                                 break;
 169 #endif
 170                         case 'n':               /* grep for name */
 171                                 grep_what = H_MATCH_KEY;
 172                                 break;
 173                         case 'v':               /* grep for value */
 174                                 grep_what = H_MATCH_DATA;
 175                                 break;
 176                         case 'b':               /* grep for both */
 177                                 grep_what = H_MATCH_BOTH;
 178                                 break;
 179                         case '-':
 180                                 goto DONE;
 181                         default:
 182                                 return CMD_RET_USAGE;
 183                         }
 184                 }
 185         }
 186
 187 DONE:
 188         len = hexport_r(&env_htab, '\n',
 189                         flag | grep_what | grep_how,
 190                         &res, 0, argc, argv);
 191
 192         if (len > 0) {
 193                 puts(res);
 194                 free(res);
 195         }
 196
 197         if (len < 2)
 198                 return 1;
 199
 200         return 0;
 201 }
 202 #endif
 203 #endif /* CONFIG_SPL_BUILD */
 204
 205 /*
 206  * Set a new environment variable,
 207  * or replace or delete an existing one.
 208  */
 209 static int _do_env_set(int flag, int argc, char * const argv[])
 210 {
 211         int   i, len;
 212         char  *name, *value, *s;
 213         ENTRY e, *ep;
 214         int env_flag = H_INTERACTIVE;
 215
 216         debug("Initial value for argc=%d\n", argc);
 217         while (argc > 1 && **(argv + 1) == '-') {
 218                 char *arg = *++argv;
 219
 220                 --argc;
 221                 while (*++arg) {
 222                         switch (*arg) {
 223                         case 'f':               /* force */
 224                                 env_flag |= H_FORCE;
 225                                 break;
 226                         default:
 227                                 return CMD_RET_USAGE;
 228                         }
 229                 }
 230         }
 231         debug("Final value for argc=%d\n", argc);
 232         name = argv[1];
 233         value = argv[2];
 234
 235         if (strchr(name, '=')) {
 236                 printf("## Error: illegal character '='"
 237                        "in variable name \"%s\"\n", name);
 238                 return 1;
 239         }
 240
 241         env_id++;
 242
 243         /* Delete only ? */
 244         if (argc < 3 || argv[2] == NULL) {
 245                 int rc = hdelete_r(name, &env_htab, env_flag);
 246                 return !rc;
 247         }
 248
 249         /*
 250          * Insert / replace new value
 251          */
 252         for (i = 2, len = 0; i < argc; ++i)
 253                 len += strlen(argv[i]) + 1;
 254
 255         value = malloc(len);
 256         if (value == NULL) {
 257                 printf("## Can't malloc %d bytes\n", len);
 258                 return 1;
 259         }
 260         for (i = 2, s = value; i < argc; ++i) {
 261                 char *v = argv[i];
 262
 263                 while ((*s++ = *v++) != '\0')
 264                         ;
 265                 *(s - 1) = ' ';
 266         }
 267         if (s != value)
 268                 *--s = '\0';
 269
 270         e.key   = name;
 271         e.data  = value;
 272         hsearch_r(e, ENTER, &ep, &env_htab, env_flag);
 273         free(value);
 274         if (!ep) {
 275                 printf("## Error inserting \"%s\" variable, errno=%d\n",
 276                         name, errno);
 277                 return 1;
 278         }
 279
 280         return 0;
 281 }
 282
 283 int setenv(const char *varname, const char *varvalue)
 284 {
 285         const char * const argv[4] = { "setenv", varname, varvalue, NULL };
 286
 287         /* before import into hashtable */
 288         if (!(gd->flags & GD_FLG_ENV_READY))
 289                 return 1;
 290
 291         if (varvalue == NULL || varvalue[0] == '\0')
 292                 return _do_env_set(0, 2, (char * const *)argv);
 293         else
 294                 return _do_env_set(0, 3, (char * const *)argv);
 295 }
 296
 297 /**
 298  * Set an environment variable to an integer value
 299  *
 300  * @param varname       Environment variable to set
 301  * @param value         Value to set it to
 302  * @return 0 if ok, 1 on error
 303  */
 304 int setenv_ulong(const char *varname, ulong value)
 305 {
 306         /* TODO: this should be unsigned */
 307         char *str = simple_itoa(value);
 308
 309         return setenv(varname, str);
 310 }
 311
 312 /**
 313  * Set an environment variable to an value in hex
 314  *
 315  * @param varname       Environment variable to set
 316  * @param value         Value to set it to
 317  * @return 0 if ok, 1 on error
 318  */
 319 int setenv_hex(const char *varname, ulong value)
 320 {
 321         char str[17];
 322
 323         sprintf(str, "%lx", value);
 324         return setenv(varname, str);
 325 }
 326
 327 ulong getenv_hex(const char *varname, ulong default_val)
 328 {
 329         const char *s;
 330         ulong value;
 331         char *endp;
 332
 333         s = getenv(varname);
 334         if (s)
 335                 value = simple_strtoul(s, &endp, 16);
 336         if (!s || endp == s)
 337                 return default_val;
 338
 339         return value;
 340 }
 341
 342 #ifndef CONFIG_SPL_BUILD
 343 static int do_env_set(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 344 {
 345         if (argc < 2)
 346                 return CMD_RET_USAGE;
 347
 348         return _do_env_set(flag, argc, argv);
 349 }
 350
 351 /*
 352  * Prompt for environment variable
 353  */
 354 #if defined(CONFIG_CMD_ASKENV)
 355 int do_env_ask(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 356 {
 357         char message[CONFIG_SYS_CBSIZE];
 358         int i, len, pos, size;
 359         char *local_args[4];
 360         char *endptr;
 361
 362         local_args[0] = argv[0];
 363         local_args[1] = argv[1];
 364         local_args[2] = NULL;
 365         local_args[3] = NULL;
 366
 367         /*
 368          * Check the syntax:
 369          *
 370          * env_ask envname [message1 ...] [size]
 371          */
 372         if (argc == 1)
 373                 return CMD_RET_USAGE;
 374
 375         /*
 376          * We test the last argument if it can be converted
 377          * into a decimal number.  If yes, we assume it's
 378          * the size.  Otherwise we echo it as part of the
 379          * message.
 380          */
 381         i = simple_strtoul(argv[argc - 1], &endptr, 10);
 382         if (*endptr != '\0') {                  /* no size */
 383                 size = CONFIG_SYS_CBSIZE - 1;
 384         } else {                                /* size given */
 385                 size = i;
 386                 --argc;
 387         }
 388
 389         if (argc <= 2) {
 390                 sprintf(message, "Please enter '%s': ", argv[1]);
 391         } else {
 392                 /* env_ask envname message1 ... messagen [size] */
 393                 for (i = 2, pos = 0; i < argc; i++) {
 394                         if (pos)
 395                                 message[pos++] = ' ';
 396
 397                         strcpy(message + pos, argv[i]);
 398                         pos += strlen(argv[i]);
 399                 }
 400                 message[pos++] = ' ';
 401                 message[pos] = '\0';
 402         }
 403
 404         if (size >= CONFIG_SYS_CBSIZE)
 405                 size = CONFIG_SYS_CBSIZE - 1;
 406
 407         if (size <= 0)
 408                 return 1;
 409
 410         /* prompt for input */
 411         len = readline(message);
 412
 413         if (size < len)
 414                 console_buffer[size] = '\0';
 415
 416         len = 2;
 417         if (console_buffer[0] != '\0') {
 418                 local_args[2] = console_buffer;
 419                 len = 3;
 420         }
 421
 422         /* Continue calling setenv code */
 423         return _do_env_set(flag, len, local_args);
 424 }
 425 #endif
 426
 427 #if defined(CONFIG_CMD_ENV_CALLBACK)
 428 static int print_static_binding(const char *var_name, const char *callback_name)
 429 {
 430         printf("\t%-20s %-20s\n", var_name, callback_name);
 431
 432         return 0;
 433 }
 434
 435 static int print_active_callback(ENTRY *entry)
 436 {
 437         struct env_clbk_tbl *clbkp;
 438         int i;
 439         int num_callbacks;
 440
 441         if (entry->callback == NULL)
 442                 return 0;
 443
 444         /* look up the callback in the linker-list */
 445         num_callbacks = ll_entry_count(struct env_clbk_tbl, env_clbk);
 446         for (i = 0, clbkp = ll_entry_start(struct env_clbk_tbl, env_clbk);
 447              i < num_callbacks;
 448              i++, clbkp++) {
 449 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
 450                 if (entry->callback == clbkp->callback + gd->reloc_off)
 451 #else
 452                 if (entry->callback == clbkp->callback)
 453 #endif
 454                         break;
 455         }
 456
 457         if (i == num_callbacks)
 458                 /* this should probably never happen, but just in case... */
 459                 printf("\t%-20s %p\n", entry->key, entry->callback);
 460         else
 461                 printf("\t%-20s %-20s\n", entry->key, clbkp->name);
 462
 463         return 0;
 464 }
 465
 466 /*
 467  * Print the callbacks available and what they are bound to
 468  */
 469 int do_env_callback(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 470 {
 471         struct env_clbk_tbl *clbkp;
 472         int i;
 473         int num_callbacks;
 474
 475         /* Print the available callbacks */
 476         puts("Available callbacks:\n");
 477         puts("\tCallback Name\n");
 478         puts("\t-------------\n");
 479         num_callbacks = ll_entry_count(struct env_clbk_tbl, env_clbk);
 480         for (i = 0, clbkp = ll_entry_start(struct env_clbk_tbl, env_clbk);
 481              i < num_callbacks;
 482              i++, clbkp++)
 483                 printf("\t%s\n", clbkp->name);
 484         puts("\n");
 485
 486         /* Print the static bindings that may exist */
 487         puts("Static callback bindings:\n");
 488         printf("\t%-20s %-20s\n", "Variable Name", "Callback Name");
 489         printf("\t%-20s %-20s\n", "-------------", "-------------");
 490         env_attr_walk(ENV_CALLBACK_LIST_STATIC, print_static_binding);
 491         puts("\n");
 492
 493         /* walk through each variable and print the callback if it has one */
 494         puts("Active callback bindings:\n");
 495         printf("\t%-20s %-20s\n", "Variable Name", "Callback Name");
 496         printf("\t%-20s %-20s\n", "-------------", "-------------");
 497         hwalk_r(&env_htab, print_active_callback);
 498         return 0;
 499 }
 500 #endif
 501
 502 #if defined(CONFIG_CMD_ENV_FLAGS)
 503 static int print_static_flags(const char *var_name, const char *flags)
 504 {
 505         enum env_flags_vartype type = env_flags_parse_vartype(flags);
 506         enum env_flags_varaccess access = env_flags_parse_varaccess(flags);
 507
 508         printf("\t%-20s %-20s %-20s\n", var_name,
 509                 env_flags_get_vartype_name(type),
 510                 env_flags_get_varaccess_name(access));
 511
 512         return 0;
 513 }
 514
 515 static int print_active_flags(ENTRY *entry)
 516 {
 517         enum env_flags_vartype type;
 518         enum env_flags_varaccess access;
 519
 520         if (entry->flags == 0)
 521                 return 0;
 522
 523         type = (enum env_flags_vartype)
 524                 (entry->flags & ENV_FLAGS_VARTYPE_BIN_MASK);
 525         access = env_flags_parse_varaccess_from_binflags(entry->flags);
 526         printf("\t%-20s %-20s %-20s\n", entry->key,
 527                 env_flags_get_vartype_name(type),
 528                 env_flags_get_varaccess_name(access));
 529
 530         return 0;
 531 }
 532
 533 /*
 534  * Print the flags available and what variables have flags
 535  */
 536 int do_env_flags(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 537 {
 538         /* Print the available variable types */
 539         printf("Available variable type flags (position %d):\n",
 540                 ENV_FLAGS_VARTYPE_LOC);
 541         puts("\tFlag\tVariable Type Name\n");
 542         puts("\t----\t------------------\n");
 543         env_flags_print_vartypes();
 544         puts("\n");
 545
 546         /* Print the available variable access types */
 547         printf("Available variable access flags (position %d):\n",
 548                 ENV_FLAGS_VARACCESS_LOC);
 549         puts("\tFlag\tVariable Access Name\n");
 550         puts("\t----\t--------------------\n");
 551         env_flags_print_varaccess();
 552         puts("\n");
 553
 554         /* Print the static flags that may exist */
 555         puts("Static flags:\n");
 556         printf("\t%-20s %-20s %-20s\n", "Variable Name", "Variable Type",
 557                 "Variable Access");
 558         printf("\t%-20s %-20s %-20s\n", "-------------", "-------------",
 559                 "---------------");
 560         env_attr_walk(ENV_FLAGS_LIST_STATIC, print_static_flags);
 561         puts("\n");
 562
 563         /* walk through each variable and print the flags if non-default */
 564         puts("Active flags:\n");
 565         printf("\t%-20s %-20s %-20s\n", "Variable Name", "Variable Type",
 566                 "Variable Access");
 567         printf("\t%-20s %-20s %-20s\n", "-------------", "-------------",
 568                 "---------------");
 569         hwalk_r(&env_htab, print_active_flags);
 570         return 0;
 571 }
 572 #endif
 573
 574 /*
 575  * Interactively edit an environment variable
 576  */
 577 #if defined(CONFIG_CMD_EDITENV)
 578 static int do_env_edit(cmd_tbl_t *cmdtp, int flag, int argc,
 579                        char * const argv[])
 580 {
 581         char buffer[CONFIG_SYS_CBSIZE];
 582         char *init_val;
 583
 584         if (argc < 2)
 585                 return CMD_RET_USAGE;
 586
 587         /* Set read buffer to initial value or empty sting */
 588         init_val = getenv(argv[1]);
 589         if (init_val)
 590                 sprintf(buffer, "%s", init_val);
 591         else
 592                 buffer[0] = '\0';
 593
 594         if (readline_into_buffer("edit: ", buffer, 0) < 0)
 595                 return 1;
 596
 597         return setenv(argv[1], buffer);
 598 }
 599 #endif /* CONFIG_CMD_EDITENV */
 600 #endif /* CONFIG_SPL_BUILD */
 601
 602 /*
 603  * Look up variable from environment,
 604  * return address of storage for that variable,
 605  * or NULL if not found
 606  */
 607 char *getenv(const char *name)
 608 {
 609         if (gd->flags & GD_FLG_ENV_READY) { /* after import into hashtable */
 610                 ENTRY e, *ep;
 611
 612                 WATCHDOG_RESET();
 613
 614                 e.key   = name;
 615                 e.data  = NULL;
 616                 hsearch_r(e, FIND, &ep, &env_htab, 0);
 617
 618                 return ep ? ep->data : NULL;
 619         }
 620
 621         /* restricted capabilities before import */
 622         if (getenv_f(name, (char *)(gd->env_buf), sizeof(gd->env_buf)) > 0)
 623                 return (char *)(gd->env_buf);
 624
 625         return NULL;
 626 }
 627
 628 /*
 629  * Look up variable from environment for restricted C runtime env.
 630  */
 631 int getenv_f(const char *name, char *buf, unsigned len)
 632 {
 633         int i, nxt;
 634
 635         for (i = 0; env_get_char(i) != '\0'; i = nxt + 1) {
 636                 int val, n;
 637
 638                 for (nxt = i; env_get_char(nxt) != '\0'; ++nxt) {
 639                         if (nxt >= CONFIG_ENV_SIZE)
 640                                 return -1;
 641                 }
 642
 643                 val = envmatch((uchar *)name, i);
 644                 if (val < 0)
 645                         continue;
 646
 647                 /* found; copy out */
 648                 for (n = 0; n < len; ++n, ++buf) {
 649                         *buf = env_get_char(val++);
 650                         if (*buf == '\0')
 651                                 return n;
 652                 }
 653
 654                 if (n)
 655                         *--buf = '\0';
 656
 657                 printf("env_buf [%d bytes] too small for value of \"%s\"\n",
 658                         len, name);
 659
 660                 return n;
 661         }
 662
 663         return -1;
 664 }
 665
 666 /**
 667  * Decode the integer value of an environment variable and return it.
 668  *
 669  * @param name          Name of environemnt variable
 670  * @param base          Number base to use (normally 10, or 16 for hex)
 671  * @param default_val   Default value to return if the variable is not
 672  *                      found
 673  * @return the decoded value, or default_val if not found
 674  */
 675 ulong getenv_ulong(const char *name, int base, ulong default_val)
 676 {
 677         /*
 678          * We can use getenv() here, even before relocation, since the
 679          * environment variable value is an integer and thus short.
 680          */
 681         const char *str = getenv(name);
 682
 683         return str ? simple_strtoul(str, NULL, base) : default_val;
 684 }
 685
 686 #ifndef CONFIG_SPL_BUILD
 687 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
 688 static int do_env_save(cmd_tbl_t *cmdtp, int flag, int argc,
 689                        char * const argv[])
 690 {
 691         printf("Saving Environment to %s...\n", env_name_spec);
 692
 693         return saveenv() ? 1 : 0;
 694 }
 695
 696 U_BOOT_CMD(
 697         saveenv, 1, 0,  do_env_save,
 698         "save environment variables to persistent storage",
 699         ""
 700 );
 701 #endif
 702 #endif /* CONFIG_SPL_BUILD */
 703
 704
 705 /*
 706  * Match a name / name=value pair
 707  *
 708  * s1 is either a simple 'name', or a 'name=value' pair.
 709  * i2 is the environment index for a 'name2=value2' pair.
 710  * If the names match, return the index for the value2, else -1.
 711  */
 712 int envmatch(uchar *s1, int i2)
 713 {
 714         if (s1 == NULL)
 715                 return -1;
 716
 717         while (*s1 == env_get_char(i2++))
 718                 if (*s1++ == '=')
 719                         return i2;
 720
 721         if (*s1 == '\0' && env_get_char(i2-1) == '=')
 722                 return i2;
 723
 724         return -1;
 725 }
 726
 727 #ifndef CONFIG_SPL_BUILD
 728 static int do_env_default(cmd_tbl_t *cmdtp, int __flag,
 729                           int argc, char * const argv[])
 730 {
 731         int all = 0, flag = 0;
 732
 733         debug("Initial value for argc=%d\n", argc);
 734         while (--argc > 0 && **++argv == '-') {
 735                 char *arg = *argv;
 736
 737                 while (*++arg) {
 738                         switch (*arg) {
 739                         case 'a':               /* default all */
 740                                 all = 1;
 741                                 break;
 742                         case 'f':               /* force */
 743                                 flag |= H_FORCE;
 744                                 break;
 745                         default:
 746                                 return cmd_usage(cmdtp);
 747                         }
 748                 }
 749         }
 750         debug("Final value for argc=%d\n", argc);
 751         if (all && (argc == 0)) {
 752                 /* Reset the whole environment */
 753                 set_default_env("## Resetting to default environment\n");
 754                 return 0;
 755         }
 756         if (!all && (argc > 0)) {
 757                 /* Reset individual variables */
 758                 set_default_vars(argc, argv);
 759                 return 0;
 760         }
 761
 762         return cmd_usage(cmdtp);
 763 }
 764
 765 static int do_env_delete(cmd_tbl_t *cmdtp, int flag,
 766                          int argc, char * const argv[])
 767 {
 768         int env_flag = H_INTERACTIVE;
 769         int ret = 0;
 770
 771         debug("Initial value for argc=%d\n", argc);
 772         while (argc > 1 && **(argv + 1) == '-') {
 773                 char *arg = *++argv;
 774
 775                 --argc;
 776                 while (*++arg) {
 777                         switch (*arg) {
 778                         case 'f':               /* force */
 779                                 env_flag |= H_FORCE;
 780                                 break;
 781                         default:
 782                                 return CMD_RET_USAGE;
 783                         }
 784                 }
 785         }
 786         debug("Final value for argc=%d\n", argc);
 787
 788         env_id++;
 789
 790         while (--argc > 0) {
 791                 char *name = *++argv;
 792
 793                 if (!hdelete_r(name, &env_htab, env_flag))
 794                         ret = 1;
 795         }
 796
 797         return ret;
 798 }
 799
 800 #ifdef CONFIG_CMD_EXPORTENV
 801 /*
 802  * env export [-t | -b | -c] [-s size] addr [var ...]
 803  *      -t:     export as text format; if size is given, data will be
 804  *              padded with '\0' bytes; if not, one terminating '\0'
 805  *              will be added (which is included in the "filesize"
 806  *              setting so you can for exmple copy this to flash and
 807  *              keep the termination).
 808  *      -b:     export as binary format (name=value pairs separated by
 809  *              '\0', list end marked by double "\0\0")
 810  *      -c:     export as checksum protected environment format as
 811  *              used for example by "saveenv" command
 812  *      -s size:
 813  *              size of output buffer
 814  *      addr:   memory address where environment gets stored
 815  *      var...  List of variable names that get included into the
 816  *              export. Without arguments, the whole environment gets
 817  *              exported.
 818  *
 819  * With "-c" and size is NOT given, then the export command will
 820  * format the data as currently used for the persistent storage,
 821  * i. e. it will use CONFIG_ENV_SECT_SIZE as output block size and
 822  * prepend a valid CRC32 checksum and, in case of resundant
 823  * environment, a "current" redundancy flag. If size is given, this
 824  * value will be used instead of CONFIG_ENV_SECT_SIZE; again, CRC32
 825  * checksum and redundancy flag will be inserted.
 826  *
 827  * With "-b" and "-t", always only the real data (including a
 828  * terminating '\0' byte) will be written; here the optional size
 829  * argument will be used to make sure not to overflow the user
 830  * provided buffer; the command will abort if the size is not
 831  * sufficient. Any remainign space will be '\0' padded.
 832  *
 833  * On successful return, the variable "filesize" will be set.
 834  * Note that filesize includes the trailing/terminating '\0' byte(s).
 835  *
 836  * Usage szenario:  create a text snapshot/backup of the current settings:
 837  *
 838  *      => env export -t 100000
 839  *      => era ${backup_addr} +${filesize}
 840  *      => cp.b 100000 ${backup_addr} ${filesize}
 841  *
 842  * Re-import this snapshot, deleting all other settings:
 843  *
 844  *      => env import -d -t ${backup_addr}
 845  */
 846 static int do_env_export(cmd_tbl_t *cmdtp, int flag,
 847                          int argc, char * const argv[])
 848 {
 849         char    buf[32];
 850         ulong   addr;
 851         char    *ptr, *cmd, *res;
 852         size_t  size = 0;
 853         ssize_t len;
 854         env_t   *envp;
 855         char    sep = '\n';
 856         int     chk = 0;
 857         int     fmt = 0;
 858
 859         cmd = *argv;
 860
 861         while (--argc > 0 && **++argv == '-') {
 862                 char *arg = *argv;
 863                 while (*++arg) {
 864                         switch (*arg) {
 865                         case 'b':               /* raw binary format */
 866                                 if (fmt++)
 867                                         goto sep_err;
 868                                 sep = '\0';
 869                                 break;
 870                         case 'c':               /* external checksum format */
 871                                 if (fmt++)
 872                                         goto sep_err;
 873                                 sep = '\0';
 874                                 chk = 1;
 875                                 break;
 876                         case 's':               /* size given */
 877                                 if (--argc <= 0)
 878                                         return cmd_usage(cmdtp);
 879                                 size = simple_strtoul(*++argv, NULL, 16);
 880                                 goto NXTARG;
 881                         case 't':               /* text format */
 882                                 if (fmt++)
 883                                         goto sep_err;
 884                                 sep = '\n';
 885                                 break;
 886                         default:
 887                                 return CMD_RET_USAGE;
 888                         }
 889                 }
 890 NXTARG:         ;
 891         }
 892
 893         if (argc < 1)
 894                 return CMD_RET_USAGE;
 895
 896         addr = simple_strtoul(argv[0], NULL, 16);
 897         ptr = map_sysmem(addr, size);
 898
 899         if (size)
 900                 memset(ptr, '\0', size);
 901
 902         argc--;
 903         argv++;
 904
 905         if (sep) {              /* export as text file */
 906                 len = hexport_r(&env_htab, sep,
 907                                 H_MATCH_KEY | H_MATCH_IDENT,
 908                                 &ptr, size, argc, argv);
 909                 if (len < 0) {
 910                         error("Cannot export environment: errno = %d\n", errno);
 911                         return 1;
 912                 }
 913                 sprintf(buf, "%zX", (size_t)len);
 914                 setenv("filesize", buf);
 915
 916                 return 0;
 917         }
 918
 919         envp = (env_t *)ptr;
 920
 921         if (chk)                /* export as checksum protected block */
 922                 res = (char *)envp->data;
 923         else                    /* export as raw binary data */
 924                 res = ptr;
 925
 926         len = hexport_r(&env_htab, '\0',
 927                         H_MATCH_KEY | H_MATCH_IDENT,
 928                         &res, ENV_SIZE, argc, argv);
 929         if (len < 0) {
 930                 error("Cannot export environment: errno = %d\n", errno);
 931                 return 1;
 932         }
 933
 934         if (chk) {
 935                 envp->crc = crc32(0, envp->data, ENV_SIZE);
 936 #ifdef CONFIG_ENV_ADDR_REDUND
 937                 envp->flags = ACTIVE_FLAG;
 938 #endif
 939         }
 940         setenv_hex("filesize", len + offsetof(env_t, data));
 941
 942         return 0;
 943
 944 sep_err:
 945         printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n", cmd);
 946         return 1;
 947 }
 948 #endif
 949
 950 #ifdef CONFIG_CMD_IMPORTENV
 951 /*
 952  * env import [-d] [-t | -b | -c] addr [size]
 953  *      -d:     delete existing environment before importing;
 954  *              otherwise overwrite / append to existion definitions
 955  *      -t:     assume text format; either "size" must be given or the
 956  *              text data must be '\0' terminated
 957  *      -b:     assume binary format ('\0' separated, "\0\0" terminated)
 958  *      -c:     assume checksum protected environment format
 959  *      addr:   memory address to read from
 960  *      size:   length of input data; if missing, proper '\0'
 961  *              termination is mandatory
 962  */
 963 static int do_env_import(cmd_tbl_t *cmdtp, int flag,
 964                          int argc, char * const argv[])
 965 {
 966         ulong   addr;
 967         char    *cmd, *ptr;
 968         char    sep = '\n';
 969         int     chk = 0;
 970         int     fmt = 0;
 971         int     del = 0;
 972         size_t  size;
 973
 974         cmd = *argv;
 975
 976         while (--argc > 0 && **++argv == '-') {
 977                 char *arg = *argv;
 978                 while (*++arg) {
 979                         switch (*arg) {
 980                         case 'b':               /* raw binary format */
 981                                 if (fmt++)
 982                                         goto sep_err;
 983                                 sep = '\0';
 984                                 break;
 985                         case 'c':               /* external checksum format */
 986                                 if (fmt++)
 987                                         goto sep_err;
 988                                 sep = '\0';
 989                                 chk = 1;
 990                                 break;
 991                         case 't':               /* text format */
 992                                 if (fmt++)
 993                                         goto sep_err;
 994                                 sep = '\n';
 995                                 break;
 996                         case 'd':
 997                                 del = 1;
 998                                 break;
 999                         default:
1000                                 return CMD_RET_USAGE;
1001                         }
1002                 }
1003         }
1004
1005         if (argc < 1)
1006                 return CMD_RET_USAGE;
1007
1008         if (!fmt)
1009                 printf("## Warning: defaulting to text format\n");
1010
1011         addr = simple_strtoul(argv[0], NULL, 16);
1012         ptr = map_sysmem(addr, 0);
1013
1014         if (argc == 2) {
1015                 size = simple_strtoul(argv[1], NULL, 16);
1016         } else if (argc == 1 && chk) {
1017                 puts("## Error: external checksum format must pass size\n");
1018                 return CMD_RET_FAILURE;
1019         } else {
1020                 char *s = ptr;
1021
1022                 size = 0;
1023
1024                 while (size < MAX_ENV_SIZE) {
1025                         if ((*s == sep) && (*(s+1) == '\0'))
1026                                 break;
1027                         ++s;
1028                         ++size;
1029                 }
1030                 if (size == MAX_ENV_SIZE) {
1031                         printf("## Warning: Input data exceeds %d bytes"
1032                                 " - truncated\n", MAX_ENV_SIZE);
1033                 }
1034                 size += 2;
1035                 printf("## Info: input data size = %zu = 0x%zX\n", size, size);
1036         }
1037
1038         if (chk) {
1039                 uint32_t crc;
1040                 env_t *ep = (env_t *)ptr;
1041
1042                 size -= offsetof(env_t, data);
1043                 memcpy(&crc, &ep->crc, sizeof(crc));
1044
1045                 if (crc32(0, ep->data, size) != crc) {
1046                         puts("## Error: bad CRC, import failed\n");
1047                         return 1;
1048                 }
1049                 ptr = (char *)ep->data;
1050         }
1051
1052         if (himport_r(&env_htab, ptr, size, sep, del ? 0 : H_NOCLEAR, 0,
1053                       NULL) == 0) {
1054                 error("Environment import failed: errno = %d\n", errno);
1055                 return 1;
1056         }
1057         gd->flags |= GD_FLG_ENV_READY;
1058
1059         return 0;
1060
1061 sep_err:
1062         printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n",
1063                 cmd);
1064         return 1;
1065 }
1066 #endif
1067
1068 #if defined(CONFIG_CMD_ENV_EXISTS)
1069 static int do_env_exists(cmd_tbl_t *cmdtp, int flag, int argc,
1070                        char * const argv[])
1071 {
1072         ENTRY e, *ep;
1073
1074         if (argc < 2)
1075                 return CMD_RET_USAGE;
1076
1077         e.key = argv[1];
1078         e.data = NULL;
1079         hsearch_r(e, FIND, &ep, &env_htab, 0);
1080
1081         return (ep == NULL) ? 1 : 0;
1082 }
1083 #endif
1084
1085 /*
1086  * New command line interface: "env" command with subcommands
1087  */
1088 static cmd_tbl_t cmd_env_sub[] = {
1089 #if defined(CONFIG_CMD_ASKENV)
1090         U_BOOT_CMD_MKENT(ask, CONFIG_SYS_MAXARGS, 1, do_env_ask, "", ""),
1091 #endif
1092         U_BOOT_CMD_MKENT(default, 1, 0, do_env_default, "", ""),
1093         U_BOOT_CMD_MKENT(delete, CONFIG_SYS_MAXARGS, 0, do_env_delete, "", ""),
1094 #if defined(CONFIG_CMD_EDITENV)
1095         U_BOOT_CMD_MKENT(edit, 2, 0, do_env_edit, "", ""),
1096 #endif
1097 #if defined(CONFIG_CMD_ENV_CALLBACK)
1098         U_BOOT_CMD_MKENT(callbacks, 1, 0, do_env_callback, "", ""),
1099 #endif
1100 #if defined(CONFIG_CMD_ENV_FLAGS)
1101         U_BOOT_CMD_MKENT(flags, 1, 0, do_env_flags, "", ""),
1102 #endif
1103 #if defined(CONFIG_CMD_EXPORTENV)
1104         U_BOOT_CMD_MKENT(export, 4, 0, do_env_export, "", ""),
1105 #endif
1106 #if defined(CONFIG_CMD_GREPENV)
1107         U_BOOT_CMD_MKENT(grep, CONFIG_SYS_MAXARGS, 1, do_env_grep, "", ""),
1108 #endif
1109 #if defined(CONFIG_CMD_IMPORTENV)
1110         U_BOOT_CMD_MKENT(import, 5, 0, do_env_import, "", ""),
1111 #endif
1112         U_BOOT_CMD_MKENT(print, CONFIG_SYS_MAXARGS, 1, do_env_print, "", ""),
1113 #if defined(CONFIG_CMD_RUN)
1114         U_BOOT_CMD_MKENT(run, CONFIG_SYS_MAXARGS, 1, do_run, "", ""),
1115 #endif
1116 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
1117         U_BOOT_CMD_MKENT(save, 1, 0, do_env_save, "", ""),
1118 #endif
1119         U_BOOT_CMD_MKENT(set, CONFIG_SYS_MAXARGS, 0, do_env_set, "", ""),
1120 #if defined(CONFIG_CMD_ENV_EXISTS)
1121         U_BOOT_CMD_MKENT(exists, 2, 0, do_env_exists, "", ""),
1122 #endif
1123 };
1124
1125 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
1126 void env_reloc(void)
1127 {
1128         fixup_cmdtable(cmd_env_sub, ARRAY_SIZE(cmd_env_sub));
1129 }
1130 #endif
1131
1132 static int do_env(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1133 {
1134         cmd_tbl_t *cp;
1135
1136         if (argc < 2)
1137                 return CMD_RET_USAGE;
1138
1139         /* drop initial "env" arg */
1140         argc--;
1141         argv++;
1142
1143         cp = find_cmd_tbl(argv[0], cmd_env_sub, ARRAY_SIZE(cmd_env_sub));
1144
1145         if (cp)
1146                 return cp->cmd(cmdtp, flag, argc, argv);
1147
1148         return CMD_RET_USAGE;
1149 }
1150
1151 #ifdef CONFIG_SYS_LONGHELP
1152 static char env_help_text[] =
1153 #if defined(CONFIG_CMD_ASKENV)
1154         "ask name [message] [size] - ask for environment variable\nenv "
1155 #endif
1156 #if defined(CONFIG_CMD_ENV_CALLBACK)
1157         "callbacks - print callbacks and their associated variables\nenv "
1158 #endif
1159         "default [-f] -a - [forcibly] reset default environment\n"
1160         "env default [-f] var [...] - [forcibly] reset variable(s) to their default values\n"
1161         "env delete [-f] var [...] - [forcibly] delete variable(s)\n"
1162 #if defined(CONFIG_CMD_EDITENV)
1163         "env edit name - edit environment variable\n"
1164 #endif
1165 #if defined(CONFIG_CMD_ENV_EXISTS)
1166         "env exists name - tests for existence of variable\n"
1167 #endif
1168 #if defined(CONFIG_CMD_EXPORTENV)
1169         "env export [-t | -b | -c] [-s size] addr [var ...] - export environment\n"
1170 #endif
1171 #if defined(CONFIG_CMD_ENV_FLAGS)
1172         "env flags - print variables that have non-default flags\n"
1173 #endif
1174 #if defined(CONFIG_CMD_GREPENV)
1175 #ifdef CONFIG_REGEX
1176         "env grep [-e] [-n | -v | -b] string [...] - search environment\n"
1177 #else
1178         "env grep [-n | -v | -b] string [...] - search environment\n"
1179 #endif
1180 #endif
1181 #if defined(CONFIG_CMD_IMPORTENV)
1182         "env import [-d] [-t | -b | -c] addr [size] - import environment\n"
1183 #endif
1184         "env print [-a | name ...] - print environment\n"
1185 #if defined(CONFIG_CMD_RUN)
1186         "env run var [...] - run commands in an environment variable\n"
1187 #endif
1188 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
1189         "env save - save environment\n"
1190 #endif
1191         "env set [-f] name [arg ...]\n";
1192 #endif
1193
1194 U_BOOT_CMD(
1195         env, CONFIG_SYS_MAXARGS, 1, do_env,
1196         "environment handling commands", env_help_text
1197 );
1198
1199 /*
1200  * Old command line interface, kept for compatibility
1201  */
1202
1203 #if defined(CONFIG_CMD_EDITENV)
1204 U_BOOT_CMD_COMPLETE(
1205         editenv, 2, 0,  do_env_edit,
1206         "edit environment variable",
1207         "name\n"
1208         "    - edit environment variable 'name'",
1209         var_complete
1210 );
1211 #endif
1212
1213 U_BOOT_CMD_COMPLETE(
1214         printenv, CONFIG_SYS_MAXARGS, 1,        do_env_print,
1215         "print environment variables",
1216         "[-a]\n    - print [all] values of all environment variables\n"
1217         "printenv name ...\n"
1218         "    - print value of environment variable 'name'",
1219         var_complete
1220 );
1221
1222 #ifdef CONFIG_CMD_GREPENV
1223 U_BOOT_CMD_COMPLETE(
1224         grepenv, CONFIG_SYS_MAXARGS, 0,  do_env_grep,
1225         "search environment variables",
1226 #ifdef CONFIG_REGEX
1227         "[-e] [-n | -v | -b] string ...\n"
1228 #else
1229         "[-n | -v | -b] string ...\n"
1230 #endif
1231         "    - list environment name=value pairs matching 'string'\n"
1232 #ifdef CONFIG_REGEX
1233         "      \"-e\": enable regular expressions;\n"
1234 #endif
1235         "      \"-n\": search variable names; \"-v\": search values;\n"
1236         "      \"-b\": search both names and values (default)",
1237         var_complete
1238 );
1239 #endif
1240
1241 U_BOOT_CMD_COMPLETE(
1242         setenv, CONFIG_SYS_MAXARGS, 0,  do_env_set,
1243         "set environment variables",
1244         "[-f] name value ...\n"
1245         "    - [forcibly] set environment variable 'name' to 'value ...'\n"
1246         "setenv [-f] name\n"
1247         "    - [forcibly] delete environment variable 'name'",
1248         var_complete
1249 );
1250
1251 #if defined(CONFIG_CMD_ASKENV)
1252
1253 U_BOOT_CMD(
1254         askenv, CONFIG_SYS_MAXARGS,     1,      do_env_ask,
1255         "get environment variables from stdin",
1256         "name [message] [size]\n"
1257         "    - get environment variable 'name' from stdin (max 'size' chars)"
1258 );
1259 #endif
1260
1261 #if defined(CONFIG_CMD_RUN)
1262 U_BOOT_CMD_COMPLETE(
1263         run,    CONFIG_SYS_MAXARGS,     1,      do_run,
1264         "run commands in an environment variable",
1265         "var [...]\n"
1266         "    - run the commands in the environment variable(s) 'var'",
1267         var_complete
1268 );
1269 #endif
1270 #endif /* CONFIG_SPL_BUILD */