include/cbfs.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * Copyright (c) 2011 The Chromium OS Authors. All rights reserved.
   4  */
   5
   6 #ifndef __CBFS_H
   7 #define __CBFS_H
   8
   9 #include <compiler.h>
  10 #include <linux/compiler.h>
  11
  12 struct cbfs_priv;
  13
  14 enum cbfs_result {
  15         CBFS_SUCCESS = 0,
  16         CBFS_NOT_INITIALIZED,
  17         CBFS_BAD_HEADER,
  18         CBFS_BAD_FILE,
  19         CBFS_FILE_NOT_FOUND
  20 };
  21
  22 enum cbfs_filetype {
  23         CBFS_TYPE_BOOTBLOCK = 0x01,
  24         CBFS_TYPE_CBFSHEADER = 0x02,
  25         CBFS_TYPE_STAGE = 0x10,
  26         CBFS_TYPE_PAYLOAD = 0x20,
  27         CBFS_TYPE_FIT = 0x21,
  28         CBFS_TYPE_OPTIONROM = 0x30,
  29         CBFS_TYPE_BOOTSPLASH = 0x40,
  30         CBFS_TYPE_RAW = 0x50,
  31         CBFS_TYPE_VSA = 0x51,
  32         CBFS_TYPE_MBI = 0x52,
  33         CBFS_TYPE_MICROCODE = 0x53,
  34         CBFS_TYPE_FSP = 0x60,
  35         CBFS_TYPE_MRC = 0x61,
  36         CBFS_TYPE_MMA = 0x62,
  37         CBFS_TYPE_EFI = 0x63,
  38         CBFS_TYPE_STRUCT = 0x70,
  39         CBFS_TYPE_CMOS_DEFAULT = 0xaa,
  40         CBFS_TYPE_SPD = 0xab,
  41         CBFS_TYPE_MRC_CACHE = 0xac,
  42         CBFS_TYPE_CMOS_LAYOUT = 0x01aa
  43 };
  44
  45 enum {
  46         CBFS_HEADER_MAGIC       = 0x4f524243,
  47         CBFS_SIZE_UNKNOWN       = 0xffffffff,
  48         CBFS_ALIGN_SIZE         = 0x40,
  49 };
  50
  51 /**
  52  * struct cbfs_header - header at the start of a CBFS region
  53  *
  54  * All fields use big-endian format.
  55  *
  56  * @magic: Magic number (CBFS_HEADER_MAGIC)
  57  */
  58 struct cbfs_header {
  59         u32 magic;
  60         u32 version;
  61         u32 rom_size;
  62         u32 boot_block_size;
  63         u32 align;
  64         u32 offset;
  65         u32 pad[2];
  66 } __packed;
  67
  68 struct cbfs_fileheader {
  69         u8 magic[8];
  70         u32 len;
  71         u32 type;
  72         /* offset to struct cbfs_file_attribute or 0 */
  73         u32 attributes_offset;
  74         u32 offset;
  75         char filename[];
  76 } __packed;
  77
  78 /**
  79  * These are standard values for the known compression alogrithms that coreboot
  80  * knows about for stages and payloads.  Of course, other CBFS users can use
  81  * whatever values they want, as long as they understand them.
  82  */
  83 #define CBFS_COMPRESS_NONE  0
  84 #define CBFS_COMPRESS_LZMA  1
  85 #define CBFS_COMPRESS_LZ4   2
  86
  87 /*
  88  * Depending on how the header was initialized, it may be backed with 0x00 or
  89  * 0xff, so support both
  90  */
  91 #define CBFS_FILE_ATTR_TAG_UNUSED 0
  92 #define CBFS_FILE_ATTR_TAG_UNUSED2 0xffffffff
  93 #define CBFS_FILE_ATTR_TAG_COMPRESSION 0x42435a4c
  94 #define CBFS_FILE_ATTR_TAG_HASH 0x68736148
  95
  96 /*
  97  * The common fields of extended cbfs file attributes. Attributes are expected
  98  * to start with tag/len, then append their specific fields
  99  */
 100 struct cbfs_file_attribute {
 101         u32 tag;
 102         /* len covers the whole structure, incl. tag and len */
 103         u32 len;
 104         u8 data[0];
 105 } __packed;
 106
 107 struct cbfs_file_attr_compression {
 108         u32 tag;
 109         u32 len;
 110         /* whole file compression format. 0 if no compression. */
 111         u32 compression;
 112         u32 decompressed_size;
 113 } __packed;
 114
 115 struct cbfs_file_attr_hash {
 116         u32 tag;
 117         u32 len;
 118         u32 hash_type;
 119         /* hash_data is len - sizeof(struct) bytes */
 120         u8  hash_data[];
 121 } __packed;
 122
 123 struct cbfs_cachenode {
 124         struct cbfs_cachenode *next;
 125         void *data;
 126         char *name;
 127         u32 type;
 128         u32 data_length;
 129         u32 name_length;
 130         u32 attr_offset;
 131         u32 comp_algo;
 132         u32 decomp_size;
 133 };
 134
 135 /**
 136  * file_cbfs_error() - Return a string describing the most recent error
 137  * condition.
 138  *
 139  * Return: A pointer to the constant string.
 140  */
 141 const char *file_cbfs_error(void);
 142
 143 /**
 144  * cbfs_get_result() - Get the result of the last CBFS operation
 145  *
 146  *Return: last result
 147  */
 148 enum cbfs_result cbfs_get_result(void);
 149
 150 /**
 151  * file_cbfs_init() - Initialize the CBFS driver and load metadata into RAM.
 152  *
 153  * @end_of_rom: Points to the end of the ROM the CBFS should be read from
 154  * Return: 0 if OK, -ve on error
 155  */
 156 int file_cbfs_init(ulong end_of_rom);
 157
 158 /**
 159  * file_cbfs_get_header() - Get the header structure for the current CBFS.
 160  *
 161  * Return: A pointer to the constant structure, or NULL if there is none.
 162  */
 163 const struct cbfs_header *file_cbfs_get_header(void);
 164
 165 /**
 166  * cbfs_get_first() - Get the first file in a CBFS
 167  *
 168  * Return: pointer to first file, or NULL if it is empty
 169  */
 170 const struct cbfs_cachenode *cbfs_get_first(const struct cbfs_priv *priv);
 171
 172 /**
 173  * cbfs_get_next() - Get the next file in a CBFS
 174  *
 175  * @filep: Pointer to current file; updated to point to the next file, if any,
 176  *      else NULL
 177  */
 178 void cbfs_get_next(const struct cbfs_cachenode **filep);
 179
 180 /**
 181  * file_cbfs_get_first() - Get a handle for the first file in CBFS.
 182  *
 183  * Return: A handle for the first file in CBFS, NULL on error.
 184  */
 185 const struct cbfs_cachenode *file_cbfs_get_first(void);
 186
 187 /**
 188  * file_cbfs_get_next() - Get a handle to the file after this one in CBFS.
 189  *
 190  * @file:               A pointer to the handle to advance.
 191  */
 192 void file_cbfs_get_next(const struct cbfs_cachenode **file);
 193
 194 /**
 195  * file_cbfs_find() - Find a file with a particular name in CBFS.
 196  *
 197  * @name:               The name to search for.
 198  *
 199  * Return: A handle to the file, or NULL on error.
 200  */
 201 const struct cbfs_cachenode *file_cbfs_find(const char *name);
 202
 203 /**
 204  * cbfs_find_file() - Find a file in a given CBFS
 205  *
 206  * @cbfs: CBFS to look in (use cbfs_init_mem() to set it up)
 207  * @name: Filename to look for
 208  * Return: pointer to CBFS node if found, else NULL
 209  */
 210 const struct cbfs_cachenode *cbfs_find_file(struct cbfs_priv *cbfs,
 211                                             const char *name);
 212
 213 /**
 214  * cbfs_init_mem() - Set up a new CBFS
 215  *
 216  * @base: Base address of CBFS
 217  * @size: Size of CBFS if known, else CBFS_SIZE_UNKNOWN
 218  * @require_header: true to read a header at the start, false to not require one
 219  * @cbfsp: Returns a pointer to CBFS on success
 220  * Return: 0 if OK, -ve on error
 221  */
 222 int cbfs_init_mem(ulong base, ulong size, bool require_hdr,
 223                   struct cbfs_priv **privp);
 224
 225 /***************************************************************************/
 226 /* All of the functions below can be used without first initializing CBFS. */
 227 /***************************************************************************/
 228
 229 /**
 230  * file_cbfs_find_uncached() - Find a file in CBFS given the end of the ROM
 231  *
 232  * Note that @node should be declared by the caller. This design is to avoid
 233  * the need for allocation here.
 234  *
 235  * @end_of_rom: Points to the end of the ROM the CBFS should be read from
 236  * @name: The name to search for
 237  * @node: Returns the contents of the node if found (i.e. copied into *node)
 238  * Return: 0 on success, -ENOENT if not found, -EFAULT on bad header
 239  */
 240 int file_cbfs_find_uncached(ulong end_of_rom, const char *name,
 241                             struct cbfs_cachenode *node);
 242
 243 /**
 244  * file_cbfs_find_uncached_base() - Find a file in CBFS given the base address
 245  *
 246  * Note that @node should be declared by the caller. This design is to avoid
 247  * the need for allocation here.
 248  *
 249  * @base: Points to the base of the CBFS
 250  * @name: The name to search for
 251  * @node: Returns the contents of the node if found (i.e. copied into *node)
 252  * Return: 0 on success, -ENOENT if not found, -EFAULT on bad header
 253  */
 254 int file_cbfs_find_uncached_base(ulong base, const char *name,
 255                                  struct cbfs_cachenode *node);
 256
 257 /**
 258  * file_cbfs_name() - Get the name of a file in CBFS.
 259  *
 260  * @file:               The handle to the file.
 261  *
 262  * Return: The name of the file, NULL on error.
 263  */
 264 const char *file_cbfs_name(const struct cbfs_cachenode *file);
 265
 266 /**
 267  * file_cbfs_size() - Get the size of a file in CBFS.
 268  *
 269  * @file:               The handle to the file.
 270  *
 271  * Return: The size of the file, zero on error.
 272  */
 273 u32 file_cbfs_size(const struct cbfs_cachenode *file);
 274
 275 /**
 276  * file_cbfs_type() - Get the type of a file in CBFS.
 277  *
 278  * @file:               The handle to the file.
 279  *
 280  * Return: The type of the file, zero on error.
 281  */
 282 u32 file_cbfs_type(const struct cbfs_cachenode *file);
 283
 284 /**
 285  * file_cbfs_read() - Read a file from CBFS into RAM
 286  *
 287  * @file:               A handle to the file to read.
 288  * @buffer:             Where to read it into memory.
 289  * @maxsize:            Maximum number of bytes to read
 290  *
 291  * Return: If positive or zero, the number of characters read. If negative, an
 292  *         error occurred.
 293  */
 294 long file_cbfs_read(const struct cbfs_cachenode *file, void *buffer,
 295                     unsigned long maxsize);
 296
 297 #endif /* __CBFS_H */