blob: ae94f1dcdf503f98451c020304a8f2757000437d [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Gabe Black84cd9322012-10-12 14:26:11 +00002/*
3 * Copyright (c) 2011 The Chromium OS Authors. All rights reserved.
Gabe Black84cd9322012-10-12 14:26:11 +00004 */
5
6#ifndef __CBFS_H
7#define __CBFS_H
8
9#include <compiler.h>
10#include <linux/compiler.h>
11
Simon Glassc4f5b5d2021-03-15 18:00:13 +130012struct cbfs_priv;
13
Gabe Black84cd9322012-10-12 14:26:11 +000014enum cbfs_result {
15 CBFS_SUCCESS = 0,
16 CBFS_NOT_INITIALIZED,
17 CBFS_BAD_HEADER,
18 CBFS_BAD_FILE,
19 CBFS_FILE_NOT_FOUND
20};
21
22enum cbfs_filetype {
Bin Meng881bb9a2018-12-22 01:55:51 -080023 CBFS_TYPE_BOOTBLOCK = 0x01,
24 CBFS_TYPE_CBFSHEADER = 0x02,
Gabe Black84cd9322012-10-12 14:26:11 +000025 CBFS_TYPE_STAGE = 0x10,
26 CBFS_TYPE_PAYLOAD = 0x20,
Bin Meng881bb9a2018-12-22 01:55:51 -080027 CBFS_TYPE_FIT = 0x21,
Gabe Black84cd9322012-10-12 14:26:11 +000028 CBFS_TYPE_OPTIONROM = 0x30,
29 CBFS_TYPE_BOOTSPLASH = 0x40,
30 CBFS_TYPE_RAW = 0x50,
31 CBFS_TYPE_VSA = 0x51,
32 CBFS_TYPE_MBI = 0x52,
33 CBFS_TYPE_MICROCODE = 0x53,
Bin Meng881bb9a2018-12-22 01:55:51 -080034 CBFS_TYPE_FSP = 0x60,
35 CBFS_TYPE_MRC = 0x61,
36 CBFS_TYPE_MMA = 0x62,
37 CBFS_TYPE_EFI = 0x63,
38 CBFS_TYPE_STRUCT = 0x70,
Bin Meng14fdf912018-12-22 01:55:50 -080039 CBFS_TYPE_CMOS_DEFAULT = 0xaa,
Bin Meng881bb9a2018-12-22 01:55:51 -080040 CBFS_TYPE_SPD = 0xab,
41 CBFS_TYPE_MRC_CACHE = 0xac,
Bin Meng14fdf912018-12-22 01:55:50 -080042 CBFS_TYPE_CMOS_LAYOUT = 0x01aa
Gabe Black84cd9322012-10-12 14:26:11 +000043};
44
Simon Glass08b7bc32019-07-08 13:18:21 -060045enum {
46 CBFS_HEADER_MAGIC = 0x4f524243,
Simon Glass5536f122021-03-15 18:00:12 +130047 CBFS_SIZE_UNKNOWN = 0xffffffff,
48 CBFS_ALIGN_SIZE = 0x40,
Simon Glass08b7bc32019-07-08 13:18:21 -060049};
50
51/**
52 * struct cbfs_header - header at the start of a CBFS region
53 *
54 * All fields use big-endian format.
55 *
56 * @magic: Magic number (CBFS_HEADER_MAGIC)
57 */
Gabe Black84cd9322012-10-12 14:26:11 +000058struct cbfs_header {
59 u32 magic;
60 u32 version;
61 u32 rom_size;
62 u32 boot_block_size;
63 u32 align;
64 u32 offset;
65 u32 pad[2];
66} __packed;
67
68struct cbfs_fileheader {
69 u8 magic[8];
70 u32 len;
71 u32 type;
Simon Glassababe102019-07-08 13:18:22 -060072 /* offset to struct cbfs_file_attribute or 0 */
73 u32 attributes_offset;
Gabe Black84cd9322012-10-12 14:26:11 +000074 u32 offset;
Simon Glass72ca4852021-03-15 18:00:09 +130075 char filename[];
76} __packed;
77
Simon Glassa202f172021-03-15 18:00:16 +130078/**
79 * These are standard values for the known compression alogrithms that coreboot
80 * knows about for stages and payloads. Of course, other CBFS users can use
81 * whatever values they want, as long as they understand them.
82 */
83#define CBFS_COMPRESS_NONE 0
84#define CBFS_COMPRESS_LZMA 1
85#define CBFS_COMPRESS_LZ4 2
86
Simon Glass72ca4852021-03-15 18:00:09 +130087/*
88 * Depending on how the header was initialized, it may be backed with 0x00 or
89 * 0xff, so support both
90 */
91#define CBFS_FILE_ATTR_TAG_UNUSED 0
92#define CBFS_FILE_ATTR_TAG_UNUSED2 0xffffffff
93#define CBFS_FILE_ATTR_TAG_COMPRESSION 0x42435a4c
94#define CBFS_FILE_ATTR_TAG_HASH 0x68736148
95
96/*
97 * The common fields of extended cbfs file attributes. Attributes are expected
98 * to start with tag/len, then append their specific fields
99 */
100struct cbfs_file_attribute {
101 u32 tag;
102 /* len covers the whole structure, incl. tag and len */
103 u32 len;
104 u8 data[0];
105} __packed;
106
107struct cbfs_file_attr_compression {
108 u32 tag;
109 u32 len;
110 /* whole file compression format. 0 if no compression. */
111 u32 compression;
112 u32 decompressed_size;
113} __packed;
114
115struct cbfs_file_attr_hash {
116 u32 tag;
117 u32 len;
118 u32 hash_type;
119 /* hash_data is len - sizeof(struct) bytes */
120 u8 hash_data[];
Gabe Black84cd9322012-10-12 14:26:11 +0000121} __packed;
122
123struct cbfs_cachenode {
124 struct cbfs_cachenode *next;
Gabe Black84cd9322012-10-12 14:26:11 +0000125 void *data;
Gabe Black84cd9322012-10-12 14:26:11 +0000126 char *name;
Heinrich Schuchardt895ae872019-10-07 00:37:45 +0200127 u32 type;
128 u32 data_length;
Gabe Black84cd9322012-10-12 14:26:11 +0000129 u32 name_length;
Simon Glass72ca4852021-03-15 18:00:09 +1300130 u32 attr_offset;
Simon Glassa202f172021-03-15 18:00:16 +1300131 u32 comp_algo;
132 u32 decomp_size;
Heinrich Schuchardt895ae872019-10-07 00:37:45 +0200133};
Gabe Black84cd9322012-10-12 14:26:11 +0000134
Simon Glasse3ff7972012-11-05 12:16:25 +0000135/**
136 * file_cbfs_error() - Return a string describing the most recent error
137 * condition.
Gabe Black84cd9322012-10-12 14:26:11 +0000138 *
139 * @return A pointer to the constant string.
140 */
141const char *file_cbfs_error(void);
142
Simon Glasse3ff7972012-11-05 12:16:25 +0000143/**
Simon Glassc7f16932019-08-14 19:56:13 -0600144 * cbfs_get_result() - Get the result of the last CBFS operation
145 *
146 *@return last result
147 */
148enum cbfs_result cbfs_get_result(void);
149
150/**
Simon Glasse3ff7972012-11-05 12:16:25 +0000151 * file_cbfs_init() - Initialize the CBFS driver and load metadata into RAM.
Gabe Black84cd9322012-10-12 14:26:11 +0000152 *
Simon Glass0e7b6312020-05-24 17:38:21 -0600153 * @end_of_rom: Points to the end of the ROM the CBFS should be read from
154 * @return 0 if OK, -ve on error
Gabe Black84cd9322012-10-12 14:26:11 +0000155 */
Simon Glass0e7b6312020-05-24 17:38:21 -0600156int file_cbfs_init(ulong end_of_rom);
Gabe Black84cd9322012-10-12 14:26:11 +0000157
Simon Glasse3ff7972012-11-05 12:16:25 +0000158/**
159 * file_cbfs_get_header() - Get the header structure for the current CBFS.
Gabe Black84cd9322012-10-12 14:26:11 +0000160 *
161 * @return A pointer to the constant structure, or NULL if there is none.
162 */
163const struct cbfs_header *file_cbfs_get_header(void);
164
Simon Glasse3ff7972012-11-05 12:16:25 +0000165/**
Simon Glassc4f5b5d2021-03-15 18:00:13 +1300166 * cbfs_get_first() - Get the first file in a CBFS
167 *
168 * @return pointer to first file, or NULL if it is empty
169 */
170const struct cbfs_cachenode *cbfs_get_first(const struct cbfs_priv *priv);
171
172/**
173 * cbfs_get_next() - Get the next file in a CBFS
174 *
175 * @filep: Pointer to current file; updated to point to the next file, if any,
176 * else NULL
177 */
178void cbfs_get_next(const struct cbfs_cachenode **filep);
179
180/**
Simon Glasse3ff7972012-11-05 12:16:25 +0000181 * file_cbfs_get_first() - Get a handle for the first file in CBFS.
Gabe Black84cd9322012-10-12 14:26:11 +0000182 *
183 * @return A handle for the first file in CBFS, NULL on error.
184 */
185const struct cbfs_cachenode *file_cbfs_get_first(void);
186
Simon Glasse3ff7972012-11-05 12:16:25 +0000187/**
188 * file_cbfs_get_next() - Get a handle to the file after this one in CBFS.
Gabe Black84cd9322012-10-12 14:26:11 +0000189 *
Simon Glasse3ff7972012-11-05 12:16:25 +0000190 * @file: A pointer to the handle to advance.
Gabe Black84cd9322012-10-12 14:26:11 +0000191 */
192void file_cbfs_get_next(const struct cbfs_cachenode **file);
193
Simon Glasse3ff7972012-11-05 12:16:25 +0000194/**
195 * file_cbfs_find() - Find a file with a particular name in CBFS.
Gabe Black84cd9322012-10-12 14:26:11 +0000196 *
Simon Glasse3ff7972012-11-05 12:16:25 +0000197 * @name: The name to search for.
Gabe Black84cd9322012-10-12 14:26:11 +0000198 *
199 * @return A handle to the file, or NULL on error.
200 */
201const struct cbfs_cachenode *file_cbfs_find(const char *name);
202
Simon Glass630b2f32019-08-14 19:56:14 -0600203/**
204 * cbfs_find_file() - Find a file in a given CBFS
205 *
206 * @cbfs: CBFS to look in (use cbfs_init_mem() to set it up)
207 * @name: Filename to look for
208 * @return pointer to CBFS node if found, else NULL
209 */
210const struct cbfs_cachenode *cbfs_find_file(struct cbfs_priv *cbfs,
211 const char *name);
212
213/**
214 * cbfs_init_mem() - Set up a new CBFS
215 *
216 * @base: Base address of CBFS
Simon Glass5536f122021-03-15 18:00:12 +1300217 * @size: Size of CBFS if known, else CBFS_SIZE_UNKNOWN
218 * @require_header: true to read a header at the start, false to not require one
Simon Glass630b2f32019-08-14 19:56:14 -0600219 * @cbfsp: Returns a pointer to CBFS on success
220 * @return 0 if OK, -ve on error
221 */
Simon Glass5536f122021-03-15 18:00:12 +1300222int cbfs_init_mem(ulong base, ulong size, bool require_hdr,
223 struct cbfs_priv **privp);
Gabe Black84cd9322012-10-12 14:26:11 +0000224
225/***************************************************************************/
226/* All of the functions below can be used without first initializing CBFS. */
227/***************************************************************************/
228
Simon Glasse3ff7972012-11-05 12:16:25 +0000229/**
Simon Glass924e3462020-05-24 17:38:22 -0600230 * file_cbfs_find_uncached() - Find a file in CBFS given the end of the ROM
Gabe Black84cd9322012-10-12 14:26:11 +0000231 *
Simon Glass924e3462020-05-24 17:38:22 -0600232 * Note that @node should be declared by the caller. This design is to avoid
233 * the need for allocation here.
Gabe Black84cd9322012-10-12 14:26:11 +0000234 *
Simon Glass924e3462020-05-24 17:38:22 -0600235 * @end_of_rom: Points to the end of the ROM the CBFS should be read from
236 * @name: The name to search for
237 * @node: Returns the contents of the node if found (i.e. copied into *node)
238 * @return 0 on success, -ENOENT if not found, -EFAULT on bad header
Gabe Black84cd9322012-10-12 14:26:11 +0000239 */
Simon Glass924e3462020-05-24 17:38:22 -0600240int file_cbfs_find_uncached(ulong end_of_rom, const char *name,
241 struct cbfs_cachenode *node);
Gabe Black84cd9322012-10-12 14:26:11 +0000242
Simon Glasse3ff7972012-11-05 12:16:25 +0000243/**
Simon Glass03d4c292020-05-24 17:38:23 -0600244 * file_cbfs_find_uncached_base() - Find a file in CBFS given the base address
245 *
246 * Note that @node should be declared by the caller. This design is to avoid
247 * the need for allocation here.
248 *
249 * @base: Points to the base of the CBFS
250 * @name: The name to search for
251 * @node: Returns the contents of the node if found (i.e. copied into *node)
252 * @return 0 on success, -ENOENT if not found, -EFAULT on bad header
253 */
254int file_cbfs_find_uncached_base(ulong base, const char *name,
255 struct cbfs_cachenode *node);
256
257/**
Simon Glasse3ff7972012-11-05 12:16:25 +0000258 * file_cbfs_name() - Get the name of a file in CBFS.
Gabe Black84cd9322012-10-12 14:26:11 +0000259 *
Simon Glasse3ff7972012-11-05 12:16:25 +0000260 * @file: The handle to the file.
Gabe Black84cd9322012-10-12 14:26:11 +0000261 *
262 * @return The name of the file, NULL on error.
263 */
264const char *file_cbfs_name(const struct cbfs_cachenode *file);
265
Simon Glasse3ff7972012-11-05 12:16:25 +0000266/**
267 * file_cbfs_size() - Get the size of a file in CBFS.
Gabe Black84cd9322012-10-12 14:26:11 +0000268 *
Simon Glasse3ff7972012-11-05 12:16:25 +0000269 * @file: The handle to the file.
Gabe Black84cd9322012-10-12 14:26:11 +0000270 *
271 * @return The size of the file, zero on error.
272 */
273u32 file_cbfs_size(const struct cbfs_cachenode *file);
274
Simon Glasse3ff7972012-11-05 12:16:25 +0000275/**
276 * file_cbfs_type() - Get the type of a file in CBFS.
Gabe Black84cd9322012-10-12 14:26:11 +0000277 *
Simon Glasse3ff7972012-11-05 12:16:25 +0000278 * @file: The handle to the file.
Gabe Black84cd9322012-10-12 14:26:11 +0000279 *
280 * @return The type of the file, zero on error.
281 */
282u32 file_cbfs_type(const struct cbfs_cachenode *file);
283
Simon Glasse3ff7972012-11-05 12:16:25 +0000284/**
285 * file_cbfs_read() - Read a file from CBFS into RAM
Gabe Black84cd9322012-10-12 14:26:11 +0000286 *
Simon Glasse3ff7972012-11-05 12:16:25 +0000287 * @file: A handle to the file to read.
288 * @buffer: Where to read it into memory.
289 * @maxsize: Maximum number of bytes to read
Gabe Black84cd9322012-10-12 14:26:11 +0000290 *
291 * @return If positive or zero, the number of characters read. If negative, an
Simon Glasse3ff7972012-11-05 12:16:25 +0000292 * error occurred.
Gabe Black84cd9322012-10-12 14:26:11 +0000293 */
294long file_cbfs_read(const struct cbfs_cachenode *file, void *buffer,
295 unsigned long maxsize);
296
297#endif /* __CBFS_H */