Angel Pons | 118a9c7 | 2020-04-02 23:48:34 +0200 | [diff] [blame] | 1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
Peter Stuge | 483b7bb | 2009-04-14 07:40:01 +0000 | [diff] [blame] | 2 | |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 3 | #include <assert.h> |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 4 | #include <boot_device.h> |
| 5 | #include <cbfs.h> |
Julius Werner | 0d9072b | 2020-03-05 12:51:08 -0800 | [diff] [blame] | 6 | #include <cbfs_private.h> |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 7 | #include <cbmem.h> |
Julius Werner | 98eeb96 | 2019-12-11 15:47:42 -0800 | [diff] [blame] | 8 | #include <commonlib/bsd/compression.h> |
Aaron Durbin | 0b418bd | 2020-10-08 14:56:03 -0600 | [diff] [blame] | 9 | #include <commonlib/endian.h> |
Bill XIE | c79e96b | 2019-08-22 20:28:36 +0800 | [diff] [blame] | 10 | #include <console/console.h> |
Bill XIE | c79e96b | 2019-08-22 20:28:36 +0800 | [diff] [blame] | 11 | #include <fmap.h> |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 12 | #include <lib.h> |
Julius Werner | fdabf3f | 2020-05-06 17:06:35 -0700 | [diff] [blame] | 13 | #include <metadata_hash.h> |
Bill XIE | c79e96b | 2019-08-22 20:28:36 +0800 | [diff] [blame] | 14 | #include <security/tpm/tspi/crtm.h> |
| 15 | #include <security/vboot/vboot_common.h> |
| 16 | #include <stdlib.h> |
| 17 | #include <string.h> |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 18 | #include <symbols.h> |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 19 | #include <timestamp.h> |
Patrick Georgi | 58a150a | 2016-05-02 17:22:29 +0800 | [diff] [blame] | 20 | |
Julius Werner | 9b1f3cc | 2020-12-30 17:30:12 -0800 | [diff] [blame^] | 21 | #if CBFS_CACHE_AVAILABLE |
| 22 | struct mem_pool cbfs_cache = MEM_POOL_INIT(_cbfs_cache, REGION_SIZE(cbfs_cache)); |
| 23 | |
| 24 | static void switch_to_postram_cache(int unused) |
| 25 | { |
| 26 | if (_preram_cbfs_cache != _postram_cbfs_cache) |
| 27 | mem_pool_init(&cbfs_cache, _postram_cbfs_cache, |
| 28 | REGION_SIZE(postram_cbfs_cache)); |
| 29 | } |
| 30 | ROMSTAGE_CBMEM_INIT_HOOK(switch_to_postram_cache); |
| 31 | #endif |
| 32 | |
Julius Werner | 0d9072b | 2020-03-05 12:51:08 -0800 | [diff] [blame] | 33 | cb_err_t cbfs_boot_lookup(const char *name, bool force_ro, |
| 34 | union cbfs_mdata *mdata, struct region_device *rdev) |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 35 | { |
Julius Werner | 0d9072b | 2020-03-05 12:51:08 -0800 | [diff] [blame] | 36 | const struct cbfs_boot_device *cbd = cbfs_get_boot_device(force_ro); |
| 37 | if (!cbd) |
| 38 | return CB_ERR; |
| 39 | |
| 40 | size_t data_offset; |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 41 | cb_err_t err = CB_CBFS_CACHE_FULL; |
Julius Werner | 34cf073 | 2020-12-08 14:21:43 -0800 | [diff] [blame] | 42 | if (!CONFIG(NO_CBFS_MCACHE) && !ENV_SMM && cbd->mcache_size) |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 43 | err = cbfs_mcache_lookup(cbd->mcache, cbd->mcache_size, |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 44 | name, mdata, &data_offset); |
Julius Werner | fdabf3f | 2020-05-06 17:06:35 -0700 | [diff] [blame] | 45 | if (err == CB_CBFS_CACHE_FULL) { |
| 46 | struct vb2_hash *metadata_hash = NULL; |
| 47 | if (CONFIG(TOCTOU_SAFETY)) { |
| 48 | if (ENV_SMM) /* Cannot provide TOCTOU safety for SMM */ |
| 49 | dead_code(); |
Julius Werner | 34cf073 | 2020-12-08 14:21:43 -0800 | [diff] [blame] | 50 | if (!cbd->mcache_size) |
| 51 | die("Cannot access CBFS TOCTOU-safely in " ENV_STRING " before CBMEM init!\n"); |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 52 | /* We can only reach this for the RW CBFS -- an mcache overflow in the |
| 53 | RO CBFS would have been caught when building the mcache in cbfs_get |
| 54 | boot_device(). (Note that TOCTOU_SAFETY implies !NO_CBFS_MCACHE.) */ |
Julius Werner | fdabf3f | 2020-05-06 17:06:35 -0700 | [diff] [blame] | 55 | assert(cbd == vboot_get_cbfs_boot_device()); |
| 56 | /* TODO: set metadata_hash to RW metadata hash here. */ |
| 57 | } |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 58 | err = cbfs_lookup(&cbd->rdev, name, mdata, &data_offset, metadata_hash); |
Julius Werner | fdabf3f | 2020-05-06 17:06:35 -0700 | [diff] [blame] | 59 | } |
Julius Werner | 0d9072b | 2020-03-05 12:51:08 -0800 | [diff] [blame] | 60 | |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 61 | if (CONFIG(VBOOT_ENABLE_CBFS_FALLBACK) && !force_ro && err == CB_CBFS_NOT_FOUND) { |
| 62 | printk(BIOS_INFO, "CBFS: Fall back to RO region for %s\n", name); |
Julius Werner | 0d9072b | 2020-03-05 12:51:08 -0800 | [diff] [blame] | 63 | return cbfs_boot_lookup(name, true, mdata, rdev); |
| 64 | } |
Julius Werner | 0247fcf | 2020-12-03 12:41:00 -0800 | [diff] [blame] | 65 | if (err) { |
| 66 | if (err == CB_CBFS_NOT_FOUND) |
| 67 | printk(BIOS_WARNING, "CBFS: '%s' not found.\n", name); |
| 68 | else if (err == CB_CBFS_HASH_MISMATCH) |
| 69 | printk(BIOS_ERR, "CBFS ERROR: metadata hash mismatch!\n"); |
| 70 | else |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 71 | printk(BIOS_ERR, "CBFS ERROR: error %d when looking up '%s'\n", |
Julius Werner | 0247fcf | 2020-12-03 12:41:00 -0800 | [diff] [blame] | 72 | err, name); |
Julius Werner | 0d9072b | 2020-03-05 12:51:08 -0800 | [diff] [blame] | 73 | return err; |
Julius Werner | 0247fcf | 2020-12-03 12:41:00 -0800 | [diff] [blame] | 74 | } |
Julius Werner | 0d9072b | 2020-03-05 12:51:08 -0800 | [diff] [blame] | 75 | |
| 76 | if (rdev_chain(rdev, &cbd->rdev, data_offset, be32toh(mdata->h.len))) |
| 77 | return CB_ERR; |
| 78 | |
Arthur Heymans | 27545df | 2021-02-26 14:22:47 +0100 | [diff] [blame] | 79 | if (tspi_measure_cbfs_hook(rdev, name, be32toh(mdata->h.type))) { |
| 80 | printk(BIOS_ERR, "CBFS ERROR: error when measuring '%s'\n", name); |
| 81 | } |
Julius Werner | 0d9072b | 2020-03-05 12:51:08 -0800 | [diff] [blame] | 82 | |
| 83 | return CB_SUCCESS; |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 84 | } |
| 85 | |
Aaron Durbin | 37a5d15 | 2015-09-17 16:09:30 -0500 | [diff] [blame] | 86 | int cbfs_boot_locate(struct cbfsf *fh, const char *name, uint32_t *type) |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 87 | { |
Julius Werner | 0d9072b | 2020-03-05 12:51:08 -0800 | [diff] [blame] | 88 | if (cbfs_boot_lookup(name, false, &fh->mdata, &fh->data)) |
Julius Werner | 1cd013b | 2019-12-11 16:50:02 -0800 | [diff] [blame] | 89 | return -1; |
| 90 | |
| 91 | size_t msize = be32toh(fh->mdata.h.offset); |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 92 | if (rdev_chain(&fh->metadata, &addrspace_32bit.rdev, (uintptr_t)&fh->mdata, msize)) |
Julius Werner | 1cd013b | 2019-12-11 16:50:02 -0800 | [diff] [blame] | 93 | return -1; |
Julius Werner | 0d9072b | 2020-03-05 12:51:08 -0800 | [diff] [blame] | 94 | |
Julius Werner | 1cd013b | 2019-12-11 16:50:02 -0800 | [diff] [blame] | 95 | if (type) { |
| 96 | if (!*type) |
| 97 | *type = be32toh(fh->mdata.h.type); |
| 98 | else if (*type != be32toh(fh->mdata.h.type)) |
| 99 | return -1; |
Wim Vervoorn | 114e2e8 | 2019-11-05 14:09:16 +0100 | [diff] [blame] | 100 | } |
| 101 | |
Julius Werner | 1cd013b | 2019-12-11 16:50:02 -0800 | [diff] [blame] | 102 | return 0; |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 103 | } |
| 104 | |
Julius Werner | 11075fc | 2020-12-29 17:51:04 -0800 | [diff] [blame] | 105 | void *_cbfs_map(const char *name, size_t *size_out, bool force_ro) |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 106 | { |
Julius Werner | d17ce41 | 2020-10-01 18:25:49 -0700 | [diff] [blame] | 107 | struct region_device rdev; |
| 108 | union cbfs_mdata mdata; |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 109 | |
Julius Werner | 9d0cc2a | 2020-01-22 18:00:18 -0800 | [diff] [blame] | 110 | if (cbfs_boot_lookup(name, force_ro, &mdata, &rdev)) |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 111 | return NULL; |
| 112 | |
Julius Werner | 834b3ec | 2020-03-04 16:52:08 -0800 | [diff] [blame] | 113 | if (size_out != NULL) |
Julius Werner | d17ce41 | 2020-10-01 18:25:49 -0700 | [diff] [blame] | 114 | *size_out = region_device_sz(&rdev); |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 115 | |
Julius Werner | 9b1f3cc | 2020-12-30 17:30:12 -0800 | [diff] [blame^] | 116 | uint32_t compression = CBFS_COMPRESS_NONE; |
| 117 | const struct cbfs_file_attr_compression *attr = cbfs_find_attr(&mdata, |
| 118 | CBFS_FILE_ATTR_TAG_COMPRESSION, sizeof(*attr)); |
| 119 | if (attr) |
| 120 | compression = be32toh(attr->compression); |
| 121 | |
| 122 | if (compression == CBFS_COMPRESS_NONE) |
| 123 | return rdev_mmap_full(&rdev); |
| 124 | |
| 125 | if (!CBFS_CACHE_AVAILABLE) { |
| 126 | ERROR("Cannot map compressed file %s on x86\n", mdata.h.filename); |
| 127 | return NULL; |
| 128 | } |
| 129 | |
| 130 | size_t size = be32toh(attr->decompressed_size); |
| 131 | void *buf = mem_pool_alloc(&cbfs_cache, size); |
| 132 | if (!buf) { |
| 133 | ERROR("CBFS cache out of memory when mapping %s\n", mdata.h.filename); |
| 134 | return NULL; |
| 135 | } |
| 136 | |
| 137 | size = cbfs_load_and_decompress(&rdev, 0, region_device_sz(&rdev), buf, size, |
| 138 | compression); |
| 139 | if (!size) |
| 140 | return NULL; |
| 141 | |
| 142 | if (size_out != NULL) |
| 143 | *size_out = size; |
| 144 | return buf; |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 145 | } |
| 146 | |
Julius Werner | 9b1f3cc | 2020-12-30 17:30:12 -0800 | [diff] [blame^] | 147 | void cbfs_unmap(void *mapping) |
Julius Werner | 834b3ec | 2020-03-04 16:52:08 -0800 | [diff] [blame] | 148 | { |
Julius Werner | 9b1f3cc | 2020-12-30 17:30:12 -0800 | [diff] [blame^] | 149 | /* |
| 150 | * This is save to call with mappings that weren't allocated in the cache (e.g. x86 |
| 151 | * direct mappings) -- mem_pool_free() just does nothing for addresses it doesn't |
| 152 | * recognize. This hardcodes the assumption that if platforms implement an rdev_mmap() |
| 153 | * that requires a free() for the boot_device, they need to implement it via the |
| 154 | * cbfs_cache mem_pool. |
| 155 | */ |
| 156 | if (CBFS_CACHE_AVAILABLE) |
| 157 | mem_pool_free(&cbfs_cache, mapping); |
Julius Werner | 834b3ec | 2020-03-04 16:52:08 -0800 | [diff] [blame] | 158 | } |
| 159 | |
Pratik Prajapati | 2a7708a | 2016-11-30 17:29:10 -0800 | [diff] [blame] | 160 | int cbfs_locate_file_in_region(struct cbfsf *fh, const char *region_name, |
Philipp Deppenwiese | 66f9a09 | 2018-11-08 10:59:40 +0100 | [diff] [blame] | 161 | const char *name, uint32_t *type) |
Pratik Prajapati | 2a7708a | 2016-11-30 17:29:10 -0800 | [diff] [blame] | 162 | { |
| 163 | struct region_device rdev; |
Bill XIE | bad08c2 | 2020-02-13 11:11:35 +0800 | [diff] [blame] | 164 | int ret = 0; |
Pratik Prajapati | 2a7708a | 2016-11-30 17:29:10 -0800 | [diff] [blame] | 165 | if (fmap_locate_area_as_rdev(region_name, &rdev)) { |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 166 | LOG("%s region not found while looking for %s\n", region_name, name); |
Pratik Prajapati | 2a7708a | 2016-11-30 17:29:10 -0800 | [diff] [blame] | 167 | return -1; |
| 168 | } |
| 169 | |
Julius Werner | 0d9072b | 2020-03-05 12:51:08 -0800 | [diff] [blame] | 170 | uint32_t dummy_type = 0; |
| 171 | if (!type) |
| 172 | type = &dummy_type; |
| 173 | |
Bill XIE | bad08c2 | 2020-02-13 11:11:35 +0800 | [diff] [blame] | 174 | ret = cbfs_locate(fh, &rdev, name, type); |
| 175 | if (!ret) |
Julius Werner | 0d9072b | 2020-03-05 12:51:08 -0800 | [diff] [blame] | 176 | if (tspi_measure_cbfs_hook(&rdev, name, *type)) |
Arthur Heymans | 27545df | 2021-02-26 14:22:47 +0100 | [diff] [blame] | 177 | LOG("error measuring %s in region %s\n", name, region_name); |
Bill XIE | bad08c2 | 2020-02-13 11:11:35 +0800 | [diff] [blame] | 178 | return ret; |
Pratik Prajapati | 2a7708a | 2016-11-30 17:29:10 -0800 | [diff] [blame] | 179 | } |
| 180 | |
Aaron Durbin | a85febc | 2020-05-15 15:09:10 -0600 | [diff] [blame] | 181 | static inline bool fsps_env(void) |
| 182 | { |
| 183 | /* FSP-S is assumed to be loaded in ramstage. */ |
| 184 | if (ENV_RAMSTAGE) |
| 185 | return true; |
| 186 | return false; |
| 187 | } |
| 188 | |
Aaron Durbin | ecbfa99 | 2020-05-15 17:01:58 -0600 | [diff] [blame] | 189 | static inline bool fspm_env(void) |
| 190 | { |
| 191 | /* FSP-M is assumed to be loaded in romstage. */ |
| 192 | if (ENV_ROMSTAGE) |
| 193 | return true; |
| 194 | return false; |
| 195 | } |
| 196 | |
Aaron Durbin | a121f95 | 2020-05-26 15:48:10 -0600 | [diff] [blame] | 197 | static inline bool cbfs_lz4_enabled(void) |
| 198 | { |
Aaron Durbin | a85febc | 2020-05-15 15:09:10 -0600 | [diff] [blame] | 199 | if (fsps_env() && CONFIG(FSP_COMPRESS_FSP_S_LZ4)) |
| 200 | return true; |
Aaron Durbin | ecbfa99 | 2020-05-15 17:01:58 -0600 | [diff] [blame] | 201 | if (fspm_env() && CONFIG(FSP_COMPRESS_FSP_M_LZ4)) |
| 202 | return true; |
Aaron Durbin | a85febc | 2020-05-15 15:09:10 -0600 | [diff] [blame] | 203 | |
Aaron Durbin | a121f95 | 2020-05-26 15:48:10 -0600 | [diff] [blame] | 204 | if ((ENV_BOOTBLOCK || ENV_SEPARATE_VERSTAGE) && !CONFIG(COMPRESS_PRERAM_STAGES)) |
| 205 | return false; |
| 206 | |
Julius Werner | 9b1f3cc | 2020-12-30 17:30:12 -0800 | [diff] [blame^] | 207 | if (ENV_SMM) |
| 208 | return false; |
| 209 | |
Aaron Durbin | a121f95 | 2020-05-26 15:48:10 -0600 | [diff] [blame] | 210 | return true; |
| 211 | } |
| 212 | |
| 213 | static inline bool cbfs_lzma_enabled(void) |
| 214 | { |
Aaron Durbin | a85febc | 2020-05-15 15:09:10 -0600 | [diff] [blame] | 215 | if (fsps_env() && CONFIG(FSP_COMPRESS_FSP_S_LZMA)) |
| 216 | return true; |
Aaron Durbin | ecbfa99 | 2020-05-15 17:01:58 -0600 | [diff] [blame] | 217 | if (fspm_env() && CONFIG(FSP_COMPRESS_FSP_M_LZMA)) |
| 218 | return true; |
Aaron Durbin | a121f95 | 2020-05-26 15:48:10 -0600 | [diff] [blame] | 219 | /* We assume here romstage and postcar are never compressed. */ |
| 220 | if (ENV_BOOTBLOCK || ENV_SEPARATE_VERSTAGE) |
| 221 | return false; |
| 222 | if (ENV_ROMSTAGE && CONFIG(POSTCAR_STAGE)) |
| 223 | return false; |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 224 | if ((ENV_ROMSTAGE || ENV_POSTCAR) && !CONFIG(COMPRESS_RAMSTAGE)) |
Aaron Durbin | a121f95 | 2020-05-26 15:48:10 -0600 | [diff] [blame] | 225 | return false; |
Julius Werner | 9b1f3cc | 2020-12-30 17:30:12 -0800 | [diff] [blame^] | 226 | if (ENV_SMM) |
| 227 | return false; |
Aaron Durbin | a121f95 | 2020-05-26 15:48:10 -0600 | [diff] [blame] | 228 | return true; |
| 229 | } |
| 230 | |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 231 | size_t cbfs_load_and_decompress(const struct region_device *rdev, size_t offset, size_t in_size, |
| 232 | void *buffer, size_t buffer_size, uint32_t compression) |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 233 | { |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 234 | size_t out_size; |
Aaron Durbin | 84f394e | 2020-05-26 16:16:42 -0600 | [diff] [blame] | 235 | void *map; |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 236 | |
| 237 | switch (compression) { |
| 238 | case CBFS_COMPRESS_NONE: |
Julius Werner | f975e55 | 2016-08-19 15:43:06 -0700 | [diff] [blame] | 239 | if (buffer_size < in_size) |
| 240 | return 0; |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 241 | if (rdev_readat(rdev, buffer, offset, in_size) != in_size) |
| 242 | return 0; |
| 243 | return in_size; |
| 244 | |
| 245 | case CBFS_COMPRESS_LZ4: |
Aaron Durbin | a121f95 | 2020-05-26 15:48:10 -0600 | [diff] [blame] | 246 | if (!cbfs_lz4_enabled()) |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 247 | return 0; |
| 248 | |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 249 | /* cbfs_stage_load_and_decompress() takes care of in-place LZ4 decompression by |
| 250 | setting up the rdev to be in memory. */ |
Aaron Durbin | 84f394e | 2020-05-26 16:16:42 -0600 | [diff] [blame] | 251 | map = rdev_mmap(rdev, offset, in_size); |
| 252 | if (map == NULL) |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 253 | return 0; |
| 254 | |
| 255 | timestamp_add_now(TS_START_ULZ4F); |
Aaron Durbin | 84f394e | 2020-05-26 16:16:42 -0600 | [diff] [blame] | 256 | out_size = ulz4fn(map, in_size, buffer, buffer_size); |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 257 | timestamp_add_now(TS_END_ULZ4F); |
Aaron Durbin | 84f394e | 2020-05-26 16:16:42 -0600 | [diff] [blame] | 258 | |
| 259 | rdev_munmap(rdev, map); |
| 260 | |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 261 | return out_size; |
| 262 | |
| 263 | case CBFS_COMPRESS_LZMA: |
Aaron Durbin | a121f95 | 2020-05-26 15:48:10 -0600 | [diff] [blame] | 264 | if (!cbfs_lzma_enabled()) |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 265 | return 0; |
Aaron Durbin | 84f394e | 2020-05-26 16:16:42 -0600 | [diff] [blame] | 266 | map = rdev_mmap(rdev, offset, in_size); |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 267 | if (map == NULL) |
| 268 | return 0; |
| 269 | |
| 270 | /* Note: timestamp not useful for memory-mapped media (x86) */ |
| 271 | timestamp_add_now(TS_START_ULZMA); |
| 272 | out_size = ulzman(map, in_size, buffer, buffer_size); |
| 273 | timestamp_add_now(TS_END_ULZMA); |
| 274 | |
| 275 | rdev_munmap(rdev, map); |
| 276 | |
| 277 | return out_size; |
| 278 | |
| 279 | default: |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 280 | return 0; |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 281 | } |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 282 | } |
| 283 | |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 284 | static size_t cbfs_stage_load_and_decompress(const struct region_device *rdev, size_t offset, |
| 285 | size_t in_size, void *buffer, size_t buffer_size, uint32_t compression) |
Aaron Durbin | 84f394e | 2020-05-26 16:16:42 -0600 | [diff] [blame] | 286 | { |
| 287 | struct region_device rdev_src; |
| 288 | |
| 289 | if (compression == CBFS_COMPRESS_LZ4) { |
| 290 | if (!cbfs_lz4_enabled()) |
| 291 | return 0; |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 292 | /* Load the compressed image to the end of the available memory area for |
| 293 | in-place decompression. It is the responsibility of the caller to ensure that |
| 294 | buffer_size is large enough (see compression.h, guaranteed by cbfstool for |
| 295 | stages). */ |
Aaron Durbin | 84f394e | 2020-05-26 16:16:42 -0600 | [diff] [blame] | 296 | void *compr_start = buffer + buffer_size - in_size; |
| 297 | if (rdev_readat(rdev, compr_start, offset, in_size) != in_size) |
| 298 | return 0; |
| 299 | /* Create a region device backed by memory. */ |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 300 | rdev_chain(&rdev_src, &addrspace_32bit.rdev, (uintptr_t)compr_start, in_size); |
Aaron Durbin | 84f394e | 2020-05-26 16:16:42 -0600 | [diff] [blame] | 301 | |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 302 | return cbfs_load_and_decompress(&rdev_src, 0, in_size, buffer, buffer_size, |
| 303 | compression); |
Aaron Durbin | 84f394e | 2020-05-26 16:16:42 -0600 | [diff] [blame] | 304 | } |
| 305 | |
| 306 | /* All other algorithms can use the generic implementation. */ |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 307 | return cbfs_load_and_decompress(rdev, offset, in_size, buffer, buffer_size, |
| 308 | compression); |
Aaron Durbin | 84f394e | 2020-05-26 16:16:42 -0600 | [diff] [blame] | 309 | } |
| 310 | |
Stefan Reinauer | 800379f | 2010-03-01 08:34:19 +0000 | [diff] [blame] | 311 | static inline int tohex4(unsigned int c) |
Patrick Georgi | b203c2f | 2009-08-20 14:48:03 +0000 | [diff] [blame] | 312 | { |
Hung-Te Lin | 6fe0cab | 2013-01-22 18:57:56 +0800 | [diff] [blame] | 313 | return (c <= 9) ? (c + '0') : (c - 10 + 'a'); |
Patrick Georgi | b203c2f | 2009-08-20 14:48:03 +0000 | [diff] [blame] | 314 | } |
| 315 | |
Martin Roth | a616a4b | 2020-01-21 09:28:40 -0700 | [diff] [blame] | 316 | static void tohex8(unsigned int val, char *dest) |
| 317 | { |
| 318 | dest[0] = tohex4((val >> 4) & 0xf); |
| 319 | dest[1] = tohex4(val & 0xf); |
| 320 | } |
| 321 | |
Lee Leahy | b2d834a | 2017-03-08 16:52:22 -0800 | [diff] [blame] | 322 | static void tohex16(unsigned int val, char *dest) |
Patrick Georgi | b203c2f | 2009-08-20 14:48:03 +0000 | [diff] [blame] | 323 | { |
Philipp Deppenwiese | 66f9a09 | 2018-11-08 10:59:40 +0100 | [diff] [blame] | 324 | dest[0] = tohex4(val >> 12); |
| 325 | dest[1] = tohex4((val >> 8) & 0xf); |
| 326 | dest[2] = tohex4((val >> 4) & 0xf); |
Hung-Te Lin | 6fe0cab | 2013-01-22 18:57:56 +0800 | [diff] [blame] | 327 | dest[3] = tohex4(val & 0xf); |
Patrick Georgi | b203c2f | 2009-08-20 14:48:03 +0000 | [diff] [blame] | 328 | } |
| 329 | |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 330 | void *cbfs_boot_map_optionrom(uint16_t vendor, uint16_t device) |
Peter Stuge | 483b7bb | 2009-04-14 07:40:01 +0000 | [diff] [blame] | 331 | { |
Hung-Te Lin | 6fe0cab | 2013-01-22 18:57:56 +0800 | [diff] [blame] | 332 | char name[17] = "pciXXXX,XXXX.rom"; |
Peter Stuge | 483b7bb | 2009-04-14 07:40:01 +0000 | [diff] [blame] | 333 | |
Philipp Deppenwiese | 66f9a09 | 2018-11-08 10:59:40 +0100 | [diff] [blame] | 334 | tohex16(vendor, name + 3); |
| 335 | tohex16(device, name + 8); |
Peter Stuge | 483b7bb | 2009-04-14 07:40:01 +0000 | [diff] [blame] | 336 | |
Julius Werner | 834b3ec | 2020-03-04 16:52:08 -0800 | [diff] [blame] | 337 | return cbfs_map(name, NULL); |
Peter Stuge | 483b7bb | 2009-04-14 07:40:01 +0000 | [diff] [blame] | 338 | } |
| 339 | |
Martin Roth | a616a4b | 2020-01-21 09:28:40 -0700 | [diff] [blame] | 340 | void *cbfs_boot_map_optionrom_revision(uint16_t vendor, uint16_t device, uint8_t rev) |
| 341 | { |
| 342 | char name[20] = "pciXXXX,XXXX,XX.rom"; |
| 343 | |
| 344 | tohex16(vendor, name + 3); |
| 345 | tohex16(device, name + 8); |
| 346 | tohex8(rev, name + 13); |
| 347 | |
Julius Werner | 834b3ec | 2020-03-04 16:52:08 -0800 | [diff] [blame] | 348 | return cbfs_map(name, NULL); |
Martin Roth | a616a4b | 2020-01-21 09:28:40 -0700 | [diff] [blame] | 349 | } |
| 350 | |
Julius Werner | 11075fc | 2020-12-29 17:51:04 -0800 | [diff] [blame] | 351 | size_t _cbfs_load(const char *name, void *buf, size_t buf_size, bool force_ro) |
Julius Werner | f975e55 | 2016-08-19 15:43:06 -0700 | [diff] [blame] | 352 | { |
Julius Werner | d17ce41 | 2020-10-01 18:25:49 -0700 | [diff] [blame] | 353 | struct region_device rdev; |
| 354 | union cbfs_mdata mdata; |
Julius Werner | f975e55 | 2016-08-19 15:43:06 -0700 | [diff] [blame] | 355 | |
Julius Werner | 9d0cc2a | 2020-01-22 18:00:18 -0800 | [diff] [blame] | 356 | if (cbfs_boot_lookup(name, force_ro, &mdata, &rdev)) |
Julius Werner | f975e55 | 2016-08-19 15:43:06 -0700 | [diff] [blame] | 357 | return 0; |
| 358 | |
Julius Werner | d17ce41 | 2020-10-01 18:25:49 -0700 | [diff] [blame] | 359 | uint32_t compression = CBFS_COMPRESS_NONE; |
| 360 | const struct cbfs_file_attr_compression *attr = cbfs_find_attr(&mdata, |
| 361 | CBFS_FILE_ATTR_TAG_COMPRESSION, sizeof(*attr)); |
| 362 | if (attr) { |
| 363 | compression = be32toh(attr->compression); |
| 364 | if (buf_size < be32toh(attr->decompressed_size)) |
| 365 | return 0; |
| 366 | } |
Julius Werner | f975e55 | 2016-08-19 15:43:06 -0700 | [diff] [blame] | 367 | |
Julius Werner | d17ce41 | 2020-10-01 18:25:49 -0700 | [diff] [blame] | 368 | return cbfs_load_and_decompress(&rdev, 0, region_device_sz(&rdev), |
| 369 | buf, buf_size, compression); |
Julius Werner | f975e55 | 2016-08-19 15:43:06 -0700 | [diff] [blame] | 370 | } |
| 371 | |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 372 | int cbfs_prog_stage_load(struct prog *pstage) |
| 373 | { |
| 374 | struct cbfs_stage stage; |
| 375 | uint8_t *load; |
| 376 | void *entry; |
| 377 | size_t fsize; |
| 378 | size_t foffset; |
Aaron Durbin | 37a5d15 | 2015-09-17 16:09:30 -0500 | [diff] [blame] | 379 | const struct region_device *fh = prog_rdev(pstage); |
Hung-Te Lin | 6fe0cab | 2013-01-22 18:57:56 +0800 | [diff] [blame] | 380 | |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 381 | if (rdev_readat(fh, &stage, 0, sizeof(stage)) != sizeof(stage)) |
Julius Werner | b29bd27b | 2015-12-03 11:29:12 -0800 | [diff] [blame] | 382 | return -1; |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 383 | |
| 384 | fsize = region_device_sz(fh); |
| 385 | fsize -= sizeof(stage); |
| 386 | foffset = 0; |
| 387 | foffset += sizeof(stage); |
| 388 | |
Aaron Durbin | 0b418bd | 2020-10-08 14:56:03 -0600 | [diff] [blame] | 389 | /* cbfs_stage fields are written in little endian despite the other |
| 390 | cbfs data types being encoded in big endian. */ |
| 391 | stage.compression = read_le32(&stage.compression); |
| 392 | stage.entry = read_le64(&stage.entry); |
| 393 | stage.load = read_le64(&stage.load); |
| 394 | stage.len = read_le32(&stage.len); |
| 395 | stage.memlen = read_le32(&stage.memlen); |
| 396 | |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 397 | assert(fsize == stage.len); |
| 398 | |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 399 | load = (void *)(uintptr_t)stage.load; |
| 400 | entry = (void *)(uintptr_t)stage.entry; |
| 401 | |
Aaron Durbin | ed253c8 | 2015-10-07 17:22:42 -0500 | [diff] [blame] | 402 | /* Hacky way to not load programs over read only media. The stages |
| 403 | * that would hit this path initialize themselves. */ |
Julius Werner | 21a4053 | 2020-04-21 16:03:53 -0700 | [diff] [blame] | 404 | if ((ENV_BOOTBLOCK || ENV_SEPARATE_VERSTAGE) && |
| 405 | !CONFIG(NO_XIP_EARLY_STAGES) && CONFIG(BOOT_DEVICE_MEMORY_MAPPED)) { |
Aaron Durbin | ed253c8 | 2015-10-07 17:22:42 -0500 | [diff] [blame] | 406 | void *mapping = rdev_mmap(fh, foffset, fsize); |
| 407 | rdev_munmap(fh, mapping); |
| 408 | if (mapping == load) |
| 409 | goto out; |
| 410 | } |
| 411 | |
Aaron Durbin | 84f394e | 2020-05-26 16:16:42 -0600 | [diff] [blame] | 412 | fsize = cbfs_stage_load_and_decompress(fh, foffset, fsize, load, |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 413 | stage.memlen, stage.compression); |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 414 | if (!fsize) |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 415 | return -1; |
| 416 | |
| 417 | /* Clear area not covered by file. */ |
| 418 | memset(&load[fsize], 0, stage.memlen - fsize); |
| 419 | |
Aaron Durbin | 096f457 | 2016-03-31 13:49:00 -0500 | [diff] [blame] | 420 | prog_segment_loaded((uintptr_t)load, stage.memlen, SEG_FINAL); |
Aaron Durbin | ed253c8 | 2015-10-07 17:22:42 -0500 | [diff] [blame] | 421 | |
| 422 | out: |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 423 | prog_set_area(pstage, load, stage.memlen); |
| 424 | prog_set_entry(pstage, entry, NULL); |
| 425 | |
| 426 | return 0; |
Hung-Te Lin | 6fe0cab | 2013-01-22 18:57:56 +0800 | [diff] [blame] | 427 | } |
Aaron Durbin | 6d720f3 | 2015-12-08 17:00:23 -0600 | [diff] [blame] | 428 | |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 429 | void cbfs_boot_device_find_mcache(struct cbfs_boot_device *cbd, uint32_t id) |
Aaron Durbin | 6d720f3 | 2015-12-08 17:00:23 -0600 | [diff] [blame] | 430 | { |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 431 | if (CONFIG(NO_CBFS_MCACHE) || ENV_SMM) |
| 432 | return; |
| 433 | |
Julius Werner | 34cf073 | 2020-12-08 14:21:43 -0800 | [diff] [blame] | 434 | if (cbd->mcache_size) |
| 435 | return; |
| 436 | |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 437 | const struct cbmem_entry *entry; |
| 438 | if (cbmem_possibly_online() && |
| 439 | (entry = cbmem_entry_find(id))) { |
| 440 | cbd->mcache = cbmem_entry_start(entry); |
| 441 | cbd->mcache_size = cbmem_entry_size(entry); |
| 442 | } else if (ENV_ROMSTAGE_OR_BEFORE) { |
| 443 | u8 *boundary = _ecbfs_mcache - REGION_SIZE(cbfs_mcache) * |
| 444 | CONFIG_CBFS_MCACHE_RW_PERCENTAGE / 100; |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 445 | boundary = (u8 *)ALIGN_DOWN((uintptr_t)boundary, CBFS_MCACHE_ALIGNMENT); |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 446 | if (id == CBMEM_ID_CBFS_RO_MCACHE) { |
| 447 | cbd->mcache = _cbfs_mcache; |
| 448 | cbd->mcache_size = boundary - _cbfs_mcache; |
| 449 | } else if (id == CBMEM_ID_CBFS_RW_MCACHE) { |
| 450 | cbd->mcache = boundary; |
| 451 | cbd->mcache_size = _ecbfs_mcache - boundary; |
| 452 | } |
| 453 | } |
Aaron Durbin | 6d720f3 | 2015-12-08 17:00:23 -0600 | [diff] [blame] | 454 | } |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 455 | |
Julius Werner | fdabf3f | 2020-05-06 17:06:35 -0700 | [diff] [blame] | 456 | cb_err_t cbfs_init_boot_device(const struct cbfs_boot_device *cbd, |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 457 | struct vb2_hash *mdata_hash) |
Julius Werner | fdabf3f | 2020-05-06 17:06:35 -0700 | [diff] [blame] | 458 | { |
| 459 | /* If we have an mcache, mcache_build() will also check mdata hash. */ |
| 460 | if (!CONFIG(NO_CBFS_MCACHE) && !ENV_SMM && cbd->mcache_size > 0) |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 461 | return cbfs_mcache_build(&cbd->rdev, cbd->mcache, cbd->mcache_size, mdata_hash); |
Julius Werner | fdabf3f | 2020-05-06 17:06:35 -0700 | [diff] [blame] | 462 | |
| 463 | /* No mcache and no verification means we have nothing special to do. */ |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 464 | if (!CONFIG(CBFS_VERIFICATION) || !mdata_hash) |
Julius Werner | fdabf3f | 2020-05-06 17:06:35 -0700 | [diff] [blame] | 465 | return CB_SUCCESS; |
| 466 | |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 467 | /* Verification only: use cbfs_walk() without a walker() function to just run through |
| 468 | the CBFS once, will return NOT_FOUND by default. */ |
| 469 | cb_err_t err = cbfs_walk(&cbd->rdev, NULL, NULL, mdata_hash, 0); |
Julius Werner | fdabf3f | 2020-05-06 17:06:35 -0700 | [diff] [blame] | 470 | if (err == CB_CBFS_NOT_FOUND) |
| 471 | err = CB_SUCCESS; |
| 472 | return err; |
| 473 | } |
| 474 | |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 475 | const struct cbfs_boot_device *cbfs_get_boot_device(bool force_ro) |
| 476 | { |
| 477 | static struct cbfs_boot_device ro; |
| 478 | |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 479 | /* Ensure we always init RO mcache, even if the first file is from the RW CBFS. |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 480 | Otherwise it may not be available when needed in later stages. */ |
| 481 | if (ENV_INITIAL_STAGE && !force_ro && !region_device_sz(&ro.rdev)) |
| 482 | cbfs_get_boot_device(true); |
| 483 | |
| 484 | if (!force_ro) { |
| 485 | const struct cbfs_boot_device *rw = vboot_get_cbfs_boot_device(); |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 486 | /* This will return NULL if vboot isn't enabled, didn't run yet or decided to |
| 487 | boot into recovery mode. */ |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 488 | if (rw) |
| 489 | return rw; |
| 490 | } |
| 491 | |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 492 | /* In rare cases post-RAM stages may run this before cbmem_initialize(), so we can't |
| 493 | lock in the result of find_mcache() on the first try and should keep trying every |
| 494 | time until an mcache is found. */ |
Julius Werner | 34cf073 | 2020-12-08 14:21:43 -0800 | [diff] [blame] | 495 | cbfs_boot_device_find_mcache(&ro, CBMEM_ID_CBFS_RO_MCACHE); |
| 496 | |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 497 | if (region_device_sz(&ro.rdev)) |
| 498 | return &ro; |
| 499 | |
| 500 | if (fmap_locate_area_as_rdev("COREBOOT", &ro.rdev)) |
Julius Werner | fdabf3f | 2020-05-06 17:06:35 -0700 | [diff] [blame] | 501 | die("Cannot locate primary CBFS"); |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 502 | |
Julius Werner | fdabf3f | 2020-05-06 17:06:35 -0700 | [diff] [blame] | 503 | if (ENV_INITIAL_STAGE) { |
| 504 | cb_err_t err = cbfs_init_boot_device(&ro, metadata_hash_get()); |
| 505 | if (err == CB_CBFS_HASH_MISMATCH) |
| 506 | die("RO CBFS metadata hash verification failure"); |
| 507 | else if (CONFIG(TOCTOU_SAFETY) && err == CB_CBFS_CACHE_FULL) |
| 508 | die("RO mcache overflow breaks TOCTOU safety!\n"); |
| 509 | else if (err && err != CB_CBFS_CACHE_FULL) |
| 510 | die("RO CBFS initialization error: %d", err); |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 511 | } |
| 512 | |
| 513 | return &ro; |
| 514 | } |
| 515 | |
| 516 | #if !CONFIG(NO_CBFS_MCACHE) |
| 517 | static void mcache_to_cbmem(const struct cbfs_boot_device *cbd, u32 cbmem_id) |
| 518 | { |
| 519 | if (!cbd) |
| 520 | return; |
| 521 | |
| 522 | size_t real_size = cbfs_mcache_real_size(cbd->mcache, cbd->mcache_size); |
| 523 | void *cbmem_mcache = cbmem_add(cbmem_id, real_size); |
| 524 | if (!cbmem_mcache) { |
| 525 | printk(BIOS_ERR, "ERROR: Cannot allocate CBMEM mcache %#x (%#zx bytes)!\n", |
| 526 | cbmem_id, real_size); |
| 527 | return; |
| 528 | } |
| 529 | memcpy(cbmem_mcache, cbd->mcache, real_size); |
| 530 | } |
| 531 | |
| 532 | static void cbfs_mcache_migrate(int unused) |
| 533 | { |
| 534 | mcache_to_cbmem(vboot_get_cbfs_boot_device(), CBMEM_ID_CBFS_RW_MCACHE); |
| 535 | mcache_to_cbmem(cbfs_get_boot_device(true), CBMEM_ID_CBFS_RO_MCACHE); |
| 536 | } |
| 537 | ROMSTAGE_CBMEM_INIT_HOOK(cbfs_mcache_migrate) |
| 538 | #endif |