flashrom.c 24.6 KB
Newer Older
Ronald G. Minnich's avatar
Dammit  
Ronald G. Minnich committed
1
/*
2
 * This file is part of the flashrom project.
Ronald G. Minnich's avatar
Dammit  
Ronald G. Minnich committed
3
 *
4 5
 * Copyright (C) 2000 Silicon Integrated System Corporation
 * Copyright (C) 2004 Tyan Corp <yhlu@tyan.com>
6
 * Copyright (C) 2005-2008 coresystems GmbH
7
 * Copyright (C) 2008,2009 Carl-Daniel Hailfinger
Ronald G. Minnich's avatar
Dammit  
Ronald G. Minnich committed
8
 *
9 10 11 12
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
Ronald G. Minnich's avatar
Dammit  
Ronald G. Minnich committed
13
 *
14 15 16 17
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
Ronald G. Minnich's avatar
Dammit  
Ronald G. Minnich committed
18
 *
19 20 21
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
Ronald G. Minnich's avatar
Dammit  
Ronald G. Minnich committed
22 23 24
 */

#include <fcntl.h>
25 26
#include <sys/types.h>
#include <sys/stat.h>
Ronald G. Minnich's avatar
Ronald G. Minnich committed
27
#include <string.h>
Ronald G. Minnich's avatar
Ronald G. Minnich committed
28
#include <stdlib.h>
29
#include <getopt.h>
Ronald G. Minnich's avatar
Dammit  
Ronald G. Minnich committed
30
#include "flash.h"
31
#include "flashchips.h"
Ronald G. Minnich's avatar
Dammit  
Ronald G. Minnich committed
32

Ronald G. Minnich's avatar
Ronald G. Minnich committed
33
char *chip_to_probe = NULL;
Stefan Reinauer's avatar
Stefan Reinauer committed
34
int exclude_start_page, exclude_end_page;
Peter Stuge's avatar
Peter Stuge committed
35
int verbose = 0;
36 37 38 39
int programmer = PROGRAMMER_INTERNAL;

const struct programmer_entry programmer_table[] = {
	{
40 41
		.init			= internal_init,
		.shutdown		= internal_shutdown,
42 43
		.map_flash_region	= physmap,
		.unmap_flash_region	= physunmap,
44 45 46
		.chip_readb		= internal_chip_readb,
		.chip_readw		= internal_chip_readw,
		.chip_readl		= internal_chip_readl,
47
		.chip_readn		= internal_chip_readn,
48 49 50
		.chip_writeb		= internal_chip_writeb,
		.chip_writew		= internal_chip_writew,
		.chip_writel		= internal_chip_writel,
51
		.chip_writen		= fallback_chip_writen,
52
		.delay			= internal_delay,
53 54
	},

55
	{
56 57
		.init			= dummy_init,
		.shutdown		= dummy_shutdown,
58 59
		.map_flash_region	= dummy_map,
		.unmap_flash_region	= dummy_unmap,
60 61 62
		.chip_readb		= dummy_chip_readb,
		.chip_readw		= dummy_chip_readw,
		.chip_readl		= dummy_chip_readl,
63
		.chip_readn		= dummy_chip_readn,
64 65 66
		.chip_writeb		= dummy_chip_writeb,
		.chip_writew		= dummy_chip_writew,
		.chip_writel		= dummy_chip_writel,
67
		.chip_writen		= dummy_chip_writen,
68
		.delay			= internal_delay,
69 70
	},

71 72 73
	{
		.init			= nic3com_init,
		.shutdown		= nic3com_shutdown,
74 75
		.map_flash_region	= fallback_map,
		.unmap_flash_region	= fallback_unmap,
76
		.chip_readb		= nic3com_chip_readb,
77 78
		.chip_readw		= fallback_chip_readw,
		.chip_readl		= fallback_chip_readl,
79
		.chip_readn		= fallback_chip_readn,
80
		.chip_writeb		= nic3com_chip_writeb,
81 82
		.chip_writew		= fallback_chip_writew,
		.chip_writel		= fallback_chip_writel,
83
		.chip_writen		= fallback_chip_writen,
84
		.delay			= internal_delay,
85 86
	},

87 88 89
	{
		.init			= satasii_init,
		.shutdown		= satasii_shutdown,
90 91
		.map_flash_region	= fallback_map,
		.unmap_flash_region	= fallback_unmap,
92 93 94
		.chip_readb		= satasii_chip_readb,
		.chip_readw		= fallback_chip_readw,
		.chip_readl		= fallback_chip_readl,
95
		.chip_readn		= fallback_chip_readn,
96 97 98
		.chip_writeb		= satasii_chip_writeb,
		.chip_writew		= fallback_chip_writew,
		.chip_writel		= fallback_chip_writel,
99
		.chip_writen		= fallback_chip_writen,
100
		.delay			= internal_delay,
101 102
	},

103 104 105 106 107 108
	{
		.init			= it87spi_init,
		.shutdown		= dummy_shutdown,
		.map_flash_region	= dummy_map,
		.unmap_flash_region	= dummy_unmap,
		.chip_readb		= dummy_chip_readb,
109 110 111
		.chip_readw		= fallback_chip_readw,
		.chip_readl		= fallback_chip_readl,
		.chip_readn		= fallback_chip_readn,
112
		.chip_writeb		= dummy_chip_writeb,
113 114 115
		.chip_writew		= fallback_chip_writew,
		.chip_writel		= fallback_chip_writel,
		.chip_writen		= fallback_chip_writen,
116
		.delay			= internal_delay,
117 118
	},

119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
	{
		.init			= ft2232_spi_init,
		.shutdown		= dummy_shutdown,
		.map_flash_region	= dummy_map,
		.unmap_flash_region	= dummy_unmap,
		.chip_readb		= dummy_chip_readb,
		.chip_readw		= fallback_chip_readw,
		.chip_readl		= fallback_chip_readl,
		.chip_readn		= fallback_chip_readn,
		.chip_writeb		= dummy_chip_writeb,
		.chip_writew		= fallback_chip_writew,
		.chip_writel		= fallback_chip_writel,
		.chip_writen		= fallback_chip_writen,
		.delay			= internal_delay,
	},

135 136
	{},
};
137

