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