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 FAILED!", idx);
192 printf("FAILED at 0x%08x!", idx);
193 printf(" Expected=0x%02x, Read=0x%02x\n",
194 *(buf + idx), *(buf2 + idx));
198 if (verbose && ((idx & 0xfff) == 0xfff))
199 printf("\b\b\b\b\b\b\b\b\b\b");
202 printf("\b\b\b\b\b\b\b\b\b\b ");
204 printf("VERIFIED. \n");
209 #define MAX(a, b) ((a) > (b) ? (a) : (b))
210 #define POS_PRINT(x) do { pos += strlen(x); printf(x); } while (0)
212 void print_supported_chips(void)
214 int okcol = 0, pos = 0;
217 for (f = flashchips; f->name != NULL; f++) {
218 if (GENERIC_DEVICE_ID == f->model_id)
220 okcol = MAX(okcol, strlen(f->vendor) + 1 + strlen(f->name));
222 okcol = (okcol + 7) & ~7;
224 POS_PRINT("Supported flash chips:");
225 while (pos < okcol) {
227 pos += 8 - (pos % 8);
229 printf("Tested OK operations:\tKnown BAD operations:\n\n");
231 for (f = flashchips; f->name != NULL; f++) {
232 printf("%s %s", f->vendor, f->name);
233 pos = strlen(f->vendor) + 1 + strlen(f->name);
234 while (pos < okcol) {
236 pos += 8 - (pos % 8);
238 if ((f->tested & TEST_OK_MASK)) {
239 if ((f->tested & TEST_OK_PROBE))
241 if ((f->tested & TEST_OK_READ))
243 if ((f->tested & TEST_OK_ERASE))
245 if ((f->tested & TEST_OK_WRITE))
248 while (pos < okcol + 24) {
250 pos += 8 - (pos % 8);
252 if ((f->tested & TEST_BAD_MASK)) {
253 if ((f->tested & TEST_BAD_PROBE))
255 if ((f->tested & TEST_BAD_READ))
257 if ((f->tested & TEST_BAD_ERASE))
259 if ((f->tested & TEST_BAD_WRITE))
266 void usage(const char *name)
268 printf("usage: %s [-rwvEVfLhR] [-c chipname] [-s exclude_start]\n",
270 printf(" [-e exclude_end] [-m [vendor:]part] [-l file.layout] [-i imagename] [file]\n");
272 (" -r | --read: read flash and save into file\n"
273 " -w | --write: write file into flash\n"
274 " -v | --verify: verify flash against file\n"
275 " -E | --erase: erase flash device\n"
276 " -V | --verbose: more verbose output\n"
277 " -c | --chip <chipname>: probe only for specified flash chip\n"
278 " -s | --estart <addr>: exclude start position\n"
279 " -e | --eend <addr>: exclude end postion\n"
280 " -m | --mainboard <[vendor:]part>: override mainboard settings\n"
281 " -f | --force: force write without checking image\n"
282 " -l | --layout <file.layout>: read rom layout from file\n"
283 " -i | --image <name>: only flash image name from flash layout\n"
284 " -L | --list-supported: print supported devices\n"
285 " -h | --help: print this help text\n"
286 " -R | --version: print the version (release)\n"
287 "\n" " If no file is specified, then all that happens"
288 " is that flash info is dumped.\n\n");
292 void print_version(void)
294 printf("flashrom r%s\n", FLASHROM_VERSION);
297 int main(int argc, char *argv[])
300 unsigned long size, numbytes;
301 uint32_t erasedbytes;
303 /* Probe for up to three flash chips. */
304 struct flashchip *flash, *flashes[3];
306 int option_index = 0;
308 int read_it = 0, write_it = 0, erase_it = 0, verify_it = 0;
314 static struct option long_options[] = {
316 {"write", 0, 0, 'w'},
317 {"erase", 0, 0, 'E'},
318 {"verify", 0, 0, 'v'},
320 {"estart", 1, 0, 's'},
322 {"mainboard", 1, 0, 'm'},
323 {"verbose", 0, 0, 'V'},
324 {"force", 0, 0, 'f'},
325 {"layout", 1, 0, 'l'},
326 {"image", 1, 0, 'i'},
327 {"list-supported", 0, 0, 'L'},
329 {"version", 0, 0, 'R'},
333 char *filename = NULL;
335 unsigned int exclude_start_position = 0, exclude_end_position = 0; // [x,y)
336 char *tempstr = NULL, *tempstr2 = NULL;
339 /* Yes, print them. */
341 printf_debug("The arguments are:\n");
342 for (i = 1; i < argc; ++i)
343 printf_debug("%s\n", argv[i]);
346 setbuf(stdout, NULL);
347 while ((opt = getopt_long(argc, argv, "rRwvVEfc:s:e:m:l:i:Lh",
348 long_options, &option_index)) != EOF) {
360 chip_to_probe = strdup(optarg);
369 tempstr = strdup(optarg);
370 sscanf(tempstr, "%x", &exclude_start_position);
373 tempstr = strdup(optarg);
374 sscanf(tempstr, "%x", &exclude_end_position);
377 tempstr = strdup(optarg);
378 strtok(tempstr, ":");
379 tempstr2 = strtok(NULL, ":");
392 tempstr = strdup(optarg);
393 if (read_romlayout(tempstr))
397 tempstr = strdup(optarg);
398 find_romentry(tempstr);
401 print_supported_chips();
402 print_supported_chipsets();
403 print_supported_boards();
417 if (read_it && write_it) {
418 printf("Error: -r and -w are mutually exclusive.\n");
423 filename = argv[optind++];
425 /* First get full io access */
426 #if defined (__sun) && (defined(__i386) || defined(__amd64))
427 if (sysi86(SI86V86, V86SC_IOPL, PS_IOPL) != 0) {
428 #elif defined(__FreeBSD__)
429 if ((io_fd = open("/dev/io", O_RDWR)) < 0) {
433 fprintf(stderr, "ERROR: Could not get IO privileges (%s).\nYou need to be root.\n", strerror(errno));
437 /* Initialize PCI access for flash enables */
438 pacc = pci_alloc(); /* Get the pci_access structure */
439 /* Set all options you want -- here we stick with the defaults */
440 pci_init(pacc); /* Initialize the PCI library */
441 pci_scan_bus(pacc); /* We want to get the list of devices */
443 /* Open the memory device UNCACHED. That's important for MMIO. */
444 if ((fd_mem = open(MEM_DEV, O_RDWR | O_SYNC)) < 0) {
445 perror("Error: Can not access memory using " MEM_DEV
446 ". You need to be root.");
450 myusec_calibrate_delay();
452 /* We look at the lbtable first to see if we need a
453 * mainboard specific flash enable sequence.
457 /* try to enable it. Failure IS an option, since not all motherboards
458 * really need this to be done, etc., etc.
460 ret = chipset_flash_enable();
462 printf("WARNING: No chipset found. Flash detection "
463 "will most likely fail.\n");
466 board_flash_enable(lb_vendor, lb_part);
468 for (i = 0; i < ARRAY_SIZE(flashes); i++) {
470 probe_flash(i ? flashes[i - 1] + 1 : flashchips, 0);
472 for (i++; i < ARRAY_SIZE(flashes); i++)
477 printf("Multiple flash chips were detected:");
478 for (i = 0; i < ARRAY_SIZE(flashes) && flashes[i]; i++)
479 printf(" %s", flashes[i]->name);
480 printf("\nPlease specify which chip to use with the -c <chipname> option.\n");
482 } else if (!flashes[0]) {
483 printf("No EEPROM/flash device found.\n");
484 if (!force || !chip_to_probe) {
485 printf("If you know which flash chip you have, and if this version of flashrom\n");
486 printf("supports a similar flash chip, you can try to force read your chip. Run:\n");
487 printf("flashrom -f -r -c similar_supported_flash_chip filename\n");
489 printf("Note: flashrom can never write when the flash chip isn't found automatically.\n");
491 if (force && read_it && chip_to_probe) {
492 printf("Force read (-f -r -c) requested, forcing chip probe success:\n");
493 flashes[0] = probe_flash(flashchips, 1);
495 printf("flashrom does not support a flash chip named '%s'.\n", chip_to_probe);
496 printf("Run flashrom -L to view the hardware supported in this flashrom version.\n");
500 printf("Error: No filename specified.\n");
503 size = flashes[0]->total_size * 1024;
504 buf = (uint8_t *) calloc(size, sizeof(char));
506 if ((image = fopen(filename, "w")) == NULL) {
510 printf("Force reading flash... ");
511 if (!flashes[0]->read)
512 memcpy(buf, (const char *)flashes[0]->virtual_memory, size);
514 flashes[0]->read(flashes[0], buf);
516 if (exclude_end_position - exclude_start_position > 0)
517 memset(buf + exclude_start_position, 0,
518 exclude_end_position -
519 exclude_start_position);
521 numbytes = fwrite(buf, 1, size, image);
523 printf("%s.\n", numbytes == size ? "done" : "FAILED");
525 return numbytes != size;
527 // FIXME: flash writes stay enabled!
533 if (TEST_OK_MASK != (flash->tested & TEST_OK_MASK)) {
535 if (flash->tested & TEST_BAD_MASK) {
536 printf("This flash part has status NOT WORKING for operations:");
537 if (flash->tested & TEST_BAD_PROBE)
539 if (flash->tested & TEST_BAD_READ)
541 if (flash->tested & TEST_BAD_ERASE)
543 if (flash->tested & TEST_BAD_WRITE)
547 if ((!(flash->tested & TEST_BAD_PROBE) && !(flash->tested & TEST_OK_PROBE)) ||
548 (!(flash->tested & TEST_BAD_READ) && !(flash->tested & TEST_OK_READ)) ||
549 (!(flash->tested & TEST_BAD_ERASE) && !(flash->tested & TEST_OK_ERASE)) ||
550 (!(flash->tested & TEST_BAD_WRITE) && !(flash->tested & TEST_OK_WRITE))) {
551 printf("This flash part has status UNTESTED for operations:");
552 if (!(flash->tested & TEST_BAD_PROBE) && !(flash->tested & TEST_OK_PROBE))
554 if (!(flash->tested & TEST_BAD_READ) && !(flash->tested & TEST_OK_READ))
556 if (!(flash->tested & TEST_BAD_ERASE) && !(flash->tested & TEST_OK_ERASE))
558 if (!(flash->tested & TEST_BAD_WRITE) && !(flash->tested & TEST_OK_WRITE))
562 printf("Please email a report to flashrom@coreboot.org if any of the above operations\n");
563 printf("work correctly for you with this flash part. Please include the full output\n");
564 printf("from the program, including chipset found. Thank you for your help!\n");
568 if (!(read_it | write_it | verify_it | erase_it)) {
569 printf("No operations were specified.\n");
570 // FIXME: flash writes stay enabled!
574 if (!filename && !erase_it) {
575 printf("Error: No filename specified.\n");
576 // FIXME: flash writes stay enabled!
580 size = flash->total_size * 1024;
581 buf = (uint8_t *) calloc(size, sizeof(char));
584 printf("Erasing flash chip... ");
585 if (NULL == flash->erase) {
587 fprintf(stderr, "ERROR: flashrom has no erase function for this flash chip.\n");
591 if (NULL == flash->read)
592 memcpy(buf, (const char *)flash->virtual_memory, size);
594 flash->read(flash, buf);
595 for (erasedbytes = 0; erasedbytes <= size; erasedbytes++)
596 if (0xff != buf[erasedbytes]) {
598 fprintf(stderr, "ERROR at 0x%08x: Expected=0xff, Read=0x%02x\n",
599 erasedbytes, buf[erasedbytes]);
602 printf("SUCCESS.\n");
604 } else if (read_it) {
605 if ((image = fopen(filename, "w")) == NULL) {
609 printf("Reading flash... ");
610 if (flash->read == NULL)
611 memcpy(buf, (const char *)flash->virtual_memory, size);
613 flash->read(flash, buf);
615 if (exclude_end_position - exclude_start_position > 0)
616 memset(buf + exclude_start_position, 0,
617 exclude_end_position - exclude_start_position);
619 numbytes = fwrite(buf, 1, size, image);
621 printf("%s.\n", numbytes == size ? "done" : "FAILED");
622 if (numbytes != size)
625 struct stat image_stat;
627 if ((image = fopen(filename, "r")) == NULL) {
631 if (fstat(fileno(image), &image_stat) != 0) {
635 if (image_stat.st_size != flash->total_size * 1024) {
636 fprintf(stderr, "Error: Image size doesn't match\n");
640 numbytes = fread(buf, 1, size, image);
641 show_id(buf, size, force);
643 if (numbytes != size) {
644 fprintf(stderr, "Error: Failed to read file. Got %ld bytes, wanted %ld!\n", numbytes, size);
649 /* exclude range stuff. Nice idea, but at the moment it is only
650 * supported in hardware by the pm49fl004 chips.
651 * Instead of implementing this for all chips I suggest advancing
652 * it to the rom layout feature below and drop exclude range
653 * completely once all flash chips can do rom layouts. stepan
656 // ////////////////////////////////////////////////////////////
657 if (exclude_end_position - exclude_start_position > 0)
658 memcpy(buf + exclude_start_position,
659 (const char *)flash->virtual_memory +
660 exclude_start_position,
661 exclude_end_position - exclude_start_position);
663 exclude_start_page = exclude_start_position / flash->page_size;
664 if ((exclude_start_position % flash->page_size) != 0) {
665 exclude_start_page++;
667 exclude_end_page = exclude_end_position / flash->page_size;
668 // ////////////////////////////////////////////////////////////
670 // This should be moved into each flash part's code to do it
671 // cleanly. This does the job.
672 handle_romentries(buf, (uint8_t *) flash->virtual_memory);
674 // ////////////////////////////////////////////////////////////
678 fprintf(stderr, "Error: flashrom has no write function for this flash chip.\n");
681 ret |= flash->write(flash, buf);
685 ret |= verify_flash(flash, buf);