138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
int programmer_init(void)
{
	return programmer_table[programmer].init();
}

int programmer_shutdown(void)
{
	return programmer_table[programmer].shutdown();
}

void *programmer_map_flash_region(const char *descr, unsigned long phys_addr,
				  size_t len)
{
	return programmer_table[programmer].map_flash_region(descr,
							     phys_addr, len);
}

void programmer_unmap_flash_region(void *virt_addr, size_t len)
{
	programmer_table[programmer].unmap_flash_region(virt_addr, len);
}

void chip_writeb(uint8_t val, chipaddr addr)
{
	programmer_table[programmer].chip_writeb(val, addr);
}

void chip_writew(uint16_t val, chipaddr addr)
{
	programmer_table[programmer].chip_writew(val, addr);
}

void chip_writel(uint32_t val, chipaddr addr)
{
	programmer_table[programmer].chip_writel(val, addr);
}

175 176 177 178 179
void chip_writen(uint8_t *buf, chipaddr addr, size_t len)
{
	programmer_table[programmer].chip_writen(buf, addr, len);
}

180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
uint8_t chip_readb(const chipaddr addr)
{
	return programmer_table[programmer].chip_readb(addr);
}

uint16_t chip_readw(const chipaddr addr)
{
	return programmer_table[programmer].chip_readw(addr);
}

uint32_t chip_readl(const chipaddr addr)
{
	return programmer_table[programmer].chip_readl(addr);
}

195 196 197 198 199 200
void chip_readn(uint8_t *buf, chipaddr addr, size_t len)
{
	programmer_table[programmer].chip_readn(buf, addr, len);
	return;
}

201 202 203 204 205
void programmer_delay(int usecs)
{
	programmer_table[programmer].delay(usecs);
}

206
void map_flash_registers(struct flashchip *flash)
207 208
{
	size_t size = flash->total_size * 1024;
209
	/* Flash registers live 4 MByte below the flash. */
210
	flash->virtual_registers = (chipaddr)programmer_map_flash_region("flash chip registers", (0xFFFFFFFF - 0x400000 - size + 1), size);
211 212
}

213
int read_memmapped(struct flashchip *flash, uint8_t *buf, int start, int len)
214
{
215
	chip_readn(buf, flash->virtual_memory + start, len);
216 217 218 219
		
	return 0;
}

220 221 222 223 224
int min(int a, int b)
{
	return (a < b) ? a : b;
}

225 226 227 228 229
int max(int a, int b)
{
	return (a > b) ? a : b;
}

230 231 232 233 234 235 236 237 238
char *strcat_realloc(char *dest, const char *src)
{
	dest = realloc(dest, strlen(dest) + strlen(src) + 1);
	if (!dest)
		return NULL;
	strcat(dest, src);
	return dest;
}

239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
/* start is an offset to the base address of the flash chip */
int check_erased_range(struct flashchip *flash, int start, int len)
{
	int ret;
	uint8_t *cmpbuf = malloc(len);

	if (!cmpbuf) {
		fprintf(stderr, "Could not allocate memory!\n");
		exit(1);
	}
	memset(cmpbuf, 0xff, len);
	ret = verify_range(flash, cmpbuf, start, len, "ERASE");
	free(cmpbuf);
	return ret;
}

