2 * (C) Copyright 2000-2002
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,
27 /**************************************************************************
29 * Support for persistent environment data
31 * The "environment" is stored as a list of '\0' terminated
32 * "name=value" strings. The end of the list is marked by a double
33 * '\0'. New entries are always added at the end. Deleting an entry
34 * shifts the remaining entries to the front. Replacing an entry is a
35 * combination of deleting the old value and adding the new one.
37 * The environment is preceeded by a 32 bit CRC over the data part.
39 **************************************************************************
44 #include <environment.h>
45 #if defined(CONFIG_CMD_EDITENV)
50 #include <linux/stddef.h>
51 #include <asm/byteorder.h>
52 #if defined(CONFIG_CMD_NET)
56 DECLARE_GLOBAL_DATA_PTR;
58 #if !defined(CONFIG_ENV_IS_IN_EEPROM) && \
59 !defined(CONFIG_ENV_IS_IN_FLASH) && \
60 !defined(CONFIG_ENV_IS_IN_DATAFLASH) && \
61 !defined(CONFIG_ENV_IS_IN_MG_DISK) && \
62 !defined(CONFIG_ENV_IS_IN_MMC) && \
63 !defined(CONFIG_ENV_IS_IN_NAND) && \
64 !defined(CONFIG_ENV_IS_IN_NVRAM) && \
65 !defined(CONFIG_ENV_IS_IN_ONENAND) && \
66 !defined(CONFIG_ENV_IS_IN_SPI_FLASH) && \
67 !defined(CONFIG_ENV_IS_NOWHERE)
68 # error Define one of CONFIG_ENV_IS_IN_{EEPROM|FLASH|DATAFLASH|ONENAND|\
69 SPI_FLASH|MG_DISK|NVRAM|MMC|NOWHERE}
73 #define MK_STR(x) XMK_STR(x)
75 /************************************************************************
76 ************************************************************************/
79 * Table with supported baudrates (defined in config_xyz.h)
81 static const unsigned long baudrate_table[] = CONFIG_SYS_BAUDRATE_TABLE;
82 #define N_BAUDRATES (sizeof(baudrate_table) / sizeof(baudrate_table[0]))
85 * This variable is incremented on each do_setenv (), so it can
86 * be used via get_env_id() as an indication, if the environment
87 * has changed or not. So it is possible to reread an environment
88 * variable only if the environment was changed ... done so for
89 * example in NetInitLoop()
91 static int env_id = 1;
97 /************************************************************************
98 * Command interface: print one or all environment variables
102 * state 0: finish printing this string and return (matched!)
103 * state 1: no matching to be done; print everything
104 * state 2: continue searching for matched name
106 static int printenv(char *name, int state)
114 while (state && env_get_char(i) != '\0') {
115 if (state == 2 && envmatch((uchar *)name, i) >= 0)
120 buf[j++] = c = env_get_char(i++);
121 if (j == sizeof(buf) - 1) {
143 int do_printenv (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
149 /* print all env vars */
150 rcode = printenv(NULL, 1);
153 printf("\nEnvironment size: %d/%ld bytes\n",
154 rcode, (ulong)ENV_SIZE);
158 /* print selected env vars */
159 for (i = 1; i < argc; ++i) {
160 char *name = argv[i];
161 if (printenv(name, 2)) {
162 printf("## Error: \"%s\" not defined\n", name);
170 /************************************************************************
171 * Set a new environment variable,
172 * or replace or delete an existing one.
174 * This function will ONLY work with a in-RAM copy of the environment
177 int _do_setenv (int flag, int argc, char * const argv[])
181 uchar *env, *nxt = NULL;
185 uchar *env_data = env_get_addr(0);
187 if (!env_data) /* need copy in RAM */
192 if (strchr(name, '=')) {
193 printf ("## Error: illegal character '=' in variable name \"%s\"\n", name);
199 * search if variable with this name already exists
202 for (env=env_data; *env; env=nxt+1) {
203 for (nxt=env; *nxt; ++nxt)
205 if ((oldval = envmatch((uchar *)name, env-env_data)) >= 0)
209 /* Check for console redirection */
210 if (strcmp(name,"stdin") == 0) {
212 } else if (strcmp(name,"stdout") == 0) {
214 } else if (strcmp(name,"stderr") == 0) {
219 if (argc < 3) { /* Cannot delete it! */
220 printf("Can't delete \"%s\"\n", name);
224 #ifdef CONFIG_CONSOLE_MUX
225 i = iomux_doenv(console, argv[2]);
229 /* Try assigning specified device */
230 if (console_assign (console, argv[2]) < 0)
233 #ifdef CONFIG_SERIAL_MULTI
234 if (serial_assign (argv[2]) < 0)
237 #endif /* CONFIG_CONSOLE_MUX */
241 * Delete any existing definition
244 #ifndef CONFIG_ENV_OVERWRITE
247 * Ethernet Address and serial# can be set only once,
251 (strcmp (name, "serial#") == 0) ||
252 ((strcmp (name, "ethaddr") == 0)
253 #if defined(CONFIG_OVERWRITE_ETHADDR_ONCE) && defined(CONFIG_ETHADDR)
254 && (strcmp ((char *)env_get_addr(oldval),MK_STR(CONFIG_ETHADDR)) != 0)
255 #endif /* CONFIG_OVERWRITE_ETHADDR_ONCE && CONFIG_ETHADDR */
257 printf ("Can't overwrite \"%s\"\n", name);
263 * Switch to new baudrate if new baudrate is supported
265 if (strcmp(argv[1],"baudrate") == 0) {
266 int baudrate = simple_strtoul(argv[2], NULL, 10);
268 for (i=0; i<N_BAUDRATES; ++i) {
269 if (baudrate == baudrate_table[i])
272 if (i == N_BAUDRATES) {
273 printf ("## Baudrate %d bps not supported\n",
277 printf ("## Switch baudrate to %d bps and press ENTER ...\n",
280 gd->baudrate = baudrate;
281 #if defined(CONFIG_PPC) || defined(CONFIG_MCF52x2)
282 gd->bd->bi_baudrate = baudrate;
293 if (*++nxt == '\0') {
294 if (env > env_data) {
302 if ((*env == '\0') && (*nxt == '\0'))
311 if ((argc < 3) || argv[2] == NULL) {
317 * Append new definition at the end
319 for (env=env_data; *env || *(env+1); ++env)
325 * "name" + "=" + "val" +"\0\0" > ENV_SIZE - (env-env_data)
327 len = strlen(name) + 2;
328 /* add '=' for first arg, ' ' for all others */
329 for (i=2; i<argc; ++i) {
330 len += strlen(argv[i]) + 1;
332 if (len > (&env_data[ENV_SIZE]-env)) {
333 printf ("## Error: environment overflow, \"%s\" deleted\n", name);
336 while ((*env = *name++) != '\0')
338 for (i=2; i<argc; ++i) {
341 *env = (i==2) ? '=' : ' ';
342 while ((*++env = *val++) != '\0')
346 /* end is marked with double '\0' */
353 * Some variables should be updated when the corresponding
354 * entry in the enviornment is changed
357 if (strcmp(argv[1],"ethaddr") == 0)
360 if (strcmp(argv[1],"ipaddr") == 0) {
361 char *s = argv[2]; /* always use only one arg */
365 for (addr=0, i=0; i<4; ++i) {
366 ulong val = s ? simple_strtoul(s, &e, 10) : 0;
368 addr |= (val & 0xFF);
369 if (s) s = (*e) ? e+1 : e;
371 bd->bi_ip_addr = htonl(addr);
374 if (strcmp(argv[1],"loadaddr") == 0) {
375 load_addr = simple_strtoul(argv[2], NULL, 16);
378 #if defined(CONFIG_CMD_NET)
379 if (strcmp(argv[1],"bootfile") == 0) {
380 copy_filename (BootFile, argv[2], sizeof(BootFile));
387 int setenv (char *varname, char *varvalue)
389 char * const argv[4] = { "setenv", varname, varvalue, NULL };
390 if ((varvalue == NULL) || (varvalue[0] == '\0'))
391 return _do_setenv (0, 2, argv);
393 return _do_setenv (0, 3, argv);
396 int do_setenv (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
399 return cmd_usage(cmdtp);
401 return _do_setenv (flag, argc, argv);
404 /************************************************************************
405 * Prompt for environment variable
408 #if defined(CONFIG_CMD_ASKENV)
409 int do_askenv ( cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
411 extern char console_buffer[CONFIG_SYS_CBSIZE];
412 char message[CONFIG_SYS_CBSIZE];
413 int size = CONFIG_SYS_CBSIZE - 1;
417 local_args[0] = argv[0];
418 local_args[1] = argv[1];
419 local_args[2] = NULL;
420 local_args[3] = NULL;
423 return cmd_usage(cmdtp);
425 /* Check the syntax */
428 return cmd_usage(cmdtp);
430 case 2: /* askenv envname */
431 sprintf (message, "Please enter '%s':", argv[1]);
434 case 3: /* askenv envname size */
435 sprintf (message, "Please enter '%s':", argv[1]);
436 size = simple_strtoul (argv[2], NULL, 10);
439 default: /* askenv envname message1 ... messagen size */
444 for (i = 2; i < argc - 1; i++) {
446 message[pos++] = ' ';
448 strcpy (message+pos, argv[i]);
449 pos += strlen(argv[i]);
452 size = simple_strtoul (argv[argc - 1], NULL, 10);
457 if (size >= CONFIG_SYS_CBSIZE)
458 size = CONFIG_SYS_CBSIZE - 1;
463 /* prompt for input */
464 len = readline (message);
467 console_buffer[size] = '\0';
470 if (console_buffer[0] != '\0') {
471 local_args[2] = console_buffer;
475 /* Continue calling setenv code */
476 return _do_setenv (flag, len, local_args);
480 /************************************************************************
481 * Interactively edit an environment variable
483 #if defined(CONFIG_CMD_EDITENV)
484 int do_editenv(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
486 char buffer[CONFIG_SYS_CBSIZE];
491 return cmd_usage(cmdtp);
493 /* Set read buffer to initial value or empty sting */
494 init_val = getenv(argv[1]);
496 len = sprintf(buffer, "%s", init_val);
500 readline_into_buffer("edit: ", buffer);
502 return setenv(argv[1], buffer);
504 #endif /* CONFIG_CMD_EDITENV */
506 /************************************************************************
507 * Look up variable from environment,
508 * return address of storage for that variable,
509 * or NULL if not found
512 char *getenv (char *name)
514 if (gd->flags & GD_FLG_RELOC) { /* full C runtime after reloc */
519 for (i=0; env_get_char(i) != '\0'; i=nxt+1) {
522 for (nxt=i; env_get_char(nxt) != '\0'; ++nxt) {
523 if (nxt >= CONFIG_ENV_SIZE) {
527 if ((val=envmatch((uchar *)name, i)) < 0)
529 return ((char *)env_get_addr(val));
535 /* restricted C runtime before reloc */
537 return ((getenv_f(name,gd->env_buf,sizeof(gd->env_buf)) > 0) ?
541 int getenv_f(char *name, char *buf, unsigned len)
545 for (i=0; env_get_char(i) != '\0'; i=nxt+1) {
548 for (nxt=i; env_get_char(nxt) != '\0'; ++nxt) {
549 if (nxt >= CONFIG_ENV_SIZE) {
553 if ((val=envmatch((uchar *)name, i)) < 0)
556 /* found; copy out */
557 for (n=0; n<len; ++n, ++buf) {
558 if ((*buf = env_get_char(val++)) == '\0')
565 printf("env_buf too small [%d]\n", len);
572 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
574 int do_saveenv (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
576 extern char * env_name_spec;
578 printf ("Saving Environment to %s...\n", env_name_spec);
580 return (saveenv() ? 1 : 0);
584 saveenv, 1, 0, do_saveenv,
585 "save environment variables to persistent storage",
592 /************************************************************************
593 * Match a name / name=value pair
595 * s1 is either a simple 'name', or a 'name=value' pair.
596 * i2 is the environment index for a 'name2=value2' pair.
597 * If the names match, return the index for the value2, else NULL.
600 int envmatch (uchar *s1, int i2)
603 while (*s1 == env_get_char(i2++))
606 if (*s1 == '\0' && env_get_char(i2-1) == '=')
612 /**************************************************/
614 #if defined(CONFIG_CMD_EDITENV)
616 editenv, 2, 0, do_editenv,
617 "edit environment variable",
619 " - edit environment variable 'name'"
624 printenv, CONFIG_SYS_MAXARGS, 1, do_printenv,
625 "print environment variables",
626 "\n - print values of all environment variables\n"
627 "printenv name ...\n"
628 " - print value of environment variable 'name'"
632 setenv, CONFIG_SYS_MAXARGS, 0, do_setenv,
633 "set environment variables",
635 " - set environment variable 'name' to 'value ...'\n"
637 " - delete environment variable 'name'"
640 #if defined(CONFIG_CMD_ASKENV)
643 askenv, CONFIG_SYS_MAXARGS, 1, do_askenv,
644 "get environment variables from stdin",
645 "name [message] [size]\n"
646 " - get environment variable 'name' from stdin (max 'size' chars)\n"
648 " - get environment variable 'name' from stdin\n"
650 " - get environment variable 'name' from stdin (max 'size' chars)\n"
651 "askenv name [message] size\n"
652 " - display 'message' string and get environment variable 'name'"
653 "from stdin (max 'size' chars)"
657 #if defined(CONFIG_CMD_RUN)
658 int do_run (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
660 run, CONFIG_SYS_MAXARGS, 1, do_run,
661 "run commands in an environment variable",
663 " - run the commands in the environment variable(s) 'var'"