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