blob: 1083abe2d632d2b93a2bddffa169002b893661e0 [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
Carl-Daniel Hailfinger831e8f42010-05-30 22:24:40 +000024#include <stdio.h>
Stefan Reinauer018aca82006-11-21 23:48:51 +000025#include <sys/types.h>
Patrick Georgia9095a92010-09-30 17:03:32 +000026#ifndef __LIBPAYLOAD__
27#include <fcntl.h>
Stefan Reinauer018aca82006-11-21 23:48:51 +000028#include <sys/stat.h>
Patrick Georgia9095a92010-09-30 17:03:32 +000029#endif
Ronald G. Minnichceec4202003-07-25 04:37:41 +000030#include <string.h>
Ronald G. Minnicheaab50b2003-09-12 22:41:53 +000031#include <stdlib.h>
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +000032#include <ctype.h>
Ollie Lho184a4042005-11-26 21:55:36 +000033#include <getopt.h>
Carl-Daniel Hailfinger132e2ec2010-03-27 16:36:40 +000034#if HAVE_UTSNAME == 1
35#include <sys/utsname.h>
36#endif
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +000037#include "flash.h"
Carl-Daniel Hailfinger08454642009-06-15 14:14:48 +000038#include "flashchips.h"
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000039#include "programmer.h"
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +000040
Mathias Krausea60faab2011-01-17 07:50:42 +000041const char flashrom_version[] = FLASHROM_VERSION;
Ronald G. Minnichceec4202003-07-25 04:37:41 +000042char *chip_to_probe = NULL;
Peter Stuge7ffbc6f2008-06-18 02:08:40 +000043int verbose = 0;
Carl-Daniel Hailfinger66ef4e52009-12-13 22:28:00 +000044
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000045#if CONFIG_INTERNAL == 1
Carl-Daniel Hailfinger415e5132009-08-12 11:39:29 +000046enum programmer programmer = PROGRAMMER_INTERNAL;
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000047#elif CONFIG_DUMMY == 1
Carl-Daniel Hailfinger66ef4e52009-12-13 22:28:00 +000048enum programmer programmer = PROGRAMMER_DUMMY;
49#else
Carl-Daniel Hailfinger1a1415c2010-01-10 13:28:48 +000050/* If neither internal nor dummy are selected, we must pick a sensible default.
51 * Since there is no reason to prefer a particular external programmer, we fail
52 * if more than one of them is selected. If only one is selected, it is clear
53 * that the user wants that one to become the default.
54 */
Carl-Daniel Hailfinger9a1105c2011-02-04 21:37:59 +000055#if CONFIG_NIC3COM+CONFIG_NICREALTEK+CONFIG_NICNATSEMI+CONFIG_GFXNVIDIA+CONFIG_DRKAISER+CONFIG_SATASII+CONFIG_ATAHPT+CONFIG_FT2232_SPI+CONFIG_SERPROG+CONFIG_BUSPIRATE_SPI+CONFIG_DEDIPROG+CONFIG_RAYER_SPI+CONFIG_NICINTEL_SPI+CONFIG_OGP_SPI+CONFIG_SATAMV > 1
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000056#error Please enable either CONFIG_DUMMY or CONFIG_INTERNAL or disable support for all programmers except one.
Carl-Daniel Hailfinger1a1415c2010-01-10 13:28:48 +000057#endif
58enum programmer programmer =
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000059#if CONFIG_NIC3COM == 1
Carl-Daniel Hailfinger1a1415c2010-01-10 13:28:48 +000060 PROGRAMMER_NIC3COM
61#endif
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000062#if CONFIG_NICREALTEK == 1
Joerg Fischer5665ef32010-05-21 21:54:07 +000063 PROGRAMMER_NICREALTEK
Joerg Fischer5665ef32010-05-21 21:54:07 +000064#endif
Andrew Morganc29c2e72010-06-07 22:37:54 +000065#if CONFIG_NICNATSEMI == 1
66 PROGRAMMER_NICNATSEMI
67#endif
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000068#if CONFIG_GFXNVIDIA == 1
Carl-Daniel Hailfinger1a1415c2010-01-10 13:28:48 +000069 PROGRAMMER_GFXNVIDIA
70#endif
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000071#if CONFIG_DRKAISER == 1
Carl-Daniel Hailfinger1a1415c2010-01-10 13:28:48 +000072 PROGRAMMER_DRKAISER
73#endif
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000074#if CONFIG_SATASII == 1
Carl-Daniel Hailfinger1a1415c2010-01-10 13:28:48 +000075 PROGRAMMER_SATASII
76#endif
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000077#if CONFIG_ATAHPT == 1
Uwe Hermannddd5c9e2010-02-21 21:17:00 +000078 PROGRAMMER_ATAHPT
79#endif
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000080#if CONFIG_FT2232_SPI == 1
81 PROGRAMMER_FT2232_SPI
Carl-Daniel Hailfinger1a1415c2010-01-10 13:28:48 +000082#endif
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000083#if CONFIG_SERPROG == 1
Carl-Daniel Hailfinger1a1415c2010-01-10 13:28:48 +000084 PROGRAMMER_SERPROG
85#endif
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000086#if CONFIG_BUSPIRATE_SPI == 1
87 PROGRAMMER_BUSPIRATE_SPI
Carl-Daniel Hailfinger1a1415c2010-01-10 13:28:48 +000088#endif
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000089#if CONFIG_DEDIPROG == 1
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +000090 PROGRAMMER_DEDIPROG
91#endif
Carl-Daniel Hailfingere7fdd6e2010-07-21 10:26:01 +000092#if CONFIG_RAYER_SPI == 1
93 PROGRAMMER_RAYER_SPI
94#endif
Idwer Vollering004f4b72010-09-03 18:21:21 +000095#if CONFIG_NICINTEL_SPI == 1
96 PROGRAMMER_NICINTEL_SPI
97#endif
Mark Marshall90021f22010-12-03 14:48:11 +000098#if CONFIG_OGP_SPI == 1
99 PROGRAMMER_OGP_SPI
100#endif
Carl-Daniel Hailfinger9a1105c2011-02-04 21:37:59 +0000101#if CONFIG_SATAMV == 1
102 PROGRAMMER_SATAMV
103#endif
Carl-Daniel Hailfinger1a1415c2010-01-10 13:28:48 +0000104;
Carl-Daniel Hailfinger66ef4e52009-12-13 22:28:00 +0000105#endif
106
Carl-Daniel Hailfinger2b6dcb32010-07-08 10:13:37 +0000107static char *programmer_param = NULL;
Stefan Reinauer70385642007-04-06 11:58:03 +0000108
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000109/* Supported buses for the current programmer. */
110enum chipbustype buses_supported;
Carl-Daniel Hailfinger66ef4e52009-12-13 22:28:00 +0000111
Uwe Hermann48ec1b12010-08-08 17:01:18 +0000112/*
Carl-Daniel Hailfinger66ef4e52009-12-13 22:28:00 +0000113 * Programmers supporting multiple buses can have differing size limits on
114 * each bus. Store the limits for each bus in a common struct.
115 */
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000116struct decode_sizes max_rom_decode;
117
118/* If nonzero, used as the start address of bottom-aligned flash. */
119unsigned long flashbase;
Carl-Daniel Hailfinger66ef4e52009-12-13 22:28:00 +0000120
Carl-Daniel Hailfingerd1be52d2010-07-03 12:14:25 +0000121/* Is writing allowed with this programmer? */
122int programmer_may_write;
123
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +0000124const struct programmer_entry programmer_table[] = {
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000125#if CONFIG_INTERNAL == 1
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +0000126 {
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +0000127 .name = "internal",
Carl-Daniel Hailfinger1e334e62009-05-11 15:46:43 +0000128 .init = internal_init,
129 .shutdown = internal_shutdown,
Carl-Daniel Hailfinger1455b2b2009-05-11 14:13:25 +0000130 .map_flash_region = physmap,
131 .unmap_flash_region = physunmap,
Carl-Daniel Hailfinger1e334e62009-05-11 15:46:43 +0000132 .chip_readb = internal_chip_readb,
133 .chip_readw = internal_chip_readw,
134 .chip_readl = internal_chip_readl,
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000135 .chip_readn = internal_chip_readn,
Carl-Daniel Hailfinger1e334e62009-05-11 15:46:43 +0000136 .chip_writeb = internal_chip_writeb,
137 .chip_writew = internal_chip_writew,
138 .chip_writel = internal_chip_writel,
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000139 .chip_writen = fallback_chip_writen,
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +0000140 .delay = internal_delay,
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +0000141 },
Carl-Daniel Hailfinger66ef4e52009-12-13 22:28:00 +0000142#endif
Luc Verhaegen8e3a6002007-04-04 22:45:58 +0000143
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000144#if CONFIG_DUMMY == 1
Carl-Daniel Hailfingerc3129202009-05-09 00:54:55 +0000145 {
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +0000146 .name = "dummy",
Carl-Daniel Hailfinger1e334e62009-05-11 15:46:43 +0000147 .init = dummy_init,
148 .shutdown = dummy_shutdown,
Carl-Daniel Hailfinger1455b2b2009-05-11 14:13:25 +0000149 .map_flash_region = dummy_map,
150 .unmap_flash_region = dummy_unmap,
Carl-Daniel Hailfinger1e334e62009-05-11 15:46:43 +0000151 .chip_readb = dummy_chip_readb,
152 .chip_readw = dummy_chip_readw,
153 .chip_readl = dummy_chip_readl,
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000154 .chip_readn = dummy_chip_readn,
Carl-Daniel Hailfinger1e334e62009-05-11 15:46:43 +0000155 .chip_writeb = dummy_chip_writeb,
156 .chip_writew = dummy_chip_writew,
157 .chip_writel = dummy_chip_writel,
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000158 .chip_writen = dummy_chip_writen,
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +0000159 .delay = internal_delay,
Carl-Daniel Hailfingerc3129202009-05-09 00:54:55 +0000160 },
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +0000161#endif
Carl-Daniel Hailfingerc3129202009-05-09 00:54:55 +0000162
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000163#if CONFIG_NIC3COM == 1
Uwe Hermannb4dcb712009-05-13 11:36:06 +0000164 {
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +0000165 .name = "nic3com",
Uwe Hermannb4dcb712009-05-13 11:36:06 +0000166 .init = nic3com_init,
167 .shutdown = nic3com_shutdown,
Uwe Hermannc6915932009-05-17 23:12:17 +0000168 .map_flash_region = fallback_map,
169 .unmap_flash_region = fallback_unmap,
Uwe Hermannb4dcb712009-05-13 11:36:06 +0000170 .chip_readb = nic3com_chip_readb,
Carl-Daniel Hailfinger9ee10772009-05-16 01:23:55 +0000171 .chip_readw = fallback_chip_readw,
172 .chip_readl = fallback_chip_readl,
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000173 .chip_readn = fallback_chip_readn,
Uwe Hermannb4dcb712009-05-13 11:36:06 +0000174 .chip_writeb = nic3com_chip_writeb,
Carl-Daniel Hailfinger9ee10772009-05-16 01:23:55 +0000175 .chip_writew = fallback_chip_writew,
176 .chip_writel = fallback_chip_writel,
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000177 .chip_writen = fallback_chip_writen,
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +0000178 .delay = internal_delay,
Uwe Hermannb4dcb712009-05-13 11:36:06 +0000179 },
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +0000180#endif
Uwe Hermannb4dcb712009-05-13 11:36:06 +0000181
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000182#if CONFIG_NICREALTEK == 1
Joerg Fischer5665ef32010-05-21 21:54:07 +0000183 {
Carl-Daniel Hailfinger40446ee2011-03-07 01:08:09 +0000184 /* This programmer works for Realtek RTL8139 and SMC 1211. */
Joerg Fischer5665ef32010-05-21 21:54:07 +0000185 .name = "nicrealtek",
Carl-Daniel Hailfinger40446ee2011-03-07 01:08:09 +0000186 //.name = "nicsmc1211",
Joerg Fischer5665ef32010-05-21 21:54:07 +0000187 .init = nicrealtek_init,
188 .shutdown = nicrealtek_shutdown,
189 .map_flash_region = fallback_map,
190 .unmap_flash_region = fallback_unmap,
191 .chip_readb = nicrealtek_chip_readb,
192 .chip_readw = fallback_chip_readw,
193 .chip_readl = fallback_chip_readl,
194 .chip_readn = fallback_chip_readn,
195 .chip_writeb = nicrealtek_chip_writeb,
196 .chip_writew = fallback_chip_writew,
197 .chip_writel = fallback_chip_writel,
198 .chip_writen = fallback_chip_writen,
199 .delay = internal_delay,
200 },
Joerg Fischer5665ef32010-05-21 21:54:07 +0000201#endif
202
Andrew Morganc29c2e72010-06-07 22:37:54 +0000203#if CONFIG_NICNATSEMI == 1
204 {
205 .name = "nicnatsemi",
206 .init = nicnatsemi_init,
207 .shutdown = nicnatsemi_shutdown,
208 .map_flash_region = fallback_map,
209 .unmap_flash_region = fallback_unmap,
210 .chip_readb = nicnatsemi_chip_readb,
211 .chip_readw = fallback_chip_readw,
212 .chip_readl = fallback_chip_readl,
213 .chip_readn = fallback_chip_readn,
214 .chip_writeb = nicnatsemi_chip_writeb,
215 .chip_writew = fallback_chip_writew,
216 .chip_writel = fallback_chip_writel,
217 .chip_writen = fallback_chip_writen,
218 .delay = internal_delay,
219 },
220#endif
Joerg Fischer5665ef32010-05-21 21:54:07 +0000221
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000222#if CONFIG_GFXNVIDIA == 1
Uwe Hermann2bc98f62009-09-30 18:29:55 +0000223 {
224 .name = "gfxnvidia",
225 .init = gfxnvidia_init,
226 .shutdown = gfxnvidia_shutdown,
227 .map_flash_region = fallback_map,
228 .unmap_flash_region = fallback_unmap,
229 .chip_readb = gfxnvidia_chip_readb,
230 .chip_readw = fallback_chip_readw,
231 .chip_readl = fallback_chip_readl,
232 .chip_readn = fallback_chip_readn,
233 .chip_writeb = gfxnvidia_chip_writeb,
234 .chip_writew = fallback_chip_writew,
235 .chip_writel = fallback_chip_writel,
236 .chip_writen = fallback_chip_writen,
237 .delay = internal_delay,
238 },
239#endif
240
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000241#if CONFIG_DRKAISER == 1
Rudolf Marek68720c72009-05-17 19:39:27 +0000242 {
TURBO Jb0912c02009-09-02 23:00:46 +0000243 .name = "drkaiser",
244 .init = drkaiser_init,
245 .shutdown = drkaiser_shutdown,
246 .map_flash_region = fallback_map,
247 .unmap_flash_region = fallback_unmap,
248 .chip_readb = drkaiser_chip_readb,
249 .chip_readw = fallback_chip_readw,
250 .chip_readl = fallback_chip_readl,
251 .chip_readn = fallback_chip_readn,
252 .chip_writeb = drkaiser_chip_writeb,
253 .chip_writew = fallback_chip_writew,
254 .chip_writel = fallback_chip_writel,
255 .chip_writen = fallback_chip_writen,
256 .delay = internal_delay,
257 },
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +0000258#endif
TURBO Jb0912c02009-09-02 23:00:46 +0000259
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000260#if CONFIG_SATASII == 1
TURBO Jb0912c02009-09-02 23:00:46 +0000261 {
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +0000262 .name = "satasii",
Rudolf Marek68720c72009-05-17 19:39:27 +0000263 .init = satasii_init,
264 .shutdown = satasii_shutdown,
Uwe Hermannc6915932009-05-17 23:12:17 +0000265 .map_flash_region = fallback_map,
266 .unmap_flash_region = fallback_unmap,
Rudolf Marek68720c72009-05-17 19:39:27 +0000267 .chip_readb = satasii_chip_readb,
268 .chip_readw = fallback_chip_readw,
269 .chip_readl = fallback_chip_readl,
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000270 .chip_readn = fallback_chip_readn,
Rudolf Marek68720c72009-05-17 19:39:27 +0000271 .chip_writeb = satasii_chip_writeb,
272 .chip_writew = fallback_chip_writew,
273 .chip_writel = fallback_chip_writel,
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000274 .chip_writen = fallback_chip_writen,
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +0000275 .delay = internal_delay,
Rudolf Marek68720c72009-05-17 19:39:27 +0000276 },
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +0000277#endif
Rudolf Marek68720c72009-05-17 19:39:27 +0000278
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000279#if CONFIG_ATAHPT == 1
Uwe Hermannddd5c9e2010-02-21 21:17:00 +0000280 {
281 .name = "atahpt",
282 .init = atahpt_init,
283 .shutdown = atahpt_shutdown,
284 .map_flash_region = fallback_map,
285 .unmap_flash_region = fallback_unmap,
286 .chip_readb = atahpt_chip_readb,
287 .chip_readw = fallback_chip_readw,
288 .chip_readl = fallback_chip_readl,
289 .chip_readn = fallback_chip_readn,
290 .chip_writeb = atahpt_chip_writeb,
291 .chip_writew = fallback_chip_writew,
292 .chip_writel = fallback_chip_writel,
293 .chip_writen = fallback_chip_writen,
294 .delay = internal_delay,
295 },
296#endif
297
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000298#if CONFIG_FT2232_SPI == 1
Paul Fox05dfbe62009-06-16 21:08:06 +0000299 {
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000300 .name = "ft2232_spi",
Paul Fox05dfbe62009-06-16 21:08:06 +0000301 .init = ft2232_spi_init,
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +0000302 .shutdown = noop_shutdown, /* Missing shutdown */
Carl-Daniel Hailfinger415e5132009-08-12 11:39:29 +0000303 .map_flash_region = fallback_map,
304 .unmap_flash_region = fallback_unmap,
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +0000305 .chip_readb = noop_chip_readb,
Paul Fox05dfbe62009-06-16 21:08:06 +0000306 .chip_readw = fallback_chip_readw,
307 .chip_readl = fallback_chip_readl,
308 .chip_readn = fallback_chip_readn,
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +0000309 .chip_writeb = noop_chip_writeb,
Paul Fox05dfbe62009-06-16 21:08:06 +0000310 .chip_writew = fallback_chip_writew,
311 .chip_writel = fallback_chip_writel,
312 .chip_writen = fallback_chip_writen,
313 .delay = internal_delay,
314 },
Carl-Daniel Hailfinger3426ef62009-08-19 13:27:58 +0000315#endif
Carl-Daniel Hailfinger415e5132009-08-12 11:39:29 +0000316
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000317#if CONFIG_SERPROG == 1
Urja Rannikko22915352009-06-23 11:33:43 +0000318 {
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +0000319 .name = "serprog",
Urja Rannikko22915352009-06-23 11:33:43 +0000320 .init = serprog_init,
321 .shutdown = serprog_shutdown,
322 .map_flash_region = fallback_map,
323 .unmap_flash_region = fallback_unmap,
324 .chip_readb = serprog_chip_readb,
325 .chip_readw = fallback_chip_readw,
326 .chip_readl = fallback_chip_readl,
327 .chip_readn = serprog_chip_readn,
328 .chip_writeb = serprog_chip_writeb,
329 .chip_writew = fallback_chip_writew,
330 .chip_writel = fallback_chip_writel,
331 .chip_writen = fallback_chip_writen,
332 .delay = serprog_delay,
333 },
Carl-Daniel Hailfinger6be74112009-08-12 16:17:41 +0000334#endif
Paul Fox05dfbe62009-06-16 21:08:06 +0000335
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000336#if CONFIG_BUSPIRATE_SPI == 1
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000337 {
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000338 .name = "buspirate_spi",
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000339 .init = buspirate_spi_init,
340 .shutdown = buspirate_spi_shutdown,
341 .map_flash_region = fallback_map,
342 .unmap_flash_region = fallback_unmap,
343 .chip_readb = noop_chip_readb,
344 .chip_readw = fallback_chip_readw,
345 .chip_readl = fallback_chip_readl,
346 .chip_readn = fallback_chip_readn,
347 .chip_writeb = noop_chip_writeb,
348 .chip_writew = fallback_chip_writew,
349 .chip_writel = fallback_chip_writel,
350 .chip_writen = fallback_chip_writen,
351 .delay = internal_delay,
352 },
353#endif
354
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000355#if CONFIG_DEDIPROG == 1
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000356 {
357 .name = "dediprog",
358 .init = dediprog_init,
359 .shutdown = dediprog_shutdown,
360 .map_flash_region = fallback_map,
361 .unmap_flash_region = fallback_unmap,
362 .chip_readb = noop_chip_readb,
363 .chip_readw = fallback_chip_readw,
364 .chip_readl = fallback_chip_readl,
365 .chip_readn = fallback_chip_readn,
366 .chip_writeb = noop_chip_writeb,
367 .chip_writew = fallback_chip_writew,
368 .chip_writel = fallback_chip_writel,
369 .chip_writen = fallback_chip_writen,
370 .delay = internal_delay,
371 },
372#endif
373
Carl-Daniel Hailfingere7fdd6e2010-07-21 10:26:01 +0000374#if CONFIG_RAYER_SPI == 1
375 {
376 .name = "rayer_spi",
377 .init = rayer_spi_init,
378 .shutdown = noop_shutdown,
379 .map_flash_region = fallback_map,
380 .unmap_flash_region = fallback_unmap,
381 .chip_readb = noop_chip_readb,
382 .chip_readw = fallback_chip_readw,
383 .chip_readl = fallback_chip_readl,
384 .chip_readn = fallback_chip_readn,
385 .chip_writeb = noop_chip_writeb,
386 .chip_writew = fallback_chip_writew,
387 .chip_writel = fallback_chip_writel,
388 .chip_writen = fallback_chip_writen,
389 .delay = internal_delay,
390 },
391#endif
392
Idwer Vollering004f4b72010-09-03 18:21:21 +0000393#if CONFIG_NICINTEL_SPI == 1
394 {
395 .name = "nicintel_spi",
396 .init = nicintel_spi_init,
397 .shutdown = nicintel_spi_shutdown,
398 .map_flash_region = fallback_map,
399 .unmap_flash_region = fallback_unmap,
400 .chip_readb = noop_chip_readb,
401 .chip_readw = fallback_chip_readw,
402 .chip_readl = fallback_chip_readl,
403 .chip_readn = fallback_chip_readn,
404 .chip_writeb = noop_chip_writeb,
405 .chip_writew = fallback_chip_writew,
406 .chip_writel = fallback_chip_writel,
407 .chip_writen = fallback_chip_writen,
408 .delay = internal_delay,
409 },
410#endif
411
Mark Marshall90021f22010-12-03 14:48:11 +0000412#if CONFIG_OGP_SPI == 1
413 {
414 .name = "ogp_spi",
415 .init = ogp_spi_init,
416 .shutdown = ogp_spi_shutdown,
417 .map_flash_region = fallback_map,
418 .unmap_flash_region = fallback_unmap,
419 .chip_readb = noop_chip_readb,
420 .chip_readw = fallback_chip_readw,
421 .chip_readl = fallback_chip_readl,
422 .chip_readn = fallback_chip_readn,
423 .chip_writeb = noop_chip_writeb,
424 .chip_writew = fallback_chip_writew,
425 .chip_writel = fallback_chip_writel,
426 .chip_writen = fallback_chip_writen,
427 .delay = internal_delay,
428 },
429#endif
430
Carl-Daniel Hailfinger9a1105c2011-02-04 21:37:59 +0000431#if CONFIG_SATAMV == 1
432 {
433 .name = "satamv",
434 .init = satamv_init,
435 .shutdown = satamv_shutdown,
436 .map_flash_region = fallback_map,
437 .unmap_flash_region = fallback_unmap,
438 .chip_readb = satamv_chip_readb,
439 .chip_readw = fallback_chip_readw,
440 .chip_readl = fallback_chip_readl,
441 .chip_readn = fallback_chip_readn,
442 .chip_writeb = satamv_chip_writeb,
443 .chip_writew = fallback_chip_writew,
444 .chip_writel = fallback_chip_writel,
445 .chip_writen = fallback_chip_writen,
446 .delay = internal_delay,
447 },
448#endif
449
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +0000450 {}, /* This entry corresponds to PROGRAMMER_INVALID. */
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +0000451};
Luc Verhaegen8e3a6002007-04-04 22:45:58 +0000452
Carl-Daniel Hailfinger2bee8cf2010-11-10 15:25:18 +0000453#define SHUTDOWN_MAXFN 32
Carl-Daniel Hailfingercc389fc2010-02-14 01:20:28 +0000454static int shutdown_fn_count = 0;
455struct shutdown_func_data {
456 void (*func) (void *data);
457 void *data;
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000458} static shutdown_fn[SHUTDOWN_MAXFN];
459/* Initialize to 0 to make sure nobody registers a shutdown function before
460 * programmer init.
461 */
462static int may_register_shutdown = 0;
Carl-Daniel Hailfingercc389fc2010-02-14 01:20:28 +0000463
464/* Register a function to be executed on programmer shutdown.
465 * The advantage over atexit() is that you can supply a void pointer which will
466 * be used as parameter to the registered function upon programmer shutdown.
467 * This pointer can point to arbitrary data used by said function, e.g. undo
468 * information for GPIO settings etc. If unneeded, set data=NULL.
469 * Please note that the first (void *data) belongs to the function signature of
470 * the function passed as first parameter.
471 */
472int register_shutdown(void (*function) (void *data), void *data)
473{
474 if (shutdown_fn_count >= SHUTDOWN_MAXFN) {
Carl-Daniel Hailfinger9f5f2152010-06-04 23:20:21 +0000475 msg_perr("Tried to register more than %i shutdown functions.\n",
Carl-Daniel Hailfingercc389fc2010-02-14 01:20:28 +0000476 SHUTDOWN_MAXFN);
477 return 1;
478 }
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000479 if (!may_register_shutdown) {
480 msg_perr("Tried to register a shutdown function before "
481 "programmer init.\n");
482 return 1;
483 }
Carl-Daniel Hailfingercc389fc2010-02-14 01:20:28 +0000484 shutdown_fn[shutdown_fn_count].func = function;
485 shutdown_fn[shutdown_fn_count].data = data;
486 shutdown_fn_count++;
487
488 return 0;
489}
490
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000491int programmer_init(char *param)
Uwe Hermann09e04f72009-05-16 22:36:00 +0000492{
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000493 int ret;
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000494 /* Initialize all programmer specific data. */
495 /* Default to unlimited decode sizes. */
496 max_rom_decode = (const struct decode_sizes) {
497 .parallel = 0xffffffff,
498 .lpc = 0xffffffff,
499 .fwh = 0xffffffff,
500 .spi = 0xffffffff
501 };
502 /* Default to Parallel/LPC/FWH flash devices. If a known host controller
503 * is found, the init routine sets the buses_supported bitfield.
504 */
505 buses_supported = CHIP_BUSTYPE_NONSPI;
506 /* Default to top aligned flash at 4 GB. */
507 flashbase = 0;
508 /* Registering shutdown functions is now allowed. */
509 may_register_shutdown = 1;
Carl-Daniel Hailfingerd1be52d2010-07-03 12:14:25 +0000510 /* Default to allowing writes. Broken programmers set this to 0. */
511 programmer_may_write = 1;
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000512
513 programmer_param = param;
514 msg_pdbg("Initializing %s programmer\n",
515 programmer_table[programmer].name);
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000516 ret = programmer_table[programmer].init();
517 if (programmer_param && strlen(programmer_param)) {
518 msg_perr("Unhandled programmer parameters: %s\n",
519 programmer_param);
520 /* Do not error out here, the init itself was successful. */
521 }
522 return ret;
Uwe Hermann09e04f72009-05-16 22:36:00 +0000523}
524
525int programmer_shutdown(void)
526{
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000527 /* Registering shutdown functions is no longer allowed. */
528 may_register_shutdown = 0;
529 while (shutdown_fn_count > 0) {
530 int i = --shutdown_fn_count;
Carl-Daniel Hailfingercc389fc2010-02-14 01:20:28 +0000531 shutdown_fn[i].func(shutdown_fn[i].data);
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000532 }
Uwe Hermann09e04f72009-05-16 22:36:00 +0000533 return programmer_table[programmer].shutdown();
534}
535
536void *programmer_map_flash_region(const char *descr, unsigned long phys_addr,
537 size_t len)
538{
539 return programmer_table[programmer].map_flash_region(descr,
540 phys_addr, len);
541}
542
543void programmer_unmap_flash_region(void *virt_addr, size_t len)
544{
545 programmer_table[programmer].unmap_flash_region(virt_addr, len);
546}
547
548void chip_writeb(uint8_t val, chipaddr addr)
549{
550 programmer_table[programmer].chip_writeb(val, addr);
551}
552
553void chip_writew(uint16_t val, chipaddr addr)
554{
555 programmer_table[programmer].chip_writew(val, addr);
556}
557
558void chip_writel(uint32_t val, chipaddr addr)
559{
560 programmer_table[programmer].chip_writel(val, addr);
561}
562
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000563void chip_writen(uint8_t *buf, chipaddr addr, size_t len)
564{
565 programmer_table[programmer].chip_writen(buf, addr, len);
566}
567
Uwe Hermann09e04f72009-05-16 22:36:00 +0000568uint8_t chip_readb(const chipaddr addr)
569{
570 return programmer_table[programmer].chip_readb(addr);
571}
572
573uint16_t chip_readw(const chipaddr addr)
574{
575 return programmer_table[programmer].chip_readw(addr);
576}
577
578uint32_t chip_readl(const chipaddr addr)
579{
580 return programmer_table[programmer].chip_readl(addr);
581}
582
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000583void chip_readn(uint8_t *buf, chipaddr addr, size_t len)
584{
585 programmer_table[programmer].chip_readn(buf, addr, len);
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000586}
587
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +0000588void programmer_delay(int usecs)
589{
590 programmer_table[programmer].delay(usecs);
591}
592
Peter Stuge776d2022009-01-26 00:39:57 +0000593void map_flash_registers(struct flashchip *flash)
Stefan Reinauerff4f1972007-05-24 08:48:10 +0000594{
Stefan Reinauerff4f1972007-05-24 08:48:10 +0000595 size_t size = flash->total_size * 1024;
Carl-Daniel Hailfingerd0fc9462009-05-11 14:01:17 +0000596 /* Flash registers live 4 MByte below the flash. */
Carl-Daniel Hailfinger8ab49e72009-08-19 13:55:34 +0000597 /* FIXME: This is incorrect for nonstandard flashbase. */
Carl-Daniel Hailfinger5820f422009-05-16 21:22:56 +0000598 flash->virtual_registers = (chipaddr)programmer_map_flash_region("flash chip registers", (0xFFFFFFFF - 0x400000 - size + 1), size);
Stefan Reinauerff4f1972007-05-24 08:48:10 +0000599}
600
Carl-Daniel Hailfingercbf563c2009-06-16 08:55:44 +0000601int read_memmapped(struct flashchip *flash, uint8_t *buf, int start, int len)
Carl-Daniel Hailfinger03b4e712009-05-08 12:49:03 +0000602{
Carl-Daniel Hailfingercbf563c2009-06-16 08:55:44 +0000603 chip_readn(buf, flash->virtual_memory + start, len);
Carl-Daniel Hailfinger03b4e712009-05-08 12:49:03 +0000604
605 return 0;
606}
607
Carl-Daniel Hailfinger38a059d2009-06-13 12:04:03 +0000608int min(int a, int b)
609{
610 return (a < b) ? a : b;
611}
612
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000613int max(int a, int b)
614{
615 return (a > b) ? a : b;
616}
617
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +0000618int bitcount(unsigned long a)
619{
620 int i = 0;
621 for (; a != 0; a >>= 1)
622 if (a & 1)
623 i++;
624 return i;
625}
626
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000627void tolower_string(char *str)
628{
629 for (; *str != '\0'; str++)
630 *str = (char)tolower((unsigned char)*str);
631}
632
Carl-Daniel Hailfingerb22918c2009-06-01 02:08:58 +0000633char *strcat_realloc(char *dest, const char *src)
634{
635 dest = realloc(dest, strlen(dest) + strlen(src) + 1);
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000636 if (!dest) {
637 msg_gerr("Out of memory!\n");
Carl-Daniel Hailfingerb22918c2009-06-01 02:08:58 +0000638 return NULL;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000639 }
Carl-Daniel Hailfingerb22918c2009-06-01 02:08:58 +0000640 strcat(dest, src);
641 return dest;
642}
643
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000644/* This is a somewhat hacked function similar in some ways to strtok().
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000645 * It will look for needle with a subsequent '=' in haystack, return a copy of
646 * needle and remove everything from the first occurrence of needle to the next
647 * delimiter from haystack.
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000648 */
649char *extract_param(char **haystack, char *needle, char *delim)
650{
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000651 char *param_pos, *opt_pos, *rest;
652 char *opt = NULL;
653 int optlen;
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000654 int needlelen;
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000655
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000656 needlelen = strlen(needle);
657 if (!needlelen) {
658 msg_gerr("%s: empty needle! Please report a bug at "
659 "flashrom@flashrom.org\n", __func__);
660 return NULL;
661 }
662 /* No programmer parameters given. */
663 if (*haystack == NULL)
664 return NULL;
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000665 param_pos = strstr(*haystack, needle);
666 do {
667 if (!param_pos)
668 return NULL;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000669 /* Needle followed by '='? */
670 if (param_pos[needlelen] == '=') {
671
672 /* Beginning of the string? */
673 if (param_pos == *haystack)
674 break;
675 /* After a delimiter? */
676 if (strchr(delim, *(param_pos - 1)))
677 break;
678 }
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000679 /* Continue searching. */
680 param_pos++;
681 param_pos = strstr(param_pos, needle);
682 } while (1);
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000683
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000684 if (param_pos) {
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000685 /* Get the string after needle and '='. */
686 opt_pos = param_pos + needlelen + 1;
687 optlen = strcspn(opt_pos, delim);
688 /* Return an empty string if the parameter was empty. */
689 opt = malloc(optlen + 1);
690 if (!opt) {
Sean Nelson316a29f2010-05-07 20:09:04 +0000691 msg_gerr("Out of memory!\n");
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000692 exit(1);
693 }
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000694 strncpy(opt, opt_pos, optlen);
695 opt[optlen] = '\0';
696 rest = opt_pos + optlen;
697 /* Skip all delimiters after the current parameter. */
698 rest += strspn(rest, delim);
699 memmove(param_pos, rest, strlen(rest) + 1);
700 /* We could shrink haystack, but the effort is not worth it. */
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000701 }
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000702
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000703 return opt;
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000704}
705
Carl-Daniel Hailfinger2b6dcb32010-07-08 10:13:37 +0000706char *extract_programmer_param(char *param_name)
707{
708 return extract_param(&programmer_param, param_name, ",");
709}
710
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000711/* start is an offset to the base address of the flash chip */
712int check_erased_range(struct flashchip *flash, int start, int len)
713{
714 int ret;
715 uint8_t *cmpbuf = malloc(len);
716
717 if (!cmpbuf) {
Sean Nelson316a29f2010-05-07 20:09:04 +0000718 msg_gerr("Could not allocate memory!\n");
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000719 exit(1);
720 }
721 memset(cmpbuf, 0xff, len);
722 ret = verify_range(flash, cmpbuf, start, len, "ERASE");
723 free(cmpbuf);
724 return ret;
725}
726
Uwe Hermann48ec1b12010-08-08 17:01:18 +0000727/*
Carl-Daniel Hailfingerd0250a32009-11-25 17:05:52 +0000728 * @cmpbuf buffer to compare against, cmpbuf[0] is expected to match the
729 flash content at location start
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000730 * @start offset to the base address of the flash chip
731 * @len length of the verified area
732 * @message string to print in the "FAILED" message
733 * @return 0 for success, -1 for failure
734 */
735int verify_range(struct flashchip *flash, uint8_t *cmpbuf, int start, int len, char *message)
736{
Carl-Daniel Hailfingerd8369412010-11-16 17:21:58 +0000737 int i, ret = 0;
738 uint8_t *readbuf = malloc(len);
Carl-Daniel Hailfinger49b9cab2009-07-23 01:42:56 +0000739 int failcount = 0;
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000740
741 if (!len)
742 goto out_free;
743
Carl-Daniel Hailfinger23290662009-06-24 08:20:45 +0000744 if (!flash->read) {
Sean Nelson316a29f2010-05-07 20:09:04 +0000745 msg_cerr("ERROR: flashrom has no read function for this flash chip.\n");
Carl-Daniel Hailfinger23290662009-06-24 08:20:45 +0000746 return 1;
747 }
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000748 if (!readbuf) {
Sean Nelson316a29f2010-05-07 20:09:04 +0000749 msg_gerr("Could not allocate memory!\n");
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000750 exit(1);
751 }
752
753 if (start + len > flash->total_size * 1024) {
Sean Nelson316a29f2010-05-07 20:09:04 +0000754 msg_gerr("Error: %s called with start 0x%x + len 0x%x >"
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000755 " total_size 0x%x\n", __func__, start, len,
756 flash->total_size * 1024);
757 ret = -1;
758 goto out_free;
759 }
760 if (!message)
761 message = "VERIFY";
762
Carl-Daniel Hailfingerd8369412010-11-16 17:21:58 +0000763 ret = flash->read(flash, readbuf, start, len);
764 if (ret) {
765 msg_gerr("Verification impossible because read failed "
766 "at 0x%x (len 0x%x)\n", start, len);
767 return ret;
768 }
769
770 for (i = 0; i < len; i++) {
771 if (cmpbuf[i] != readbuf[i]) {
772 /* Only print the first failure. */
773 if (!failcount++)
774 msg_cerr("%s FAILED at 0x%08x! "
775 "Expected=0x%02x, Read=0x%02x,",
776 message, start + i, cmpbuf[i],
777 readbuf[i]);
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000778 }
779 }
Carl-Daniel Hailfinger49b9cab2009-07-23 01:42:56 +0000780 if (failcount) {
Sean Nelson316a29f2010-05-07 20:09:04 +0000781 msg_cerr(" failed byte count from 0x%08x-0x%08x: 0x%x\n",
Carl-Daniel Hailfinger49b9cab2009-07-23 01:42:56 +0000782 start, start + len - 1, failcount);
783 ret = -1;
784 }
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000785
786out_free:
787 free(readbuf);
788 return ret;
789}
790
Uwe Hermann48ec1b12010-08-08 17:01:18 +0000791/*
Carl-Daniel Hailfingere8e369f2010-03-08 00:42:32 +0000792 * Check if the buffer @have can be programmed to the content of @want without
793 * erasing. This is only possible if all chunks of size @gran are either kept
794 * as-is or changed from an all-ones state to any other state.
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000795 *
Carl-Daniel Hailfingere8e369f2010-03-08 00:42:32 +0000796 * The following write granularities (enum @gran) are known:
797 * - 1 bit. Each bit can be cleared individually.
798 * - 1 byte. A byte can be written once. Further writes to an already written
799 * byte cause the contents to be either undefined or to stay unchanged.
800 * - 128 bytes. If less than 128 bytes are written, the rest will be
801 * erased. Each write to a 128-byte region will trigger an automatic erase
802 * before anything is written. Very uncommon behaviour and unsupported by
803 * this function.
804 * - 256 bytes. If less than 256 bytes are written, the contents of the
805 * unwritten bytes are undefined.
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000806 * Warning: This function assumes that @have and @want point to naturally
807 * aligned regions.
Carl-Daniel Hailfingere8e369f2010-03-08 00:42:32 +0000808 *
809 * @have buffer with current content
810 * @want buffer with desired content
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000811 * @len length of the checked area
Carl-Daniel Hailfingere8e369f2010-03-08 00:42:32 +0000812 * @gran write granularity (enum, not count)
813 * @return 0 if no erase is needed, 1 otherwise
814 */
815int need_erase(uint8_t *have, uint8_t *want, int len, enum write_granularity gran)
816{
817 int result = 0;
818 int i, j, limit;
819
820 switch (gran) {
821 case write_gran_1bit:
822 for (i = 0; i < len; i++)
823 if ((have[i] & want[i]) != want[i]) {
824 result = 1;
825 break;
826 }
827 break;
828 case write_gran_1byte:
829 for (i = 0; i < len; i++)
830 if ((have[i] != want[i]) && (have[i] != 0xff)) {
831 result = 1;
832 break;
833 }
834 break;
835 case write_gran_256bytes:
836 for (j = 0; j < len / 256; j++) {
837 limit = min (256, len - j * 256);
Uwe Hermann43959702010-03-13 17:28:29 +0000838 /* Are 'have' and 'want' identical? */
Carl-Daniel Hailfingere8e369f2010-03-08 00:42:32 +0000839 if (!memcmp(have + j * 256, want + j * 256, limit))
840 continue;
841 /* have needs to be in erased state. */
842 for (i = 0; i < limit; i++)
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000843 if (have[j * 256 + i] != 0xff) {
Carl-Daniel Hailfingere8e369f2010-03-08 00:42:32 +0000844 result = 1;
845 break;
846 }
847 if (result)
848 break;
849 }
850 break;
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000851 default:
852 msg_cerr("%s: Unsupported granularity! Please report a bug at "
853 "flashrom@flashrom.org\n", __func__);
Carl-Daniel Hailfingere8e369f2010-03-08 00:42:32 +0000854 }
855 return result;
856}
857
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000858/**
859 * Check if the buffer @have needs to be programmed to get the content of @want.
860 * If yes, return 1 and fill in first_start with the start address of the
861 * write operation and first_len with the length of the first to-be-written
862 * chunk. If not, return 0 and leave first_start and first_len undefined.
863 *
864 * Warning: This function assumes that @have and @want point to naturally
865 * aligned regions.
866 *
867 * @have buffer with current content
868 * @want buffer with desired content
869 * @len length of the checked area
870 * @gran write granularity (enum, not count)
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +0000871 * @first_start offset of the first byte which needs to be written (passed in
872 * value is increased by the offset of the first needed write
873 * relative to have/want or unchanged if no write is needed)
874 * @return length of the first contiguous area which needs to be written
875 * 0 if no write is needed
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000876 *
877 * FIXME: This function needs a parameter which tells it about coalescing
878 * in relation to the max write length of the programmer and the max write
879 * length of the chip.
880 */
881static int get_next_write(uint8_t *have, uint8_t *want, int len,
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +0000882 int *first_start, enum write_granularity gran)
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000883{
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +0000884 int need_write = 0, rel_start = 0, first_len = 0;
885 int i, limit, stride;
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000886
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000887 switch (gran) {
888 case write_gran_1bit:
889 case write_gran_1byte:
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +0000890 stride = 1;
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000891 break;
892 case write_gran_256bytes:
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +0000893 stride = 256;
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000894 break;
895 default:
896 msg_cerr("%s: Unsupported granularity! Please report a bug at "
897 "flashrom@flashrom.org\n", __func__);
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +0000898 /* Claim that no write was needed. A write with unknown
899 * granularity is too dangerous to try.
900 */
901 return 0;
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000902 }
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +0000903 for (i = 0; i < len / stride; i++) {
904 limit = min(stride, len - i * stride);
905 /* Are 'have' and 'want' identical? */
906 if (memcmp(have + i * stride, want + i * stride, limit)) {
907 if (!need_write) {
908 /* First location where have and want differ. */
909 need_write = 1;
910 rel_start = i * stride;
911 }
912 } else {
913 if (need_write) {
914 /* First location where have and want
915 * do not differ anymore.
916 */
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +0000917 break;
918 }
919 }
920 }
Carl-Daniel Hailfinger202bf532010-12-06 13:05:44 +0000921 if (need_write)
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +0000922 first_len = min(i * stride - rel_start, len);
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000923 *first_start += rel_start;
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +0000924 return first_len;
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000925}
926
Carl-Daniel Hailfingereaac68b2009-11-23 12:55:31 +0000927/* This function generates various test patterns useful for testing controller
928 * and chip communication as well as chip behaviour.
929 *
930 * If a byte can be written multiple times, each time keeping 0-bits at 0
931 * and changing 1-bits to 0 if the new value for that bit is 0, the effect
932 * is essentially an AND operation. That's also the reason why this function
933 * provides the result of AND between various patterns.
934 *
935 * Below is a list of patterns (and their block length).
936 * Pattern 0 is 05 15 25 35 45 55 65 75 85 95 a5 b5 c5 d5 e5 f5 (16 Bytes)
937 * Pattern 1 is 0a 1a 2a 3a 4a 5a 6a 7a 8a 9a aa ba ca da ea fa (16 Bytes)
938 * Pattern 2 is 50 51 52 53 54 55 56 57 58 59 5a 5b 5c 5d 5e 5f (16 Bytes)
939 * Pattern 3 is a0 a1 a2 a3 a4 a5 a6 a7 a8 a9 aa ab ac ad ae af (16 Bytes)
940 * Pattern 4 is 00 10 20 30 40 50 60 70 80 90 a0 b0 c0 d0 e0 f0 (16 Bytes)
941 * Pattern 5 is 00 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f (16 Bytes)
942 * Pattern 6 is 00 (1 Byte)
943 * Pattern 7 is ff (1 Byte)
944 * Patterns 0-7 have a big-endian block number in the last 2 bytes of each 256
945 * byte block.
946 *
947 * Pattern 8 is 00 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f 10 11... (256 B)
948 * Pattern 9 is ff fe fd fc fb fa f9 f8 f7 f6 f5 f4 f3 f2 f1 f0 ef ee... (256 B)
949 * Pattern 10 is 00 00 00 01 00 02 00 03 00 04... (128 kB big-endian counter)
950 * Pattern 11 is ff ff ff fe ff fd ff fc ff fb... (128 kB big-endian downwards)
951 * Pattern 12 is 00 (1 Byte)
952 * Pattern 13 is ff (1 Byte)
953 * Patterns 8-13 have no block number.
954 *
955 * Patterns 0-3 are created to detect and efficiently diagnose communication
956 * slips like missed bits or bytes and their repetitive nature gives good visual
957 * cues to the person inspecting the results. In addition, the following holds:
958 * AND Pattern 0/1 == Pattern 4
959 * AND Pattern 2/3 == Pattern 5
960 * AND Pattern 0/1/2/3 == AND Pattern 4/5 == Pattern 6
961 * A weakness of pattern 0-5 is the inability to detect swaps/copies between
962 * any two 16-byte blocks except for the last 16-byte block in a 256-byte bloc.
963 * They work perfectly for detecting any swaps/aliasing of blocks >= 256 bytes.
964 * 0x5 and 0xa were picked because they are 0101 and 1010 binary.
965 * Patterns 8-9 are best for detecting swaps/aliasing of blocks < 256 bytes.
966 * Besides that, they provide for bit testing of the last two bytes of every
967 * 256 byte block which contains the block number for patterns 0-6.
968 * Patterns 10-11 are special purpose for detecting subblock aliasing with
969 * block sizes >256 bytes (some Dataflash chips etc.)
970 * AND Pattern 8/9 == Pattern 12
971 * AND Pattern 10/11 == Pattern 12
972 * Pattern 13 is the completely erased state.
973 * None of the patterns can detect aliasing at boundaries which are a multiple
974 * of 16 MBytes (but such chips do not exist anyway for Parallel/LPC/FWH/SPI).
975 */
976int generate_testpattern(uint8_t *buf, uint32_t size, int variant)
977{
978 int i;
979
980 if (!buf) {
Sean Nelson316a29f2010-05-07 20:09:04 +0000981 msg_gerr("Invalid buffer!\n");
Carl-Daniel Hailfingereaac68b2009-11-23 12:55:31 +0000982 return 1;
983 }
984
985 switch (variant) {
986 case 0:
987 for (i = 0; i < size; i++)
988 buf[i] = (i & 0xf) << 4 | 0x5;
989 break;
990 case 1:
991 for (i = 0; i < size; i++)
992 buf[i] = (i & 0xf) << 4 | 0xa;
993 break;
994 case 2:
995 for (i = 0; i < size; i++)
996 buf[i] = 0x50 | (i & 0xf);
997 break;
998 case 3:
999 for (i = 0; i < size; i++)
1000 buf[i] = 0xa0 | (i & 0xf);
1001 break;
1002 case 4:
1003 for (i = 0; i < size; i++)
1004 buf[i] = (i & 0xf) << 4;
1005 break;
1006 case 5:
1007 for (i = 0; i < size; i++)
1008 buf[i] = i & 0xf;
1009 break;
1010 case 6:
1011 memset(buf, 0x00, size);
1012 break;
1013 case 7:
1014 memset(buf, 0xff, size);
1015 break;
1016 case 8:
1017 for (i = 0; i < size; i++)
1018 buf[i] = i & 0xff;
1019 break;
1020 case 9:
1021 for (i = 0; i < size; i++)
1022 buf[i] = ~(i & 0xff);
1023 break;
1024 case 10:
1025 for (i = 0; i < size % 2; i++) {
1026 buf[i * 2] = (i >> 8) & 0xff;
1027 buf[i * 2 + 1] = i & 0xff;
1028 }
1029 if (size & 0x1)
1030 buf[i * 2] = (i >> 8) & 0xff;
1031 break;
1032 case 11:
1033 for (i = 0; i < size % 2; i++) {
1034 buf[i * 2] = ~((i >> 8) & 0xff);
1035 buf[i * 2 + 1] = ~(i & 0xff);
1036 }
1037 if (size & 0x1)
1038 buf[i * 2] = ~((i >> 8) & 0xff);
1039 break;
1040 case 12:
1041 memset(buf, 0x00, size);
1042 break;
1043 case 13:
1044 memset(buf, 0xff, size);
1045 break;
1046 }
1047
1048 if ((variant >= 0) && (variant <= 7)) {
1049 /* Write block number in the last two bytes of each 256-byte
1050 * block, big endian for easier reading of the hexdump.
1051 * Note that this wraps around for chips larger than 2^24 bytes
1052 * (16 MB).
1053 */
1054 for (i = 0; i < size / 256; i++) {
1055 buf[i * 256 + 254] = (i >> 8) & 0xff;
1056 buf[i * 256 + 255] = i & 0xff;
1057 }
1058 }
1059
1060 return 0;
1061}
1062
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +00001063int check_max_decode(enum chipbustype buses, uint32_t size)
1064{
1065 int limitexceeded = 0;
1066 if ((buses & CHIP_BUSTYPE_PARALLEL) &&
1067 (max_rom_decode.parallel < size)) {
1068 limitexceeded++;
Sean Nelson316a29f2010-05-07 20:09:04 +00001069 msg_pdbg("Chip size %u kB is bigger than supported "
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +00001070 "size %u kB of chipset/board/programmer "
1071 "for %s interface, "
1072 "probe/read/erase/write may fail. ", size / 1024,
1073 max_rom_decode.parallel / 1024, "Parallel");
1074 }
1075 if ((buses & CHIP_BUSTYPE_LPC) && (max_rom_decode.lpc < size)) {
1076 limitexceeded++;
Sean Nelson316a29f2010-05-07 20:09:04 +00001077 msg_pdbg("Chip size %u kB is bigger than supported "
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +00001078 "size %u kB of chipset/board/programmer "
1079 "for %s interface, "
1080 "probe/read/erase/write may fail. ", size / 1024,
1081 max_rom_decode.lpc / 1024, "LPC");
1082 }
1083 if ((buses & CHIP_BUSTYPE_FWH) && (max_rom_decode.fwh < size)) {
1084 limitexceeded++;
Sean Nelson316a29f2010-05-07 20:09:04 +00001085 msg_pdbg("Chip size %u kB is bigger than supported "
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +00001086 "size %u kB of chipset/board/programmer "
1087 "for %s interface, "
1088 "probe/read/erase/write may fail. ", size / 1024,
1089 max_rom_decode.fwh / 1024, "FWH");
1090 }
1091 if ((buses & CHIP_BUSTYPE_SPI) && (max_rom_decode.spi < size)) {
1092 limitexceeded++;
Sean Nelson316a29f2010-05-07 20:09:04 +00001093 msg_pdbg("Chip size %u kB is bigger than supported "
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +00001094 "size %u kB of chipset/board/programmer "
1095 "for %s interface, "
1096 "probe/read/erase/write may fail. ", size / 1024,
1097 max_rom_decode.spi / 1024, "SPI");
1098 }
1099 if (!limitexceeded)
1100 return 0;
1101 /* Sometimes chip and programmer have more than one bus in common,
1102 * and the limit is not exceeded on all buses. Tell the user.
1103 */
1104 if (bitcount(buses) > limitexceeded)
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +00001105 /* FIXME: This message is designed towards CLI users. */
Sean Nelson316a29f2010-05-07 20:09:04 +00001106 msg_pdbg("There is at least one common chip/programmer "
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +00001107 "interface which can support a chip of this size. "
1108 "You can try --force at your own risk.\n");
1109 return 1;
1110}
1111
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +00001112int probe_flash(int startchip, struct flashchip *fill_flash, int force)
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +00001113{
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +00001114 const struct flashchip *flash;
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +00001115 unsigned long base = 0;
Stefan Reinauer051e2362011-01-19 06:21:54 +00001116 char location[64];
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +00001117 uint32_t size;
1118 enum chipbustype buses_common;
Carl-Daniel Hailfingerb22918c2009-06-01 02:08:58 +00001119 char *tmp;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +00001120
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +00001121 for (flash = flashchips + startchip; flash && flash->name; flash++) {
Peter Stuge27c3e2d2008-07-02 17:15:47 +00001122 if (chip_to_probe && strcmp(flash->name, chip_to_probe) != 0)
Ollie Lhocbbf1252004-03-17 22:22:08 +00001123 continue;
Carl-Daniel Hailfinger12575e52010-03-22 23:43:51 +00001124 msg_gdbg("Probing for %s %s, %d KB: ",
Stefan Reinauerac378972008-03-17 22:59:40 +00001125 flash->vendor, flash->name, flash->total_size);
Peter Stuge7ffbc6f2008-06-18 02:08:40 +00001126 if (!flash->probe && !force) {
Carl-Daniel Hailfinger12575e52010-03-22 23:43:51 +00001127 msg_gdbg("failed! flashrom has no probe function for "
1128 "this flash chip.\n");
Peter Stugef31104c2008-04-28 14:47:30 +00001129 continue;
1130 }
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +00001131 buses_common = buses_supported & flash->bustype;
1132 if (!buses_common) {
Carl-Daniel Hailfingerb22918c2009-06-01 02:08:58 +00001133 tmp = flashbuses_to_text(buses_supported);
Carl-Daniel Hailfinger12575e52010-03-22 23:43:51 +00001134 msg_gdbg("skipped.");
1135 msg_gspew(" Host bus type %s ", tmp);
Carl-Daniel Hailfingerb22918c2009-06-01 02:08:58 +00001136 free(tmp);
1137 tmp = flashbuses_to_text(flash->bustype);
Carl-Daniel Hailfinger12575e52010-03-22 23:43:51 +00001138 msg_gspew("and chip bus type %s are incompatible.",
1139 tmp);
Carl-Daniel Hailfingerb22918c2009-06-01 02:08:58 +00001140 free(tmp);
Carl-Daniel Hailfinger12575e52010-03-22 23:43:51 +00001141 msg_gdbg("\n");
Carl-Daniel Hailfingerb22918c2009-06-01 02:08:58 +00001142 continue;
1143 }
Stefan Reinauer70385642007-04-06 11:58:03 +00001144
Ollie Lhocbbf1252004-03-17 22:22:08 +00001145 size = flash->total_size * 1024;
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +00001146 check_max_decode(buses_common, size);
Stefan Reinauer70385642007-04-06 11:58:03 +00001147
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +00001148 /* Start filling in the dynamic data. */
1149 *fill_flash = *flash;
1150
Carl-Daniel Hailfinger97d6b092009-05-09 07:27:23 +00001151 base = flashbase ? flashbase : (0xffffffff - size + 1);
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +00001152 fill_flash->virtual_memory = (chipaddr)programmer_map_flash_region("flash chip", base, size);
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +00001153
Peter Stuge27c3e2d2008-07-02 17:15:47 +00001154 if (force)
1155 break;
Stefan Reinauerfcb63682006-03-16 16:57:41 +00001156
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +00001157 if (fill_flash->probe(fill_flash) != 1)
Peter Stuge483b8f02008-09-03 23:10:05 +00001158 goto notfound;
1159
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +00001160 /* If this is the first chip found, accept it.
1161 * If this is not the first chip found, accept it only if it is
1162 * a non-generic match.
1163 * We could either make chipcount global or provide it as
1164 * parameter, or we assume that startchip==0 means this call to
1165 * probe_flash() is the first one and thus no chip has been
1166 * found before.
1167 */
1168 if (startchip == 0 || fill_flash->model_id != GENERIC_DEVICE_ID)
Peter Stuge27c3e2d2008-07-02 17:15:47 +00001169 break;
1170
Peter Stuge483b8f02008-09-03 23:10:05 +00001171notfound:
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +00001172 programmer_unmap_flash_region((void *)fill_flash->virtual_memory, size);
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +00001173 }
Uwe Hermannffec5f32007-08-23 16:08:21 +00001174
Peter Stuge27c3e2d2008-07-02 17:15:47 +00001175 if (!flash || !flash->name)
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +00001176 return -1;
Peter Stuge27c3e2d2008-07-02 17:15:47 +00001177
Carl-Daniel Hailfingerd9535582011-03-08 00:09:11 +00001178#if CONFIG_INTERNAL == 1
1179 if (programmer_table[programmer].map_flash_region == physmap)
Stefan Reinauer051e2362011-01-19 06:21:54 +00001180 snprintf(location, sizeof(location), "at physical address 0x%lx", base);
Carl-Daniel Hailfingerd9535582011-03-08 00:09:11 +00001181 else
1182#endif
Stefan Reinauer051e2362011-01-19 06:21:54 +00001183 snprintf(location, sizeof(location), "on %s", programmer_table[programmer].name);
Stefan Reinauer051e2362011-01-19 06:21:54 +00001184
1185 msg_cinfo("%s chip \"%s %s\" (%d KB, %s) %s.\n",
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +00001186 force ? "Assuming" : "Found",
Uwe Hermann9899cad2009-06-28 21:47:57 +00001187 flash->vendor, flash->name, flash->total_size,
Stefan Reinauer051e2362011-01-19 06:21:54 +00001188 flashbuses_to_text(flash->bustype), location);
Uwe Hermann9899cad2009-06-28 21:47:57 +00001189
Carl-Daniel Hailfinger859f3f02010-12-02 21:59:42 +00001190 /* Flash registers will not be mapped if the chip was forced. Lock info
1191 * may be stored in registers, so avoid lock info printing.
1192 */
1193 if (!force)
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +00001194 if (fill_flash->printlock)
1195 fill_flash->printlock(fill_flash);
Sean Nelson6e0b9122010-02-19 00:52:10 +00001196
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +00001197 /* Return position of matching chip. */
1198 return flash - flashchips;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +00001199}
1200
Stefan Reinauere3705282005-12-18 16:41:10 +00001201int verify_flash(struct flashchip *flash, uint8_t *buf)
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +00001202{
Carl-Daniel Hailfinger23290662009-06-24 08:20:45 +00001203 int ret;
Ollie Lho761bf1b2004-03-20 16:46:10 +00001204 int total_size = flash->total_size * 1024;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +00001205
Sean Nelson316a29f2010-05-07 20:09:04 +00001206 msg_cinfo("Verifying flash... ");
Uwe Hermanna7e05482007-05-09 10:17:44 +00001207
Carl-Daniel Hailfinger23290662009-06-24 08:20:45 +00001208 ret = verify_range(flash, buf, 0, total_size, NULL);
Uwe Hermanna7e05482007-05-09 10:17:44 +00001209
Carl-Daniel Hailfinger23290662009-06-24 08:20:45 +00001210 if (!ret)
Sean Nelson316a29f2010-05-07 20:09:04 +00001211 msg_cinfo("VERIFIED. \n");
Stefan Reinauerfcb63682006-03-16 16:57:41 +00001212
Carl-Daniel Hailfinger23290662009-06-24 08:20:45 +00001213 return ret;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +00001214}
1215
Carl-Daniel Hailfinger43069442010-10-15 00:01:14 +00001216int read_buf_from_file(unsigned char *buf, unsigned long size, char *filename)
1217{
1218 unsigned long numbytes;
1219 FILE *image;
1220 struct stat image_stat;
1221
1222 if ((image = fopen(filename, "rb")) == NULL) {
1223 perror(filename);
1224 return 1;
1225 }
1226 if (fstat(fileno(image), &image_stat) != 0) {
1227 perror(filename);
1228 fclose(image);
1229 return 1;
1230 }
1231 if (image_stat.st_size != size) {
1232 msg_gerr("Error: Image size doesn't match\n");
1233 fclose(image);
1234 return 1;
1235 }
1236 numbytes = fread(buf, 1, size, image);
1237 if (fclose(image)) {
1238 perror(filename);
1239 return 1;
1240 }
1241 if (numbytes != size) {
1242 msg_gerr("Error: Failed to read complete file. Got %ld bytes, "
1243 "wanted %ld!\n", numbytes, size);
1244 return 1;
1245 }
1246 return 0;
1247}
1248
Carl-Daniel Hailfinger1748c572010-07-13 23:56:13 +00001249int write_buf_to_file(unsigned char *buf, unsigned long size, char *filename)
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +00001250{
1251 unsigned long numbytes;
1252 FILE *image;
Stephan Guilloux21dd55b2009-06-01 22:07:52 +00001253
1254 if (!filename) {
Carl-Daniel Hailfinger1748c572010-07-13 23:56:13 +00001255 msg_gerr("No filename specified.\n");
Stephan Guilloux21dd55b2009-06-01 22:07:52 +00001256 return 1;
1257 }
Patrick Georgi0bf842d2010-01-25 22:55:33 +00001258 if ((image = fopen(filename, "wb")) == NULL) {
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +00001259 perror(filename);
Carl-Daniel Hailfinger03b4e712009-05-08 12:49:03 +00001260 return 1;
Carl-Daniel Hailfinger1748c572010-07-13 23:56:13 +00001261 }
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +00001262
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +00001263 numbytes = fwrite(buf, 1, size, image);
1264 fclose(image);
Carl-Daniel Hailfinger1748c572010-07-13 23:56:13 +00001265 if (numbytes != size) {
1266 msg_gerr("File %s could not be written completely.\n",
1267 filename);
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +00001268 return 1;
Carl-Daniel Hailfinger1748c572010-07-13 23:56:13 +00001269 }
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +00001270 return 0;
1271}
1272
Carl-Daniel Hailfinger1748c572010-07-13 23:56:13 +00001273int read_flash_to_file(struct flashchip *flash, char *filename)
1274{
1275 unsigned long size = flash->total_size * 1024;
1276 unsigned char *buf = calloc(size, sizeof(char));
1277 int ret = 0;
1278
1279 msg_cinfo("Reading flash... ");
1280 if (!buf) {
1281 msg_gerr("Memory allocation failed!\n");
1282 msg_cinfo("FAILED.\n");
1283 return 1;
1284 }
1285 if (!flash->read) {
1286 msg_cerr("No read function available for this flash chip.\n");
1287 ret = 1;
1288 goto out_free;
1289 }
1290 if (flash->read(flash, buf, 0, size)) {
1291 msg_cerr("Read operation failed!\n");
1292 ret = 1;
1293 goto out_free;
1294 }
1295
1296 ret = write_buf_to_file(buf, flash->total_size * 1024, filename);
1297out_free:
1298 free(buf);
1299 msg_cinfo("%s.\n", ret ? "FAILED" : "done");
1300 return ret;
1301}
1302
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001303/* This function shares a lot of its structure with erase_and_write_flash() and
1304 * walk_eraseregions().
Carl-Daniel Hailfinger415afcf2010-01-19 06:42:46 +00001305 * Even if an error is found, the function will keep going and check the rest.
1306 */
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +00001307static int selfcheck_eraseblocks(const struct flashchip *flash)
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001308{
Carl-Daniel Hailfinger415afcf2010-01-19 06:42:46 +00001309 int i, j, k;
1310 int ret = 0;
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001311
1312 for (k = 0; k < NUM_ERASEFUNCTIONS; k++) {
1313 unsigned int done = 0;
1314 struct block_eraser eraser = flash->block_erasers[k];
1315
1316 for (i = 0; i < NUM_ERASEREGIONS; i++) {
1317 /* Blocks with zero size are bugs in flashchips.c. */
1318 if (eraser.eraseblocks[i].count &&
1319 !eraser.eraseblocks[i].size) {
1320 msg_gerr("ERROR: Flash chip %s erase function "
1321 "%i region %i has size 0. Please report"
1322 " a bug at flashrom@flashrom.org\n",
1323 flash->name, k, i);
Carl-Daniel Hailfinger415afcf2010-01-19 06:42:46 +00001324 ret = 1;
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001325 }
1326 /* Blocks with zero count are bugs in flashchips.c. */
1327 if (!eraser.eraseblocks[i].count &&
1328 eraser.eraseblocks[i].size) {
1329 msg_gerr("ERROR: Flash chip %s erase function "
1330 "%i region %i has count 0. Please report"
1331 " a bug at flashrom@flashrom.org\n",
1332 flash->name, k, i);
Carl-Daniel Hailfinger415afcf2010-01-19 06:42:46 +00001333 ret = 1;
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001334 }
1335 done += eraser.eraseblocks[i].count *
1336 eraser.eraseblocks[i].size;
1337 }
Carl-Daniel Hailfinger415afcf2010-01-19 06:42:46 +00001338 /* Empty eraseblock definition with erase function. */
1339 if (!done && eraser.block_erase)
Sean Nelson316a29f2010-05-07 20:09:04 +00001340 msg_gspew("Strange: Empty eraseblock definition with "
Carl-Daniel Hailfinger415afcf2010-01-19 06:42:46 +00001341 "non-empty erase function. Not an error.\n");
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001342 if (!done)
1343 continue;
1344 if (done != flash->total_size * 1024) {
1345 msg_gerr("ERROR: Flash chip %s erase function %i "
1346 "region walking resulted in 0x%06x bytes total,"
1347 " expected 0x%06x bytes. Please report a bug at"
1348 " flashrom@flashrom.org\n", flash->name, k,
1349 done, flash->total_size * 1024);
Carl-Daniel Hailfinger415afcf2010-01-19 06:42:46 +00001350 ret = 1;
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001351 }
Carl-Daniel Hailfinger415afcf2010-01-19 06:42:46 +00001352 if (!eraser.block_erase)
1353 continue;
1354 /* Check if there are identical erase functions for different
1355 * layouts. That would imply "magic" erase functions. The
1356 * easiest way to check this is with function pointers.
1357 */
Uwe Hermann43959702010-03-13 17:28:29 +00001358 for (j = k + 1; j < NUM_ERASEFUNCTIONS; j++) {
Carl-Daniel Hailfinger415afcf2010-01-19 06:42:46 +00001359 if (eraser.block_erase ==
1360 flash->block_erasers[j].block_erase) {
1361 msg_gerr("ERROR: Flash chip %s erase function "
1362 "%i and %i are identical. Please report"
1363 " a bug at flashrom@flashrom.org\n",
1364 flash->name, k, j);
1365 ret = 1;
1366 }
Uwe Hermann43959702010-03-13 17:28:29 +00001367 }
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001368 }
Carl-Daniel Hailfinger415afcf2010-01-19 06:42:46 +00001369 return ret;
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001370}
1371
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001372static int erase_and_write_block_helper(struct flashchip *flash,
1373 unsigned int start, unsigned int len,
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001374 uint8_t *curcontents,
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001375 uint8_t *newcontents,
1376 int (*erasefn) (struct flashchip *flash,
1377 unsigned int addr,
1378 unsigned int len))
1379{
1380 int starthere = 0;
1381 int lenhere = 0;
1382 int ret = 0;
1383 int skip = 1;
1384 int writecount = 0;
1385 enum write_granularity gran = write_gran_256bytes; /* FIXME */
1386
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001387 /* curcontents and newcontents are opaque to walk_eraseregions, and
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001388 * need to be adjusted here to keep the impression of proper abstraction
1389 */
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001390 curcontents += start;
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001391 newcontents += start;
1392 msg_cdbg(":");
1393 /* FIXME: Assume 256 byte granularity for now to play it safe. */
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001394 if (need_erase(curcontents, newcontents, len, gran)) {
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001395 msg_cdbg("E");
1396 ret = erasefn(flash, start, len);
1397 if (ret)
1398 return ret;
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001399 /* Erase was successful. Adjust curcontents. */
1400 memset(curcontents, 0xff, len);
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001401 skip = 0;
1402 }
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001403 /* get_next_write() sets starthere to a new value after the call. */
1404 while ((lenhere = get_next_write(curcontents + starthere,
1405 newcontents + starthere,
1406 len - starthere, &starthere, gran))) {
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001407 if (!writecount++)
1408 msg_cdbg("W");
1409 /* Needs the partial write function signature. */
1410 ret = flash->write(flash, newcontents + starthere,
1411 start + starthere, lenhere);
1412 if (ret)
1413 return ret;
1414 starthere += lenhere;
1415 skip = 0;
1416 }
1417 if (skip)
1418 msg_cdbg("S");
1419 return ret;
1420}
1421
Carl-Daniel Hailfinger4d3e9ca2010-07-13 00:42:00 +00001422static int walk_eraseregions(struct flashchip *flash, int erasefunction,
1423 int (*do_something) (struct flashchip *flash,
1424 unsigned int addr,
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001425 unsigned int len,
1426 uint8_t *param1,
1427 uint8_t *param2,
1428 int (*erasefn) (
1429 struct flashchip *flash,
1430 unsigned int addr,
1431 unsigned int len)),
1432 void *param1, void *param2)
Carl-Daniel Hailfingera1223412010-07-13 00:37:19 +00001433{
1434 int i, j;
1435 unsigned int start = 0;
1436 unsigned int len;
1437 struct block_eraser eraser = flash->block_erasers[erasefunction];
1438 for (i = 0; i < NUM_ERASEREGIONS; i++) {
1439 /* count==0 for all automatically initialized array
1440 * members so the loop below won't be executed for them.
1441 */
1442 len = eraser.eraseblocks[i].size;
1443 for (j = 0; j < eraser.eraseblocks[i].count; j++) {
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001444 /* Print this for every block except the first one. */
1445 if (i || j)
1446 msg_cdbg(", ");
1447 msg_cdbg("0x%06x-0x%06x", start,
Carl-Daniel Hailfingera1223412010-07-13 00:37:19 +00001448 start + len - 1);
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001449 if (do_something(flash, start, len, param1, param2,
1450 eraser.block_erase)) {
1451 msg_cdbg("\n");
Carl-Daniel Hailfingera1223412010-07-13 00:37:19 +00001452 return 1;
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001453 }
Carl-Daniel Hailfingera1223412010-07-13 00:37:19 +00001454 start += len;
1455 }
1456 }
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001457 msg_cdbg("\n");
Carl-Daniel Hailfingera1223412010-07-13 00:37:19 +00001458 return 0;
1459}
1460
Carl-Daniel Hailfingerdce73ae2010-12-05 15:14:44 +00001461static int check_block_eraser(struct flashchip *flash, int k, int log)
1462{
1463 struct block_eraser eraser = flash->block_erasers[k];
1464
1465 if (!eraser.block_erase && !eraser.eraseblocks[0].count) {
1466 if (log)
1467 msg_cdbg("not defined. ");
1468 return 1;
1469 }
1470 if (!eraser.block_erase && eraser.eraseblocks[0].count) {
1471 if (log)
1472 msg_cdbg("eraseblock layout is known, but matching "
1473 "block erase function is not implemented. ");
1474 return 1;
1475 }
1476 if (eraser.block_erase && !eraser.eraseblocks[0].count) {
1477 if (log)
1478 msg_cdbg("block erase function found, but "
1479 "eraseblock layout is not defined. ");
1480 return 1;
1481 }
1482 return 0;
1483}
1484
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001485int erase_and_write_flash(struct flashchip *flash, uint8_t *oldcontents, uint8_t *newcontents)
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +00001486{
Carl-Daniel Hailfingerdce73ae2010-12-05 15:14:44 +00001487 int k, ret = 0;
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001488 uint8_t *curcontents;
1489 unsigned long size = flash->total_size * 1024;
Carl-Daniel Hailfingerdce73ae2010-12-05 15:14:44 +00001490 int usable_erasefunctions = 0;
1491
1492 for (k = 0; k < NUM_ERASEFUNCTIONS; k++)
1493 if (!check_block_eraser(flash, k, 0))
1494 usable_erasefunctions++;
1495 msg_cinfo("Erasing and writing flash chip... ");
1496 if (!usable_erasefunctions) {
1497 msg_cerr("ERROR: flashrom has no erase function for this flash "
1498 "chip.\n");
1499 return 1;
1500 }
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +00001501
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001502 curcontents = (uint8_t *) malloc(size);
1503 /* Copy oldcontents to curcontents to avoid clobbering oldcontents. */
1504 memcpy(curcontents, oldcontents, size);
1505
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +00001506 for (k = 0; k < NUM_ERASEFUNCTIONS; k++) {
Sean Nelson316a29f2010-05-07 20:09:04 +00001507 msg_cdbg("Looking at blockwise erase function %i... ", k);
Carl-Daniel Hailfingerdce73ae2010-12-05 15:14:44 +00001508 if (check_block_eraser(flash, k, 1) && usable_erasefunctions) {
1509 msg_cdbg("Looking for another erase function.\n");
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +00001510 continue;
1511 }
Carl-Daniel Hailfingerdce73ae2010-12-05 15:14:44 +00001512 usable_erasefunctions--;
Sean Nelson316a29f2010-05-07 20:09:04 +00001513 msg_cdbg("trying... ");
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001514 ret = walk_eraseregions(flash, k, &erase_and_write_block_helper, curcontents, newcontents);
Sean Nelson316a29f2010-05-07 20:09:04 +00001515 msg_cdbg("\n");
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +00001516 /* If everything is OK, don't try another erase function. */
1517 if (!ret)
1518 break;
Carl-Daniel Hailfingerb23b1eb2010-12-02 02:41:55 +00001519 /* Write/erase failed, so try to find out what the current chip
1520 * contents are. If no usable erase functions remain, we could
1521 * abort the loop instead of continuing, the effect is the same.
1522 * The only difference is whether the reason for other unusable
1523 * functions is printed or not. If in doubt, verbosity wins.
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001524 */
Carl-Daniel Hailfingerdce73ae2010-12-05 15:14:44 +00001525 if (!usable_erasefunctions)
1526 continue;
Carl-Daniel Hailfingerb23b1eb2010-12-02 02:41:55 +00001527 if (flash->read(flash, curcontents, 0, size)) {
1528 /* Now we are truly screwed. Read failed as well. */
1529 msg_cerr("Can't read anymore!\n");
1530 /* We have no idea about the flash chip contents, so
1531 * retrying with another erase function is pointless.
1532 */
1533 break;
1534 }
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +00001535 }
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001536 /* Free the scratchpad. */
1537 free(curcontents);
Carl-Daniel Hailfingerf160a122009-05-08 17:15:15 +00001538
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +00001539 if (ret) {
Sean Nelson316a29f2010-05-07 20:09:04 +00001540 msg_cerr("FAILED!\n");
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +00001541 } else {
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001542 msg_cinfo("Done.\n");
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +00001543 }
1544 return ret;
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +00001545}
1546
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001547void nonfatal_help_message(void)
1548{
1549 msg_gerr("Writing to the flash chip apparently didn't do anything.\n"
1550 "This means we have to add special support for your board, "
1551 "programmer or flash chip.\n"
1552 "Please report this on IRC at irc.freenode.net (channel "
1553 "#flashrom) or\n"
1554 "mail flashrom@flashrom.org!\n"
1555 "-------------------------------------------------------------"
1556 "------------------\n"
1557 "You may now reboot or simply leave the machine running.\n");
1558}
1559
Uwe Hermannc67d0372009-10-01 18:40:02 +00001560void emergency_help_message(void)
Carl-Daniel Hailfinger8ab49e72009-08-19 13:55:34 +00001561{
Sean Nelson316a29f2010-05-07 20:09:04 +00001562 msg_gerr("Your flash chip is in an unknown state.\n"
Uwe Hermannc67d0372009-10-01 18:40:02 +00001563 "Get help on IRC at irc.freenode.net (channel #flashrom) or\n"
Paul Menzelab6328f2010-10-08 11:03:02 +00001564 "mail flashrom@flashrom.org with FAILED: your board name in "
1565 "the subject line!\n"
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +00001566 "-------------------------------------------------------------"
1567 "------------------\n"
Carl-Daniel Hailfinger8ab49e72009-08-19 13:55:34 +00001568 "DO NOT REBOOT OR POWEROFF!\n");
1569}
1570
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001571/* The way to go if you want a delimited list of programmers*/
1572void list_programmers(char *delim)
1573{
1574 enum programmer p;
1575 for (p = 0; p < PROGRAMMER_INVALID; p++) {
Sean Nelson316a29f2010-05-07 20:09:04 +00001576 msg_ginfo("%s", programmer_table[p].name);
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001577 if (p < PROGRAMMER_INVALID - 1)
Sean Nelson316a29f2010-05-07 20:09:04 +00001578 msg_ginfo("%s", delim);
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001579 }
Sean Nelson316a29f2010-05-07 20:09:04 +00001580 msg_ginfo("\n");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001581}
1582
Carl-Daniel Hailfingera73fb492010-10-06 23:48:34 +00001583void list_programmers_linebreak(int startcol, int cols, int paren)
1584{
1585 const char *pname;
1586 int pnamelen;
1587 int remaining = 0;
1588 int firstline = 1;
1589 enum programmer p;
1590 int i;
1591
1592 for (p = 0; p < PROGRAMMER_INVALID; p++) {
1593 pname = programmer_table[p].name;
1594 pnamelen = strlen(pname);
1595 if (remaining - pnamelen - 2 < 0) {
1596 if (firstline)
1597 firstline = 0;
1598 else
1599 printf("\n");
1600 for (i = 0; i < startcol; i++)
1601 printf(" ");
1602 remaining = cols - startcol;
1603 } else {
1604 printf(" ");
1605 remaining--;
1606 }
1607 if (paren && (p == 0)) {
1608 printf("(");
1609 remaining--;
1610 }
1611 printf("%s", pname);
1612 remaining -= pnamelen;
1613 if (p < PROGRAMMER_INVALID - 1) {
1614 printf(",");
1615 remaining--;
1616 } else {
1617 if (paren)
1618 printf(")");
1619 printf("\n");
1620 }
1621 }
1622}
1623
Carl-Daniel Hailfinger132e2ec2010-03-27 16:36:40 +00001624void print_sysinfo(void)
1625{
1626#if HAVE_UTSNAME == 1
1627 struct utsname osinfo;
1628 uname(&osinfo);
1629
1630 msg_ginfo(" on %s %s (%s)", osinfo.sysname, osinfo.release,
1631 osinfo.machine);
1632#else
1633 msg_ginfo(" on unknown machine");
1634#endif
1635 msg_ginfo(", built with");
1636#if NEED_PCI == 1
1637#ifdef PCILIB_VERSION
1638 msg_ginfo(" libpci %s,", PCILIB_VERSION);
1639#else
1640 msg_ginfo(" unknown PCI library,");
1641#endif
1642#endif
1643#ifdef __clang__
Carl-Daniel Hailfingerb51e58e2010-07-17 14:49:30 +00001644 msg_ginfo(" LLVM Clang");
1645#ifdef __clang_version__
1646 msg_ginfo(" %s,", __clang_version__);
1647#else
1648 msg_ginfo(" unknown version (before r102686),");
1649#endif
Carl-Daniel Hailfinger132e2ec2010-03-27 16:36:40 +00001650#elif defined(__GNUC__)
1651 msg_ginfo(" GCC");
1652#ifdef __VERSION__
Carl-Daniel Hailfingercceafa22010-05-26 01:45:41 +00001653 msg_ginfo(" %s,", __VERSION__);
Carl-Daniel Hailfinger132e2ec2010-03-27 16:36:40 +00001654#else
Carl-Daniel Hailfingercceafa22010-05-26 01:45:41 +00001655 msg_ginfo(" unknown version,");
Carl-Daniel Hailfinger132e2ec2010-03-27 16:36:40 +00001656#endif
1657#else
Carl-Daniel Hailfingercceafa22010-05-26 01:45:41 +00001658 msg_ginfo(" unknown compiler,");
1659#endif
1660#if defined (__FLASHROM_LITTLE_ENDIAN__)
1661 msg_ginfo(" little endian");
1662#else
1663 msg_ginfo(" big endian");
Carl-Daniel Hailfinger132e2ec2010-03-27 16:36:40 +00001664#endif
1665 msg_ginfo("\n");
1666}
1667
Bernhard Walle201bde32008-01-21 15:24:22 +00001668void print_version(void)
1669{
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +00001670 msg_ginfo("flashrom v%s", flashrom_version);
Carl-Daniel Hailfinger132e2ec2010-03-27 16:36:40 +00001671 print_sysinfo();
Bernhard Walle201bde32008-01-21 15:24:22 +00001672}
1673
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +00001674void print_banner(void)
1675{
1676 msg_ginfo("flashrom is free software, get the source code at "
1677 "http://www.flashrom.org\n");
1678 msg_ginfo("\n");
1679}
1680
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001681int selfcheck(void)
1682{
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001683 int ret = 0;
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +00001684 const struct flashchip *flash;
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001685
1686 /* Safety check. Instead of aborting after the first error, check
1687 * if more errors exist.
1688 */
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001689 if (ARRAY_SIZE(programmer_table) - 1 != PROGRAMMER_INVALID) {
Sean Nelson316a29f2010-05-07 20:09:04 +00001690 msg_gerr("Programmer table miscompilation!\n");
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001691 ret = 1;
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001692 }
1693 if (spi_programmer_count - 1 != SPI_CONTROLLER_INVALID) {
Sean Nelson316a29f2010-05-07 20:09:04 +00001694 msg_gerr("SPI programmer table miscompilation!\n");
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001695 ret = 1;
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001696 }
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001697 for (flash = flashchips; flash && flash->name; flash++)
1698 if (selfcheck_eraseblocks(flash))
1699 ret = 1;
1700 return ret;
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001701}
1702
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +00001703void check_chip_supported(const struct flashchip *flash)
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001704{
1705 if (TEST_OK_MASK != (flash->tested & TEST_OK_MASK)) {
Sean Nelson316a29f2010-05-07 20:09:04 +00001706 msg_cinfo("===\n");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001707 if (flash->tested & TEST_BAD_MASK) {
Sean Nelson316a29f2010-05-07 20:09:04 +00001708 msg_cinfo("This flash part has status NOT WORKING for operations:");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001709 if (flash->tested & TEST_BAD_PROBE)
Sean Nelson316a29f2010-05-07 20:09:04 +00001710 msg_cinfo(" PROBE");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001711 if (flash->tested & TEST_BAD_READ)
Sean Nelson316a29f2010-05-07 20:09:04 +00001712 msg_cinfo(" READ");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001713 if (flash->tested & TEST_BAD_ERASE)
Sean Nelson316a29f2010-05-07 20:09:04 +00001714 msg_cinfo(" ERASE");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001715 if (flash->tested & TEST_BAD_WRITE)
Sean Nelson316a29f2010-05-07 20:09:04 +00001716 msg_cinfo(" WRITE");
1717 msg_cinfo("\n");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001718 }
1719 if ((!(flash->tested & TEST_BAD_PROBE) && !(flash->tested & TEST_OK_PROBE)) ||
1720 (!(flash->tested & TEST_BAD_READ) && !(flash->tested & TEST_OK_READ)) ||
1721 (!(flash->tested & TEST_BAD_ERASE) && !(flash->tested & TEST_OK_ERASE)) ||
1722 (!(flash->tested & TEST_BAD_WRITE) && !(flash->tested & TEST_OK_WRITE))) {
Sean Nelson316a29f2010-05-07 20:09:04 +00001723 msg_cinfo("This flash part has status UNTESTED for operations:");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001724 if (!(flash->tested & TEST_BAD_PROBE) && !(flash->tested & TEST_OK_PROBE))
Sean Nelson316a29f2010-05-07 20:09:04 +00001725 msg_cinfo(" PROBE");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001726 if (!(flash->tested & TEST_BAD_READ) && !(flash->tested & TEST_OK_READ))
Sean Nelson316a29f2010-05-07 20:09:04 +00001727 msg_cinfo(" READ");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001728 if (!(flash->tested & TEST_BAD_ERASE) && !(flash->tested & TEST_OK_ERASE))
Sean Nelson316a29f2010-05-07 20:09:04 +00001729 msg_cinfo(" ERASE");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001730 if (!(flash->tested & TEST_BAD_WRITE) && !(flash->tested & TEST_OK_WRITE))
Sean Nelson316a29f2010-05-07 20:09:04 +00001731 msg_cinfo(" WRITE");
1732 msg_cinfo("\n");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001733 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +00001734 /* FIXME: This message is designed towards CLI users. */
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +00001735 msg_cinfo("The test status of this chip may have been updated "
1736 "in the latest development\n"
1737 "version of flashrom. If you are running the latest "
1738 "development version,\n"
1739 "please email a report to flashrom@flashrom.org if "
1740 "any of the above operations\n"
1741 "work correctly for you with this flash part. Please "
1742 "include the flashrom\n"
1743 "output with the additional -V option for all "
1744 "operations you tested (-V, -Vr,\n"
1745 "-Vw, -VE), and mention which mainboard or "
1746 "programmer you tested.\n"
Paul Menzelab6328f2010-10-08 11:03:02 +00001747 "Please mention your board in the subject line. "
1748 "Thanks for your help!\n");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001749 }
1750}
1751
Ollie Lho761bf1b2004-03-20 16:46:10 +00001752int main(int argc, char *argv[])
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +00001753{
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +00001754 return cli_classic(argc, argv);
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001755}
1756
Carl-Daniel Hailfinger43069442010-10-15 00:01:14 +00001757/* FIXME: This function signature needs to be improved once doit() has a better
1758 * function signature.
1759 */
1760int chip_safety_check(struct flashchip *flash, int force, char *filename, int read_it, int write_it, int erase_it, int verify_it)
1761{
1762 if (!programmer_may_write && (write_it || erase_it)) {
1763 msg_perr("Write/erase is not working yet on your programmer in "
1764 "its current configuration.\n");
1765 /* --force is the wrong approach, but it's the best we can do
1766 * until the generic programmer parameter parser is merged.
1767 */
1768 if (!force)
1769 return 1;
1770 msg_cerr("Continuing anyway.\n");
1771 }
1772
1773 if (read_it || erase_it || write_it || verify_it) {
1774 /* Everything needs read. */
1775 if (flash->tested & TEST_BAD_READ) {
1776 msg_cerr("Read is not working on this chip. ");
1777 if (!force)
1778 return 1;
1779 msg_cerr("Continuing anyway.\n");
1780 }
1781 if (!flash->read) {
1782 msg_cerr("flashrom has no read function for this "
1783 "flash chip.\n");
1784 return 1;
1785 }
1786 }
1787 if (erase_it || write_it) {
1788 /* Write needs erase. */
1789 if (flash->tested & TEST_BAD_ERASE) {
1790 msg_cerr("Erase is not working on this chip. ");
1791 if (!force)
1792 return 1;
1793 msg_cerr("Continuing anyway.\n");
1794 }
1795 /* FIXME: Check if at least one erase function exists. */
1796 }
1797 if (write_it) {
1798 if (flash->tested & TEST_BAD_WRITE) {
1799 msg_cerr("Write is not working on this chip. ");
1800 if (!force)
1801 return 1;
1802 msg_cerr("Continuing anyway.\n");
1803 }
1804 if (!flash->write) {
1805 msg_cerr("flashrom has no write function for this "
1806 "flash chip.\n");
1807 return 1;
1808 }
1809 }
1810 return 0;
1811}
1812
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001813/* This function signature is horrible. We need to design a better interface,
1814 * but right now it allows us to split off the CLI code.
Carl-Daniel Hailfingerf52f7842010-10-08 18:52:29 +00001815 * Besides that, the function itself is a textbook example of abysmal code flow.
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001816 */
1817int doit(struct flashchip *flash, int force, char *filename, int read_it, int write_it, int erase_it, int verify_it)
1818{
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001819 uint8_t *oldcontents;
1820 uint8_t *newcontents;
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001821 int ret = 0;
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001822 unsigned long size = flash->total_size * 1024;
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001823
Carl-Daniel Hailfinger43069442010-10-15 00:01:14 +00001824 if (chip_safety_check(flash, force, filename, read_it, write_it, erase_it, verify_it)) {
1825 msg_cerr("Aborting.\n");
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001826 ret = 1;
1827 goto out_nofree;
Carl-Daniel Hailfinger43069442010-10-15 00:01:14 +00001828 }
1829
Carl-Daniel Hailfinger43069442010-10-15 00:01:14 +00001830 /* Given the existence of read locks, we want to unlock for read,
1831 * erase and write.
1832 */
1833 if (flash->unlock)
1834 flash->unlock(flash);
1835
1836 if (read_it) {
1837 ret = read_flash_to_file(flash, filename);
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001838 goto out_nofree;
Carl-Daniel Hailfingerd1be52d2010-07-03 12:14:25 +00001839 }
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001840
1841 oldcontents = (uint8_t *) malloc(size);
1842 /* Assume worst case: All bits are 0. */
1843 memset(oldcontents, 0x00, size);
1844 newcontents = (uint8_t *) malloc(size);
1845 /* Assume best case: All bits should be 1. */
1846 memset(newcontents, 0xff, size);
1847 /* Side effect of the assumptions above: Default write action is erase
1848 * because newcontents looks like a completely erased chip, and
1849 * oldcontents being completely 0x00 means we have to erase everything
1850 * before we can write.
1851 */
1852
Ollie Lhoefa28582004-12-08 20:10:01 +00001853 if (erase_it) {
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001854 /* FIXME: Do we really want the scary warning if erase failed?
1855 * After all, after erase the chip is either blank or partially
1856 * blank or it has the old contents. A blank chip won't boot,
1857 * so if the user wanted erase and reboots afterwards, the user
1858 * knows very well that booting won't work.
1859 */
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001860 if (erase_and_write_flash(flash, oldcontents, newcontents)) {
Carl-Daniel Hailfinger8ab49e72009-08-19 13:55:34 +00001861 emergency_help_message();
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001862 ret = 1;
Carl-Daniel Hailfinger8ab49e72009-08-19 13:55:34 +00001863 }
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001864 goto out;
Carl-Daniel Hailfingerf52f7842010-10-08 18:52:29 +00001865 }
Carl-Daniel Hailfinger43069442010-10-15 00:01:14 +00001866
Carl-Daniel Hailfingerf52f7842010-10-08 18:52:29 +00001867 if (write_it || verify_it) {
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001868 if (read_buf_from_file(newcontents, size, filename)) {
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001869 ret = 1;
1870 goto out;
Stefan Reinauer018aca82006-11-21 23:48:51 +00001871 }
1872
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +00001873#if CONFIG_INTERNAL == 1
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001874 if (programmer == PROGRAMMER_INTERNAL)
1875 show_id(newcontents, size, force);
Carl-Daniel Hailfinger66ef4e52009-12-13 22:28:00 +00001876#endif
Ollie Lhocbbf1252004-03-17 22:22:08 +00001877 }
1878
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001879 /* Read the whole chip to be able to check whether regions need to be
1880 * erased and to give better diagnostics in case write fails.
1881 * The alternative would be to read only the regions which are to be
1882 * preserved, but in that case we might perform unneeded erase which
1883 * takes time as well.
1884 */
1885 msg_cdbg("Reading old flash chip contents...\n");
1886 if (flash->read(flash, oldcontents, 0, size)) {
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001887 ret = 1;
1888 goto out;
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001889 }
1890
Ollie Lho184a4042005-11-26 21:55:36 +00001891 // This should be moved into each flash part's code to do it
1892 // cleanly. This does the job.
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001893 handle_romentries(flash, oldcontents, newcontents);
Uwe Hermanna7e05482007-05-09 10:17:44 +00001894
Ollie Lho184a4042005-11-26 21:55:36 +00001895 // ////////////////////////////////////////////////////////////
Uwe Hermanna7e05482007-05-09 10:17:44 +00001896
Peter Stugef31104c2008-04-28 14:47:30 +00001897 if (write_it) {
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001898 if (erase_and_write_flash(flash, oldcontents, newcontents)) {
1899 msg_cerr("Uh oh. Erase/write failed. Checking if "
1900 "anything changed.\n");
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001901 if (!flash->read(flash, newcontents, 0, size)) {
1902 if (!memcmp(oldcontents, newcontents, size)) {
1903 msg_cinfo("Good. It seems nothing was "
1904 "changed.\n");
1905 nonfatal_help_message();
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001906 ret = 1;
1907 goto out;
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001908 }
1909 }
Carl-Daniel Hailfingerf52f7842010-10-08 18:52:29 +00001910 emergency_help_message();
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001911 ret = 1;
1912 goto out;
Peter Stugef31104c2008-04-28 14:47:30 +00001913 }
Peter Stugef31104c2008-04-28 14:47:30 +00001914 }
Ollie Lho184a4042005-11-26 21:55:36 +00001915
Carl-Daniel Hailfinger8ab49e72009-08-19 13:55:34 +00001916 if (verify_it) {
1917 /* Work around chips which need some time to calm down. */
1918 if (write_it)
1919 programmer_delay(1000*1000);
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001920 ret = verify_flash(flash, newcontents);
Carl-Daniel Hailfingerf5292052009-11-17 09:57:34 +00001921 /* If we tried to write, and verification now fails, we
Carl-Daniel Hailfinger8ab49e72009-08-19 13:55:34 +00001922 * might have an emergency situation.
1923 */
1924 if (ret && write_it)
1925 emergency_help_message();
1926 }
Ollie Lho184a4042005-11-26 21:55:36 +00001927
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001928out:
1929 free(oldcontents);
1930 free(newcontents);
1931out_nofree:
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +00001932 programmer_shutdown();
Stefan Reinauer143da0b2006-01-04 16:42:57 +00001933 return ret;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +00001934}