2 * (C) Copyright 2000-2003
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 * See file CREDITS for list of people who contributed to this
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License as
10 * published by the Free Software Foundation; either version 2 of
11 * the License, or (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
30 #include <sys/types.h>
31 #include <sys/ioctl.h>
34 #include <linux/mtd/mtd.h>
37 typedef unsigned char uchar;
39 #define CMD_GETENV "fw_printenv"
40 #define CMD_SETENV "fw_setenv"
42 typedef struct envdev_s {
43 uchar devname[16]; /* Device name */
44 ulong devoff; /* Device offset */
45 ulong env_size; /* environment size */
46 ulong erase_size; /* device erase size */
49 static envdev_t envdevices[2];
52 #define DEVNAME(i) envdevices[(i)].devname
53 #define DEVOFFSET(i) envdevices[(i)].devoff
54 #define ENVSIZE(i) envdevices[(i)].env_size
55 #define DEVESIZE(i) envdevices[(i)].erase_size
57 #define CFG_ENV_SIZE ENVSIZE(curdev)
59 #define ENV_SIZE getenvsize()
61 typedef struct environment_s {
62 ulong crc; /* CRC32 over data bytes */
63 uchar flags; /* active or obsolete */
67 static env_t environment;
69 static int HaveRedundEnv = 0;
71 static uchar active_flag = 1;
72 static uchar obsolete_flag = 0;
76 #define MK_STR(x) XMK_STR(x)
78 static uchar default_environment[] = {
79 #if defined(CONFIG_BOOTARGS)
80 "bootargs=" CONFIG_BOOTARGS "\0"
82 #if defined(CONFIG_BOOTCOMMAND)
83 "bootcmd=" CONFIG_BOOTCOMMAND "\0"
85 #if defined(CONFIG_RAMBOOTCOMMAND)
86 "ramboot=" CONFIG_RAMBOOTCOMMAND "\0"
88 #if defined(CONFIG_NFSBOOTCOMMAND)
89 "nfsboot=" CONFIG_NFSBOOTCOMMAND "\0"
91 #if defined(CONFIG_BOOTDELAY) && (CONFIG_BOOTDELAY >= 0)
92 "bootdelay=" MK_STR (CONFIG_BOOTDELAY) "\0"
94 #if defined(CONFIG_BAUDRATE) && (CONFIG_BAUDRATE >= 0)
95 "baudrate=" MK_STR (CONFIG_BAUDRATE) "\0"
97 #ifdef CONFIG_LOADS_ECHO
98 "loads_echo=" MK_STR (CONFIG_LOADS_ECHO) "\0"
100 #ifdef CONFIG_ETHADDR
101 "ethaddr=" MK_STR (CONFIG_ETHADDR) "\0"
103 #ifdef CONFIG_ETH1ADDR
104 "eth1addr=" MK_STR (CONFIG_ETH1ADDR) "\0"
106 #ifdef CONFIG_ETH2ADDR
107 "eth2addr=" MK_STR (CONFIG_ETH2ADDR) "\0"
109 #ifdef CONFIG_ETHPRIME
110 "ethprime=" CONFIG_ETHPRIME "\0"
113 "ipaddr=" MK_STR (CONFIG_IPADDR) "\0"
115 #ifdef CONFIG_SERVERIP
116 "serverip=" MK_STR (CONFIG_SERVERIP) "\0"
119 "autoload=" CFG_AUTOLOAD "\0"
121 #ifdef CONFIG_ROOTPATH
122 "rootpath=" MK_STR (CONFIG_ROOTPATH) "\0"
124 #ifdef CONFIG_GATEWAYIP
125 "gatewayip=" MK_STR (CONFIG_GATEWAYIP) "\0"
127 #ifdef CONFIG_NETMASK
128 "netmask=" MK_STR (CONFIG_NETMASK) "\0"
130 #ifdef CONFIG_HOSTNAME
131 "hostname=" MK_STR (CONFIG_HOSTNAME) "\0"
133 #ifdef CONFIG_BOOTFILE
134 "bootfile=" MK_STR (CONFIG_BOOTFILE) "\0"
136 #ifdef CONFIG_LOADADDR
137 "loadaddr=" MK_STR (CONFIG_LOADADDR) "\0"
139 #ifdef CONFIG_PREBOOT
140 "preboot=" CONFIG_PREBOOT "\0"
142 #ifdef CONFIG_CLOCKS_IN_MHZ
143 "clocks_in_mhz=" "1" "\0"
145 #if defined(CONFIG_PCI_BOOTDELAY) && (CONFIG_PCI_BOOTDELAY > 0)
146 "pcidelay=" MK_STR (CONFIG_PCI_BOOTDELAY) "\0"
148 #ifdef CONFIG_EXTRA_ENV_SETTINGS
149 CONFIG_EXTRA_ENV_SETTINGS
151 "\0" /* Termimate env_t data with 2 NULs */
154 static int flash_io (int mode);
155 static uchar *envmatch (uchar * s1, uchar * s2);
156 static int env_init (void);
157 static int parse_config (void);
159 #if defined(CONFIG_FILE)
160 static int get_config (char *);
162 static inline ulong getenvsize (void)
164 ulong rc = CFG_ENV_SIZE - sizeof (long);
172 * Search the environment for a variable.
173 * Return the value, if found, or NULL, if not found.
175 unsigned char *fw_getenv (unsigned char *name)
182 for (env = environment.data; *env; env = nxt + 1) {
185 for (nxt = env; *nxt; ++nxt) {
186 if (nxt >= &environment.data[ENV_SIZE]) {
187 fprintf (stderr, "## Error: "
188 "environment not terminated\n");
192 val = envmatch (name, env);
201 * Print the current definition of one, or more, or all
202 * environment variables
204 void fw_printenv (int argc, char *argv[])
212 if (argc == 1) { /* Print all env variables */
213 for (env = environment.data; *env; env = nxt + 1) {
214 for (nxt = env; *nxt; ++nxt) {
215 if (nxt >= &environment.data[ENV_SIZE]) {
216 fprintf (stderr, "## Error: "
217 "environment not terminated\n");
222 printf ("%s\n", env);
227 if (strcmp (argv[1], "-n") == 0) {
232 fprintf (stderr, "## Error: "
233 "`-n' option requires exactly one argument\n");
240 for (i = 1; i < argc; ++i) { /* print single env variables */
241 uchar *name = argv[i];
244 for (env = environment.data; *env; env = nxt + 1) {
246 for (nxt = env; *nxt; ++nxt) {
247 if (nxt >= &environment.data[ENV_SIZE]) {
248 fprintf (stderr, "## Error: "
249 "environment not terminated\n");
253 val = envmatch (name, env);
256 fputs (name, stdout);
264 fprintf (stderr, "## Error: \"%s\" not defined\n", name);
269 * Deletes or sets environment variables. Returns errno style error codes:
271 * EINVAL - need at least 1 argument
272 * EROFS - certain variables ("ethaddr", "serial#") cannot be
273 * modified or deleted
276 int fw_setenv (int argc, char *argv[])
280 uchar *oldval = NULL;
293 * search if variable with this name already exists
295 for (nxt = env = environment.data; *env; env = nxt + 1) {
296 for (nxt = env; *nxt; ++nxt) {
297 if (nxt >= &environment.data[ENV_SIZE]) {
298 fprintf (stderr, "## Error: "
299 "environment not terminated\n");
303 if ((oldval = envmatch (name, env)) != NULL)
308 * Delete any existing definition
312 * Ethernet Address and serial# can be set only once
314 if ((strcmp (name, "ethaddr") == 0) ||
315 (strcmp (name, "serial#") == 0)) {
316 fprintf (stderr, "Can't overwrite \"%s\"\n", name);
320 if (*++nxt == '\0') {
325 if ((*env == '\0') && (*nxt == '\0'))
338 * Append new definition at the end
340 for (env = environment.data; *env || *(env + 1); ++env);
341 if (env > environment.data)
345 * "name" + "=" + "val" +"\0\0" > CFG_ENV_SIZE - (env-environment)
347 len = strlen (name) + 2;
348 /* add '=' for first arg, ' ' for all others */
349 for (i = 2; i < argc; ++i) {
350 len += strlen (argv[i]) + 1;
352 if (len > (&environment.data[ENV_SIZE] - env)) {
354 "Error: environment overflow, \"%s\" deleted\n",
358 while ((*env = *name++) != '\0')
360 for (i = 2; i < argc; ++i) {
361 uchar *val = argv[i];
363 *env = (i == 2) ? '=' : ' ';
364 while ((*++env = *val++) != '\0');
367 /* end is marked with double '\0' */
373 environment.crc = crc32 (0, environment.data, ENV_SIZE);
375 /* write environment back to flash */
376 if (flash_io (O_RDWR)) {
377 fprintf (stderr, "Error: can't write fw_env to flash\n");
384 static int flash_io (int mode)
386 int fd, fdr, rc, otherdev, len, resid;
390 if ((fd = open (DEVNAME (curdev), mode)) < 0) {
392 "Can't open %s: %s\n",
393 DEVNAME (curdev), strerror (errno));
397 len = sizeof (environment.crc);
399 len += sizeof (environment.flags);
402 if (mode == O_RDWR) {
404 /* switch to next partition for writing */
406 if ((fdr = open (DEVNAME (otherdev), mode)) < 0) {
408 "Can't open %s: %s\n",
417 printf ("Unlocking flash...\n");
418 erase.length = DEVESIZE (otherdev);
419 erase.start = DEVOFFSET (otherdev);
420 ioctl (fdr, MEMUNLOCK, &erase);
423 erase.length = DEVESIZE (curdev);
424 erase.start = DEVOFFSET (curdev);
425 ioctl (fd, MEMUNLOCK, &erase);
426 environment.flags = active_flag;
430 resid = DEVESIZE (otherdev) - CFG_ENV_SIZE;
432 if ((data = malloc (resid)) == NULL) {
434 "Cannot malloc %d bytes: %s\n",
439 if (lseek (fdr, DEVOFFSET (otherdev) + CFG_ENV_SIZE, SEEK_SET)
441 fprintf (stderr, "seek error on %s: %s\n",
446 if ((rc = read (fdr, data, resid)) != resid) {
448 "read error on %s: %s\n",
455 printf ("Erasing old environment...\n");
457 erase.length = DEVESIZE (otherdev);
458 erase.start = DEVOFFSET (otherdev);
459 if (ioctl (fdr, MEMERASE, &erase) != 0) {
460 fprintf (stderr, "MTD erase error on %s: %s\n",
468 printf ("Writing environment to %s...\n", DEVNAME (otherdev));
469 if (lseek (fdr, DEVOFFSET (otherdev), SEEK_SET) == -1) {
471 "seek error on %s: %s\n",
472 DEVNAME (otherdev), strerror (errno));
475 if (write (fdr, &environment, len) != len) {
477 "CRC write error on %s: %s\n",
478 DEVNAME (otherdev), strerror (errno));
481 if (write (fdr, environment.data, ENV_SIZE) != ENV_SIZE) {
483 "Write error on %s: %s\n",
484 DEVNAME (otherdev), strerror (errno));
488 if (write (fdr, data, resid) != resid) {
490 "write error on %s: %s\n",
491 DEVNAME (curdev), strerror (errno));
497 /* change flag on current active env partition */
498 if (lseek (fd, DEVOFFSET (curdev) + sizeof (ulong), SEEK_SET)
500 fprintf (stderr, "seek error on %s: %s\n",
501 DEVNAME (curdev), strerror (errno));
504 if (write (fd, &obsolete_flag, sizeof (obsolete_flag)) !=
505 sizeof (obsolete_flag)) {
507 "Write error on %s: %s\n",
508 DEVNAME (curdev), strerror (errno));
513 printf ("Locking ...\n");
514 erase.length = DEVESIZE (otherdev);
515 erase.start = DEVOFFSET (otherdev);
516 ioctl (fdr, MEMLOCK, &erase);
518 erase.length = DEVESIZE (curdev);
519 erase.start = DEVOFFSET (curdev);
520 ioctl (fd, MEMLOCK, &erase);
523 "I/O error on %s: %s\n",
532 if (lseek (fd, DEVOFFSET (curdev), SEEK_SET) == -1) {
534 "seek error on %s: %s\n",
535 DEVNAME (curdev), strerror (errno));
538 if (read (fd, &environment, len) != len) {
540 "CRC read error on %s: %s\n",
541 DEVNAME (curdev), strerror (errno));
544 if ((rc = read (fd, environment.data, ENV_SIZE)) != ENV_SIZE) {
546 "Read error on %s: %s\n",
547 DEVNAME (curdev), strerror (errno));
554 "I/O error on %s: %s\n",
555 DEVNAME (curdev), strerror (errno));
564 * s1 is either a simple 'name', or a 'name=value' pair.
565 * s2 is a 'name=value' pair.
566 * If the names match, return the value of s2, else NULL.
569 static uchar *envmatch (uchar * s1, uchar * s2)
575 if (*s1 == '\0' && *(s2 - 1) == '=')
581 * Prevent confusion if running from erased flash memory
583 static int env_init (void)
589 uchar flag1, flag2, *addr2;
591 if (parse_config ()) /* should fill envdevices */
594 if ((addr1 = calloc (1, ENV_SIZE)) == NULL) {
596 "Not enough memory for environment (%ld bytes)\n",
601 /* read environment from FLASH to local buffer */
602 environment.data = addr1;
604 if (flash_io (O_RDONLY)) {
608 crc1_ok = ((crc1 = crc32 (0, environment.data, ENV_SIZE))
610 if (!HaveRedundEnv) {
613 "Warning: Bad CRC, using default environment\n");
614 environment.data = default_environment;
618 flag1 = environment.flags;
621 if ((addr2 = calloc (1, ENV_SIZE)) == NULL) {
623 "Not enough memory for environment (%ld bytes)\n",
627 environment.data = addr2;
629 if (flash_io (O_RDONLY)) {
633 crc2_ok = ((crc2 = crc32 (0, environment.data, ENV_SIZE))
635 flag2 = environment.flags;
637 if (crc1_ok && !crc2_ok) {
638 environment.data = addr1;
639 environment.flags = flag1;
640 environment.crc = crc1;
643 } else if (!crc1_ok && crc2_ok) {
644 environment.data = addr2;
645 environment.flags = flag2;
646 environment.crc = crc2;
649 } else if (!crc1_ok && !crc2_ok) {
651 "Warning: Bad CRC, using default environment\n");
652 environment.data = default_environment;
656 } else if (flag1 == active_flag && flag2 == obsolete_flag) {
657 environment.data = addr1;
658 environment.flags = flag1;
659 environment.crc = crc1;
662 } else if (flag1 == obsolete_flag && flag2 == active_flag) {
663 environment.data = addr2;
664 environment.flags = flag2;
665 environment.crc = crc2;
668 } else if (flag1 == flag2) {
669 environment.data = addr1;
670 environment.flags = flag1;
671 environment.crc = crc1;
674 } else if (flag1 == 0xFF) {
675 environment.data = addr1;
676 environment.flags = flag1;
677 environment.crc = crc1;
680 } else if (flag2 == 0xFF) {
681 environment.data = addr2;
682 environment.flags = flag2;
683 environment.crc = crc2;
692 static int parse_config ()
696 #if defined(CONFIG_FILE)
697 /* Fills in DEVNAME(), ENVSIZE(), DEVESIZE(). Or don't. */
698 if (get_config (CONFIG_FILE)) {
700 "Cannot parse config file: %s\n", strerror (errno));
704 strcpy (DEVNAME (0), DEVICE1_NAME);
705 DEVOFFSET (0) = DEVICE1_OFFSET;
706 ENVSIZE (0) = ENV1_SIZE;
707 DEVESIZE (0) = DEVICE1_ESIZE;
709 strcpy (DEVNAME (1), DEVICE2_NAME);
710 DEVOFFSET (1) = DEVICE2_OFFSET;
711 ENVSIZE (1) = ENV2_SIZE;
712 DEVESIZE (1) = DEVICE2_ESIZE;
716 if (stat (DEVNAME (0), &st)) {
718 "Cannot access MTD device %s: %s\n",
719 DEVNAME (0), strerror (errno));
723 if (HaveRedundEnv && stat (DEVNAME (1), &st)) {
725 "Cannot access MTD device %s: %s\n",
726 DEVNAME (2), strerror (errno));
732 #if defined(CONFIG_FILE)
733 static int get_config (char *fname)
740 if ((fp = fopen (fname, "r")) == NULL) {
744 while ((i < 2) && ((rc = fscanf (fp, "%s %lx %lx %lx",
748 &DEVESIZE (i) )) != EOF)) {
750 /* Skip incomplete conversions and comment strings */
751 if ((rc < 3) || (*DEVNAME (i) == '#')) {
752 fgets (dump, sizeof (dump), fp); /* Consume till end */
760 HaveRedundEnv = i - 1;
761 if (!i) { /* No valid entries found */