Uwe Hermann | 75f5107 | 2008-03-04 16:29:54 +0000 | [diff] [blame] | 1 | /* |
| 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 Tauner | 949ccc8 | 2013-09-15 14:01:06 +0000 | [diff] [blame] | 6 | * Copyright (C) 2011-2013 Stefan Tauner |
Uwe Hermann | 75f5107 | 2008-03-04 16:29:54 +0000 | [diff] [blame] | 7 | * |
| 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. |
Uwe Hermann | 75f5107 | 2008-03-04 16:29:54 +0000 | [diff] [blame] | 16 | */ |
| 17 | |
Carl-Daniel Hailfinger | 831e8f4 | 2010-05-30 22:24:40 +0000 | [diff] [blame] | 18 | #include <stdio.h> |
Ollie Lho | 184a404 | 2005-11-26 21:55:36 +0000 | [diff] [blame] | 19 | #include <stdlib.h> |
| 20 | #include <string.h> |
Carl-Daniel Hailfinger | cb6ad16 | 2010-11-02 03:12:51 +0000 | [diff] [blame] | 21 | #include <limits.h> |
Uwe Hermann | 0846f89 | 2007-08-23 13:34:59 +0000 | [diff] [blame] | 22 | #include "flash.h" |
Carl-Daniel Hailfinger | 5b997c3 | 2010-07-27 22:41:39 +0000 | [diff] [blame] | 23 | #include "programmer.h" |
Nico Huber | 3a9939b | 2016-04-27 15:56:14 +0200 | [diff] [blame] | 24 | #include "layout.h" |
Ollie Lho | 184a404 | 2005-11-26 21:55:36 +0000 | [diff] [blame] | 25 | |
Nico Huber | 3a9939b | 2016-04-27 15:56:14 +0200 | [diff] [blame] | 26 | struct romentry entries[MAX_ROMLAYOUT]; |
| 27 | static struct flashrom_layout layout = { entries, 0 }; |
Stefan Tauner | c70bc8a | 2013-08-30 22:22:57 +0000 | [diff] [blame] | 28 | |
| 29 | /* include_args holds the arguments specified at the command line with -i. They must be processed at some point |
Nico Huber | 3a9939b | 2016-04-27 15:56:14 +0200 | [diff] [blame] | 30 | * so that desired regions are marked as "included" in the layout. */ |
Stefan Tauner | c70bc8a | 2013-08-30 22:22:57 +0000 | [diff] [blame] | 31 | static char *include_args[MAX_ROMLAYOUT]; |
| 32 | static int num_include_args = 0; /* the number of valid include_args. */ |
Ollie Lho | 184a404 | 2005-11-26 21:55:36 +0000 | [diff] [blame] | 33 | |
Nico Huber | 305f417 | 2013-06-14 11:55:26 +0200 | [diff] [blame] | 34 | struct flashrom_layout *get_global_layout(void) |
Nico Huber | 3a9939b | 2016-04-27 15:56:14 +0200 | [diff] [blame] | 35 | { |
| 36 | return &layout; |
| 37 | } |
| 38 | |
dhendrix | beaefe0 | 2017-09-03 18:06:53 -0700 | [diff] [blame] | 39 | const struct flashrom_layout *get_layout(const struct flashrom_flashctx *const flashctx) |
| 40 | { |
| 41 | if (flashctx->layout && flashctx->layout->num_entries) |
| 42 | return flashctx->layout; |
| 43 | else |
| 44 | return &flashctx->fallback_layout.base; |
| 45 | } |
| 46 | |
Patrick Georgi | a9095a9 | 2010-09-30 17:03:32 +0000 | [diff] [blame] | 47 | #ifndef __LIBPAYLOAD__ |
Mark Marshall | f20b7be | 2014-05-09 21:16:21 +0000 | [diff] [blame] | 48 | int read_romlayout(const char *name) |
Ollie Lho | 184a404 | 2005-11-26 21:55:36 +0000 | [diff] [blame] | 49 | { |
| 50 | FILE *romlayout; |
| 51 | char tempstr[256]; |
| 52 | int i; |
| 53 | |
Uwe Hermann | a7e0548 | 2007-05-09 10:17:44 +0000 | [diff] [blame] | 54 | romlayout = fopen(name, "r"); |
| 55 | |
| 56 | if (!romlayout) { |
Carl-Daniel Hailfinger | 831e8f4 | 2010-05-30 22:24:40 +0000 | [diff] [blame] | 57 | msg_gerr("ERROR: Could not open ROM layout (%s).\n", |
Uwe Hermann | a7e0548 | 2007-05-09 10:17:44 +0000 | [diff] [blame] | 58 | name); |
Ollie Lho | 184a404 | 2005-11-26 21:55:36 +0000 | [diff] [blame] | 59 | return -1; |
| 60 | } |
Uwe Hermann | a7e0548 | 2007-05-09 10:17:44 +0000 | [diff] [blame] | 61 | |
| 62 | while (!feof(romlayout)) { |
Ollie Lho | 184a404 | 2005-11-26 21:55:36 +0000 | [diff] [blame] | 63 | char *tstr1, *tstr2; |
Carl-Daniel Hailfinger | da53ada | 2010-12-04 11:56:52 +0000 | [diff] [blame] | 64 | |
Nico Huber | 3a9939b | 2016-04-27 15:56:14 +0200 | [diff] [blame] | 65 | if (layout.num_entries >= MAX_ROMLAYOUT) { |
Carl-Daniel Hailfinger | da53ada | 2010-12-04 11:56:52 +0000 | [diff] [blame] | 66 | msg_gerr("Maximum number of ROM images (%i) in layout " |
Louis Yung-Chieh Lo | 9bcf268 | 2011-12-25 09:12:16 +0000 | [diff] [blame] | 67 | "file reached.\n", MAX_ROMLAYOUT); |
Stefan Tauner | 1668770 | 2015-12-25 21:59:45 +0000 | [diff] [blame] | 68 | (void)fclose(romlayout); |
Louis Yung-Chieh Lo | 9bcf268 | 2011-12-25 09:12:16 +0000 | [diff] [blame] | 69 | return 1; |
Carl-Daniel Hailfinger | da53ada | 2010-12-04 11:56:52 +0000 | [diff] [blame] | 70 | } |
Nico Huber | 3a9939b | 2016-04-27 15:56:14 +0200 | [diff] [blame] | 71 | if (2 != fscanf(romlayout, "%255s %255s\n", tempstr, layout.entries[layout.num_entries].name)) |
Peter Stuge | 1fec0f3 | 2009-01-12 21:00:35 +0000 | [diff] [blame] | 72 | continue; |
Ollie Lho | 184a404 | 2005-11-26 21:55:36 +0000 | [diff] [blame] | 73 | #if 0 |
| 74 | // fscanf does not like arbitrary comments like that :( later |
Uwe Hermann | a7e0548 | 2007-05-09 10:17:44 +0000 | [diff] [blame] | 75 | if (tempstr[0] == '#') { |
Ollie Lho | 184a404 | 2005-11-26 21:55:36 +0000 | [diff] [blame] | 76 | continue; |
| 77 | } |
| 78 | #endif |
Uwe Hermann | a7e0548 | 2007-05-09 10:17:44 +0000 | [diff] [blame] | 79 | tstr1 = strtok(tempstr, ":"); |
| 80 | tstr2 = strtok(NULL, ":"); |
Uwe Hermann | 58783e3 | 2008-12-22 16:42:59 +0000 | [diff] [blame] | 81 | if (!tstr1 || !tstr2) { |
Stefan Tauner | eb58257 | 2012-09-21 12:52:50 +0000 | [diff] [blame] | 82 | msg_gerr("Error parsing layout file. Offending string: \"%s\"\n", tempstr); |
Stefan Tauner | 1668770 | 2015-12-25 21:59:45 +0000 | [diff] [blame] | 83 | (void)fclose(romlayout); |
Uwe Hermann | 58783e3 | 2008-12-22 16:42:59 +0000 | [diff] [blame] | 84 | return 1; |
| 85 | } |
Nico Huber | 3a9939b | 2016-04-27 15:56:14 +0200 | [diff] [blame] | 86 | layout.entries[layout.num_entries].start = strtol(tstr1, (char **)NULL, 16); |
| 87 | layout.entries[layout.num_entries].end = strtol(tstr2, (char **)NULL, 16); |
| 88 | layout.entries[layout.num_entries].included = 0; |
| 89 | layout.num_entries++; |
Ollie Lho | 184a404 | 2005-11-26 21:55:36 +0000 | [diff] [blame] | 90 | } |
Uwe Hermann | a7e0548 | 2007-05-09 10:17:44 +0000 | [diff] [blame] | 91 | |
Nico Huber | 3a9939b | 2016-04-27 15:56:14 +0200 | [diff] [blame] | 92 | for (i = 0; i < layout.num_entries; i++) { |
Carl-Daniel Hailfinger | 831e8f4 | 2010-05-30 22:24:40 +0000 | [diff] [blame] | 93 | msg_gdbg("romlayout %08x - %08x named %s\n", |
Nico Huber | 3a9939b | 2016-04-27 15:56:14 +0200 | [diff] [blame] | 94 | layout.entries[i].start, |
| 95 | layout.entries[i].end, layout.entries[i].name); |
Ollie Lho | 184a404 | 2005-11-26 21:55:36 +0000 | [diff] [blame] | 96 | } |
| 97 | |
Stefan Tauner | 1668770 | 2015-12-25 21:59:45 +0000 | [diff] [blame] | 98 | (void)fclose(romlayout); |
Uwe Hermann | ffec5f3 | 2007-08-23 16:08:21 +0000 | [diff] [blame] | 99 | |
Uwe Hermann | a7e0548 | 2007-05-09 10:17:44 +0000 | [diff] [blame] | 100 | return 0; |
Ollie Lho | 184a404 | 2005-11-26 21:55:36 +0000 | [diff] [blame] | 101 | } |
Patrick Georgi | a9095a9 | 2010-09-30 17:03:32 +0000 | [diff] [blame] | 102 | #endif |
Ollie Lho | 184a404 | 2005-11-26 21:55:36 +0000 | [diff] [blame] | 103 | |
Stefan Tauner | 23bb6d5 | 2012-04-15 14:09:16 +0000 | [diff] [blame] | 104 | /* returns the index of the entry (or a negative value if it is not found) */ |
Mark Marshall | f20b7be | 2014-05-09 21:16:21 +0000 | [diff] [blame] | 105 | static int find_include_arg(const char *const name) |
Stefan Tauner | 23bb6d5 | 2012-04-15 14:09:16 +0000 | [diff] [blame] | 106 | { |
| 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 Lo | 9bcf268 | 2011-12-25 09:12:16 +0000 | [diff] [blame] | 115 | /* register an include argument (-i) for later processing */ |
| 116 | int 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 Tauner | 23bb6d5 | 2012-04-15 14:09:16 +0000 | [diff] [blame] | 128 | if (find_include_arg(name) != -1) { |
| 129 | msg_gerr("Duplicate region name: \"%s\".\n", name); |
| 130 | return 1; |
| 131 | } |
| 132 | |
Louis Yung-Chieh Lo | 9bcf268 | 2011-12-25 09:12:16 +0000 | [diff] [blame] | 133 | include_args[num_include_args] = name; |
| 134 | num_include_args++; |
| 135 | return 0; |
| 136 | } |
| 137 | |
Arthur Heymans | 32b9f5c | 2019-02-05 16:14:55 +0100 | [diff] [blame] | 138 | /* returns -1 if an entry is not found, 0 if found. */ |
Nico Huber | 305f417 | 2013-06-14 11:55:26 +0200 | [diff] [blame] | 139 | static int find_romentry(struct flashrom_layout *const l, char *name) |
Ollie Lho | 184a404 | 2005-11-26 21:55:36 +0000 | [diff] [blame] | 140 | { |
Nico Huber | 305f417 | 2013-06-14 11:55:26 +0200 | [diff] [blame] | 141 | if (l->num_entries == 0) |
Uwe Hermann | a7e0548 | 2007-05-09 10:17:44 +0000 | [diff] [blame] | 142 | return -1; |
Ollie Lho | 184a404 | 2005-11-26 21:55:36 +0000 | [diff] [blame] | 143 | |
Louis Yung-Chieh Lo | 9bcf268 | 2011-12-25 09:12:16 +0000 | [diff] [blame] | 144 | msg_gspew("Looking for region \"%s\"... ", name); |
Arthur Heymans | 32b9f5c | 2019-02-05 16:14:55 +0100 | [diff] [blame] | 145 | if (flashrom_layout_include_region(l, name)) { |
| 146 | msg_gspew("not found.\n"); |
| 147 | return -1; |
Ollie Lho | 184a404 | 2005-11-26 21:55:36 +0000 | [diff] [blame] | 148 | } |
Arthur Heymans | 32b9f5c | 2019-02-05 16:14:55 +0100 | [diff] [blame] | 149 | msg_gspew("found.\n"); |
| 150 | return 0; |
Ollie Lho | 184a404 | 2005-11-26 21:55:36 +0000 | [diff] [blame] | 151 | } |
| 152 | |
Louis Yung-Chieh Lo | 9bcf268 | 2011-12-25 09:12:16 +0000 | [diff] [blame] | 153 | /* process -i arguments |
| 154 | * returns 0 to indicate success, >0 to indicate failure |
| 155 | */ |
Nico Huber | 305f417 | 2013-06-14 11:55:26 +0200 | [diff] [blame] | 156 | int process_include_args(struct flashrom_layout *const l) |
Louis Yung-Chieh Lo | 9bcf268 | 2011-12-25 09:12:16 +0000 | [diff] [blame] | 157 | { |
| 158 | int i; |
Louis Yung-Chieh Lo | 9bcf268 | 2011-12-25 09:12:16 +0000 | [diff] [blame] | 159 | |
| 160 | if (num_include_args == 0) |
| 161 | return 0; |
| 162 | |
Stefan Tauner | 23bb6d5 | 2012-04-15 14:09:16 +0000 | [diff] [blame] | 163 | /* User has specified an area, but no layout file is loaded. */ |
Nico Huber | 305f417 | 2013-06-14 11:55:26 +0200 | [diff] [blame] | 164 | if (l->num_entries == 0) { |
Stefan Tauner | 23bb6d5 | 2012-04-15 14:09:16 +0000 | [diff] [blame] | 165 | msg_gerr("Region requested (with -i \"%s\"), " |
| 166 | "but no layout data is available.\n", |
| 167 | include_args[0]); |
| 168 | return 1; |
| 169 | } |
Louis Yung-Chieh Lo | 9bcf268 | 2011-12-25 09:12:16 +0000 | [diff] [blame] | 170 | |
Stefan Tauner | 23bb6d5 | 2012-04-15 14:09:16 +0000 | [diff] [blame] | 171 | for (i = 0; i < num_include_args; i++) { |
Nico Huber | 305f417 | 2013-06-14 11:55:26 +0200 | [diff] [blame] | 172 | if (find_romentry(l, include_args[i]) < 0) { |
Stefan Tauner | 23bb6d5 | 2012-04-15 14:09:16 +0000 | [diff] [blame] | 173 | msg_gerr("Invalid region specified: \"%s\".\n", |
Louis Yung-Chieh Lo | 9bcf268 | 2011-12-25 09:12:16 +0000 | [diff] [blame] | 174 | include_args[i]); |
| 175 | return 1; |
| 176 | } |
Louis Yung-Chieh Lo | 9bcf268 | 2011-12-25 09:12:16 +0000 | [diff] [blame] | 177 | } |
| 178 | |
| 179 | msg_ginfo("Using region%s: \"%s\"", num_include_args > 1 ? "s" : "", |
| 180 | include_args[0]); |
| 181 | for (i = 1; i < num_include_args; i++) |
| 182 | msg_ginfo(", \"%s\"", include_args[i]); |
| 183 | msg_ginfo(".\n"); |
| 184 | return 0; |
| 185 | } |
| 186 | |
Stefan Tauner | 949ccc8 | 2013-09-15 14:01:06 +0000 | [diff] [blame] | 187 | void layout_cleanup(void) |
| 188 | { |
| 189 | int i; |
| 190 | for (i = 0; i < num_include_args; i++) { |
| 191 | free(include_args[i]); |
| 192 | include_args[i] = NULL; |
| 193 | } |
| 194 | num_include_args = 0; |
| 195 | |
Nico Huber | 3a9939b | 2016-04-27 15:56:14 +0200 | [diff] [blame] | 196 | for (i = 0; i < layout.num_entries; i++) { |
| 197 | layout.entries[i].included = 0; |
Stefan Tauner | 949ccc8 | 2013-09-15 14:01:06 +0000 | [diff] [blame] | 198 | } |
Nico Huber | 3a9939b | 2016-04-27 15:56:14 +0200 | [diff] [blame] | 199 | layout.num_entries = 0; |
Stefan Tauner | 949ccc8 | 2013-09-15 14:01:06 +0000 | [diff] [blame] | 200 | } |
| 201 | |
Stefan Tauner | 8268fdb | 2013-09-23 14:21:06 +0000 | [diff] [blame] | 202 | /* Validate and - if needed - normalize layout entries. */ |
| 203 | int normalize_romentries(const struct flashctx *flash) |
| 204 | { |
| 205 | chipsize_t total_size = flash->chip->total_size * 1024; |
| 206 | int ret = 0; |
| 207 | |
| 208 | int i; |
Nico Huber | 3a9939b | 2016-04-27 15:56:14 +0200 | [diff] [blame] | 209 | for (i = 0; i < layout.num_entries; i++) { |
| 210 | if (layout.entries[i].start >= total_size || layout.entries[i].end >= total_size) { |
Stefan Tauner | 8268fdb | 2013-09-23 14:21:06 +0000 | [diff] [blame] | 211 | msg_gwarn("Warning: Address range of region \"%s\" exceeds the current chip's " |
Nico Huber | 3a9939b | 2016-04-27 15:56:14 +0200 | [diff] [blame] | 212 | "address space.\n", layout.entries[i].name); |
| 213 | if (layout.entries[i].included) |
Stefan Tauner | 8268fdb | 2013-09-23 14:21:06 +0000 | [diff] [blame] | 214 | ret = 1; |
| 215 | } |
Nico Huber | 3a9939b | 2016-04-27 15:56:14 +0200 | [diff] [blame] | 216 | if (layout.entries[i].start > layout.entries[i].end) { |
Stefan Tauner | 8268fdb | 2013-09-23 14:21:06 +0000 | [diff] [blame] | 217 | msg_gerr("Error: Size of the address range of region \"%s\" is not positive.\n", |
Nico Huber | 3a9939b | 2016-04-27 15:56:14 +0200 | [diff] [blame] | 218 | layout.entries[i].name); |
Stefan Tauner | 8268fdb | 2013-09-23 14:21:06 +0000 | [diff] [blame] | 219 | ret = 1; |
| 220 | } |
| 221 | } |
| 222 | |
| 223 | return ret; |
| 224 | } |
Nico Huber | 3d7b1e3 | 2018-12-22 00:53:14 +0100 | [diff] [blame] | 225 | |
| 226 | const struct romentry *layout_next_included_region( |
| 227 | const struct flashrom_layout *const l, const chipoff_t where) |
| 228 | { |
| 229 | unsigned int i; |
| 230 | const struct romentry *lowest = NULL; |
| 231 | |
| 232 | for (i = 0; i < l->num_entries; ++i) { |
| 233 | if (!l->entries[i].included) |
| 234 | continue; |
| 235 | if (l->entries[i].end < where) |
| 236 | continue; |
| 237 | if (!lowest || lowest->start > l->entries[i].start) |
| 238 | lowest = &l->entries[i]; |
| 239 | } |
| 240 | |
| 241 | return lowest; |
| 242 | } |