1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright 2000-2013
4 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
6 * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
7 * Andreas Heppel <aheppel@sysgo.de>
9 * Copyright 2011 Freescale Semiconductor, Inc.
13 * Support for persistent environment data
15 * The "environment" is stored on external storage as a list of '\0'
16 * terminated "name=value" strings. The end of the list is marked by
17 * a double '\0'. The environment is preceded by a 32 bit CRC over
18 * the data part and, in case of redundant environment, a byte of
21 * This linearized representation will also be used before
22 * relocation, i. e. as long as we don't have a full C runtime
23 * environment. After that, we use a hash table.
31 #include <env_internal.h>
37 #include <u-boot/crc.h>
39 #include <linux/stddef.h>
40 #include <asm/byteorder.h>
43 DECLARE_GLOBAL_DATA_PTR
;
45 #if defined(CONFIG_ENV_IS_IN_EEPROM) || \
46 defined(CONFIG_ENV_IS_IN_FLASH) || \
47 defined(CONFIG_ENV_IS_IN_MMC) || \
48 defined(CONFIG_ENV_IS_IN_FAT) || \
49 defined(CONFIG_ENV_IS_IN_EXT4) || \
50 defined(CONFIG_ENV_IS_IN_NAND) || \
51 defined(CONFIG_ENV_IS_IN_NVRAM) || \
52 defined(CONFIG_ENV_IS_IN_ONENAND) || \
53 defined(CONFIG_ENV_IS_IN_SATA) || \
54 defined(CONFIG_ENV_IS_IN_SPI_FLASH) || \
55 defined(CONFIG_ENV_IS_IN_REMOTE) || \
56 defined(CONFIG_ENV_IS_IN_UBI)
58 #define ENV_IS_IN_DEVICE
62 #if !defined(ENV_IS_IN_DEVICE) && \
63 !defined(CONFIG_ENV_IS_NOWHERE)
64 # error Define one of CONFIG_ENV_IS_IN_{EEPROM|FLASH|MMC|FAT|EXT4|\
65 NAND|NVRAM|ONENAND|SATA|SPI_FLASH|REMOTE|UBI} or CONFIG_ENV_IS_NOWHERE
69 * Maximum expected input data size for import command
71 #define MAX_ENV_SIZE (1 << 20) /* 1 MiB */
74 * This variable is incremented on each do_env_set(), so it can
75 * be used via env_get_id() as an indication, if the environment
76 * has changed or not. So it is possible to reread an environment
77 * variable only if the environment was changed ... done so for
78 * example in NetInitLoop()
80 static int env_id
= 1;
87 #ifndef CONFIG_SPL_BUILD
89 * Command interface: print one or all environment variables
91 * Returns 0 in case of error, or length of printed string
93 static int env_print(char *name
, int flag
)
98 if (name
) { /* print a single name */
99 struct env_entry e
, *ep
;
103 hsearch_r(e
, ENV_FIND
, &ep
, &env_htab
, flag
);
106 len
= printf("%s=%s\n", ep
->key
, ep
->data
);
110 /* print whole list */
111 len
= hexport_r(&env_htab
, '\n', flag
, &res
, 0, 0, NULL
);
119 /* should never happen */
120 printf("## Error: cannot export environment\n");
124 static int do_env_print(cmd_tbl_t
*cmdtp
, int flag
, int argc
,
129 int env_flag
= H_HIDE_DOT
;
131 #if defined(CONFIG_CMD_NVEDIT_EFI)
132 if (argc
> 1 && argv
[1][0] == '-' && argv
[1][1] == 'e')
133 return do_env_print_efi(cmdtp
, flag
, --argc
, ++argv
);
136 if (argc
> 1 && argv
[1][0] == '-' && argv
[1][1] == 'a') {
139 env_flag
&= ~H_HIDE_DOT
;
143 /* print all env vars */
144 rcode
= env_print(NULL
, env_flag
);
147 printf("\nEnvironment size: %d/%ld bytes\n",
148 rcode
, (ulong
)ENV_SIZE
);
152 /* print selected env vars */
153 env_flag
&= ~H_HIDE_DOT
;
154 for (i
= 1; i
< argc
; ++i
) {
155 int rc
= env_print(argv
[i
], env_flag
);
157 printf("## Error: \"%s\" not defined\n", argv
[i
]);
165 #ifdef CONFIG_CMD_GREPENV
166 static int do_env_grep(cmd_tbl_t
*cmdtp
, int flag
,
167 int argc
, char * const argv
[])
170 int len
, grep_how
, grep_what
;
173 return CMD_RET_USAGE
;
175 grep_how
= H_MATCH_SUBSTR
; /* default: substring search */
176 grep_what
= H_MATCH_BOTH
; /* default: grep names and values */
178 while (--argc
> 0 && **++argv
== '-') {
183 case 'e': /* use regex matching */
184 grep_how
= H_MATCH_REGEX
;
187 case 'n': /* grep for name */
188 grep_what
= H_MATCH_KEY
;
190 case 'v': /* grep for value */
191 grep_what
= H_MATCH_DATA
;
193 case 'b': /* grep for both */
194 grep_what
= H_MATCH_BOTH
;
199 return CMD_RET_USAGE
;
205 len
= hexport_r(&env_htab
, '\n',
206 flag
| grep_what
| grep_how
,
207 &res
, 0, argc
, argv
);
220 #endif /* CONFIG_SPL_BUILD */
223 * Set a new environment variable,
224 * or replace or delete an existing one.
226 static int _do_env_set(int flag
, int argc
, char * const argv
[], int env_flag
)
229 char *name
, *value
, *s
;
230 struct env_entry e
, *ep
;
232 debug("Initial value for argc=%d\n", argc
);
234 #if CONFIG_IS_ENABLED(CMD_NVEDIT_EFI)
235 if (argc
> 1 && argv
[1][0] == '-' && argv
[1][1] == 'e')
236 return do_env_set_efi(NULL
, flag
, --argc
, ++argv
);
239 while (argc
> 1 && **(argv
+ 1) == '-') {
245 case 'f': /* force */
249 return CMD_RET_USAGE
;
253 debug("Final value for argc=%d\n", argc
);
256 if (strchr(name
, '=')) {
257 printf("## Error: illegal character '='"
258 "in variable name \"%s\"\n", name
);
265 if (argc
< 3 || argv
[2] == NULL
) {
266 int rc
= hdelete_r(name
, &env_htab
, env_flag
);
271 * Insert / replace new value
273 for (i
= 2, len
= 0; i
< argc
; ++i
)
274 len
+= strlen(argv
[i
]) + 1;
278 printf("## Can't malloc %d bytes\n", len
);
281 for (i
= 2, s
= value
; i
< argc
; ++i
) {
284 while ((*s
++ = *v
++) != '\0')
293 hsearch_r(e
, ENV_ENTER
, &ep
, &env_htab
, env_flag
);
296 printf("## Error inserting \"%s\" variable, errno=%d\n",
304 int env_set(const char *varname
, const char *varvalue
)
306 const char * const argv
[4] = { "setenv", varname
, varvalue
, NULL
};
308 /* before import into hashtable */
309 if (!(gd
->flags
& GD_FLG_ENV_READY
))
312 if (varvalue
== NULL
|| varvalue
[0] == '\0')
313 return _do_env_set(0, 2, (char * const *)argv
, H_PROGRAMMATIC
);
315 return _do_env_set(0, 3, (char * const *)argv
, H_PROGRAMMATIC
);
319 * Set an environment variable to an integer value
321 * @param varname Environment variable to set
322 * @param value Value to set it to
323 * @return 0 if ok, 1 on error
325 int env_set_ulong(const char *varname
, ulong value
)
327 /* TODO: this should be unsigned */
328 char *str
= simple_itoa(value
);
330 return env_set(varname
, str
);
334 * Set an environment variable to an value in hex
336 * @param varname Environment variable to set
337 * @param value Value to set it to
338 * @return 0 if ok, 1 on error
340 int env_set_hex(const char *varname
, ulong value
)
344 sprintf(str
, "%lx", value
);
345 return env_set(varname
, str
);
348 ulong
env_get_hex(const char *varname
, ulong default_val
)
354 s
= env_get(varname
);
356 value
= simple_strtoul(s
, &endp
, 16);
363 int eth_env_get_enetaddr(const char *name
, uint8_t *enetaddr
)
365 string_to_enetaddr(env_get(name
), enetaddr
);
366 return is_valid_ethaddr(enetaddr
);
369 int eth_env_set_enetaddr(const char *name
, const uint8_t *enetaddr
)
371 char buf
[ARP_HLEN_ASCII
+ 1];
373 if (eth_env_get_enetaddr(name
, (uint8_t *)buf
))
376 sprintf(buf
, "%pM", enetaddr
);
378 return env_set(name
, buf
);
381 #ifndef CONFIG_SPL_BUILD
382 static int do_env_set(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
385 return CMD_RET_USAGE
;
387 return _do_env_set(flag
, argc
, argv
, H_INTERACTIVE
);
391 * Prompt for environment variable
393 #if defined(CONFIG_CMD_ASKENV)
394 int do_env_ask(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
396 char message
[CONFIG_SYS_CBSIZE
];
397 int i
, len
, pos
, size
;
401 local_args
[0] = argv
[0];
402 local_args
[1] = argv
[1];
403 local_args
[2] = NULL
;
404 local_args
[3] = NULL
;
409 * env_ask envname [message1 ...] [size]
412 return CMD_RET_USAGE
;
415 * We test the last argument if it can be converted
416 * into a decimal number. If yes, we assume it's
417 * the size. Otherwise we echo it as part of the
420 i
= simple_strtoul(argv
[argc
- 1], &endptr
, 10);
421 if (*endptr
!= '\0') { /* no size */
422 size
= CONFIG_SYS_CBSIZE
- 1;
423 } else { /* size given */
429 sprintf(message
, "Please enter '%s': ", argv
[1]);
431 /* env_ask envname message1 ... messagen [size] */
432 for (i
= 2, pos
= 0; i
< argc
&& pos
+1 < sizeof(message
); i
++) {
434 message
[pos
++] = ' ';
436 strncpy(message
+ pos
, argv
[i
], sizeof(message
) - pos
);
437 pos
+= strlen(argv
[i
]);
439 if (pos
< sizeof(message
) - 1) {
440 message
[pos
++] = ' ';
443 message
[CONFIG_SYS_CBSIZE
- 1] = '\0';
446 if (size
>= CONFIG_SYS_CBSIZE
)
447 size
= CONFIG_SYS_CBSIZE
- 1;
452 /* prompt for input */
453 len
= cli_readline(message
);
456 console_buffer
[size
] = '\0';
459 if (console_buffer
[0] != '\0') {
460 local_args
[2] = console_buffer
;
464 /* Continue calling setenv code */
465 return _do_env_set(flag
, len
, local_args
, H_INTERACTIVE
);
469 #if defined(CONFIG_CMD_ENV_CALLBACK)
470 static int print_static_binding(const char *var_name
, const char *callback_name
,
473 printf("\t%-20s %-20s\n", var_name
, callback_name
);
478 static int print_active_callback(struct env_entry
*entry
)
480 struct env_clbk_tbl
*clbkp
;
484 if (entry
->callback
== NULL
)
487 /* look up the callback in the linker-list */
488 num_callbacks
= ll_entry_count(struct env_clbk_tbl
, env_clbk
);
489 for (i
= 0, clbkp
= ll_entry_start(struct env_clbk_tbl
, env_clbk
);
492 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
493 if (entry
->callback
== clbkp
->callback
+ gd
->reloc_off
)
495 if (entry
->callback
== clbkp
->callback
)
500 if (i
== num_callbacks
)
501 /* this should probably never happen, but just in case... */
502 printf("\t%-20s %p\n", entry
->key
, entry
->callback
);
504 printf("\t%-20s %-20s\n", entry
->key
, clbkp
->name
);
510 * Print the callbacks available and what they are bound to
512 int do_env_callback(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
514 struct env_clbk_tbl
*clbkp
;
518 /* Print the available callbacks */
519 puts("Available callbacks:\n");
520 puts("\tCallback Name\n");
521 puts("\t-------------\n");
522 num_callbacks
= ll_entry_count(struct env_clbk_tbl
, env_clbk
);
523 for (i
= 0, clbkp
= ll_entry_start(struct env_clbk_tbl
, env_clbk
);
526 printf("\t%s\n", clbkp
->name
);
529 /* Print the static bindings that may exist */
530 puts("Static callback bindings:\n");
531 printf("\t%-20s %-20s\n", "Variable Name", "Callback Name");
532 printf("\t%-20s %-20s\n", "-------------", "-------------");
533 env_attr_walk(ENV_CALLBACK_LIST_STATIC
, print_static_binding
, NULL
);
536 /* walk through each variable and print the callback if it has one */
537 puts("Active callback bindings:\n");
538 printf("\t%-20s %-20s\n", "Variable Name", "Callback Name");
539 printf("\t%-20s %-20s\n", "-------------", "-------------");
540 hwalk_r(&env_htab
, print_active_callback
);
545 #if defined(CONFIG_CMD_ENV_FLAGS)
546 static int print_static_flags(const char *var_name
, const char *flags
,
549 enum env_flags_vartype type
= env_flags_parse_vartype(flags
);
550 enum env_flags_varaccess access
= env_flags_parse_varaccess(flags
);
552 printf("\t%-20s %-20s %-20s\n", var_name
,
553 env_flags_get_vartype_name(type
),
554 env_flags_get_varaccess_name(access
));
559 static int print_active_flags(struct env_entry
*entry
)
561 enum env_flags_vartype type
;
562 enum env_flags_varaccess access
;
564 if (entry
->flags
== 0)
567 type
= (enum env_flags_vartype
)
568 (entry
->flags
& ENV_FLAGS_VARTYPE_BIN_MASK
);
569 access
= env_flags_parse_varaccess_from_binflags(entry
->flags
);
570 printf("\t%-20s %-20s %-20s\n", entry
->key
,
571 env_flags_get_vartype_name(type
),
572 env_flags_get_varaccess_name(access
));
578 * Print the flags available and what variables have flags
580 int do_env_flags(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
582 /* Print the available variable types */
583 printf("Available variable type flags (position %d):\n",
584 ENV_FLAGS_VARTYPE_LOC
);
585 puts("\tFlag\tVariable Type Name\n");
586 puts("\t----\t------------------\n");
587 env_flags_print_vartypes();
590 /* Print the available variable access types */
591 printf("Available variable access flags (position %d):\n",
592 ENV_FLAGS_VARACCESS_LOC
);
593 puts("\tFlag\tVariable Access Name\n");
594 puts("\t----\t--------------------\n");
595 env_flags_print_varaccess();
598 /* Print the static flags that may exist */
599 puts("Static flags:\n");
600 printf("\t%-20s %-20s %-20s\n", "Variable Name", "Variable Type",
602 printf("\t%-20s %-20s %-20s\n", "-------------", "-------------",
604 env_attr_walk(ENV_FLAGS_LIST_STATIC
, print_static_flags
, NULL
);
607 /* walk through each variable and print the flags if non-default */
608 puts("Active flags:\n");
609 printf("\t%-20s %-20s %-20s\n", "Variable Name", "Variable Type",
611 printf("\t%-20s %-20s %-20s\n", "-------------", "-------------",
613 hwalk_r(&env_htab
, print_active_flags
);
619 * Interactively edit an environment variable
621 #if defined(CONFIG_CMD_EDITENV)
622 static int do_env_edit(cmd_tbl_t
*cmdtp
, int flag
, int argc
,
625 char buffer
[CONFIG_SYS_CBSIZE
];
629 return CMD_RET_USAGE
;
631 /* before import into hashtable */
632 if (!(gd
->flags
& GD_FLG_ENV_READY
))
635 /* Set read buffer to initial value or empty sting */
636 init_val
= env_get(argv
[1]);
638 snprintf(buffer
, CONFIG_SYS_CBSIZE
, "%s", init_val
);
642 if (cli_readline_into_buffer("edit: ", buffer
, 0) < 0)
645 if (buffer
[0] == '\0') {
646 const char * const _argv
[3] = { "setenv", argv
[1], NULL
};
648 return _do_env_set(0, 2, (char * const *)_argv
, H_INTERACTIVE
);
650 const char * const _argv
[4] = { "setenv", argv
[1], buffer
,
653 return _do_env_set(0, 3, (char * const *)_argv
, H_INTERACTIVE
);
656 #endif /* CONFIG_CMD_EDITENV */
657 #endif /* CONFIG_SPL_BUILD */
660 * Look up variable from environment,
661 * return address of storage for that variable,
662 * or NULL if not found
664 char *env_get(const char *name
)
666 if (gd
->flags
& GD_FLG_ENV_READY
) { /* after import into hashtable */
667 struct env_entry e
, *ep
;
673 hsearch_r(e
, ENV_FIND
, &ep
, &env_htab
, 0);
675 return ep
? ep
->data
: NULL
;
678 /* restricted capabilities before import */
679 if (env_get_f(name
, (char *)(gd
->env_buf
), sizeof(gd
->env_buf
)) > 0)
680 return (char *)(gd
->env_buf
);
686 * Like env_get, but prints an error if envvar isn't defined in the
687 * environment. It always returns what env_get does, so it can be used in
688 * place of env_get without changing error handling otherwise.
690 char *from_env(const char *envvar
)
694 ret
= env_get(envvar
);
697 printf("missing environment variable: %s\n", envvar
);
703 * Look up variable from environment for restricted C runtime env.
705 int env_get_f(const char *name
, char *buf
, unsigned len
)
709 for (i
= 0; env_get_char(i
) != '\0'; i
= nxt
+ 1) {
712 for (nxt
= i
; (c
= env_get_char(nxt
)) != '\0'; ++nxt
) {
715 if (nxt
>= CONFIG_ENV_SIZE
)
719 val
= env_match((uchar
*)name
, i
);
723 /* found; copy out */
724 for (n
= 0; n
< len
; ++n
, ++buf
) {
725 c
= env_get_char(val
++);
736 printf("env_buf [%u bytes] too small for value of \"%s\"\n",
746 * Decode the integer value of an environment variable and return it.
748 * @param name Name of environment variable
749 * @param base Number base to use (normally 10, or 16 for hex)
750 * @param default_val Default value to return if the variable is not
752 * @return the decoded value, or default_val if not found
754 ulong
env_get_ulong(const char *name
, int base
, ulong default_val
)
757 * We can use env_get() here, even before relocation, since the
758 * environment variable value is an integer and thus short.
760 const char *str
= env_get(name
);
762 return str
? simple_strtoul(str
, NULL
, base
) : default_val
;
765 #ifndef CONFIG_SPL_BUILD
766 #if defined(CONFIG_CMD_SAVEENV) && defined(ENV_IS_IN_DEVICE)
767 static int do_env_save(cmd_tbl_t
*cmdtp
, int flag
, int argc
,
770 return env_save() ? 1 : 0;
774 saveenv
, 1, 0, do_env_save
,
775 "save environment variables to persistent storage",
779 #if defined(CONFIG_CMD_ERASEENV)
780 static int do_env_erase(cmd_tbl_t
*cmdtp
, int flag
, int argc
,
783 return env_erase() ? 1 : 0;
787 eraseenv
, 1, 0, do_env_erase
,
788 "erase environment variables from persistent storage",
793 #endif /* CONFIG_SPL_BUILD */
795 int env_match(uchar
*s1
, int i2
)
800 while (*s1
== env_get_char(i2
++))
804 if (*s1
== '\0' && env_get_char(i2
-1) == '=')
810 #ifndef CONFIG_SPL_BUILD
811 static int do_env_default(cmd_tbl_t
*cmdtp
, int flag
,
812 int argc
, char * const argv
[])
814 int all
= 0, env_flag
= H_INTERACTIVE
;
816 debug("Initial value for argc=%d\n", argc
);
817 while (--argc
> 0 && **++argv
== '-') {
822 case 'a': /* default all */
825 case 'f': /* force */
829 return cmd_usage(cmdtp
);
833 debug("Final value for argc=%d\n", argc
);
834 if (all
&& (argc
== 0)) {
835 /* Reset the whole environment */
836 env_set_default("## Resetting to default environment\n",
840 if (!all
&& (argc
> 0)) {
841 /* Reset individual variables */
842 env_set_default_vars(argc
, argv
, env_flag
);
846 return cmd_usage(cmdtp
);
849 static int do_env_delete(cmd_tbl_t
*cmdtp
, int flag
,
850 int argc
, char * const argv
[])
852 int env_flag
= H_INTERACTIVE
;
855 debug("Initial value for argc=%d\n", argc
);
856 while (argc
> 1 && **(argv
+ 1) == '-') {
862 case 'f': /* force */
866 return CMD_RET_USAGE
;
870 debug("Final value for argc=%d\n", argc
);
875 char *name
= *++argv
;
877 if (!hdelete_r(name
, &env_htab
, env_flag
))
884 #ifdef CONFIG_CMD_EXPORTENV
886 * env export [-t | -b | -c] [-s size] addr [var ...]
887 * -t: export as text format; if size is given, data will be
888 * padded with '\0' bytes; if not, one terminating '\0'
889 * will be added (which is included in the "filesize"
890 * setting so you can for exmple copy this to flash and
891 * keep the termination).
892 * -b: export as binary format (name=value pairs separated by
893 * '\0', list end marked by double "\0\0")
894 * -c: export as checksum protected environment format as
895 * used for example by "saveenv" command
897 * size of output buffer
898 * addr: memory address where environment gets stored
899 * var... List of variable names that get included into the
900 * export. Without arguments, the whole environment gets
903 * With "-c" and size is NOT given, then the export command will
904 * format the data as currently used for the persistent storage,
905 * i. e. it will use CONFIG_ENV_SECT_SIZE as output block size and
906 * prepend a valid CRC32 checksum and, in case of redundant
907 * environment, a "current" redundancy flag. If size is given, this
908 * value will be used instead of CONFIG_ENV_SECT_SIZE; again, CRC32
909 * checksum and redundancy flag will be inserted.
911 * With "-b" and "-t", always only the real data (including a
912 * terminating '\0' byte) will be written; here the optional size
913 * argument will be used to make sure not to overflow the user
914 * provided buffer; the command will abort if the size is not
915 * sufficient. Any remaining space will be '\0' padded.
917 * On successful return, the variable "filesize" will be set.
918 * Note that filesize includes the trailing/terminating '\0' byte(s).
920 * Usage scenario: create a text snapshot/backup of the current settings:
922 * => env export -t 100000
923 * => era ${backup_addr} +${filesize}
924 * => cp.b 100000 ${backup_addr} ${filesize}
926 * Re-import this snapshot, deleting all other settings:
928 * => env import -d -t ${backup_addr}
930 static int do_env_export(cmd_tbl_t
*cmdtp
, int flag
,
931 int argc
, char * const argv
[])
935 char *ptr
, *cmd
, *res
;
945 while (--argc
> 0 && **++argv
== '-') {
949 case 'b': /* raw binary format */
954 case 'c': /* external checksum format */
960 case 's': /* size given */
962 return cmd_usage(cmdtp
);
963 size
= simple_strtoul(*++argv
, NULL
, 16);
965 case 't': /* text format */
971 return CMD_RET_USAGE
;
978 return CMD_RET_USAGE
;
980 addr
= simple_strtoul(argv
[0], NULL
, 16);
981 ptr
= map_sysmem(addr
, size
);
984 memset(ptr
, '\0', size
);
989 if (sep
) { /* export as text file */
990 len
= hexport_r(&env_htab
, sep
,
991 H_MATCH_KEY
| H_MATCH_IDENT
,
992 &ptr
, size
, argc
, argv
);
994 pr_err("## Error: Cannot export environment: errno = %d\n",
998 sprintf(buf
, "%zX", (size_t)len
);
999 env_set("filesize", buf
);
1004 envp
= (env_t
*)ptr
;
1006 if (chk
) /* export as checksum protected block */
1007 res
= (char *)envp
->data
;
1008 else /* export as raw binary data */
1011 len
= hexport_r(&env_htab
, '\0',
1012 H_MATCH_KEY
| H_MATCH_IDENT
,
1013 &res
, ENV_SIZE
, argc
, argv
);
1015 pr_err("## Error: Cannot export environment: errno = %d\n",
1021 envp
->crc
= crc32(0, envp
->data
,
1022 size
? size
- offsetof(env_t
, data
) : ENV_SIZE
);
1023 #ifdef CONFIG_ENV_ADDR_REDUND
1024 envp
->flags
= ENV_REDUND_ACTIVE
;
1027 env_set_hex("filesize", len
+ offsetof(env_t
, data
));
1032 printf("## Error: %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n",
1038 #ifdef CONFIG_CMD_IMPORTENV
1040 * env import [-d] [-t [-r] | -b | -c] addr [size] [var ...]
1041 * -d: delete existing environment before importing if no var is
1042 * passed; if vars are passed, if one var is in the current
1043 * environment but not in the environment at addr, delete var from
1044 * current environment;
1045 * otherwise overwrite / append to existing definitions
1046 * -t: assume text format; either "size" must be given or the
1047 * text data must be '\0' terminated
1048 * -r: handle CRLF like LF, that means exported variables with
1049 * a content which ends with \r won't get imported. Used
1050 * to import text files created with editors which are using CRLF
1051 * for line endings. Only effective in addition to -t.
1052 * -b: assume binary format ('\0' separated, "\0\0" terminated)
1053 * -c: assume checksum protected environment format
1054 * addr: memory address to read from
1055 * size: length of input data; if missing, proper '\0'
1056 * termination is mandatory
1057 * if var is set and size should be missing (i.e. '\0'
1058 * termination), set size to '-'
1059 * var... List of the names of the only variables that get imported from
1060 * the environment at address 'addr'. Without arguments, the whole
1061 * environment gets imported.
1063 static int do_env_import(cmd_tbl_t
*cmdtp
, int flag
,
1064 int argc
, char * const argv
[])
1078 while (--argc
> 0 && **++argv
== '-') {
1082 case 'b': /* raw binary format */
1087 case 'c': /* external checksum format */
1093 case 't': /* text format */
1098 case 'r': /* handle CRLF like LF */
1105 return CMD_RET_USAGE
;
1111 return CMD_RET_USAGE
;
1114 printf("## Warning: defaulting to text format\n");
1116 if (sep
!= '\n' && crlf_is_lf
)
1119 addr
= simple_strtoul(argv
[0], NULL
, 16);
1120 ptr
= map_sysmem(addr
, 0);
1122 if (argc
>= 2 && strcmp(argv
[1], "-")) {
1123 size
= simple_strtoul(argv
[1], NULL
, 16);
1125 puts("## Error: external checksum format must pass size\n");
1126 return CMD_RET_FAILURE
;
1132 while (size
< MAX_ENV_SIZE
) {
1133 if ((*s
== sep
) && (*(s
+1) == '\0'))
1138 if (size
== MAX_ENV_SIZE
) {
1139 printf("## Warning: Input data exceeds %d bytes"
1140 " - truncated\n", MAX_ENV_SIZE
);
1143 printf("## Info: input data size = %zu = 0x%zX\n", size
, size
);
1151 env_t
*ep
= (env_t
*)ptr
;
1153 size
-= offsetof(env_t
, data
);
1154 memcpy(&crc
, &ep
->crc
, sizeof(crc
));
1156 if (crc32(0, ep
->data
, size
) != crc
) {
1157 puts("## Error: bad CRC, import failed\n");
1160 ptr
= (char *)ep
->data
;
1163 if (!himport_r(&env_htab
, ptr
, size
, sep
, del
? 0 : H_NOCLEAR
,
1164 crlf_is_lf
, wl
? argc
- 2 : 0, wl
? &argv
[2] : NULL
)) {
1165 pr_err("## Error: Environment import failed: errno = %d\n",
1169 gd
->flags
|= GD_FLG_ENV_READY
;
1174 printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n",
1180 #if defined(CONFIG_CMD_NVEDIT_INFO)
1182 * print_env_info - print environment information
1184 static int print_env_info(void)
1188 /* print environment validity value */
1189 switch (gd
->env_valid
) {
1197 value
= "redundant";
1203 printf("env_valid = %s\n", value
);
1205 /* print environment ready flag */
1206 value
= gd
->flags
& GD_FLG_ENV_READY
? "true" : "false";
1207 printf("env_ready = %s\n", value
);
1209 /* print environment using default flag */
1210 value
= gd
->flags
& GD_FLG_ENV_DEFAULT
? "true" : "false";
1211 printf("env_use_default = %s\n", value
);
1213 return CMD_RET_SUCCESS
;
1216 #define ENV_INFO_IS_DEFAULT BIT(0) /* default environment bit mask */
1217 #define ENV_INFO_IS_PERSISTED BIT(1) /* environment persistence bit mask */
1220 * env info - display environment information
1221 * env info [-d] - evaluate whether default environment is used
1222 * env info [-p] - evaluate whether environment can be persisted
1224 static int do_env_info(cmd_tbl_t
*cmdtp
, int flag
,
1225 int argc
, char * const argv
[])
1228 int eval_results
= 0;
1230 /* display environment information */
1232 return print_env_info();
1234 /* process options */
1235 while (--argc
> 0 && **++argv
== '-') {
1241 eval_flags
|= ENV_INFO_IS_DEFAULT
;
1244 eval_flags
|= ENV_INFO_IS_PERSISTED
;
1247 return CMD_RET_USAGE
;
1252 /* evaluate whether default environment is used */
1253 if (eval_flags
& ENV_INFO_IS_DEFAULT
) {
1254 if (gd
->flags
& GD_FLG_ENV_DEFAULT
) {
1255 printf("Default environment is used\n");
1256 eval_results
|= ENV_INFO_IS_DEFAULT
;
1258 printf("Environment was loaded from persistent storage\n");
1262 /* evaluate whether environment can be persisted */
1263 if (eval_flags
& ENV_INFO_IS_PERSISTED
) {
1264 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
1265 printf("Environment can be persisted\n");
1266 eval_results
|= ENV_INFO_IS_PERSISTED
;
1268 printf("Environment cannot be persisted\n");
1272 /* The result of evaluations is combined with AND */
1273 if (eval_flags
!= eval_results
)
1274 return CMD_RET_FAILURE
;
1276 return CMD_RET_SUCCESS
;
1280 #if defined(CONFIG_CMD_ENV_EXISTS)
1281 static int do_env_exists(cmd_tbl_t
*cmdtp
, int flag
, int argc
,
1282 char * const argv
[])
1284 struct env_entry e
, *ep
;
1287 return CMD_RET_USAGE
;
1291 hsearch_r(e
, ENV_FIND
, &ep
, &env_htab
, 0);
1293 return (ep
== NULL
) ? 1 : 0;
1298 * New command line interface: "env" command with subcommands
1300 static cmd_tbl_t cmd_env_sub
[] = {
1301 #if defined(CONFIG_CMD_ASKENV)
1302 U_BOOT_CMD_MKENT(ask
, CONFIG_SYS_MAXARGS
, 1, do_env_ask
, "", ""),
1304 U_BOOT_CMD_MKENT(default, 1, 0, do_env_default
, "", ""),
1305 U_BOOT_CMD_MKENT(delete, CONFIG_SYS_MAXARGS
, 0, do_env_delete
, "", ""),
1306 #if defined(CONFIG_CMD_EDITENV)
1307 U_BOOT_CMD_MKENT(edit
, 2, 0, do_env_edit
, "", ""),
1309 #if defined(CONFIG_CMD_ENV_CALLBACK)
1310 U_BOOT_CMD_MKENT(callbacks
, 1, 0, do_env_callback
, "", ""),
1312 #if defined(CONFIG_CMD_ENV_FLAGS)
1313 U_BOOT_CMD_MKENT(flags
, 1, 0, do_env_flags
, "", ""),
1315 #if defined(CONFIG_CMD_EXPORTENV)
1316 U_BOOT_CMD_MKENT(export
, 4, 0, do_env_export
, "", ""),
1318 #if defined(CONFIG_CMD_GREPENV)
1319 U_BOOT_CMD_MKENT(grep
, CONFIG_SYS_MAXARGS
, 1, do_env_grep
, "", ""),
1321 #if defined(CONFIG_CMD_IMPORTENV)
1322 U_BOOT_CMD_MKENT(import
, 5, 0, do_env_import
, "", ""),
1324 #if defined(CONFIG_CMD_NVEDIT_INFO)
1325 U_BOOT_CMD_MKENT(info
, 2, 0, do_env_info
, "", ""),
1327 U_BOOT_CMD_MKENT(print
, CONFIG_SYS_MAXARGS
, 1, do_env_print
, "", ""),
1328 #if defined(CONFIG_CMD_RUN)
1329 U_BOOT_CMD_MKENT(run
, CONFIG_SYS_MAXARGS
, 1, do_run
, "", ""),
1331 #if defined(CONFIG_CMD_SAVEENV) && defined(ENV_IS_IN_DEVICE)
1332 U_BOOT_CMD_MKENT(save
, 1, 0, do_env_save
, "", ""),
1333 #if defined(CONFIG_CMD_ERASEENV)
1334 U_BOOT_CMD_MKENT(erase
, 1, 0, do_env_erase
, "", ""),
1337 U_BOOT_CMD_MKENT(set
, CONFIG_SYS_MAXARGS
, 0, do_env_set
, "", ""),
1338 #if defined(CONFIG_CMD_ENV_EXISTS)
1339 U_BOOT_CMD_MKENT(exists
, 2, 0, do_env_exists
, "", ""),
1343 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
1344 void env_reloc(void)
1346 fixup_cmdtable(cmd_env_sub
, ARRAY_SIZE(cmd_env_sub
));
1350 static int do_env(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
1355 return CMD_RET_USAGE
;
1357 /* drop initial "env" arg */
1361 cp
= find_cmd_tbl(argv
[0], cmd_env_sub
, ARRAY_SIZE(cmd_env_sub
));
1364 return cp
->cmd(cmdtp
, flag
, argc
, argv
);
1366 return CMD_RET_USAGE
;
1369 #ifdef CONFIG_SYS_LONGHELP
1370 static char env_help_text
[] =
1371 #if defined(CONFIG_CMD_ASKENV)
1372 "ask name [message] [size] - ask for environment variable\nenv "
1374 #if defined(CONFIG_CMD_ENV_CALLBACK)
1375 "callbacks - print callbacks and their associated variables\nenv "
1377 "default [-f] -a - [forcibly] reset default environment\n"
1378 "env default [-f] var [...] - [forcibly] reset variable(s) to their default values\n"
1379 "env delete [-f] var [...] - [forcibly] delete variable(s)\n"
1380 #if defined(CONFIG_CMD_EDITENV)
1381 "env edit name - edit environment variable\n"
1383 #if defined(CONFIG_CMD_ENV_EXISTS)
1384 "env exists name - tests for existence of variable\n"
1386 #if defined(CONFIG_CMD_EXPORTENV)
1387 "env export [-t | -b | -c] [-s size] addr [var ...] - export environment\n"
1389 #if defined(CONFIG_CMD_ENV_FLAGS)
1390 "env flags - print variables that have non-default flags\n"
1392 #if defined(CONFIG_CMD_GREPENV)
1394 "env grep [-e] [-n | -v | -b] string [...] - search environment\n"
1396 "env grep [-n | -v | -b] string [...] - search environment\n"
1399 #if defined(CONFIG_CMD_IMPORTENV)
1400 "env import [-d] [-t [-r] | -b | -c] addr [size] [var ...] - import environment\n"
1402 #if defined(CONFIG_CMD_NVEDIT_INFO)
1403 "env info - display environment information\n"
1404 "env info [-d] - whether default environment is used\n"
1405 "env info [-p] - whether environment can be persisted\n"
1407 "env print [-a | name ...] - print environment\n"
1408 #if defined(CONFIG_CMD_NVEDIT_EFI)
1409 "env print -e [-guid guid|-all][-n] [name ...] - print UEFI environment\n"
1411 #if defined(CONFIG_CMD_RUN)
1412 "env run var [...] - run commands in an environment variable\n"
1414 #if defined(CONFIG_CMD_SAVEENV) && defined(ENV_IS_IN_DEVICE)
1415 "env save - save environment\n"
1416 #if defined(CONFIG_CMD_ERASEENV)
1417 "env erase - erase environment\n"
1420 #if defined(CONFIG_CMD_NVEDIT_EFI)
1421 "env set -e [-nv][-bs][-rt][-at][-a][-i addr,size][-v] name [arg ...]\n"
1422 " - set UEFI variable; unset if '-i' or 'arg' not specified\n"
1424 "env set [-f] name [arg ...]\n";
1428 env
, CONFIG_SYS_MAXARGS
, 1, do_env
,
1429 "environment handling commands", env_help_text
1433 * Old command line interface, kept for compatibility
1436 #if defined(CONFIG_CMD_EDITENV)
1437 U_BOOT_CMD_COMPLETE(
1438 editenv
, 2, 0, do_env_edit
,
1439 "edit environment variable",
1441 " - edit environment variable 'name'",
1446 U_BOOT_CMD_COMPLETE(
1447 printenv
, CONFIG_SYS_MAXARGS
, 1, do_env_print
,
1448 "print environment variables",
1449 "[-a]\n - print [all] values of all environment variables\n"
1450 #if defined(CONFIG_CMD_NVEDIT_EFI)
1451 "printenv -e [-guid guid|-all][-n] [name ...]\n"
1452 " - print UEFI variable 'name' or all the variables\n"
1453 " \"-n\": suppress dumping variable's value\n"
1455 "printenv name ...\n"
1456 " - print value of environment variable 'name'",
1460 #ifdef CONFIG_CMD_GREPENV
1461 U_BOOT_CMD_COMPLETE(
1462 grepenv
, CONFIG_SYS_MAXARGS
, 0, do_env_grep
,
1463 "search environment variables",
1465 "[-e] [-n | -v | -b] string ...\n"
1467 "[-n | -v | -b] string ...\n"
1469 " - list environment name=value pairs matching 'string'\n"
1471 " \"-e\": enable regular expressions;\n"
1473 " \"-n\": search variable names; \"-v\": search values;\n"
1474 " \"-b\": search both names and values (default)",
1479 U_BOOT_CMD_COMPLETE(
1480 setenv
, CONFIG_SYS_MAXARGS
, 0, do_env_set
,
1481 "set environment variables",
1482 #if defined(CONFIG_CMD_NVEDIT_EFI)
1483 "-e [-guid guid][-nv][-bs][-rt][-at][-a][-v]\n"
1484 " [-i addr,size name], or [name [value ...]]\n"
1485 " - set UEFI variable 'name' to 'value' ...'\n"
1486 " \"-guid\": set vendor guid\n"
1487 " \"-nv\": set non-volatile attribute\n"
1488 " \"-bs\": set boot-service attribute\n"
1489 " \"-rt\": set runtime attribute\n"
1490 " \"-at\": set time-based authentication attribute\n"
1491 " \"-a\": append-write\n"
1492 " \"-i addr,size\": use <addr,size> as variable's value\n"
1493 " \"-v\": verbose message\n"
1494 " - delete UEFI variable 'name' if 'value' not specified\n"
1496 "setenv [-f] name value ...\n"
1497 " - [forcibly] set environment variable 'name' to 'value ...'\n"
1498 "setenv [-f] name\n"
1499 " - [forcibly] delete environment variable 'name'",
1503 #if defined(CONFIG_CMD_ASKENV)
1506 askenv
, CONFIG_SYS_MAXARGS
, 1, do_env_ask
,
1507 "get environment variables from stdin",
1508 "name [message] [size]\n"
1509 " - get environment variable 'name' from stdin (max 'size' chars)"
1513 #if defined(CONFIG_CMD_RUN)
1514 U_BOOT_CMD_COMPLETE(
1515 run
, CONFIG_SYS_MAXARGS
, 1, do_run
,
1516 "run commands in an environment variable",
1518 " - run the commands in the environment variable(s) 'var'",
1522 #endif /* CONFIG_SPL_BUILD */