blob: cd16d71737d3c10cd1aa3b2b1e9e9904838d3580 [file] [log] [blame]
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +00001/*
Uwe Hermannd1107642007-08-29 17:52:32 +00002 * This file is part of the flashrom project.
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +00003 *
Uwe Hermannd22a1d42007-09-09 20:21:05 +00004 * Copyright (C) 2000 Silicon Integrated System Corporation
5 * Copyright (C) 2004 Tyan Corp <yhlu@tyan.com>
Stefan Reinauer566ce1b2008-08-02 15:13:58 +00006 * Copyright (C) 2005-2008 coresystems GmbH
Carl-Daniel Hailfinger03b4e712009-05-08 12:49:03 +00007 * Copyright (C) 2008,2009 Carl-Daniel Hailfinger
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +00008 *
Uwe Hermannd1107642007-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.
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +000013 *
Uwe Hermannd1107642007-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.
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +000018 *
Uwe Hermannd1107642007-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
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +000022 */
23
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +000024#include <fcntl.h>
Stefan Reinauer018aca82006-11-21 23:48:51 +000025#include <sys/types.h>
26#include <sys/stat.h>
Ronald G. Minnichceec4202003-07-25 04:37:41 +000027#include <string.h>
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000028#include <stdlib.h>
Ollie Lho184a4042005-11-26 21:55:36 +000029#include <getopt.h>
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +000030#include "flash.h"
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +000031
Ronald G. Minnichceec4202003-07-25 04:37:41 +000032char *chip_to_probe = NULL;
Stefan Reinauere3705282005-12-18 16:41:10 +000033int exclude_start_page, exclude_end_page;
Peter Stuge7ffbc6f2008-06-18 02:08:40 +000034int verbose = 0;
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +000035int programmer = PROGRAMMER_INTERNAL;
Stefan Reinauer70385642007-04-06 11:58:03 +000036
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +000037const struct programmer_entry programmer_table[] = {
38 {
Carl-Daniel Hailfinger1e334e62009-05-11 15:46:43 +000039 .init = internal_init,
40 .shutdown = internal_shutdown,
Carl-Daniel Hailfinger1455b2b2009-05-11 14:13:25 +000041 .map_flash_region = physmap,
42 .unmap_flash_region = physunmap,
Carl-Daniel Hailfinger1e334e62009-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,
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +000049 },
Luc Verhaegen8e3a6002007-04-04 22:45:58 +000050
Carl-Daniel Hailfingerc3129202009-05-09 00:54:55 +000051 {
Carl-Daniel Hailfinger1e334e62009-05-11 15:46:43 +000052 .init = dummy_init,
53 .shutdown = dummy_shutdown,
Carl-Daniel Hailfinger1455b2b2009-05-11 14:13:25 +000054 .map_flash_region = dummy_map,
55 .unmap_flash_region = dummy_unmap,
Carl-Daniel Hailfinger1e334e62009-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,
Carl-Daniel Hailfingerc3129202009-05-09 00:54:55 +000062 },
63
Uwe Hermannb4dcb712009-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,
Carl-Daniel Hailfinger9ee10772009-05-16 01:23:55 +000070 .chip_readw = fallback_chip_readw,
71 .chip_readl = fallback_chip_readl,
Uwe Hermannb4dcb712009-05-13 11:36:06 +000072 .chip_writeb = nic3com_chip_writeb,
Carl-Daniel Hailfinger9ee10772009-05-16 01:23:55 +000073 .chip_writew = fallback_chip_writew,
74 .chip_writel = fallback_chip_writel,
Uwe Hermannb4dcb712009-05-13 11:36:06 +000075 },
76
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +000077 {},
78};
Luc Verhaegen8e3a6002007-04-04 22:45:58 +000079
Uwe Hermann09e04f72009-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
Peter Stuge776d2022009-01-26 00:39:57 +0000132void map_flash_registers(struct flashchip *flash)
Stefan Reinauerff4f1972007-05-24 08:48:10 +0000133{
Stefan Reinauerff4f1972007-05-24 08:48:10 +0000134 size_t size = flash->total_size * 1024;
Carl-Daniel Hailfingerd0fc9462009-05-11 14:01:17 +0000135 /* Flash registers live 4 MByte below the flash. */
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000136 flash->virtual_registers = (chipaddr)programmer_map_flash_region("flash chip registers", (0xFFFFFFFF - 0x400000 - size + 1), size);
Stefan Reinauerff4f1972007-05-24 08:48:10 +0000137}
138
Carl-Daniel Hailfinger03b4e712009-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
Peter Stuge483b8f02008-09-03 23:10:05 +0000151struct flashchip *probe_flash(struct flashchip *first_flash, int force)
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000152{
Peter Stuge483b8f02008-09-03 23:10:05 +0000153 struct flashchip *flash;
Peter Stuge7ccce542008-12-03 23:36:48 +0000154 unsigned long base = 0, size;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000155
Peter Stuge483b8f02008-09-03 23:10:05 +0000156 for (flash = first_flash; flash && flash->name; flash++) {
Peter Stuge27c3e2d2008-07-02 17:15:47 +0000157 if (chip_to_probe && strcmp(flash->name, chip_to_probe) != 0)
Ollie Lhocbbf1252004-03-17 22:22:08 +0000158 continue;
Stefan Reinauerac378972008-03-17 22:59:40 +0000159 printf_debug("Probing for %s %s, %d KB: ",
160 flash->vendor, flash->name, flash->total_size);
Peter Stuge7ffbc6f2008-06-18 02:08:40 +0000161 if (!flash->probe && !force) {
Peter Stugef31104c2008-04-28 14:47:30 +0000162 printf_debug("failed! flashrom has no probe function for this flash chip.\n");
Peter Stugef31104c2008-04-28 14:47:30 +0000163 continue;
164 }
Stefan Reinauer70385642007-04-06 11:58:03 +0000165
Ollie Lhocbbf1252004-03-17 22:22:08 +0000166 size = flash->total_size * 1024;
Stefan Reinauer70385642007-04-06 11:58:03 +0000167
Carl-Daniel Hailfinger97d6b092009-05-09 07:27:23 +0000168 base = flashbase ? flashbase : (0xffffffff - size + 1);
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000169 flash->virtual_memory = (chipaddr)programmer_map_flash_region("flash chip", base, size);
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000170
Peter Stuge27c3e2d2008-07-02 17:15:47 +0000171 if (force)
172 break;
Stefan Reinauerfcb63682006-03-16 16:57:41 +0000173
Peter Stuge483b8f02008-09-03 23:10:05 +0000174 if (flash->probe(flash) != 1)
175 goto notfound;
176
Uwe Hermann394131e2008-10-18 21:14:13 +0000177 if (first_flash == flashchips
178 || flash->model_id != GENERIC_DEVICE_ID)
Peter Stuge27c3e2d2008-07-02 17:15:47 +0000179 break;
180
Peter Stuge483b8f02008-09-03 23:10:05 +0000181notfound:
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000182 programmer_unmap_flash_region((void *)flash->virtual_memory, size);
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000183 }
Uwe Hermannffec5f32007-08-23 16:08:21 +0000184
Peter Stuge27c3e2d2008-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",
Peter Stuge73bdb922008-12-03 21:39:56 +0000189 flash->vendor, flash->name, flash->total_size, base);
Peter Stuge27c3e2d2008-07-02 17:15:47 +0000190 return flash;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000191}
192
Stefan Reinauere3705282005-12-18 16:41:10 +0000193int verify_flash(struct flashchip *flash, uint8_t *buf)
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000194{
Stefan Reinauerfcb63682006-03-16 16:57:41 +0000195 int idx;
Ollie Lho761bf1b2004-03-20 16:46:10 +0000196 int total_size = flash->total_size * 1024;
Carl-Daniel Hailfingerd7b5bf32008-01-22 15:19:01 +0000197 uint8_t *buf2 = (uint8_t *) calloc(total_size, sizeof(char));
Carl-Daniel Hailfinger03b4e712009-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
Carl-Daniel Hailfingerd7b5bf32008-01-22 15:19:01 +0000203 flash->read(flash, buf2);
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000204
Uwe Hermanna502dce2007-10-17 23:55:15 +0000205 printf("Verifying flash... ");
Uwe Hermanna7e05482007-05-09 10:17:44 +0000206
207 if (verbose)
208 printf("address: 0x00000000\b\b\b\b\b\b\b\b\b\b");
209
Stefan Reinauerfcb63682006-03-16 16:57:41 +0000210 for (idx = 0; idx < total_size; idx++) {
Uwe Hermanna7e05482007-05-09 10:17:44 +0000211 if (verbose && ((idx & 0xfff) == 0xfff))
Stefan Reinauerfcb63682006-03-16 16:57:41 +0000212 printf("0x%08x", idx);
213
Carl-Daniel Hailfingerd7b5bf32008-01-22 15:19:01 +0000214 if (*(buf2 + idx) != *(buf + idx)) {
Peter Stugef9ad0bb2009-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",
Uwe Hermann394131e2008-10-18 21:14:13 +0000220 *(buf + idx), *(buf2 + idx));
Stefan Reinauerfcb63682006-03-16 16:57:41 +0000221 return 1;
Ollie Lhocbbf1252004-03-17 22:22:08 +0000222 }
Uwe Hermanna7e05482007-05-09 10:17:44 +0000223
224 if (verbose && ((idx & 0xfff) == 0xfff))
Ollie Lhocbbf1252004-03-17 22:22:08 +0000225 printf("\b\b\b\b\b\b\b\b\b\b");
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000226 }
Uwe Hermanna7e05482007-05-09 10:17:44 +0000227 if (verbose)
Stefan Reinauerfcb63682006-03-16 16:57:41 +0000228 printf("\b\b\b\b\b\b\b\b\b\b ");
Uwe Hermanna7e05482007-05-09 10:17:44 +0000229
Uwe Hermanna502dce2007-10-17 23:55:15 +0000230 printf("VERIFIED. \n");
Uwe Hermannffec5f32007-08-23 16:08:21 +0000231
Stefan Reinauerfcb63682006-03-16 16:57:41 +0000232 return 0;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000233}
234
Carl-Daniel Hailfinger7314cc32009-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... ");
Carl-Daniel Hailfinger03b4e712009-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
Carl-Daniel Hailfinger7314cc32009-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 }
Carl-Daniel Hailfingerf160a122009-05-08 17:15:15 +0000276 flash->erase(flash);
277
Carl-Daniel Hailfinger03b4e712009-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
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +0000283 flash->read(flash, buf);
Carl-Daniel Hailfinger03b4e712009-05-08 12:49:03 +0000284
Carl-Daniel Hailfinger7314cc32009-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
Uwe Hermannad216bf2009-04-24 16:17:41 +0000296#ifndef MAX
Peter Stugef0ef27b2008-12-06 01:37:09 +0000297#define MAX(a, b) ((a) > (b) ? (a) : (b))
Uwe Hermannad216bf2009-04-24 16:17:41 +0000298#endif
Peter Stugef0ef27b2008-12-06 01:37:09 +0000299#define POS_PRINT(x) do { pos += strlen(x); printf(x); } while (0)
300
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000301void print_supported_chips(void)
302{
Peter Stugef0ef27b2008-12-06 01:37:09 +0000303 int okcol = 0, pos = 0;
304 struct flashchip *f;
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000305
Peter Stugef0ef27b2008-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;
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000312
Peter Stugef0ef27b2008-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 }
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000353}
354
Ronald G. Minniche5559572003-03-28 03:29:43 +0000355void usage(const char *name)
356{
Uwe Hermann394131e2008-10-18 21:14:13 +0000357 printf("usage: %s [-rwvEVfLhR] [-c chipname] [-s exclude_start]\n",
358 name);
Peter Stuge6b53fed2008-01-27 16:21:21 +0000359 printf(" [-e exclude_end] [-m [vendor:]part] [-l file.layout] [-i imagename] [file]\n");
Carl-Daniel Hailfinger5de93412009-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");
Uwe Hermanna7e05482007-05-09 10:17:44 +0000364 printf
Peter Stuge6b53fed2008-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"
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000377 " -L | --list-supported: print supported devices\n"
Carl-Daniel Hailfingerce986772009-05-09 00:27:07 +0000378 " -p | --programmer <name>: specify the programmer device\n"
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000379 " -h | --help: print this help text\n"
Peter Stuge6b53fed2008-01-27 16:21:21 +0000380 " -R | --version: print the version (release)\n"
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000381 "\n" " If no file is specified, then all that happens"
Uwe Hermanna7e05482007-05-09 10:17:44 +0000382 " is that flash info is dumped.\n\n");
Ollie Lhocbbf1252004-03-17 22:22:08 +0000383 exit(1);
Ronald G. Minniche5559572003-03-28 03:29:43 +0000384}
385
Bernhard Walle201bde32008-01-21 15:24:22 +0000386void print_version(void)
387{
Carl-Daniel Hailfinger3f8f9b62009-05-04 12:18:10 +0000388 printf("flashrom v%s\n", FLASHROM_VERSION);
Bernhard Walle201bde32008-01-21 15:24:22 +0000389}
390
Ollie Lho761bf1b2004-03-20 16:46:10 +0000391int main(int argc, char *argv[])
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000392{
Ollie Lho184a4042005-11-26 21:55:36 +0000393 uint8_t *buf;
Peter Stuge1fec0f32009-01-12 21:00:35 +0000394 unsigned long size, numbytes;
Ollie Lho761bf1b2004-03-20 16:46:10 +0000395 FILE *image;
Claus Gindhart2fd11d62008-05-08 00:31:44 +0000396 /* Probe for up to three flash chips. */
397 struct flashchip *flash, *flashes[3];
Ollie Lhocbbf1252004-03-17 22:22:08 +0000398 int opt;
Ollie Lho184a4042005-11-26 21:55:36 +0000399 int option_index = 0;
Peter Stuge7ffbc6f2008-06-18 02:08:40 +0000400 int force = 0;
Uwe Hermanna7e05482007-05-09 10:17:44 +0000401 int read_it = 0, write_it = 0, erase_it = 0, verify_it = 0;
Claus Gindhart2fd11d62008-05-08 00:31:44 +0000402 int ret = 0, i;
Ollie Lho184a4042005-11-26 21:55:36 +0000403
Uwe Hermanna7e05482007-05-09 10:17:44 +0000404 static struct option long_options[] = {
405 {"read", 0, 0, 'r'},
406 {"write", 0, 0, 'w'},
407 {"erase", 0, 0, 'E'},
408 {"verify", 0, 0, 'v'},
409 {"chip", 1, 0, 'c'},
410 {"estart", 1, 0, 's'},
411 {"eend", 1, 0, 'e'},
412 {"mainboard", 1, 0, 'm'},
413 {"verbose", 0, 0, 'V'},
414 {"force", 0, 0, 'f'},
415 {"layout", 1, 0, 'l'},
416 {"image", 1, 0, 'i'},
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000417 {"list-supported", 0, 0, 'L'},
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +0000418 {"programmer", 1, 0, 'p'},
Uwe Hermanna7e05482007-05-09 10:17:44 +0000419 {"help", 0, 0, 'h'},
Bernhard Walle201bde32008-01-21 15:24:22 +0000420 {"version", 0, 0, 'R'},
Uwe Hermanna7e05482007-05-09 10:17:44 +0000421 {0, 0, 0, 0}
Ollie Lho184a4042005-11-26 21:55:36 +0000422 };
Uwe Hermanna7e05482007-05-09 10:17:44 +0000423
Ollie Lhocbbf1252004-03-17 22:22:08 +0000424 char *filename = NULL;
Ronald G. Minnichceec4202003-07-25 04:37:41 +0000425
Uwe Hermanna7e05482007-05-09 10:17:44 +0000426 unsigned int exclude_start_position = 0, exclude_end_position = 0; // [x,y)
427 char *tempstr = NULL, *tempstr2 = NULL;
Yinghai Luad8ffd22004-10-20 05:07:16 +0000428
Carl-Daniel Hailfinger259fa012009-05-07 00:59:53 +0000429 print_version();
430
Yinghai Luad8ffd22004-10-20 05:07:16 +0000431 if (argc > 1) {
432 /* Yes, print them. */
433 int i;
Uwe Hermanna7e05482007-05-09 10:17:44 +0000434 printf_debug("The arguments are:\n");
Yinghai Luad8ffd22004-10-20 05:07:16 +0000435 for (i = 1; i < argc; ++i)
Uwe Hermanna7e05482007-05-09 10:17:44 +0000436 printf_debug("%s\n", argv[i]);
Yinghai Luad8ffd22004-10-20 05:07:16 +0000437 }
438
Ollie Lhocbbf1252004-03-17 22:22:08 +0000439 setbuf(stdout, NULL);
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +0000440 while ((opt = getopt_long(argc, argv, "rRwvVEfc:s:e:m:l:i:p:Lh",
Uwe Hermanna7e05482007-05-09 10:17:44 +0000441 long_options, &option_index)) != EOF) {
Ollie Lhocbbf1252004-03-17 22:22:08 +0000442 switch (opt) {
443 case 'r':
444 read_it = 1;
445 break;
446 case 'w':
447 write_it = 1;
448 break;
449 case 'v':
450 verify_it = 1;
451 break;
452 case 'c':
453 chip_to_probe = strdup(optarg);
454 break;
Ollie Lho789ad3d2004-03-18 20:27:33 +0000455 case 'V':
456 verbose = 1;
457 break;
Ollie Lhoefa28582004-12-08 20:10:01 +0000458 case 'E':
459 erase_it = 1;
460 break;
Yinghai Luad8ffd22004-10-20 05:07:16 +0000461 case 's':
462 tempstr = strdup(optarg);
Uwe Hermanna7e05482007-05-09 10:17:44 +0000463 sscanf(tempstr, "%x", &exclude_start_position);
Yinghai Luad8ffd22004-10-20 05:07:16 +0000464 break;
465 case 'e':
Ollie Lho98bea8a2004-12-07 03:15:51 +0000466 tempstr = strdup(optarg);
Uwe Hermanna7e05482007-05-09 10:17:44 +0000467 sscanf(tempstr, "%x", &exclude_end_position);
Ollie Lho98bea8a2004-12-07 03:15:51 +0000468 break;
Ollie Lho184a4042005-11-26 21:55:36 +0000469 case 'm':
470 tempstr = strdup(optarg);
471 strtok(tempstr, ":");
Uwe Hermanna7e05482007-05-09 10:17:44 +0000472 tempstr2 = strtok(NULL, ":");
Ollie Lho184a4042005-11-26 21:55:36 +0000473 if (tempstr2) {
Uwe Hermanna7e05482007-05-09 10:17:44 +0000474 lb_vendor = tempstr;
475 lb_part = tempstr2;
Ollie Lho184a4042005-11-26 21:55:36 +0000476 } else {
Peter Stuge6b53fed2008-01-27 16:21:21 +0000477 lb_vendor = NULL;
478 lb_part = tempstr;
Ollie Lho184a4042005-11-26 21:55:36 +0000479 }
480 break;
481 case 'f':
Uwe Hermanna7e05482007-05-09 10:17:44 +0000482 force = 1;
Ollie Lho184a4042005-11-26 21:55:36 +0000483 break;
484 case 'l':
Uwe Hermanna7e05482007-05-09 10:17:44 +0000485 tempstr = strdup(optarg);
Stefan Reinauer0a05d672007-04-14 16:32:59 +0000486 if (read_romlayout(tempstr))
487 exit(1);
Ollie Lho184a4042005-11-26 21:55:36 +0000488 break;
489 case 'i':
Uwe Hermanna7e05482007-05-09 10:17:44 +0000490 tempstr = strdup(optarg);
Ollie Lho184a4042005-11-26 21:55:36 +0000491 find_romentry(tempstr);
492 break;
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000493 case 'L':
494 print_supported_chips();
495 print_supported_chipsets();
496 print_supported_boards();
Uwe Hermann515ab3d2009-05-15 17:02:34 +0000497 printf("\nSupported PCI devices flashrom can use "
498 "as programmer:\n\n");
499 print_supported_pcidevs(nics_3com);
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000500 exit(0);
501 break;
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +0000502 case 'p':
503 if (strncmp(optarg, "internal", 8) == 0) {
504 programmer = PROGRAMMER_INTERNAL;
Carl-Daniel Hailfingerc3129202009-05-09 00:54:55 +0000505 } else if (strncmp(optarg, "dummy", 5) == 0) {
506 programmer = PROGRAMMER_DUMMY;
Uwe Hermannb4dcb712009-05-13 11:36:06 +0000507 } else if (strncmp(optarg, "nic3com", 7) == 0) {
508 programmer = PROGRAMMER_NIC3COM;
Christian Ruppert0cdb0312009-05-14 18:57:26 +0000509 if (optarg[7] == '=')
Uwe Hermann515ab3d2009-05-15 17:02:34 +0000510 pcidev_bdf = strdup(optarg + 8);
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +0000511 } else {
512 printf("Error: Unknown programmer.\n");
513 exit(1);
514 }
515 break;
Bernhard Walle201bde32008-01-21 15:24:22 +0000516 case 'R':
Carl-Daniel Hailfinger259fa012009-05-07 00:59:53 +0000517 /* print_version() is always called during startup. */
Bernhard Walle201bde32008-01-21 15:24:22 +0000518 exit(0);
519 break;
Ollie Lho184a4042005-11-26 21:55:36 +0000520 case 'h':
Ollie Lhocbbf1252004-03-17 22:22:08 +0000521 default:
522 usage(argv[0]);
523 break;
524 }
525 }
Yinghai Luad8ffd22004-10-20 05:07:16 +0000526
Ollie Lhocbbf1252004-03-17 22:22:08 +0000527 if (read_it && write_it) {
Uwe Hermann793bdcd2008-05-22 22:47:04 +0000528 printf("Error: -r and -w are mutually exclusive.\n");
Ollie Lhocbbf1252004-03-17 22:22:08 +0000529 usage(argv[0]);
530 }
Ronald G. Minniche5559572003-03-28 03:29:43 +0000531
Ollie Lhocbbf1252004-03-17 22:22:08 +0000532 if (optind < argc)
533 filename = argv[optind++];
Ronald G. Minniche5559572003-03-28 03:29:43 +0000534
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +0000535 ret = programmer_init();
Luc Verhaegen8e3a6002007-04-04 22:45:58 +0000536
Ollie Lhocbbf1252004-03-17 22:22:08 +0000537 myusec_calibrate_delay();
Ollie Lho184a4042005-11-26 21:55:36 +0000538
Claus Gindhart2fd11d62008-05-08 00:31:44 +0000539 for (i = 0; i < ARRAY_SIZE(flashes); i++) {
Uwe Hermann394131e2008-10-18 21:14:13 +0000540 flashes[i] =
541 probe_flash(i ? flashes[i - 1] + 1 : flashchips, 0);
Claus Gindhart2fd11d62008-05-08 00:31:44 +0000542 if (!flashes[i])
543 for (i++; i < ARRAY_SIZE(flashes); i++)
544 flashes[i] = NULL;
545 }
546
547 if (flashes[1]) {
548 printf("Multiple flash chips were detected:");
549 for (i = 0; i < ARRAY_SIZE(flashes) && flashes[i]; i++)
550 printf(" %s", flashes[i]->name);
551 printf("\nPlease specify which chip to use with the -c <chipname> option.\n");
552 exit(1);
553 } else if (!flashes[0]) {
Ollie Lho184a4042005-11-26 21:55:36 +0000554 printf("No EEPROM/flash device found.\n");
Peter Stuge7ffbc6f2008-06-18 02:08:40 +0000555 if (!force || !chip_to_probe) {
556 printf("If you know which flash chip you have, and if this version of flashrom\n");
557 printf("supports a similar flash chip, you can try to force read your chip. Run:\n");
558 printf("flashrom -f -r -c similar_supported_flash_chip filename\n");
559 printf("\n");
560 printf("Note: flashrom can never write when the flash chip isn't found automatically.\n");
561 }
562 if (force && read_it && chip_to_probe) {
563 printf("Force read (-f -r -c) requested, forcing chip probe success:\n");
564 flashes[0] = probe_flash(flashchips, 1);
565 if (!flashes[0]) {
566 printf("flashrom does not support a flash chip named '%s'.\n", chip_to_probe);
567 printf("Run flashrom -L to view the hardware supported in this flashrom version.\n");
568 exit(1);
569 }
Peter Stuge23dc1df2008-10-10 20:43:17 +0000570 if (!filename) {
571 printf("Error: No filename specified.\n");
572 exit(1);
573 }
Peter Stuge7ffbc6f2008-06-18 02:08:40 +0000574 size = flashes[0]->total_size * 1024;
575 buf = (uint8_t *) calloc(size, sizeof(char));
576
577 if ((image = fopen(filename, "w")) == NULL) {
578 perror(filename);
579 exit(1);
580 }
Jason Wanga3f04be2008-11-28 21:36:51 +0000581 printf("Force reading flash... ");
Carl-Daniel Hailfinger03b4e712009-05-08 12:49:03 +0000582 if (!flashes[0]->read) {
583 printf("FAILED!\n");
584 fprintf(stderr, "ERROR: flashrom has no read function for this flash chip.\n");
585 return 1;
586 } else
Peter Stuge7ffbc6f2008-06-18 02:08:40 +0000587 flashes[0]->read(flashes[0], buf);
588
589 if (exclude_end_position - exclude_start_position > 0)
590 memset(buf + exclude_start_position, 0,
Uwe Hermann394131e2008-10-18 21:14:13 +0000591 exclude_end_position -
592 exclude_start_position);
Peter Stuge7ffbc6f2008-06-18 02:08:40 +0000593
Peter Stuge1fec0f32009-01-12 21:00:35 +0000594 numbytes = fwrite(buf, 1, size, image);
Peter Stuge7ffbc6f2008-06-18 02:08:40 +0000595 fclose(image);
Peter Stuge1fec0f32009-01-12 21:00:35 +0000596 printf("%s.\n", numbytes == size ? "done" : "FAILED");
Peter Stuge7ffbc6f2008-06-18 02:08:40 +0000597 free(buf);
Peter Stuge1fec0f32009-01-12 21:00:35 +0000598 return numbytes != size;
Peter Stuge7ffbc6f2008-06-18 02:08:40 +0000599 }
Jordan Crouse144ede62007-10-04 06:26:41 +0000600 // FIXME: flash writes stay enabled!
Ollie Lhocbbf1252004-03-17 22:22:08 +0000601 exit(1);
602 }
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000603
Claus Gindhart2fd11d62008-05-08 00:31:44 +0000604 flash = flashes[0];
605
Peter Stuge1159d582008-05-03 04:34:37 +0000606 if (TEST_OK_MASK != (flash->tested & TEST_OK_MASK)) {
607 printf("===\n");
608 if (flash->tested & TEST_BAD_MASK) {
609 printf("This flash part has status NOT WORKING for operations:");
610 if (flash->tested & TEST_BAD_PROBE)
611 printf(" PROBE");
612 if (flash->tested & TEST_BAD_READ)
613 printf(" READ");
614 if (flash->tested & TEST_BAD_ERASE)
615 printf(" ERASE");
616 if (flash->tested & TEST_BAD_WRITE)
617 printf(" WRITE");
618 printf("\n");
Carl-Daniel Hailfinger6a0a25c2008-11-28 23:45:27 +0000619 }
620 if ((!(flash->tested & TEST_BAD_PROBE) && !(flash->tested & TEST_OK_PROBE)) ||
621 (!(flash->tested & TEST_BAD_READ) && !(flash->tested & TEST_OK_READ)) ||
622 (!(flash->tested & TEST_BAD_ERASE) && !(flash->tested & TEST_OK_ERASE)) ||
623 (!(flash->tested & TEST_BAD_WRITE) && !(flash->tested & TEST_OK_WRITE))) {
Peter Stuge1159d582008-05-03 04:34:37 +0000624 printf("This flash part has status UNTESTED for operations:");
Carl-Daniel Hailfinger6a0a25c2008-11-28 23:45:27 +0000625 if (!(flash->tested & TEST_BAD_PROBE) && !(flash->tested & TEST_OK_PROBE))
Peter Stuge1159d582008-05-03 04:34:37 +0000626 printf(" PROBE");
Carl-Daniel Hailfinger6a0a25c2008-11-28 23:45:27 +0000627 if (!(flash->tested & TEST_BAD_READ) && !(flash->tested & TEST_OK_READ))
Peter Stuge1159d582008-05-03 04:34:37 +0000628 printf(" READ");
Carl-Daniel Hailfinger6a0a25c2008-11-28 23:45:27 +0000629 if (!(flash->tested & TEST_BAD_ERASE) && !(flash->tested & TEST_OK_ERASE))
Peter Stuge1159d582008-05-03 04:34:37 +0000630 printf(" ERASE");
Carl-Daniel Hailfinger6a0a25c2008-11-28 23:45:27 +0000631 if (!(flash->tested & TEST_BAD_WRITE) && !(flash->tested & TEST_OK_WRITE))
Peter Stuge1159d582008-05-03 04:34:37 +0000632 printf(" WRITE");
633 printf("\n");
634 }
635 printf("Please email a report to flashrom@coreboot.org if any of the above operations\n");
636 printf("work correctly for you with this flash part. Please include the full output\n");
637 printf("from the program, including chipset found. Thank you for your help!\n");
638 printf("===\n");
639 }
Ollie Lho184a4042005-11-26 21:55:36 +0000640
Jordan Crouse144ede62007-10-04 06:26:41 +0000641 if (!(read_it | write_it | verify_it | erase_it)) {
642 printf("No operations were specified.\n");
643 // FIXME: flash writes stay enabled!
644 exit(1);
645 }
646
Ollie Lhoefa28582004-12-08 20:10:01 +0000647 if (!filename && !erase_it) {
Jordan Crouse144ede62007-10-04 06:26:41 +0000648 printf("Error: No filename specified.\n");
649 // FIXME: flash writes stay enabled!
650 exit(1);
Ollie Lhocbbf1252004-03-17 22:22:08 +0000651 }
Ollie Lhocbbf1252004-03-17 22:22:08 +0000652
Ollie Lho184a4042005-11-26 21:55:36 +0000653 size = flash->total_size * 1024;
654 buf = (uint8_t *) calloc(size, sizeof(char));
Uwe Hermanna7e05482007-05-09 10:17:44 +0000655
Ollie Lhoefa28582004-12-08 20:10:01 +0000656 if (erase_it) {
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +0000657 if (erase_flash(flash))
Peter Stugef31104c2008-04-28 14:47:30 +0000658 return 1;
Ollie Lhoefa28582004-12-08 20:10:01 +0000659 } else if (read_it) {
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +0000660 if (read_flash(flash, filename, exclude_start_position, exclude_end_position))
Peter Stuge1fec0f32009-01-12 21:00:35 +0000661 return 1;
Ollie Lhocbbf1252004-03-17 22:22:08 +0000662 } else {
Stefan Reinauer018aca82006-11-21 23:48:51 +0000663 struct stat image_stat;
664
Ollie Lho761bf1b2004-03-20 16:46:10 +0000665 if ((image = fopen(filename, "r")) == NULL) {
Ollie Lhocbbf1252004-03-17 22:22:08 +0000666 perror(filename);
667 exit(1);
668 }
Stefan Reinauer018aca82006-11-21 23:48:51 +0000669 if (fstat(fileno(image), &image_stat) != 0) {
670 perror(filename);
671 exit(1);
672 }
Uwe Hermanna7e05482007-05-09 10:17:44 +0000673 if (image_stat.st_size != flash->total_size * 1024) {
Uwe Hermann793bdcd2008-05-22 22:47:04 +0000674 fprintf(stderr, "Error: Image size doesn't match\n");
Stefan Reinauer018aca82006-11-21 23:48:51 +0000675 exit(1);
676 }
677
Peter Stuge1fec0f32009-01-12 21:00:35 +0000678 numbytes = fread(buf, 1, size, image);
Peter Stuge7ffbc6f2008-06-18 02:08:40 +0000679 show_id(buf, size, force);
Ollie Lhocbbf1252004-03-17 22:22:08 +0000680 fclose(image);
Peter Stuge1fec0f32009-01-12 21:00:35 +0000681 if (numbytes != size) {
682 fprintf(stderr, "Error: Failed to read file. Got %ld bytes, wanted %ld!\n", numbytes, size);
683 return 1;
684 }
Ollie Lhocbbf1252004-03-17 22:22:08 +0000685 }
686
Ollie Lho184a4042005-11-26 21:55:36 +0000687 /* exclude range stuff. Nice idea, but at the moment it is only
688 * supported in hardware by the pm49fl004 chips.
689 * Instead of implementing this for all chips I suggest advancing
690 * it to the rom layout feature below and drop exclude range
691 * completely once all flash chips can do rom layouts. stepan
692 */
Uwe Hermanna7e05482007-05-09 10:17:44 +0000693
Ollie Lho184a4042005-11-26 21:55:36 +0000694 // ////////////////////////////////////////////////////////////
Carl-Daniel Hailfinger03b4e712009-05-08 12:49:03 +0000695 /* FIXME: This memcpy will not work for SPI nor external flashers.
696 * Convert to chip_readb.
697 */
Ollie Lho98bea8a2004-12-07 03:15:51 +0000698 if (exclude_end_position - exclude_start_position > 0)
Uwe Hermanna7e05482007-05-09 10:17:44 +0000699 memcpy(buf + exclude_start_position,
Uwe Hermanna8808852007-05-24 19:17:29 +0000700 (const char *)flash->virtual_memory +
701 exclude_start_position,
Uwe Hermanna7e05482007-05-09 10:17:44 +0000702 exclude_end_position - exclude_start_position);
Ollie Lho98bea8a2004-12-07 03:15:51 +0000703
Uwe Hermanna7e05482007-05-09 10:17:44 +0000704 exclude_start_page = exclude_start_position / flash->page_size;
705 if ((exclude_start_position % flash->page_size) != 0) {
Ollie Lho98bea8a2004-12-07 03:15:51 +0000706 exclude_start_page++;
707 }
Uwe Hermanna7e05482007-05-09 10:17:44 +0000708 exclude_end_page = exclude_end_position / flash->page_size;
Ollie Lho184a4042005-11-26 21:55:36 +0000709 // ////////////////////////////////////////////////////////////
Yinghai Luad8ffd22004-10-20 05:07:16 +0000710
Ollie Lho184a4042005-11-26 21:55:36 +0000711 // This should be moved into each flash part's code to do it
712 // cleanly. This does the job.
Stefan Reinauerce532972007-05-23 17:20:56 +0000713 handle_romentries(buf, (uint8_t *) flash->virtual_memory);
Uwe Hermanna7e05482007-05-09 10:17:44 +0000714
Ollie Lho184a4042005-11-26 21:55:36 +0000715 // ////////////////////////////////////////////////////////////
Uwe Hermanna7e05482007-05-09 10:17:44 +0000716
Peter Stugef31104c2008-04-28 14:47:30 +0000717 if (write_it) {
718 if (!flash->write) {
719 fprintf(stderr, "Error: flashrom has no write function for this flash chip.\n");
720 return 1;
721 }
Stefan Reinauer143da0b2006-01-04 16:42:57 +0000722 ret |= flash->write(flash, buf);
Peter Stugef31104c2008-04-28 14:47:30 +0000723 }
Ollie Lho184a4042005-11-26 21:55:36 +0000724
Ollie Lhocbbf1252004-03-17 22:22:08 +0000725 if (verify_it)
Stefan Reinauer143da0b2006-01-04 16:42:57 +0000726 ret |= verify_flash(flash, buf);
Ollie Lho184a4042005-11-26 21:55:36 +0000727
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +0000728 programmer_shutdown();
729
Stefan Reinauer143da0b2006-01-04 16:42:57 +0000730 return ret;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000731}