2 * (C) Copyright 2000-2008
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>
37 # include <linux/mtd/mtd.h>
39 # define __user /* nothing */
40 # include <mtd/mtd-user.h>
45 #define CMD_GETENV "fw_printenv"
46 #define CMD_SETENV "fw_setenv"
48 typedef struct envdev_s {
49 char devname[16]; /* Device name */
50 ulong devoff; /* Device offset */
51 ulong env_size; /* environment size */
52 ulong erase_size; /* device erase size */
55 static envdev_t envdevices[2];
58 #define DEVNAME(i) envdevices[(i)].devname
59 #define DEVOFFSET(i) envdevices[(i)].devoff
60 #define ENVSIZE(i) envdevices[(i)].env_size
61 #define DEVESIZE(i) envdevices[(i)].erase_size
63 #define CFG_ENV_SIZE ENVSIZE(curdev)
65 #define ENV_SIZE getenvsize()
67 typedef struct environment_s {
68 ulong crc; /* CRC32 over data bytes */
69 unsigned char flags; /* active or obsolete */
73 static env_t environment;
75 static int HaveRedundEnv = 0;
77 static unsigned char active_flag = 1;
78 static unsigned char obsolete_flag = 0;
82 #define MK_STR(x) XMK_STR(x)
84 static char default_environment[] = {
85 #if defined(CONFIG_BOOTARGS)
86 "bootargs=" CONFIG_BOOTARGS "\0"
88 #if defined(CONFIG_BOOTCOMMAND)
89 "bootcmd=" CONFIG_BOOTCOMMAND "\0"
91 #if defined(CONFIG_RAMBOOTCOMMAND)
92 "ramboot=" CONFIG_RAMBOOTCOMMAND "\0"
94 #if defined(CONFIG_NFSBOOTCOMMAND)
95 "nfsboot=" CONFIG_NFSBOOTCOMMAND "\0"
97 #if defined(CONFIG_BOOTDELAY) && (CONFIG_BOOTDELAY >= 0)
98 "bootdelay=" MK_STR (CONFIG_BOOTDELAY) "\0"
100 #if defined(CONFIG_BAUDRATE) && (CONFIG_BAUDRATE >= 0)
101 "baudrate=" MK_STR (CONFIG_BAUDRATE) "\0"
103 #ifdef CONFIG_LOADS_ECHO
104 "loads_echo=" MK_STR (CONFIG_LOADS_ECHO) "\0"
106 #ifdef CONFIG_ETHADDR
107 "ethaddr=" MK_STR (CONFIG_ETHADDR) "\0"
109 #ifdef CONFIG_ETH1ADDR
110 "eth1addr=" MK_STR (CONFIG_ETH1ADDR) "\0"
112 #ifdef CONFIG_ETH2ADDR
113 "eth2addr=" MK_STR (CONFIG_ETH2ADDR) "\0"
115 #ifdef CONFIG_ETH3ADDR
116 "eth3addr=" MK_STR (CONFIG_ETH3ADDR) "\0"
118 #ifdef CONFIG_ETHPRIME
119 "ethprime=" CONFIG_ETHPRIME "\0"
122 "ipaddr=" MK_STR (CONFIG_IPADDR) "\0"
124 #ifdef CONFIG_SERVERIP
125 "serverip=" MK_STR (CONFIG_SERVERIP) "\0"
128 "autoload=" CFG_AUTOLOAD "\0"
130 #ifdef CONFIG_ROOTPATH
131 "rootpath=" MK_STR (CONFIG_ROOTPATH) "\0"
133 #ifdef CONFIG_GATEWAYIP
134 "gatewayip=" MK_STR (CONFIG_GATEWAYIP) "\0"
136 #ifdef CONFIG_NETMASK
137 "netmask=" MK_STR (CONFIG_NETMASK) "\0"
139 #ifdef CONFIG_HOSTNAME
140 "hostname=" MK_STR (CONFIG_HOSTNAME) "\0"
142 #ifdef CONFIG_BOOTFILE
143 "bootfile=" MK_STR (CONFIG_BOOTFILE) "\0"
145 #ifdef CONFIG_LOADADDR
146 "loadaddr=" MK_STR (CONFIG_LOADADDR) "\0"
148 #ifdef CONFIG_PREBOOT
149 "preboot=" CONFIG_PREBOOT "\0"
151 #ifdef CONFIG_CLOCKS_IN_MHZ
152 "clocks_in_mhz=" "1" "\0"
154 #if defined(CONFIG_PCI_BOOTDELAY) && (CONFIG_PCI_BOOTDELAY > 0)
155 "pcidelay=" MK_STR (CONFIG_PCI_BOOTDELAY) "\0"
157 #ifdef CONFIG_EXTRA_ENV_SETTINGS
158 CONFIG_EXTRA_ENV_SETTINGS
160 "\0" /* Termimate env_t data with 2 NULs */
163 static int flash_io (int mode);
164 static char *envmatch (char * s1, char * s2);
165 static int env_init (void);
166 static int parse_config (void);
168 #if defined(CONFIG_FILE)
169 static int get_config (char *);
171 static inline ulong getenvsize (void)
173 ulong rc = CFG_ENV_SIZE - sizeof (long);
181 * Search the environment for a variable.
182 * Return the value, if found, or NULL, if not found.
184 char *fw_getenv (char *name)
191 for (env = environment.data; *env; env = nxt + 1) {
194 for (nxt = env; *nxt; ++nxt) {
195 if (nxt >= &environment.data[ENV_SIZE]) {
196 fprintf (stderr, "## Error: "
197 "environment not terminated\n");
201 val = envmatch (name, env);
210 * Print the current definition of one, or more, or all
211 * environment variables
213 int fw_printenv (int argc, char *argv[])
222 if (argc == 1) { /* Print all env variables */
223 for (env = environment.data; *env; env = nxt + 1) {
224 for (nxt = env; *nxt; ++nxt) {
225 if (nxt >= &environment.data[ENV_SIZE]) {
226 fprintf (stderr, "## Error: "
227 "environment not terminated\n");
232 printf ("%s\n", env);
237 if (strcmp (argv[1], "-n") == 0) {
242 fprintf (stderr, "## Error: "
243 "`-n' option requires exactly one argument\n");
250 for (i = 1; i < argc; ++i) { /* print single env variables */
251 char *name = argv[i];
254 for (env = environment.data; *env; env = nxt + 1) {
256 for (nxt = env; *nxt; ++nxt) {
257 if (nxt >= &environment.data[ENV_SIZE]) {
258 fprintf (stderr, "## Error: "
259 "environment not terminated\n");
263 val = envmatch (name, env);
266 fputs (name, stdout);
274 fprintf (stderr, "## Error: \"%s\" not defined\n", name);
283 * Deletes or sets environment variables. Returns errno style error codes:
285 * EINVAL - need at least 1 argument
286 * EROFS - certain variables ("ethaddr", "serial#") cannot be
287 * modified or deleted
290 int fw_setenv (int argc, char *argv[])
307 * search if variable with this name already exists
309 for (nxt = env = environment.data; *env; env = nxt + 1) {
310 for (nxt = env; *nxt; ++nxt) {
311 if (nxt >= &environment.data[ENV_SIZE]) {
312 fprintf (stderr, "## Error: "
313 "environment not terminated\n");
317 if ((oldval = envmatch (name, env)) != NULL)
322 * Delete any existing definition
326 * Ethernet Address and serial# can be set only once
328 if ((strcmp (name, "ethaddr") == 0) ||
329 (strcmp (name, "serial#") == 0)) {
330 fprintf (stderr, "Can't overwrite \"%s\"\n", name);
334 if (*++nxt == '\0') {
339 if ((*env == '\0') && (*nxt == '\0'))
352 * Append new definition at the end
354 for (env = environment.data; *env || *(env + 1); ++env);
355 if (env > environment.data)
359 * "name" + "=" + "val" +"\0\0" > CFG_ENV_SIZE - (env-environment)
361 len = strlen (name) + 2;
362 /* add '=' for first arg, ' ' for all others */
363 for (i = 2; i < argc; ++i) {
364 len += strlen (argv[i]) + 1;
366 if (len > (&environment.data[ENV_SIZE] - env)) {
368 "Error: environment overflow, \"%s\" deleted\n",
372 while ((*env = *name++) != '\0')
374 for (i = 2; i < argc; ++i) {
377 *env = (i == 2) ? '=' : ' ';
378 while ((*++env = *val++) != '\0');
381 /* end is marked with double '\0' */
387 environment.crc = crc32 (0, (uint8_t*) environment.data, ENV_SIZE);
389 /* write environment back to flash */
390 if (flash_io (O_RDWR)) {
391 fprintf (stderr, "Error: can't write fw_env to flash\n");
398 static int flash_io (int mode)
400 int fd, fdr, rc, otherdev, len, resid;
401 struct erase_info_user erase;
404 if ((fd = open (DEVNAME (curdev), mode)) < 0) {
406 "Can't open %s: %s\n",
407 DEVNAME (curdev), strerror (errno));
411 len = sizeof (environment.crc);
413 len += sizeof (environment.flags);
416 if (mode == O_RDWR) {
418 /* switch to next partition for writing */
420 if ((fdr = open (DEVNAME (otherdev), mode)) < 0) {
422 "Can't open %s: %s\n",
431 printf ("Unlocking flash...\n");
432 erase.length = DEVESIZE (otherdev);
433 erase.start = DEVOFFSET (otherdev);
434 ioctl (fdr, MEMUNLOCK, &erase);
437 erase.length = DEVESIZE (curdev);
438 erase.start = DEVOFFSET (curdev);
439 ioctl (fd, MEMUNLOCK, &erase);
440 environment.flags = active_flag;
444 resid = DEVESIZE (otherdev) - CFG_ENV_SIZE;
446 if ((data = malloc (resid)) == NULL) {
448 "Cannot malloc %d bytes: %s\n",
453 if (lseek (fdr, DEVOFFSET (otherdev) + CFG_ENV_SIZE, SEEK_SET)
455 fprintf (stderr, "seek error on %s: %s\n",
460 if ((rc = read (fdr, data, resid)) != resid) {
462 "read error on %s: %s\n",
469 printf ("Erasing old environment...\n");
471 erase.length = DEVESIZE (otherdev);
472 erase.start = DEVOFFSET (otherdev);
473 if (ioctl (fdr, MEMERASE, &erase) != 0) {
474 fprintf (stderr, "MTD erase error on %s: %s\n",
482 printf ("Writing environment to %s...\n", DEVNAME (otherdev));
483 if (lseek (fdr, DEVOFFSET (otherdev), SEEK_SET) == -1) {
485 "seek error on %s: %s\n",
486 DEVNAME (otherdev), strerror (errno));
489 if (write (fdr, &environment, len) != len) {
491 "CRC write error on %s: %s\n",
492 DEVNAME (otherdev), strerror (errno));
495 if (write (fdr, environment.data, ENV_SIZE) != ENV_SIZE) {
497 "Write error on %s: %s\n",
498 DEVNAME (otherdev), strerror (errno));
502 if (write (fdr, data, resid) != resid) {
504 "write error on %s: %s\n",
505 DEVNAME (curdev), strerror (errno));
511 /* change flag on current active env partition */
512 if (lseek (fd, DEVOFFSET (curdev) + sizeof (ulong), SEEK_SET)
514 fprintf (stderr, "seek error on %s: %s\n",
515 DEVNAME (curdev), strerror (errno));
518 if (write (fd, &obsolete_flag, sizeof (obsolete_flag)) !=
519 sizeof (obsolete_flag)) {
521 "Write error on %s: %s\n",
522 DEVNAME (curdev), strerror (errno));
527 printf ("Locking ...\n");
528 erase.length = DEVESIZE (otherdev);
529 erase.start = DEVOFFSET (otherdev);
530 ioctl (fdr, MEMLOCK, &erase);
532 erase.length = DEVESIZE (curdev);
533 erase.start = DEVOFFSET (curdev);
534 ioctl (fd, MEMLOCK, &erase);
537 "I/O error on %s: %s\n",
546 if (lseek (fd, DEVOFFSET (curdev), SEEK_SET) == -1) {
548 "seek error on %s: %s\n",
549 DEVNAME (curdev), strerror (errno));
552 if (read (fd, &environment, len) != len) {
554 "CRC read error on %s: %s\n",
555 DEVNAME (curdev), strerror (errno));
558 if ((rc = read (fd, environment.data, ENV_SIZE)) != ENV_SIZE) {
560 "Read error on %s: %s\n",
561 DEVNAME (curdev), strerror (errno));
568 "I/O error on %s: %s\n",
569 DEVNAME (curdev), strerror (errno));
578 * s1 is either a simple 'name', or a 'name=value' pair.
579 * s2 is a 'name=value' pair.
580 * If the names match, return the value of s2, else NULL.
583 static char *envmatch (char * s1, char * s2)
589 if (*s1 == '\0' && *(s2 - 1) == '=')
595 * Prevent confusion if running from erased flash memory
597 static int env_init (void)
603 char flag1, flag2, *addr2;
605 if (parse_config ()) /* should fill envdevices */
608 if ((addr1 = calloc (1, ENV_SIZE)) == NULL) {
610 "Not enough memory for environment (%ld bytes)\n",
615 /* read environment from FLASH to local buffer */
616 environment.data = addr1;
618 if (flash_io (O_RDONLY)) {
622 crc1_ok = ((crc1 = crc32 (0, (uint8_t *) environment.data, ENV_SIZE))
624 if (!HaveRedundEnv) {
627 "Warning: Bad CRC, using default environment\n");
628 memcpy(environment.data, default_environment, sizeof default_environment);
631 flag1 = environment.flags;
634 if ((addr2 = calloc (1, ENV_SIZE)) == NULL) {
636 "Not enough memory for environment (%ld bytes)\n",
640 environment.data = addr2;
642 if (flash_io (O_RDONLY)) {
646 crc2_ok = ((crc2 = crc32 (0, (uint8_t *) environment.data, ENV_SIZE))
648 flag2 = environment.flags;
650 if (crc1_ok && !crc2_ok) {
651 environment.data = addr1;
652 environment.flags = flag1;
653 environment.crc = crc1;
656 } else if (!crc1_ok && crc2_ok) {
657 environment.data = addr2;
658 environment.flags = flag2;
659 environment.crc = crc2;
662 } else if (!crc1_ok && !crc2_ok) {
664 "Warning: Bad CRC, using default environment\n");
665 memcpy(environment.data, default_environment, sizeof default_environment);
668 } else if (flag1 == active_flag && flag2 == obsolete_flag) {
669 environment.data = addr1;
670 environment.flags = flag1;
671 environment.crc = crc1;
674 } else if (flag1 == obsolete_flag && flag2 == active_flag) {
675 environment.data = addr2;
676 environment.flags = flag2;
677 environment.crc = crc2;
680 } else if (flag1 == flag2) {
681 environment.data = addr1;
682 environment.flags = flag1;
683 environment.crc = crc1;
686 } else if (flag1 == 0xFF) {
687 environment.data = addr1;
688 environment.flags = flag1;
689 environment.crc = crc1;
692 } else if (flag2 == 0xFF) {
693 environment.data = addr2;
694 environment.flags = flag2;
695 environment.crc = crc2;
704 static int parse_config ()
708 #if defined(CONFIG_FILE)
709 /* Fills in DEVNAME(), ENVSIZE(), DEVESIZE(). Or don't. */
710 if (get_config (CONFIG_FILE)) {
712 "Cannot parse config file: %s\n", strerror (errno));
716 strcpy (DEVNAME (0), DEVICE1_NAME);
717 DEVOFFSET (0) = DEVICE1_OFFSET;
718 ENVSIZE (0) = ENV1_SIZE;
719 DEVESIZE (0) = DEVICE1_ESIZE;
721 strcpy (DEVNAME (1), DEVICE2_NAME);
722 DEVOFFSET (1) = DEVICE2_OFFSET;
723 ENVSIZE (1) = ENV2_SIZE;
724 DEVESIZE (1) = DEVICE2_ESIZE;
728 if (stat (DEVNAME (0), &st)) {
730 "Cannot access MTD device %s: %s\n",
731 DEVNAME (0), strerror (errno));
735 if (HaveRedundEnv && stat (DEVNAME (1), &st)) {
737 "Cannot access MTD device %s: %s\n",
738 DEVNAME (1), strerror (errno));
744 #if defined(CONFIG_FILE)
745 static int get_config (char *fname)
752 if ((fp = fopen (fname, "r")) == NULL) {
756 while ((i < 2) && ((rc = fscanf (fp, "%s %lx %lx %lx",
760 &DEVESIZE (i) )) != EOF)) {
762 /* Skip incomplete conversions and comment strings */
763 if ((rc < 3) || (*DEVNAME (i) == '#')) {
764 fgets (dump, sizeof (dump), fp); /* Consume till end */
772 HaveRedundEnv = i - 1;
773 if (!i) { /* No valid entries found */