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.
30 #include <environment.h>
36 #include <linux/stddef.h>
37 #include <asm/byteorder.h>
40 DECLARE_GLOBAL_DATA_PTR
;
42 #if !defined(CONFIG_ENV_IS_IN_EEPROM) && \
43 !defined(CONFIG_ENV_IS_IN_FLASH) && \
44 !defined(CONFIG_ENV_IS_IN_MMC) && \
45 !defined(CONFIG_ENV_IS_IN_FAT) && \
46 !defined(CONFIG_ENV_IS_IN_EXT4) && \
47 !defined(CONFIG_ENV_IS_IN_NAND) && \
48 !defined(CONFIG_ENV_IS_IN_NVRAM) && \
49 !defined(CONFIG_ENV_IS_IN_ONENAND) && \
50 !defined(CONFIG_ENV_IS_IN_SATA) && \
51 !defined(CONFIG_ENV_IS_IN_SPI_FLASH) && \
52 !defined(CONFIG_ENV_IS_IN_REMOTE) && \
53 !defined(CONFIG_ENV_IS_IN_UBI) && \
54 !defined(CONFIG_ENV_IS_NOWHERE)
55 # error Define one of CONFIG_ENV_IS_IN_{EEPROM|FLASH|MMC|FAT|EXT4|\
56 NAND|NVRAM|ONENAND|SATA|SPI_FLASH|REMOTE|UBI} or CONFIG_ENV_IS_NOWHERE
60 * Maximum expected input data size for import command
62 #define MAX_ENV_SIZE (1 << 20) /* 1 MiB */
65 * This variable is incremented on each do_env_set(), so it can
66 * be used via get_env_id() as an indication, if the environment
67 * has changed or not. So it is possible to reread an environment
68 * variable only if the environment was changed ... done so for
69 * example in NetInitLoop()
71 static int env_id
= 1;
78 #ifndef CONFIG_SPL_BUILD
80 * Command interface: print one or all environment variables
82 * Returns 0 in case of error, or length of printed string
84 static int env_print(char *name
, int flag
)
89 if (name
) { /* print a single name */
94 hsearch_r(e
, FIND
, &ep
, &env_htab
, flag
);
97 len
= printf("%s=%s\n", ep
->key
, ep
->data
);
101 /* print whole list */
102 len
= hexport_r(&env_htab
, '\n', flag
, &res
, 0, 0, NULL
);
110 /* should never happen */
111 printf("## Error: cannot export environment\n");
115 static int do_env_print(cmd_tbl_t
*cmdtp
, int flag
, int argc
,
120 int env_flag
= H_HIDE_DOT
;
122 if (argc
> 1 && argv
[1][0] == '-' && argv
[1][1] == 'a') {
125 env_flag
&= ~H_HIDE_DOT
;
129 /* print all env vars */
130 rcode
= env_print(NULL
, env_flag
);
133 printf("\nEnvironment size: %d/%ld bytes\n",
134 rcode
, (ulong
)ENV_SIZE
);
138 /* print selected env vars */
139 env_flag
&= ~H_HIDE_DOT
;
140 for (i
= 1; i
< argc
; ++i
) {
141 int rc
= env_print(argv
[i
], env_flag
);
143 printf("## Error: \"%s\" not defined\n", argv
[i
]);
151 #ifdef CONFIG_CMD_GREPENV
152 static int do_env_grep(cmd_tbl_t
*cmdtp
, int flag
,
153 int argc
, char * const argv
[])
156 int len
, grep_how
, grep_what
;
159 return CMD_RET_USAGE
;
161 grep_how
= H_MATCH_SUBSTR
; /* default: substring search */
162 grep_what
= H_MATCH_BOTH
; /* default: grep names and values */
164 while (--argc
> 0 && **++argv
== '-') {
169 case 'e': /* use regex matching */
170 grep_how
= H_MATCH_REGEX
;
173 case 'n': /* grep for name */
174 grep_what
= H_MATCH_KEY
;
176 case 'v': /* grep for value */
177 grep_what
= H_MATCH_DATA
;
179 case 'b': /* grep for both */
180 grep_what
= H_MATCH_BOTH
;
185 return CMD_RET_USAGE
;
191 len
= hexport_r(&env_htab
, '\n',
192 flag
| grep_what
| grep_how
,
193 &res
, 0, argc
, argv
);
206 #endif /* CONFIG_SPL_BUILD */
209 * Set a new environment variable,
210 * or replace or delete an existing one.
212 static int _do_env_set(int flag
, int argc
, char * const argv
[], int env_flag
)
215 char *name
, *value
, *s
;
218 debug("Initial value for argc=%d\n", argc
);
219 while (argc
> 1 && **(argv
+ 1) == '-') {
225 case 'f': /* force */
229 return CMD_RET_USAGE
;
233 debug("Final value for argc=%d\n", argc
);
236 if (strchr(name
, '=')) {
237 printf("## Error: illegal character '='"
238 "in variable name \"%s\"\n", name
);
245 if (argc
< 3 || argv
[2] == NULL
) {
246 int rc
= hdelete_r(name
, &env_htab
, env_flag
);
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
, 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
);
299 * Set an environment variable to an integer value
301 * @param varname Environment variable to set
302 * @param value Value to set it to
303 * @return 0 if ok, 1 on error
305 int env_set_ulong(const char *varname
, ulong value
)
307 /* TODO: this should be unsigned */
308 char *str
= simple_itoa(value
);
310 return env_set(varname
, str
);
314 * Set an environment variable to an value in hex
316 * @param varname Environment variable to set
317 * @param value Value to set it to
318 * @return 0 if ok, 1 on error
320 int env_set_hex(const char *varname
, ulong value
)
324 sprintf(str
, "%lx", value
);
325 return env_set(varname
, str
);
328 ulong
env_get_hex(const char *varname
, ulong default_val
)
334 s
= env_get(varname
);
336 value
= simple_strtoul(s
, &endp
, 16);
343 void eth_parse_enetaddr(const char *addr
, uint8_t *enetaddr
)
348 for (i
= 0; i
< 6; ++i
) {
349 enetaddr
[i
] = addr
? simple_strtoul(addr
, &end
, 16) : 0;
351 addr
= (*end
) ? end
+ 1 : end
;
355 int eth_env_get_enetaddr(const char *name
, uint8_t *enetaddr
)
357 eth_parse_enetaddr(env_get(name
), enetaddr
);
358 return is_valid_ethaddr(enetaddr
);
361 int eth_env_set_enetaddr(const char *name
, const uint8_t *enetaddr
)
363 char buf
[ARP_HLEN_ASCII
+ 1];
365 if (eth_env_get_enetaddr(name
, (uint8_t *)buf
))
368 sprintf(buf
, "%pM", enetaddr
);
370 return env_set(name
, buf
);
373 #ifndef CONFIG_SPL_BUILD
374 static int do_env_set(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
377 return CMD_RET_USAGE
;
379 return _do_env_set(flag
, argc
, argv
, H_INTERACTIVE
);
383 * Prompt for environment variable
385 #if defined(CONFIG_CMD_ASKENV)
386 int do_env_ask(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
388 char message
[CONFIG_SYS_CBSIZE
];
389 int i
, len
, pos
, size
;
393 local_args
[0] = argv
[0];
394 local_args
[1] = argv
[1];
395 local_args
[2] = NULL
;
396 local_args
[3] = NULL
;
401 * env_ask envname [message1 ...] [size]
404 return CMD_RET_USAGE
;
407 * We test the last argument if it can be converted
408 * into a decimal number. If yes, we assume it's
409 * the size. Otherwise we echo it as part of the
412 i
= simple_strtoul(argv
[argc
- 1], &endptr
, 10);
413 if (*endptr
!= '\0') { /* no size */
414 size
= CONFIG_SYS_CBSIZE
- 1;
415 } else { /* size given */
421 sprintf(message
, "Please enter '%s': ", argv
[1]);
423 /* env_ask envname message1 ... messagen [size] */
424 for (i
= 2, pos
= 0; i
< argc
&& pos
+1 < sizeof(message
); i
++) {
426 message
[pos
++] = ' ';
428 strncpy(message
+ pos
, argv
[i
], sizeof(message
) - pos
);
429 pos
+= strlen(argv
[i
]);
431 if (pos
< sizeof(message
) - 1) {
432 message
[pos
++] = ' ';
435 message
[CONFIG_SYS_CBSIZE
- 1] = '\0';
438 if (size
>= CONFIG_SYS_CBSIZE
)
439 size
= CONFIG_SYS_CBSIZE
- 1;
444 /* prompt for input */
445 len
= cli_readline(message
);
448 console_buffer
[size
] = '\0';
451 if (console_buffer
[0] != '\0') {
452 local_args
[2] = console_buffer
;
456 /* Continue calling setenv code */
457 return _do_env_set(flag
, len
, local_args
, H_INTERACTIVE
);
461 #if defined(CONFIG_CMD_ENV_CALLBACK)
462 static int print_static_binding(const char *var_name
, const char *callback_name
,
465 printf("\t%-20s %-20s\n", var_name
, callback_name
);
470 static int print_active_callback(ENTRY
*entry
)
472 struct env_clbk_tbl
*clbkp
;
476 if (entry
->callback
== NULL
)
479 /* look up the callback in the linker-list */
480 num_callbacks
= ll_entry_count(struct env_clbk_tbl
, env_clbk
);
481 for (i
= 0, clbkp
= ll_entry_start(struct env_clbk_tbl
, env_clbk
);
484 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
485 if (entry
->callback
== clbkp
->callback
+ gd
->reloc_off
)
487 if (entry
->callback
== clbkp
->callback
)
492 if (i
== num_callbacks
)
493 /* this should probably never happen, but just in case... */
494 printf("\t%-20s %p\n", entry
->key
, entry
->callback
);
496 printf("\t%-20s %-20s\n", entry
->key
, clbkp
->name
);
502 * Print the callbacks available and what they are bound to
504 int do_env_callback(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
506 struct env_clbk_tbl
*clbkp
;
510 /* Print the available callbacks */
511 puts("Available callbacks:\n");
512 puts("\tCallback Name\n");
513 puts("\t-------------\n");
514 num_callbacks
= ll_entry_count(struct env_clbk_tbl
, env_clbk
);
515 for (i
= 0, clbkp
= ll_entry_start(struct env_clbk_tbl
, env_clbk
);
518 printf("\t%s\n", clbkp
->name
);
521 /* Print the static bindings that may exist */
522 puts("Static callback bindings:\n");
523 printf("\t%-20s %-20s\n", "Variable Name", "Callback Name");
524 printf("\t%-20s %-20s\n", "-------------", "-------------");
525 env_attr_walk(ENV_CALLBACK_LIST_STATIC
, print_static_binding
, NULL
);
528 /* walk through each variable and print the callback if it has one */
529 puts("Active callback bindings:\n");
530 printf("\t%-20s %-20s\n", "Variable Name", "Callback Name");
531 printf("\t%-20s %-20s\n", "-------------", "-------------");
532 hwalk_r(&env_htab
, print_active_callback
);
537 #if defined(CONFIG_CMD_ENV_FLAGS)
538 static int print_static_flags(const char *var_name
, const char *flags
,
541 enum env_flags_vartype type
= env_flags_parse_vartype(flags
);
542 enum env_flags_varaccess access
= env_flags_parse_varaccess(flags
);
544 printf("\t%-20s %-20s %-20s\n", var_name
,
545 env_flags_get_vartype_name(type
),
546 env_flags_get_varaccess_name(access
));
551 static int print_active_flags(ENTRY
*entry
)
553 enum env_flags_vartype type
;
554 enum env_flags_varaccess access
;
556 if (entry
->flags
== 0)
559 type
= (enum env_flags_vartype
)
560 (entry
->flags
& ENV_FLAGS_VARTYPE_BIN_MASK
);
561 access
= env_flags_parse_varaccess_from_binflags(entry
->flags
);
562 printf("\t%-20s %-20s %-20s\n", entry
->key
,
563 env_flags_get_vartype_name(type
),
564 env_flags_get_varaccess_name(access
));
570 * Print the flags available and what variables have flags
572 int do_env_flags(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
574 /* Print the available variable types */
575 printf("Available variable type flags (position %d):\n",
576 ENV_FLAGS_VARTYPE_LOC
);
577 puts("\tFlag\tVariable Type Name\n");
578 puts("\t----\t------------------\n");
579 env_flags_print_vartypes();
582 /* Print the available variable access types */
583 printf("Available variable access flags (position %d):\n",
584 ENV_FLAGS_VARACCESS_LOC
);
585 puts("\tFlag\tVariable Access Name\n");
586 puts("\t----\t--------------------\n");
587 env_flags_print_varaccess();
590 /* Print the static flags that may exist */
591 puts("Static flags:\n");
592 printf("\t%-20s %-20s %-20s\n", "Variable Name", "Variable Type",
594 printf("\t%-20s %-20s %-20s\n", "-------------", "-------------",
596 env_attr_walk(ENV_FLAGS_LIST_STATIC
, print_static_flags
, NULL
);
599 /* walk through each variable and print the flags if non-default */
600 puts("Active flags:\n");
601 printf("\t%-20s %-20s %-20s\n", "Variable Name", "Variable Type",
603 printf("\t%-20s %-20s %-20s\n", "-------------", "-------------",
605 hwalk_r(&env_htab
, print_active_flags
);
611 * Interactively edit an environment variable
613 #if defined(CONFIG_CMD_EDITENV)
614 static int do_env_edit(cmd_tbl_t
*cmdtp
, int flag
, int argc
,
617 char buffer
[CONFIG_SYS_CBSIZE
];
621 return CMD_RET_USAGE
;
623 /* before import into hashtable */
624 if (!(gd
->flags
& GD_FLG_ENV_READY
))
627 /* Set read buffer to initial value or empty sting */
628 init_val
= env_get(argv
[1]);
630 snprintf(buffer
, CONFIG_SYS_CBSIZE
, "%s", init_val
);
634 if (cli_readline_into_buffer("edit: ", buffer
, 0) < 0)
637 if (buffer
[0] == '\0') {
638 const char * const _argv
[3] = { "setenv", argv
[1], NULL
};
640 return _do_env_set(0, 2, (char * const *)_argv
, H_INTERACTIVE
);
642 const char * const _argv
[4] = { "setenv", argv
[1], buffer
,
645 return _do_env_set(0, 3, (char * const *)_argv
, H_INTERACTIVE
);
648 #endif /* CONFIG_CMD_EDITENV */
649 #endif /* CONFIG_SPL_BUILD */
652 * Look up variable from environment,
653 * return address of storage for that variable,
654 * or NULL if not found
656 char *env_get(const char *name
)
658 if (gd
->flags
& GD_FLG_ENV_READY
) { /* after import into hashtable */
665 hsearch_r(e
, FIND
, &ep
, &env_htab
, 0);
667 return ep
? ep
->data
: NULL
;
670 /* restricted capabilities before import */
671 if (env_get_f(name
, (char *)(gd
->env_buf
), sizeof(gd
->env_buf
)) > 0)
672 return (char *)(gd
->env_buf
);
678 * Look up variable from environment for restricted C runtime env.
680 int env_get_f(const char *name
, char *buf
, unsigned len
)
684 for (i
= 0; env_get_char(i
) != '\0'; i
= nxt
+ 1) {
687 for (nxt
= i
; (c
= env_get_char(nxt
)) != '\0'; ++nxt
) {
690 if (nxt
>= CONFIG_ENV_SIZE
)
694 val
= envmatch((uchar
*)name
, i
);
698 /* found; copy out */
699 for (n
= 0; n
< len
; ++n
, ++buf
) {
700 c
= env_get_char(val
++);
711 printf("env_buf [%u bytes] too small for value of \"%s\"\n",
721 * Decode the integer value of an environment variable and return it.
723 * @param name Name of environment variable
724 * @param base Number base to use (normally 10, or 16 for hex)
725 * @param default_val Default value to return if the variable is not
727 * @return the decoded value, or default_val if not found
729 ulong
env_get_ulong(const char *name
, int base
, ulong default_val
)
732 * We can use env_get() here, even before relocation, since the
733 * environment variable value is an integer and thus short.
735 const char *str
= env_get(name
);
737 return str
? simple_strtoul(str
, NULL
, base
) : default_val
;
740 #ifndef CONFIG_SPL_BUILD
741 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
742 static int do_env_save(cmd_tbl_t
*cmdtp
, int flag
, int argc
,
745 return env_save() ? 1 : 0;
749 saveenv
, 1, 0, do_env_save
,
750 "save environment variables to persistent storage",
754 #endif /* CONFIG_SPL_BUILD */
758 * Match a name / name=value pair
760 * s1 is either a simple 'name', or a 'name=value' pair.
761 * i2 is the environment index for a 'name2=value2' pair.
762 * If the names match, return the index for the value2, else -1.
764 int envmatch(uchar
*s1
, int i2
)
769 while (*s1
== env_get_char(i2
++))
773 if (*s1
== '\0' && env_get_char(i2
-1) == '=')
779 #ifndef CONFIG_SPL_BUILD
780 static int do_env_default(cmd_tbl_t
*cmdtp
, int flag
,
781 int argc
, char * const argv
[])
783 int all
= 0, env_flag
= H_INTERACTIVE
;
785 debug("Initial value for argc=%d\n", argc
);
786 while (--argc
> 0 && **++argv
== '-') {
791 case 'a': /* default all */
794 case 'f': /* force */
798 return cmd_usage(cmdtp
);
802 debug("Final value for argc=%d\n", argc
);
803 if (all
&& (argc
== 0)) {
804 /* Reset the whole environment */
805 set_default_env("## Resetting to default environment\n",
809 if (!all
&& (argc
> 0)) {
810 /* Reset individual variables */
811 set_default_vars(argc
, argv
, env_flag
);
815 return cmd_usage(cmdtp
);
818 static int do_env_delete(cmd_tbl_t
*cmdtp
, int flag
,
819 int argc
, char * const argv
[])
821 int env_flag
= H_INTERACTIVE
;
824 debug("Initial value for argc=%d\n", argc
);
825 while (argc
> 1 && **(argv
+ 1) == '-') {
831 case 'f': /* force */
835 return CMD_RET_USAGE
;
839 debug("Final value for argc=%d\n", argc
);
844 char *name
= *++argv
;
846 if (!hdelete_r(name
, &env_htab
, env_flag
))
853 #ifdef CONFIG_CMD_EXPORTENV
855 * env export [-t | -b | -c] [-s size] addr [var ...]
856 * -t: export as text format; if size is given, data will be
857 * padded with '\0' bytes; if not, one terminating '\0'
858 * will be added (which is included in the "filesize"
859 * setting so you can for exmple copy this to flash and
860 * keep the termination).
861 * -b: export as binary format (name=value pairs separated by
862 * '\0', list end marked by double "\0\0")
863 * -c: export as checksum protected environment format as
864 * used for example by "saveenv" command
866 * size of output buffer
867 * addr: memory address where environment gets stored
868 * var... List of variable names that get included into the
869 * export. Without arguments, the whole environment gets
872 * With "-c" and size is NOT given, then the export command will
873 * format the data as currently used for the persistent storage,
874 * i. e. it will use CONFIG_ENV_SECT_SIZE as output block size and
875 * prepend a valid CRC32 checksum and, in case of redundant
876 * environment, a "current" redundancy flag. If size is given, this
877 * value will be used instead of CONFIG_ENV_SECT_SIZE; again, CRC32
878 * checksum and redundancy flag will be inserted.
880 * With "-b" and "-t", always only the real data (including a
881 * terminating '\0' byte) will be written; here the optional size
882 * argument will be used to make sure not to overflow the user
883 * provided buffer; the command will abort if the size is not
884 * sufficient. Any remaining space will be '\0' padded.
886 * On successful return, the variable "filesize" will be set.
887 * Note that filesize includes the trailing/terminating '\0' byte(s).
889 * Usage scenario: create a text snapshot/backup of the current settings:
891 * => env export -t 100000
892 * => era ${backup_addr} +${filesize}
893 * => cp.b 100000 ${backup_addr} ${filesize}
895 * Re-import this snapshot, deleting all other settings:
897 * => env import -d -t ${backup_addr}
899 static int do_env_export(cmd_tbl_t
*cmdtp
, int flag
,
900 int argc
, char * const argv
[])
904 char *ptr
, *cmd
, *res
;
914 while (--argc
> 0 && **++argv
== '-') {
918 case 'b': /* raw binary format */
923 case 'c': /* external checksum format */
929 case 's': /* size given */
931 return cmd_usage(cmdtp
);
932 size
= simple_strtoul(*++argv
, NULL
, 16);
934 case 't': /* text format */
940 return CMD_RET_USAGE
;
947 return CMD_RET_USAGE
;
949 addr
= simple_strtoul(argv
[0], NULL
, 16);
950 ptr
= map_sysmem(addr
, size
);
953 memset(ptr
, '\0', size
);
958 if (sep
) { /* export as text file */
959 len
= hexport_r(&env_htab
, sep
,
960 H_MATCH_KEY
| H_MATCH_IDENT
,
961 &ptr
, size
, argc
, argv
);
963 pr_err("## Error: Cannot export environment: errno = %d\n",
967 sprintf(buf
, "%zX", (size_t)len
);
968 env_set("filesize", buf
);
975 if (chk
) /* export as checksum protected block */
976 res
= (char *)envp
->data
;
977 else /* export as raw binary data */
980 len
= hexport_r(&env_htab
, '\0',
981 H_MATCH_KEY
| H_MATCH_IDENT
,
982 &res
, ENV_SIZE
, argc
, argv
);
984 pr_err("## Error: Cannot export environment: errno = %d\n",
990 envp
->crc
= crc32(0, envp
->data
,
991 size
? size
- offsetof(env_t
, data
) : ENV_SIZE
);
992 #ifdef CONFIG_ENV_ADDR_REDUND
993 envp
->flags
= ACTIVE_FLAG
;
996 env_set_hex("filesize", len
+ offsetof(env_t
, data
));
1001 printf("## Error: %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n",
1007 #ifdef CONFIG_CMD_IMPORTENV
1009 * env import [-d] [-t [-r] | -b | -c] addr [size] [var ...]
1010 * -d: delete existing environment before importing if no var is
1011 * passed; if vars are passed, if one var is in the current
1012 * environment but not in the environment at addr, delete var from
1013 * current environment;
1014 * otherwise overwrite / append to existing definitions
1015 * -t: assume text format; either "size" must be given or the
1016 * text data must be '\0' terminated
1017 * -r: handle CRLF like LF, that means exported variables with
1018 * a content which ends with \r won't get imported. Used
1019 * to import text files created with editors which are using CRLF
1020 * for line endings. Only effective in addition to -t.
1021 * -b: assume binary format ('\0' separated, "\0\0" terminated)
1022 * -c: assume checksum protected environment format
1023 * addr: memory address to read from
1024 * size: length of input data; if missing, proper '\0'
1025 * termination is mandatory
1026 * if var is set and size should be missing (i.e. '\0'
1027 * termination), set size to '-'
1028 * var... List of the names of the only variables that get imported from
1029 * the environment at address 'addr'. Without arguments, the whole
1030 * environment gets imported.
1032 static int do_env_import(cmd_tbl_t
*cmdtp
, int flag
,
1033 int argc
, char * const argv
[])
1047 while (--argc
> 0 && **++argv
== '-') {
1051 case 'b': /* raw binary format */
1056 case 'c': /* external checksum format */
1062 case 't': /* text format */
1067 case 'r': /* handle CRLF like LF */
1074 return CMD_RET_USAGE
;
1080 return CMD_RET_USAGE
;
1083 printf("## Warning: defaulting to text format\n");
1085 if (sep
!= '\n' && crlf_is_lf
)
1088 addr
= simple_strtoul(argv
[0], NULL
, 16);
1089 ptr
= map_sysmem(addr
, 0);
1091 if (argc
>= 2 && strcmp(argv
[1], "-")) {
1092 size
= simple_strtoul(argv
[1], NULL
, 16);
1094 puts("## Error: external checksum format must pass size\n");
1095 return CMD_RET_FAILURE
;
1101 while (size
< MAX_ENV_SIZE
) {
1102 if ((*s
== sep
) && (*(s
+1) == '\0'))
1107 if (size
== MAX_ENV_SIZE
) {
1108 printf("## Warning: Input data exceeds %d bytes"
1109 " - truncated\n", MAX_ENV_SIZE
);
1112 printf("## Info: input data size = %zu = 0x%zX\n", size
, size
);
1120 env_t
*ep
= (env_t
*)ptr
;
1122 size
-= offsetof(env_t
, data
);
1123 memcpy(&crc
, &ep
->crc
, sizeof(crc
));
1125 if (crc32(0, ep
->data
, size
) != crc
) {
1126 puts("## Error: bad CRC, import failed\n");
1129 ptr
= (char *)ep
->data
;
1132 if (!himport_r(&env_htab
, ptr
, size
, sep
, del
? 0 : H_NOCLEAR
,
1133 crlf_is_lf
, wl
? argc
- 2 : 0, wl
? &argv
[2] : NULL
)) {
1134 pr_err("## Error: Environment import failed: errno = %d\n",
1138 gd
->flags
|= GD_FLG_ENV_READY
;
1143 printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n",
1149 #if defined(CONFIG_CMD_ENV_EXISTS)
1150 static int do_env_exists(cmd_tbl_t
*cmdtp
, int flag
, int argc
,
1151 char * const argv
[])
1156 return CMD_RET_USAGE
;
1160 hsearch_r(e
, FIND
, &ep
, &env_htab
, 0);
1162 return (ep
== NULL
) ? 1 : 0;
1167 * New command line interface: "env" command with subcommands
1169 static cmd_tbl_t 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 U_BOOT_CMD_MKENT(print
, CONFIG_SYS_MAXARGS
, 1, do_env_print
, "", ""),
1194 #if defined(CONFIG_CMD_RUN)
1195 U_BOOT_CMD_MKENT(run
, CONFIG_SYS_MAXARGS
, 1, do_run
, "", ""),
1197 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
1198 U_BOOT_CMD_MKENT(save
, 1, 0, do_env_save
, "", ""),
1200 U_BOOT_CMD_MKENT(set
, CONFIG_SYS_MAXARGS
, 0, do_env_set
, "", ""),
1201 #if defined(CONFIG_CMD_ENV_EXISTS)
1202 U_BOOT_CMD_MKENT(exists
, 2, 0, do_env_exists
, "", ""),
1206 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
1207 void env_reloc(void)
1209 fixup_cmdtable(cmd_env_sub
, ARRAY_SIZE(cmd_env_sub
));
1213 static int do_env(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
1218 return CMD_RET_USAGE
;
1220 /* drop initial "env" arg */
1224 cp
= find_cmd_tbl(argv
[0], cmd_env_sub
, ARRAY_SIZE(cmd_env_sub
));
1227 return cp
->cmd(cmdtp
, flag
, argc
, argv
);
1229 return CMD_RET_USAGE
;
1232 #ifdef CONFIG_SYS_LONGHELP
1233 static char env_help_text
[] =
1234 #if defined(CONFIG_CMD_ASKENV)
1235 "ask name [message] [size] - ask for environment variable\nenv "
1237 #if defined(CONFIG_CMD_ENV_CALLBACK)
1238 "callbacks - print callbacks and their associated variables\nenv "
1240 "default [-f] -a - [forcibly] reset default environment\n"
1241 "env default [-f] var [...] - [forcibly] reset variable(s) to their default values\n"
1242 "env delete [-f] var [...] - [forcibly] delete variable(s)\n"
1243 #if defined(CONFIG_CMD_EDITENV)
1244 "env edit name - edit environment variable\n"
1246 #if defined(CONFIG_CMD_ENV_EXISTS)
1247 "env exists name - tests for existence of variable\n"
1249 #if defined(CONFIG_CMD_EXPORTENV)
1250 "env export [-t | -b | -c] [-s size] addr [var ...] - export environment\n"
1252 #if defined(CONFIG_CMD_ENV_FLAGS)
1253 "env flags - print variables that have non-default flags\n"
1255 #if defined(CONFIG_CMD_GREPENV)
1257 "env grep [-e] [-n | -v | -b] string [...] - search environment\n"
1259 "env grep [-n | -v | -b] string [...] - search environment\n"
1262 #if defined(CONFIG_CMD_IMPORTENV)
1263 "env import [-d] [-t [-r] | -b | -c] addr [size] [var ...] - import environment\n"
1265 "env print [-a | name ...] - print environment\n"
1266 #if defined(CONFIG_CMD_RUN)
1267 "env run var [...] - run commands in an environment variable\n"
1269 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
1270 "env save - save environment\n"
1272 "env set [-f] name [arg ...]\n";
1276 env
, CONFIG_SYS_MAXARGS
, 1, do_env
,
1277 "environment handling commands", env_help_text
1281 * Old command line interface, kept for compatibility
1284 #if defined(CONFIG_CMD_EDITENV)
1285 U_BOOT_CMD_COMPLETE(
1286 editenv
, 2, 0, do_env_edit
,
1287 "edit environment variable",
1289 " - edit environment variable 'name'",
1294 U_BOOT_CMD_COMPLETE(
1295 printenv
, CONFIG_SYS_MAXARGS
, 1, do_env_print
,
1296 "print environment variables",
1297 "[-a]\n - print [all] values of all environment variables\n"
1298 "printenv name ...\n"
1299 " - print value of environment variable 'name'",
1303 #ifdef CONFIG_CMD_GREPENV
1304 U_BOOT_CMD_COMPLETE(
1305 grepenv
, CONFIG_SYS_MAXARGS
, 0, do_env_grep
,
1306 "search environment variables",
1308 "[-e] [-n | -v | -b] string ...\n"
1310 "[-n | -v | -b] string ...\n"
1312 " - list environment name=value pairs matching 'string'\n"
1314 " \"-e\": enable regular expressions;\n"
1316 " \"-n\": search variable names; \"-v\": search values;\n"
1317 " \"-b\": search both names and values (default)",
1322 U_BOOT_CMD_COMPLETE(
1323 setenv
, CONFIG_SYS_MAXARGS
, 0, do_env_set
,
1324 "set environment variables",
1325 "[-f] name value ...\n"
1326 " - [forcibly] set environment variable 'name' to 'value ...'\n"
1327 "setenv [-f] name\n"
1328 " - [forcibly] delete environment variable 'name'",
1332 #if defined(CONFIG_CMD_ASKENV)
1335 askenv
, CONFIG_SYS_MAXARGS
, 1, do_env_ask
,
1336 "get environment variables from stdin",
1337 "name [message] [size]\n"
1338 " - get environment variable 'name' from stdin (max 'size' chars)"
1342 #if defined(CONFIG_CMD_RUN)
1343 U_BOOT_CMD_COMPLETE(
1344 run
, CONFIG_SYS_MAXARGS
, 1, do_run
,
1345 "run commands in an environment variable",
1347 " - run the commands in the environment variable(s) 'var'",
1351 #endif /* CONFIG_SPL_BUILD */