blob: 680fdefbe8c50e33989f45220aae39d2a8fc56ac [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 Huberc3b02dc2023-08-12 01:13:45 +020031#include "libflashprog.h"
Nico Huber34e783a2023-02-11 00:30:27 +010032#include "cli.h"
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000033
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +000034static void cli_classic_usage(const char *name)
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000035{
Stefan Taunerb226cb12012-11-24 18:59:39 +000036 printf("Usage: %s [-h|-R|-L|"
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000037#if CONFIG_PRINT_WIKI == 1
Stefan Taunerb226cb12012-11-24 18:59:39 +000038 "-z|"
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000039#endif
Edward O'Callaghan16ec45c2019-10-04 20:24:53 +100040 "\n\t-p <programmername>[:<parameters>] [-c <chipname>]\n"
41 "\t\t(--flash-name|--flash-size|\n"
42 "\t\t [-E|(-r|-w|-v) <file>]\n"
43 "\t\t [(-l <layoutfile>|--ifd| --fmap|--fmap-file <file>) [-i <imagename>]...]\n"
44 "\t\t [-n] [-N] [-f])]\n"
45 "\t[-V[V[V]]] [-o <logfile>]\n\n", name);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000046
Stefan Taunerb226cb12012-11-24 18:59:39 +000047 printf(" -h | --help print this help text\n"
48 " -R | --version print version (release)\n"
49 " -r | --read <file> read flash and save to <file>\n"
Daniel Campellod12b6bc2022-03-14 11:43:16 -060050 " -w | --write (<file>|-) write <file> or the content provided\n"
Daniel Campello8eaef7d2021-04-15 10:36:04 -060051 " on the standard input to flash\n"
Daniel Campellod12b6bc2022-03-14 11:43:16 -060052 " -v | --verify (<file>|-) verify flash against <file>\n"
Daniel Campello8eaef7d2021-04-15 10:36:04 -060053 " or the content provided on the standard input\n"
Stefan Taunerb226cb12012-11-24 18:59:39 +000054 " -E | --erase erase flash memory\n"
55 " -V | --verbose more verbose output\n"
56 " -c | --chip <chipname> probe only for specified flash chip\n"
57 " -f | --force force specific operations (see man page)\n"
58 " -n | --noverify don't auto-verify\n"
Nico Huber99d15952016-05-02 16:54:24 +020059 " -N | --noverify-all verify included regions only (cf. -i)\n"
Stefan Taunerb226cb12012-11-24 18:59:39 +000060 " -l | --layout <layoutfile> read ROM layout from <layoutfile>\n"
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +100061 " --flash-name read out the detected flash name\n"
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +100062 " --flash-size read out the detected flash size\n"
Arthur Heymansc82900b2018-01-10 12:48:16 +010063 " --fmap read ROM layout from fmap embedded in ROM\n"
64 " --fmap-file <fmapfile> read ROM layout from fmap in <fmapfile>\n"
Nico Huber305f4172013-06-14 11:55:26 +020065 " --ifd read layout from an Intel Firmware Descriptor\n"
Anastasia Klimchuka7cb7e92022-11-25 18:10:43 +110066 " -i | --include <region> only read/write image <region> from layout\n"
67 " --image <region> deprecated, please use --include\n"
Stefan Taunerb226cb12012-11-24 18:59:39 +000068 " -o | --output <logfile> log output to <logfile>\n"
Paul Kocialkowskif701f342018-01-15 01:10:36 +030069 " --flash-contents <ref-file> assume flash contents to be <ref-file>\n"
Stefan Taunerb226cb12012-11-24 18:59:39 +000070 " -L | --list-supported print supported devices\n"
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000071#if CONFIG_PRINT_WIKI == 1
Stefan Taunerb226cb12012-11-24 18:59:39 +000072 " -z | --list-supported-wiki print supported devices in wiki syntax\n"
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000073#endif
Richard Hughes842d6782021-01-15 09:48:12 +000074 " --progress show progress percentage on the standard output\n"
Stefan Taunerb226cb12012-11-24 18:59:39 +000075 " -p | --programmer <name>[:<param>] specify the programmer device. One of\n");
76 list_programmers_linebreak(4, 80, 0);
77 printf(".\n\nYou can specify one of -h, -R, -L, "
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000078#if CONFIG_PRINT_WIKI == 1
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000079 "-z, "
80#endif
81 "-E, -r, -w, -v or no operation.\n"
Nico Huberc3b02dc2023-08-12 01:13:45 +020082 "If no operation is specified, flashprog will only probe for flash chips.\n");
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000083}
84
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +100085static void cli_classic_abort_usage(const char *msg)
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000086{
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +100087 if (msg)
88 fprintf(stderr, "%s", msg);
Nico Huberc3b02dc2023-08-12 01:13:45 +020089 printf("Please run \"flashprog --help\" for usage info.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +000090 exit(1);
91}
92
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +100093static void cli_classic_validate_singleop(int *operation_specified)
94{
95 if (++(*operation_specified) > 1) {
96 cli_classic_abort_usage("More than one operation specified. Aborting.\n");
97 }
98}
99
Jacob Garber4a84ec22019-07-25 19:12:31 -0600100static int check_filename(char *filename, const char *type)
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000101{
102 if (!filename || (filename[0] == '\0')) {
103 fprintf(stderr, "Error: No %s file specified.\n", type);
104 return 1;
105 }
106 /* 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 -0600107 if (filename[0] == '-' && filename[1] != '\0')
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000108 fprintf(stderr, "Warning: Supplied %s file name starts with -\n", type);
109 return 0;
110}
111
Jack Rosenthal85777562021-04-09 10:03:14 -0600112/* Ensure a file is open by means of fstat */
113static bool check_file(FILE *file)
114{
Jack Rosenthal85777562021-04-09 10:03:14 -0600115 struct stat statbuf;
116
117 if (fstat(fileno(file), &statbuf) < 0)
118 return false;
Jack Rosenthal85777562021-04-09 10:03:14 -0600119 return true;
120}
121
Edward O'Callaghan98cfa692021-12-13 12:46:12 +1100122static int do_read(struct flashctx *const flash, const char *const filename)
123{
124 int ret;
125
Nico Huberc3b02dc2023-08-12 01:13:45 +0200126 unsigned long size = flashprog_flash_getsize(flash);
Edward O'Callaghan98cfa692021-12-13 12:46:12 +1100127 unsigned char *buf = calloc(size, sizeof(unsigned char));
128 if (!buf) {
129 msg_gerr("Memory allocation failed!\n");
130 return 1;
131 }
132
Nico Huberc3b02dc2023-08-12 01:13:45 +0200133 ret = flashprog_image_read(flash, buf, size);
Edward O'Callaghan98cfa692021-12-13 12:46:12 +1100134 if (ret > 0)
135 goto free_out;
136
137 ret = write_buf_to_file(buf, size, filename);
138
139free_out:
140 free(buf);
141 return ret;
142}
143
144static int do_write(struct flashctx *const flash, const char *const filename, const char *const referencefile)
145{
Nico Huberc3b02dc2023-08-12 01:13:45 +0200146 const size_t flash_size = flashprog_flash_getsize(flash);
Edward O'Callaghan98cfa692021-12-13 12:46:12 +1100147 int ret = 1;
148
149 uint8_t *const newcontents = malloc(flash_size);
150 uint8_t *const refcontents = referencefile ? malloc(flash_size) : NULL;
151
152 if (!newcontents || (referencefile && !refcontents)) {
153 msg_gerr("Out of memory!\n");
154 goto _free_ret;
155 }
156
157 if (read_buf_from_file(newcontents, flash_size, filename))
158 goto _free_ret;
159
160 if (referencefile) {
161 if (read_buf_from_file(refcontents, flash_size, referencefile))
162 goto _free_ret;
163 }
164
Nico Huberc3b02dc2023-08-12 01:13:45 +0200165 ret = flashprog_image_write(flash, newcontents, flash_size, refcontents);
Edward O'Callaghan98cfa692021-12-13 12:46:12 +1100166
167_free_ret:
168 free(refcontents);
169 free(newcontents);
170 return ret;
171}
172
173static int do_verify(struct flashctx *const flash, const char *const filename)
174{
Nico Huberc3b02dc2023-08-12 01:13:45 +0200175 const size_t flash_size = flashprog_flash_getsize(flash);
Edward O'Callaghan98cfa692021-12-13 12:46:12 +1100176 int ret = 1;
177
178 uint8_t *const newcontents = malloc(flash_size);
179 if (!newcontents) {
180 msg_gerr("Out of memory!\n");
181 goto _free_ret;
182 }
183
184 if (read_buf_from_file(newcontents, flash_size, filename))
185 goto _free_ret;
186
Nico Huberc3b02dc2023-08-12 01:13:45 +0200187 ret = flashprog_image_verify(flash, newcontents, flash_size);
Edward O'Callaghan98cfa692021-12-13 12:46:12 +1100188
189_free_ret:
190 free(newcontents);
191 return ret;
192}
193
Nico Huber89569d62023-01-12 23:31:40 +0100194/* Returns true if the flash chip cannot be completely accessed due to size/address limits of the programmer. */
195static bool max_decode_exceeded(const struct registered_master *const mst, const struct flashctx *const flash)
Edward O'Callaghanaba36582022-09-05 11:09:28 +1000196{
Nico Huber89569d62023-01-12 23:31:40 +0100197 if (flashprog_flash_getsize(flash) <= mst->max_rom_decode)
198 return false;
Edward O'Callaghanaba36582022-09-05 11:09:28 +1000199
Nico Huber89569d62023-01-12 23:31:40 +0100200 msg_pdbg("Chip size %u kB is bigger than supported size %zu kB of\n"
201 "chipset/board/programmer for memory-mapped interface, probe/read/erase/write\n"
202 "may fail.\n", flash->chip->total_size, mst->max_rom_decode / KiB);
203 return true;
Edward O'Callaghanaba36582022-09-05 11:09:28 +1000204}
205
Uwe Hermann394ee782011-08-20 14:14:22 +0000206int main(int argc, char *argv[])
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000207{
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000208 const struct flashchip *chip = NULL;
Jernej Å krabece814a9b2014-12-12 00:32:03 +0000209 /* Probe for up to eight flash chips. */
210 struct flashctx flashes[8] = {{0}};
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000211 struct flashctx *fill_flash;
Nico Hubere68b08b2023-02-11 00:00:54 +0100212 int opt, i, j;
Felix Singer2a768e42022-05-22 02:04:18 +0200213 int startchip = -1, chipcount = 0, option_index = 0;
214 int operation_specified = 0;
215 bool force = false, ifd = false, fmap = false;
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000216#if CONFIG_PRINT_WIKI == 1
Felix Singer2a768e42022-05-22 02:04:18 +0200217 bool list_supported_wiki = false;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000218#endif
Felix Singer2a768e42022-05-22 02:04:18 +0200219 bool flash_name = false, flash_size = false;
220 bool read_it = false, write_it = false, erase_it = false, verify_it = false;
221 bool dont_verify_it = false, dont_verify_all = false;
222 bool list_supported = false;
Richard Hughes842d6782021-01-15 09:48:12 +0000223 bool show_progress = false;
Nico Huberc3b02dc2023-08-12 01:13:45 +0200224 struct flashprog_layout *layout = NULL;
Nico Hubere68b08b2023-02-11 00:00:54 +0100225 struct flashprog_programmer *prog = NULL;
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000226 int ret = 0;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000227
Nico Huber99d15952016-05-02 16:54:24 +0200228 static const char optstring[] = "r:Rw:v:nNVEfc:l:i:p:Lzho:";
Mathias Krausea60faab2011-01-17 07:50:42 +0000229 static const struct option long_options[] = {
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000230 {"read", 1, NULL, 'r'},
231 {"write", 1, NULL, 'w'},
232 {"erase", 0, NULL, 'E'},
233 {"verify", 1, NULL, 'v'},
234 {"noverify", 0, NULL, 'n'},
Nico Huber99d15952016-05-02 16:54:24 +0200235 {"noverify-all", 0, NULL, 'N'},
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000236 {"chip", 1, NULL, 'c'},
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000237 {"verbose", 0, NULL, 'V'},
238 {"force", 0, NULL, 'f'},
239 {"layout", 1, NULL, 'l'},
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300240 {"ifd", 0, NULL, OPTION_IFD},
Arthur Heymansc82900b2018-01-10 12:48:16 +0100241 {"fmap", 0, NULL, OPTION_FMAP},
242 {"fmap-file", 1, NULL, OPTION_FMAP_FILE},
Anastasia Klimchuka7cb7e92022-11-25 18:10:43 +1100243 {"image", 1, NULL, 'i'}, // (deprecated): back compatibility.
244 {"include", 1, NULL, 'i'},
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300245 {"flash-contents", 1, NULL, OPTION_FLASH_CONTENTS},
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +1000246 {"flash-name", 0, NULL, OPTION_FLASH_NAME},
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000247 {"flash-size", 0, NULL, OPTION_FLASH_SIZE},
248 {"get-size", 0, NULL, OPTION_FLASH_SIZE}, // (deprecated): back compatibility.
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000249 {"list-supported", 0, NULL, 'L'},
250 {"list-supported-wiki", 0, NULL, 'z'},
251 {"programmer", 1, NULL, 'p'},
252 {"help", 0, NULL, 'h'},
253 {"version", 0, NULL, 'R'},
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000254 {"output", 1, NULL, 'o'},
Richard Hughes842d6782021-01-15 09:48:12 +0000255 {"progress", 0, NULL, OPTION_PROGRESS},
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000256 {NULL, 0, NULL, 0},
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000257 };
258
259 char *filename = NULL;
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300260 char *referencefile = NULL;
Carl-Daniel Hailfinger46284452012-01-11 02:10:11 +0000261 char *layoutfile = NULL;
Arthur Heymansc82900b2018-01-10 12:48:16 +0100262 char *fmapfile = NULL;
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000263 char *logfile = NULL;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000264 char *tempstr = NULL;
Nico Huber34e783a2023-02-11 00:30:27 +0100265 struct flash_args flash_args = { 0 };
Arthur Heymansb04fef92019-02-05 17:35:05 +0100266 struct layout_include_args *include_args = NULL;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000267
Jack Rosenthal85777562021-04-09 10:03:14 -0600268 /*
269 * Safety-guard against a user who has (mistakenly) closed
Nico Huberc3b02dc2023-08-12 01:13:45 +0200270 * stdout or stderr before exec'ing flashprog. We disable
Jack Rosenthal85777562021-04-09 10:03:14 -0600271 * logging in this case to prevent writing log data to a flash
272 * chip when a flash device gets opened with fd 1 or 2.
273 */
274 if (check_file(stdout) && check_file(stderr)) {
Nico Huberc3b02dc2023-08-12 01:13:45 +0200275 flashprog_set_log_callback(
276 (flashprog_log_callback *)&flashprog_print_cb);
Jack Rosenthal85777562021-04-09 10:03:14 -0600277 }
Nico Huber18781102012-12-10 13:34:12 +0000278
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000279 print_version();
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000280 print_banner();
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000281
Edward O'Callaghand58496b2022-02-03 12:52:02 +1100282 /* FIXME: Delay calibration should happen in programmer code. */
Nico Huberc3b02dc2023-08-12 01:13:45 +0200283 if (flashprog_init(1))
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000284 exit(1);
285
286 setbuf(stdout, NULL);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000287 /* FIXME: Delay all operation_specified checks until after command
288 * line parsing to allow --help overriding everything else.
289 */
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000290 while ((opt = getopt_long(argc, argv, optstring,
291 long_options, &option_index)) != EOF) {
292 switch (opt) {
293 case 'r':
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000294 cli_classic_validate_singleop(&operation_specified);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000295 filename = strdup(optarg);
Felix Singer2a768e42022-05-22 02:04:18 +0200296 read_it = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000297 break;
298 case 'w':
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000299 cli_classic_validate_singleop(&operation_specified);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000300 filename = strdup(optarg);
Felix Singer2a768e42022-05-22 02:04:18 +0200301 write_it = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000302 break;
303 case 'v':
304 //FIXME: gracefully handle superfluous -v
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000305 cli_classic_validate_singleop(&operation_specified);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000306 if (dont_verify_it) {
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000307 cli_classic_abort_usage("--verify and --noverify are mutually exclusive. Aborting.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000308 }
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000309 filename = strdup(optarg);
Felix Singer2a768e42022-05-22 02:04:18 +0200310 verify_it = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000311 break;
312 case 'n':
313 if (verify_it) {
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000314 cli_classic_abort_usage("--verify and --noverify are mutually exclusive. Aborting.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000315 }
Felix Singer2a768e42022-05-22 02:04:18 +0200316 dont_verify_it = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000317 break;
Nico Huber99d15952016-05-02 16:54:24 +0200318 case 'N':
Felix Singer2a768e42022-05-22 02:04:18 +0200319 dont_verify_all = true;
Nico Huber99d15952016-05-02 16:54:24 +0200320 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000321 case 'c':
Nico Huber34e783a2023-02-11 00:30:27 +0100322 case 'p':
323 ret = cli_parse_flash_args(&flash_args, opt, optarg);
324 if (ret == 1)
325 cli_classic_abort_usage(NULL);
326 else if (ret)
327 exit(1);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000328 break;
329 case 'V':
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000330 verbose_screen++;
Nico Huberc3b02dc2023-08-12 01:13:45 +0200331 if (verbose_screen > FLASHPROG_MSG_DEBUG2)
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000332 verbose_logfile = verbose_screen;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000333 break;
334 case 'E':
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000335 cli_classic_validate_singleop(&operation_specified);
Felix Singer2a768e42022-05-22 02:04:18 +0200336 erase_it = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000337 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000338 case 'f':
Felix Singer2a768e42022-05-22 02:04:18 +0200339 force = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000340 break;
341 case 'l':
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000342 if (layoutfile)
343 cli_classic_abort_usage("Error: --layout specified more than once. Aborting.\n");
344 if (ifd)
345 cli_classic_abort_usage("Error: --layout and --ifd both specified. Aborting.\n");
346 if (fmap)
347 cli_classic_abort_usage("Error: --layout and --fmap-file both specified. Aborting.\n");
Carl-Daniel Hailfinger46284452012-01-11 02:10:11 +0000348 layoutfile = strdup(optarg);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000349 break;
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300350 case OPTION_IFD:
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000351 if (layoutfile)
352 cli_classic_abort_usage("Error: --layout and --ifd both specified. Aborting.\n");
353 if (fmap)
354 cli_classic_abort_usage("Error: --fmap-file and --ifd both specified. Aborting.\n");
Felix Singer2a768e42022-05-22 02:04:18 +0200355 ifd = true;
Nico Huber305f4172013-06-14 11:55:26 +0200356 break;
Arthur Heymansc82900b2018-01-10 12:48:16 +0100357 case OPTION_FMAP_FILE:
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000358 if (fmap)
359 cli_classic_abort_usage("Error: --fmap or --fmap-file specified "
Arthur Heymansc82900b2018-01-10 12:48:16 +0100360 "more than once. Aborting.\n");
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000361 if (ifd)
362 cli_classic_abort_usage("Error: --fmap-file and --ifd both specified. Aborting.\n");
363 if (layoutfile)
364 cli_classic_abort_usage("Error: --fmap-file and --layout both specified. Aborting.\n");
Arthur Heymansc82900b2018-01-10 12:48:16 +0100365 fmapfile = strdup(optarg);
Felix Singer2a768e42022-05-22 02:04:18 +0200366 fmap = true;
Arthur Heymansc82900b2018-01-10 12:48:16 +0100367 break;
368 case OPTION_FMAP:
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000369 if (fmap)
370 cli_classic_abort_usage("Error: --fmap or --fmap-file specified "
Arthur Heymansc82900b2018-01-10 12:48:16 +0100371 "more than once. Aborting.\n");
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000372 if (ifd)
373 cli_classic_abort_usage("Error: --fmap and --ifd both specified. Aborting.\n");
374 if (layoutfile)
375 cli_classic_abort_usage("Error: --layout and --fmap both specified. Aborting.\n");
Felix Singer2a768e42022-05-22 02:04:18 +0200376 fmap = true;
Arthur Heymansc82900b2018-01-10 12:48:16 +0100377 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000378 case 'i':
379 tempstr = strdup(optarg);
Arthur Heymansb04fef92019-02-05 17:35:05 +0100380 if (register_include_arg(&include_args, tempstr)) {
Stefan Taunerb8911d62012-12-26 07:55:00 +0000381 free(tempstr);
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000382 cli_classic_abort_usage(NULL);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000383 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000384 break;
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300385 case OPTION_FLASH_CONTENTS:
Angel Ponsa60f6412020-03-31 15:02:02 +0200386 if (referencefile)
387 cli_classic_abort_usage("Error: --flash-contents specified more than once."
388 "Aborting.\n");
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300389 referencefile = strdup(optarg);
390 break;
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +1000391 case OPTION_FLASH_NAME:
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000392 cli_classic_validate_singleop(&operation_specified);
Felix Singer2a768e42022-05-22 02:04:18 +0200393 flash_name = true;
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +1000394 break;
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000395 case OPTION_FLASH_SIZE:
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000396 cli_classic_validate_singleop(&operation_specified);
Felix Singer2a768e42022-05-22 02:04:18 +0200397 flash_size = true;
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000398 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000399 case 'L':
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000400 cli_classic_validate_singleop(&operation_specified);
Felix Singer2a768e42022-05-22 02:04:18 +0200401 list_supported = true;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000402 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000403 case 'z':
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000404#if CONFIG_PRINT_WIKI == 1
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000405 cli_classic_validate_singleop(&operation_specified);
Felix Singer2a768e42022-05-22 02:04:18 +0200406 list_supported_wiki = true;
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000407#else
Idwer Vollering40407b62020-12-08 00:24:39 +0100408 cli_classic_abort_usage("Error: Wiki output was not "
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000409 "compiled in. Aborting.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000410#endif
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000411 break;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000412 case 'R':
413 /* print_version() is always called during startup. */
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000414 cli_classic_validate_singleop(&operation_specified);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000415 exit(0);
416 break;
417 case 'h':
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000418 cli_classic_validate_singleop(&operation_specified);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000419 cli_classic_usage(argv[0]);
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000420 exit(0);
421 break;
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000422 case 'o':
Elyes HAOUASef78de42019-07-18 15:08:10 +0200423 if (logfile) {
424 fprintf(stderr, "Warning: -o/--output specified multiple times.\n");
425 free(logfile);
426 }
427
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000428 logfile = strdup(optarg);
429 if (logfile[0] == '\0') {
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000430 cli_classic_abort_usage("No log filename specified.\n");
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000431 }
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000432 break;
Richard Hughes842d6782021-01-15 09:48:12 +0000433 case OPTION_PROGRESS:
434 show_progress = true;
435 break;
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000436 default:
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000437 cli_classic_abort_usage(NULL);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000438 break;
439 }
440 }
441
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000442 if (optind < argc)
443 cli_classic_abort_usage("Error: Extra parameter found.\n");
444 if ((read_it | write_it | verify_it) && check_filename(filename, "image"))
445 cli_classic_abort_usage(NULL);
446 if (layoutfile && check_filename(layoutfile, "layout"))
447 cli_classic_abort_usage(NULL);
448 if (fmapfile && check_filename(fmapfile, "fmap"))
449 cli_classic_abort_usage(NULL);
450 if (referencefile && check_filename(referencefile, "reference"))
451 cli_classic_abort_usage(NULL);
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000452 if (logfile && check_filename(logfile, "log"))
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000453 cli_classic_abort_usage(NULL);
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000454 if (logfile && open_logfile(logfile))
Edward O'Callaghan8b60fc72019-09-26 11:17:20 +1000455 cli_classic_abort_usage(NULL);
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000456
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000457#if CONFIG_PRINT_WIKI == 1
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000458 if (list_supported_wiki) {
459 print_supported_wiki();
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000460 goto out;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000461 }
462#endif
463
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000464 if (list_supported) {
Niklas Söderlundede2fa42012-10-23 13:06:46 +0000465 if (print_supported())
466 ret = 1;
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000467 goto out;
468 }
Carl-Daniel Hailfinger46284452012-01-11 02:10:11 +0000469
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000470 start_logging();
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000471
472 print_buildinfo();
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000473 msg_gdbg("Command line (%i args):", argc - 1);
474 for (i = 0; i < argc; i++) {
475 msg_gdbg(" %s", argv[i]);
476 }
477 msg_gdbg("\n");
478
Nico Huberd9b57712021-05-14 01:07:28 +0200479 if (layoutfile && layout_from_file(&layout, layoutfile)) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000480 ret = 1;
481 goto out;
482 }
Arthur Heymansc82900b2018-01-10 12:48:16 +0100483
Nico Huberd9b57712021-05-14 01:07:28 +0200484 if (!ifd && !fmap && process_include_args(layout, include_args)) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000485 ret = 1;
486 goto out;
487 }
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000488 /* Does a chip with the requested name exist in the flashchips array? */
Nico Huber34e783a2023-02-11 00:30:27 +0100489 if (flash_args.chip) {
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000490 for (chip = flashchips; chip && chip->name; chip++)
Nico Huber34e783a2023-02-11 00:30:27 +0100491 if (!strcmp(chip->name, flash_args.chip))
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000492 break;
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000493 if (!chip || !chip->name) {
Nico Huber34e783a2023-02-11 00:30:27 +0100494 msg_cerr("Error: Unknown chip '%s' specified.\n", flash_args.chip);
Nico Huberc3b02dc2023-08-12 01:13:45 +0200495 msg_gerr("Run flashprog -L to view the hardware supported in this flashprog version.\n");
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000496 ret = 1;
497 goto out;
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000498 }
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000499 /* Keep chip around for later usage in case a forced read is requested. */
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000500 }
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000501
Nico Huber34e783a2023-02-11 00:30:27 +0100502 if (flash_args.prog_name == NULL) {
Nico Hubere68b08b2023-02-11 00:00:54 +0100503 const char *const default_programmer = CONFIG_DEFAULT_PROGRAMMER_NAME;
Thomas Heijligen84e9c912021-06-01 16:22:14 +0200504
Nico Hubere68b08b2023-02-11 00:00:54 +0100505 if (default_programmer[0]) {
506 /* We need to strdup here because we free() unconditionally later. */
Nico Huber34e783a2023-02-11 00:30:27 +0100507 flash_args.prog_name = strdup(default_programmer);
508 flash_args.prog_args = strdup(CONFIG_DEFAULT_PROGRAMMER_ARGS);
509 if (!flash_args.prog_name || !flash_args.prog_args) {
Nico Hubere68b08b2023-02-11 00:00:54 +0100510 fprintf(stderr, "Out of memory!\n");
511 ret = 1;
512 goto out;
513 }
Stefan Tauner265fcac2014-06-02 00:12:23 +0000514 msg_pinfo("Using default programmer \"%s\" with arguments \"%s\".\n",
Nico Huber34e783a2023-02-11 00:30:27 +0100515 flash_args.prog_name, flash_args.prog_args);
Stefan Taunerfd0d4132012-09-25 21:24:55 +0000516 } else {
517 msg_perr("Please select a programmer with the --programmer parameter.\n"
Stefan Taunerb226cb12012-11-24 18:59:39 +0000518#if CONFIG_INTERNAL == 1
519 "To choose the mainboard of this computer use 'internal'. "
520#endif
Stefan Taunerfd0d4132012-09-25 21:24:55 +0000521 "Valid choices are:\n");
522 list_programmers_linebreak(0, 80, 0);
Stefan Taunerb226cb12012-11-24 18:59:39 +0000523 msg_ginfo(".\n");
Stefan Taunerfd0d4132012-09-25 21:24:55 +0000524 ret = 1;
525 goto out;
526 }
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000527 }
Carl-Daniel Hailfinger2e681602011-09-08 00:00:29 +0000528
Nico Huber34e783a2023-02-11 00:30:27 +0100529 if (flashprog_programmer_init(&prog, flash_args.prog_name, flash_args.prog_args)) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000530 msg_perr("Error: Programmer initialization failed.\n");
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000531 ret = 1;
Nico Huber2b66ad92023-01-11 20:15:15 +0100532 goto out;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000533 }
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000534 tempstr = flashbuses_to_text(get_buses_supported());
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000535 msg_pdbg("The following protocols are supported: %s.\n", tempstr);
Carl-Daniel Hailfingereaacd2d2011-11-09 23:40:00 +0000536 free(tempstr);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000537
Nico Huber34e783a2023-02-11 00:30:27 +0100538 chip_to_probe = flash_args.chip;
Nico Huber89569d62023-01-12 23:31:40 +0100539 struct registered_master *matched_master = NULL;
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000540 for (j = 0; j < registered_master_count; j++) {
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000541 startchip = 0;
Nico Huber519be662018-12-23 20:03:35 +0100542 while (chipcount < (int)ARRAY_SIZE(flashes)) {
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000543 startchip = probe_flash(&registered_masters[j], startchip, &flashes[chipcount], 0);
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000544 if (startchip == -1)
545 break;
Nico Huber89569d62023-01-12 23:31:40 +0100546 if (chipcount == 0)
547 matched_master = &registered_masters[j];
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000548 chipcount++;
549 startchip++;
550 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000551 }
552
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000553 if (chipcount > 1) {
Stefan Tauner0554ca52013-07-25 22:54:25 +0000554 msg_cinfo("Multiple flash chip definitions match the detected chip(s): \"%s\"",
555 flashes[0].chip->name);
Stefan Tauner716e0982011-07-25 20:38:52 +0000556 for (i = 1; i < chipcount; i++)
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000557 msg_cinfo(", \"%s\"", flashes[i].chip->name);
Stefan Tauner0554ca52013-07-25 22:54:25 +0000558 msg_cinfo("\nPlease specify which chip definition to use with the -c <chipname> option.\n");
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000559 ret = 1;
560 goto out_shutdown;
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000561 } else if (!chipcount) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000562 msg_cinfo("No EEPROM/flash device found.\n");
Nico Huber34e783a2023-02-11 00:30:27 +0100563 if (!force || !flash_args.chip) {
Nico Huberc3b02dc2023-08-12 01:13:45 +0200564 msg_cinfo("Note: flashprog can never write if the flash chip isn't found "
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000565 "automatically.\n");
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000566 }
Nico Huber34e783a2023-02-11 00:30:27 +0100567 if (force && read_it && flash_args.chip) {
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000568 struct registered_master *mst;
569 int compatible_masters = 0;
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000570 msg_cinfo("Force read (-f -r -c) requested, pretending the chip is there:\n");
Carl-Daniel Hailfingerb428e972012-02-16 20:31:25 +0000571 /* This loop just counts compatible controllers. */
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000572 for (j = 0; j < registered_master_count; j++) {
573 mst = &registered_masters[j];
Nico Huber34e783a2023-02-11 00:30:27 +0100574 /* chip is still set from the search earlier in this function. */
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000575 if (mst->buses_supported & chip->bustype)
576 compatible_masters++;
Carl-Daniel Hailfingerb428e972012-02-16 20:31:25 +0000577 }
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000578 if (!compatible_masters) {
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000579 msg_cinfo("No compatible controller found for the requested flash chip.\n");
580 ret = 1;
581 goto out_shutdown;
582 }
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000583 if (compatible_masters > 1)
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000584 msg_cinfo("More than one compatible controller found for the requested flash "
585 "chip, using the first one.\n");
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000586 for (j = 0; j < registered_master_count; j++) {
587 mst = &registered_masters[j];
588 startchip = probe_flash(mst, 0, &flashes[0], 1);
Carl-Daniel Hailfingerb428e972012-02-16 20:31:25 +0000589 if (startchip != -1)
590 break;
591 }
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000592 if (startchip == -1) {
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000593 // FIXME: This should never happen! Ask for a bug report?
Nico Huber34e783a2023-02-11 00:30:27 +0100594 msg_cinfo("Probing for flash chip '%s' failed.\n", flash_args.chip);
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000595 ret = 1;
596 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000597 }
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000598 msg_cinfo("Please note that forced reads most likely contain garbage.\n");
Nico Huberc3b02dc2023-08-12 01:13:45 +0200599 flashprog_flag_set(&flashes[0], FLASHPROG_FLAG_FORCE, force);
Edward O'Callaghan2d170412021-11-15 15:47:15 +1100600 ret = do_read(&flashes[0], filename);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000601 free(flashes[0].chip);
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000602 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000603 }
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000604 ret = 1;
605 goto out_shutdown;
Nico Huber34e783a2023-02-11 00:30:27 +0100606 } else if (!flash_args.chip) {
Stefan Tauner1d947632011-09-11 22:08:58 +0000607 /* repeat for convenience when looking at foreign logs */
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000608 tempstr = flashbuses_to_text(flashes[0].chip->bustype);
Stefan Tauner1d947632011-09-11 22:08:58 +0000609 msg_gdbg("Found %s flash chip \"%s\" (%d kB, %s).\n",
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000610 flashes[0].chip->vendor, flashes[0].chip->name, flashes[0].chip->total_size, tempstr);
Stefan Tauner1d947632011-09-11 22:08:58 +0000611 free(tempstr);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000612 }
613
Carl-Daniel Hailfinger4c823182011-05-04 00:39:50 +0000614 fill_flash = &flashes[0];
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000615
Richard Hughes842d6782021-01-15 09:48:12 +0000616 if (show_progress)
617 flashprog_set_progress_callback(fill_flash, &flashprog_progress_cb, NULL);
618
Stefan Tauner9b32de92014-08-08 23:52:33 +0000619 print_chip_support_status(fill_flash->chip);
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000620
Nico Huber89569d62023-01-12 23:31:40 +0100621 if (max_decode_exceeded(matched_master, fill_flash) && !force) {
Stefan Tauner9e3a6982014-08-15 17:17:59 +0000622 msg_cerr("This flash chip is too big for this programmer (--verbose/-V gives details).\n"
623 "Use --force/-f to override at your own risk.\n");
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000624 ret = 1;
625 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000626 }
627
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000628 if (!(read_it | write_it | verify_it | erase_it | flash_name | flash_size)) {
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000629 msg_ginfo("No operations were specified.\n");
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000630 goto out_shutdown;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000631 }
632
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +1000633 if (flash_name) {
634 if (fill_flash->chip->vendor && fill_flash->chip->name) {
635 printf("vendor=\"%s\" name=\"%s\"\n",
636 fill_flash->chip->vendor,
637 fill_flash->chip->name);
638 } else {
639 ret = -1;
640 }
641 goto out_shutdown;
642 }
643
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000644 if (flash_size) {
Nico Huberc3b02dc2023-08-12 01:13:45 +0200645 printf("%zu\n", flashprog_flash_getsize(fill_flash));
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000646 goto out_shutdown;
647 }
648
Nico Huberc3b02dc2023-08-12 01:13:45 +0200649 if (ifd && (flashprog_layout_read_from_ifd(&layout, fill_flash, NULL, 0) ||
Arthur Heymansb04fef92019-02-05 17:35:05 +0100650 process_include_args(layout, include_args))) {
Nico Huber305f4172013-06-14 11:55:26 +0200651 ret = 1;
652 goto out_shutdown;
Arthur Heymansc82900b2018-01-10 12:48:16 +0100653 } else if (fmap && fmapfile) {
654 struct stat s;
655 if (stat(fmapfile, &s) != 0) {
656 msg_gerr("Failed to stat fmapfile \"%s\"\n", fmapfile);
657 ret = 1;
658 goto out_shutdown;
659 }
660
661 size_t fmapfile_size = s.st_size;
662 uint8_t *fmapfile_buffer = malloc(fmapfile_size);
663 if (!fmapfile_buffer) {
664 ret = 1;
665 goto out_shutdown;
666 }
667
668 if (read_buf_from_file(fmapfile_buffer, fmapfile_size, fmapfile)) {
669 ret = 1;
670 free(fmapfile_buffer);
671 goto out_shutdown;
672 }
673
Nico Huberc3b02dc2023-08-12 01:13:45 +0200674 if (flashprog_layout_read_fmap_from_buffer(&layout, fill_flash, fmapfile_buffer, fmapfile_size) ||
Arthur Heymansb04fef92019-02-05 17:35:05 +0100675 process_include_args(layout, include_args)) {
Arthur Heymansc82900b2018-01-10 12:48:16 +0100676 ret = 1;
677 free(fmapfile_buffer);
678 goto out_shutdown;
679 }
680 free(fmapfile_buffer);
Nico Huberc3b02dc2023-08-12 01:13:45 +0200681 } else if (fmap && (flashprog_layout_read_fmap_from_rom(&layout, fill_flash, 0,
682 flashprog_flash_getsize(fill_flash)) || process_include_args(layout, include_args))) {
Arthur Heymansc82900b2018-01-10 12:48:16 +0100683 ret = 1;
684 goto out_shutdown;
Nico Huber305f4172013-06-14 11:55:26 +0200685 }
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000686
Nico Huberc3b02dc2023-08-12 01:13:45 +0200687 flashprog_layout_set(fill_flash, layout);
688 flashprog_flag_set(fill_flash, FLASHPROG_FLAG_FORCE, force);
Urja Rannikko7258cf52017-06-17 11:31:57 +0300689#if CONFIG_INTERNAL == 1
Nico Huberc3b02dc2023-08-12 01:13:45 +0200690 flashprog_flag_set(fill_flash, FLASHPROG_FLAG_FORCE_BOARDMISMATCH, force_boardmismatch);
Urja Rannikko7258cf52017-06-17 11:31:57 +0300691#endif
Nico Huberc3b02dc2023-08-12 01:13:45 +0200692 flashprog_flag_set(fill_flash, FLASHPROG_FLAG_VERIFY_AFTER_WRITE, !dont_verify_it);
693 flashprog_flag_set(fill_flash, FLASHPROG_FLAG_VERIFY_WHOLE_CHIP, !dont_verify_all);
Stefan Tauner4e32ec12014-08-30 23:39:51 +0000694
Carl-Daniel Hailfinger9ad42552010-09-15 10:20:16 +0000695 /* FIXME: We should issue an unconditional chip reset here. This can be
696 * done once we have a .reset function in struct flashchip.
697 * Give the chip time to settle.
698 */
699 programmer_delay(100000);
Nico Huber899e4ec2016-04-29 18:39:01 +0200700 if (read_it)
701 ret = do_read(fill_flash, filename);
Edward O'Callaghanc72d20a2021-12-13 12:30:03 +1100702 else if (erase_it) {
Nico Huberc3b02dc2023-08-12 01:13:45 +0200703 ret = flashprog_flash_erase(fill_flash);
Edward O'Callaghanc72d20a2021-12-13 12:30:03 +1100704 /*
705 * FIXME: Do we really want the scary warning if erase failed?
706 * After all, after erase the chip is either blank or partially
707 * blank or it has the old contents. A blank chip won't boot,
708 * so if the user wanted erase and reboots afterwards, the user
709 * knows very well that booting won't work.
710 */
711 if (ret)
712 emergency_help_message();
713 }
Nico Huber899e4ec2016-04-29 18:39:01 +0200714 else if (write_it)
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300715 ret = do_write(fill_flash, filename, referencefile);
Nico Huber899e4ec2016-04-29 18:39:01 +0200716 else if (verify_it)
717 ret = do_verify(fill_flash, filename);
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000718
Nico Huberc3b02dc2023-08-12 01:13:45 +0200719 flashprog_layout_release(layout);
Nico Huber305f4172013-06-14 11:55:26 +0200720
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000721out_shutdown:
Nico Hubere68b08b2023-02-11 00:00:54 +0100722 flashprog_programmer_shutdown(prog);
Carl-Daniel Hailfinger901a3ba2012-05-14 22:54:58 +0000723out:
Nico Huber5bd990c2019-06-16 19:46:46 +0200724 for (i = 0; i < chipcount; i++) {
Nico Huberc3b02dc2023-08-12 01:13:45 +0200725 flashprog_layout_release(flashes[i].default_layout);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000726 free(flashes[i].chip);
Nico Huber5bd990c2019-06-16 19:46:46 +0200727 }
Stefan Taunerb8911d62012-12-26 07:55:00 +0000728
Nico Huber345f65a2021-05-14 01:11:08 +0200729 cleanup_include_args(&include_args);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000730 free(filename);
Richard Hughes6eca7612018-12-19 15:40:27 +0000731 free(fmapfile);
Paul Kocialkowskif701f342018-01-15 01:10:36 +0300732 free(referencefile);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000733 free(layoutfile);
Nico Huber34e783a2023-02-11 00:30:27 +0100734 free(flash_args.prog_args);
735 free(flash_args.prog_name);
736 free(flash_args.chip);
Stefan Taunerb8911d62012-12-26 07:55:00 +0000737 /* clean up global variables */
Stefan Taunerb8911d62012-12-26 07:55:00 +0000738 chip_to_probe = NULL;
Stefan Tauner20da4aa2014-05-07 22:07:23 +0000739 free(logfile);
Carl-Daniel Hailfinger1c155482012-06-06 09:17:06 +0000740 ret |= close_logfile();
Carl-Daniel Hailfingerd5660142011-07-15 23:47:45 +0000741 return ret;
Carl-Daniel Hailfingera84835a2010-01-07 03:24:05 +0000742}