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