1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * Copyright (c) 2011 The Chromium OS Authors. All rights reserved.
10 #include <linux/compiler.h>
21 CBFS_TYPE_BOOTBLOCK = 0x01,
22 CBFS_TYPE_CBFSHEADER = 0x02,
23 CBFS_TYPE_STAGE = 0x10,
24 CBFS_TYPE_PAYLOAD = 0x20,
26 CBFS_TYPE_OPTIONROM = 0x30,
27 CBFS_TYPE_BOOTSPLASH = 0x40,
31 CBFS_TYPE_MICROCODE = 0x53,
36 CBFS_TYPE_STRUCT = 0x70,
37 CBFS_TYPE_CMOS_DEFAULT = 0xaa,
39 CBFS_TYPE_MRC_CACHE = 0xac,
40 CBFS_TYPE_CMOS_LAYOUT = 0x01aa
44 CBFS_HEADER_MAGIC = 0x4f524243,
48 * struct cbfs_header - header at the start of a CBFS region
50 * All fields use big-endian format.
52 * @magic: Magic number (CBFS_HEADER_MAGIC)
64 struct cbfs_fileheader {
68 /* offset to struct cbfs_file_attribute or 0 */
69 u32 attributes_offset;
73 struct cbfs_cachenode {
74 struct cbfs_cachenode *next;
80 u32 attributes_offset;
83 extern enum cbfs_result file_cbfs_result;
86 * file_cbfs_error() - Return a string describing the most recent error
89 * @return A pointer to the constant string.
91 const char *file_cbfs_error(void);
94 * file_cbfs_init() - Initialize the CBFS driver and load metadata into RAM.
96 * @end_of_rom: Points to the end of the ROM the CBFS should be read
99 void file_cbfs_init(uintptr_t end_of_rom);
102 * file_cbfs_get_header() - Get the header structure for the current CBFS.
104 * @return A pointer to the constant structure, or NULL if there is none.
106 const struct cbfs_header *file_cbfs_get_header(void);
109 * file_cbfs_get_first() - Get a handle for the first file in CBFS.
111 * @return A handle for the first file in CBFS, NULL on error.
113 const struct cbfs_cachenode *file_cbfs_get_first(void);
116 * file_cbfs_get_next() - Get a handle to the file after this one in CBFS.
118 * @file: A pointer to the handle to advance.
120 void file_cbfs_get_next(const struct cbfs_cachenode **file);
123 * file_cbfs_find() - Find a file with a particular name in CBFS.
125 * @name: The name to search for.
127 * @return A handle to the file, or NULL on error.
129 const struct cbfs_cachenode *file_cbfs_find(const char *name);
132 /***************************************************************************/
133 /* All of the functions below can be used without first initializing CBFS. */
134 /***************************************************************************/
137 * file_cbfs_find_uncached() - Find a file with a particular name in CBFS
138 * without using the heap.
140 * @end_of_rom: Points to the end of the ROM the CBFS should be read
142 * @name: The name to search for.
144 * @return A handle to the file, or NULL on error.
146 const struct cbfs_cachenode *file_cbfs_find_uncached(uintptr_t end_of_rom,
150 * file_cbfs_name() - Get the name of a file in CBFS.
152 * @file: The handle to the file.
154 * @return The name of the file, NULL on error.
156 const char *file_cbfs_name(const struct cbfs_cachenode *file);
159 * file_cbfs_size() - Get the size of a file in CBFS.
161 * @file: The handle to the file.
163 * @return The size of the file, zero on error.
165 u32 file_cbfs_size(const struct cbfs_cachenode *file);
168 * file_cbfs_type() - Get the type of a file in CBFS.
170 * @file: The handle to the file.
172 * @return The type of the file, zero on error.
174 u32 file_cbfs_type(const struct cbfs_cachenode *file);
177 * file_cbfs_read() - Read a file from CBFS into RAM
179 * @file: A handle to the file to read.
180 * @buffer: Where to read it into memory.
181 * @maxsize: Maximum number of bytes to read
183 * @return If positive or zero, the number of characters read. If negative, an
186 long file_cbfs_read(const struct cbfs_cachenode *file, void *buffer,
187 unsigned long maxsize);
189 #endif /* __CBFS_H */