2 * Copyright (c) 2011 The Chromium OS Authors. All rights reserved.
4 * SPDX-License-Identifier: GPL-2.0+
11 #include <linux/compiler.h>
22 CBFS_TYPE_STAGE = 0x10,
23 CBFS_TYPE_PAYLOAD = 0x20,
24 CBFS_TYPE_OPTIONROM = 0x30,
25 CBFS_TYPE_BOOTSPLASH = 0x40,
29 CBFS_TYPE_MICROCODE = 0x53,
30 CBFS_COMPONENT_CMOS_DEFAULT = 0xaa,
31 CBFS_COMPONENT_CMOS_LAYOUT = 0x01aa
44 struct cbfs_fileheader {
52 struct cbfs_cachenode {
53 struct cbfs_cachenode *next;
62 extern enum cbfs_result file_cbfs_result;
65 * file_cbfs_error() - Return a string describing the most recent error
68 * @return A pointer to the constant string.
70 const char *file_cbfs_error(void);
73 * file_cbfs_init() - Initialize the CBFS driver and load metadata into RAM.
75 * @end_of_rom: Points to the end of the ROM the CBFS should be read
78 void file_cbfs_init(uintptr_t end_of_rom);
81 * file_cbfs_get_header() - Get the header structure for the current CBFS.
83 * @return A pointer to the constant structure, or NULL if there is none.
85 const struct cbfs_header *file_cbfs_get_header(void);
88 * file_cbfs_get_first() - Get a handle for the first file in CBFS.
90 * @return A handle for the first file in CBFS, NULL on error.
92 const struct cbfs_cachenode *file_cbfs_get_first(void);
95 * file_cbfs_get_next() - Get a handle to the file after this one in CBFS.
97 * @file: A pointer to the handle to advance.
99 void file_cbfs_get_next(const struct cbfs_cachenode **file);
102 * file_cbfs_find() - Find a file with a particular name in CBFS.
104 * @name: The name to search for.
106 * @return A handle to the file, or NULL on error.
108 const struct cbfs_cachenode *file_cbfs_find(const char *name);
111 /***************************************************************************/
112 /* All of the functions below can be used without first initializing CBFS. */
113 /***************************************************************************/
116 * file_cbfs_find_uncached() - Find a file with a particular name in CBFS
117 * without using the heap.
119 * @end_of_rom: Points to the end of the ROM the CBFS should be read
121 * @name: The name to search for.
123 * @return A handle to the file, or NULL on error.
125 const struct cbfs_cachenode *file_cbfs_find_uncached(uintptr_t end_of_rom,
129 * file_cbfs_name() - Get the name of a file in CBFS.
131 * @file: The handle to the file.
133 * @return The name of the file, NULL on error.
135 const char *file_cbfs_name(const struct cbfs_cachenode *file);
138 * file_cbfs_size() - Get the size of a file in CBFS.
140 * @file: The handle to the file.
142 * @return The size of the file, zero on error.
144 u32 file_cbfs_size(const struct cbfs_cachenode *file);
147 * file_cbfs_type() - Get the type of a file in CBFS.
149 * @file: The handle to the file.
151 * @return The type of the file, zero on error.
153 u32 file_cbfs_type(const struct cbfs_cachenode *file);
156 * file_cbfs_read() - Read a file from CBFS into RAM
158 * @file: A handle to the file to read.
159 * @buffer: Where to read it into memory.
160 * @maxsize: Maximum number of bytes to read
162 * @return If positive or zero, the number of characters read. If negative, an
165 long file_cbfs_read(const struct cbfs_cachenode *file, void *buffer,
166 unsigned long maxsize);
168 #endif /* __CBFS_H */