2 * (C) Copyright 2000-2010
5 * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
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)
233 if (argc < 3) { /* Cannot delete it! */
234 printf("Can't delete \"%s\"\n", name);
238 #ifdef CONFIG_CONSOLE_MUX
239 i = iomux_doenv(console, argv[2]);
243 /* Try assigning specified device */
244 if (console_assign(console, argv[2]) < 0)
247 #ifdef CONFIG_SERIAL_MULTI
248 if (serial_assign(argv[2]) < 0)
251 #endif /* CONFIG_CONSOLE_MUX */
255 * Some variables like "ethaddr" and "serial#" can be set only
256 * once and cannot be deleted; also, "ver" is readonly.
258 if (ep) { /* variable exists */
259 #ifndef CONFIG_ENV_OVERWRITE
260 if ((strcmp(name, "serial#") == 0) ||
261 ((strcmp(name, "ethaddr") == 0)
262 #if defined(CONFIG_OVERWRITE_ETHADDR_ONCE) && defined(CONFIG_ETHADDR)
263 && (strcmp(ep->data, MK_STR(CONFIG_ETHADDR)) != 0)
264 #endif /* CONFIG_OVERWRITE_ETHADDR_ONCE && CONFIG_ETHADDR */
266 printf("Can't overwrite \"%s\"\n", name);
271 * Switch to new baudrate if new baudrate is supported
273 if (strcmp(name, "baudrate") == 0) {
274 int baudrate = simple_strtoul(argv[2], NULL, 10);
276 for (i = 0; i < N_BAUDRATES; ++i) {
277 if (baudrate == baudrate_table[i])
280 if (i == N_BAUDRATES) {
281 printf("## Baudrate %d bps not supported\n",
285 printf ("## Switch baudrate to %d bps and press ENTER ...\n",
288 gd->baudrate = baudrate;
289 #if defined(CONFIG_PPC) || defined(CONFIG_MCF52x2)
290 gd->bd->bi_baudrate = baudrate;
303 if ((argc < 3) || argv[2] == NULL) {
304 int rc = hdelete_r(name, &env_htab);
309 * Insert / replace new value
311 for (i = 2, len = 0; i < argc; ++i)
312 len += strlen(argv[i]) + 1;
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(const char *varname, const char *varvalue)
372 const char * const argv[4] = { "setenv", varname, varvalue, NULL };
374 if ((varvalue == NULL) || (varvalue[0] == '\0'))
375 return _do_env_set(0, 2, (char * const *)argv);
377 return _do_env_set(0, 3, (char * const *)argv);
380 int do_env_set(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
383 return cmd_usage(cmdtp);
385 return _do_env_set(flag, argc, argv);
389 * Prompt for environment variable
391 #if defined(CONFIG_CMD_ASKENV)
392 int do_env_ask(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
394 extern char console_buffer[CONFIG_SYS_CBSIZE];
395 char message[CONFIG_SYS_CBSIZE];
396 int size = CONFIG_SYS_CBSIZE - 1;
400 local_args[0] = argv[0];
401 local_args[1] = argv[1];
402 local_args[2] = NULL;
403 local_args[3] = NULL;
405 /* Check the syntax */
408 return cmd_usage(cmdtp);
410 case 2: /* env_ask envname */
411 sprintf(message, "Please enter '%s':", argv[1]);
414 case 3: /* env_ask envname size */
415 sprintf(message, "Please enter '%s':", argv[1]);
416 size = simple_strtoul(argv[2], NULL, 10);
419 default: /* env_ask envname message1 ... messagen size */
420 for (i = 2, pos = 0; i < argc - 1; i++) {
422 message[pos++] = ' ';
424 strcpy(message+pos, argv[i]);
425 pos += strlen(argv[i]);
428 size = simple_strtoul(argv[argc - 1], NULL, 10);
432 if (size >= CONFIG_SYS_CBSIZE)
433 size = CONFIG_SYS_CBSIZE - 1;
438 /* prompt for input */
439 len = readline(message);
442 console_buffer[size] = '\0';
445 if (console_buffer[0] != '\0') {
446 local_args[2] = console_buffer;
450 /* Continue calling setenv code */
451 return _do_env_set(flag, len, local_args);
456 * Interactively edit an environment variable
458 #if defined(CONFIG_CMD_EDITENV)
459 int do_env_edit(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
461 char buffer[CONFIG_SYS_CBSIZE];
466 return cmd_usage(cmdtp);
468 /* Set read buffer to initial value or empty sting */
469 init_val = getenv(argv[1]);
471 len = sprintf(buffer, "%s", init_val);
475 readline_into_buffer("edit: ", buffer);
477 return setenv(argv[1], buffer);
479 #endif /* CONFIG_CMD_EDITENV */
482 * Look up variable from environment,
483 * return address of storage for that variable,
484 * or NULL if not found
486 char *getenv(const char *name)
488 if (gd->flags & GD_FLG_ENV_READY) { /* after import into hashtable */
495 hsearch_r(e, FIND, &ep, &env_htab);
497 return ep ? ep->data : NULL;
500 /* restricted capabilities before import */
502 if (getenv_f(name, (char *)(gd->env_buf), sizeof(gd->env_buf)) > 0)
503 return (char *)(gd->env_buf);
509 * Look up variable from environment for restricted C runtime env.
511 int getenv_f(const char *name, char *buf, unsigned len)
515 for (i = 0; env_get_char(i) != '\0'; i = nxt+1) {
518 for (nxt = i; env_get_char(nxt) != '\0'; ++nxt) {
519 if (nxt >= CONFIG_ENV_SIZE)
523 val = envmatch((uchar *)name, i);
527 /* found; copy out */
528 for (n = 0; n < len; ++n, ++buf) {
529 if ((*buf = env_get_char(val++)) == '\0')
536 printf("env_buf [%d bytes] too small for value of \"%s\"\n",
544 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
546 int do_env_save(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
548 extern char *env_name_spec;
550 printf("Saving Environment to %s...\n", env_name_spec);
552 return saveenv() ? 1 : 0;
556 saveenv, 1, 0, do_env_save,
557 "save environment variables to persistent storage",
565 * Match a name / name=value pair
567 * s1 is either a simple 'name', or a 'name=value' pair.
568 * i2 is the environment index for a 'name2=value2' pair.
569 * If the names match, return the index for the value2, else NULL.
572 int envmatch(uchar *s1, int i2)
574 while (*s1 == env_get_char(i2++))
577 if (*s1 == '\0' && env_get_char(i2-1) == '=')
582 static int do_env_default(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
584 if ((argc != 2) || (strcmp(argv[1], "-f") != 0))
585 return cmd_usage(cmdtp);
587 set_default_env("## Resetting to default environment\n");
591 static int do_env_delete(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
593 printf("Not implemented yet\n");
597 #ifdef CONFIG_CMD_EXPORTENV
599 * env export [-t | -b | -c] addr [size]
600 * -t: export as text format; if size is given, data will be
601 * padded with '\0' bytes; if not, one terminating '\0'
602 * will be added (which is included in the "filesize"
603 * setting so you can for exmple copy this to flash and
604 * keep the termination).
605 * -b: export as binary format (name=value pairs separated by
606 * '\0', list end marked by double "\0\0")
607 * -c: export as checksum protected environment format as
608 * used for example by "saveenv" command
609 * addr: memory address where environment gets stored
610 * size: size of output buffer
612 * With "-c" and size is NOT given, then the export command will
613 * format the data as currently used for the persistent storage,
614 * i. e. it will use CONFIG_ENV_SECT_SIZE as output block size and
615 * prepend a valid CRC32 checksum and, in case of resundant
616 * environment, a "current" redundancy flag. If size is given, this
617 * value will be used instead of CONFIG_ENV_SECT_SIZE; again, CRC32
618 * checksum and redundancy flag will be inserted.
620 * With "-b" and "-t", always only the real data (including a
621 * terminating '\0' byte) will be written; here the optional size
622 * argument will be used to make sure not to overflow the user
623 * provided buffer; the command will abort if the size is not
624 * sufficient. Any remainign space will be '\0' padded.
626 * On successful return, the variable "filesize" will be set.
627 * Note that filesize includes the trailing/terminating '\0' byte(s).
629 * Usage szenario: create a text snapshot/backup of the current settings:
631 * => env export -t 100000
632 * => era ${backup_addr} +${filesize}
633 * => cp.b 100000 ${backup_addr} ${filesize}
635 * Re-import this snapshot, deleting all other settings:
637 * => env import -d -t ${backup_addr}
639 static int do_env_export(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
642 char *addr, *cmd, *res;
652 while (--argc > 0 && **++argv == '-') {
656 case 'b': /* raw binary format */
661 case 'c': /* external checksum format */
667 case 't': /* text format */
673 return cmd_usage(cmdtp);
679 return cmd_usage(cmdtp);
681 addr = (char *)simple_strtoul(argv[0], NULL, 16);
684 size = simple_strtoul(argv[1], NULL, 16);
685 memset(addr, '\0', size);
690 if (sep) { /* export as text file */
691 len = hexport_r(&env_htab, sep, &addr, size);
693 error("Cannot export environment: errno = %d\n",
697 sprintf(buf, "%zX", (size_t)len);
698 setenv("filesize", buf);
703 envp = (env_t *)addr;
705 if (chk) /* export as checksum protected block */
706 res = (char *)envp->data;
707 else /* export as raw binary data */
710 len = hexport_r(&env_htab, '\0', &res, ENV_SIZE);
712 error("Cannot export environment: errno = %d\n",
718 envp->crc = crc32(0, envp->data, ENV_SIZE);
719 #ifdef CONFIG_ENV_ADDR_REDUND
720 envp->flags = ACTIVE_FLAG;
723 sprintf(buf, "%zX", (size_t)(len + offsetof(env_t, data)));
724 setenv("filesize", buf);
729 printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n",
735 #ifdef CONFIG_CMD_IMPORTENV
737 * env import [-d] [-t | -b | -c] addr [size]
738 * -d: delete existing environment before importing;
739 * otherwise overwrite / append to existion definitions
740 * -t: assume text format; either "size" must be given or the
741 * text data must be '\0' terminated
742 * -b: assume binary format ('\0' separated, "\0\0" terminated)
743 * -c: assume checksum protected environment format
744 * addr: memory address to read from
745 * size: length of input data; if missing, proper '\0'
746 * termination is mandatory
748 static int do_env_import(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
759 while (--argc > 0 && **++argv == '-') {
763 case 'b': /* raw binary format */
768 case 'c': /* external checksum format */
774 case 't': /* text format */
783 return cmd_usage(cmdtp);
789 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'",