blob: 0b9f6e5f9fa912020669211e08032186bc72ccd9 [file] [log] [blame]
Uwe Hermann75f51072008-03-04 16:29:54 +00001/*
2 * This file is part of the flashrom project.
3 *
4 * Copyright (C) 2005-2008 coresystems GmbH
5 * (Written by Stefan Reinauer <stepan@coresystems.de> for coresystems GmbH)
Stefan Tauner949ccc82013-09-15 14:01:06 +00006 * Copyright (C) 2011-2013 Stefan Tauner
Uwe Hermann75f51072008-03-04 16:29:54 +00007 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; version 2 of the License.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
Carl-Daniel Hailfinger831e8f42010-05-30 22:24:40 +000022#include <stdio.h>
Ollie Lho184a4042005-11-26 21:55:36 +000023#include <stdlib.h>
24#include <string.h>
Carl-Daniel Hailfingercb6ad162010-11-02 03:12:51 +000025#include <limits.h>
Uwe Hermann0846f892007-08-23 13:34:59 +000026#include "flash.h"
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000027#include "programmer.h"
Ollie Lho184a4042005-11-26 21:55:36 +000028
David Hendricks444cefc2010-10-29 20:17:41 +000029#define MAX_ROMLAYOUT 32
Ollie Lho184a4042005-11-26 21:55:36 +000030
31typedef struct {
Stefan Tauner8268fdb2013-09-23 14:21:06 +000032 chipoff_t start;
33 chipoff_t end;
Ollie Lho184a4042005-11-26 21:55:36 +000034 unsigned int included;
35 char name[256];
Stefan Tauner97b6c112013-08-30 22:23:02 +000036} romentry_t;
Ollie Lho184a4042005-11-26 21:55:36 +000037
Stefan Taunerc70bc8a2013-08-30 22:22:57 +000038/* rom_entries store the entries specified in a layout file and associated run-time data */
Stefan Tauner97b6c112013-08-30 22:23:02 +000039static romentry_t rom_entries[MAX_ROMLAYOUT];
Stefan Tauner8268fdb2013-09-23 14:21:06 +000040static int num_rom_entries = 0; /* the number of successfully parsed rom_entries */
Stefan Taunerc70bc8a2013-08-30 22:22:57 +000041
42/* include_args holds the arguments specified at the command line with -i. They must be processed at some point
43 * so that desired regions are marked as "included" in the rom_entries list. */
44static char *include_args[MAX_ROMLAYOUT];
45static int num_include_args = 0; /* the number of valid include_args. */
Ollie Lho184a4042005-11-26 21:55:36 +000046
Patrick Georgia9095a92010-09-30 17:03:32 +000047#ifndef __LIBPAYLOAD__
Mark Marshallf20b7be2014-05-09 21:16:21 +000048int read_romlayout(const char *name)
Ollie Lho184a4042005-11-26 21:55:36 +000049{
50 FILE *romlayout;
51 char tempstr[256];
52 int i;
53
Uwe Hermanna7e05482007-05-09 10:17:44 +000054 romlayout = fopen(name, "r");
55
56 if (!romlayout) {
Carl-Daniel Hailfinger831e8f42010-05-30 22:24:40 +000057 msg_gerr("ERROR: Could not open ROM layout (%s).\n",
Uwe Hermanna7e05482007-05-09 10:17:44 +000058 name);
Ollie Lho184a4042005-11-26 21:55:36 +000059 return -1;
60 }
Uwe Hermanna7e05482007-05-09 10:17:44 +000061
62 while (!feof(romlayout)) {
Ollie Lho184a4042005-11-26 21:55:36 +000063 char *tstr1, *tstr2;
Carl-Daniel Hailfingerda53ada2010-12-04 11:56:52 +000064
Stefan Taunerc70bc8a2013-08-30 22:22:57 +000065 if (num_rom_entries >= MAX_ROMLAYOUT) {
Carl-Daniel Hailfingerda53ada2010-12-04 11:56:52 +000066 msg_gerr("Maximum number of ROM images (%i) in layout "
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +000067 "file reached.\n", MAX_ROMLAYOUT);
Stefan Reinauer4c00d092014-04-26 16:11:39 +000068 fclose(romlayout);
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +000069 return 1;
Carl-Daniel Hailfingerda53ada2010-12-04 11:56:52 +000070 }
Stefan Taunerc70bc8a2013-08-30 22:22:57 +000071 if (2 != fscanf(romlayout, "%s %s\n", tempstr, rom_entries[num_rom_entries].name))
Peter Stuge1fec0f32009-01-12 21:00:35 +000072 continue;
Ollie Lho184a4042005-11-26 21:55:36 +000073#if 0
74 // fscanf does not like arbitrary comments like that :( later
Uwe Hermanna7e05482007-05-09 10:17:44 +000075 if (tempstr[0] == '#') {
Ollie Lho184a4042005-11-26 21:55:36 +000076 continue;
77 }
78#endif
Uwe Hermanna7e05482007-05-09 10:17:44 +000079 tstr1 = strtok(tempstr, ":");
80 tstr2 = strtok(NULL, ":");
Uwe Hermann58783e32008-12-22 16:42:59 +000081 if (!tstr1 || !tstr2) {
Stefan Taunereb582572012-09-21 12:52:50 +000082 msg_gerr("Error parsing layout file. Offending string: \"%s\"\n", tempstr);
Uwe Hermann58783e32008-12-22 16:42:59 +000083 fclose(romlayout);
84 return 1;
85 }
Stefan Taunerc70bc8a2013-08-30 22:22:57 +000086 rom_entries[num_rom_entries].start = strtol(tstr1, (char **)NULL, 16);
87 rom_entries[num_rom_entries].end = strtol(tstr2, (char **)NULL, 16);
88 rom_entries[num_rom_entries].included = 0;
89 num_rom_entries++;
Ollie Lho184a4042005-11-26 21:55:36 +000090 }
Uwe Hermanna7e05482007-05-09 10:17:44 +000091
Stefan Taunerc70bc8a2013-08-30 22:22:57 +000092 for (i = 0; i < num_rom_entries; i++) {
Carl-Daniel Hailfinger831e8f42010-05-30 22:24:40 +000093 msg_gdbg("romlayout %08x - %08x named %s\n",
Uwe Hermanna7e05482007-05-09 10:17:44 +000094 rom_entries[i].start,
95 rom_entries[i].end, rom_entries[i].name);
Ollie Lho184a4042005-11-26 21:55:36 +000096 }
97
98 fclose(romlayout);
Uwe Hermannffec5f32007-08-23 16:08:21 +000099
Uwe Hermanna7e05482007-05-09 10:17:44 +0000100 return 0;
Ollie Lho184a4042005-11-26 21:55:36 +0000101}
Patrick Georgia9095a92010-09-30 17:03:32 +0000102#endif
Ollie Lho184a4042005-11-26 21:55:36 +0000103
Stefan Tauner23bb6d52012-04-15 14:09:16 +0000104/* returns the index of the entry (or a negative value if it is not found) */
Mark Marshallf20b7be2014-05-09 21:16:21 +0000105static int find_include_arg(const char *const name)
Stefan Tauner23bb6d52012-04-15 14:09:16 +0000106{
107 unsigned int i;
108 for (i = 0; i < num_include_args; i++) {
109 if (!strcmp(include_args[i], name))
110 return i;
111 }
112 return -1;
113}
114
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +0000115/* register an include argument (-i) for later processing */
116int register_include_arg(char *name)
117{
118 if (num_include_args >= MAX_ROMLAYOUT) {
119 msg_gerr("Too many regions included (%i).\n", num_include_args);
120 return 1;
121 }
122
123 if (name == NULL) {
124 msg_gerr("<NULL> is a bad region name.\n");
125 return 1;
126 }
127
Stefan Tauner23bb6d52012-04-15 14:09:16 +0000128 if (find_include_arg(name) != -1) {
129 msg_gerr("Duplicate region name: \"%s\".\n", name);
130 return 1;
131 }
132
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +0000133 include_args[num_include_args] = name;
134 num_include_args++;
135 return 0;
136}
137
138/* returns the index of the entry (or a negative value if it is not found) */
139static int find_romentry(char *name)
Ollie Lho184a4042005-11-26 21:55:36 +0000140{
141 int i;
142
Stefan Taunerc70bc8a2013-08-30 22:22:57 +0000143 if (num_rom_entries == 0)
Uwe Hermanna7e05482007-05-09 10:17:44 +0000144 return -1;
Ollie Lho184a4042005-11-26 21:55:36 +0000145
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +0000146 msg_gspew("Looking for region \"%s\"... ", name);
Stefan Taunerc70bc8a2013-08-30 22:22:57 +0000147 for (i = 0; i < num_rom_entries; i++) {
Uwe Hermanna7e05482007-05-09 10:17:44 +0000148 if (!strcmp(rom_entries[i].name, name)) {
149 rom_entries[i].included = 1;
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +0000150 msg_gspew("found.\n");
Ollie Lho184a4042005-11-26 21:55:36 +0000151 return i;
152 }
153 }
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +0000154 msg_gspew("not found.\n");
Ollie Lho184a4042005-11-26 21:55:36 +0000155 return -1;
156}
157
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +0000158/* process -i arguments
159 * returns 0 to indicate success, >0 to indicate failure
160 */
161int process_include_args(void)
162{
163 int i;
164 unsigned int found = 0;
165
166 if (num_include_args == 0)
167 return 0;
168
Stefan Tauner23bb6d52012-04-15 14:09:16 +0000169 /* User has specified an area, but no layout file is loaded. */
Stefan Taunerc70bc8a2013-08-30 22:22:57 +0000170 if (num_rom_entries == 0) {
Stefan Tauner23bb6d52012-04-15 14:09:16 +0000171 msg_gerr("Region requested (with -i \"%s\"), "
172 "but no layout data is available.\n",
173 include_args[0]);
174 return 1;
175 }
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +0000176
Stefan Tauner23bb6d52012-04-15 14:09:16 +0000177 for (i = 0; i < num_include_args; i++) {
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +0000178 if (find_romentry(include_args[i]) < 0) {
Stefan Tauner23bb6d52012-04-15 14:09:16 +0000179 msg_gerr("Invalid region specified: \"%s\".\n",
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +0000180 include_args[i]);
181 return 1;
182 }
183 found++;
184 }
185
186 msg_ginfo("Using region%s: \"%s\"", num_include_args > 1 ? "s" : "",
187 include_args[0]);
188 for (i = 1; i < num_include_args; i++)
189 msg_ginfo(", \"%s\"", include_args[i]);
190 msg_ginfo(".\n");
191 return 0;
192}
193
Stefan Tauner949ccc82013-09-15 14:01:06 +0000194void layout_cleanup(void)
195{
196 int i;
197 for (i = 0; i < num_include_args; i++) {
198 free(include_args[i]);
199 include_args[i] = NULL;
200 }
201 num_include_args = 0;
202
203 for (i = 0; i < num_rom_entries; i++) {
204 rom_entries[i].included = 0;
205 }
206 num_rom_entries = 0;
207}
208
Stefan Tauner97b6c112013-08-30 22:23:02 +0000209romentry_t *get_next_included_romentry(unsigned int start)
Ollie Lho184a4042005-11-26 21:55:36 +0000210{
211 int i;
Carl-Daniel Hailfingercb6ad162010-11-02 03:12:51 +0000212 unsigned int best_start = UINT_MAX;
Stefan Tauner97b6c112013-08-30 22:23:02 +0000213 romentry_t *best_entry = NULL;
214 romentry_t *cur;
Ollie Lho184a4042005-11-26 21:55:36 +0000215
Carl-Daniel Hailfingercb6ad162010-11-02 03:12:51 +0000216 /* First come, first serve for overlapping regions. */
Stefan Taunerc70bc8a2013-08-30 22:22:57 +0000217 for (i = 0; i < num_rom_entries; i++) {
Stefan Tauner104b0d92011-12-25 09:07:59 +0000218 cur = &rom_entries[i];
219 if (!cur->included)
Ollie Lho184a4042005-11-26 21:55:36 +0000220 continue;
Carl-Daniel Hailfingercb6ad162010-11-02 03:12:51 +0000221 /* Already past the current entry? */
Stefan Tauner104b0d92011-12-25 09:07:59 +0000222 if (start > cur->end)
Carl-Daniel Hailfingercb6ad162010-11-02 03:12:51 +0000223 continue;
224 /* Inside the current entry? */
Stefan Tauner104b0d92011-12-25 09:07:59 +0000225 if (start >= cur->start)
226 return cur;
Carl-Daniel Hailfingercb6ad162010-11-02 03:12:51 +0000227 /* Entry begins after start. */
Stefan Tauner104b0d92011-12-25 09:07:59 +0000228 if (best_start > cur->start) {
229 best_start = cur->start;
230 best_entry = cur;
Carl-Daniel Hailfingercb6ad162010-11-02 03:12:51 +0000231 }
Ollie Lho184a4042005-11-26 21:55:36 +0000232 }
Carl-Daniel Hailfingercb6ad162010-11-02 03:12:51 +0000233 return best_entry;
234}
Ollie Lho184a4042005-11-26 21:55:36 +0000235
Stefan Tauner8268fdb2013-09-23 14:21:06 +0000236/* Validate and - if needed - normalize layout entries. */
237int normalize_romentries(const struct flashctx *flash)
238{
239 chipsize_t total_size = flash->chip->total_size * 1024;
240 int ret = 0;
241
242 int i;
243 for (i = 0; i < num_rom_entries; i++) {
244 if (rom_entries[i].start >= total_size || rom_entries[i].end >= total_size) {
245 msg_gwarn("Warning: Address range of region \"%s\" exceeds the current chip's "
246 "address space.\n", rom_entries[i].name);
247 if (rom_entries[i].included)
248 ret = 1;
249 }
250 if (rom_entries[i].start > rom_entries[i].end) {
251 msg_gerr("Error: Size of the address range of region \"%s\" is not positive.\n",
252 rom_entries[i].name);
253 ret = 1;
254 }
255 }
256
257 return ret;
258}
259
Stefan Tauner73f5bda2014-10-19 07:53:45 +0000260static int copy_old_content(struct flashctx *flash, int oldcontents_valid, uint8_t *oldcontents, uint8_t *newcontents, unsigned int start, unsigned int size)
261{
262 if (!oldcontents_valid) {
263 /* oldcontents is a zero-filled buffer. By reading the current data into oldcontents here, we
264 * avoid a rewrite of identical regions even if an initial full chip read didn't happen. */
265 msg_gdbg2("Read a chunk starting at 0x%06x (len=0x%06x).\n", start, size);
266 int ret = flash->chip->read(flash, oldcontents + start, start, size);
267 if (ret != 0) {
268 msg_gerr("Failed to read chunk 0x%06x-0x%06x.\n", start, start + size - 1);
269 return 1;
270 }
271 }
272 memcpy(newcontents + start, oldcontents + start, size);
273 return 0;
274}
275
276/**
277 * Modify @newcontents so that it contains the data that should be on the chip eventually. In the case the user
278 * wants to update only parts of it, copy the chunks to be preserved from @oldcontents to @newcontents. If
279 * @oldcontents is not valid, we need to fetch the current data from the chip first.
280 */
281int build_new_image(struct flashctx *flash, bool oldcontents_valid, uint8_t *oldcontents, uint8_t *newcontents)
Carl-Daniel Hailfingercb6ad162010-11-02 03:12:51 +0000282{
283 unsigned int start = 0;
Stefan Tauner97b6c112013-08-30 22:23:02 +0000284 romentry_t *entry;
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000285 unsigned int size = flash->chip->total_size * 1024;
Carl-Daniel Hailfingercb6ad162010-11-02 03:12:51 +0000286
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +0000287 /* If no regions were specified for inclusion, assume
288 * that the user wants to write the complete new image.
Carl-Daniel Hailfingercb6ad162010-11-02 03:12:51 +0000289 */
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +0000290 if (num_include_args == 0)
Carl-Daniel Hailfingercb6ad162010-11-02 03:12:51 +0000291 return 0;
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +0000292
Carl-Daniel Hailfingercb6ad162010-11-02 03:12:51 +0000293 /* Non-included romentries are ignored.
294 * The union of all included romentries is used from the new image.
295 */
296 while (start < size) {
Stefan Tauner104b0d92011-12-25 09:07:59 +0000297 entry = get_next_included_romentry(start);
Carl-Daniel Hailfingercb6ad162010-11-02 03:12:51 +0000298 /* No more romentries for remaining region? */
Stefan Tauner104b0d92011-12-25 09:07:59 +0000299 if (!entry) {
Stefan Tauner73f5bda2014-10-19 07:53:45 +0000300 copy_old_content(flash, oldcontents_valid, oldcontents, newcontents, start,
301 size - start);
Carl-Daniel Hailfingercb6ad162010-11-02 03:12:51 +0000302 break;
303 }
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +0000304 /* For non-included region, copy from old content. */
Stefan Tauner104b0d92011-12-25 09:07:59 +0000305 if (entry->start > start)
Stefan Tauner73f5bda2014-10-19 07:53:45 +0000306 copy_old_content(flash, oldcontents_valid, oldcontents, newcontents, start,
307 entry->start - start);
Carl-Daniel Hailfingercb6ad162010-11-02 03:12:51 +0000308 /* Skip to location after current romentry. */
Stefan Tauner104b0d92011-12-25 09:07:59 +0000309 start = entry->end + 1;
Carl-Daniel Hailfingercb6ad162010-11-02 03:12:51 +0000310 /* Catch overflow. */
311 if (!start)
312 break;
313 }
Ollie Lho184a4042005-11-26 21:55:36 +0000314 return 0;
315}