/**
 * @cmpbuf	buffer to compare against
 * @start	offset to the base address of the flash chip
 * @len		length of the verified area
 * @message	string to print in the "FAILED" message
 * @return	0 for success, -1 for failure
 */
int verify_range(struct flashchip *flash, uint8_t *cmpbuf, int start, int len, char *message)
{
	int i, j, starthere, lenhere, ret = 0;
	chipaddr bios = flash->virtual_memory;
	int page_size = flash->page_size;
	uint8_t *readbuf = malloc(page_size);

	if (!len)
		goto out_free;

	if (!readbuf) {
		fprintf(stderr, "Could not allocate memory!\n");
		exit(1);
	}

	if (start + len > flash->total_size * 1024) {
		fprintf(stderr, "Error: %s called with start 0x%x + len 0x%x >"
			" total_size 0x%x\n", __func__, start, len,
			flash->total_size * 1024);
		ret = -1;
		goto out_free;
	}
	if (!message)
		message = "VERIFY";
	
	/* Warning: This loop has a very unusual condition and body.
	 * The loop needs to go through each page with at least one affected
	 * byte. The lowest page number is (start / page_size) since that
	 * division rounds down. The highest page number we want is the page
	 * where the last byte of the range lives. That last byte has the
	 * address (start + len - 1), thus the highest page number is
	 * (start + len - 1) / page_size. Since we want to include that last
	 * page as well, the loop condition uses <=.
	 */
	for (i = start / page_size; i <= (start + len - 1) / page_size; i++) {
		/* Byte position of the first byte in the range in this page. */
		starthere = max(start, i * page_size);
		/* Length of bytes in the range in this page. */
		lenhere = min(start + len, (i + 1) * page_size) - starthere;
		chip_readn(readbuf, bios + starthere, lenhere);
		for (j = 0; j < lenhere; j++) {
			if (cmpbuf[starthere - start + j] != readbuf[j]) {
				fprintf(stderr, "%s FAILED at 0x%08x! "
					"Expected=0x%02x, Read=0x%02x\n",
					message, starthere + j,
					cmpbuf[starthere - start + j], readbuf[j]);
				ret = -1;
				goto out_free;
			}
		}
	}

out_free:
	free(readbuf);
	return ret;
}

319
struct flashchip *probe_flash(struct flashchip *first_flash, int force)
Ronald G. Minnich's avatar
Dammit  
Ronald G. Minnich committed
320
{
321
	struct flashchip *flash;
322
	unsigned long base = 0, size;
323
	char *tmp;
Ronald G. Minnich's avatar
Dammit  
Ronald G. Minnich committed
324

325
	for (flash = first_flash; flash && flash->name; flash++) {
326
		if (chip_to_probe && strcmp(flash->name, chip_to_probe) != 0)
327
			continue;
328 329
		printf_debug("Probing for %s %s, %d KB: ",
			     flash->vendor, flash->name, flash->total_size);
Peter Stuge's avatar
Peter Stuge committed
330
		if (!flash->probe && !force) {
331 332 333
			printf_debug("failed! flashrom has no probe function for this flash chip.\n");
			continue;
		}
334 335 336 337 338 339 340 341 342
		if (!(buses_supported & flash->bustype)) {
			tmp = flashbuses_to_text(buses_supported);
			printf_debug("skipped. Host bus type %s ", tmp);
			free(tmp);
			tmp = flashbuses_to_text(flash->bustype);
			printf_debug("and chip bus type %s are incompatible.\n", tmp);
			free(tmp);
			continue;
		}
Stefan Reinauer's avatar
Stefan Reinauer committed
343

344
		size = flash->total_size * 1024;
Stefan Reinauer's avatar
Stefan Reinauer committed
345

346
		base = flashbase ? flashbase : (0xffffffff - size + 1);
347
		flash->virtual_memory = (chipaddr)programmer_map_flash_region("flash chip", base, size);
348

349 350 351
		if (force)
			break;

352 353 354
		if (flash->probe(flash) != 1)
			goto notfound;

355 356
		if (first_flash == flashchips
		    || flash->model_id != GENERIC_DEVICE_ID)
357
			break;
Stefan Reinauer's avatar
Stefan Reinauer committed
358

359
notfound:
360
		programmer_unmap_flash_region((void *)flash->virtual_memory, size);
Ronald G. Minnich's avatar
Dammit  
Ronald G. Minnich committed
361
	}
Uwe Hermann's avatar
Uwe Hermann committed
362

363 364 365 366
	if (!flash || !flash->name)
		return NULL;

	printf("Found chip \"%s %s\" (%d KB) at physical address 0x%lx.\n",
Peter Stuge's avatar
Peter Stuge committed
367
	       flash->vendor, flash->name, flash->total_size, base);
368
	return flash;
Ronald G. Minnich's avatar
Dammit  
Ronald G. Minnich committed
369 370
}

