Hung-Te Lin | eab2c81 | 2013-01-29 01:56:17 +0800 | [diff] [blame] | 1 | /* |
| 2 | * CBFS Image Manipulation |
| 3 | * |
| 4 | * Copyright (C) 2013 The Chromium OS Authors. All rights reserved. |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or modify |
| 7 | * it under the terms of the GNU General Public License as published by |
| 8 | * the Free Software Foundation; version 2 of the License. |
| 9 | * |
| 10 | * This program is distributed in the hope that it will be useful, |
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 13 | * GNU General Public License for more details. |
| 14 | * |
| 15 | * You should have received a copy of the GNU General Public License |
| 16 | * along with this program; if not, write to the Free Software |
| 17 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA |
| 18 | */ |
| 19 | |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 20 | #include <inttypes.h> |
| 21 | #include <libgen.h> |
Hung-Te Lin | eab2c81 | 2013-01-29 01:56:17 +0800 | [diff] [blame] | 22 | #include <stdio.h> |
| 23 | #include <stdlib.h> |
| 24 | #include <string.h> |
| 25 | |
| 26 | #include "common.h" |
| 27 | #include "cbfs_image.h" |
| 28 | |
| 29 | /* The file name align is not defined in CBFS spec -- only a preference by |
| 30 | * (old) cbfstool. */ |
| 31 | #define CBFS_FILENAME_ALIGN (16) |
| 32 | |
| 33 | /* To make CBFS more friendly to ROM, fill -1 (0xFF) instead of zero. */ |
| 34 | #define CBFS_CONTENT_DEFAULT_VALUE (-1) |
| 35 | |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 36 | /* Type and format */ |
| 37 | |
| 38 | struct typedesc_t { |
| 39 | uint32_t type; |
| 40 | const char *name; |
| 41 | }; |
| 42 | |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 43 | static const struct typedesc_t types_cbfs_entry[] = { |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 44 | {CBFS_COMPONENT_STAGE, "stage"}, |
| 45 | {CBFS_COMPONENT_PAYLOAD, "payload"}, |
| 46 | {CBFS_COMPONENT_OPTIONROM, "optionrom"}, |
| 47 | {CBFS_COMPONENT_BOOTSPLASH, "bootsplash"}, |
| 48 | {CBFS_COMPONENT_RAW, "raw"}, |
| 49 | {CBFS_COMPONENT_VSA, "vsa"}, |
| 50 | {CBFS_COMPONENT_MBI, "mbi"}, |
| 51 | {CBFS_COMPONENT_MICROCODE, "microcode"}, |
| 52 | {CBFS_COMPONENT_CMOS_DEFAULT, "cmos_default"}, |
| 53 | {CBFS_COMPONENT_CMOS_LAYOUT, "cmos_layout"}, |
| 54 | {CBFS_COMPONENT_DELETED, "deleted"}, |
| 55 | {CBFS_COMPONENT_NULL, "null"}, |
| 56 | {0, NULL}, |
| 57 | }; |
| 58 | |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 59 | static const struct typedesc_t types_cbfs_compression[] = { |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 60 | {CBFS_COMPRESS_NONE, "none"}, |
| 61 | {CBFS_COMPRESS_LZMA, "LZMA"}, |
| 62 | {0, NULL}, |
| 63 | }; |
| 64 | |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 65 | static uint32_t align_up(uint32_t value, uint32_t align) |
| 66 | { |
| 67 | if (value % align) |
| 68 | value += align - (value % align); |
| 69 | return value; |
| 70 | } |
| 71 | |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 72 | static const char *lookup_name_by_type(const struct typedesc_t *desc, uint32_t type, |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 73 | const char *default_value) |
| 74 | { |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 75 | int i; |
| 76 | for (i = 0; desc[i].name; i++) |
| 77 | if (desc[i].type == type) |
| 78 | return desc[i].name; |
| 79 | return default_value; |
| 80 | } |
| 81 | |
Stefan Reinauer | 2dd161f | 2015-03-04 00:55:03 +0100 | [diff] [blame^] | 82 | static const char *get_cbfs_entry_type_name(uint32_t type) |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 83 | { |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 84 | return lookup_name_by_type(types_cbfs_entry, type, "(unknown)"); |
| 85 | } |
| 86 | |
Hung-Te Lin | c03d9b0 | 2013-01-29 02:38:40 +0800 | [diff] [blame] | 87 | /* CBFS image */ |
| 88 | |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 89 | static int cbfs_calculate_file_header_size(const char *name) |
| 90 | { |
Hung-Te Lin | c03d9b0 | 2013-01-29 02:38:40 +0800 | [diff] [blame] | 91 | return (sizeof(struct cbfs_file) + |
| 92 | align_up(strlen(name) + 1, CBFS_FILENAME_ALIGN)); |
| 93 | } |
| 94 | |
Alexandru Gagniuc | c1d1fd8 | 2014-02-05 01:10:08 -0600 | [diff] [blame] | 95 | static int cbfs_fix_legacy_size(struct cbfs_image *image, char *hdr_loc) |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 96 | { |
Hung-Te Lin | 49fcd75 | 2013-01-29 03:16:20 +0800 | [diff] [blame] | 97 | // A bug in old cbfstool may produce extra few bytes (by alignment) and |
| 98 | // cause cbfstool to overwrite things after free space -- which is |
| 99 | // usually CBFS header on x86. We need to workaround that. |
| 100 | |
| 101 | struct cbfs_file *entry, *first = NULL, *last = NULL; |
| 102 | for (first = entry = cbfs_find_first_entry(image); |
Hung-Te Lin | 408aefd | 2013-02-09 10:38:55 +0800 | [diff] [blame] | 103 | entry && cbfs_is_valid_entry(image, entry); |
Hung-Te Lin | 49fcd75 | 2013-01-29 03:16:20 +0800 | [diff] [blame] | 104 | entry = cbfs_find_next_entry(image, entry)) { |
| 105 | last = entry; |
| 106 | } |
Alexandru Gagniuc | c1d1fd8 | 2014-02-05 01:10:08 -0600 | [diff] [blame] | 107 | if ((char *)first < (char *)hdr_loc && |
| 108 | (char *)entry > (char *)hdr_loc) { |
Hung-Te Lin | 49fcd75 | 2013-01-29 03:16:20 +0800 | [diff] [blame] | 109 | WARN("CBFS image was created with old cbfstool with size bug. " |
| 110 | "Fixing size in last entry...\n"); |
Alexandru Gagniuc | c1d1fd8 | 2014-02-05 01:10:08 -0600 | [diff] [blame] | 111 | last->len = htonl(ntohl(last->len) - image->header->align); |
Hung-Te Lin | 49fcd75 | 2013-01-29 03:16:20 +0800 | [diff] [blame] | 112 | DEBUG("Last entry has been changed from 0x%x to 0x%x.\n", |
| 113 | cbfs_get_entry_addr(image, entry), |
| 114 | cbfs_get_entry_addr(image, |
| 115 | cbfs_find_next_entry(image, last))); |
| 116 | } |
| 117 | return 0; |
| 118 | } |
| 119 | |
Ronald G. Minnich | b5adeee | 2014-01-06 08:38:15 -0800 | [diff] [blame] | 120 | void cbfs_put_header(void *dest, const struct cbfs_header *header) |
| 121 | { |
| 122 | struct buffer outheader; |
| 123 | |
| 124 | outheader.data = dest; |
| 125 | outheader.size = 0; |
| 126 | |
| 127 | xdr_be.put32(&outheader, header->magic); |
| 128 | xdr_be.put32(&outheader, header->version); |
| 129 | xdr_be.put32(&outheader, header->romsize); |
| 130 | xdr_be.put32(&outheader, header->bootblocksize); |
| 131 | xdr_be.put32(&outheader, header->align); |
| 132 | xdr_be.put32(&outheader, header->offset); |
| 133 | xdr_be.put32(&outheader, header->architecture); |
| 134 | } |
Alexandru Gagniuc | c1d1fd8 | 2014-02-05 01:10:08 -0600 | [diff] [blame] | 135 | |
Hung-Te Lin | 0780d67 | 2014-05-16 10:14:05 +0800 | [diff] [blame] | 136 | static void cbfs_decode_payload_segment(struct cbfs_payload_segment *output, |
| 137 | struct cbfs_payload_segment *input) |
| 138 | { |
| 139 | struct buffer seg = { |
| 140 | .data = (void *)input, |
| 141 | .size = sizeof(*input), |
| 142 | }; |
| 143 | output->type = xdr_be.get32(&seg); |
| 144 | output->compression = xdr_be.get32(&seg); |
| 145 | output->offset = xdr_be.get32(&seg); |
| 146 | output->load_addr = xdr_be.get64(&seg); |
| 147 | output->len = xdr_be.get32(&seg); |
| 148 | output->mem_len = xdr_be.get32(&seg); |
| 149 | assert(seg.size == 0); |
| 150 | } |
| 151 | |
Alexandru Gagniuc | c1d1fd8 | 2014-02-05 01:10:08 -0600 | [diff] [blame] | 152 | void cbfs_get_header(struct cbfs_header *header, const void *src) |
| 153 | { |
| 154 | struct buffer outheader; |
| 155 | |
| 156 | outheader.data = (void *)src; /* We're not modifying the data */ |
| 157 | outheader.size = 0; |
| 158 | |
| 159 | header->magic = xdr_be.get32(&outheader); |
| 160 | header->version = xdr_be.get32(&outheader); |
| 161 | header->romsize = xdr_be.get32(&outheader); |
| 162 | header->bootblocksize = xdr_be.get32(&outheader); |
| 163 | header->align = xdr_be.get32(&outheader); |
| 164 | header->offset = xdr_be.get32(&outheader); |
| 165 | header->architecture = xdr_be.get32(&outheader); |
| 166 | } |
| 167 | |
Hung-Te Lin | f56c73f | 2013-01-29 09:45:12 +0800 | [diff] [blame] | 168 | int cbfs_image_create(struct cbfs_image *image, |
Stefan Reinauer | 2dd161f | 2015-03-04 00:55:03 +0100 | [diff] [blame^] | 169 | uint32_t architecture, |
Hung-Te Lin | f56c73f | 2013-01-29 09:45:12 +0800 | [diff] [blame] | 170 | size_t size, |
| 171 | uint32_t align, |
| 172 | struct buffer *bootblock, |
| 173 | int32_t bootblock_offset, |
| 174 | int32_t header_offset, |
| 175 | int32_t entries_offset) |
| 176 | { |
Ronald G. Minnich | b5adeee | 2014-01-06 08:38:15 -0800 | [diff] [blame] | 177 | struct cbfs_header header; |
Hung-Te Lin | f56c73f | 2013-01-29 09:45:12 +0800 | [diff] [blame] | 178 | struct cbfs_file *entry; |
| 179 | uint32_t cbfs_len; |
Hung-Te Lin | b02c873 | 2013-03-15 17:40:08 +0800 | [diff] [blame] | 180 | size_t entry_header_len; |
Alexandru Gagniuc | c1d1fd8 | 2014-02-05 01:10:08 -0600 | [diff] [blame] | 181 | void *header_loc; |
Hung-Te Lin | f56c73f | 2013-01-29 09:45:12 +0800 | [diff] [blame] | 182 | |
| 183 | DEBUG("cbfs_image_create: bootblock=0x%x+0x%zx, " |
| 184 | "header=0x%x+0x%zx, entries_offset=0x%x\n", |
| 185 | bootblock_offset, bootblock->size, |
Ronald G. Minnich | b5adeee | 2014-01-06 08:38:15 -0800 | [diff] [blame] | 186 | header_offset, sizeof(header), entries_offset); |
Hung-Te Lin | f56c73f | 2013-01-29 09:45:12 +0800 | [diff] [blame] | 187 | |
| 188 | if (buffer_create(&image->buffer, size, "(new)") != 0) |
| 189 | return -1; |
Alexandru Gagniuc | c1d1fd8 | 2014-02-05 01:10:08 -0600 | [diff] [blame] | 190 | if ((image->header = malloc(sizeof(*image->header))) == NULL) |
| 191 | return -1; |
Hung-Te Lin | f56c73f | 2013-01-29 09:45:12 +0800 | [diff] [blame] | 192 | memset(image->buffer.data, CBFS_CONTENT_DEFAULT_VALUE, size); |
| 193 | |
| 194 | // Adjust legcay top-aligned address to ROM offset. |
| 195 | if (IS_TOP_ALIGNED_ADDRESS(entries_offset)) |
| 196 | entries_offset += (int32_t)size; |
| 197 | if (IS_TOP_ALIGNED_ADDRESS(bootblock_offset)) |
| 198 | bootblock_offset += (int32_t)size; |
| 199 | if (IS_TOP_ALIGNED_ADDRESS(header_offset)) |
| 200 | header_offset += (int32_t) size; |
| 201 | |
| 202 | DEBUG("cbfs_create_image: (real offset) bootblock=0x%x, " |
| 203 | "header=0x%x, entries_offset=0x%x\n", |
| 204 | bootblock_offset, header_offset, entries_offset); |
| 205 | |
| 206 | if (align == 0) |
| 207 | align = 64; // default align size. |
| 208 | |
| 209 | // Prepare bootblock |
| 210 | if (bootblock_offset + bootblock->size > size) { |
| 211 | ERROR("Bootblock (0x%x+0x%zx) exceed ROM size (0x%zx)\n", |
| 212 | bootblock_offset, bootblock->size, size); |
| 213 | return -1; |
| 214 | } |
Hung-Te Lin | c5ff648 | 2013-02-06 12:41:49 +0800 | [diff] [blame] | 215 | if (entries_offset > bootblock_offset && |
| 216 | entries_offset < bootblock->size) { |
| 217 | ERROR("Bootblock (0x%x+0x%zx) overlap CBFS data (0x%x)\n", |
| 218 | bootblock_offset, bootblock->size, entries_offset); |
| 219 | return -1; |
| 220 | } |
Hung-Te Lin | f56c73f | 2013-01-29 09:45:12 +0800 | [diff] [blame] | 221 | memcpy(image->buffer.data + bootblock_offset, bootblock->data, |
| 222 | bootblock->size); |
| 223 | |
| 224 | // Prepare header |
Ronald G. Minnich | b5adeee | 2014-01-06 08:38:15 -0800 | [diff] [blame] | 225 | if (header_offset + sizeof(header) > size) { |
Hung-Te Lin | f56c73f | 2013-01-29 09:45:12 +0800 | [diff] [blame] | 226 | ERROR("Header (0x%x+0x%zx) exceed ROM size (0x%zx)\n", |
Ronald G. Minnich | b5adeee | 2014-01-06 08:38:15 -0800 | [diff] [blame] | 227 | header_offset, sizeof(header), size); |
Hung-Te Lin | f56c73f | 2013-01-29 09:45:12 +0800 | [diff] [blame] | 228 | return -1; |
| 229 | } |
Alexandru Gagniuc | c1d1fd8 | 2014-02-05 01:10:08 -0600 | [diff] [blame] | 230 | image->header->magic = CBFS_HEADER_MAGIC; |
| 231 | image->header->version = CBFS_HEADER_VERSION; |
| 232 | image->header->romsize = size; |
| 233 | image->header->bootblocksize = bootblock->size; |
| 234 | image->header->align = align; |
| 235 | image->header->offset = entries_offset; |
Stefan Reinauer | 2dd161f | 2015-03-04 00:55:03 +0100 | [diff] [blame^] | 236 | image->header->architecture = architecture; |
Alexandru Gagniuc | c1d1fd8 | 2014-02-05 01:10:08 -0600 | [diff] [blame] | 237 | |
| 238 | header_loc = (image->buffer.data + header_offset); |
| 239 | cbfs_put_header(header_loc, image->header); |
Hung-Te Lin | f56c73f | 2013-01-29 09:45:12 +0800 | [diff] [blame] | 240 | |
| 241 | // Prepare entries |
| 242 | if (align_up(entries_offset, align) != entries_offset) { |
| 243 | ERROR("Offset (0x%x) must be aligned to 0x%x.\n", |
| 244 | entries_offset, align); |
| 245 | return -1; |
| 246 | } |
Hung-Te Lin | b02c873 | 2013-03-15 17:40:08 +0800 | [diff] [blame] | 247 | entry_header_len = cbfs_calculate_file_header_size(""); |
| 248 | if (entries_offset + entry_header_len > size) { |
Hung-Te Lin | f56c73f | 2013-01-29 09:45:12 +0800 | [diff] [blame] | 249 | ERROR("Offset (0x%x+0x%zx) exceed ROM size(0x%zx)\n", |
Hung-Te Lin | b02c873 | 2013-03-15 17:40:08 +0800 | [diff] [blame] | 250 | entries_offset, entry_header_len, size); |
Hung-Te Lin | f56c73f | 2013-01-29 09:45:12 +0800 | [diff] [blame] | 251 | return -1; |
| 252 | } |
| 253 | entry = (struct cbfs_file *)(image->buffer.data + entries_offset); |
| 254 | // To calculate available length, find |
| 255 | // e = min(bootblock, header, size) where e > entries_offset. |
| 256 | cbfs_len = size; |
| 257 | if (bootblock_offset > entries_offset && bootblock_offset < cbfs_len) |
| 258 | cbfs_len = bootblock_offset; |
| 259 | if (header_offset > entries_offset && header_offset < cbfs_len) |
| 260 | cbfs_len = header_offset; |
Hung-Te Lin | b02c873 | 2013-03-15 17:40:08 +0800 | [diff] [blame] | 261 | cbfs_len -= entries_offset + align + entry_header_len; |
Hung-Te Lin | f56c73f | 2013-01-29 09:45:12 +0800 | [diff] [blame] | 262 | cbfs_create_empty_entry(image, entry, cbfs_len, ""); |
| 263 | LOG("Created CBFS image (capacity = %d bytes)\n", cbfs_len); |
| 264 | return 0; |
| 265 | } |
| 266 | |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 267 | int cbfs_image_from_file(struct cbfs_image *image, const char *filename) |
| 268 | { |
Alexandru Gagniuc | c1d1fd8 | 2014-02-05 01:10:08 -0600 | [diff] [blame] | 269 | void *header_loc; |
| 270 | |
Hung-Te Lin | eab2c81 | 2013-01-29 01:56:17 +0800 | [diff] [blame] | 271 | if (buffer_from_file(&image->buffer, filename) != 0) |
| 272 | return -1; |
| 273 | DEBUG("read_cbfs_image: %s (%zd bytes)\n", image->buffer.name, |
| 274 | image->buffer.size); |
Alexandru Gagniuc | c1d1fd8 | 2014-02-05 01:10:08 -0600 | [diff] [blame] | 275 | header_loc = cbfs_find_header(image->buffer.data, image->buffer.size); |
| 276 | if (!header_loc) { |
Hung-Te Lin | eab2c81 | 2013-01-29 01:56:17 +0800 | [diff] [blame] | 277 | ERROR("%s does not have CBFS master header.\n", filename); |
| 278 | cbfs_image_delete(image); |
| 279 | return -1; |
| 280 | } |
Alexandru Gagniuc | c1d1fd8 | 2014-02-05 01:10:08 -0600 | [diff] [blame] | 281 | |
| 282 | if ((image->header = malloc(sizeof(*image->header))) == NULL) |
| 283 | return -1; |
| 284 | |
| 285 | cbfs_get_header(image->header, header_loc); |
| 286 | cbfs_fix_legacy_size(image, header_loc); |
Hung-Te Lin | eab2c81 | 2013-01-29 01:56:17 +0800 | [diff] [blame] | 287 | |
| 288 | return 0; |
| 289 | } |
| 290 | |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 291 | int cbfs_image_write_file(struct cbfs_image *image, const char *filename) |
| 292 | { |
Hung-Te Lin | eab2c81 | 2013-01-29 01:56:17 +0800 | [diff] [blame] | 293 | assert(image && image->buffer.data); |
| 294 | return buffer_write_file(&image->buffer, filename); |
| 295 | } |
| 296 | |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 297 | int cbfs_image_delete(struct cbfs_image *image) |
| 298 | { |
Edward O'Callaghan | a0f9ece | 2014-03-09 00:05:18 +1100 | [diff] [blame] | 299 | if (image == NULL) |
| 300 | return 0; |
| 301 | |
Hung-Te Lin | eab2c81 | 2013-01-29 01:56:17 +0800 | [diff] [blame] | 302 | buffer_delete(&image->buffer); |
| 303 | image->header = NULL; |
| 304 | return 0; |
| 305 | } |
| 306 | |
Hung-Te Lin | 5f3eb26 | 2013-01-29 10:24:00 +0800 | [diff] [blame] | 307 | /* Tries to add an entry with its data (CBFS_SUBHEADER) at given offset. */ |
| 308 | static int cbfs_add_entry_at(struct cbfs_image *image, |
| 309 | struct cbfs_file *entry, |
| 310 | uint32_t size, |
| 311 | const char *name, |
| 312 | uint32_t type, |
| 313 | const void *data, |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 314 | uint32_t content_offset) |
| 315 | { |
Hung-Te Lin | 5f3eb26 | 2013-01-29 10:24:00 +0800 | [diff] [blame] | 316 | struct cbfs_file *next = cbfs_find_next_entry(image, entry); |
| 317 | uint32_t addr = cbfs_get_entry_addr(image, entry), |
| 318 | addr_next = cbfs_get_entry_addr(image, next); |
| 319 | uint32_t header_size = cbfs_calculate_file_header_size(name), |
| 320 | min_entry_size = cbfs_calculate_file_header_size(""); |
| 321 | uint32_t len, target; |
Alexandru Gagniuc | c1d1fd8 | 2014-02-05 01:10:08 -0600 | [diff] [blame] | 322 | uint32_t align = image->header->align; |
Hung-Te Lin | 5f3eb26 | 2013-01-29 10:24:00 +0800 | [diff] [blame] | 323 | |
| 324 | target = content_offset - header_size; |
| 325 | if (target % align) |
| 326 | target -= target % align; |
| 327 | if (target < addr) { |
| 328 | ERROR("No space to hold cbfs_file header."); |
| 329 | return -1; |
| 330 | } |
| 331 | |
| 332 | // Process buffer BEFORE content_offset. |
| 333 | if (target - addr > min_entry_size) { |
| 334 | DEBUG("|min|...|header|content|... <create new entry>\n"); |
| 335 | len = target - addr - min_entry_size; |
| 336 | cbfs_create_empty_entry(image, entry, len, ""); |
| 337 | if (verbose > 1) cbfs_print_entry_info(image, entry, stderr); |
| 338 | entry = cbfs_find_next_entry(image, entry); |
| 339 | addr = cbfs_get_entry_addr(image, entry); |
| 340 | } |
| 341 | |
| 342 | len = size + (content_offset - addr - header_size); |
| 343 | cbfs_create_empty_entry(image, entry, len, name); |
| 344 | if (len != size) { |
| 345 | DEBUG("|..|header|content|... <use offset to create entry>\n"); |
| 346 | DEBUG("before: offset=0x%x, len=0x%x\n", |
| 347 | ntohl(entry->offset), ntohl(entry->len)); |
| 348 | // TODO reset expanded name buffer to 0xFF. |
| 349 | entry->offset = htonl(ntohl(entry->offset) + (len - size)); |
| 350 | entry->len = htonl(size); |
| 351 | DEBUG("after: offset=0x%x, len=0x%x\n", |
| 352 | ntohl(entry->offset), ntohl(entry->len)); |
| 353 | } |
| 354 | |
| 355 | // Ready to fill data into entry. |
| 356 | assert(ntohl(entry->len) == size); |
| 357 | entry->type = htonl(type); |
| 358 | DEBUG("content_offset: 0x%x, entry location: %x\n", |
| 359 | content_offset, (int)((char*)CBFS_SUBHEADER(entry) - |
| 360 | image->buffer.data)); |
| 361 | assert((char*)CBFS_SUBHEADER(entry) - image->buffer.data == |
| 362 | content_offset); |
| 363 | memcpy(CBFS_SUBHEADER(entry), data, size); |
| 364 | if (verbose > 1) cbfs_print_entry_info(image, entry, stderr); |
| 365 | |
| 366 | // Process buffer AFTER entry. |
| 367 | entry = cbfs_find_next_entry(image, entry); |
| 368 | addr = cbfs_get_entry_addr(image, entry); |
| 369 | assert(addr < addr_next); |
| 370 | |
| 371 | if (addr_next - addr < min_entry_size) { |
| 372 | DEBUG("No space after content to keep CBFS structure.\n"); |
| 373 | return -1; |
| 374 | } |
| 375 | |
| 376 | len = addr_next - addr - min_entry_size; |
| 377 | cbfs_create_empty_entry(image, entry, len, ""); |
| 378 | if (verbose > 1) cbfs_print_entry_info(image, entry, stderr); |
| 379 | return 0; |
| 380 | } |
| 381 | |
| 382 | int cbfs_add_entry(struct cbfs_image *image, struct buffer *buffer, |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 383 | const char *name, uint32_t type, uint32_t content_offset) |
| 384 | { |
Hung-Te Lin | 5f3eb26 | 2013-01-29 10:24:00 +0800 | [diff] [blame] | 385 | uint32_t entry_type; |
| 386 | uint32_t addr, addr_next; |
| 387 | struct cbfs_file *entry, *next; |
| 388 | uint32_t header_size, need_size, new_size; |
| 389 | |
| 390 | header_size = cbfs_calculate_file_header_size(name); |
| 391 | |
| 392 | need_size = header_size + buffer->size; |
| 393 | DEBUG("cbfs_add_entry('%s'@0x%x) => need_size = %u+%zu=%u\n", |
| 394 | name, content_offset, header_size, buffer->size, need_size); |
| 395 | |
| 396 | if (IS_TOP_ALIGNED_ADDRESS(content_offset)) { |
| 397 | // legacy cbfstool takes top-aligned address. |
Alexandru Gagniuc | c1d1fd8 | 2014-02-05 01:10:08 -0600 | [diff] [blame] | 398 | uint32_t theromsize = image->header->romsize; |
Hung-Te Lin | 5f3eb26 | 2013-01-29 10:24:00 +0800 | [diff] [blame] | 399 | INFO("Converting top-aligned address 0x%x to offset: 0x%x\n", |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 400 | content_offset, content_offset + theromsize); |
| 401 | content_offset += theromsize; |
Hung-Te Lin | 5f3eb26 | 2013-01-29 10:24:00 +0800 | [diff] [blame] | 402 | } |
| 403 | |
| 404 | // Merge empty entries. |
| 405 | DEBUG("(trying to merge empty entries...)\n"); |
| 406 | cbfs_walk(image, cbfs_merge_empty_entry, NULL); |
| 407 | |
| 408 | for (entry = cbfs_find_first_entry(image); |
Hung-Te Lin | 408aefd | 2013-02-09 10:38:55 +0800 | [diff] [blame] | 409 | entry && cbfs_is_valid_entry(image, entry); |
Hung-Te Lin | 5f3eb26 | 2013-01-29 10:24:00 +0800 | [diff] [blame] | 410 | entry = cbfs_find_next_entry(image, entry)) { |
| 411 | |
| 412 | entry_type = ntohl(entry->type); |
| 413 | if (entry_type != CBFS_COMPONENT_NULL) |
| 414 | continue; |
| 415 | |
| 416 | addr = cbfs_get_entry_addr(image, entry); |
| 417 | next = cbfs_find_next_entry(image, entry); |
| 418 | addr_next = cbfs_get_entry_addr(image, next); |
| 419 | |
| 420 | DEBUG("cbfs_add_entry: space at 0x%x+0x%x(%d) bytes\n", |
| 421 | addr, addr_next - addr, addr_next - addr); |
Aaron Durbin | 1ebc7e9 | 2014-01-21 15:28:38 -0600 | [diff] [blame] | 422 | |
| 423 | /* Will the file fit? Don't yet worry if we have space for a new |
| 424 | * "empty" entry. We take care of that later. |
| 425 | */ |
Hung-Te Lin | 5f3eb26 | 2013-01-29 10:24:00 +0800 | [diff] [blame] | 426 | if (addr + need_size > addr_next) |
| 427 | continue; |
| 428 | |
| 429 | // Can we simply put object here? |
| 430 | if (!content_offset || content_offset == addr + header_size) { |
| 431 | DEBUG("Filling new entry data (%zd bytes).\n", |
| 432 | buffer->size); |
| 433 | cbfs_create_empty_entry(image, entry, buffer->size, |
| 434 | name); |
| 435 | entry->type = htonl(type); |
| 436 | memcpy(CBFS_SUBHEADER(entry), buffer->data, buffer->size); |
| 437 | if (verbose) |
| 438 | cbfs_print_entry_info(image, entry, stderr); |
| 439 | |
| 440 | // setup new entry |
Paul Menzel | 4159a80 | 2013-07-14 00:24:31 +0200 | [diff] [blame] | 441 | DEBUG("Setting new empty entry.\n"); |
Hung-Te Lin | 5f3eb26 | 2013-01-29 10:24:00 +0800 | [diff] [blame] | 442 | entry = cbfs_find_next_entry(image, entry); |
| 443 | new_size = (cbfs_get_entry_addr(image, next) - |
| 444 | cbfs_get_entry_addr(image, entry)); |
Aaron Durbin | 1ebc7e9 | 2014-01-21 15:28:38 -0600 | [diff] [blame] | 445 | |
| 446 | /* Entry was added and no space for new "empty" entry */ |
| 447 | if (new_size < cbfs_calculate_file_header_size("")) { |
| 448 | DEBUG("No need for new \"empty\" entry\n"); |
| 449 | /* No need to increase the size of the just |
| 450 | * stored file to extend to next file. Alignment |
| 451 | * of next file takes care of this. |
| 452 | */ |
| 453 | return 0; |
| 454 | } |
Hung-Te Lin | 5f3eb26 | 2013-01-29 10:24:00 +0800 | [diff] [blame] | 455 | new_size -= cbfs_calculate_file_header_size(""); |
| 456 | DEBUG("new size: %d\n", new_size); |
| 457 | cbfs_create_empty_entry(image, entry, new_size, ""); |
| 458 | if (verbose) |
| 459 | cbfs_print_entry_info(image, entry, stderr); |
| 460 | return 0; |
| 461 | } |
| 462 | |
| 463 | // We need to put content here, and the case is really |
| 464 | // complicated... |
| 465 | assert(content_offset); |
| 466 | if (addr_next < content_offset) { |
| 467 | DEBUG("Not for specified offset yet"); |
| 468 | continue; |
| 469 | } else if (addr > content_offset) { |
| 470 | DEBUG("Exceed specified content_offset."); |
| 471 | break; |
| 472 | } else if (addr + header_size > content_offset) { |
| 473 | ERROR("Not enough space for header.\n"); |
| 474 | break; |
| 475 | } else if (content_offset + buffer->size > addr_next) { |
| 476 | ERROR("Not enough space for content.\n"); |
| 477 | break; |
| 478 | } |
| 479 | |
| 480 | // TODO there are more few tricky cases that we may |
| 481 | // want to fit by altering offset. |
| 482 | DEBUG("section 0x%x+0x%x for content_offset 0x%x.\n", |
| 483 | addr, addr_next - addr, content_offset); |
| 484 | |
| 485 | if (cbfs_add_entry_at(image, entry, buffer->size, name, type, |
| 486 | buffer->data, content_offset) == 0) { |
| 487 | return 0; |
| 488 | } |
| 489 | break; |
| 490 | } |
| 491 | |
| 492 | ERROR("Could not add [%s, %zd bytes (%zd KB)@0x%x]; too big?\n", |
| 493 | buffer->name, buffer->size, buffer->size / 1024, content_offset); |
| 494 | return -1; |
| 495 | } |
| 496 | |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 497 | struct cbfs_file *cbfs_get_entry(struct cbfs_image *image, const char *name) |
| 498 | { |
Hung-Te Lin | 0f8af71 | 2013-01-29 02:29:49 +0800 | [diff] [blame] | 499 | struct cbfs_file *entry; |
| 500 | for (entry = cbfs_find_first_entry(image); |
Hung-Te Lin | 408aefd | 2013-02-09 10:38:55 +0800 | [diff] [blame] | 501 | entry && cbfs_is_valid_entry(image, entry); |
Hung-Te Lin | 0f8af71 | 2013-01-29 02:29:49 +0800 | [diff] [blame] | 502 | entry = cbfs_find_next_entry(image, entry)) { |
| 503 | if (strcasecmp(CBFS_NAME(entry), name) == 0) { |
| 504 | DEBUG("cbfs_get_entry: found %s\n", name); |
| 505 | return entry; |
| 506 | } |
| 507 | } |
| 508 | return NULL; |
| 509 | } |
| 510 | |
| 511 | int cbfs_export_entry(struct cbfs_image *image, const char *entry_name, |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 512 | const char *filename) |
| 513 | { |
Hung-Te Lin | 0f8af71 | 2013-01-29 02:29:49 +0800 | [diff] [blame] | 514 | struct cbfs_file *entry = cbfs_get_entry(image, entry_name); |
| 515 | struct buffer buffer; |
| 516 | if (!entry) { |
| 517 | ERROR("File not found: %s\n", entry_name); |
| 518 | return -1; |
| 519 | } |
| 520 | LOG("Found file %.30s at 0x%x, type %.12s, size %d\n", |
| 521 | entry_name, cbfs_get_entry_addr(image, entry), |
| 522 | get_cbfs_entry_type_name(ntohl(entry->type)), ntohl(entry->len)); |
| 523 | |
| 524 | if (ntohl(entry->type) != CBFS_COMPONENT_RAW) { |
| 525 | WARN("Only 'raw' files are safe to extract.\n"); |
| 526 | } |
| 527 | |
| 528 | buffer.data = CBFS_SUBHEADER(entry); |
| 529 | buffer.size = ntohl(entry->len); |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 530 | buffer.name = (char *)"(cbfs_export_entry)"; |
Hung-Te Lin | 0f8af71 | 2013-01-29 02:29:49 +0800 | [diff] [blame] | 531 | if (buffer_write_file(&buffer, filename) != 0) { |
| 532 | ERROR("Failed to write %s into %s.\n", |
| 533 | entry_name, filename); |
| 534 | return -1; |
| 535 | } |
| 536 | INFO("Successfully dumped the file to: %s\n", filename); |
| 537 | return 0; |
| 538 | } |
| 539 | |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 540 | int cbfs_remove_entry(struct cbfs_image *image, const char *name) |
| 541 | { |
Hung-Te Lin | c03d9b0 | 2013-01-29 02:38:40 +0800 | [diff] [blame] | 542 | struct cbfs_file *entry, *next; |
| 543 | size_t len; |
| 544 | entry = cbfs_get_entry(image, name); |
| 545 | if (!entry) { |
| 546 | ERROR("CBFS file %s not found.\n", name); |
| 547 | return -1; |
| 548 | } |
| 549 | next = cbfs_find_next_entry(image, entry); |
| 550 | assert(next); |
| 551 | DEBUG("cbfs_remove_entry: Removed %s @ 0x%x\n", |
| 552 | CBFS_NAME(entry), cbfs_get_entry_addr(image, entry)); |
| 553 | entry->type = htonl(CBFS_COMPONENT_DELETED); |
| 554 | len = (cbfs_get_entry_addr(image, next) - |
| 555 | cbfs_get_entry_addr(image, entry)); |
| 556 | entry->offset = htonl(cbfs_calculate_file_header_size("")); |
| 557 | entry->len = htonl(len - ntohl(entry->offset)); |
| 558 | memset(CBFS_NAME(entry), 0, ntohl(entry->offset) - sizeof(*entry)); |
| 559 | memset(CBFS_SUBHEADER(entry), CBFS_CONTENT_DEFAULT_VALUE, |
| 560 | ntohl(entry->len)); |
| 561 | return 0; |
| 562 | } |
| 563 | |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 564 | int cbfs_print_header_info(struct cbfs_image *image) |
| 565 | { |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 566 | char *name = strdup(image->buffer.name); |
| 567 | assert(image && image->header); |
| 568 | printf("%s: %zd kB, bootblocksize %d, romsize %d, offset 0x%x\n" |
Stefan Reinauer | 8f50e53 | 2013-11-13 14:34:57 -0800 | [diff] [blame] | 569 | "alignment: %d bytes, architecture: %s\n\n", |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 570 | basename(name), |
| 571 | image->buffer.size / 1024, |
Alexandru Gagniuc | c1d1fd8 | 2014-02-05 01:10:08 -0600 | [diff] [blame] | 572 | image->header->bootblocksize, |
| 573 | image->header->romsize, |
| 574 | image->header->offset, |
Stefan Reinauer | 8f50e53 | 2013-11-13 14:34:57 -0800 | [diff] [blame] | 575 | image->header->align, |
| 576 | arch_to_string(image->header->architecture)); |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 577 | free(name); |
| 578 | return 0; |
| 579 | } |
| 580 | |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 581 | static int cbfs_print_stage_info(struct cbfs_stage *stage, FILE* fp) |
| 582 | { |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 583 | fprintf(fp, |
| 584 | " %s compression, entry: 0x%" PRIx64 ", load: 0x%" PRIx64 ", " |
| 585 | "length: %d/%d\n", |
| 586 | lookup_name_by_type(types_cbfs_compression, |
| 587 | stage->compression, "(unknown)"), |
| 588 | stage->entry, |
| 589 | stage->load, |
| 590 | stage->len, |
| 591 | stage->memlen); |
| 592 | return 0; |
| 593 | } |
| 594 | |
Hung-Te Lin | 0780d67 | 2014-05-16 10:14:05 +0800 | [diff] [blame] | 595 | static int cbfs_print_decoded_payload_segment_info( |
| 596 | struct cbfs_payload_segment *seg, FILE *fp) |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 597 | { |
Hung-Te Lin | 0780d67 | 2014-05-16 10:14:05 +0800 | [diff] [blame] | 598 | /* The input (seg) must be already decoded by |
| 599 | * cbfs_decode_payload_segment. |
| 600 | */ |
| 601 | switch (seg->type) { |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 602 | case PAYLOAD_SEGMENT_CODE: |
| 603 | case PAYLOAD_SEGMENT_DATA: |
| 604 | fprintf(fp, " %s (%s compression, offset: 0x%x, " |
| 605 | "load: 0x%" PRIx64 ", length: %d/%d)\n", |
Hung-Te Lin | 0780d67 | 2014-05-16 10:14:05 +0800 | [diff] [blame] | 606 | (seg->type == PAYLOAD_SEGMENT_CODE ? |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 607 | "code " : "data"), |
| 608 | lookup_name_by_type(types_cbfs_compression, |
Hung-Te Lin | 0780d67 | 2014-05-16 10:14:05 +0800 | [diff] [blame] | 609 | seg->compression, |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 610 | "(unknown)"), |
Hung-Te Lin | 0780d67 | 2014-05-16 10:14:05 +0800 | [diff] [blame] | 611 | seg->offset, seg->load_addr, seg->len, |
| 612 | seg->mem_len); |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 613 | break; |
| 614 | |
| 615 | case PAYLOAD_SEGMENT_ENTRY: |
| 616 | fprintf(fp, " entry (0x%" PRIx64 ")\n", |
Hung-Te Lin | 0780d67 | 2014-05-16 10:14:05 +0800 | [diff] [blame] | 617 | seg->load_addr); |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 618 | break; |
| 619 | |
| 620 | case PAYLOAD_SEGMENT_BSS: |
| 621 | fprintf(fp, " BSS (address 0x%016" PRIx64 ", " |
| 622 | "length 0x%x)\n", |
Hung-Te Lin | 0780d67 | 2014-05-16 10:14:05 +0800 | [diff] [blame] | 623 | seg->load_addr, seg->len); |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 624 | break; |
| 625 | |
| 626 | case PAYLOAD_SEGMENT_PARAMS: |
| 627 | fprintf(fp, " parameters\n"); |
| 628 | break; |
| 629 | |
| 630 | default: |
| 631 | fprintf(fp, " 0x%x (%s compression, offset: 0x%x, " |
| 632 | "load: 0x%" PRIx64 ", length: %d/%d\n", |
Hung-Te Lin | 0780d67 | 2014-05-16 10:14:05 +0800 | [diff] [blame] | 633 | seg->type, |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 634 | lookup_name_by_type(types_cbfs_compression, |
Hung-Te Lin | 0780d67 | 2014-05-16 10:14:05 +0800 | [diff] [blame] | 635 | seg->compression, |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 636 | "(unknown)"), |
Hung-Te Lin | 0780d67 | 2014-05-16 10:14:05 +0800 | [diff] [blame] | 637 | seg->offset, seg->load_addr, seg->len, |
| 638 | seg->mem_len); |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 639 | break; |
| 640 | } |
| 641 | return 0; |
| 642 | } |
| 643 | |
| 644 | int cbfs_print_entry_info(struct cbfs_image *image, struct cbfs_file *entry, |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 645 | void *arg) |
| 646 | { |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 647 | const char *name = CBFS_NAME(entry); |
| 648 | struct cbfs_payload_segment *payload; |
| 649 | FILE *fp = (FILE *)arg; |
| 650 | |
Hung-Te Lin | 408aefd | 2013-02-09 10:38:55 +0800 | [diff] [blame] | 651 | if (!cbfs_is_valid_entry(image, entry)) { |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 652 | ERROR("cbfs_print_entry_info: Invalid entry at 0x%x\n", |
| 653 | cbfs_get_entry_addr(image, entry)); |
| 654 | return -1; |
| 655 | } |
| 656 | if (!fp) |
| 657 | fp = stdout; |
| 658 | |
| 659 | fprintf(fp, "%-30s 0x%-8x %-12s %d\n", |
| 660 | *name ? name : "(empty)", |
| 661 | cbfs_get_entry_addr(image, entry), |
| 662 | get_cbfs_entry_type_name(ntohl(entry->type)), |
| 663 | ntohl(entry->len)); |
| 664 | |
| 665 | if (!verbose) |
| 666 | return 0; |
| 667 | |
| 668 | DEBUG(" cbfs_file=0x%x, offset=0x%x, content_address=0x%x+0x%x\n", |
| 669 | cbfs_get_entry_addr(image, entry), ntohl(entry->offset), |
| 670 | cbfs_get_entry_addr(image, entry) + ntohl(entry->offset), |
| 671 | ntohl(entry->len)); |
| 672 | |
| 673 | /* note the components of the subheader may be in host order ... */ |
| 674 | switch (ntohl(entry->type)) { |
| 675 | case CBFS_COMPONENT_STAGE: |
| 676 | cbfs_print_stage_info((struct cbfs_stage *) |
| 677 | CBFS_SUBHEADER(entry), fp); |
| 678 | break; |
| 679 | |
| 680 | case CBFS_COMPONENT_PAYLOAD: |
| 681 | payload = (struct cbfs_payload_segment *) |
| 682 | CBFS_SUBHEADER(entry); |
| 683 | while (payload) { |
Hung-Te Lin | 0780d67 | 2014-05-16 10:14:05 +0800 | [diff] [blame] | 684 | struct cbfs_payload_segment seg; |
| 685 | cbfs_decode_payload_segment(&seg, payload); |
| 686 | cbfs_print_decoded_payload_segment_info( |
| 687 | &seg, fp); |
| 688 | if (seg.type == PAYLOAD_SEGMENT_ENTRY) |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 689 | break; |
Hung-Te Lin | 0780d67 | 2014-05-16 10:14:05 +0800 | [diff] [blame] | 690 | else |
Aaron Durbin | ca63027 | 2014-08-05 10:48:20 -0500 | [diff] [blame] | 691 | payload ++; |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 692 | } |
| 693 | break; |
| 694 | default: |
| 695 | break; |
| 696 | } |
| 697 | return 0; |
| 698 | } |
| 699 | |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 700 | int cbfs_print_directory(struct cbfs_image *image) |
| 701 | { |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 702 | cbfs_print_header_info(image); |
| 703 | printf("%-30s %-10s %-12s Size\n", "Name", "Offset", "Type"); |
| 704 | cbfs_walk(image, cbfs_print_entry_info, NULL); |
| 705 | return 0; |
| 706 | } |
| 707 | |
Hung-Te Lin | 215d1d7 | 2013-01-29 03:46:02 +0800 | [diff] [blame] | 708 | int cbfs_merge_empty_entry(struct cbfs_image *image, struct cbfs_file *entry, |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 709 | void *arg) |
| 710 | { |
Hung-Te Lin | 215d1d7 | 2013-01-29 03:46:02 +0800 | [diff] [blame] | 711 | struct cbfs_file *next; |
| 712 | uint32_t type, addr, last_addr; |
| 713 | |
| 714 | type = ntohl(entry->type); |
| 715 | if (type == CBFS_COMPONENT_DELETED) { |
| 716 | // Ready to be recycled. |
| 717 | type = CBFS_COMPONENT_NULL; |
| 718 | entry->type = htonl(type); |
| 719 | } |
| 720 | if (type != CBFS_COMPONENT_NULL) |
| 721 | return 0; |
| 722 | |
| 723 | next = cbfs_find_next_entry(image, entry); |
| 724 | |
Hung-Te Lin | 408aefd | 2013-02-09 10:38:55 +0800 | [diff] [blame] | 725 | while (next && cbfs_is_valid_entry(image, next)) { |
Hung-Te Lin | 215d1d7 | 2013-01-29 03:46:02 +0800 | [diff] [blame] | 726 | type = ntohl(next->type); |
| 727 | if (type == CBFS_COMPONENT_DELETED) { |
| 728 | type = CBFS_COMPONENT_NULL; |
| 729 | next->type = htonl(type); |
| 730 | } |
| 731 | if (type != CBFS_COMPONENT_NULL) |
| 732 | return 0; |
| 733 | |
| 734 | addr = cbfs_get_entry_addr(image, entry); |
| 735 | last_addr = cbfs_get_entry_addr( |
| 736 | image, cbfs_find_next_entry(image, next)); |
| 737 | |
| 738 | // Now, we find two deleted/empty entries; try to merge now. |
| 739 | DEBUG("join_empty_entry: combine 0x%x+0x%x and 0x%x+0x%x.\n", |
| 740 | cbfs_get_entry_addr(image, entry), ntohl(entry->len), |
| 741 | cbfs_get_entry_addr(image, next), ntohl(next->len)); |
| 742 | cbfs_create_empty_entry(image, entry, |
| 743 | (last_addr - addr - |
| 744 | cbfs_calculate_file_header_size("")), |
| 745 | ""); |
| 746 | DEBUG("new empty entry: length=0x%x\n", ntohl(entry->len)); |
| 747 | next = cbfs_find_next_entry(image, entry); |
| 748 | } |
| 749 | return 0; |
| 750 | } |
| 751 | |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 752 | int cbfs_walk(struct cbfs_image *image, cbfs_entry_callback callback, |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 753 | void *arg) |
| 754 | { |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 755 | int count = 0; |
| 756 | struct cbfs_file *entry; |
| 757 | for (entry = cbfs_find_first_entry(image); |
Hung-Te Lin | 408aefd | 2013-02-09 10:38:55 +0800 | [diff] [blame] | 758 | entry && cbfs_is_valid_entry(image, entry); |
Hung-Te Lin | 3bb035b | 2013-01-29 02:15:49 +0800 | [diff] [blame] | 759 | entry = cbfs_find_next_entry(image, entry)) { |
| 760 | count ++; |
| 761 | if (callback(image, entry, arg) != 0) |
| 762 | break; |
| 763 | } |
| 764 | return count; |
| 765 | } |
| 766 | |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 767 | struct cbfs_header *cbfs_find_header(char *data, size_t size) |
| 768 | { |
Hung-Te Lin | eab2c81 | 2013-01-29 01:56:17 +0800 | [diff] [blame] | 769 | size_t offset; |
| 770 | int found = 0; |
| 771 | uint32_t x86sig; |
| 772 | struct cbfs_header *header, *result = NULL; |
| 773 | |
| 774 | // Try x86 style (check signature in bottom) header first. |
| 775 | x86sig = *(uint32_t *)(data + size - sizeof(uint32_t)); |
| 776 | offset = (x86sig + (uint32_t)size); |
| 777 | DEBUG("x86sig: 0x%x, offset: 0x%zx\n", x86sig, offset); |
| 778 | if (offset >= size - sizeof(*header) || |
| 779 | ntohl(((struct cbfs_header *)(data + offset))->magic) != |
| 780 | CBFS_HEADER_MAGIC) |
| 781 | offset = 0; |
| 782 | |
| 783 | for (; offset + sizeof(*header) < size; offset++) { |
| 784 | header = (struct cbfs_header *)(data + offset); |
| 785 | if (ntohl(header->magic) !=(CBFS_HEADER_MAGIC)) |
| 786 | continue; |
| 787 | if (ntohl(header->version) != CBFS_HEADER_VERSION1 && |
| 788 | ntohl(header->version) != CBFS_HEADER_VERSION2) { |
| 789 | // Probably not a real CBFS header? |
| 790 | continue; |
| 791 | } |
| 792 | found++; |
| 793 | result = header; |
| 794 | } |
| 795 | if (found > 1) { |
| 796 | ERROR("multiple (%d) CBFS headers found!\n", |
| 797 | found); |
| 798 | result = NULL; |
| 799 | } |
| 800 | return result; |
| 801 | } |
| 802 | |
| 803 | |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 804 | struct cbfs_file *cbfs_find_first_entry(struct cbfs_image *image) |
| 805 | { |
Hung-Te Lin | eab2c81 | 2013-01-29 01:56:17 +0800 | [diff] [blame] | 806 | assert(image && image->header); |
| 807 | return (struct cbfs_file *)(image->buffer.data + |
Alexandru Gagniuc | c1d1fd8 | 2014-02-05 01:10:08 -0600 | [diff] [blame] | 808 | image->header->offset); |
Hung-Te Lin | eab2c81 | 2013-01-29 01:56:17 +0800 | [diff] [blame] | 809 | } |
| 810 | |
| 811 | struct cbfs_file *cbfs_find_next_entry(struct cbfs_image *image, |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 812 | struct cbfs_file *entry) |
| 813 | { |
Hung-Te Lin | eab2c81 | 2013-01-29 01:56:17 +0800 | [diff] [blame] | 814 | uint32_t addr = cbfs_get_entry_addr(image, entry); |
Alexandru Gagniuc | c1d1fd8 | 2014-02-05 01:10:08 -0600 | [diff] [blame] | 815 | int align = image->header->align; |
Hung-Te Lin | 408aefd | 2013-02-09 10:38:55 +0800 | [diff] [blame] | 816 | assert(entry && cbfs_is_valid_entry(image, entry)); |
Hung-Te Lin | eab2c81 | 2013-01-29 01:56:17 +0800 | [diff] [blame] | 817 | addr += ntohl(entry->offset) + ntohl(entry->len); |
| 818 | addr = align_up(addr, align); |
| 819 | return (struct cbfs_file *)(image->buffer.data + addr); |
| 820 | } |
| 821 | |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 822 | uint32_t cbfs_get_entry_addr(struct cbfs_image *image, struct cbfs_file *entry) |
| 823 | { |
Hung-Te Lin | eab2c81 | 2013-01-29 01:56:17 +0800 | [diff] [blame] | 824 | assert(image && image->buffer.data && entry); |
| 825 | return (int32_t)((char *)entry - image->buffer.data); |
| 826 | } |
| 827 | |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 828 | int cbfs_is_valid_entry(struct cbfs_image *image, struct cbfs_file *entry) |
| 829 | { |
Hung-Te Lin | 408aefd | 2013-02-09 10:38:55 +0800 | [diff] [blame] | 830 | return (entry && |
| 831 | (char *)entry >= image->buffer.data && |
| 832 | (char *)entry + sizeof(entry->magic) < |
| 833 | image->buffer.data + image->buffer.size && |
| 834 | memcmp(entry->magic, CBFS_FILE_MAGIC, |
| 835 | sizeof(entry->magic)) == 0); |
Hung-Te Lin | eab2c81 | 2013-01-29 01:56:17 +0800 | [diff] [blame] | 836 | } |
| 837 | |
Hung-Te Lin | 215d1d7 | 2013-01-29 03:46:02 +0800 | [diff] [blame] | 838 | int cbfs_create_empty_entry(struct cbfs_image *image, struct cbfs_file *entry, |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 839 | size_t len, const char *name) |
| 840 | { |
Hung-Te Lin | 215d1d7 | 2013-01-29 03:46:02 +0800 | [diff] [blame] | 841 | memset(entry, CBFS_CONTENT_DEFAULT_VALUE, sizeof(*entry)); |
| 842 | memcpy(entry->magic, CBFS_FILE_MAGIC, sizeof(entry->magic)); |
| 843 | entry->type = htonl(CBFS_COMPONENT_NULL); |
| 844 | entry->len = htonl(len); |
| 845 | entry->checksum = 0; // TODO Build a checksum algorithm. |
| 846 | entry->offset = htonl(cbfs_calculate_file_header_size(name)); |
| 847 | memset(CBFS_NAME(entry), 0, ntohl(entry->offset) - sizeof(*entry)); |
| 848 | strcpy(CBFS_NAME(entry), name); |
| 849 | memset(CBFS_SUBHEADER(entry), CBFS_CONTENT_DEFAULT_VALUE, len); |
| 850 | return 0; |
| 851 | } |
| 852 | |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 853 | /* Finds a place to hold whole data in same memory page. */ |
| 854 | static int is_in_same_page(uint32_t start, uint32_t size, uint32_t page) |
| 855 | { |
Hung-Te Lin | 215d1d7 | 2013-01-29 03:46:02 +0800 | [diff] [blame] | 856 | if (!page) |
| 857 | return 1; |
| 858 | return (start / page) == (start + size - 1) / page; |
| 859 | } |
| 860 | |
Hung-Te Lin | e4ea2ca | 2013-03-19 12:24:43 +0800 | [diff] [blame] | 861 | /* Tests if data can fit in a range by given offset: |
| 862 | * start ->| header_len | offset (+ size) |<- end |
| 863 | */ |
| 864 | static int is_in_range(uint32_t start, uint32_t end, uint32_t header_len, |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 865 | uint32_t offset, uint32_t size) |
| 866 | { |
Hung-Te Lin | e4ea2ca | 2013-03-19 12:24:43 +0800 | [diff] [blame] | 867 | return (offset >= start + header_len && offset + size <= end); |
| 868 | } |
| 869 | |
Hung-Te Lin | 215d1d7 | 2013-01-29 03:46:02 +0800 | [diff] [blame] | 870 | int32_t cbfs_locate_entry(struct cbfs_image *image, const char *name, |
Stefan Reinauer | dc7bc8e | 2013-03-26 12:51:36 -0700 | [diff] [blame] | 871 | uint32_t size, uint32_t page_size, uint32_t align) |
| 872 | { |
Hung-Te Lin | 215d1d7 | 2013-01-29 03:46:02 +0800 | [diff] [blame] | 873 | struct cbfs_file *entry; |
| 874 | size_t need_len; |
Hung-Te Lin | e4ea2ca | 2013-03-19 12:24:43 +0800 | [diff] [blame] | 875 | uint32_t addr, addr_next, addr2, addr3, offset, header_len; |
| 876 | |
| 877 | /* Default values: allow fitting anywhere in ROM. */ |
| 878 | if (!page_size) |
Alexandru Gagniuc | c1d1fd8 | 2014-02-05 01:10:08 -0600 | [diff] [blame] | 879 | page_size = image->header->romsize; |
Hung-Te Lin | e4ea2ca | 2013-03-19 12:24:43 +0800 | [diff] [blame] | 880 | if (!align) |
| 881 | align = 1; |
| 882 | |
| 883 | if (size > page_size) |
| 884 | ERROR("Input file size (%d) greater than page size (%d).\n", |
| 885 | size, page_size); |
Hung-Te Lin | 215d1d7 | 2013-01-29 03:46:02 +0800 | [diff] [blame] | 886 | |
Alexandru Gagniuc | c1d1fd8 | 2014-02-05 01:10:08 -0600 | [diff] [blame] | 887 | if (page_size % image->header->align) |
Hung-Te Lin | e4ea2ca | 2013-03-19 12:24:43 +0800 | [diff] [blame] | 888 | WARN("%s: Page size (%#x) not aligned with CBFS image (%#x).\n", |
Alexandru Gagniuc | c1d1fd8 | 2014-02-05 01:10:08 -0600 | [diff] [blame] | 889 | __func__, page_size, image->header->align); |
Hung-Te Lin | 215d1d7 | 2013-01-29 03:46:02 +0800 | [diff] [blame] | 890 | |
| 891 | /* TODO Old cbfstool always assume input is a stage file (and adding |
| 892 | * sizeof(cbfs_stage) for header. We should fix that by adding "-t" |
Hung-Te Lin | e4ea2ca | 2013-03-19 12:24:43 +0800 | [diff] [blame] | 893 | * (type) param in future. For right now, we assume cbfs_stage is the |
| 894 | * largest structure and add it into header size. */ |
| 895 | assert(sizeof(struct cbfs_stage) >= sizeof(struct cbfs_payload)); |
Hung-Te Lin | 215d1d7 | 2013-01-29 03:46:02 +0800 | [diff] [blame] | 896 | header_len = (cbfs_calculate_file_header_size(name) + |
| 897 | sizeof(struct cbfs_stage)); |
| 898 | need_len = header_len + size; |
| 899 | |
Hung-Te Lin | e4ea2ca | 2013-03-19 12:24:43 +0800 | [diff] [blame] | 900 | // Merge empty entries to build get max available space. |
Hung-Te Lin | 215d1d7 | 2013-01-29 03:46:02 +0800 | [diff] [blame] | 901 | cbfs_walk(image, cbfs_merge_empty_entry, NULL); |
| 902 | |
| 903 | /* Three cases of content location on memory page: |
| 904 | * case 1. |
| 905 | * | PAGE 1 | PAGE 2 | |
| 906 | * | <header><content>| Fit. Return start of content. |
| 907 | * |
| 908 | * case 2. |
| 909 | * | PAGE 1 | PAGE 2 | |
| 910 | * | <header><content> | Fits when we shift content to align |
| 911 | * shift-> | <header>|<content> | at starting of PAGE 2. |
| 912 | * |
| 913 | * case 3. (large content filling whole page) |
Hung-Te Lin | e4ea2ca | 2013-03-19 12:24:43 +0800 | [diff] [blame] | 914 | * | PAGE 1 | PAGE 2 | PAGE 3 | |
| 915 | * | <header>< content > | Can't fit. If we shift content to |
| 916 | * |trial-> <header>< content > | PAGE 2, header can't fit in free |
| 917 | * | shift-> <header><content> space, so we must use PAGE 3. |
Hung-Te Lin | 215d1d7 | 2013-01-29 03:46:02 +0800 | [diff] [blame] | 918 | * |
Hung-Te Lin | e4ea2ca | 2013-03-19 12:24:43 +0800 | [diff] [blame] | 919 | * The returned address can be then used as "base-address" (-b) in add-* |
| 920 | * commands (will be re-calculated and positioned by cbfs_add_entry_at). |
| 921 | * For stage targets, the address is also used to re-link stage before |
| 922 | * being added into CBFS. |
Hung-Te Lin | 215d1d7 | 2013-01-29 03:46:02 +0800 | [diff] [blame] | 923 | */ |
| 924 | for (entry = cbfs_find_first_entry(image); |
Hung-Te Lin | 408aefd | 2013-02-09 10:38:55 +0800 | [diff] [blame] | 925 | entry && cbfs_is_valid_entry(image, entry); |
Hung-Te Lin | 215d1d7 | 2013-01-29 03:46:02 +0800 | [diff] [blame] | 926 | entry = cbfs_find_next_entry(image, entry)) { |
| 927 | |
| 928 | uint32_t type = ntohl(entry->type); |
| 929 | if (type != CBFS_COMPONENT_NULL) |
| 930 | continue; |
| 931 | |
| 932 | addr = cbfs_get_entry_addr(image, entry); |
| 933 | addr_next = cbfs_get_entry_addr(image, cbfs_find_next_entry( |
| 934 | image, entry)); |
| 935 | if (addr_next - addr < need_len) |
| 936 | continue; |
Hung-Te Lin | e4ea2ca | 2013-03-19 12:24:43 +0800 | [diff] [blame] | 937 | |
| 938 | offset = align_up(addr + header_len, align); |
| 939 | if (is_in_same_page(offset, size, page_size) && |
| 940 | is_in_range(addr, addr_next, header_len, offset, size)) { |
Hung-Te Lin | 215d1d7 | 2013-01-29 03:46:02 +0800 | [diff] [blame] | 941 | DEBUG("cbfs_locate_entry: FIT (PAGE1)."); |
Hung-Te Lin | e4ea2ca | 2013-03-19 12:24:43 +0800 | [diff] [blame] | 942 | return offset; |
Hung-Te Lin | 215d1d7 | 2013-01-29 03:46:02 +0800 | [diff] [blame] | 943 | } |
| 944 | |
| 945 | addr2 = align_up(addr, page_size); |
Hung-Te Lin | e4ea2ca | 2013-03-19 12:24:43 +0800 | [diff] [blame] | 946 | offset = align_up(addr2, align); |
| 947 | if (is_in_range(addr, addr_next, header_len, offset, size)) { |
Hung-Te Lin | 215d1d7 | 2013-01-29 03:46:02 +0800 | [diff] [blame] | 948 | DEBUG("cbfs_locate_entry: OVERLAP (PAGE2)."); |
Hung-Te Lin | e4ea2ca | 2013-03-19 12:24:43 +0800 | [diff] [blame] | 949 | return offset; |
Hung-Te Lin | 215d1d7 | 2013-01-29 03:46:02 +0800 | [diff] [blame] | 950 | } |
| 951 | |
Hung-Te Lin | e4ea2ca | 2013-03-19 12:24:43 +0800 | [diff] [blame] | 952 | /* Assume page_size >= header_len so adding one page will |
| 953 | * definitely provide the space for header. */ |
| 954 | assert(page_size >= header_len); |
Hung-Te Lin | 215d1d7 | 2013-01-29 03:46:02 +0800 | [diff] [blame] | 955 | addr3 = addr2 + page_size; |
Hung-Te Lin | e4ea2ca | 2013-03-19 12:24:43 +0800 | [diff] [blame] | 956 | offset = align_up(addr3, align); |
| 957 | if (is_in_range(addr, addr_next, header_len, offset, size)) { |
Hung-Te Lin | 215d1d7 | 2013-01-29 03:46:02 +0800 | [diff] [blame] | 958 | DEBUG("cbfs_locate_entry: OVERLAP+ (PAGE3)."); |
Hung-Te Lin | e4ea2ca | 2013-03-19 12:24:43 +0800 | [diff] [blame] | 959 | return offset; |
Hung-Te Lin | 215d1d7 | 2013-01-29 03:46:02 +0800 | [diff] [blame] | 960 | } |
| 961 | } |
| 962 | return -1; |
| 963 | } |