1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright 2018 Google, Inc
4 * Written by Simon Glass <sjg@chromium.org>
12 #include <asm/global_data.h>
13 #include <u-boot/crc.h>
16 * A bloblist is a single contiguous chunk of memory with a header
17 * (struct bloblist_hdr) and a number of blobs in it.
19 * Each blob starts on a BLOBLIST_ALIGN boundary relative to the start of the
20 * bloblist and consists of a struct bloblist_rec, some padding to the required
21 * alignment for the blog and then the actual data. The padding ensures that the
22 * start address of the data in each blob is aligned as required. Note that
23 * each blob's *data* is aligned to BLOBLIST_ALIGN regardless of the alignment
24 * of the bloblist itself or the blob header.
26 * So far, only BLOBLIST_ALIGN alignment is supported.
29 DECLARE_GLOBAL_DATA_PTR;
31 static const char *const tag_name[] = {
32 [BLOBLISTT_NONE] = "(none)",
33 [BLOBLISTT_EC_HOSTEVENT] = "EC host event",
34 [BLOBLISTT_SPL_HANDOFF] = "SPL hand-off",
35 [BLOBLISTT_VBOOT_CTX] = "Chrome OS vboot context",
36 [BLOBLISTT_VBOOT_HANDOFF] = "Chrome OS vboot hand-off",
37 [BLOBLISTT_ACPI_GNVS] = "ACPI GNVS",
38 [BLOBLISTT_INTEL_VBT] = "Intel Video-BIOS table",
39 [BLOBLISTT_TPM2_TCG_LOG] = "TPM v2 log space",
40 [BLOBLISTT_TCPA_LOG] = "TPM log space",
41 [BLOBLISTT_ACPI_TABLES] = "ACPI tables for x86",
42 [BLOBLISTT_SMBIOS_TABLES] = "SMBIOS tables for x86",
45 const char *bloblist_tag_name(enum bloblist_tag_t tag)
47 if (tag < 0 || tag >= BLOBLISTT_COUNT)
53 static struct bloblist_rec *bloblist_first_blob(struct bloblist_hdr *hdr)
55 if (hdr->alloced <= hdr->hdr_size)
57 return (struct bloblist_rec *)((void *)hdr + hdr->hdr_size);
60 static struct bloblist_rec *bloblist_next_blob(struct bloblist_hdr *hdr,
61 struct bloblist_rec *rec)
65 offset = (void *)rec - (void *)hdr;
66 offset += rec->hdr_size + ALIGN(rec->size, BLOBLIST_ALIGN);
67 if (offset >= hdr->alloced)
69 return (struct bloblist_rec *)((void *)hdr + offset);
72 #define foreach_rec(_rec, _hdr) \
73 for (_rec = bloblist_first_blob(_hdr); \
75 _rec = bloblist_next_blob(_hdr, _rec))
77 static struct bloblist_rec *bloblist_findrec(uint tag)
79 struct bloblist_hdr *hdr = gd->bloblist;
80 struct bloblist_rec *rec;
85 foreach_rec(rec, hdr) {
93 static int bloblist_addrec(uint tag, int size, int align,
94 struct bloblist_rec **recp)
96 struct bloblist_hdr *hdr = gd->bloblist;
97 struct bloblist_rec *rec;
98 int data_start, new_alloced;
101 align = BLOBLIST_ALIGN;
103 /* Figure out where the new data will start */
104 data_start = map_to_sysmem(hdr) + hdr->alloced + sizeof(*rec);
106 /* Align the address and then calculate the offset from ->alloced */
107 data_start = ALIGN(data_start, align) - map_to_sysmem(hdr);
109 /* Calculate the new allocated total */
110 new_alloced = data_start + ALIGN(size, align);
112 if (new_alloced >= hdr->size) {
113 log(LOGC_BLOBLIST, LOGL_ERR,
114 "Failed to allocate %x bytes size=%x, need size=%x\n",
115 size, hdr->size, new_alloced);
116 return log_msg_ret("bloblist add", -ENOSPC);
118 rec = (void *)hdr + hdr->alloced;
121 rec->hdr_size = data_start - hdr->alloced;
125 /* Zero the record data */
126 memset((void *)rec + rec->hdr_size, '\0', rec->size);
128 hdr->alloced = new_alloced;
134 static int bloblist_ensurerec(uint tag, struct bloblist_rec **recp, int size,
137 struct bloblist_rec *rec;
139 rec = bloblist_findrec(tag);
141 if (size && size != rec->size) {
148 ret = bloblist_addrec(tag, size, align, &rec);
157 void *bloblist_find(uint tag, int size)
159 struct bloblist_rec *rec;
161 rec = bloblist_findrec(tag);
164 if (size && size != rec->size)
167 return (void *)rec + rec->hdr_size;
170 void *bloblist_add(uint tag, int size, int align)
172 struct bloblist_rec *rec;
174 if (bloblist_addrec(tag, size, align, &rec))
177 return (void *)rec + rec->hdr_size;
180 int bloblist_ensure_size(uint tag, int size, int align, void **blobp)
182 struct bloblist_rec *rec;
185 ret = bloblist_ensurerec(tag, &rec, size, align);
188 *blobp = (void *)rec + rec->hdr_size;
193 void *bloblist_ensure(uint tag, int size)
195 struct bloblist_rec *rec;
197 if (bloblist_ensurerec(tag, &rec, size, 0))
200 return (void *)rec + rec->hdr_size;
203 int bloblist_ensure_size_ret(uint tag, int *sizep, void **blobp)
205 struct bloblist_rec *rec;
208 ret = bloblist_ensurerec(tag, &rec, *sizep, 0);
213 *blobp = (void *)rec + rec->hdr_size;
218 static u32 bloblist_calc_chksum(struct bloblist_hdr *hdr)
220 struct bloblist_rec *rec;
223 chksum = crc32(0, (unsigned char *)hdr,
224 offsetof(struct bloblist_hdr, chksum));
225 foreach_rec(rec, hdr) {
226 chksum = crc32(chksum, (void *)rec, rec->hdr_size);
227 chksum = crc32(chksum, (void *)rec + rec->hdr_size, rec->size);
233 int bloblist_new(ulong addr, uint size, uint flags)
235 struct bloblist_hdr *hdr;
237 if (size < sizeof(*hdr))
238 return log_ret(-ENOSPC);
239 if (addr & (BLOBLIST_ALIGN - 1))
240 return log_ret(-EFAULT);
241 hdr = map_sysmem(addr, size);
242 memset(hdr, '\0', sizeof(*hdr));
243 hdr->version = BLOBLIST_VERSION;
244 hdr->hdr_size = sizeof(*hdr);
246 hdr->magic = BLOBLIST_MAGIC;
248 hdr->alloced = hdr->hdr_size;
255 int bloblist_check(ulong addr, uint size)
257 struct bloblist_hdr *hdr;
260 hdr = map_sysmem(addr, sizeof(*hdr));
261 if (hdr->magic != BLOBLIST_MAGIC)
262 return log_msg_ret("Bad magic", -ENOENT);
263 if (hdr->version != BLOBLIST_VERSION)
264 return log_msg_ret("Bad version", -EPROTONOSUPPORT);
265 if (size && hdr->size != size)
266 return log_msg_ret("Bad size", -EFBIG);
267 chksum = bloblist_calc_chksum(hdr);
268 if (hdr->chksum != chksum) {
269 log(LOGC_BLOBLIST, LOGL_ERR, "Checksum %x != %x\n", hdr->chksum,
271 return log_msg_ret("Bad checksum", -EIO);
278 int bloblist_finish(void)
280 struct bloblist_hdr *hdr = gd->bloblist;
282 hdr->chksum = bloblist_calc_chksum(hdr);
287 void bloblist_get_stats(ulong *basep, ulong *sizep, ulong *allocedp)
289 struct bloblist_hdr *hdr = gd->bloblist;
291 *basep = map_to_sysmem(gd->bloblist);
293 *allocedp = hdr->alloced;
296 static void show_value(const char *prompt, ulong value)
298 printf("%s:%*s %-5lx ", prompt, 8 - (int)strlen(prompt), "", value);
299 print_size(value, "\n");
302 void bloblist_show_stats(void)
304 ulong base, size, alloced;
306 bloblist_get_stats(&base, &size, &alloced);
307 printf("base: %lx\n", base);
308 show_value("size", size);
309 show_value("alloced", alloced);
310 show_value("free", size - alloced);
313 void bloblist_show_list(void)
315 struct bloblist_hdr *hdr = gd->bloblist;
316 struct bloblist_rec *rec;
318 printf("%-8s %8s Tag Name\n", "Address", "Size");
319 for (rec = bloblist_first_blob(hdr); rec;
320 rec = bloblist_next_blob(hdr, rec)) {
321 printf("%08lx %8x %3d %s\n",
322 (ulong)map_to_sysmem((void *)rec + rec->hdr_size),
323 rec->size, rec->tag, bloblist_tag_name(rec->tag));
327 void bloblist_reloc(void *to, uint to_size, void *from, uint from_size)
329 struct bloblist_hdr *hdr;
331 memcpy(to, from, from_size);
336 int bloblist_init(void)
342 * Wed expect to find an existing bloblist in the first phase of U-Boot
345 expected = !u_boot_first_phase();
346 if (spl_prev_phase() == PHASE_TPL && !IS_ENABLED(CONFIG_TPL_BLOBLIST))
349 ret = bloblist_check(CONFIG_BLOBLIST_ADDR,
350 CONFIG_BLOBLIST_SIZE);
352 log(LOGC_BLOBLIST, expected ? LOGL_WARNING : LOGL_DEBUG,
353 "Existing bloblist not found: creating new bloblist\n");
354 ret = bloblist_new(CONFIG_BLOBLIST_ADDR, CONFIG_BLOBLIST_SIZE,
357 log(LOGC_BLOBLIST, LOGL_DEBUG, "Found existing bloblist\n");