blob: 3769163ad3a1f29a39fcc9fbcbcfbf4405d6b76e [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.
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000018 */
19
Carl-Daniel Hailfinger831e8f42010-05-30 22:24:40 +000020#include <stdio.h>
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000021#include <fcntl.h>
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000022#include <sys/stat.h>
23#include <string.h>
Jack Rosenthal85777562021-04-09 10:03:14 -060024#include <stdbool.h>
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000025#include <stdlib.h>
26#include <getopt.h>
27#include "flash.h"
28#include "flashchips.h"
Arthur Heymansc82900b2018-01-10 12:48:16 +010029#include "fmap.h"
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000030#include "programmer.h"
Nico Huber18781102012-12-10 13:34:12 +000031#include "libflashrom.h"
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000032
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +000033static void cli_classic_usage(const char *name)
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000034{
Stefan Taunerb226cb12012-11-24 18:59:39 +000035 printf("Usage: %s [-h|-R|-L|"
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000036#if CONFIG_PRINT_WIKI == 1
Stefan Taunerb226cb12012-11-24 18:59:39 +000037 "-z|"
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000038#endif
Edward O'Callaghan16ec45c2019-10-04 20:24:53 +100039 "\n\t-p <programmername>[:<parameters>] [-c <chipname>]\n"
40 "\t\t(--flash-name|--flash-size|\n"
41 "\t\t [-E|(-r|-w|-v) <file>]\n"
42 "\t\t [(-l <layoutfile>|--ifd| --fmap|--fmap-file <file>) [-i <imagename>]...]\n"
43 "\t\t [-n] [-N] [-f])]\n"
44 "\t[-V[V[V]]] [-o <logfile>]\n\n", name);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000045
Stefan Taunerb226cb12012-11-24 18:59:39 +000046 printf(" -h | --help print this help text\n"
47 " -R | --version print version (release)\n"
48 " -r | --read <file> read flash and save to <file>\n"
Daniel Campellod12b6bc2022-03-14 11:43:16 -060049 " -w | --write (<file>|-) write <file> or the content provided\n"
Daniel Campello8eaef7d2021-04-15 10:36:04 -060050 " on the standard input to flash\n"
Daniel Campellod12b6bc2022-03-14 11:43:16 -060051 " -v | --verify (<file>|-) verify flash against <file>\n"
Daniel Campello8eaef7d2021-04-15 10:36:04 -060052 " or the content provided on the standard input\n"
Stefan Taunerb226cb12012-11-24 18:59:39 +000053 " -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"
Nico Huber99d15952016-05-02 16:54:24 +020058 " -N | --noverify-all verify included regions only (cf. -i)\n"
Stefan Taunerb226cb12012-11-24 18:59:39 +000059 " -l | --layout <layoutfile> read ROM layout from <layoutfile>\n"
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +100060 " --flash-name read out the detected flash name\n"
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +100061 " --flash-size read out the detected flash size\n"
Arthur Heymansc82900b2018-01-10 12:48:16 +010062 " --fmap read ROM layout from fmap embedded in ROM\n"
63 " --fmap-file <fmapfile> read ROM layout from fmap in <fmapfile>\n"
Nico Huber305f4172013-06-14 11:55:26 +020064 " --ifd read layout from an Intel Firmware Descriptor\n"
Stefan Taunerb226cb12012-11-24 18:59:39 +000065 " -i | --image <name> only flash image <name> from flash layout\n"
66 " -o | --output <logfile> log output to <logfile>\n"
Paul Kocialkowskif701f342018-01-15 01:10:36 +030067 " --flash-contents <ref-file> assume flash contents to be <ref-file>\n"
Stefan Taunerb226cb12012-11-24 18:59:39 +000068 " -L | --list-supported print supported devices\n"
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000069#if CONFIG_PRINT_WIKI == 1
Stefan Taunerb226cb12012-11-24 18:59:39 +000070 " -z | --list-supported-wiki print supported devices in wiki syntax\n"
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000071#endif
Stefan Taunerb226cb12012-11-24 18:59:39 +000072 " -p | --programmer <name>[:<param>] specify the programmer device. One of\n");
73 list_programmers_linebreak(4, 80, 0);
74 printf(".\n\nYou can specify one of -h, -R, -L, "
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000075#if CONFIG_PRINT_WIKI == 1
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000076 "-z, "
77#endif
78 "-E, -r, -w, -v or no operation.\n"
Stefan Taunerb226cb12012-11-24 18:59:39 +000079 "If no operation is specified, flashrom will only probe for flash chips.\n");
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000080}
81
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +100082static void cli_classic_abort_usage(const char *msg)
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000083{
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +100084 if (msg)
85 fprintf(stderr, "%s", msg);
Uwe Hermann2db77a02010-06-04 17:07:39 +000086 printf("Please run \"flashrom --help\" for usage info.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000087 exit(1);
88}
89
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +100090static void cli_classic_validate_singleop(int *operation_specified)
91{
92 if (++(*operation_specified) > 1) {
93 cli_classic_abort_usage("More than one operation specified. Aborting.\n");
94 }
95}
96
Jacob Garber4a84ec22019-07-25 19:12:31 -060097static int check_filename(char *filename, const char *type)
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +000098{
99 if (!filename || (filename[0] == '\0')) {
100 fprintf(stderr, "Error: No %s file specified.\n", type);
101 return 1;
102 }
103 /* Not an error, but maybe the user intended to specify a CLI option instead of a file name. */
Daniel Campello8eaef7d2021-04-15 10:36:04 -0600104 if (filename[0] == '-' && filename[1] != '\0')
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000105 fprintf(stderr, "Warning: Supplied %s file name starts with -\n", type);
106 return 0;
107}
108
Jack Rosenthal85777562021-04-09 10:03:14 -0600109/* Ensure a file is open by means of fstat */
110static bool check_file(FILE *file)
111{
Jack Rosenthal85777562021-04-09 10:03:14 -0600112 struct stat statbuf;
113
114 if (fstat(fileno(file), &statbuf) < 0)
115 return false;
Jack Rosenthal85777562021-04-09 10:03:14 -0600116 return true;
117}
118
Edward O'Callaghan98cfa692021-12-13 12:46:12 +1100119static int do_read(struct flashctx *const flash, const char *const filename)
120{
121 int ret;
122
Edward O'Callaghan136bf432022-02-03 14:39:29 +1100123 unsigned long size = flashrom_flash_getsize(flash);
Edward O'Callaghan98cfa692021-12-13 12:46:12 +1100124 unsigned char *buf = calloc(size, sizeof(unsigned char));
125 if (!buf) {
126 msg_gerr("Memory allocation failed!\n");
127 return 1;
128 }
129
130 ret = flashrom_image_read(flash, buf, size);
131 if (ret > 0)
132 goto free_out;
133
134 ret = write_buf_to_file(buf, size, filename);
135
136free_out:
137 free(buf);
138 return ret;
139}
140
141static int do_write(struct flashctx *const flash, const char *const filename, const char *const referencefile)
142{
Edward O'Callaghan136bf432022-02-03 14:39:29 +1100143 const size_t flash_size = flashrom_flash_getsize(flash);
Edward O'Callaghan98cfa692021-12-13 12:46:12 +1100144 int ret = 1;
145
146 uint8_t *const newcontents = malloc(flash_size);
147 uint8_t *const refcontents = referencefile ? malloc(flash_size) : NULL;
148
149 if (!newcontents || (referencefile && !refcontents)) {
150 msg_gerr("Out of memory!\n");
151 goto _free_ret;
152 }
153
154 if (read_buf_from_file(newcontents, flash_size, filename))
155 goto _free_ret;
156
157 if (referencefile) {
158 if (read_buf_from_file(refcontents, flash_size, referencefile))
159 goto _free_ret;
160 }
161
162 ret = flashrom_image_write(flash, newcontents, flash_size, refcontents);
163
164_free_ret:
165 free(refcontents);
166 free(newcontents);
167 return ret;
168}
169
170static int do_verify(struct flashctx *const flash, const char *const filename)
171{
Edward O'Callaghan136bf432022-02-03 14:39:29 +1100172 const size_t flash_size = flashrom_flash_getsize(flash);
Edward O'Callaghan98cfa692021-12-13 12:46:12 +1100173 int ret = 1;
174
175 uint8_t *const newcontents = malloc(flash_size);
176 if (!newcontents) {
177 msg_gerr("Out of memory!\n");
178 goto _free_ret;
179 }
180
181 if (read_buf_from_file(newcontents, flash_size, filename))
182 goto _free_ret;
183
184 ret = flashrom_image_verify(flash, newcontents, flash_size);
185
186_free_ret:
187 free(newcontents);
188 return ret;
189}
190
Edward O'Callaghanaba36582022-09-05 11:09:28 +1000191/* Returns the number of buses commonly supported by the current programmer and flash chip where the latter
192 * can not be completely accessed due to size/address limits of the programmer. */
Edward O'Callaghan92ae5bb2022-09-05 11:13:56 +1000193static unsigned int count_max_decode_exceedings(const struct flashctx *flash,
194 const struct decode_sizes *max_rom_decode_)
Edward O'Callaghanaba36582022-09-05 11:09:28 +1000195{
196 unsigned int limitexceeded = 0;
197 uint32_t size = flash->chip->total_size * 1024;
198 enum chipbustype buses = flash->mst->buses_supported & flash->chip->bustype;
199
Edward O'Callaghan92ae5bb2022-09-05 11:13:56 +1000200 if ((buses & BUS_PARALLEL) && (max_rom_decode_->parallel < size)) {
Edward O'Callaghanaba36582022-09-05 11:09:28 +1000201 limitexceeded++;
202 msg_pdbg("Chip size %u kB is bigger than supported "
203 "size %u kB of chipset/board/programmer "
204 "for %s interface, "
205 "probe/read/erase/write may fail. ", size / 1024,
Edward O'Callaghan92ae5bb2022-09-05 11:13:56 +1000206 max_rom_decode_->parallel / 1024, "Parallel");
Edward O'Callaghanaba36582022-09-05 11:09:28 +1000207 }
Edward O'Callaghan92ae5bb2022-09-05 11:13:56 +1000208 if ((buses & BUS_LPC) && (max_rom_decode_->lpc < size)) {
Edward O'Callaghanaba36582022-09-05 11:09:28 +1000209 limitexceeded++;
210 msg_pdbg("Chip size %u kB is bigger than supported "
211 "size %u kB of chipset/board/programmer "
212 "for %s interface, "
213 "probe/read/erase/write may fail. ", size / 1024,
Edward O'Callaghan92ae5bb2022-09-05 11:13:56 +1000214 max_rom_decode_->lpc / 1024, "LPC");
Edward O'Callaghanaba36582022-09-05 11:09:28 +1000215 }
Edward O'Callaghan92ae5bb2022-09-05 11:13:56 +1000216 if ((buses & BUS_FWH) && (max_rom_decode_->fwh < size)) {
Edward O'Callaghanaba36582022-09-05 11:09:28 +1000217 limitexceeded++;
218 msg_pdbg("Chip size %u kB is bigger than supported "
219 "size %u kB of chipset/board/programmer "
220 "for %s interface, "
221 "probe/read/erase/write may fail. ", size / 1024,
Edward O'Callaghan92ae5bb2022-09-05 11:13:56 +1000222 max_rom_decode_->fwh / 1024, "FWH");
Edward O'Callaghanaba36582022-09-05 11:09:28 +1000223 }
Edward O'Callaghan92ae5bb2022-09-05 11:13:56 +1000224 if ((buses & BUS_SPI) && (max_rom_decode_->spi < size)) {
Edward O'Callaghanaba36582022-09-05 11:09:28 +1000225 limitexceeded++;
226 msg_pdbg("Chip size %u kB is bigger than supported "
227 "size %u kB of chipset/board/programmer "
228 "for %s interface, "
229 "probe/read/erase/write may fail. ", size / 1024,
Edward O'Callaghan92ae5bb2022-09-05 11:13:56 +1000230 max_rom_decode_->spi / 1024, "SPI");
Edward O'Callaghanaba36582022-09-05 11:09:28 +1000231 }
232 return limitexceeded;
233}
234
Uwe Hermann394ee782011-08-20 14:14:22 +0000235int main(int argc, char *argv[])
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000236{
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000237 const struct flashchip *chip = NULL;
Jernej Å krabece814a9b2014-12-12 00:32:03 +0000238 /* Probe for up to eight flash chips. */
239 struct flashctx flashes[8] = {{0}};
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000240 struct flashctx *fill_flash;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000241 const char *name;
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000242 int namelen, opt, i, j;
Felix Singer2a768e42022-05-22 02:04:18 +0200243 int startchip = -1, chipcount = 0, option_index = 0;
244 int operation_specified = 0;
245 bool force = false, ifd = false, fmap = false;
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000246#if CONFIG_PRINT_WIKI == 1
Felix Singer2a768e42022-05-22 02:04:18 +0200247 bool list_supported_wiki = false;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000248#endif
Felix Singer2a768e42022-05-22 02:04:18 +0200249 bool flash_name = false, flash_size = false;
250 bool read_it = false, write_it = false, erase_it = false, verify_it = false;
251 bool dont_verify_it = false, dont_verify_all = false;
252 bool list_supported = false;
Nico Huber305f4172013-06-14 11:55:26 +0200253 struct flashrom_layout *layout = NULL;
Thomas Heijligenacd9c942021-06-01 14:51:13 +0200254 static const struct programmer_entry *prog = NULL;
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300255 enum {
256 OPTION_IFD = 0x0100,
Arthur Heymansc82900b2018-01-10 12:48:16 +0100257 OPTION_FMAP,
258 OPTION_FMAP_FILE,
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300259 OPTION_FLASH_CONTENTS,
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +1000260 OPTION_FLASH_NAME,
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000261 OPTION_FLASH_SIZE,
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300262 };
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000263 int ret = 0;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000264
Nico Huber99d15952016-05-02 16:54:24 +0200265 static const char optstring[] = "r:Rw:v:nNVEfc:l:i:p:Lzho:";
Mathias Krausea60faab2011-01-17 07:50:42 +0000266 static const struct option long_options[] = {
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000267 {"read", 1, NULL, 'r'},
268 {"write", 1, NULL, 'w'},
269 {"erase", 0, NULL, 'E'},
270 {"verify", 1, NULL, 'v'},
271 {"noverify", 0, NULL, 'n'},
Nico Huber99d15952016-05-02 16:54:24 +0200272 {"noverify-all", 0, NULL, 'N'},
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000273 {"chip", 1, NULL, 'c'},
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000274 {"verbose", 0, NULL, 'V'},
275 {"force", 0, NULL, 'f'},
276 {"layout", 1, NULL, 'l'},
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300277 {"ifd", 0, NULL, OPTION_IFD},
Arthur Heymansc82900b2018-01-10 12:48:16 +0100278 {"fmap", 0, NULL, OPTION_FMAP},
279 {"fmap-file", 1, NULL, OPTION_FMAP_FILE},
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000280 {"image", 1, NULL, 'i'},
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300281 {"flash-contents", 1, NULL, OPTION_FLASH_CONTENTS},
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +1000282 {"flash-name", 0, NULL, OPTION_FLASH_NAME},
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000283 {"flash-size", 0, NULL, OPTION_FLASH_SIZE},
284 {"get-size", 0, NULL, OPTION_FLASH_SIZE}, // (deprecated): back compatibility.
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000285 {"list-supported", 0, NULL, 'L'},
286 {"list-supported-wiki", 0, NULL, 'z'},
287 {"programmer", 1, NULL, 'p'},
288 {"help", 0, NULL, 'h'},
289 {"version", 0, NULL, 'R'},
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000290 {"output", 1, NULL, 'o'},
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000291 {NULL, 0, NULL, 0},
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000292 };
293
294 char *filename = NULL;
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300295 char *referencefile = NULL;
Carl-Daniel Hailfinger46284452012-01-11 02:10:11 +0000296 char *layoutfile = NULL;
Arthur Heymansc82900b2018-01-10 12:48:16 +0100297 char *fmapfile = NULL;
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000298 char *logfile = NULL;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000299 char *tempstr = NULL;
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000300 char *pparam = NULL;
Arthur Heymansb04fef92019-02-05 17:35:05 +0100301 struct layout_include_args *include_args = NULL;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000302
Jack Rosenthal85777562021-04-09 10:03:14 -0600303 /*
304 * Safety-guard against a user who has (mistakenly) closed
305 * stdout or stderr before exec'ing flashrom. We disable
306 * logging in this case to prevent writing log data to a flash
307 * chip when a flash device gets opened with fd 1 or 2.
308 */
309 if (check_file(stdout) && check_file(stderr)) {
310 flashrom_set_log_callback(
311 (flashrom_log_callback *)&flashrom_print_cb);
312 }
Nico Huber18781102012-12-10 13:34:12 +0000313
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000314 print_version();
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000315 print_banner();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000316
Edward O'Callaghand58496b2022-02-03 12:52:02 +1100317 /* FIXME: Delay calibration should happen in programmer code. */
318 if (flashrom_init(1))
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000319 exit(1);
320
321 setbuf(stdout, NULL);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000322 /* FIXME: Delay all operation_specified checks until after command
323 * line parsing to allow --help overriding everything else.
324 */
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000325 while ((opt = getopt_long(argc, argv, optstring,
326 long_options, &option_index)) != EOF) {
327 switch (opt) {
328 case 'r':
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000329 cli_classic_validate_singleop(&operation_specified);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000330 filename = strdup(optarg);
Felix Singer2a768e42022-05-22 02:04:18 +0200331 read_it = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000332 break;
333 case 'w':
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000334 cli_classic_validate_singleop(&operation_specified);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000335 filename = strdup(optarg);
Felix Singer2a768e42022-05-22 02:04:18 +0200336 write_it = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000337 break;
338 case 'v':
339 //FIXME: gracefully handle superfluous -v
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000340 cli_classic_validate_singleop(&operation_specified);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000341 if (dont_verify_it) {
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000342 cli_classic_abort_usage("--verify and --noverify are mutually exclusive. Aborting.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000343 }
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000344 filename = strdup(optarg);
Felix Singer2a768e42022-05-22 02:04:18 +0200345 verify_it = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000346 break;
347 case 'n':
348 if (verify_it) {
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000349 cli_classic_abort_usage("--verify and --noverify are mutually exclusive. Aborting.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000350 }
Felix Singer2a768e42022-05-22 02:04:18 +0200351 dont_verify_it = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000352 break;
Nico Huber99d15952016-05-02 16:54:24 +0200353 case 'N':
Felix Singer2a768e42022-05-22 02:04:18 +0200354 dont_verify_all = true;
Nico Huber99d15952016-05-02 16:54:24 +0200355 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000356 case 'c':
357 chip_to_probe = strdup(optarg);
358 break;
359 case 'V':
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000360 verbose_screen++;
Nico Huberd152fb92017-06-19 12:57:10 +0200361 if (verbose_screen > FLASHROM_MSG_DEBUG2)
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000362 verbose_logfile = verbose_screen;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000363 break;
364 case 'E':
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000365 cli_classic_validate_singleop(&operation_specified);
Felix Singer2a768e42022-05-22 02:04:18 +0200366 erase_it = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000367 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000368 case 'f':
Felix Singer2a768e42022-05-22 02:04:18 +0200369 force = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000370 break;
371 case 'l':
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000372 if (layoutfile)
373 cli_classic_abort_usage("Error: --layout specified more than once. Aborting.\n");
374 if (ifd)
375 cli_classic_abort_usage("Error: --layout and --ifd both specified. Aborting.\n");
376 if (fmap)
377 cli_classic_abort_usage("Error: --layout and --fmap-file both specified. Aborting.\n");
Carl-Daniel Hailfinger46284452012-01-11 02:10:11 +0000378 layoutfile = strdup(optarg);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000379 break;
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300380 case OPTION_IFD:
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000381 if (layoutfile)
382 cli_classic_abort_usage("Error: --layout and --ifd both specified. Aborting.\n");
383 if (fmap)
384 cli_classic_abort_usage("Error: --fmap-file and --ifd both specified. Aborting.\n");
Felix Singer2a768e42022-05-22 02:04:18 +0200385 ifd = true;
Nico Huber305f4172013-06-14 11:55:26 +0200386 break;
Arthur Heymansc82900b2018-01-10 12:48:16 +0100387 case OPTION_FMAP_FILE:
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000388 if (fmap)
389 cli_classic_abort_usage("Error: --fmap or --fmap-file specified "
Arthur Heymansc82900b2018-01-10 12:48:16 +0100390 "more than once. Aborting.\n");
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000391 if (ifd)
392 cli_classic_abort_usage("Error: --fmap-file and --ifd both specified. Aborting.\n");
393 if (layoutfile)
394 cli_classic_abort_usage("Error: --fmap-file and --layout both specified. Aborting.\n");
Arthur Heymansc82900b2018-01-10 12:48:16 +0100395 fmapfile = strdup(optarg);
Felix Singer2a768e42022-05-22 02:04:18 +0200396 fmap = true;
Arthur Heymansc82900b2018-01-10 12:48:16 +0100397 break;
398 case OPTION_FMAP:
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000399 if (fmap)
400 cli_classic_abort_usage("Error: --fmap or --fmap-file specified "
Arthur Heymansc82900b2018-01-10 12:48:16 +0100401 "more than once. Aborting.\n");
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000402 if (ifd)
403 cli_classic_abort_usage("Error: --fmap and --ifd both specified. Aborting.\n");
404 if (layoutfile)
405 cli_classic_abort_usage("Error: --layout and --fmap both specified. Aborting.\n");
Felix Singer2a768e42022-05-22 02:04:18 +0200406 fmap = true;
Arthur Heymansc82900b2018-01-10 12:48:16 +0100407 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000408 case 'i':
409 tempstr = strdup(optarg);
Arthur Heymansb04fef92019-02-05 17:35:05 +0100410 if (register_include_arg(&include_args, tempstr)) {
Stefan Taunerb8911d62012-12-26 07:55:00 +0000411 free(tempstr);
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000412 cli_classic_abort_usage(NULL);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000413 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000414 break;
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300415 case OPTION_FLASH_CONTENTS:
Angel Ponsa60f6412020-03-31 15:02:02 +0200416 if (referencefile)
417 cli_classic_abort_usage("Error: --flash-contents specified more than once."
418 "Aborting.\n");
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300419 referencefile = strdup(optarg);
420 break;
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +1000421 case OPTION_FLASH_NAME:
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000422 cli_classic_validate_singleop(&operation_specified);
Felix Singer2a768e42022-05-22 02:04:18 +0200423 flash_name = true;
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +1000424 break;
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000425 case OPTION_FLASH_SIZE:
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000426 cli_classic_validate_singleop(&operation_specified);
Felix Singer2a768e42022-05-22 02:04:18 +0200427 flash_size = true;
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000428 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000429 case 'L':
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000430 cli_classic_validate_singleop(&operation_specified);
Felix Singer2a768e42022-05-22 02:04:18 +0200431 list_supported = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000432 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000433 case 'z':
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000434#if CONFIG_PRINT_WIKI == 1
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000435 cli_classic_validate_singleop(&operation_specified);
Felix Singer2a768e42022-05-22 02:04:18 +0200436 list_supported_wiki = true;
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000437#else
Idwer Vollering40407b62020-12-08 00:24:39 +0100438 cli_classic_abort_usage("Error: Wiki output was not "
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000439 "compiled in. Aborting.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000440#endif
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000441 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000442 case 'p':
Thomas Heijligenacd9c942021-06-01 14:51:13 +0200443 if (prog != NULL) {
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000444 cli_classic_abort_usage("Error: --programmer specified "
Carl-Daniel Hailfinger2e681602011-09-08 00:00:29 +0000445 "more than once. You can separate "
446 "multiple\nparameters for a programmer "
447 "with \",\". Please see the man page "
448 "for details.\n");
Carl-Daniel Hailfinger2e681602011-09-08 00:00:29 +0000449 }
Thomas Heijligenacd9c942021-06-01 14:51:13 +0200450 size_t p;
451 for (p = 0; p < programmer_table_size; p++) {
452 name = programmer_table[p]->name;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000453 namelen = strlen(name);
454 if (strncmp(optarg, name, namelen) == 0) {
455 switch (optarg[namelen]) {
456 case ':':
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000457 pparam = strdup(optarg + namelen + 1);
458 if (!strlen(pparam)) {
459 free(pparam);
460 pparam = NULL;
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000461 }
Thomas Heijligenacd9c942021-06-01 14:51:13 +0200462 prog = programmer_table[p];
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000463 break;
464 case '\0':
Thomas Heijligenacd9c942021-06-01 14:51:13 +0200465 prog = programmer_table[p];
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000466 break;
467 default:
468 /* The continue refers to the
469 * for loop. It is here to be
470 * able to differentiate between
471 * foo and foobar.
472 */
473 continue;
474 }
475 break;
476 }
477 }
Thomas Heijligenacd9c942021-06-01 14:51:13 +0200478 if (prog == NULL) {
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000479 fprintf(stderr, "Error: Unknown programmer \"%s\". Valid choices are:\n",
480 optarg);
481 list_programmers_linebreak(0, 80, 0);
Stefan Taunerb226cb12012-11-24 18:59:39 +0000482 msg_ginfo(".\n");
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000483 cli_classic_abort_usage(NULL);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000484 }
485 break;
486 case 'R':
487 /* print_version() is always called during startup. */
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000488 cli_classic_validate_singleop(&operation_specified);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000489 exit(0);
490 break;
491 case 'h':
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000492 cli_classic_validate_singleop(&operation_specified);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000493 cli_classic_usage(argv[0]);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000494 exit(0);
495 break;
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000496 case 'o':
Elyes HAOUASef78de42019-07-18 15:08:10 +0200497 if (logfile) {
498 fprintf(stderr, "Warning: -o/--output specified multiple times.\n");
499 free(logfile);
500 }
501
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000502 logfile = strdup(optarg);
503 if (logfile[0] == '\0') {
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000504 cli_classic_abort_usage("No log filename specified.\n");
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000505 }
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000506 break;
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000507 default:
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000508 cli_classic_abort_usage(NULL);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000509 break;
510 }
511 }
512
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000513 if (optind < argc)
514 cli_classic_abort_usage("Error: Extra parameter found.\n");
515 if ((read_it | write_it | verify_it) && check_filename(filename, "image"))
516 cli_classic_abort_usage(NULL);
517 if (layoutfile && check_filename(layoutfile, "layout"))
518 cli_classic_abort_usage(NULL);
519 if (fmapfile && check_filename(fmapfile, "fmap"))
520 cli_classic_abort_usage(NULL);
521 if (referencefile && check_filename(referencefile, "reference"))
522 cli_classic_abort_usage(NULL);
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000523 if (logfile && check_filename(logfile, "log"))
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000524 cli_classic_abort_usage(NULL);
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000525 if (logfile && open_logfile(logfile))
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000526 cli_classic_abort_usage(NULL);
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000527
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000528#if CONFIG_PRINT_WIKI == 1
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000529 if (list_supported_wiki) {
530 print_supported_wiki();
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000531 goto out;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000532 }
533#endif
534
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000535 if (list_supported) {
Niklas Söderlundede2fa42012-10-23 13:06:46 +0000536 if (print_supported())
537 ret = 1;
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000538 goto out;
539 }
Carl-Daniel Hailfinger46284452012-01-11 02:10:11 +0000540
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000541 start_logging();
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000542
543 print_buildinfo();
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000544 msg_gdbg("Command line (%i args):", argc - 1);
545 for (i = 0; i < argc; i++) {
546 msg_gdbg(" %s", argv[i]);
547 }
548 msg_gdbg("\n");
549
Nico Huberd9b57712021-05-14 01:07:28 +0200550 if (layoutfile && layout_from_file(&layout, layoutfile)) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000551 ret = 1;
552 goto out;
553 }
Arthur Heymansc82900b2018-01-10 12:48:16 +0100554
Nico Huberd9b57712021-05-14 01:07:28 +0200555 if (!ifd && !fmap && process_include_args(layout, include_args)) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000556 ret = 1;
557 goto out;
558 }
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000559 /* Does a chip with the requested name exist in the flashchips array? */
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000560 if (chip_to_probe) {
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000561 for (chip = flashchips; chip && chip->name; chip++)
562 if (!strcmp(chip->name, chip_to_probe))
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000563 break;
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000564 if (!chip || !chip->name) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000565 msg_cerr("Error: Unknown chip '%s' specified.\n", chip_to_probe);
566 msg_gerr("Run flashrom -L to view the hardware supported in this flashrom version.\n");
567 ret = 1;
568 goto out;
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000569 }
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000570 /* Keep chip around for later usage in case a forced read is requested. */
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000571 }
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000572
Thomas Heijligenacd9c942021-06-01 14:51:13 +0200573 if (prog == NULL) {
Thomas Heijligen84e9c912021-06-01 16:22:14 +0200574 const struct programmer_entry *const default_programmer = CONFIG_DEFAULT_PROGRAMMER_NAME;
575
576 if (default_programmer) {
577 prog = default_programmer;
Stefan Tauner265fcac2014-06-02 00:12:23 +0000578 /* We need to strdup here because we free(pparam) unconditionally later. */
579 pparam = strdup(CONFIG_DEFAULT_PROGRAMMER_ARGS);
580 msg_pinfo("Using default programmer \"%s\" with arguments \"%s\".\n",
Thomas Heijligen84e9c912021-06-01 16:22:14 +0200581 default_programmer->name, pparam);
Stefan Taunerfd0d4132012-09-25 21:24:55 +0000582 } else {
583 msg_perr("Please select a programmer with the --programmer parameter.\n"
Stefan Taunerb226cb12012-11-24 18:59:39 +0000584#if CONFIG_INTERNAL == 1
585 "To choose the mainboard of this computer use 'internal'. "
586#endif
Stefan Taunerfd0d4132012-09-25 21:24:55 +0000587 "Valid choices are:\n");
588 list_programmers_linebreak(0, 80, 0);
Stefan Taunerb226cb12012-11-24 18:59:39 +0000589 msg_ginfo(".\n");
Stefan Taunerfd0d4132012-09-25 21:24:55 +0000590 ret = 1;
591 goto out;
592 }
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000593 }
Carl-Daniel Hailfinger2e681602011-09-08 00:00:29 +0000594
Thomas Heijligenacd9c942021-06-01 14:51:13 +0200595 if (programmer_init(prog, pparam)) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000596 msg_perr("Error: Programmer initialization failed.\n");
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000597 ret = 1;
598 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000599 }
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000600 tempstr = flashbuses_to_text(get_buses_supported());
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000601 msg_pdbg("The following protocols are supported: %s.\n", tempstr);
Carl-Daniel Hailfingereaacd2d2011-11-09 23:40:00 +0000602 free(tempstr);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000603
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000604 for (j = 0; j < registered_master_count; j++) {
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000605 startchip = 0;
Nico Huber519be662018-12-23 20:03:35 +0100606 while (chipcount < (int)ARRAY_SIZE(flashes)) {
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000607 startchip = probe_flash(&registered_masters[j], startchip, &flashes[chipcount], 0);
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000608 if (startchip == -1)
609 break;
610 chipcount++;
611 startchip++;
612 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000613 }
614
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000615 if (chipcount > 1) {
Stefan Tauner0554ca52013-07-25 22:54:25 +0000616 msg_cinfo("Multiple flash chip definitions match the detected chip(s): \"%s\"",
617 flashes[0].chip->name);
Stefan Tauner716e0982011-07-25 20:38:52 +0000618 for (i = 1; i < chipcount; i++)
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000619 msg_cinfo(", \"%s\"", flashes[i].chip->name);
Stefan Tauner0554ca52013-07-25 22:54:25 +0000620 msg_cinfo("\nPlease specify which chip definition to use with the -c <chipname> option.\n");
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000621 ret = 1;
622 goto out_shutdown;
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000623 } else if (!chipcount) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000624 msg_cinfo("No EEPROM/flash device found.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000625 if (!force || !chip_to_probe) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000626 msg_cinfo("Note: flashrom can never write if the flash chip isn't found "
627 "automatically.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000628 }
629 if (force && read_it && chip_to_probe) {
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000630 struct registered_master *mst;
631 int compatible_masters = 0;
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000632 msg_cinfo("Force read (-f -r -c) requested, pretending the chip is there:\n");
Carl-Daniel Hailfingerb428e972012-02-16 20:31:25 +0000633 /* This loop just counts compatible controllers. */
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000634 for (j = 0; j < registered_master_count; j++) {
635 mst = &registered_masters[j];
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000636 /* chip is still set from the chip_to_probe earlier in this function. */
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000637 if (mst->buses_supported & chip->bustype)
638 compatible_masters++;
Carl-Daniel Hailfingerb428e972012-02-16 20:31:25 +0000639 }
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000640 if (!compatible_masters) {
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000641 msg_cinfo("No compatible controller found for the requested flash chip.\n");
642 ret = 1;
643 goto out_shutdown;
644 }
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000645 if (compatible_masters > 1)
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000646 msg_cinfo("More than one compatible controller found for the requested flash "
647 "chip, using the first one.\n");
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000648 for (j = 0; j < registered_master_count; j++) {
649 mst = &registered_masters[j];
650 startchip = probe_flash(mst, 0, &flashes[0], 1);
Carl-Daniel Hailfingerb428e972012-02-16 20:31:25 +0000651 if (startchip != -1)
652 break;
653 }
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000654 if (startchip == -1) {
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000655 // FIXME: This should never happen! Ask for a bug report?
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000656 msg_cinfo("Probing for flash chip '%s' failed.\n", chip_to_probe);
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000657 ret = 1;
658 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000659 }
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000660 msg_cinfo("Please note that forced reads most likely contain garbage.\n");
Felix Singer2a768e42022-05-22 02:04:18 +0200661 flashrom_flag_set(&flashes[0], FLASHROM_FLAG_FORCE, force);
Edward O'Callaghan2d170412021-11-15 15:47:15 +1100662 ret = do_read(&flashes[0], filename);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000663 free(flashes[0].chip);
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000664 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000665 }
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000666 ret = 1;
667 goto out_shutdown;
Stefan Tauner1d947632011-09-11 22:08:58 +0000668 } else if (!chip_to_probe) {
669 /* repeat for convenience when looking at foreign logs */
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000670 tempstr = flashbuses_to_text(flashes[0].chip->bustype);
Stefan Tauner1d947632011-09-11 22:08:58 +0000671 msg_gdbg("Found %s flash chip \"%s\" (%d kB, %s).\n",
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000672 flashes[0].chip->vendor, flashes[0].chip->name, flashes[0].chip->total_size, tempstr);
Stefan Tauner1d947632011-09-11 22:08:58 +0000673 free(tempstr);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000674 }
675
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000676 fill_flash = &flashes[0];
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000677
Stefan Tauner9b32de92014-08-08 23:52:33 +0000678 print_chip_support_status(fill_flash->chip);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000679
Edward O'Callaghan92ae5bb2022-09-05 11:13:56 +1000680 unsigned int limitexceeded = count_max_decode_exceedings(fill_flash, &max_rom_decode);
Stefan Tauner9e3a6982014-08-15 17:17:59 +0000681 if (limitexceeded > 0 && !force) {
682 enum chipbustype commonbuses = fill_flash->mst->buses_supported & fill_flash->chip->bustype;
683
684 /* Sometimes chip and programmer have more than one bus in common,
685 * and the limit is not exceeded on all buses. Tell the user. */
686 if ((bitcount(commonbuses) > limitexceeded)) {
687 msg_pdbg("There is at least one interface available which could support the size of\n"
688 "the selected flash chip.\n");
689 }
690 msg_cerr("This flash chip is too big for this programmer (--verbose/-V gives details).\n"
691 "Use --force/-f to override at your own risk.\n");
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000692 ret = 1;
693 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000694 }
695
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000696 if (!(read_it | write_it | verify_it | erase_it | flash_name | flash_size)) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000697 msg_ginfo("No operations were specified.\n");
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000698 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000699 }
700
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +1000701 if (flash_name) {
702 if (fill_flash->chip->vendor && fill_flash->chip->name) {
703 printf("vendor=\"%s\" name=\"%s\"\n",
704 fill_flash->chip->vendor,
705 fill_flash->chip->name);
706 } else {
707 ret = -1;
708 }
709 goto out_shutdown;
710 }
711
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000712 if (flash_size) {
Edward O'Callaghan136bf432022-02-03 14:39:29 +1100713 printf("%zu\n", flashrom_flash_getsize(fill_flash));
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000714 goto out_shutdown;
715 }
716
Nico Huberd9b57712021-05-14 01:07:28 +0200717 if (ifd && (flashrom_layout_read_from_ifd(&layout, fill_flash, NULL, 0) ||
Arthur Heymansb04fef92019-02-05 17:35:05 +0100718 process_include_args(layout, include_args))) {
Nico Huber305f4172013-06-14 11:55:26 +0200719 ret = 1;
720 goto out_shutdown;
Arthur Heymansc82900b2018-01-10 12:48:16 +0100721 } else if (fmap && fmapfile) {
722 struct stat s;
723 if (stat(fmapfile, &s) != 0) {
724 msg_gerr("Failed to stat fmapfile \"%s\"\n", fmapfile);
725 ret = 1;
726 goto out_shutdown;
727 }
728
729 size_t fmapfile_size = s.st_size;
730 uint8_t *fmapfile_buffer = malloc(fmapfile_size);
731 if (!fmapfile_buffer) {
732 ret = 1;
733 goto out_shutdown;
734 }
735
736 if (read_buf_from_file(fmapfile_buffer, fmapfile_size, fmapfile)) {
737 ret = 1;
738 free(fmapfile_buffer);
739 goto out_shutdown;
740 }
741
742 if (flashrom_layout_read_fmap_from_buffer(&layout, fill_flash, fmapfile_buffer, fmapfile_size) ||
Arthur Heymansb04fef92019-02-05 17:35:05 +0100743 process_include_args(layout, include_args)) {
Arthur Heymansc82900b2018-01-10 12:48:16 +0100744 ret = 1;
745 free(fmapfile_buffer);
746 goto out_shutdown;
747 }
748 free(fmapfile_buffer);
749 } else if (fmap && (flashrom_layout_read_fmap_from_rom(&layout, fill_flash, 0,
Edward O'Callaghan136bf432022-02-03 14:39:29 +1100750 flashrom_flash_getsize(fill_flash)) || process_include_args(layout, include_args))) {
Arthur Heymansc82900b2018-01-10 12:48:16 +0100751 ret = 1;
752 goto out_shutdown;
Nico Huber305f4172013-06-14 11:55:26 +0200753 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000754
Nico Huber305f4172013-06-14 11:55:26 +0200755 flashrom_layout_set(fill_flash, layout);
Felix Singer2a768e42022-05-22 02:04:18 +0200756 flashrom_flag_set(fill_flash, FLASHROM_FLAG_FORCE, force);
Urja Rannikko7258cf52017-06-17 11:31:57 +0300757#if CONFIG_INTERNAL == 1
Felix Singer2a768e42022-05-22 02:04:18 +0200758 flashrom_flag_set(fill_flash, FLASHROM_FLAG_FORCE_BOARDMISMATCH, force_boardmismatch);
Urja Rannikko7258cf52017-06-17 11:31:57 +0300759#endif
Nico Huber899e4ec2016-04-29 18:39:01 +0200760 flashrom_flag_set(fill_flash, FLASHROM_FLAG_VERIFY_AFTER_WRITE, !dont_verify_it);
Nico Huber99d15952016-05-02 16:54:24 +0200761 flashrom_flag_set(fill_flash, FLASHROM_FLAG_VERIFY_WHOLE_CHIP, !dont_verify_all);
Stefan Tauner4e32ec12014-08-30 23:39:51 +0000762
Carl-Daniel Hailfinger9ad42552010-09-15 10:20:16 +0000763 /* FIXME: We should issue an unconditional chip reset here. This can be
764 * done once we have a .reset function in struct flashchip.
765 * Give the chip time to settle.
766 */
767 programmer_delay(100000);
Nico Huber899e4ec2016-04-29 18:39:01 +0200768 if (read_it)
769 ret = do_read(fill_flash, filename);
Edward O'Callaghanc72d20a2021-12-13 12:30:03 +1100770 else if (erase_it) {
771 ret = flashrom_flash_erase(fill_flash);
772 /*
773 * FIXME: Do we really want the scary warning if erase failed?
774 * After all, after erase the chip is either blank or partially
775 * blank or it has the old contents. A blank chip won't boot,
776 * so if the user wanted erase and reboots afterwards, the user
777 * knows very well that booting won't work.
778 */
779 if (ret)
780 emergency_help_message();
781 }
Nico Huber899e4ec2016-04-29 18:39:01 +0200782 else if (write_it)
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300783 ret = do_write(fill_flash, filename, referencefile);
Nico Huber899e4ec2016-04-29 18:39:01 +0200784 else if (verify_it)
785 ret = do_verify(fill_flash, filename);
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000786
Nico Huber305f4172013-06-14 11:55:26 +0200787 flashrom_layout_release(layout);
788
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000789out_shutdown:
Edward O'Callaghan91eaebc2022-02-03 14:49:23 +1100790 flashrom_programmer_shutdown(NULL);
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000791out:
Nico Huber5bd990c2019-06-16 19:46:46 +0200792 for (i = 0; i < chipcount; i++) {
793 flashrom_layout_release(flashes[i].default_layout);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000794 free(flashes[i].chip);
Nico Huber5bd990c2019-06-16 19:46:46 +0200795 }
Stefan Taunerb8911d62012-12-26 07:55:00 +0000796
Nico Huber345f65a2021-05-14 01:11:08 +0200797 cleanup_include_args(&include_args);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000798 free(filename);
Richard Hughes6eca7612018-12-19 15:40:27 +0000799 free(fmapfile);
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300800 free(referencefile);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000801 free(layoutfile);
802 free(pparam);
803 /* clean up global variables */
Nico Huberbcb2e5a2012-12-30 01:23:17 +0000804 free((char *)chip_to_probe); /* Silence! Freeing is not modifying contents. */
Stefan Taunerb8911d62012-12-26 07:55:00 +0000805 chip_to_probe = NULL;
Stefan Tauner20da4aa2014-05-07 22:07:23 +0000806 free(logfile);
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000807 ret |= close_logfile();
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000808 return ret;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000809}