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 */
79 ulong load_addr = CONFIG_SYS_LOAD_ADDR; /* Default Load Address */
82 * Table with supported baudrates (defined in config_xyz.h)
84 static const unsigned long baudrate_table[] = CONFIG_SYS_BAUDRATE_TABLE;
85 #define N_BAUDRATES (sizeof(baudrate_table) / sizeof(baudrate_table[0]))
88 * This variable is incremented on each do_env_set(), so it can
89 * be used via get_env_id() as an indication, if the environment
90 * has changed or not. So it is possible to reread an environment
91 * variable only if the environment was changed ... done so for
92 * example in NetInitLoop()
94 static int env_id = 1;
102 * Command interface: print one or all environment variables
104 * Returns 0 in case of error, or length of printed string
106 static int env_print(char *name)
111 if (name) { /* print a single name */
116 hsearch_r(e, FIND, &ep, &env_htab);
119 len = printf ("%s=%s\n", ep->key, ep->data);
123 /* print whole list */
124 len = hexport_r(&env_htab, '\n', &res, 0);
132 /* should never happen */
136 int do_env_print (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
142 /* print all env vars */
143 rcode = env_print(NULL);
146 printf("\nEnvironment size: %d/%ld bytes\n",
147 rcode, (ulong)ENV_SIZE);
151 /* print selected env vars */
152 for (i = 1; i < argc; ++i) {
153 int rc = env_print(argv[i]);
155 printf("## Error: \"%s\" not defined\n", argv[i]);
164 * Set a new environment variable,
165 * or replace or delete an existing one.
168 int _do_env_set (int flag, int argc, char * const argv[])
173 char *name, *value, *s;
178 if (strchr(name, '=')) {
179 printf ("## Error: illegal character '=' in variable name \"%s\"\n", name);
185 * search if variable with this name already exists
189 hsearch_r(e, FIND, &ep, &env_htab);
191 /* Check for console redirection */
192 if (strcmp(name,"stdin") == 0) {
194 } else if (strcmp(name,"stdout") == 0) {
196 } else if (strcmp(name,"stderr") == 0) {
201 if (argc < 3) { /* Cannot delete it! */
202 printf("Can't delete \"%s\"\n", name);
206 #ifdef CONFIG_CONSOLE_MUX
207 i = iomux_doenv(console, argv[2]);
211 /* Try assigning specified device */
212 if (console_assign (console, argv[2]) < 0)
215 #ifdef CONFIG_SERIAL_MULTI
216 if (serial_assign (argv[2]) < 0)
219 #endif /* CONFIG_CONSOLE_MUX */
223 * Some variables like "ethaddr" and "serial#" can be set only
224 * once and cannot be deleted; also, "ver" is readonly.
226 if (ep) { /* variable exists */
227 #ifndef CONFIG_ENV_OVERWRITE
228 if ((strcmp (name, "serial#") == 0) ||
229 ((strcmp (name, "ethaddr") == 0)
230 #if defined(CONFIG_OVERWRITE_ETHADDR_ONCE) && defined(CONFIG_ETHADDR)
231 && (strcmp (ep->data,MK_STR(CONFIG_ETHADDR)) != 0)
232 #endif /* CONFIG_OVERWRITE_ETHADDR_ONCE && CONFIG_ETHADDR */
234 printf ("Can't overwrite \"%s\"\n", name);
239 * Switch to new baudrate if new baudrate is supported
241 if (strcmp(name,"baudrate") == 0) {
242 int baudrate = simple_strtoul(argv[2], NULL, 10);
244 for (i=0; i<N_BAUDRATES; ++i) {
245 if (baudrate == baudrate_table[i])
248 if (i == N_BAUDRATES) {
249 printf ("## Baudrate %d bps not supported\n",
253 printf ("## Switch baudrate to %d bps and press ENTER ...\n",
256 gd->baudrate = baudrate;
257 #if defined(CONFIG_PPC) || defined(CONFIG_MCF52x2)
258 gd->bd->bi_baudrate = baudrate;
271 if ((argc < 3) || argv[2] == NULL) {
272 int rc = hdelete_r(name, &env_htab);
277 * Insert / replace new value
279 for (i=2,len=0; i<argc; ++i) {
280 len += strlen(argv[i]) + 1;
282 if ((value = malloc(len)) == NULL) {
283 printf("## Can't malloc %d bytes\n", len);
286 for (i=2,s=value; i<argc; ++i) {
289 while ((*s++ = *v++) != '\0')
298 hsearch_r(e, ENTER, &ep, &env_htab);
301 printf("## Error inserting \"%s\" variable, errno=%d\n",
307 * Some variables should be updated when the corresponding
308 * entry in the environment is changed
311 if (strcmp(name,"ipaddr") == 0) {
312 char *s = argv[2]; /* always use only one arg */
316 for (addr=0, i=0; i<4; ++i) {
317 ulong val = s ? simple_strtoul(s, &e, 10) : 0;
319 addr |= (val & 0xFF);
320 if (s) s = (*e) ? e+1 : e;
322 bd->bi_ip_addr = htonl(addr);
324 } else if (strcmp(argv[1],"loadaddr") == 0) {
325 load_addr = simple_strtoul(argv[2], NULL, 16);
328 #if defined(CONFIG_CMD_NET)
329 else if (strcmp(argv[1],"bootfile") == 0) {
330 copy_filename (BootFile, argv[2], sizeof(BootFile));
337 int setenv (char *varname, char *varvalue)
339 char * const argv[4] = { "setenv", varname, varvalue, NULL };
340 if ((varvalue == NULL) || (varvalue[0] == '\0'))
341 return _do_env_set(0, 2, argv);
343 return _do_env_set(0, 3, argv);
346 int do_env_set (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
349 return cmd_usage(cmdtp);
351 return _do_env_set(flag, argc, argv);
355 * Prompt for environment variable
357 #if defined(CONFIG_CMD_ASKENV)
358 int do_env_ask ( cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
360 extern char console_buffer[CONFIG_SYS_CBSIZE];
361 char message[CONFIG_SYS_CBSIZE];
362 int size = CONFIG_SYS_CBSIZE - 1;
366 local_args[0] = argv[0];
367 local_args[1] = argv[1];
368 local_args[2] = NULL;
369 local_args[3] = NULL;
371 /* Check the syntax */
374 return cmd_usage(cmdtp);
376 case 2: /* env_ask envname */
377 sprintf(message, "Please enter '%s':", argv[1]);
380 case 3: /* env_ask envname size */
381 sprintf(message, "Please enter '%s':", argv[1]);
382 size = simple_strtoul(argv[2], NULL, 10);
385 default: /* env_ask envname message1 ... messagen size */
386 for (i=2,pos=0; i < argc - 1; i++) {
388 message[pos++] = ' ';
390 strcpy(message+pos, argv[i]);
391 pos += strlen(argv[i]);
394 size = simple_strtoul(argv[argc - 1], NULL, 10);
398 if (size >= CONFIG_SYS_CBSIZE)
399 size = CONFIG_SYS_CBSIZE - 1;
404 /* prompt for input */
405 len = readline(message);
408 console_buffer[size] = '\0';
411 if (console_buffer[0] != '\0') {
412 local_args[2] = console_buffer;
416 /* Continue calling setenv code */
417 return _do_env_set(flag, len, local_args);
422 * Interactively edit an environment variable
424 #if defined(CONFIG_CMD_EDITENV)
425 int do_env_edit(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
427 char buffer[CONFIG_SYS_CBSIZE];
432 return cmd_usage(cmdtp);
434 /* Set read buffer to initial value or empty sting */
435 init_val = getenv(argv[1]);
437 len = sprintf(buffer, "%s", init_val);
441 readline_into_buffer("edit: ", buffer);
443 return setenv(argv[1], buffer);
445 #endif /* CONFIG_CMD_EDITENV */
448 * Look up variable from environment,
449 * return address of storage for that variable,
450 * or NULL if not found
452 char *getenv (char *name)
454 if (gd->flags & GD_FLG_ENV_READY) { /* after import into hashtable */
461 hsearch_r(e, FIND, &ep, &env_htab);
463 return (ep ? ep->data : NULL);
466 /* restricted capabilities before import */
468 if (getenv_f(name, (char *)(gd->env_buf), sizeof(gd->env_buf)) > 0)
469 return (char *)(gd->env_buf);
475 * Look up variable from environment for restricted C runtime env.
477 int getenv_f (char *name, char *buf, unsigned len)
481 for (i=0; env_get_char(i) != '\0'; i=nxt+1) {
484 for (nxt=i; env_get_char(nxt) != '\0'; ++nxt) {
485 if (nxt >= CONFIG_ENV_SIZE) {
489 if ((val=envmatch((uchar *)name, i)) < 0)
492 /* found; copy out */
493 for (n=0; n<len; ++n, ++buf) {
494 if ((*buf = env_get_char(val++)) == '\0')
501 printf("env_buf too small [%d]\n", len);
508 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
510 int do_env_save (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
512 extern char * env_name_spec;
514 printf ("Saving Environment to %s...\n", env_name_spec);
516 return (saveenv() ? 1 : 0);
520 saveenv, 1, 0, do_env_save,
521 "save environment variables to persistent storage",
529 * Match a name / name=value pair
531 * s1 is either a simple 'name', or a 'name=value' pair.
532 * i2 is the environment index for a 'name2=value2' pair.
533 * If the names match, return the index for the value2, else NULL.
536 int envmatch (uchar *s1, int i2)
539 while (*s1 == env_get_char(i2++))
542 if (*s1 == '\0' && env_get_char(i2-1) == '=')
547 static int do_env_default(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
549 if ((argc != 2) || (strcmp(argv[1], "-f") != 0)) {
550 return cmd_usage(cmdtp);
552 set_default_env("## Resetting to default environment\n");
556 static int do_env_delete(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
558 printf("Not implemented yet\n");
563 * env export [-t | -b | -c] addr [size]
564 * -t: export as text format; if size is given, data will be
565 * padded with '\0' bytes; if not, one terminating '\0'
566 * will be added (which is included in the "filesize"
567 * setting so you can for exmple copy this to flash and
568 * keep the termination).
569 * -b: export as binary format (name=value pairs separated by
570 * '\0', list end marked by double "\0\0")
571 * -c: export as checksum protected environment format as
572 * used for example by "saveenv" command
573 * addr: memory address where environment gets stored
574 * size: size of output buffer
576 * With "-c" and size is NOT given, then the export command will
577 * format the data as currently used for the persistent storage,
578 * i. e. it will use CONFIG_ENV_SECT_SIZE as output block size and
579 * prepend a valid CRC32 checksum and, in case of resundant
580 * environment, a "current" redundancy flag. If size is given, this
581 * value will be used instead of CONFIG_ENV_SECT_SIZE; again, CRC32
582 * checksum and redundancy flag will be inserted.
584 * With "-b" and "-t", always only the real data (including a
585 * terminating '\0' byte) will be written; here the optional size
586 * argument will be used to make sure not to overflow the user
587 * provided buffer; the command will abort if the size is not
588 * sufficient. Any remainign space will be '\0' padded.
590 * On successful return, the variable "filesize" will be set.
591 * Note that filesize includes the trailing/terminating '\0' byte(s).
593 * Usage szenario: create a text snapshot/backup of the current settings:
595 * => env export -t 100000
596 * => era ${backup_addr} +${filesize}
597 * => cp.b 100000 ${backup_addr} ${filesize}
599 * Re-import this snapshot, deleting all other settings:
601 * => env import -d -t ${backup_addr}
603 static int do_env_export(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
606 char *addr, *cmd, *res;
616 while (--argc > 0 && **++argv == '-') {
620 case 'b': /* raw binary format */
625 case 'c': /* external checksum format */
631 case 't': /* text format */
637 return cmd_usage(cmdtp);
643 return cmd_usage(cmdtp);
646 addr = (char *)simple_strtoul(argv[0], NULL, 16);
649 size = simple_strtoul(argv[1], NULL, 16);
650 memset(addr, '\0', size);
655 if (sep) { /* export as text file */
656 len = hexport_r(&env_htab, sep, &addr, size);
658 error("Cannot export environment: errno = %d\n",
662 sprintf(buf, "%zX", len);
663 setenv("filesize", buf);
668 envp = (env_t *)addr;
670 if (chk) /* export as checksum protected block */
671 res = (char *)envp->data;
672 else /* export as raw binary data */
675 len = hexport_r(&env_htab, '\0', &res, ENV_SIZE);
677 error("Cannot export environment: errno = %d\n",
683 envp->crc = crc32(0, envp->data, ENV_SIZE);
684 #ifdef CONFIG_ENV_ADDR_REDUND
685 envp->flags = ACTIVE_FLAG;
688 sprintf(buf, "%zX", len + offsetof(env_t,data));
689 setenv("filesize", buf);
694 printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n",
700 * env import [-d] [-t | -b | -c] addr [size]
701 * -d: delete existing environment before importing;
702 * otherwise overwrite / append to existion definitions
703 * -t: assume text format; either "size" must be given or the
704 * text data must be '\0' terminated
705 * -b: assume binary format ('\0' separated, "\0\0" terminated)
706 * -c: assume checksum protected environment format
707 * addr: memory address to read from
708 * size: length of input data; if missing, proper '\0'
709 * termination is mandatory
711 static int do_env_import(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
722 while (--argc > 0 && **++argv == '-') {
726 case 'b': /* raw binary format */
731 case 'c': /* external checksum format */
737 case 't': /* text format */
746 return cmd_usage(cmdtp);
752 return cmd_usage(cmdtp);
756 printf("## Warning: defaulting to text format\n");
758 addr = (char *)simple_strtoul(argv[0], NULL, 16);
761 size = simple_strtoul(argv[1], NULL, 16);
767 while (size < MAX_ENV_SIZE) {
768 if ((*s == sep) && (*(s+1) == '\0'))
773 if (size == MAX_ENV_SIZE) {
774 printf("## Warning: Input data exceeds %d bytes"
775 " - truncated\n", MAX_ENV_SIZE);
778 printf("## Info: input data size = %zd = 0x%zX\n", size, size);
783 env_t *ep = (env_t *)addr;
785 size -= offsetof(env_t, data);
786 memcpy(&crc, &ep->crc, sizeof(crc));
788 if (crc32(0, ep->data, size) != crc) {
789 puts("## Error: bad CRC, import failed\n");
792 addr = (char *)ep->data;
795 if (himport_r(&env_htab, addr, size, sep, del ? 0 : H_NOCLEAR) == 0) {
796 error("Environment import failed: errno = %d\n", errno);
799 gd->flags |= GD_FLG_ENV_READY;
804 printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n",
809 #if defined(CONFIG_CMD_RUN)
810 extern int do_run (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
814 * New command line interface: "env" command with subcommands
816 static cmd_tbl_t cmd_env_sub[] = {
817 #if defined(CONFIG_CMD_ASKENV)
818 U_BOOT_CMD_MKENT(ask, CONFIG_SYS_MAXARGS, 1, do_env_ask, "", ""),
820 U_BOOT_CMD_MKENT(default, 1, 0, do_env_default, "", ""),
821 U_BOOT_CMD_MKENT(delete, 2, 0, do_env_delete, "", ""),
822 #if defined(CONFIG_CMD_EDITENV)
823 U_BOOT_CMD_MKENT(edit, 2, 0, do_env_edit, "", ""),
825 U_BOOT_CMD_MKENT(export, 4, 0, do_env_export, "", ""),
826 U_BOOT_CMD_MKENT(import, 5, 0, do_env_import, "", ""),
827 U_BOOT_CMD_MKENT(print, CONFIG_SYS_MAXARGS, 1, do_env_print, "", ""),
828 #if defined(CONFIG_CMD_RUN)
829 U_BOOT_CMD_MKENT(run, CONFIG_SYS_MAXARGS, 1, do_run, "", ""),
831 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
832 U_BOOT_CMD_MKENT(save, 1, 0, do_env_save, "", ""),
834 U_BOOT_CMD_MKENT(set, CONFIG_SYS_MAXARGS, 0, do_env_set, "", ""),
837 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
840 fixup_cmdtable(cmd_env_sub, ARRAY_SIZE(cmd_env_sub));
844 static int do_env (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
849 return cmd_usage(cmdtp);
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);
860 return cmd_usage(cmdtp);
864 env, CONFIG_SYS_MAXARGS, 1, do_env,
865 "environment handling commands",
866 #if defined(CONFIG_CMD_ASKENV)
867 "ask name [message] [size] - ask for environment variable\nenv "
869 "default -f - reset default environment\n"
870 #if defined(CONFIG_CMD_EDITENV)
871 "env edit name - edit environment variable\n"
873 "env export [-t | -b | -c] addr [size] - export environmnt\n"
874 "env import [-d] [-t | -b | -c] addr [size] - import environmnt\n"
875 "env print [name ...] - print environment\n"
876 #if defined(CONFIG_CMD_RUN)
877 "env run var [...] - run commands in an environment variable\n"
879 "env save - save environment\n"
880 "env set [-f] name [arg ...]\n"
884 * Old command line interface, kept for compatibility
887 #if defined(CONFIG_CMD_EDITENV)
889 editenv, 2, 0, do_env_edit,
890 "edit environment variable",
892 " - 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'",
907 setenv, CONFIG_SYS_MAXARGS, 0, do_env_set,
908 "set environment variables",
910 " - set environment variable 'name' to 'value ...'\n"
912 " - delete environment variable 'name'",
916 #if defined(CONFIG_CMD_ASKENV)
919 askenv, CONFIG_SYS_MAXARGS, 1, do_env_ask,
920 "get environment variables from stdin",
921 "name [message] [size]\n"
922 " - get environment variable 'name' from stdin (max 'size' chars)\n"
924 " - get environment variable 'name' from stdin\n"
926 " - get environment variable 'name' from stdin (max 'size' chars)\n"
927 "askenv name [message] size\n"
928 " - display 'message' string and get environment variable 'name'"
929 "from stdin (max 'size' chars)"
933 #if defined(CONFIG_CMD_RUN)
935 run, CONFIG_SYS_MAXARGS, 1, do_run,
936 "run commands in an environment variable",
938 " - run the commands in the environment variable(s) 'var'",