blob: 984a4dac2c958f91483579ac0e6062d47bd1f2a2 [file] [log] [blame]
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +00001/*
2 * This file is part of the flashrom project.
3 *
4 * Copyright (C) 2000 Silicon Integrated System Corporation
5 * Copyright (C) 2004 Tyan Corp <yhlu@tyan.com>
6 * Copyright (C) 2005-2008 coresystems GmbH
7 * Copyright (C) 2008,2009,2010 Carl-Daniel Hailfinger
8 *
9 * 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.
13 *
14 * 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.
18 *
19 * 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
22 */
23
Carl-Daniel Hailfinger831e8f42010-05-30 22:24:40 +000024#include <stdio.h>
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000025#include <fcntl.h>
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000026#include <sys/stat.h>
27#include <string.h>
28#include <stdlib.h>
29#include <getopt.h>
30#include "flash.h"
31#include "flashchips.h"
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000032#include "programmer.h"
Nico Huber18781102012-12-10 13:34:12 +000033#include "libflashrom.h"
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000034
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +000035static void cli_classic_usage(const char *name)
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000036{
Stefan Taunerb226cb12012-11-24 18:59:39 +000037 printf("Please note that the command line interface for flashrom has changed between\n"
38 "0.9.5 and 0.9.6 and will change again before flashrom 1.0.\n\n");
39
40 printf("Usage: %s [-h|-R|-L|"
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000041#if CONFIG_PRINT_WIKI == 1
Stefan Taunerb226cb12012-11-24 18:59:39 +000042 "-z|"
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000043#endif
Stefan Taunerb226cb12012-11-24 18:59:39 +000044 "-p <programmername>[:<parameters>] [-c <chipname>]\n"
45 "[-E|(-r|-w|-v) <file>] [-l <layoutfile> [-i <imagename>]...] [-n] [-f]]\n"
46 "[-V[V[V]]] [-o <logfile>]\n\n", name);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000047
Stefan Taunerb226cb12012-11-24 18:59:39 +000048 printf(" -h | --help print this help text\n"
49 " -R | --version print version (release)\n"
50 " -r | --read <file> read flash and save to <file>\n"
51 " -w | --write <file> write <file> to flash\n"
52 " -v | --verify <file> verify flash against <file>\n"
53 " -E | --erase erase flash memory\n"
54 " -V | --verbose more verbose output\n"
55 " -c | --chip <chipname> probe only for specified flash chip\n"
56 " -f | --force force specific operations (see man page)\n"
57 " -n | --noverify don't auto-verify\n"
58 " -l | --layout <layoutfile> read ROM layout from <layoutfile>\n"
59 " -i | --image <name> only flash image <name> from flash layout\n"
60 " -o | --output <logfile> log output to <logfile>\n"
61 " -L | --list-supported print supported devices\n"
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000062#if CONFIG_PRINT_WIKI == 1
Stefan Taunerb226cb12012-11-24 18:59:39 +000063 " -z | --list-supported-wiki print supported devices in wiki syntax\n"
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000064#endif
Stefan Taunerb226cb12012-11-24 18:59:39 +000065 " -p | --programmer <name>[:<param>] specify the programmer device. One of\n");
66 list_programmers_linebreak(4, 80, 0);
67 printf(".\n\nYou can specify one of -h, -R, -L, "
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000068#if CONFIG_PRINT_WIKI == 1
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000069 "-z, "
70#endif
71 "-E, -r, -w, -v or no operation.\n"
Stefan Taunerb226cb12012-11-24 18:59:39 +000072 "If no operation is specified, flashrom will only probe for flash chips.\n");
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000073}
74
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +000075static void cli_classic_abort_usage(void)
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000076{
Uwe Hermann2db77a02010-06-04 17:07:39 +000077 printf("Please run \"flashrom --help\" for usage info.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000078 exit(1);
79}
80
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +000081static int check_filename(char *filename, char *type)
82{
83 if (!filename || (filename[0] == '\0')) {
84 fprintf(stderr, "Error: No %s file specified.\n", type);
85 return 1;
86 }
87 /* Not an error, but maybe the user intended to specify a CLI option instead of a file name. */
88 if (filename[0] == '-')
89 fprintf(stderr, "Warning: Supplied %s file name starts with -\n", type);
90 return 0;
91}
92
Uwe Hermann394ee782011-08-20 14:14:22 +000093int main(int argc, char *argv[])
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000094{
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +000095 const struct flashchip *chip = NULL;
Jernej Škrabece814a9b2014-12-12 00:32:03 +000096 /* Probe for up to eight flash chips. */
97 struct flashctx flashes[8] = {{0}};
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000098 struct flashctx *fill_flash;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000099 const char *name;
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000100 int namelen, opt, i, j;
Carl-Daniel Hailfingerb428e972012-02-16 20:31:25 +0000101 int startchip = -1, chipcount = 0, option_index = 0, force = 0;
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000102#if CONFIG_PRINT_WIKI == 1
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000103 int list_supported_wiki = 0;
104#endif
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000105 int read_it = 0, write_it = 0, erase_it = 0, verify_it = 0;
106 int dont_verify_it = 0, list_supported = 0, operation_specified = 0;
Carl-Daniel Hailfinger2e681602011-09-08 00:00:29 +0000107 enum programmer prog = PROGRAMMER_INVALID;
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000108 int ret = 0;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000109
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000110 static const char optstring[] = "r:Rw:v:nVEfc:l:i:p:Lzho:";
Mathias Krausea60faab2011-01-17 07:50:42 +0000111 static const struct option long_options[] = {
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000112 {"read", 1, NULL, 'r'},
113 {"write", 1, NULL, 'w'},
114 {"erase", 0, NULL, 'E'},
115 {"verify", 1, NULL, 'v'},
116 {"noverify", 0, NULL, 'n'},
117 {"chip", 1, NULL, 'c'},
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000118 {"verbose", 0, NULL, 'V'},
119 {"force", 0, NULL, 'f'},
120 {"layout", 1, NULL, 'l'},
121 {"image", 1, NULL, 'i'},
122 {"list-supported", 0, NULL, 'L'},
123 {"list-supported-wiki", 0, NULL, 'z'},
124 {"programmer", 1, NULL, 'p'},
125 {"help", 0, NULL, 'h'},
126 {"version", 0, NULL, 'R'},
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000127 {"output", 1, NULL, 'o'},
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000128 {NULL, 0, NULL, 0},
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000129 };
130
131 char *filename = NULL;
Carl-Daniel Hailfinger46284452012-01-11 02:10:11 +0000132 char *layoutfile = NULL;
Stefan Taunerb8911d62012-12-26 07:55:00 +0000133#ifndef STANDALONE
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000134 char *logfile = NULL;
Stefan Taunerb8911d62012-12-26 07:55:00 +0000135#endif /* !STANDALONE */
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000136 char *tempstr = NULL;
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000137 char *pparam = NULL;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000138
Nico Huber18781102012-12-10 13:34:12 +0000139 flashrom_set_log_callback((flashrom_log_callback *)&flashrom_print_cb);
140
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000141 print_version();
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000142 print_banner();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000143
144 if (selfcheck())
145 exit(1);
146
147 setbuf(stdout, NULL);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000148 /* FIXME: Delay all operation_specified checks until after command
149 * line parsing to allow --help overriding everything else.
150 */
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000151 while ((opt = getopt_long(argc, argv, optstring,
152 long_options, &option_index)) != EOF) {
153 switch (opt) {
154 case 'r':
155 if (++operation_specified > 1) {
156 fprintf(stderr, "More than one operation "
157 "specified. Aborting.\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000158 cli_classic_abort_usage();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000159 }
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000160 filename = strdup(optarg);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000161 read_it = 1;
162 break;
163 case 'w':
164 if (++operation_specified > 1) {
165 fprintf(stderr, "More than one operation "
166 "specified. Aborting.\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000167 cli_classic_abort_usage();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000168 }
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000169 filename = strdup(optarg);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000170 write_it = 1;
171 break;
172 case 'v':
173 //FIXME: gracefully handle superfluous -v
174 if (++operation_specified > 1) {
175 fprintf(stderr, "More than one operation "
176 "specified. Aborting.\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000177 cli_classic_abort_usage();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000178 }
179 if (dont_verify_it) {
Stefan Taunerc4f44df2013-08-12 22:58:43 +0000180 fprintf(stderr, "--verify and --noverify are mutually exclusive. Aborting.\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000181 cli_classic_abort_usage();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000182 }
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000183 filename = strdup(optarg);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000184 verify_it = 1;
185 break;
186 case 'n':
187 if (verify_it) {
Stefan Taunerc4f44df2013-08-12 22:58:43 +0000188 fprintf(stderr, "--verify and --noverify are mutually exclusive. Aborting.\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000189 cli_classic_abort_usage();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000190 }
191 dont_verify_it = 1;
192 break;
193 case 'c':
194 chip_to_probe = strdup(optarg);
195 break;
196 case 'V':
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000197 verbose_screen++;
198 if (verbose_screen > MSG_DEBUG2)
199 verbose_logfile = verbose_screen;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000200 break;
201 case 'E':
202 if (++operation_specified > 1) {
203 fprintf(stderr, "More than one operation "
204 "specified. Aborting.\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000205 cli_classic_abort_usage();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000206 }
207 erase_it = 1;
208 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000209 case 'f':
210 force = 1;
211 break;
212 case 'l':
Carl-Daniel Hailfinger46284452012-01-11 02:10:11 +0000213 if (layoutfile) {
214 fprintf(stderr, "Error: --layout specified "
215 "more than once. Aborting.\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000216 cli_classic_abort_usage();
Carl-Daniel Hailfinger46284452012-01-11 02:10:11 +0000217 }
218 layoutfile = strdup(optarg);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000219 break;
220 case 'i':
221 tempstr = strdup(optarg);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000222 if (register_include_arg(tempstr)) {
223 free(tempstr);
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000224 cli_classic_abort_usage();
Stefan Taunerb8911d62012-12-26 07:55:00 +0000225 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000226 break;
227 case 'L':
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000228 if (++operation_specified > 1) {
229 fprintf(stderr, "More than one operation "
230 "specified. Aborting.\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000231 cli_classic_abort_usage();
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000232 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000233 list_supported = 1;
234 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000235 case 'z':
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000236#if CONFIG_PRINT_WIKI == 1
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000237 if (++operation_specified > 1) {
238 fprintf(stderr, "More than one operation "
239 "specified. Aborting.\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000240 cli_classic_abort_usage();
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000241 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000242 list_supported_wiki = 1;
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000243#else
244 fprintf(stderr, "Error: Wiki output was not compiled "
245 "in. Aborting.\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000246 cli_classic_abort_usage();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000247#endif
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000248 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000249 case 'p':
Carl-Daniel Hailfinger2e681602011-09-08 00:00:29 +0000250 if (prog != PROGRAMMER_INVALID) {
251 fprintf(stderr, "Error: --programmer specified "
252 "more than once. You can separate "
253 "multiple\nparameters for a programmer "
254 "with \",\". Please see the man page "
255 "for details.\n");
256 cli_classic_abort_usage();
257 }
258 for (prog = 0; prog < PROGRAMMER_INVALID; prog++) {
259 name = programmer_table[prog].name;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000260 namelen = strlen(name);
261 if (strncmp(optarg, name, namelen) == 0) {
262 switch (optarg[namelen]) {
263 case ':':
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000264 pparam = strdup(optarg + namelen + 1);
265 if (!strlen(pparam)) {
266 free(pparam);
267 pparam = NULL;
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000268 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000269 break;
270 case '\0':
271 break;
272 default:
273 /* The continue refers to the
274 * for loop. It is here to be
275 * able to differentiate between
276 * foo and foobar.
277 */
278 continue;
279 }
280 break;
281 }
282 }
Carl-Daniel Hailfinger2e681602011-09-08 00:00:29 +0000283 if (prog == PROGRAMMER_INVALID) {
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000284 fprintf(stderr, "Error: Unknown programmer \"%s\". Valid choices are:\n",
285 optarg);
286 list_programmers_linebreak(0, 80, 0);
Stefan Taunerb226cb12012-11-24 18:59:39 +0000287 msg_ginfo(".\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000288 cli_classic_abort_usage();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000289 }
290 break;
291 case 'R':
292 /* print_version() is always called during startup. */
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000293 if (++operation_specified > 1) {
294 fprintf(stderr, "More than one operation "
295 "specified. Aborting.\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000296 cli_classic_abort_usage();
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000297 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000298 exit(0);
299 break;
300 case 'h':
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000301 if (++operation_specified > 1) {
302 fprintf(stderr, "More than one operation "
303 "specified. Aborting.\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000304 cli_classic_abort_usage();
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000305 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000306 cli_classic_usage(argv[0]);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000307 exit(0);
308 break;
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000309 case 'o':
310#ifdef STANDALONE
311 fprintf(stderr, "Log file not supported in standalone mode. Aborting.\n");
312 cli_classic_abort_usage();
313#else /* STANDALONE */
314 logfile = strdup(optarg);
315 if (logfile[0] == '\0') {
316 fprintf(stderr, "No log filename specified.\n");
317 cli_classic_abort_usage();
318 }
319#endif /* STANDALONE */
320 break;
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000321 default:
Uwe Hermann2db77a02010-06-04 17:07:39 +0000322 cli_classic_abort_usage();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000323 break;
324 }
325 }
326
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000327 if (optind < argc) {
328 fprintf(stderr, "Error: Extra parameter found.\n");
329 cli_classic_abort_usage();
330 }
331
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000332 if ((read_it | write_it | verify_it) && check_filename(filename, "image")) {
333 cli_classic_abort_usage();
334 }
335 if (layoutfile && check_filename(layoutfile, "layout")) {
336 cli_classic_abort_usage();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000337 }
338
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000339#ifndef STANDALONE
340 if (logfile && check_filename(logfile, "log"))
341 cli_classic_abort_usage();
342 if (logfile && open_logfile(logfile))
Stefan Tauner20da4aa2014-05-07 22:07:23 +0000343 cli_classic_abort_usage();
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000344#endif /* !STANDALONE */
345
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000346#if CONFIG_PRINT_WIKI == 1
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000347 if (list_supported_wiki) {
348 print_supported_wiki();
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000349 goto out;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000350 }
351#endif
352
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000353 if (list_supported) {
Niklas Söderlundede2fa42012-10-23 13:06:46 +0000354 if (print_supported())
355 ret = 1;
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000356 goto out;
357 }
Carl-Daniel Hailfinger46284452012-01-11 02:10:11 +0000358
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000359#ifndef STANDALONE
360 start_logging();
361#endif /* !STANDALONE */
362
363 print_buildinfo();
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000364 msg_gdbg("Command line (%i args):", argc - 1);
365 for (i = 0; i < argc; i++) {
366 msg_gdbg(" %s", argv[i]);
367 }
368 msg_gdbg("\n");
369
370 if (layoutfile && read_romlayout(layoutfile)) {
371 ret = 1;
372 goto out;
373 }
Stefan Tauner8268fdb2013-09-23 14:21:06 +0000374 if (layoutfile != NULL && !write_it) {
375 msg_gerr("Layout files are currently supported for write operations only.\n");
376 ret = 1;
377 goto out;
378 }
379
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000380 if (process_include_args()) {
381 ret = 1;
382 goto out;
383 }
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000384 /* Does a chip with the requested name exist in the flashchips array? */
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000385 if (chip_to_probe) {
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000386 for (chip = flashchips; chip && chip->name; chip++)
387 if (!strcmp(chip->name, chip_to_probe))
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000388 break;
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000389 if (!chip || !chip->name) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000390 msg_cerr("Error: Unknown chip '%s' specified.\n", chip_to_probe);
391 msg_gerr("Run flashrom -L to view the hardware supported in this flashrom version.\n");
392 ret = 1;
393 goto out;
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000394 }
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000395 /* Keep chip around for later usage in case a forced read is requested. */
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000396 }
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000397
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000398 if (prog == PROGRAMMER_INVALID) {
Stefan Taunerfd0d4132012-09-25 21:24:55 +0000399 if (CONFIG_DEFAULT_PROGRAMMER != PROGRAMMER_INVALID) {
400 prog = CONFIG_DEFAULT_PROGRAMMER;
Stefan Tauner265fcac2014-06-02 00:12:23 +0000401 /* We need to strdup here because we free(pparam) unconditionally later. */
402 pparam = strdup(CONFIG_DEFAULT_PROGRAMMER_ARGS);
403 msg_pinfo("Using default programmer \"%s\" with arguments \"%s\".\n",
404 programmer_table[CONFIG_DEFAULT_PROGRAMMER].name, pparam);
Stefan Taunerfd0d4132012-09-25 21:24:55 +0000405 } else {
406 msg_perr("Please select a programmer with the --programmer parameter.\n"
Stefan Taunerb226cb12012-11-24 18:59:39 +0000407 "Previously this was not necessary because there was a default set.\n"
408#if CONFIG_INTERNAL == 1
409 "To choose the mainboard of this computer use 'internal'. "
410#endif
Stefan Taunerfd0d4132012-09-25 21:24:55 +0000411 "Valid choices are:\n");
412 list_programmers_linebreak(0, 80, 0);
Stefan Taunerb226cb12012-11-24 18:59:39 +0000413 msg_ginfo(".\n");
Stefan Taunerfd0d4132012-09-25 21:24:55 +0000414 ret = 1;
415 goto out;
416 }
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000417 }
Carl-Daniel Hailfinger2e681602011-09-08 00:00:29 +0000418
Carl-Daniel Hailfinger49884202010-05-22 07:10:46 +0000419 /* FIXME: Delay calibration should happen in programmer code. */
420 myusec_calibrate_delay();
421
Carl-Daniel Hailfinger2e681602011-09-08 00:00:29 +0000422 if (programmer_init(prog, pparam)) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000423 msg_perr("Error: Programmer initialization failed.\n");
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000424 ret = 1;
425 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000426 }
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000427 tempstr = flashbuses_to_text(get_buses_supported());
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000428 msg_pdbg("The following protocols are supported: %s.\n", tempstr);
Carl-Daniel Hailfingereaacd2d2011-11-09 23:40:00 +0000429 free(tempstr);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000430
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000431 for (j = 0; j < registered_master_count; j++) {
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000432 startchip = 0;
Michael Karcher222bf102011-12-22 23:27:03 +0000433 while (chipcount < ARRAY_SIZE(flashes)) {
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000434 startchip = probe_flash(&registered_masters[j], startchip, &flashes[chipcount], 0);
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000435 if (startchip == -1)
436 break;
437 chipcount++;
438 startchip++;
439 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000440 }
441
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000442 if (chipcount > 1) {
Stefan Tauner0554ca52013-07-25 22:54:25 +0000443 msg_cinfo("Multiple flash chip definitions match the detected chip(s): \"%s\"",
444 flashes[0].chip->name);
Stefan Tauner716e0982011-07-25 20:38:52 +0000445 for (i = 1; i < chipcount; i++)
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000446 msg_cinfo(", \"%s\"", flashes[i].chip->name);
Stefan Tauner0554ca52013-07-25 22:54:25 +0000447 msg_cinfo("\nPlease specify which chip definition to use with the -c <chipname> option.\n");
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000448 ret = 1;
449 goto out_shutdown;
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000450 } else if (!chipcount) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000451 msg_cinfo("No EEPROM/flash device found.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000452 if (!force || !chip_to_probe) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000453 msg_cinfo("Note: flashrom can never write if the flash chip isn't found "
454 "automatically.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000455 }
456 if (force && read_it && chip_to_probe) {
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000457 struct registered_master *mst;
458 int compatible_masters = 0;
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000459 msg_cinfo("Force read (-f -r -c) requested, pretending the chip is there:\n");
Carl-Daniel Hailfingerb428e972012-02-16 20:31:25 +0000460 /* This loop just counts compatible controllers. */
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000461 for (j = 0; j < registered_master_count; j++) {
462 mst = &registered_masters[j];
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000463 /* chip is still set from the chip_to_probe earlier in this function. */
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000464 if (mst->buses_supported & chip->bustype)
465 compatible_masters++;
Carl-Daniel Hailfingerb428e972012-02-16 20:31:25 +0000466 }
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000467 if (!compatible_masters) {
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000468 msg_cinfo("No compatible controller found for the requested flash chip.\n");
469 ret = 1;
470 goto out_shutdown;
471 }
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000472 if (compatible_masters > 1)
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000473 msg_cinfo("More than one compatible controller found for the requested flash "
474 "chip, using the first one.\n");
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000475 for (j = 0; j < registered_master_count; j++) {
476 mst = &registered_masters[j];
477 startchip = probe_flash(mst, 0, &flashes[0], 1);
Carl-Daniel Hailfingerb428e972012-02-16 20:31:25 +0000478 if (startchip != -1)
479 break;
480 }
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000481 if (startchip == -1) {
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000482 // FIXME: This should never happen! Ask for a bug report?
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000483 msg_cinfo("Probing for flash chip '%s' failed.\n", chip_to_probe);
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000484 ret = 1;
485 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000486 }
Stefan Tauner4e32ec12014-08-30 23:39:51 +0000487 if (map_flash(&flashes[0]) != 0) {
488 free(flashes[0].chip);
489 ret = 1;
490 goto out_shutdown;
491 }
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000492 msg_cinfo("Please note that forced reads most likely contain garbage.\n");
493 ret = read_flash_to_file(&flashes[0], filename);
Stefan Tauner4e32ec12014-08-30 23:39:51 +0000494 unmap_flash(&flashes[0]);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000495 free(flashes[0].chip);
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000496 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000497 }
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000498 ret = 1;
499 goto out_shutdown;
Stefan Tauner1d947632011-09-11 22:08:58 +0000500 } else if (!chip_to_probe) {
501 /* repeat for convenience when looking at foreign logs */
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000502 tempstr = flashbuses_to_text(flashes[0].chip->bustype);
Stefan Tauner1d947632011-09-11 22:08:58 +0000503 msg_gdbg("Found %s flash chip \"%s\" (%d kB, %s).\n",
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000504 flashes[0].chip->vendor, flashes[0].chip->name, flashes[0].chip->total_size, tempstr);
Stefan Tauner1d947632011-09-11 22:08:58 +0000505 free(tempstr);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000506 }
507
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000508 fill_flash = &flashes[0];
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000509
Stefan Tauner9b32de92014-08-08 23:52:33 +0000510 print_chip_support_status(fill_flash->chip);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000511
Stefan Tauner9e3a6982014-08-15 17:17:59 +0000512 unsigned int limitexceeded = count_max_decode_exceedings(fill_flash);
513 if (limitexceeded > 0 && !force) {
514 enum chipbustype commonbuses = fill_flash->mst->buses_supported & fill_flash->chip->bustype;
515
516 /* Sometimes chip and programmer have more than one bus in common,
517 * and the limit is not exceeded on all buses. Tell the user. */
518 if ((bitcount(commonbuses) > limitexceeded)) {
519 msg_pdbg("There is at least one interface available which could support the size of\n"
520 "the selected flash chip.\n");
521 }
522 msg_cerr("This flash chip is too big for this programmer (--verbose/-V gives details).\n"
523 "Use --force/-f to override at your own risk.\n");
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000524 ret = 1;
525 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000526 }
527
528 if (!(read_it | write_it | verify_it | erase_it)) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000529 msg_ginfo("No operations were specified.\n");
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000530 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000531 }
532
533 /* Always verify write operations unless -n is used. */
534 if (write_it && !dont_verify_it)
535 verify_it = 1;
536
Stefan Tauner4e32ec12014-08-30 23:39:51 +0000537 /* Map the selected flash chip again. */
538 if (map_flash(fill_flash) != 0) {
539 ret = 1;
540 goto out_shutdown;
541 }
542
Carl-Daniel Hailfinger9ad42552010-09-15 10:20:16 +0000543 /* FIXME: We should issue an unconditional chip reset here. This can be
544 * done once we have a .reset function in struct flashchip.
545 * Give the chip time to settle.
546 */
547 programmer_delay(100000);
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000548 ret |= doit(fill_flash, force, filename, read_it, write_it, erase_it, verify_it);
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000549
Stefan Tauner4e32ec12014-08-30 23:39:51 +0000550 unmap_flash(fill_flash);
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000551out_shutdown:
552 programmer_shutdown();
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000553out:
Stefan Taunerb8911d62012-12-26 07:55:00 +0000554 for (i = 0; i < chipcount; i++)
555 free(flashes[i].chip);
556
Stefan Tauner949ccc82013-09-15 14:01:06 +0000557 layout_cleanup();
Stefan Taunerb8911d62012-12-26 07:55:00 +0000558 free(filename);
559 free(layoutfile);
560 free(pparam);
561 /* clean up global variables */
Nico Huberbcb2e5a2012-12-30 01:23:17 +0000562 free((char *)chip_to_probe); /* Silence! Freeing is not modifying contents. */
Stefan Taunerb8911d62012-12-26 07:55:00 +0000563 chip_to_probe = NULL;
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000564#ifndef STANDALONE
Stefan Tauner20da4aa2014-05-07 22:07:23 +0000565 free(logfile);
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000566 ret |= close_logfile();
567#endif /* !STANDALONE */
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000568 return ret;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000569}