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 * Copyright 2011 Freescale Semiconductor, Inc.
10 * See file CREDITS for list of people who contributed to this
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.
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.
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,
30 * Support for persistent environment data
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
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.
45 #include <environment.h>
51 #include <linux/stddef.h>
52 #include <asm/byteorder.h>
53 #if defined(CONFIG_CMD_NET)
57 DECLARE_GLOBAL_DATA_PTR;
59 #if !defined(CONFIG_ENV_IS_IN_EEPROM) && \
60 !defined(CONFIG_ENV_IS_IN_FLASH) && \
61 !defined(CONFIG_ENV_IS_IN_DATAFLASH) && \
62 !defined(CONFIG_ENV_IS_IN_MG_DISK) && \
63 !defined(CONFIG_ENV_IS_IN_MMC) && \
64 !defined(CONFIG_ENV_IS_IN_NAND) && \
65 !defined(CONFIG_ENV_IS_IN_NVRAM) && \
66 !defined(CONFIG_ENV_IS_IN_ONENAND) && \
67 !defined(CONFIG_ENV_IS_IN_SPI_FLASH) && \
68 !defined(CONFIG_ENV_IS_NOWHERE)
69 # error Define one of CONFIG_ENV_IS_IN_{EEPROM|FLASH|DATAFLASH|ONENAND|\
70 SPI_FLASH|MG_DISK|NVRAM|MMC} or CONFIG_ENV_IS_NOWHERE
74 #define MK_STR(x) XMK_STR(x)
77 * Maximum expected input data size for import command
79 #define MAX_ENV_SIZE (1 << 20) /* 1 MiB */
81 ulong load_addr = CONFIG_SYS_LOAD_ADDR; /* Default Load Address */
84 * Table with supported baudrates (defined in config_xyz.h)
86 static const unsigned long baudrate_table[] = CONFIG_SYS_BAUDRATE_TABLE;
87 #define N_BAUDRATES (sizeof(baudrate_table) / sizeof(baudrate_table[0]))
90 * This variable is incremented on each do_env_set(), so it can
91 * be used via get_env_id() as an indication, if the environment
92 * has changed or not. So it is possible to reread an environment
93 * variable only if the environment was changed ... done so for
94 * example in NetInitLoop()
96 static int env_id = 1;
104 * Command interface: print one or all environment variables
106 * Returns 0 in case of error, or length of printed string
108 static int env_print(char *name)
113 if (name) { /* print a single name */
118 hsearch_r(e, FIND, &ep, &env_htab);
121 len = printf ("%s=%s\n", ep->key, ep->data);
125 /* print whole list */
126 len = hexport_r(&env_htab, '\n', &res, 0);
134 /* should never happen */
138 int do_env_print (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
144 /* print all env vars */
145 rcode = env_print(NULL);
148 printf("\nEnvironment size: %d/%ld bytes\n",
149 rcode, (ulong)ENV_SIZE);
153 /* print selected env vars */
154 for (i = 1; i < argc; ++i) {
155 int rc = env_print(argv[i]);
157 printf("## Error: \"%s\" not defined\n", argv[i]);
165 #ifdef CONFIG_CMD_GREPENV
166 static int do_env_grep (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
169 unsigned char matched[env_htab.size / 8];
170 int rcode = 1, arg = 1, idx;
173 return cmd_usage(cmdtp);
175 memset(matched, 0, env_htab.size / 8);
177 while (arg <= argc) {
179 while ((idx = hstrstr_r(argv[arg], idx, &match, &env_htab))) {
180 if (!(matched[idx / 8] & (1 << (idx & 7)))) {
186 matched[idx / 8] |= 1 << (idx & 7);
197 * Set a new environment variable,
198 * or replace or delete an existing one.
201 int _do_env_set (int flag, int argc, char * const argv[])
206 char *name, *value, *s;
211 if (strchr(name, '=')) {
212 printf ("## Error: illegal character '=' in variable name \"%s\"\n", name);
218 * search if variable with this name already exists
222 hsearch_r(e, FIND, &ep, &env_htab);
224 /* Check for console redirection */
225 if (strcmp(name,"stdin") == 0) {
227 } else if (strcmp(name,"stdout") == 0) {
229 } else if (strcmp(name,"stderr") == 0) {
234 if (argc < 3) { /* Cannot delete it! */
235 printf("Can't delete \"%s\"\n", name);
239 #ifdef CONFIG_CONSOLE_MUX
240 i = iomux_doenv(console, argv[2]);
244 /* Try assigning specified device */
245 if (console_assign (console, argv[2]) < 0)
248 #ifdef CONFIG_SERIAL_MULTI
249 if (serial_assign (argv[2]) < 0)
252 #endif /* CONFIG_CONSOLE_MUX */
256 * Some variables like "ethaddr" and "serial#" can be set only
257 * once and cannot be deleted; also, "ver" is readonly.
259 if (ep) { /* variable exists */
260 #ifndef CONFIG_ENV_OVERWRITE
261 if ((strcmp (name, "serial#") == 0) ||
262 ((strcmp (name, "ethaddr") == 0)
263 #if defined(CONFIG_OVERWRITE_ETHADDR_ONCE) && defined(CONFIG_ETHADDR)
264 && (strcmp (ep->data,MK_STR(CONFIG_ETHADDR)) != 0)
265 #endif /* CONFIG_OVERWRITE_ETHADDR_ONCE && CONFIG_ETHADDR */
267 printf ("Can't overwrite \"%s\"\n", name);
272 * Switch to new baudrate if new baudrate is supported
274 if (strcmp(name,"baudrate") == 0) {
275 int baudrate = simple_strtoul(argv[2], NULL, 10);
277 for (i=0; i<N_BAUDRATES; ++i) {
278 if (baudrate == baudrate_table[i])
281 if (i == N_BAUDRATES) {
282 printf ("## Baudrate %d bps not supported\n",
286 printf ("## Switch baudrate to %d bps and press ENTER ...\n",
289 gd->baudrate = baudrate;
290 #if defined(CONFIG_PPC) || defined(CONFIG_MCF52x2)
291 gd->bd->bi_baudrate = baudrate;
304 if ((argc < 3) || argv[2] == NULL) {
305 int rc = hdelete_r(name, &env_htab);
310 * Insert / replace new value
312 for (i=2,len=0; i<argc; ++i) {
313 len += strlen(argv[i]) + 1;
315 if ((value = malloc(len)) == NULL) {
316 printf("## Can't malloc %d bytes\n", len);
319 for (i=2,s=value; i<argc; ++i) {
322 while ((*s++ = *v++) != '\0')
331 hsearch_r(e, ENTER, &ep, &env_htab);
334 printf("## Error inserting \"%s\" variable, errno=%d\n",
340 * Some variables should be updated when the corresponding
341 * entry in the environment is changed
344 if (strcmp(name,"ipaddr") == 0) {
345 char *s = argv[2]; /* always use only one arg */
349 for (addr=0, i=0; i<4; ++i) {
350 ulong val = s ? simple_strtoul(s, &e, 10) : 0;
352 addr |= (val & 0xFF);
353 if (s) s = (*e) ? e+1 : e;
355 bd->bi_ip_addr = htonl(addr);
357 } else if (strcmp(argv[1],"loadaddr") == 0) {
358 load_addr = simple_strtoul(argv[2], NULL, 16);
361 #if defined(CONFIG_CMD_NET)
362 else if (strcmp(argv[1],"bootfile") == 0) {
363 copy_filename (BootFile, argv[2], sizeof(BootFile));
370 int setenv (char *varname, char *varvalue)
372 char * const argv[4] = { "setenv", varname, varvalue, NULL };
373 if ((varvalue == NULL) || (varvalue[0] == '\0'))
374 return _do_env_set(0, 2, argv);
376 return _do_env_set(0, 3, argv);
379 int do_env_set (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
382 return cmd_usage(cmdtp);
384 return _do_env_set(flag, argc, argv);
388 * Prompt for environment variable
390 #if defined(CONFIG_CMD_ASKENV)
391 int do_env_ask ( cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
393 extern char console_buffer[CONFIG_SYS_CBSIZE];
394 char message[CONFIG_SYS_CBSIZE];
395 int size = CONFIG_SYS_CBSIZE - 1;
399 local_args[0] = argv[0];
400 local_args[1] = argv[1];
401 local_args[2] = NULL;
402 local_args[3] = NULL;
404 /* Check the syntax */
407 return cmd_usage(cmdtp);
409 case 2: /* env_ask envname */
410 sprintf(message, "Please enter '%s':", argv[1]);
413 case 3: /* env_ask envname size */
414 sprintf(message, "Please enter '%s':", argv[1]);
415 size = simple_strtoul(argv[2], NULL, 10);
418 default: /* env_ask envname message1 ... messagen size */
419 for (i=2,pos=0; i < argc - 1; i++) {
421 message[pos++] = ' ';
423 strcpy(message+pos, argv[i]);
424 pos += strlen(argv[i]);
427 size = simple_strtoul(argv[argc - 1], NULL, 10);
431 if (size >= CONFIG_SYS_CBSIZE)
432 size = CONFIG_SYS_CBSIZE - 1;
437 /* prompt for input */
438 len = readline(message);
441 console_buffer[size] = '\0';
444 if (console_buffer[0] != '\0') {
445 local_args[2] = console_buffer;
449 /* Continue calling setenv code */
450 return _do_env_set(flag, len, local_args);
455 * Interactively edit an environment variable
457 #if defined(CONFIG_CMD_EDITENV)
458 int do_env_edit(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
460 char buffer[CONFIG_SYS_CBSIZE];
465 return cmd_usage(cmdtp);
467 /* Set read buffer to initial value or empty sting */
468 init_val = getenv(argv[1]);
470 len = sprintf(buffer, "%s", init_val);
474 readline_into_buffer("edit: ", buffer);
476 return setenv(argv[1], buffer);
478 #endif /* CONFIG_CMD_EDITENV */
481 * Look up variable from environment,
482 * return address of storage for that variable,
483 * or NULL if not found
485 char *getenv (char *name)
487 if (gd->flags & GD_FLG_ENV_READY) { /* after import into hashtable */
494 hsearch_r(e, FIND, &ep, &env_htab);
496 return (ep ? ep->data : NULL);
499 /* restricted capabilities before import */
501 if (getenv_f(name, (char *)(gd->env_buf), sizeof(gd->env_buf)) > 0)
502 return (char *)(gd->env_buf);
508 * Look up variable from environment for restricted C runtime env.
510 int getenv_f (char *name, char *buf, unsigned len)
514 for (i=0; env_get_char(i) != '\0'; i=nxt+1) {
517 for (nxt=i; env_get_char(nxt) != '\0'; ++nxt) {
518 if (nxt >= CONFIG_ENV_SIZE) {
522 if ((val=envmatch((uchar *)name, i)) < 0)
525 /* found; copy out */
526 for (n=0; n<len; ++n, ++buf) {
527 if ((*buf = env_get_char(val++)) == '\0')
534 printf("env_buf too small [%d]\n", len);
541 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
543 int do_env_save (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
545 extern char * env_name_spec;
547 printf ("Saving Environment to %s...\n", env_name_spec);
549 return (saveenv() ? 1 : 0);
553 saveenv, 1, 0, do_env_save,
554 "save environment variables to persistent storage",
562 * Match a name / name=value pair
564 * s1 is either a simple 'name', or a 'name=value' pair.
565 * i2 is the environment index for a 'name2=value2' pair.
566 * If the names match, return the index for the value2, else NULL.
569 int envmatch (uchar *s1, int i2)
572 while (*s1 == env_get_char(i2++))
575 if (*s1 == '\0' && env_get_char(i2-1) == '=')
580 static int do_env_default(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
582 if ((argc != 2) || (strcmp(argv[1], "-f") != 0)) {
583 return cmd_usage(cmdtp);
585 set_default_env("## Resetting to default environment\n");
589 static int do_env_delete(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
591 printf("Not implemented yet\n");
595 #ifdef CONFIG_CMD_EXPORTENV
597 * env export [-t | -b | -c] addr [size]
598 * -t: export as text format; if size is given, data will be
599 * padded with '\0' bytes; if not, one terminating '\0'
600 * will be added (which is included in the "filesize"
601 * setting so you can for exmple copy this to flash and
602 * keep the termination).
603 * -b: export as binary format (name=value pairs separated by
604 * '\0', list end marked by double "\0\0")
605 * -c: export as checksum protected environment format as
606 * used for example by "saveenv" command
607 * addr: memory address where environment gets stored
608 * size: size of output buffer
610 * With "-c" and size is NOT given, then the export command will
611 * format the data as currently used for the persistent storage,
612 * i. e. it will use CONFIG_ENV_SECT_SIZE as output block size and
613 * prepend a valid CRC32 checksum and, in case of resundant
614 * environment, a "current" redundancy flag. If size is given, this
615 * value will be used instead of CONFIG_ENV_SECT_SIZE; again, CRC32
616 * checksum and redundancy flag will be inserted.
618 * With "-b" and "-t", always only the real data (including a
619 * terminating '\0' byte) will be written; here the optional size
620 * argument will be used to make sure not to overflow the user
621 * provided buffer; the command will abort if the size is not
622 * sufficient. Any remainign space will be '\0' padded.
624 * On successful return, the variable "filesize" will be set.
625 * Note that filesize includes the trailing/terminating '\0' byte(s).
627 * Usage szenario: create a text snapshot/backup of the current settings:
629 * => env export -t 100000
630 * => era ${backup_addr} +${filesize}
631 * => cp.b 100000 ${backup_addr} ${filesize}
633 * Re-import this snapshot, deleting all other settings:
635 * => env import -d -t ${backup_addr}
637 static int do_env_export(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
640 char *addr, *cmd, *res;
650 while (--argc > 0 && **++argv == '-') {
654 case 'b': /* raw binary format */
659 case 'c': /* external checksum format */
665 case 't': /* text format */
671 return cmd_usage(cmdtp);
677 return cmd_usage(cmdtp);
680 addr = (char *)simple_strtoul(argv[0], NULL, 16);
683 size = simple_strtoul(argv[1], NULL, 16);
684 memset(addr, '\0', size);
689 if (sep) { /* export as text file */
690 len = hexport_r(&env_htab, sep, &addr, size);
692 error("Cannot export environment: errno = %d\n",
696 sprintf(buf, "%zX", (size_t)len);
697 setenv("filesize", buf);
702 envp = (env_t *)addr;
704 if (chk) /* export as checksum protected block */
705 res = (char *)envp->data;
706 else /* export as raw binary data */
709 len = hexport_r(&env_htab, '\0', &res, ENV_SIZE);
711 error("Cannot export environment: errno = %d\n",
717 envp->crc = crc32(0, envp->data, ENV_SIZE);
718 #ifdef CONFIG_ENV_ADDR_REDUND
719 envp->flags = ACTIVE_FLAG;
722 sprintf(buf, "%zX", (size_t)(len + offsetof(env_t,data)));
723 setenv("filesize", buf);
728 printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n",
734 #ifdef CONFIG_CMD_IMPORTENV
736 * env import [-d] [-t | -b | -c] addr [size]
737 * -d: delete existing environment before importing;
738 * otherwise overwrite / append to existion definitions
739 * -t: assume text format; either "size" must be given or the
740 * text data must be '\0' terminated
741 * -b: assume binary format ('\0' separated, "\0\0" terminated)
742 * -c: assume checksum protected environment format
743 * addr: memory address to read from
744 * size: length of input data; if missing, proper '\0'
745 * termination is mandatory
747 static int do_env_import(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
758 while (--argc > 0 && **++argv == '-') {
762 case 'b': /* raw binary format */
767 case 'c': /* external checksum format */
773 case 't': /* text format */
782 return cmd_usage(cmdtp);
788 return cmd_usage(cmdtp);
792 printf("## Warning: defaulting to text format\n");
794 addr = (char *)simple_strtoul(argv[0], NULL, 16);
797 size = simple_strtoul(argv[1], NULL, 16);
803 while (size < MAX_ENV_SIZE) {
804 if ((*s == sep) && (*(s+1) == '\0'))
809 if (size == MAX_ENV_SIZE) {
810 printf("## Warning: Input data exceeds %d bytes"
811 " - truncated\n", MAX_ENV_SIZE);
814 printf("## Info: input data size = %zd = 0x%zX\n", size, size);
819 env_t *ep = (env_t *)addr;
821 size -= offsetof(env_t, data);
822 memcpy(&crc, &ep->crc, sizeof(crc));
824 if (crc32(0, ep->data, size) != crc) {
825 puts("## Error: bad CRC, import failed\n");
828 addr = (char *)ep->data;
831 if (himport_r(&env_htab, addr, size, sep, del ? 0 : H_NOCLEAR) == 0) {
832 error("Environment import failed: errno = %d\n", errno);
835 gd->flags |= GD_FLG_ENV_READY;
840 printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n",
846 #if defined(CONFIG_CMD_RUN)
847 extern int do_run (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
851 * New command line interface: "env" command with subcommands
853 static cmd_tbl_t cmd_env_sub[] = {
854 #if defined(CONFIG_CMD_ASKENV)
855 U_BOOT_CMD_MKENT(ask, CONFIG_SYS_MAXARGS, 1, do_env_ask, "", ""),
857 U_BOOT_CMD_MKENT(default, 1, 0, do_env_default, "", ""),
858 U_BOOT_CMD_MKENT(delete, 2, 0, do_env_delete, "", ""),
859 #if defined(CONFIG_CMD_EDITENV)
860 U_BOOT_CMD_MKENT(edit, 2, 0, do_env_edit, "", ""),
862 #if defined(CONFIG_CMD_EXPORTENV)
863 U_BOOT_CMD_MKENT(export, 4, 0, do_env_export, "", ""),
865 #if defined(CONFIG_CMD_GREPENV)
866 U_BOOT_CMD_MKENT(grep, CONFIG_SYS_MAXARGS, 1, do_env_grep, "", ""),
868 #if defined(CONFIG_CMD_IMPORTENV)
869 U_BOOT_CMD_MKENT(import, 5, 0, do_env_import, "", ""),
871 U_BOOT_CMD_MKENT(print, CONFIG_SYS_MAXARGS, 1, do_env_print, "", ""),
872 #if defined(CONFIG_CMD_RUN)
873 U_BOOT_CMD_MKENT(run, CONFIG_SYS_MAXARGS, 1, do_run, "", ""),
875 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
876 U_BOOT_CMD_MKENT(save, 1, 0, do_env_save, "", ""),
878 U_BOOT_CMD_MKENT(set, CONFIG_SYS_MAXARGS, 0, do_env_set, "", ""),
881 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
884 fixup_cmdtable(cmd_env_sub, ARRAY_SIZE(cmd_env_sub));
888 static int do_env (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
893 return cmd_usage(cmdtp);
895 /* drop initial "env" arg */
899 cp = find_cmd_tbl(argv[0], cmd_env_sub, ARRAY_SIZE(cmd_env_sub));
902 return cp->cmd(cmdtp, flag, argc, argv);
904 return cmd_usage(cmdtp);
908 env, CONFIG_SYS_MAXARGS, 1, do_env,
909 "environment handling commands",
910 #if defined(CONFIG_CMD_ASKENV)
911 "ask name [message] [size] - ask for environment variable\nenv "
913 "default -f - reset default environment\n"
914 #if defined(CONFIG_CMD_EDITENV)
915 "env edit name - edit environment variable\n"
917 "env export [-t | -b | -c] addr [size] - export environment\n"
918 #if defined(CONFIG_CMD_GREPENV)
919 "env grep string [...] - search environment\n"
921 "env import [-d] [-t | -b | -c] addr [size] - import environment\n"
922 "env print [name ...] - print environment\n"
923 #if defined(CONFIG_CMD_RUN)
924 "env run var [...] - run commands in an environment variable\n"
926 "env save - save environment\n"
927 "env set [-f] name [arg ...]\n"
931 * Old command line interface, kept for compatibility
934 #if defined(CONFIG_CMD_EDITENV)
936 editenv, 2, 0, do_env_edit,
937 "edit environment variable",
939 " - edit environment variable 'name'",
945 printenv, CONFIG_SYS_MAXARGS, 1, do_env_print,
946 "print environment variables",
947 "\n - print values of all environment variables\n"
948 "printenv name ...\n"
949 " - print value of environment variable 'name'",
953 #ifdef CONFIG_CMD_GREPENV
955 grepenv, CONFIG_SYS_MAXARGS, 0, do_env_grep,
956 "search environment variables",
958 " - list environment name=value pairs matching 'string'",
964 setenv, CONFIG_SYS_MAXARGS, 0, do_env_set,
965 "set environment variables",
967 " - set environment variable 'name' to 'value ...'\n"
969 " - delete environment variable 'name'",
973 #if defined(CONFIG_CMD_ASKENV)
976 askenv, CONFIG_SYS_MAXARGS, 1, do_env_ask,
977 "get environment variables from stdin",
978 "name [message] [size]\n"
979 " - get environment variable 'name' from stdin (max 'size' chars)\n"
981 " - get environment variable 'name' from stdin\n"
983 " - get environment variable 'name' from stdin (max 'size' chars)\n"
984 "askenv name [message] size\n"
985 " - display 'message' string and get environment variable 'name'"
986 "from stdin (max 'size' chars)"
990 #if defined(CONFIG_CMD_RUN)
992 run, CONFIG_SYS_MAXARGS, 1, do_run,
993 "run commands in an environment variable",
995 " - run the commands in the environment variable(s) 'var'",