123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263 |
- /* SPDX-License-Identifier: GPL-2.0+ */
- /*
- * This provides a standard way of passing information between boot phases
- * (TPL -> SPL -> U-Boot proper.)
- *
- * A list of blobs of data, tagged with their owner. The list resides in memory
- * and can be updated by SPL, U-Boot, etc.
- *
- * Copyright 2018 Google, Inc
- * Written by Simon Glass <sjg@chromium.org>
- */
- #ifndef __BLOBLIST_H
- #define __BLOBLIST_H
- enum {
- BLOBLIST_VERSION = 0,
- BLOBLIST_MAGIC = 0xb00757a3,
- BLOBLIST_ALIGN = 16,
- };
- /* Supported tags - add new ones to tag_name in bloblist.c */
- enum bloblist_tag_t {
- BLOBLISTT_NONE = 0,
- /* Vendor-specific tags are permitted here */
- BLOBLISTT_EC_HOSTEVENT, /* Chromium OS EC host-event mask */
- BLOBLISTT_SPL_HANDOFF, /* Hand-off info from SPL */
- BLOBLISTT_VBOOT_CTX, /* Chromium OS verified boot context */
- BLOBLISTT_VBOOT_HANDOFF, /* Chromium OS internal handoff info */
- /*
- * Advanced Configuration and Power Interface Global Non-Volatile
- * Sleeping table. This forms part of the ACPI tables passed to Linux.
- */
- BLOBLISTT_ACPI_GNVS,
- BLOBLISTT_INTEL_VBT, /* Intel Video-BIOS table */
- BLOBLISTT_TPM2_TCG_LOG, /* TPM v2 log space */
- BLOBLISTT_TCPA_LOG, /* TPM log space */
- BLOBLISTT_ACPI_TABLES, /* ACPI tables for x86 */
- BLOBLISTT_SMBIOS_TABLES, /* SMBIOS tables for x86 */
- BLOBLISTT_COUNT
- };
- /**
- * struct bloblist_hdr - header for the bloblist
- *
- * This is stored at the start of the bloblist which is always on a 16-byte
- * boundary. Records follow this header. The bloblist normally stays in the
- * same place in memory as SPL and U-Boot execute, but it can be safely moved
- * around.
- *
- * None of the bloblist structures contain pointers but it is possible to put
- * pointers inside a bloblist record if desired. This is not encouraged,
- * since it can make part of the bloblist inaccessible if the pointer is
- * no-longer valid. It is better to just store all the data inside a bloblist
- * record.
- *
- * Each bloblist record is aligned to a 16-byte boundary and follows immediately
- * from the last.
- *
- * @version: BLOBLIST_VERSION
- * @hdr_size: Size of this header, normally sizeof(struct bloblist_hdr). The
- * first bloblist_rec starts at this offset from the start of the header
- * @flags: Space for BLOBLISTF_... flags (none yet)
- * @magic: BLOBLIST_MAGIC
- * @size: Total size of all records (non-zero if valid) including this header.
- * The bloblist extends for this many bytes from the start of this header.
- * @alloced: Total size allocated for this bloblist. When adding new records,
- * the bloblist can grow up to this size. This starts out as
- * sizeof(bloblist_hdr) since we need at least that much space to store a
- * valid bloblist
- * @spare: Spare space (for future use)
- * @chksum: CRC32 for the entire bloblist allocated area. Since any of the
- * blobs can be altered after being created, this checksum is only valid
- * when the bloblist is finalised before jumping to the next stage of boot.
- * Note: @chksum is last to make it easier to exclude it from the checksum
- * calculation.
- */
- struct bloblist_hdr {
- u32 version;
- u32 hdr_size;
- u32 flags;
- u32 magic;
- u32 size;
- u32 alloced;
- u32 spare;
- u32 chksum;
- };
- /**
- * struct bloblist_rec - record for the bloblist
- *
- * NOTE: Only exported for testing purposes. Do not use this struct.
- *
- * The bloblist contains a number of records each consisting of this record
- * structure followed by the data contained. Each records is 16-byte aligned.
- *
- * @tag: Tag indicating what the record contains
- * @hdr_size: Size of this header, normally sizeof(struct bloblist_rec). The
- * record's data starts at this offset from the start of the record
- * @size: Size of record in bytes, excluding the header size. This does not
- * need to be aligned (e.g. 3 is OK).
- * @spare: Spare space for other things
- */
- struct bloblist_rec {
- u32 tag;
- u32 hdr_size;
- u32 size;
- u32 spare;
- };
- /**
- * bloblist_find() - Find a blob
- *
- * Searches the bloblist and returns the blob with the matching tag
- *
- * @tag: Tag to search for (enum bloblist_tag_t)
- * @size: Expected size of the blob, or 0 for any size
- * @return pointer to blob if found, or NULL if not found, or a blob was found
- * but it is the wrong size
- */
- void *bloblist_find(uint tag, int size);
- /**
- * bloblist_add() - Add a new blob
- *
- * Add a new blob to the bloblist
- *
- * This should only be called if you konw there is no existing blob for a
- * particular tag. It is typically safe to call in the first phase of U-Boot
- * (e.g. TPL or SPL). After that, bloblist_ensure() should be used instead.
- *
- * @tag: Tag to add (enum bloblist_tag_t)
- * @size: Size of the blob
- * @align: Alignment of the blob (in bytes), 0 for default
- * @return pointer to the newly added block, or NULL if there is not enough
- * space for the blob
- */
- void *bloblist_add(uint tag, int size, int align);
- /**
- * bloblist_ensure_size() - Find or add a blob
- *
- * Find an existing blob, or add a new one if not found
- *
- * @tag: Tag to add (enum bloblist_tag_t)
- * @size: Size of the blob
- * @blobp: Returns a pointer to blob on success
- * @align: Alignment of the blob (in bytes), 0 for default
- * @return 0 if OK, -ENOSPC if it is missing and could not be added due to lack
- * of space, or -ESPIPE it exists but has the wrong size
- */
- int bloblist_ensure_size(uint tag, int size, int align, void **blobp);
- /**
- * bloblist_ensure() - Find or add a blob
- *
- * Find an existing blob, or add a new one if not found
- *
- * @tag: Tag to add (enum bloblist_tag_t)
- * @size: Size of the blob
- * @return pointer to blob, or NULL if it is missing and could not be added due
- * to lack of space, or it exists but has the wrong size
- */
- void *bloblist_ensure(uint tag, int size);
- /**
- * bloblist_ensure_size_ret() - Find or add a blob
- *
- * Find an existing blob, or add a new one if not found
- *
- * @tag: Tag to add (enum bloblist_tag_t)
- * @sizep: Size of the blob to create; returns size of actual blob
- * @blobp: Returns a pointer to blob on success
- * @return 0 if OK, -ENOSPC if it is missing and could not be added due to lack
- * of space
- */
- int bloblist_ensure_size_ret(uint tag, int *sizep, void **blobp);
- /**
- * bloblist_new() - Create a new, empty bloblist of a given size
- *
- * @addr: Address of bloblist
- * @size: Initial size for bloblist
- * @flags: Flags to use for bloblist
- * @return 0 if OK, -EFAULT if addr is not aligned correctly, -ENOSPC is the
- * area is not large enough
- */
- int bloblist_new(ulong addr, uint size, uint flags);
- /**
- * bloblist_check() - Check if a bloblist exists
- *
- * @addr: Address of bloblist
- * @size: Expected size of blobsize, or 0 to detect the size
- * @return 0 if OK, -ENOENT if the magic number doesn't match (indicating that
- * there problem is no bloblist at the given address), -EPROTONOSUPPORT
- * if the version does not match, -EIO if the checksum does not match,
- * -EFBIG if the expected size does not match the detected size, -ENOSPC
- * if the size is not large enough to hold the headers
- */
- int bloblist_check(ulong addr, uint size);
- /**
- * bloblist_finish() - Set up the bloblist for the next U-Boot part
- *
- * This sets the correct checksum for the bloblist. This ensures that the
- * bloblist will be detected correctly by the next phase of U-Boot.
- *
- * @return 0
- */
- int bloblist_finish(void);
- /**
- * bloblist_get_stats() - Get information about the bloblist
- *
- * This returns useful information about the bloblist
- */
- void bloblist_get_stats(ulong *basep, ulong *sizep, ulong *allocedp);
- /**
- * bloblist_show_stats() - Show information about the bloblist
- *
- * This shows useful information about the bloblist on the console
- */
- void bloblist_show_stats(void);
- /**
- * bloblist_show_list() - Show a list of blobs in the bloblist
- *
- * This shows a list of blobs, showing their address, size and tag.
- */
- void bloblist_show_list(void);
- /**
- * bloblist_tag_name() - Get the name for a tag
- *
- * @tag: Tag to check
- * @return name of tag, or "invalid" if an invalid tag is provided
- */
- const char *bloblist_tag_name(enum bloblist_tag_t tag);
- /**
- * bloblist_reloc() - Relocate the bloblist and optionally resize it
- *
- * @to: Pointer to new bloblist location (must not overlap old location)
- * @to:size: New size for bloblist (must be larger than from_size)
- * @from: Pointer to bloblist to relocate
- * @from_size: Size of bloblist to relocate
- */
- void bloblist_reloc(void *to, uint to_size, void *from, uint from_size);
- /**
- * bloblist_init() - Init the bloblist system with a single bloblist
- *
- * This uses CONFIG_BLOBLIST_ADDR and CONFIG_BLOBLIST_SIZE to set up a bloblist
- * for use by U-Boot.
- */
- int bloblist_init(void);
- #endif /* __BLOBLIST_H */
|