blob: 38efb1d2b02e724a4bfd38b1e1ce8c9d5c370fee [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,
Simon Glass9dc29742022-02-28 12:08:26 -070027 CBFS_TYPE_SELF = CBFS_TYPE_PAYLOAD,
28
Bin Meng881bb9a2018-12-22 01:55:51 -080029 CBFS_TYPE_FIT = 0x21,
Gabe Black84cd9322012-10-12 14:26:11 +000030 CBFS_TYPE_OPTIONROM = 0x30,
31 CBFS_TYPE_BOOTSPLASH = 0x40,
32 CBFS_TYPE_RAW = 0x50,
33 CBFS_TYPE_VSA = 0x51,
34 CBFS_TYPE_MBI = 0x52,
35 CBFS_TYPE_MICROCODE = 0x53,
Bin Meng881bb9a2018-12-22 01:55:51 -080036 CBFS_TYPE_FSP = 0x60,
37 CBFS_TYPE_MRC = 0x61,
38 CBFS_TYPE_MMA = 0x62,
39 CBFS_TYPE_EFI = 0x63,
40 CBFS_TYPE_STRUCT = 0x70,
Bin Meng14fdf912018-12-22 01:55:50 -080041 CBFS_TYPE_CMOS_DEFAULT = 0xaa,
Bin Meng881bb9a2018-12-22 01:55:51 -080042 CBFS_TYPE_SPD = 0xab,
43 CBFS_TYPE_MRC_CACHE = 0xac,
Bin Meng14fdf912018-12-22 01:55:50 -080044 CBFS_TYPE_CMOS_LAYOUT = 0x01aa
Gabe Black84cd9322012-10-12 14:26:11 +000045};
46
Simon Glass08b7bc32019-07-08 13:18:21 -060047enum {
48 CBFS_HEADER_MAGIC = 0x4f524243,
Simon Glass5536f122021-03-15 18:00:12 +130049 CBFS_SIZE_UNKNOWN = 0xffffffff,
50 CBFS_ALIGN_SIZE = 0x40,
Simon Glass08b7bc32019-07-08 13:18:21 -060051};
52
53/**
54 * struct cbfs_header - header at the start of a CBFS region
55 *
56 * All fields use big-endian format.
57 *
58 * @magic: Magic number (CBFS_HEADER_MAGIC)
59 */
Gabe Black84cd9322012-10-12 14:26:11 +000060struct cbfs_header {
61 u32 magic;
62 u32 version;
63 u32 rom_size;
64 u32 boot_block_size;
65 u32 align;
66 u32 offset;
67 u32 pad[2];
68} __packed;
69
70struct cbfs_fileheader {
71 u8 magic[8];
72 u32 len;
73 u32 type;
Simon Glassababe102019-07-08 13:18:22 -060074 /* offset to struct cbfs_file_attribute or 0 */
75 u32 attributes_offset;
Gabe Black84cd9322012-10-12 14:26:11 +000076 u32 offset;
Simon Glass72ca4852021-03-15 18:00:09 +130077 char filename[];
78} __packed;
79
Simon Glassa202f172021-03-15 18:00:16 +130080/**
81 * These are standard values for the known compression alogrithms that coreboot
82 * knows about for stages and payloads. Of course, other CBFS users can use
83 * whatever values they want, as long as they understand them.
84 */
85#define CBFS_COMPRESS_NONE 0
86#define CBFS_COMPRESS_LZMA 1
87#define CBFS_COMPRESS_LZ4 2
88
Simon Glass72ca4852021-03-15 18:00:09 +130089/*
90 * Depending on how the header was initialized, it may be backed with 0x00 or
91 * 0xff, so support both
92 */
93#define CBFS_FILE_ATTR_TAG_UNUSED 0
94#define CBFS_FILE_ATTR_TAG_UNUSED2 0xffffffff
95#define CBFS_FILE_ATTR_TAG_COMPRESSION 0x42435a4c
96#define CBFS_FILE_ATTR_TAG_HASH 0x68736148
97
98/*
99 * The common fields of extended cbfs file attributes. Attributes are expected
100 * to start with tag/len, then append their specific fields
101 */
102struct cbfs_file_attribute {
103 u32 tag;
104 /* len covers the whole structure, incl. tag and len */
105 u32 len;
106 u8 data[0];
107} __packed;
108
109struct cbfs_file_attr_compression {
110 u32 tag;
111 u32 len;
112 /* whole file compression format. 0 if no compression. */
113 u32 compression;
114 u32 decompressed_size;
115} __packed;
116
117struct cbfs_file_attr_hash {
118 u32 tag;
119 u32 len;
120 u32 hash_type;
121 /* hash_data is len - sizeof(struct) bytes */
122 u8 hash_data[];
Gabe Black84cd9322012-10-12 14:26:11 +0000123} __packed;
124
Simon Glass9dc29742022-02-28 12:08:26 -0700125/*** Component sub-headers ***/
126
127/* Following are component sub-headers for the "standard" component types */
128
129/**
130 * struct cbfs_stage - sub-header for stage components
131 *
132 * Stages are loaded by coreboot during the normal boot process
133 */
134struct cbfs_stage {
135 u32 compression; /** Compression type */
136 u64 entry; /** entry point */
137 u64 load; /** Where to load in memory */
138 u32 len; /** length of data to load */
139 u32 memlen; /** total length of object in memory */
140} __packed;
141
142/**
143 * struct cbfs_payload_segment - sub-header for payload components
144 *
145 * Payloads are loaded by coreboot at the end of the boot process
146 */
147struct cbfs_payload_segment {
148 u32 type;
149 u32 compression;
150 u32 offset;
151 u64 load_addr;
152 u32 len;
153 u32 mem_len;
154} __packed;
155
156struct cbfs_payload {
157 struct cbfs_payload_segment segments;
158};
159
160#define PAYLOAD_SEGMENT_CODE 0x45444F43
161#define PAYLOAD_SEGMENT_DATA 0x41544144
162#define PAYLOAD_SEGMENT_BSS 0x20535342
163#define PAYLOAD_SEGMENT_PARAMS 0x41524150
164#define PAYLOAD_SEGMENT_ENTRY 0x52544E45
165
Gabe Black84cd9322012-10-12 14:26:11 +0000166struct cbfs_cachenode {
167 struct cbfs_cachenode *next;
Gabe Black84cd9322012-10-12 14:26:11 +0000168 void *data;
Gabe Black84cd9322012-10-12 14:26:11 +0000169 char *name;
Heinrich Schuchardt895ae872019-10-07 00:37:45 +0200170 u32 type;
171 u32 data_length;
Gabe Black84cd9322012-10-12 14:26:11 +0000172 u32 name_length;
Simon Glass72ca4852021-03-15 18:00:09 +1300173 u32 attr_offset;
Simon Glassa202f172021-03-15 18:00:16 +1300174 u32 comp_algo;
175 u32 decomp_size;
Heinrich Schuchardt895ae872019-10-07 00:37:45 +0200176};
Gabe Black84cd9322012-10-12 14:26:11 +0000177
Simon Glasse3ff7972012-11-05 12:16:25 +0000178/**
179 * file_cbfs_error() - Return a string describing the most recent error
180 * condition.
Gabe Black84cd9322012-10-12 14:26:11 +0000181 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100182 * Return: A pointer to the constant string.
Gabe Black84cd9322012-10-12 14:26:11 +0000183 */
184const char *file_cbfs_error(void);
185
Simon Glasse3ff7972012-11-05 12:16:25 +0000186/**
Simon Glassc7f16932019-08-14 19:56:13 -0600187 * cbfs_get_result() - Get the result of the last CBFS operation
188 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100189 *Return: last result
Simon Glassc7f16932019-08-14 19:56:13 -0600190 */
191enum cbfs_result cbfs_get_result(void);
192
193/**
Simon Glasse3ff7972012-11-05 12:16:25 +0000194 * file_cbfs_init() - Initialize the CBFS driver and load metadata into RAM.
Gabe Black84cd9322012-10-12 14:26:11 +0000195 *
Simon Glass0e7b6312020-05-24 17:38:21 -0600196 * @end_of_rom: Points to the end of the ROM the CBFS should be read from
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100197 * Return: 0 if OK, -ve on error
Gabe Black84cd9322012-10-12 14:26:11 +0000198 */
Simon Glass0e7b6312020-05-24 17:38:21 -0600199int file_cbfs_init(ulong end_of_rom);
Gabe Black84cd9322012-10-12 14:26:11 +0000200
Simon Glasse3ff7972012-11-05 12:16:25 +0000201/**
202 * file_cbfs_get_header() - Get the header structure for the current CBFS.
Gabe Black84cd9322012-10-12 14:26:11 +0000203 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100204 * Return: A pointer to the constant structure, or NULL if there is none.
Gabe Black84cd9322012-10-12 14:26:11 +0000205 */
206const struct cbfs_header *file_cbfs_get_header(void);
207
Simon Glasse3ff7972012-11-05 12:16:25 +0000208/**
Simon Glassc4f5b5d2021-03-15 18:00:13 +1300209 * cbfs_get_first() - Get the first file in a CBFS
210 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100211 * Return: pointer to first file, or NULL if it is empty
Simon Glassc4f5b5d2021-03-15 18:00:13 +1300212 */
213const struct cbfs_cachenode *cbfs_get_first(const struct cbfs_priv *priv);
214
215/**
216 * cbfs_get_next() - Get the next file in a CBFS
217 *
218 * @filep: Pointer to current file; updated to point to the next file, if any,
219 * else NULL
220 */
221void cbfs_get_next(const struct cbfs_cachenode **filep);
222
223/**
Simon Glasse3ff7972012-11-05 12:16:25 +0000224 * file_cbfs_get_first() - Get a handle for the first file in CBFS.
Gabe Black84cd9322012-10-12 14:26:11 +0000225 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100226 * Return: A handle for the first file in CBFS, NULL on error.
Gabe Black84cd9322012-10-12 14:26:11 +0000227 */
228const struct cbfs_cachenode *file_cbfs_get_first(void);
229
Simon Glasse3ff7972012-11-05 12:16:25 +0000230/**
231 * file_cbfs_get_next() - Get a handle to the file after this one in CBFS.
Gabe Black84cd9322012-10-12 14:26:11 +0000232 *
Simon Glasse3ff7972012-11-05 12:16:25 +0000233 * @file: A pointer to the handle to advance.
Gabe Black84cd9322012-10-12 14:26:11 +0000234 */
235void file_cbfs_get_next(const struct cbfs_cachenode **file);
236
Simon Glasse3ff7972012-11-05 12:16:25 +0000237/**
238 * file_cbfs_find() - Find a file with a particular name in CBFS.
Gabe Black84cd9322012-10-12 14:26:11 +0000239 *
Simon Glasse3ff7972012-11-05 12:16:25 +0000240 * @name: The name to search for.
Gabe Black84cd9322012-10-12 14:26:11 +0000241 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100242 * Return: A handle to the file, or NULL on error.
Gabe Black84cd9322012-10-12 14:26:11 +0000243 */
244const struct cbfs_cachenode *file_cbfs_find(const char *name);
245
Simon Glass630b2f32019-08-14 19:56:14 -0600246/**
247 * cbfs_find_file() - Find a file in a given CBFS
248 *
249 * @cbfs: CBFS to look in (use cbfs_init_mem() to set it up)
250 * @name: Filename to look for
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100251 * Return: pointer to CBFS node if found, else NULL
Simon Glass630b2f32019-08-14 19:56:14 -0600252 */
253const struct cbfs_cachenode *cbfs_find_file(struct cbfs_priv *cbfs,
254 const char *name);
255
256/**
257 * cbfs_init_mem() - Set up a new CBFS
258 *
259 * @base: Base address of CBFS
Simon Glass5536f122021-03-15 18:00:12 +1300260 * @size: Size of CBFS if known, else CBFS_SIZE_UNKNOWN
261 * @require_header: true to read a header at the start, false to not require one
Simon Glass630b2f32019-08-14 19:56:14 -0600262 * @cbfsp: Returns a pointer to CBFS on success
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100263 * Return: 0 if OK, -ve on error
Simon Glass630b2f32019-08-14 19:56:14 -0600264 */
Simon Glass5536f122021-03-15 18:00:12 +1300265int cbfs_init_mem(ulong base, ulong size, bool require_hdr,
266 struct cbfs_priv **privp);
Gabe Black84cd9322012-10-12 14:26:11 +0000267
268/***************************************************************************/
269/* All of the functions below can be used without first initializing CBFS. */
270/***************************************************************************/
271
Simon Glasse3ff7972012-11-05 12:16:25 +0000272/**
Simon Glass924e3462020-05-24 17:38:22 -0600273 * file_cbfs_find_uncached() - Find a file in CBFS given the end of the ROM
Gabe Black84cd9322012-10-12 14:26:11 +0000274 *
Simon Glass924e3462020-05-24 17:38:22 -0600275 * Note that @node should be declared by the caller. This design is to avoid
276 * the need for allocation here.
Gabe Black84cd9322012-10-12 14:26:11 +0000277 *
Simon Glass924e3462020-05-24 17:38:22 -0600278 * @end_of_rom: Points to the end of the ROM the CBFS should be read from
279 * @name: The name to search for
280 * @node: Returns the contents of the node if found (i.e. copied into *node)
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100281 * Return: 0 on success, -ENOENT if not found, -EFAULT on bad header
Gabe Black84cd9322012-10-12 14:26:11 +0000282 */
Simon Glass924e3462020-05-24 17:38:22 -0600283int file_cbfs_find_uncached(ulong end_of_rom, const char *name,
284 struct cbfs_cachenode *node);
Gabe Black84cd9322012-10-12 14:26:11 +0000285
Simon Glasse3ff7972012-11-05 12:16:25 +0000286/**
Simon Glass03d4c292020-05-24 17:38:23 -0600287 * file_cbfs_find_uncached_base() - Find a file in CBFS given the base address
288 *
289 * Note that @node should be declared by the caller. This design is to avoid
290 * the need for allocation here.
291 *
292 * @base: Points to the base of the CBFS
293 * @name: The name to search for
294 * @node: Returns the contents of the node if found (i.e. copied into *node)
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100295 * Return: 0 on success, -ENOENT if not found, -EFAULT on bad header
Simon Glass03d4c292020-05-24 17:38:23 -0600296 */
297int file_cbfs_find_uncached_base(ulong base, const char *name,
298 struct cbfs_cachenode *node);
299
300/**
Simon Glasse3ff7972012-11-05 12:16:25 +0000301 * file_cbfs_name() - Get the name of a file in CBFS.
Gabe Black84cd9322012-10-12 14:26:11 +0000302 *
Simon Glasse3ff7972012-11-05 12:16:25 +0000303 * @file: The handle to the file.
Gabe Black84cd9322012-10-12 14:26:11 +0000304 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100305 * Return: The name of the file, NULL on error.
Gabe Black84cd9322012-10-12 14:26:11 +0000306 */
307const char *file_cbfs_name(const struct cbfs_cachenode *file);
308
Simon Glasse3ff7972012-11-05 12:16:25 +0000309/**
310 * file_cbfs_size() - Get the size of a file in CBFS.
Gabe Black84cd9322012-10-12 14:26:11 +0000311 *
Simon Glasse3ff7972012-11-05 12:16:25 +0000312 * @file: The handle to the file.
Gabe Black84cd9322012-10-12 14:26:11 +0000313 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100314 * Return: The size of the file, zero on error.
Gabe Black84cd9322012-10-12 14:26:11 +0000315 */
316u32 file_cbfs_size(const struct cbfs_cachenode *file);
317
Simon Glasse3ff7972012-11-05 12:16:25 +0000318/**
319 * file_cbfs_type() - Get the type of a file in CBFS.
Gabe Black84cd9322012-10-12 14:26:11 +0000320 *
Simon Glasse3ff7972012-11-05 12:16:25 +0000321 * @file: The handle to the file.
Gabe Black84cd9322012-10-12 14:26:11 +0000322 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100323 * Return: The type of the file, zero on error.
Gabe Black84cd9322012-10-12 14:26:11 +0000324 */
325u32 file_cbfs_type(const struct cbfs_cachenode *file);
326
Simon Glasse3ff7972012-11-05 12:16:25 +0000327/**
328 * file_cbfs_read() - Read a file from CBFS into RAM
Gabe Black84cd9322012-10-12 14:26:11 +0000329 *
Simon Glasse3ff7972012-11-05 12:16:25 +0000330 * @file: A handle to the file to read.
331 * @buffer: Where to read it into memory.
332 * @maxsize: Maximum number of bytes to read
Gabe Black84cd9322012-10-12 14:26:11 +0000333 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100334 * Return: If positive or zero, the number of characters read. If negative, an
Simon Glasse3ff7972012-11-05 12:16:25 +0000335 * error occurred.
Gabe Black84cd9322012-10-12 14:26:11 +0000336 */
337long file_cbfs_read(const struct cbfs_cachenode *file, void *buffer,
338 unsigned long maxsize);
339
340#endif /* __CBFS_H */