blob: 04e99347b6deea9014df65da7bac3767423c308c [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"
Carl-Daniel Hailfinger06b9efa2012-08-07 11:59:59 +000040#include "hwaccess.h"
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +000041
Mathias Krausea60faab2011-01-17 07:50:42 +000042const char flashrom_version[] = FLASHROM_VERSION;
Ronald G. Minnichceec4202003-07-25 04:37:41 +000043char *chip_to_probe = NULL;
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +000044int verbose_screen = MSG_INFO;
45int verbose_logfile = MSG_DEBUG2;
Carl-Daniel Hailfinger66ef4e52009-12-13 22:28:00 +000046
Carl-Daniel Hailfinger2e681602011-09-08 00:00:29 +000047static enum programmer programmer = PROGRAMMER_INVALID;
Carl-Daniel Hailfinger66ef4e52009-12-13 22:28:00 +000048
Carl-Daniel Hailfinger2b6dcb32010-07-08 10:13:37 +000049static char *programmer_param = NULL;
Stefan Reinauer70385642007-04-06 11:58:03 +000050
Uwe Hermann48ec1b12010-08-08 17:01:18 +000051/*
Carl-Daniel Hailfinger66ef4e52009-12-13 22:28:00 +000052 * Programmers supporting multiple buses can have differing size limits on
53 * each bus. Store the limits for each bus in a common struct.
54 */
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +000055struct decode_sizes max_rom_decode;
56
57/* If nonzero, used as the start address of bottom-aligned flash. */
58unsigned long flashbase;
Carl-Daniel Hailfinger66ef4e52009-12-13 22:28:00 +000059
Carl-Daniel Hailfingerd1be52d2010-07-03 12:14:25 +000060/* Is writing allowed with this programmer? */
61int programmer_may_write;
62
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +000063#if CONFIG_INTERNAL+CONFIG_DUMMY+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_PONY_SPI+CONFIG_NICINTEL+CONFIG_NICINTEL_SPI+CONFIG_OGP_SPI+CONFIG_SATAMV+CONFIG_LINUX_SPI < 1
64#error You have to enable at least one programmer!
65#endif
66
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +000067const struct programmer_entry programmer_table[] = {
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000068#if CONFIG_INTERNAL == 1
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +000069 {
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +000070 .name = "internal",
Carl-Daniel Hailfinger1e334e62009-05-11 15:46:43 +000071 .init = internal_init,
Carl-Daniel Hailfinger1455b2b2009-05-11 14:13:25 +000072 .map_flash_region = physmap,
73 .unmap_flash_region = physunmap,
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +000074 .delay = internal_delay,
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +000075 },
Carl-Daniel Hailfinger66ef4e52009-12-13 22:28:00 +000076#endif
Luc Verhaegen8e3a6002007-04-04 22:45:58 +000077
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000078#if CONFIG_DUMMY == 1
Carl-Daniel Hailfingerc3129202009-05-09 00:54:55 +000079 {
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +000080 .name = "dummy",
Carl-Daniel Hailfinger1e334e62009-05-11 15:46:43 +000081 .init = dummy_init,
Carl-Daniel Hailfinger1455b2b2009-05-11 14:13:25 +000082 .map_flash_region = dummy_map,
83 .unmap_flash_region = dummy_unmap,
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +000084 .delay = internal_delay,
Carl-Daniel Hailfingerc3129202009-05-09 00:54:55 +000085 },
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +000086#endif
Carl-Daniel Hailfingerc3129202009-05-09 00:54:55 +000087
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000088#if CONFIG_NIC3COM == 1
Uwe Hermannb4dcb712009-05-13 11:36:06 +000089 {
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +000090 .name = "nic3com",
Uwe Hermannb4dcb712009-05-13 11:36:06 +000091 .init = nic3com_init,
Uwe Hermannc6915932009-05-17 23:12:17 +000092 .map_flash_region = fallback_map,
93 .unmap_flash_region = fallback_unmap,
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +000094 .delay = internal_delay,
Uwe Hermannb4dcb712009-05-13 11:36:06 +000095 },
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +000096#endif
Uwe Hermannb4dcb712009-05-13 11:36:06 +000097
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000098#if CONFIG_NICREALTEK == 1
Joerg Fischer5665ef32010-05-21 21:54:07 +000099 {
Carl-Daniel Hailfinger40446ee2011-03-07 01:08:09 +0000100 /* This programmer works for Realtek RTL8139 and SMC 1211. */
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000101 .name = "nicrealtek",
102 //.name = "nicsmc1211",
103 .init = nicrealtek_init,
104 .map_flash_region = fallback_map,
105 .unmap_flash_region = fallback_unmap,
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000106 .delay = internal_delay,
Joerg Fischer5665ef32010-05-21 21:54:07 +0000107 },
Joerg Fischer5665ef32010-05-21 21:54:07 +0000108#endif
109
Andrew Morganc29c2e72010-06-07 22:37:54 +0000110#if CONFIG_NICNATSEMI == 1
111 {
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000112 .name = "nicnatsemi",
113 .init = nicnatsemi_init,
114 .map_flash_region = fallback_map,
115 .unmap_flash_region = fallback_unmap,
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000116 .delay = internal_delay,
Andrew Morganc29c2e72010-06-07 22:37:54 +0000117 },
118#endif
Joerg Fischer5665ef32010-05-21 21:54:07 +0000119
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000120#if CONFIG_GFXNVIDIA == 1
Uwe Hermann2bc98f62009-09-30 18:29:55 +0000121 {
122 .name = "gfxnvidia",
123 .init = gfxnvidia_init,
Uwe Hermann2bc98f62009-09-30 18:29:55 +0000124 .map_flash_region = fallback_map,
125 .unmap_flash_region = fallback_unmap,
Uwe Hermann2bc98f62009-09-30 18:29:55 +0000126 .delay = internal_delay,
127 },
128#endif
129
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000130#if CONFIG_DRKAISER == 1
Rudolf Marek68720c72009-05-17 19:39:27 +0000131 {
TURBO Jb0912c02009-09-02 23:00:46 +0000132 .name = "drkaiser",
133 .init = drkaiser_init,
TURBO Jb0912c02009-09-02 23:00:46 +0000134 .map_flash_region = fallback_map,
135 .unmap_flash_region = fallback_unmap,
TURBO Jb0912c02009-09-02 23:00:46 +0000136 .delay = internal_delay,
137 },
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +0000138#endif
TURBO Jb0912c02009-09-02 23:00:46 +0000139
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000140#if CONFIG_SATASII == 1
TURBO Jb0912c02009-09-02 23:00:46 +0000141 {
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +0000142 .name = "satasii",
Rudolf Marek68720c72009-05-17 19:39:27 +0000143 .init = satasii_init,
Uwe Hermannc6915932009-05-17 23:12:17 +0000144 .map_flash_region = fallback_map,
145 .unmap_flash_region = fallback_unmap,
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +0000146 .delay = internal_delay,
Rudolf Marek68720c72009-05-17 19:39:27 +0000147 },
Carl-Daniel Hailfinger4740c6f2009-09-16 10:09:21 +0000148#endif
Rudolf Marek68720c72009-05-17 19:39:27 +0000149
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000150#if CONFIG_ATAHPT == 1
Uwe Hermannddd5c9e2010-02-21 21:17:00 +0000151 {
152 .name = "atahpt",
153 .init = atahpt_init,
Uwe Hermannddd5c9e2010-02-21 21:17:00 +0000154 .map_flash_region = fallback_map,
155 .unmap_flash_region = fallback_unmap,
Uwe Hermannddd5c9e2010-02-21 21:17:00 +0000156 .delay = internal_delay,
157 },
158#endif
159
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000160#if CONFIG_FT2232_SPI == 1
Paul Fox05dfbe62009-06-16 21:08:06 +0000161 {
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000162 .name = "ft2232_spi",
Paul Fox05dfbe62009-06-16 21:08:06 +0000163 .init = ft2232_spi_init,
Carl-Daniel Hailfinger415e5132009-08-12 11:39:29 +0000164 .map_flash_region = fallback_map,
165 .unmap_flash_region = fallback_unmap,
Paul Fox05dfbe62009-06-16 21:08:06 +0000166 .delay = internal_delay,
167 },
Carl-Daniel Hailfinger3426ef62009-08-19 13:27:58 +0000168#endif
Carl-Daniel Hailfinger415e5132009-08-12 11:39:29 +0000169
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000170#if CONFIG_SERPROG == 1
Urja Rannikko22915352009-06-23 11:33:43 +0000171 {
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +0000172 .name = "serprog",
Urja Rannikko22915352009-06-23 11:33:43 +0000173 .init = serprog_init,
Urja Rannikko22915352009-06-23 11:33:43 +0000174 .map_flash_region = fallback_map,
175 .unmap_flash_region = fallback_unmap,
Urja Rannikko22915352009-06-23 11:33:43 +0000176 .delay = serprog_delay,
177 },
Carl-Daniel Hailfinger6be74112009-08-12 16:17:41 +0000178#endif
Paul Fox05dfbe62009-06-16 21:08:06 +0000179
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000180#if CONFIG_BUSPIRATE_SPI == 1
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000181 {
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000182 .name = "buspirate_spi",
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000183 .init = buspirate_spi_init,
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000184 .map_flash_region = fallback_map,
185 .unmap_flash_region = fallback_unmap,
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000186 .delay = internal_delay,
187 },
188#endif
189
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000190#if CONFIG_DEDIPROG == 1
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000191 {
192 .name = "dediprog",
193 .init = dediprog_init,
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000194 .map_flash_region = fallback_map,
195 .unmap_flash_region = fallback_unmap,
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000196 .delay = internal_delay,
197 },
198#endif
199
Carl-Daniel Hailfingere7fdd6e2010-07-21 10:26:01 +0000200#if CONFIG_RAYER_SPI == 1
201 {
202 .name = "rayer_spi",
203 .init = rayer_spi_init,
Carl-Daniel Hailfingere7fdd6e2010-07-21 10:26:01 +0000204 .map_flash_region = fallback_map,
205 .unmap_flash_region = fallback_unmap,
Carl-Daniel Hailfingere7fdd6e2010-07-21 10:26:01 +0000206 .delay = internal_delay,
207 },
208#endif
209
Virgil-Adrian Teacada7c5452012-04-30 23:11:06 +0000210#if CONFIG_PONY_SPI == 1
211 {
212 .name = "pony_spi",
213 .init = pony_spi_init,
214 .map_flash_region = fallback_map,
215 .unmap_flash_region = fallback_unmap,
216 .delay = internal_delay,
217},
218#endif
219
Carl-Daniel Hailfingerb713d2e2011-05-08 00:24:18 +0000220#if CONFIG_NICINTEL == 1
221 {
222 .name = "nicintel",
223 .init = nicintel_init,
Carl-Daniel Hailfingerb713d2e2011-05-08 00:24:18 +0000224 .map_flash_region = fallback_map,
225 .unmap_flash_region = fallback_unmap,
Carl-Daniel Hailfingerb713d2e2011-05-08 00:24:18 +0000226 .delay = internal_delay,
227 },
228#endif
229
Idwer Vollering004f4b72010-09-03 18:21:21 +0000230#if CONFIG_NICINTEL_SPI == 1
231 {
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000232 .name = "nicintel_spi",
233 .init = nicintel_spi_init,
234 .map_flash_region = fallback_map,
235 .unmap_flash_region = fallback_unmap,
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000236 .delay = internal_delay,
Idwer Vollering004f4b72010-09-03 18:21:21 +0000237 },
238#endif
239
Mark Marshall90021f22010-12-03 14:48:11 +0000240#if CONFIG_OGP_SPI == 1
241 {
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000242 .name = "ogp_spi",
243 .init = ogp_spi_init,
244 .map_flash_region = fallback_map,
245 .unmap_flash_region = fallback_unmap,
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000246 .delay = internal_delay,
Mark Marshall90021f22010-12-03 14:48:11 +0000247 },
248#endif
249
Carl-Daniel Hailfinger9a1105c2011-02-04 21:37:59 +0000250#if CONFIG_SATAMV == 1
251 {
252 .name = "satamv",
253 .init = satamv_init,
Carl-Daniel Hailfinger9a1105c2011-02-04 21:37:59 +0000254 .map_flash_region = fallback_map,
255 .unmap_flash_region = fallback_unmap,
Carl-Daniel Hailfinger9a1105c2011-02-04 21:37:59 +0000256 .delay = internal_delay,
257 },
258#endif
259
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000260#if CONFIG_LINUX_SPI == 1
261 {
262 .name = "linux_spi",
263 .init = linux_spi_init,
264 .map_flash_region = fallback_map,
265 .unmap_flash_region = fallback_unmap,
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000266 .delay = internal_delay,
267 },
268#endif
269
Carl-Daniel Hailfinger37fc4692009-08-12 14:34:35 +0000270 {}, /* This entry corresponds to PROGRAMMER_INVALID. */
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +0000271};
Luc Verhaegen8e3a6002007-04-04 22:45:58 +0000272
Carl-Daniel Hailfinger2bee8cf2010-11-10 15:25:18 +0000273#define SHUTDOWN_MAXFN 32
Carl-Daniel Hailfingercc389fc2010-02-14 01:20:28 +0000274static int shutdown_fn_count = 0;
275struct shutdown_func_data {
David Hendricks8bb20212011-06-14 01:35:36 +0000276 int (*func) (void *data);
Carl-Daniel Hailfingercc389fc2010-02-14 01:20:28 +0000277 void *data;
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000278} static shutdown_fn[SHUTDOWN_MAXFN];
279/* Initialize to 0 to make sure nobody registers a shutdown function before
280 * programmer init.
281 */
282static int may_register_shutdown = 0;
Carl-Daniel Hailfingercc389fc2010-02-14 01:20:28 +0000283
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000284static int check_block_eraser(const struct flashctx *flash, int k, int log);
Stefan Tauner5368dca2011-07-01 00:19:12 +0000285
Carl-Daniel Hailfingercc389fc2010-02-14 01:20:28 +0000286/* Register a function to be executed on programmer shutdown.
287 * The advantage over atexit() is that you can supply a void pointer which will
288 * be used as parameter to the registered function upon programmer shutdown.
289 * This pointer can point to arbitrary data used by said function, e.g. undo
290 * information for GPIO settings etc. If unneeded, set data=NULL.
291 * Please note that the first (void *data) belongs to the function signature of
292 * the function passed as first parameter.
293 */
David Hendricks8bb20212011-06-14 01:35:36 +0000294int register_shutdown(int (*function) (void *data), void *data)
Carl-Daniel Hailfingercc389fc2010-02-14 01:20:28 +0000295{
296 if (shutdown_fn_count >= SHUTDOWN_MAXFN) {
Carl-Daniel Hailfinger9f5f2152010-06-04 23:20:21 +0000297 msg_perr("Tried to register more than %i shutdown functions.\n",
Carl-Daniel Hailfingercc389fc2010-02-14 01:20:28 +0000298 SHUTDOWN_MAXFN);
299 return 1;
300 }
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000301 if (!may_register_shutdown) {
302 msg_perr("Tried to register a shutdown function before "
303 "programmer init.\n");
304 return 1;
305 }
Carl-Daniel Hailfingercc389fc2010-02-14 01:20:28 +0000306 shutdown_fn[shutdown_fn_count].func = function;
307 shutdown_fn[shutdown_fn_count].data = data;
308 shutdown_fn_count++;
309
310 return 0;
311}
312
Carl-Daniel Hailfinger2e681602011-09-08 00:00:29 +0000313int programmer_init(enum programmer prog, char *param)
Uwe Hermann09e04f72009-05-16 22:36:00 +0000314{
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000315 int ret;
Carl-Daniel Hailfinger2e681602011-09-08 00:00:29 +0000316
317 if (prog >= PROGRAMMER_INVALID) {
318 msg_perr("Invalid programmer specified!\n");
319 return -1;
320 }
321 programmer = prog;
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000322 /* Initialize all programmer specific data. */
323 /* Default to unlimited decode sizes. */
324 max_rom_decode = (const struct decode_sizes) {
325 .parallel = 0xffffffff,
326 .lpc = 0xffffffff,
327 .fwh = 0xffffffff,
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000328 .spi = 0xffffffff,
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000329 };
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000330 /* Default to top aligned flash at 4 GB. */
331 flashbase = 0;
332 /* Registering shutdown functions is now allowed. */
333 may_register_shutdown = 1;
Carl-Daniel Hailfingerd1be52d2010-07-03 12:14:25 +0000334 /* Default to allowing writes. Broken programmers set this to 0. */
335 programmer_may_write = 1;
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000336
337 programmer_param = param;
338 msg_pdbg("Initializing %s programmer\n",
339 programmer_table[programmer].name);
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000340 ret = programmer_table[programmer].init();
341 if (programmer_param && strlen(programmer_param)) {
342 msg_perr("Unhandled programmer parameters: %s\n",
343 programmer_param);
344 /* Do not error out here, the init itself was successful. */
345 }
346 return ret;
Uwe Hermann09e04f72009-05-16 22:36:00 +0000347}
348
349int programmer_shutdown(void)
350{
David Hendricks8bb20212011-06-14 01:35:36 +0000351 int ret = 0;
352
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000353 /* Registering shutdown functions is no longer allowed. */
354 may_register_shutdown = 0;
355 while (shutdown_fn_count > 0) {
356 int i = --shutdown_fn_count;
David Hendricks8bb20212011-06-14 01:35:36 +0000357 ret |= shutdown_fn[i].func(shutdown_fn[i].data);
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000358 }
David Hendricks8bb20212011-06-14 01:35:36 +0000359 return ret;
Uwe Hermann09e04f72009-05-16 22:36:00 +0000360}
361
362void *programmer_map_flash_region(const char *descr, unsigned long phys_addr,
363 size_t len)
364{
365 return programmer_table[programmer].map_flash_region(descr,
366 phys_addr, len);
367}
368
369void programmer_unmap_flash_region(void *virt_addr, size_t len)
370{
371 programmer_table[programmer].unmap_flash_region(virt_addr, len);
372}
373
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000374void chip_writeb(const struct flashctx *flash, uint8_t val, chipaddr addr)
Uwe Hermann09e04f72009-05-16 22:36:00 +0000375{
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000376 flash->pgm->par.chip_writeb(flash, val, addr);
Uwe Hermann09e04f72009-05-16 22:36:00 +0000377}
378
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000379void chip_writew(const struct flashctx *flash, uint16_t val, chipaddr addr)
Uwe Hermann09e04f72009-05-16 22:36:00 +0000380{
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000381 flash->pgm->par.chip_writew(flash, val, addr);
Uwe Hermann09e04f72009-05-16 22:36:00 +0000382}
383
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000384void chip_writel(const struct flashctx *flash, uint32_t val, chipaddr addr)
Uwe Hermann09e04f72009-05-16 22:36:00 +0000385{
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000386 flash->pgm->par.chip_writel(flash, val, addr);
Uwe Hermann09e04f72009-05-16 22:36:00 +0000387}
388
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000389void chip_writen(const struct flashctx *flash, uint8_t *buf, chipaddr addr,
390 size_t len)
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000391{
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000392 flash->pgm->par.chip_writen(flash, buf, addr, len);
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000393}
394
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000395uint8_t chip_readb(const struct flashctx *flash, const chipaddr addr)
Uwe Hermann09e04f72009-05-16 22:36:00 +0000396{
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000397 return flash->pgm->par.chip_readb(flash, addr);
Uwe Hermann09e04f72009-05-16 22:36:00 +0000398}
399
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000400uint16_t chip_readw(const struct flashctx *flash, const chipaddr addr)
Uwe Hermann09e04f72009-05-16 22:36:00 +0000401{
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000402 return flash->pgm->par.chip_readw(flash, addr);
Uwe Hermann09e04f72009-05-16 22:36:00 +0000403}
404
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000405uint32_t chip_readl(const struct flashctx *flash, const chipaddr addr)
Uwe Hermann09e04f72009-05-16 22:36:00 +0000406{
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000407 return flash->pgm->par.chip_readl(flash, addr);
Uwe Hermann09e04f72009-05-16 22:36:00 +0000408}
409
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000410void chip_readn(const struct flashctx *flash, uint8_t *buf, chipaddr addr,
411 size_t len)
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000412{
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000413 flash->pgm->par.chip_readn(flash, buf, addr, len);
Carl-Daniel Hailfinger0bd2a2b2009-06-05 18:32:07 +0000414}
415
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +0000416void programmer_delay(int usecs)
417{
418 programmer_table[programmer].delay(usecs);
419}
420
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000421void map_flash_registers(struct flashctx *flash)
Stefan Reinauerff4f1972007-05-24 08:48:10 +0000422{
Stefan Reinauerff4f1972007-05-24 08:48:10 +0000423 size_t size = flash->total_size * 1024;
Carl-Daniel Hailfingerd0fc9462009-05-11 14:01:17 +0000424 /* Flash registers live 4 MByte below the flash. */
Carl-Daniel Hailfinger8ab49e72009-08-19 13:55:34 +0000425 /* FIXME: This is incorrect for nonstandard flashbase. */
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000426 flash->virtual_registers = (chipaddr)programmer_map_flash_region("flash chip registers", (0xFFFFFFFF - 0x400000 - size + 1), size);
Stefan Reinauerff4f1972007-05-24 08:48:10 +0000427}
428
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000429int read_memmapped(struct flashctx *flash, uint8_t *buf, unsigned int start,
430 int unsigned len)
Carl-Daniel Hailfinger03b4e712009-05-08 12:49:03 +0000431{
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000432 chip_readn(flash, buf, flash->virtual_memory + start, len);
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000433
Carl-Daniel Hailfinger03b4e712009-05-08 12:49:03 +0000434 return 0;
435}
436
Carl-Daniel Hailfinger38a059d2009-06-13 12:04:03 +0000437int min(int a, int b)
438{
439 return (a < b) ? a : b;
440}
441
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000442int max(int a, int b)
443{
444 return (a > b) ? a : b;
445}
446
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +0000447int bitcount(unsigned long a)
448{
449 int i = 0;
450 for (; a != 0; a >>= 1)
451 if (a & 1)
452 i++;
453 return i;
454}
455
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000456void tolower_string(char *str)
457{
458 for (; *str != '\0'; str++)
459 *str = (char)tolower((unsigned char)*str);
460}
461
Carl-Daniel Hailfingerb22918c2009-06-01 02:08:58 +0000462char *strcat_realloc(char *dest, const char *src)
463{
464 dest = realloc(dest, strlen(dest) + strlen(src) + 1);
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000465 if (!dest) {
466 msg_gerr("Out of memory!\n");
Carl-Daniel Hailfingerb22918c2009-06-01 02:08:58 +0000467 return NULL;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000468 }
Carl-Daniel Hailfingerb22918c2009-06-01 02:08:58 +0000469 strcat(dest, src);
470 return dest;
471}
472
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000473/* This is a somewhat hacked function similar in some ways to strtok().
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000474 * It will look for needle with a subsequent '=' in haystack, return a copy of
475 * needle and remove everything from the first occurrence of needle to the next
476 * delimiter from haystack.
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000477 */
Stefan Tauner66652442011-06-26 17:38:17 +0000478char *extract_param(char **haystack, const char *needle, const char *delim)
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000479{
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000480 char *param_pos, *opt_pos, *rest;
481 char *opt = NULL;
482 int optlen;
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000483 int needlelen;
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000484
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000485 needlelen = strlen(needle);
486 if (!needlelen) {
487 msg_gerr("%s: empty needle! Please report a bug at "
488 "flashrom@flashrom.org\n", __func__);
489 return NULL;
490 }
491 /* No programmer parameters given. */
492 if (*haystack == NULL)
493 return NULL;
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000494 param_pos = strstr(*haystack, needle);
495 do {
496 if (!param_pos)
497 return NULL;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000498 /* Needle followed by '='? */
499 if (param_pos[needlelen] == '=') {
500
501 /* Beginning of the string? */
502 if (param_pos == *haystack)
503 break;
504 /* After a delimiter? */
505 if (strchr(delim, *(param_pos - 1)))
506 break;
507 }
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000508 /* Continue searching. */
509 param_pos++;
510 param_pos = strstr(param_pos, needle);
511 } while (1);
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000512
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000513 if (param_pos) {
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000514 /* Get the string after needle and '='. */
515 opt_pos = param_pos + needlelen + 1;
516 optlen = strcspn(opt_pos, delim);
517 /* Return an empty string if the parameter was empty. */
518 opt = malloc(optlen + 1);
519 if (!opt) {
Sean Nelson316a29f2010-05-07 20:09:04 +0000520 msg_gerr("Out of memory!\n");
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000521 exit(1);
522 }
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000523 strncpy(opt, opt_pos, optlen);
524 opt[optlen] = '\0';
525 rest = opt_pos + optlen;
526 /* Skip all delimiters after the current parameter. */
527 rest += strspn(rest, delim);
528 memmove(param_pos, rest, strlen(rest) + 1);
529 /* We could shrink haystack, but the effort is not worth it. */
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000530 }
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000531
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000532 return opt;
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000533}
534
Stefan Tauner66652442011-06-26 17:38:17 +0000535char *extract_programmer_param(const char *param_name)
Carl-Daniel Hailfinger2b6dcb32010-07-08 10:13:37 +0000536{
537 return extract_param(&programmer_param, param_name, ",");
538}
539
Sylvain "ythier" Hitier9db45512011-07-04 07:27:17 +0000540/* Returns the number of well-defined erasers for a chip. */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000541static unsigned int count_usable_erasers(const struct flashctx *flash)
Stefan Tauner5368dca2011-07-01 00:19:12 +0000542{
543 unsigned int usable_erasefunctions = 0;
544 int k;
545 for (k = 0; k < NUM_ERASEFUNCTIONS; k++) {
546 if (!check_block_eraser(flash, k, 0))
547 usable_erasefunctions++;
548 }
549 return usable_erasefunctions;
550}
551
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000552/* start is an offset to the base address of the flash chip */
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000553int check_erased_range(struct flashctx *flash, unsigned int start,
554 unsigned int len)
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000555{
556 int ret;
557 uint8_t *cmpbuf = malloc(len);
558
559 if (!cmpbuf) {
Sean Nelson316a29f2010-05-07 20:09:04 +0000560 msg_gerr("Could not allocate memory!\n");
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000561 exit(1);
562 }
563 memset(cmpbuf, 0xff, len);
564 ret = verify_range(flash, cmpbuf, start, len, "ERASE");
565 free(cmpbuf);
566 return ret;
567}
568
Uwe Hermann48ec1b12010-08-08 17:01:18 +0000569/*
Carl-Daniel Hailfingerd0250a32009-11-25 17:05:52 +0000570 * @cmpbuf buffer to compare against, cmpbuf[0] is expected to match the
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000571 * flash content at location start
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000572 * @start offset to the base address of the flash chip
573 * @len length of the verified area
574 * @message string to print in the "FAILED" message
575 * @return 0 for success, -1 for failure
576 */
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000577int verify_range(struct flashctx *flash, uint8_t *cmpbuf, unsigned int start,
578 unsigned int len, const char *message)
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000579{
Stefan Taunerc69c9c82011-11-23 09:13:48 +0000580 unsigned int i;
Carl-Daniel Hailfingerd8369412010-11-16 17:21:58 +0000581 uint8_t *readbuf = malloc(len);
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000582 int ret = 0, failcount = 0;
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000583
584 if (!len)
585 goto out_free;
586
Carl-Daniel Hailfinger23290662009-06-24 08:20:45 +0000587 if (!flash->read) {
Sean Nelson316a29f2010-05-07 20:09:04 +0000588 msg_cerr("ERROR: flashrom has no read function for this flash chip.\n");
Carl-Daniel Hailfinger23290662009-06-24 08:20:45 +0000589 return 1;
590 }
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000591 if (!readbuf) {
Sean Nelson316a29f2010-05-07 20:09:04 +0000592 msg_gerr("Could not allocate memory!\n");
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000593 exit(1);
594 }
595
596 if (start + len > flash->total_size * 1024) {
Sean Nelson316a29f2010-05-07 20:09:04 +0000597 msg_gerr("Error: %s called with start 0x%x + len 0x%x >"
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000598 " total_size 0x%x\n", __func__, start, len,
599 flash->total_size * 1024);
600 ret = -1;
601 goto out_free;
602 }
603 if (!message)
604 message = "VERIFY";
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000605
Carl-Daniel Hailfingerd8369412010-11-16 17:21:58 +0000606 ret = flash->read(flash, readbuf, start, len);
607 if (ret) {
608 msg_gerr("Verification impossible because read failed "
609 "at 0x%x (len 0x%x)\n", start, len);
610 return ret;
611 }
612
613 for (i = 0; i < len; i++) {
614 if (cmpbuf[i] != readbuf[i]) {
615 /* Only print the first failure. */
616 if (!failcount++)
617 msg_cerr("%s FAILED at 0x%08x! "
618 "Expected=0x%02x, Read=0x%02x,",
619 message, start + i, cmpbuf[i],
620 readbuf[i]);
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000621 }
622 }
Carl-Daniel Hailfinger49b9cab2009-07-23 01:42:56 +0000623 if (failcount) {
Sean Nelson316a29f2010-05-07 20:09:04 +0000624 msg_cerr(" failed byte count from 0x%08x-0x%08x: 0x%x\n",
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000625 start, start + len - 1, failcount);
Carl-Daniel Hailfinger49b9cab2009-07-23 01:42:56 +0000626 ret = -1;
627 }
Carl-Daniel Hailfinger30f7cb22009-06-15 17:23:36 +0000628
629out_free:
630 free(readbuf);
631 return ret;
632}
633
Uwe Hermann48ec1b12010-08-08 17:01:18 +0000634/*
Carl-Daniel Hailfingere8e369f2010-03-08 00:42:32 +0000635 * Check if the buffer @have can be programmed to the content of @want without
636 * erasing. This is only possible if all chunks of size @gran are either kept
637 * as-is or changed from an all-ones state to any other state.
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000638 *
Carl-Daniel Hailfingere8e369f2010-03-08 00:42:32 +0000639 * The following write granularities (enum @gran) are known:
640 * - 1 bit. Each bit can be cleared individually.
641 * - 1 byte. A byte can be written once. Further writes to an already written
642 * byte cause the contents to be either undefined or to stay unchanged.
643 * - 128 bytes. If less than 128 bytes are written, the rest will be
644 * erased. Each write to a 128-byte region will trigger an automatic erase
645 * before anything is written. Very uncommon behaviour and unsupported by
646 * this function.
647 * - 256 bytes. If less than 256 bytes are written, the contents of the
648 * unwritten bytes are undefined.
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000649 * Warning: This function assumes that @have and @want point to naturally
650 * aligned regions.
Carl-Daniel Hailfingere8e369f2010-03-08 00:42:32 +0000651 *
652 * @have buffer with current content
653 * @want buffer with desired content
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000654 * @len length of the checked area
Carl-Daniel Hailfingere8e369f2010-03-08 00:42:32 +0000655 * @gran write granularity (enum, not count)
656 * @return 0 if no erase is needed, 1 otherwise
657 */
Stefan Taunerc69c9c82011-11-23 09:13:48 +0000658int need_erase(uint8_t *have, uint8_t *want, unsigned int len, enum write_granularity gran)
Carl-Daniel Hailfingere8e369f2010-03-08 00:42:32 +0000659{
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000660 int result = 0;
Stefan Taunerc69c9c82011-11-23 09:13:48 +0000661 unsigned int i, j, limit;
Carl-Daniel Hailfingere8e369f2010-03-08 00:42:32 +0000662
663 switch (gran) {
664 case write_gran_1bit:
665 for (i = 0; i < len; i++)
666 if ((have[i] & want[i]) != want[i]) {
667 result = 1;
668 break;
669 }
670 break;
671 case write_gran_1byte:
672 for (i = 0; i < len; i++)
673 if ((have[i] != want[i]) && (have[i] != 0xff)) {
674 result = 1;
675 break;
676 }
677 break;
678 case write_gran_256bytes:
679 for (j = 0; j < len / 256; j++) {
680 limit = min (256, len - j * 256);
Uwe Hermann43959702010-03-13 17:28:29 +0000681 /* Are 'have' and 'want' identical? */
Carl-Daniel Hailfingere8e369f2010-03-08 00:42:32 +0000682 if (!memcmp(have + j * 256, want + j * 256, limit))
683 continue;
684 /* have needs to be in erased state. */
685 for (i = 0; i < limit; i++)
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000686 if (have[j * 256 + i] != 0xff) {
Carl-Daniel Hailfingere8e369f2010-03-08 00:42:32 +0000687 result = 1;
688 break;
689 }
690 if (result)
691 break;
692 }
693 break;
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000694 default:
695 msg_cerr("%s: Unsupported granularity! Please report a bug at "
696 "flashrom@flashrom.org\n", __func__);
Carl-Daniel Hailfingere8e369f2010-03-08 00:42:32 +0000697 }
698 return result;
699}
700
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000701/**
702 * Check if the buffer @have needs to be programmed to get the content of @want.
703 * If yes, return 1 and fill in first_start with the start address of the
704 * write operation and first_len with the length of the first to-be-written
705 * chunk. If not, return 0 and leave first_start and first_len undefined.
706 *
707 * Warning: This function assumes that @have and @want point to naturally
708 * aligned regions.
709 *
710 * @have buffer with current content
711 * @want buffer with desired content
712 * @len length of the checked area
713 * @gran write granularity (enum, not count)
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +0000714 * @first_start offset of the first byte which needs to be written (passed in
715 * value is increased by the offset of the first needed write
716 * relative to have/want or unchanged if no write is needed)
717 * @return length of the first contiguous area which needs to be written
718 * 0 if no write is needed
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000719 *
720 * FIXME: This function needs a parameter which tells it about coalescing
721 * in relation to the max write length of the programmer and the max write
722 * length of the chip.
723 */
Stefan Taunerc69c9c82011-11-23 09:13:48 +0000724static unsigned int get_next_write(uint8_t *have, uint8_t *want, unsigned int len,
725 unsigned int *first_start,
726 enum write_granularity gran)
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000727{
Stefan Taunerc69c9c82011-11-23 09:13:48 +0000728 int need_write = 0;
729 unsigned int rel_start = 0, first_len = 0;
730 unsigned int i, limit, stride;
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000731
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000732 switch (gran) {
733 case write_gran_1bit:
734 case write_gran_1byte:
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +0000735 stride = 1;
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000736 break;
737 case write_gran_256bytes:
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +0000738 stride = 256;
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000739 break;
740 default:
741 msg_cerr("%s: Unsupported granularity! Please report a bug at "
742 "flashrom@flashrom.org\n", __func__);
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +0000743 /* Claim that no write was needed. A write with unknown
744 * granularity is too dangerous to try.
745 */
746 return 0;
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000747 }
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +0000748 for (i = 0; i < len / stride; i++) {
749 limit = min(stride, len - i * stride);
750 /* Are 'have' and 'want' identical? */
751 if (memcmp(have + i * stride, want + i * stride, limit)) {
752 if (!need_write) {
753 /* First location where have and want differ. */
754 need_write = 1;
755 rel_start = i * stride;
756 }
757 } else {
758 if (need_write) {
759 /* First location where have and want
760 * do not differ anymore.
761 */
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +0000762 break;
763 }
764 }
765 }
Carl-Daniel Hailfinger202bf532010-12-06 13:05:44 +0000766 if (need_write)
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +0000767 first_len = min(i * stride - rel_start, len);
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000768 *first_start += rel_start;
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +0000769 return first_len;
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +0000770}
771
Carl-Daniel Hailfingereaac68b2009-11-23 12:55:31 +0000772/* This function generates various test patterns useful for testing controller
773 * and chip communication as well as chip behaviour.
774 *
775 * If a byte can be written multiple times, each time keeping 0-bits at 0
776 * and changing 1-bits to 0 if the new value for that bit is 0, the effect
777 * is essentially an AND operation. That's also the reason why this function
778 * provides the result of AND between various patterns.
779 *
780 * Below is a list of patterns (and their block length).
781 * Pattern 0 is 05 15 25 35 45 55 65 75 85 95 a5 b5 c5 d5 e5 f5 (16 Bytes)
782 * Pattern 1 is 0a 1a 2a 3a 4a 5a 6a 7a 8a 9a aa ba ca da ea fa (16 Bytes)
783 * Pattern 2 is 50 51 52 53 54 55 56 57 58 59 5a 5b 5c 5d 5e 5f (16 Bytes)
784 * Pattern 3 is a0 a1 a2 a3 a4 a5 a6 a7 a8 a9 aa ab ac ad ae af (16 Bytes)
785 * Pattern 4 is 00 10 20 30 40 50 60 70 80 90 a0 b0 c0 d0 e0 f0 (16 Bytes)
786 * Pattern 5 is 00 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f (16 Bytes)
787 * Pattern 6 is 00 (1 Byte)
788 * Pattern 7 is ff (1 Byte)
789 * Patterns 0-7 have a big-endian block number in the last 2 bytes of each 256
790 * byte block.
791 *
792 * Pattern 8 is 00 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f 10 11... (256 B)
793 * Pattern 9 is ff fe fd fc fb fa f9 f8 f7 f6 f5 f4 f3 f2 f1 f0 ef ee... (256 B)
794 * Pattern 10 is 00 00 00 01 00 02 00 03 00 04... (128 kB big-endian counter)
795 * Pattern 11 is ff ff ff fe ff fd ff fc ff fb... (128 kB big-endian downwards)
796 * Pattern 12 is 00 (1 Byte)
797 * Pattern 13 is ff (1 Byte)
798 * Patterns 8-13 have no block number.
799 *
800 * Patterns 0-3 are created to detect and efficiently diagnose communication
801 * slips like missed bits or bytes and their repetitive nature gives good visual
802 * cues to the person inspecting the results. In addition, the following holds:
803 * AND Pattern 0/1 == Pattern 4
804 * AND Pattern 2/3 == Pattern 5
805 * AND Pattern 0/1/2/3 == AND Pattern 4/5 == Pattern 6
806 * A weakness of pattern 0-5 is the inability to detect swaps/copies between
807 * any two 16-byte blocks except for the last 16-byte block in a 256-byte bloc.
808 * They work perfectly for detecting any swaps/aliasing of blocks >= 256 bytes.
809 * 0x5 and 0xa were picked because they are 0101 and 1010 binary.
810 * Patterns 8-9 are best for detecting swaps/aliasing of blocks < 256 bytes.
811 * Besides that, they provide for bit testing of the last two bytes of every
812 * 256 byte block which contains the block number for patterns 0-6.
813 * Patterns 10-11 are special purpose for detecting subblock aliasing with
814 * block sizes >256 bytes (some Dataflash chips etc.)
815 * AND Pattern 8/9 == Pattern 12
816 * AND Pattern 10/11 == Pattern 12
817 * Pattern 13 is the completely erased state.
818 * None of the patterns can detect aliasing at boundaries which are a multiple
819 * of 16 MBytes (but such chips do not exist anyway for Parallel/LPC/FWH/SPI).
820 */
821int generate_testpattern(uint8_t *buf, uint32_t size, int variant)
822{
823 int i;
824
825 if (!buf) {
Sean Nelson316a29f2010-05-07 20:09:04 +0000826 msg_gerr("Invalid buffer!\n");
Carl-Daniel Hailfingereaac68b2009-11-23 12:55:31 +0000827 return 1;
828 }
829
830 switch (variant) {
831 case 0:
832 for (i = 0; i < size; i++)
833 buf[i] = (i & 0xf) << 4 | 0x5;
834 break;
835 case 1:
836 for (i = 0; i < size; i++)
837 buf[i] = (i & 0xf) << 4 | 0xa;
838 break;
839 case 2:
840 for (i = 0; i < size; i++)
841 buf[i] = 0x50 | (i & 0xf);
842 break;
843 case 3:
844 for (i = 0; i < size; i++)
845 buf[i] = 0xa0 | (i & 0xf);
846 break;
847 case 4:
848 for (i = 0; i < size; i++)
849 buf[i] = (i & 0xf) << 4;
850 break;
851 case 5:
852 for (i = 0; i < size; i++)
853 buf[i] = i & 0xf;
854 break;
855 case 6:
856 memset(buf, 0x00, size);
857 break;
858 case 7:
859 memset(buf, 0xff, size);
860 break;
861 case 8:
862 for (i = 0; i < size; i++)
863 buf[i] = i & 0xff;
864 break;
865 case 9:
866 for (i = 0; i < size; i++)
867 buf[i] = ~(i & 0xff);
868 break;
869 case 10:
870 for (i = 0; i < size % 2; i++) {
871 buf[i * 2] = (i >> 8) & 0xff;
872 buf[i * 2 + 1] = i & 0xff;
873 }
874 if (size & 0x1)
875 buf[i * 2] = (i >> 8) & 0xff;
876 break;
877 case 11:
878 for (i = 0; i < size % 2; i++) {
879 buf[i * 2] = ~((i >> 8) & 0xff);
880 buf[i * 2 + 1] = ~(i & 0xff);
881 }
882 if (size & 0x1)
883 buf[i * 2] = ~((i >> 8) & 0xff);
884 break;
885 case 12:
886 memset(buf, 0x00, size);
887 break;
888 case 13:
889 memset(buf, 0xff, size);
890 break;
891 }
892
893 if ((variant >= 0) && (variant <= 7)) {
894 /* Write block number in the last two bytes of each 256-byte
895 * block, big endian for easier reading of the hexdump.
896 * Note that this wraps around for chips larger than 2^24 bytes
897 * (16 MB).
898 */
899 for (i = 0; i < size / 256; i++) {
900 buf[i * 256 + 254] = (i >> 8) & 0xff;
901 buf[i * 256 + 255] = i & 0xff;
902 }
903 }
904
905 return 0;
906}
907
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +0000908int check_max_decode(enum chipbustype buses, uint32_t size)
909{
910 int limitexceeded = 0;
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000911
912 if ((buses & BUS_PARALLEL) && (max_rom_decode.parallel < size)) {
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +0000913 limitexceeded++;
Sean Nelson316a29f2010-05-07 20:09:04 +0000914 msg_pdbg("Chip size %u kB is bigger than supported "
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000915 "size %u kB of chipset/board/programmer "
916 "for %s interface, "
917 "probe/read/erase/write may fail. ", size / 1024,
918 max_rom_decode.parallel / 1024, "Parallel");
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +0000919 }
Carl-Daniel Hailfinger1a227952011-07-27 07:13:06 +0000920 if ((buses & BUS_LPC) && (max_rom_decode.lpc < size)) {
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +0000921 limitexceeded++;
Sean Nelson316a29f2010-05-07 20:09:04 +0000922 msg_pdbg("Chip size %u kB is bigger than supported "
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000923 "size %u kB of chipset/board/programmer "
924 "for %s interface, "
925 "probe/read/erase/write may fail. ", size / 1024,
926 max_rom_decode.lpc / 1024, "LPC");
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +0000927 }
Carl-Daniel Hailfinger1a227952011-07-27 07:13:06 +0000928 if ((buses & BUS_FWH) && (max_rom_decode.fwh < size)) {
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +0000929 limitexceeded++;
Sean Nelson316a29f2010-05-07 20:09:04 +0000930 msg_pdbg("Chip size %u kB is bigger than supported "
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000931 "size %u kB of chipset/board/programmer "
932 "for %s interface, "
933 "probe/read/erase/write may fail. ", size / 1024,
934 max_rom_decode.fwh / 1024, "FWH");
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +0000935 }
Carl-Daniel Hailfinger1a227952011-07-27 07:13:06 +0000936 if ((buses & BUS_SPI) && (max_rom_decode.spi < size)) {
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +0000937 limitexceeded++;
Sean Nelson316a29f2010-05-07 20:09:04 +0000938 msg_pdbg("Chip size %u kB is bigger than supported "
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000939 "size %u kB of chipset/board/programmer "
940 "for %s interface, "
941 "probe/read/erase/write may fail. ", size / 1024,
942 max_rom_decode.spi / 1024, "SPI");
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +0000943 }
944 if (!limitexceeded)
945 return 0;
946 /* Sometimes chip and programmer have more than one bus in common,
947 * and the limit is not exceeded on all buses. Tell the user.
948 */
949 if (bitcount(buses) > limitexceeded)
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000950 /* FIXME: This message is designed towards CLI users. */
Sean Nelson316a29f2010-05-07 20:09:04 +0000951 msg_pdbg("There is at least one common chip/programmer "
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000952 "interface which can support a chip of this size. "
953 "You can try --force at your own risk.\n");
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +0000954 return 1;
955}
956
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000957int probe_flash(struct registered_programmer *pgm, int startchip,
958 struct flashctx *fill_flash, int force)
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000959{
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000960 const struct flashchip *flash;
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +0000961 unsigned long base = 0;
Stefan Reinauer051e2362011-01-19 06:21:54 +0000962 char location[64];
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +0000963 uint32_t size;
964 enum chipbustype buses_common;
Carl-Daniel Hailfingerb22918c2009-06-01 02:08:58 +0000965 char *tmp;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000966
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000967 for (flash = flashchips + startchip; flash && flash->name; flash++) {
Peter Stuge27c3e2d2008-07-02 17:15:47 +0000968 if (chip_to_probe && strcmp(flash->name, chip_to_probe) != 0)
Ollie Lhocbbf1252004-03-17 22:22:08 +0000969 continue;
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000970 buses_common = pgm->buses_supported & flash->bustype;
971 if (!buses_common)
Carl-Daniel Hailfinger6573b742011-06-17 22:38:53 +0000972 continue;
Carl-Daniel Hailfinger6573b742011-06-17 22:38:53 +0000973 msg_gdbg("Probing for %s %s, %d kB: ",
974 flash->vendor, flash->name, flash->total_size);
975 if (!flash->probe && !force) {
976 msg_gdbg("failed! flashrom has no probe function for "
977 "this flash chip.\n");
Carl-Daniel Hailfingerb22918c2009-06-01 02:08:58 +0000978 continue;
979 }
Stefan Reinauer70385642007-04-06 11:58:03 +0000980
Ollie Lhocbbf1252004-03-17 22:22:08 +0000981 size = flash->total_size * 1024;
Carl-Daniel Hailfinger115d3902009-10-31 01:53:09 +0000982 check_max_decode(buses_common, size);
Stefan Reinauer70385642007-04-06 11:58:03 +0000983
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000984 /* Start filling in the dynamic data. */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000985 memcpy(fill_flash, flash, sizeof(struct flashchip));
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000986 fill_flash->pgm = pgm;
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000987
Carl-Daniel Hailfinger97d6b092009-05-09 07:27:23 +0000988 base = flashbase ? flashbase : (0xffffffff - size + 1);
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000989 fill_flash->virtual_memory = (chipaddr)programmer_map_flash_region("flash chip", base, size);
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +0000990
Peter Stuge27c3e2d2008-07-02 17:15:47 +0000991 if (force)
992 break;
Stefan Reinauerfcb63682006-03-16 16:57:41 +0000993
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000994 if (fill_flash->probe(fill_flash) != 1)
Peter Stuge483b8f02008-09-03 23:10:05 +0000995 goto notfound;
996
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000997 /* If this is the first chip found, accept it.
998 * If this is not the first chip found, accept it only if it is
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000999 * a non-generic match. SFDP and CFI are generic matches.
1000 * startchip==0 means this call to probe_flash() is the first
1001 * one for this programmer interface and thus no other chip has
1002 * been found on this interface.
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +00001003 */
Stefan Taunerac1b4c82012-02-17 14:51:04 +00001004 if (startchip == 0 && fill_flash->model_id == SFDP_DEVICE_ID) {
1005 msg_cinfo("===\n"
1006 "SFDP has autodetected a flash chip which is "
1007 "not natively supported by flashrom yet.\n");
1008 if (count_usable_erasers(fill_flash) == 0)
1009 msg_cinfo("The standard operations read and "
1010 "verify should work, but to support "
1011 "erase, write and all other "
1012 "possible features");
1013 else
1014 msg_cinfo("All standard operations (read, "
1015 "verify, erase and write) should "
1016 "work, but to support all possible "
1017 "features");
1018
1019 msg_cinfo(" we need to add them manually.\nYou "
1020 "can help us by mailing us the output of "
1021 "the following command to flashrom@flashrom."
1022 "org: \n'flashrom -VV [plus the "
1023 "-p/--programmer parameter (if needed)]"
1024 "'\nThanks for your help!\n"
1025 "===\n");
1026 }
1027
1028 if (startchip == 0 ||
1029 ((fill_flash->model_id != GENERIC_DEVICE_ID) &&
1030 (fill_flash->model_id != SFDP_DEVICE_ID)))
Peter Stuge27c3e2d2008-07-02 17:15:47 +00001031 break;
1032
Peter Stuge483b8f02008-09-03 23:10:05 +00001033notfound:
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +00001034 programmer_unmap_flash_region((void *)fill_flash->virtual_memory, size);
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +00001035 }
Uwe Hermannffec5f32007-08-23 16:08:21 +00001036
Peter Stuge27c3e2d2008-07-02 17:15:47 +00001037 if (!flash || !flash->name)
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +00001038 return -1;
Peter Stuge27c3e2d2008-07-02 17:15:47 +00001039
Carl-Daniel Hailfingerd9535582011-03-08 00:09:11 +00001040#if CONFIG_INTERNAL == 1
1041 if (programmer_table[programmer].map_flash_region == physmap)
Stefan Reinauer051e2362011-01-19 06:21:54 +00001042 snprintf(location, sizeof(location), "at physical address 0x%lx", base);
Carl-Daniel Hailfingerd9535582011-03-08 00:09:11 +00001043 else
1044#endif
Stefan Reinauer051e2362011-01-19 06:21:54 +00001045 snprintf(location, sizeof(location), "on %s", programmer_table[programmer].name);
Stefan Reinauer051e2362011-01-19 06:21:54 +00001046
Stefan Tauner00155492011-06-26 20:45:35 +00001047 tmp = flashbuses_to_text(flash->bustype);
Stefan Tauner716e0982011-07-25 20:38:52 +00001048 msg_cinfo("%s %s flash chip \"%s\" (%d kB, %s) %s.\n",
Stefan Tauner00155492011-06-26 20:45:35 +00001049 force ? "Assuming" : "Found", fill_flash->vendor,
1050 fill_flash->name, fill_flash->total_size, tmp, location);
1051 free(tmp);
Uwe Hermann9899cad2009-06-28 21:47:57 +00001052
Carl-Daniel Hailfinger859f3f02010-12-02 21:59:42 +00001053 /* Flash registers will not be mapped if the chip was forced. Lock info
1054 * may be stored in registers, so avoid lock info printing.
1055 */
1056 if (!force)
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +00001057 if (fill_flash->printlock)
1058 fill_flash->printlock(fill_flash);
Sean Nelson6e0b9122010-02-19 00:52:10 +00001059
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +00001060 /* Return position of matching chip. */
1061 return flash - flashchips;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +00001062}
1063
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +00001064int verify_flash(struct flashctx *flash, uint8_t *buf)
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +00001065{
Carl-Daniel Hailfinger23290662009-06-24 08:20:45 +00001066 int ret;
Stefan Taunerc69c9c82011-11-23 09:13:48 +00001067 unsigned int total_size = flash->total_size * 1024;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +00001068
Sean Nelson316a29f2010-05-07 20:09:04 +00001069 msg_cinfo("Verifying flash... ");
Uwe Hermanna7e05482007-05-09 10:17:44 +00001070
Carl-Daniel Hailfinger23290662009-06-24 08:20:45 +00001071 ret = verify_range(flash, buf, 0, total_size, NULL);
Uwe Hermanna7e05482007-05-09 10:17:44 +00001072
Carl-Daniel Hailfinger23290662009-06-24 08:20:45 +00001073 if (!ret)
Sean Nelson316a29f2010-05-07 20:09:04 +00001074 msg_cinfo("VERIFIED. \n");
Stefan Reinauerfcb63682006-03-16 16:57:41 +00001075
Carl-Daniel Hailfinger23290662009-06-24 08:20:45 +00001076 return ret;
Ronald G. Minnichf4cf2ba2002-01-29 18:26:26 +00001077}
1078
Uwe Hermann91f4afa2011-07-28 08:13:25 +00001079int read_buf_from_file(unsigned char *buf, unsigned long size,
1080 const char *filename)
Carl-Daniel Hailfinger43069442010-10-15 00:01:14 +00001081{
1082 unsigned long numbytes;
1083 FILE *image;
1084 struct stat image_stat;
1085
1086 if ((image = fopen(filename, "rb")) == NULL) {
1087 perror(filename);
1088 return 1;
1089 }
1090 if (fstat(fileno(image), &image_stat) != 0) {
1091 perror(filename);
1092 fclose(image);
1093 return 1;
1094 }
1095 if (image_stat.st_size != size) {
1096 msg_gerr("Error: Image size doesn't match\n");
1097 fclose(image);
1098 return 1;
1099 }
1100 numbytes = fread(buf, 1, size, image);
1101 if (fclose(image)) {
1102 perror(filename);
1103 return 1;
1104 }
1105 if (numbytes != size) {
1106 msg_gerr("Error: Failed to read complete file. Got %ld bytes, "
1107 "wanted %ld!\n", numbytes, size);
1108 return 1;
1109 }
1110 return 0;
1111}
1112
Uwe Hermann91f4afa2011-07-28 08:13:25 +00001113int write_buf_to_file(unsigned char *buf, unsigned long size,
1114 const char *filename)
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +00001115{
1116 unsigned long numbytes;
1117 FILE *image;
Stephan Guilloux21dd55b2009-06-01 22:07:52 +00001118
1119 if (!filename) {
Carl-Daniel Hailfinger1748c572010-07-13 23:56:13 +00001120 msg_gerr("No filename specified.\n");
Stephan Guilloux21dd55b2009-06-01 22:07:52 +00001121 return 1;
1122 }
Patrick Georgi0bf842d2010-01-25 22:55:33 +00001123 if ((image = fopen(filename, "wb")) == NULL) {
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +00001124 perror(filename);
Carl-Daniel Hailfinger03b4e712009-05-08 12:49:03 +00001125 return 1;
Carl-Daniel Hailfinger1748c572010-07-13 23:56:13 +00001126 }
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +00001127
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +00001128 numbytes = fwrite(buf, 1, size, image);
1129 fclose(image);
Carl-Daniel Hailfinger1748c572010-07-13 23:56:13 +00001130 if (numbytes != size) {
1131 msg_gerr("File %s could not be written completely.\n",
1132 filename);
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +00001133 return 1;
Carl-Daniel Hailfinger1748c572010-07-13 23:56:13 +00001134 }
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +00001135 return 0;
1136}
1137
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +00001138int read_flash_to_file(struct flashctx *flash, const char *filename)
Carl-Daniel Hailfinger1748c572010-07-13 23:56:13 +00001139{
1140 unsigned long size = flash->total_size * 1024;
1141 unsigned char *buf = calloc(size, sizeof(char));
1142 int ret = 0;
1143
1144 msg_cinfo("Reading flash... ");
1145 if (!buf) {
1146 msg_gerr("Memory allocation failed!\n");
1147 msg_cinfo("FAILED.\n");
1148 return 1;
1149 }
1150 if (!flash->read) {
1151 msg_cerr("No read function available for this flash chip.\n");
1152 ret = 1;
1153 goto out_free;
1154 }
1155 if (flash->read(flash, buf, 0, size)) {
1156 msg_cerr("Read operation failed!\n");
1157 ret = 1;
1158 goto out_free;
1159 }
1160
Stefan Tauner355cbfd2011-05-28 02:37:14 +00001161 ret = write_buf_to_file(buf, size, filename);
Carl-Daniel Hailfinger1748c572010-07-13 23:56:13 +00001162out_free:
1163 free(buf);
1164 msg_cinfo("%s.\n", ret ? "FAILED" : "done");
1165 return ret;
1166}
1167
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001168/* This function shares a lot of its structure with erase_and_write_flash() and
1169 * walk_eraseregions().
Carl-Daniel Hailfinger415afcf2010-01-19 06:42:46 +00001170 * Even if an error is found, the function will keep going and check the rest.
1171 */
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +00001172static int selfcheck_eraseblocks(const struct flashchip *flash)
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001173{
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +00001174 int i, j, k;
1175 int ret = 0;
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001176
1177 for (k = 0; k < NUM_ERASEFUNCTIONS; k++) {
1178 unsigned int done = 0;
1179 struct block_eraser eraser = flash->block_erasers[k];
1180
1181 for (i = 0; i < NUM_ERASEREGIONS; i++) {
1182 /* Blocks with zero size are bugs in flashchips.c. */
1183 if (eraser.eraseblocks[i].count &&
1184 !eraser.eraseblocks[i].size) {
1185 msg_gerr("ERROR: Flash chip %s erase function "
1186 "%i region %i has size 0. Please report"
1187 " a bug at flashrom@flashrom.org\n",
1188 flash->name, k, i);
Carl-Daniel Hailfinger415afcf2010-01-19 06:42:46 +00001189 ret = 1;
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001190 }
1191 /* Blocks with zero count are bugs in flashchips.c. */
1192 if (!eraser.eraseblocks[i].count &&
1193 eraser.eraseblocks[i].size) {
1194 msg_gerr("ERROR: Flash chip %s erase function "
1195 "%i region %i has count 0. Please report"
1196 " a bug at flashrom@flashrom.org\n",
1197 flash->name, k, i);
Carl-Daniel Hailfinger415afcf2010-01-19 06:42:46 +00001198 ret = 1;
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001199 }
1200 done += eraser.eraseblocks[i].count *
1201 eraser.eraseblocks[i].size;
1202 }
Carl-Daniel Hailfinger415afcf2010-01-19 06:42:46 +00001203 /* Empty eraseblock definition with erase function. */
1204 if (!done && eraser.block_erase)
Sean Nelson316a29f2010-05-07 20:09:04 +00001205 msg_gspew("Strange: Empty eraseblock definition with "
Uwe Hermann91f4afa2011-07-28 08:13:25 +00001206 "non-empty erase function. Not an error.\n");
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001207 if (!done)
1208 continue;
1209 if (done != flash->total_size * 1024) {
1210 msg_gerr("ERROR: Flash chip %s erase function %i "
1211 "region walking resulted in 0x%06x bytes total,"
1212 " expected 0x%06x bytes. Please report a bug at"
1213 " flashrom@flashrom.org\n", flash->name, k,
1214 done, flash->total_size * 1024);
Carl-Daniel Hailfinger415afcf2010-01-19 06:42:46 +00001215 ret = 1;
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001216 }
Carl-Daniel Hailfinger415afcf2010-01-19 06:42:46 +00001217 if (!eraser.block_erase)
1218 continue;
1219 /* Check if there are identical erase functions for different
1220 * layouts. That would imply "magic" erase functions. The
1221 * easiest way to check this is with function pointers.
1222 */
Uwe Hermann43959702010-03-13 17:28:29 +00001223 for (j = k + 1; j < NUM_ERASEFUNCTIONS; j++) {
Carl-Daniel Hailfinger415afcf2010-01-19 06:42:46 +00001224 if (eraser.block_erase ==
1225 flash->block_erasers[j].block_erase) {
1226 msg_gerr("ERROR: Flash chip %s erase function "
1227 "%i and %i are identical. Please report"
1228 " a bug at flashrom@flashrom.org\n",
1229 flash->name, k, j);
1230 ret = 1;
1231 }
Uwe Hermann43959702010-03-13 17:28:29 +00001232 }
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001233 }
Carl-Daniel Hailfinger415afcf2010-01-19 06:42:46 +00001234 return ret;
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001235}
1236
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +00001237static int erase_and_write_block_helper(struct flashctx *flash,
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001238 unsigned int start, unsigned int len,
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001239 uint8_t *curcontents,
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001240 uint8_t *newcontents,
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +00001241 int (*erasefn) (struct flashctx *flash,
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001242 unsigned int addr,
1243 unsigned int len))
1244{
Stefan Taunerc69c9c82011-11-23 09:13:48 +00001245 unsigned int starthere = 0, lenhere = 0;
1246 int ret = 0, skip = 1, writecount = 0;
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001247 enum write_granularity gran = write_gran_256bytes; /* FIXME */
1248
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001249 /* curcontents and newcontents are opaque to walk_eraseregions, and
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001250 * need to be adjusted here to keep the impression of proper abstraction
1251 */
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001252 curcontents += start;
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001253 newcontents += start;
1254 msg_cdbg(":");
1255 /* FIXME: Assume 256 byte granularity for now to play it safe. */
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001256 if (need_erase(curcontents, newcontents, len, gran)) {
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001257 msg_cdbg("E");
1258 ret = erasefn(flash, start, len);
1259 if (ret)
1260 return ret;
Carl-Daniel Hailfingerb4061f62011-06-26 17:04:16 +00001261 if (check_erased_range(flash, start, len)) {
1262 msg_cerr("ERASE FAILED!\n");
1263 return -1;
1264 }
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001265 /* Erase was successful. Adjust curcontents. */
1266 memset(curcontents, 0xff, len);
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001267 skip = 0;
1268 }
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001269 /* get_next_write() sets starthere to a new value after the call. */
1270 while ((lenhere = get_next_write(curcontents + starthere,
1271 newcontents + starthere,
1272 len - starthere, &starthere, gran))) {
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001273 if (!writecount++)
1274 msg_cdbg("W");
1275 /* Needs the partial write function signature. */
1276 ret = flash->write(flash, newcontents + starthere,
1277 start + starthere, lenhere);
1278 if (ret)
1279 return ret;
1280 starthere += lenhere;
1281 skip = 0;
1282 }
1283 if (skip)
1284 msg_cdbg("S");
1285 return ret;
1286}
1287
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +00001288static int walk_eraseregions(struct flashctx *flash, int erasefunction,
1289 int (*do_something) (struct flashctx *flash,
Carl-Daniel Hailfinger4d3e9ca2010-07-13 00:42:00 +00001290 unsigned int addr,
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001291 unsigned int len,
1292 uint8_t *param1,
1293 uint8_t *param2,
1294 int (*erasefn) (
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +00001295 struct flashctx *flash,
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001296 unsigned int addr,
1297 unsigned int len)),
1298 void *param1, void *param2)
Carl-Daniel Hailfingera1223412010-07-13 00:37:19 +00001299{
1300 int i, j;
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +00001301 unsigned int start = 0;
1302 unsigned int len;
Carl-Daniel Hailfingera1223412010-07-13 00:37:19 +00001303 struct block_eraser eraser = flash->block_erasers[erasefunction];
Uwe Hermann91f4afa2011-07-28 08:13:25 +00001304
Carl-Daniel Hailfingera1223412010-07-13 00:37:19 +00001305 for (i = 0; i < NUM_ERASEREGIONS; i++) {
1306 /* count==0 for all automatically initialized array
1307 * members so the loop below won't be executed for them.
1308 */
1309 len = eraser.eraseblocks[i].size;
1310 for (j = 0; j < eraser.eraseblocks[i].count; j++) {
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001311 /* Print this for every block except the first one. */
1312 if (i || j)
1313 msg_cdbg(", ");
1314 msg_cdbg("0x%06x-0x%06x", start,
Carl-Daniel Hailfingera1223412010-07-13 00:37:19 +00001315 start + len - 1);
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001316 if (do_something(flash, start, len, param1, param2,
1317 eraser.block_erase)) {
Carl-Daniel Hailfingera1223412010-07-13 00:37:19 +00001318 return 1;
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001319 }
Carl-Daniel Hailfingera1223412010-07-13 00:37:19 +00001320 start += len;
1321 }
1322 }
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001323 msg_cdbg("\n");
Carl-Daniel Hailfingera1223412010-07-13 00:37:19 +00001324 return 0;
1325}
1326
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +00001327static int check_block_eraser(const struct flashctx *flash, int k, int log)
Carl-Daniel Hailfingerdce73ae2010-12-05 15:14:44 +00001328{
1329 struct block_eraser eraser = flash->block_erasers[k];
1330
1331 if (!eraser.block_erase && !eraser.eraseblocks[0].count) {
1332 if (log)
1333 msg_cdbg("not defined. ");
1334 return 1;
1335 }
1336 if (!eraser.block_erase && eraser.eraseblocks[0].count) {
1337 if (log)
1338 msg_cdbg("eraseblock layout is known, but matching "
Stefan Tauner355cbfd2011-05-28 02:37:14 +00001339 "block erase function is not implemented. ");
Carl-Daniel Hailfingerdce73ae2010-12-05 15:14:44 +00001340 return 1;
1341 }
1342 if (eraser.block_erase && !eraser.eraseblocks[0].count) {
1343 if (log)
1344 msg_cdbg("block erase function found, but "
Stefan Tauner355cbfd2011-05-28 02:37:14 +00001345 "eraseblock layout is not defined. ");
Carl-Daniel Hailfingerdce73ae2010-12-05 15:14:44 +00001346 return 1;
1347 }
1348 return 0;
1349}
1350
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +00001351int erase_and_write_flash(struct flashctx *flash, uint8_t *oldcontents,
Uwe Hermann91f4afa2011-07-28 08:13:25 +00001352 uint8_t *newcontents)
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +00001353{
Carl-Daniel Hailfingerd8334db2011-07-21 21:21:04 +00001354 int k, ret = 1;
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001355 uint8_t *curcontents;
1356 unsigned long size = flash->total_size * 1024;
Sylvain "ythier" Hitier9db45512011-07-04 07:27:17 +00001357 unsigned int usable_erasefunctions = count_usable_erasers(flash);
Carl-Daniel Hailfingerdce73ae2010-12-05 15:14:44 +00001358
Carl-Daniel Hailfingerdce73ae2010-12-05 15:14:44 +00001359 msg_cinfo("Erasing and writing flash chip... ");
Stefan Tauner269de352011-07-12 22:35:21 +00001360 curcontents = malloc(size);
1361 if (!curcontents) {
1362 msg_gerr("Out of memory!\n");
1363 exit(1);
1364 }
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001365 /* Copy oldcontents to curcontents to avoid clobbering oldcontents. */
1366 memcpy(curcontents, oldcontents, size);
1367
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +00001368 for (k = 0; k < NUM_ERASEFUNCTIONS; k++) {
Carl-Daniel Hailfinger84d19682011-07-26 14:28:35 +00001369 if (k != 0)
1370 msg_cdbg("Looking for another erase function.\n");
Carl-Daniel Hailfingerd8334db2011-07-21 21:21:04 +00001371 if (!usable_erasefunctions) {
1372 msg_cdbg("No usable erase functions left.\n");
1373 break;
1374 }
Carl-Daniel Hailfinger84d19682011-07-26 14:28:35 +00001375 msg_cdbg("Trying erase function %i... ", k);
1376 if (check_block_eraser(flash, k, 1))
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +00001377 continue;
Carl-Daniel Hailfingerdce73ae2010-12-05 15:14:44 +00001378 usable_erasefunctions--;
Carl-Daniel Hailfinger84d19682011-07-26 14:28:35 +00001379 ret = walk_eraseregions(flash, k, &erase_and_write_block_helper,
1380 curcontents, newcontents);
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +00001381 /* If everything is OK, don't try another erase function. */
1382 if (!ret)
1383 break;
Carl-Daniel Hailfingerb23b1eb2010-12-02 02:41:55 +00001384 /* Write/erase failed, so try to find out what the current chip
Carl-Daniel Hailfingerd8334db2011-07-21 21:21:04 +00001385 * contents are. If no usable erase functions remain, we can
1386 * skip this: the next iteration will break immediately anyway.
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001387 */
Carl-Daniel Hailfingerdce73ae2010-12-05 15:14:44 +00001388 if (!usable_erasefunctions)
1389 continue;
Carl-Daniel Hailfinger84d19682011-07-26 14:28:35 +00001390 /* Reading the whole chip may take a while, inform the user even
1391 * in non-verbose mode.
1392 */
1393 msg_cinfo("Reading current flash chip contents... ");
Carl-Daniel Hailfingerb23b1eb2010-12-02 02:41:55 +00001394 if (flash->read(flash, curcontents, 0, size)) {
1395 /* Now we are truly screwed. Read failed as well. */
Carl-Daniel Hailfinger84d19682011-07-26 14:28:35 +00001396 msg_cerr("Can't read anymore! Aborting.\n");
Carl-Daniel Hailfingerb23b1eb2010-12-02 02:41:55 +00001397 /* We have no idea about the flash chip contents, so
1398 * retrying with another erase function is pointless.
1399 */
1400 break;
1401 }
Carl-Daniel Hailfinger84d19682011-07-26 14:28:35 +00001402 msg_cinfo("done. ");
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +00001403 }
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001404 /* Free the scratchpad. */
1405 free(curcontents);
Carl-Daniel Hailfingerf160a122009-05-08 17:15:15 +00001406
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +00001407 if (ret) {
Sean Nelson316a29f2010-05-07 20:09:04 +00001408 msg_cerr("FAILED!\n");
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +00001409 } else {
Carl-Daniel Hailfinger84d19682011-07-26 14:28:35 +00001410 msg_cinfo("Erase/write done.\n");
Carl-Daniel Hailfingerf38431a2009-09-05 02:30:58 +00001411 }
1412 return ret;
Carl-Daniel Hailfinger7314cc32009-01-28 00:27:54 +00001413}
1414
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001415void nonfatal_help_message(void)
1416{
1417 msg_gerr("Writing to the flash chip apparently didn't do anything.\n"
1418 "This means we have to add special support for your board, "
1419 "programmer or flash chip.\n"
1420 "Please report this on IRC at irc.freenode.net (channel "
1421 "#flashrom) or\n"
1422 "mail flashrom@flashrom.org!\n"
1423 "-------------------------------------------------------------"
1424 "------------------\n"
1425 "You may now reboot or simply leave the machine running.\n");
1426}
1427
Uwe Hermannc67d0372009-10-01 18:40:02 +00001428void emergency_help_message(void)
Carl-Daniel Hailfinger8ab49e72009-08-19 13:55:34 +00001429{
Sean Nelson316a29f2010-05-07 20:09:04 +00001430 msg_gerr("Your flash chip is in an unknown state.\n"
Stefan Tauner2abab942012-04-27 20:41:23 +00001431 "Get help on IRC at chat.freenode.net (channel #flashrom) or\n"
1432 "mail flashrom@flashrom.org with the subject "
1433 "\"FAILED: <your board name>\"!\n"
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +00001434 "-------------------------------------------------------------"
1435 "------------------\n"
Carl-Daniel Hailfinger8ab49e72009-08-19 13:55:34 +00001436 "DO NOT REBOOT OR POWEROFF!\n");
1437}
1438
Uwe Hermann91f4afa2011-07-28 08:13:25 +00001439/* The way to go if you want a delimited list of programmers */
Stefan Tauner66652442011-06-26 17:38:17 +00001440void list_programmers(const char *delim)
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001441{
1442 enum programmer p;
1443 for (p = 0; p < PROGRAMMER_INVALID; p++) {
Sean Nelson316a29f2010-05-07 20:09:04 +00001444 msg_ginfo("%s", programmer_table[p].name);
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001445 if (p < PROGRAMMER_INVALID - 1)
Sean Nelson316a29f2010-05-07 20:09:04 +00001446 msg_ginfo("%s", delim);
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001447 }
Sean Nelson316a29f2010-05-07 20:09:04 +00001448 msg_ginfo("\n");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001449}
1450
Carl-Daniel Hailfingera73fb492010-10-06 23:48:34 +00001451void list_programmers_linebreak(int startcol, int cols, int paren)
1452{
1453 const char *pname;
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +00001454 int pnamelen;
1455 int remaining = 0, firstline = 1;
Carl-Daniel Hailfingera73fb492010-10-06 23:48:34 +00001456 enum programmer p;
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +00001457 int i;
Carl-Daniel Hailfingera73fb492010-10-06 23:48:34 +00001458
1459 for (p = 0; p < PROGRAMMER_INVALID; p++) {
1460 pname = programmer_table[p].name;
1461 pnamelen = strlen(pname);
1462 if (remaining - pnamelen - 2 < 0) {
1463 if (firstline)
1464 firstline = 0;
1465 else
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +00001466 msg_ginfo("\n");
Carl-Daniel Hailfingera73fb492010-10-06 23:48:34 +00001467 for (i = 0; i < startcol; i++)
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +00001468 msg_ginfo(" ");
Carl-Daniel Hailfingera73fb492010-10-06 23:48:34 +00001469 remaining = cols - startcol;
1470 } else {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +00001471 msg_ginfo(" ");
Carl-Daniel Hailfingera73fb492010-10-06 23:48:34 +00001472 remaining--;
1473 }
1474 if (paren && (p == 0)) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +00001475 msg_ginfo("(");
Carl-Daniel Hailfingera73fb492010-10-06 23:48:34 +00001476 remaining--;
1477 }
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +00001478 msg_ginfo("%s", pname);
Carl-Daniel Hailfingera73fb492010-10-06 23:48:34 +00001479 remaining -= pnamelen;
1480 if (p < PROGRAMMER_INVALID - 1) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +00001481 msg_ginfo(",");
Carl-Daniel Hailfingera73fb492010-10-06 23:48:34 +00001482 remaining--;
1483 } else {
1484 if (paren)
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +00001485 msg_ginfo(")");
1486 msg_ginfo("\n");
Carl-Daniel Hailfingera73fb492010-10-06 23:48:34 +00001487 }
1488 }
1489}
1490
Carl-Daniel Hailfinger132e2ec2010-03-27 16:36:40 +00001491void print_sysinfo(void)
1492{
1493#if HAVE_UTSNAME == 1
1494 struct utsname osinfo;
1495 uname(&osinfo);
1496
1497 msg_ginfo(" on %s %s (%s)", osinfo.sysname, osinfo.release,
1498 osinfo.machine);
1499#else
1500 msg_ginfo(" on unknown machine");
1501#endif
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +00001502}
1503
1504void print_buildinfo(void)
1505{
1506 msg_gdbg("flashrom was built with");
Carl-Daniel Hailfinger132e2ec2010-03-27 16:36:40 +00001507#if NEED_PCI == 1
1508#ifdef PCILIB_VERSION
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +00001509 msg_gdbg(" libpci %s,", PCILIB_VERSION);
Carl-Daniel Hailfinger132e2ec2010-03-27 16:36:40 +00001510#else
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +00001511 msg_gdbg(" unknown PCI library,");
Carl-Daniel Hailfinger132e2ec2010-03-27 16:36:40 +00001512#endif
1513#endif
1514#ifdef __clang__
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +00001515 msg_gdbg(" LLVM Clang");
Carl-Daniel Hailfingerb51e58e2010-07-17 14:49:30 +00001516#ifdef __clang_version__
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +00001517 msg_gdbg(" %s,", __clang_version__);
Carl-Daniel Hailfingerb51e58e2010-07-17 14:49:30 +00001518#else
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +00001519 msg_gdbg(" unknown version (before r102686),");
Carl-Daniel Hailfingerb51e58e2010-07-17 14:49:30 +00001520#endif
Carl-Daniel Hailfinger132e2ec2010-03-27 16:36:40 +00001521#elif defined(__GNUC__)
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +00001522 msg_gdbg(" GCC");
Carl-Daniel Hailfinger132e2ec2010-03-27 16:36:40 +00001523#ifdef __VERSION__
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +00001524 msg_gdbg(" %s,", __VERSION__);
Carl-Daniel Hailfinger132e2ec2010-03-27 16:36:40 +00001525#else
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +00001526 msg_gdbg(" unknown version,");
Carl-Daniel Hailfinger132e2ec2010-03-27 16:36:40 +00001527#endif
1528#else
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +00001529 msg_gdbg(" unknown compiler,");
Carl-Daniel Hailfingercceafa22010-05-26 01:45:41 +00001530#endif
1531#if defined (__FLASHROM_LITTLE_ENDIAN__)
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +00001532 msg_gdbg(" little endian");
Carl-Daniel Hailfinger06b9efa2012-08-07 11:59:59 +00001533#elif defined (__FLASHROM_BIG_ENDIAN__)
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +00001534 msg_gdbg(" big endian");
Carl-Daniel Hailfinger06b9efa2012-08-07 11:59:59 +00001535#else
1536#error Endianness could not be determined
Carl-Daniel Hailfinger132e2ec2010-03-27 16:36:40 +00001537#endif
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +00001538 msg_gdbg("\n");
Carl-Daniel Hailfinger132e2ec2010-03-27 16:36:40 +00001539}
1540
Bernhard Walle201bde32008-01-21 15:24:22 +00001541void print_version(void)
1542{
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +00001543 msg_ginfo("flashrom v%s", flashrom_version);
Carl-Daniel Hailfinger132e2ec2010-03-27 16:36:40 +00001544 print_sysinfo();
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +00001545 msg_ginfo("\n");
Bernhard Walle201bde32008-01-21 15:24:22 +00001546}
1547
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +00001548void print_banner(void)
1549{
1550 msg_ginfo("flashrom is free software, get the source code at "
Uwe Hermann91f4afa2011-07-28 08:13:25 +00001551 "http://www.flashrom.org\n");
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +00001552 msg_ginfo("\n");
1553}
1554
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001555int selfcheck(void)
1556{
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001557 int ret = 0;
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +00001558 const struct flashchip *flash;
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001559
1560 /* Safety check. Instead of aborting after the first error, check
1561 * if more errors exist.
1562 */
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001563 if (ARRAY_SIZE(programmer_table) - 1 != PROGRAMMER_INVALID) {
Sean Nelson316a29f2010-05-07 20:09:04 +00001564 msg_gerr("Programmer table miscompilation!\n");
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001565 ret = 1;
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001566 }
Stefan Tauner93f70232011-07-26 14:33:46 +00001567 /* It would be favorable if we could also check for correct termination
Stefan Tauner716e0982011-07-25 20:38:52 +00001568 * of the following arrays, but we don't know their sizes in here...
Stefan Tauner7bcacb12011-05-26 01:35:19 +00001569 * For 'flashchips' we check the first element to be non-null. In the
1570 * other cases there exist use cases where the first element can be
1571 * null. */
1572 if (flashchips == NULL || flashchips[0].vendor == NULL) {
1573 msg_gerr("Flashchips table miscompilation!\n");
1574 ret = 1;
1575 }
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +00001576 /* Check that virtual_memory in struct flashctx is placed directly
1577 * after the members copied from struct flashchip.
1578 */
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +00001579 if (sizeof(struct flashchip) !=
1580 offsetof(struct flashctx, virtual_memory)) {
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +00001581 msg_gerr("struct flashctx broken!\n");
1582 ret = 1;
1583 }
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001584 for (flash = flashchips; flash && flash->name; flash++)
1585 if (selfcheck_eraseblocks(flash))
1586 ret = 1;
Stefan Tauner7bcacb12011-05-26 01:35:19 +00001587
1588#if CONFIG_INTERNAL == 1
1589 if (chipset_enables == NULL) {
1590 msg_gerr("Chipset enables table does not exist!\n");
1591 ret = 1;
1592 }
Carl-Daniel Hailfinger97d5b122011-08-31 16:19:50 +00001593 if (board_matches == NULL) {
Stefan Tauner7bcacb12011-05-26 01:35:19 +00001594 msg_gerr("Board enables table does not exist!\n");
1595 ret = 1;
1596 }
1597 if (boards_known == NULL) {
1598 msg_gerr("Known boards table does not exist!\n");
1599 ret = 1;
1600 }
1601 if (laptops_known == NULL) {
1602 msg_gerr("Known laptops table does not exist!\n");
1603 ret = 1;
1604 }
Uwe Hermann91f4afa2011-07-28 08:13:25 +00001605#endif
Carl-Daniel Hailfinger293adf02010-01-18 08:14:43 +00001606 return ret;
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001607}
1608
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +00001609void check_chip_supported(const struct flashctx *flash)
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001610{
Daniel Lenski65922a32012-02-15 23:40:23 +00001611 if (flash->feature_bits & FEATURE_OTP) {
1612 msg_cdbg("This chip may contain one-time programmable memory. "
1613 "flashrom cannot read\nand may never be able to write "
1614 "it, hence it may not be able to completely\n"
1615 "clone the contents of this chip (see man page for "
1616 "details).\n");
1617 }
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001618 if (TEST_OK_MASK != (flash->tested & TEST_OK_MASK)) {
Sean Nelson316a29f2010-05-07 20:09:04 +00001619 msg_cinfo("===\n");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001620 if (flash->tested & TEST_BAD_MASK) {
Sean Nelson316a29f2010-05-07 20:09:04 +00001621 msg_cinfo("This flash part has status NOT WORKING for operations:");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001622 if (flash->tested & TEST_BAD_PROBE)
Sean Nelson316a29f2010-05-07 20:09:04 +00001623 msg_cinfo(" PROBE");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001624 if (flash->tested & TEST_BAD_READ)
Sean Nelson316a29f2010-05-07 20:09:04 +00001625 msg_cinfo(" READ");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001626 if (flash->tested & TEST_BAD_ERASE)
Sean Nelson316a29f2010-05-07 20:09:04 +00001627 msg_cinfo(" ERASE");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001628 if (flash->tested & TEST_BAD_WRITE)
Sean Nelson316a29f2010-05-07 20:09:04 +00001629 msg_cinfo(" WRITE");
1630 msg_cinfo("\n");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001631 }
1632 if ((!(flash->tested & TEST_BAD_PROBE) && !(flash->tested & TEST_OK_PROBE)) ||
1633 (!(flash->tested & TEST_BAD_READ) && !(flash->tested & TEST_OK_READ)) ||
1634 (!(flash->tested & TEST_BAD_ERASE) && !(flash->tested & TEST_OK_ERASE)) ||
1635 (!(flash->tested & TEST_BAD_WRITE) && !(flash->tested & TEST_OK_WRITE))) {
Sean Nelson316a29f2010-05-07 20:09:04 +00001636 msg_cinfo("This flash part has status UNTESTED for operations:");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001637 if (!(flash->tested & TEST_BAD_PROBE) && !(flash->tested & TEST_OK_PROBE))
Sean Nelson316a29f2010-05-07 20:09:04 +00001638 msg_cinfo(" PROBE");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001639 if (!(flash->tested & TEST_BAD_READ) && !(flash->tested & TEST_OK_READ))
Sean Nelson316a29f2010-05-07 20:09:04 +00001640 msg_cinfo(" READ");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001641 if (!(flash->tested & TEST_BAD_ERASE) && !(flash->tested & TEST_OK_ERASE))
Sean Nelson316a29f2010-05-07 20:09:04 +00001642 msg_cinfo(" ERASE");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001643 if (!(flash->tested & TEST_BAD_WRITE) && !(flash->tested & TEST_OK_WRITE))
Sean Nelson316a29f2010-05-07 20:09:04 +00001644 msg_cinfo(" WRITE");
1645 msg_cinfo("\n");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001646 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +00001647 /* FIXME: This message is designed towards CLI users. */
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +00001648 msg_cinfo("The test status of this chip may have been updated "
1649 "in the latest development\n"
1650 "version of flashrom. If you are running the latest "
1651 "development version,\n"
1652 "please email a report to flashrom@flashrom.org if "
1653 "any of the above operations\n"
1654 "work correctly for you with this flash part. Please "
1655 "include the flashrom\n"
1656 "output with the additional -V option for all "
1657 "operations you tested (-V, -Vr,\n"
Paul Menzele3800132012-01-12 13:58:43 +00001658 "-VE, -Vw), and mention which mainboard or "
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +00001659 "programmer you tested.\n"
Paul Menzelab6328f2010-10-08 11:03:02 +00001660 "Please mention your board in the subject line. "
1661 "Thanks for your help!\n");
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001662 }
1663}
1664
Carl-Daniel Hailfinger43069442010-10-15 00:01:14 +00001665/* FIXME: This function signature needs to be improved once doit() has a better
1666 * function signature.
1667 */
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +00001668int chip_safety_check(struct flashctx *flash, int force, int read_it,
1669 int write_it, int erase_it, int verify_it)
Carl-Daniel Hailfinger43069442010-10-15 00:01:14 +00001670{
1671 if (!programmer_may_write && (write_it || erase_it)) {
1672 msg_perr("Write/erase is not working yet on your programmer in "
1673 "its current configuration.\n");
1674 /* --force is the wrong approach, but it's the best we can do
1675 * until the generic programmer parameter parser is merged.
1676 */
1677 if (!force)
1678 return 1;
1679 msg_cerr("Continuing anyway.\n");
1680 }
1681
1682 if (read_it || erase_it || write_it || verify_it) {
1683 /* Everything needs read. */
1684 if (flash->tested & TEST_BAD_READ) {
1685 msg_cerr("Read is not working on this chip. ");
1686 if (!force)
1687 return 1;
1688 msg_cerr("Continuing anyway.\n");
1689 }
1690 if (!flash->read) {
1691 msg_cerr("flashrom has no read function for this "
1692 "flash chip.\n");
1693 return 1;
1694 }
1695 }
1696 if (erase_it || write_it) {
1697 /* Write needs erase. */
1698 if (flash->tested & TEST_BAD_ERASE) {
1699 msg_cerr("Erase is not working on this chip. ");
1700 if (!force)
1701 return 1;
1702 msg_cerr("Continuing anyway.\n");
1703 }
Sylvain "ythier" Hitier9db45512011-07-04 07:27:17 +00001704 if(count_usable_erasers(flash) == 0) {
Stefan Tauner5368dca2011-07-01 00:19:12 +00001705 msg_cerr("flashrom has no erase function for this "
1706 "flash chip.\n");
1707 return 1;
1708 }
Carl-Daniel Hailfinger43069442010-10-15 00:01:14 +00001709 }
1710 if (write_it) {
1711 if (flash->tested & TEST_BAD_WRITE) {
1712 msg_cerr("Write is not working on this chip. ");
1713 if (!force)
1714 return 1;
1715 msg_cerr("Continuing anyway.\n");
1716 }
1717 if (!flash->write) {
1718 msg_cerr("flashrom has no write function for this "
1719 "flash chip.\n");
1720 return 1;
1721 }
1722 }
1723 return 0;
1724}
1725
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001726/* This function signature is horrible. We need to design a better interface,
1727 * but right now it allows us to split off the CLI code.
Carl-Daniel Hailfingerf52f7842010-10-08 18:52:29 +00001728 * Besides that, the function itself is a textbook example of abysmal code flow.
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001729 */
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +00001730int doit(struct flashctx *flash, int force, const char *filename, int read_it,
1731 int write_it, int erase_it, int verify_it)
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001732{
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001733 uint8_t *oldcontents;
1734 uint8_t *newcontents;
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001735 int ret = 0;
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001736 unsigned long size = flash->total_size * 1024;
Carl-Daniel Hailfinger552420b2009-12-24 02:15:55 +00001737
David Hendricks77f931a2011-05-18 01:30:56 +00001738 if (chip_safety_check(flash, force, read_it, write_it, erase_it, verify_it)) {
Carl-Daniel Hailfinger43069442010-10-15 00:01:14 +00001739 msg_cerr("Aborting.\n");
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001740 ret = 1;
1741 goto out_nofree;
Carl-Daniel Hailfinger43069442010-10-15 00:01:14 +00001742 }
1743
Carl-Daniel Hailfinger43069442010-10-15 00:01:14 +00001744 /* Given the existence of read locks, we want to unlock for read,
1745 * erase and write.
1746 */
1747 if (flash->unlock)
1748 flash->unlock(flash);
1749
1750 if (read_it) {
1751 ret = read_flash_to_file(flash, filename);
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001752 goto out_nofree;
Carl-Daniel Hailfingerd1be52d2010-07-03 12:14:25 +00001753 }
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001754
Stefan Tauner269de352011-07-12 22:35:21 +00001755 oldcontents = malloc(size);
1756 if (!oldcontents) {
1757 msg_gerr("Out of memory!\n");
1758 exit(1);
1759 }
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001760 /* Assume worst case: All bits are 0. */
1761 memset(oldcontents, 0x00, size);
Stefan Tauner269de352011-07-12 22:35:21 +00001762 newcontents = malloc(size);
1763 if (!newcontents) {
1764 msg_gerr("Out of memory!\n");
1765 exit(1);
1766 }
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001767 /* Assume best case: All bits should be 1. */
1768 memset(newcontents, 0xff, size);
1769 /* Side effect of the assumptions above: Default write action is erase
1770 * because newcontents looks like a completely erased chip, and
1771 * oldcontents being completely 0x00 means we have to erase everything
1772 * before we can write.
1773 */
1774
Ollie Lhoefa28582004-12-08 20:10:01 +00001775 if (erase_it) {
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001776 /* FIXME: Do we really want the scary warning if erase failed?
1777 * After all, after erase the chip is either blank or partially
1778 * blank or it has the old contents. A blank chip won't boot,
1779 * so if the user wanted erase and reboots afterwards, the user
1780 * knows very well that booting won't work.
1781 */
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001782 if (erase_and_write_flash(flash, oldcontents, newcontents)) {
Carl-Daniel Hailfinger8ab49e72009-08-19 13:55:34 +00001783 emergency_help_message();
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001784 ret = 1;
Carl-Daniel Hailfinger8ab49e72009-08-19 13:55:34 +00001785 }
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001786 goto out;
Carl-Daniel Hailfingerf52f7842010-10-08 18:52:29 +00001787 }
Carl-Daniel Hailfinger43069442010-10-15 00:01:14 +00001788
Carl-Daniel Hailfingerf52f7842010-10-08 18:52:29 +00001789 if (write_it || verify_it) {
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001790 if (read_buf_from_file(newcontents, size, filename)) {
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001791 ret = 1;
1792 goto out;
Stefan Reinauer018aca82006-11-21 23:48:51 +00001793 }
1794
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +00001795#if CONFIG_INTERNAL == 1
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001796 if (programmer == PROGRAMMER_INTERNAL)
Niklas Söderlund9e423762012-06-16 00:11:16 +00001797 if (show_id(newcontents, size, force)) {
1798 ret = 1;
1799 goto out;
1800 }
Carl-Daniel Hailfinger66ef4e52009-12-13 22:28:00 +00001801#endif
Ollie Lhocbbf1252004-03-17 22:22:08 +00001802 }
1803
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001804 /* Read the whole chip to be able to check whether regions need to be
1805 * erased and to give better diagnostics in case write fails.
1806 * The alternative would be to read only the regions which are to be
1807 * preserved, but in that case we might perform unneeded erase which
1808 * takes time as well.
1809 */
Carl-Daniel Hailfinger84d19682011-07-26 14:28:35 +00001810 msg_cinfo("Reading old flash chip contents... ");
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001811 if (flash->read(flash, oldcontents, 0, size)) {
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001812 ret = 1;
Carl-Daniel Hailfinger84d19682011-07-26 14:28:35 +00001813 msg_cinfo("FAILED.\n");
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001814 goto out;
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001815 }
Carl-Daniel Hailfinger84d19682011-07-26 14:28:35 +00001816 msg_cinfo("done.\n");
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001817
Ollie Lho184a4042005-11-26 21:55:36 +00001818 // This should be moved into each flash part's code to do it
1819 // cleanly. This does the job.
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001820 handle_romentries(flash, oldcontents, newcontents);
Uwe Hermanna7e05482007-05-09 10:17:44 +00001821
Ollie Lho184a4042005-11-26 21:55:36 +00001822 // ////////////////////////////////////////////////////////////
Uwe Hermanna7e05482007-05-09 10:17:44 +00001823
Peter Stugef31104c2008-04-28 14:47:30 +00001824 if (write_it) {
Carl-Daniel Hailfinger6e2ea322010-11-04 01:04:27 +00001825 if (erase_and_write_flash(flash, oldcontents, newcontents)) {
1826 msg_cerr("Uh oh. Erase/write failed. Checking if "
1827 "anything changed.\n");
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001828 if (!flash->read(flash, newcontents, 0, size)) {
1829 if (!memcmp(oldcontents, newcontents, size)) {
1830 msg_cinfo("Good. It seems nothing was "
1831 "changed.\n");
1832 nonfatal_help_message();
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001833 ret = 1;
1834 goto out;
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001835 }
1836 }
Carl-Daniel Hailfingerf52f7842010-10-08 18:52:29 +00001837 emergency_help_message();
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001838 ret = 1;
1839 goto out;
Peter Stugef31104c2008-04-28 14:47:30 +00001840 }
Peter Stugef31104c2008-04-28 14:47:30 +00001841 }
Ollie Lho184a4042005-11-26 21:55:36 +00001842
Carl-Daniel Hailfinger8ab49e72009-08-19 13:55:34 +00001843 if (verify_it) {
1844 /* Work around chips which need some time to calm down. */
1845 if (write_it)
1846 programmer_delay(1000*1000);
Carl-Daniel Hailfinger42d38a92010-10-19 22:06:20 +00001847 ret = verify_flash(flash, newcontents);
Carl-Daniel Hailfingerf5292052009-11-17 09:57:34 +00001848 /* If we tried to write, and verification now fails, we
Carl-Daniel Hailfinger8ab49e72009-08-19 13:55:34 +00001849 * might have an emergency situation.
1850 */
1851 if (ret && write_it)
1852 emergency_help_message();
1853 }
Ollie Lho184a4042005-11-26 21:55:36 +00001854
Carl-Daniel Hailfinger12d6d822010-11-05 14:51:59 +00001855out:
1856 free(oldcontents);
1857 free(newcontents);
1858out_nofree:
Carl-Daniel Hailfinger702218d2009-05-08 17:43:22 +00001859