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