blob: 925b05b933a7b3271d4c8f7347e6cdbbd3662771 [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>
stepan838a3f12008-08-02 15:13:58 +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,
67 .map_flash_region = nic3com_map,
68 .unmap_flash_region = nic3com_unmap,
69 .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
hailfingerabe249e2009-05-08 17:43:22 +000077 {},
78};
stepan927d4e22007-04-04 22:45:58 +000079
uweabe92a52009-05-16 22:36:00 +000080int programmer_init(void)
81{
82 return programmer_table[programmer].init();
83}
84
85int programmer_shutdown(void)
86{
87 return programmer_table[programmer].shutdown();
88}
89
90void *programmer_map_flash_region(const char *descr, unsigned long phys_addr,
91 size_t len)
92{
93 return programmer_table[programmer].map_flash_region(descr,
94 phys_addr, len);
95}
96
97void programmer_unmap_flash_region(void *virt_addr, size_t len)
98{
99 programmer_table[programmer].unmap_flash_region(virt_addr, len);
100}
101
102void chip_writeb(uint8_t val, chipaddr addr)
103{
104 programmer_table[programmer].chip_writeb(val, addr);
105}
106
107void chip_writew(uint16_t val, chipaddr addr)
108{
109 programmer_table[programmer].chip_writew(val, addr);
110}
111
112void chip_writel(uint32_t val, chipaddr addr)
113{
114 programmer_table[programmer].chip_writel(val, addr);
115}
116
117uint8_t chip_readb(const chipaddr addr)
118{
119 return programmer_table[programmer].chip_readb(addr);
120}
121
122uint16_t chip_readw(const chipaddr addr)
123{
124 return programmer_table[programmer].chip_readw(addr);
125}
126
127uint32_t chip_readl(const chipaddr addr)
128{
129 return programmer_table[programmer].chip_readl(addr);
130}
131
stuge5ff0e6c2009-01-26 00:39:57 +0000132void map_flash_registers(struct flashchip *flash)
stepan15e64bc2007-05-24 08:48:10 +0000133{
stepan15e64bc2007-05-24 08:48:10 +0000134 size_t size = flash->total_size * 1024;
hailfinger8577ad12009-05-11 14:01:17 +0000135 /* Flash registers live 4 MByte below the flash. */
hailfinger82719632009-05-16 21:22:56 +0000136 flash->virtual_registers = (chipaddr)programmer_map_flash_region("flash chip registers", (0xFFFFFFFF - 0x400000 - size + 1), size);
stepan15e64bc2007-05-24 08:48:10 +0000137}
138
hailfinger23060112009-05-08 12:49:03 +0000139int read_memmapped(struct flashchip *flash, uint8_t *buf)
140{
141 int i;
142
143 /* We could do a memcpy as optimization if the flash is onboard */
144 //memcpy(buf, (const char *)flash->virtual_memory, flash->total_size * 1024);
145 for (i = 0; i < flash->total_size * 1024; i++)
146 buf[i] = chip_readb(flash->virtual_memory + i);
147
148 return 0;
149}
150
stuge56300c32008-09-03 23:10:05 +0000151struct flashchip *probe_flash(struct flashchip *first_flash, int force)
rminnich8d3ff912003-10-25 17:01:29 +0000152{
stuge56300c32008-09-03 23:10:05 +0000153 struct flashchip *flash;
stuge0b8a7fb2008-12-03 23:36:48 +0000154 unsigned long base = 0, size;
rminnich8d3ff912003-10-25 17:01:29 +0000155
stuge56300c32008-09-03 23:10:05 +0000156 for (flash = first_flash; flash && flash->name; flash++) {
stugec1e55fe2008-07-02 17:15:47 +0000157 if (chip_to_probe && strcmp(flash->name, chip_to_probe) != 0)
ollie5672ac62004-03-17 22:22:08 +0000158 continue;
stepanb8361b92008-03-17 22:59:40 +0000159 printf_debug("Probing for %s %s, %d KB: ",
160 flash->vendor, flash->name, flash->total_size);
stuge98c09aa2008-06-18 02:08:40 +0000161 if (!flash->probe && !force) {
stuge8ce3a3c2008-04-28 14:47:30 +0000162 printf_debug("failed! flashrom has no probe function for this flash chip.\n");
stuge8ce3a3c2008-04-28 14:47:30 +0000163 continue;
164 }
stepan782fb172007-04-06 11:58:03 +0000165
ollie5672ac62004-03-17 22:22:08 +0000166 size = flash->total_size * 1024;
stepan782fb172007-04-06 11:58:03 +0000167
hailfinger72d3b982009-05-09 07:27:23 +0000168 base = flashbase ? flashbase : (0xffffffff - size + 1);
hailfinger82719632009-05-16 21:22:56 +0000169 flash->virtual_memory = (chipaddr)programmer_map_flash_region("flash chip", base, size);
rminnich8d3ff912003-10-25 17:01:29 +0000170
stugec1e55fe2008-07-02 17:15:47 +0000171 if (force)
172 break;
stepanc98b80b2006-03-16 16:57:41 +0000173
stuge56300c32008-09-03 23:10:05 +0000174 if (flash->probe(flash) != 1)
175 goto notfound;
176
uwefa98ca12008-10-18 21:14:13 +0000177 if (first_flash == flashchips
178 || flash->model_id != GENERIC_DEVICE_ID)
stugec1e55fe2008-07-02 17:15:47 +0000179 break;
180
stuge56300c32008-09-03 23:10:05 +0000181notfound:
hailfinger82719632009-05-16 21:22:56 +0000182 programmer_unmap_flash_region((void *)flash->virtual_memory, size);
rminnich8d3ff912003-10-25 17:01:29 +0000183 }
uwebe4477b2007-08-23 16:08:21 +0000184
stugec1e55fe2008-07-02 17:15:47 +0000185 if (!flash || !flash->name)
186 return NULL;
187
188 printf("Found chip \"%s %s\" (%d KB) at physical address 0x%lx.\n",
stugeceb2afc2008-12-03 21:39:56 +0000189 flash->vendor, flash->name, flash->total_size, base);
stugec1e55fe2008-07-02 17:15:47 +0000190 return flash;
rminnich8d3ff912003-10-25 17:01:29 +0000191}
192
stepan193c9c22005-12-18 16:41:10 +0000193int verify_flash(struct flashchip *flash, uint8_t *buf)
rminnich8d3ff912003-10-25 17:01:29 +0000194{
stepanc98b80b2006-03-16 16:57:41 +0000195 int idx;
ollie5b621572004-03-20 16:46:10 +0000196 int total_size = flash->total_size * 1024;
hailfinger94586ba2008-01-22 15:19:01 +0000197 uint8_t *buf2 = (uint8_t *) calloc(total_size, sizeof(char));
hailfinger23060112009-05-08 12:49:03 +0000198 if (!flash->read) {
199 printf("FAILED!\n");
200 fprintf(stderr, "ERROR: flashrom has no read function for this flash chip.\n");
201 return 1;
202 } else
hailfinger94586ba2008-01-22 15:19:01 +0000203 flash->read(flash, buf2);
rminnich8d3ff912003-10-25 17:01:29 +0000204
uwefd2d0fe2007-10-17 23:55:15 +0000205 printf("Verifying flash... ");
uwef6641642007-05-09 10:17:44 +0000206
207 if (verbose)
208 printf("address: 0x00000000\b\b\b\b\b\b\b\b\b\b");
209
stepanc98b80b2006-03-16 16:57:41 +0000210 for (idx = 0; idx < total_size; idx++) {
uwef6641642007-05-09 10:17:44 +0000211 if (verbose && ((idx & 0xfff) == 0xfff))
stepanc98b80b2006-03-16 16:57:41 +0000212 printf("0x%08x", idx);
213
hailfinger94586ba2008-01-22 15:19:01 +0000214 if (*(buf2 + idx) != *(buf + idx)) {
stuge4eb58f12009-01-13 14:32:27 +0000215 if (verbose)
216 printf("0x%08x FAILED!", idx);
217 else
218 printf("FAILED at 0x%08x!", idx);
219 printf(" Expected=0x%02x, Read=0x%02x\n",
uwefa98ca12008-10-18 21:14:13 +0000220 *(buf + idx), *(buf2 + idx));
stepanc98b80b2006-03-16 16:57:41 +0000221 return 1;
ollie5672ac62004-03-17 22:22:08 +0000222 }
uwef6641642007-05-09 10:17:44 +0000223
224 if (verbose && ((idx & 0xfff) == 0xfff))
ollie5672ac62004-03-17 22:22:08 +0000225 printf("\b\b\b\b\b\b\b\b\b\b");
rminnich8d3ff912003-10-25 17:01:29 +0000226 }
uwef6641642007-05-09 10:17:44 +0000227 if (verbose)
stepanc98b80b2006-03-16 16:57:41 +0000228 printf("\b\b\b\b\b\b\b\b\b\b ");
uwef6641642007-05-09 10:17:44 +0000229
uwefd2d0fe2007-10-17 23:55:15 +0000230 printf("VERIFIED. \n");
uwebe4477b2007-08-23 16:08:21 +0000231
stepanc98b80b2006-03-16 16:57:41 +0000232 return 0;
rminnich8d3ff912003-10-25 17:01:29 +0000233}
234
hailfingerd219a232009-01-28 00:27:54 +0000235int read_flash(struct flashchip *flash, char *filename, unsigned int exclude_start_position, unsigned int exclude_end_position)
236{
237 unsigned long numbytes;
238 FILE *image;
239 unsigned long size = flash->total_size * 1024;
240 unsigned char *buf = calloc(size, sizeof(char));
241 if ((image = fopen(filename, "w")) == NULL) {
242 perror(filename);
243 exit(1);
244 }
245 printf("Reading flash... ");
hailfinger23060112009-05-08 12:49:03 +0000246 if (!flash->read) {
247 printf("FAILED!\n");
248 fprintf(stderr, "ERROR: flashrom has no read function for this flash chip.\n");
249 return 1;
250 } else
hailfingerd219a232009-01-28 00:27:54 +0000251 flash->read(flash, buf);
252
253 if (exclude_end_position - exclude_start_position > 0)
254 memset(buf + exclude_start_position, 0,
255 exclude_end_position - exclude_start_position);
256
257 numbytes = fwrite(buf, 1, size, image);
258 fclose(image);
259 printf("%s.\n", numbytes == size ? "done" : "FAILED");
260 if (numbytes != size)
261 return 1;
262 return 0;
263}
264
265int erase_flash(struct flashchip *flash)
266{
267 uint32_t erasedbytes;
268 unsigned long size = flash->total_size * 1024;
269 unsigned char *buf = calloc(size, sizeof(char));
270 printf("Erasing flash chip... ");
271 if (NULL == flash->erase) {
272 printf("FAILED!\n");
273 fprintf(stderr, "ERROR: flashrom has no erase function for this flash chip.\n");
274 return 1;
275 }
hailfinger1e9ee0f2009-05-08 17:15:15 +0000276 flash->erase(flash);
277
hailfinger23060112009-05-08 12:49:03 +0000278 if (!flash->read) {
279 printf("FAILED!\n");
280 fprintf(stderr, "ERROR: flashrom has no read function for this flash chip.\n");
281 return 1;
282 } else
hailfingerd219a232009-01-28 00:27:54 +0000283 flash->read(flash, buf);
hailfinger23060112009-05-08 12:49:03 +0000284
hailfingerd219a232009-01-28 00:27:54 +0000285 for (erasedbytes = 0; erasedbytes < size; erasedbytes++)
286 if (0xff != buf[erasedbytes]) {
287 printf("FAILED!\n");
288 fprintf(stderr, "ERROR at 0x%08x: Expected=0xff, Read=0x%02x\n",
289 erasedbytes, buf[erasedbytes]);
290 return 1;
291 }
292 printf("SUCCESS.\n");
293 return 0;
294}
295
uwee06bcf82009-04-24 16:17:41 +0000296#ifndef MAX
stugecae7e532008-12-06 01:37:09 +0000297#define MAX(a, b) ((a) > (b) ? (a) : (b))
uwee06bcf82009-04-24 16:17:41 +0000298#endif
stugecae7e532008-12-06 01:37:09 +0000299#define POS_PRINT(x) do { pos += strlen(x); printf(x); } while (0)
300
uwe16f99092008-03-12 11:54:51 +0000301void print_supported_chips(void)
302{
stugecae7e532008-12-06 01:37:09 +0000303 int okcol = 0, pos = 0;
304 struct flashchip *f;
uwe16f99092008-03-12 11:54:51 +0000305
stugecae7e532008-12-06 01:37:09 +0000306 for (f = flashchips; f->name != NULL; f++) {
307 if (GENERIC_DEVICE_ID == f->model_id)
308 continue;
309 okcol = MAX(okcol, strlen(f->vendor) + 1 + strlen(f->name));
310 }
311 okcol = (okcol + 7) & ~7;
uwe16f99092008-03-12 11:54:51 +0000312
stugecae7e532008-12-06 01:37:09 +0000313 POS_PRINT("Supported flash chips:");
314 while (pos < okcol) {
315 printf("\t");
316 pos += 8 - (pos % 8);
317 }
318 printf("Tested OK operations:\tKnown BAD operations:\n\n");
319
320 for (f = flashchips; f->name != NULL; f++) {
321 printf("%s %s", f->vendor, f->name);
322 pos = strlen(f->vendor) + 1 + strlen(f->name);
323 while (pos < okcol) {
324 printf("\t");
325 pos += 8 - (pos % 8);
326 }
327 if ((f->tested & TEST_OK_MASK)) {
328 if ((f->tested & TEST_OK_PROBE))
329 POS_PRINT("PROBE ");
330 if ((f->tested & TEST_OK_READ))
331 POS_PRINT("READ ");
332 if ((f->tested & TEST_OK_ERASE))
333 POS_PRINT("ERASE ");
334 if ((f->tested & TEST_OK_WRITE))
335 POS_PRINT("WRITE");
336 }
337 while (pos < okcol + 24) {
338 printf("\t");
339 pos += 8 - (pos % 8);
340 }
341 if ((f->tested & TEST_BAD_MASK)) {
342 if ((f->tested & TEST_BAD_PROBE))
343 printf("PROBE ");
344 if ((f->tested & TEST_BAD_READ))
345 printf("READ ");
346 if ((f->tested & TEST_BAD_ERASE))
347 printf("ERASE ");
348 if ((f->tested & TEST_BAD_WRITE))
349 printf("WRITE");
350 }
351 printf("\n");
352 }
uwe16f99092008-03-12 11:54:51 +0000353}
354
rminnich8d3ff912003-10-25 17:01:29 +0000355void usage(const char *name)
356{
uwefa98ca12008-10-18 21:14:13 +0000357 printf("usage: %s [-rwvEVfLhR] [-c chipname] [-s exclude_start]\n",
358 name);
stugeb9b411f2008-01-27 16:21:21 +0000359 printf(" [-e exclude_end] [-m [vendor:]part] [-l file.layout] [-i imagename] [file]\n");
hailfingerca7f01d2009-05-01 10:53:49 +0000360 printf("Please note that the command line interface for flashrom will "
361 "change before flashrom 1.0. Do not use flashrom in scripts or "
362 "other automated tools without checking that your flashrom "
363 "version won't interpret them in a totally different way.\n\n");
uwef6641642007-05-09 10:17:44 +0000364 printf
stugeb9b411f2008-01-27 16:21:21 +0000365 (" -r | --read: read flash and save into file\n"
366 " -w | --write: write file into flash\n"
367 " -v | --verify: verify flash against file\n"
368 " -E | --erase: erase flash device\n"
369 " -V | --verbose: more verbose output\n"
370 " -c | --chip <chipname>: probe only for specified flash chip\n"
371 " -s | --estart <addr>: exclude start position\n"
372 " -e | --eend <addr>: exclude end postion\n"
373 " -m | --mainboard <[vendor:]part>: override mainboard settings\n"
374 " -f | --force: force write without checking image\n"
375 " -l | --layout <file.layout>: read rom layout from file\n"
376 " -i | --image <name>: only flash image name from flash layout\n"
uwe16f99092008-03-12 11:54:51 +0000377 " -L | --list-supported: print supported devices\n"
hailfinger46bed042009-05-09 00:27:07 +0000378 " -p | --programmer <name>: specify the programmer device\n"
uwe16f99092008-03-12 11:54:51 +0000379 " -h | --help: print this help text\n"
stugeb9b411f2008-01-27 16:21:21 +0000380 " -R | --version: print the version (release)\n"
uwe16f99092008-03-12 11:54:51 +0000381 "\n" " If no file is specified, then all that happens"
uwef6641642007-05-09 10:17:44 +0000382 " is that flash info is dumped.\n\n");
ollie5672ac62004-03-17 22:22:08 +0000383 exit(1);
rminnich8d3ff912003-10-25 17:01:29 +0000384}
385
uwefdeca092008-01-21 15:24:22 +0000386void print_version(void)
387{
hailfingera5cfc5f2009-05-04 12:18:10 +0000388 printf("flashrom v%s\n", FLASHROM_VERSION);
uwefdeca092008-01-21 15:24:22 +0000389}
390
ollie5b621572004-03-20 16:46:10 +0000391int main(int argc, char *argv[])
rminnich8d3ff912003-10-25 17:01:29 +0000392{
ollie6a600992005-11-26 21:55:36 +0000393 uint8_t *buf;
stugebbcc2f12009-01-12 21:00:35 +0000394 unsigned long size, numbytes;
ollie5b621572004-03-20 16:46:10 +0000395 FILE *image;
stugec7354dc2008-05-08 00:31:44 +0000396 /* Probe for up to three flash chips. */
397 struct flashchip *flash, *flashes[3];
ollie5672ac62004-03-17 22:22:08 +0000398 int opt;
ollie6a600992005-11-26 21:55:36 +0000399 int option_index = 0;
stuge98c09aa2008-06-18 02:08:40 +0000400 int force = 0;
uwef6641642007-05-09 10:17:44 +0000401 int read_it = 0, write_it = 0, erase_it = 0, verify_it = 0;
uwe5f612c82009-05-16 23:42:17 +0000402 int list_supported = 0;
stugec7354dc2008-05-08 00:31:44 +0000403 int ret = 0, i;
ollie6a600992005-11-26 21:55:36 +0000404
uwef6641642007-05-09 10:17:44 +0000405 static struct option long_options[] = {
406 {"read", 0, 0, 'r'},
407 {"write", 0, 0, 'w'},
408 {"erase", 0, 0, 'E'},
409 {"verify", 0, 0, 'v'},
410 {"chip", 1, 0, 'c'},
411 {"estart", 1, 0, 's'},
412 {"eend", 1, 0, 'e'},
413 {"mainboard", 1, 0, 'm'},
414 {"verbose", 0, 0, 'V'},
415 {"force", 0, 0, 'f'},
416 {"layout", 1, 0, 'l'},
417 {"image", 1, 0, 'i'},
uwe16f99092008-03-12 11:54:51 +0000418 {"list-supported", 0, 0, 'L'},
hailfingerabe249e2009-05-08 17:43:22 +0000419 {"programmer", 1, 0, 'p'},
uwef6641642007-05-09 10:17:44 +0000420 {"help", 0, 0, 'h'},
uwefdeca092008-01-21 15:24:22 +0000421 {"version", 0, 0, 'R'},
uwef6641642007-05-09 10:17:44 +0000422 {0, 0, 0, 0}
ollie6a600992005-11-26 21:55:36 +0000423 };
uwef6641642007-05-09 10:17:44 +0000424
ollie5672ac62004-03-17 22:22:08 +0000425 char *filename = NULL;
rminnich8d3ff912003-10-25 17:01:29 +0000426
uwef6641642007-05-09 10:17:44 +0000427 unsigned int exclude_start_position = 0, exclude_end_position = 0; // [x,y)
428 char *tempstr = NULL, *tempstr2 = NULL;
yhlu5d4383a2004-10-20 05:07:16 +0000429
hailfingerf17c52f2009-05-07 00:59:53 +0000430 print_version();
431
yhlu5d4383a2004-10-20 05:07:16 +0000432 if (argc > 1) {
433 /* Yes, print them. */
434 int i;
uwef6641642007-05-09 10:17:44 +0000435 printf_debug("The arguments are:\n");
yhlu5d4383a2004-10-20 05:07:16 +0000436 for (i = 1; i < argc; ++i)
uwef6641642007-05-09 10:17:44 +0000437 printf_debug("%s\n", argv[i]);
yhlu5d4383a2004-10-20 05:07:16 +0000438 }
439
ollie5672ac62004-03-17 22:22:08 +0000440 setbuf(stdout, NULL);
hailfingerabe249e2009-05-08 17:43:22 +0000441 while ((opt = getopt_long(argc, argv, "rRwvVEfc:s:e:m:l:i:p:Lh",
uwef6641642007-05-09 10:17:44 +0000442 long_options, &option_index)) != EOF) {
ollie5672ac62004-03-17 22:22:08 +0000443 switch (opt) {
444 case 'r':
445 read_it = 1;
446 break;
447 case 'w':
448 write_it = 1;
449 break;
450 case 'v':
451 verify_it = 1;
452 break;
453 case 'c':
454 chip_to_probe = strdup(optarg);
455 break;
ollie077017b2004-03-18 20:27:33 +0000456 case 'V':
457 verbose = 1;
458 break;
ollie0eb62d62004-12-08 20:10:01 +0000459 case 'E':
460 erase_it = 1;
461 break;
yhlu5d4383a2004-10-20 05:07:16 +0000462 case 's':
463 tempstr = strdup(optarg);
uwef6641642007-05-09 10:17:44 +0000464 sscanf(tempstr, "%x", &exclude_start_position);
yhlu5d4383a2004-10-20 05:07:16 +0000465 break;
466 case 'e':
olliea4302802004-12-07 03:15:51 +0000467 tempstr = strdup(optarg);
uwef6641642007-05-09 10:17:44 +0000468 sscanf(tempstr, "%x", &exclude_end_position);
olliea4302802004-12-07 03:15:51 +0000469 break;
ollie6a600992005-11-26 21:55:36 +0000470 case 'm':
471 tempstr = strdup(optarg);
472 strtok(tempstr, ":");
uwef6641642007-05-09 10:17:44 +0000473 tempstr2 = strtok(NULL, ":");
ollie6a600992005-11-26 21:55:36 +0000474 if (tempstr2) {
uwef6641642007-05-09 10:17:44 +0000475 lb_vendor = tempstr;
476 lb_part = tempstr2;
ollie6a600992005-11-26 21:55:36 +0000477 } else {
stugeb9b411f2008-01-27 16:21:21 +0000478 lb_vendor = NULL;
479 lb_part = tempstr;
ollie6a600992005-11-26 21:55:36 +0000480 }
481 break;
482 case 'f':
uwef6641642007-05-09 10:17:44 +0000483 force = 1;
ollie6a600992005-11-26 21:55:36 +0000484 break;
485 case 'l':
uwef6641642007-05-09 10:17:44 +0000486 tempstr = strdup(optarg);
stepan14566ee2007-04-14 16:32:59 +0000487 if (read_romlayout(tempstr))
488 exit(1);
ollie6a600992005-11-26 21:55:36 +0000489 break;
490 case 'i':
uwef6641642007-05-09 10:17:44 +0000491 tempstr = strdup(optarg);
ollie6a600992005-11-26 21:55:36 +0000492 find_romentry(tempstr);
493 break;
uwe16f99092008-03-12 11:54:51 +0000494 case 'L':
uwe5f612c82009-05-16 23:42:17 +0000495 list_supported = 1;
uwe16f99092008-03-12 11:54:51 +0000496 break;
hailfingerabe249e2009-05-08 17:43:22 +0000497 case 'p':
498 if (strncmp(optarg, "internal", 8) == 0) {
499 programmer = PROGRAMMER_INTERNAL;
hailfingera9df33c2009-05-09 00:54:55 +0000500 } else if (strncmp(optarg, "dummy", 5) == 0) {
501 programmer = PROGRAMMER_DUMMY;
uwe0f5a3a22009-05-13 11:36:06 +0000502 } else if (strncmp(optarg, "nic3com", 7) == 0) {
503 programmer = PROGRAMMER_NIC3COM;
uwe6934c4a2009-05-14 18:57:26 +0000504 if (optarg[7] == '=')
uwea3a82c92009-05-15 17:02:34 +0000505 pcidev_bdf = strdup(optarg + 8);
hailfingerabe249e2009-05-08 17:43:22 +0000506 } else {
507 printf("Error: Unknown programmer.\n");
508 exit(1);
509 }
510 break;
uwefdeca092008-01-21 15:24:22 +0000511 case 'R':
hailfingerf17c52f2009-05-07 00:59:53 +0000512 /* print_version() is always called during startup. */
uwefdeca092008-01-21 15:24:22 +0000513 exit(0);
514 break;
ollie6a600992005-11-26 21:55:36 +0000515 case 'h':
ollie5672ac62004-03-17 22:22:08 +0000516 default:
517 usage(argv[0]);
518 break;
519 }
520 }
yhlu5d4383a2004-10-20 05:07:16 +0000521
uwe5f612c82009-05-16 23:42:17 +0000522 if (list_supported) {
523 print_supported_chips();
524 print_supported_chipsets();
525 print_supported_boards();
526 printf("\nSupported PCI devices flashrom can use "
527 "as programmer:\n\n");
528 print_supported_pcidevs(nics_3com);
529 exit(0);
530 }
531
ollie5672ac62004-03-17 22:22:08 +0000532 if (read_it && write_it) {
uwe017911e2008-05-22 22:47:04 +0000533 printf("Error: -r and -w are mutually exclusive.\n");
ollie5672ac62004-03-17 22:22:08 +0000534 usage(argv[0]);
535 }
rminnich8d3ff912003-10-25 17:01:29 +0000536
ollie5672ac62004-03-17 22:22:08 +0000537 if (optind < argc)
538 filename = argv[optind++];
rminnich8d3ff912003-10-25 17:01:29 +0000539
hailfingerabe249e2009-05-08 17:43:22 +0000540 ret = programmer_init();
stepan927d4e22007-04-04 22:45:58 +0000541
ollie5672ac62004-03-17 22:22:08 +0000542 myusec_calibrate_delay();
ollie6a600992005-11-26 21:55:36 +0000543
stugec7354dc2008-05-08 00:31:44 +0000544 for (i = 0; i < ARRAY_SIZE(flashes); i++) {
uwefa98ca12008-10-18 21:14:13 +0000545 flashes[i] =
546 probe_flash(i ? flashes[i - 1] + 1 : flashchips, 0);
stugec7354dc2008-05-08 00:31:44 +0000547 if (!flashes[i])
548 for (i++; i < ARRAY_SIZE(flashes); i++)
549 flashes[i] = NULL;
550 }
551
552 if (flashes[1]) {
553 printf("Multiple flash chips were detected:");
554 for (i = 0; i < ARRAY_SIZE(flashes) && flashes[i]; i++)
555 printf(" %s", flashes[i]->name);
556 printf("\nPlease specify which chip to use with the -c <chipname> option.\n");
557 exit(1);
558 } else if (!flashes[0]) {
ollie6a600992005-11-26 21:55:36 +0000559 printf("No EEPROM/flash device found.\n");
stuge98c09aa2008-06-18 02:08:40 +0000560 if (!force || !chip_to_probe) {
561 printf("If you know which flash chip you have, and if this version of flashrom\n");
562 printf("supports a similar flash chip, you can try to force read your chip. Run:\n");
563 printf("flashrom -f -r -c similar_supported_flash_chip filename\n");
564 printf("\n");
565 printf("Note: flashrom can never write when the flash chip isn't found automatically.\n");
566 }
567 if (force && read_it && chip_to_probe) {
568 printf("Force read (-f -r -c) requested, forcing chip probe success:\n");
569 flashes[0] = probe_flash(flashchips, 1);
570 if (!flashes[0]) {
571 printf("flashrom does not support a flash chip named '%s'.\n", chip_to_probe);
572 printf("Run flashrom -L to view the hardware supported in this flashrom version.\n");
573 exit(1);
574 }
stuged88bbe52008-10-10 20:43:17 +0000575 if (!filename) {
576 printf("Error: No filename specified.\n");
577 exit(1);
578 }
stuge98c09aa2008-06-18 02:08:40 +0000579 size = flashes[0]->total_size * 1024;
580 buf = (uint8_t *) calloc(size, sizeof(char));
581
582 if ((image = fopen(filename, "w")) == NULL) {
583 perror(filename);
584 exit(1);
585 }
uwe17efbed2008-11-28 21:36:51 +0000586 printf("Force reading flash... ");
hailfinger23060112009-05-08 12:49:03 +0000587 if (!flashes[0]->read) {
588 printf("FAILED!\n");
589 fprintf(stderr, "ERROR: flashrom has no read function for this flash chip.\n");
590 return 1;
591 } else
stuge98c09aa2008-06-18 02:08:40 +0000592 flashes[0]->read(flashes[0], buf);
593
594 if (exclude_end_position - exclude_start_position > 0)
595 memset(buf + exclude_start_position, 0,
uwefa98ca12008-10-18 21:14:13 +0000596 exclude_end_position -
597 exclude_start_position);
stuge98c09aa2008-06-18 02:08:40 +0000598
stugebbcc2f12009-01-12 21:00:35 +0000599 numbytes = fwrite(buf, 1, size, image);
stuge98c09aa2008-06-18 02:08:40 +0000600 fclose(image);
stugebbcc2f12009-01-12 21:00:35 +0000601 printf("%s.\n", numbytes == size ? "done" : "FAILED");
stuge98c09aa2008-06-18 02:08:40 +0000602 free(buf);
stugebbcc2f12009-01-12 21:00:35 +0000603 return numbytes != size;
stuge98c09aa2008-06-18 02:08:40 +0000604 }
stepan9cbfb252007-10-04 06:26:41 +0000605 // FIXME: flash writes stay enabled!
ollie5672ac62004-03-17 22:22:08 +0000606 exit(1);
607 }
rminnich8d3ff912003-10-25 17:01:29 +0000608
stugec7354dc2008-05-08 00:31:44 +0000609 flash = flashes[0];
610
stuge9cd64bd2008-05-03 04:34:37 +0000611 if (TEST_OK_MASK != (flash->tested & TEST_OK_MASK)) {
612 printf("===\n");
613 if (flash->tested & TEST_BAD_MASK) {
614 printf("This flash part has status NOT WORKING for operations:");
615 if (flash->tested & TEST_BAD_PROBE)
616 printf(" PROBE");
617 if (flash->tested & TEST_BAD_READ)
618 printf(" READ");
619 if (flash->tested & TEST_BAD_ERASE)
620 printf(" ERASE");
621 if (flash->tested & TEST_BAD_WRITE)
622 printf(" WRITE");
623 printf("\n");
hailfinger6aaf46a2008-11-28 23:45:27 +0000624 }
625 if ((!(flash->tested & TEST_BAD_PROBE) && !(flash->tested & TEST_OK_PROBE)) ||
626 (!(flash->tested & TEST_BAD_READ) && !(flash->tested & TEST_OK_READ)) ||
627 (!(flash->tested & TEST_BAD_ERASE) && !(flash->tested & TEST_OK_ERASE)) ||
628 (!(flash->tested & TEST_BAD_WRITE) && !(flash->tested & TEST_OK_WRITE))) {
stuge9cd64bd2008-05-03 04:34:37 +0000629 printf("This flash part has status UNTESTED for operations:");
hailfinger6aaf46a2008-11-28 23:45:27 +0000630 if (!(flash->tested & TEST_BAD_PROBE) && !(flash->tested & TEST_OK_PROBE))
stuge9cd64bd2008-05-03 04:34:37 +0000631 printf(" PROBE");
hailfinger6aaf46a2008-11-28 23:45:27 +0000632 if (!(flash->tested & TEST_BAD_READ) && !(flash->tested & TEST_OK_READ))
stuge9cd64bd2008-05-03 04:34:37 +0000633 printf(" READ");
hailfinger6aaf46a2008-11-28 23:45:27 +0000634 if (!(flash->tested & TEST_BAD_ERASE) && !(flash->tested & TEST_OK_ERASE))
stuge9cd64bd2008-05-03 04:34:37 +0000635 printf(" ERASE");
hailfinger6aaf46a2008-11-28 23:45:27 +0000636 if (!(flash->tested & TEST_BAD_WRITE) && !(flash->tested & TEST_OK_WRITE))
stuge9cd64bd2008-05-03 04:34:37 +0000637 printf(" WRITE");
638 printf("\n");
639 }
640 printf("Please email a report to flashrom@coreboot.org if any of the above operations\n");
641 printf("work correctly for you with this flash part. Please include the full output\n");
642 printf("from the program, including chipset found. Thank you for your help!\n");
643 printf("===\n");
644 }
ollie6a600992005-11-26 21:55:36 +0000645
stepan9cbfb252007-10-04 06:26:41 +0000646 if (!(read_it | write_it | verify_it | erase_it)) {
647 printf("No operations were specified.\n");
648 // FIXME: flash writes stay enabled!
649 exit(1);
650 }
651
ollie0eb62d62004-12-08 20:10:01 +0000652 if (!filename && !erase_it) {
stepan9cbfb252007-10-04 06:26:41 +0000653 printf("Error: No filename specified.\n");
654 // FIXME: flash writes stay enabled!
655 exit(1);
ollie5672ac62004-03-17 22:22:08 +0000656 }
ollie5672ac62004-03-17 22:22:08 +0000657
ollie6a600992005-11-26 21:55:36 +0000658 size = flash->total_size * 1024;
659 buf = (uint8_t *) calloc(size, sizeof(char));
uwef6641642007-05-09 10:17:44 +0000660
ollie0eb62d62004-12-08 20:10:01 +0000661 if (erase_it) {
hailfingerd219a232009-01-28 00:27:54 +0000662 if (erase_flash(flash))
stuge8ce3a3c2008-04-28 14:47:30 +0000663 return 1;
ollie0eb62d62004-12-08 20:10:01 +0000664 } else if (read_it) {
hailfingerd219a232009-01-28 00:27:54 +0000665 if (read_flash(flash, filename, exclude_start_position, exclude_end_position))
stugebbcc2f12009-01-12 21:00:35 +0000666 return 1;
ollie5672ac62004-03-17 22:22:08 +0000667 } else {
stepan1da96c02006-11-21 23:48:51 +0000668 struct stat image_stat;
669
ollie5b621572004-03-20 16:46:10 +0000670 if ((image = fopen(filename, "r")) == NULL) {
ollie5672ac62004-03-17 22:22:08 +0000671 perror(filename);
672 exit(1);
673 }
stepan1da96c02006-11-21 23:48:51 +0000674 if (fstat(fileno(image), &image_stat) != 0) {
675 perror(filename);
676 exit(1);
677 }
uwef6641642007-05-09 10:17:44 +0000678 if (image_stat.st_size != flash->total_size * 1024) {
uwe017911e2008-05-22 22:47:04 +0000679 fprintf(stderr, "Error: Image size doesn't match\n");
stepan1da96c02006-11-21 23:48:51 +0000680 exit(1);
681 }
682
stugebbcc2f12009-01-12 21:00:35 +0000683 numbytes = fread(buf, 1, size, image);
stuge98c09aa2008-06-18 02:08:40 +0000684 show_id(buf, size, force);
ollie5672ac62004-03-17 22:22:08 +0000685 fclose(image);
stugebbcc2f12009-01-12 21:00:35 +0000686 if (numbytes != size) {
687 fprintf(stderr, "Error: Failed to read file. Got %ld bytes, wanted %ld!\n", numbytes, size);
688 return 1;
689 }
ollie5672ac62004-03-17 22:22:08 +0000690 }
691
ollie6a600992005-11-26 21:55:36 +0000692 /* exclude range stuff. Nice idea, but at the moment it is only
693 * supported in hardware by the pm49fl004 chips.
694 * Instead of implementing this for all chips I suggest advancing
695 * it to the rom layout feature below and drop exclude range
696 * completely once all flash chips can do rom layouts. stepan
697 */
uwef6641642007-05-09 10:17:44 +0000698
ollie6a600992005-11-26 21:55:36 +0000699 // ////////////////////////////////////////////////////////////
hailfinger23060112009-05-08 12:49:03 +0000700 /* FIXME: This memcpy will not work for SPI nor external flashers.
701 * Convert to chip_readb.
702 */
olliea4302802004-12-07 03:15:51 +0000703 if (exclude_end_position - exclude_start_position > 0)
uwef6641642007-05-09 10:17:44 +0000704 memcpy(buf + exclude_start_position,
uwecdf59ac2007-05-24 19:17:29 +0000705 (const char *)flash->virtual_memory +
706 exclude_start_position,
uwef6641642007-05-09 10:17:44 +0000707 exclude_end_position - exclude_start_position);
olliea4302802004-12-07 03:15:51 +0000708
uwef6641642007-05-09 10:17:44 +0000709 exclude_start_page = exclude_start_position / flash->page_size;
710 if ((exclude_start_position % flash->page_size) != 0) {
olliea4302802004-12-07 03:15:51 +0000711 exclude_start_page++;
712 }
uwef6641642007-05-09 10:17:44 +0000713 exclude_end_page = exclude_end_position / flash->page_size;
ollie6a600992005-11-26 21:55:36 +0000714 // ////////////////////////////////////////////////////////////
yhlu5d4383a2004-10-20 05:07:16 +0000715
ollie6a600992005-11-26 21:55:36 +0000716 // This should be moved into each flash part's code to do it
717 // cleanly. This does the job.
stepan7cd945e2007-05-23 17:20:56 +0000718 handle_romentries(buf, (uint8_t *) flash->virtual_memory);
uwef6641642007-05-09 10:17:44 +0000719
ollie6a600992005-11-26 21:55:36 +0000720 // ////////////////////////////////////////////////////////////
uwef6641642007-05-09 10:17:44 +0000721
stuge8ce3a3c2008-04-28 14:47:30 +0000722 if (write_it) {
723 if (!flash->write) {
724 fprintf(stderr, "Error: flashrom has no write function for this flash chip.\n");
725 return 1;
726 }
stepan83eca252006-01-04 16:42:57 +0000727 ret |= flash->write(flash, buf);
stuge8ce3a3c2008-04-28 14:47:30 +0000728 }
ollie6a600992005-11-26 21:55:36 +0000729
ollie5672ac62004-03-17 22:22:08 +0000730 if (verify_it)
stepan83eca252006-01-04 16:42:57 +0000731 ret |= verify_flash(flash, buf);
ollie6a600992005-11-26 21:55:36 +0000732
hailfingerabe249e2009-05-08 17:43:22 +0000733 programmer_shutdown();
734
stepan83eca252006-01-04 16:42:57 +0000735 return ret;
rminnich8d3ff912003-10-25 17:01:29 +0000736}