1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright 2000-2013
6 * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
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 <asm/global_data.h>
38 #include <linux/bitops.h>
39 #include <u-boot/crc.h>
40 #include <linux/stddef.h>
41 #include <asm/byteorder.h>
44 DECLARE_GLOBAL_DATA_PTR;
47 * Maximum expected input data size for import command
49 #define MAX_ENV_SIZE (1 << 20) /* 1 MiB */
52 * This variable is incremented on each do_env_set(), so it can
53 * be used via env_get_id() as an indication, if the environment
54 * has changed or not. So it is possible to reread an environment
55 * variable only if the environment was changed ... done so for
56 * example in NetInitLoop()
58 static int env_id = 1;
65 #ifndef CONFIG_SPL_BUILD
67 * Command interface: print one or all environment variables
69 * Returns 0 in case of error, or length of printed string
71 static int env_print(char *name, int flag)
76 if (name) { /* print a single name */
77 struct env_entry e, *ep;
81 hsearch_r(e, ENV_FIND, &ep, &env_htab, flag);
84 len = printf("%s=%s\n", ep->key, ep->data);
88 /* print whole list */
89 len = hexport_r(&env_htab, '\n', flag, &res, 0, 0, NULL);
97 /* should never happen */
98 printf("## Error: cannot export environment\n");
102 static int do_env_print(struct cmd_tbl *cmdtp, int flag, int argc,
107 int env_flag = H_HIDE_DOT;
109 #if defined(CONFIG_CMD_NVEDIT_EFI)
110 if (argc > 1 && argv[1][0] == '-' && argv[1][1] == 'e')
111 return do_env_print_efi(cmdtp, flag, --argc, ++argv);
114 if (argc > 1 && argv[1][0] == '-' && argv[1][1] == 'a') {
117 env_flag &= ~H_HIDE_DOT;
121 /* print all env vars */
122 rcode = env_print(NULL, env_flag);
125 printf("\nEnvironment size: %d/%ld bytes\n",
126 rcode, (ulong)ENV_SIZE);
130 /* print selected env vars */
131 env_flag &= ~H_HIDE_DOT;
132 for (i = 1; i < argc; ++i) {
133 int rc = env_print(argv[i], env_flag);
135 printf("## Error: \"%s\" not defined\n", argv[i]);
143 #ifdef CONFIG_CMD_GREPENV
144 static int do_env_grep(struct cmd_tbl *cmdtp, int flag,
145 int argc, char *const argv[])
148 int len, grep_how, grep_what;
151 return CMD_RET_USAGE;
153 grep_how = H_MATCH_SUBSTR; /* default: substring search */
154 grep_what = H_MATCH_BOTH; /* default: grep names and values */
156 while (--argc > 0 && **++argv == '-') {
161 case 'e': /* use regex matching */
162 grep_how = H_MATCH_REGEX;
165 case 'n': /* grep for name */
166 grep_what = H_MATCH_KEY;
168 case 'v': /* grep for value */
169 grep_what = H_MATCH_DATA;
171 case 'b': /* grep for both */
172 grep_what = H_MATCH_BOTH;
177 return CMD_RET_USAGE;
183 len = hexport_r(&env_htab, '\n',
184 flag | grep_what | grep_how,
185 &res, 0, argc, argv);
198 #endif /* CONFIG_SPL_BUILD */
201 * Set a new environment variable,
202 * or replace or delete an existing one.
204 static int _do_env_set(int flag, int argc, char *const argv[], int env_flag)
207 char *name, *value, *s;
208 struct env_entry e, *ep;
210 debug("Initial value for argc=%d\n", argc);
212 #if !IS_ENABLED(CONFIG_SPL_BUILD) && IS_ENABLED(CONFIG_CMD_NVEDIT_EFI)
213 if (argc > 1 && argv[1][0] == '-' && argv[1][1] == 'e')
214 return do_env_set_efi(NULL, flag, --argc, ++argv);
217 while (argc > 1 && **(argv + 1) == '-') {
223 case 'f': /* force */
227 return CMD_RET_USAGE;
231 debug("Final value for argc=%d\n", argc);
234 if (strchr(name, '=')) {
235 printf("## Error: illegal character '='"
236 "in variable name \"%s\"\n", name);
243 if (argc < 3 || argv[2] == NULL) {
244 int rc = hdelete_r(name, &env_htab, env_flag);
246 /* If the variable didn't exist, don't report an error */
247 return rc && rc != -ENOENT ? 1 : 0;
251 * Insert / replace new value
253 for (i = 2, len = 0; i < argc; ++i)
254 len += strlen(argv[i]) + 1;
258 printf("## Can't malloc %d bytes\n", len);
261 for (i = 2, s = value; i < argc; ++i) {
264 while ((*s++ = *v++) != '\0')
273 hsearch_r(e, ENV_ENTER, &ep, &env_htab, env_flag);
276 printf("## Error inserting \"%s\" variable, errno=%d\n",
284 int env_set(const char *varname, const char *varvalue)
286 const char * const argv[4] = { "setenv", varname, varvalue, NULL };
288 /* before import into hashtable */
289 if (!(gd->flags & GD_FLG_ENV_READY))
292 if (varvalue == NULL || varvalue[0] == '\0')
293 return _do_env_set(0, 2, (char * const *)argv, H_PROGRAMMATIC);
295 return _do_env_set(0, 3, (char * const *)argv, H_PROGRAMMATIC);
298 #ifndef CONFIG_SPL_BUILD
299 static int do_env_set(struct cmd_tbl *cmdtp, int flag, int argc,
303 return CMD_RET_USAGE;
305 return _do_env_set(flag, argc, argv, H_INTERACTIVE);
309 * Prompt for environment variable
311 #if defined(CONFIG_CMD_ASKENV)
312 int do_env_ask(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
314 char message[CONFIG_SYS_CBSIZE];
315 int i, len, pos, size;
319 local_args[0] = argv[0];
320 local_args[1] = argv[1];
321 local_args[2] = NULL;
322 local_args[3] = NULL;
327 * env_ask envname [message1 ...] [size]
330 return CMD_RET_USAGE;
333 * We test the last argument if it can be converted
334 * into a decimal number. If yes, we assume it's
335 * the size. Otherwise we echo it as part of the
338 i = dectoul(argv[argc - 1], &endptr);
339 if (*endptr != '\0') { /* no size */
340 size = CONFIG_SYS_CBSIZE - 1;
341 } else { /* size given */
347 sprintf(message, "Please enter '%s': ", argv[1]);
349 /* env_ask envname message1 ... messagen [size] */
350 for (i = 2, pos = 0; i < argc && pos+1 < sizeof(message); i++) {
352 message[pos++] = ' ';
354 strncpy(message + pos, argv[i], sizeof(message) - pos);
355 pos += strlen(argv[i]);
357 if (pos < sizeof(message) - 1) {
358 message[pos++] = ' ';
361 message[CONFIG_SYS_CBSIZE - 1] = '\0';
364 if (size >= CONFIG_SYS_CBSIZE)
365 size = CONFIG_SYS_CBSIZE - 1;
370 /* prompt for input */
371 len = cli_readline(message);
374 console_buffer[size] = '\0';
377 if (console_buffer[0] != '\0') {
378 local_args[2] = console_buffer;
382 /* Continue calling setenv code */
383 return _do_env_set(flag, len, local_args, H_INTERACTIVE);
387 #if defined(CONFIG_CMD_ENV_CALLBACK)
388 static int print_static_binding(const char *var_name, const char *callback_name,
391 printf("\t%-20s %-20s\n", var_name, callback_name);
396 static int print_active_callback(struct env_entry *entry)
398 struct env_clbk_tbl *clbkp;
402 if (entry->callback == NULL)
405 /* look up the callback in the linker-list */
406 num_callbacks = ll_entry_count(struct env_clbk_tbl, env_clbk);
407 for (i = 0, clbkp = ll_entry_start(struct env_clbk_tbl, env_clbk);
410 if (entry->callback == clbkp->callback)
414 if (i == num_callbacks)
415 /* this should probably never happen, but just in case... */
416 printf("\t%-20s %p\n", entry->key, entry->callback);
418 printf("\t%-20s %-20s\n", entry->key, clbkp->name);
424 * Print the callbacks available and what they are bound to
426 int do_env_callback(struct cmd_tbl *cmdtp, int flag, int argc,
429 struct env_clbk_tbl *clbkp;
433 /* Print the available callbacks */
434 puts("Available callbacks:\n");
435 puts("\tCallback Name\n");
436 puts("\t-------------\n");
437 num_callbacks = ll_entry_count(struct env_clbk_tbl, env_clbk);
438 for (i = 0, clbkp = ll_entry_start(struct env_clbk_tbl, env_clbk);
441 printf("\t%s\n", clbkp->name);
444 /* Print the static bindings that may exist */
445 puts("Static callback bindings:\n");
446 printf("\t%-20s %-20s\n", "Variable Name", "Callback Name");
447 printf("\t%-20s %-20s\n", "-------------", "-------------");
448 env_attr_walk(ENV_CALLBACK_LIST_STATIC, print_static_binding, NULL);
451 /* walk through each variable and print the callback if it has one */
452 puts("Active callback bindings:\n");
453 printf("\t%-20s %-20s\n", "Variable Name", "Callback Name");
454 printf("\t%-20s %-20s\n", "-------------", "-------------");
455 hwalk_r(&env_htab, print_active_callback);
460 #if defined(CONFIG_CMD_ENV_FLAGS)
461 static int print_static_flags(const char *var_name, const char *flags,
464 enum env_flags_vartype type = env_flags_parse_vartype(flags);
465 enum env_flags_varaccess access = env_flags_parse_varaccess(flags);
467 printf("\t%-20s %-20s %-20s\n", var_name,
468 env_flags_get_vartype_name(type),
469 env_flags_get_varaccess_name(access));
474 static int print_active_flags(struct env_entry *entry)
476 enum env_flags_vartype type;
477 enum env_flags_varaccess access;
479 if (entry->flags == 0)
482 type = (enum env_flags_vartype)
483 (entry->flags & ENV_FLAGS_VARTYPE_BIN_MASK);
484 access = env_flags_parse_varaccess_from_binflags(entry->flags);
485 printf("\t%-20s %-20s %-20s\n", entry->key,
486 env_flags_get_vartype_name(type),
487 env_flags_get_varaccess_name(access));
493 * Print the flags available and what variables have flags
495 int do_env_flags(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
497 /* Print the available variable types */
498 printf("Available variable type flags (position %d):\n",
499 ENV_FLAGS_VARTYPE_LOC);
500 puts("\tFlag\tVariable Type Name\n");
501 puts("\t----\t------------------\n");
502 env_flags_print_vartypes();
505 /* Print the available variable access types */
506 printf("Available variable access flags (position %d):\n",
507 ENV_FLAGS_VARACCESS_LOC);
508 puts("\tFlag\tVariable Access Name\n");
509 puts("\t----\t--------------------\n");
510 env_flags_print_varaccess();
513 /* Print the static flags that may exist */
514 puts("Static flags:\n");
515 printf("\t%-20s %-20s %-20s\n", "Variable Name", "Variable Type",
517 printf("\t%-20s %-20s %-20s\n", "-------------", "-------------",
519 env_attr_walk(ENV_FLAGS_LIST_STATIC, print_static_flags, NULL);
522 /* walk through each variable and print the flags if non-default */
523 puts("Active flags:\n");
524 printf("\t%-20s %-20s %-20s\n", "Variable Name", "Variable Type",
526 printf("\t%-20s %-20s %-20s\n", "-------------", "-------------",
528 hwalk_r(&env_htab, print_active_flags);
534 * Interactively edit an environment variable
536 #if defined(CONFIG_CMD_EDITENV)
537 static int do_env_edit(struct cmd_tbl *cmdtp, int flag, int argc,
540 char buffer[CONFIG_SYS_CBSIZE];
544 return CMD_RET_USAGE;
546 /* before import into hashtable */
547 if (!(gd->flags & GD_FLG_ENV_READY))
550 /* Set read buffer to initial value or empty sting */
551 init_val = env_get(argv[1]);
553 snprintf(buffer, CONFIG_SYS_CBSIZE, "%s", init_val);
557 if (cli_readline_into_buffer("edit: ", buffer, 0) < 0)
560 if (buffer[0] == '\0') {
561 const char * const _argv[3] = { "setenv", argv[1], NULL };
563 return _do_env_set(0, 2, (char * const *)_argv, H_INTERACTIVE);
565 const char * const _argv[4] = { "setenv", argv[1], buffer,
568 return _do_env_set(0, 3, (char * const *)_argv, H_INTERACTIVE);
571 #endif /* CONFIG_CMD_EDITENV */
573 #if defined(CONFIG_CMD_SAVEENV) && !IS_ENABLED(CONFIG_ENV_IS_DEFAULT)
574 static int do_env_save(struct cmd_tbl *cmdtp, int flag, int argc,
577 return env_save() ? 1 : 0;
581 saveenv, 1, 0, do_env_save,
582 "save environment variables to persistent storage",
586 #if defined(CONFIG_CMD_ERASEENV)
587 static int do_env_erase(struct cmd_tbl *cmdtp, int flag, int argc,
590 return env_erase() ? 1 : 0;
594 eraseenv, 1, 0, do_env_erase,
595 "erase environment variables from persistent storage",
601 #if defined(CONFIG_CMD_NVEDIT_LOAD)
602 static int do_env_load(struct cmd_tbl *cmdtp, int flag, int argc,
605 return env_reload() ? 1 : 0;
609 #if defined(CONFIG_CMD_NVEDIT_SELECT)
610 static int do_env_select(struct cmd_tbl *cmdtp, int flag, int argc,
613 return env_select(argv[1]) ? 1 : 0;
617 #endif /* CONFIG_SPL_BUILD */
619 #ifndef CONFIG_SPL_BUILD
620 static int do_env_default(struct cmd_tbl *cmdtp, int flag,
621 int argc, char *const argv[])
623 int all = 0, env_flag = H_INTERACTIVE;
625 debug("Initial value for argc=%d\n", argc);
626 while (--argc > 0 && **++argv == '-') {
631 case 'a': /* default all */
634 case 'f': /* force */
638 return cmd_usage(cmdtp);
642 debug("Final value for argc=%d\n", argc);
643 if (all && (argc == 0)) {
644 /* Reset the whole environment */
645 env_set_default("## Resetting to default environment\n",
649 if (!all && (argc > 0)) {
650 /* Reset individual variables */
651 env_set_default_vars(argc, argv, env_flag);
655 return cmd_usage(cmdtp);
658 static int do_env_delete(struct cmd_tbl *cmdtp, int flag,
659 int argc, char *const argv[])
661 int env_flag = H_INTERACTIVE;
664 debug("Initial value for argc=%d\n", argc);
665 while (argc > 1 && **(argv + 1) == '-') {
671 case 'f': /* force */
675 return CMD_RET_USAGE;
679 debug("Final value for argc=%d\n", argc);
684 char *name = *++argv;
686 if (hdelete_r(name, &env_htab, env_flag))
693 #ifdef CONFIG_CMD_EXPORTENV
695 * env export [-t | -b | -c] [-s size] addr [var ...]
696 * -t: export as text format; if size is given, data will be
697 * padded with '\0' bytes; if not, one terminating '\0'
698 * will be added (which is included in the "filesize"
699 * setting so you can for exmple copy this to flash and
700 * keep the termination).
701 * -b: export as binary format (name=value pairs separated by
702 * '\0', list end marked by double "\0\0")
703 * -c: export as checksum protected environment format as
704 * used for example by "saveenv" command
706 * size of output buffer
707 * addr: memory address where environment gets stored
708 * var... List of variable names that get included into the
709 * export. Without arguments, the whole environment gets
712 * With "-c" and size is NOT given, then the export command will
713 * format the data as currently used for the persistent storage,
714 * i. e. it will use CONFIG_ENV_SECT_SIZE as output block size and
715 * prepend a valid CRC32 checksum and, in case of redundant
716 * environment, a "current" redundancy flag. If size is given, this
717 * value will be used instead of CONFIG_ENV_SECT_SIZE; again, CRC32
718 * checksum and redundancy flag will be inserted.
720 * With "-b" and "-t", always only the real data (including a
721 * terminating '\0' byte) will be written; here the optional size
722 * argument will be used to make sure not to overflow the user
723 * provided buffer; the command will abort if the size is not
724 * sufficient. Any remaining space will be '\0' padded.
726 * On successful return, the variable "filesize" will be set.
727 * Note that filesize includes the trailing/terminating '\0' byte(s).
729 * Usage scenario: create a text snapshot/backup of the current settings:
731 * => env export -t 100000
732 * => era ${backup_addr} +${filesize}
733 * => cp.b 100000 ${backup_addr} ${filesize}
735 * Re-import this snapshot, deleting all other settings:
737 * => env import -d -t ${backup_addr}
739 static int do_env_export(struct cmd_tbl *cmdtp, int flag,
740 int argc, char *const argv[])
744 char *ptr, *cmd, *res;
754 while (--argc > 0 && **++argv == '-') {
758 case 'b': /* raw binary format */
763 case 'c': /* external checksum format */
769 case 's': /* size given */
771 return cmd_usage(cmdtp);
772 size = hextoul(*++argv, NULL);
774 case 't': /* text format */
780 return CMD_RET_USAGE;
787 return CMD_RET_USAGE;
789 addr = hextoul(argv[0], NULL);
790 ptr = map_sysmem(addr, size);
793 memset(ptr, '\0', size);
798 if (sep) { /* export as text file */
799 len = hexport_r(&env_htab, sep,
800 H_MATCH_KEY | H_MATCH_IDENT,
801 &ptr, size, argc, argv);
803 pr_err("## Error: Cannot export environment: errno = %d\n",
807 sprintf(buf, "%zX", (size_t)len);
808 env_set("filesize", buf);
815 if (chk) /* export as checksum protected block */
816 res = (char *)envp->data;
817 else /* export as raw binary data */
820 len = hexport_r(&env_htab, '\0',
821 H_MATCH_KEY | H_MATCH_IDENT,
822 &res, ENV_SIZE, argc, argv);
824 pr_err("## Error: Cannot export environment: errno = %d\n",
830 envp->crc = crc32(0, envp->data,
831 size ? size - offsetof(env_t, data) : ENV_SIZE);
832 #ifdef CONFIG_ENV_ADDR_REDUND
833 envp->flags = ENV_REDUND_ACTIVE;
836 env_set_hex("filesize", len + offsetof(env_t, data));
841 printf("## Error: %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n",
847 #ifdef CONFIG_CMD_IMPORTENV
849 * env import [-d] [-t [-r] | -b | -c] addr [size] [var ...]
850 * -d: delete existing environment before importing if no var is
851 * passed; if vars are passed, if one var is in the current
852 * environment but not in the environment at addr, delete var from
853 * current environment;
854 * otherwise overwrite / append to existing definitions
855 * -t: assume text format; either "size" must be given or the
856 * text data must be '\0' terminated
857 * -r: handle CRLF like LF, that means exported variables with
858 * a content which ends with \r won't get imported. Used
859 * to import text files created with editors which are using CRLF
860 * for line endings. Only effective in addition to -t.
861 * -b: assume binary format ('\0' separated, "\0\0" terminated)
862 * -c: assume checksum protected environment format
863 * addr: memory address to read from
864 * size: length of input data; if missing, proper '\0'
865 * termination is mandatory
866 * if var is set and size should be missing (i.e. '\0'
867 * termination), set size to '-'
868 * var... List of the names of the only variables that get imported from
869 * the environment at address 'addr'. Without arguments, the whole
870 * environment gets imported.
872 static int do_env_import(struct cmd_tbl *cmdtp, int flag,
873 int argc, char *const argv[])
887 while (--argc > 0 && **++argv == '-') {
891 case 'b': /* raw binary format */
896 case 'c': /* external checksum format */
902 case 't': /* text format */
907 case 'r': /* handle CRLF like LF */
914 return CMD_RET_USAGE;
920 return CMD_RET_USAGE;
923 printf("## Warning: defaulting to text format\n");
925 if (sep != '\n' && crlf_is_lf )
928 addr = hextoul(argv[0], NULL);
929 ptr = map_sysmem(addr, 0);
931 if (argc >= 2 && strcmp(argv[1], "-")) {
932 size = hextoul(argv[1], NULL);
934 puts("## Error: external checksum format must pass size\n");
935 return CMD_RET_FAILURE;
941 while (size < MAX_ENV_SIZE) {
942 if ((*s == sep) && (*(s+1) == '\0'))
947 if (size == MAX_ENV_SIZE) {
948 printf("## Warning: Input data exceeds %d bytes"
949 " - truncated\n", MAX_ENV_SIZE);
952 printf("## Info: input data size = %zu = 0x%zX\n", size, size);
960 env_t *ep = (env_t *)ptr;
962 if (size <= offsetof(env_t, data)) {
963 printf("## Error: Invalid size 0x%zX\n", size);
967 size -= offsetof(env_t, data);
968 memcpy(&crc, &ep->crc, sizeof(crc));
970 if (crc32(0, ep->data, size) != crc) {
971 puts("## Error: bad CRC, import failed\n");
974 ptr = (char *)ep->data;
977 if (!himport_r(&env_htab, ptr, size, sep, del ? 0 : H_NOCLEAR,
978 crlf_is_lf, wl ? argc - 2 : 0, wl ? &argv[2] : NULL)) {
979 pr_err("## Error: Environment import failed: errno = %d\n",
983 gd->flags |= GD_FLG_ENV_READY;
988 printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n",
994 #if defined(CONFIG_CMD_NVEDIT_INDIRECT)
995 static int do_env_indirect(struct cmd_tbl *cmdtp, int flag,
996 int argc, char *const argv[])
999 char *from = argv[2];
1000 char *default_value = NULL;
1004 if (argc < 3 || argc > 4) {
1005 return CMD_RET_USAGE;
1009 default_value = argv[3];
1012 val = env_get(from) ?: default_value;
1014 printf("## env indirect: Environment variable for <from> (%s) does not exist.\n", from);
1016 return CMD_RET_FAILURE;
1019 ret = env_set(to, val);
1022 return CMD_RET_SUCCESS;
1025 return CMD_RET_FAILURE;
1030 #if defined(CONFIG_CMD_NVEDIT_INFO)
1032 * print_env_info - print environment information
1034 static int print_env_info(void)
1038 /* print environment validity value */
1039 switch (gd->env_valid) {
1047 value = "redundant";
1053 printf("env_valid = %s\n", value);
1055 /* print environment ready flag */
1056 value = gd->flags & GD_FLG_ENV_READY ? "true" : "false";
1057 printf("env_ready = %s\n", value);
1059 /* print environment using default flag */
1060 value = gd->flags & GD_FLG_ENV_DEFAULT ? "true" : "false";
1061 printf("env_use_default = %s\n", value);
1063 return CMD_RET_SUCCESS;
1066 #define ENV_INFO_IS_DEFAULT BIT(0) /* default environment bit mask */
1067 #define ENV_INFO_IS_PERSISTED BIT(1) /* environment persistence bit mask */
1070 * env info - display environment information
1071 * env info [-d] - evaluate whether default environment is used
1072 * env info [-p] - evaluate whether environment can be persisted
1073 * Add [-q] - quiet mode, use only for command result, for test by example:
1074 * test env info -p -d -q
1076 static int do_env_info(struct cmd_tbl *cmdtp, int flag,
1077 int argc, char *const argv[])
1080 int eval_results = 0;
1082 #if defined(CONFIG_CMD_SAVEENV) && !IS_ENABLED(CONFIG_ENV_IS_DEFAULT)
1083 enum env_location loc;
1086 /* display environment information */
1088 return print_env_info();
1090 /* process options */
1091 while (--argc > 0 && **++argv == '-') {
1097 eval_flags |= ENV_INFO_IS_DEFAULT;
1100 eval_flags |= ENV_INFO_IS_PERSISTED;
1106 return CMD_RET_USAGE;
1111 /* evaluate whether default environment is used */
1112 if (eval_flags & ENV_INFO_IS_DEFAULT) {
1113 if (gd->flags & GD_FLG_ENV_DEFAULT) {
1115 printf("Default environment is used\n");
1116 eval_results |= ENV_INFO_IS_DEFAULT;
1119 printf("Environment was loaded from persistent storage\n");
1123 /* evaluate whether environment can be persisted */
1124 if (eval_flags & ENV_INFO_IS_PERSISTED) {
1125 #if defined(CONFIG_CMD_SAVEENV) && !IS_ENABLED(CONFIG_ENV_IS_DEFAULT)
1126 loc = env_get_location(ENVOP_SAVE, gd->env_load_prio);
1127 if (ENVL_NOWHERE != loc && ENVL_UNKNOWN != loc) {
1129 printf("Environment can be persisted\n");
1130 eval_results |= ENV_INFO_IS_PERSISTED;
1133 printf("Environment cannot be persisted\n");
1137 printf("Environment cannot be persisted\n");
1141 /* The result of evaluations is combined with AND */
1142 if (eval_flags != eval_results)
1143 return CMD_RET_FAILURE;
1145 return CMD_RET_SUCCESS;
1149 #if defined(CONFIG_CMD_ENV_EXISTS)
1150 static int do_env_exists(struct cmd_tbl *cmdtp, int flag, int argc,
1153 struct env_entry e, *ep;
1156 return CMD_RET_USAGE;
1160 hsearch_r(e, ENV_FIND, &ep, &env_htab, 0);
1162 return (ep == NULL) ? 1 : 0;
1167 * New command line interface: "env" command with subcommands
1169 static struct cmd_tbl cmd_env_sub[] = {
1170 #if defined(CONFIG_CMD_ASKENV)
1171 U_BOOT_CMD_MKENT(ask, CONFIG_SYS_MAXARGS, 1, do_env_ask, "", ""),
1173 U_BOOT_CMD_MKENT(default, 1, 0, do_env_default, "", ""),
1174 U_BOOT_CMD_MKENT(delete, CONFIG_SYS_MAXARGS, 0, do_env_delete, "", ""),
1175 #if defined(CONFIG_CMD_EDITENV)
1176 U_BOOT_CMD_MKENT(edit, 2, 0, do_env_edit, "", ""),
1178 #if defined(CONFIG_CMD_ENV_CALLBACK)
1179 U_BOOT_CMD_MKENT(callbacks, 1, 0, do_env_callback, "", ""),
1181 #if defined(CONFIG_CMD_ENV_FLAGS)
1182 U_BOOT_CMD_MKENT(flags, 1, 0, do_env_flags, "", ""),
1184 #if defined(CONFIG_CMD_EXPORTENV)
1185 U_BOOT_CMD_MKENT(export, 4, 0, do_env_export, "", ""),
1187 #if defined(CONFIG_CMD_GREPENV)
1188 U_BOOT_CMD_MKENT(grep, CONFIG_SYS_MAXARGS, 1, do_env_grep, "", ""),
1190 #if defined(CONFIG_CMD_IMPORTENV)
1191 U_BOOT_CMD_MKENT(import, 5, 0, do_env_import, "", ""),
1193 #if defined(CONFIG_CMD_NVEDIT_INDIRECT)
1194 U_BOOT_CMD_MKENT(indirect, 3, 0, do_env_indirect, "", ""),
1196 #if defined(CONFIG_CMD_NVEDIT_INFO)
1197 U_BOOT_CMD_MKENT(info, 3, 0, do_env_info, "", ""),
1199 #if defined(CONFIG_CMD_NVEDIT_LOAD)
1200 U_BOOT_CMD_MKENT(load, 1, 0, do_env_load, "", ""),
1202 U_BOOT_CMD_MKENT(print, CONFIG_SYS_MAXARGS, 1, do_env_print, "", ""),
1203 #if defined(CONFIG_CMD_RUN)
1204 U_BOOT_CMD_MKENT(run, CONFIG_SYS_MAXARGS, 1, do_run, "", ""),
1206 #if defined(CONFIG_CMD_SAVEENV) && !IS_ENABLED(CONFIG_ENV_IS_DEFAULT)
1207 U_BOOT_CMD_MKENT(save, 1, 0, do_env_save, "", ""),
1208 #if defined(CONFIG_CMD_ERASEENV)
1209 U_BOOT_CMD_MKENT(erase, 1, 0, do_env_erase, "", ""),
1212 #if defined(CONFIG_CMD_NVEDIT_SELECT)
1213 U_BOOT_CMD_MKENT(select, 2, 0, do_env_select, "", ""),
1215 U_BOOT_CMD_MKENT(set, CONFIG_SYS_MAXARGS, 0, do_env_set, "", ""),
1216 #if defined(CONFIG_CMD_ENV_EXISTS)
1217 U_BOOT_CMD_MKENT(exists, 2, 0, do_env_exists, "", ""),
1221 static int do_env(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
1226 return CMD_RET_USAGE;
1228 /* drop initial "env" arg */
1232 cp = find_cmd_tbl(argv[0], cmd_env_sub, ARRAY_SIZE(cmd_env_sub));
1235 return cp->cmd(cmdtp, flag, argc, argv);
1237 return CMD_RET_USAGE;
1240 #ifdef CONFIG_SYS_LONGHELP
1241 static char env_help_text[] =
1242 #if defined(CONFIG_CMD_ASKENV)
1243 "ask name [message] [size] - ask for environment variable\nenv "
1245 #if defined(CONFIG_CMD_ENV_CALLBACK)
1246 "callbacks - print callbacks and their associated variables\nenv "
1248 "default [-f] -a - [forcibly] reset default environment\n"
1249 "env default [-f] var [...] - [forcibly] reset variable(s) to their default values\n"
1250 "env delete [-f] var [...] - [forcibly] delete variable(s)\n"
1251 #if defined(CONFIG_CMD_EDITENV)
1252 "env edit name - edit environment variable\n"
1254 #if defined(CONFIG_CMD_ENV_EXISTS)
1255 "env exists name - tests for existence of variable\n"
1257 #if defined(CONFIG_CMD_EXPORTENV)
1258 "env export [-t | -b | -c] [-s size] addr [var ...] - export environment\n"
1260 #if defined(CONFIG_CMD_ENV_FLAGS)
1261 "env flags - print variables that have non-default flags\n"
1263 #if defined(CONFIG_CMD_GREPENV)
1265 "env grep [-e] [-n | -v | -b] string [...] - search environment\n"
1267 "env grep [-n | -v | -b] string [...] - search environment\n"
1270 #if defined(CONFIG_CMD_IMPORTENV)
1271 "env import [-d] [-t [-r] | -b | -c] addr [size] [var ...] - import environment\n"
1273 #if defined(CONFIG_CMD_NVEDIT_INDIRECT)
1274 "env indirect <to> <from> [default] - sets <to> to the value of <from>, using [default] when unset\n"
1276 #if defined(CONFIG_CMD_NVEDIT_INFO)
1277 "env info - display environment information\n"
1278 "env info [-d] [-p] [-q] - evaluate environment information\n"
1279 " \"-d\": default environment is used\n"
1280 " \"-p\": environment can be persisted\n"
1281 " \"-q\": quiet output\n"
1283 "env print [-a | name ...] - print environment\n"
1284 #if defined(CONFIG_CMD_NVEDIT_EFI)
1285 "env print -e [-guid guid] [-n] [name ...] - print UEFI environment\n"
1287 #if defined(CONFIG_CMD_RUN)
1288 "env run var [...] - run commands in an environment variable\n"
1290 #if defined(CONFIG_CMD_SAVEENV) && !IS_ENABLED(CONFIG_ENV_IS_DEFAULT)
1291 "env save - save environment\n"
1292 #if defined(CONFIG_CMD_ERASEENV)
1293 "env erase - erase environment\n"
1296 #if defined(CONFIG_CMD_NVEDIT_LOAD)
1297 "env load - load environment\n"
1299 #if defined(CONFIG_CMD_NVEDIT_SELECT)
1300 "env select [target] - select environment target\n"
1302 #if defined(CONFIG_CMD_NVEDIT_EFI)
1303 "env set -e [-nv][-bs][-rt][-at][-a][-i addr:size][-v] name [arg ...]\n"
1304 " - set UEFI variable; unset if '-i' or 'arg' not specified\n"
1306 "env set [-f] name [arg ...]\n";
1310 env, CONFIG_SYS_MAXARGS, 1, do_env,
1311 "environment handling commands", env_help_text
1315 * Old command line interface, kept for compatibility
1318 #if defined(CONFIG_CMD_EDITENV)
1319 U_BOOT_CMD_COMPLETE(
1320 editenv, 2, 0, do_env_edit,
1321 "edit environment variable",
1323 " - edit environment variable 'name'",
1328 U_BOOT_CMD_COMPLETE(
1329 printenv, CONFIG_SYS_MAXARGS, 1, do_env_print,
1330 "print environment variables",
1331 "[-a]\n - print [all] values of all environment variables\n"
1332 #if defined(CONFIG_CMD_NVEDIT_EFI)
1333 "printenv -e [-guid guid][-n] [name ...]\n"
1334 " - print UEFI variable 'name' or all the variables\n"
1335 " \"-guid\": GUID xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\n"
1336 " \"-n\": suppress dumping variable's value\n"
1338 "printenv name ...\n"
1339 " - print value of environment variable 'name'",
1343 #ifdef CONFIG_CMD_GREPENV
1344 U_BOOT_CMD_COMPLETE(
1345 grepenv, CONFIG_SYS_MAXARGS, 0, do_env_grep,
1346 "search environment variables",
1348 "[-e] [-n | -v | -b] string ...\n"
1350 "[-n | -v | -b] string ...\n"
1352 " - list environment name=value pairs matching 'string'\n"
1354 " \"-e\": enable regular expressions;\n"
1356 " \"-n\": search variable names; \"-v\": search values;\n"
1357 " \"-b\": search both names and values (default)",
1362 U_BOOT_CMD_COMPLETE(
1363 setenv, CONFIG_SYS_MAXARGS, 0, do_env_set,
1364 "set environment variables",
1365 #if defined(CONFIG_CMD_NVEDIT_EFI)
1366 "-e [-guid guid][-nv][-bs][-rt][-at][-a][-v]\n"
1367 " [-i addr:size name], or [name [value ...]]\n"
1368 " - set UEFI variable 'name' to 'value' ...'\n"
1369 " \"-guid\": GUID xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\n"
1370 " \"-nv\": set non-volatile attribute\n"
1371 " \"-bs\": set boot-service attribute\n"
1372 " \"-rt\": set runtime attribute\n"
1373 " \"-at\": set time-based authentication attribute\n"
1374 " \"-a\": append-write\n"
1375 " \"-i addr,size\": use <addr,size> as variable's value\n"
1376 " \"-v\": verbose message\n"
1377 " - delete UEFI variable 'name' if 'value' not specified\n"
1379 "setenv [-f] name value ...\n"
1380 " - [forcibly] set environment variable 'name' to 'value ...'\n"
1381 "setenv [-f] name\n"
1382 " - [forcibly] delete environment variable 'name'",
1386 #if defined(CONFIG_CMD_ASKENV)
1389 askenv, CONFIG_SYS_MAXARGS, 1, do_env_ask,
1390 "get environment variables from stdin",
1391 "name [message] [size]\n"
1392 " - get environment variable 'name' from stdin (max 'size' chars)"
1396 #if defined(CONFIG_CMD_RUN)
1397 U_BOOT_CMD_COMPLETE(
1398 run, CONFIG_SYS_MAXARGS, 1, do_run,
1399 "run commands in an environment variable",
1401 " - run the commands in the environment variable(s) 'var'",
1405 #endif /* CONFIG_SPL_BUILD */