util/flashrom/flashrom.c

   1 /*
   2  * This file is part of the flashrom project.
   3  *
   4  * Copyright (C) 2000 Silicon Integrated System Corporation
   5  * Copyright (C) 2004 Tyan Corp <yhlu@tyan.com>
   6  * Copyright (C) 2005-2008 coresystems GmbH
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  21  */
  22
  23 #include <errno.h>
  24 #include <fcntl.h>
  25 #include <sys/mman.h>
  26 #include <sys/types.h>
  27 #include <sys/stat.h>
  28 #include <unistd.h>
  29 #include <stdio.h>
  30 #include <string.h>
  31 #include <stdlib.h>
  32 #include <getopt.h>
  33 #include <pci/pci.h>
  34 /* for iopl */
  35 #if defined (__sun) && (defined(__i386) || defined(__amd64))
  36 #include <strings.h>
  37 #include <sys/sysi86.h>
  38 #include <sys/psw.h>
  39 #include <asm/sunddi.h>
  40 #endif
  41 #include "flash.h"
  42
  43 char *chip_to_probe = NULL;
  44 struct pci_access *pacc;        /* For board and chipset_enable */
  45 int exclude_start_page, exclude_end_page;
  46 int verbose = 0;
  47 int fd_mem;
  48
  49 struct pci_dev *pci_dev_find(uint16_t vendor, uint16_t device)
  50 {
  51         struct pci_dev *temp;
  52         struct pci_filter filter;
  53
  54         pci_filter_init(NULL, &filter);
  55         filter.vendor = vendor;
  56         filter.device = device;
  57
  58         for (temp = pacc->devices; temp; temp = temp->next)
  59                 if (pci_filter_match(&filter, temp))
  60                         return temp;
  61
  62         return NULL;
  63 }
  64
  65 struct pci_dev *pci_card_find(uint16_t vendor, uint16_t device,
  66                               uint16_t card_vendor, uint16_t card_device)
  67 {
  68         struct pci_dev *temp;
  69         struct pci_filter filter;
  70
  71         pci_filter_init(NULL, &filter);
  72         filter.vendor = vendor;
  73         filter.device = device;
  74
  75         for (temp = pacc->devices; temp; temp = temp->next)
  76                 if (pci_filter_match(&filter, temp)) {
  77                         if ((card_vendor == pci_read_word(temp, PCI_SUBSYSTEM_VENDOR_ID)) &&
  78                             (card_device == pci_read_word(temp, PCI_SUBSYSTEM_ID)))
  79                                 return temp;
  80                 }
  81
  82         return NULL;
  83 }
  84
  85 int map_flash_registers(struct flashchip *flash)
  86 {
  87         volatile uint8_t *registers;
  88         size_t size = flash->total_size * 1024;
  89
  90         registers = mmap(0, size, PROT_WRITE | PROT_READ, MAP_SHARED,
  91                          fd_mem, (off_t) (0xFFFFFFFF - 0x400000 - size + 1));
  92
  93         if (registers == MAP_FAILED) {
  94                 perror("Can't mmap registers using " MEM_DEV);
  95                 exit(1);
  96         }
  97         flash->virtual_registers = registers;
  98
  99         return 0;
 100 }
 101
 102 struct flashchip *probe_flash(struct flashchip *first_flash, int force)
 103 {
 104         volatile uint8_t *bios;
 105         struct flashchip *flash;
 106         unsigned long flash_baseaddr = 0, size;
 107
 108         for (flash = first_flash; flash && flash->name; flash++) {
 109                 if (chip_to_probe && strcmp(flash->name, chip_to_probe) != 0)
 110                         continue;
 111                 printf_debug("Probing for %s %s, %d KB: ",
 112                              flash->vendor, flash->name, flash->total_size);
 113                 if (!flash->probe && !force) {
 114                         printf_debug("failed! flashrom has no probe function for this flash chip.\n");
 115                         continue;
 116                 }
 117
 118                 size = flash->total_size * 1024;
 119
 120                 /* If getpagesize() > size ->
 121                  * "Can't mmap memory using /dev/mem: Invalid argument"
 122                  * This should never happen as we don't support any flash chips
 123                  * smaller than 4k or 8k (yet).
 124                  */
 125
 126                 if (getpagesize() > size) {
 127                         /*
 128                          * if a flash size of 0 is mapped, we map a single page
 129                          * so we can probe in that area whether we know the
 130                          * vendor at least.
 131                          */
 132                         size = getpagesize();
 133                 }
 134
 135 #ifdef TS5300
 136                 // FIXME: Wrong place for this decision
 137                 // FIXME: This should be autodetected. It is trivial.
 138                 flash_baseaddr = 0x9400000;
 139 #else
 140                 flash_baseaddr = (0xffffffff - size + 1);
 141 #endif
 142
 143                 bios = mmap(0, size, PROT_WRITE | PROT_READ, MAP_SHARED,
 144                             fd_mem, (off_t) flash_baseaddr);
 145                 if (bios == MAP_FAILED) {
 146                         perror("Can't mmap memory using " MEM_DEV);
 147                         exit(1);
 148                 }
 149                 flash->virtual_memory = bios;
 150
 151                 if (force)
 152                         break;
 153
 154                 if (flash->probe(flash) != 1)
 155                         goto notfound;
 156
 157                 if (first_flash == flashchips || flash->model_id != GENERIC_DEVICE_ID)
 158                         break;
 159
 160 notfound:
 161                 munmap((void *)bios, size);
 162         }
 163
 164         if (!flash || !flash->name)
 165                 return NULL;
 166
 167         printf("Found chip \"%s %s\" (%d KB) at physical address 0x%lx.\n",
 168                flash->vendor, flash->name, flash->total_size, flash_baseaddr);
 169         return flash;
 170 }
 171
 172 int verify_flash(struct flashchip *flash, uint8_t *buf)
 173 {
 174         int idx;
 175         int total_size = flash->total_size * 1024;
 176         uint8_t *buf2 = (uint8_t *) calloc(total_size, sizeof(char));
 177         if (flash->read == NULL)
 178                 memcpy(buf2, (const char *)flash->virtual_memory, total_size);
 179         else
 180                 flash->read(flash, buf2);
 181
 182         printf("Verifying flash... ");
 183
 184         if (verbose)
 185                 printf("address: 0x00000000\b\b\b\b\b\b\b\b\b\b");
 186
 187         for (idx = 0; idx < total_size; idx++) {
 188                 if (verbose && ((idx & 0xfff) == 0xfff))
 189                         printf("0x%08x", idx);
 190
 191                 if (*(buf2 + idx) != *(buf + idx)) {
 192                         if (verbose) {
 193                                 printf("0x%08x ", idx);
 194                         }
 195                         printf("FAILED!  Expected=0x%02x, Read=0x%02x\n",
 196                                 *(buf + idx), *(buf2 + idx));
 197                         return 1;
 198                 }
 199
 200                 if (verbose && ((idx & 0xfff) == 0xfff))
 201                         printf("\b\b\b\b\b\b\b\b\b\b");
 202         }
 203         if (verbose)
 204                 printf("\b\b\b\b\b\b\b\b\b\b ");
 205
 206         printf("VERIFIED.          \n");
 207
 208         return 0;
 209 }
 210
 211 void print_supported_chips(void)
 212 {
 213         int i;
 214
 215         printf("Supported ROM chips:\n\n");
 216
 217         for (i = 0; flashchips[i].name != NULL; i++)
 218                 printf("%s %s\n", flashchips[i].vendor, flashchips[i].name);
 219 }
 220
 221 void usage(const char *name)
 222 {
 223         printf("usage: %s [-rwvEVfLhR] [-c chipname] [-s exclude_start]\n", name);
 224         printf("       [-e exclude_end] [-m [vendor:]part] [-l file.layout] [-i imagename] [file]\n");
 225         printf
 226             ("   -r | --read:                      read flash and save into file\n"
 227              "   -w | --write:                     write file into flash\n"
 228              "   -v | --verify:                    verify flash against file\n"
 229              "   -E | --erase:                     erase flash device\n"
 230              "   -V | --verbose:                   more verbose output\n"
 231              "   -c | --chip <chipname>:           probe only for specified flash chip\n"
 232              "   -s | --estart <addr>:             exclude start position\n"
 233              "   -e | --eend <addr>:               exclude end postion\n"
 234              "   -m | --mainboard <[vendor:]part>: override mainboard settings\n"
 235              "   -f | --force:                     force write without checking image\n"
 236              "   -l | --layout <file.layout>:      read rom layout from file\n"
 237              "   -i | --image <name>:              only flash image name from flash layout\n"
 238              "   -L | --list-supported:            print supported devices\n"
 239              "   -h | --help:                      print this help text\n"
 240              "   -R | --version:                   print the version (release)\n"
 241              "\n" " If no file is specified, then all that happens"
 242              " is that flash info is dumped.\n\n");
 243         exit(1);
 244 }
 245
 246 void print_version(void)
 247 {
 248         printf("flashrom r%s\n", FLASHROM_VERSION);
 249 }
 250
 251 int main(int argc, char *argv[])
 252 {
 253         uint8_t *buf;
 254         unsigned long size;
 255         FILE *image;
 256         /* Probe for up to three flash chips. */
 257         struct flashchip *flash, *flashes[3];
 258         int opt;
 259         int option_index = 0;
 260         int force = 0;
 261         int read_it = 0, write_it = 0, erase_it = 0, verify_it = 0;
 262         int ret = 0, i;
 263 #ifdef __FreeBSD__
 264         int io_fd;
 265 #endif
 266
 267         static struct option long_options[] = {
 268                 {"read", 0, 0, 'r'},
 269                 {"write", 0, 0, 'w'},
 270                 {"erase", 0, 0, 'E'},
 271                 {"verify", 0, 0, 'v'},
 272                 {"chip", 1, 0, 'c'},
 273                 {"estart", 1, 0, 's'},
 274                 {"eend", 1, 0, 'e'},
 275                 {"mainboard", 1, 0, 'm'},
 276                 {"verbose", 0, 0, 'V'},
 277                 {"force", 0, 0, 'f'},
 278                 {"layout", 1, 0, 'l'},
 279                 {"image", 1, 0, 'i'},
 280                 {"list-supported", 0, 0, 'L'},
 281                 {"help", 0, 0, 'h'},
 282                 {"version", 0, 0, 'R'},
 283                 {0, 0, 0, 0}
 284         };
 285
 286         char *filename = NULL;
 287
 288         unsigned int exclude_start_position = 0, exclude_end_position = 0;      // [x,y)
 289         char *tempstr = NULL, *tempstr2 = NULL;
 290
 291         if (argc > 1) {
 292                 /* Yes, print them. */
 293                 int i;
 294                 printf_debug("The arguments are:\n");
 295                 for (i = 1; i < argc; ++i)
 296                         printf_debug("%s\n", argv[i]);
 297         }
 298
 299         setbuf(stdout, NULL);
 300         while ((opt = getopt_long(argc, argv, "rRwvVEfc:s:e:m:l:i:Lh",
 301                                   long_options, &option_index)) != EOF) {
 302                 switch (opt) {
 303                 case 'r':
 304                         read_it = 1;
 305                         break;
 306                 case 'w':
 307                         write_it = 1;
 308                         break;
 309                 case 'v':
 310                         verify_it = 1;
 311                         break;
 312                 case 'c':
 313                         chip_to_probe = strdup(optarg);
 314                         break;
 315                 case 'V':
 316                         verbose = 1;
 317                         break;
 318                 case 'E':
 319                         erase_it = 1;
 320                         break;
 321                 case 's':
 322                         tempstr = strdup(optarg);
 323                         sscanf(tempstr, "%x", &exclude_start_position);
 324                         break;
 325                 case 'e':
 326                         tempstr = strdup(optarg);
 327                         sscanf(tempstr, "%x", &exclude_end_position);
 328                         break;
 329                 case 'm':
 330                         tempstr = strdup(optarg);
 331                         strtok(tempstr, ":");
 332                         tempstr2 = strtok(NULL, ":");
 333                         if (tempstr2) {
 334                                 lb_vendor = tempstr;
 335                                 lb_part = tempstr2;
 336                         } else {
 337                                 lb_vendor = NULL;
 338                                 lb_part = tempstr;
 339                         }
 340                         break;
 341                 case 'f':
 342                         force = 1;
 343                         break;
 344                 case 'l':
 345                         tempstr = strdup(optarg);
 346                         if (read_romlayout(tempstr))
 347                                 exit(1);
 348                         break;
 349                 case 'i':
 350                         tempstr = strdup(optarg);
 351                         find_romentry(tempstr);
 352                         break;
 353                 case 'L':
 354                         print_supported_chips();
 355                         print_supported_chipsets();
 356                         print_supported_boards();
 357                         exit(0);
 358                         break;
 359                 case 'R':
 360                         print_version();
 361                         exit(0);
 362                         break;
 363                 case 'h':
 364                 default:
 365                         usage(argv[0]);
 366                         break;
 367                 }
 368         }
 369
 370         if (read_it && write_it) {
 371                 printf("Error: -r and -w are mutually exclusive.\n");
 372                 usage(argv[0]);
 373         }
 374
 375         if (optind < argc)
 376                 filename = argv[optind++];
 377
 378         /* First get full io access */
 379 #if defined (__sun) && (defined(__i386) || defined(__amd64))
 380         if (sysi86(SI86V86, V86SC_IOPL, PS_IOPL) != 0) {
 381 #elif defined(__FreeBSD__)
 382         if ((io_fd = open("/dev/io", O_RDWR)) < 0) {
 383 #else
 384         if (iopl(3) != 0) {
 385 #endif
 386                fprintf(stderr, "ERROR: Could not get IO privileges (%s).\nYou need to be root.\n",
 387                         strerror(errno));
 388                 exit(1);
 389         }
 390
 391         /* Initialize PCI access for flash enables */
 392         pacc = pci_alloc();     /* Get the pci_access structure */
 393         /* Set all options you want -- here we stick with the defaults */
 394         pci_init(pacc);         /* Initialize the PCI library */
 395         pci_scan_bus(pacc);     /* We want to get the list of devices */
 396
 397         /* Open the memory device UNCACHED. That's important for MMIO. */
 398         if ((fd_mem = open(MEM_DEV, O_RDWR|O_SYNC)) < 0) {
 399                 perror("Error: Can not access memory using " MEM_DEV
 400                        ". You need to be root.");
 401                 exit(1);
 402         }
 403
 404         myusec_calibrate_delay();
 405
 406         /* We look at the lbtable first to see if we need a
 407          * mainboard specific flash enable sequence.
 408          */
 409         coreboot_init();
 410
 411         /* try to enable it. Failure IS an option, since not all motherboards
 412          * really need this to be done, etc., etc.
 413          */
 414         ret = chipset_flash_enable();
 415         if (ret == -2) {
 416                 printf("WARNING: No chipset found. Flash detection "
 417                        "will most likely fail.\n");
 418         }
 419
 420         board_flash_enable(lb_vendor, lb_part);
 421
 422         for (i = 0; i < ARRAY_SIZE(flashes); i++) {
 423                 flashes[i] = probe_flash(i ? flashes[i - 1] + 1 : flashchips, 0);
 424                 if (!flashes[i])
 425                         for (i++; i < ARRAY_SIZE(flashes); i++)
 426                                 flashes[i] = NULL;
 427         }
 428
 429         if (flashes[1]) {
 430                 printf("Multiple flash chips were detected:");
 431                 for (i = 0; i < ARRAY_SIZE(flashes) && flashes[i]; i++)
 432                         printf(" %s", flashes[i]->name);
 433                 printf("\nPlease specify which chip to use with the -c <chipname> option.\n");
 434                 exit(1);
 435         } else if (!flashes[0]) {
 436                 printf("No EEPROM/flash device found.\n");
 437                 if (!force || !chip_to_probe) {
 438                         printf("If you know which flash chip you have, and if this version of flashrom\n");
 439                         printf("supports a similar flash chip, you can try to force read your chip. Run:\n");
 440                         printf("flashrom -f -r -c similar_supported_flash_chip filename\n");
 441                         printf("\n");
 442                         printf("Note: flashrom can never write when the flash chip isn't found automatically.\n");
 443                 }
 444                 if (force && read_it && chip_to_probe) {
 445                         printf("Force read (-f -r -c) requested, forcing chip probe success:\n");
 446                         flashes[0] = probe_flash(flashchips, 1);
 447                         if (!flashes[0]) {
 448                                 printf("flashrom does not support a flash chip named '%s'.\n", chip_to_probe);
 449                                 printf("Run flashrom -L to view the hardware supported in this flashrom version.\n");
 450                                 exit(1);
 451                         }
 452                         size = flashes[0]->total_size * 1024;
 453                         buf = (uint8_t *) calloc(size, sizeof(char));
 454
 455                         if ((image = fopen(filename, "w")) == NULL) {
 456                                 perror(filename);
 457                                 exit(1);
 458                         }
 459                         printf("Force reading flash...");
 460                         if (!flashes[0]->read)
 461                                 memcpy(buf, (const char *)flashes[0]->virtual_memory, size);
 462                         else
 463                                 flashes[0]->read(flashes[0], buf);
 464
 465                         if (exclude_end_position - exclude_start_position > 0)
 466                                 memset(buf + exclude_start_position, 0,
 467                                        exclude_end_position - exclude_start_position);
 468
 469                         fwrite(buf, sizeof(char), size, image);
 470                         fclose(image);
 471                         printf("done\n");
 472                         free(buf);
 473                         exit(0);
 474                 }
 475                 // FIXME: flash writes stay enabled!
 476                 exit(1);
 477         }
 478
 479         flash = flashes[0];
 480
 481         if (TEST_OK_MASK != (flash->tested & TEST_OK_MASK)) {
 482                 printf("===\n");
 483                 if (flash->tested & TEST_BAD_MASK) {
 484                         printf("This flash part has status NOT WORKING for operations:");
 485                         if (flash->tested & TEST_BAD_PROBE)
 486                                 printf(" PROBE");
 487                         if (flash->tested & TEST_BAD_READ)
 488                                 printf(" READ");
 489                         if (flash->tested & TEST_BAD_ERASE)
 490                                 printf(" ERASE");
 491                         if (flash->tested & TEST_BAD_WRITE)
 492                                 printf(" WRITE");
 493                         printf("\n");
 494                 } else {
 495                         printf("This flash part has status UNTESTED for operations:");
 496                         if (!(flash->tested & TEST_OK_PROBE))
 497                                 printf(" PROBE");
 498                         if (!(flash->tested & TEST_OK_READ))
 499                                 printf(" READ");
 500                         if (!(flash->tested & TEST_OK_ERASE))
 501                                 printf(" ERASE");
 502                         if (!(flash->tested & TEST_OK_WRITE))
 503                                 printf(" WRITE");
 504                         printf("\n");
 505                 }
 506                 printf("Please email a report to flashrom@coreboot.org if any of the above operations\n");
 507                 printf("work correctly for you with this flash part. Please include the full output\n");
 508                 printf("from the program, including chipset found. Thank you for your help!\n");
 509                 printf("===\n");
 510         }
 511
 512         if (!(read_it | write_it | verify_it | erase_it)) {
 513                 printf("No operations were specified.\n");
 514                 // FIXME: flash writes stay enabled!
 515                 exit(1);
 516         }
 517
 518         if (!filename && !erase_it) {
 519                 printf("Error: No filename specified.\n");
 520                 // FIXME: flash writes stay enabled!
 521                 exit(1);
 522         }
 523
 524         size = flash->total_size * 1024;
 525         buf = (uint8_t *) calloc(size, sizeof(char));
 526
 527         if (erase_it) {
 528                 printf("Erasing flash chip.\n");
 529                 if (!flash->erase) {
 530                         fprintf(stderr, "Error: flashrom has no erase function for this flash chip.\n");
 531                         return 1;
 532                 }
 533                 flash->erase(flash);
 534                 exit(0);
 535         } else if (read_it) {
 536                 if ((image = fopen(filename, "w")) == NULL) {
 537                         perror(filename);
 538                         exit(1);
 539                 }
 540                 printf("Reading Flash...");
 541                 if (flash->read == NULL)
 542                         memcpy(buf, (const char *)flash->virtual_memory, size);
 543                 else
 544                         flash->read(flash, buf);
 545
 546                 if (exclude_end_position - exclude_start_position > 0)
 547                         memset(buf + exclude_start_position, 0,
 548                                exclude_end_position - exclude_start_position);
 549
 550                 fwrite(buf, sizeof(char), size, image);
 551                 fclose(image);
 552                 printf("done\n");
 553         } else {
 554                 struct stat image_stat;
 555
 556                 if ((image = fopen(filename, "r")) == NULL) {
 557                         perror(filename);
 558                         exit(1);
 559                 }
 560                 if (fstat(fileno(image), &image_stat) != 0) {
 561                         perror(filename);
 562                         exit(1);
 563                 }
 564                 if (image_stat.st_size != flash->total_size * 1024) {
 565                         fprintf(stderr, "Error: Image size doesn't match\n");
 566                         exit(1);
 567                 }
 568
 569                 fread(buf, sizeof(char), size, image);
 570                 show_id(buf, size, force);
 571                 fclose(image);
 572         }
 573
 574         /* exclude range stuff. Nice idea, but at the moment it is only
 575          * supported in hardware by the pm49fl004 chips.
 576          * Instead of implementing this for all chips I suggest advancing
 577          * it to the rom layout feature below and drop exclude range
 578          * completely once all flash chips can do rom layouts. stepan
 579          */
 580
 581         // ////////////////////////////////////////////////////////////
 582         if (exclude_end_position - exclude_start_position > 0)
 583                 memcpy(buf + exclude_start_position,
 584                        (const char *)flash->virtual_memory +
 585                        exclude_start_position,
 586                        exclude_end_position - exclude_start_position);
 587
 588         exclude_start_page = exclude_start_position / flash->page_size;
 589         if ((exclude_start_position % flash->page_size) != 0) {
 590                 exclude_start_page++;
 591         }
 592         exclude_end_page = exclude_end_position / flash->page_size;
 593         // ////////////////////////////////////////////////////////////
 594
 595         // This should be moved into each flash part's code to do it
 596         // cleanly. This does the job.
 597         handle_romentries(buf, (uint8_t *) flash->virtual_memory);
 598
 599         // ////////////////////////////////////////////////////////////
 600
 601         if (write_it) {
 602                 if (!flash->write) {
 603                         fprintf(stderr, "Error: flashrom has no write function for this flash chip.\n");
 604                         return 1;
 605                 }
 606                 ret |= flash->write(flash, buf);
 607         }
 608
 609         if (verify_it)
 610                 ret |= verify_flash(flash, buf);
 611
 612 #ifdef __FreeBSD__
 613         close(io_fd);
 614 #endif
 615         return ret;
 616 }