tools/env/fw_env.c

   1 /*
   2  * (C) Copyright 2000-2010
   3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   4  *
   5  * (C) Copyright 2008
   6  * Guennadi Liakhovetski, DENX Software Engineering, lg@denx.de.
   7  *
   8  * See file CREDITS for list of people who contributed to this
   9  * project.
  10  *
  11  * This program is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU General Public License as
  13  * published by the Free Software Foundation; either version 2 of
  14  * the License, or (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  24  * MA 02111-1307 USA
  25  */
  26
  27 #include <errno.h>
  28 #include <fcntl.h>
  29 #include <stdio.h>
  30 #include <stdlib.h>
  31 #include <stddef.h>
  32 #include <string.h>
  33 #include <sys/types.h>
  34 #include <sys/ioctl.h>
  35 #include <sys/stat.h>
  36 #include <unistd.h>
  37
  38 #ifdef MTD_OLD
  39 # include <stdint.h>
  40 # include <linux/mtd/mtd.h>
  41 #else
  42 # define  __user        /* nothing */
  43 # include <mtd/mtd-user.h>
  44 #endif
  45
  46 #include "fw_env.h"
  47
  48 #define WHITESPACE(c) ((c == '\t') || (c == ' '))
  49
  50 #define min(x, y) ({                            \
  51         typeof(x) _min1 = (x);                  \
  52         typeof(y) _min2 = (y);                  \
  53         (void) (&_min1 == &_min2);              \
  54         _min1 < _min2 ? _min1 : _min2; })
  55
  56 struct envdev_s {
  57         char devname[16];               /* Device name */
  58         ulong devoff;                   /* Device offset */
  59         ulong env_size;                 /* environment size */
  60         ulong erase_size;               /* device erase size */
  61         ulong env_sectors;              /* number of environment sectors */
  62         uint8_t mtd_type;               /* type of the MTD device */
  63 };
  64
  65 static struct envdev_s envdevices[2] =
  66 {
  67         {
  68                 .mtd_type = MTD_ABSENT,
  69         }, {
  70                 .mtd_type = MTD_ABSENT,
  71         },
  72 };
  73 static int dev_current;
  74
  75 #define DEVNAME(i)    envdevices[(i)].devname
  76 #define DEVOFFSET(i)  envdevices[(i)].devoff
  77 #define ENVSIZE(i)    envdevices[(i)].env_size
  78 #define DEVESIZE(i)   envdevices[(i)].erase_size
  79 #define ENVSECTORS(i) envdevices[(i)].env_sectors
  80 #define DEVTYPE(i)    envdevices[(i)].mtd_type
  81
  82 #define CUR_ENVSIZE ENVSIZE(dev_current)
  83
  84 #define ENV_SIZE      getenvsize()
  85
  86 struct env_image_single {
  87         uint32_t        crc;    /* CRC32 over data bytes    */
  88         char            data[];
  89 };
  90
  91 struct env_image_redundant {
  92         uint32_t        crc;    /* CRC32 over data bytes    */
  93         unsigned char   flags;  /* active or obsolete */
  94         char            data[];
  95 };
  96
  97 enum flag_scheme {
  98         FLAG_NONE,
  99         FLAG_BOOLEAN,
 100         FLAG_INCREMENTAL,
 101 };
 102
 103 struct environment {
 104         void                    *image;
 105         uint32_t                *crc;
 106         unsigned char           *flags;
 107         char                    *data;
 108         enum flag_scheme        flag_scheme;
 109 };
 110
 111 static struct environment environment = {
 112         .flag_scheme = FLAG_NONE,
 113 };
 114
 115 static int HaveRedundEnv = 0;
 116
 117 static unsigned char active_flag = 1;
 118 /* obsolete_flag must be 0 to efficiently set it on NOR flash without erasing */
 119 static unsigned char obsolete_flag = 0;
 120
 121
 122 static char default_environment[] = {
 123 #if defined(CONFIG_BOOTARGS)
 124         "bootargs=" CONFIG_BOOTARGS "\0"
 125 #endif
 126 #if defined(CONFIG_BOOTCOMMAND)
 127         "bootcmd=" CONFIG_BOOTCOMMAND "\0"
 128 #endif
 129 #if defined(CONFIG_RAMBOOTCOMMAND)
 130         "ramboot=" CONFIG_RAMBOOTCOMMAND "\0"
 131 #endif
 132 #if defined(CONFIG_NFSBOOTCOMMAND)
 133         "nfsboot=" CONFIG_NFSBOOTCOMMAND "\0"
 134 #endif
 135 #if defined(CONFIG_BOOTDELAY) && (CONFIG_BOOTDELAY >= 0)
 136         "bootdelay=" __stringify(CONFIG_BOOTDELAY) "\0"
 137 #endif
 138 #if defined(CONFIG_BAUDRATE) && (CONFIG_BAUDRATE >= 0)
 139         "baudrate=" __stringify(CONFIG_BAUDRATE) "\0"
 140 #endif
 141 #ifdef  CONFIG_LOADS_ECHO
 142         "loads_echo=" __stringify(CONFIG_LOADS_ECHO) "\0"
 143 #endif
 144 #ifdef  CONFIG_ETHADDR
 145         "ethaddr=" __stringify(CONFIG_ETHADDR) "\0"
 146 #endif
 147 #ifdef  CONFIG_ETH1ADDR
 148         "eth1addr=" __stringify(CONFIG_ETH1ADDR) "\0"
 149 #endif
 150 #ifdef  CONFIG_ETH2ADDR
 151         "eth2addr=" __stringify(CONFIG_ETH2ADDR) "\0"
 152 #endif
 153 #ifdef  CONFIG_ETH3ADDR
 154         "eth3addr=" __stringify(CONFIG_ETH3ADDR) "\0"
 155 #endif
 156 #ifdef  CONFIG_ETH4ADDR
 157         "eth4addr=" __stringify(CONFIG_ETH4ADDR) "\0"
 158 #endif
 159 #ifdef  CONFIG_ETH5ADDR
 160         "eth5addr=" __stringify(CONFIG_ETH5ADDR) "\0"
 161 #endif
 162 #ifdef  CONFIG_ETHPRIME
 163         "ethprime=" CONFIG_ETHPRIME "\0"
 164 #endif
 165 #ifdef  CONFIG_IPADDR
 166         "ipaddr=" __stringify(CONFIG_IPADDR) "\0"
 167 #endif
 168 #ifdef  CONFIG_SERVERIP
 169         "serverip=" __stringify(CONFIG_SERVERIP) "\0"
 170 #endif
 171 #ifdef  CONFIG_SYS_AUTOLOAD
 172         "autoload=" CONFIG_SYS_AUTOLOAD "\0"
 173 #endif
 174 #ifdef  CONFIG_ROOTPATH
 175         "rootpath=" CONFIG_ROOTPATH "\0"
 176 #endif
 177 #ifdef  CONFIG_GATEWAYIP
 178         "gatewayip=" __stringify(CONFIG_GATEWAYIP) "\0"
 179 #endif
 180 #ifdef  CONFIG_NETMASK
 181         "netmask=" __stringify(CONFIG_NETMASK) "\0"
 182 #endif
 183 #ifdef  CONFIG_HOSTNAME
 184         "hostname=" __stringify(CONFIG_HOSTNAME) "\0"
 185 #endif
 186 #ifdef  CONFIG_BOOTFILE
 187         "bootfile=" CONFIG_BOOTFILE "\0"
 188 #endif
 189 #ifdef  CONFIG_LOADADDR
 190         "loadaddr=" __stringify(CONFIG_LOADADDR) "\0"
 191 #endif
 192 #ifdef  CONFIG_PREBOOT
 193         "preboot=" CONFIG_PREBOOT "\0"
 194 #endif
 195 #ifdef  CONFIG_CLOCKS_IN_MHZ
 196         "clocks_in_mhz=" "1" "\0"
 197 #endif
 198 #if defined(CONFIG_PCI_BOOTDELAY) && (CONFIG_PCI_BOOTDELAY > 0)
 199         "pcidelay=" __stringify(CONFIG_PCI_BOOTDELAY) "\0"
 200 #endif
 201 #ifdef  CONFIG_ENV_VARS_UBOOT_CONFIG
 202         "arch=" CONFIG_SYS_ARCH "\0"
 203         "cpu=" CONFIG_SYS_CPU "\0"
 204         "board=" CONFIG_SYS_BOARD "\0"
 205 #ifdef CONFIG_SYS_VENDOR
 206         "vendor=" CONFIG_SYS_VENDOR "\0"
 207 #endif
 208 #ifdef CONFIG_SYS_SOC
 209         "soc=" CONFIG_SYS_SOC "\0"
 210 #endif
 211 #endif
 212 #ifdef  CONFIG_EXTRA_ENV_SETTINGS
 213         CONFIG_EXTRA_ENV_SETTINGS
 214 #endif
 215         "\0"            /* Termimate struct environment data with 2 NULs */
 216 };
 217
 218 static int flash_io (int mode);
 219 static char *envmatch (char * s1, char * s2);
 220 static int parse_config (void);
 221
 222 #if defined(CONFIG_FILE)
 223 static int get_config (char *);
 224 #endif
 225 static inline ulong getenvsize (void)
 226 {
 227         ulong rc = CUR_ENVSIZE - sizeof(long);
 228
 229         if (HaveRedundEnv)
 230                 rc -= sizeof (char);
 231         return rc;
 232 }
 233
 234 static char *fw_string_blank(char *s, int noblank)
 235 {
 236         int i;
 237         int len = strlen(s);
 238
 239         for (i = 0; i < len; i++, s++) {
 240                 if ((noblank && !WHITESPACE(*s)) ||
 241                         (!noblank && WHITESPACE(*s)))
 242                         break;
 243         }
 244         if (i == len)
 245                 return NULL;
 246
 247         return s;
 248 }
 249
 250 /*
 251  * Search the environment for a variable.
 252  * Return the value, if found, or NULL, if not found.
 253  */
 254 char *fw_getenv (char *name)
 255 {
 256         char *env, *nxt;
 257
 258         for (env = environment.data; *env; env = nxt + 1) {
 259                 char *val;
 260
 261                 for (nxt = env; *nxt; ++nxt) {
 262                         if (nxt >= &environment.data[ENV_SIZE]) {
 263                                 fprintf (stderr, "## Error: "
 264                                         "environment not terminated\n");
 265                                 return NULL;
 266                         }
 267                 }
 268                 val = envmatch (name, env);
 269                 if (!val)
 270                         continue;
 271                 return val;
 272         }
 273         return NULL;
 274 }
 275
 276 /*
 277  * Print the current definition of one, or more, or all
 278  * environment variables
 279  */
 280 int fw_printenv (int argc, char *argv[])
 281 {
 282         char *env, *nxt;
 283         int i, n_flag;
 284         int rc = 0;
 285
 286         if (fw_env_open())
 287                 return -1;
 288
 289         if (argc == 1) {                /* Print all env variables  */
 290                 for (env = environment.data; *env; env = nxt + 1) {
 291                         for (nxt = env; *nxt; ++nxt) {
 292                                 if (nxt >= &environment.data[ENV_SIZE]) {
 293                                         fprintf (stderr, "## Error: "
 294                                                 "environment not terminated\n");
 295                                         return -1;
 296                                 }
 297                         }
 298
 299                         printf ("%s\n", env);
 300                 }
 301                 return 0;
 302         }
 303
 304         if (strcmp (argv[1], "-n") == 0) {
 305                 n_flag = 1;
 306                 ++argv;
 307                 --argc;
 308                 if (argc != 2) {
 309                         fprintf (stderr, "## Error: "
 310                                 "`-n' option requires exactly one argument\n");
 311                         return -1;
 312                 }
 313         } else {
 314                 n_flag = 0;
 315         }
 316
 317         for (i = 1; i < argc; ++i) {    /* print single env variables   */
 318                 char *name = argv[i];
 319                 char *val = NULL;
 320
 321                 for (env = environment.data; *env; env = nxt + 1) {
 322
 323                         for (nxt = env; *nxt; ++nxt) {
 324                                 if (nxt >= &environment.data[ENV_SIZE]) {
 325                                         fprintf (stderr, "## Error: "
 326                                                 "environment not terminated\n");
 327                                         return -1;
 328                                 }
 329                         }
 330                         val = envmatch (name, env);
 331                         if (val) {
 332                                 if (!n_flag) {
 333                                         fputs (name, stdout);
 334                                         putc ('=', stdout);
 335                                 }
 336                                 puts (val);
 337                                 break;
 338                         }
 339                 }
 340                 if (!val) {
 341                         fprintf (stderr, "## Error: \"%s\" not defined\n", name);
 342                         rc = -1;
 343                 }
 344         }
 345
 346         return rc;
 347 }
 348
 349 int fw_env_close(void)
 350 {
 351         /*
 352          * Update CRC
 353          */
 354         *environment.crc = crc32(0, (uint8_t *) environment.data, ENV_SIZE);
 355
 356         /* write environment back to flash */
 357         if (flash_io(O_RDWR)) {
 358                 fprintf(stderr,
 359                         "Error: can't write fw_env to flash\n");
 360                         return -1;
 361         }
 362
 363         return 0;
 364 }
 365
 366
 367 /*
 368  * Set/Clear a single variable in the environment.
 369  * This is called in sequence to update the environment
 370  * in RAM without updating the copy in flash after each set
 371  */
 372 int fw_env_write(char *name, char *value)
 373 {
 374         int len;
 375         char *env, *nxt;
 376         char *oldval = NULL;
 377
 378         /*
 379          * search if variable with this name already exists
 380          */
 381         for (nxt = env = environment.data; *env; env = nxt + 1) {
 382                 for (nxt = env; *nxt; ++nxt) {
 383                         if (nxt >= &environment.data[ENV_SIZE]) {
 384                                 fprintf(stderr, "## Error: "
 385                                         "environment not terminated\n");
 386                                 errno = EINVAL;
 387                                 return -1;
 388                         }
 389                 }
 390                 if ((oldval = envmatch (name, env)) != NULL)
 391                         break;
 392         }
 393
 394         /*
 395          * Delete any existing definition
 396          */
 397         if (oldval) {
 398 #ifndef CONFIG_ENV_OVERWRITE
 399                 /*
 400                  * Ethernet Address and serial# can be set only once
 401                  */
 402                 if (
 403                     (strcmp(name, "serial#") == 0) ||
 404                     ((strcmp(name, "ethaddr") == 0)
 405 #if defined(CONFIG_OVERWRITE_ETHADDR_ONCE) && defined(CONFIG_ETHADDR)
 406                     && (strcmp(oldval, __stringify(CONFIG_ETHADDR)) != 0)
 407 #endif /* CONFIG_OVERWRITE_ETHADDR_ONCE && CONFIG_ETHADDR */
 408                    ) ) {
 409                         fprintf (stderr, "Can't overwrite \"%s\"\n", name);
 410                         errno = EROFS;
 411                         return -1;
 412                 }
 413 #endif /* CONFIG_ENV_OVERWRITE */
 414
 415                 if (*++nxt == '\0') {
 416                         *env = '\0';
 417                 } else {
 418                         for (;;) {
 419                                 *env = *nxt++;
 420                                 if ((*env == '\0') && (*nxt == '\0'))
 421                                         break;
 422                                 ++env;
 423                         }
 424                 }
 425                 *++env = '\0';
 426         }
 427
 428         /* Delete only ? */
 429         if (!value || !strlen(value))
 430                 return 0;
 431
 432         /*
 433          * Append new definition at the end
 434          */
 435         for (env = environment.data; *env || *(env + 1); ++env);
 436         if (env > environment.data)
 437                 ++env;
 438         /*
 439          * Overflow when:
 440          * "name" + "=" + "val" +"\0\0"  > CUR_ENVSIZE - (env-environment)
 441          */
 442         len = strlen (name) + 2;
 443         /* add '=' for first arg, ' ' for all others */
 444         len += strlen(value) + 1;
 445
 446         if (len > (&environment.data[ENV_SIZE] - env)) {
 447                 fprintf (stderr,
 448                         "Error: environment overflow, \"%s\" deleted\n",
 449                         name);
 450                 return -1;
 451         }
 452
 453         while ((*env = *name++) != '\0')
 454                 env++;
 455         *env = '=';
 456         while ((*++env = *value++) != '\0')
 457                 ;
 458
 459         /* end is marked with double '\0' */
 460         *++env = '\0';
 461
 462         return 0;
 463 }
 464
 465 /*
 466  * Deletes or sets environment variables. Returns -1 and sets errno error codes:
 467  * 0      - OK
 468  * EINVAL - need at least 1 argument
 469  * EROFS  - certain variables ("ethaddr", "serial#") cannot be
 470  *          modified or deleted
 471  *
 472  */
 473 int fw_setenv(int argc, char *argv[])
 474 {
 475         int i, len;
 476         char *name;
 477         char *value = NULL;
 478
 479         if (argc < 2) {
 480                 errno = EINVAL;
 481                 return -1;
 482         }
 483
 484         if (fw_env_open()) {
 485                 fprintf(stderr, "Error: environment not initialized\n");
 486                 return -1;
 487         }
 488
 489         name = argv[1];
 490
 491         len = 0;
 492         for (i = 2; i < argc; ++i) {
 493                 char *val = argv[i];
 494                 size_t val_len = strlen(val);
 495
 496                 value = realloc(value, len + val_len + 1);
 497                 if (!value) {
 498                         fprintf(stderr,
 499                                 "Cannot malloc %zu bytes: %s\n",
 500                                 len, strerror(errno));
 501                         return -1;
 502                 }
 503
 504                 memcpy(value + len, val, val_len);
 505                 len += val_len;
 506                 value[len++] = ' ';
 507         }
 508         value[len - 1] = '\0';
 509
 510         fw_env_write(name, value);
 511
 512         free(value);
 513
 514         return fw_env_close();
 515 }
 516
 517 /*
 518  * Parse  a file  and configure the u-boot variables.
 519  * The script file has a very simple format, as follows:
 520  *
 521  * Each line has a couple with name, value:
 522  * <white spaces>variable_name<white spaces>variable_value
 523  *
 524  * Both variable_name and variable_value are interpreted as strings.
 525  * Any character after <white spaces> and before ending \r\n is interpreted
 526  * as variable's value (no comment allowed on these lines !)
 527  *
 528  * Comments are allowed if the first character in the line is #
 529  *
 530  * Returns -1 and sets errno error codes:
 531  * 0      - OK
 532  * -1     - Error
 533  */
 534 int fw_parse_script(char *fname)
 535 {
 536         FILE *fp;
 537         char dump[1024];        /* Maximum line length in the file */
 538         char *name;
 539         char *val;
 540         int lineno = 0;
 541         int len;
 542         int ret = 0;
 543
 544         if (fw_env_open()) {
 545                 fprintf(stderr, "Error: environment not initialized\n");
 546                 return -1;
 547         }
 548
 549         if (strcmp(fname, "-") == 0)
 550                 fp = stdin;
 551         else {
 552                 fp = fopen(fname, "r");
 553                 if (fp == NULL) {
 554                         fprintf(stderr, "I cannot open %s for reading\n",
 555                                  fname);
 556                         return -1;
 557                 }
 558         }
 559
 560         while (fgets(dump, sizeof(dump), fp)) {
 561                 lineno++;
 562                 len = strlen(dump);
 563
 564                 /*
 565                  * Read a whole line from the file. If the line is too long
 566                  * or is not terminated, reports an error and exit.
 567                  */
 568                 if (dump[len - 1] != '\n') {
 569                         fprintf(stderr,
 570                         "Line %d not corrected terminated or too long\n",
 571                                 lineno);
 572                         ret = -1;
 573                         break;
 574                 }
 575
 576                 /* Drop ending line feed / carriage return */
 577                 while (len > 0 && (dump[len - 1] == '\n' ||
 578                                 dump[len - 1] == '\r')) {
 579                         dump[len - 1] = '\0';
 580                         len--;
 581                 }
 582
 583                 /* Skip comment or empty lines */
 584                 if ((len == 0) || dump[0] == '#')
 585                         continue;
 586
 587                 /*
 588                  * Search for variable's name,
 589                  * remove leading whitespaces
 590                  */
 591                 name = fw_string_blank(dump, 1);
 592                 if (!name)
 593                         continue;
 594
 595                 /* The first white space is the end of variable name */
 596                 val = fw_string_blank(name, 0);
 597                 len = strlen(name);
 598                 if (val) {
 599                         *val++ = '\0';
 600                         if ((val - name) < len)
 601                                 val = fw_string_blank(val, 1);
 602                         else
 603                                 val = NULL;
 604                 }
 605
 606 #ifdef DEBUG
 607                 fprintf(stderr, "Setting %s : %s\n",
 608                         name, val ? val : " removed");
 609 #endif
 610
 611                 /*
 612                  * If there is an error setting a variable,
 613                  * try to save the environment and returns an error
 614                  */
 615                 if (fw_env_write(name, val)) {
 616                         fprintf(stderr,
 617                         "fw_env_write returns with error : %s\n",
 618                                 strerror(errno));
 619                         ret = -1;
 620                         break;
 621                 }
 622
 623         }
 624
 625         /* Close file if not stdin */
 626         if (strcmp(fname, "-") != 0)
 627                 fclose(fp);
 628
 629         ret |= fw_env_close();
 630
 631         return ret;
 632
 633 }
 634
 635 /*
 636  * Test for bad block on NAND, just returns 0 on NOR, on NAND:
 637  * 0    - block is good
 638  * > 0  - block is bad
 639  * < 0  - failed to test
 640  */
 641 static int flash_bad_block (int fd, uint8_t mtd_type, loff_t *blockstart)
 642 {
 643         if (mtd_type == MTD_NANDFLASH) {
 644                 int badblock = ioctl (fd, MEMGETBADBLOCK, blockstart);
 645
 646                 if (badblock < 0) {
 647                         perror ("Cannot read bad block mark");
 648                         return badblock;
 649                 }
 650
 651                 if (badblock) {
 652 #ifdef DEBUG
 653                         fprintf (stderr, "Bad block at 0x%llx, "
 654                                  "skipping\n", *blockstart);
 655 #endif
 656                         return badblock;
 657                 }
 658         }
 659
 660         return 0;
 661 }
 662
 663 /*
 664  * Read data from flash at an offset into a provided buffer. On NAND it skips
 665  * bad blocks but makes sure it stays within ENVSECTORS (dev) starting from
 666  * the DEVOFFSET (dev) block. On NOR the loop is only run once.
 667  */
 668 static int flash_read_buf (int dev, int fd, void *buf, size_t count,
 669                            off_t offset, uint8_t mtd_type)
 670 {
 671         size_t blocklen;        /* erase / write length - one block on NAND,
 672                                    0 on NOR */
 673         size_t processed = 0;   /* progress counter */
 674         size_t readlen = count; /* current read length */
 675         off_t top_of_range;     /* end of the last block we may use */
 676         off_t block_seek;       /* offset inside the current block to the start
 677                                    of the data */
 678         loff_t blockstart;      /* running start of the current block -
 679                                    MEMGETBADBLOCK needs 64 bits */
 680         int rc;
 681
 682         blockstart = (offset / DEVESIZE (dev)) * DEVESIZE (dev);
 683
 684         /* Offset inside a block */
 685         block_seek = offset - blockstart;
 686
 687         if (mtd_type == MTD_NANDFLASH) {
 688                 /*
 689                  * NAND: calculate which blocks we are reading. We have
 690                  * to read one block at a time to skip bad blocks.
 691                  */
 692                 blocklen = DEVESIZE (dev);
 693
 694                 /*
 695                  * To calculate the top of the range, we have to use the
 696                  * global DEVOFFSET (dev), which can be different from offset
 697                  */
 698                 top_of_range = ((DEVOFFSET(dev) / blocklen) +
 699                                 ENVSECTORS (dev)) * blocklen;
 700
 701                 /* Limit to one block for the first read */
 702                 if (readlen > blocklen - block_seek)
 703                         readlen = blocklen - block_seek;
 704         } else {
 705                 blocklen = 0;
 706                 top_of_range = offset + count;
 707         }
 708
 709         /* This only runs once on NOR flash */
 710         while (processed < count) {
 711                 rc = flash_bad_block (fd, mtd_type, &blockstart);
 712                 if (rc < 0)             /* block test failed */
 713                         return -1;
 714
 715                 if (blockstart + block_seek + readlen > top_of_range) {
 716                         /* End of range is reached */
 717                         fprintf (stderr,
 718                                  "Too few good blocks within range\n");
 719                         return -1;
 720                 }
 721
 722                 if (rc) {               /* block is bad */
 723                         blockstart += blocklen;
 724                         continue;
 725                 }
 726
 727                 /*
 728                  * If a block is bad, we retry in the next block at the same
 729                  * offset - see common/env_nand.c::writeenv()
 730                  */
 731                 lseek (fd, blockstart + block_seek, SEEK_SET);
 732
 733                 rc = read (fd, buf + processed, readlen);
 734                 if (rc != readlen) {
 735                         fprintf (stderr, "Read error on %s: %s\n",
 736                                  DEVNAME (dev), strerror (errno));
 737                         return -1;
 738                 }
 739 #ifdef DEBUG
 740                 fprintf (stderr, "Read 0x%x bytes at 0x%llx\n",
 741                          rc, blockstart + block_seek);
 742 #endif
 743                 processed += readlen;
 744                 readlen = min (blocklen, count - processed);
 745                 block_seek = 0;
 746                 blockstart += blocklen;
 747         }
 748
 749         return processed;
 750 }
 751
 752 /*
 753  * Write count bytes at offset, but stay within ENVSECTORS (dev) sectors of
 754  * DEVOFFSET (dev). Similar to the read case above, on NOR and dataflash we
 755  * erase and write the whole data at once.
 756  */
 757 static int flash_write_buf (int dev, int fd, void *buf, size_t count,
 758                             off_t offset, uint8_t mtd_type)
 759 {
 760         void *data;
 761         struct erase_info_user erase;
 762         size_t blocklen;        /* length of NAND block / NOR erase sector */
 763         size_t erase_len;       /* whole area that can be erased - may include
 764                                    bad blocks */
 765         size_t erasesize;       /* erase / write length - one block on NAND,
 766                                    whole area on NOR */
 767         size_t processed = 0;   /* progress counter */
 768         size_t write_total;     /* total size to actually write - excluding
 769                                    bad blocks */
 770         off_t erase_offset;     /* offset to the first erase block (aligned)
 771                                    below offset */
 772         off_t block_seek;       /* offset inside the erase block to the start
 773                                    of the data */
 774         off_t top_of_range;     /* end of the last block we may use */
 775         loff_t blockstart;      /* running start of the current block -
 776                                    MEMGETBADBLOCK needs 64 bits */
 777         int rc;
 778
 779         blocklen = DEVESIZE (dev);
 780
 781         top_of_range = ((DEVOFFSET(dev) / blocklen) +
 782                                         ENVSECTORS (dev)) * blocklen;
 783
 784         erase_offset = (offset / blocklen) * blocklen;
 785
 786         /* Maximum area we may use */
 787         erase_len = top_of_range - erase_offset;
 788
 789         blockstart = erase_offset;
 790         /* Offset inside a block */
 791         block_seek = offset - erase_offset;
 792
 793         /*
 794          * Data size we actually have to write: from the start of the block
 795          * to the start of the data, then count bytes of data, and to the
 796          * end of the block
 797          */
 798         write_total = ((block_seek + count + blocklen - 1) /
 799                                                 blocklen) * blocklen;
 800
 801         /*
 802          * Support data anywhere within erase sectors: read out the complete
 803          * area to be erased, replace the environment image, write the whole
 804          * block back again.
 805          */
 806         if (write_total > count) {
 807                 data = malloc (erase_len);
 808                 if (!data) {
 809                         fprintf (stderr,
 810                                  "Cannot malloc %zu bytes: %s\n",
 811                                  erase_len, strerror (errno));
 812                         return -1;
 813                 }
 814
 815                 rc = flash_read_buf (dev, fd, data, write_total, erase_offset,
 816                                      mtd_type);
 817                 if (write_total != rc)
 818                         return -1;
 819
 820                 /* Overwrite the old environment */
 821                 memcpy (data + block_seek, buf, count);
 822         } else {
 823                 /*
 824                  * We get here, iff offset is block-aligned and count is a
 825                  * multiple of blocklen - see write_total calculation above
 826                  */
 827                 data = buf;
 828         }
 829
 830         if (mtd_type == MTD_NANDFLASH) {
 831                 /*
 832                  * NAND: calculate which blocks we are writing. We have
 833                  * to write one block at a time to skip bad blocks.
 834                  */
 835                 erasesize = blocklen;
 836         } else {
 837                 erasesize = erase_len;
 838         }
 839
 840         erase.length = erasesize;
 841
 842         /* This only runs once on NOR flash and SPI-dataflash */
 843         while (processed < write_total) {
 844                 rc = flash_bad_block (fd, mtd_type, &blockstart);
 845                 if (rc < 0)             /* block test failed */
 846                         return rc;
 847
 848                 if (blockstart + erasesize > top_of_range) {
 849                         fprintf (stderr, "End of range reached, aborting\n");
 850                         return -1;
 851                 }
 852
 853                 if (rc) {               /* block is bad */
 854                         blockstart += blocklen;
 855                         continue;
 856                 }
 857
 858                 erase.start = blockstart;
 859                 ioctl (fd, MEMUNLOCK, &erase);
 860
 861                 /* Dataflash does not need an explicit erase cycle */
 862                 if (mtd_type != MTD_DATAFLASH)
 863                         if (ioctl (fd, MEMERASE, &erase) != 0) {
 864                                 fprintf (stderr, "MTD erase error on %s: %s\n",
 865                                          DEVNAME (dev),
 866                                          strerror (errno));
 867                                 return -1;
 868                         }
 869
 870                 if (lseek (fd, blockstart, SEEK_SET) == -1) {
 871                         fprintf (stderr,
 872                                  "Seek error on %s: %s\n",
 873                                  DEVNAME (dev), strerror (errno));
 874                         return -1;
 875                 }
 876
 877 #ifdef DEBUG
 878                 printf ("Write 0x%x bytes at 0x%llx\n", erasesize, blockstart);
 879 #endif
 880                 if (write (fd, data + processed, erasesize) != erasesize) {
 881                         fprintf (stderr, "Write error on %s: %s\n",
 882                                  DEVNAME (dev), strerror (errno));
 883                         return -1;
 884                 }
 885
 886                 ioctl (fd, MEMLOCK, &erase);
 887
 888                 processed  += blocklen;
 889                 block_seek = 0;
 890                 blockstart += blocklen;
 891         }
 892
 893         if (write_total > count)
 894                 free (data);
 895
 896         return processed;
 897 }
 898
 899 /*
 900  * Set obsolete flag at offset - NOR flash only
 901  */
 902 static int flash_flag_obsolete (int dev, int fd, off_t offset)
 903 {
 904         int rc;
 905         struct erase_info_user erase;
 906
 907         erase.start  = DEVOFFSET (dev);
 908         erase.length = DEVESIZE (dev);
 909         /* This relies on the fact, that obsolete_flag == 0 */
 910         rc = lseek (fd, offset, SEEK_SET);
 911         if (rc < 0) {
 912                 fprintf (stderr, "Cannot seek to set the flag on %s \n",
 913                          DEVNAME (dev));
 914                 return rc;
 915         }
 916         ioctl (fd, MEMUNLOCK, &erase);
 917         rc = write (fd, &obsolete_flag, sizeof (obsolete_flag));
 918         ioctl (fd, MEMLOCK, &erase);
 919         if (rc < 0)
 920                 perror ("Could not set obsolete flag");
 921
 922         return rc;
 923 }
 924
 925 static int flash_write (int fd_current, int fd_target, int dev_target)
 926 {
 927         int rc;
 928
 929         switch (environment.flag_scheme) {
 930         case FLAG_NONE:
 931                 break;
 932         case FLAG_INCREMENTAL:
 933                 (*environment.flags)++;
 934                 break;
 935         case FLAG_BOOLEAN:
 936                 *environment.flags = active_flag;
 937                 break;
 938         default:
 939                 fprintf (stderr, "Unimplemented flash scheme %u \n",
 940                          environment.flag_scheme);
 941                 return -1;
 942         }
 943
 944 #ifdef DEBUG
 945         printf ("Writing new environment at 0x%lx on %s\n",
 946                 DEVOFFSET (dev_target), DEVNAME (dev_target));
 947 #endif
 948         rc = flash_write_buf(dev_target, fd_target, environment.image,
 949                               CUR_ENVSIZE, DEVOFFSET(dev_target),
 950                               DEVTYPE(dev_target));
 951         if (rc < 0)
 952                 return rc;
 953
 954         if (environment.flag_scheme == FLAG_BOOLEAN) {
 955                 /* Have to set obsolete flag */
 956                 off_t offset = DEVOFFSET (dev_current) +
 957                         offsetof (struct env_image_redundant, flags);
 958 #ifdef DEBUG
 959                 printf ("Setting obsolete flag in environment at 0x%lx on %s\n",
 960                         DEVOFFSET (dev_current), DEVNAME (dev_current));
 961 #endif
 962                 flash_flag_obsolete (dev_current, fd_current, offset);
 963         }
 964
 965         return 0;
 966 }
 967
 968 static int flash_read (int fd)
 969 {
 970         struct mtd_info_user mtdinfo;
 971         int rc;
 972
 973         rc = ioctl (fd, MEMGETINFO, &mtdinfo);
 974         if (rc < 0) {
 975                 perror ("Cannot get MTD information");
 976                 return -1;
 977         }
 978
 979         if (mtdinfo.type != MTD_NORFLASH &&
 980             mtdinfo.type != MTD_NANDFLASH &&
 981             mtdinfo.type != MTD_DATAFLASH) {
 982                 fprintf (stderr, "Unsupported flash type %u\n", mtdinfo.type);
 983                 return -1;
 984         }
 985
 986         DEVTYPE(dev_current) = mtdinfo.type;
 987
 988         rc = flash_read_buf(dev_current, fd, environment.image, CUR_ENVSIZE,
 989                              DEVOFFSET (dev_current), mtdinfo.type);
 990
 991         return (rc != CUR_ENVSIZE) ? -1 : 0;
 992 }
 993
 994 static int flash_io (int mode)
 995 {
 996         int fd_current, fd_target, rc, dev_target;
 997
 998         /* dev_current: fd_current, erase_current */
 999         fd_current = open (DEVNAME (dev_current), mode);
1000         if (fd_current < 0) {
1001                 fprintf (stderr,
1002                          "Can't open %s: %s\n",
1003                          DEVNAME (dev_current), strerror (errno));
1004                 return -1;
1005         }
1006
1007         if (mode == O_RDWR) {
1008                 if (HaveRedundEnv) {
1009                         /* switch to next partition for writing */
1010                         dev_target = !dev_current;
1011                         /* dev_target: fd_target, erase_target */
1012                         fd_target = open (DEVNAME (dev_target), mode);
1013                         if (fd_target < 0) {
1014                                 fprintf (stderr,
1015                                          "Can't open %s: %s\n",
1016                                          DEVNAME (dev_target),
1017                                          strerror (errno));
1018                                 rc = -1;
1019                                 goto exit;
1020                         }
1021                 } else {
1022                         dev_target = dev_current;
1023                         fd_target = fd_current;
1024                 }
1025
1026                 rc = flash_write (fd_current, fd_target, dev_target);
1027
1028                 if (HaveRedundEnv) {
1029                         if (close (fd_target)) {
1030                                 fprintf (stderr,
1031                                         "I/O error on %s: %s\n",
1032                                         DEVNAME (dev_target),
1033                                         strerror (errno));
1034                                 rc = -1;
1035                         }
1036                 }
1037         } else {
1038                 rc = flash_read (fd_current);
1039         }
1040
1041 exit:
1042         if (close (fd_current)) {
1043                 fprintf (stderr,
1044                          "I/O error on %s: %s\n",
1045                          DEVNAME (dev_current), strerror (errno));
1046                 return -1;
1047         }
1048
1049         return rc;
1050 }
1051
1052 /*
1053  * s1 is either a simple 'name', or a 'name=value' pair.
1054  * s2 is a 'name=value' pair.
1055  * If the names match, return the value of s2, else NULL.
1056  */
1057
1058 static char *envmatch (char * s1, char * s2)
1059 {
1060         if (s1 == NULL || s2 == NULL)
1061                 return NULL;
1062
1063         while (*s1 == *s2++)
1064                 if (*s1++ == '=')
1065                         return s2;
1066         if (*s1 == '\0' && *(s2 - 1) == '=')
1067                 return s2;
1068         return NULL;
1069 }
1070
1071 /*
1072  * Prevent confusion if running from erased flash memory
1073  */
1074 int fw_env_open(void)
1075 {
1076         int crc0, crc0_ok;
1077         unsigned char flag0;
1078         void *addr0;
1079
1080         int crc1, crc1_ok;
1081         unsigned char flag1;
1082         void *addr1;
1083
1084         struct env_image_single *single;
1085         struct env_image_redundant *redundant;
1086
1087         if (parse_config ())            /* should fill envdevices */
1088                 return -1;
1089
1090         addr0 = calloc(1, CUR_ENVSIZE);
1091         if (addr0 == NULL) {
1092                 fprintf(stderr,
1093                         "Not enough memory for environment (%ld bytes)\n",
1094                         CUR_ENVSIZE);
1095                 return -1;
1096         }
1097
1098         /* read environment from FLASH to local buffer */
1099         environment.image = addr0;
1100
1101         if (HaveRedundEnv) {
1102                 redundant = addr0;
1103                 environment.crc         = &redundant->crc;
1104                 environment.flags       = &redundant->flags;
1105                 environment.data        = redundant->data;
1106         } else {
1107                 single = addr0;
1108                 environment.crc         = &single->crc;
1109                 environment.flags       = NULL;
1110                 environment.data        = single->data;
1111         }
1112
1113         dev_current = 0;
1114         if (flash_io (O_RDONLY))
1115                 return -1;
1116
1117         crc0 = crc32 (0, (uint8_t *) environment.data, ENV_SIZE);
1118         crc0_ok = (crc0 == *environment.crc);
1119         if (!HaveRedundEnv) {
1120                 if (!crc0_ok) {
1121                         fprintf (stderr,
1122                                 "Warning: Bad CRC, using default environment\n");
1123                         memcpy(environment.data, default_environment, sizeof default_environment);
1124                 }
1125         } else {
1126                 flag0 = *environment.flags;
1127
1128                 dev_current = 1;
1129                 addr1 = calloc(1, CUR_ENVSIZE);
1130                 if (addr1 == NULL) {
1131                         fprintf(stderr,
1132                                 "Not enough memory for environment (%ld bytes)\n",
1133                                 CUR_ENVSIZE);
1134                         return -1;
1135                 }
1136                 redundant = addr1;
1137
1138                 /*
1139                  * have to set environment.image for flash_read(), careful -
1140                  * other pointers in environment still point inside addr0
1141                  */
1142                 environment.image = addr1;
1143                 if (flash_io (O_RDONLY))
1144                         return -1;
1145
1146                 /* Check flag scheme compatibility */
1147                 if (DEVTYPE(dev_current) == MTD_NORFLASH &&
1148                     DEVTYPE(!dev_current) == MTD_NORFLASH) {
1149                         environment.flag_scheme = FLAG_BOOLEAN;
1150                 } else if (DEVTYPE(dev_current) == MTD_NANDFLASH &&
1151                            DEVTYPE(!dev_current) == MTD_NANDFLASH) {
1152                         environment.flag_scheme = FLAG_INCREMENTAL;
1153                 } else if (DEVTYPE(dev_current) == MTD_DATAFLASH &&
1154                            DEVTYPE(!dev_current) == MTD_DATAFLASH) {
1155                         environment.flag_scheme = FLAG_BOOLEAN;
1156                 } else {
1157                         fprintf (stderr, "Incompatible flash types!\n");
1158                         return -1;
1159                 }
1160
1161                 crc1 = crc32 (0, (uint8_t *) redundant->data, ENV_SIZE);
1162                 crc1_ok = (crc1 == redundant->crc);
1163                 flag1 = redundant->flags;
1164
1165                 if (crc0_ok && !crc1_ok) {
1166                         dev_current = 0;
1167                 } else if (!crc0_ok && crc1_ok) {
1168                         dev_current = 1;
1169                 } else if (!crc0_ok && !crc1_ok) {
1170                         fprintf (stderr,
1171                                 "Warning: Bad CRC, using default environment\n");
1172                         memcpy (environment.data, default_environment,
1173                                 sizeof default_environment);
1174                         dev_current = 0;
1175                 } else {
1176                         switch (environment.flag_scheme) {
1177                         case FLAG_BOOLEAN:
1178                                 if (flag0 == active_flag &&
1179                                     flag1 == obsolete_flag) {
1180                                         dev_current = 0;
1181                                 } else if (flag0 == obsolete_flag &&
1182                                            flag1 == active_flag) {
1183                                         dev_current = 1;
1184                                 } else if (flag0 == flag1) {
1185                                         dev_current = 0;
1186                                 } else if (flag0 == 0xFF) {
1187                                         dev_current = 0;
1188                                 } else if (flag1 == 0xFF) {
1189                                         dev_current = 1;
1190                                 } else {
1191                                         dev_current = 0;
1192                                 }
1193                                 break;
1194                         case FLAG_INCREMENTAL:
1195                                 if (flag0 == 255 && flag1 == 0)
1196                                         dev_current = 1;
1197                                 else if ((flag1 == 255 && flag0 == 0) ||
1198                                          flag0 >= flag1)
1199                                         dev_current = 0;
1200                                 else /* flag1 > flag0 */
1201                                         dev_current = 1;
1202                                 break;
1203                         default:
1204                                 fprintf (stderr, "Unknown flag scheme %u \n",
1205                                          environment.flag_scheme);
1206                                 return -1;
1207                         }
1208                 }
1209
1210                 /*
1211                  * If we are reading, we don't need the flag and the CRC any
1212                  * more, if we are writing, we will re-calculate CRC and update
1213                  * flags before writing out
1214                  */
1215                 if (dev_current) {
1216                         environment.image       = addr1;
1217                         environment.crc         = &redundant->crc;
1218                         environment.flags       = &redundant->flags;
1219                         environment.data        = redundant->data;
1220                         free (addr0);
1221                 } else {
1222                         environment.image       = addr0;
1223                         /* Other pointers are already set */
1224                         free (addr1);
1225                 }
1226         }
1227         return 0;
1228 }
1229
1230
1231 static int parse_config ()
1232 {
1233         struct stat st;
1234
1235 #if defined(CONFIG_FILE)
1236         /* Fills in DEVNAME(), ENVSIZE(), DEVESIZE(). Or don't. */
1237         if (get_config (CONFIG_FILE)) {
1238                 fprintf (stderr,
1239                         "Cannot parse config file: %s\n", strerror (errno));
1240                 return -1;
1241         }
1242 #else
1243         strcpy (DEVNAME (0), DEVICE1_NAME);
1244         DEVOFFSET (0) = DEVICE1_OFFSET;
1245         ENVSIZE (0) = ENV1_SIZE;
1246         /* Default values are: erase-size=env-size, #sectors=1 */
1247         DEVESIZE (0) = ENVSIZE (0);
1248         ENVSECTORS (0) = 1;
1249 #ifdef DEVICE1_ESIZE
1250         DEVESIZE (0) = DEVICE1_ESIZE;
1251 #endif
1252 #ifdef DEVICE1_ENVSECTORS
1253         ENVSECTORS (0) = DEVICE1_ENVSECTORS;
1254 #endif
1255
1256 #ifdef HAVE_REDUND
1257         strcpy (DEVNAME (1), DEVICE2_NAME);
1258         DEVOFFSET (1) = DEVICE2_OFFSET;
1259         ENVSIZE (1) = ENV2_SIZE;
1260         /* Default values are: erase-size=env-size, #sectors=1 */
1261         DEVESIZE (1) = ENVSIZE (1);
1262         ENVSECTORS (1) = 1;
1263 #ifdef DEVICE2_ESIZE
1264         DEVESIZE (1) = DEVICE2_ESIZE;
1265 #endif
1266 #ifdef DEVICE2_ENVSECTORS
1267         ENVSECTORS (1) = DEVICE2_ENVSECTORS;
1268 #endif
1269         HaveRedundEnv = 1;
1270 #endif
1271 #endif
1272         if (stat (DEVNAME (0), &st)) {
1273                 fprintf (stderr,
1274                         "Cannot access MTD device %s: %s\n",
1275                         DEVNAME (0), strerror (errno));
1276                 return -1;
1277         }
1278
1279         if (HaveRedundEnv && stat (DEVNAME (1), &st)) {
1280                 fprintf (stderr,
1281                         "Cannot access MTD device %s: %s\n",
1282                         DEVNAME (1), strerror (errno));
1283                 return -1;
1284         }
1285         return 0;
1286 }
1287
1288 #if defined(CONFIG_FILE)
1289 static int get_config (char *fname)
1290 {
1291         FILE *fp;
1292         int i = 0;
1293         int rc;
1294         char dump[128];
1295
1296         fp = fopen (fname, "r");
1297         if (fp == NULL)
1298                 return -1;
1299
1300         while (i < 2 && fgets (dump, sizeof (dump), fp)) {
1301                 /* Skip incomplete conversions and comment strings */
1302                 if (dump[0] == '#')
1303                         continue;
1304
1305                 rc = sscanf (dump, "%s %lx %lx %lx %lx",
1306                              DEVNAME (i),
1307                              &DEVOFFSET (i),
1308                              &ENVSIZE (i),
1309                              &DEVESIZE (i),
1310                              &ENVSECTORS (i));
1311
1312                 if (rc < 3)
1313                         continue;
1314
1315                 if (rc < 4)
1316                         /* Assume the erase size is the same as the env-size */
1317                         DEVESIZE(i) = ENVSIZE(i);
1318
1319                 if (rc < 5)
1320                         /* Default - 1 sector */
1321                         ENVSECTORS (i) = 1;
1322
1323                 i++;
1324         }
1325         fclose (fp);
1326
1327         HaveRedundEnv = i - 1;
1328         if (!i) {                       /* No valid entries found */
1329                 errno = EINVAL;
1330                 return -1;
1331         } else
1332                 return 0;
1333 }
1334 #endif