git.sur5r.net Git - u-boot/blob - common/cmd_nvedit.c

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