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