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