Stefan Reinauer's avatar
Stefan Reinauer committed
371
int verify_flash(struct flashchip *flash, uint8_t *buf)
Ronald G. Minnich's avatar
Dammit  
Ronald G. Minnich committed
372
{
Stefan Reinauer's avatar
Stefan Reinauer committed
373
	int idx;
374
	int total_size = flash->total_size * 1024;
375
	uint8_t *buf2 = (uint8_t *) calloc(total_size, sizeof(char));
376 377 378 379 380
	if (!flash->read) {
		printf("FAILED!\n");
		fprintf(stderr, "ERROR: flashrom has no read function for this flash chip.\n");
		return 1;
	} else
381
		flash->read(flash, buf2, 0, total_size);
382

383
	printf("Verifying flash... ");
384 385 386 387

	if (verbose)
		printf("address: 0x00000000\b\b\b\b\b\b\b\b\b\b");

Stefan Reinauer's avatar
Stefan Reinauer committed
388
	for (idx = 0; idx < total_size; idx++) {
389
		if (verbose && ((idx & 0xfff) == 0xfff))
Stefan Reinauer's avatar
Stefan Reinauer committed
390 391
			printf("0x%08x", idx);

392
		if (*(buf2 + idx) != *(buf + idx)) {
393 394 395 396 397
			if (verbose)
				printf("0x%08x FAILED!", idx);
			else
				printf("FAILED at 0x%08x!", idx);
			printf("  Expected=0x%02x, Read=0x%02x\n",
398
			       *(buf + idx), *(buf2 + idx));
Stefan Reinauer's avatar
Stefan Reinauer committed
399
			return 1;
400
		}
401 402

		if (verbose && ((idx & 0xfff) == 0xfff))
403
			printf("\b\b\b\b\b\b\b\b\b\b");
Ronald G. Minnich's avatar
Fixes  
Ronald G. Minnich committed
404
	}
405
	if (verbose)
Stefan Reinauer's avatar
Stefan Reinauer committed
406
		printf("\b\b\b\b\b\b\b\b\b\b ");
407

408
	printf("VERIFIED.          \n");
Uwe Hermann's avatar
Uwe Hermann committed
409

Stefan Reinauer's avatar
Stefan Reinauer committed
410
	return 0;
Ronald G. Minnich's avatar
Fixes  
Ronald G. Minnich committed
411 412
}

413 414 415 416 417 418
int read_flash(struct flashchip *flash, char *filename, unsigned int exclude_start_position, unsigned int exclude_end_position)
{
	unsigned long numbytes;
	FILE *image;
	unsigned long size = flash->total_size * 1024;
	unsigned char *buf = calloc(size, sizeof(char));
419 420 421 422 423

	if (!filename) {
		printf("Error: No filename specified.\n");
		return 1;
	}
424 425 426 427 428
	if ((image = fopen(filename, "w")) == NULL) {
		perror(filename);
		exit(1);
	}
	printf("Reading flash... ");
429 430 431 432 433
	if (!flash->read) {
		printf("FAILED!\n");
		fprintf(stderr, "ERROR: flashrom has no read function for this flash chip.\n");
		return 1;
	} else
434
		flash->read(flash, buf, 0, size);
435 436 437 438 439 440 441

	if (exclude_end_position - exclude_start_position > 0)
		memset(buf + exclude_start_position, 0,
		       exclude_end_position - exclude_start_position);

	numbytes = fwrite(buf, 1, size, image);
	fclose(image);
442
	free(buf);
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
	printf("%s.\n", numbytes == size ? "done" : "FAILED");
	if (numbytes != size)
		return 1;
	return 0;
}

