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