blob: 9bf0b038f7f5fabe4d819aeadb6797e4a367ba24 [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"
Nico Huber3a9939b2016-04-27 15:56:14 +020028#include "layout.h"
Ollie Lho184a4042005-11-26 21:55:36 +000029
Nico Huber3a9939b2016-04-27 15:56:14 +020030struct romentry entries[MAX_ROMLAYOUT];
31static struct flashrom_layout layout = { entries, 0 };
Stefan Taunerc70bc8a2013-08-30 22:22:57 +000032
33/* include_args holds the arguments specified at the command line with -i. They must be processed at some point
Nico Huber3a9939b2016-04-27 15:56:14 +020034 * so that desired regions are marked as "included" in the layout. */
Stefan Taunerc70bc8a2013-08-30 22:22:57 +000035static char *include_args[MAX_ROMLAYOUT];
36static int num_include_args = 0; /* the number of valid include_args. */
Ollie Lho184a4042005-11-26 21:55:36 +000037
Nico Huber305f4172013-06-14 11:55:26 +020038struct flashrom_layout *get_global_layout(void)
Nico Huber3a9939b2016-04-27 15:56:14 +020039{
40 return &layout;
41}
42
Patrick Georgia9095a92010-09-30 17:03:32 +000043#ifndef __LIBPAYLOAD__
Mark Marshallf20b7be2014-05-09 21:16:21 +000044int read_romlayout(const char *name)
Ollie Lho184a4042005-11-26 21:55:36 +000045{
46 FILE *romlayout;
47 char tempstr[256];
48 int i;
49
Uwe Hermanna7e05482007-05-09 10:17:44 +000050 romlayout = fopen(name, "r");
51
52 if (!romlayout) {
Carl-Daniel Hailfinger831e8f42010-05-30 22:24:40 +000053 msg_gerr("ERROR: Could not open ROM layout (%s).\n",
Uwe Hermanna7e05482007-05-09 10:17:44 +000054 name);
Ollie Lho184a4042005-11-26 21:55:36 +000055 return -1;
56 }
Uwe Hermanna7e05482007-05-09 10:17:44 +000057
58 while (!feof(romlayout)) {
Ollie Lho184a4042005-11-26 21:55:36 +000059 char *tstr1, *tstr2;
Carl-Daniel Hailfingerda53ada2010-12-04 11:56:52 +000060
Nico Huber3a9939b2016-04-27 15:56:14 +020061 if (layout.num_entries >= MAX_ROMLAYOUT) {
Carl-Daniel Hailfingerda53ada2010-12-04 11:56:52 +000062 msg_gerr("Maximum number of ROM images (%i) in layout "
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +000063 "file reached.\n", MAX_ROMLAYOUT);
Stefan Tauner16687702015-12-25 21:59:45 +000064 (void)fclose(romlayout);
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +000065 return 1;
Carl-Daniel Hailfingerda53ada2010-12-04 11:56:52 +000066 }
Nico Huber3a9939b2016-04-27 15:56:14 +020067 if (2 != fscanf(romlayout, "%255s %255s\n", tempstr, layout.entries[layout.num_entries].name))
Peter Stuge1fec0f32009-01-12 21:00:35 +000068 continue;
Ollie Lho184a4042005-11-26 21:55:36 +000069#if 0
70 // fscanf does not like arbitrary comments like that :( later
Uwe Hermanna7e05482007-05-09 10:17:44 +000071 if (tempstr[0] == '#') {
Ollie Lho184a4042005-11-26 21:55:36 +000072 continue;
73 }
74#endif
Uwe Hermanna7e05482007-05-09 10:17:44 +000075 tstr1 = strtok(tempstr, ":");
76 tstr2 = strtok(NULL, ":");
Uwe Hermann58783e32008-12-22 16:42:59 +000077 if (!tstr1 || !tstr2) {
Stefan Taunereb582572012-09-21 12:52:50 +000078 msg_gerr("Error parsing layout file. Offending string: \"%s\"\n", tempstr);
Stefan Tauner16687702015-12-25 21:59:45 +000079 (void)fclose(romlayout);
Uwe Hermann58783e32008-12-22 16:42:59 +000080 return 1;
81 }
Nico Huber3a9939b2016-04-27 15:56:14 +020082 layout.entries[layout.num_entries].start = strtol(tstr1, (char **)NULL, 16);
83 layout.entries[layout.num_entries].end = strtol(tstr2, (char **)NULL, 16);
84 layout.entries[layout.num_entries].included = 0;
85 layout.num_entries++;
Ollie Lho184a4042005-11-26 21:55:36 +000086 }
Uwe Hermanna7e05482007-05-09 10:17:44 +000087
Nico Huber3a9939b2016-04-27 15:56:14 +020088 for (i = 0; i < layout.num_entries; i++) {
Carl-Daniel Hailfinger831e8f42010-05-30 22:24:40 +000089 msg_gdbg("romlayout %08x - %08x named %s\n",
Nico Huber3a9939b2016-04-27 15:56:14 +020090 layout.entries[i].start,
91 layout.entries[i].end, layout.entries[i].name);
Ollie Lho184a4042005-11-26 21:55:36 +000092 }
93
Stefan Tauner16687702015-12-25 21:59:45 +000094 (void)fclose(romlayout);
Uwe Hermannffec5f32007-08-23 16:08:21 +000095
Uwe Hermanna7e05482007-05-09 10:17:44 +000096 return 0;
Ollie Lho184a4042005-11-26 21:55:36 +000097}
Patrick Georgia9095a92010-09-30 17:03:32 +000098#endif
Ollie Lho184a4042005-11-26 21:55:36 +000099
Stefan Tauner23bb6d52012-04-15 14:09:16 +0000100/* returns the index of the entry (or a negative value if it is not found) */
Mark Marshallf20b7be2014-05-09 21:16:21 +0000101static int find_include_arg(const char *const name)
Stefan Tauner23bb6d52012-04-15 14:09:16 +0000102{
103 unsigned int i;
104 for (i = 0; i < num_include_args; i++) {
105 if (!strcmp(include_args[i], name))
106 return i;
107 }
108 return -1;
109}
110
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +0000111/* register an include argument (-i) for later processing */
112int register_include_arg(char *name)
113{
114 if (num_include_args >= MAX_ROMLAYOUT) {
115 msg_gerr("Too many regions included (%i).\n", num_include_args);
116 return 1;
117 }
118
119 if (name == NULL) {
120 msg_gerr("<NULL> is a bad region name.\n");
121 return 1;
122 }
123
Stefan Tauner23bb6d52012-04-15 14:09:16 +0000124 if (find_include_arg(name) != -1) {
125 msg_gerr("Duplicate region name: \"%s\".\n", name);
126 return 1;
127 }
128
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +0000129 include_args[num_include_args] = name;
130 num_include_args++;
131 return 0;
132}
133
134/* returns the index of the entry (or a negative value if it is not found) */
Nico Huber305f4172013-06-14 11:55:26 +0200135static int find_romentry(struct flashrom_layout *const l, char *name)
Ollie Lho184a4042005-11-26 21:55:36 +0000136{
137 int i;
138
Nico Huber305f4172013-06-14 11:55:26 +0200139 if (l->num_entries == 0)
Uwe Hermanna7e05482007-05-09 10:17:44 +0000140 return -1;
Ollie Lho184a4042005-11-26 21:55:36 +0000141
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +0000142 msg_gspew("Looking for region \"%s\"... ", name);
Nico Huber305f4172013-06-14 11:55:26 +0200143 for (i = 0; i < l->num_entries; i++) {
144 if (!strcmp(l->entries[i].name, name)) {
145 l->entries[i].included = 1;
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +0000146 msg_gspew("found.\n");
Ollie Lho184a4042005-11-26 21:55:36 +0000147 return i;
148 }
149 }
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +0000150 msg_gspew("not found.\n");
Ollie Lho184a4042005-11-26 21:55:36 +0000151 return -1;
152}
153
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +0000154/* process -i arguments
155 * returns 0 to indicate success, >0 to indicate failure
156 */
Nico Huber305f4172013-06-14 11:55:26 +0200157int process_include_args(struct flashrom_layout *const l)
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +0000158{
159 int i;
160 unsigned int found = 0;
161
162 if (num_include_args == 0)
163 return 0;
164
Stefan Tauner23bb6d52012-04-15 14:09:16 +0000165 /* User has specified an area, but no layout file is loaded. */
Nico Huber305f4172013-06-14 11:55:26 +0200166 if (l->num_entries == 0) {
Stefan Tauner23bb6d52012-04-15 14:09:16 +0000167 msg_gerr("Region requested (with -i \"%s\"), "
168 "but no layout data is available.\n",
169 include_args[0]);
170 return 1;
171 }
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +0000172
Stefan Tauner23bb6d52012-04-15 14:09:16 +0000173 for (i = 0; i < num_include_args; i++) {
Nico Huber305f4172013-06-14 11:55:26 +0200174 if (find_romentry(l, include_args[i]) < 0) {
Stefan Tauner23bb6d52012-04-15 14:09:16 +0000175 msg_gerr("Invalid region specified: \"%s\".\n",
Louis Yung-Chieh Lo9bcf2682011-12-25 09:12:16 +0000176 include_args[i]);
177 return 1;
178 }
179 found++;
180 }
181
182 msg_ginfo("Using region%s: \"%s\"", num_include_args > 1 ? "s" : "",
183 include_args[0]);
184 for (i = 1; i < num_include_args; i++)
185 msg_ginfo(", \"%s\"", include_args[i]);
186 msg_ginfo(".\n");
187 return 0;
188}
189
Stefan Tauner949ccc82013-09-15 14:01:06 +0000190void layout_cleanup(void)
191{
192 int i;
193 for (i = 0; i < num_include_args; i++) {
194 free(include_args[i]);
195 include_args[i] = NULL;
196 }
197 num_include_args = 0;
198
Nico Huber3a9939b2016-04-27 15:56:14 +0200199 for (i = 0; i < layout.num_entries; i++) {
200 layout.entries[i].included = 0;
Stefan Tauner949ccc82013-09-15 14:01:06 +0000201 }
Nico Huber3a9939b2016-04-27 15:56:14 +0200202 layout.num_entries = 0;
Stefan Tauner949ccc82013-09-15 14:01:06 +0000203}
204
Stefan Tauner8268fdb2013-09-23 14:21:06 +0000205/* Validate and - if needed - normalize layout entries. */
206int normalize_romentries(const struct flashctx *flash)
207{
208 chipsize_t total_size = flash->chip->total_size * 1024;
209 int ret = 0;
210
211 int i;
Nico Huber3a9939b2016-04-27 15:56:14 +0200212 for (i = 0; i < layout.num_entries; i++) {
213 if (layout.entries[i].start >= total_size || layout.entries[i].end >= total_size) {
Stefan Tauner8268fdb2013-09-23 14:21:06 +0000214 msg_gwarn("Warning: Address range of region \"%s\" exceeds the current chip's "
Nico Huber3a9939b2016-04-27 15:56:14 +0200215 "address space.\n", layout.entries[i].name);
216 if (layout.entries[i].included)
Stefan Tauner8268fdb2013-09-23 14:21:06 +0000217 ret = 1;
218 }
Nico Huber3a9939b2016-04-27 15:56:14 +0200219 if (layout.entries[i].start > layout.entries[i].end) {
Stefan Tauner8268fdb2013-09-23 14:21:06 +0000220 msg_gerr("Error: Size of the address range of region \"%s\" is not positive.\n",
Nico Huber3a9939b2016-04-27 15:56:14 +0200221 layout.entries[i].name);
Stefan Tauner8268fdb2013-09-23 14:21:06 +0000222 ret = 1;
223 }
224 }
225
226 return ret;
227}