1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * (C) Copyright 2000-2013
4 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 *
6 * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
7 * Andreas Heppel <aheppel@sysgo.de>
8 *
9 * Copyright 2011 Freescale Semiconductor, Inc.
10 */
11
12 /*
13 * Support for persistent environment data
14 *
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
19 * flags.
20 *
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.
24 */
25
26 #include <config.h>
27 #include <cli.h>
28 #include <command.h>
29 #include <console.h>
30 #include <env.h>
31 #include <env_internal.h>
32 #include <log.h>
33 #include <search.h>
34 #include <errno.h>
35 #include <malloc.h>
36 #include <mapmem.h>
37 #include <asm/global_data.h>
38 #include <linux/bitops.h>
39 #include <linux/printk.h>
40 #include <u-boot/crc.h>
41 #include <linux/stddef.h>
42 #include <asm/byteorder.h>
43 #include <asm/io.h>
44
45 DECLARE_GLOBAL_DATA_PTR;
46
47 /*
48 * Maximum expected input data size for import command
49 */
50 #define MAX_ENV_SIZE (1 << 20) /* 1 MiB */
51
52 #ifndef CONFIG_XPL_BUILD
53 /*
54 * Command interface: print one or all environment variables
55 *
56 * Returns 0 in case of error, or length of printed string
57 */
env_print(char * name,int flag)58 static int env_print(char *name, int flag)
59 {
60 char *res = NULL;
61 ssize_t len;
62
63 if (name) { /* print a single name */
64 struct env_entry e, *ep;
65
66 e.key = name;
67 e.data = NULL;
68 hsearch_r(e, ENV_FIND, &ep, &env_htab, flag);
69 if (ep == NULL)
70 return 0;
71 len = printf("%s=%s\n", ep->key, ep->data);
72 return len;
73 }
74
75 /* print whole list */
76 len = hexport_r(&env_htab, '\n', flag, &res, 0, 0, NULL);
77
78 if (len > 0) {
79 puts(res);
80 free(res);
81 return len;
82 }
83
84 /* should never happen */
85 printf("## Error: cannot export environment\n");
86 return 0;
87 }
88
do_env_print(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])89 static int do_env_print(struct cmd_tbl *cmdtp, int flag, int argc,
90 char *const argv[])
91 {
92 int i;
93 int rcode = 0;
94 int env_flag = H_HIDE_DOT;
95
96 #if defined(CONFIG_CMD_NVEDIT_EFI)
97 if (argc > 1 && argv[1][0] == '-' && argv[1][1] == 'e')
98 return do_env_print_efi(cmdtp, flag, --argc, ++argv);
99 #endif
100
101 if (argc > 1 && argv[1][0] == '-' && argv[1][1] == 'a') {
102 argc--;
103 argv++;
104 env_flag &= ~H_HIDE_DOT;
105 }
106
107 if (argc == 1) {
108 /* print all env vars */
109 rcode = env_print(NULL, env_flag);
110 if (!rcode)
111 return 1;
112 printf("\nEnvironment size: %d/%ld bytes\n",
113 rcode, (ulong)ENV_SIZE);
114 return 0;
115 }
116
117 /* print selected env vars */
118 env_flag &= ~H_HIDE_DOT;
119 for (i = 1; i < argc; ++i) {
120 int rc = env_print(argv[i], env_flag);
121 if (!rc) {
122 printf("## Error: \"%s\" not defined\n", argv[i]);
123 ++rcode;
124 }
125 }
126
127 return rcode;
128 }
129
130 #ifdef CONFIG_CMD_GREPENV
do_env_grep(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])131 static int do_env_grep(struct cmd_tbl *cmdtp, int flag,
132 int argc, char *const argv[])
133 {
134 char *res = NULL;
135 int len, grep_how, grep_what;
136
137 if (argc < 2)
138 return CMD_RET_USAGE;
139
140 grep_how = H_MATCH_SUBSTR; /* default: substring search */
141 grep_what = H_MATCH_BOTH; /* default: grep names and values */
142
143 while (--argc > 0 && **++argv == '-') {
144 char *arg = *argv;
145 while (*++arg) {
146 switch (*arg) {
147 #ifdef CONFIG_REGEX
148 case 'e': /* use regex matching */
149 grep_how = H_MATCH_REGEX;
150 break;
151 #endif
152 case 'n': /* grep for name */
153 grep_what = H_MATCH_KEY;
154 break;
155 case 'v': /* grep for value */
156 grep_what = H_MATCH_DATA;
157 break;
158 case 'b': /* grep for both */
159 grep_what = H_MATCH_BOTH;
160 break;
161 case '-':
162 goto DONE;
163 default:
164 return CMD_RET_USAGE;
165 }
166 }
167 }
168
169 DONE:
170 len = hexport_r(&env_htab, '\n',
171 flag | grep_what | grep_how,
172 &res, 0, argc, argv);
173
174 if (len > 0) {
175 puts(res);
176 free(res);
177 }
178
179 if (len < 2)
180 return 1;
181
182 return 0;
183 }
184 #endif
185 #endif /* CONFIG_XPL_BUILD */
186
187 #ifndef CONFIG_XPL_BUILD
do_env_set(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])188 static int do_env_set(struct cmd_tbl *cmdtp, int flag, int argc,
189 char *const argv[])
190 {
191 if (argc < 2)
192 return CMD_RET_USAGE;
193
194 return env_do_env_set(flag, argc, argv, H_INTERACTIVE);
195 }
196
197 /*
198 * Prompt for environment variable
199 */
200 #if defined(CONFIG_CMD_ASKENV)
do_env_ask(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])201 static int do_env_ask(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
202 {
203 char message[CONFIG_SYS_CBSIZE];
204 int i, len, pos, size;
205 char *local_args[4];
206 char *endptr;
207
208 local_args[0] = argv[0];
209 local_args[1] = argv[1];
210 local_args[2] = NULL;
211 local_args[3] = NULL;
212
213 /*
214 * Check the syntax:
215 *
216 * env_ask envname [message1 ...] [size]
217 */
218 if (argc == 1)
219 return CMD_RET_USAGE;
220
221 /*
222 * We test the last argument if it can be converted
223 * into a decimal number. If yes, we assume it's
224 * the size. Otherwise we echo it as part of the
225 * message.
226 */
227 i = dectoul(argv[argc - 1], &endptr);
228 if (*endptr != '\0') { /* no size */
229 size = CONFIG_SYS_CBSIZE - 1;
230 } else { /* size given */
231 size = i;
232 --argc;
233 }
234
235 if (argc <= 2) {
236 sprintf(message, "Please enter '%s': ", argv[1]);
237 } else {
238 /* env_ask envname message1 ... messagen [size] */
239 for (i = 2, pos = 0; i < argc && pos+1 < sizeof(message); i++) {
240 if (pos)
241 message[pos++] = ' ';
242
243 strncpy(message + pos, argv[i], sizeof(message) - pos);
244 pos += strlen(argv[i]);
245 }
246 if (pos < sizeof(message) - 1) {
247 message[pos++] = ' ';
248 message[pos] = '\0';
249 } else
250 message[CONFIG_SYS_CBSIZE - 1] = '\0';
251 }
252
253 if (size >= CONFIG_SYS_CBSIZE)
254 size = CONFIG_SYS_CBSIZE - 1;
255
256 if (size <= 0)
257 return 1;
258
259 /* prompt for input */
260 len = cli_readline(message);
261
262 if (size < len)
263 console_buffer[size] = '\0';
264
265 len = 2;
266 if (console_buffer[0] != '\0') {
267 local_args[2] = console_buffer;
268 len = 3;
269 }
270
271 /* Continue calling setenv code */
272 return env_do_env_set(flag, len, local_args, H_INTERACTIVE);
273 }
274 #endif
275
276 #if defined(CONFIG_CMD_ENV_CALLBACK)
print_static_binding(const char * var_name,const char * callback_name,void * priv)277 static int print_static_binding(const char *var_name, const char *callback_name,
278 void *priv)
279 {
280 printf("\t%-20s %-20s\n", var_name, callback_name);
281
282 return 0;
283 }
284
print_active_callback(struct env_entry * entry)285 static int print_active_callback(struct env_entry *entry)
286 {
287 struct env_clbk_tbl *clbkp;
288 int i;
289 int num_callbacks;
290
291 if (entry->callback == NULL)
292 return 0;
293
294 /* look up the callback in the linker-list */
295 num_callbacks = ll_entry_count(struct env_clbk_tbl, env_clbk);
296 for (i = 0, clbkp = ll_entry_start(struct env_clbk_tbl, env_clbk);
297 i < num_callbacks;
298 i++, clbkp++) {
299 if (entry->callback == clbkp->callback)
300 break;
301 }
302
303 if (i == num_callbacks)
304 /* this should probably never happen, but just in case... */
305 printf("\t%-20s %p\n", entry->key, entry->callback);
306 else
307 printf("\t%-20s %-20s\n", entry->key, clbkp->name);
308
309 return 0;
310 }
311
312 /*
313 * Print the callbacks available and what they are bound to
314 */
do_env_callback(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])315 static int do_env_callback(struct cmd_tbl *cmdtp, int flag, int argc,
316 char *const argv[])
317 {
318 struct env_clbk_tbl *clbkp;
319 int i;
320 int num_callbacks;
321
322 /* Print the available callbacks */
323 puts("Available callbacks:\n");
324 puts("\tCallback Name\n");
325 puts("\t-------------\n");
326 num_callbacks = ll_entry_count(struct env_clbk_tbl, env_clbk);
327 for (i = 0, clbkp = ll_entry_start(struct env_clbk_tbl, env_clbk);
328 i < num_callbacks;
329 i++, clbkp++)
330 printf("\t%s\n", clbkp->name);
331 puts("\n");
332
333 /* Print the static bindings that may exist */
334 puts("Static callback bindings:\n");
335 printf("\t%-20s %-20s\n", "Variable Name", "Callback Name");
336 printf("\t%-20s %-20s\n", "-------------", "-------------");
337 env_attr_walk(ENV_CALLBACK_LIST_STATIC, print_static_binding, NULL);
338 puts("\n");
339
340 /* walk through each variable and print the callback if it has one */
341 puts("Active callback bindings:\n");
342 printf("\t%-20s %-20s\n", "Variable Name", "Callback Name");
343 printf("\t%-20s %-20s\n", "-------------", "-------------");
344 hwalk_r(&env_htab, print_active_callback);
345 return 0;
346 }
347 #endif
348
349 #if defined(CONFIG_CMD_ENV_FLAGS)
print_static_flags(const char * var_name,const char * flags,void * priv)350 static int print_static_flags(const char *var_name, const char *flags,
351 void *priv)
352 {
353 enum env_flags_vartype type = env_flags_parse_vartype(flags);
354 enum env_flags_varaccess access = env_flags_parse_varaccess(flags);
355
356 printf("\t%-20s %-20s %-20s\n", var_name,
357 env_flags_get_vartype_name(type),
358 env_flags_get_varaccess_name(access));
359
360 return 0;
361 }
362
print_active_flags(struct env_entry * entry)363 static int print_active_flags(struct env_entry *entry)
364 {
365 enum env_flags_vartype type;
366 enum env_flags_varaccess access;
367
368 if (entry->flags == 0)
369 return 0;
370
371 type = (enum env_flags_vartype)
372 (entry->flags & ENV_FLAGS_VARTYPE_BIN_MASK);
373 access = env_flags_parse_varaccess_from_binflags(entry->flags);
374 printf("\t%-20s %-20s %-20s\n", entry->key,
375 env_flags_get_vartype_name(type),
376 env_flags_get_varaccess_name(access));
377
378 return 0;
379 }
380
381 /*
382 * Print the flags available and what variables have flags
383 */
do_env_flags(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])384 static int do_env_flags(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
385 {
386 /* Print the available variable types */
387 printf("Available variable type flags (position %d):\n",
388 ENV_FLAGS_VARTYPE_LOC);
389 puts("\tFlag\tVariable Type Name\n");
390 puts("\t----\t------------------\n");
391 env_flags_print_vartypes();
392 puts("\n");
393
394 /* Print the available variable access types */
395 printf("Available variable access flags (position %d):\n",
396 ENV_FLAGS_VARACCESS_LOC);
397 puts("\tFlag\tVariable Access Name\n");
398 puts("\t----\t--------------------\n");
399 env_flags_print_varaccess();
400 puts("\n");
401
402 /* Print the static flags that may exist */
403 puts("Static flags:\n");
404 printf("\t%-20s %-20s %-20s\n", "Variable Name", "Variable Type",
405 "Variable Access");
406 printf("\t%-20s %-20s %-20s\n", "-------------", "-------------",
407 "---------------");
408 env_attr_walk(ENV_FLAGS_LIST_STATIC, print_static_flags, NULL);
409 puts("\n");
410
411 /* walk through each variable and print the flags if non-default */
412 puts("Active flags:\n");
413 printf("\t%-20s %-20s %-20s\n", "Variable Name", "Variable Type",
414 "Variable Access");
415 printf("\t%-20s %-20s %-20s\n", "-------------", "-------------",
416 "---------------");
417 hwalk_r(&env_htab, print_active_flags);
418 return 0;
419 }
420 #endif
421
422 /*
423 * Interactively edit an environment variable
424 */
425 #if defined(CONFIG_CMD_EDITENV)
do_env_edit(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])426 static int do_env_edit(struct cmd_tbl *cmdtp, int flag, int argc,
427 char *const argv[])
428 {
429 char buffer[CONFIG_SYS_CBSIZE];
430 char *init_val;
431
432 if (argc < 2)
433 return CMD_RET_USAGE;
434
435 /* before import into hashtable */
436 if (!(gd->flags & GD_FLG_ENV_READY))
437 return 1;
438
439 /* Set read buffer to initial value or empty sting */
440 init_val = env_get(argv[1]);
441 if (init_val)
442 snprintf(buffer, CONFIG_SYS_CBSIZE, "%s", init_val);
443 else
444 buffer[0] = '\0';
445
446 if (cli_readline_into_buffer("edit: ", buffer, 0) < 0)
447 return 1;
448
449 if (buffer[0] == '\0') {
450 const char * const _argv[3] = { "setenv", argv[1], NULL };
451
452 return env_do_env_set(0, 2, (char * const *)_argv, H_INTERACTIVE);
453 } else {
454 const char * const _argv[4] = { "setenv", argv[1], buffer,
455 NULL };
456
457 return env_do_env_set(0, 3, (char * const *)_argv, H_INTERACTIVE);
458 }
459 }
460 #endif /* CONFIG_CMD_EDITENV */
461
462 #if defined(CONFIG_CMD_SAVEENV) && !IS_ENABLED(CONFIG_ENV_IS_DEFAULT)
do_env_save(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])463 static int do_env_save(struct cmd_tbl *cmdtp, int flag, int argc,
464 char *const argv[])
465 {
466 return env_save() ? 1 : 0;
467 }
468
469 U_BOOT_CMD(
470 saveenv, 1, 0, do_env_save,
471 "save environment variables to persistent storage",
472 ""
473 );
474
475 #if defined(CONFIG_CMD_ERASEENV)
do_env_erase(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])476 static int do_env_erase(struct cmd_tbl *cmdtp, int flag, int argc,
477 char *const argv[])
478 {
479 return env_erase() ? 1 : 0;
480 }
481
482 U_BOOT_CMD(
483 eraseenv, 1, 0, do_env_erase,
484 "erase environment variables from persistent storage",
485 ""
486 );
487 #endif
488 #endif
489
490 #if defined(CONFIG_CMD_NVEDIT_LOAD)
do_env_load(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])491 static int do_env_load(struct cmd_tbl *cmdtp, int flag, int argc,
492 char *const argv[])
493 {
494 return env_reload() ? 1 : 0;
495 }
496 #endif
497
498 #if defined(CONFIG_CMD_NVEDIT_SELECT)
do_env_select(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])499 static int do_env_select(struct cmd_tbl *cmdtp, int flag, int argc,
500 char *const argv[])
501 {
502 return env_select(argv[1]) ? 1 : 0;
503 }
504 #endif
505
506 #endif /* CONFIG_XPL_BUILD */
507
508 #ifndef CONFIG_XPL_BUILD
do_env_default(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])509 static int do_env_default(struct cmd_tbl *cmdtp, int flag,
510 int argc, char *const argv[])
511 {
512 int all = 0, env_flag = H_INTERACTIVE;
513
514 debug("Initial value for argc=%d\n", argc);
515 while (--argc > 0 && **++argv == '-') {
516 char *arg = *argv;
517
518 while (*++arg) {
519 switch (*arg) {
520 case 'a': /* default all */
521 all = 1;
522 break;
523 case 'f': /* force */
524 env_flag |= H_FORCE;
525 break;
526 case 'k':
527 env_flag |= H_NOCLEAR;
528 break;
529 default:
530 return cmd_usage(cmdtp);
531 }
532 }
533 }
534 debug("Final value for argc=%d\n", argc);
535 if (all && (argc == 0)) {
536 /* Reset the whole environment */
537 env_set_default("## Resetting to default environment\n",
538 env_flag);
539 return 0;
540 }
541 if (!all && (argc > 0)) {
542 /* Reset individual variables */
543 env_set_default_vars(argc, argv, env_flag);
544 return 0;
545 }
546
547 return cmd_usage(cmdtp);
548 }
549
do_env_delete(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])550 static int do_env_delete(struct cmd_tbl *cmdtp, int flag,
551 int argc, char *const argv[])
552 {
553 int env_flag = H_INTERACTIVE;
554 int ret = 0;
555
556 debug("Initial value for argc=%d\n", argc);
557 while (argc > 1 && **(argv + 1) == '-') {
558 char *arg = *++argv;
559
560 --argc;
561 while (*++arg) {
562 switch (*arg) {
563 case 'f': /* force */
564 env_flag |= H_FORCE;
565 break;
566 default:
567 return CMD_RET_USAGE;
568 }
569 }
570 }
571 debug("Final value for argc=%d\n", argc);
572
573 env_inc_id();
574
575 while (--argc > 0) {
576 char *name = *++argv;
577
578 if (hdelete_r(name, &env_htab, env_flag))
579 ret = 1;
580 }
581
582 return ret;
583 }
584
585 #ifdef CONFIG_CMD_EXPORTENV
586 /*
587 * env export [-t | -b | -c] [-s size] addr [var ...]
588 * -t: export as text format; if size is given, data will be
589 * padded with '\0' bytes; if not, one terminating '\0'
590 * will be added (which is included in the "filesize"
591 * setting so you can for exmple copy this to flash and
592 * keep the termination).
593 * -b: export as binary format (name=value pairs separated by
594 * '\0', list end marked by double "\0\0")
595 * -c: export as checksum protected environment format as
596 * used for example by "saveenv" command
597 * -s size:
598 * size of output buffer
599 * addr: memory address where environment gets stored
600 * var... List of variable names that get included into the
601 * export. Without arguments, the whole environment gets
602 * exported.
603 *
604 * With "-c" and size is NOT given, then the export command will
605 * format the data as currently used for the persistent storage,
606 * i. e. it will use CONFIG_ENV_SECT_SIZE as output block size and
607 * prepend a valid CRC32 checksum and, in case of redundant
608 * environment, a "current" redundancy flag. If size is given, this
609 * value will be used instead of CONFIG_ENV_SECT_SIZE; again, CRC32
610 * checksum and redundancy flag will be inserted.
611 *
612 * With "-b" and "-t", always only the real data (including a
613 * terminating '\0' byte) will be written; here the optional size
614 * argument will be used to make sure not to overflow the user
615 * provided buffer; the command will abort if the size is not
616 * sufficient. Any remaining space will be '\0' padded.
617 *
618 * On successful return, the variable "filesize" will be set.
619 * Note that filesize includes the trailing/terminating '\0' byte(s).
620 *
621 * Usage scenario: create a text snapshot/backup of the current settings:
622 *
623 * => env export -t 100000
624 * => era ${backup_addr} +${filesize}
625 * => cp.b 100000 ${backup_addr} ${filesize}
626 *
627 * Re-import this snapshot, deleting all other settings:
628 *
629 * => env import -d -t ${backup_addr}
630 */
do_env_export(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])631 static int do_env_export(struct cmd_tbl *cmdtp, int flag,
632 int argc, char *const argv[])
633 {
634 char buf[32];
635 ulong addr;
636 char *ptr, *cmd, *res;
637 size_t size = 0;
638 ssize_t len;
639 env_t *envp;
640 char sep = '\n';
641 int chk = 0;
642 int fmt = 0;
643
644 cmd = *argv;
645
646 while (--argc > 0 && **++argv == '-') {
647 char *arg = *argv;
648 while (*++arg) {
649 switch (*arg) {
650 case 'b': /* raw binary format */
651 if (fmt++)
652 goto sep_err;
653 sep = '\0';
654 break;
655 case 'c': /* external checksum format */
656 if (fmt++)
657 goto sep_err;
658 sep = '\0';
659 chk = 1;
660 break;
661 case 's': /* size given */
662 if (--argc <= 0)
663 return cmd_usage(cmdtp);
664 size = hextoul(*++argv, NULL);
665 goto NXTARG;
666 case 't': /* text format */
667 if (fmt++)
668 goto sep_err;
669 sep = '\n';
670 break;
671 default:
672 return CMD_RET_USAGE;
673 }
674 }
675 NXTARG: ;
676 }
677
678 if (argc < 1)
679 return CMD_RET_USAGE;
680
681 addr = hextoul(argv[0], NULL);
682 ptr = map_sysmem(addr, size);
683
684 if (size)
685 memset(ptr, '\0', size);
686
687 argc--;
688 argv++;
689
690 if (sep) { /* export as text file */
691 len = hexport_r(&env_htab, sep,
692 H_MATCH_KEY | H_MATCH_IDENT,
693 &ptr, size, argc, argv);
694 if (len < 0) {
695 pr_err("## Error: Cannot export environment: errno = %d\n",
696 errno);
697 return 1;
698 }
699 sprintf(buf, "%zX", (size_t)len);
700 env_set("filesize", buf);
701
702 return 0;
703 }
704
705 envp = (env_t *)ptr;
706
707 if (chk) /* export as checksum protected block */
708 res = (char *)envp->data;
709 else /* export as raw binary data */
710 res = ptr;
711
712 len = hexport_r(&env_htab, '\0',
713 H_MATCH_KEY | H_MATCH_IDENT,
714 &res, ENV_SIZE, argc, argv);
715 if (len < 0) {
716 pr_err("## Error: Cannot export environment: errno = %d\n",
717 errno);
718 return 1;
719 }
720
721 if (chk) {
722 envp->crc = crc32(0, envp->data,
723 size ? size - offsetof(env_t, data) : ENV_SIZE);
724 #ifdef CONFIG_ENV_ADDR_REDUND
725 envp->flags = ENV_REDUND_ACTIVE;
726 #endif
727 }
728 env_set_hex("filesize", len + offsetof(env_t, data));
729
730 return 0;
731
732 sep_err:
733 printf("## Error: %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n",
734 cmd);
735 return 1;
736 }
737 #endif
738
739 #ifdef CONFIG_CMD_IMPORTENV
740 /*
741 * env import [-d] [-t [-r] | -b | -c] addr [size] [var ...]
742 * -d: delete existing environment before importing if no var is
743 * passed; if vars are passed, if one var is in the current
744 * environment but not in the environment at addr, delete var from
745 * current environment;
746 * otherwise overwrite / append to existing definitions
747 * -t: assume text format; either "size" must be given or the
748 * text data must be '\0' terminated
749 * -r: handle CRLF like LF, that means exported variables with
750 * a content which ends with \r won't get imported. Used
751 * to import text files created with editors which are using CRLF
752 * for line endings. Only effective in addition to -t.
753 * -b: assume binary format ('\0' separated, "\0\0" terminated)
754 * -c: assume checksum protected environment format
755 * addr: memory address to read from
756 * size: length of input data; if missing, proper '\0'
757 * termination is mandatory
758 * if var is set and size should be missing (i.e. '\0'
759 * termination), set size to '-'
760 * var... List of the names of the only variables that get imported from
761 * the environment at address 'addr'. Without arguments, the whole
762 * environment gets imported.
763 */
do_env_import(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])764 static int do_env_import(struct cmd_tbl *cmdtp, int flag,
765 int argc, char *const argv[])
766 {
767 ulong addr;
768 char *cmd, *ptr;
769 char sep = '\n';
770 int chk = 0;
771 int fmt = 0;
772 int del = 0;
773 int crlf_is_lf = 0;
774 int wl = 0;
775 size_t size;
776
777 cmd = *argv;
778
779 while (--argc > 0 && **++argv == '-') {
780 char *arg = *argv;
781 while (*++arg) {
782 switch (*arg) {
783 case 'b': /* raw binary format */
784 if (fmt++)
785 goto sep_err;
786 sep = '\0';
787 break;
788 case 'c': /* external checksum format */
789 if (fmt++)
790 goto sep_err;
791 sep = '\0';
792 chk = 1;
793 break;
794 case 't': /* text format */
795 if (fmt++)
796 goto sep_err;
797 sep = '\n';
798 break;
799 case 'r': /* handle CRLF like LF */
800 crlf_is_lf = 1;
801 break;
802 case 'd':
803 del = 1;
804 break;
805 default:
806 return CMD_RET_USAGE;
807 }
808 }
809 }
810
811 if (argc < 1)
812 return CMD_RET_USAGE;
813
814 if (!fmt)
815 printf("## Warning: defaulting to text format\n");
816
817 if (sep != '\n' && crlf_is_lf )
818 crlf_is_lf = 0;
819
820 addr = hextoul(argv[0], NULL);
821 ptr = map_sysmem(addr, 0);
822
823 if (argc >= 2 && strcmp(argv[1], "-")) {
824 size = hextoul(argv[1], NULL);
825 } else if (chk) {
826 puts("## Error: external checksum format must pass size\n");
827 return CMD_RET_FAILURE;
828 } else {
829 char *s = ptr;
830
831 size = 0;
832
833 while (size < MAX_ENV_SIZE) {
834 if ((*s == sep) && (*(s+1) == '\0'))
835 break;
836 ++s;
837 ++size;
838 }
839 if (size == MAX_ENV_SIZE) {
840 printf("## Warning: Input data exceeds %d bytes"
841 " - truncated\n", MAX_ENV_SIZE);
842 }
843 size += 2;
844 printf("## Info: input data size = %zu = 0x%zX\n", size, size);
845 }
846
847 if (argc > 2)
848 wl = 1;
849
850 if (chk) {
851 uint32_t crc;
852 env_t *ep = (env_t *)ptr;
853
854 if (size <= offsetof(env_t, data)) {
855 printf("## Error: Invalid size 0x%zX\n", size);
856 return 1;
857 }
858
859 size -= offsetof(env_t, data);
860 memcpy(&crc, &ep->crc, sizeof(crc));
861
862 if (crc32(0, ep->data, size) != crc) {
863 puts("## Error: bad CRC, import failed\n");
864 return 1;
865 }
866 ptr = (char *)ep->data;
867 }
868
869 if (!himport_r(&env_htab, ptr, size, sep, del ? 0 : H_NOCLEAR,
870 crlf_is_lf, wl ? argc - 2 : 0, wl ? &argv[2] : NULL)) {
871 pr_err("## Error: Environment import failed: errno = %d\n",
872 errno);
873 return 1;
874 }
875 gd->flags |= GD_FLG_ENV_READY;
876
877 return 0;
878
879 sep_err:
880 printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n",
881 cmd);
882 return 1;
883 }
884 #endif
885
886 #if defined(CONFIG_CMD_NVEDIT_INDIRECT)
do_env_indirect(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])887 static int do_env_indirect(struct cmd_tbl *cmdtp, int flag,
888 int argc, char *const argv[])
889 {
890 char *to = argv[1];
891 char *from = argv[2];
892 char *default_value = NULL;
893 int ret = 0;
894 char *val;
895
896 if (argc < 3 || argc > 4) {
897 return CMD_RET_USAGE;
898 }
899
900 if (argc == 4) {
901 default_value = argv[3];
902 }
903
904 val = env_get(from) ?: default_value;
905 if (!val) {
906 printf("## env indirect: Environment variable for <from> (%s) does not exist.\n", from);
907
908 return CMD_RET_FAILURE;
909 }
910
911 ret = env_set(to, val);
912
913 if (ret == 0) {
914 return CMD_RET_SUCCESS;
915 }
916 else {
917 return CMD_RET_FAILURE;
918 }
919 }
920 #endif
921
922 #if defined(CONFIG_CMD_NVEDIT_INFO)
923 /*
924 * print_env_info - print environment information
925 */
print_env_info(void)926 static int print_env_info(void)
927 {
928 const char *value;
929
930 /* print environment validity value */
931 switch (gd->env_valid) {
932 case ENV_INVALID:
933 value = "invalid";
934 break;
935 case ENV_VALID:
936 value = "valid";
937 break;
938 case ENV_REDUND:
939 value = "redundant";
940 break;
941 default:
942 value = "unknown";
943 break;
944 }
945 printf("env_valid = %s\n", value);
946
947 /* print environment ready flag */
948 value = gd->flags & GD_FLG_ENV_READY ? "true" : "false";
949 printf("env_ready = %s\n", value);
950
951 /* print environment using default flag */
952 value = gd->flags & GD_FLG_ENV_DEFAULT ? "true" : "false";
953 printf("env_use_default = %s\n", value);
954
955 return CMD_RET_SUCCESS;
956 }
957
958 #define ENV_INFO_IS_DEFAULT BIT(0) /* default environment bit mask */
959 #define ENV_INFO_IS_PERSISTED BIT(1) /* environment persistence bit mask */
960
961 /*
962 * env info - display environment information
963 * env info [-d] - evaluate whether default environment is used
964 * env info [-p] - evaluate whether environment can be persisted
965 * Add [-q] - quiet mode, use only for command result, for test by example:
966 * test env info -p -d -q
967 */
do_env_info(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])968 static int do_env_info(struct cmd_tbl *cmdtp, int flag,
969 int argc, char *const argv[])
970 {
971 int eval_flags = 0;
972 int eval_results = 0;
973 bool quiet = false;
974 #if defined(CONFIG_CMD_SAVEENV) && !IS_ENABLED(CONFIG_ENV_IS_DEFAULT)
975 enum env_location loc;
976 #endif
977
978 /* display environment information */
979 if (argc <= 1)
980 return print_env_info();
981
982 /* process options */
983 while (--argc > 0 && **++argv == '-') {
984 char *arg = *argv;
985
986 while (*++arg) {
987 switch (*arg) {
988 case 'd':
989 eval_flags |= ENV_INFO_IS_DEFAULT;
990 break;
991 case 'p':
992 eval_flags |= ENV_INFO_IS_PERSISTED;
993 break;
994 case 'q':
995 quiet = true;
996 break;
997 default:
998 return CMD_RET_USAGE;
999 }
1000 }
1001 }
1002
1003 /* evaluate whether default environment is used */
1004 if (eval_flags & ENV_INFO_IS_DEFAULT) {
1005 if (gd->flags & GD_FLG_ENV_DEFAULT) {
1006 if (!quiet)
1007 printf("Default environment is used\n");
1008 eval_results |= ENV_INFO_IS_DEFAULT;
1009 } else {
1010 if (!quiet)
1011 printf("Environment was loaded from persistent storage\n");
1012 }
1013 }
1014
1015 /* evaluate whether environment can be persisted */
1016 if (eval_flags & ENV_INFO_IS_PERSISTED) {
1017 #if defined(CONFIG_CMD_SAVEENV) && !IS_ENABLED(CONFIG_ENV_IS_DEFAULT)
1018 loc = env_get_location(ENVOP_SAVE, gd->env_load_prio);
1019 if (ENVL_NOWHERE != loc && ENVL_UNKNOWN != loc) {
1020 if (!quiet)
1021 printf("Environment can be persisted\n");
1022 eval_results |= ENV_INFO_IS_PERSISTED;
1023 } else {
1024 if (!quiet)
1025 printf("Environment cannot be persisted\n");
1026 }
1027 #else
1028 if (!quiet)
1029 printf("Environment cannot be persisted\n");
1030 #endif
1031 }
1032
1033 /* The result of evaluations is combined with AND */
1034 if (eval_flags != eval_results)
1035 return CMD_RET_FAILURE;
1036
1037 return CMD_RET_SUCCESS;
1038 }
1039 #endif
1040
1041 #if defined(CONFIG_CMD_ENV_EXISTS)
do_env_exists(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])1042 static int do_env_exists(struct cmd_tbl *cmdtp, int flag, int argc,
1043 char *const argv[])
1044 {
1045 struct env_entry e, *ep;
1046
1047 if (argc < 2)
1048 return CMD_RET_USAGE;
1049
1050 e.key = argv[1];
1051 e.data = NULL;
1052 hsearch_r(e, ENV_FIND, &ep, &env_htab, 0);
1053
1054 return (ep == NULL) ? 1 : 0;
1055 }
1056 #endif
1057
1058 /*
1059 * New command line interface: "env" command with subcommands
1060 */
1061 static struct cmd_tbl cmd_env_sub[] = {
1062 #if defined(CONFIG_CMD_ASKENV)
1063 U_BOOT_CMD_MKENT(ask, CONFIG_SYS_MAXARGS, 1, do_env_ask, "", ""),
1064 #endif
1065 U_BOOT_CMD_MKENT(default, 1, 0, do_env_default, "", ""),
1066 U_BOOT_CMD_MKENT(delete, CONFIG_SYS_MAXARGS, 0, do_env_delete, "", ""),
1067 #if defined(CONFIG_CMD_EDITENV)
1068 U_BOOT_CMD_MKENT(edit, 2, 0, do_env_edit, "", ""),
1069 #endif
1070 #if defined(CONFIG_CMD_ENV_CALLBACK)
1071 U_BOOT_CMD_MKENT(callbacks, 1, 0, do_env_callback, "", ""),
1072 #endif
1073 #if defined(CONFIG_CMD_ENV_FLAGS)
1074 U_BOOT_CMD_MKENT(flags, 1, 0, do_env_flags, "", ""),
1075 #endif
1076 #if defined(CONFIG_CMD_EXPORTENV)
1077 U_BOOT_CMD_MKENT(export, 4, 0, do_env_export, "", ""),
1078 #endif
1079 #if defined(CONFIG_CMD_GREPENV)
1080 U_BOOT_CMD_MKENT(grep, CONFIG_SYS_MAXARGS, 1, do_env_grep, "", ""),
1081 #endif
1082 #if defined(CONFIG_CMD_IMPORTENV)
1083 U_BOOT_CMD_MKENT(import, 5, 0, do_env_import, "", ""),
1084 #endif
1085 #if defined(CONFIG_CMD_NVEDIT_INDIRECT)
1086 U_BOOT_CMD_MKENT(indirect, 3, 0, do_env_indirect, "", ""),
1087 #endif
1088 #if defined(CONFIG_CMD_NVEDIT_INFO)
1089 U_BOOT_CMD_MKENT(info, 3, 0, do_env_info, "", ""),
1090 #endif
1091 #if defined(CONFIG_CMD_NVEDIT_LOAD)
1092 U_BOOT_CMD_MKENT(load, 1, 0, do_env_load, "", ""),
1093 #endif
1094 U_BOOT_CMD_MKENT(print, CONFIG_SYS_MAXARGS, 1, do_env_print, "", ""),
1095 #if defined(CONFIG_CMD_RUN)
1096 U_BOOT_CMD_MKENT(run, CONFIG_SYS_MAXARGS, 1, do_run, "", ""),
1097 #endif
1098 #if defined(CONFIG_CMD_SAVEENV) && !IS_ENABLED(CONFIG_ENV_IS_DEFAULT)
1099 U_BOOT_CMD_MKENT(save, 1, 0, do_env_save, "", ""),
1100 #if defined(CONFIG_CMD_ERASEENV)
1101 U_BOOT_CMD_MKENT(erase, 1, 0, do_env_erase, "", ""),
1102 #endif
1103 #endif
1104 #if defined(CONFIG_CMD_NVEDIT_SELECT)
1105 U_BOOT_CMD_MKENT(select, 2, 0, do_env_select, "", ""),
1106 #endif
1107 U_BOOT_CMD_MKENT(set, CONFIG_SYS_MAXARGS, 0, do_env_set, "", ""),
1108 #if defined(CONFIG_CMD_ENV_EXISTS)
1109 U_BOOT_CMD_MKENT(exists, 2, 0, do_env_exists, "", ""),
1110 #endif
1111 };
1112
do_env(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])1113 static int do_env(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
1114 {
1115 struct cmd_tbl *cp;
1116
1117 if (argc < 2)
1118 return CMD_RET_USAGE;
1119
1120 /* drop initial "env" arg */
1121 argc--;
1122 argv++;
1123
1124 cp = find_cmd_tbl(argv[0], cmd_env_sub, ARRAY_SIZE(cmd_env_sub));
1125
1126 if (cp)
1127 return cp->cmd(cmdtp, flag, argc, argv);
1128
1129 return CMD_RET_USAGE;
1130 }
1131
1132 U_BOOT_LONGHELP(env,
1133 #if defined(CONFIG_CMD_ASKENV)
1134 "ask name [message] [size] - ask for environment variable\nenv "
1135 #endif
1136 #if defined(CONFIG_CMD_ENV_CALLBACK)
1137 "callbacks - print callbacks and their associated variables\nenv "
1138 #endif
1139 "default [-k] [-f] -a - [forcibly] reset default environment\n"
1140 "env default [-k] [-f] var [...] - [forcibly] reset variable(s) to their default values\n"
1141 " \"-k\": keep variables not defined in default environment\n"
1142 "env delete [-f] var [...] - [forcibly] delete variable(s)\n"
1143 #if defined(CONFIG_CMD_EDITENV)
1144 "env edit name - edit environment variable\n"
1145 #endif
1146 #if defined(CONFIG_CMD_ENV_EXISTS)
1147 "env exists name - tests for existence of variable\n"
1148 #endif
1149 #if defined(CONFIG_CMD_EXPORTENV)
1150 "env export [-t | -b | -c] [-s size] addr [var ...] - export environment\n"
1151 #endif
1152 #if defined(CONFIG_CMD_ENV_FLAGS)
1153 "env flags - print variables that have non-default flags\n"
1154 #endif
1155 #if defined(CONFIG_CMD_GREPENV)
1156 #ifdef CONFIG_REGEX
1157 "env grep [-e] [-n | -v | -b] string [...] - search environment\n"
1158 #else
1159 "env grep [-n | -v | -b] string [...] - search environment\n"
1160 #endif
1161 #endif
1162 #if defined(CONFIG_CMD_IMPORTENV)
1163 "env import [-d] [-t [-r] | -b | -c] addr [size] [var ...] - import environment\n"
1164 #endif
1165 #if defined(CONFIG_CMD_NVEDIT_INDIRECT)
1166 "env indirect <to> <from> [default] - sets <to> to the value of <from>, using [default] when unset\n"
1167 #endif
1168 #if defined(CONFIG_CMD_NVEDIT_INFO)
1169 "env info - display environment information\n"
1170 "env info [-d] [-p] [-q] - evaluate environment information\n"
1171 " \"-d\": default environment is used\n"
1172 " \"-p\": environment can be persisted\n"
1173 " \"-q\": quiet output\n"
1174 #endif
1175 "env print [-a | name ...] - print environment\n"
1176 #if defined(CONFIG_CMD_NVEDIT_EFI)
1177 "env print -e [-guid guid] [-n] [name ...] - print UEFI environment\n"
1178 #endif
1179 #if defined(CONFIG_CMD_RUN)
1180 "env run var [...] - run commands in an environment variable\n"
1181 #endif
1182 #if defined(CONFIG_CMD_SAVEENV) && !IS_ENABLED(CONFIG_ENV_IS_DEFAULT)
1183 "env save - save environment\n"
1184 #if defined(CONFIG_CMD_ERASEENV)
1185 "env erase - erase environment\n"
1186 #endif
1187 #endif
1188 #if defined(CONFIG_CMD_NVEDIT_LOAD)
1189 "env load - load environment\n"
1190 #endif
1191 #if defined(CONFIG_CMD_NVEDIT_SELECT)
1192 "env select [target] - select environment target\n"
1193 #endif
1194 #if defined(CONFIG_CMD_NVEDIT_EFI)
1195 "env set -e [-nv][-bs][-rt][-at][-a][-i addr:size][-v] name [arg ...]\n"
1196 " - set UEFI variable; unset if '-i' or 'arg' not specified\n"
1197 #endif
1198 "env set [-f] name [arg ...]\n");
1199
1200 U_BOOT_CMD(
1201 env, CONFIG_SYS_MAXARGS, 1, do_env,
1202 "environment handling commands", env_help_text
1203 );
1204
1205 /*
1206 * Old command line interface, kept for compatibility
1207 */
1208
1209 #if defined(CONFIG_CMD_EDITENV)
1210 U_BOOT_CMD_COMPLETE(
1211 editenv, 2, 0, do_env_edit,
1212 "edit environment variable",
1213 "name\n"
1214 " - edit environment variable 'name'",
1215 var_complete
1216 );
1217 #endif
1218
1219 U_BOOT_CMD_COMPLETE(
1220 printenv, CONFIG_SYS_MAXARGS, 1, do_env_print,
1221 "print environment variables",
1222 "[-a]\n - print [all] values of all environment variables\n"
1223 #if defined(CONFIG_CMD_NVEDIT_EFI)
1224 "printenv -e [-guid guid][-n] [name ...]\n"
1225 " - print UEFI variable 'name' or all the variables\n"
1226 " \"-guid\": GUID xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\n"
1227 " \"-n\": suppress dumping variable's value\n"
1228 #endif
1229 "printenv name ...\n"
1230 " - print value of environment variable 'name'",
1231 var_complete
1232 );
1233
1234 #ifdef CONFIG_CMD_GREPENV
1235 U_BOOT_CMD_COMPLETE(
1236 grepenv, CONFIG_SYS_MAXARGS, 0, do_env_grep,
1237 "search environment variables",
1238 #ifdef CONFIG_REGEX
1239 "[-e] [-n | -v | -b] string ...\n"
1240 #else
1241 "[-n | -v | -b] string ...\n"
1242 #endif
1243 " - list environment name=value pairs matching 'string'\n"
1244 #ifdef CONFIG_REGEX
1245 " \"-e\": enable regular expressions;\n"
1246 #endif
1247 " \"-n\": search variable names; \"-v\": search values;\n"
1248 " \"-b\": search both names and values (default)",
1249 var_complete
1250 );
1251 #endif
1252
1253 U_BOOT_CMD_COMPLETE(
1254 setenv, CONFIG_SYS_MAXARGS, 0, do_env_set,
1255 "set environment variables",
1256 #if defined(CONFIG_CMD_NVEDIT_EFI)
1257 "-e [-guid guid][-nv][-bs][-rt][-at][-a][-v]\n"
1258 " [-i addr:size name], or [name [value ...]]\n"
1259 " - set UEFI variable 'name' to 'value' ...'\n"
1260 " \"-guid\": GUID xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\n"
1261 " \"-nv\": set non-volatile attribute\n"
1262 " \"-bs\": set boot-service attribute\n"
1263 " \"-rt\": set runtime attribute\n"
1264 " \"-at\": set time-based authentication attribute\n"
1265 " \"-a\": append-write\n"
1266 " \"-i addr:size\": use <addr,size> as variable's value\n"
1267 " \"-v\": verbose message\n"
1268 " - delete UEFI variable 'name' if 'value' not specified\n"
1269 #endif
1270 "setenv [-f] name value ...\n"
1271 " - [forcibly] set environment variable 'name' to 'value ...'\n"
1272 "setenv [-f] name\n"
1273 " - [forcibly] delete environment variable 'name'",
1274 var_complete
1275 );
1276
1277 #if defined(CONFIG_CMD_ASKENV)
1278
1279 U_BOOT_CMD(
1280 askenv, CONFIG_SYS_MAXARGS, 1, do_env_ask,
1281 "get environment variables from stdin",
1282 "name [message] [size]\n"
1283 " - get environment variable 'name' from stdin (max 'size' chars)"
1284 );
1285 #endif
1286
1287 #if defined(CONFIG_CMD_RUN)
1288 U_BOOT_CMD_COMPLETE(
1289 run, CONFIG_SYS_MAXARGS, 1, do_run,
1290 "run commands in an environment variable",
1291 "var [...]\n"
1292 " - run the commands in the environment variable(s) 'var'",
1293 var_complete
1294 );
1295 #endif
1296 #endif /* CONFIG_XPL_BUILD */
1297