include/bloblist.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * This provides a standard way of passing information between boot phases
   4  * (TPL -> SPL -> U-Boot proper.)
   5  *
   6  * A list of blobs of data, tagged with their owner. The list resides in memory
   7  * and can be updated by SPL, U-Boot, etc.
   8  *
   9  * Copyright 2018 Google, Inc
  10  * Written by Simon Glass <sjg@chromium.org>
  11  */
  12
  13 #ifndef __BLOBLIST_H
  14 #define __BLOBLIST_H
  15
  16 enum {
  17         BLOBLIST_VERSION        = 0,
  18         BLOBLIST_MAGIC          = 0xb00757a3,
  19         BLOBLIST_ALIGN          = 16,
  20 };
  21
  22 enum bloblist_tag_t {
  23         BLOBLISTT_NONE = 0,
  24
  25         /* Vendor-specific tags are permitted here */
  26         BLOBLISTT_EC_HOSTEVENT,         /* Chromium OS EC host-event mask */
  27         BLOBLISTT_SPL_HANDOFF,          /* Hand-off info from SPL */
  28         BLOBLISTT_VBOOT_CTX,            /* Chromium OS verified boot context */
  29         BLOBLISTT_VBOOT_HANDOFF,        /* Chromium OS internal handoff info */
  30         /*
  31          * Advanced Configuration and Power Interface Global Non-Volatile
  32          * Sleeping table. This forms part of the ACPI tables passed to Linux.
  33          */
  34         BLOBLISTT_ACPI_GNVS,
  35 };
  36
  37 /**
  38  * struct bloblist_hdr - header for the bloblist
  39  *
  40  * This is stored at the start of the bloblist which is always on a 16-byte
  41  * boundary. Records follow this header. The bloblist normally stays in the
  42  * same place in memory as SPL and U-Boot execute, but it can be safely moved
  43  * around.
  44  *
  45  * None of the bloblist structures contain pointers but it is possible to put
  46  * pointers inside a bloblist record if desired. This is not encouraged,
  47  * since it can make part of the bloblist inaccessible if the pointer is
  48  * no-longer valid. It is better to just store all the data inside a bloblist
  49  * record.
  50  *
  51  * Each bloblist record is aligned to a 16-byte boundary and follows immediately
  52  * from the last.
  53  *
  54  * @version: BLOBLIST_VERSION
  55  * @hdr_size: Size of this header, normally sizeof(struct bloblist_hdr). The
  56  *      first bloblist_rec starts at this offset from the start of the header
  57  * @flags: Space for BLOBLISTF_... flags (none yet)
  58  * @magic: BLOBLIST_MAGIC
  59  * @size: Total size of all records (non-zero if valid) including this header.
  60  *      The bloblist extends for this many bytes from the start of this header.
  61  * @alloced: Total size allocated for this bloblist. When adding new records,
  62  *      the bloblist can grow up to this size. This starts out as
  63  *      sizeof(bloblist_hdr) since we need at least that much space to store a
  64  *      valid bloblist
  65  * @spare: Space space
  66  * @chksum: CRC32 for the entire bloblist allocated area. Since any of the
  67  *      blobs can be altered after being created, this checksum is only valid
  68  *      when the bloblist is finalised before jumping to the next stage of boot.
  69  *      Note: @chksum is last to make it easier to exclude it from the checksum
  70  *      calculation.
  71  */
  72 struct bloblist_hdr {
  73         u32 version;
  74         u32 hdr_size;
  75         u32 flags;
  76         u32 magic;
  77
  78         u32 size;
  79         u32 alloced;
  80         u32 spare;
  81         u32 chksum;
  82 };
  83
  84 /**
  85  * struct bloblist_rec - record for the bloblist
  86  *
  87  * NOTE: Only exported for testing purposes. Do not use this struct.
  88  *
  89  * The bloblist contains a number of records each consisting of this record
  90  * structure followed by the data contained. Each records is 16-byte aligned.
  91  *
  92  * @tag: Tag indicating what the record contains
  93  * @hdr_size: Size of this header, normally sizeof(struct bloblist_rec). The
  94  *      record's data starts at this offset from the start of the record
  95  * @size: Size of record in bytes, excluding the header size. This does not
  96  *      need to be aligned (e.g. 3 is OK).
  97  * @spare: Spare space for other things
  98  */
  99 struct bloblist_rec {
 100         u32 tag;
 101         u32 hdr_size;
 102         u32 size;
 103         u32 spare;
 104 };
 105
 106 /**
 107  * bloblist_find() - Find a blob
 108  *
 109  * Searches the bloblist and returns the blob with the matching tag
 110  *
 111  * @tag:        Tag to search for (enum bloblist_tag_t)
 112  * @size:       Expected size of the blob
 113  * @return pointer to blob if found, or NULL if not found, or a blob was found
 114  *      but it is the wrong size
 115  */
 116 void *bloblist_find(uint tag, int size);
 117
 118 /**
 119  * bloblist_add() - Add a new blob
 120  *
 121  * Add a new blob to the bloblist
 122  *
 123  * This should only be called if you konw there is no existing blob for a
 124  * particular tag. It is typically safe to call in the first phase of U-Boot
 125  * (e.g. TPL or SPL). After that, bloblist_ensure() should be used instead.
 126  *
 127  * @tag:        Tag to add (enum bloblist_tag_t)
 128  * @size:       Size of the blob
 129  * @return pointer to the newly added block, or NULL if there is not enough
 130  *      space for the blob
 131  */
 132 void *bloblist_add(uint tag, int size);
 133
 134 /**
 135  * bloblist_ensure_size() - Find or add a blob
 136  *
 137  * Find an existing blob, or add a new one if not found
 138  *
 139  * @tag:        Tag to add (enum bloblist_tag_t)
 140  * @size:       Size of the blob
 141  * @blobp:      Returns a pointer to blob on success
 142  * @return 0 if OK, -ENOSPC if it is missing and could not be added due to lack
 143  *      of space, or -ESPIPE it exists but has the wrong size
 144  */
 145 int bloblist_ensure_size(uint tag, int size, void **blobp);
 146
 147 /**
 148  * bloblist_ensure() - Find or add a blob
 149  *
 150  * Find an existing blob, or add a new one if not found
 151  *
 152  * @tag:        Tag to add (enum bloblist_tag_t)
 153  * @size:       Size of the blob
 154  * @return pointer to blob, or NULL if it is missing and could not be added due
 155  *      to lack of space, or it exists but has the wrong size
 156  */
 157 void *bloblist_ensure(uint tag, int size);
 158
 159 /**
 160  * bloblist_ensure_size_ret() - Find or add a blob
 161  *
 162  * Find an existing blob, or add a new one if not found
 163  *
 164  * @tag:        Tag to add (enum bloblist_tag_t)
 165  * @sizep:      Size of the blob to create; returns size of actual blob
 166  * @blobp:      Returns a pointer to blob on success
 167  * @return 0 if OK, -ENOSPC if it is missing and could not be added due to lack
 168  *      of space
 169  */
 170 int bloblist_ensure_size_ret(uint tag, int *sizep, void **blobp);
 171
 172 /**
 173  * bloblist_new() - Create a new, empty bloblist of a given size
 174  *
 175  * @addr: Address of bloblist
 176  * @size: Initial size for bloblist
 177  * @flags: Flags to use for bloblist
 178  * @return 0 if OK, -EFAULT if addr is not aligned correctly, -ENOSPC is the
 179  *      area is not large enough
 180  */
 181 int bloblist_new(ulong addr, uint size, uint flags);
 182
 183 /**
 184  * bloblist_check() - Check if a bloblist exists
 185  *
 186  * @addr: Address of bloblist
 187  * @size: Expected size of blobsize, or 0 to detect the size
 188  * @return 0 if OK, -ENOENT if the magic number doesn't match (indicating that
 189  *      there problem is no bloblist at the given address), -EPROTONOSUPPORT
 190  *      if the version does not match, -EIO if the checksum does not match,
 191  *      -EFBIG if the expected size does not match the detected size, -ENOSPC
 192  *      if the size is not large enough to hold the headers
 193  */
 194 int bloblist_check(ulong addr, uint size);
 195
 196 /**
 197  * bloblist_finish() - Set up the bloblist for the next U-Boot part
 198  *
 199  * This sets the correct checksum for the bloblist. This ensures that the
 200  * bloblist will be detected correctly by the next phase of U-Boot.
 201  *
 202  * @return 0
 203  */
 204 int bloblist_finish(void);
 205
 206 /**
 207  * bloblist_init() - Init the bloblist system with a single bloblist
 208  *
 209  * This uses CONFIG_BLOBLIST_ADDR and CONFIG_BLOBLIST_SIZE to set up a bloblist
 210  * for use by U-Boot.
 211  */
 212 int bloblist_init(void);
 213
 214 #endif /* __BLOBLIST_H */