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>
36 # include <linux/mtd/mtd.h>
38 # include <mtd/mtd-user.h>
43 #define CMD_GETENV "fw_printenv"
44 #define CMD_SETENV "fw_setenv"
46 typedef struct envdev_s {
47 char devname[16]; /* Device name */
48 ulong devoff; /* Device offset */
49 ulong env_size; /* environment size */
50 ulong erase_size; /* device erase size */
53 static envdev_t envdevices[2];
56 #define DEVNAME(i) envdevices[(i)].devname
57 #define DEVOFFSET(i) envdevices[(i)].devoff
58 #define ENVSIZE(i) envdevices[(i)].env_size
59 #define DEVESIZE(i) envdevices[(i)].erase_size
61 #define CFG_ENV_SIZE ENVSIZE(curdev)
63 #define ENV_SIZE getenvsize()
65 typedef struct environment_s {
66 ulong crc; /* CRC32 over data bytes */
67 unsigned char flags; /* active or obsolete */
71 static env_t environment;
73 static int HaveRedundEnv = 0;
75 static unsigned char active_flag = 1;
76 static unsigned char obsolete_flag = 0;
80 #define MK_STR(x) XMK_STR(x)
82 static char default_environment[] = {
83 #if defined(CONFIG_BOOTARGS)
84 "bootargs=" CONFIG_BOOTARGS "\0"
86 #if defined(CONFIG_BOOTCOMMAND)
87 "bootcmd=" CONFIG_BOOTCOMMAND "\0"
89 #if defined(CONFIG_RAMBOOTCOMMAND)
90 "ramboot=" CONFIG_RAMBOOTCOMMAND "\0"
92 #if defined(CONFIG_NFSBOOTCOMMAND)
93 "nfsboot=" CONFIG_NFSBOOTCOMMAND "\0"
95 #if defined(CONFIG_BOOTDELAY) && (CONFIG_BOOTDELAY >= 0)
96 "bootdelay=" MK_STR (CONFIG_BOOTDELAY) "\0"
98 #if defined(CONFIG_BAUDRATE) && (CONFIG_BAUDRATE >= 0)
99 "baudrate=" MK_STR (CONFIG_BAUDRATE) "\0"
101 #ifdef CONFIG_LOADS_ECHO
102 "loads_echo=" MK_STR (CONFIG_LOADS_ECHO) "\0"
104 #ifdef CONFIG_ETHADDR
105 "ethaddr=" MK_STR (CONFIG_ETHADDR) "\0"
107 #ifdef CONFIG_ETH1ADDR
108 "eth1addr=" MK_STR (CONFIG_ETH1ADDR) "\0"
110 #ifdef CONFIG_ETH2ADDR
111 "eth2addr=" MK_STR (CONFIG_ETH2ADDR) "\0"
113 #ifdef CONFIG_ETH3ADDR
114 "eth3addr=" MK_STR (CONFIG_ETH3ADDR) "\0"
116 #ifdef CONFIG_ETHPRIME
117 "ethprime=" CONFIG_ETHPRIME "\0"
120 "ipaddr=" MK_STR (CONFIG_IPADDR) "\0"
122 #ifdef CONFIG_SERVERIP
123 "serverip=" MK_STR (CONFIG_SERVERIP) "\0"
126 "autoload=" CFG_AUTOLOAD "\0"
128 #ifdef CONFIG_ROOTPATH
129 "rootpath=" MK_STR (CONFIG_ROOTPATH) "\0"
131 #ifdef CONFIG_GATEWAYIP
132 "gatewayip=" MK_STR (CONFIG_GATEWAYIP) "\0"
134 #ifdef CONFIG_NETMASK
135 "netmask=" MK_STR (CONFIG_NETMASK) "\0"
137 #ifdef CONFIG_HOSTNAME
138 "hostname=" MK_STR (CONFIG_HOSTNAME) "\0"
140 #ifdef CONFIG_BOOTFILE
141 "bootfile=" MK_STR (CONFIG_BOOTFILE) "\0"
143 #ifdef CONFIG_LOADADDR
144 "loadaddr=" MK_STR (CONFIG_LOADADDR) "\0"
146 #ifdef CONFIG_PREBOOT
147 "preboot=" CONFIG_PREBOOT "\0"
149 #ifdef CONFIG_CLOCKS_IN_MHZ
150 "clocks_in_mhz=" "1" "\0"
152 #if defined(CONFIG_PCI_BOOTDELAY) && (CONFIG_PCI_BOOTDELAY > 0)
153 "pcidelay=" MK_STR (CONFIG_PCI_BOOTDELAY) "\0"
155 #ifdef CONFIG_EXTRA_ENV_SETTINGS
156 CONFIG_EXTRA_ENV_SETTINGS
158 "\0" /* Termimate env_t data with 2 NULs */
161 static int flash_io (int mode);
162 static char *envmatch (char * s1, char * s2);
163 static int env_init (void);
164 static int parse_config (void);
166 #if defined(CONFIG_FILE)
167 static int get_config (char *);
169 static inline ulong getenvsize (void)
171 ulong rc = CFG_ENV_SIZE - sizeof (long);
179 * Search the environment for a variable.
180 * Return the value, if found, or NULL, if not found.
182 char *fw_getenv (char *name)
189 for (env = environment.data; *env; env = nxt + 1) {
192 for (nxt = env; *nxt; ++nxt) {
193 if (nxt >= &environment.data[ENV_SIZE]) {
194 fprintf (stderr, "## Error: "
195 "environment not terminated\n");
199 val = envmatch (name, env);
208 * Print the current definition of one, or more, or all
209 * environment variables
211 void fw_printenv (int argc, char *argv[])
219 if (argc == 1) { /* Print all env variables */
220 for (env = environment.data; *env; env = nxt + 1) {
221 for (nxt = env; *nxt; ++nxt) {
222 if (nxt >= &environment.data[ENV_SIZE]) {
223 fprintf (stderr, "## Error: "
224 "environment not terminated\n");
229 printf ("%s\n", env);
234 if (strcmp (argv[1], "-n") == 0) {
239 fprintf (stderr, "## Error: "
240 "`-n' option requires exactly one argument\n");
247 for (i = 1; i < argc; ++i) { /* print single env variables */
248 char *name = argv[i];
251 for (env = environment.data; *env; env = nxt + 1) {
253 for (nxt = env; *nxt; ++nxt) {
254 if (nxt >= &environment.data[ENV_SIZE]) {
255 fprintf (stderr, "## Error: "
256 "environment not terminated\n");
260 val = envmatch (name, env);
263 fputs (name, stdout);
271 fprintf (stderr, "## Error: \"%s\" not defined\n", name);
276 * Deletes or sets environment variables. Returns errno style error codes:
278 * EINVAL - need at least 1 argument
279 * EROFS - certain variables ("ethaddr", "serial#") cannot be
280 * modified or deleted
283 int fw_setenv (int argc, char *argv[])
300 * search if variable with this name already exists
302 for (nxt = env = environment.data; *env; env = nxt + 1) {
303 for (nxt = env; *nxt; ++nxt) {
304 if (nxt >= &environment.data[ENV_SIZE]) {
305 fprintf (stderr, "## Error: "
306 "environment not terminated\n");
310 if ((oldval = envmatch (name, env)) != NULL)
315 * Delete any existing definition
319 * Ethernet Address and serial# can be set only once
321 if ((strcmp (name, "ethaddr") == 0) ||
322 (strcmp (name, "serial#") == 0)) {
323 fprintf (stderr, "Can't overwrite \"%s\"\n", name);
327 if (*++nxt == '\0') {
332 if ((*env == '\0') && (*nxt == '\0'))
345 * Append new definition at the end
347 for (env = environment.data; *env || *(env + 1); ++env);
348 if (env > environment.data)
352 * "name" + "=" + "val" +"\0\0" > CFG_ENV_SIZE - (env-environment)
354 len = strlen (name) + 2;
355 /* add '=' for first arg, ' ' for all others */
356 for (i = 2; i < argc; ++i) {
357 len += strlen (argv[i]) + 1;
359 if (len > (&environment.data[ENV_SIZE] - env)) {
361 "Error: environment overflow, \"%s\" deleted\n",
365 while ((*env = *name++) != '\0')
367 for (i = 2; i < argc; ++i) {
370 *env = (i == 2) ? '=' : ' ';
371 while ((*++env = *val++) != '\0');
374 /* end is marked with double '\0' */
380 environment.crc = crc32 (0, (uint8_t*) environment.data, ENV_SIZE);
382 /* write environment back to flash */
383 if (flash_io (O_RDWR)) {
384 fprintf (stderr, "Error: can't write fw_env to flash\n");
391 static int flash_io (int mode)
393 int fd, fdr, rc, otherdev, len, resid;
397 if ((fd = open (DEVNAME (curdev), mode)) < 0) {
399 "Can't open %s: %s\n",
400 DEVNAME (curdev), strerror (errno));
404 len = sizeof (environment.crc);
406 len += sizeof (environment.flags);
409 if (mode == O_RDWR) {
411 /* switch to next partition for writing */
413 if ((fdr = open (DEVNAME (otherdev), mode)) < 0) {
415 "Can't open %s: %s\n",
424 printf ("Unlocking flash...\n");
425 erase.length = DEVESIZE (otherdev);
426 erase.start = DEVOFFSET (otherdev);
427 ioctl (fdr, MEMUNLOCK, &erase);
430 erase.length = DEVESIZE (curdev);
431 erase.start = DEVOFFSET (curdev);
432 ioctl (fd, MEMUNLOCK, &erase);
433 environment.flags = active_flag;
437 resid = DEVESIZE (otherdev) - CFG_ENV_SIZE;
439 if ((data = malloc (resid)) == NULL) {
441 "Cannot malloc %d bytes: %s\n",
446 if (lseek (fdr, DEVOFFSET (otherdev) + CFG_ENV_SIZE, SEEK_SET)
448 fprintf (stderr, "seek error on %s: %s\n",
453 if ((rc = read (fdr, data, resid)) != resid) {
455 "read error on %s: %s\n",
462 printf ("Erasing old environment...\n");
464 erase.length = DEVESIZE (otherdev);
465 erase.start = DEVOFFSET (otherdev);
466 if (ioctl (fdr, MEMERASE, &erase) != 0) {
467 fprintf (stderr, "MTD erase error on %s: %s\n",
475 printf ("Writing environment to %s...\n", DEVNAME (otherdev));
476 if (lseek (fdr, DEVOFFSET (otherdev), SEEK_SET) == -1) {
478 "seek error on %s: %s\n",
479 DEVNAME (otherdev), strerror (errno));
482 if (write (fdr, &environment, len) != len) {
484 "CRC write error on %s: %s\n",
485 DEVNAME (otherdev), strerror (errno));
488 if (write (fdr, environment.data, ENV_SIZE) != ENV_SIZE) {
490 "Write error on %s: %s\n",
491 DEVNAME (otherdev), strerror (errno));
495 if (write (fdr, data, resid) != resid) {
497 "write error on %s: %s\n",
498 DEVNAME (curdev), strerror (errno));
504 /* change flag on current active env partition */
505 if (lseek (fd, DEVOFFSET (curdev) + sizeof (ulong), SEEK_SET)
507 fprintf (stderr, "seek error on %s: %s\n",
508 DEVNAME (curdev), strerror (errno));
511 if (write (fd, &obsolete_flag, sizeof (obsolete_flag)) !=
512 sizeof (obsolete_flag)) {
514 "Write error on %s: %s\n",
515 DEVNAME (curdev), strerror (errno));
520 printf ("Locking ...\n");
521 erase.length = DEVESIZE (otherdev);
522 erase.start = DEVOFFSET (otherdev);
523 ioctl (fdr, MEMLOCK, &erase);
525 erase.length = DEVESIZE (curdev);
526 erase.start = DEVOFFSET (curdev);
527 ioctl (fd, MEMLOCK, &erase);
530 "I/O error on %s: %s\n",
539 if (lseek (fd, DEVOFFSET (curdev), SEEK_SET) == -1) {
541 "seek error on %s: %s\n",
542 DEVNAME (curdev), strerror (errno));
545 if (read (fd, &environment, len) != len) {
547 "CRC read error on %s: %s\n",
548 DEVNAME (curdev), strerror (errno));
551 if ((rc = read (fd, environment.data, ENV_SIZE)) != ENV_SIZE) {
553 "Read error on %s: %s\n",
554 DEVNAME (curdev), strerror (errno));
561 "I/O error on %s: %s\n",
562 DEVNAME (curdev), strerror (errno));
571 * s1 is either a simple 'name', or a 'name=value' pair.
572 * s2 is a 'name=value' pair.
573 * If the names match, return the value of s2, else NULL.
576 static char *envmatch (char * s1, char * s2)
582 if (*s1 == '\0' && *(s2 - 1) == '=')
588 * Prevent confusion if running from erased flash memory
590 static int env_init (void)
596 char flag1, flag2, *addr2;
598 if (parse_config ()) /* should fill envdevices */
601 if ((addr1 = calloc (1, ENV_SIZE)) == NULL) {
603 "Not enough memory for environment (%ld bytes)\n",
608 /* read environment from FLASH to local buffer */
609 environment.data = addr1;
611 if (flash_io (O_RDONLY)) {
615 crc1_ok = ((crc1 = crc32 (0, (uint8_t *) environment.data, ENV_SIZE))
617 if (!HaveRedundEnv) {
620 "Warning: Bad CRC, using default environment\n");
621 memcpy(environment.data, default_environment, sizeof default_environment);
624 flag1 = environment.flags;
627 if ((addr2 = calloc (1, ENV_SIZE)) == NULL) {
629 "Not enough memory for environment (%ld bytes)\n",
633 environment.data = addr2;
635 if (flash_io (O_RDONLY)) {
639 crc2_ok = ((crc2 = crc32 (0, (uint8_t *) environment.data, ENV_SIZE))
641 flag2 = environment.flags;
643 if (crc1_ok && !crc2_ok) {
644 environment.data = addr1;
645 environment.flags = flag1;
646 environment.crc = crc1;
649 } else if (!crc1_ok && crc2_ok) {
650 environment.data = addr2;
651 environment.flags = flag2;
652 environment.crc = crc2;
655 } else if (!crc1_ok && !crc2_ok) {
657 "Warning: Bad CRC, using default environment\n");
658 memcpy(environment.data, default_environment, sizeof default_environment);
661 } else if (flag1 == active_flag && flag2 == obsolete_flag) {
662 environment.data = addr1;
663 environment.flags = flag1;
664 environment.crc = crc1;
667 } else if (flag1 == obsolete_flag && flag2 == active_flag) {
668 environment.data = addr2;
669 environment.flags = flag2;
670 environment.crc = crc2;
673 } else if (flag1 == flag2) {
674 environment.data = addr1;
675 environment.flags = flag1;
676 environment.crc = crc1;
679 } else if (flag1 == 0xFF) {
680 environment.data = addr1;
681 environment.flags = flag1;
682 environment.crc = crc1;
685 } else if (flag2 == 0xFF) {
686 environment.data = addr2;
687 environment.flags = flag2;
688 environment.crc = crc2;
697 static int parse_config ()
701 #if defined(CONFIG_FILE)
702 /* Fills in DEVNAME(), ENVSIZE(), DEVESIZE(). Or don't. */
703 if (get_config (CONFIG_FILE)) {
705 "Cannot parse config file: %s\n", strerror (errno));
709 strcpy (DEVNAME (0), DEVICE1_NAME);
710 DEVOFFSET (0) = DEVICE1_OFFSET;
711 ENVSIZE (0) = ENV1_SIZE;
712 DEVESIZE (0) = DEVICE1_ESIZE;
714 strcpy (DEVNAME (1), DEVICE2_NAME);
715 DEVOFFSET (1) = DEVICE2_OFFSET;
716 ENVSIZE (1) = ENV2_SIZE;
717 DEVESIZE (1) = DEVICE2_ESIZE;
721 if (stat (DEVNAME (0), &st)) {
723 "Cannot access MTD device %s: %s\n",
724 DEVNAME (0), strerror (errno));
728 if (HaveRedundEnv && stat (DEVNAME (1), &st)) {
730 "Cannot access MTD device %s: %s\n",
731 DEVNAME (1), strerror (errno));
737 #if defined(CONFIG_FILE)
738 static int get_config (char *fname)
745 if ((fp = fopen (fname, "r")) == NULL) {
749 while ((i < 2) && ((rc = fscanf (fp, "%s %lx %lx %lx",
753 &DEVESIZE (i) )) != EOF)) {
755 /* Skip incomplete conversions and comment strings */
756 if ((rc < 3) || (*DEVNAME (i) == '#')) {
757 fgets (dump, sizeof (dump), fp); /* Consume till end */
765 HaveRedundEnv = i - 1;
766 if (!i) { /* No valid entries found */