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