blob: e002ca22a779c930761bdc81a008a3e8d33eda3e [file] [log] [blame]
rminnich8d3ff912003-10-25 17:01:29 +00001/*
uweb25f1ea2007-08-29 17:52:32 +00002 * This file is part of the flashrom project.
rminnich8d3ff912003-10-25 17:01:29 +00003 *
uwe555dd972007-09-09 20:21:05 +00004 * Copyright (C) 2000 Silicon Integrated System Corporation
5 * Copyright (C) 2004 Tyan Corp <yhlu@tyan.com>
uwe4475e902009-05-19 14:14:21 +00006 * Copyright (C) 2005-2008 coresystems GmbH
hailfinger23060112009-05-08 12:49:03 +00007 * Copyright (C) 2008,2009 Carl-Daniel Hailfinger
rminnich8d3ff912003-10-25 17:01:29 +00008 *
uweb25f1ea2007-08-29 17:52:32 +00009 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
rminnich8d3ff912003-10-25 17:01:29 +000013 *
uweb25f1ea2007-08-29 17:52:32 +000014 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
rminnich8d3ff912003-10-25 17:01:29 +000018 *
uweb25f1ea2007-08-29 17:52:32 +000019 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
rminnich8d3ff912003-10-25 17:01:29 +000022 */
23
rminnich8d3ff912003-10-25 17:01:29 +000024#include <fcntl.h>
stepan1da96c02006-11-21 23:48:51 +000025#include <sys/types.h>
26#include <sys/stat.h>
rminnich8d3ff912003-10-25 17:01:29 +000027#include <string.h>
28#include <stdlib.h>
ollie6a600992005-11-26 21:55:36 +000029#include <getopt.h>
rminnich8d3ff912003-10-25 17:01:29 +000030#include "flash.h"
rminnich8d3ff912003-10-25 17:01:29 +000031
32char *chip_to_probe = NULL;
stepan193c9c22005-12-18 16:41:10 +000033int exclude_start_page, exclude_end_page;
stuge98c09aa2008-06-18 02:08:40 +000034int verbose = 0;
hailfingerabe249e2009-05-08 17:43:22 +000035int programmer = PROGRAMMER_INTERNAL;
stepan782fb172007-04-06 11:58:03 +000036
hailfingerabe249e2009-05-08 17:43:22 +000037const struct programmer_entry programmer_table[] = {
38 {
hailfinger6c69ab02009-05-11 15:46:43 +000039 .init = internal_init,
40 .shutdown = internal_shutdown,
hailfinger11ae3c42009-05-11 14:13:25 +000041 .map_flash_region = physmap,
42 .unmap_flash_region = physunmap,
hailfinger6c69ab02009-05-11 15:46:43 +000043 .chip_readb = internal_chip_readb,
44 .chip_readw = internal_chip_readw,
45 .chip_readl = internal_chip_readl,
46 .chip_writeb = internal_chip_writeb,
47 .chip_writew = internal_chip_writew,
48 .chip_writel = internal_chip_writel,
hailfingerabe249e2009-05-08 17:43:22 +000049 },
stepan927d4e22007-04-04 22:45:58 +000050
hailfingera9df33c2009-05-09 00:54:55 +000051 {
hailfinger6c69ab02009-05-11 15:46:43 +000052 .init = dummy_init,
53 .shutdown = dummy_shutdown,
hailfinger11ae3c42009-05-11 14:13:25 +000054 .map_flash_region = dummy_map,
55 .unmap_flash_region = dummy_unmap,
hailfinger6c69ab02009-05-11 15:46:43 +000056 .chip_readb = dummy_chip_readb,
57 .chip_readw = dummy_chip_readw,
58 .chip_readl = dummy_chip_readl,
59 .chip_writeb = dummy_chip_writeb,
60 .chip_writew = dummy_chip_writew,
61 .chip_writel = dummy_chip_writel,
hailfingera9df33c2009-05-09 00:54:55 +000062 },
63
uwe0f5a3a22009-05-13 11:36:06 +000064 {
65 .init = nic3com_init,
66 .shutdown = nic3com_shutdown,
uwe3e656bd2009-05-17 23:12:17 +000067 .map_flash_region = fallback_map,
68 .unmap_flash_region = fallback_unmap,
uwe0f5a3a22009-05-13 11:36:06 +000069 .chip_readb = nic3com_chip_readb,
hailfinger43716942009-05-16 01:23:55 +000070 .chip_readw = fallback_chip_readw,
71 .chip_readl = fallback_chip_readl,
uwe0f5a3a22009-05-13 11:36:06 +000072 .chip_writeb = nic3com_chip_writeb,
hailfinger43716942009-05-16 01:23:55 +000073 .chip_writew = fallback_chip_writew,
74 .chip_writel = fallback_chip_writel,
uwe0f5a3a22009-05-13 11:36:06 +000075 },
76
ruikda922a12009-05-17 19:39:27 +000077 {
78 .init = satasii_init,
79 .shutdown = satasii_shutdown,
uwe3e656bd2009-05-17 23:12:17 +000080 .map_flash_region = fallback_map,
81 .unmap_flash_region = fallback_unmap,
ruikda922a12009-05-17 19:39:27 +000082 .chip_readb = satasii_chip_readb,
83 .chip_readw = fallback_chip_readw,
84 .chip_readl = fallback_chip_readl,
85 .chip_writeb = satasii_chip_writeb,
86 .chip_writew = fallback_chip_writew,
87 .chip_writel = fallback_chip_writel,
88 },
89
hailfingerabe249e2009-05-08 17:43:22 +000090 {},
91};
stepan927d4e22007-04-04 22:45:58 +000092
uweabe92a52009-05-16 22:36:00 +000093int programmer_init(void)
94{
95 return programmer_table[programmer].init();
96}
97
98int programmer_shutdown(void)
99{
100 return programmer_table[programmer].shutdown();
101}
102
103void *programmer_map_flash_region(const char *descr, unsigned long phys_addr,
104 size_t len)
105{
106 return programmer_table[programmer].map_flash_region(descr,
107 phys_addr, len);
108}
109
110void programmer_unmap_flash_region(void *virt_addr, size_t len)
111{
112 programmer_table[programmer].unmap_flash_region(virt_addr, len);
113}
114
115void chip_writeb(uint8_t val, chipaddr addr)
116{
117 programmer_table[programmer].chip_writeb(val, addr);
118}
119
120void chip_writew(uint16_t val, chipaddr addr)
121{
122 programmer_table[programmer].chip_writew(val, addr);
123}
124
125void chip_writel(uint32_t val, chipaddr addr)
126{
127 programmer_table[programmer].chip_writel(val, addr);
128}
129
130uint8_t chip_readb(const chipaddr addr)
131{
132 return programmer_table[programmer].chip_readb(addr);
133}
134
135uint16_t chip_readw(const chipaddr addr)
136{
137 return programmer_table[programmer].chip_readw(addr);
138}
139
140uint32_t chip_readl(const chipaddr addr)
141{
142 return programmer_table[programmer].chip_readl(addr);
143}
144
stuge5ff0e6c2009-01-26 00:39:57 +0000145void map_flash_registers(struct flashchip *flash)
stepan15e64bc2007-05-24 08:48:10 +0000146{
stepan15e64bc2007-05-24 08:48:10 +0000147 size_t size = flash->total_size * 1024;
hailfinger8577ad12009-05-11 14:01:17 +0000148 /* Flash registers live 4 MByte below the flash. */
hailfinger82719632009-05-16 21:22:56 +0000149 flash->virtual_registers = (chipaddr)programmer_map_flash_region("flash chip registers", (0xFFFFFFFF - 0x400000 - size + 1), size);
stepan15e64bc2007-05-24 08:48:10 +0000150}
151
hailfinger23060112009-05-08 12:49:03 +0000152int read_memmapped(struct flashchip *flash, uint8_t *buf)
153{
154 int i;
155
156 /* We could do a memcpy as optimization if the flash is onboard */
157 //memcpy(buf, (const char *)flash->virtual_memory, flash->total_size * 1024);
158 for (i = 0; i < flash->total_size * 1024; i++)
159 buf[i] = chip_readb(flash->virtual_memory + i);
160
161 return 0;
162}
163
stuge56300c32008-09-03 23:10:05 +0000164struct flashchip *probe_flash(struct flashchip *first_flash, int force)
rminnich8d3ff912003-10-25 17:01:29 +0000165{
stuge56300c32008-09-03 23:10:05 +0000166 struct flashchip *flash;
stuge0b8a7fb2008-12-03 23:36:48 +0000167 unsigned long base = 0, size;
rminnich8d3ff912003-10-25 17:01:29 +0000168
stuge56300c32008-09-03 23:10:05 +0000169 for (flash = first_flash; flash && flash->name; flash++) {
stugec1e55fe2008-07-02 17:15:47 +0000170 if (chip_to_probe && strcmp(flash->name, chip_to_probe) != 0)
ollie5672ac62004-03-17 22:22:08 +0000171 continue;
stepanb8361b92008-03-17 22:59:40 +0000172 printf_debug("Probing for %s %s, %d KB: ",
173 flash->vendor, flash->name, flash->total_size);
stuge98c09aa2008-06-18 02:08:40 +0000174 if (!flash->probe && !force) {
stuge8ce3a3c2008-04-28 14:47:30 +0000175 printf_debug("failed! flashrom has no probe function for this flash chip.\n");
stuge8ce3a3c2008-04-28 14:47:30 +0000176 continue;
177 }
stepan782fb172007-04-06 11:58:03 +0000178
ollie5672ac62004-03-17 22:22:08 +0000179 size = flash->total_size * 1024;
stepan782fb172007-04-06 11:58:03 +0000180
hailfinger72d3b982009-05-09 07:27:23 +0000181 base = flashbase ? flashbase : (0xffffffff - size + 1);
hailfinger82719632009-05-16 21:22:56 +0000182 flash->virtual_memory = (chipaddr)programmer_map_flash_region("flash chip", base, size);
rminnich8d3ff912003-10-25 17:01:29 +0000183
stugec1e55fe2008-07-02 17:15:47 +0000184 if (force)
185 break;
stepanc98b80b2006-03-16 16:57:41 +0000186
stuge56300c32008-09-03 23:10:05 +0000187 if (flash->probe(flash) != 1)
188 goto notfound;
189
uwefa98ca12008-10-18 21:14:13 +0000190 if (first_flash == flashchips
191 || flash->model_id != GENERIC_DEVICE_ID)
stugec1e55fe2008-07-02 17:15:47 +0000192 break;
193
stuge56300c32008-09-03 23:10:05 +0000194notfound:
hailfinger82719632009-05-16 21:22:56 +0000195 programmer_unmap_flash_region((void *)flash->virtual_memory, size);
rminnich8d3ff912003-10-25 17:01:29 +0000196 }
uwebe4477b2007-08-23 16:08:21 +0000197
stugec1e55fe2008-07-02 17:15:47 +0000198 if (!flash || !flash->name)
199 return NULL;
200
201 printf("Found chip \"%s %s\" (%d KB) at physical address 0x%lx.\n",
stugeceb2afc2008-12-03 21:39:56 +0000202 flash->vendor, flash->name, flash->total_size, base);
stugec1e55fe2008-07-02 17:15:47 +0000203 return flash;
rminnich8d3ff912003-10-25 17:01:29 +0000204}
205
stepan193c9c22005-12-18 16:41:10 +0000206int verify_flash(struct flashchip *flash, uint8_t *buf)
rminnich8d3ff912003-10-25 17:01:29 +0000207{
stepanc98b80b2006-03-16 16:57:41 +0000208 int idx;
ollie5b621572004-03-20 16:46:10 +0000209 int total_size = flash->total_size * 1024;
hailfinger94586ba2008-01-22 15:19:01 +0000210 uint8_t *buf2 = (uint8_t *) calloc(total_size, sizeof(char));
hailfinger23060112009-05-08 12:49:03 +0000211 if (!flash->read) {
212 printf("FAILED!\n");
213 fprintf(stderr, "ERROR: flashrom has no read function for this flash chip.\n");
214 return 1;
215 } else
hailfinger94586ba2008-01-22 15:19:01 +0000216 flash->read(flash, buf2);
rminnich8d3ff912003-10-25 17:01:29 +0000217
uwefd2d0fe2007-10-17 23:55:15 +0000218 printf("Verifying flash... ");
uwef6641642007-05-09 10:17:44 +0000219
220 if (verbose)
221 printf("address: 0x00000000\b\b\b\b\b\b\b\b\b\b");
222
stepanc98b80b2006-03-16 16:57:41 +0000223 for (idx = 0; idx < total_size; idx++) {
uwef6641642007-05-09 10:17:44 +0000224 if (verbose && ((idx & 0xfff) == 0xfff))
stepanc98b80b2006-03-16 16:57:41 +0000225 printf("0x%08x", idx);
226
hailfinger94586ba2008-01-22 15:19:01 +0000227 if (*(buf2 + idx) != *(buf + idx)) {
stuge4eb58f12009-01-13 14:32:27 +0000228 if (verbose)
229 printf("0x%08x FAILED!", idx);
230 else
231 printf("FAILED at 0x%08x!", idx);
232 printf(" Expected=0x%02x, Read=0x%02x\n",
uwefa98ca12008-10-18 21:14:13 +0000233 *(buf + idx), *(buf2 + idx));
stepanc98b80b2006-03-16 16:57:41 +0000234 return 1;
ollie5672ac62004-03-17 22:22:08 +0000235 }
uwef6641642007-05-09 10:17:44 +0000236
237 if (verbose && ((idx & 0xfff) == 0xfff))
ollie5672ac62004-03-17 22:22:08 +0000238 printf("\b\b\b\b\b\b\b\b\b\b");
rminnich8d3ff912003-10-25 17:01:29 +0000239 }
uwef6641642007-05-09 10:17:44 +0000240 if (verbose)
stepanc98b80b2006-03-16 16:57:41 +0000241 printf("\b\b\b\b\b\b\b\b\b\b ");
uwef6641642007-05-09 10:17:44 +0000242
uwefd2d0fe2007-10-17 23:55:15 +0000243 printf("VERIFIED. \n");
uwebe4477b2007-08-23 16:08:21 +0000244
stepanc98b80b2006-03-16 16:57:41 +0000245 return 0;
rminnich8d3ff912003-10-25 17:01:29 +0000246}
247
hailfingerd219a232009-01-28 00:27:54 +0000248int read_flash(struct flashchip *flash, char *filename, unsigned int exclude_start_position, unsigned int exclude_end_position)
249{
250 unsigned long numbytes;
251 FILE *image;
252 unsigned long size = flash->total_size * 1024;
253 unsigned char *buf = calloc(size, sizeof(char));
254 if ((image = fopen(filename, "w")) == NULL) {
255 perror(filename);
256 exit(1);
257 }
258 printf("Reading flash... ");
hailfinger23060112009-05-08 12:49:03 +0000259 if (!flash->read) {
260 printf("FAILED!\n");
261 fprintf(stderr, "ERROR: flashrom has no read function for this flash chip.\n");
262 return 1;
263 } else
hailfingerd219a232009-01-28 00:27:54 +0000264 flash->read(flash, buf);
265
266 if (exclude_end_position - exclude_start_position > 0)
267 memset(buf + exclude_start_position, 0,
268 exclude_end_position - exclude_start_position);
269
270 numbytes = fwrite(buf, 1, size, image);
271 fclose(image);
272 printf("%s.\n", numbytes == size ? "done" : "FAILED");
273 if (numbytes != size)
274 return 1;
275 return 0;
276}
277
278int erase_flash(struct flashchip *flash)
279{
280 uint32_t erasedbytes;
281 unsigned long size = flash->total_size * 1024;
282 unsigned char *buf = calloc(size, sizeof(char));
283 printf("Erasing flash chip... ");
284 if (NULL == flash->erase) {
285 printf("FAILED!\n");
286 fprintf(stderr, "ERROR: flashrom has no erase function for this flash chip.\n");
287 return 1;
288 }
hailfinger1e9ee0f2009-05-08 17:15:15 +0000289 flash->erase(flash);
290
hailfinger23060112009-05-08 12:49:03 +0000291 if (!flash->read) {
292 printf("FAILED!\n");
293 fprintf(stderr, "ERROR: flashrom has no read function for this flash chip.\n");
294 return 1;
295 } else
hailfingerd219a232009-01-28 00:27:54 +0000296 flash->read(flash, buf);
hailfinger23060112009-05-08 12:49:03 +0000297
hailfingerd219a232009-01-28 00:27:54 +0000298 for (erasedbytes = 0; erasedbytes < size; erasedbytes++)
299 if (0xff != buf[erasedbytes]) {
300 printf("FAILED!\n");
301 fprintf(stderr, "ERROR at 0x%08x: Expected=0xff, Read=0x%02x\n",
302 erasedbytes, buf[erasedbytes]);
303 return 1;
304 }
305 printf("SUCCESS.\n");
306 return 0;
307}
308
uwee06bcf82009-04-24 16:17:41 +0000309#ifndef MAX
stugecae7e532008-12-06 01:37:09 +0000310#define MAX(a, b) ((a) > (b) ? (a) : (b))
uwee06bcf82009-04-24 16:17:41 +0000311#endif
stugecae7e532008-12-06 01:37:09 +0000312#define POS_PRINT(x) do { pos += strlen(x); printf(x); } while (0)
313
uwe16f99092008-03-12 11:54:51 +0000314void print_supported_chips(void)
315{
stugecae7e532008-12-06 01:37:09 +0000316 int okcol = 0, pos = 0;
317 struct flashchip *f;
uwe16f99092008-03-12 11:54:51 +0000318
stugecae7e532008-12-06 01:37:09 +0000319 for (f = flashchips; f->name != NULL; f++) {
320 if (GENERIC_DEVICE_ID == f->model_id)
321 continue;
322 okcol = MAX(okcol, strlen(f->vendor) + 1 + strlen(f->name));
323 }
324 okcol = (okcol + 7) & ~7;
uwe16f99092008-03-12 11:54:51 +0000325
stugecae7e532008-12-06 01:37:09 +0000326 POS_PRINT("Supported flash chips:");
327 while (pos < okcol) {
328 printf("\t");
329 pos += 8 - (pos % 8);
330 }
331 printf("Tested OK operations:\tKnown BAD operations:\n\n");
332
333 for (f = flashchips; f->name != NULL; f++) {
334 printf("%s %s", f->vendor, f->name);
335 pos = strlen(f->vendor) + 1 + strlen(f->name);
336 while (pos < okcol) {
337 printf("\t");
338 pos += 8 - (pos % 8);
339 }
340 if ((f->tested & TEST_OK_MASK)) {
341 if ((f->tested & TEST_OK_PROBE))
342 POS_PRINT("PROBE ");
343 if ((f->tested & TEST_OK_READ))
344 POS_PRINT("READ ");
345 if ((f->tested & TEST_OK_ERASE))
346 POS_PRINT("ERASE ");
347 if ((f->tested & TEST_OK_WRITE))
348 POS_PRINT("WRITE");
349 }
350 while (pos < okcol + 24) {
351 printf("\t");
352 pos += 8 - (pos % 8);
353 }
354 if ((f->tested & TEST_BAD_MASK)) {
355 if ((f->tested & TEST_BAD_PROBE))
356 printf("PROBE ");
357 if ((f->tested & TEST_BAD_READ))
358 printf("READ ");
359 if ((f->tested & TEST_BAD_ERASE))
360 printf("ERASE ");
361 if ((f->tested & TEST_BAD_WRITE))
362 printf("WRITE");
363 }
364 printf("\n");
365 }
uwe16f99092008-03-12 11:54:51 +0000366}
367
rminnich8d3ff912003-10-25 17:01:29 +0000368void usage(const char *name)
369{
uwe4475e902009-05-19 14:14:21 +0000370 printf("usage: %s [-EVfLhR] [-r file] [-w file] [-v file] [-c chipname] [-s addr]\n"
371 " [-e addr] [-m [vendor:]part] [-l file] [-i image] [-p programmer] [file]",
uwefa98ca12008-10-18 21:14:13 +0000372 name);
uwe4475e902009-05-19 14:14:21 +0000373
374 printf("\n\nPlease note that the command line interface for flashrom will "
375 "change before flashrom 1.0.\nDo not use flashrom in scripts or "
376 "other automated tools without checking that your flashrom\n"
hailfingerca7f01d2009-05-01 10:53:49 +0000377 "version won't interpret them in a totally different way.\n\n");
uwe4475e902009-05-19 14:14:21 +0000378
uwef6641642007-05-09 10:17:44 +0000379 printf
stugeb9b411f2008-01-27 16:21:21 +0000380 (" -r | --read: read flash and save into file\n"
381 " -w | --write: write file into flash\n"
382 " -v | --verify: verify flash against file\n"
383 " -E | --erase: erase flash device\n"
384 " -V | --verbose: more verbose output\n"
385 " -c | --chip <chipname>: probe only for specified flash chip\n"
386 " -s | --estart <addr>: exclude start position\n"
387 " -e | --eend <addr>: exclude end postion\n"
388 " -m | --mainboard <[vendor:]part>: override mainboard settings\n"
389 " -f | --force: force write without checking image\n"
390 " -l | --layout <file.layout>: read rom layout from file\n"
391 " -i | --image <name>: only flash image name from flash layout\n"
uwe16f99092008-03-12 11:54:51 +0000392 " -L | --list-supported: print supported devices\n"
hailfinger46bed042009-05-09 00:27:07 +0000393 " -p | --programmer <name>: specify the programmer device\n"
uwe4475e902009-05-19 14:14:21 +0000394 " (internal, dummy, nic3com, satasii)\n"
uwe16f99092008-03-12 11:54:51 +0000395 " -h | --help: print this help text\n"
stugeb9b411f2008-01-27 16:21:21 +0000396 " -R | --version: print the version (release)\n"
uwe4475e902009-05-19 14:14:21 +0000397 "\nIf no file is specified, then all that happens"
uwef6641642007-05-09 10:17:44 +0000398 " is that flash info is dumped.\n\n");
ollie5672ac62004-03-17 22:22:08 +0000399 exit(1);
rminnich8d3ff912003-10-25 17:01:29 +0000400}
401
uwefdeca092008-01-21 15:24:22 +0000402void print_version(void)
403{
hailfingera5cfc5f2009-05-04 12:18:10 +0000404 printf("flashrom v%s\n", FLASHROM_VERSION);
uwefdeca092008-01-21 15:24:22 +0000405}
406
ollie5b621572004-03-20 16:46:10 +0000407int main(int argc, char *argv[])
rminnich8d3ff912003-10-25 17:01:29 +0000408{
ollie6a600992005-11-26 21:55:36 +0000409 uint8_t *buf;
stugebbcc2f12009-01-12 21:00:35 +0000410 unsigned long size, numbytes;
ollie5b621572004-03-20 16:46:10 +0000411 FILE *image;
stugec7354dc2008-05-08 00:31:44 +0000412 /* Probe for up to three flash chips. */
413 struct flashchip *flash, *flashes[3];
ollie5672ac62004-03-17 22:22:08 +0000414 int opt;
ollie6a600992005-11-26 21:55:36 +0000415 int option_index = 0;
stuge98c09aa2008-06-18 02:08:40 +0000416 int force = 0;
uwef6641642007-05-09 10:17:44 +0000417 int read_it = 0, write_it = 0, erase_it = 0, verify_it = 0;
uwe5f612c82009-05-16 23:42:17 +0000418 int list_supported = 0;
stugec7354dc2008-05-08 00:31:44 +0000419 int ret = 0, i;
ollie6a600992005-11-26 21:55:36 +0000420
uwef6641642007-05-09 10:17:44 +0000421 static struct option long_options[] = {
422 {"read", 0, 0, 'r'},
423 {"write", 0, 0, 'w'},
424 {"erase", 0, 0, 'E'},
425 {"verify", 0, 0, 'v'},
426 {"chip", 1, 0, 'c'},
427 {"estart", 1, 0, 's'},
428 {"eend", 1, 0, 'e'},
429 {"mainboard", 1, 0, 'm'},
430 {"verbose", 0, 0, 'V'},
431 {"force", 0, 0, 'f'},
432 {"layout", 1, 0, 'l'},
433 {"image", 1, 0, 'i'},
uwe16f99092008-03-12 11:54:51 +0000434 {"list-supported", 0, 0, 'L'},
hailfingerabe249e2009-05-08 17:43:22 +0000435 {"programmer", 1, 0, 'p'},
uwef6641642007-05-09 10:17:44 +0000436 {"help", 0, 0, 'h'},
uwefdeca092008-01-21 15:24:22 +0000437 {"version", 0, 0, 'R'},
uwef6641642007-05-09 10:17:44 +0000438 {0, 0, 0, 0}
ollie6a600992005-11-26 21:55:36 +0000439 };
uwef6641642007-05-09 10:17:44 +0000440
ollie5672ac62004-03-17 22:22:08 +0000441 char *filename = NULL;
rminnich8d3ff912003-10-25 17:01:29 +0000442
uwef6641642007-05-09 10:17:44 +0000443 unsigned int exclude_start_position = 0, exclude_end_position = 0; // [x,y)
444 char *tempstr = NULL, *tempstr2 = NULL;
yhlu5d4383a2004-10-20 05:07:16 +0000445
hailfingerf17c52f2009-05-07 00:59:53 +0000446 print_version();
447
yhlu5d4383a2004-10-20 05:07:16 +0000448 if (argc > 1) {
449 /* Yes, print them. */
450 int i;
uwef6641642007-05-09 10:17:44 +0000451 printf_debug("The arguments are:\n");
yhlu5d4383a2004-10-20 05:07:16 +0000452 for (i = 1; i < argc; ++i)
uwef6641642007-05-09 10:17:44 +0000453 printf_debug("%s\n", argv[i]);
yhlu5d4383a2004-10-20 05:07:16 +0000454 }
455
ollie5672ac62004-03-17 22:22:08 +0000456 setbuf(stdout, NULL);
hailfingerabe249e2009-05-08 17:43:22 +0000457 while ((opt = getopt_long(argc, argv, "rRwvVEfc:s:e:m:l:i:p:Lh",
uwef6641642007-05-09 10:17:44 +0000458 long_options, &option_index)) != EOF) {
ollie5672ac62004-03-17 22:22:08 +0000459 switch (opt) {
460 case 'r':
461 read_it = 1;
462 break;
463 case 'w':
464 write_it = 1;
465 break;
466 case 'v':
467 verify_it = 1;
468 break;
469 case 'c':
470 chip_to_probe = strdup(optarg);
471 break;
ollie077017b2004-03-18 20:27:33 +0000472 case 'V':
473 verbose = 1;
474 break;
ollie0eb62d62004-12-08 20:10:01 +0000475 case 'E':
476 erase_it = 1;
477 break;
yhlu5d4383a2004-10-20 05:07:16 +0000478 case 's':
479 tempstr = strdup(optarg);
uwef6641642007-05-09 10:17:44 +0000480 sscanf(tempstr, "%x", &exclude_start_position);
yhlu5d4383a2004-10-20 05:07:16 +0000481 break;
482 case 'e':
olliea4302802004-12-07 03:15:51 +0000483 tempstr = strdup(optarg);
uwef6641642007-05-09 10:17:44 +0000484 sscanf(tempstr, "%x", &exclude_end_position);
olliea4302802004-12-07 03:15:51 +0000485 break;
ollie6a600992005-11-26 21:55:36 +0000486 case 'm':
487 tempstr = strdup(optarg);
488 strtok(tempstr, ":");
uwef6641642007-05-09 10:17:44 +0000489 tempstr2 = strtok(NULL, ":");
ollie6a600992005-11-26 21:55:36 +0000490 if (tempstr2) {
uwef6641642007-05-09 10:17:44 +0000491 lb_vendor = tempstr;
492 lb_part = tempstr2;
ollie6a600992005-11-26 21:55:36 +0000493 } else {
stugeb9b411f2008-01-27 16:21:21 +0000494 lb_vendor = NULL;
495 lb_part = tempstr;
ollie6a600992005-11-26 21:55:36 +0000496 }
497 break;
498 case 'f':
uwef6641642007-05-09 10:17:44 +0000499 force = 1;
ollie6a600992005-11-26 21:55:36 +0000500 break;
501 case 'l':
uwef6641642007-05-09 10:17:44 +0000502 tempstr = strdup(optarg);
stepan14566ee2007-04-14 16:32:59 +0000503 if (read_romlayout(tempstr))
504 exit(1);
ollie6a600992005-11-26 21:55:36 +0000505 break;
506 case 'i':
uwef6641642007-05-09 10:17:44 +0000507 tempstr = strdup(optarg);
ollie6a600992005-11-26 21:55:36 +0000508 find_romentry(tempstr);
509 break;
uwe16f99092008-03-12 11:54:51 +0000510 case 'L':
uwe5f612c82009-05-16 23:42:17 +0000511 list_supported = 1;
uwe16f99092008-03-12 11:54:51 +0000512 break;
hailfingerabe249e2009-05-08 17:43:22 +0000513 case 'p':
514 if (strncmp(optarg, "internal", 8) == 0) {
515 programmer = PROGRAMMER_INTERNAL;
hailfingera9df33c2009-05-09 00:54:55 +0000516 } else if (strncmp(optarg, "dummy", 5) == 0) {
517 programmer = PROGRAMMER_DUMMY;
uwe0f5a3a22009-05-13 11:36:06 +0000518 } else if (strncmp(optarg, "nic3com", 7) == 0) {
519 programmer = PROGRAMMER_NIC3COM;
uwe6934c4a2009-05-14 18:57:26 +0000520 if (optarg[7] == '=')
uwea3a82c92009-05-15 17:02:34 +0000521 pcidev_bdf = strdup(optarg + 8);
ruikda922a12009-05-17 19:39:27 +0000522 } else if (strncmp(optarg, "satasii", 7) == 0) {
523 programmer = PROGRAMMER_SATASII;
524 if (optarg[7] == '=')
525 pcidev_bdf = strdup(optarg + 8);
hailfingerabe249e2009-05-08 17:43:22 +0000526 } else {
527 printf("Error: Unknown programmer.\n");
528 exit(1);
529 }
530 break;
uwefdeca092008-01-21 15:24:22 +0000531 case 'R':
hailfingerf17c52f2009-05-07 00:59:53 +0000532 /* print_version() is always called during startup. */
uwefdeca092008-01-21 15:24:22 +0000533 exit(0);
534 break;
ollie6a600992005-11-26 21:55:36 +0000535 case 'h':
ollie5672ac62004-03-17 22:22:08 +0000536 default:
537 usage(argv[0]);
538 break;
539 }
540 }
yhlu5d4383a2004-10-20 05:07:16 +0000541
uwe5f612c82009-05-16 23:42:17 +0000542 if (list_supported) {
543 print_supported_chips();
544 print_supported_chipsets();
545 print_supported_boards();
546 printf("\nSupported PCI devices flashrom can use "
547 "as programmer:\n\n");
548 print_supported_pcidevs(nics_3com);
uwef95d4462009-05-17 22:57:34 +0000549 print_supported_pcidevs(satas_sii);
uwe5f612c82009-05-16 23:42:17 +0000550 exit(0);
551 }
552
ollie5672ac62004-03-17 22:22:08 +0000553 if (read_it && write_it) {
uwe017911e2008-05-22 22:47:04 +0000554 printf("Error: -r and -w are mutually exclusive.\n");
ollie5672ac62004-03-17 22:22:08 +0000555 usage(argv[0]);
556 }
rminnich8d3ff912003-10-25 17:01:29 +0000557
ollie5672ac62004-03-17 22:22:08 +0000558 if (optind < argc)
559 filename = argv[optind++];
rminnich8d3ff912003-10-25 17:01:29 +0000560
hailfingerabe249e2009-05-08 17:43:22 +0000561 ret = programmer_init();
stepan927d4e22007-04-04 22:45:58 +0000562
ollie5672ac62004-03-17 22:22:08 +0000563 myusec_calibrate_delay();
ollie6a600992005-11-26 21:55:36 +0000564
stugec7354dc2008-05-08 00:31:44 +0000565 for (i = 0; i < ARRAY_SIZE(flashes); i++) {
uwefa98ca12008-10-18 21:14:13 +0000566 flashes[i] =
567 probe_flash(i ? flashes[i - 1] + 1 : flashchips, 0);
stugec7354dc2008-05-08 00:31:44 +0000568 if (!flashes[i])
569 for (i++; i < ARRAY_SIZE(flashes); i++)
570 flashes[i] = NULL;
571 }
572
573 if (flashes[1]) {
574 printf("Multiple flash chips were detected:");
575 for (i = 0; i < ARRAY_SIZE(flashes) && flashes[i]; i++)
576 printf(" %s", flashes[i]->name);
577 printf("\nPlease specify which chip to use with the -c <chipname> option.\n");
578 exit(1);
579 } else if (!flashes[0]) {
ollie6a600992005-11-26 21:55:36 +0000580 printf("No EEPROM/flash device found.\n");
stuge98c09aa2008-06-18 02:08:40 +0000581 if (!force || !chip_to_probe) {
582 printf("If you know which flash chip you have, and if this version of flashrom\n");
583 printf("supports a similar flash chip, you can try to force read your chip. Run:\n");
584 printf("flashrom -f -r -c similar_supported_flash_chip filename\n");
585 printf("\n");
586 printf("Note: flashrom can never write when the flash chip isn't found automatically.\n");
587 }
588 if (force && read_it && chip_to_probe) {
589 printf("Force read (-f -r -c) requested, forcing chip probe success:\n");
590 flashes[0] = probe_flash(flashchips, 1);
591 if (!flashes[0]) {
592 printf("flashrom does not support a flash chip named '%s'.\n", chip_to_probe);
593 printf("Run flashrom -L to view the hardware supported in this flashrom version.\n");
594 exit(1);
595 }
stuged88bbe52008-10-10 20:43:17 +0000596 if (!filename) {
597 printf("Error: No filename specified.\n");
598 exit(1);
599 }
stuge98c09aa2008-06-18 02:08:40 +0000600 size = flashes[0]->total_size * 1024;
601 buf = (uint8_t *) calloc(size, sizeof(char));
602
603 if ((image = fopen(filename, "w")) == NULL) {
604 perror(filename);
605 exit(1);
606 }
uwe17efbed2008-11-28 21:36:51 +0000607 printf("Force reading flash... ");
hailfinger23060112009-05-08 12:49:03 +0000608 if (!flashes[0]->read) {
609 printf("FAILED!\n");
610 fprintf(stderr, "ERROR: flashrom has no read function for this flash chip.\n");
611 return 1;
612 } else
stuge98c09aa2008-06-18 02:08:40 +0000613 flashes[0]->read(flashes[0], buf);
614
615 if (exclude_end_position - exclude_start_position > 0)
616 memset(buf + exclude_start_position, 0,
uwefa98ca12008-10-18 21:14:13 +0000617 exclude_end_position -
618 exclude_start_position);
stuge98c09aa2008-06-18 02:08:40 +0000619
stugebbcc2f12009-01-12 21:00:35 +0000620 numbytes = fwrite(buf, 1, size, image);
stuge98c09aa2008-06-18 02:08:40 +0000621 fclose(image);
stugebbcc2f12009-01-12 21:00:35 +0000622 printf("%s.\n", numbytes == size ? "done" : "FAILED");
stuge98c09aa2008-06-18 02:08:40 +0000623 free(buf);
stugebbcc2f12009-01-12 21:00:35 +0000624 return numbytes != size;
stuge98c09aa2008-06-18 02:08:40 +0000625 }
stepan9cbfb252007-10-04 06:26:41 +0000626 // FIXME: flash writes stay enabled!
ollie5672ac62004-03-17 22:22:08 +0000627 exit(1);
628 }
rminnich8d3ff912003-10-25 17:01:29 +0000629
stugec7354dc2008-05-08 00:31:44 +0000630 flash = flashes[0];
631
stuge9cd64bd2008-05-03 04:34:37 +0000632 if (TEST_OK_MASK != (flash->tested & TEST_OK_MASK)) {
633 printf("===\n");
634 if (flash->tested & TEST_BAD_MASK) {
635 printf("This flash part has status NOT WORKING for operations:");
636 if (flash->tested & TEST_BAD_PROBE)
637 printf(" PROBE");
638 if (flash->tested & TEST_BAD_READ)
639 printf(" READ");
640 if (flash->tested & TEST_BAD_ERASE)
641 printf(" ERASE");
642 if (flash->tested & TEST_BAD_WRITE)
643 printf(" WRITE");
644 printf("\n");
hailfinger6aaf46a2008-11-28 23:45:27 +0000645 }
646 if ((!(flash->tested & TEST_BAD_PROBE) && !(flash->tested & TEST_OK_PROBE)) ||
647 (!(flash->tested & TEST_BAD_READ) && !(flash->tested & TEST_OK_READ)) ||
648 (!(flash->tested & TEST_BAD_ERASE) && !(flash->tested & TEST_OK_ERASE)) ||
649 (!(flash->tested & TEST_BAD_WRITE) && !(flash->tested & TEST_OK_WRITE))) {
stuge9cd64bd2008-05-03 04:34:37 +0000650 printf("This flash part has status UNTESTED for operations:");
hailfinger6aaf46a2008-11-28 23:45:27 +0000651 if (!(flash->tested & TEST_BAD_PROBE) && !(flash->tested & TEST_OK_PROBE))
stuge9cd64bd2008-05-03 04:34:37 +0000652 printf(" PROBE");
hailfinger6aaf46a2008-11-28 23:45:27 +0000653 if (!(flash->tested & TEST_BAD_READ) && !(flash->tested & TEST_OK_READ))
stuge9cd64bd2008-05-03 04:34:37 +0000654 printf(" READ");
hailfinger6aaf46a2008-11-28 23:45:27 +0000655 if (!(flash->tested & TEST_BAD_ERASE) && !(flash->tested & TEST_OK_ERASE))
stuge9cd64bd2008-05-03 04:34:37 +0000656 printf(" ERASE");
hailfinger6aaf46a2008-11-28 23:45:27 +0000657 if (!(flash->tested & TEST_BAD_WRITE) && !(flash->tested & TEST_OK_WRITE))
stuge9cd64bd2008-05-03 04:34:37 +0000658 printf(" WRITE");
659 printf("\n");
660 }
uwe3cfe8a52009-05-21 15:55:46 +0000661 printf("Please email a report to flashrom@coreboot.org if any "
662 "of the above operations\nwork correctly for you with "
663 "this flash part. Please include the flashrom\noutput "
664 "with the additional -V option for all operations you "
665 "tested (-V, -rV,\n-wV, -EV), and mention which "
666 "mainboard you tested. Thanks for your help!\n===\n");
stuge9cd64bd2008-05-03 04:34:37 +0000667 }
ollie6a600992005-11-26 21:55:36 +0000668
stepan9cbfb252007-10-04 06:26:41 +0000669 if (!(read_it | write_it | verify_it | erase_it)) {
670 printf("No operations were specified.\n");
671 // FIXME: flash writes stay enabled!
672 exit(1);
673 }
674
ollie0eb62d62004-12-08 20:10:01 +0000675 if (!filename && !erase_it) {
stepan9cbfb252007-10-04 06:26:41 +0000676 printf("Error: No filename specified.\n");
677 // FIXME: flash writes stay enabled!
678 exit(1);
ollie5672ac62004-03-17 22:22:08 +0000679 }
ollie5672ac62004-03-17 22:22:08 +0000680
ollie6a600992005-11-26 21:55:36 +0000681 size = flash->total_size * 1024;
682 buf = (uint8_t *) calloc(size, sizeof(char));
uwef6641642007-05-09 10:17:44 +0000683
ollie0eb62d62004-12-08 20:10:01 +0000684 if (erase_it) {
hailfingerd219a232009-01-28 00:27:54 +0000685 if (erase_flash(flash))
stuge8ce3a3c2008-04-28 14:47:30 +0000686 return 1;
ollie0eb62d62004-12-08 20:10:01 +0000687 } else if (read_it) {
hailfingerd219a232009-01-28 00:27:54 +0000688 if (read_flash(flash, filename, exclude_start_position, exclude_end_position))
stugebbcc2f12009-01-12 21:00:35 +0000689 return 1;
ollie5672ac62004-03-17 22:22:08 +0000690 } else {
stepan1da96c02006-11-21 23:48:51 +0000691 struct stat image_stat;
692
ollie5b621572004-03-20 16:46:10 +0000693 if ((image = fopen(filename, "r")) == NULL) {
ollie5672ac62004-03-17 22:22:08 +0000694 perror(filename);
695 exit(1);
696 }
stepan1da96c02006-11-21 23:48:51 +0000697 if (fstat(fileno(image), &image_stat) != 0) {
698 perror(filename);
699 exit(1);
700 }
uwef6641642007-05-09 10:17:44 +0000701 if (image_stat.st_size != flash->total_size * 1024) {
uwe017911e2008-05-22 22:47:04 +0000702 fprintf(stderr, "Error: Image size doesn't match\n");
stepan1da96c02006-11-21 23:48:51 +0000703 exit(1);
704 }
705
stugebbcc2f12009-01-12 21:00:35 +0000706 numbytes = fread(buf, 1, size, image);
stuge98c09aa2008-06-18 02:08:40 +0000707 show_id(buf, size, force);
ollie5672ac62004-03-17 22:22:08 +0000708 fclose(image);
stugebbcc2f12009-01-12 21:00:35 +0000709 if (numbytes != size) {
710 fprintf(stderr, "Error: Failed to read file. Got %ld bytes, wanted %ld!\n", numbytes, size);
711 return 1;
712 }
ollie5672ac62004-03-17 22:22:08 +0000713 }
714
ollie6a600992005-11-26 21:55:36 +0000715 /* exclude range stuff. Nice idea, but at the moment it is only
716 * supported in hardware by the pm49fl004 chips.
717 * Instead of implementing this for all chips I suggest advancing
718 * it to the rom layout feature below and drop exclude range
719 * completely once all flash chips can do rom layouts. stepan
720 */
uwef6641642007-05-09 10:17:44 +0000721
ollie6a600992005-11-26 21:55:36 +0000722 // ////////////////////////////////////////////////////////////
hailfinger23060112009-05-08 12:49:03 +0000723 /* FIXME: This memcpy will not work for SPI nor external flashers.
724 * Convert to chip_readb.
725 */
olliea4302802004-12-07 03:15:51 +0000726 if (exclude_end_position - exclude_start_position > 0)
uwef6641642007-05-09 10:17:44 +0000727 memcpy(buf + exclude_start_position,
uwecdf59ac2007-05-24 19:17:29 +0000728 (const char *)flash->virtual_memory +
729 exclude_start_position,
uwef6641642007-05-09 10:17:44 +0000730 exclude_end_position - exclude_start_position);
olliea4302802004-12-07 03:15:51 +0000731
uwef6641642007-05-09 10:17:44 +0000732 exclude_start_page = exclude_start_position / flash->page_size;
733 if ((exclude_start_position % flash->page_size) != 0) {
olliea4302802004-12-07 03:15:51 +0000734 exclude_start_page++;
735 }
uwef6641642007-05-09 10:17:44 +0000736 exclude_end_page = exclude_end_position / flash->page_size;
ollie6a600992005-11-26 21:55:36 +0000737 // ////////////////////////////////////////////////////////////
yhlu5d4383a2004-10-20 05:07:16 +0000738
ollie6a600992005-11-26 21:55:36 +0000739 // This should be moved into each flash part's code to do it
740 // cleanly. This does the job.
stepan7cd945e2007-05-23 17:20:56 +0000741 handle_romentries(buf, (uint8_t *) flash->virtual_memory);
uwef6641642007-05-09 10:17:44 +0000742
ollie6a600992005-11-26 21:55:36 +0000743 // ////////////////////////////////////////////////////////////
uwef6641642007-05-09 10:17:44 +0000744
stuge8ce3a3c2008-04-28 14:47:30 +0000745 if (write_it) {
746 if (!flash->write) {
747 fprintf(stderr, "Error: flashrom has no write function for this flash chip.\n");
748 return 1;
749 }
stepan83eca252006-01-04 16:42:57 +0000750 ret |= flash->write(flash, buf);
stuge8ce3a3c2008-04-28 14:47:30 +0000751 }
ollie6a600992005-11-26 21:55:36 +0000752
ollie5672ac62004-03-17 22:22:08 +0000753 if (verify_it)
stepan83eca252006-01-04 16:42:57 +0000754 ret |= verify_flash(flash, buf);
ollie6a600992005-11-26 21:55:36 +0000755
hailfingerabe249e2009-05-08 17:43:22 +0000756 programmer_shutdown();
757
stepan83eca252006-01-04 16:42:57 +0000758 return ret;
rminnich8d3ff912003-10-25 17:01:29 +0000759}