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