int erase_flash(struct flashchip *flash)
{
	uint32_t erasedbytes;
	unsigned long size = flash->total_size * 1024;
	unsigned char *buf = calloc(size, sizeof(char));
	printf("Erasing flash chip... ");
	if (NULL == flash->erase) {
		printf("FAILED!\n");
		fprintf(stderr, "ERROR: flashrom has no erase function for this flash chip.\n");
		return 1;
	}
460 461
	flash->erase(flash);

462 463 464
	/* FIXME: The lines below are superfluous. We should check the result
	 * of flash->erase(flash) instead.
	 */
465 466 467 468 469
	if (!flash->read) {
		printf("FAILED!\n");
		fprintf(stderr, "ERROR: flashrom has no read function for this flash chip.\n");
		return 1;
	} else
470
		flash->read(flash, buf, 0, size);
471

472 473 474 475 476 477 478 479 480 481 482
	for (erasedbytes = 0; erasedbytes < size; erasedbytes++)
		if (0xff != buf[erasedbytes]) {
			printf("FAILED!\n");
			fprintf(stderr, "ERROR at 0x%08x: Expected=0xff, Read=0x%02x\n",
				erasedbytes, buf[erasedbytes]);
			return 1;
		}
	printf("SUCCESS.\n");
	return 0;
}

Ronald G. Minnich's avatar
Ronald G. Minnich committed
483 484
void usage(const char *name)
{
485
	printf("usage: %s [-VfLhR] [-E|-r file|-w file|-v file] [-c chipname] [-s addr]\n"
486
	       "       [-e addr] [-m [vendor:]part] [-l file] [-i image] [-p programmer] [file]\n\n",
487
	       name);
488

489 490 491 492
	printf("Please note that the command line interface for flashrom will "
		"change before\nflashrom 1.0. Do not use flashrom in scripts "
		"or other automated tools without\nchecking that your flashrom"
		" version won't interpret options in a different way.\n\n");
493

494
	printf
495 496 497 498 499 500 501 502 503 504
	    ("   -r | --read:                      read flash and save into file\n"
	     "   -w | --write:                     write file into flash\n"
	     "   -v | --verify:                    verify flash against file\n"
	     "   -E | --erase:                     erase flash device\n"
	     "   -V | --verbose:                   more verbose output\n"
	     "   -c | --chip <chipname>:           probe only for specified flash chip\n"
	     "   -s | --estart <addr>:             exclude start position\n"
	     "   -e | --eend <addr>:               exclude end postion\n"
	     "   -m | --mainboard <[vendor:]part>: override mainboard settings\n"
	     "   -f | --force:                     force write without checking image\n"
505
	     "   -l | --layout <file.layout>:      read ROM layout from file\n"
506
	     "   -i | --image <name>:              only flash image name from flash layout\n"
507
	     "   -L | --list-supported:            print supported devices\n"
508
	     "   -p | --programmer <name>:         specify the programmer device\n"
509
	     "                                     (internal, dummy, nic3com, satasii, it87spi, ft2232spi)\n"
510
	     "   -h | --help:                      print this help text\n"
511
	     "   -R | --version:                   print the version (release)\n"
512 513
	     "\nYou can specify one of -E, -r, -w, -v or no operation.\n"
	     "If no operation is specified, then all that happens"
514
	     " is that flash info is dumped.\n\n");
515
	exit(1);
Ronald G. Minnich's avatar
Ronald G. Minnich committed
516 517
}

518 519
void print_version(void)
{
Carl-Daniel Hailfinger's avatar
Carl-Daniel Hailfinger committed
520
	printf("flashrom v%s\n", FLASHROM_VERSION);
521 522
}

