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 struct cbfs_header {
  44         u32 magic;
  45         u32 version;
  46         u32 rom_size;
  47         u32 boot_block_size;
  48         u32 align;
  49         u32 offset;
  50         u32 pad[2];
  51 } __packed;
  52
  53 struct cbfs_fileheader {
  54         u8 magic[8];
  55         u32 len;
  56         u32 type;
  57         u32 checksum;
  58         u32 offset;
  59 } __packed;
  60
  61 struct cbfs_cachenode {
  62         struct cbfs_cachenode *next;
  63         u32 type;
  64         void *data;
  65         u32 data_length;
  66         char *name;
  67         u32 name_length;
  68         u32 checksum;
  69 } __packed;
  70
  71 extern enum cbfs_result file_cbfs_result;
  72
  73 /**
  74  * file_cbfs_error() - Return a string describing the most recent error
  75  * condition.
  76  *
  77  * @return A pointer to the constant string.
  78  */
  79 const char *file_cbfs_error(void);
  80
  81 /**
  82  * file_cbfs_init() - Initialize the CBFS driver and load metadata into RAM.
  83  *
  84  * @end_of_rom: Points to the end of the ROM the CBFS should be read
  85  *                      from.
  86  */
  87 void file_cbfs_init(uintptr_t end_of_rom);
  88
  89 /**
  90  * file_cbfs_get_header() - Get the header structure for the current CBFS.
  91  *
  92  * @return A pointer to the constant structure, or NULL if there is none.
  93  */
  94 const struct cbfs_header *file_cbfs_get_header(void);
  95
  96 /**
  97  * file_cbfs_get_first() - Get a handle for the first file in CBFS.
  98  *
  99  * @return A handle for the first file in CBFS, NULL on error.
 100  */
 101 const struct cbfs_cachenode *file_cbfs_get_first(void);
 102
 103 /**
 104  * file_cbfs_get_next() - Get a handle to the file after this one in CBFS.
 105  *
 106  * @file:               A pointer to the handle to advance.
 107  */
 108 void file_cbfs_get_next(const struct cbfs_cachenode **file);
 109
 110 /**
 111  * file_cbfs_find() - Find a file with a particular name in CBFS.
 112  *
 113  * @name:               The name to search for.
 114  *
 115  * @return A handle to the file, or NULL on error.
 116  */
 117 const struct cbfs_cachenode *file_cbfs_find(const char *name);
 118
 119
 120 /***************************************************************************/
 121 /* All of the functions below can be used without first initializing CBFS. */
 122 /***************************************************************************/
 123
 124 /**
 125  * file_cbfs_find_uncached() - Find a file with a particular name in CBFS
 126  * without using the heap.
 127  *
 128  * @end_of_rom:         Points to the end of the ROM the CBFS should be read
 129  *                      from.
 130  * @name:               The name to search for.
 131  *
 132  * @return A handle to the file, or NULL on error.
 133  */
 134 const struct cbfs_cachenode *file_cbfs_find_uncached(uintptr_t end_of_rom,
 135                                                      const char *name);
 136
 137 /**
 138  * file_cbfs_name() - Get the name of a file in CBFS.
 139  *
 140  * @file:               The handle to the file.
 141  *
 142  * @return The name of the file, NULL on error.
 143  */
 144 const char *file_cbfs_name(const struct cbfs_cachenode *file);
 145
 146 /**
 147  * file_cbfs_size() - Get the size of a file in CBFS.
 148  *
 149  * @file:               The handle to the file.
 150  *
 151  * @return The size of the file, zero on error.
 152  */
 153 u32 file_cbfs_size(const struct cbfs_cachenode *file);
 154
 155 /**
 156  * file_cbfs_type() - Get the type of a file in CBFS.
 157  *
 158  * @file:               The handle to the file.
 159  *
 160  * @return The type of the file, zero on error.
 161  */
 162 u32 file_cbfs_type(const struct cbfs_cachenode *file);
 163
 164 /**
 165  * file_cbfs_read() - Read a file from CBFS into RAM
 166  *
 167  * @file:               A handle to the file to read.
 168  * @buffer:             Where to read it into memory.
 169  * @maxsize:            Maximum number of bytes to read
 170  *
 171  * @return If positive or zero, the number of characters read. If negative, an
 172  *         error occurred.
 173  */
 174 long file_cbfs_read(const struct cbfs_cachenode *file, void *buffer,
 175                     unsigned long maxsize);
 176
 177 #endif /* __CBFS_H */