Merge branch 'u-boot-imx/master' into 'u-boot-arm/master'
[platform/kernel/u-boot.git] / common / cmd_nvedit.c
1 /*
2  * (C) Copyright 2000-2010
3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4  *
5  * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
6  * Andreas Heppel <aheppel@sysgo.de>
7  *
8  * Copyright 2011 Freescale Semiconductor, Inc.
9  *
10  * See file CREDITS for list of people who contributed to this
11  * project.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License as
15  * published by the Free Software Foundation; either version 2 of
16  * the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software
25  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
26  * MA 02111-1307 USA
27  */
28
29 /*
30  * Support for persistent environment data
31  *
32  * The "environment" is stored on external storage as a list of '\0'
33  * terminated "name=value" strings. The end of the list is marked by
34  * a double '\0'. The environment is preceeded by a 32 bit CRC over
35  * the data part and, in case of redundant environment, a byte of
36  * flags.
37  *
38  * This linearized representation will also be used before
39  * relocation, i. e. as long as we don't have a full C runtime
40  * environment. After that, we use a hash table.
41  */
42
43 #include <common.h>
44 #include <command.h>
45 #include <environment.h>
46 #include <search.h>
47 #include <errno.h>
48 #include <malloc.h>
49 #include <watchdog.h>
50 #include <linux/stddef.h>
51 #include <asm/byteorder.h>
52
53 DECLARE_GLOBAL_DATA_PTR;
54
55 #if     !defined(CONFIG_ENV_IS_IN_EEPROM)       && \
56         !defined(CONFIG_ENV_IS_IN_FLASH)        && \
57         !defined(CONFIG_ENV_IS_IN_DATAFLASH)    && \
58         !defined(CONFIG_ENV_IS_IN_MMC)          && \
59         !defined(CONFIG_ENV_IS_IN_FAT)          && \
60         !defined(CONFIG_ENV_IS_IN_NAND)         && \
61         !defined(CONFIG_ENV_IS_IN_NVRAM)        && \
62         !defined(CONFIG_ENV_IS_IN_ONENAND)      && \
63         !defined(CONFIG_ENV_IS_IN_SPI_FLASH)    && \
64         !defined(CONFIG_ENV_IS_IN_REMOTE)       && \
65         !defined(CONFIG_ENV_IS_NOWHERE)
66 # error Define one of CONFIG_ENV_IS_IN_{EEPROM|FLASH|DATAFLASH|ONENAND|\
67 SPI_FLASH|NVRAM|MMC|FAT|REMOTE} 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 get_env_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 get_env_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         size_t len;
99
100         if (name) {             /* print a single name */
101                 ENTRY e, *ep;
102
103                 e.key = name;
104                 e.data = NULL;
105                 hsearch_r(e, 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         return 0;
123 }
124
125 static int do_env_print(cmd_tbl_t *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 (argc > 1 && argv[1][0] == '-' && argv[1][1] == 'a') {
133                 argc--;
134                 argv++;
135                 env_flag &= ~H_HIDE_DOT;
136         }
137
138         if (argc == 1) {
139                 /* print all env vars */
140                 rcode = env_print(NULL, env_flag);
141                 if (!rcode)
142                         return 1;
143                 printf("\nEnvironment size: %d/%ld bytes\n",
144                         rcode, (ulong)ENV_SIZE);
145                 return 0;
146         }
147
148         /* print selected env vars */
149         env_flag &= ~H_HIDE_DOT;
150         for (i = 1; i < argc; ++i) {
151                 int rc = env_print(argv[i], env_flag);
152                 if (!rc) {
153                         printf("## Error: \"%s\" not defined\n", argv[i]);
154                         ++rcode;
155                 }
156         }
157
158         return rcode;
159 }
160
161 #ifdef CONFIG_CMD_GREPENV
162 static int do_env_grep(cmd_tbl_t *cmdtp, int flag,
163                        int argc, char * const argv[])
164 {
165         ENTRY *match;
166         unsigned char matched[env_htab.size / 8];
167         int rcode = 1, arg = 1, idx;
168
169         if (argc < 2)
170                 return CMD_RET_USAGE;
171
172         memset(matched, 0, env_htab.size / 8);
173
174         while (arg <= argc) {
175                 idx = 0;
176                 while ((idx = hstrstr_r(argv[arg], idx, &match, &env_htab))) {
177                         if (!(matched[idx / 8] & (1 << (idx & 7)))) {
178                                 puts(match->key);
179                                 puts("=");
180                                 puts(match->data);
181                                 puts("\n");
182                         }
183                         matched[idx / 8] |= 1 << (idx & 7);
184                         rcode = 0;
185                 }
186                 arg++;
187         }
188
189         return rcode;
190 }
191 #endif
192 #endif /* CONFIG_SPL_BUILD */
193
194 /*
195  * Set a new environment variable,
196  * or replace or delete an existing one.
197  */
198 static int _do_env_set(int flag, int argc, char * const argv[])
199 {
200         int   i, len;
201         char  *name, *value, *s;
202         ENTRY e, *ep;
203         int env_flag = H_INTERACTIVE;
204
205         debug("Initial value for argc=%d\n", argc);
206         while (argc > 1 && **(argv + 1) == '-') {
207                 char *arg = *++argv;
208
209                 --argc;
210                 while (*++arg) {
211                         switch (*arg) {
212                         case 'f':               /* force */
213                                 env_flag |= H_FORCE;
214                                 break;
215                         default:
216                                 return CMD_RET_USAGE;
217                         }
218                 }
219         }
220         debug("Final value for argc=%d\n", argc);
221         name = argv[1];
222         value = argv[2];
223
224         if (strchr(name, '=')) {
225                 printf("## Error: illegal character '='"
226                        "in variable name \"%s\"\n", name);
227                 return 1;
228         }
229
230         env_id++;
231
232         /* Delete only ? */
233         if (argc < 3 || argv[2] == NULL) {
234                 int rc = hdelete_r(name, &env_htab, env_flag);
235                 return !rc;
236         }
237
238         /*
239          * Insert / replace new value
240          */
241         for (i = 2, len = 0; i < argc; ++i)
242                 len += strlen(argv[i]) + 1;
243
244         value = malloc(len);
245         if (value == NULL) {
246                 printf("## Can't malloc %d bytes\n", len);
247                 return 1;
248         }
249         for (i = 2, s = value; i < argc; ++i) {
250                 char *v = argv[i];
251
252                 while ((*s++ = *v++) != '\0')
253                         ;
254                 *(s - 1) = ' ';
255         }
256         if (s != value)
257                 *--s = '\0';
258
259         e.key   = name;
260         e.data  = value;
261         hsearch_r(e, ENTER, &ep, &env_htab, env_flag);
262         free(value);
263         if (!ep) {
264                 printf("## Error inserting \"%s\" variable, errno=%d\n",
265                         name, errno);
266                 return 1;
267         }
268
269         return 0;
270 }
271
272 int setenv(const char *varname, const char *varvalue)
273 {
274         const char * const argv[4] = { "setenv", varname, varvalue, NULL };
275
276         if (varvalue == NULL || varvalue[0] == '\0')
277                 return _do_env_set(0, 2, (char * const *)argv);
278         else
279                 return _do_env_set(0, 3, (char * const *)argv);
280 }
281
282 /**
283  * Set an environment variable to an integer value
284  *
285  * @param varname       Environmet variable to set
286  * @param value         Value to set it to
287  * @return 0 if ok, 1 on error
288  */
289 int setenv_ulong(const char *varname, ulong value)
290 {
291         /* TODO: this should be unsigned */
292         char *str = simple_itoa(value);
293
294         return setenv(varname, str);
295 }
296
297 /**
298  * Set an environment variable to an value in hex
299  *
300  * @param varname       Environmet variable to set
301  * @param value         Value to set it to
302  * @return 0 if ok, 1 on error
303  */
304 int setenv_hex(const char *varname, ulong value)
305 {
306         char str[17];
307
308         sprintf(str, "%lx", value);
309         return setenv(varname, str);
310 }
311
312 #ifndef CONFIG_SPL_BUILD
313 static int do_env_set(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
314 {
315         if (argc < 2)
316                 return CMD_RET_USAGE;
317
318         return _do_env_set(flag, argc, argv);
319 }
320
321 /*
322  * Prompt for environment variable
323  */
324 #if defined(CONFIG_CMD_ASKENV)
325 int do_env_ask(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
326 {
327         char message[CONFIG_SYS_CBSIZE];
328         int i, len, pos, size;
329         char *local_args[4];
330         char *endptr;
331
332         local_args[0] = argv[0];
333         local_args[1] = argv[1];
334         local_args[2] = NULL;
335         local_args[3] = NULL;
336
337         /*
338          * Check the syntax:
339          *
340          * env_ask envname [message1 ...] [size]
341          */
342         if (argc == 1)
343                 return CMD_RET_USAGE;
344
345         /*
346          * We test the last argument if it can be converted
347          * into a decimal number.  If yes, we assume it's
348          * the size.  Otherwise we echo it as part of the
349          * message.
350          */
351         i = simple_strtoul(argv[argc - 1], &endptr, 10);
352         if (*endptr != '\0') {                  /* no size */
353                 size = CONFIG_SYS_CBSIZE - 1;
354         } else {                                /* size given */
355                 size = i;
356                 --argc;
357         }
358
359         if (argc <= 2) {
360                 sprintf(message, "Please enter '%s': ", argv[1]);
361         } else {
362                 /* env_ask envname message1 ... messagen [size] */
363                 for (i = 2, pos = 0; i < argc; i++) {
364                         if (pos)
365                                 message[pos++] = ' ';
366
367                         strcpy(message + pos, argv[i]);
368                         pos += strlen(argv[i]);
369                 }
370                 message[pos++] = ' ';
371                 message[pos] = '\0';
372         }
373
374         if (size >= CONFIG_SYS_CBSIZE)
375                 size = CONFIG_SYS_CBSIZE - 1;
376
377         if (size <= 0)
378                 return 1;
379
380         /* prompt for input */
381         len = readline(message);
382
383         if (size < len)
384                 console_buffer[size] = '\0';
385
386         len = 2;
387         if (console_buffer[0] != '\0') {
388                 local_args[2] = console_buffer;
389                 len = 3;
390         }
391
392         /* Continue calling setenv code */
393         return _do_env_set(flag, len, local_args);
394 }
395 #endif
396
397 #if defined(CONFIG_CMD_ENV_CALLBACK)
398 static int print_static_binding(const char *var_name, const char *callback_name)
399 {
400         printf("\t%-20s %-20s\n", var_name, callback_name);
401
402         return 0;
403 }
404
405 static int print_active_callback(ENTRY *entry)
406 {
407         struct env_clbk_tbl *clbkp;
408         int i;
409         int num_callbacks;
410
411         if (entry->callback == NULL)
412                 return 0;
413
414         /* look up the callback in the linker-list */
415         num_callbacks = ll_entry_count(struct env_clbk_tbl, env_clbk);
416         for (i = 0, clbkp = ll_entry_start(struct env_clbk_tbl, env_clbk);
417              i < num_callbacks;
418              i++, clbkp++) {
419 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
420                 if (entry->callback == clbkp->callback + gd->reloc_off)
421 #else
422                 if (entry->callback == clbkp->callback)
423 #endif
424                         break;
425         }
426
427         if (i == num_callbacks)
428                 /* this should probably never happen, but just in case... */
429                 printf("\t%-20s %p\n", entry->key, entry->callback);
430         else
431                 printf("\t%-20s %-20s\n", entry->key, clbkp->name);
432
433         return 0;
434 }
435
436 /*
437  * Print the callbacks available and what they are bound to
438  */
439 int do_env_callback(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
440 {
441         struct env_clbk_tbl *clbkp;
442         int i;
443         int num_callbacks;
444
445         /* Print the available callbacks */
446         puts("Available callbacks:\n");
447         puts("\tCallback Name\n");
448         puts("\t-------------\n");
449         num_callbacks = ll_entry_count(struct env_clbk_tbl, env_clbk);
450         for (i = 0, clbkp = ll_entry_start(struct env_clbk_tbl, env_clbk);
451              i < num_callbacks;
452              i++, clbkp++)
453                 printf("\t%s\n", clbkp->name);
454         puts("\n");
455
456         /* Print the static bindings that may exist */
457         puts("Static callback bindings:\n");
458         printf("\t%-20s %-20s\n", "Variable Name", "Callback Name");
459         printf("\t%-20s %-20s\n", "-------------", "-------------");
460         env_attr_walk(ENV_CALLBACK_LIST_STATIC, print_static_binding);
461         puts("\n");
462
463         /* walk through each variable and print the callback if it has one */
464         puts("Active callback bindings:\n");
465         printf("\t%-20s %-20s\n", "Variable Name", "Callback Name");
466         printf("\t%-20s %-20s\n", "-------------", "-------------");
467         hwalk_r(&env_htab, print_active_callback);
468         return 0;
469 }
470 #endif
471
472 #if defined(CONFIG_CMD_ENV_FLAGS)
473 static int print_static_flags(const char *var_name, const char *flags)
474 {
475         enum env_flags_vartype type = env_flags_parse_vartype(flags);
476         enum env_flags_varaccess access = env_flags_parse_varaccess(flags);
477
478         printf("\t%-20s %-20s %-20s\n", var_name,
479                 env_flags_get_vartype_name(type),
480                 env_flags_get_varaccess_name(access));
481
482         return 0;
483 }
484
485 static int print_active_flags(ENTRY *entry)
486 {
487         enum env_flags_vartype type;
488         enum env_flags_varaccess access;
489
490         if (entry->flags == 0)
491                 return 0;
492
493         type = (enum env_flags_vartype)
494                 (entry->flags & ENV_FLAGS_VARTYPE_BIN_MASK);
495         access = env_flags_parse_varaccess_from_binflags(entry->flags);
496         printf("\t%-20s %-20s %-20s\n", entry->key,
497                 env_flags_get_vartype_name(type),
498                 env_flags_get_varaccess_name(access));
499
500         return 0;
501 }
502
503 /*
504  * Print the flags available and what variables have flags
505  */
506 int do_env_flags(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
507 {
508         /* Print the available variable types */
509         printf("Available variable type flags (position %d):\n",
510                 ENV_FLAGS_VARTYPE_LOC);
511         puts("\tFlag\tVariable Type Name\n");
512         puts("\t----\t------------------\n");
513         env_flags_print_vartypes();
514         puts("\n");
515
516         /* Print the available variable access types */
517         printf("Available variable access flags (position %d):\n",
518                 ENV_FLAGS_VARACCESS_LOC);
519         puts("\tFlag\tVariable Access Name\n");
520         puts("\t----\t--------------------\n");
521         env_flags_print_varaccess();
522         puts("\n");
523
524         /* Print the static flags that may exist */
525         puts("Static flags:\n");
526         printf("\t%-20s %-20s %-20s\n", "Variable Name", "Variable Type",
527                 "Variable Access");
528         printf("\t%-20s %-20s %-20s\n", "-------------", "-------------",
529                 "---------------");
530         env_attr_walk(ENV_FLAGS_LIST_STATIC, print_static_flags);
531         puts("\n");
532
533         /* walk through each variable and print the flags if non-default */
534         puts("Active flags:\n");
535         printf("\t%-20s %-20s %-20s\n", "Variable Name", "Variable Type",
536                 "Variable Access");
537         printf("\t%-20s %-20s %-20s\n", "-------------", "-------------",
538                 "---------------");
539         hwalk_r(&env_htab, print_active_flags);
540         return 0;
541 }
542 #endif
543
544 /*
545  * Interactively edit an environment variable
546  */
547 #if defined(CONFIG_CMD_EDITENV)
548 static int do_env_edit(cmd_tbl_t *cmdtp, int flag, int argc,
549                        char * const argv[])
550 {
551         char buffer[CONFIG_SYS_CBSIZE];
552         char *init_val;
553
554         if (argc < 2)
555                 return CMD_RET_USAGE;
556
557         /* Set read buffer to initial value or empty sting */
558         init_val = getenv(argv[1]);
559         if (init_val)
560                 sprintf(buffer, "%s", init_val);
561         else
562                 buffer[0] = '\0';
563
564         if (readline_into_buffer("edit: ", buffer, 0) < 0)
565                 return 1;
566
567         return setenv(argv[1], buffer);
568 }
569 #endif /* CONFIG_CMD_EDITENV */
570 #endif /* CONFIG_SPL_BUILD */
571
572 /*
573  * Look up variable from environment,
574  * return address of storage for that variable,
575  * or NULL if not found
576  */
577 char *getenv(const char *name)
578 {
579         if (gd->flags & GD_FLG_ENV_READY) { /* after import into hashtable */
580                 ENTRY e, *ep;
581
582                 WATCHDOG_RESET();
583
584                 e.key   = name;
585                 e.data  = NULL;
586                 hsearch_r(e, FIND, &ep, &env_htab, 0);
587
588                 return ep ? ep->data : NULL;
589         }
590
591         /* restricted capabilities before import */
592         if (getenv_f(name, (char *)(gd->env_buf), sizeof(gd->env_buf)) > 0)
593                 return (char *)(gd->env_buf);
594
595         return NULL;
596 }
597
598 /*
599  * Look up variable from environment for restricted C runtime env.
600  */
601 int getenv_f(const char *name, char *buf, unsigned len)
602 {
603         int i, nxt;
604
605         for (i = 0; env_get_char(i) != '\0'; i = nxt + 1) {
606                 int val, n;
607
608                 for (nxt = i; env_get_char(nxt) != '\0'; ++nxt) {
609                         if (nxt >= CONFIG_ENV_SIZE)
610                                 return -1;
611                 }
612
613                 val = envmatch((uchar *)name, i);
614                 if (val < 0)
615                         continue;
616
617                 /* found; copy out */
618                 for (n = 0; n < len; ++n, ++buf) {
619                         *buf = env_get_char(val++);
620                         if (*buf == '\0')
621                                 return n;
622                 }
623
624                 if (n)
625                         *--buf = '\0';
626
627                 printf("env_buf [%d bytes] too small for value of \"%s\"\n",
628                         len, name);
629
630                 return n;
631         }
632
633         return -1;
634 }
635
636 /**
637  * Decode the integer value of an environment variable and return it.
638  *
639  * @param name          Name of environemnt variable
640  * @param base          Number base to use (normally 10, or 16 for hex)
641  * @param default_val   Default value to return if the variable is not
642  *                      found
643  * @return the decoded value, or default_val if not found
644  */
645 ulong getenv_ulong(const char *name, int base, ulong default_val)
646 {
647         /*
648          * We can use getenv() here, even before relocation, since the
649          * environment variable value is an integer and thus short.
650          */
651         const char *str = getenv(name);
652
653         return str ? simple_strtoul(str, NULL, base) : default_val;
654 }
655
656 #ifndef CONFIG_SPL_BUILD
657 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
658 static int do_env_save(cmd_tbl_t *cmdtp, int flag, int argc,
659                        char * const argv[])
660 {
661         printf("Saving Environment to %s...\n", env_name_spec);
662
663         return saveenv() ? 1 : 0;
664 }
665
666 U_BOOT_CMD(
667         saveenv, 1, 0,  do_env_save,
668         "save environment variables to persistent storage",
669         ""
670 );
671 #endif
672 #endif /* CONFIG_SPL_BUILD */
673
674
675 /*
676  * Match a name / name=value pair
677  *
678  * s1 is either a simple 'name', or a 'name=value' pair.
679  * i2 is the environment index for a 'name2=value2' pair.
680  * If the names match, return the index for the value2, else -1.
681  */
682 int envmatch(uchar *s1, int i2)
683 {
684         if (s1 == NULL)
685                 return -1;
686
687         while (*s1 == env_get_char(i2++))
688                 if (*s1++ == '=')
689                         return i2;
690
691         if (*s1 == '\0' && env_get_char(i2-1) == '=')
692                 return i2;
693
694         return -1;
695 }
696
697 #ifndef CONFIG_SPL_BUILD
698 static int do_env_default(cmd_tbl_t *cmdtp, int __flag,
699                           int argc, char * const argv[])
700 {
701         int all = 0, flag = 0;
702
703         debug("Initial value for argc=%d\n", argc);
704         while (--argc > 0 && **++argv == '-') {
705                 char *arg = *argv;
706
707                 while (*++arg) {
708                         switch (*arg) {
709                         case 'a':               /* default all */
710                                 all = 1;
711                                 break;
712                         case 'f':               /* force */
713                                 flag |= H_FORCE;
714                                 break;
715                         default:
716                                 return cmd_usage(cmdtp);
717                         }
718                 }
719         }
720         debug("Final value for argc=%d\n", argc);
721         if (all && (argc == 0)) {
722                 /* Reset the whole environment */
723                 set_default_env("## Resetting to default environment\n");
724                 return 0;
725         }
726         if (!all && (argc > 0)) {
727                 /* Reset individual variables */
728                 set_default_vars(argc, argv);
729                 return 0;
730         }
731
732         return cmd_usage(cmdtp);
733 }
734
735 static int do_env_delete(cmd_tbl_t *cmdtp, int flag,
736                          int argc, char * const argv[])
737 {
738         int env_flag = H_INTERACTIVE;
739         int ret = 0;
740
741         debug("Initial value for argc=%d\n", argc);
742         while (argc > 1 && **(argv + 1) == '-') {
743                 char *arg = *++argv;
744
745                 --argc;
746                 while (*++arg) {
747                         switch (*arg) {
748                         case 'f':               /* force */
749                                 env_flag |= H_FORCE;
750                                 break;
751                         default:
752                                 return CMD_RET_USAGE;
753                         }
754                 }
755         }
756         debug("Final value for argc=%d\n", argc);
757
758         env_id++;
759
760         while (--argc > 0) {
761                 char *name = *++argv;
762
763                 if (!hdelete_r(name, &env_htab, env_flag))
764                         ret = 1;
765         }
766
767         return ret;
768 }
769
770 #ifdef CONFIG_CMD_EXPORTENV
771 /*
772  * env export [-t | -b | -c] [-s size] addr [var ...]
773  *      -t:     export as text format; if size is given, data will be
774  *              padded with '\0' bytes; if not, one terminating '\0'
775  *              will be added (which is included in the "filesize"
776  *              setting so you can for exmple copy this to flash and
777  *              keep the termination).
778  *      -b:     export as binary format (name=value pairs separated by
779  *              '\0', list end marked by double "\0\0")
780  *      -c:     export as checksum protected environment format as
781  *              used for example by "saveenv" command
782  *      -s size:
783  *              size of output buffer
784  *      addr:   memory address where environment gets stored
785  *      var...  List of variable names that get included into the
786  *              export. Without arguments, the whole environment gets
787  *              exported.
788  *
789  * With "-c" and size is NOT given, then the export command will
790  * format the data as currently used for the persistent storage,
791  * i. e. it will use CONFIG_ENV_SECT_SIZE as output block size and
792  * prepend a valid CRC32 checksum and, in case of resundant
793  * environment, a "current" redundancy flag. If size is given, this
794  * value will be used instead of CONFIG_ENV_SECT_SIZE; again, CRC32
795  * checksum and redundancy flag will be inserted.
796  *
797  * With "-b" and "-t", always only the real data (including a
798  * terminating '\0' byte) will be written; here the optional size
799  * argument will be used to make sure not to overflow the user
800  * provided buffer; the command will abort if the size is not
801  * sufficient. Any remainign space will be '\0' padded.
802  *
803  * On successful return, the variable "filesize" will be set.
804  * Note that filesize includes the trailing/terminating '\0' byte(s).
805  *
806  * Usage szenario:  create a text snapshot/backup of the current settings:
807  *
808  *      => env export -t 100000
809  *      => era ${backup_addr} +${filesize}
810  *      => cp.b 100000 ${backup_addr} ${filesize}
811  *
812  * Re-import this snapshot, deleting all other settings:
813  *
814  *      => env import -d -t ${backup_addr}
815  */
816 static int do_env_export(cmd_tbl_t *cmdtp, int flag,
817                          int argc, char * const argv[])
818 {
819         char    buf[32];
820         char    *addr, *cmd, *res;
821         size_t  size = 0;
822         ssize_t len;
823         env_t   *envp;
824         char    sep = '\n';
825         int     chk = 0;
826         int     fmt = 0;
827
828         cmd = *argv;
829
830         while (--argc > 0 && **++argv == '-') {
831                 char *arg = *argv;
832                 while (*++arg) {
833                         switch (*arg) {
834                         case 'b':               /* raw binary format */
835                                 if (fmt++)
836                                         goto sep_err;
837                                 sep = '\0';
838                                 break;
839                         case 'c':               /* external checksum format */
840                                 if (fmt++)
841                                         goto sep_err;
842                                 sep = '\0';
843                                 chk = 1;
844                                 break;
845                         case 's':               /* size given */
846                                 if (--argc <= 0)
847                                         return cmd_usage(cmdtp);
848                                 size = simple_strtoul(*++argv, NULL, 16);
849                                 goto NXTARG;
850                         case 't':               /* text format */
851                                 if (fmt++)
852                                         goto sep_err;
853                                 sep = '\n';
854                                 break;
855                         default:
856                                 return CMD_RET_USAGE;
857                         }
858                 }
859 NXTARG:         ;
860         }
861
862         if (argc < 1)
863                 return CMD_RET_USAGE;
864
865         addr = (char *)simple_strtoul(argv[0], NULL, 16);
866
867         if (size)
868                 memset(addr, '\0', size);
869
870         argc--;
871         argv++;
872
873         if (sep) {              /* export as text file */
874                 len = hexport_r(&env_htab, sep, 0, &addr, size, argc, argv);
875                 if (len < 0) {
876                         error("Cannot export environment: errno = %d\n", errno);
877                         return 1;
878                 }
879                 sprintf(buf, "%zX", (size_t)len);
880                 setenv("filesize", buf);
881
882                 return 0;
883         }
884
885         envp = (env_t *)addr;
886
887         if (chk)                /* export as checksum protected block */
888                 res = (char *)envp->data;
889         else                    /* export as raw binary data */
890                 res = addr;
891
892         len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, argc, argv);
893         if (len < 0) {
894                 error("Cannot export environment: errno = %d\n", errno);
895                 return 1;
896         }
897
898         if (chk) {
899                 envp->crc = crc32(0, envp->data, ENV_SIZE);
900 #ifdef CONFIG_ENV_ADDR_REDUND
901                 envp->flags = ACTIVE_FLAG;
902 #endif
903         }
904         setenv_hex("filesize", len + offsetof(env_t, data));
905
906         return 0;
907
908 sep_err:
909         printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n", cmd);
910         return 1;
911 }
912 #endif
913
914 #ifdef CONFIG_CMD_IMPORTENV
915 /*
916  * env import [-d] [-t | -b | -c] addr [size]
917  *      -d:     delete existing environment before importing;
918  *              otherwise overwrite / append to existion definitions
919  *      -t:     assume text format; either "size" must be given or the
920  *              text data must be '\0' terminated
921  *      -b:     assume binary format ('\0' separated, "\0\0" terminated)
922  *      -c:     assume checksum protected environment format
923  *      addr:   memory address to read from
924  *      size:   length of input data; if missing, proper '\0'
925  *              termination is mandatory
926  */
927 static int do_env_import(cmd_tbl_t *cmdtp, int flag,
928                          int argc, char * const argv[])
929 {
930         char    *cmd, *addr;
931         char    sep = '\n';
932         int     chk = 0;
933         int     fmt = 0;
934         int     del = 0;
935         size_t  size;
936
937         cmd = *argv;
938
939         while (--argc > 0 && **++argv == '-') {
940                 char *arg = *argv;
941                 while (*++arg) {
942                         switch (*arg) {
943                         case 'b':               /* raw binary format */
944                                 if (fmt++)
945                                         goto sep_err;
946                                 sep = '\0';
947                                 break;
948                         case 'c':               /* external checksum format */
949                                 if (fmt++)
950                                         goto sep_err;
951                                 sep = '\0';
952                                 chk = 1;
953                                 break;
954                         case 't':               /* text format */
955                                 if (fmt++)
956                                         goto sep_err;
957                                 sep = '\n';
958                                 break;
959                         case 'd':
960                                 del = 1;
961                                 break;
962                         default:
963                                 return CMD_RET_USAGE;
964                         }
965                 }
966         }
967
968         if (argc < 1)
969                 return CMD_RET_USAGE;
970
971         if (!fmt)
972                 printf("## Warning: defaulting to text format\n");
973
974         addr = (char *)simple_strtoul(argv[0], NULL, 16);
975
976         if (argc == 2) {
977                 size = simple_strtoul(argv[1], NULL, 16);
978         } else {
979                 char *s = addr;
980
981                 size = 0;
982
983                 while (size < MAX_ENV_SIZE) {
984                         if ((*s == sep) && (*(s+1) == '\0'))
985                                 break;
986                         ++s;
987                         ++size;
988                 }
989                 if (size == MAX_ENV_SIZE) {
990                         printf("## Warning: Input data exceeds %d bytes"
991                                 " - truncated\n", MAX_ENV_SIZE);
992                 }
993                 size += 2;
994                 printf("## Info: input data size = %zu = 0x%zX\n", size, size);
995         }
996
997         if (chk) {
998                 uint32_t crc;
999                 env_t *ep = (env_t *)addr;
1000
1001                 size -= offsetof(env_t, data);
1002                 memcpy(&crc, &ep->crc, sizeof(crc));
1003
1004                 if (crc32(0, ep->data, size) != crc) {
1005                         puts("## Error: bad CRC, import failed\n");
1006                         return 1;
1007                 }
1008                 addr = (char *)ep->data;
1009         }
1010
1011         if (himport_r(&env_htab, addr, size, sep, del ? 0 : H_NOCLEAR,
1012                         0, NULL) == 0) {
1013                 error("Environment import failed: errno = %d\n", errno);
1014                 return 1;
1015         }
1016         gd->flags |= GD_FLG_ENV_READY;
1017
1018         return 0;
1019
1020 sep_err:
1021         printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n",
1022                 cmd);
1023         return 1;
1024 }
1025 #endif
1026
1027 /*
1028  * New command line interface: "env" command with subcommands
1029  */
1030 static cmd_tbl_t cmd_env_sub[] = {
1031 #if defined(CONFIG_CMD_ASKENV)
1032         U_BOOT_CMD_MKENT(ask, CONFIG_SYS_MAXARGS, 1, do_env_ask, "", ""),
1033 #endif
1034         U_BOOT_CMD_MKENT(default, 1, 0, do_env_default, "", ""),
1035         U_BOOT_CMD_MKENT(delete, CONFIG_SYS_MAXARGS, 0, do_env_delete, "", ""),
1036 #if defined(CONFIG_CMD_EDITENV)
1037         U_BOOT_CMD_MKENT(edit, 2, 0, do_env_edit, "", ""),
1038 #endif
1039 #if defined(CONFIG_CMD_ENV_CALLBACK)
1040         U_BOOT_CMD_MKENT(callbacks, 1, 0, do_env_callback, "", ""),
1041 #endif
1042 #if defined(CONFIG_CMD_ENV_FLAGS)
1043         U_BOOT_CMD_MKENT(flags, 1, 0, do_env_flags, "", ""),
1044 #endif
1045 #if defined(CONFIG_CMD_EXPORTENV)
1046         U_BOOT_CMD_MKENT(export, 4, 0, do_env_export, "", ""),
1047 #endif
1048 #if defined(CONFIG_CMD_GREPENV)
1049         U_BOOT_CMD_MKENT(grep, CONFIG_SYS_MAXARGS, 1, do_env_grep, "", ""),
1050 #endif
1051 #if defined(CONFIG_CMD_IMPORTENV)
1052         U_BOOT_CMD_MKENT(import, 5, 0, do_env_import, "", ""),
1053 #endif
1054         U_BOOT_CMD_MKENT(print, CONFIG_SYS_MAXARGS, 1, do_env_print, "", ""),
1055 #if defined(CONFIG_CMD_RUN)
1056         U_BOOT_CMD_MKENT(run, CONFIG_SYS_MAXARGS, 1, do_run, "", ""),
1057 #endif
1058 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
1059         U_BOOT_CMD_MKENT(save, 1, 0, do_env_save, "", ""),
1060 #endif
1061         U_BOOT_CMD_MKENT(set, CONFIG_SYS_MAXARGS, 0, do_env_set, "", ""),
1062 };
1063
1064 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
1065 void env_reloc(void)
1066 {
1067         fixup_cmdtable(cmd_env_sub, ARRAY_SIZE(cmd_env_sub));
1068 }
1069 #endif
1070
1071 static int do_env(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1072 {
1073         cmd_tbl_t *cp;
1074
1075         if (argc < 2)
1076                 return CMD_RET_USAGE;
1077
1078         /* drop initial "env" arg */
1079         argc--;
1080         argv++;
1081
1082         cp = find_cmd_tbl(argv[0], cmd_env_sub, ARRAY_SIZE(cmd_env_sub));
1083
1084         if (cp)
1085                 return cp->cmd(cmdtp, flag, argc, argv);
1086
1087         return CMD_RET_USAGE;
1088 }
1089
1090 #ifdef CONFIG_SYS_LONGHELP
1091 static char env_help_text[] =
1092 #if defined(CONFIG_CMD_ASKENV)
1093         "ask name [message] [size] - ask for environment variable\nenv "
1094 #endif
1095 #if defined(CONFIG_CMD_ENV_CALLBACK)
1096         "callbacks - print callbacks and their associated variables\nenv "
1097 #endif
1098         "default [-f] -a - [forcibly] reset default environment\n"
1099         "env default [-f] var [...] - [forcibly] reset variable(s) to their default values\n"
1100         "env delete [-f] var [...] - [forcibly] delete variable(s)\n"
1101 #if defined(CONFIG_CMD_EDITENV)
1102         "env edit name - edit environment variable\n"
1103 #endif
1104 #if defined(CONFIG_CMD_EXPORTENV)
1105         "env export [-t | -b | -c] [-s size] addr [var ...] - export environment\n"
1106 #endif
1107 #if defined(CONFIG_CMD_ENV_FLAGS)
1108         "env flags - print variables that have non-default flags\n"
1109 #endif
1110 #if defined(CONFIG_CMD_GREPENV)
1111         "env grep string [...] - search environment\n"
1112 #endif
1113 #if defined(CONFIG_CMD_IMPORTENV)
1114         "env import [-d] [-t | -b | -c] addr [size] - import environment\n"
1115 #endif
1116         "env print [-a | name ...] - print environment\n"
1117 #if defined(CONFIG_CMD_RUN)
1118         "env run var [...] - run commands in an environment variable\n"
1119 #endif
1120 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
1121         "env save - save environment\n"
1122 #endif
1123         "env set [-f] name [arg ...]\n";
1124 #endif
1125
1126 U_BOOT_CMD(
1127         env, CONFIG_SYS_MAXARGS, 1, do_env,
1128         "environment handling commands", env_help_text
1129 );
1130
1131 /*
1132  * Old command line interface, kept for compatibility
1133  */
1134
1135 #if defined(CONFIG_CMD_EDITENV)
1136 U_BOOT_CMD_COMPLETE(
1137         editenv, 2, 0,  do_env_edit,
1138         "edit environment variable",
1139         "name\n"
1140         "    - edit environment variable 'name'",
1141         var_complete
1142 );
1143 #endif
1144
1145 U_BOOT_CMD_COMPLETE(
1146         printenv, CONFIG_SYS_MAXARGS, 1,        do_env_print,
1147         "print environment variables",
1148         "[-a]\n    - print [all] values of all environment variables\n"
1149         "printenv name ...\n"
1150         "    - print value of environment variable 'name'",
1151         var_complete
1152 );
1153
1154 #ifdef CONFIG_CMD_GREPENV
1155 U_BOOT_CMD_COMPLETE(
1156         grepenv, CONFIG_SYS_MAXARGS, 0,  do_env_grep,
1157         "search environment variables",
1158         "string ...\n"
1159         "    - list environment name=value pairs matching 'string'",
1160         var_complete
1161 );
1162 #endif
1163
1164 U_BOOT_CMD_COMPLETE(
1165         setenv, CONFIG_SYS_MAXARGS, 0,  do_env_set,
1166         "set environment variables",
1167         "[-f] name value ...\n"
1168         "    - [forcibly] set environment variable 'name' to 'value ...'\n"
1169         "setenv [-f] name\n"
1170         "    - [forcibly] delete environment variable 'name'",
1171         var_complete
1172 );
1173
1174 #if defined(CONFIG_CMD_ASKENV)
1175
1176 U_BOOT_CMD(
1177         askenv, CONFIG_SYS_MAXARGS,     1,      do_env_ask,
1178         "get environment variables from stdin",
1179         "name [message] [size]\n"
1180         "    - get environment variable 'name' from stdin (max 'size' chars)"
1181 );
1182 #endif
1183
1184 #if defined(CONFIG_CMD_RUN)
1185 U_BOOT_CMD_COMPLETE(
1186         run,    CONFIG_SYS_MAXARGS,     1,      do_run,
1187         "run commands in an environment variable",
1188         "var [...]\n"
1189         "    - run the commands in the environment variable(s) 'var'",
1190         var_complete
1191 );
1192 #endif
1193 #endif /* CONFIG_SPL_BUILD */