]>
Commit | Line | Data |
---|---|---|
83d290c5 | 1 | /* SPDX-License-Identifier: GPL-2.0+ */ |
84cd9327 GB |
2 | /* |
3 | * Copyright (c) 2011 The Chromium OS Authors. All rights reserved. | |
84cd9327 GB |
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 { | |
881bb9ab BM |
21 | CBFS_TYPE_BOOTBLOCK = 0x01, |
22 | CBFS_TYPE_CBFSHEADER = 0x02, | |
84cd9327 GB |
23 | CBFS_TYPE_STAGE = 0x10, |
24 | CBFS_TYPE_PAYLOAD = 0x20, | |
881bb9ab | 25 | CBFS_TYPE_FIT = 0x21, |
84cd9327 GB |
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, | |
881bb9ab BM |
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, | |
14fdf91e | 37 | CBFS_TYPE_CMOS_DEFAULT = 0xaa, |
881bb9ab BM |
38 | CBFS_TYPE_SPD = 0xab, |
39 | CBFS_TYPE_MRC_CACHE = 0xac, | |
14fdf91e | 40 | CBFS_TYPE_CMOS_LAYOUT = 0x01aa |
84cd9327 GB |
41 | }; |
42 | ||
08b7bc3c SG |
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 | */ | |
84cd9327 GB |
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; | |
ababe101 SG |
68 | /* offset to struct cbfs_file_attribute or 0 */ |
69 | u32 attributes_offset; | |
84cd9327 GB |
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; | |
ababe101 | 80 | u32 attributes_offset; |
84cd9327 GB |
81 | } __packed; |
82 | ||
83 | extern enum cbfs_result file_cbfs_result; | |
84 | ||
e3ff797c SG |
85 | /** |
86 | * file_cbfs_error() - Return a string describing the most recent error | |
87 | * condition. | |
84cd9327 GB |
88 | * |
89 | * @return A pointer to the constant string. | |
90 | */ | |
91 | const char *file_cbfs_error(void); | |
92 | ||
c7f16934 SG |
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 | ||
e3ff797c SG |
100 | /** |
101 | * file_cbfs_init() - Initialize the CBFS driver and load metadata into RAM. | |
84cd9327 | 102 | * |
e3ff797c | 103 | * @end_of_rom: Points to the end of the ROM the CBFS should be read |
84cd9327 GB |
104 | * from. |
105 | */ | |
106 | void file_cbfs_init(uintptr_t end_of_rom); | |
107 | ||
e3ff797c SG |
108 | /** |
109 | * file_cbfs_get_header() - Get the header structure for the current CBFS. | |
84cd9327 GB |
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 | ||
e3ff797c SG |
115 | /** |
116 | * file_cbfs_get_first() - Get a handle for the first file in CBFS. | |
84cd9327 GB |
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 | ||
e3ff797c SG |
122 | /** |
123 | * file_cbfs_get_next() - Get a handle to the file after this one in CBFS. | |
84cd9327 | 124 | * |
e3ff797c | 125 | * @file: A pointer to the handle to advance. |
84cd9327 GB |
126 | */ |
127 | void file_cbfs_get_next(const struct cbfs_cachenode **file); | |
128 | ||
e3ff797c SG |
129 | /** |
130 | * file_cbfs_find() - Find a file with a particular name in CBFS. | |
84cd9327 | 131 | * |
e3ff797c | 132 | * @name: The name to search for. |
84cd9327 GB |
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 | ||
139 | /***************************************************************************/ | |
140 | /* All of the functions below can be used without first initializing CBFS. */ | |
141 | /***************************************************************************/ | |
142 | ||
e3ff797c SG |
143 | /** |
144 | * file_cbfs_find_uncached() - Find a file with a particular name in CBFS | |
145 | * without using the heap. | |
84cd9327 | 146 | * |
e3ff797c | 147 | * @end_of_rom: Points to the end of the ROM the CBFS should be read |
84cd9327 | 148 | * from. |
e3ff797c | 149 | * @name: The name to search for. |
84cd9327 GB |
150 | * |
151 | * @return A handle to the file, or NULL on error. | |
152 | */ | |
153 | const struct cbfs_cachenode *file_cbfs_find_uncached(uintptr_t end_of_rom, | |
154 | const char *name); | |
155 | ||
e3ff797c SG |
156 | /** |
157 | * file_cbfs_name() - Get the name of a file in CBFS. | |
84cd9327 | 158 | * |
e3ff797c | 159 | * @file: The handle to the file. |
84cd9327 GB |
160 | * |
161 | * @return The name of the file, NULL on error. | |
162 | */ | |
163 | const char *file_cbfs_name(const struct cbfs_cachenode *file); | |
164 | ||
e3ff797c SG |
165 | /** |
166 | * file_cbfs_size() - Get the size of a file in CBFS. | |
84cd9327 | 167 | * |
e3ff797c | 168 | * @file: The handle to the file. |
84cd9327 GB |
169 | * |
170 | * @return The size of the file, zero on error. | |
171 | */ | |
172 | u32 file_cbfs_size(const struct cbfs_cachenode *file); | |
173 | ||
e3ff797c SG |
174 | /** |
175 | * file_cbfs_type() - Get the type of a file in CBFS. | |
84cd9327 | 176 | * |
e3ff797c | 177 | * @file: The handle to the file. |
84cd9327 GB |
178 | * |
179 | * @return The type of the file, zero on error. | |
180 | */ | |
181 | u32 file_cbfs_type(const struct cbfs_cachenode *file); | |
182 | ||
e3ff797c SG |
183 | /** |
184 | * file_cbfs_read() - Read a file from CBFS into RAM | |
84cd9327 | 185 | * |
e3ff797c SG |
186 | * @file: A handle to the file to read. |
187 | * @buffer: Where to read it into memory. | |
188 | * @maxsize: Maximum number of bytes to read | |
84cd9327 GB |
189 | * |
190 | * @return If positive or zero, the number of characters read. If negative, an | |
e3ff797c | 191 | * error occurred. |
84cd9327 GB |
192 | */ |
193 | long file_cbfs_read(const struct cbfs_cachenode *file, void *buffer, | |
194 | unsigned long maxsize); | |
195 | ||
196 | #endif /* __CBFS_H */ |