blob: 38fa7a852f0f479354fe500c072e0ca5a21d1230 [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. */
193static unsigned int count_max_decode_exceedings(const struct flashctx *flash)
194{
195 unsigned int limitexceeded = 0;
196 uint32_t size = flash->chip->total_size * 1024;
197 enum chipbustype buses = flash->mst->buses_supported & flash->chip->bustype;
198
199 if ((buses & BUS_PARALLEL) && (max_rom_decode.parallel < size)) {
200 limitexceeded++;
201 msg_pdbg("Chip size %u kB is bigger than supported "
202 "size %u kB of chipset/board/programmer "
203 "for %s interface, "
204 "probe/read/erase/write may fail. ", size / 1024,
205 max_rom_decode.parallel / 1024, "Parallel");
206 }
207 if ((buses & BUS_LPC) && (max_rom_decode.lpc < size)) {
208 limitexceeded++;
209 msg_pdbg("Chip size %u kB is bigger than supported "
210 "size %u kB of chipset/board/programmer "
211 "for %s interface, "
212 "probe/read/erase/write may fail. ", size / 1024,
213 max_rom_decode.lpc / 1024, "LPC");
214 }
215 if ((buses & BUS_FWH) && (max_rom_decode.fwh < size)) {
216 limitexceeded++;
217 msg_pdbg("Chip size %u kB is bigger than supported "
218 "size %u kB of chipset/board/programmer "
219 "for %s interface, "
220 "probe/read/erase/write may fail. ", size / 1024,
221 max_rom_decode.fwh / 1024, "FWH");
222 }
223 if ((buses & BUS_SPI) && (max_rom_decode.spi < size)) {
224 limitexceeded++;
225 msg_pdbg("Chip size %u kB is bigger than supported "
226 "size %u kB of chipset/board/programmer "
227 "for %s interface, "
228 "probe/read/erase/write may fail. ", size / 1024,
229 max_rom_decode.spi / 1024, "SPI");
230 }
231 return limitexceeded;
232}
233
Uwe Hermann394ee782011-08-20 14:14:22 +0000234int main(int argc, char *argv[])
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000235{
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000236 const struct flashchip *chip = NULL;
Jernej Å krabece814a9b2014-12-12 00:32:03 +0000237 /* Probe for up to eight flash chips. */
238 struct flashctx flashes[8] = {{0}};
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000239 struct flashctx *fill_flash;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000240 const char *name;
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000241 int namelen, opt, i, j;
Felix Singer2a768e42022-05-22 02:04:18 +0200242 int startchip = -1, chipcount = 0, option_index = 0;
243 int operation_specified = 0;
244 bool force = false, ifd = false, fmap = false;
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000245#if CONFIG_PRINT_WIKI == 1
Felix Singer2a768e42022-05-22 02:04:18 +0200246 bool list_supported_wiki = false;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000247#endif
Felix Singer2a768e42022-05-22 02:04:18 +0200248 bool flash_name = false, flash_size = false;
249 bool read_it = false, write_it = false, erase_it = false, verify_it = false;
250 bool dont_verify_it = false, dont_verify_all = false;
251 bool list_supported = false;
Nico Huber305f4172013-06-14 11:55:26 +0200252 struct flashrom_layout *layout = NULL;
Thomas Heijligenacd9c942021-06-01 14:51:13 +0200253 static const struct programmer_entry *prog = NULL;
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300254 enum {
255 OPTION_IFD = 0x0100,
Arthur Heymansc82900b2018-01-10 12:48:16 +0100256 OPTION_FMAP,
257 OPTION_FMAP_FILE,
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300258 OPTION_FLASH_CONTENTS,
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +1000259 OPTION_FLASH_NAME,
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000260 OPTION_FLASH_SIZE,
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300261 };
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000262 int ret = 0;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000263
Nico Huber99d15952016-05-02 16:54:24 +0200264 static const char optstring[] = "r:Rw:v:nNVEfc:l:i:p:Lzho:";
Mathias Krausea60faab2011-01-17 07:50:42 +0000265 static const struct option long_options[] = {
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000266 {"read", 1, NULL, 'r'},
267 {"write", 1, NULL, 'w'},
268 {"erase", 0, NULL, 'E'},
269 {"verify", 1, NULL, 'v'},
270 {"noverify", 0, NULL, 'n'},
Nico Huber99d15952016-05-02 16:54:24 +0200271 {"noverify-all", 0, NULL, 'N'},
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000272 {"chip", 1, NULL, 'c'},
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000273 {"verbose", 0, NULL, 'V'},
274 {"force", 0, NULL, 'f'},
275 {"layout", 1, NULL, 'l'},
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300276 {"ifd", 0, NULL, OPTION_IFD},
Arthur Heymansc82900b2018-01-10 12:48:16 +0100277 {"fmap", 0, NULL, OPTION_FMAP},
278 {"fmap-file", 1, NULL, OPTION_FMAP_FILE},
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000279 {"image", 1, NULL, 'i'},
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300280 {"flash-contents", 1, NULL, OPTION_FLASH_CONTENTS},
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +1000281 {"flash-name", 0, NULL, OPTION_FLASH_NAME},
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000282 {"flash-size", 0, NULL, OPTION_FLASH_SIZE},
283 {"get-size", 0, NULL, OPTION_FLASH_SIZE}, // (deprecated): back compatibility.
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000284 {"list-supported", 0, NULL, 'L'},
285 {"list-supported-wiki", 0, NULL, 'z'},
286 {"programmer", 1, NULL, 'p'},
287 {"help", 0, NULL, 'h'},
288 {"version", 0, NULL, 'R'},
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000289 {"output", 1, NULL, 'o'},
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000290 {NULL, 0, NULL, 0},
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000291 };
292
293 char *filename = NULL;
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300294 char *referencefile = NULL;
Carl-Daniel Hailfinger46284452012-01-11 02:10:11 +0000295 char *layoutfile = NULL;
Arthur Heymansc82900b2018-01-10 12:48:16 +0100296 char *fmapfile = NULL;
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000297 char *logfile = NULL;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000298 char *tempstr = NULL;
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000299 char *pparam = NULL;
Arthur Heymansb04fef92019-02-05 17:35:05 +0100300 struct layout_include_args *include_args = NULL;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000301
Jack Rosenthal85777562021-04-09 10:03:14 -0600302 /*
303 * Safety-guard against a user who has (mistakenly) closed
304 * stdout or stderr before exec'ing flashrom. We disable
305 * logging in this case to prevent writing log data to a flash
306 * chip when a flash device gets opened with fd 1 or 2.
307 */
308 if (check_file(stdout) && check_file(stderr)) {
309 flashrom_set_log_callback(
310 (flashrom_log_callback *)&flashrom_print_cb);
311 }
Nico Huber18781102012-12-10 13:34:12 +0000312
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000313 print_version();
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000314 print_banner();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000315
Edward O'Callaghand58496b2022-02-03 12:52:02 +1100316 /* FIXME: Delay calibration should happen in programmer code. */
317 if (flashrom_init(1))
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000318 exit(1);
319
320 setbuf(stdout, NULL);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000321 /* FIXME: Delay all operation_specified checks until after command
322 * line parsing to allow --help overriding everything else.
323 */
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000324 while ((opt = getopt_long(argc, argv, optstring,
325 long_options, &option_index)) != EOF) {
326 switch (opt) {
327 case 'r':
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000328 cli_classic_validate_singleop(&operation_specified);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000329 filename = strdup(optarg);
Felix Singer2a768e42022-05-22 02:04:18 +0200330 read_it = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000331 break;
332 case 'w':
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000333 cli_classic_validate_singleop(&operation_specified);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000334 filename = strdup(optarg);
Felix Singer2a768e42022-05-22 02:04:18 +0200335 write_it = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000336 break;
337 case 'v':
338 //FIXME: gracefully handle superfluous -v
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000339 cli_classic_validate_singleop(&operation_specified);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000340 if (dont_verify_it) {
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000341 cli_classic_abort_usage("--verify and --noverify are mutually exclusive. Aborting.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000342 }
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000343 filename = strdup(optarg);
Felix Singer2a768e42022-05-22 02:04:18 +0200344 verify_it = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000345 break;
346 case 'n':
347 if (verify_it) {
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000348 cli_classic_abort_usage("--verify and --noverify are mutually exclusive. Aborting.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000349 }
Felix Singer2a768e42022-05-22 02:04:18 +0200350 dont_verify_it = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000351 break;
Nico Huber99d15952016-05-02 16:54:24 +0200352 case 'N':
Felix Singer2a768e42022-05-22 02:04:18 +0200353 dont_verify_all = true;
Nico Huber99d15952016-05-02 16:54:24 +0200354 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000355 case 'c':
356 chip_to_probe = strdup(optarg);
357 break;
358 case 'V':
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000359 verbose_screen++;
Nico Huberd152fb92017-06-19 12:57:10 +0200360 if (verbose_screen > FLASHROM_MSG_DEBUG2)
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000361 verbose_logfile = verbose_screen;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000362 break;
363 case 'E':
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000364 cli_classic_validate_singleop(&operation_specified);
Felix Singer2a768e42022-05-22 02:04:18 +0200365 erase_it = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000366 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000367 case 'f':
Felix Singer2a768e42022-05-22 02:04:18 +0200368 force = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000369 break;
370 case 'l':
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000371 if (layoutfile)
372 cli_classic_abort_usage("Error: --layout specified more than once. Aborting.\n");
373 if (ifd)
374 cli_classic_abort_usage("Error: --layout and --ifd both specified. Aborting.\n");
375 if (fmap)
376 cli_classic_abort_usage("Error: --layout and --fmap-file both specified. Aborting.\n");
Carl-Daniel Hailfinger46284452012-01-11 02:10:11 +0000377 layoutfile = strdup(optarg);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000378 break;
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300379 case OPTION_IFD:
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000380 if (layoutfile)
381 cli_classic_abort_usage("Error: --layout and --ifd both specified. Aborting.\n");
382 if (fmap)
383 cli_classic_abort_usage("Error: --fmap-file and --ifd both specified. Aborting.\n");
Felix Singer2a768e42022-05-22 02:04:18 +0200384 ifd = true;
Nico Huber305f4172013-06-14 11:55:26 +0200385 break;
Arthur Heymansc82900b2018-01-10 12:48:16 +0100386 case OPTION_FMAP_FILE:
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000387 if (fmap)
388 cli_classic_abort_usage("Error: --fmap or --fmap-file specified "
Arthur Heymansc82900b2018-01-10 12:48:16 +0100389 "more than once. Aborting.\n");
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000390 if (ifd)
391 cli_classic_abort_usage("Error: --fmap-file and --ifd both specified. Aborting.\n");
392 if (layoutfile)
393 cli_classic_abort_usage("Error: --fmap-file and --layout both specified. Aborting.\n");
Arthur Heymansc82900b2018-01-10 12:48:16 +0100394 fmapfile = strdup(optarg);
Felix Singer2a768e42022-05-22 02:04:18 +0200395 fmap = true;
Arthur Heymansc82900b2018-01-10 12:48:16 +0100396 break;
397 case OPTION_FMAP:
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000398 if (fmap)
399 cli_classic_abort_usage("Error: --fmap or --fmap-file specified "
Arthur Heymansc82900b2018-01-10 12:48:16 +0100400 "more than once. Aborting.\n");
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000401 if (ifd)
402 cli_classic_abort_usage("Error: --fmap and --ifd both specified. Aborting.\n");
403 if (layoutfile)
404 cli_classic_abort_usage("Error: --layout and --fmap both specified. Aborting.\n");
Felix Singer2a768e42022-05-22 02:04:18 +0200405 fmap = true;
Arthur Heymansc82900b2018-01-10 12:48:16 +0100406 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000407 case 'i':
408 tempstr = strdup(optarg);
Arthur Heymansb04fef92019-02-05 17:35:05 +0100409 if (register_include_arg(&include_args, tempstr)) {
Stefan Taunerb8911d62012-12-26 07:55:00 +0000410 free(tempstr);
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000411 cli_classic_abort_usage(NULL);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000412 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000413 break;
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300414 case OPTION_FLASH_CONTENTS:
Angel Ponsa60f6412020-03-31 15:02:02 +0200415 if (referencefile)
416 cli_classic_abort_usage("Error: --flash-contents specified more than once."
417 "Aborting.\n");
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300418 referencefile = strdup(optarg);
419 break;
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +1000420 case OPTION_FLASH_NAME:
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000421 cli_classic_validate_singleop(&operation_specified);
Felix Singer2a768e42022-05-22 02:04:18 +0200422 flash_name = true;
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +1000423 break;
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000424 case OPTION_FLASH_SIZE:
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000425 cli_classic_validate_singleop(&operation_specified);
Felix Singer2a768e42022-05-22 02:04:18 +0200426 flash_size = true;
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000427 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000428 case 'L':
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000429 cli_classic_validate_singleop(&operation_specified);
Felix Singer2a768e42022-05-22 02:04:18 +0200430 list_supported = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000431 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000432 case 'z':
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000433#if CONFIG_PRINT_WIKI == 1
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000434 cli_classic_validate_singleop(&operation_specified);
Felix Singer2a768e42022-05-22 02:04:18 +0200435 list_supported_wiki = true;
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000436#else
Idwer Vollering40407b62020-12-08 00:24:39 +0100437 cli_classic_abort_usage("Error: Wiki output was not "
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000438 "compiled in. Aborting.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000439#endif
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000440 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000441 case 'p':
Thomas Heijligenacd9c942021-06-01 14:51:13 +0200442 if (prog != NULL) {
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000443 cli_classic_abort_usage("Error: --programmer specified "
Carl-Daniel Hailfinger2e681602011-09-08 00:00:29 +0000444 "more than once. You can separate "
445 "multiple\nparameters for a programmer "
446 "with \",\". Please see the man page "
447 "for details.\n");
Carl-Daniel Hailfinger2e681602011-09-08 00:00:29 +0000448 }
Thomas Heijligenacd9c942021-06-01 14:51:13 +0200449 size_t p;
450 for (p = 0; p < programmer_table_size; p++) {
451 name = programmer_table[p]->name;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000452 namelen = strlen(name);
453 if (strncmp(optarg, name, namelen) == 0) {
454 switch (optarg[namelen]) {
455 case ':':
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000456 pparam = strdup(optarg + namelen + 1);
457 if (!strlen(pparam)) {
458 free(pparam);
459 pparam = NULL;
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000460 }
Thomas Heijligenacd9c942021-06-01 14:51:13 +0200461 prog = programmer_table[p];
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000462 break;
463 case '\0':
Thomas Heijligenacd9c942021-06-01 14:51:13 +0200464 prog = programmer_table[p];
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000465 break;
466 default:
467 /* The continue refers to the
468 * for loop. It is here to be
469 * able to differentiate between
470 * foo and foobar.
471 */
472 continue;
473 }
474 break;
475 }
476 }
Thomas Heijligenacd9c942021-06-01 14:51:13 +0200477 if (prog == NULL) {
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000478 fprintf(stderr, "Error: Unknown programmer \"%s\". Valid choices are:\n",
479 optarg);
480 list_programmers_linebreak(0, 80, 0);
Stefan Taunerb226cb12012-11-24 18:59:39 +0000481 msg_ginfo(".\n");
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000482 cli_classic_abort_usage(NULL);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000483 }
484 break;
485 case 'R':
486 /* print_version() is always called during startup. */
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000487 cli_classic_validate_singleop(&operation_specified);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000488 exit(0);
489 break;
490 case 'h':
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000491 cli_classic_validate_singleop(&operation_specified);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000492 cli_classic_usage(argv[0]);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000493 exit(0);
494 break;
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000495 case 'o':
Elyes HAOUASef78de42019-07-18 15:08:10 +0200496 if (logfile) {
497 fprintf(stderr, "Warning: -o/--output specified multiple times.\n");
498 free(logfile);
499 }
500
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000501 logfile = strdup(optarg);
502 if (logfile[0] == '\0') {
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000503 cli_classic_abort_usage("No log filename specified.\n");
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000504 }
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000505 break;
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000506 default:
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000507 cli_classic_abort_usage(NULL);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000508 break;
509 }
510 }
511
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000512 if (optind < argc)
513 cli_classic_abort_usage("Error: Extra parameter found.\n");
514 if ((read_it | write_it | verify_it) && check_filename(filename, "image"))
515 cli_classic_abort_usage(NULL);
516 if (layoutfile && check_filename(layoutfile, "layout"))
517 cli_classic_abort_usage(NULL);
518 if (fmapfile && check_filename(fmapfile, "fmap"))
519 cli_classic_abort_usage(NULL);
520 if (referencefile && check_filename(referencefile, "reference"))
521 cli_classic_abort_usage(NULL);
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000522 if (logfile && check_filename(logfile, "log"))
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000523 cli_classic_abort_usage(NULL);
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000524 if (logfile && open_logfile(logfile))
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000525 cli_classic_abort_usage(NULL);
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000526
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000527#if CONFIG_PRINT_WIKI == 1
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000528 if (list_supported_wiki) {
529 print_supported_wiki();
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000530 goto out;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000531 }
532#endif
533
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000534 if (list_supported) {
Niklas Söderlundede2fa42012-10-23 13:06:46 +0000535 if (print_supported())
536 ret = 1;
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000537 goto out;
538 }
Carl-Daniel Hailfinger46284452012-01-11 02:10:11 +0000539
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000540 start_logging();
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000541
542 print_buildinfo();
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000543 msg_gdbg("Command line (%i args):", argc - 1);
544 for (i = 0; i < argc; i++) {
545 msg_gdbg(" %s", argv[i]);
546 }
547 msg_gdbg("\n");
548
Nico Huberd9b57712021-05-14 01:07:28 +0200549 if (layoutfile && layout_from_file(&layout, layoutfile)) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000550 ret = 1;
551 goto out;
552 }
Arthur Heymansc82900b2018-01-10 12:48:16 +0100553
Nico Huberd9b57712021-05-14 01:07:28 +0200554 if (!ifd && !fmap && process_include_args(layout, include_args)) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000555 ret = 1;
556 goto out;
557 }
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000558 /* Does a chip with the requested name exist in the flashchips array? */
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000559 if (chip_to_probe) {
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000560 for (chip = flashchips; chip && chip->name; chip++)
561 if (!strcmp(chip->name, chip_to_probe))
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000562 break;
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000563 if (!chip || !chip->name) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000564 msg_cerr("Error: Unknown chip '%s' specified.\n", chip_to_probe);
565 msg_gerr("Run flashrom -L to view the hardware supported in this flashrom version.\n");
566 ret = 1;
567 goto out;
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000568 }
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000569 /* Keep chip around for later usage in case a forced read is requested. */
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000570 }
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000571
Thomas Heijligenacd9c942021-06-01 14:51:13 +0200572 if (prog == NULL) {
Thomas Heijligen84e9c912021-06-01 16:22:14 +0200573 const struct programmer_entry *const default_programmer = CONFIG_DEFAULT_PROGRAMMER_NAME;
574
575 if (default_programmer) {
576 prog = default_programmer;
Stefan Tauner265fcac2014-06-02 00:12:23 +0000577 /* We need to strdup here because we free(pparam) unconditionally later. */
578 pparam = strdup(CONFIG_DEFAULT_PROGRAMMER_ARGS);
579 msg_pinfo("Using default programmer \"%s\" with arguments \"%s\".\n",
Thomas Heijligen84e9c912021-06-01 16:22:14 +0200580 default_programmer->name, pparam);
Stefan Taunerfd0d4132012-09-25 21:24:55 +0000581 } else {
582 msg_perr("Please select a programmer with the --programmer parameter.\n"
Stefan Taunerb226cb12012-11-24 18:59:39 +0000583#if CONFIG_INTERNAL == 1
584 "To choose the mainboard of this computer use 'internal'. "
585#endif
Stefan Taunerfd0d4132012-09-25 21:24:55 +0000586 "Valid choices are:\n");
587 list_programmers_linebreak(0, 80, 0);
Stefan Taunerb226cb12012-11-24 18:59:39 +0000588 msg_ginfo(".\n");
Stefan Taunerfd0d4132012-09-25 21:24:55 +0000589 ret = 1;
590 goto out;
591 }
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000592 }
Carl-Daniel Hailfinger2e681602011-09-08 00:00:29 +0000593
Thomas Heijligenacd9c942021-06-01 14:51:13 +0200594 if (programmer_init(prog, pparam)) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000595 msg_perr("Error: Programmer initialization failed.\n");
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000596 ret = 1;
597 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000598 }
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000599 tempstr = flashbuses_to_text(get_buses_supported());
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000600 msg_pdbg("The following protocols are supported: %s.\n", tempstr);
Carl-Daniel Hailfingereaacd2d2011-11-09 23:40:00 +0000601 free(tempstr);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000602
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000603 for (j = 0; j < registered_master_count; j++) {
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000604 startchip = 0;
Nico Huber519be662018-12-23 20:03:35 +0100605 while (chipcount < (int)ARRAY_SIZE(flashes)) {
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000606 startchip = probe_flash(&registered_masters[j], startchip, &flashes[chipcount], 0);
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000607 if (startchip == -1)
608 break;
609 chipcount++;
610 startchip++;
611 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000612 }
613
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000614 if (chipcount > 1) {
Stefan Tauner0554ca52013-07-25 22:54:25 +0000615 msg_cinfo("Multiple flash chip definitions match the detected chip(s): \"%s\"",
616 flashes[0].chip->name);
Stefan Tauner716e0982011-07-25 20:38:52 +0000617 for (i = 1; i < chipcount; i++)
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000618 msg_cinfo(", \"%s\"", flashes[i].chip->name);
Stefan Tauner0554ca52013-07-25 22:54:25 +0000619 msg_cinfo("\nPlease specify which chip definition to use with the -c <chipname> option.\n");
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000620 ret = 1;
621 goto out_shutdown;
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000622 } else if (!chipcount) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000623 msg_cinfo("No EEPROM/flash device found.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000624 if (!force || !chip_to_probe) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000625 msg_cinfo("Note: flashrom can never write if the flash chip isn't found "
626 "automatically.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000627 }
628 if (force && read_it && chip_to_probe) {
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000629 struct registered_master *mst;
630 int compatible_masters = 0;
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000631 msg_cinfo("Force read (-f -r -c) requested, pretending the chip is there:\n");
Carl-Daniel Hailfingerb428e972012-02-16 20:31:25 +0000632 /* This loop just counts compatible controllers. */
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000633 for (j = 0; j < registered_master_count; j++) {
634 mst = &registered_masters[j];
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000635 /* chip is still set from the chip_to_probe earlier in this function. */
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000636 if (mst->buses_supported & chip->bustype)
637 compatible_masters++;
Carl-Daniel Hailfingerb428e972012-02-16 20:31:25 +0000638 }
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000639 if (!compatible_masters) {
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000640 msg_cinfo("No compatible controller found for the requested flash chip.\n");
641 ret = 1;
642 goto out_shutdown;
643 }
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000644 if (compatible_masters > 1)
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000645 msg_cinfo("More than one compatible controller found for the requested flash "
646 "chip, using the first one.\n");
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000647 for (j = 0; j < registered_master_count; j++) {
648 mst = &registered_masters[j];
649 startchip = probe_flash(mst, 0, &flashes[0], 1);
Carl-Daniel Hailfingerb428e972012-02-16 20:31:25 +0000650 if (startchip != -1)
651 break;
652 }
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000653 if (startchip == -1) {
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000654 // FIXME: This should never happen! Ask for a bug report?
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000655 msg_cinfo("Probing for flash chip '%s' failed.\n", chip_to_probe);
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000656 ret = 1;
657 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000658 }
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000659 msg_cinfo("Please note that forced reads most likely contain garbage.\n");
Felix Singer2a768e42022-05-22 02:04:18 +0200660 flashrom_flag_set(&flashes[0], FLASHROM_FLAG_FORCE, force);
Edward O'Callaghan2d170412021-11-15 15:47:15 +1100661 ret = do_read(&flashes[0], filename);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000662 free(flashes[0].chip);
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000663 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000664 }
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000665 ret = 1;
666 goto out_shutdown;
Stefan Tauner1d947632011-09-11 22:08:58 +0000667 } else if (!chip_to_probe) {
668 /* repeat for convenience when looking at foreign logs */
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000669 tempstr = flashbuses_to_text(flashes[0].chip->bustype);
Stefan Tauner1d947632011-09-11 22:08:58 +0000670 msg_gdbg("Found %s flash chip \"%s\" (%d kB, %s).\n",
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000671 flashes[0].chip->vendor, flashes[0].chip->name, flashes[0].chip->total_size, tempstr);
Stefan Tauner1d947632011-09-11 22:08:58 +0000672 free(tempstr);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000673 }
674
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000675 fill_flash = &flashes[0];
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000676
Stefan Tauner9b32de92014-08-08 23:52:33 +0000677 print_chip_support_status(fill_flash->chip);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000678
Stefan Tauner9e3a6982014-08-15 17:17:59 +0000679 unsigned int limitexceeded = count_max_decode_exceedings(fill_flash);
680 if (limitexceeded > 0 && !force) {
681 enum chipbustype commonbuses = fill_flash->mst->buses_supported & fill_flash->chip->bustype;
682
683 /* Sometimes chip and programmer have more than one bus in common,
684 * and the limit is not exceeded on all buses. Tell the user. */
685 if ((bitcount(commonbuses) > limitexceeded)) {
686 msg_pdbg("There is at least one interface available which could support the size of\n"
687 "the selected flash chip.\n");
688 }
689 msg_cerr("This flash chip is too big for this programmer (--verbose/-V gives details).\n"
690 "Use --force/-f to override at your own risk.\n");
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000691 ret = 1;
692 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000693 }
694
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000695 if (!(read_it | write_it | verify_it | erase_it | flash_name | flash_size)) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000696 msg_ginfo("No operations were specified.\n");
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000697 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000698 }
699
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +1000700 if (flash_name) {
701 if (fill_flash->chip->vendor && fill_flash->chip->name) {
702 printf("vendor=\"%s\" name=\"%s\"\n",
703 fill_flash->chip->vendor,
704 fill_flash->chip->name);
705 } else {
706 ret = -1;
707 }
708 goto out_shutdown;
709 }
710
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000711 if (flash_size) {
Edward O'Callaghan136bf432022-02-03 14:39:29 +1100712 printf("%zu\n", flashrom_flash_getsize(fill_flash));
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000713 goto out_shutdown;
714 }
715
Nico Huberd9b57712021-05-14 01:07:28 +0200716 if (ifd && (flashrom_layout_read_from_ifd(&layout, fill_flash, NULL, 0) ||
Arthur Heymansb04fef92019-02-05 17:35:05 +0100717 process_include_args(layout, include_args))) {
Nico Huber305f4172013-06-14 11:55:26 +0200718 ret = 1;
719 goto out_shutdown;
Arthur Heymansc82900b2018-01-10 12:48:16 +0100720 } else if (fmap && fmapfile) {
721 struct stat s;
722 if (stat(fmapfile, &s) != 0) {
723 msg_gerr("Failed to stat fmapfile \"%s\"\n", fmapfile);
724 ret = 1;
725 goto out_shutdown;
726 }
727
728 size_t fmapfile_size = s.st_size;
729 uint8_t *fmapfile_buffer = malloc(fmapfile_size);
730 if (!fmapfile_buffer) {
731 ret = 1;
732 goto out_shutdown;
733 }
734
735 if (read_buf_from_file(fmapfile_buffer, fmapfile_size, fmapfile)) {
736 ret = 1;
737 free(fmapfile_buffer);
738 goto out_shutdown;
739 }
740
741 if (flashrom_layout_read_fmap_from_buffer(&layout, fill_flash, fmapfile_buffer, fmapfile_size) ||
Arthur Heymansb04fef92019-02-05 17:35:05 +0100742 process_include_args(layout, include_args)) {
Arthur Heymansc82900b2018-01-10 12:48:16 +0100743 ret = 1;
744 free(fmapfile_buffer);
745 goto out_shutdown;
746 }
747 free(fmapfile_buffer);
748 } else if (fmap && (flashrom_layout_read_fmap_from_rom(&layout, fill_flash, 0,
Edward O'Callaghan136bf432022-02-03 14:39:29 +1100749 flashrom_flash_getsize(fill_flash)) || process_include_args(layout, include_args))) {
Arthur Heymansc82900b2018-01-10 12:48:16 +0100750 ret = 1;
751 goto out_shutdown;
Nico Huber305f4172013-06-14 11:55:26 +0200752 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000753
Nico Huber305f4172013-06-14 11:55:26 +0200754 flashrom_layout_set(fill_flash, layout);
Felix Singer2a768e42022-05-22 02:04:18 +0200755 flashrom_flag_set(fill_flash, FLASHROM_FLAG_FORCE, force);
Urja Rannikko7258cf52017-06-17 11:31:57 +0300756#if CONFIG_INTERNAL == 1
Felix Singer2a768e42022-05-22 02:04:18 +0200757 flashrom_flag_set(fill_flash, FLASHROM_FLAG_FORCE_BOARDMISMATCH, force_boardmismatch);
Urja Rannikko7258cf52017-06-17 11:31:57 +0300758#endif
Nico Huber899e4ec2016-04-29 18:39:01 +0200759 flashrom_flag_set(fill_flash, FLASHROM_FLAG_VERIFY_AFTER_WRITE, !dont_verify_it);
Nico Huber99d15952016-05-02 16:54:24 +0200760 flashrom_flag_set(fill_flash, FLASHROM_FLAG_VERIFY_WHOLE_CHIP, !dont_verify_all);
Stefan Tauner4e32ec12014-08-30 23:39:51 +0000761
Carl-Daniel Hailfinger9ad42552010-09-15 10:20:16 +0000762 /* FIXME: We should issue an unconditional chip reset here. This can be
763 * done once we have a .reset function in struct flashchip.
764 * Give the chip time to settle.
765 */
766 programmer_delay(100000);
Nico Huber899e4ec2016-04-29 18:39:01 +0200767 if (read_it)
768 ret = do_read(fill_flash, filename);
Edward O'Callaghanc72d20a2021-12-13 12:30:03 +1100769 else if (erase_it) {
770 ret = flashrom_flash_erase(fill_flash);
771 /*
772 * FIXME: Do we really want the scary warning if erase failed?
773 * After all, after erase the chip is either blank or partially
774 * blank or it has the old contents. A blank chip won't boot,
775 * so if the user wanted erase and reboots afterwards, the user
776 * knows very well that booting won't work.
777 */
778 if (ret)
779 emergency_help_message();
780 }
Nico Huber899e4ec2016-04-29 18:39:01 +0200781 else if (write_it)
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300782 ret = do_write(fill_flash, filename, referencefile);
Nico Huber899e4ec2016-04-29 18:39:01 +0200783 else if (verify_it)
784 ret = do_verify(fill_flash, filename);
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000785
Nico Huber305f4172013-06-14 11:55:26 +0200786 flashrom_layout_release(layout);
787
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000788out_shutdown:
Edward O'Callaghan91eaebc2022-02-03 14:49:23 +1100789 flashrom_programmer_shutdown(NULL);
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000790out:
Nico Huber5bd990c2019-06-16 19:46:46 +0200791 for (i = 0; i < chipcount; i++) {
792 flashrom_layout_release(flashes[i].default_layout);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000793 free(flashes[i].chip);
Nico Huber5bd990c2019-06-16 19:46:46 +0200794 }
Stefan Taunerb8911d62012-12-26 07:55:00 +0000795
Nico Huber345f65a2021-05-14 01:11:08 +0200796 cleanup_include_args(&include_args);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000797 free(filename);
Richard Hughes6eca7612018-12-19 15:40:27 +0000798 free(fmapfile);
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300799 free(referencefile);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000800 free(layoutfile);
801 free(pparam);
802 /* clean up global variables */
Nico Huberbcb2e5a2012-12-30 01:23:17 +0000803 free((char *)chip_to_probe); /* Silence! Freeing is not modifying contents. */
Stefan Taunerb8911d62012-12-26 07:55:00 +0000804 chip_to_probe = NULL;
Stefan Tauner20da4aa2014-05-07 22:07:23 +0000805 free(logfile);
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000806 ret |= close_logfile();
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000807 return ret;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000808}