blob: a32d55b3168b893354d61112adf7f445644f7d34 [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"
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000033
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +000034static void cli_classic_usage(const char *name)
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000035{
Stefan Taunerb226cb12012-11-24 18:59:39 +000036 printf("Please note that the command line interface for flashrom has changed between\n"
37 "0.9.5 and 0.9.6 and will change again before flashrom 1.0.\n\n");
38
39 printf("Usage: %s [-h|-R|-L|"
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000040#if CONFIG_PRINT_WIKI == 1
Stefan Taunerb226cb12012-11-24 18:59:39 +000041 "-z|"
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000042#endif
Stefan Taunerb226cb12012-11-24 18:59:39 +000043 "-p <programmername>[:<parameters>] [-c <chipname>]\n"
44 "[-E|(-r|-w|-v) <file>] [-l <layoutfile> [-i <imagename>]...] [-n] [-f]]\n"
45 "[-V[V[V]]] [-o <logfile>]\n\n", name);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000046
Stefan Taunerb226cb12012-11-24 18:59:39 +000047 printf(" -h | --help print this help text\n"
48 " -R | --version print version (release)\n"
49 " -r | --read <file> read flash and save to <file>\n"
50 " -w | --write <file> write <file> to flash\n"
51 " -v | --verify <file> verify flash against <file>\n"
52 " -E | --erase erase flash memory\n"
53 " -V | --verbose more verbose output\n"
54 " -c | --chip <chipname> probe only for specified flash chip\n"
55 " -f | --force force specific operations (see man page)\n"
56 " -n | --noverify don't auto-verify\n"
57 " -l | --layout <layoutfile> read ROM layout from <layoutfile>\n"
58 " -i | --image <name> only flash image <name> from flash layout\n"
59 " -o | --output <logfile> log output to <logfile>\n"
60 " -L | --list-supported print supported devices\n"
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000061#if CONFIG_PRINT_WIKI == 1
Stefan Taunerb226cb12012-11-24 18:59:39 +000062 " -z | --list-supported-wiki print supported devices in wiki syntax\n"
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000063#endif
Stefan Taunerb226cb12012-11-24 18:59:39 +000064 " -p | --programmer <name>[:<param>] specify the programmer device. One of\n");
65 list_programmers_linebreak(4, 80, 0);
66 printf(".\n\nYou can specify one of -h, -R, -L, "
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000067#if CONFIG_PRINT_WIKI == 1
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000068 "-z, "
69#endif
70 "-E, -r, -w, -v or no operation.\n"
Stefan Taunerb226cb12012-11-24 18:59:39 +000071 "If no operation is specified, flashrom will only probe for flash chips.\n");
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000072}
73
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +000074static void cli_classic_abort_usage(void)
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000075{
Uwe Hermann2db77a02010-06-04 17:07:39 +000076 printf("Please run \"flashrom --help\" for usage info.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000077 exit(1);
78}
79
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +000080static int check_filename(char *filename, char *type)
81{
82 if (!filename || (filename[0] == '\0')) {
83 fprintf(stderr, "Error: No %s file specified.\n", type);
84 return 1;
85 }
86 /* Not an error, but maybe the user intended to specify a CLI option instead of a file name. */
87 if (filename[0] == '-')
88 fprintf(stderr, "Warning: Supplied %s file name starts with -\n", type);
89 return 0;
90}
91
Uwe Hermann394ee782011-08-20 14:14:22 +000092int main(int argc, char *argv[])
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000093{
94 unsigned long size;
95 /* Probe for up to three flash chips. */
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +000096 const struct flashchip *chip = NULL;
97 struct flashctx flashes[3] = {{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
139 print_version();
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000140 print_banner();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000141
142 if (selfcheck())
143 exit(1);
144
145 setbuf(stdout, NULL);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000146 /* FIXME: Delay all operation_specified checks until after command
147 * line parsing to allow --help overriding everything else.
148 */
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000149 while ((opt = getopt_long(argc, argv, optstring,
150 long_options, &option_index)) != EOF) {
151 switch (opt) {
152 case 'r':
153 if (++operation_specified > 1) {
154 fprintf(stderr, "More than one operation "
155 "specified. Aborting.\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000156 cli_classic_abort_usage();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000157 }
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000158 filename = strdup(optarg);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000159 read_it = 1;
160 break;
161 case 'w':
162 if (++operation_specified > 1) {
163 fprintf(stderr, "More than one operation "
164 "specified. Aborting.\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000165 cli_classic_abort_usage();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000166 }
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000167 filename = strdup(optarg);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000168 write_it = 1;
169 break;
170 case 'v':
171 //FIXME: gracefully handle superfluous -v
172 if (++operation_specified > 1) {
173 fprintf(stderr, "More than one operation "
174 "specified. Aborting.\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000175 cli_classic_abort_usage();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000176 }
177 if (dont_verify_it) {
Stefan Taunerc4f44df2013-08-12 22:58:43 +0000178 fprintf(stderr, "--verify and --noverify are mutually exclusive. Aborting.\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000179 cli_classic_abort_usage();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000180 }
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000181 filename = strdup(optarg);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000182 verify_it = 1;
183 break;
184 case 'n':
185 if (verify_it) {
Stefan Taunerc4f44df2013-08-12 22:58:43 +0000186 fprintf(stderr, "--verify and --noverify are mutually exclusive. Aborting.\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000187 cli_classic_abort_usage();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000188 }
189 dont_verify_it = 1;
190 break;
191 case 'c':
192 chip_to_probe = strdup(optarg);
193 break;
194 case 'V':
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000195 verbose_screen++;
196 if (verbose_screen > MSG_DEBUG2)
197 verbose_logfile = verbose_screen;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000198 break;
199 case 'E':
200 if (++operation_specified > 1) {
201 fprintf(stderr, "More than one operation "
202 "specified. Aborting.\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000203 cli_classic_abort_usage();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000204 }
205 erase_it = 1;
206 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000207 case 'f':
208 force = 1;
209 break;
210 case 'l':
Carl-Daniel Hailfinger46284452012-01-11 02:10:11 +0000211 if (layoutfile) {
212 fprintf(stderr, "Error: --layout specified "
213 "more than once. Aborting.\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000214 cli_classic_abort_usage();
Carl-Daniel Hailfinger46284452012-01-11 02:10:11 +0000215 }
216 layoutfile = strdup(optarg);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000217 break;
218 case 'i':
219 tempstr = strdup(optarg);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000220 if (register_include_arg(tempstr)) {
221 free(tempstr);
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000222 cli_classic_abort_usage();
Stefan Taunerb8911d62012-12-26 07:55:00 +0000223 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000224 break;
225 case 'L':
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000226 if (++operation_specified > 1) {
227 fprintf(stderr, "More than one operation "
228 "specified. Aborting.\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000229 cli_classic_abort_usage();
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000230 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000231 list_supported = 1;
232 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000233 case 'z':
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000234#if CONFIG_PRINT_WIKI == 1
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000235 if (++operation_specified > 1) {
236 fprintf(stderr, "More than one operation "
237 "specified. Aborting.\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000238 cli_classic_abort_usage();
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000239 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000240 list_supported_wiki = 1;
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000241#else
242 fprintf(stderr, "Error: Wiki output was not compiled "
243 "in. Aborting.\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000244 cli_classic_abort_usage();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000245#endif
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000246 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000247 case 'p':
Carl-Daniel Hailfinger2e681602011-09-08 00:00:29 +0000248 if (prog != PROGRAMMER_INVALID) {
249 fprintf(stderr, "Error: --programmer specified "
250 "more than once. You can separate "
251 "multiple\nparameters for a programmer "
252 "with \",\". Please see the man page "
253 "for details.\n");
254 cli_classic_abort_usage();
255 }
256 for (prog = 0; prog < PROGRAMMER_INVALID; prog++) {
257 name = programmer_table[prog].name;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000258 namelen = strlen(name);
259 if (strncmp(optarg, name, namelen) == 0) {
260 switch (optarg[namelen]) {
261 case ':':
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000262 pparam = strdup(optarg + namelen + 1);
263 if (!strlen(pparam)) {
264 free(pparam);
265 pparam = NULL;
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000266 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000267 break;
268 case '\0':
269 break;
270 default:
271 /* The continue refers to the
272 * for loop. It is here to be
273 * able to differentiate between
274 * foo and foobar.
275 */
276 continue;
277 }
278 break;
279 }
280 }
Carl-Daniel Hailfinger2e681602011-09-08 00:00:29 +0000281 if (prog == PROGRAMMER_INVALID) {
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000282 fprintf(stderr, "Error: Unknown programmer \"%s\". Valid choices are:\n",
283 optarg);
284 list_programmers_linebreak(0, 80, 0);
Stefan Taunerb226cb12012-11-24 18:59:39 +0000285 msg_ginfo(".\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000286 cli_classic_abort_usage();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000287 }
288 break;
289 case 'R':
290 /* print_version() is always called during startup. */
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000291 if (++operation_specified > 1) {
292 fprintf(stderr, "More than one operation "
293 "specified. Aborting.\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000294 cli_classic_abort_usage();
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000295 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000296 exit(0);
297 break;
298 case 'h':
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000299 if (++operation_specified > 1) {
300 fprintf(stderr, "More than one operation "
301 "specified. Aborting.\n");
Uwe Hermann2db77a02010-06-04 17:07:39 +0000302 cli_classic_abort_usage();
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000303 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000304 cli_classic_usage(argv[0]);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000305 exit(0);
306 break;
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000307 case 'o':
308#ifdef STANDALONE
309 fprintf(stderr, "Log file not supported in standalone mode. Aborting.\n");
310 cli_classic_abort_usage();
311#else /* STANDALONE */
312 logfile = strdup(optarg);
313 if (logfile[0] == '\0') {
314 fprintf(stderr, "No log filename specified.\n");
315 cli_classic_abort_usage();
316 }
317#endif /* STANDALONE */
318 break;
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000319 default:
Uwe Hermann2db77a02010-06-04 17:07:39 +0000320 cli_classic_abort_usage();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000321 break;
322 }
323 }
324
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000325 if (optind < argc) {
326 fprintf(stderr, "Error: Extra parameter found.\n");
327 cli_classic_abort_usage();
328 }
329
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000330 if ((read_it | write_it | verify_it) && check_filename(filename, "image")) {
331 cli_classic_abort_usage();
332 }
333 if (layoutfile && check_filename(layoutfile, "layout")) {
334 cli_classic_abort_usage();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000335 }
336
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000337#ifndef STANDALONE
338 if (logfile && check_filename(logfile, "log"))
339 cli_classic_abort_usage();
340 if (logfile && open_logfile(logfile))
Stefan Tauner20da4aa2014-05-07 22:07:23 +0000341 cli_classic_abort_usage();
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000342#endif /* !STANDALONE */
343
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000344#if CONFIG_PRINT_WIKI == 1
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000345 if (list_supported_wiki) {
346 print_supported_wiki();
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000347 goto out;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000348 }
349#endif
350
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000351 if (list_supported) {
Niklas Söderlundede2fa42012-10-23 13:06:46 +0000352 if (print_supported())
353 ret = 1;
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000354 goto out;
355 }
Carl-Daniel Hailfinger46284452012-01-11 02:10:11 +0000356
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000357#ifndef STANDALONE
358 start_logging();
359#endif /* !STANDALONE */
360
361 print_buildinfo();
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000362 msg_gdbg("Command line (%i args):", argc - 1);
363 for (i = 0; i < argc; i++) {
364 msg_gdbg(" %s", argv[i]);
365 }
366 msg_gdbg("\n");
367
368 if (layoutfile && read_romlayout(layoutfile)) {
369 ret = 1;
370 goto out;
371 }
Stefan Tauner8268fdb2013-09-23 14:21:06 +0000372 if (layoutfile != NULL && !write_it) {
373 msg_gerr("Layout files are currently supported for write operations only.\n");
374 ret = 1;
375 goto out;
376 }
377
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000378 if (process_include_args()) {
379 ret = 1;
380 goto out;
381 }
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000382 /* Does a chip with the requested name exist in the flashchips array? */
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000383 if (chip_to_probe) {
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000384 for (chip = flashchips; chip && chip->name; chip++)
385 if (!strcmp(chip->name, chip_to_probe))
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000386 break;
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000387 if (!chip || !chip->name) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000388 msg_cerr("Error: Unknown chip '%s' specified.\n", chip_to_probe);
389 msg_gerr("Run flashrom -L to view the hardware supported in this flashrom version.\n");
390 ret = 1;
391 goto out;
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000392 }
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000393 /* Keep chip around for later usage in case a forced read is requested. */
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000394 }
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000395
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000396 if (prog == PROGRAMMER_INVALID) {
Stefan Taunerfd0d4132012-09-25 21:24:55 +0000397 if (CONFIG_DEFAULT_PROGRAMMER != PROGRAMMER_INVALID) {
398 prog = CONFIG_DEFAULT_PROGRAMMER;
399 msg_pinfo("Using default programmer \"%s\".\n",
400 programmer_table[CONFIG_DEFAULT_PROGRAMMER].name);
401 } else {
402 msg_perr("Please select a programmer with the --programmer parameter.\n"
Stefan Taunerb226cb12012-11-24 18:59:39 +0000403 "Previously this was not necessary because there was a default set.\n"
404#if CONFIG_INTERNAL == 1
405 "To choose the mainboard of this computer use 'internal'. "
406#endif
Stefan Taunerfd0d4132012-09-25 21:24:55 +0000407 "Valid choices are:\n");
408 list_programmers_linebreak(0, 80, 0);
Stefan Taunerb226cb12012-11-24 18:59:39 +0000409 msg_ginfo(".\n");
Stefan Taunerfd0d4132012-09-25 21:24:55 +0000410 ret = 1;
411 goto out;
412 }
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000413 }
Carl-Daniel Hailfinger2e681602011-09-08 00:00:29 +0000414
Carl-Daniel Hailfinger49884202010-05-22 07:10:46 +0000415 /* FIXME: Delay calibration should happen in programmer code. */
416 myusec_calibrate_delay();
417
Carl-Daniel Hailfinger2e681602011-09-08 00:00:29 +0000418 if (programmer_init(prog, pparam)) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000419 msg_perr("Error: Programmer initialization failed.\n");
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000420 ret = 1;
421 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000422 }
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000423 tempstr = flashbuses_to_text(get_buses_supported());
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000424 msg_pdbg("The following protocols are supported: %s.\n", tempstr);
Carl-Daniel Hailfingereaacd2d2011-11-09 23:40:00 +0000425 free(tempstr);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000426
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000427 for (j = 0; j < registered_programmer_count; j++) {
428 startchip = 0;
Michael Karcher222bf102011-12-22 23:27:03 +0000429 while (chipcount < ARRAY_SIZE(flashes)) {
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000430 startchip = probe_flash(&registered_programmers[j], startchip, &flashes[chipcount], 0);
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000431 if (startchip == -1)
432 break;
433 chipcount++;
434 startchip++;
435 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000436 }
437
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000438 if (chipcount > 1) {
Stefan Tauner0554ca52013-07-25 22:54:25 +0000439 msg_cinfo("Multiple flash chip definitions match the detected chip(s): \"%s\"",
440 flashes[0].chip->name);
Stefan Tauner716e0982011-07-25 20:38:52 +0000441 for (i = 1; i < chipcount; i++)
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000442 msg_cinfo(", \"%s\"", flashes[i].chip->name);
Stefan Tauner0554ca52013-07-25 22:54:25 +0000443 msg_cinfo("\nPlease specify which chip definition to use with the -c <chipname> option.\n");
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000444 ret = 1;
445 goto out_shutdown;
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000446 } else if (!chipcount) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000447 msg_cinfo("No EEPROM/flash device found.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000448 if (!force || !chip_to_probe) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000449 msg_cinfo("Note: flashrom can never write if the flash chip isn't found "
450 "automatically.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000451 }
452 if (force && read_it && chip_to_probe) {
Carl-Daniel Hailfingerb428e972012-02-16 20:31:25 +0000453 struct registered_programmer *pgm;
454 int compatible_programmers = 0;
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000455 msg_cinfo("Force read (-f -r -c) requested, pretending the chip is there:\n");
Carl-Daniel Hailfingerb428e972012-02-16 20:31:25 +0000456 /* This loop just counts compatible controllers. */
457 for (j = 0; j < registered_programmer_count; j++) {
458 pgm = &registered_programmers[j];
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000459 /* chip is still set from the chip_to_probe earlier in this function. */
460 if (pgm->buses_supported & chip->bustype)
Carl-Daniel Hailfingerb428e972012-02-16 20:31:25 +0000461 compatible_programmers++;
462 }
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000463 if (!compatible_programmers) {
464 msg_cinfo("No compatible controller found for the requested flash chip.\n");
465 ret = 1;
466 goto out_shutdown;
467 }
Carl-Daniel Hailfingerb428e972012-02-16 20:31:25 +0000468 if (compatible_programmers > 1)
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000469 msg_cinfo("More than one compatible controller found for the requested flash "
470 "chip, using the first one.\n");
Carl-Daniel Hailfingerb428e972012-02-16 20:31:25 +0000471 for (j = 0; j < registered_programmer_count; j++) {
472 pgm = &registered_programmers[j];
473 startchip = probe_flash(pgm, 0, &flashes[0], 1);
474 if (startchip != -1)
475 break;
476 }
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000477 if (startchip == -1) {
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000478 // FIXME: This should never happen! Ask for a bug report?
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000479 msg_cinfo("Probing for flash chip '%s' failed.\n", chip_to_probe);
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000480 ret = 1;
481 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000482 }
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000483 msg_cinfo("Please note that forced reads most likely contain garbage.\n");
484 ret = read_flash_to_file(&flashes[0], filename);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000485 free(flashes[0].chip);
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000486 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000487 }
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000488 ret = 1;
489 goto out_shutdown;
Stefan Tauner1d947632011-09-11 22:08:58 +0000490 } else if (!chip_to_probe) {
491 /* repeat for convenience when looking at foreign logs */
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000492 tempstr = flashbuses_to_text(flashes[0].chip->bustype);
Stefan Tauner1d947632011-09-11 22:08:58 +0000493 msg_gdbg("Found %s flash chip \"%s\" (%d kB, %s).\n",
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000494 flashes[0].chip->vendor, flashes[0].chip->name, flashes[0].chip->total_size, tempstr);
Stefan Tauner1d947632011-09-11 22:08:58 +0000495 free(tempstr);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000496 }
497
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000498 fill_flash = &flashes[0];
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000499
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000500 check_chip_supported(fill_flash->chip);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000501
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000502 size = fill_flash->chip->total_size * 1024;
503 if (check_max_decode(fill_flash->pgm->buses_supported & fill_flash->chip->bustype, size) && (!force)) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000504 msg_cerr("Chip is too big for this programmer (-V gives details). Use --force to override.\n");
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000505 ret = 1;
506 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000507 }
508
509 if (!(read_it | write_it | verify_it | erase_it)) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000510 msg_ginfo("No operations were specified.\n");
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000511 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000512 }
513
514 /* Always verify write operations unless -n is used. */
515 if (write_it && !dont_verify_it)
516 verify_it = 1;
517
Carl-Daniel Hailfinger9ad42552010-09-15 10:20:16 +0000518 /* FIXME: We should issue an unconditional chip reset here. This can be
519 * done once we have a .reset function in struct flashchip.
520 * Give the chip time to settle.
521 */
522 programmer_delay(100000);
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000523 ret |= doit(fill_flash, force, filename, read_it, write_it, erase_it, verify_it);
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000524
525out_shutdown:
526 programmer_shutdown();
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000527out:
Stefan Taunerb8911d62012-12-26 07:55:00 +0000528 for (i = 0; i < chipcount; i++)
529 free(flashes[i].chip);
530
Stefan Tauner949ccc82013-09-15 14:01:06 +0000531 layout_cleanup();
Stefan Taunerb8911d62012-12-26 07:55:00 +0000532 free(filename);
533 free(layoutfile);
534 free(pparam);
535 /* clean up global variables */
Nico Huberbcb2e5a2012-12-30 01:23:17 +0000536 free((char *)chip_to_probe); /* Silence! Freeing is not modifying contents. */
Stefan Taunerb8911d62012-12-26 07:55:00 +0000537 chip_to_probe = NULL;
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000538#ifndef STANDALONE
Stefan Tauner20da4aa2014-05-07 22:07:23 +0000539 free(logfile);
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000540 ret |= close_logfile();
541#endif /* !STANDALONE */
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000542 return ret;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000543}