blob: 7eb4962af7d06aa082b3f950a4807801b4c5ad2a [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>
Uwe Hermannc7e8a0c2009-05-19 14:14:21 +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"
Carl-Daniel Hailfinger08454642009-06-15 14:14:48 +000031#include "flashchips.h"
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +000032
Carl-Daniel Hailfingera80cfbc2009-07-22 20:13:00 +000033const char *flashrom_version = FLASHROM_VERSION;
Ronald G. Minnichceec4202003-07-25 04:37:41 +000034char *chip_to_probe = NULL;
Peter Stuge7ffbc6f2008-06-18 02:08:40 +000035int verbose = 0;
Carl-Daniel Hailfinger415e5132009-08-12 11:39:29 +000036enum programmer programmer = PROGRAMMER_INTERNAL;
Carl-Daniel Hailfingeref58a9c2009-08-12 13:32:56 +000037char *programmer_param = NULL;
Stefan Reinauer70385642007-04-06 11:58:03 +000038
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +000039const struct programmer_entry programmer_table[] = {
40 {
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +000041 .name = "internal",
Carl-Daniel Hailfinger1e334e62009-05-11 15:46:43 +000042 .init = internal_init,
43 .shutdown = internal_shutdown,
Carl-Daniel Hailfinger1455b2b2009-05-11 14:13:25 +000044 .map_flash_region = physmap,
45 .unmap_flash_region = physunmap,
Carl-Daniel Hailfinger1e334e62009-05-11 15:46:43 +000046 .chip_readb = internal_chip_readb,
47 .chip_readw = internal_chip_readw,
48 .chip_readl = internal_chip_readl,
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +000049 .chip_readn = internal_chip_readn,
Carl-Daniel Hailfinger1e334e62009-05-11 15:46:43 +000050 .chip_writeb = internal_chip_writeb,
51 .chip_writew = internal_chip_writew,
52 .chip_writel = internal_chip_writel,
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +000053 .chip_writen = fallback_chip_writen,
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +000054 .delay = internal_delay,
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +000055 },
Luc Verhaegen8e3a6002007-04-04 22:45:58 +000056
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +000057#if DUMMY_SUPPORT == 1
Carl-Daniel Hailfingerc3129202009-05-09 00:54:55 +000058 {
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +000059 .name = "dummy",
Carl-Daniel Hailfinger1e334e62009-05-11 15:46:43 +000060 .init = dummy_init,
61 .shutdown = dummy_shutdown,
Carl-Daniel Hailfinger1455b2b2009-05-11 14:13:25 +000062 .map_flash_region = dummy_map,
63 .unmap_flash_region = dummy_unmap,
Carl-Daniel Hailfinger1e334e62009-05-11 15:46:43 +000064 .chip_readb = dummy_chip_readb,
65 .chip_readw = dummy_chip_readw,
66 .chip_readl = dummy_chip_readl,
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +000067 .chip_readn = dummy_chip_readn,
Carl-Daniel Hailfinger1e334e62009-05-11 15:46:43 +000068 .chip_writeb = dummy_chip_writeb,
69 .chip_writew = dummy_chip_writew,
70 .chip_writel = dummy_chip_writel,
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +000071 .chip_writen = dummy_chip_writen,
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +000072 .delay = internal_delay,
Carl-Daniel Hailfingerc3129202009-05-09 00:54:55 +000073 },
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +000074#endif
Carl-Daniel Hailfingerc3129202009-05-09 00:54:55 +000075
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +000076#if NIC3COM_SUPPORT == 1
Uwe Hermannb4dcb712009-05-13 11:36:06 +000077 {
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +000078 .name = "nic3com",
Uwe Hermannb4dcb712009-05-13 11:36:06 +000079 .init = nic3com_init,
80 .shutdown = nic3com_shutdown,
Uwe Hermannc6915932009-05-17 23:12:17 +000081 .map_flash_region = fallback_map,
82 .unmap_flash_region = fallback_unmap,
Uwe Hermannb4dcb712009-05-13 11:36:06 +000083 .chip_readb = nic3com_chip_readb,
Carl-Daniel Hailfinger9ee10772009-05-16 01:23:55 +000084 .chip_readw = fallback_chip_readw,
85 .chip_readl = fallback_chip_readl,
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +000086 .chip_readn = fallback_chip_readn,
Uwe Hermannb4dcb712009-05-13 11:36:06 +000087 .chip_writeb = nic3com_chip_writeb,
Carl-Daniel Hailfinger9ee10772009-05-16 01:23:55 +000088 .chip_writew = fallback_chip_writew,
89 .chip_writel = fallback_chip_writel,
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +000090 .chip_writen = fallback_chip_writen,
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +000091 .delay = internal_delay,
Uwe Hermannb4dcb712009-05-13 11:36:06 +000092 },
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +000093#endif
Uwe Hermannb4dcb712009-05-13 11:36:06 +000094
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +000095#if DRKAISER_SUPPORT == 1
Rudolf Marek68720c72009-05-17 19:39:27 +000096 {
TURBO Jb0912c02009-09-02 23:00:46 +000097 .name = "drkaiser",
98 .init = drkaiser_init,
99 .shutdown = drkaiser_shutdown,
100 .map_flash_region = fallback_map,
101 .unmap_flash_region = fallback_unmap,
102 .chip_readb = drkaiser_chip_readb,
103 .chip_readw = fallback_chip_readw,
104 .chip_readl = fallback_chip_readl,
105 .chip_readn = fallback_chip_readn,
106 .chip_writeb = drkaiser_chip_writeb,
107 .chip_writew = fallback_chip_writew,
108 .chip_writel = fallback_chip_writel,
109 .chip_writen = fallback_chip_writen,
110 .delay = internal_delay,
111 },
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +0000112#endif
TURBO Jb0912c02009-09-02 23:00:46 +0000113
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +0000114#if SATASII_SUPPORT == 1
TURBO Jb0912c02009-09-02 23:00:46 +0000115 {
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +0000116 .name = "satasii",
Rudolf Marek68720c72009-05-17 19:39:27 +0000117 .init = satasii_init,
118 .shutdown = satasii_shutdown,
Uwe Hermannc6915932009-05-17 23:12:17 +0000119 .map_flash_region = fallback_map,
120 .unmap_flash_region = fallback_unmap,
Rudolf Marek68720c72009-05-17 19:39:27 +0000121 .chip_readb = satasii_chip_readb,
122 .chip_readw = fallback_chip_readw,
123 .chip_readl = fallback_chip_readl,
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000124 .chip_readn = fallback_chip_readn,
Rudolf Marek68720c72009-05-17 19:39:27 +0000125 .chip_writeb = satasii_chip_writeb,
126 .chip_writew = fallback_chip_writew,
127 .chip_writel = fallback_chip_writel,
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000128 .chip_writen = fallback_chip_writen,
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +0000129 .delay = internal_delay,
Rudolf Marek68720c72009-05-17 19:39:27 +0000130 },
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +0000131#endif
Rudolf Marek68720c72009-05-17 19:39:27 +0000132
Carl-Daniel Hailfingerb8afecd2009-05-31 18:00:57 +0000133 {
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +0000134 .name = "it87spi",
Carl-Daniel Hailfingerb8afecd2009-05-31 18:00:57 +0000135 .init = it87spi_init,
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +0000136 .shutdown = noop_shutdown,
Carl-Daniel Hailfinger415e5132009-08-12 11:39:29 +0000137 .map_flash_region = fallback_map,
138 .unmap_flash_region = fallback_unmap,
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +0000139 .chip_readb = noop_chip_readb,
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000140 .chip_readw = fallback_chip_readw,
141 .chip_readl = fallback_chip_readl,
142 .chip_readn = fallback_chip_readn,
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +0000143 .chip_writeb = noop_chip_writeb,
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000144 .chip_writew = fallback_chip_writew,
145 .chip_writel = fallback_chip_writel,
146 .chip_writen = fallback_chip_writen,
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +0000147 .delay = internal_delay,
Carl-Daniel Hailfingerb8afecd2009-05-31 18:00:57 +0000148 },
149
Carl-Daniel Hailfinger3426ef62009-08-19 13:27:58 +0000150#if FT2232_SPI_SUPPORT == 1
Paul Fox05dfbe62009-06-16 21:08:06 +0000151 {
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +0000152 .name = "ft2232spi",
Paul Fox05dfbe62009-06-16 21:08:06 +0000153 .init = ft2232_spi_init,
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +0000154 .shutdown = noop_shutdown, /* Missing shutdown */
Carl-Daniel Hailfinger415e5132009-08-12 11:39:29 +0000155 .map_flash_region = fallback_map,
156 .unmap_flash_region = fallback_unmap,
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +0000157 .chip_readb = noop_chip_readb,
Paul Fox05dfbe62009-06-16 21:08:06 +0000158 .chip_readw = fallback_chip_readw,
159 .chip_readl = fallback_chip_readl,
160 .chip_readn = fallback_chip_readn,
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +0000161 .chip_writeb = noop_chip_writeb,
Paul Fox05dfbe62009-06-16 21:08:06 +0000162 .chip_writew = fallback_chip_writew,
163 .chip_writel = fallback_chip_writel,
164 .chip_writen = fallback_chip_writen,
165 .delay = internal_delay,
166 },
Carl-Daniel Hailfinger3426ef62009-08-19 13:27:58 +0000167#endif
Carl-Daniel Hailfinger415e5132009-08-12 11:39:29 +0000168
Carl-Daniel Hailfinger6be74112009-08-12 16:17:41 +0000169#if SERPROG_SUPPORT == 1
Urja Rannikko22915352009-06-23 11:33:43 +0000170 {
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +0000171 .name = "serprog",
Urja Rannikko22915352009-06-23 11:33:43 +0000172 .init = serprog_init,
173 .shutdown = serprog_shutdown,
174 .map_flash_region = fallback_map,
175 .unmap_flash_region = fallback_unmap,
176 .chip_readb = serprog_chip_readb,
177 .chip_readw = fallback_chip_readw,
178 .chip_readl = fallback_chip_readl,
179 .chip_readn = serprog_chip_readn,
180 .chip_writeb = serprog_chip_writeb,
181 .chip_writew = fallback_chip_writew,
182 .chip_writel = fallback_chip_writel,
183 .chip_writen = fallback_chip_writen,
184 .delay = serprog_delay,
185 },
Carl-Daniel Hailfinger6be74112009-08-12 16:17:41 +0000186#endif
Paul Fox05dfbe62009-06-16 21:08:06 +0000187
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +0000188 {}, /* This entry corresponds to PROGRAMMER_INVALID. */
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +0000189};
Luc Verhaegen8e3a6002007-04-04 22:45:58 +0000190
Uwe Hermann09e04f72009-05-16 22:36:00 +0000191int programmer_init(void)
192{
193 return programmer_table[programmer].init();
194}
195
196int programmer_shutdown(void)
197{
198 return programmer_table[programmer].shutdown();
199}
200
201void *programmer_map_flash_region(const char *descr, unsigned long phys_addr,
202 size_t len)
203{
204 return programmer_table[programmer].map_flash_region(descr,
205 phys_addr, len);
206}
207
208void programmer_unmap_flash_region(void *virt_addr, size_t len)
209{
210 programmer_table[programmer].unmap_flash_region(virt_addr, len);
211}
212
213void chip_writeb(uint8_t val, chipaddr addr)
214{
215 programmer_table[programmer].chip_writeb(val, addr);
216}
217
218void chip_writew(uint16_t val, chipaddr addr)
219{
220 programmer_table[programmer].chip_writew(val, addr);
221}
222
223void chip_writel(uint32_t val, chipaddr addr)
224{
225 programmer_table[programmer].chip_writel(val, addr);
226}
227
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000228void chip_writen(uint8_t *buf, chipaddr addr, size_t len)
229{
230 programmer_table[programmer].chip_writen(buf, addr, len);
231}
232
Uwe Hermann09e04f72009-05-16 22:36:00 +0000233uint8_t chip_readb(const chipaddr addr)
234{
235 return programmer_table[programmer].chip_readb(addr);
236}
237
238uint16_t chip_readw(const chipaddr addr)
239{
240 return programmer_table[programmer].chip_readw(addr);
241}
242
243uint32_t chip_readl(const chipaddr addr)
244{
245 return programmer_table[programmer].chip_readl(addr);
246}
247
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000248void chip_readn(uint8_t *buf, chipaddr addr, size_t len)
249{
250 programmer_table[programmer].chip_readn(buf, addr, len);
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000251}
252
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +0000253void programmer_delay(int usecs)
254{
255 programmer_table[programmer].delay(usecs);
256}
257
Peter Stuge776d2022009-01-26 00:39:57 +0000258void map_flash_registers(struct flashchip *flash)
Stefan Reinauerff4f1972007-05-24 08:48:10 +0000259{
Stefan Reinauerff4f1972007-05-24 08:48:10 +0000260 size_t size = flash->total_size * 1024;
Carl-Daniel Hailfingerd0fc9462009-05-11 14:01:17 +0000261 /* Flash registers live 4 MByte below the flash. */
Carl-Daniel Hailfinger8ab49e72009-08-19 13:55:34 +0000262 /* FIXME: This is incorrect for nonstandard flashbase. */
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000263 flash->virtual_registers = (chipaddr)programmer_map_flash_region("flash chip registers", (0xFFFFFFFF - 0x400000 - size + 1), size);
Stefan Reinauerff4f1972007-05-24 08:48:10 +0000264}
265
Carl-Daniel Hailfingercbf563c2009-06-16 08:55:44 +0000266int read_memmapped(struct flashchip *flash, uint8_t *buf, int start, int len)
Carl-Daniel Hailfinger03b4e712009-05-08 12:49:03 +0000267{
Carl-Daniel Hailfingercbf563c2009-06-16 08:55:44 +0000268 chip_readn(buf, flash->virtual_memory + start, len);
Carl-Daniel Hailfinger03b4e712009-05-08 12:49:03 +0000269
270 return 0;
271}
272
Carl-Daniel Hailfinger38a059d2009-06-13 12:04:03 +0000273int min(int a, int b)
274{
275 return (a < b) ? a : b;
276}
277
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000278int max(int a, int b)
279{
280 return (a > b) ? a : b;
281}
282
Carl-Daniel Hailfingerb22918c2009-06-01 02:08:58 +0000283char *strcat_realloc(char *dest, const char *src)
284{
285 dest = realloc(dest, strlen(dest) + strlen(src) + 1);
286 if (!dest)
287 return NULL;
288 strcat(dest, src);
289 return dest;
290}
291
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000292/* start is an offset to the base address of the flash chip */
293int check_erased_range(struct flashchip *flash, int start, int len)
294{
295 int ret;
296 uint8_t *cmpbuf = malloc(len);
297
298 if (!cmpbuf) {
299 fprintf(stderr, "Could not allocate memory!\n");
300 exit(1);
301 }
302 memset(cmpbuf, 0xff, len);
303 ret = verify_range(flash, cmpbuf, start, len, "ERASE");
304 free(cmpbuf);
305 return ret;
306}
307
308/**
309 * @cmpbuf buffer to compare against
310 * @start offset to the base address of the flash chip
311 * @len length of the verified area
312 * @message string to print in the "FAILED" message
313 * @return 0 for success, -1 for failure
314 */
315int verify_range(struct flashchip *flash, uint8_t *cmpbuf, int start, int len, char *message)
316{
317 int i, j, starthere, lenhere, ret = 0;
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000318 int page_size = flash->page_size;
319 uint8_t *readbuf = malloc(page_size);
Carl-Daniel Hailfinger49b9cab2009-07-23 01:42:56 +0000320 int failcount = 0;
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000321
322 if (!len)
323 goto out_free;
324
Carl-Daniel Hailfinger23290662009-06-24 08:20:45 +0000325 if (!flash->read) {
326 fprintf(stderr, "ERROR: flashrom has no read function for this flash chip.\n");
327 return 1;
328 }
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000329 if (!readbuf) {
330 fprintf(stderr, "Could not allocate memory!\n");
331 exit(1);
332 }
333
334 if (start + len > flash->total_size * 1024) {
335 fprintf(stderr, "Error: %s called with start 0x%x + len 0x%x >"
336 " total_size 0x%x\n", __func__, start, len,
337 flash->total_size * 1024);
338 ret = -1;
339 goto out_free;
340 }
341 if (!message)
342 message = "VERIFY";
343
344 /* Warning: This loop has a very unusual condition and body.
345 * The loop needs to go through each page with at least one affected
346 * byte. The lowest page number is (start / page_size) since that
347 * division rounds down. The highest page number we want is the page
348 * where the last byte of the range lives. That last byte has the
349 * address (start + len - 1), thus the highest page number is
350 * (start + len - 1) / page_size. Since we want to include that last
351 * page as well, the loop condition uses <=.
352 */
353 for (i = start / page_size; i <= (start + len - 1) / page_size; i++) {
354 /* Byte position of the first byte in the range in this page. */
355 starthere = max(start, i * page_size);
356 /* Length of bytes in the range in this page. */
357 lenhere = min(start + len, (i + 1) * page_size) - starthere;
Carl-Daniel Hailfinger23290662009-06-24 08:20:45 +0000358 flash->read(flash, readbuf, starthere, lenhere);
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000359 for (j = 0; j < lenhere; j++) {
360 if (cmpbuf[starthere - start + j] != readbuf[j]) {
Carl-Daniel Hailfinger49b9cab2009-07-23 01:42:56 +0000361 /* Only print the first failure. */
362 if (!failcount++)
363 fprintf(stderr, "%s FAILED at 0x%08x! "
364 "Expected=0x%02x, Read=0x%02x,",
365 message, starthere + j,
366 cmpbuf[starthere - start + j],
367 readbuf[j]);
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000368 }
369 }
370 }
Carl-Daniel Hailfinger49b9cab2009-07-23 01:42:56 +0000371 if (failcount) {
372 fprintf(stderr, " failed byte count from 0x%08x-0x%08x: 0x%x\n",
373 start, start + len - 1, failcount);
374 ret = -1;
375 }
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000376
377out_free:
378 free(readbuf);
379 return ret;
380}
381
Peter Stuge483b8f02008-09-03 23:10:05 +0000382struct flashchip *probe_flash(struct flashchip *first_flash, int force)
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000383{
Peter Stuge483b8f02008-09-03 23:10:05 +0000384 struct flashchip *flash;
Peter Stuge7ccce542008-12-03 23:36:48 +0000385 unsigned long base = 0, size;
Carl-Daniel Hailfingerb22918c2009-06-01 02:08:58 +0000386 char *tmp;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000387
Peter Stuge483b8f02008-09-03 23:10:05 +0000388 for (flash = first_flash; flash && flash->name; flash++) {
Peter Stuge27c3e2d2008-07-02 17:15:47 +0000389 if (chip_to_probe && strcmp(flash->name, chip_to_probe) != 0)
Ollie Lhocbbf1252004-03-17 22:22:08 +0000390 continue;
Stefan Reinauerac378972008-03-17 22:59:40 +0000391 printf_debug("Probing for %s %s, %d KB: ",
392 flash->vendor, flash->name, flash->total_size);
Peter Stuge7ffbc6f2008-06-18 02:08:40 +0000393 if (!flash->probe && !force) {
Peter Stugef31104c2008-04-28 14:47:30 +0000394 printf_debug("failed! flashrom has no probe function for this flash chip.\n");
Peter Stugef31104c2008-04-28 14:47:30 +0000395 continue;
396 }
Carl-Daniel Hailfingerb22918c2009-06-01 02:08:58 +0000397 if (!(buses_supported & flash->bustype)) {
398 tmp = flashbuses_to_text(buses_supported);
399 printf_debug("skipped. Host bus type %s ", tmp);
400 free(tmp);
401 tmp = flashbuses_to_text(flash->bustype);
402 printf_debug("and chip bus type %s are incompatible.\n", tmp);
403 free(tmp);
404 continue;
405 }
Stefan Reinauer70385642007-04-06 11:58:03 +0000406
Ollie Lhocbbf1252004-03-17 22:22:08 +0000407 size = flash->total_size * 1024;
Stefan Reinauer70385642007-04-06 11:58:03 +0000408
Carl-Daniel Hailfinger97d6b092009-05-09 07:27:23 +0000409 base = flashbase ? flashbase : (0xffffffff - size + 1);
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000410 flash->virtual_memory = (chipaddr)programmer_map_flash_region("flash chip", base, size);
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000411
Peter Stuge27c3e2d2008-07-02 17:15:47 +0000412 if (force)
413 break;
Stefan Reinauerfcb63682006-03-16 16:57:41 +0000414
Peter Stuge483b8f02008-09-03 23:10:05 +0000415 if (flash->probe(flash) != 1)
416 goto notfound;
417
Uwe Hermann394131e2008-10-18 21:14:13 +0000418 if (first_flash == flashchips
419 || flash->model_id != GENERIC_DEVICE_ID)
Peter Stuge27c3e2d2008-07-02 17:15:47 +0000420 break;
421
Peter Stuge483b8f02008-09-03 23:10:05 +0000422notfound:
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000423 programmer_unmap_flash_region((void *)flash->virtual_memory, size);
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000424 }
Uwe Hermannffec5f32007-08-23 16:08:21 +0000425
Peter Stuge27c3e2d2008-07-02 17:15:47 +0000426 if (!flash || !flash->name)
427 return NULL;
428
Uwe Hermann9899cad2009-06-28 21:47:57 +0000429 printf("Found chip \"%s %s\" (%d KB, %s) at physical address 0x%lx.\n",
430 flash->vendor, flash->name, flash->total_size,
431 flashbuses_to_text(flash->bustype), base);
432
Peter Stuge27c3e2d2008-07-02 17:15:47 +0000433 return flash;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000434}
435
Stefan Reinauere3705282005-12-18 16:41:10 +0000436int verify_flash(struct flashchip *flash, uint8_t *buf)
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000437{
Carl-Daniel Hailfinger23290662009-06-24 08:20:45 +0000438 int ret;
Ollie Lho761bf1b2004-03-20 16:46:10 +0000439 int total_size = flash->total_size * 1024;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000440
Uwe Hermanna502dce2007-10-17 23:55:15 +0000441 printf("Verifying flash... ");
Uwe Hermanna7e05482007-05-09 10:17:44 +0000442
Carl-Daniel Hailfinger23290662009-06-24 08:20:45 +0000443 ret = verify_range(flash, buf, 0, total_size, NULL);
Uwe Hermanna7e05482007-05-09 10:17:44 +0000444
Carl-Daniel Hailfinger23290662009-06-24 08:20:45 +0000445 if (!ret)
446 printf("VERIFIED. \n");
Stefan Reinauerfcb63682006-03-16 16:57:41 +0000447
Carl-Daniel Hailfinger23290662009-06-24 08:20:45 +0000448 return ret;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000449}
450
Carl-Daniel Hailfinger49eb4dd2009-06-19 11:23:57 +0000451int read_flash(struct flashchip *flash, char *filename)
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +0000452{
453 unsigned long numbytes;
454 FILE *image;
455 unsigned long size = flash->total_size * 1024;
456 unsigned char *buf = calloc(size, sizeof(char));
Stephan Guilloux21dd55b2009-06-01 22:07:52 +0000457
458 if (!filename) {
459 printf("Error: No filename specified.\n");
460 return 1;
461 }
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +0000462 if ((image = fopen(filename, "w")) == NULL) {
463 perror(filename);
464 exit(1);
465 }
466 printf("Reading flash... ");
Carl-Daniel Hailfinger03b4e712009-05-08 12:49:03 +0000467 if (!flash->read) {
468 printf("FAILED!\n");
469 fprintf(stderr, "ERROR: flashrom has no read function for this flash chip.\n");
470 return 1;
471 } else
Carl-Daniel Hailfingercbf563c2009-06-16 08:55:44 +0000472 flash->read(flash, buf, 0, size);
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +0000473
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +0000474 numbytes = fwrite(buf, 1, size, image);
475 fclose(image);
Stephan Guilloux5a8b2442009-06-01 21:37:00 +0000476 free(buf);
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +0000477 printf("%s.\n", numbytes == size ? "done" : "FAILED");
478 if (numbytes != size)
479 return 1;
480 return 0;
481}
482
483int erase_flash(struct flashchip *flash)
484{
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +0000485 int i, j, k, ret = 0, found = 0;
486
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +0000487 printf("Erasing flash chip... ");
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +0000488 for (k = 0; k < NUM_ERASEFUNCTIONS; k++) {
489 unsigned long done = 0;
490 struct block_eraser eraser = flash->block_erasers[k];
491
492 printf_debug("Looking at blockwise erase function %i... ", k);
493 if (!eraser.block_erase && !eraser.eraseblocks[0].count) {
494 printf_debug("not defined. "
495 "Looking for another erase function.\n");
496 continue;
497 }
498 if (!eraser.block_erase && eraser.eraseblocks[0].count) {
499 printf_debug("eraseblock layout is known, but no "
500 "matching block erase function found. "
501 "Looking for another erase function.\n");
502 continue;
503 }
504 if (eraser.block_erase && !eraser.eraseblocks[0].count) {
505 printf_debug("block erase function found, but "
506 "eraseblock layout is unknown. "
507 "Looking for another erase function.\n");
508 continue;
509 }
510 found = 1;
511 printf_debug("trying... ");
512 for (i = 0; i < NUM_ERASEREGIONS; i++) {
513 /* count==0 for all automatically initialized array
514 * members so the loop below won't be executed for them.
515 */
516 for (j = 0; j < eraser.eraseblocks[i].count; j++) {
517 ret = eraser.block_erase(flash, done + eraser.eraseblocks[i].size * j, eraser.eraseblocks[i].size);
518 if (ret)
519 break;
520 }
521 if (ret)
522 break;
523 }
524 /* If everything is OK, don't try another erase function. */
525 if (!ret)
526 break;
527 }
528 /* If no block erase function was found or block erase failed, retry. */
529 if ((!found || ret) && (flash->erase)) {
530 found = 1;
531 printf_debug("Trying whole-chip erase function... ");
532 ret = flash->erase(flash);
533 }
534 if (!found) {
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +0000535 fprintf(stderr, "ERROR: flashrom has no erase function for this flash chip.\n");
536 return 1;
537 }
Carl-Daniel Hailfingerf160a122009-05-08 17:15:15 +0000538
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +0000539 if (ret) {
540 fprintf(stderr, "FAILED!\n");
541 } else {
542 printf("SUCCESS.\n");
543 }
544 return ret;
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +0000545}
546
Carl-Daniel Hailfinger8ab49e72009-08-19 13:55:34 +0000547void emergency_help_message()
548{
549 fprintf(stderr, "Your flash chip is in an unknown state.\n"
550 "Get help on IRC at irc.freenode.net channel #flashrom or\n"
551 "mail flashrom@flashrom.org\n"
552 "------------------------------------------------------------\n"
553 "DO NOT REBOOT OR POWEROFF!\n");
554}
555
Ronald G. Minniche5559572003-03-28 03:29:43 +0000556void usage(const char *name)
557{
Carl-Daniel Hailfinger204b0762009-08-13 11:38:44 +0000558 const char *pname;
559 int pnamelen;
560 int remaining = 0;
561 enum programmer p;
562
Carl-Daniel Hailfinger49eb4dd2009-06-19 11:23:57 +0000563 printf("usage: %s [-VfLzhR] [-E|-r file|-w file|-v file] [-c chipname]\n"
Carl-Daniel Hailfinger5d1f4182009-06-24 08:18:38 +0000564 " [-m [vendor:]part] [-l file] [-i image] [-p programmer]\n\n", name);
Uwe Hermannc7e8a0c2009-05-19 14:14:21 +0000565
Uwe Hermanne8ba5382009-05-22 11:37:27 +0000566 printf("Please note that the command line interface for flashrom will "
567 "change before\nflashrom 1.0. Do not use flashrom in scripts "
568 "or other automated tools without\nchecking that your flashrom"
569 " version won't interpret options in a different way.\n\n");
Uwe Hermannc7e8a0c2009-05-19 14:14:21 +0000570
Uwe Hermanna7e05482007-05-09 10:17:44 +0000571 printf
Peter Stuge6b53fed2008-01-27 16:21:21 +0000572 (" -r | --read: read flash and save into file\n"
573 " -w | --write: write file into flash\n"
574 " -v | --verify: verify flash against file\n"
Uwe Hermannea07f622009-06-24 17:31:08 +0000575 " -n | --noverify: don't verify flash against file\n"
Peter Stuge6b53fed2008-01-27 16:21:21 +0000576 " -E | --erase: erase flash device\n"
577 " -V | --verbose: more verbose output\n"
578 " -c | --chip <chipname>: probe only for specified flash chip\n"
Peter Stuge6b53fed2008-01-27 16:21:21 +0000579 " -m | --mainboard <[vendor:]part>: override mainboard settings\n"
580 " -f | --force: force write without checking image\n"
Uwe Hermanne8ba5382009-05-22 11:37:27 +0000581 " -l | --layout <file.layout>: read ROM layout from file\n"
Peter Stuge6b53fed2008-01-27 16:21:21 +0000582 " -i | --image <name>: only flash image name from flash layout\n"
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000583 " -L | --list-supported: print supported devices\n"
Uwe Hermann707f1eb2009-09-18 13:38:14 +0000584#if PRINT_WIKI_SUPPORT == 1
Uwe Hermann20a293f2009-06-19 10:42:43 +0000585 " -z | --list-supported-wiki: print supported devices in wiki syntax\n"
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000586#endif
Carl-Daniel Hailfinger204b0762009-08-13 11:38:44 +0000587 " -p | --programmer <name>: specify the programmer device");
588
589 for (p = 0; p < PROGRAMMER_INVALID; p++) {
590 pname = programmer_table[p].name;
591 pnamelen = strlen(pname);
592 if (remaining - pnamelen - 2 < 0) {
593 printf("\n ");
594 remaining = 43;
595 } else {
596 printf(" ");
597 remaining--;
598 }
599 if (p == 0) {
600 printf("(");
601 remaining--;
602 }
603 printf("%s", pname);
604 remaining -= pnamelen;
605 if (p < PROGRAMMER_INVALID - 1) {
606 printf(",");
607 remaining--;
608 } else {
609 printf(")\n");
610 }
611 }
612
613 printf(
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000614 " -h | --help: print this help text\n"
Peter Stuge6b53fed2008-01-27 16:21:21 +0000615 " -R | --version: print the version (release)\n"
Carl-Daniel Hailfinger5d1f4182009-06-24 08:18:38 +0000616 "\nYou can specify one of -E, -r, -w, -v or no operation. If no operation is\n"
617 "specified, then all that happens is that flash info is dumped.\n\n");
Ollie Lhocbbf1252004-03-17 22:22:08 +0000618 exit(1);
Ronald G. Minniche5559572003-03-28 03:29:43 +0000619}
620
Bernhard Walle201bde32008-01-21 15:24:22 +0000621void print_version(void)
622{
Carl-Daniel Hailfingera80cfbc2009-07-22 20:13:00 +0000623 printf("flashrom v%s\n", flashrom_version);
Bernhard Walle201bde32008-01-21 15:24:22 +0000624}
625
Ollie Lho761bf1b2004-03-20 16:46:10 +0000626int main(int argc, char *argv[])
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000627{
Ollie Lho184a4042005-11-26 21:55:36 +0000628 uint8_t *buf;
Peter Stuge1fec0f32009-01-12 21:00:35 +0000629 unsigned long size, numbytes;
Ollie Lho761bf1b2004-03-20 16:46:10 +0000630 FILE *image;
Claus Gindhart2fd11d62008-05-08 00:31:44 +0000631 /* Probe for up to three flash chips. */
632 struct flashchip *flash, *flashes[3];
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +0000633 const char *name;
634 int namelen;
Ollie Lhocbbf1252004-03-17 22:22:08 +0000635 int opt;
Ollie Lho184a4042005-11-26 21:55:36 +0000636 int option_index = 0;
Peter Stuge7ffbc6f2008-06-18 02:08:40 +0000637 int force = 0;
Uwe Hermanna7e05482007-05-09 10:17:44 +0000638 int read_it = 0, write_it = 0, erase_it = 0, verify_it = 0;
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000639 int dont_verify_it = 0, list_supported = 0;
Uwe Hermann707f1eb2009-09-18 13:38:14 +0000640#if PRINT_WIKI_SUPPORT == 1
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000641 int list_supported_wiki = 0;
642#endif
Carl-Daniel Hailfinger01d6aba2009-06-12 14:02:07 +0000643 int operation_specified = 0;
Claus Gindhart2fd11d62008-05-08 00:31:44 +0000644 int ret = 0, i;
Ollie Lho184a4042005-11-26 21:55:36 +0000645
Uwe Hermann707f1eb2009-09-18 13:38:14 +0000646#if PRINT_WIKI_SUPPORT == 1
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000647 const char *optstring = "rRwvnVEfc:m:l:i:p:Lzh";
648#else
649 const char *optstring = "rRwvnVEfc:m:l:i:p:Lh";
650#endif
Uwe Hermanna7e05482007-05-09 10:17:44 +0000651 static struct option long_options[] = {
652 {"read", 0, 0, 'r'},
653 {"write", 0, 0, 'w'},
654 {"erase", 0, 0, 'E'},
655 {"verify", 0, 0, 'v'},
Uwe Hermannea07f622009-06-24 17:31:08 +0000656 {"noverify", 0, 0, 'n'},
Uwe Hermanna7e05482007-05-09 10:17:44 +0000657 {"chip", 1, 0, 'c'},
Uwe Hermanna7e05482007-05-09 10:17:44 +0000658 {"mainboard", 1, 0, 'm'},
659 {"verbose", 0, 0, 'V'},
660 {"force", 0, 0, 'f'},
661 {"layout", 1, 0, 'l'},
662 {"image", 1, 0, 'i'},
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000663 {"list-supported", 0, 0, 'L'},
Uwe Hermann707f1eb2009-09-18 13:38:14 +0000664#if PRINT_WIKI_SUPPORT == 1
Uwe Hermann20a293f2009-06-19 10:42:43 +0000665 {"list-supported-wiki", 0, 0, 'z'},
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000666#endif
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +0000667 {"programmer", 1, 0, 'p'},
Uwe Hermanna7e05482007-05-09 10:17:44 +0000668 {"help", 0, 0, 'h'},
Bernhard Walle201bde32008-01-21 15:24:22 +0000669 {"version", 0, 0, 'R'},
Uwe Hermanna7e05482007-05-09 10:17:44 +0000670 {0, 0, 0, 0}
Ollie Lho184a4042005-11-26 21:55:36 +0000671 };
Uwe Hermanna7e05482007-05-09 10:17:44 +0000672
Ollie Lhocbbf1252004-03-17 22:22:08 +0000673 char *filename = NULL;
Ronald G. Minnichceec4202003-07-25 04:37:41 +0000674
Uwe Hermanna7e05482007-05-09 10:17:44 +0000675 char *tempstr = NULL, *tempstr2 = NULL;
Yinghai Luad8ffd22004-10-20 05:07:16 +0000676
Carl-Daniel Hailfinger259fa012009-05-07 00:59:53 +0000677 print_version();
678
Yinghai Luad8ffd22004-10-20 05:07:16 +0000679 if (argc > 1) {
680 /* Yes, print them. */
681 int i;
Uwe Hermanna7e05482007-05-09 10:17:44 +0000682 printf_debug("The arguments are:\n");
Yinghai Luad8ffd22004-10-20 05:07:16 +0000683 for (i = 1; i < argc; ++i)
Uwe Hermanna7e05482007-05-09 10:17:44 +0000684 printf_debug("%s\n", argv[i]);
Yinghai Luad8ffd22004-10-20 05:07:16 +0000685 }
686
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +0000687 /* Safety check. */
688 if (ARRAY_SIZE(programmer_table) - 1 != PROGRAMMER_INVALID) {
689 fprintf(stderr, "Programmer table miscompilation!\n");
690 exit(1);
691 }
Carl-Daniel Hailfinger3426ef62009-08-19 13:27:58 +0000692 if (spi_programmer_count - 1 != SPI_CONTROLLER_INVALID) {
693 fprintf(stderr, "SPI programmer table miscompilation!\n");
694 exit(1);
695 }
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +0000696#if BITBANG_SPI_SUPPORT == 1
697 if (spi_bitbang_master_count - 1 != SPI_BITBANG_INVALID) {
698 fprintf(stderr, "Bitbanging SPI master table miscompilation!\n");
699 exit(1);
700 }
701#endif
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +0000702
Ollie Lhocbbf1252004-03-17 22:22:08 +0000703 setbuf(stdout, NULL);
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000704 while ((opt = getopt_long(argc, argv, optstring,
Uwe Hermanna7e05482007-05-09 10:17:44 +0000705 long_options, &option_index)) != EOF) {
Ollie Lhocbbf1252004-03-17 22:22:08 +0000706 switch (opt) {
707 case 'r':
Carl-Daniel Hailfinger01d6aba2009-06-12 14:02:07 +0000708 if (++operation_specified > 1) {
709 fprintf(stderr, "More than one operation "
710 "specified. Aborting.\n");
711 exit(1);
712 }
Ollie Lhocbbf1252004-03-17 22:22:08 +0000713 read_it = 1;
714 break;
715 case 'w':
Carl-Daniel Hailfinger01d6aba2009-06-12 14:02:07 +0000716 if (++operation_specified > 1) {
717 fprintf(stderr, "More than one operation "
718 "specified. Aborting.\n");
719 exit(1);
720 }
Ollie Lhocbbf1252004-03-17 22:22:08 +0000721 write_it = 1;
722 break;
723 case 'v':
Carl-Daniel Hailfinger01d6aba2009-06-12 14:02:07 +0000724 if (++operation_specified > 1) {
725 fprintf(stderr, "More than one operation "
726 "specified. Aborting.\n");
727 exit(1);
728 }
Ollie Lhocbbf1252004-03-17 22:22:08 +0000729 verify_it = 1;
730 break;
Uwe Hermannea07f622009-06-24 17:31:08 +0000731 case 'n':
732 dont_verify_it = 1;
733 break;
Ollie Lhocbbf1252004-03-17 22:22:08 +0000734 case 'c':
735 chip_to_probe = strdup(optarg);
736 break;
Ollie Lho789ad3d2004-03-18 20:27:33 +0000737 case 'V':
738 verbose = 1;
739 break;
Ollie Lhoefa28582004-12-08 20:10:01 +0000740 case 'E':
Carl-Daniel Hailfinger01d6aba2009-06-12 14:02:07 +0000741 if (++operation_specified > 1) {
742 fprintf(stderr, "More than one operation "
743 "specified. Aborting.\n");
744 exit(1);
745 }
Ollie Lhoefa28582004-12-08 20:10:01 +0000746 erase_it = 1;
747 break;
Ollie Lho184a4042005-11-26 21:55:36 +0000748 case 'm':
749 tempstr = strdup(optarg);
750 strtok(tempstr, ":");
Uwe Hermanna7e05482007-05-09 10:17:44 +0000751 tempstr2 = strtok(NULL, ":");
Ollie Lho184a4042005-11-26 21:55:36 +0000752 if (tempstr2) {
Uwe Hermanna7e05482007-05-09 10:17:44 +0000753 lb_vendor = tempstr;
754 lb_part = tempstr2;
Ollie Lho184a4042005-11-26 21:55:36 +0000755 } else {
Peter Stuge6b53fed2008-01-27 16:21:21 +0000756 lb_vendor = NULL;
757 lb_part = tempstr;
Ollie Lho184a4042005-11-26 21:55:36 +0000758 }
759 break;
760 case 'f':
Uwe Hermanna7e05482007-05-09 10:17:44 +0000761 force = 1;
Ollie Lho184a4042005-11-26 21:55:36 +0000762 break;
763 case 'l':
Uwe Hermanna7e05482007-05-09 10:17:44 +0000764 tempstr = strdup(optarg);
Stefan Reinauer0a05d672007-04-14 16:32:59 +0000765 if (read_romlayout(tempstr))
766 exit(1);
Ollie Lho184a4042005-11-26 21:55:36 +0000767 break;
768 case 'i':
Uwe Hermanna7e05482007-05-09 10:17:44 +0000769 tempstr = strdup(optarg);
Ollie Lho184a4042005-11-26 21:55:36 +0000770 find_romentry(tempstr);
771 break;
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000772 case 'L':
Uwe Hermann05fab752009-05-16 23:42:17 +0000773 list_supported = 1;
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000774 break;
Uwe Hermann707f1eb2009-09-18 13:38:14 +0000775#if PRINT_WIKI_SUPPORT == 1
Uwe Hermann20a293f2009-06-19 10:42:43 +0000776 case 'z':
777 list_supported_wiki = 1;
778 break;
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000779#endif
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +0000780 case 'p':
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +0000781 for (programmer = 0; programmer < PROGRAMMER_INVALID; programmer++) {
782 name = programmer_table[programmer].name;
783 namelen = strlen(name);
784 if (strncmp(optarg, name, namelen) == 0) {
785 switch (optarg[namelen]) {
Carl-Daniel Hailfinger664e7ad2009-08-19 15:03:28 +0000786 case ':':
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +0000787 programmer_param = strdup(optarg + namelen + 1);
788 break;
789 case '\0':
790 break;
791 default:
792 /* The continue refers to the
793 * for loop. It is here to be
794 * able to differentiate between
795 * foo and foobar.
796 */
797 continue;
798 }
799 break;
800 }
801 }
802 if (programmer == PROGRAMMER_INVALID) {
Carl-Daniel Hailfinger664e7ad2009-08-19 15:03:28 +0000803 printf("Error: Unknown programmer %s.\n", optarg);
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +0000804 exit(1);
805 }
806 break;
Bernhard Walle201bde32008-01-21 15:24:22 +0000807 case 'R':
Carl-Daniel Hailfinger259fa012009-05-07 00:59:53 +0000808 /* print_version() is always called during startup. */
Bernhard Walle201bde32008-01-21 15:24:22 +0000809 exit(0);
810 break;
Ollie Lho184a4042005-11-26 21:55:36 +0000811 case 'h':
Ollie Lhocbbf1252004-03-17 22:22:08 +0000812 default:
813 usage(argv[0]);
814 break;
815 }
816 }
Yinghai Luad8ffd22004-10-20 05:07:16 +0000817
Uwe Hermann05fab752009-05-16 23:42:17 +0000818 if (list_supported) {
819 print_supported_chips();
820 print_supported_chipsets();
821 print_supported_boards();
822 printf("\nSupported PCI devices flashrom can use "
823 "as programmer:\n\n");
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +0000824#if NIC3COM_SUPPORT == 1
Uwe Hermann05fab752009-05-16 23:42:17 +0000825 print_supported_pcidevs(nics_3com);
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +0000826#endif
827#if DRKAISER_SUPPORT == 1
TURBO Jb0912c02009-09-02 23:00:46 +0000828 print_supported_pcidevs(drkaiser_pcidev);
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +0000829#endif
830#if SATASII_SUPPORT == 1
Uwe Hermanneaefb482009-05-17 22:57:34 +0000831 print_supported_pcidevs(satas_sii);
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +0000832#endif
Uwe Hermann05fab752009-05-16 23:42:17 +0000833 exit(0);
834 }
835
Uwe Hermann707f1eb2009-09-18 13:38:14 +0000836#if PRINT_WIKI_SUPPORT == 1
Uwe Hermann20a293f2009-06-19 10:42:43 +0000837 if (list_supported_wiki) {
Uwe Hermanna2d05012009-06-20 01:21:38 +0000838 print_wiki_tables();
Uwe Hermann20a293f2009-06-19 10:42:43 +0000839 exit(0);
840 }
Carl-Daniel Hailfinger9c8476b2009-09-16 12:19:03 +0000841#endif
Uwe Hermann20a293f2009-06-19 10:42:43 +0000842
Ollie Lhocbbf1252004-03-17 22:22:08 +0000843 if (read_it && write_it) {
Uwe Hermann793bdcd2008-05-22 22:47:04 +0000844 printf("Error: -r and -w are mutually exclusive.\n");
Ollie Lhocbbf1252004-03-17 22:22:08 +0000845 usage(argv[0]);
846 }
Ronald G. Minniche5559572003-03-28 03:29:43 +0000847
Ollie Lhocbbf1252004-03-17 22:22:08 +0000848 if (optind < argc)
849 filename = argv[optind++];
Ronald G. Minniche5559572003-03-28 03:29:43 +0000850
Carl-Daniel Hailfinger34cc6cc2009-06-28 10:57:58 +0000851 if (programmer_init()) {
852 fprintf(stderr, "Error: Programmer initialization failed.\n");
853 exit(1);
854 }
Luc Verhaegen8e3a6002007-04-04 22:45:58 +0000855
Ollie Lhocbbf1252004-03-17 22:22:08 +0000856 myusec_calibrate_delay();
Ollie Lho184a4042005-11-26 21:55:36 +0000857
Claus Gindhart2fd11d62008-05-08 00:31:44 +0000858 for (i = 0; i < ARRAY_SIZE(flashes); i++) {
Uwe Hermann394131e2008-10-18 21:14:13 +0000859 flashes[i] =
860 probe_flash(i ? flashes[i - 1] + 1 : flashchips, 0);
Claus Gindhart2fd11d62008-05-08 00:31:44 +0000861 if (!flashes[i])
862 for (i++; i < ARRAY_SIZE(flashes); i++)
863 flashes[i] = NULL;
864 }
865
866 if (flashes[1]) {
867 printf("Multiple flash chips were detected:");
868 for (i = 0; i < ARRAY_SIZE(flashes) && flashes[i]; i++)
869 printf(" %s", flashes[i]->name);
870 printf("\nPlease specify which chip to use with the -c <chipname> option.\n");
871 exit(1);
872 } else if (!flashes[0]) {
Ollie Lho184a4042005-11-26 21:55:36 +0000873 printf("No EEPROM/flash device found.\n");
Peter Stuge7ffbc6f2008-06-18 02:08:40 +0000874 if (!force || !chip_to_probe) {
875 printf("If you know which flash chip you have, and if this version of flashrom\n");
876 printf("supports a similar flash chip, you can try to force read your chip. Run:\n");
877 printf("flashrom -f -r -c similar_supported_flash_chip filename\n");
878 printf("\n");
879 printf("Note: flashrom can never write when the flash chip isn't found automatically.\n");
880 }
881 if (force && read_it && chip_to_probe) {
882 printf("Force read (-f -r -c) requested, forcing chip probe success:\n");
883 flashes[0] = probe_flash(flashchips, 1);
884 if (!flashes[0]) {
885 printf("flashrom does not support a flash chip named '%s'.\n", chip_to_probe);
886 printf("Run flashrom -L to view the hardware supported in this flashrom version.\n");
887 exit(1);
888 }
Carl-Daniel Hailfinger8ab49e72009-08-19 13:55:34 +0000889 printf("Please note that forced reads most likely contain garbage.\n");
Carl-Daniel Hailfinger49eb4dd2009-06-19 11:23:57 +0000890 return read_flash(flashes[0], filename);
Peter Stuge7ffbc6f2008-06-18 02:08:40 +0000891 }
Jordan Crouse144ede62007-10-04 06:26:41 +0000892 // FIXME: flash writes stay enabled!
Ollie Lhocbbf1252004-03-17 22:22:08 +0000893 exit(1);
894 }
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000895
Claus Gindhart2fd11d62008-05-08 00:31:44 +0000896 flash = flashes[0];
897
Peter Stuge1159d582008-05-03 04:34:37 +0000898 if (TEST_OK_MASK != (flash->tested & TEST_OK_MASK)) {
899 printf("===\n");
900 if (flash->tested & TEST_BAD_MASK) {
901 printf("This flash part has status NOT WORKING for operations:");
902 if (flash->tested & TEST_BAD_PROBE)
903 printf(" PROBE");
904 if (flash->tested & TEST_BAD_READ)
905 printf(" READ");
906 if (flash->tested & TEST_BAD_ERASE)
907 printf(" ERASE");
908 if (flash->tested & TEST_BAD_WRITE)
909 printf(" WRITE");
910 printf("\n");
Carl-Daniel Hailfinger6a0a25c2008-11-28 23:45:27 +0000911 }
912 if ((!(flash->tested & TEST_BAD_PROBE) && !(flash->tested & TEST_OK_PROBE)) ||
913 (!(flash->tested & TEST_BAD_READ) && !(flash->tested & TEST_OK_READ)) ||
914 (!(flash->tested & TEST_BAD_ERASE) && !(flash->tested & TEST_OK_ERASE)) ||
915 (!(flash->tested & TEST_BAD_WRITE) && !(flash->tested & TEST_OK_WRITE))) {
Peter Stuge1159d582008-05-03 04:34:37 +0000916 printf("This flash part has status UNTESTED for operations:");
Carl-Daniel Hailfinger6a0a25c2008-11-28 23:45:27 +0000917 if (!(flash->tested & TEST_BAD_PROBE) && !(flash->tested & TEST_OK_PROBE))
Peter Stuge1159d582008-05-03 04:34:37 +0000918 printf(" PROBE");
Carl-Daniel Hailfinger6a0a25c2008-11-28 23:45:27 +0000919 if (!(flash->tested & TEST_BAD_READ) && !(flash->tested & TEST_OK_READ))
Peter Stuge1159d582008-05-03 04:34:37 +0000920 printf(" READ");
Carl-Daniel Hailfinger6a0a25c2008-11-28 23:45:27 +0000921 if (!(flash->tested & TEST_BAD_ERASE) && !(flash->tested & TEST_OK_ERASE))
Peter Stuge1159d582008-05-03 04:34:37 +0000922 printf(" ERASE");
Carl-Daniel Hailfinger6a0a25c2008-11-28 23:45:27 +0000923 if (!(flash->tested & TEST_BAD_WRITE) && !(flash->tested & TEST_OK_WRITE))
Peter Stuge1159d582008-05-03 04:34:37 +0000924 printf(" WRITE");
925 printf("\n");
926 }
Stefan Reinauer22ea8cd2009-07-30 13:32:26 +0000927 printf("Please email a report to flashrom@flashrom.org if any "
Uwe Hermanna9720402009-05-21 15:55:46 +0000928 "of the above operations\nwork correctly for you with "
929 "this flash part. Please include the flashrom\noutput "
930 "with the additional -V option for all operations you "
931 "tested (-V, -rV,\n-wV, -EV), and mention which "
932 "mainboard you tested. Thanks for your help!\n===\n");
Peter Stuge1159d582008-05-03 04:34:37 +0000933 }
Ollie Lho184a4042005-11-26 21:55:36 +0000934
Jordan Crouse144ede62007-10-04 06:26:41 +0000935 if (!(read_it | write_it | verify_it | erase_it)) {
936 printf("No operations were specified.\n");
937 // FIXME: flash writes stay enabled!
938 exit(1);
939 }
940
Ollie Lhoefa28582004-12-08 20:10:01 +0000941 if (!filename && !erase_it) {
Jordan Crouse144ede62007-10-04 06:26:41 +0000942 printf("Error: No filename specified.\n");
943 // FIXME: flash writes stay enabled!
944 exit(1);
Ollie Lhocbbf1252004-03-17 22:22:08 +0000945 }
Ollie Lhocbbf1252004-03-17 22:22:08 +0000946
Uwe Hermannea07f622009-06-24 17:31:08 +0000947 /* Always verify write operations unless -n is used. */
948 if (write_it && !dont_verify_it)
949 verify_it = 1;
950
Ollie Lho184a4042005-11-26 21:55:36 +0000951 size = flash->total_size * 1024;
952 buf = (uint8_t *) calloc(size, sizeof(char));
Uwe Hermanna7e05482007-05-09 10:17:44 +0000953
Ollie Lhoefa28582004-12-08 20:10:01 +0000954 if (erase_it) {
Carl-Daniel Hailfinger8ab49e72009-08-19 13:55:34 +0000955 if (flash->tested & TEST_BAD_ERASE) {
956 fprintf(stderr, "Erase is not working on this chip. ");
957 if (!force) {
958 fprintf(stderr, "Aborting.\n");
959 return 1;
960 } else {
961 fprintf(stderr, "Continuing anyway.\n");
962 }
963 }
964 if (erase_flash(flash)) {
965 emergency_help_message();
Peter Stugef31104c2008-04-28 14:47:30 +0000966 return 1;
Carl-Daniel Hailfinger8ab49e72009-08-19 13:55:34 +0000967 }
Ollie Lhoefa28582004-12-08 20:10:01 +0000968 } else if (read_it) {
Carl-Daniel Hailfinger49eb4dd2009-06-19 11:23:57 +0000969 if (read_flash(flash, filename))
Peter Stuge1fec0f32009-01-12 21:00:35 +0000970 return 1;
Ollie Lhocbbf1252004-03-17 22:22:08 +0000971 } else {
Stefan Reinauer018aca82006-11-21 23:48:51 +0000972 struct stat image_stat;
973
Carl-Daniel Hailfinger8ab49e72009-08-19 13:55:34 +0000974 if (flash->tested & TEST_BAD_ERASE) {
975 fprintf(stderr, "Erase is not working on this chip "
976 "and erase is needed for write. ");
977 if (!force) {
978 fprintf(stderr, "Aborting.\n");
979 return 1;
980 } else {
981 fprintf(stderr, "Continuing anyway.\n");
982 }
983 }
984 if (flash->tested & TEST_BAD_WRITE) {
985 fprintf(stderr, "Write is not working on this chip. ");
986 if (!force) {
987 fprintf(stderr, "Aborting.\n");
988 return 1;
989 } else {
990 fprintf(stderr, "Continuing anyway.\n");
991 }
992 }
Ollie Lho761bf1b2004-03-20 16:46:10 +0000993 if ((image = fopen(filename, "r")) == NULL) {
Ollie Lhocbbf1252004-03-17 22:22:08 +0000994 perror(filename);
995 exit(1);
996 }
Stefan Reinauer018aca82006-11-21 23:48:51 +0000997 if (fstat(fileno(image), &image_stat) != 0) {
998 perror(filename);
999 exit(1);
1000 }
Uwe Hermanna7e05482007-05-09 10:17:44 +00001001 if (image_stat.st_size != flash->total_size * 1024) {
Uwe Hermann793bdcd2008-05-22 22:47:04 +00001002 fprintf(stderr, "Error: Image size doesn't match\n");
Stefan Reinauer018aca82006-11-21 23:48:51 +00001003 exit(1);
1004 }
1005
Peter Stuge1fec0f32009-01-12 21:00:35 +00001006 numbytes = fread(buf, 1, size, image);
Peter Stuge7ffbc6f2008-06-18 02:08:40 +00001007 show_id(buf, size, force);
Ollie Lhocbbf1252004-03-17 22:22:08 +00001008 fclose(image);
Peter Stuge1fec0f32009-01-12 21:00:35 +00001009 if (numbytes != size) {
1010 fprintf(stderr, "Error: Failed to read file. Got %ld bytes, wanted %ld!\n", numbytes, size);
1011 return 1;
1012 }
Ollie Lhocbbf1252004-03-17 22:22:08 +00001013 }
1014
Ollie Lho184a4042005-11-26 21:55:36 +00001015 // This should be moved into each flash part's code to do it
1016 // cleanly. This does the job.
Carl-Daniel Hailfingerf5fb51c2009-08-19 15:19:18 +00001017 handle_romentries(buf, flash);
Uwe Hermanna7e05482007-05-09 10:17:44 +00001018
Ollie Lho184a4042005-11-26 21:55:36 +00001019 // ////////////////////////////////////////////////////////////
Uwe Hermanna7e05482007-05-09 10:17:44 +00001020
Peter Stugef31104c2008-04-28 14:47:30 +00001021 if (write_it) {
Paul Foxd51410c2009-06-12 08:04:08 +00001022 printf("Writing flash chip... ");
Peter Stugef31104c2008-04-28 14:47:30 +00001023 if (!flash->write) {
1024 fprintf(stderr, "Error: flashrom has no write function for this flash chip.\n");
1025 return 1;
1026 }
Carl-Daniel Hailfinger0a3e5ae2009-07-24 12:18:54 +00001027 ret = flash->write(flash, buf);
1028 if (ret) {
1029 fprintf(stderr, "FAILED!\n");
Carl-Daniel Hailfinger8ab49e72009-08-19 13:55:34 +00001030 emergency_help_message();
Carl-Daniel Hailfinger0a3e5ae2009-07-24 12:18:54 +00001031 return 1;
1032 } else {
1033 printf("COMPLETE.\n");
1034 }
Peter Stugef31104c2008-04-28 14:47:30 +00001035 }
Ollie Lho184a4042005-11-26 21:55:36 +00001036
Carl-Daniel Hailfinger8ab49e72009-08-19 13:55:34 +00001037 if (verify_it) {
1038 /* Work around chips which need some time to calm down. */
1039 if (write_it)
1040 programmer_delay(1000*1000);
Carl-Daniel Hailfinger0a3e5ae2009-07-24 12:18:54 +00001041 ret = verify_flash(flash, buf);
Carl-Daniel Hailfinger8ab49e72009-08-19 13:55:34 +00001042 /* If we tried to write, and now we don't properly verify, we
1043 * might have an emergency situation.
1044 */
1045 if (ret && write_it)
1046 emergency_help_message();
1047 }
Ollie Lho184a4042005-11-26 21:55:36 +00001048
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +00001049 programmer_shutdown();
1050
Stefan Reinauer143da0b2006-01-04 16:42:57 +00001051 return ret;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +00001052}