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