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 #ifdef CONFIG_EXTRA_ENV_SETTINGS
146 CONFIG_EXTRA_ENV_SETTINGS
148 "\0" /* Termimate env_t data with 2 NULs */
151 static int flash_io (int mode);
152 static uchar *envmatch(uchar *s1, uchar *s2);
153 static int env_init(void);
154 static int parse_config(void);
155 #if defined(CONFIG_FILE)
156 static int get_config(char *);
158 static inline ulong getenvsize(void)
160 ulong rc = CFG_ENV_SIZE - sizeof(long);
167 * Search the environment for a variable.
168 * Return the value, if found, or NULL, if not found.
170 unsigned char *fw_getenv (unsigned char *name)
177 for (env=environment.data; *env; env=nxt+1) {
180 for (nxt=env; *nxt; ++nxt) {
181 if (nxt >= &environment.data[ENV_SIZE]) {
182 fprintf (stderr, "## Error: "
183 "environment not terminated\n");
187 val=envmatch(name, env);
196 * Print the current definition of one, or more, or all
197 * environment variables
199 void fw_printenv(int argc, char *argv[])
207 if (argc == 1) { /* Print all env variables */
208 for (env=environment.data; *env; env=nxt+1) {
209 for (nxt=env; *nxt; ++nxt) {
210 if (nxt >= &environment.data[ENV_SIZE]) {
211 fprintf (stderr, "## Error: "
212 "environment not terminated\n");
222 if (strcmp(argv[1], "-n") == 0) {
227 fprintf (stderr, "## Error: "
228 "`-n' option requires exactly one argument\n");
235 for (i=1; i<argc; ++i) { /* print single env variables */
236 uchar *name = argv[i];
239 for (env=environment.data; *env; env=nxt+1) {
241 for (nxt=env; *nxt; ++nxt) {
242 if (nxt >= &environment.data[ENV_SIZE]) {
243 fprintf (stderr, "## Error: "
244 "environment not terminated\n");
248 val=envmatch(name, env);
251 fputs (name, stdout);
259 fprintf (stderr, "## Error: \"%s\" not defined\n",
265 * Deletes or sets environment variables. Returns errno style error codes:
267 * EINVAL - need at least 1 argument
268 * EROFS - certain variables ("ethaddr", "serial#") cannot be
269 * modified or deleted
272 int fw_setenv (int argc, char *argv[])
276 uchar *oldval = NULL;
289 * search if variable with this name already exists
291 for (env=environment.data; *env; env=nxt+1) {
292 for (nxt=env; *nxt; ++nxt) {
293 if (nxt >= &environment.data[ENV_SIZE]) {
294 fprintf (stderr, "## Error: "
295 "environment not terminated\n");
299 if ((oldval=envmatch(name, env)) != NULL)
304 * Delete any existing definition
308 * Ethernet Address and serial# can be set only once
310 if ((strcmp (name, "ethaddr") == 0) ||
311 (strcmp (name, "serial#") == 0) ) {
312 fprintf (stderr, "Can't overwrite \"%s\"\n", name);
316 if (*++nxt == '\0') {
321 if ((*env == '\0') && (*nxt == '\0'))
334 * Append new definition at the end
336 for (env=environment.data; *env || *(env+1); ++env)
338 if (env > environment.data)
342 * "name" + "=" + "val" +"\0\0" > CFG_ENV_SIZE - (env-environment)
344 len = strlen(name) + 2;
345 /* add '=' for first arg, ' ' for all others */
346 for (i=2; i<argc; ++i) {
347 len += strlen(argv[i]) + 1;
349 if (len > (&environment.data[ENV_SIZE]-env)) {
351 "Error: environment overflow, \"%s\" deleted\n",
355 while ((*env = *name++) != '\0')
357 for (i=2; i<argc; ++i) {
358 uchar *val = argv[i];
360 *env = (i==2) ? '=' : ' ';
361 while ((*++env = *val++) != '\0')
365 /* end is marked with double '\0' */
371 environment.crc = crc32(0, environment.data, ENV_SIZE);
373 /* write environment back to flash */
374 if (flash_io (O_RDWR)) {
376 "Error: can't write fw_env to flash\n");
383 static int flash_io (int mode)
385 int fd, fdr, rc, otherdev, len, resid;
389 if ((fd = open(DEVNAME(curdev), mode)) < 0) {
391 "Can't open %s: %s\n",
392 DEVNAME(curdev), strerror(errno));
396 len = sizeof(environment.crc);
398 len += sizeof(environment.flags);
401 if (mode == O_RDWR) {
403 /* switch to next partition for writing */
405 if ((fdr = open(DEVNAME(otherdev), mode)) < 0) {
407 "Can't open %s: %s\n",
408 DEVNAME(otherdev), strerror(errno));
415 printf("Unlocking flash...\n");
416 erase.length = DEVESIZE(otherdev);
417 erase.start = DEVOFFSET(otherdev);
418 ioctl (fdr, MEMUNLOCK, &erase);
421 erase.length = DEVESIZE(curdev);
422 erase.start = DEVOFFSET(curdev);
423 ioctl (fd, MEMUNLOCK, &erase);
424 environment.flags = active_flag;
428 resid = DEVESIZE(otherdev) - CFG_ENV_SIZE;
430 if ((data = malloc(resid)) == NULL) {
432 "Cannot malloc %d bytes: %s\n",
433 resid, strerror(errno));
436 if (lseek (fdr, DEVOFFSET(otherdev) + CFG_ENV_SIZE, SEEK_SET) == -1) {
438 "seek error on %s: %s\n",
439 DEVNAME(otherdev), strerror(errno));
442 if ((rc = read (fdr, data, resid)) != resid) {
444 "read error on %s: %s\n",
445 DEVNAME(otherdev), strerror(errno));
450 printf("Erasing old environment...\n");
452 erase.length = DEVESIZE(otherdev);
453 erase.start = DEVOFFSET(otherdev);
454 if (ioctl (fdr, MEMERASE, &erase) != 0) {
455 fprintf (stderr, "MTD erase error on %s: %s\n",
456 DEVNAME(otherdev), strerror(errno));
462 printf("Writing environment to %s...\n",DEVNAME(otherdev));
463 if (lseek (fdr, DEVOFFSET(otherdev), SEEK_SET) == -1) {
465 "seek error on %s: %s\n",
466 DEVNAME(otherdev), strerror(errno));
469 if (write(fdr, &environment, len) != len) {
471 "CRC write error on %s: %s\n",
472 DEVNAME(otherdev), strerror(errno));
475 if (write(fdr, environment.data, ENV_SIZE) != ENV_SIZE) {
477 "Write error on %s: %s\n",
478 DEVNAME(otherdev), strerror(errno));
482 if (write (fdr, data, resid) != resid) {
484 "write error on %s: %s\n",
485 DEVNAME(curdev), strerror(errno));
491 /* change flag on current active env partition */
492 if (lseek (fd, DEVOFFSET(curdev) + sizeof(ulong), SEEK_SET) == -1) {
494 "seek error on %s: %s\n",
495 DEVNAME(curdev), strerror(errno));
498 if (write (fd, &obsolete_flag, sizeof(obsolete_flag)) !=
499 sizeof(obsolete_flag)) {
501 "Write error on %s: %s\n",
502 DEVNAME(curdev), strerror(errno));
507 printf("Locking ...\n");
508 erase.length = DEVESIZE(otherdev);
509 erase.start = DEVOFFSET(otherdev);
510 ioctl (fdr, MEMLOCK, &erase);
512 erase.length = DEVESIZE(curdev);
513 erase.start = DEVOFFSET(curdev);
514 ioctl (fd, MEMLOCK, &erase);
517 "I/O error on %s: %s\n",
518 DEVNAME(otherdev), strerror(errno));
525 if (lseek (fd, DEVOFFSET(curdev), SEEK_SET) == -1) {
527 "seek error on %s: %s\n",
528 DEVNAME(curdev), strerror(errno));
531 if (read (fd, &environment, len) != len) {
533 "CRC read error on %s: %s\n",
534 DEVNAME(curdev), strerror(errno));
537 if ((rc = read (fd, environment.data, ENV_SIZE)) != ENV_SIZE) {
539 "Read error on %s: %s\n",
540 DEVNAME(curdev), strerror(errno));
547 "I/O error on %s: %s\n",
548 DEVNAME(curdev), strerror(errno));
557 * s1 is either a simple 'name', or a 'name=value' pair.
558 * s2 is a 'name=value' pair.
559 * If the names match, return the value of s2, else NULL.
563 envmatch (uchar *s1, uchar *s2)
569 if (*s1 == '\0' && *(s2-1) == '=')
575 * Prevent confusion if running from erased flash memory
577 static int env_init(void)
583 uchar flag1, flag2, *addr2;
585 if (parse_config()) /* should fill envdevices */
588 if ((addr1 = calloc (1, ENV_SIZE)) == NULL) {
590 "Not enough memory for environment (%ld bytes)\n",
595 /* read environment from FLASH to local buffer */
596 environment.data = addr1;
598 if (flash_io (O_RDONLY)) {
602 crc1_ok = ((crc1 = crc32(0, environment.data, ENV_SIZE))
604 if (!HaveRedundEnv) {
607 "Warning: Bad CRC, using default environment\n");
608 environment.data = default_environment;
612 flag1 = environment.flags;
615 if ((addr2 = calloc (1, ENV_SIZE)) == NULL) {
617 "Not enough memory for environment (%ld bytes)\n",
621 environment.data = addr2;
623 if (flash_io (O_RDONLY)) {
627 crc2_ok = ((crc2 = crc32(0, environment.data, ENV_SIZE))
629 flag2 = environment.flags;
631 if (crc1_ok && ! crc2_ok) {
632 environment.data = addr1;
633 environment.flags = flag1;
634 environment.crc = crc1;
638 else if (! crc1_ok && crc2_ok) {
639 environment.data = addr2;
640 environment.flags = flag2;
641 environment.crc = crc2;
645 else if (! crc1_ok && ! crc2_ok) {
647 "Warning: Bad CRC, using default environment\n");
648 environment.data = default_environment;
653 else if (flag1 == active_flag && flag2 == obsolete_flag) {
654 environment.data = addr1;
655 environment.flags = flag1;
656 environment.crc = crc1;
660 else if (flag1 == obsolete_flag && flag2 == active_flag) {
661 environment.data = addr2;
662 environment.flags = flag2;
663 environment.crc = crc2;
667 else if (flag1 == flag2) {
668 environment.data = addr1;
669 environment.flags = flag1;
670 environment.crc = crc1;
674 else if (flag1 == 0xFF) {
675 environment.data = addr1;
676 environment.flags = flag1;
677 environment.crc = crc1;
681 else if (flag2 == 0xFF) {
682 environment.data = addr2;
683 environment.flags = flag2;
684 environment.crc = crc2;
693 static int parse_config()
697 #if defined(CONFIG_FILE)
698 /* Fills in DEVNAME(), ENVSIZE(), DEVESIZE(). Or don't. */
699 if (get_config(CONFIG_FILE)) {
701 "Cannot parse config file: %s\n",
707 strcpy(DEVNAME(0), DEVICE1_NAME);
708 DEVOFFSET(0) = DEVICE1_OFFSET;
709 ENVSIZE(0) = ENV1_SIZE;
710 DEVESIZE(0) = DEVICE1_ESIZE;
712 strcpy(DEVNAME(1), DEVICE2_NAME);
713 DEVOFFSET(1) = DEVICE2_OFFSET;
714 ENVSIZE(1) = ENV2_SIZE;
715 DEVESIZE(1) = DEVICE2_ESIZE;
719 if (stat (DEVNAME(0), &st)) {
721 "Cannot access MTD device %s: %s\n",
722 DEVNAME(0), strerror(errno));
726 if (HaveRedundEnv && stat (DEVNAME(1), &st)) {
728 "Cannot access MTD device %s: %s\n",
729 DEVNAME(2), strerror(errno));
735 #if defined(CONFIG_FILE)
736 static int get_config (char *fname)
743 if ((fp = fopen(fname, "r")) == NULL) {
748 ((rc = fscanf (fp, "%s %lx %lx %lx",
749 DEVNAME(i), &DEVOFFSET(i), &ENVSIZE(i), &DEVESIZE(i))) != EOF)) {
751 /* Skip incomplete conversions and comment strings */
752 if ((rc < 3) || (*DEVNAME(i) == '#')) {
753 fgets (dump, sizeof(dump), fp); /* Consume till end */
761 HaveRedundEnv = i - 1;
762 if (!i) { /* No valid entries found */