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 } __packed;
  72
  73 struct cbfs_cachenode {
  74         struct cbfs_cachenode *next;
  75         u32 type;
  76         void *data;
  77         u32 data_length;
  78         char *name;
  79         u32 name_length;
  80         u32 attributes_offset;
  81 } __packed;
  82
  83 extern enum cbfs_result file_cbfs_result;
  84
  85 /**
  86  * file_cbfs_error() - Return a string describing the most recent error
  87  * condition.
  88  *
  89  * @return A pointer to the constant string.
  90  */
  91 const char *file_cbfs_error(void);
  92
  93 /**
  94  * cbfs_get_result() - Get the result of the last CBFS operation
  95  *
  96  *@return last result
  97  */
  98 enum cbfs_result cbfs_get_result(void);
  99
 100 /**
 101  * file_cbfs_init() - Initialize the CBFS driver and load metadata into RAM.
 102  *
 103  * @end_of_rom: Points to the end of the ROM the CBFS should be read
 104  *                      from.
 105  */
 106 void file_cbfs_init(uintptr_t end_of_rom);
 107
 108 /**
 109  * file_cbfs_get_header() - Get the header structure for the current CBFS.
 110  *
 111  * @return A pointer to the constant structure, or NULL if there is none.
 112  */
 113 const struct cbfs_header *file_cbfs_get_header(void);
 114
 115 /**
 116  * file_cbfs_get_first() - Get a handle for the first file in CBFS.
 117  *
 118  * @return A handle for the first file in CBFS, NULL on error.
 119  */
 120 const struct cbfs_cachenode *file_cbfs_get_first(void);
 121
 122 /**
 123  * file_cbfs_get_next() - Get a handle to the file after this one in CBFS.
 124  *
 125  * @file:               A pointer to the handle to advance.
 126  */
 127 void file_cbfs_get_next(const struct cbfs_cachenode **file);
 128
 129 /**
 130  * file_cbfs_find() - Find a file with a particular name in CBFS.
 131  *
 132  * @name:               The name to search for.
 133  *
 134  * @return A handle to the file, or NULL on error.
 135  */
 136 const struct cbfs_cachenode *file_cbfs_find(const char *name);
 137
 138 struct cbfs_priv *priv;
 139
 140 /**
 141  * cbfs_find_file() - Find a file in a given CBFS
 142  *
 143  * @cbfs: CBFS to look in (use cbfs_init_mem() to set it up)
 144  * @name: Filename to look for
 145  * @return pointer to CBFS node if found, else NULL
 146  */
 147 const struct cbfs_cachenode *cbfs_find_file(struct cbfs_priv *cbfs,
 148                                             const char *name);
 149
 150 /**
 151  * cbfs_init_mem() - Set up a new CBFS
 152  *
 153  * @base: Base address of CBFS
 154  * @size: Size of CBFS in bytes
 155  * @cbfsp: Returns a pointer to CBFS on success
 156  * @return 0 if OK, -ve on error
 157  */
 158 int cbfs_init_mem(ulong base, ulong size, struct cbfs_priv **privp);
 159
 160
 161 /***************************************************************************/
 162 /* All of the functions below can be used without first initializing CBFS. */
 163 /***************************************************************************/
 164
 165 /**
 166  * file_cbfs_find_uncached() - Find a file with a particular name in CBFS
 167  * without using the heap.
 168  *
 169  * @end_of_rom:         Points to the end of the ROM the CBFS should be read
 170  *                      from.
 171  * @name:               The name to search for.
 172  *
 173  * @return A handle to the file, or NULL on error.
 174  */
 175 const struct cbfs_cachenode *file_cbfs_find_uncached(uintptr_t end_of_rom,
 176                                                      const char *name);
 177
 178 /**
 179  * file_cbfs_name() - Get the name of a file in CBFS.
 180  *
 181  * @file:               The handle to the file.
 182  *
 183  * @return The name of the file, NULL on error.
 184  */
 185 const char *file_cbfs_name(const struct cbfs_cachenode *file);
 186
 187 /**
 188  * file_cbfs_size() - Get the size of a file in CBFS.
 189  *
 190  * @file:               The handle to the file.
 191  *
 192  * @return The size of the file, zero on error.
 193  */
 194 u32 file_cbfs_size(const struct cbfs_cachenode *file);
 195
 196 /**
 197  * file_cbfs_type() - Get the type of a file in CBFS.
 198  *
 199  * @file:               The handle to the file.
 200  *
 201  * @return The type of the file, zero on error.
 202  */
 203 u32 file_cbfs_type(const struct cbfs_cachenode *file);
 204
 205 /**
 206  * file_cbfs_read() - Read a file from CBFS into RAM
 207  *
 208  * @file:               A handle to the file to read.
 209  * @buffer:             Where to read it into memory.
 210  * @maxsize:            Maximum number of bytes to read
 211  *
 212  * @return If positive or zero, the number of characters read. If negative, an
 213  *         error occurred.
 214  */
 215 long file_cbfs_read(const struct cbfs_cachenode *file, void *buffer,
 216                     unsigned long maxsize);
 217
 218 #endif /* __CBFS_H */