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