2 * This file is part of the flashrom project.
4 * Copyright (C) 2000 Silicon Integrated System Corporation
5 * Copyright (C) 2004 Tyan Corp <yhlu@tyan.com>
6 * Copyright (C) 2005-2008 coresystems GmbH
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.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
26 #include <sys/types.h>
35 #if defined (__sun) && (defined(__i386) || defined(__amd64))
37 #include <sys/sysi86.h>
39 #include <asm/sunddi.h>
43 char *chip_to_probe = NULL;
44 struct pci_access *pacc; /* For board and chipset_enable */
45 int exclude_start_page, exclude_end_page;
49 struct pci_dev *pci_dev_find(uint16_t vendor, uint16_t device)
52 struct pci_filter filter;
54 pci_filter_init(NULL, &filter);
55 filter.vendor = vendor;
56 filter.device = device;
58 for (temp = pacc->devices; temp; temp = temp->next)
59 if (pci_filter_match(&filter, temp))
65 struct pci_dev *pci_card_find(uint16_t vendor, uint16_t device,
66 uint16_t card_vendor, uint16_t card_device)
69 struct pci_filter filter;
71 pci_filter_init(NULL, &filter);
72 filter.vendor = vendor;
73 filter.device = device;
75 for (temp = pacc->devices; temp; temp = temp->next)
76 if (pci_filter_match(&filter, temp)) {
78 pci_read_word(temp, PCI_SUBSYSTEM_VENDOR_ID))
80 pci_read_word(temp, PCI_SUBSYSTEM_ID)))
87 int map_flash_registers(struct flashchip *flash)
89 volatile uint8_t *registers;
90 size_t size = flash->total_size * 1024;
92 registers = mmap(0, size, PROT_WRITE | PROT_READ, MAP_SHARED,
93 fd_mem, (off_t) (0xFFFFFFFF - 0x400000 - size + 1));
95 if (registers == MAP_FAILED) {
96 perror("Can't mmap registers using " MEM_DEV);
99 flash->virtual_registers = registers;
104 struct flashchip *probe_flash(struct flashchip *first_flash, int force)
106 volatile uint8_t *bios;
107 struct flashchip *flash;
108 unsigned long base = 0, size;
110 for (flash = first_flash; flash && flash->name; flash++) {
111 if (chip_to_probe && strcmp(flash->name, chip_to_probe) != 0)
113 printf_debug("Probing for %s %s, %d KB: ",
114 flash->vendor, flash->name, flash->total_size);
115 if (!flash->probe && !force) {
116 printf_debug("failed! flashrom has no probe function for this flash chip.\n");
120 size = flash->total_size * 1024;
122 /* If getpagesize() > size ->
123 * "Can't mmap memory using /dev/mem: Invalid argument"
124 * This should never happen as we don't support any flash chips
125 * smaller than 4k or 8k (yet).
128 if (getpagesize() > size) {
130 * if a flash size of 0 is mapped, we map a single page
131 * so we can probe in that area whether we know the
134 size = getpagesize();
137 base = flashbase ? flashbase : (0xffffffff - size + 1);
138 bios = mmap(0, size, PROT_WRITE | PROT_READ, MAP_SHARED,
139 fd_mem, (off_t) base);
140 if (bios == MAP_FAILED) {
141 perror("Can't mmap memory using " MEM_DEV);
144 flash->virtual_memory = bios;
149 if (flash->probe(flash) != 1)
152 if (first_flash == flashchips
153 || flash->model_id != GENERIC_DEVICE_ID)
157 munmap((void *)bios, size);
160 if (!flash || !flash->name)
163 printf("Found chip \"%s %s\" (%d KB) at physical address 0x%lx.\n",
164 flash->vendor, flash->name, flash->total_size, base);
169 int verify_flash(struct flashchip *flash, uint8_t *buf)
172 int total_size = flash->total_size * 1024;
173 uint8_t *buf2 = (uint8_t *) calloc(total_size, sizeof(char));
174 if (flash->read == NULL)
175 memcpy(buf2, (const char *)flash->virtual_memory, total_size);
177 flash->read(flash, buf2);
179 printf("Verifying flash... ");
182 printf("address: 0x00000000\b\b\b\b\b\b\b\b\b\b");
184 for (idx = 0; idx < total_size; idx++) {
185 if (verbose && ((idx & 0xfff) == 0xfff))
186 printf("0x%08x", idx);
188 if (*(buf2 + idx) != *(buf + idx)) {
190 printf("0x%08x ", idx);
192 printf("FAILED! Expected=0x%02x, Read=0x%02x\n",
193 *(buf + idx), *(buf2 + idx));
197 if (verbose && ((idx & 0xfff) == 0xfff))
198 printf("\b\b\b\b\b\b\b\b\b\b");
201 printf("\b\b\b\b\b\b\b\b\b\b ");
203 printf("VERIFIED. \n");
208 #define MAX(a, b) ((a) > (b) ? (a) : (b))
209 #define POS_PRINT(x) do { pos += strlen(x); printf(x); } while (0)
211 void print_supported_chips(void)
213 int okcol = 0, pos = 0;
216 for (f = flashchips; f->name != NULL; f++) {
217 if (GENERIC_DEVICE_ID == f->model_id)
219 okcol = MAX(okcol, strlen(f->vendor) + 1 + strlen(f->name));
221 okcol = (okcol + 7) & ~7;
223 POS_PRINT("Supported flash chips:");
224 while (pos < okcol) {
226 pos += 8 - (pos % 8);
228 printf("Tested OK operations:\tKnown BAD operations:\n\n");
230 for (f = flashchips; f->name != NULL; f++) {
231 printf("%s %s", f->vendor, f->name);
232 pos = strlen(f->vendor) + 1 + strlen(f->name);
233 while (pos < okcol) {
235 pos += 8 - (pos % 8);
237 if ((f->tested & TEST_OK_MASK)) {
238 if ((f->tested & TEST_OK_PROBE))
240 if ((f->tested & TEST_OK_READ))
242 if ((f->tested & TEST_OK_ERASE))
244 if ((f->tested & TEST_OK_WRITE))
247 while (pos < okcol + 24) {
249 pos += 8 - (pos % 8);
251 if ((f->tested & TEST_BAD_MASK)) {
252 if ((f->tested & TEST_BAD_PROBE))
254 if ((f->tested & TEST_BAD_READ))
256 if ((f->tested & TEST_BAD_ERASE))
258 if ((f->tested & TEST_BAD_WRITE))
265 void usage(const char *name)
267 printf("usage: %s [-rwvEVfLhR] [-c chipname] [-s exclude_start]\n",
269 printf(" [-e exclude_end] [-m [vendor:]part] [-l file.layout] [-i imagename] [file]\n");
271 (" -r | --read: read flash and save into file\n"
272 " -w | --write: write file into flash\n"
273 " -v | --verify: verify flash against file\n"
274 " -E | --erase: erase flash device\n"
275 " -V | --verbose: more verbose output\n"
276 " -c | --chip <chipname>: probe only for specified flash chip\n"
277 " -s | --estart <addr>: exclude start position\n"
278 " -e | --eend <addr>: exclude end postion\n"
279 " -m | --mainboard <[vendor:]part>: override mainboard settings\n"
280 " -f | --force: force write without checking image\n"
281 " -l | --layout <file.layout>: read rom layout from file\n"
282 " -i | --image <name>: only flash image name from flash layout\n"
283 " -L | --list-supported: print supported devices\n"
284 " -h | --help: print this help text\n"
285 " -R | --version: print the version (release)\n"
286 "\n" " If no file is specified, then all that happens"
287 " is that flash info is dumped.\n\n");
291 void print_version(void)
293 printf("flashrom r%s\n", FLASHROM_VERSION);
296 int main(int argc, char *argv[])
300 uint32_t erasedbytes;
302 /* Probe for up to three flash chips. */
303 struct flashchip *flash, *flashes[3];
305 int option_index = 0;
307 int read_it = 0, write_it = 0, erase_it = 0, verify_it = 0;
313 static struct option long_options[] = {
315 {"write", 0, 0, 'w'},
316 {"erase", 0, 0, 'E'},
317 {"verify", 0, 0, 'v'},
319 {"estart", 1, 0, 's'},
321 {"mainboard", 1, 0, 'm'},
322 {"verbose", 0, 0, 'V'},
323 {"force", 0, 0, 'f'},
324 {"layout", 1, 0, 'l'},
325 {"image", 1, 0, 'i'},
326 {"list-supported", 0, 0, 'L'},
328 {"version", 0, 0, 'R'},
332 char *filename = NULL;
334 unsigned int exclude_start_position = 0, exclude_end_position = 0; // [x,y)
335 char *tempstr = NULL, *tempstr2 = NULL;
338 /* Yes, print them. */
340 printf_debug("The arguments are:\n");
341 for (i = 1; i < argc; ++i)
342 printf_debug("%s\n", argv[i]);
345 setbuf(stdout, NULL);
346 while ((opt = getopt_long(argc, argv, "rRwvVEfc:s:e:m:l:i:Lh",
347 long_options, &option_index)) != EOF) {
359 chip_to_probe = strdup(optarg);
368 tempstr = strdup(optarg);
369 sscanf(tempstr, "%x", &exclude_start_position);
372 tempstr = strdup(optarg);
373 sscanf(tempstr, "%x", &exclude_end_position);
376 tempstr = strdup(optarg);
377 strtok(tempstr, ":");
378 tempstr2 = strtok(NULL, ":");
391 tempstr = strdup(optarg);
392 if (read_romlayout(tempstr))
396 tempstr = strdup(optarg);
397 find_romentry(tempstr);
400 print_supported_chips();
401 print_supported_chipsets();
402 print_supported_boards();
416 if (read_it && write_it) {
417 printf("Error: -r and -w are mutually exclusive.\n");
422 filename = argv[optind++];
424 /* First get full io access */
425 #if defined (__sun) && (defined(__i386) || defined(__amd64))
426 if (sysi86(SI86V86, V86SC_IOPL, PS_IOPL) != 0) {
427 #elif defined(__FreeBSD__)
428 if ((io_fd = open("/dev/io", O_RDWR)) < 0) {
432 fprintf(stderr, "ERROR: Could not get IO privileges (%s).\nYou need to be root.\n", strerror(errno));
436 /* Initialize PCI access for flash enables */
437 pacc = pci_alloc(); /* Get the pci_access structure */
438 /* Set all options you want -- here we stick with the defaults */
439 pci_init(pacc); /* Initialize the PCI library */
440 pci_scan_bus(pacc); /* We want to get the list of devices */
442 /* Open the memory device UNCACHED. That's important for MMIO. */
443 if ((fd_mem = open(MEM_DEV, O_RDWR | O_SYNC)) < 0) {
444 perror("Error: Can not access memory using " MEM_DEV
445 ". You need to be root.");
449 myusec_calibrate_delay();
451 /* We look at the lbtable first to see if we need a
452 * mainboard specific flash enable sequence.
456 /* try to enable it. Failure IS an option, since not all motherboards
457 * really need this to be done, etc., etc.
459 ret = chipset_flash_enable();
461 printf("WARNING: No chipset found. Flash detection "
462 "will most likely fail.\n");
465 board_flash_enable(lb_vendor, lb_part);
467 for (i = 0; i < ARRAY_SIZE(flashes); i++) {
469 probe_flash(i ? flashes[i - 1] + 1 : flashchips, 0);
471 for (i++; i < ARRAY_SIZE(flashes); i++)
476 printf("Multiple flash chips were detected:");
477 for (i = 0; i < ARRAY_SIZE(flashes) && flashes[i]; i++)
478 printf(" %s", flashes[i]->name);
479 printf("\nPlease specify which chip to use with the -c <chipname> option.\n");
481 } else if (!flashes[0]) {
482 printf("No EEPROM/flash device found.\n");
483 if (!force || !chip_to_probe) {
484 printf("If you know which flash chip you have, and if this version of flashrom\n");
485 printf("supports a similar flash chip, you can try to force read your chip. Run:\n");
486 printf("flashrom -f -r -c similar_supported_flash_chip filename\n");
488 printf("Note: flashrom can never write when the flash chip isn't found automatically.\n");
490 if (force && read_it && chip_to_probe) {
491 printf("Force read (-f -r -c) requested, forcing chip probe success:\n");
492 flashes[0] = probe_flash(flashchips, 1);
494 printf("flashrom does not support a flash chip named '%s'.\n", chip_to_probe);
495 printf("Run flashrom -L to view the hardware supported in this flashrom version.\n");
499 printf("Error: No filename specified.\n");
502 size = flashes[0]->total_size * 1024;
503 buf = (uint8_t *) calloc(size, sizeof(char));
505 if ((image = fopen(filename, "w")) == NULL) {
509 printf("Force reading flash... ");
510 if (!flashes[0]->read)
511 memcpy(buf, (const char *)flashes[0]->virtual_memory, size);
513 flashes[0]->read(flashes[0], buf);
515 if (exclude_end_position - exclude_start_position > 0)
516 memset(buf + exclude_start_position, 0,
517 exclude_end_position -
518 exclude_start_position);
520 fwrite(buf, sizeof(char), size, image);
526 // FIXME: flash writes stay enabled!
532 if (TEST_OK_MASK != (flash->tested & TEST_OK_MASK)) {
534 if (flash->tested & TEST_BAD_MASK) {
535 printf("This flash part has status NOT WORKING for operations:");
536 if (flash->tested & TEST_BAD_PROBE)
538 if (flash->tested & TEST_BAD_READ)
540 if (flash->tested & TEST_BAD_ERASE)
542 if (flash->tested & TEST_BAD_WRITE)
546 if ((!(flash->tested & TEST_BAD_PROBE) && !(flash->tested & TEST_OK_PROBE)) ||
547 (!(flash->tested & TEST_BAD_READ) && !(flash->tested & TEST_OK_READ)) ||
548 (!(flash->tested & TEST_BAD_ERASE) && !(flash->tested & TEST_OK_ERASE)) ||
549 (!(flash->tested & TEST_BAD_WRITE) && !(flash->tested & TEST_OK_WRITE))) {
550 printf("This flash part has status UNTESTED for operations:");
551 if (!(flash->tested & TEST_BAD_PROBE) && !(flash->tested & TEST_OK_PROBE))
553 if (!(flash->tested & TEST_BAD_READ) && !(flash->tested & TEST_OK_READ))
555 if (!(flash->tested & TEST_BAD_ERASE) && !(flash->tested & TEST_OK_ERASE))
557 if (!(flash->tested & TEST_BAD_WRITE) && !(flash->tested & TEST_OK_WRITE))
561 printf("Please email a report to flashrom@coreboot.org if any of the above operations\n");
562 printf("work correctly for you with this flash part. Please include the full output\n");
563 printf("from the program, including chipset found. Thank you for your help!\n");
567 if (!(read_it | write_it | verify_it | erase_it)) {
568 printf("No operations were specified.\n");
569 // FIXME: flash writes stay enabled!
573 if (!filename && !erase_it) {
574 printf("Error: No filename specified.\n");
575 // FIXME: flash writes stay enabled!
579 size = flash->total_size * 1024;
580 buf = (uint8_t *) calloc(size, sizeof(char));
583 printf("Erasing flash chip... ");
584 if (NULL == flash->erase) {
586 fprintf(stderr, "ERROR: flashrom has no erase function for this flash chip.\n");
590 if (NULL == flash->read)
591 memcpy(buf, (const char *)flash->virtual_memory, size);
593 flash->read(flash, buf);
594 for (erasedbytes = 0; erasedbytes <= size; erasedbytes++)
595 if (0xff != buf[erasedbytes]) {
597 fprintf(stderr, "ERROR at 0x%08x: Expected=0xff, Read=0x%02x\n",
598 erasedbytes, buf[erasedbytes]);
601 printf("SUCCESS.\n");
603 } else if (read_it) {
604 if ((image = fopen(filename, "w")) == NULL) {
608 printf("Reading flash... ");
609 if (flash->read == NULL)
610 memcpy(buf, (const char *)flash->virtual_memory, size);
612 flash->read(flash, buf);
614 if (exclude_end_position - exclude_start_position > 0)
615 memset(buf + exclude_start_position, 0,
616 exclude_end_position - exclude_start_position);
618 fwrite(buf, sizeof(char), size, image);
622 struct stat image_stat;
624 if ((image = fopen(filename, "r")) == NULL) {
628 if (fstat(fileno(image), &image_stat) != 0) {
632 if (image_stat.st_size != flash->total_size * 1024) {
633 fprintf(stderr, "Error: Image size doesn't match\n");
637 fread(buf, sizeof(char), size, image);
638 show_id(buf, size, force);
642 /* exclude range stuff. Nice idea, but at the moment it is only
643 * supported in hardware by the pm49fl004 chips.
644 * Instead of implementing this for all chips I suggest advancing
645 * it to the rom layout feature below and drop exclude range
646 * completely once all flash chips can do rom layouts. stepan
649 // ////////////////////////////////////////////////////////////
650 if (exclude_end_position - exclude_start_position > 0)
651 memcpy(buf + exclude_start_position,
652 (const char *)flash->virtual_memory +
653 exclude_start_position,
654 exclude_end_position - exclude_start_position);
656 exclude_start_page = exclude_start_position / flash->page_size;
657 if ((exclude_start_position % flash->page_size) != 0) {
658 exclude_start_page++;
660 exclude_end_page = exclude_end_position / flash->page_size;
661 // ////////////////////////////////////////////////////////////
663 // This should be moved into each flash part's code to do it
664 // cleanly. This does the job.
665 handle_romentries(buf, (uint8_t *) flash->virtual_memory);
667 // ////////////////////////////////////////////////////////////
671 fprintf(stderr, "Error: flashrom has no write function for this flash chip.\n");
674 ret |= flash->write(flash, buf);
678 ret |= verify_flash(flash, buf);