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);
158 #if defined(CONFIG_FILE)
159 static int get_config(char *);
161 static inline ulong getenvsize(void)
163 ulong rc = CFG_ENV_SIZE - sizeof(long);
170 * Search the environment for a variable.
171 * Return the value, if found, or NULL, if not found.
173 unsigned char *fw_getenv (unsigned char *name)
180 for (env=environment.data; *env; env=nxt+1) {
183 for (nxt=env; *nxt; ++nxt) {
184 if (nxt >= &environment.data[ENV_SIZE]) {
185 fprintf (stderr, "## Error: "
186 "environment not terminated\n");
190 val=envmatch(name, env);
199 * Print the current definition of one, or more, or all
200 * environment variables
202 void fw_printenv(int argc, char *argv[])
210 if (argc == 1) { /* Print all env variables */
211 for (env=environment.data; *env; env=nxt+1) {
212 for (nxt=env; *nxt; ++nxt) {
213 if (nxt >= &environment.data[ENV_SIZE]) {
214 fprintf (stderr, "## Error: "
215 "environment not terminated\n");
225 if (strcmp(argv[1], "-n") == 0) {
230 fprintf (stderr, "## Error: "
231 "`-n' option requires exactly one argument\n");
238 for (i=1; i<argc; ++i) { /* print single env variables */
239 uchar *name = argv[i];
242 for (env=environment.data; *env; env=nxt+1) {
244 for (nxt=env; *nxt; ++nxt) {
245 if (nxt >= &environment.data[ENV_SIZE]) {
246 fprintf (stderr, "## Error: "
247 "environment not terminated\n");
251 val=envmatch(name, env);
254 fputs (name, stdout);
262 fprintf (stderr, "## Error: \"%s\" not defined\n",
268 * Deletes or sets environment variables. Returns errno style error codes:
270 * EINVAL - need at least 1 argument
271 * EROFS - certain variables ("ethaddr", "serial#") cannot be
272 * modified or deleted
275 int fw_setenv (int argc, char *argv[])
279 uchar *oldval = NULL;
292 * search if variable with this name already exists
294 for (env=environment.data; *env; env=nxt+1) {
295 for (nxt=env; *nxt; ++nxt) {
296 if (nxt >= &environment.data[ENV_SIZE]) {
297 fprintf (stderr, "## Error: "
298 "environment not terminated\n");
302 if ((oldval=envmatch(name, env)) != NULL)
307 * Delete any existing definition
311 * Ethernet Address and serial# can be set only once
313 if ((strcmp (name, "ethaddr") == 0) ||
314 (strcmp (name, "serial#") == 0) ) {
315 fprintf (stderr, "Can't overwrite \"%s\"\n", name);
319 if (*++nxt == '\0') {
324 if ((*env == '\0') && (*nxt == '\0'))
337 * Append new definition at the end
339 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')
368 /* end is marked with double '\0' */
374 environment.crc = crc32(0, environment.data, ENV_SIZE);
376 /* write environment back to flash */
377 if (flash_io (O_RDWR)) {
379 "Error: can't write fw_env to flash\n");
386 static int flash_io (int mode)
388 int fd, fdr, rc, otherdev, len, resid;
392 if ((fd = open(DEVNAME(curdev), mode)) < 0) {
394 "Can't open %s: %s\n",
395 DEVNAME(curdev), strerror(errno));
399 len = sizeof(environment.crc);
401 len += sizeof(environment.flags);
404 if (mode == O_RDWR) {
406 /* switch to next partition for writing */
408 if ((fdr = open(DEVNAME(otherdev), mode)) < 0) {
410 "Can't open %s: %s\n",
411 DEVNAME(otherdev), strerror(errno));
418 printf("Unlocking flash...\n");
419 erase.length = DEVESIZE(otherdev);
420 erase.start = DEVOFFSET(otherdev);
421 ioctl (fdr, MEMUNLOCK, &erase);
424 erase.length = DEVESIZE(curdev);
425 erase.start = DEVOFFSET(curdev);
426 ioctl (fd, MEMUNLOCK, &erase);
427 environment.flags = active_flag;
431 resid = DEVESIZE(otherdev) - CFG_ENV_SIZE;
433 if ((data = malloc(resid)) == NULL) {
435 "Cannot malloc %d bytes: %s\n",
436 resid, strerror(errno));
439 if (lseek (fdr, DEVOFFSET(otherdev) + CFG_ENV_SIZE, SEEK_SET) == -1) {
441 "seek error on %s: %s\n",
442 DEVNAME(otherdev), strerror(errno));
445 if ((rc = read (fdr, data, resid)) != resid) {
447 "read error on %s: %s\n",
448 DEVNAME(otherdev), strerror(errno));
453 printf("Erasing old environment...\n");
455 erase.length = DEVESIZE(otherdev);
456 erase.start = DEVOFFSET(otherdev);
457 if (ioctl (fdr, MEMERASE, &erase) != 0) {
458 fprintf (stderr, "MTD erase error on %s: %s\n",
459 DEVNAME(otherdev), strerror(errno));
465 printf("Writing environment to %s...\n",DEVNAME(otherdev));
466 if (lseek (fdr, DEVOFFSET(otherdev), SEEK_SET) == -1) {
468 "seek error on %s: %s\n",
469 DEVNAME(otherdev), strerror(errno));
472 if (write(fdr, &environment, len) != len) {
474 "CRC write error on %s: %s\n",
475 DEVNAME(otherdev), strerror(errno));
478 if (write(fdr, environment.data, ENV_SIZE) != ENV_SIZE) {
480 "Write error on %s: %s\n",
481 DEVNAME(otherdev), strerror(errno));
485 if (write (fdr, data, resid) != resid) {
487 "write error on %s: %s\n",
488 DEVNAME(curdev), strerror(errno));
494 /* change flag on current active env partition */
495 if (lseek (fd, DEVOFFSET(curdev) + sizeof(ulong), SEEK_SET) == -1) {
497 "seek error on %s: %s\n",
498 DEVNAME(curdev), strerror(errno));
501 if (write (fd, &obsolete_flag, sizeof(obsolete_flag)) !=
502 sizeof(obsolete_flag)) {
504 "Write error on %s: %s\n",
505 DEVNAME(curdev), strerror(errno));
510 printf("Locking ...\n");
511 erase.length = DEVESIZE(otherdev);
512 erase.start = DEVOFFSET(otherdev);
513 ioctl (fdr, MEMLOCK, &erase);
515 erase.length = DEVESIZE(curdev);
516 erase.start = DEVOFFSET(curdev);
517 ioctl (fd, MEMLOCK, &erase);
520 "I/O error on %s: %s\n",
521 DEVNAME(otherdev), strerror(errno));
528 if (lseek (fd, DEVOFFSET(curdev), SEEK_SET) == -1) {
530 "seek error on %s: %s\n",
531 DEVNAME(curdev), strerror(errno));
534 if (read (fd, &environment, len) != len) {
536 "CRC read error on %s: %s\n",
537 DEVNAME(curdev), strerror(errno));
540 if ((rc = read (fd, environment.data, ENV_SIZE)) != ENV_SIZE) {
542 "Read error on %s: %s\n",
543 DEVNAME(curdev), strerror(errno));
550 "I/O error on %s: %s\n",
551 DEVNAME(curdev), strerror(errno));
560 * s1 is either a simple 'name', or a 'name=value' pair.
561 * s2 is a 'name=value' pair.
562 * If the names match, return the value of s2, else NULL.
566 envmatch (uchar *s1, uchar *s2)
572 if (*s1 == '\0' && *(s2-1) == '=')
578 * Prevent confusion if running from erased flash memory
580 static int env_init(void)
586 uchar flag1, flag2, *addr2;
588 if (parse_config()) /* should fill envdevices */
591 if ((addr1 = calloc (1, ENV_SIZE)) == NULL) {
593 "Not enough memory for environment (%ld bytes)\n",
598 /* read environment from FLASH to local buffer */
599 environment.data = addr1;
601 if (flash_io (O_RDONLY)) {
605 crc1_ok = ((crc1 = crc32(0, environment.data, ENV_SIZE))
607 if (!HaveRedundEnv) {
610 "Warning: Bad CRC, using default environment\n");
611 environment.data = default_environment;
615 flag1 = environment.flags;
618 if ((addr2 = calloc (1, ENV_SIZE)) == NULL) {
620 "Not enough memory for environment (%ld bytes)\n",
624 environment.data = addr2;
626 if (flash_io (O_RDONLY)) {
630 crc2_ok = ((crc2 = crc32(0, environment.data, ENV_SIZE))
632 flag2 = environment.flags;
634 if (crc1_ok && ! crc2_ok) {
635 environment.data = addr1;
636 environment.flags = flag1;
637 environment.crc = crc1;
641 else if (! crc1_ok && crc2_ok) {
642 environment.data = addr2;
643 environment.flags = flag2;
644 environment.crc = crc2;
648 else if (! crc1_ok && ! crc2_ok) {
650 "Warning: Bad CRC, using default environment\n");
651 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;
663 else if (flag1 == obsolete_flag && flag2 == active_flag) {
664 environment.data = addr2;
665 environment.flags = flag2;
666 environment.crc = crc2;
670 else if (flag1 == flag2) {
671 environment.data = addr1;
672 environment.flags = flag1;
673 environment.crc = crc1;
677 else if (flag1 == 0xFF) {
678 environment.data = addr1;
679 environment.flags = flag1;
680 environment.crc = crc1;
684 else if (flag2 == 0xFF) {
685 environment.data = addr2;
686 environment.flags = flag2;
687 environment.crc = crc2;
696 static int parse_config()
700 #if defined(CONFIG_FILE)
701 /* Fills in DEVNAME(), ENVSIZE(), DEVESIZE(). Or don't. */
702 if (get_config(CONFIG_FILE)) {
704 "Cannot parse config file: %s\n",
710 strcpy(DEVNAME(0), DEVICE1_NAME);
711 DEVOFFSET(0) = DEVICE1_OFFSET;
712 ENVSIZE(0) = ENV1_SIZE;
713 DEVESIZE(0) = DEVICE1_ESIZE;
715 strcpy(DEVNAME(1), DEVICE2_NAME);
716 DEVOFFSET(1) = DEVICE2_OFFSET;
717 ENVSIZE(1) = ENV2_SIZE;
718 DEVESIZE(1) = DEVICE2_ESIZE;
722 if (stat (DEVNAME(0), &st)) {
724 "Cannot access MTD device %s: %s\n",
725 DEVNAME(0), strerror(errno));
729 if (HaveRedundEnv && stat (DEVNAME(1), &st)) {
731 "Cannot access MTD device %s: %s\n",
732 DEVNAME(2), strerror(errno));
738 #if defined(CONFIG_FILE)
739 static int get_config (char *fname)
746 if ((fp = fopen(fname, "r")) == NULL) {
751 ((rc = fscanf (fp, "%s %lx %lx %lx",
752 DEVNAME(i), &DEVOFFSET(i), &ENVSIZE(i), &DEVESIZE(i))) != EOF)) {
754 /* Skip incomplete conversions and comment strings */
755 if ((rc < 3) || (*DEVNAME(i) == '#')) {
756 fgets (dump, sizeof(dump), fp); /* Consume till end */
764 HaveRedundEnv = i - 1;
765 if (!i) { /* No valid entries found */