523
int main(int argc, char *argv[])
Ronald G. Minnich's avatar
Dammit  
Ronald G. Minnich committed
524
{
525
	uint8_t *buf;
526
	unsigned long size, numbytes;
527
	FILE *image;
Claus Gindhart's avatar
Claus Gindhart committed
528 529
	/* Probe for up to three flash chips. */
	struct flashchip *flash, *flashes[3];
530
	int opt;
531
	int option_index = 0;
Peter Stuge's avatar
Peter Stuge committed
532
	int force = 0;
533
	int read_it = 0, write_it = 0, erase_it = 0, verify_it = 0;
Uwe Hermann's avatar
Uwe Hermann committed
534
	int list_supported = 0;
535
	int operation_specified = 0;
Claus Gindhart's avatar
Claus Gindhart committed
536
	int ret = 0, i;
537

538 539 540 541 542 543 544 545 546 547 548 549 550
	static struct option long_options[] = {
		{"read", 0, 0, 'r'},
		{"write", 0, 0, 'w'},
		{"erase", 0, 0, 'E'},
		{"verify", 0, 0, 'v'},
		{"chip", 1, 0, 'c'},
		{"estart", 1, 0, 's'},
		{"eend", 1, 0, 'e'},
		{"mainboard", 1, 0, 'm'},
		{"verbose", 0, 0, 'V'},
		{"force", 0, 0, 'f'},
		{"layout", 1, 0, 'l'},
		{"image", 1, 0, 'i'},
551
		{"list-supported", 0, 0, 'L'},
552
		{"programmer", 1, 0, 'p'},
553
		{"help", 0, 0, 'h'},
554
		{"version", 0, 0, 'R'},
555
		{0, 0, 0, 0}
556
	};
557

558
	char *filename = NULL;
559

560 561
	unsigned int exclude_start_position = 0, exclude_end_position = 0;	// [x,y)
	char *tempstr = NULL, *tempstr2 = NULL;
562

563 564
	print_version();

565 566 567
	if (argc > 1) {
		/* Yes, print them. */
		int i;
568
		printf_debug("The arguments are:\n");
569
		for (i = 1; i < argc; ++i)
570
			printf_debug("%s\n", argv[i]);
571 572
	}

573
	setbuf(stdout, NULL);
574
	while ((opt = getopt_long(argc, argv, "rRwvVEfc:s:e:m:l:i:p:Lh",
575
				  long_options, &option_index)) != EOF) {
576 577
		switch (opt) {
		case 'r':
578 579 580 581 582
			if (++operation_specified > 1) {
				fprintf(stderr, "More than one operation "
					"specified. Aborting.\n");
				exit(1);
			}
583 584 585
			read_it = 1;
			break;
		case 'w':
586 587 588 589 590
			if (++operation_specified > 1) {
				fprintf(stderr, "More than one operation "
					"specified. Aborting.\n");
				exit(1);
			}
591 592 593
			write_it = 1;
			break;
		case 'v':
594 595 596 597 598
			if (++operation_specified > 1) {
				fprintf(stderr, "More than one operation "
					"specified. Aborting.\n");
				exit(1);
			}
599 600 601 602 603
			verify_it = 1;
			break;
		case 'c':
			chip_to_probe = strdup(optarg);
			break;
Ollie Lho's avatar
Ollie Lho committed
604 605 606
		case 'V':
			verbose = 1;
			break;
607
		case 'E':
608 609 610 611 612
			if (++operation_specified > 1) {
				fprintf(stderr, "More than one operation "
					"specified. Aborting.\n");
				exit(1);
			}
613 614
			erase_it = 1;
			break;
615 616
		case 's':
			tempstr = strdup(optarg);
617
			sscanf(tempstr, "%x", &exclude_start_position);
618 619
			break;
		case 'e':
620
			tempstr = strdup(optarg);
621
			sscanf(tempstr, "%x", &exclude_end_position);
622
			break;
623 624 625
		case 'm':
			tempstr = strdup(optarg);
			strtok(tempstr, ":");
626
			tempstr2 = strtok(NULL, ":");
627
			if (tempstr2) {
628 629
				lb_vendor = tempstr;
				lb_part = tempstr2;
630
			} else {
631 632
				lb_vendor = NULL;
				lb_part = tempstr;
633 634 635
			}
			break;
		case 'f':
636
			force = 1;
637 638
			break;
		case 'l':
639
			tempstr = strdup(optarg);
640 641
			if (read_romlayout(tempstr))
				exit(1);
642 643
			break;
		case 'i':
644
			tempstr = strdup(optarg);
645 646
			find_romentry(tempstr);
			break;
647
		case 'L':
Uwe Hermann's avatar
Uwe Hermann committed
648
			list_supported = 1;
649
			break;
650 651 652
		case 'p':
			if (strncmp(optarg, "internal", 8) == 0) {
				programmer = PROGRAMMER_INTERNAL;
653 654
			} else if (strncmp(optarg, "dummy", 5) == 0) {
				programmer = PROGRAMMER_DUMMY;
655 656
				if (optarg[5] == '=')
					dummytype = strdup(optarg + 6);
657 658
			} else if (strncmp(optarg, "nic3com", 7) == 0) {
				programmer = PROGRAMMER_NIC3COM;
659
				if (optarg[7] == '=')
660
					pcidev_bdf = strdup(optarg + 8);
661 662 663 664
			} else if (strncmp(optarg, "satasii", 7) == 0) {
				programmer = PROGRAMMER_SATASII;
				if (optarg[7] == '=')
					pcidev_bdf = strdup(optarg + 8);
665 666
			} else if (strncmp(optarg, "it87spi", 7) == 0) {
				programmer = PROGRAMMER_IT87SPI;
667 668
			} else if (strncmp(optarg, "ft2232spi", 9) == 0) {
				programmer = PROGRAMMER_FT2232SPI;
669 670 671 672 673
			} else {
				printf("Error: Unknown programmer.\n");
				exit(1);
			}
			break;
674
		case 'R':
675
			/* print_version() is always called during startup. */
676 677
			exit(0);
			break;
678
		case 'h':
679 680 681 682 683
		default:
			usage(argv[0]);
			break;
		}
	}
684

Uwe Hermann's avatar
Uwe Hermann committed
685 686 687 688 689 690 691
	if (list_supported) {
		print_supported_chips();
		print_supported_chipsets();
		print_supported_boards();
		printf("\nSupported PCI devices flashrom can use "
		       "as programmer:\n\n");
		print_supported_pcidevs(nics_3com);
692
		print_supported_pcidevs(satas_sii);
Uwe Hermann's avatar
Uwe Hermann committed
693 694 695
		exit(0);
	}

696
	if (read_it && write_it) {
Uwe Hermann's avatar
Uwe Hermann committed
697
		printf("Error: -r and -w are mutually exclusive.\n");
698 699
		usage(argv[0]);
	}
Ronald G. Minnich's avatar
Dammit  
Ronald G. Minnich committed
700

701 702
	if (optind < argc)
		filename = argv[optind++];
Ronald G. Minnich's avatar
Ronald G. Minnich committed
703

704
	ret = programmer_init();
705

706
	myusec_calibrate_delay();
707

Claus Gindhart's avatar
Claus Gindhart committed
708
	for (i = 0; i < ARRAY_SIZE(flashes); i++) {
709 710
		flashes[i] =
		    probe_flash(i ? flashes[i - 1] + 1 : flashchips, 0);
Claus Gindhart's avatar
Claus Gindhart committed
711 712 713 714 715 716 717 718 719 720 721 722
		if (!flashes[i])
			for (i++; i < ARRAY_SIZE(flashes); i++)
				flashes[i] = NULL;
	}

	if (flashes[1]) {
		printf("Multiple flash chips were detected:");
		for (i = 0; i < ARRAY_SIZE(flashes) && flashes[i]; i++)
			printf(" %s", flashes[i]->name);
		printf("\nPlease specify which chip to use with the -c <chipname> option.\n");
		exit(1);
	} else if (!flashes[0]) {
723
		printf("No EEPROM/flash device found.\n");
Peter Stuge's avatar
Peter Stuge committed
724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
		if (!force || !chip_to_probe) {
			printf("If you know which flash chip you have, and if this version of flashrom\n");
			printf("supports a similar flash chip, you can try to force read your chip. Run:\n");
			printf("flashrom -f -r -c similar_supported_flash_chip filename\n");
			printf("\n");
			printf("Note: flashrom can never write when the flash chip isn't found automatically.\n");
		}
		if (force && read_it && chip_to_probe) {
			printf("Force read (-f -r -c) requested, forcing chip probe success:\n");
			flashes[0] = probe_flash(flashchips, 1);
			if (!flashes[0]) {
				printf("flashrom does not support a flash chip named '%s'.\n", chip_to_probe);
				printf("Run flashrom -L to view the hardware supported in this flashrom version.\n");
				exit(1);
			}
739
			return read_flash(flashes[0], filename, exclude_start_position, exclude_end_position);
Peter Stuge's avatar
Peter Stuge committed
740
		}
741
		// FIXME: flash writes stay enabled!
742 743
		exit(1);
	}
Ronald G. Minnich's avatar
Dammit  
Ronald G. Minnich committed
744

Claus Gindhart's avatar
Claus Gindhart committed
745 746
	flash = flashes[0];

747 748 749 750 751 752 753 754 755 756 757 758 759
	if (TEST_OK_MASK != (flash->tested & TEST_OK_MASK)) {
		printf("===\n");
		if (flash->tested & TEST_BAD_MASK) {
			printf("This flash part has status NOT WORKING for operations:");
			if (flash->tested & TEST_BAD_PROBE)
				printf(" PROBE");
			if (flash->tested & TEST_BAD_READ)
				printf(" READ");
			if (flash->tested & TEST_BAD_ERASE)
				printf(" ERASE");
			if (flash->tested & TEST_BAD_WRITE)
				printf(" WRITE");
			printf("\n");
760 761 762 763 764
		}
		if ((!(flash->tested & TEST_BAD_PROBE) && !(flash->tested & TEST_OK_PROBE)) ||
		    (!(flash->tested & TEST_BAD_READ) && !(flash->tested & TEST_OK_READ)) ||
		    (!(flash->tested & TEST_BAD_ERASE) && !(flash->tested & TEST_OK_ERASE)) ||
		    (!(flash->tested & TEST_BAD_WRITE) && !(flash->tested & TEST_OK_WRITE))) {
765
			printf("This flash part has status UNTESTED for operations:");
766
			if (!(flash->tested & TEST_BAD_PROBE) && !(flash->tested & TEST_OK_PROBE))
767
				printf(" PROBE");
768
			if (!(flash->tested & TEST_BAD_READ) && !(flash->tested & TEST_OK_READ))
769
				printf(" READ");
770
			if (!(flash->tested & TEST_BAD_ERASE) && !(flash->tested & TEST_OK_ERASE))
771
				printf(" ERASE");
772
			if (!(flash->tested & TEST_BAD_WRITE) && !(flash->tested & TEST_OK_WRITE))
773 774 775
				printf(" WRITE");
			printf("\n");
		}
776 777 778 779 780 781
		printf("Please email a report to flashrom@coreboot.org if any "
		       "of the above operations\nwork correctly for you with "
		       "this flash part. Please include the flashrom\noutput "
		       "with the additional -V option for all operations you "
		       "tested (-V, -rV,\n-wV, -EV), and mention which "
		       "mainboard you tested. Thanks for your help!\n===\n");
782
	}
783

784 785 786 787 788 789
	if (!(read_it | write_it | verify_it | erase_it)) {
		printf("No operations were specified.\n");
		// FIXME: flash writes stay enabled!
		exit(1);
	}

790
	if (!filename && !erase_it) {
791 792 793
		printf("Error: No filename specified.\n");
		// FIXME: flash writes stay enabled!
		exit(1);
794 795
	}

796 797
	size = flash->total_size * 1024;
	buf = (uint8_t *) calloc(size, sizeof(char));
798

799
	if (erase_it) {
800
		if (erase_flash(flash))
801
			return 1;
802
	} else if (read_it) {
803
		if (read_flash(flash, filename, exclude_start_position, exclude_end_position))
804
			return 1;
805
	} else {
806 807
		struct stat image_stat;

808
		if ((image = fopen(filename, "r")) == NULL) {
809 810 811
			perror(filename);
			exit(1);
		}
812 813 814 815
		if (fstat(fileno(image), &image_stat) != 0) {
			perror(filename);
			exit(1);
		}
816
		if (image_stat.st_size != flash->total_size * 1024) {
Uwe Hermann's avatar
Uwe Hermann committed
817
			fprintf(stderr, "Error: Image size doesn't match\n");
818 819 820
			exit(1);
		}

821
		numbytes = fread(buf, 1, size, image);
Peter Stuge's avatar
Peter Stuge committed
822
		show_id(buf, size, force);
823
		fclose(image);
824 825 826 827
		if (numbytes != size) {
			fprintf(stderr, "Error: Failed to read file. Got %ld bytes, wanted %ld!\n", numbytes, size);
			return 1;
		}
828
	}
Ronald G. Minnich's avatar
Ronald G. Minnich committed
829

830 831 832 833 834 835
	/* exclude range stuff. Nice idea, but at the moment it is only
	 * supported in hardware by the pm49fl004 chips. 
	 * Instead of implementing this for all chips I suggest advancing
	 * it to the rom layout feature below and drop exclude range
	 * completely once all flash chips can do rom layouts. stepan
	 */
836

837
	/* FIXME: This code is totally broken. It treats exclude ranges as include ranges. */
838
	// ////////////////////////////////////////////////////////////
839
	if (exclude_end_position - exclude_start_position > 0)
840 841 842
		chip_readn(buf + exclude_start_position,
			   flash->virtual_memory + exclude_start_position,
			   exclude_end_position - exclude_start_position);
843

844 845
	exclude_start_page = exclude_start_position / flash->page_size;
	if ((exclude_start_position % flash->page_size) != 0) {
846 847
		exclude_start_page++;
	}
848
	exclude_end_page = exclude_end_position / flash->page_size;
849 850 851 852
	// ////////////////////////////////////////////////////////////

	// This should be moved into each flash part's code to do it 
	// cleanly. This does the job.
853
	/* FIXME: Adapt to the external flasher infrastructure. */
854
	handle_romentries(buf, (uint8_t *) flash->virtual_memory);
855

856
	// ////////////////////////////////////////////////////////////
857

858
	if (write_it) {
859
		printf("Writing flash chip... ");
860 861 862 863
		if (!flash->write) {
			fprintf(stderr, "Error: flashrom has no write function for this flash chip.\n");
			return 1;
		}
Stefan Reinauer's avatar
Stefan Reinauer committed
864
		ret |= flash->write(flash, buf);
865
		if (!ret) printf("COMPLETE.\n");
866
	}
867

868
	if (verify_it)
Stefan Reinauer's avatar
Stefan Reinauer committed
869
		ret |= verify_flash(flash, buf);
870

871 872
	programmer_shutdown();

Stefan Reinauer's avatar
Stefan Reinauer committed
873
	return ret;
Ronald G. Minnich's avatar
Dammit  
Ronald G. Minnich committed
874
}