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