mtd: Make mtdparts work with pre-reloc env
[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         /* before import into hashtable */
277         if (!(gd->flags & GD_FLG_ENV_READY))
278                 return 1;
279
280         if (varvalue == NULL || varvalue[0] == '\0')
281                 return _do_env_set(0, 2, (char * const *)argv);
282         else
283                 return _do_env_set(0, 3, (char * const *)argv);
284 }
285
286 /**
287  * Set an environment variable to an integer value
288  *
289  * @param varname       Environmet variable to set
290  * @param value         Value to set it to
291  * @return 0 if ok, 1 on error
292  */
293 int setenv_ulong(const char *varname, ulong value)
294 {
295         /* TODO: this should be unsigned */
296         char *str = simple_itoa(value);
297
298         return setenv(varname, str);
299 }
300
301 /**
302  * Set an environment variable to an value in hex
303  *
304  * @param varname       Environmet variable to set
305  * @param value         Value to set it to
306  * @return 0 if ok, 1 on error
307  */
308 int setenv_hex(const char *varname, ulong value)
309 {
310         char str[17];
311
312         sprintf(str, "%lx", value);
313         return setenv(varname, str);
314 }
315
316 #ifndef CONFIG_SPL_BUILD
317 static int do_env_set(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
318 {
319         if (argc < 2)
320                 return CMD_RET_USAGE;
321
322         return _do_env_set(flag, argc, argv);
323 }
324
325 /*
326  * Prompt for environment variable
327  */
328 #if defined(CONFIG_CMD_ASKENV)
329 int do_env_ask(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
330 {
331         char message[CONFIG_SYS_CBSIZE];
332         int i, len, pos, size;
333         char *local_args[4];
334         char *endptr;
335
336         local_args[0] = argv[0];
337         local_args[1] = argv[1];
338         local_args[2] = NULL;
339         local_args[3] = NULL;
340
341         /*
342          * Check the syntax:
343          *
344          * env_ask envname [message1 ...] [size]
345          */
346         if (argc == 1)
347                 return CMD_RET_USAGE;
348
349         /*
350          * We test the last argument if it can be converted
351          * into a decimal number.  If yes, we assume it's
352          * the size.  Otherwise we echo it as part of the
353          * message.
354          */
355         i = simple_strtoul(argv[argc - 1], &endptr, 10);
356         if (*endptr != '\0') {                  /* no size */
357                 size = CONFIG_SYS_CBSIZE - 1;
358         } else {                                /* size given */
359                 size = i;
360                 --argc;
361         }
362
363         if (argc <= 2) {
364                 sprintf(message, "Please enter '%s': ", argv[1]);
365         } else {
366                 /* env_ask envname message1 ... messagen [size] */
367                 for (i = 2, pos = 0; i < argc; i++) {
368                         if (pos)
369                                 message[pos++] = ' ';
370
371                         strcpy(message + pos, argv[i]);
372                         pos += strlen(argv[i]);
373                 }
374                 message[pos++] = ' ';
375                 message[pos] = '\0';
376         }
377
378         if (size >= CONFIG_SYS_CBSIZE)
379                 size = CONFIG_SYS_CBSIZE - 1;
380
381         if (size <= 0)
382                 return 1;
383
384         /* prompt for input */
385         len = readline(message);
386
387         if (size < len)
388                 console_buffer[size] = '\0';
389
390         len = 2;
391         if (console_buffer[0] != '\0') {
392                 local_args[2] = console_buffer;
393                 len = 3;
394         }
395
396         /* Continue calling setenv code */
397         return _do_env_set(flag, len, local_args);
398 }
399 #endif
400
401 #if defined(CONFIG_CMD_ENV_CALLBACK)
402 static int print_static_binding(const char *var_name, const char *callback_name)
403 {
404         printf("\t%-20s %-20s\n", var_name, callback_name);
405
406         return 0;
407 }
408
409 static int print_active_callback(ENTRY *entry)
410 {
411         struct env_clbk_tbl *clbkp;
412         int i;
413         int num_callbacks;
414
415         if (entry->callback == NULL)
416                 return 0;
417
418         /* look up the callback in the linker-list */
419         num_callbacks = ll_entry_count(struct env_clbk_tbl, env_clbk);
420         for (i = 0, clbkp = ll_entry_start(struct env_clbk_tbl, env_clbk);
421              i < num_callbacks;
422              i++, clbkp++) {
423 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
424                 if (entry->callback == clbkp->callback + gd->reloc_off)
425 #else
426                 if (entry->callback == clbkp->callback)
427 #endif
428                         break;
429         }
430
431         if (i == num_callbacks)
432                 /* this should probably never happen, but just in case... */
433                 printf("\t%-20s %p\n", entry->key, entry->callback);
434         else
435                 printf("\t%-20s %-20s\n", entry->key, clbkp->name);
436
437         return 0;
438 }
439
440 /*
441  * Print the callbacks available and what they are bound to
442  */
443 int do_env_callback(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
444 {
445         struct env_clbk_tbl *clbkp;
446         int i;
447         int num_callbacks;
448
449         /* Print the available callbacks */
450         puts("Available callbacks:\n");
451         puts("\tCallback Name\n");
452         puts("\t-------------\n");
453         num_callbacks = ll_entry_count(struct env_clbk_tbl, env_clbk);
454         for (i = 0, clbkp = ll_entry_start(struct env_clbk_tbl, env_clbk);
455              i < num_callbacks;
456              i++, clbkp++)
457                 printf("\t%s\n", clbkp->name);
458         puts("\n");
459
460         /* Print the static bindings that may exist */
461         puts("Static callback bindings:\n");
462         printf("\t%-20s %-20s\n", "Variable Name", "Callback Name");
463         printf("\t%-20s %-20s\n", "-------------", "-------------");
464         env_attr_walk(ENV_CALLBACK_LIST_STATIC, print_static_binding);
465         puts("\n");
466
467         /* walk through each variable and print the callback if it has one */
468         puts("Active callback bindings:\n");
469         printf("\t%-20s %-20s\n", "Variable Name", "Callback Name");
470         printf("\t%-20s %-20s\n", "-------------", "-------------");
471         hwalk_r(&env_htab, print_active_callback);
472         return 0;
473 }
474 #endif
475
476 #if defined(CONFIG_CMD_ENV_FLAGS)
477 static int print_static_flags(const char *var_name, const char *flags)
478 {
479         enum env_flags_vartype type = env_flags_parse_vartype(flags);
480         enum env_flags_varaccess access = env_flags_parse_varaccess(flags);
481
482         printf("\t%-20s %-20s %-20s\n", var_name,
483                 env_flags_get_vartype_name(type),
484                 env_flags_get_varaccess_name(access));
485
486         return 0;
487 }
488
489 static int print_active_flags(ENTRY *entry)
490 {
491         enum env_flags_vartype type;
492         enum env_flags_varaccess access;
493
494         if (entry->flags == 0)
495                 return 0;
496
497         type = (enum env_flags_vartype)
498                 (entry->flags & ENV_FLAGS_VARTYPE_BIN_MASK);
499         access = env_flags_parse_varaccess_from_binflags(entry->flags);
500         printf("\t%-20s %-20s %-20s\n", entry->key,
501                 env_flags_get_vartype_name(type),
502                 env_flags_get_varaccess_name(access));
503
504         return 0;
505 }
506
507 /*
508  * Print the flags available and what variables have flags
509  */
510 int do_env_flags(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
511 {
512         /* Print the available variable types */
513         printf("Available variable type flags (position %d):\n",
514                 ENV_FLAGS_VARTYPE_LOC);
515         puts("\tFlag\tVariable Type Name\n");
516         puts("\t----\t------------------\n");
517         env_flags_print_vartypes();
518         puts("\n");
519
520         /* Print the available variable access types */
521         printf("Available variable access flags (position %d):\n",
522                 ENV_FLAGS_VARACCESS_LOC);
523         puts("\tFlag\tVariable Access Name\n");
524         puts("\t----\t--------------------\n");
525         env_flags_print_varaccess();
526         puts("\n");
527
528         /* Print the static flags that may exist */
529         puts("Static flags:\n");
530         printf("\t%-20s %-20s %-20s\n", "Variable Name", "Variable Type",
531                 "Variable Access");
532         printf("\t%-20s %-20s %-20s\n", "-------------", "-------------",
533                 "---------------");
534         env_attr_walk(ENV_FLAGS_LIST_STATIC, print_static_flags);
535         puts("\n");
536
537         /* walk through each variable and print the flags if non-default */
538         puts("Active flags:\n");
539         printf("\t%-20s %-20s %-20s\n", "Variable Name", "Variable Type",
540                 "Variable Access");
541         printf("\t%-20s %-20s %-20s\n", "-------------", "-------------",
542                 "---------------");
543         hwalk_r(&env_htab, print_active_flags);
544         return 0;
545 }
546 #endif
547
548 /*
549  * Interactively edit an environment variable
550  */
551 #if defined(CONFIG_CMD_EDITENV)
552 static int do_env_edit(cmd_tbl_t *cmdtp, int flag, int argc,
553                        char * const argv[])
554 {
555         char buffer[CONFIG_SYS_CBSIZE];
556         char *init_val;
557
558         if (argc < 2)
559                 return CMD_RET_USAGE;
560
561         /* Set read buffer to initial value or empty sting */
562         init_val = getenv(argv[1]);
563         if (init_val)
564                 sprintf(buffer, "%s", init_val);
565         else
566                 buffer[0] = '\0';
567
568         if (readline_into_buffer("edit: ", buffer, 0) < 0)
569                 return 1;
570
571         return setenv(argv[1], buffer);
572 }
573 #endif /* CONFIG_CMD_EDITENV */
574 #endif /* CONFIG_SPL_BUILD */
575
576 /*
577  * Look up variable from environment,
578  * return address of storage for that variable,
579  * or NULL if not found
580  */
581 char *getenv(const char *name)
582 {
583         if (gd->flags & GD_FLG_ENV_READY) { /* after import into hashtable */
584                 ENTRY e, *ep;
585
586                 WATCHDOG_RESET();
587
588                 e.key   = name;
589                 e.data  = NULL;
590                 hsearch_r(e, FIND, &ep, &env_htab, 0);
591
592                 return ep ? ep->data : NULL;
593         }
594
595         /* restricted capabilities before import */
596         if (getenv_f(name, (char *)(gd->env_buf), sizeof(gd->env_buf)) > 0)
597                 return (char *)(gd->env_buf);
598
599         return NULL;
600 }
601
602 /*
603  * Look up variable from environment for restricted C runtime env.
604  */
605 int getenv_f(const char *name, char *buf, unsigned len)
606 {
607         int i, nxt;
608
609         for (i = 0; env_get_char(i) != '\0'; i = nxt + 1) {
610                 int val, n;
611
612                 for (nxt = i; env_get_char(nxt) != '\0'; ++nxt) {
613                         if (nxt >= CONFIG_ENV_SIZE)
614                                 return -1;
615                 }
616
617                 val = envmatch((uchar *)name, i);
618                 if (val < 0)
619                         continue;
620
621                 /* found; copy out */
622                 for (n = 0; n < len; ++n, ++buf) {
623                         *buf = env_get_char(val++);
624                         if (*buf == '\0')
625                                 return n;
626                 }
627
628                 if (n)
629                         *--buf = '\0';
630
631                 printf("env_buf [%d bytes] too small for value of \"%s\"\n",
632                         len, name);
633
634                 return n;
635         }
636
637         return -1;
638 }
639
640 /**
641  * Decode the integer value of an environment variable and return it.
642  *
643  * @param name          Name of environemnt variable
644  * @param base          Number base to use (normally 10, or 16 for hex)
645  * @param default_val   Default value to return if the variable is not
646  *                      found
647  * @return the decoded value, or default_val if not found
648  */
649 ulong getenv_ulong(const char *name, int base, ulong default_val)
650 {
651         /*
652          * We can use getenv() here, even before relocation, since the
653          * environment variable value is an integer and thus short.
654          */
655         const char *str = getenv(name);
656
657         return str ? simple_strtoul(str, NULL, base) : default_val;
658 }
659
660 #ifndef CONFIG_SPL_BUILD
661 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
662 static int do_env_save(cmd_tbl_t *cmdtp, int flag, int argc,
663                        char * const argv[])
664 {
665         printf("Saving Environment to %s...\n", env_name_spec);
666
667         return saveenv() ? 1 : 0;
668 }
669
670 U_BOOT_CMD(
671         saveenv, 1, 0,  do_env_save,
672         "save environment variables to persistent storage",
673         ""
674 );
675 #endif
676 #endif /* CONFIG_SPL_BUILD */
677
678
679 /*
680  * Match a name / name=value pair
681  *
682  * s1 is either a simple 'name', or a 'name=value' pair.
683  * i2 is the environment index for a 'name2=value2' pair.
684  * If the names match, return the index for the value2, else -1.
685  */
686 int envmatch(uchar *s1, int i2)
687 {
688         if (s1 == NULL)
689                 return -1;
690
691         while (*s1 == env_get_char(i2++))
692                 if (*s1++ == '=')
693                         return i2;
694
695         if (*s1 == '\0' && env_get_char(i2-1) == '=')
696                 return i2;
697
698         return -1;
699 }
700
701 #ifndef CONFIG_SPL_BUILD
702 static int do_env_default(cmd_tbl_t *cmdtp, int __flag,
703                           int argc, char * const argv[])
704 {
705         int all = 0, flag = 0;
706
707         debug("Initial value for argc=%d\n", argc);
708         while (--argc > 0 && **++argv == '-') {
709                 char *arg = *argv;
710
711                 while (*++arg) {
712                         switch (*arg) {
713                         case 'a':               /* default all */
714                                 all = 1;
715                                 break;
716                         case 'f':               /* force */
717                                 flag |= H_FORCE;
718                                 break;
719                         default:
720                                 return cmd_usage(cmdtp);
721                         }
722                 }
723         }
724         debug("Final value for argc=%d\n", argc);
725         if (all && (argc == 0)) {
726                 /* Reset the whole environment */
727                 set_default_env("## Resetting to default environment\n");
728                 return 0;
729         }
730         if (!all && (argc > 0)) {
731                 /* Reset individual variables */
732                 set_default_vars(argc, argv);
733                 return 0;
734         }
735
736         return cmd_usage(cmdtp);
737 }
738
739 static int do_env_delete(cmd_tbl_t *cmdtp, int flag,
740                          int argc, char * const argv[])
741 {
742         int env_flag = H_INTERACTIVE;
743         int ret = 0;
744
745         debug("Initial value for argc=%d\n", argc);
746         while (argc > 1 && **(argv + 1) == '-') {
747                 char *arg = *++argv;
748
749                 --argc;
750                 while (*++arg) {
751                         switch (*arg) {
752                         case 'f':               /* force */
753                                 env_flag |= H_FORCE;
754                                 break;
755                         default:
756                                 return CMD_RET_USAGE;
757                         }
758                 }
759         }
760         debug("Final value for argc=%d\n", argc);
761
762         env_id++;
763
764         while (--argc > 0) {
765                 char *name = *++argv;
766
767                 if (!hdelete_r(name, &env_htab, env_flag))
768                         ret = 1;
769         }
770
771         return ret;
772 }
773
774 #ifdef CONFIG_CMD_EXPORTENV
775 /*
776  * env export [-t | -b | -c] [-s size] addr [var ...]
777  *      -t:     export as text format; if size is given, data will be
778  *              padded with '\0' bytes; if not, one terminating '\0'
779  *              will be added (which is included in the "filesize"
780  *              setting so you can for exmple copy this to flash and
781  *              keep the termination).
782  *      -b:     export as binary format (name=value pairs separated by
783  *              '\0', list end marked by double "\0\0")
784  *      -c:     export as checksum protected environment format as
785  *              used for example by "saveenv" command
786  *      -s size:
787  *              size of output buffer
788  *      addr:   memory address where environment gets stored
789  *      var...  List of variable names that get included into the
790  *              export. Without arguments, the whole environment gets
791  *              exported.
792  *
793  * With "-c" and size is NOT given, then the export command will
794  * format the data as currently used for the persistent storage,
795  * i. e. it will use CONFIG_ENV_SECT_SIZE as output block size and
796  * prepend a valid CRC32 checksum and, in case of resundant
797  * environment, a "current" redundancy flag. If size is given, this
798  * value will be used instead of CONFIG_ENV_SECT_SIZE; again, CRC32
799  * checksum and redundancy flag will be inserted.
800  *
801  * With "-b" and "-t", always only the real data (including a
802  * terminating '\0' byte) will be written; here the optional size
803  * argument will be used to make sure not to overflow the user
804  * provided buffer; the command will abort if the size is not
805  * sufficient. Any remainign space will be '\0' padded.
806  *
807  * On successful return, the variable "filesize" will be set.
808  * Note that filesize includes the trailing/terminating '\0' byte(s).
809  *
810  * Usage szenario:  create a text snapshot/backup of the current settings:
811  *
812  *      => env export -t 100000
813  *      => era ${backup_addr} +${filesize}
814  *      => cp.b 100000 ${backup_addr} ${filesize}
815  *
816  * Re-import this snapshot, deleting all other settings:
817  *
818  *      => env import -d -t ${backup_addr}
819  */
820 static int do_env_export(cmd_tbl_t *cmdtp, int flag,
821                          int argc, char * const argv[])
822 {
823         char    buf[32];
824         char    *addr, *cmd, *res;
825         size_t  size = 0;
826         ssize_t len;
827         env_t   *envp;
828         char    sep = '\n';
829         int     chk = 0;
830         int     fmt = 0;
831
832         cmd = *argv;
833
834         while (--argc > 0 && **++argv == '-') {
835                 char *arg = *argv;
836                 while (*++arg) {
837                         switch (*arg) {
838                         case 'b':               /* raw binary format */
839                                 if (fmt++)
840                                         goto sep_err;
841                                 sep = '\0';
842                                 break;
843                         case 'c':               /* external checksum format */
844                                 if (fmt++)
845                                         goto sep_err;
846                                 sep = '\0';
847                                 chk = 1;
848                                 break;
849                         case 's':               /* size given */
850                                 if (--argc <= 0)
851                                         return cmd_usage(cmdtp);
852                                 size = simple_strtoul(*++argv, NULL, 16);
853                                 goto NXTARG;
854                         case 't':               /* text format */
855                                 if (fmt++)
856                                         goto sep_err;
857                                 sep = '\n';
858                                 break;
859                         default:
860                                 return CMD_RET_USAGE;
861                         }
862                 }
863 NXTARG:         ;
864         }
865
866         if (argc < 1)
867                 return CMD_RET_USAGE;
868
869         addr = (char *)simple_strtoul(argv[0], NULL, 16);
870
871         if (size)
872                 memset(addr, '\0', size);
873
874         argc--;
875         argv++;
876
877         if (sep) {              /* export as text file */
878                 len = hexport_r(&env_htab, sep, 0, &addr, size, argc, argv);
879                 if (len < 0) {
880                         error("Cannot export environment: errno = %d\n", errno);
881                         return 1;
882                 }
883                 sprintf(buf, "%zX", (size_t)len);
884                 setenv("filesize", buf);
885
886                 return 0;
887         }
888
889         envp = (env_t *)addr;
890
891         if (chk)                /* export as checksum protected block */
892                 res = (char *)envp->data;
893         else                    /* export as raw binary data */
894                 res = addr;
895
896         len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, argc, argv);
897         if (len < 0) {
898                 error("Cannot export environment: errno = %d\n", errno);
899                 return 1;
900         }
901
902         if (chk) {
903                 envp->crc = crc32(0, envp->data, ENV_SIZE);
904 #ifdef CONFIG_ENV_ADDR_REDUND
905                 envp->flags = ACTIVE_FLAG;
906 #endif
907         }
908         setenv_hex("filesize", len + offsetof(env_t, data));
909
910         return 0;
911
912 sep_err:
913         printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n", cmd);
914         return 1;
915 }
916 #endif
917
918 #ifdef CONFIG_CMD_IMPORTENV
919 /*
920  * env import [-d] [-t | -b | -c] addr [size]
921  *      -d:     delete existing environment before importing;
922  *              otherwise overwrite / append to existion definitions
923  *      -t:     assume text format; either "size" must be given or the
924  *              text data must be '\0' terminated
925  *      -b:     assume binary format ('\0' separated, "\0\0" terminated)
926  *      -c:     assume checksum protected environment format
927  *      addr:   memory address to read from
928  *      size:   length of input data; if missing, proper '\0'
929  *              termination is mandatory
930  */
931 static int do_env_import(cmd_tbl_t *cmdtp, int flag,
932                          int argc, char * const argv[])
933 {
934         char    *cmd, *addr;
935         char    sep = '\n';
936         int     chk = 0;
937         int     fmt = 0;
938         int     del = 0;
939         size_t  size;
940
941         cmd = *argv;
942
943         while (--argc > 0 && **++argv == '-') {
944                 char *arg = *argv;
945                 while (*++arg) {
946                         switch (*arg) {
947                         case 'b':               /* raw binary format */
948                                 if (fmt++)
949                                         goto sep_err;
950                                 sep = '\0';
951                                 break;
952                         case 'c':               /* external checksum format */
953                                 if (fmt++)
954                                         goto sep_err;
955                                 sep = '\0';
956                                 chk = 1;
957                                 break;
958                         case 't':               /* text format */
959                                 if (fmt++)
960                                         goto sep_err;
961                                 sep = '\n';
962                                 break;
963                         case 'd':
964                                 del = 1;
965                                 break;
966                         default:
967                                 return CMD_RET_USAGE;
968                         }
969                 }
970         }
971
972         if (argc < 1)
973                 return CMD_RET_USAGE;
974
975         if (!fmt)
976                 printf("## Warning: defaulting to text format\n");
977
978         addr = (char *)simple_strtoul(argv[0], NULL, 16);
979
980         if (argc == 2) {
981                 size = simple_strtoul(argv[1], NULL, 16);
982         } else {
983                 char *s = addr;
984
985                 size = 0;
986
987                 while (size < MAX_ENV_SIZE) {
988                         if ((*s == sep) && (*(s+1) == '\0'))
989                                 break;
990                         ++s;
991                         ++size;
992                 }
993                 if (size == MAX_ENV_SIZE) {
994                         printf("## Warning: Input data exceeds %d bytes"
995                                 " - truncated\n", MAX_ENV_SIZE);
996                 }
997                 size += 2;
998                 printf("## Info: input data size = %zu = 0x%zX\n", size, size);
999         }
1000
1001         if (chk) {
1002                 uint32_t crc;
1003                 env_t *ep = (env_t *)addr;
1004
1005                 size -= offsetof(env_t, data);
1006                 memcpy(&crc, &ep->crc, sizeof(crc));
1007
1008                 if (crc32(0, ep->data, size) != crc) {
1009                         puts("## Error: bad CRC, import failed\n");
1010                         return 1;
1011                 }
1012                 addr = (char *)ep->data;
1013         }
1014
1015         if (himport_r(&env_htab, addr, size, sep, del ? 0 : H_NOCLEAR,
1016                         0, NULL) == 0) {
1017                 error("Environment import failed: errno = %d\n", errno);
1018                 return 1;
1019         }
1020         gd->flags |= GD_FLG_ENV_READY;
1021
1022         return 0;
1023
1024 sep_err:
1025         printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n",
1026                 cmd);
1027         return 1;
1028 }
1029 #endif
1030
1031 /*
1032  * New command line interface: "env" command with subcommands
1033  */
1034 static cmd_tbl_t cmd_env_sub[] = {
1035 #if defined(CONFIG_CMD_ASKENV)
1036         U_BOOT_CMD_MKENT(ask, CONFIG_SYS_MAXARGS, 1, do_env_ask, "", ""),
1037 #endif
1038         U_BOOT_CMD_MKENT(default, 1, 0, do_env_default, "", ""),
1039         U_BOOT_CMD_MKENT(delete, CONFIG_SYS_MAXARGS, 0, do_env_delete, "", ""),
1040 #if defined(CONFIG_CMD_EDITENV)
1041         U_BOOT_CMD_MKENT(edit, 2, 0, do_env_edit, "", ""),
1042 #endif
1043 #if defined(CONFIG_CMD_ENV_CALLBACK)
1044         U_BOOT_CMD_MKENT(callbacks, 1, 0, do_env_callback, "", ""),
1045 #endif
1046 #if defined(CONFIG_CMD_ENV_FLAGS)
1047         U_BOOT_CMD_MKENT(flags, 1, 0, do_env_flags, "", ""),
1048 #endif
1049 #if defined(CONFIG_CMD_EXPORTENV)
1050         U_BOOT_CMD_MKENT(export, 4, 0, do_env_export, "", ""),
1051 #endif
1052 #if defined(CONFIG_CMD_GREPENV)
1053         U_BOOT_CMD_MKENT(grep, CONFIG_SYS_MAXARGS, 1, do_env_grep, "", ""),
1054 #endif
1055 #if defined(CONFIG_CMD_IMPORTENV)
1056         U_BOOT_CMD_MKENT(import, 5, 0, do_env_import, "", ""),
1057 #endif
1058         U_BOOT_CMD_MKENT(print, CONFIG_SYS_MAXARGS, 1, do_env_print, "", ""),
1059 #if defined(CONFIG_CMD_RUN)
1060         U_BOOT_CMD_MKENT(run, CONFIG_SYS_MAXARGS, 1, do_run, "", ""),
1061 #endif
1062 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
1063         U_BOOT_CMD_MKENT(save, 1, 0, do_env_save, "", ""),
1064 #endif
1065         U_BOOT_CMD_MKENT(set, CONFIG_SYS_MAXARGS, 0, do_env_set, "", ""),
1066 };
1067
1068 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
1069 void env_reloc(void)
1070 {
1071         fixup_cmdtable(cmd_env_sub, ARRAY_SIZE(cmd_env_sub));
1072 }
1073 #endif
1074
1075 static int do_env(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1076 {
1077         cmd_tbl_t *cp;
1078
1079         if (argc < 2)
1080                 return CMD_RET_USAGE;
1081
1082         /* drop initial "env" arg */
1083         argc--;
1084         argv++;
1085
1086         cp = find_cmd_tbl(argv[0], cmd_env_sub, ARRAY_SIZE(cmd_env_sub));
1087
1088         if (cp)
1089                 return cp->cmd(cmdtp, flag, argc, argv);
1090
1091         return CMD_RET_USAGE;
1092 }
1093
1094 #ifdef CONFIG_SYS_LONGHELP
1095 static char env_help_text[] =
1096 #if defined(CONFIG_CMD_ASKENV)
1097         "ask name [message] [size] - ask for environment variable\nenv "
1098 #endif
1099 #if defined(CONFIG_CMD_ENV_CALLBACK)
1100         "callbacks - print callbacks and their associated variables\nenv "
1101 #endif
1102         "default [-f] -a - [forcibly] reset default environment\n"
1103         "env default [-f] var [...] - [forcibly] reset variable(s) to their default values\n"
1104         "env delete [-f] var [...] - [forcibly] delete variable(s)\n"
1105 #if defined(CONFIG_CMD_EDITENV)
1106         "env edit name - edit environment variable\n"
1107 #endif
1108 #if defined(CONFIG_CMD_EXPORTENV)
1109         "env export [-t | -b | -c] [-s size] addr [var ...] - export environment\n"
1110 #endif
1111 #if defined(CONFIG_CMD_ENV_FLAGS)
1112         "env flags - print variables that have non-default flags\n"
1113 #endif
1114 #if defined(CONFIG_CMD_GREPENV)
1115         "env grep string [...] - search environment\n"
1116 #endif
1117 #if defined(CONFIG_CMD_IMPORTENV)
1118         "env import [-d] [-t | -b | -c] addr [size] - import environment\n"
1119 #endif
1120         "env print [-a | name ...] - print environment\n"
1121 #if defined(CONFIG_CMD_RUN)
1122         "env run var [...] - run commands in an environment variable\n"
1123 #endif
1124 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
1125         "env save - save environment\n"
1126 #endif
1127         "env set [-f] name [arg ...]\n";
1128 #endif
1129
1130 U_BOOT_CMD(
1131         env, CONFIG_SYS_MAXARGS, 1, do_env,
1132         "environment handling commands", env_help_text
1133 );
1134
1135 /*
1136  * Old command line interface, kept for compatibility
1137  */
1138
1139 #if defined(CONFIG_CMD_EDITENV)
1140 U_BOOT_CMD_COMPLETE(
1141         editenv, 2, 0,  do_env_edit,
1142         "edit environment variable",
1143         "name\n"
1144         "    - edit environment variable 'name'",
1145         var_complete
1146 );
1147 #endif
1148
1149 U_BOOT_CMD_COMPLETE(
1150         printenv, CONFIG_SYS_MAXARGS, 1,        do_env_print,
1151         "print environment variables",
1152         "[-a]\n    - print [all] values of all environment variables\n"
1153         "printenv name ...\n"
1154         "    - print value of environment variable 'name'",
1155         var_complete
1156 );
1157
1158 #ifdef CONFIG_CMD_GREPENV
1159 U_BOOT_CMD_COMPLETE(
1160         grepenv, CONFIG_SYS_MAXARGS, 0,  do_env_grep,
1161         "search environment variables",
1162         "string ...\n"
1163         "    - list environment name=value pairs matching 'string'",
1164         var_complete
1165 );
1166 #endif
1167
1168 U_BOOT_CMD_COMPLETE(
1169         setenv, CONFIG_SYS_MAXARGS, 0,  do_env_set,
1170         "set environment variables",
1171         "[-f] name value ...\n"
1172         "    - [forcibly] set environment variable 'name' to 'value ...'\n"
1173         "setenv [-f] name\n"
1174         "    - [forcibly] delete environment variable 'name'",
1175         var_complete
1176 );
1177
1178 #if defined(CONFIG_CMD_ASKENV)
1179
1180 U_BOOT_CMD(
1181         askenv, CONFIG_SYS_MAXARGS,     1,      do_env_ask,
1182         "get environment variables from stdin",
1183         "name [message] [size]\n"
1184         "    - get environment variable 'name' from stdin (max 'size' chars)"
1185 );
1186 #endif
1187
1188 #if defined(CONFIG_CMD_RUN)
1189 U_BOOT_CMD_COMPLETE(
1190         run,    CONFIG_SYS_MAXARGS,     1,      do_run,
1191         "run commands in an environment variable",
1192         "var [...]\n"
1193         "    - run the commands in the environment variable(s) 'var'",
1194         var_complete
1195 );
1196 #endif
1197 #endif /* CONFIG_SPL_BUILD */