2 * (C) Copyright 2000-2010
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
6 * Andreas Heppel <aheppel@sysgo.de>
8 * See file CREDITS for list of people who contributed to this
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License as
13 * published by the Free Software Foundation; either version 2 of
14 * the License, or (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
28 * Support for persistent environment data
30 * The "environment" is stored on external storage as a list of '\0'
31 * terminated "name=value" strings. The end of the list is marked by
32 * a double '\0'. The environment is preceeded by a 32 bit CRC over
33 * the data part and, in case of redundant environment, a byte of
36 * This linearized representation will also be used before
37 * relocation, i. e. as long as we don't have a full C runtime
38 * environment. After that, we use a hash table.
43 #include <environment.h>
49 #include <linux/stddef.h>
50 #include <asm/byteorder.h>
51 #if defined(CONFIG_CMD_NET)
55 DECLARE_GLOBAL_DATA_PTR
;
57 #if !defined(CONFIG_ENV_IS_IN_EEPROM) && \
58 !defined(CONFIG_ENV_IS_IN_FLASH) && \
59 !defined(CONFIG_ENV_IS_IN_DATAFLASH) && \
60 !defined(CONFIG_ENV_IS_IN_MG_DISK) && \
61 !defined(CONFIG_ENV_IS_IN_MMC) && \
62 !defined(CONFIG_ENV_IS_IN_NAND) && \
63 !defined(CONFIG_ENV_IS_IN_NVRAM) && \
64 !defined(CONFIG_ENV_IS_IN_ONENAND) && \
65 !defined(CONFIG_ENV_IS_IN_SPI_FLASH) && \
66 !defined(CONFIG_ENV_IS_NOWHERE)
67 # error Define one of CONFIG_ENV_IS_IN_{EEPROM|FLASH|DATAFLASH|ONENAND|\
68 SPI_FLASH|MG_DISK|NVRAM|MMC|NOWHERE}
72 #define MK_STR(x) XMK_STR(x)
75 * Maximum expected input data size for import command
77 #define MAX_ENV_SIZE (1 << 20) /* 1 MiB */
80 * Table with supported baudrates (defined in config_xyz.h)
82 static const unsigned long baudrate_table
[] = CONFIG_SYS_BAUDRATE_TABLE
;
83 #define N_BAUDRATES (sizeof(baudrate_table) / sizeof(baudrate_table[0]))
86 * This variable is incremented on each do_env_set(), so it can
87 * be used via get_env_id() as an indication, if the environment
88 * has changed or not. So it is possible to reread an environment
89 * variable only if the environment was changed ... done so for
90 * example in NetInitLoop()
92 static int env_id
= 1;
100 * Command interface: print one or all environment variables
102 * Returns 0 in case of error, or length of printed string
104 static int env_print(char *name
)
109 if (name
) { /* print a single name */
114 ep
= hsearch (e
, FIND
);
117 len
= printf ("%s=%s\n", ep
->key
, ep
->data
);
121 /* print whole list */
122 len
= hexport('\n', &res
, 0);
130 /* should never happen */
134 int do_env_print (cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
140 /* print all env vars */
141 rcode
= env_print(NULL
);
144 printf("\nEnvironment size: %d/%ld bytes\n",
145 rcode
, (ulong
)ENV_SIZE
);
149 /* print selected env vars */
150 for (i
= 1; i
< argc
; ++i
) {
151 int rc
= env_print(argv
[i
]);
153 printf("## Error: \"%s\" not defined\n", argv
[i
]);
162 * Set a new environment variable,
163 * or replace or delete an existing one.
166 int _do_env_set (int flag
, int argc
, char * const argv
[])
171 char *name
, *value
, *s
;
176 if (strchr(name
, '=')) {
177 printf ("## Error: illegal character '=' in variable name \"%s\"\n", name
);
183 * search if variable with this name already exists
187 ep
= hsearch (e
, FIND
);
189 /* Check for console redirection */
190 if (strcmp(name
,"stdin") == 0) {
192 } else if (strcmp(name
,"stdout") == 0) {
194 } else if (strcmp(name
,"stderr") == 0) {
199 if (argc
< 3) { /* Cannot delete it! */
200 printf("Can't delete \"%s\"\n", name
);
204 #ifdef CONFIG_CONSOLE_MUX
205 i
= iomux_doenv(console
, argv
[2]);
209 /* Try assigning specified device */
210 if (console_assign (console
, argv
[2]) < 0)
213 #ifdef CONFIG_SERIAL_MULTI
214 if (serial_assign (argv
[2]) < 0)
217 #endif /* CONFIG_CONSOLE_MUX */
221 * Some variables like "ethaddr" and "serial#" can be set only
222 * once and cannot be deleted; also, "ver" is readonly.
224 if (ep
) { /* variable exists */
225 #ifndef CONFIG_ENV_OVERWRITE
226 if ((strcmp (name
, "serial#") == 0) ||
227 ((strcmp (name
, "ethaddr") == 0)
228 #if defined(CONFIG_OVERWRITE_ETHADDR_ONCE) && defined(CONFIG_ETHADDR)
229 && (strcmp (ep
->data
,MK_STR(CONFIG_ETHADDR
)) != 0)
230 #endif /* CONFIG_OVERWRITE_ETHADDR_ONCE && CONFIG_ETHADDR */
232 printf ("Can't overwrite \"%s\"\n", name
);
237 * Switch to new baudrate if new baudrate is supported
239 if (strcmp(name
,"baudrate") == 0) {
240 int baudrate
= simple_strtoul(argv
[2], NULL
, 10);
242 for (i
=0; i
<N_BAUDRATES
; ++i
) {
243 if (baudrate
== baudrate_table
[i
])
246 if (i
== N_BAUDRATES
) {
247 printf ("## Baudrate %d bps not supported\n",
251 printf ("## Switch baudrate to %d bps and press ENTER ...\n",
254 gd
->baudrate
= baudrate
;
255 #if defined(CONFIG_PPC) || defined(CONFIG_MCF52x2)
256 gd
->bd
->bi_baudrate
= baudrate
;
269 if ((argc
< 3) || argv
[2] == NULL
) {
270 int rc
= hdelete(name
);
275 * Insert / replace new value
277 for (i
=2,len
=0; i
<argc
; ++i
) {
278 len
+= strlen(argv
[i
]) + 1;
280 if ((value
= malloc(len
)) == NULL
) {
281 printf("## Can't malloc %d bytes\n", len
);
284 for (i
=2,s
=value
; i
<argc
; ++i
) {
287 while ((*s
++ = *v
++) != '\0')
296 ep
= hsearch(e
, ENTER
);
299 printf("## Error inserting \"%s\" variable, errno=%d\n",
305 * Some variables should be updated when the corresponding
306 * entry in the environment is changed
309 if (strcmp(name
,"ipaddr") == 0) {
310 char *s
= argv
[2]; /* always use only one arg */
314 for (addr
=0, i
=0; i
<4; ++i
) {
315 ulong val
= s
? simple_strtoul(s
, &e
, 10) : 0;
317 addr
|= (val
& 0xFF);
318 if (s
) s
= (*e
) ? e
+1 : e
;
320 bd
->bi_ip_addr
= htonl(addr
);
322 } else if (strcmp(argv
[1],"loadaddr") == 0) {
323 load_addr
= simple_strtoul(argv
[2], NULL
, 16);
326 #if defined(CONFIG_CMD_NET)
327 else if (strcmp(argv
[1],"bootfile") == 0) {
328 copy_filename (BootFile
, argv
[2], sizeof(BootFile
));
335 int setenv (char *varname
, char *varvalue
)
337 char * const argv
[4] = { "setenv", varname
, varvalue
, NULL
};
338 if ((varvalue
== NULL
) || (varvalue
[0] == '\0'))
339 return _do_env_set(0, 2, argv
);
341 return _do_env_set(0, 3, argv
);
344 int do_env_set (cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
347 return cmd_usage(cmdtp
);
349 return _do_env_set(flag
, argc
, argv
);
353 * Prompt for environment variable
355 #if defined(CONFIG_CMD_ASKENV)
356 int do_env_ask ( cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
358 extern char console_buffer
[CONFIG_SYS_CBSIZE
];
359 char message
[CONFIG_SYS_CBSIZE
];
360 int size
= CONFIG_SYS_CBSIZE
- 1;
364 local_args
[0] = argv
[0];
365 local_args
[1] = argv
[1];
366 local_args
[2] = NULL
;
367 local_args
[3] = NULL
;
369 /* Check the syntax */
372 return cmd_usage(cmdtp
);
374 case 2: /* env_ask envname */
375 sprintf(message
, "Please enter '%s':", argv
[1]);
378 case 3: /* env_ask envname size */
379 sprintf(message
, "Please enter '%s':", argv
[1]);
380 size
= simple_strtoul(argv
[2], NULL
, 10);
383 default: /* env_ask envname message1 ... messagen size */
384 for (i
=2,pos
=0; i
< argc
- 1; i
++) {
386 message
[pos
++] = ' ';
388 strcpy(message
+pos
, argv
[i
]);
389 pos
+= strlen(argv
[i
]);
392 size
= simple_strtoul(argv
[argc
- 1], NULL
, 10);
396 if (size
>= CONFIG_SYS_CBSIZE
)
397 size
= CONFIG_SYS_CBSIZE
- 1;
402 /* prompt for input */
403 len
= readline(message
);
406 console_buffer
[size
] = '\0';
409 if (console_buffer
[0] != '\0') {
410 local_args
[2] = console_buffer
;
414 /* Continue calling setenv code */
415 return _do_env_set(flag
, len
, local_args
);
420 * Interactively edit an environment variable
422 #if defined(CONFIG_CMD_EDITENV)
423 int do_env_edit(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
425 char buffer
[CONFIG_SYS_CBSIZE
];
430 return cmd_usage(cmdtp
);
432 /* Set read buffer to initial value or empty sting */
433 init_val
= getenv(argv
[1]);
435 len
= sprintf(buffer
, "%s", init_val
);
439 readline_into_buffer("edit: ", buffer
);
441 return setenv(argv
[1], buffer
);
443 #endif /* CONFIG_CMD_EDITENV */
446 * Look up variable from environment,
447 * return address of storage for that variable,
448 * or NULL if not found
450 char *getenv (char *name
)
452 if (gd
->flags
& GD_FLG_ENV_READY
) { /* after import into hashtable */
459 ep
= hsearch (e
, FIND
);
461 return (ep
? ep
->data
: NULL
);
464 /* restricted capabilities before import */
466 if (getenv_f(name
, (char *)(gd
->env_buf
), sizeof(gd
->env_buf
)) > 0)
467 return (char *)(gd
->env_buf
);
473 * Look up variable from environment for restricted C runtime env.
475 int getenv_f (char *name
, char *buf
, unsigned len
)
479 for (i
=0; env_get_char(i
) != '\0'; i
=nxt
+1) {
482 for (nxt
=i
; env_get_char(nxt
) != '\0'; ++nxt
) {
483 if (nxt
>= CONFIG_ENV_SIZE
) {
487 if ((val
=envmatch((uchar
*)name
, i
)) < 0)
490 /* found; copy out */
491 for (n
=0; n
<len
; ++n
, ++buf
) {
492 if ((*buf
= env_get_char(val
++)) == '\0')
499 printf("env_buf too small [%d]\n", len
);
506 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
508 int do_env_save (cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
510 extern char * env_name_spec
;
512 printf ("Saving Environment to %s...\n", env_name_spec
);
514 return (saveenv() ? 1 : 0);
518 saveenv
, 1, 0, do_env_save
,
519 "save environment variables to persistent storage",
527 * Match a name / name=value pair
529 * s1 is either a simple 'name', or a 'name=value' pair.
530 * i2 is the environment index for a 'name2=value2' pair.
531 * If the names match, return the index for the value2, else NULL.
534 int envmatch (uchar
*s1
, int i2
)
537 while (*s1
== env_get_char(i2
++))
540 if (*s1
== '\0' && env_get_char(i2
-1) == '=')
545 static int do_env_default(cmd_tbl_t
* cmdtp
, int flag
, int argc
, char * const argv
[])
547 if ((argc
!= 2) || (strcmp(argv
[1], "-f") != 0)) {
551 set_default_env("## Resetting to default environment\n");
555 static int do_env_delete(cmd_tbl_t
* cmdtp
, int flag
, int argc
, char * const argv
[])
557 printf("Not implemented yet\n");
562 * env export [-t | -b | -c] addr [size]
563 * -t: export as text format; if size is given, data will be
564 * padded with '\0' bytes; if not, one terminating '\0'
565 * will be added (which is included in the "filesize"
566 * setting so you can for exmple copy this to flash and
567 * keep the termination).
568 * -b: export as binary format (name=value pairs separated by
569 * '\0', list end marked by double "\0\0")
570 * -c: export as checksum protected environment format as
571 * used for example by "saveenv" command
572 * addr: memory address where environment gets stored
573 * size: size of output buffer
575 * With "-c" and size is NOT given, then the export command will
576 * format the data as currently used for the persistent storage,
577 * i. e. it will use CONFIG_ENV_SECT_SIZE as output block size and
578 * prepend a valid CRC32 checksum and, in case of resundant
579 * environment, a "current" redundancy flag. If size is given, this
580 * value will be used instead of CONFIG_ENV_SECT_SIZE; again, CRC32
581 * checksum and redundancy flag will be inserted.
583 * With "-b" and "-t", always only the real data (including a
584 * terminating '\0' byte) will be written; here the optional size
585 * argument will be used to make sure not to overflow the user
586 * provided buffer; the command will abort if the size is not
587 * sufficient. Any remainign space will be '\0' padded.
589 * On successful return, the variable "filesize" will be set.
590 * Note that filesize includes the trailing/terminating '\0' byte(s).
592 * Usage szenario: create a text snapshot/backup of the current settings:
594 * => env export -t 100000
595 * => era ${backup_addr} +${filesize}
596 * => cp.b 100000 ${backup_addr} ${filesize}
598 * Re-import this snapshot, deleting all other settings:
600 * => env import -d -t ${backup_addr}
602 static int do_env_export(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
605 char *addr
, *cmd
, *res
;
615 while (--argc
> 0 && **++argv
== '-') {
619 case 'b': /* raw binary format */
624 case 'c': /* external checksum format */
630 case 't': /* text format */
647 addr
= (char *)simple_strtoul(argv
[0], NULL
, 16);
650 size
= simple_strtoul(argv
[1], NULL
, 16);
651 memset(addr
, '\0', size
);
656 if (sep
) { /* export as text file */
657 len
= hexport(sep
, &addr
, size
);
659 error("Cannot export environment: errno = %d\n",
663 sprintf(buf
, "%zX", len
);
664 setenv("filesize", buf
);
669 envp
= (env_t
*)addr
;
671 if (chk
) /* export as checksum protected block */
672 res
= (char *)envp
->data
;
673 else /* export as raw binary data */
676 len
= hexport('\0', &res
, ENV_SIZE
);
678 error("Cannot export environment: errno = %d\n",
684 envp
->crc
= crc32(0, envp
->data
, ENV_SIZE
);
685 #ifdef CONFIG_ENV_ADDR_REDUND
686 envp
->flags
= ACTIVE_FLAG
;
689 sprintf(buf
, "%zX", len
+ offsetof(env_t
,data
));
690 setenv("filesize", buf
);
695 printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n",
701 * env import [-d] [-t | -b | -c] addr [size]
702 * -d: delete existing environment before importing;
703 * otherwise overwrite / append to existion definitions
704 * -t: assume text format; either "size" must be given or the
705 * text data must be '\0' terminated
706 * -b: assume binary format ('\0' separated, "\0\0" terminated)
707 * -c: assume checksum protected environment format
708 * addr: memory address to read from
709 * size: length of input data; if missing, proper '\0'
710 * termination is mandatory
712 static int do_env_import(cmd_tbl_t
* cmdtp
, int flag
, int argc
, char * const argv
[])
723 while (--argc
> 0 && **++argv
== '-') {
727 case 'b': /* raw binary format */
732 case 'c': /* external checksum format */
738 case 't': /* text format */
759 printf("## Warning: defaulting to text format\n");
761 addr
= (char *)simple_strtoul(argv
[0], NULL
, 16);
764 size
= simple_strtoul(argv
[1], NULL
, 16);
770 while (size
< MAX_ENV_SIZE
) {
771 if ((*s
== sep
) && (*(s
+1) == '\0'))
776 if (size
== MAX_ENV_SIZE
) {
777 printf("## Warning: Input data exceeds %d bytes"
778 " - truncated\n", MAX_ENV_SIZE
);
781 printf("## Info: input data size = %zd = 0x%zX\n", size
, size
);
786 env_t
*ep
= (env_t
*)addr
;
788 size
-= offsetof(env_t
, data
);
789 memcpy(&crc
, &ep
->crc
, sizeof(crc
));
791 if (crc32(0, ep
->data
, size
) != crc
) {
792 puts("## Error: bad CRC, import failed\n");
795 addr
= (char *)ep
->data
;
798 if (himport(addr
, size
, sep
, del
? 0 : H_NOCLEAR
) == 0) {
799 error("Environment import failed: errno = %d\n", errno
);
802 gd
->flags
|= GD_FLG_ENV_READY
;
807 printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n",
812 #if defined(CONFIG_CMD_RUN)
813 extern int do_run (cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[]);
817 * New command line interface: "env" command with subcommands
819 static cmd_tbl_t cmd_env_sub
[] = {
820 #if defined(CONFIG_CMD_ASKENV)
821 U_BOOT_CMD_MKENT(ask
, CONFIG_SYS_MAXARGS
, 1, do_env_ask
, "", ""),
823 U_BOOT_CMD_MKENT(default, 1, 0, do_env_default
, "", ""),
824 U_BOOT_CMD_MKENT(delete, 2, 0, do_env_delete
, "", ""),
825 #if defined(CONFIG_CMD_EDITENV)
826 U_BOOT_CMD_MKENT(edit
, 2, 0, do_env_edit
, "", ""),
828 U_BOOT_CMD_MKENT(export
, 4, 0, do_env_export
, "", ""),
829 U_BOOT_CMD_MKENT(import
, 5, 0, do_env_import
, "", ""),
830 U_BOOT_CMD_MKENT(print
, CONFIG_SYS_MAXARGS
, 1, do_env_print
, "", ""),
831 #if defined(CONFIG_CMD_RUN)
832 U_BOOT_CMD_MKENT(run
, CONFIG_SYS_MAXARGS
, 1, do_run
, "", ""),
834 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
835 U_BOOT_CMD_MKENT(save
, 1, 0, do_env_save
, "", ""),
837 U_BOOT_CMD_MKENT(set
, CONFIG_SYS_MAXARGS
, 0, do_env_set
, "", ""),
840 #if !defined(CONFIG_RELOC_FIXUP_WORKS)
843 fixup_cmdtable(cmd_env_sub
, ARRAY_SIZE(cmd_env_sub
));
847 static int do_env (cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
851 /* drop initial "env" arg */
855 cp
= find_cmd_tbl(argv
[0], cmd_env_sub
, ARRAY_SIZE(cmd_env_sub
));
858 return cp
->cmd(cmdtp
, flag
, argc
, argv
);
865 env
, CONFIG_SYS_MAXARGS
, 1, do_env
,
866 "environment handling commands",
867 #if defined(CONFIG_CMD_ASKENV)
868 "ask name [message] [size] - ask for environment variable\nenv "
870 "default -f - reset default environment\n"
871 #if defined(CONFIG_CMD_EDITENV)
872 "env edit name - edit environment variable\n"
874 "env export [-t | -b | -c] addr [size] - export environmnt\n"
875 "env import [-d] [-t | -b | -c] addr [size] - import environmnt\n"
876 "env print [name ...] - print environment\n"
877 #if defined(CONFIG_CMD_RUN)
878 "env run var [...] - run commands in an environment variable\n"
880 "env save - save environment\n"
881 "env set [-f] name [arg ...]\n"
885 * Old command line interface, kept for compatibility
888 #if defined(CONFIG_CMD_EDITENV)
890 editenv
, 2, 0, do_env_edit
,
891 "edit environment variable",
893 " - edit environment variable 'name'"
898 printenv
, CONFIG_SYS_MAXARGS
, 1, do_env_print
,
899 "print environment variables",
900 "\n - print values of all environment variables\n"
901 "printenv name ...\n"
902 " - print value of environment variable 'name'"
906 setenv
, CONFIG_SYS_MAXARGS
, 0, do_env_set
,
907 "set environment variables",
909 " - set environment variable 'name' to 'value ...'\n"
911 " - delete environment variable 'name'"
914 #if defined(CONFIG_CMD_ASKENV)
917 askenv
, CONFIG_SYS_MAXARGS
, 1, do_env_ask
,
918 "get environment variables from stdin",
919 "name [message] [size]\n"
920 " - get environment variable 'name' from stdin (max 'size' chars)\n"
922 " - get environment variable 'name' from stdin\n"
924 " - get environment variable 'name' from stdin (max 'size' chars)\n"
925 "askenv name [message] size\n"
926 " - display 'message' string and get environment variable 'name'"
927 "from stdin (max 'size' chars)"
931 #if defined(CONFIG_CMD_RUN)
933 run
, CONFIG_SYS_MAXARGS
, 1, do_run
,
934 "run commands in an environment variable",
936 " - run the commands in the environment variable(s) 'var'"