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_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|NOWHERE}
72 #define MK_STR(x) XMK_STR(x)
74 /************************************************************************
75 ************************************************************************/
78 * Table with supported baudrates (defined in config_xyz.h)
80 static const unsigned long baudrate_table
[] = CONFIG_SYS_BAUDRATE_TABLE
;
81 #define N_BAUDRATES (sizeof(baudrate_table) / sizeof(baudrate_table[0]))
84 * This variable is incremented on each do_setenv (), so it can
85 * be used via get_env_id() as an indication, if the environment
86 * has changed or not. So it is possible to reread an environment
87 * variable only if the environment was changed ... done so for
88 * example in NetInitLoop()
90 static int env_id
= 1;
96 /************************************************************************
97 * Command interface: print one or all environment variables
101 * state 0: finish printing this string and return (matched!)
102 * state 1: no matching to be done; print everything
103 * state 2: continue searching for matched name
105 static int printenv(char *name
, int state
)
113 while (state
&& env_get_char(i
) != '\0') {
114 if (state
== 2 && envmatch((uchar
*)name
, i
) >= 0)
119 buf
[j
++] = c
= env_get_char(i
++);
120 if (j
== sizeof(buf
) - 1) {
142 int do_printenv (cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
148 /* print all env vars */
149 rcode
= printenv(NULL
, 1);
152 printf("\nEnvironment size: %d/%ld bytes\n",
153 rcode
, (ulong
)ENV_SIZE
);
157 /* print selected env vars */
158 for (i
= 1; i
< argc
; ++i
) {
159 char *name
= argv
[i
];
160 if (printenv(name
, 2)) {
161 printf("## Error: \"%s\" not defined\n", name
);
169 /************************************************************************
170 * Set a new environment variable,
171 * or replace or delete an existing one.
173 * This function will ONLY work with a in-RAM copy of the environment
176 int _do_setenv (int flag
, int argc
, char * const argv
[])
180 uchar
*env
, *nxt
= NULL
;
184 uchar
*env_data
= env_get_addr(0);
186 if (!env_data
) /* need copy in RAM */
191 if (strchr(name
, '=')) {
192 printf ("## Error: illegal character '=' in variable name \"%s\"\n", name
);
198 * search if variable with this name already exists
201 for (env
=env_data
; *env
; env
=nxt
+1) {
202 for (nxt
=env
; *nxt
; ++nxt
)
204 if ((oldval
= envmatch((uchar
*)name
, env
-env_data
)) >= 0)
208 /* Check for console redirection */
209 if (strcmp(name
,"stdin") == 0) {
211 } else if (strcmp(name
,"stdout") == 0) {
213 } else if (strcmp(name
,"stderr") == 0) {
218 if (argc
< 3) { /* Cannot delete it! */
219 printf("Can't delete \"%s\"\n", name
);
223 #ifdef CONFIG_CONSOLE_MUX
224 i
= iomux_doenv(console
, argv
[2]);
228 /* Try assigning specified device */
229 if (console_assign (console
, argv
[2]) < 0)
232 #ifdef CONFIG_SERIAL_MULTI
233 if (serial_assign (argv
[2]) < 0)
236 #endif /* CONFIG_CONSOLE_MUX */
240 * Delete any existing definition
243 #ifndef CONFIG_ENV_OVERWRITE
246 * Ethernet Address and serial# can be set only once,
250 #ifdef CONFIG_HAS_UID
251 /* Allow serial# forced overwrite with 0xdeaf4add flag */
252 ((strcmp (name
, "serial#") == 0) && (flag
!= 0xdeaf4add)) ||
254 (strcmp (name
, "serial#") == 0) ||
256 ((strcmp (name
, "ethaddr") == 0)
257 #if defined(CONFIG_OVERWRITE_ETHADDR_ONCE) && defined(CONFIG_ETHADDR)
258 && (strcmp ((char *)env_get_addr(oldval
),MK_STR(CONFIG_ETHADDR
)) != 0)
259 #endif /* CONFIG_OVERWRITE_ETHADDR_ONCE && CONFIG_ETHADDR */
261 printf ("Can't overwrite \"%s\"\n", name
);
267 * Switch to new baudrate if new baudrate is supported
269 if (strcmp(argv
[1],"baudrate") == 0) {
270 int baudrate
= simple_strtoul(argv
[2], NULL
, 10);
272 for (i
=0; i
<N_BAUDRATES
; ++i
) {
273 if (baudrate
== baudrate_table
[i
])
276 if (i
== N_BAUDRATES
) {
277 printf ("## Baudrate %d bps not supported\n",
281 printf ("## Switch baudrate to %d bps and press ENTER ...\n",
284 gd
->baudrate
= baudrate
;
285 #if defined(CONFIG_PPC) || defined(CONFIG_MCF52x2)
286 gd
->bd
->bi_baudrate
= baudrate
;
297 if (*++nxt
== '\0') {
298 if (env
> env_data
) {
306 if ((*env
== '\0') && (*nxt
== '\0'))
315 if ((argc
< 3) || argv
[2] == NULL
) {
321 * Append new definition at the end
323 for (env
=env_data
; *env
|| *(env
+1); ++env
)
329 * "name" + "=" + "val" +"\0\0" > ENV_SIZE - (env-env_data)
331 len
= strlen(name
) + 2;
332 /* add '=' for first arg, ' ' for all others */
333 for (i
=2; i
<argc
; ++i
) {
334 len
+= strlen(argv
[i
]) + 1;
336 if (len
> (&env_data
[ENV_SIZE
]-env
)) {
337 printf ("## Error: environment overflow, \"%s\" deleted\n", name
);
340 while ((*env
= *name
++) != '\0')
342 for (i
=2; i
<argc
; ++i
) {
345 *env
= (i
==2) ? '=' : ' ';
346 while ((*++env
= *val
++) != '\0')
350 /* end is marked with double '\0' */
357 * Some variables should be updated when the corresponding
358 * entry in the enviornment is changed
361 if (strcmp(argv
[1],"ethaddr") == 0)
364 if (strcmp(argv
[1],"ipaddr") == 0) {
365 char *s
= argv
[2]; /* always use only one arg */
369 for (addr
=0, i
=0; i
<4; ++i
) {
370 ulong val
= s
? simple_strtoul(s
, &e
, 10) : 0;
372 addr
|= (val
& 0xFF);
373 if (s
) s
= (*e
) ? e
+1 : e
;
375 bd
->bi_ip_addr
= htonl(addr
);
378 if (strcmp(argv
[1],"loadaddr") == 0) {
379 load_addr
= simple_strtoul(argv
[2], NULL
, 16);
382 #if defined(CONFIG_CMD_NET)
383 if (strcmp(argv
[1],"bootfile") == 0) {
384 copy_filename (BootFile
, argv
[2], sizeof(BootFile
));
391 int setenv (char *varname
, char *varvalue
)
393 char * const argv
[4] = { "setenv", varname
, varvalue
, NULL
};
394 if ((varvalue
== NULL
) || (varvalue
[0] == '\0'))
395 return _do_setenv (0, 2, argv
);
397 return _do_setenv (0, 3, argv
);
400 #ifdef CONFIG_HAS_UID
401 void forceenv (char *varname
, char *varvalue
)
403 char * const argv
[4] = { "forceenv", varname
, varvalue
, NULL
};
404 _do_setenv (0xdeaf4add, 3, argv
);
408 int do_setenv (cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
411 return cmd_usage(cmdtp
);
413 return _do_setenv (flag
, argc
, argv
);
416 /************************************************************************
417 * Prompt for environment variable
420 #if defined(CONFIG_CMD_ASKENV)
421 int do_askenv ( cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
423 extern char console_buffer
[CONFIG_SYS_CBSIZE
];
424 char message
[CONFIG_SYS_CBSIZE
];
425 int size
= CONFIG_SYS_CBSIZE
- 1;
429 local_args
[0] = argv
[0];
430 local_args
[1] = argv
[1];
431 local_args
[2] = NULL
;
432 local_args
[3] = NULL
;
435 return cmd_usage(cmdtp
);
437 /* Check the syntax */
440 return cmd_usage(cmdtp
);
442 case 2: /* askenv envname */
443 sprintf (message
, "Please enter '%s':", argv
[1]);
446 case 3: /* askenv envname size */
447 sprintf (message
, "Please enter '%s':", argv
[1]);
448 size
= simple_strtoul (argv
[2], NULL
, 10);
451 default: /* askenv envname message1 ... messagen size */
456 for (i
= 2; i
< argc
- 1; i
++) {
458 message
[pos
++] = ' ';
460 strcpy (message
+pos
, argv
[i
]);
461 pos
+= strlen(argv
[i
]);
464 size
= simple_strtoul (argv
[argc
- 1], NULL
, 10);
469 if (size
>= CONFIG_SYS_CBSIZE
)
470 size
= CONFIG_SYS_CBSIZE
- 1;
475 /* prompt for input */
476 len
= readline (message
);
479 console_buffer
[size
] = '\0';
482 if (console_buffer
[0] != '\0') {
483 local_args
[2] = console_buffer
;
487 /* Continue calling setenv code */
488 return _do_setenv (flag
, len
, local_args
);
492 /************************************************************************
493 * Interactively edit an environment variable
495 #if defined(CONFIG_CMD_EDITENV)
496 int do_editenv(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
498 char buffer
[CONFIG_SYS_CBSIZE
];
503 return cmd_usage(cmdtp
);
505 /* Set read buffer to initial value or empty sting */
506 init_val
= getenv(argv
[1]);
508 len
= sprintf(buffer
, "%s", init_val
);
512 readline_into_buffer("edit: ", buffer
);
514 return setenv(argv
[1], buffer
);
516 #endif /* CONFIG_CMD_EDITENV */
518 /************************************************************************
519 * Look up variable from environment,
520 * return address of storage for that variable,
521 * or NULL if not found
524 char *getenv (char *name
)
530 for (i
=0; env_get_char(i
) != '\0'; i
=nxt
+1) {
533 for (nxt
=i
; env_get_char(nxt
) != '\0'; ++nxt
) {
534 if (nxt
>= CONFIG_ENV_SIZE
) {
538 if ((val
=envmatch((uchar
*)name
, i
)) < 0)
540 return ((char *)env_get_addr(val
));
546 int getenv_r (char *name
, char *buf
, unsigned len
)
550 for (i
=0; env_get_char(i
) != '\0'; i
=nxt
+1) {
553 for (nxt
=i
; env_get_char(nxt
) != '\0'; ++nxt
) {
554 if (nxt
>= CONFIG_ENV_SIZE
) {
558 if ((val
=envmatch((uchar
*)name
, i
)) < 0)
560 /* found; copy out */
562 while ((len
> n
++) && (*buf
++ = env_get_char(val
++)) != '\0')
571 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
573 int do_saveenv (cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
575 extern char * env_name_spec
;
577 printf ("Saving Environment to %s...\n", env_name_spec
);
579 return (saveenv() ? 1 : 0);
583 saveenv
, 1, 0, do_saveenv
,
584 "save environment variables to persistent storage",
591 /************************************************************************
592 * Match a name / name=value pair
594 * s1 is either a simple 'name', or a 'name=value' pair.
595 * i2 is the environment index for a 'name2=value2' pair.
596 * If the names match, return the index for the value2, else NULL.
599 int envmatch (uchar
*s1
, int i2
)
602 while (*s1
== env_get_char(i2
++))
605 if (*s1
== '\0' && env_get_char(i2
-1) == '=')
611 /**************************************************/
613 #if defined(CONFIG_CMD_EDITENV)
615 editenv
, 2, 0, do_editenv
,
616 "edit environment variable",
618 " - edit environment variable 'name'"
623 printenv
, CONFIG_SYS_MAXARGS
, 1, do_printenv
,
624 "print environment variables",
625 "\n - print values of all environment variables\n"
626 "printenv name ...\n"
627 " - print value of environment variable 'name'"
631 setenv
, CONFIG_SYS_MAXARGS
, 0, do_setenv
,
632 "set environment variables",
634 " - set environment variable 'name' to 'value ...'\n"
636 " - delete environment variable 'name'"
639 #if defined(CONFIG_CMD_ASKENV)
642 askenv
, CONFIG_SYS_MAXARGS
, 1, do_askenv
,
643 "get environment variables from stdin",
644 "name [message] [size]\n"
645 " - get environment variable 'name' from stdin (max 'size' chars)\n"
647 " - get environment variable 'name' from stdin\n"
649 " - get environment variable 'name' from stdin (max 'size' chars)\n"
650 "askenv name [message] size\n"
651 " - display 'message' string and get environment variable 'name'"
652 "from stdin (max 'size' chars)"
656 #if defined(CONFIG_CMD_RUN)
657 int do_run (cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[]);
659 run
, CONFIG_SYS_MAXARGS
, 1, do_run
,
660 "run commands in an environment variable",
662 " - run the commands in the environment variable(s) 'var'"