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                                 void *priv)
 432 {
 433         printf("\t%-20s %-20s\n", var_name, callback_name);
 434
 435         return 0;
 436 }
 437
 438 static int print_active_callback(ENTRY *entry)
 439 {
 440         struct env_clbk_tbl *clbkp;
 441         int i;
 442         int num_callbacks;
 443
 444         if (entry->callback == NULL)
 445                 return 0;
 446
 447         /* look up the callback in the linker-list */
 448         num_callbacks = ll_entry_count(struct env_clbk_tbl, env_clbk);
 449         for (i = 0, clbkp = ll_entry_start(struct env_clbk_tbl, env_clbk);
 450              i < num_callbacks;
 451              i++, clbkp++) {
 452 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
 453                 if (entry->callback == clbkp->callback + gd->reloc_off)
 454 #else
 455                 if (entry->callback == clbkp->callback)
 456 #endif
 457                         break;
 458         }
 459
 460         if (i == num_callbacks)
 461                 /* this should probably never happen, but just in case... */
 462                 printf("\t%-20s %p\n", entry->key, entry->callback);
 463         else
 464                 printf("\t%-20s %-20s\n", entry->key, clbkp->name);
 465
 466         return 0;
 467 }
 468
 469 /*
 470  * Print the callbacks available and what they are bound to
 471  */
 472 int do_env_callback(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 473 {
 474         struct env_clbk_tbl *clbkp;
 475         int i;
 476         int num_callbacks;
 477
 478         /* Print the available callbacks */
 479         puts("Available callbacks:\n");
 480         puts("\tCallback Name\n");
 481         puts("\t-------------\n");
 482         num_callbacks = ll_entry_count(struct env_clbk_tbl, env_clbk);
 483         for (i = 0, clbkp = ll_entry_start(struct env_clbk_tbl, env_clbk);
 484              i < num_callbacks;
 485              i++, clbkp++)
 486                 printf("\t%s\n", clbkp->name);
 487         puts("\n");
 488
 489         /* Print the static bindings that may exist */
 490         puts("Static callback bindings:\n");
 491         printf("\t%-20s %-20s\n", "Variable Name", "Callback Name");
 492         printf("\t%-20s %-20s\n", "-------------", "-------------");
 493         env_attr_walk(ENV_CALLBACK_LIST_STATIC, print_static_binding, NULL);
 494         puts("\n");
 495
 496         /* walk through each variable and print the callback if it has one */
 497         puts("Active callback bindings:\n");
 498         printf("\t%-20s %-20s\n", "Variable Name", "Callback Name");
 499         printf("\t%-20s %-20s\n", "-------------", "-------------");
 500         hwalk_r(&env_htab, print_active_callback);
 501         return 0;
 502 }
 503 #endif
 504
 505 #if defined(CONFIG_CMD_ENV_FLAGS)
 506 static int print_static_flags(const char *var_name, const char *flags,
 507                               void *priv)
 508 {
 509         enum env_flags_vartype type = env_flags_parse_vartype(flags);
 510         enum env_flags_varaccess access = env_flags_parse_varaccess(flags);
 511
 512         printf("\t%-20s %-20s %-20s\n", var_name,
 513                 env_flags_get_vartype_name(type),
 514                 env_flags_get_varaccess_name(access));
 515
 516         return 0;
 517 }
 518
 519 static int print_active_flags(ENTRY *entry)
 520 {
 521         enum env_flags_vartype type;
 522         enum env_flags_varaccess access;
 523
 524         if (entry->flags == 0)
 525                 return 0;
 526
 527         type = (enum env_flags_vartype)
 528                 (entry->flags & ENV_FLAGS_VARTYPE_BIN_MASK);
 529         access = env_flags_parse_varaccess_from_binflags(entry->flags);
 530         printf("\t%-20s %-20s %-20s\n", entry->key,
 531                 env_flags_get_vartype_name(type),
 532                 env_flags_get_varaccess_name(access));
 533
 534         return 0;
 535 }
 536
 537 /*
 538  * Print the flags available and what variables have flags
 539  */
 540 int do_env_flags(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 541 {
 542         /* Print the available variable types */
 543         printf("Available variable type flags (position %d):\n",
 544                 ENV_FLAGS_VARTYPE_LOC);
 545         puts("\tFlag\tVariable Type Name\n");
 546         puts("\t----\t------------------\n");
 547         env_flags_print_vartypes();
 548         puts("\n");
 549
 550         /* Print the available variable access types */
 551         printf("Available variable access flags (position %d):\n",
 552                 ENV_FLAGS_VARACCESS_LOC);
 553         puts("\tFlag\tVariable Access Name\n");
 554         puts("\t----\t--------------------\n");
 555         env_flags_print_varaccess();
 556         puts("\n");
 557
 558         /* Print the static flags that may exist */
 559         puts("Static flags:\n");
 560         printf("\t%-20s %-20s %-20s\n", "Variable Name", "Variable Type",
 561                 "Variable Access");
 562         printf("\t%-20s %-20s %-20s\n", "-------------", "-------------",
 563                 "---------------");
 564         env_attr_walk(ENV_FLAGS_LIST_STATIC, print_static_flags, NULL);
 565         puts("\n");
 566
 567         /* walk through each variable and print the flags if non-default */
 568         puts("Active flags:\n");
 569         printf("\t%-20s %-20s %-20s\n", "Variable Name", "Variable Type",
 570                 "Variable Access");
 571         printf("\t%-20s %-20s %-20s\n", "-------------", "-------------",
 572                 "---------------");
 573         hwalk_r(&env_htab, print_active_flags);
 574         return 0;
 575 }
 576 #endif
 577
 578 /*
 579  * Interactively edit an environment variable
 580  */
 581 #if defined(CONFIG_CMD_EDITENV)
 582 static int do_env_edit(cmd_tbl_t *cmdtp, int flag, int argc,
 583                        char * const argv[])
 584 {
 585         char buffer[CONFIG_SYS_CBSIZE];
 586         char *init_val;
 587
 588         if (argc < 2)
 589                 return CMD_RET_USAGE;
 590
 591         /* Set read buffer to initial value or empty sting */
 592         init_val = getenv(argv[1]);
 593         if (init_val)
 594                 sprintf(buffer, "%s", init_val);
 595         else
 596                 buffer[0] = '\0';
 597
 598         if (cli_readline_into_buffer("edit: ", buffer, 0) < 0)
 599                 return 1;
 600
 601         return setenv(argv[1], buffer);
 602 }
 603 #endif /* CONFIG_CMD_EDITENV */
 604 #endif /* CONFIG_SPL_BUILD */
 605
 606 /*
 607  * Look up variable from environment,
 608  * return address of storage for that variable,
 609  * or NULL if not found
 610  */
 611 char *getenv(const char *name)
 612 {
 613         if (gd->flags & GD_FLG_ENV_READY) { /* after import into hashtable */
 614                 ENTRY e, *ep;
 615
 616                 WATCHDOG_RESET();
 617
 618                 e.key   = name;
 619                 e.data  = NULL;
 620                 hsearch_r(e, FIND, &ep, &env_htab, 0);
 621
 622                 return ep ? ep->data : NULL;
 623         }
 624
 625         /* restricted capabilities before import */
 626         if (getenv_f(name, (char *)(gd->env_buf), sizeof(gd->env_buf)) > 0)
 627                 return (char *)(gd->env_buf);
 628
 629         return NULL;
 630 }
 631
 632 /*
 633  * Look up variable from environment for restricted C runtime env.
 634  */
 635 int getenv_f(const char *name, char *buf, unsigned len)
 636 {
 637         int i, nxt;
 638
 639         for (i = 0; env_get_char(i) != '\0'; i = nxt + 1) {
 640                 int val, n;
 641
 642                 for (nxt = i; env_get_char(nxt) != '\0'; ++nxt) {
 643                         if (nxt >= CONFIG_ENV_SIZE)
 644                                 return -1;
 645                 }
 646
 647                 val = envmatch((uchar *)name, i);
 648                 if (val < 0)
 649                         continue;
 650
 651                 /* found; copy out */
 652                 for (n = 0; n < len; ++n, ++buf) {
 653                         *buf = env_get_char(val++);
 654                         if (*buf == '\0')
 655                                 return n;
 656                 }
 657
 658                 if (n)
 659                         *--buf = '\0';
 660
 661                 printf("env_buf [%d bytes] too small for value of \"%s\"\n",
 662                         len, name);
 663
 664                 return n;
 665         }
 666
 667         return -1;
 668 }
 669
 670 /**
 671  * Decode the integer value of an environment variable and return it.
 672  *
 673  * @param name          Name of environemnt variable
 674  * @param base          Number base to use (normally 10, or 16 for hex)
 675  * @param default_val   Default value to return if the variable is not
 676  *                      found
 677  * @return the decoded value, or default_val if not found
 678  */
 679 ulong getenv_ulong(const char *name, int base, ulong default_val)
 680 {
 681         /*
 682          * We can use getenv() here, even before relocation, since the
 683          * environment variable value is an integer and thus short.
 684          */
 685         const char *str = getenv(name);
 686
 687         return str ? simple_strtoul(str, NULL, base) : default_val;
 688 }
 689
 690 #ifndef CONFIG_SPL_BUILD
 691 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
 692 static int do_env_save(cmd_tbl_t *cmdtp, int flag, int argc,
 693                        char * const argv[])
 694 {
 695         printf("Saving Environment to %s...\n", env_name_spec);
 696
 697         return saveenv() ? 1 : 0;
 698 }
 699
 700 U_BOOT_CMD(
 701         saveenv, 1, 0,  do_env_save,
 702         "save environment variables to persistent storage",
 703         ""
 704 );
 705 #endif
 706 #endif /* CONFIG_SPL_BUILD */
 707
 708
 709 /*
 710  * Match a name / name=value pair
 711  *
 712  * s1 is either a simple 'name', or a 'name=value' pair.
 713  * i2 is the environment index for a 'name2=value2' pair.
 714  * If the names match, return the index for the value2, else -1.
 715  */
 716 int envmatch(uchar *s1, int i2)
 717 {
 718         if (s1 == NULL)
 719                 return -1;
 720
 721         while (*s1 == env_get_char(i2++))
 722                 if (*s1++ == '=')
 723                         return i2;
 724
 725         if (*s1 == '\0' && env_get_char(i2-1) == '=')
 726                 return i2;
 727
 728         return -1;
 729 }
 730
 731 #ifndef CONFIG_SPL_BUILD
 732 static int do_env_default(cmd_tbl_t *cmdtp, int __flag,
 733                           int argc, char * const argv[])
 734 {
 735         int all = 0, flag = 0;
 736
 737         debug("Initial value for argc=%d\n", argc);
 738         while (--argc > 0 && **++argv == '-') {
 739                 char *arg = *argv;
 740
 741                 while (*++arg) {
 742                         switch (*arg) {
 743                         case 'a':               /* default all */
 744                                 all = 1;
 745                                 break;
 746                         case 'f':               /* force */
 747                                 flag |= H_FORCE;
 748                                 break;
 749                         default:
 750                                 return cmd_usage(cmdtp);
 751                         }
 752                 }
 753         }
 754         debug("Final value for argc=%d\n", argc);
 755         if (all && (argc == 0)) {
 756                 /* Reset the whole environment */
 757                 set_default_env("## Resetting to default environment\n");
 758                 return 0;
 759         }
 760         if (!all && (argc > 0)) {
 761                 /* Reset individual variables */
 762                 set_default_vars(argc, argv);
 763                 return 0;
 764         }
 765
 766         return cmd_usage(cmdtp);
 767 }
 768
 769 static int do_env_delete(cmd_tbl_t *cmdtp, int flag,
 770                          int argc, char * const argv[])
 771 {
 772         int env_flag = H_INTERACTIVE;
 773         int ret = 0;
 774
 775         debug("Initial value for argc=%d\n", argc);
 776         while (argc > 1 && **(argv + 1) == '-') {
 777                 char *arg = *++argv;
 778
 779                 --argc;
 780                 while (*++arg) {
 781                         switch (*arg) {
 782                         case 'f':               /* force */
 783                                 env_flag |= H_FORCE;
 784                                 break;
 785                         default:
 786                                 return CMD_RET_USAGE;
 787                         }
 788                 }
 789         }
 790         debug("Final value for argc=%d\n", argc);
 791
 792         env_id++;
 793
 794         while (--argc > 0) {
 795                 char *name = *++argv;
 796
 797                 if (!hdelete_r(name, &env_htab, env_flag))
 798                         ret = 1;
 799         }
 800
 801         return ret;
 802 }
 803
 804 #ifdef CONFIG_CMD_EXPORTENV
 805 /*
 806  * env export [-t | -b | -c] [-s size] addr [var ...]
 807  *      -t:     export as text format; if size is given, data will be
 808  *              padded with '\0' bytes; if not, one terminating '\0'
 809  *              will be added (which is included in the "filesize"
 810  *              setting so you can for exmple copy this to flash and
 811  *              keep the termination).
 812  *      -b:     export as binary format (name=value pairs separated by
 813  *              '\0', list end marked by double "\0\0")
 814  *      -c:     export as checksum protected environment format as
 815  *              used for example by "saveenv" command
 816  *      -s size:
 817  *              size of output buffer
 818  *      addr:   memory address where environment gets stored
 819  *      var...  List of variable names that get included into the
 820  *              export. Without arguments, the whole environment gets
 821  *              exported.
 822  *
 823  * With "-c" and size is NOT given, then the export command will
 824  * format the data as currently used for the persistent storage,
 825  * i. e. it will use CONFIG_ENV_SECT_SIZE as output block size and
 826  * prepend a valid CRC32 checksum and, in case of resundant
 827  * environment, a "current" redundancy flag. If size is given, this
 828  * value will be used instead of CONFIG_ENV_SECT_SIZE; again, CRC32
 829  * checksum and redundancy flag will be inserted.
 830  *
 831  * With "-b" and "-t", always only the real data (including a
 832  * terminating '\0' byte) will be written; here the optional size
 833  * argument will be used to make sure not to overflow the user
 834  * provided buffer; the command will abort if the size is not
 835  * sufficient. Any remainign space will be '\0' padded.
 836  *
 837  * On successful return, the variable "filesize" will be set.
 838  * Note that filesize includes the trailing/terminating '\0' byte(s).
 839  *
 840  * Usage szenario:  create a text snapshot/backup of the current settings:
 841  *
 842  *      => env export -t 100000
 843  *      => era ${backup_addr} +${filesize}
 844  *      => cp.b 100000 ${backup_addr} ${filesize}
 845  *
 846  * Re-import this snapshot, deleting all other settings:
 847  *
 848  *      => env import -d -t ${backup_addr}
 849  */
 850 static int do_env_export(cmd_tbl_t *cmdtp, int flag,
 851                          int argc, char * const argv[])
 852 {
 853         char    buf[32];
 854         ulong   addr;
 855         char    *ptr, *cmd, *res;
 856         size_t  size = 0;
 857         ssize_t len;
 858         env_t   *envp;
 859         char    sep = '\n';
 860         int     chk = 0;
 861         int     fmt = 0;
 862
 863         cmd = *argv;
 864
 865         while (--argc > 0 && **++argv == '-') {
 866                 char *arg = *argv;
 867                 while (*++arg) {
 868                         switch (*arg) {
 869                         case 'b':               /* raw binary format */
 870                                 if (fmt++)
 871                                         goto sep_err;
 872                                 sep = '\0';
 873                                 break;
 874                         case 'c':               /* external checksum format */
 875                                 if (fmt++)
 876                                         goto sep_err;
 877                                 sep = '\0';
 878                                 chk = 1;
 879                                 break;
 880                         case 's':               /* size given */
 881                                 if (--argc <= 0)
 882                                         return cmd_usage(cmdtp);
 883                                 size = simple_strtoul(*++argv, NULL, 16);
 884                                 goto NXTARG;
 885                         case 't':               /* text format */
 886                                 if (fmt++)
 887                                         goto sep_err;
 888                                 sep = '\n';
 889                                 break;
 890                         default:
 891                                 return CMD_RET_USAGE;
 892                         }
 893                 }
 894 NXTARG:         ;
 895         }
 896
 897         if (argc < 1)
 898                 return CMD_RET_USAGE;
 899
 900         addr = simple_strtoul(argv[0], NULL, 16);
 901         ptr = map_sysmem(addr, size);
 902
 903         if (size)
 904                 memset(ptr, '\0', size);
 905
 906         argc--;
 907         argv++;
 908
 909         if (sep) {              /* export as text file */
 910                 len = hexport_r(&env_htab, sep,
 911                                 H_MATCH_KEY | H_MATCH_IDENT,
 912                                 &ptr, size, argc, argv);
 913                 if (len < 0) {
 914                         error("Cannot export environment: errno = %d\n", errno);
 915                         return 1;
 916                 }
 917                 sprintf(buf, "%zX", (size_t)len);
 918                 setenv("filesize", buf);
 919
 920                 return 0;
 921         }
 922
 923         envp = (env_t *)ptr;
 924
 925         if (chk)                /* export as checksum protected block */
 926                 res = (char *)envp->data;
 927         else                    /* export as raw binary data */
 928                 res = ptr;
 929
 930         len = hexport_r(&env_htab, '\0',
 931                         H_MATCH_KEY | H_MATCH_IDENT,
 932                         &res, ENV_SIZE, argc, argv);
 933         if (len < 0) {
 934                 error("Cannot export environment: errno = %d\n", errno);
 935                 return 1;
 936         }
 937
 938         if (chk) {
 939                 envp->crc = crc32(0, envp->data, ENV_SIZE);
 940 #ifdef CONFIG_ENV_ADDR_REDUND
 941                 envp->flags = ACTIVE_FLAG;
 942 #endif
 943         }
 944         setenv_hex("filesize", len + offsetof(env_t, data));
 945
 946         return 0;
 947
 948 sep_err:
 949         printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n", cmd);
 950         return 1;
 951 }
 952 #endif
 953
 954 #ifdef CONFIG_CMD_IMPORTENV
 955 /*
 956  * env import [-d] [-t [-r] | -b | -c] addr [size]
 957  *      -d:     delete existing environment before importing;
 958  *              otherwise overwrite / append to existion definitions
 959  *      -t:     assume text format; either "size" must be given or the
 960  *              text data must be '\0' terminated
 961  *      -r:     handle CRLF like LF, that means exported variables with
 962  *              a content which ends with \r won't get imported. Used
 963  *              to import text files created with editors which are using CRLF
 964  *              for line endings. Only effective in addition to -t.
 965  *      -b:     assume binary format ('\0' separated, "\0\0" terminated)
 966  *      -c:     assume checksum protected environment format
 967  *      addr:   memory address to read from
 968  *      size:   length of input data; if missing, proper '\0'
 969  *              termination is mandatory
 970  */
 971 static int do_env_import(cmd_tbl_t *cmdtp, int flag,
 972                          int argc, char * const argv[])
 973 {
 974         ulong   addr;
 975         char    *cmd, *ptr;
 976         char    sep = '\n';
 977         int     chk = 0;
 978         int     fmt = 0;
 979         int     del = 0;
 980         int     crlf_is_lf = 0;
 981         size_t  size;
 982
 983         cmd = *argv;
 984
 985         while (--argc > 0 && **++argv == '-') {
 986                 char *arg = *argv;
 987                 while (*++arg) {
 988                         switch (*arg) {
 989                         case 'b':               /* raw binary format */
 990                                 if (fmt++)
 991                                         goto sep_err;
 992                                 sep = '\0';
 993                                 break;
 994                         case 'c':               /* external checksum format */
 995                                 if (fmt++)
 996                                         goto sep_err;
 997                                 sep = '\0';
 998                                 chk = 1;
 999                                 break;
1000                         case 't':               /* text format */
1001                                 if (fmt++)
1002                                         goto sep_err;
1003                                 sep = '\n';
1004                                 break;
1005                         case 'r':               /* handle CRLF like LF */
1006                                 crlf_is_lf = 1;
1007                                 break;
1008                         case 'd':
1009                                 del = 1;
1010                                 break;
1011                         default:
1012                                 return CMD_RET_USAGE;
1013                         }
1014                 }
1015         }
1016
1017         if (argc < 1)
1018                 return CMD_RET_USAGE;
1019
1020         if (!fmt)
1021                 printf("## Warning: defaulting to text format\n");
1022
1023         if (sep != '\n' && crlf_is_lf )
1024                 crlf_is_lf = 0;
1025
1026         addr = simple_strtoul(argv[0], NULL, 16);
1027         ptr = map_sysmem(addr, 0);
1028
1029         if (argc == 2) {
1030                 size = simple_strtoul(argv[1], NULL, 16);
1031         } else if (argc == 1 && chk) {
1032                 puts("## Error: external checksum format must pass size\n");
1033                 return CMD_RET_FAILURE;
1034         } else {
1035                 char *s = ptr;
1036
1037                 size = 0;
1038
1039                 while (size < MAX_ENV_SIZE) {
1040                         if ((*s == sep) && (*(s+1) == '\0'))
1041                                 break;
1042                         ++s;
1043                         ++size;
1044                 }
1045                 if (size == MAX_ENV_SIZE) {
1046                         printf("## Warning: Input data exceeds %d bytes"
1047                                 " - truncated\n", MAX_ENV_SIZE);
1048                 }
1049                 size += 2;
1050                 printf("## Info: input data size = %zu = 0x%zX\n", size, size);
1051         }
1052
1053         if (chk) {
1054                 uint32_t crc;
1055                 env_t *ep = (env_t *)ptr;
1056
1057                 size -= offsetof(env_t, data);
1058                 memcpy(&crc, &ep->crc, sizeof(crc));
1059
1060                 if (crc32(0, ep->data, size) != crc) {
1061                         puts("## Error: bad CRC, import failed\n");
1062                         return 1;
1063                 }
1064                 ptr = (char *)ep->data;
1065         }
1066
1067         if (himport_r(&env_htab, ptr, size, sep, del ? 0 : H_NOCLEAR,
1068                         crlf_is_lf, 0, NULL) == 0) {
1069                 error("Environment import failed: errno = %d\n", errno);
1070                 return 1;
1071         }
1072         gd->flags |= GD_FLG_ENV_READY;
1073
1074         return 0;
1075
1076 sep_err:
1077         printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n",
1078                 cmd);
1079         return 1;
1080 }
1081 #endif
1082
1083 #if defined(CONFIG_CMD_ENV_EXISTS)
1084 static int do_env_exists(cmd_tbl_t *cmdtp, int flag, int argc,
1085                        char * const argv[])
1086 {
1087         ENTRY e, *ep;
1088
1089         if (argc < 2)
1090                 return CMD_RET_USAGE;
1091
1092         e.key = argv[1];
1093         e.data = NULL;
1094         hsearch_r(e, FIND, &ep, &env_htab, 0);
1095
1096         return (ep == NULL) ? 1 : 0;
1097 }
1098 #endif
1099
1100 /*
1101  * New command line interface: "env" command with subcommands
1102  */
1103 static cmd_tbl_t cmd_env_sub[] = {
1104 #if defined(CONFIG_CMD_ASKENV)
1105         U_BOOT_CMD_MKENT(ask, CONFIG_SYS_MAXARGS, 1, do_env_ask, "", ""),
1106 #endif
1107         U_BOOT_CMD_MKENT(default, 1, 0, do_env_default, "", ""),
1108         U_BOOT_CMD_MKENT(delete, CONFIG_SYS_MAXARGS, 0, do_env_delete, "", ""),
1109 #if defined(CONFIG_CMD_EDITENV)
1110         U_BOOT_CMD_MKENT(edit, 2, 0, do_env_edit, "", ""),
1111 #endif
1112 #if defined(CONFIG_CMD_ENV_CALLBACK)
1113         U_BOOT_CMD_MKENT(callbacks, 1, 0, do_env_callback, "", ""),
1114 #endif
1115 #if defined(CONFIG_CMD_ENV_FLAGS)
1116         U_BOOT_CMD_MKENT(flags, 1, 0, do_env_flags, "", ""),
1117 #endif
1118 #if defined(CONFIG_CMD_EXPORTENV)
1119         U_BOOT_CMD_MKENT(export, 4, 0, do_env_export, "", ""),
1120 #endif
1121 #if defined(CONFIG_CMD_GREPENV)
1122         U_BOOT_CMD_MKENT(grep, CONFIG_SYS_MAXARGS, 1, do_env_grep, "", ""),
1123 #endif
1124 #if defined(CONFIG_CMD_IMPORTENV)
1125         U_BOOT_CMD_MKENT(import, 5, 0, do_env_import, "", ""),
1126 #endif
1127         U_BOOT_CMD_MKENT(print, CONFIG_SYS_MAXARGS, 1, do_env_print, "", ""),
1128 #if defined(CONFIG_CMD_RUN)
1129         U_BOOT_CMD_MKENT(run, CONFIG_SYS_MAXARGS, 1, do_run, "", ""),
1130 #endif
1131 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
1132         U_BOOT_CMD_MKENT(save, 1, 0, do_env_save, "", ""),
1133 #endif
1134         U_BOOT_CMD_MKENT(set, CONFIG_SYS_MAXARGS, 0, do_env_set, "", ""),
1135 #if defined(CONFIG_CMD_ENV_EXISTS)
1136         U_BOOT_CMD_MKENT(exists, 2, 0, do_env_exists, "", ""),
1137 #endif
1138 };
1139
1140 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
1141 void env_reloc(void)
1142 {
1143         fixup_cmdtable(cmd_env_sub, ARRAY_SIZE(cmd_env_sub));
1144 }
1145 #endif
1146
1147 static int do_env(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1148 {
1149         cmd_tbl_t *cp;
1150
1151         if (argc < 2)
1152                 return CMD_RET_USAGE;
1153
1154         /* drop initial "env" arg */
1155         argc--;
1156         argv++;
1157
1158         cp = find_cmd_tbl(argv[0], cmd_env_sub, ARRAY_SIZE(cmd_env_sub));
1159
1160         if (cp)
1161                 return cp->cmd(cmdtp, flag, argc, argv);
1162
1163         return CMD_RET_USAGE;
1164 }
1165
1166 #ifdef CONFIG_SYS_LONGHELP
1167 static char env_help_text[] =
1168 #if defined(CONFIG_CMD_ASKENV)
1169         "ask name [message] [size] - ask for environment variable\nenv "
1170 #endif
1171 #if defined(CONFIG_CMD_ENV_CALLBACK)
1172         "callbacks - print callbacks and their associated variables\nenv "
1173 #endif
1174         "default [-f] -a - [forcibly] reset default environment\n"
1175         "env default [-f] var [...] - [forcibly] reset variable(s) to their default values\n"
1176         "env delete [-f] var [...] - [forcibly] delete variable(s)\n"
1177 #if defined(CONFIG_CMD_EDITENV)
1178         "env edit name - edit environment variable\n"
1179 #endif
1180 #if defined(CONFIG_CMD_ENV_EXISTS)
1181         "env exists name - tests for existence of variable\n"
1182 #endif
1183 #if defined(CONFIG_CMD_EXPORTENV)
1184         "env export [-t | -b | -c] [-s size] addr [var ...] - export environment\n"
1185 #endif
1186 #if defined(CONFIG_CMD_ENV_FLAGS)
1187         "env flags - print variables that have non-default flags\n"
1188 #endif
1189 #if defined(CONFIG_CMD_GREPENV)
1190 #ifdef CONFIG_REGEX
1191         "env grep [-e] [-n | -v | -b] string [...] - search environment\n"
1192 #else
1193         "env grep [-n | -v | -b] string [...] - search environment\n"
1194 #endif
1195 #endif
1196 #if defined(CONFIG_CMD_IMPORTENV)
1197         "env import [-d] [-t [-r] | -b | -c] addr [size] - import environment\n"
1198 #endif
1199         "env print [-a | name ...] - print environment\n"
1200 #if defined(CONFIG_CMD_RUN)
1201         "env run var [...] - run commands in an environment variable\n"
1202 #endif
1203 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
1204         "env save - save environment\n"
1205 #endif
1206         "env set [-f] name [arg ...]\n";
1207 #endif
1208
1209 U_BOOT_CMD(
1210         env, CONFIG_SYS_MAXARGS, 1, do_env,
1211         "environment handling commands", env_help_text
1212 );
1213
1214 /*
1215  * Old command line interface, kept for compatibility
1216  */
1217
1218 #if defined(CONFIG_CMD_EDITENV)
1219 U_BOOT_CMD_COMPLETE(
1220         editenv, 2, 0,  do_env_edit,
1221         "edit environment variable",
1222         "name\n"
1223         "    - edit environment variable 'name'",
1224         var_complete
1225 );
1226 #endif
1227
1228 U_BOOT_CMD_COMPLETE(
1229         printenv, CONFIG_SYS_MAXARGS, 1,        do_env_print,
1230         "print environment variables",
1231         "[-a]\n    - print [all] values of all environment variables\n"
1232         "printenv name ...\n"
1233         "    - print value of environment variable 'name'",
1234         var_complete
1235 );
1236
1237 #ifdef CONFIG_CMD_GREPENV
1238 U_BOOT_CMD_COMPLETE(
1239         grepenv, CONFIG_SYS_MAXARGS, 0,  do_env_grep,
1240         "search environment variables",
1241 #ifdef CONFIG_REGEX
1242         "[-e] [-n | -v | -b] string ...\n"
1243 #else
1244         "[-n | -v | -b] string ...\n"
1245 #endif
1246         "    - list environment name=value pairs matching 'string'\n"
1247 #ifdef CONFIG_REGEX
1248         "      \"-e\": enable regular expressions;\n"
1249 #endif
1250         "      \"-n\": search variable names; \"-v\": search values;\n"
1251         "      \"-b\": search both names and values (default)",
1252         var_complete
1253 );
1254 #endif
1255
1256 U_BOOT_CMD_COMPLETE(
1257         setenv, CONFIG_SYS_MAXARGS, 0,  do_env_set,
1258         "set environment variables",
1259         "[-f] name value ...\n"
1260         "    - [forcibly] set environment variable 'name' to 'value ...'\n"
1261         "setenv [-f] name\n"
1262         "    - [forcibly] delete environment variable 'name'",
1263         var_complete
1264 );
1265
1266 #if defined(CONFIG_CMD_ASKENV)
1267
1268 U_BOOT_CMD(
1269         askenv, CONFIG_SYS_MAXARGS,     1,      do_env_ask,
1270         "get environment variables from stdin",
1271         "name [message] [size]\n"
1272         "    - get environment variable 'name' from stdin (max 'size' chars)"
1273 );
1274 #endif
1275
1276 #if defined(CONFIG_CMD_RUN)
1277 U_BOOT_CMD_COMPLETE(
1278         run,    CONFIG_SYS_MAXARGS,     1,      do_run,
1279         "run commands in an environment variable",
1280         "var [...]\n"
1281         "    - run the commands in the environment variable(s) 'var'",
1282         var_complete
1283 );
1284 #endif
1285 #endif /* CONFIG_SPL_BUILD */