blob: ad2de6ffade7a3b2bf303392b53f90ade0d23392 [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"
Anastasia Klimchuka7cb7e92022-11-25 18:10:43 +110065 " -i | --include <region> only read/write image <region> from layout\n"
66 " --image <region> deprecated, please use --include\n"
Stefan Taunerb226cb12012-11-24 18:59:39 +000067 " -o | --output <logfile> log output to <logfile>\n"
Paul Kocialkowskif701f342018-01-15 01:10:36 +030068 " --flash-contents <ref-file> assume flash contents to be <ref-file>\n"
Stefan Taunerb226cb12012-11-24 18:59:39 +000069 " -L | --list-supported print supported devices\n"
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000070#if CONFIG_PRINT_WIKI == 1
Stefan Taunerb226cb12012-11-24 18:59:39 +000071 " -z | --list-supported-wiki print supported devices in wiki syntax\n"
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000072#endif
Stefan Taunerb226cb12012-11-24 18:59:39 +000073 " -p | --programmer <name>[:<param>] specify the programmer device. One of\n");
74 list_programmers_linebreak(4, 80, 0);
75 printf(".\n\nYou can specify one of -h, -R, -L, "
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000076#if CONFIG_PRINT_WIKI == 1
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000077 "-z, "
78#endif
79 "-E, -r, -w, -v or no operation.\n"
Stefan Taunerb226cb12012-11-24 18:59:39 +000080 "If no operation is specified, flashrom will only probe for flash chips.\n");
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000081}
82
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +100083static void cli_classic_abort_usage(const char *msg)
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000084{
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +100085 if (msg)
86 fprintf(stderr, "%s", msg);
Uwe Hermann2db77a02010-06-04 17:07:39 +000087 printf("Please run \"flashrom --help\" for usage info.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000088 exit(1);
89}
90
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +100091static void cli_classic_validate_singleop(int *operation_specified)
92{
93 if (++(*operation_specified) > 1) {
94 cli_classic_abort_usage("More than one operation specified. Aborting.\n");
95 }
96}
97
Jacob Garber4a84ec22019-07-25 19:12:31 -060098static int check_filename(char *filename, const char *type)
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +000099{
100 if (!filename || (filename[0] == '\0')) {
101 fprintf(stderr, "Error: No %s file specified.\n", type);
102 return 1;
103 }
104 /* 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 -0600105 if (filename[0] == '-' && filename[1] != '\0')
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000106 fprintf(stderr, "Warning: Supplied %s file name starts with -\n", type);
107 return 0;
108}
109
Jack Rosenthal85777562021-04-09 10:03:14 -0600110/* Ensure a file is open by means of fstat */
111static bool check_file(FILE *file)
112{
Jack Rosenthal85777562021-04-09 10:03:14 -0600113 struct stat statbuf;
114
115 if (fstat(fileno(file), &statbuf) < 0)
116 return false;
Jack Rosenthal85777562021-04-09 10:03:14 -0600117 return true;
118}
119
Edward O'Callaghan98cfa692021-12-13 12:46:12 +1100120static int do_read(struct flashctx *const flash, const char *const filename)
121{
122 int ret;
123
Edward O'Callaghan136bf432022-02-03 14:39:29 +1100124 unsigned long size = flashrom_flash_getsize(flash);
Edward O'Callaghan98cfa692021-12-13 12:46:12 +1100125 unsigned char *buf = calloc(size, sizeof(unsigned char));
126 if (!buf) {
127 msg_gerr("Memory allocation failed!\n");
128 return 1;
129 }
130
131 ret = flashrom_image_read(flash, buf, size);
132 if (ret > 0)
133 goto free_out;
134
135 ret = write_buf_to_file(buf, size, filename);
136
137free_out:
138 free(buf);
139 return ret;
140}
141
142static int do_write(struct flashctx *const flash, const char *const filename, const char *const referencefile)
143{
Edward O'Callaghan136bf432022-02-03 14:39:29 +1100144 const size_t flash_size = flashrom_flash_getsize(flash);
Edward O'Callaghan98cfa692021-12-13 12:46:12 +1100145 int ret = 1;
146
147 uint8_t *const newcontents = malloc(flash_size);
148 uint8_t *const refcontents = referencefile ? malloc(flash_size) : NULL;
149
150 if (!newcontents || (referencefile && !refcontents)) {
151 msg_gerr("Out of memory!\n");
152 goto _free_ret;
153 }
154
155 if (read_buf_from_file(newcontents, flash_size, filename))
156 goto _free_ret;
157
158 if (referencefile) {
159 if (read_buf_from_file(refcontents, flash_size, referencefile))
160 goto _free_ret;
161 }
162
163 ret = flashrom_image_write(flash, newcontents, flash_size, refcontents);
164
165_free_ret:
166 free(refcontents);
167 free(newcontents);
168 return ret;
169}
170
171static int do_verify(struct flashctx *const flash, const char *const filename)
172{
Edward O'Callaghan136bf432022-02-03 14:39:29 +1100173 const size_t flash_size = flashrom_flash_getsize(flash);
Edward O'Callaghan98cfa692021-12-13 12:46:12 +1100174 int ret = 1;
175
176 uint8_t *const newcontents = malloc(flash_size);
177 if (!newcontents) {
178 msg_gerr("Out of memory!\n");
179 goto _free_ret;
180 }
181
182 if (read_buf_from_file(newcontents, flash_size, filename))
183 goto _free_ret;
184
185 ret = flashrom_image_verify(flash, newcontents, flash_size);
186
187_free_ret:
188 free(newcontents);
189 return ret;
190}
191
Edward O'Callaghanaba36582022-09-05 11:09:28 +1000192/* Returns the number of buses commonly supported by the current programmer and flash chip where the latter
193 * can not be completely accessed due to size/address limits of the programmer. */
Edward O'Callaghan92ae5bb2022-09-05 11:13:56 +1000194static unsigned int count_max_decode_exceedings(const struct flashctx *flash,
195 const struct decode_sizes *max_rom_decode_)
Edward O'Callaghanaba36582022-09-05 11:09:28 +1000196{
197 unsigned int limitexceeded = 0;
198 uint32_t size = flash->chip->total_size * 1024;
199 enum chipbustype buses = flash->mst->buses_supported & flash->chip->bustype;
200
Edward O'Callaghan92ae5bb2022-09-05 11:13:56 +1000201 if ((buses & BUS_PARALLEL) && (max_rom_decode_->parallel < size)) {
Edward O'Callaghanaba36582022-09-05 11:09:28 +1000202 limitexceeded++;
203 msg_pdbg("Chip size %u kB is bigger than supported "
204 "size %u kB of chipset/board/programmer "
205 "for %s interface, "
206 "probe/read/erase/write may fail. ", size / 1024,
Edward O'Callaghan92ae5bb2022-09-05 11:13:56 +1000207 max_rom_decode_->parallel / 1024, "Parallel");
Edward O'Callaghanaba36582022-09-05 11:09:28 +1000208 }
Edward O'Callaghan92ae5bb2022-09-05 11:13:56 +1000209 if ((buses & BUS_LPC) && (max_rom_decode_->lpc < size)) {
Edward O'Callaghanaba36582022-09-05 11:09:28 +1000210 limitexceeded++;
211 msg_pdbg("Chip size %u kB is bigger than supported "
212 "size %u kB of chipset/board/programmer "
213 "for %s interface, "
214 "probe/read/erase/write may fail. ", size / 1024,
Edward O'Callaghan92ae5bb2022-09-05 11:13:56 +1000215 max_rom_decode_->lpc / 1024, "LPC");
Edward O'Callaghanaba36582022-09-05 11:09:28 +1000216 }
Edward O'Callaghan92ae5bb2022-09-05 11:13:56 +1000217 if ((buses & BUS_FWH) && (max_rom_decode_->fwh < size)) {
Edward O'Callaghanaba36582022-09-05 11:09:28 +1000218 limitexceeded++;
219 msg_pdbg("Chip size %u kB is bigger than supported "
220 "size %u kB of chipset/board/programmer "
221 "for %s interface, "
222 "probe/read/erase/write may fail. ", size / 1024,
Edward O'Callaghan92ae5bb2022-09-05 11:13:56 +1000223 max_rom_decode_->fwh / 1024, "FWH");
Edward O'Callaghanaba36582022-09-05 11:09:28 +1000224 }
Edward O'Callaghan92ae5bb2022-09-05 11:13:56 +1000225 if ((buses & BUS_SPI) && (max_rom_decode_->spi < size)) {
Edward O'Callaghanaba36582022-09-05 11:09:28 +1000226 limitexceeded++;
227 msg_pdbg("Chip size %u kB is bigger than supported "
228 "size %u kB of chipset/board/programmer "
229 "for %s interface, "
230 "probe/read/erase/write may fail. ", size / 1024,
Edward O'Callaghan92ae5bb2022-09-05 11:13:56 +1000231 max_rom_decode_->spi / 1024, "SPI");
Edward O'Callaghanaba36582022-09-05 11:09:28 +1000232 }
233 return limitexceeded;
234}
235
Uwe Hermann394ee782011-08-20 14:14:22 +0000236int main(int argc, char *argv[])
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000237{
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000238 const struct flashchip *chip = NULL;
Jernej Å krabece814a9b2014-12-12 00:32:03 +0000239 /* Probe for up to eight flash chips. */
240 struct flashctx flashes[8] = {{0}};
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000241 struct flashctx *fill_flash;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000242 const char *name;
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000243 int namelen, opt, i, j;
Felix Singer2a768e42022-05-22 02:04:18 +0200244 int startchip = -1, chipcount = 0, option_index = 0;
245 int operation_specified = 0;
246 bool force = false, ifd = false, fmap = false;
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000247#if CONFIG_PRINT_WIKI == 1
Felix Singer2a768e42022-05-22 02:04:18 +0200248 bool list_supported_wiki = false;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000249#endif
Felix Singer2a768e42022-05-22 02:04:18 +0200250 bool flash_name = false, flash_size = false;
251 bool read_it = false, write_it = false, erase_it = false, verify_it = false;
252 bool dont_verify_it = false, dont_verify_all = false;
253 bool list_supported = false;
Nico Huber305f4172013-06-14 11:55:26 +0200254 struct flashrom_layout *layout = NULL;
Thomas Heijligenacd9c942021-06-01 14:51:13 +0200255 static const struct programmer_entry *prog = NULL;
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300256 enum {
257 OPTION_IFD = 0x0100,
Arthur Heymansc82900b2018-01-10 12:48:16 +0100258 OPTION_FMAP,
259 OPTION_FMAP_FILE,
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300260 OPTION_FLASH_CONTENTS,
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +1000261 OPTION_FLASH_NAME,
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000262 OPTION_FLASH_SIZE,
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300263 };
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000264 int ret = 0;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000265
Nico Huber99d15952016-05-02 16:54:24 +0200266 static const char optstring[] = "r:Rw:v:nNVEfc:l:i:p:Lzho:";
Mathias Krausea60faab2011-01-17 07:50:42 +0000267 static const struct option long_options[] = {
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000268 {"read", 1, NULL, 'r'},
269 {"write", 1, NULL, 'w'},
270 {"erase", 0, NULL, 'E'},
271 {"verify", 1, NULL, 'v'},
272 {"noverify", 0, NULL, 'n'},
Nico Huber99d15952016-05-02 16:54:24 +0200273 {"noverify-all", 0, NULL, 'N'},
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000274 {"chip", 1, NULL, 'c'},
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000275 {"verbose", 0, NULL, 'V'},
276 {"force", 0, NULL, 'f'},
277 {"layout", 1, NULL, 'l'},
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300278 {"ifd", 0, NULL, OPTION_IFD},
Arthur Heymansc82900b2018-01-10 12:48:16 +0100279 {"fmap", 0, NULL, OPTION_FMAP},
280 {"fmap-file", 1, NULL, OPTION_FMAP_FILE},
Anastasia Klimchuka7cb7e92022-11-25 18:10:43 +1100281 {"image", 1, NULL, 'i'}, // (deprecated): back compatibility.
282 {"include", 1, NULL, 'i'},
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300283 {"flash-contents", 1, NULL, OPTION_FLASH_CONTENTS},
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +1000284 {"flash-name", 0, NULL, OPTION_FLASH_NAME},
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000285 {"flash-size", 0, NULL, OPTION_FLASH_SIZE},
286 {"get-size", 0, NULL, OPTION_FLASH_SIZE}, // (deprecated): back compatibility.
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000287 {"list-supported", 0, NULL, 'L'},
288 {"list-supported-wiki", 0, NULL, 'z'},
289 {"programmer", 1, NULL, 'p'},
290 {"help", 0, NULL, 'h'},
291 {"version", 0, NULL, 'R'},
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000292 {"output", 1, NULL, 'o'},
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000293 {NULL, 0, NULL, 0},
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000294 };
295
296 char *filename = NULL;
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300297 char *referencefile = NULL;
Carl-Daniel Hailfinger46284452012-01-11 02:10:11 +0000298 char *layoutfile = NULL;
Arthur Heymansc82900b2018-01-10 12:48:16 +0100299 char *fmapfile = NULL;
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000300 char *logfile = NULL;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000301 char *tempstr = NULL;
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000302 char *pparam = NULL;
Arthur Heymansb04fef92019-02-05 17:35:05 +0100303 struct layout_include_args *include_args = NULL;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000304
Jack Rosenthal85777562021-04-09 10:03:14 -0600305 /*
306 * Safety-guard against a user who has (mistakenly) closed
307 * stdout or stderr before exec'ing flashrom. We disable
308 * logging in this case to prevent writing log data to a flash
309 * chip when a flash device gets opened with fd 1 or 2.
310 */
311 if (check_file(stdout) && check_file(stderr)) {
312 flashrom_set_log_callback(
313 (flashrom_log_callback *)&flashrom_print_cb);
314 }
Nico Huber18781102012-12-10 13:34:12 +0000315
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000316 print_version();
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000317 print_banner();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000318
Edward O'Callaghand58496b2022-02-03 12:52:02 +1100319 /* FIXME: Delay calibration should happen in programmer code. */
320 if (flashrom_init(1))
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000321 exit(1);
322
323 setbuf(stdout, NULL);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000324 /* FIXME: Delay all operation_specified checks until after command
325 * line parsing to allow --help overriding everything else.
326 */
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000327 while ((opt = getopt_long(argc, argv, optstring,
328 long_options, &option_index)) != EOF) {
329 switch (opt) {
330 case 'r':
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000331 cli_classic_validate_singleop(&operation_specified);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000332 filename = strdup(optarg);
Felix Singer2a768e42022-05-22 02:04:18 +0200333 read_it = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000334 break;
335 case 'w':
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000336 cli_classic_validate_singleop(&operation_specified);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000337 filename = strdup(optarg);
Felix Singer2a768e42022-05-22 02:04:18 +0200338 write_it = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000339 break;
340 case 'v':
341 //FIXME: gracefully handle superfluous -v
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000342 cli_classic_validate_singleop(&operation_specified);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000343 if (dont_verify_it) {
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000344 cli_classic_abort_usage("--verify and --noverify are mutually exclusive. Aborting.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000345 }
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000346 filename = strdup(optarg);
Felix Singer2a768e42022-05-22 02:04:18 +0200347 verify_it = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000348 break;
349 case 'n':
350 if (verify_it) {
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000351 cli_classic_abort_usage("--verify and --noverify are mutually exclusive. Aborting.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000352 }
Felix Singer2a768e42022-05-22 02:04:18 +0200353 dont_verify_it = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000354 break;
Nico Huber99d15952016-05-02 16:54:24 +0200355 case 'N':
Felix Singer2a768e42022-05-22 02:04:18 +0200356 dont_verify_all = true;
Nico Huber99d15952016-05-02 16:54:24 +0200357 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000358 case 'c':
359 chip_to_probe = strdup(optarg);
360 break;
361 case 'V':
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000362 verbose_screen++;
Nico Huberd152fb92017-06-19 12:57:10 +0200363 if (verbose_screen > FLASHROM_MSG_DEBUG2)
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000364 verbose_logfile = verbose_screen;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000365 break;
366 case 'E':
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000367 cli_classic_validate_singleop(&operation_specified);
Felix Singer2a768e42022-05-22 02:04:18 +0200368 erase_it = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000369 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000370 case 'f':
Felix Singer2a768e42022-05-22 02:04:18 +0200371 force = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000372 break;
373 case 'l':
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000374 if (layoutfile)
375 cli_classic_abort_usage("Error: --layout specified more than once. Aborting.\n");
376 if (ifd)
377 cli_classic_abort_usage("Error: --layout and --ifd both specified. Aborting.\n");
378 if (fmap)
379 cli_classic_abort_usage("Error: --layout and --fmap-file both specified. Aborting.\n");
Carl-Daniel Hailfinger46284452012-01-11 02:10:11 +0000380 layoutfile = strdup(optarg);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000381 break;
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300382 case OPTION_IFD:
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000383 if (layoutfile)
384 cli_classic_abort_usage("Error: --layout and --ifd both specified. Aborting.\n");
385 if (fmap)
386 cli_classic_abort_usage("Error: --fmap-file and --ifd both specified. Aborting.\n");
Felix Singer2a768e42022-05-22 02:04:18 +0200387 ifd = true;
Nico Huber305f4172013-06-14 11:55:26 +0200388 break;
Arthur Heymansc82900b2018-01-10 12:48:16 +0100389 case OPTION_FMAP_FILE:
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000390 if (fmap)
391 cli_classic_abort_usage("Error: --fmap or --fmap-file specified "
Arthur Heymansc82900b2018-01-10 12:48:16 +0100392 "more than once. Aborting.\n");
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000393 if (ifd)
394 cli_classic_abort_usage("Error: --fmap-file and --ifd both specified. Aborting.\n");
395 if (layoutfile)
396 cli_classic_abort_usage("Error: --fmap-file and --layout both specified. Aborting.\n");
Arthur Heymansc82900b2018-01-10 12:48:16 +0100397 fmapfile = strdup(optarg);
Felix Singer2a768e42022-05-22 02:04:18 +0200398 fmap = true;
Arthur Heymansc82900b2018-01-10 12:48:16 +0100399 break;
400 case OPTION_FMAP:
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000401 if (fmap)
402 cli_classic_abort_usage("Error: --fmap or --fmap-file specified "
Arthur Heymansc82900b2018-01-10 12:48:16 +0100403 "more than once. Aborting.\n");
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000404 if (ifd)
405 cli_classic_abort_usage("Error: --fmap and --ifd both specified. Aborting.\n");
406 if (layoutfile)
407 cli_classic_abort_usage("Error: --layout and --fmap both specified. Aborting.\n");
Felix Singer2a768e42022-05-22 02:04:18 +0200408 fmap = true;
Arthur Heymansc82900b2018-01-10 12:48:16 +0100409 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000410 case 'i':
411 tempstr = strdup(optarg);
Arthur Heymansb04fef92019-02-05 17:35:05 +0100412 if (register_include_arg(&include_args, tempstr)) {
Stefan Taunerb8911d62012-12-26 07:55:00 +0000413 free(tempstr);
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000414 cli_classic_abort_usage(NULL);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000415 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000416 break;
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300417 case OPTION_FLASH_CONTENTS:
Angel Ponsa60f6412020-03-31 15:02:02 +0200418 if (referencefile)
419 cli_classic_abort_usage("Error: --flash-contents specified more than once."
420 "Aborting.\n");
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300421 referencefile = strdup(optarg);
422 break;
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +1000423 case OPTION_FLASH_NAME:
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000424 cli_classic_validate_singleop(&operation_specified);
Felix Singer2a768e42022-05-22 02:04:18 +0200425 flash_name = true;
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +1000426 break;
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000427 case OPTION_FLASH_SIZE:
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000428 cli_classic_validate_singleop(&operation_specified);
Felix Singer2a768e42022-05-22 02:04:18 +0200429 flash_size = true;
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000430 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000431 case 'L':
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000432 cli_classic_validate_singleop(&operation_specified);
Felix Singer2a768e42022-05-22 02:04:18 +0200433 list_supported = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000434 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000435 case 'z':
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000436#if CONFIG_PRINT_WIKI == 1
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000437 cli_classic_validate_singleop(&operation_specified);
Felix Singer2a768e42022-05-22 02:04:18 +0200438 list_supported_wiki = true;
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000439#else
Idwer Vollering40407b62020-12-08 00:24:39 +0100440 cli_classic_abort_usage("Error: Wiki output was not "
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000441 "compiled in. Aborting.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000442#endif
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000443 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000444 case 'p':
Thomas Heijligenacd9c942021-06-01 14:51:13 +0200445 if (prog != NULL) {
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000446 cli_classic_abort_usage("Error: --programmer specified "
Carl-Daniel Hailfinger2e681602011-09-08 00:00:29 +0000447 "more than once. You can separate "
448 "multiple\nparameters for a programmer "
449 "with \",\". Please see the man page "
450 "for details.\n");
Carl-Daniel Hailfinger2e681602011-09-08 00:00:29 +0000451 }
Thomas Heijligenacd9c942021-06-01 14:51:13 +0200452 size_t p;
453 for (p = 0; p < programmer_table_size; p++) {
454 name = programmer_table[p]->name;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000455 namelen = strlen(name);
456 if (strncmp(optarg, name, namelen) == 0) {
457 switch (optarg[namelen]) {
458 case ':':
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000459 pparam = strdup(optarg + namelen + 1);
460 if (!strlen(pparam)) {
461 free(pparam);
462 pparam = NULL;
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000463 }
Thomas Heijligenacd9c942021-06-01 14:51:13 +0200464 prog = programmer_table[p];
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000465 break;
466 case '\0':
Thomas Heijligenacd9c942021-06-01 14:51:13 +0200467 prog = programmer_table[p];
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000468 break;
469 default:
470 /* The continue refers to the
471 * for loop. It is here to be
472 * able to differentiate between
473 * foo and foobar.
474 */
475 continue;
476 }
477 break;
478 }
479 }
Thomas Heijligenacd9c942021-06-01 14:51:13 +0200480 if (prog == NULL) {
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000481 fprintf(stderr, "Error: Unknown programmer \"%s\". Valid choices are:\n",
482 optarg);
483 list_programmers_linebreak(0, 80, 0);
Stefan Taunerb226cb12012-11-24 18:59:39 +0000484 msg_ginfo(".\n");
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000485 cli_classic_abort_usage(NULL);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000486 }
487 break;
488 case 'R':
489 /* print_version() is always called during startup. */
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000490 cli_classic_validate_singleop(&operation_specified);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000491 exit(0);
492 break;
493 case 'h':
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000494 cli_classic_validate_singleop(&operation_specified);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000495 cli_classic_usage(argv[0]);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000496 exit(0);
497 break;
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000498 case 'o':
Elyes HAOUASef78de42019-07-18 15:08:10 +0200499 if (logfile) {
500 fprintf(stderr, "Warning: -o/--output specified multiple times.\n");
501 free(logfile);
502 }
503
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000504 logfile = strdup(optarg);
505 if (logfile[0] == '\0') {
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000506 cli_classic_abort_usage("No log filename specified.\n");
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000507 }
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000508 break;
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000509 default:
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000510 cli_classic_abort_usage(NULL);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000511 break;
512 }
513 }
514
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000515 if (optind < argc)
516 cli_classic_abort_usage("Error: Extra parameter found.\n");
517 if ((read_it | write_it | verify_it) && check_filename(filename, "image"))
518 cli_classic_abort_usage(NULL);
519 if (layoutfile && check_filename(layoutfile, "layout"))
520 cli_classic_abort_usage(NULL);
521 if (fmapfile && check_filename(fmapfile, "fmap"))
522 cli_classic_abort_usage(NULL);
523 if (referencefile && check_filename(referencefile, "reference"))
524 cli_classic_abort_usage(NULL);
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000525 if (logfile && check_filename(logfile, "log"))
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000526 cli_classic_abort_usage(NULL);
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000527 if (logfile && open_logfile(logfile))
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000528 cli_classic_abort_usage(NULL);
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000529
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000530#if CONFIG_PRINT_WIKI == 1
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000531 if (list_supported_wiki) {
532 print_supported_wiki();
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000533 goto out;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000534 }
535#endif
536
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000537 if (list_supported) {
Niklas Söderlundede2fa42012-10-23 13:06:46 +0000538 if (print_supported())
539 ret = 1;
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000540 goto out;
541 }
Carl-Daniel Hailfinger46284452012-01-11 02:10:11 +0000542
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000543 start_logging();
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000544
545 print_buildinfo();
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000546 msg_gdbg("Command line (%i args):", argc - 1);
547 for (i = 0; i < argc; i++) {
548 msg_gdbg(" %s", argv[i]);
549 }
550 msg_gdbg("\n");
551
Nico Huberd9b57712021-05-14 01:07:28 +0200552 if (layoutfile && layout_from_file(&layout, layoutfile)) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000553 ret = 1;
554 goto out;
555 }
Arthur Heymansc82900b2018-01-10 12:48:16 +0100556
Nico Huberd9b57712021-05-14 01:07:28 +0200557 if (!ifd && !fmap && process_include_args(layout, include_args)) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000558 ret = 1;
559 goto out;
560 }
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000561 /* Does a chip with the requested name exist in the flashchips array? */
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000562 if (chip_to_probe) {
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000563 for (chip = flashchips; chip && chip->name; chip++)
564 if (!strcmp(chip->name, chip_to_probe))
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000565 break;
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000566 if (!chip || !chip->name) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000567 msg_cerr("Error: Unknown chip '%s' specified.\n", chip_to_probe);
568 msg_gerr("Run flashrom -L to view the hardware supported in this flashrom version.\n");
569 ret = 1;
570 goto out;
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000571 }
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000572 /* Keep chip around for later usage in case a forced read is requested. */
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000573 }
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000574
Thomas Heijligenacd9c942021-06-01 14:51:13 +0200575 if (prog == NULL) {
Thomas Heijligen84e9c912021-06-01 16:22:14 +0200576 const struct programmer_entry *const default_programmer = CONFIG_DEFAULT_PROGRAMMER_NAME;
577
578 if (default_programmer) {
579 prog = default_programmer;
Stefan Tauner265fcac2014-06-02 00:12:23 +0000580 /* We need to strdup here because we free(pparam) unconditionally later. */
581 pparam = strdup(CONFIG_DEFAULT_PROGRAMMER_ARGS);
582 msg_pinfo("Using default programmer \"%s\" with arguments \"%s\".\n",
Thomas Heijligen84e9c912021-06-01 16:22:14 +0200583 default_programmer->name, pparam);
Stefan Taunerfd0d4132012-09-25 21:24:55 +0000584 } else {
585 msg_perr("Please select a programmer with the --programmer parameter.\n"
Stefan Taunerb226cb12012-11-24 18:59:39 +0000586#if CONFIG_INTERNAL == 1
587 "To choose the mainboard of this computer use 'internal'. "
588#endif
Stefan Taunerfd0d4132012-09-25 21:24:55 +0000589 "Valid choices are:\n");
590 list_programmers_linebreak(0, 80, 0);
Stefan Taunerb226cb12012-11-24 18:59:39 +0000591 msg_ginfo(".\n");
Stefan Taunerfd0d4132012-09-25 21:24:55 +0000592 ret = 1;
593 goto out;
594 }
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000595 }
Carl-Daniel Hailfinger2e681602011-09-08 00:00:29 +0000596
Thomas Heijligenacd9c942021-06-01 14:51:13 +0200597 if (programmer_init(prog, pparam)) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000598 msg_perr("Error: Programmer initialization failed.\n");
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000599 ret = 1;
600 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000601 }
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000602 tempstr = flashbuses_to_text(get_buses_supported());
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000603 msg_pdbg("The following protocols are supported: %s.\n", tempstr);
Carl-Daniel Hailfingereaacd2d2011-11-09 23:40:00 +0000604 free(tempstr);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000605
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000606 for (j = 0; j < registered_master_count; j++) {
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000607 startchip = 0;
Nico Huber519be662018-12-23 20:03:35 +0100608 while (chipcount < (int)ARRAY_SIZE(flashes)) {
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000609 startchip = probe_flash(&registered_masters[j], startchip, &flashes[chipcount], 0);
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000610 if (startchip == -1)
611 break;
612 chipcount++;
613 startchip++;
614 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000615 }
616
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000617 if (chipcount > 1) {
Stefan Tauner0554ca52013-07-25 22:54:25 +0000618 msg_cinfo("Multiple flash chip definitions match the detected chip(s): \"%s\"",
619 flashes[0].chip->name);
Stefan Tauner716e0982011-07-25 20:38:52 +0000620 for (i = 1; i < chipcount; i++)
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000621 msg_cinfo(", \"%s\"", flashes[i].chip->name);
Stefan Tauner0554ca52013-07-25 22:54:25 +0000622 msg_cinfo("\nPlease specify which chip definition to use with the -c <chipname> option.\n");
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000623 ret = 1;
624 goto out_shutdown;
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000625 } else if (!chipcount) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000626 msg_cinfo("No EEPROM/flash device found.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000627 if (!force || !chip_to_probe) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000628 msg_cinfo("Note: flashrom can never write if the flash chip isn't found "
629 "automatically.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000630 }
631 if (force && read_it && chip_to_probe) {
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000632 struct registered_master *mst;
633 int compatible_masters = 0;
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000634 msg_cinfo("Force read (-f -r -c) requested, pretending the chip is there:\n");
Carl-Daniel Hailfingerb428e972012-02-16 20:31:25 +0000635 /* This loop just counts compatible controllers. */
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000636 for (j = 0; j < registered_master_count; j++) {
637 mst = &registered_masters[j];
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000638 /* chip is still set from the chip_to_probe earlier in this function. */
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000639 if (mst->buses_supported & chip->bustype)
640 compatible_masters++;
Carl-Daniel Hailfingerb428e972012-02-16 20:31:25 +0000641 }
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000642 if (!compatible_masters) {
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000643 msg_cinfo("No compatible controller found for the requested flash chip.\n");
644 ret = 1;
645 goto out_shutdown;
646 }
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000647 if (compatible_masters > 1)
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000648 msg_cinfo("More than one compatible controller found for the requested flash "
649 "chip, using the first one.\n");
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000650 for (j = 0; j < registered_master_count; j++) {
651 mst = &registered_masters[j];
652 startchip = probe_flash(mst, 0, &flashes[0], 1);
Carl-Daniel Hailfingerb428e972012-02-16 20:31:25 +0000653 if (startchip != -1)
654 break;
655 }
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000656 if (startchip == -1) {
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000657 // FIXME: This should never happen! Ask for a bug report?
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000658 msg_cinfo("Probing for flash chip '%s' failed.\n", chip_to_probe);
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000659 ret = 1;
660 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000661 }
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000662 msg_cinfo("Please note that forced reads most likely contain garbage.\n");
Felix Singer2a768e42022-05-22 02:04:18 +0200663 flashrom_flag_set(&flashes[0], FLASHROM_FLAG_FORCE, force);
Edward O'Callaghan2d170412021-11-15 15:47:15 +1100664 ret = do_read(&flashes[0], filename);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000665 free(flashes[0].chip);
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000666 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000667 }
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000668 ret = 1;
669 goto out_shutdown;
Stefan Tauner1d947632011-09-11 22:08:58 +0000670 } else if (!chip_to_probe) {
671 /* repeat for convenience when looking at foreign logs */
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000672 tempstr = flashbuses_to_text(flashes[0].chip->bustype);
Stefan Tauner1d947632011-09-11 22:08:58 +0000673 msg_gdbg("Found %s flash chip \"%s\" (%d kB, %s).\n",
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000674 flashes[0].chip->vendor, flashes[0].chip->name, flashes[0].chip->total_size, tempstr);
Stefan Tauner1d947632011-09-11 22:08:58 +0000675 free(tempstr);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000676 }
677
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000678 fill_flash = &flashes[0];
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000679
Stefan Tauner9b32de92014-08-08 23:52:33 +0000680 print_chip_support_status(fill_flash->chip);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000681
Edward O'Callaghan92ae5bb2022-09-05 11:13:56 +1000682 unsigned int limitexceeded = count_max_decode_exceedings(fill_flash, &max_rom_decode);
Stefan Tauner9e3a6982014-08-15 17:17:59 +0000683 if (limitexceeded > 0 && !force) {
684 enum chipbustype commonbuses = fill_flash->mst->buses_supported & fill_flash->chip->bustype;
685
686 /* Sometimes chip and programmer have more than one bus in common,
687 * and the limit is not exceeded on all buses. Tell the user. */
688 if ((bitcount(commonbuses) > limitexceeded)) {
689 msg_pdbg("There is at least one interface available which could support the size of\n"
690 "the selected flash chip.\n");
691 }
692 msg_cerr("This flash chip is too big for this programmer (--verbose/-V gives details).\n"
693 "Use --force/-f to override at your own risk.\n");
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000694 ret = 1;
695 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000696 }
697
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000698 if (!(read_it | write_it | verify_it | erase_it | flash_name | flash_size)) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000699 msg_ginfo("No operations were specified.\n");
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000700 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000701 }
702
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +1000703 if (flash_name) {
704 if (fill_flash->chip->vendor && fill_flash->chip->name) {
705 printf("vendor=\"%s\" name=\"%s\"\n",
706 fill_flash->chip->vendor,
707 fill_flash->chip->name);
708 } else {
709 ret = -1;
710 }
711 goto out_shutdown;
712 }
713
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000714 if (flash_size) {
Edward O'Callaghan136bf432022-02-03 14:39:29 +1100715 printf("%zu\n", flashrom_flash_getsize(fill_flash));
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000716 goto out_shutdown;
717 }
718
Nico Huberd9b57712021-05-14 01:07:28 +0200719 if (ifd && (flashrom_layout_read_from_ifd(&layout, fill_flash, NULL, 0) ||
Arthur Heymansb04fef92019-02-05 17:35:05 +0100720 process_include_args(layout, include_args))) {
Nico Huber305f4172013-06-14 11:55:26 +0200721 ret = 1;
722 goto out_shutdown;
Arthur Heymansc82900b2018-01-10 12:48:16 +0100723 } else if (fmap && fmapfile) {
724 struct stat s;
725 if (stat(fmapfile, &s) != 0) {
726 msg_gerr("Failed to stat fmapfile \"%s\"\n", fmapfile);
727 ret = 1;
728 goto out_shutdown;
729 }
730
731 size_t fmapfile_size = s.st_size;
732 uint8_t *fmapfile_buffer = malloc(fmapfile_size);
733 if (!fmapfile_buffer) {
734 ret = 1;
735 goto out_shutdown;
736 }
737
738 if (read_buf_from_file(fmapfile_buffer, fmapfile_size, fmapfile)) {
739 ret = 1;
740 free(fmapfile_buffer);
741 goto out_shutdown;
742 }
743
744 if (flashrom_layout_read_fmap_from_buffer(&layout, fill_flash, fmapfile_buffer, fmapfile_size) ||
Arthur Heymansb04fef92019-02-05 17:35:05 +0100745 process_include_args(layout, include_args)) {
Arthur Heymansc82900b2018-01-10 12:48:16 +0100746 ret = 1;
747 free(fmapfile_buffer);
748 goto out_shutdown;
749 }
750 free(fmapfile_buffer);
751 } else if (fmap && (flashrom_layout_read_fmap_from_rom(&layout, fill_flash, 0,
Edward O'Callaghan136bf432022-02-03 14:39:29 +1100752 flashrom_flash_getsize(fill_flash)) || process_include_args(layout, include_args))) {
Arthur Heymansc82900b2018-01-10 12:48:16 +0100753 ret = 1;
754 goto out_shutdown;
Nico Huber305f4172013-06-14 11:55:26 +0200755 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000756
Nico Huber305f4172013-06-14 11:55:26 +0200757 flashrom_layout_set(fill_flash, layout);
Felix Singer2a768e42022-05-22 02:04:18 +0200758 flashrom_flag_set(fill_flash, FLASHROM_FLAG_FORCE, force);
Urja Rannikko7258cf52017-06-17 11:31:57 +0300759#if CONFIG_INTERNAL == 1
Felix Singer2a768e42022-05-22 02:04:18 +0200760 flashrom_flag_set(fill_flash, FLASHROM_FLAG_FORCE_BOARDMISMATCH, force_boardmismatch);
Urja Rannikko7258cf52017-06-17 11:31:57 +0300761#endif
Nico Huber899e4ec2016-04-29 18:39:01 +0200762 flashrom_flag_set(fill_flash, FLASHROM_FLAG_VERIFY_AFTER_WRITE, !dont_verify_it);
Nico Huber99d15952016-05-02 16:54:24 +0200763 flashrom_flag_set(fill_flash, FLASHROM_FLAG_VERIFY_WHOLE_CHIP, !dont_verify_all);
Stefan Tauner4e32ec12014-08-30 23:39:51 +0000764
Carl-Daniel Hailfinger9ad42552010-09-15 10:20:16 +0000765 /* FIXME: We should issue an unconditional chip reset here. This can be
766 * done once we have a .reset function in struct flashchip.
767 * Give the chip time to settle.
768 */
769 programmer_delay(100000);
Nico Huber899e4ec2016-04-29 18:39:01 +0200770 if (read_it)
771 ret = do_read(fill_flash, filename);
Edward O'Callaghanc72d20a2021-12-13 12:30:03 +1100772 else if (erase_it) {
773 ret = flashrom_flash_erase(fill_flash);
774 /*
775 * FIXME: Do we really want the scary warning if erase failed?
776 * After all, after erase the chip is either blank or partially
777 * blank or it has the old contents. A blank chip won't boot,
778 * so if the user wanted erase and reboots afterwards, the user
779 * knows very well that booting won't work.
780 */
781 if (ret)
782 emergency_help_message();
783 }
Nico Huber899e4ec2016-04-29 18:39:01 +0200784 else if (write_it)
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300785 ret = do_write(fill_flash, filename, referencefile);
Nico Huber899e4ec2016-04-29 18:39:01 +0200786 else if (verify_it)
787 ret = do_verify(fill_flash, filename);
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000788
Nico Huber305f4172013-06-14 11:55:26 +0200789 flashrom_layout_release(layout);
790
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000791out_shutdown:
Edward O'Callaghan91eaebc2022-02-03 14:49:23 +1100792 flashrom_programmer_shutdown(NULL);
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000793out:
Nico Huber5bd990c2019-06-16 19:46:46 +0200794 for (i = 0; i < chipcount; i++) {
795 flashrom_layout_release(flashes[i].default_layout);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000796 free(flashes[i].chip);
Nico Huber5bd990c2019-06-16 19:46:46 +0200797 }
Stefan Taunerb8911d62012-12-26 07:55:00 +0000798
Nico Huber345f65a2021-05-14 01:11:08 +0200799 cleanup_include_args(&include_args);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000800 free(filename);
Richard Hughes6eca7612018-12-19 15:40:27 +0000801 free(fmapfile);
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300802 free(referencefile);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000803 free(layoutfile);
804 free(pparam);
805 /* clean up global variables */
Nico Huberbcb2e5a2012-12-30 01:23:17 +0000806 free((char *)chip_to_probe); /* Silence! Freeing is not modifying contents. */
Stefan Taunerb8911d62012-12-26 07:55:00 +0000807 chip_to_probe = NULL;
Stefan Tauner20da4aa2014-05-07 22:07:23 +0000808 free(logfile);
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000809 ret |= close_logfile();
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000810 return ret;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000811}