Blame view
include/cbfs.h
4.15 KB
83d290c56 SPDX: Convert all... |
1 |
/* SPDX-License-Identifier: GPL-2.0+ */ |
84cd93272 fs: Add a Coreboo... |
2 3 |
/* * Copyright (c) 2011 The Chromium OS Authors. All rights reserved. |
84cd93272 fs: Add a Coreboo... |
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
*/ #ifndef __CBFS_H #define __CBFS_H #include <compiler.h> #include <linux/compiler.h> enum cbfs_result { CBFS_SUCCESS = 0, CBFS_NOT_INITIALIZED, CBFS_BAD_HEADER, CBFS_BAD_FILE, CBFS_FILE_NOT_FOUND }; enum cbfs_filetype { |
881bb9ab3 fs: cbfs: Add mis... |
21 22 |
CBFS_TYPE_BOOTBLOCK = 0x01, CBFS_TYPE_CBFSHEADER = 0x02, |
84cd93272 fs: Add a Coreboo... |
23 24 |
CBFS_TYPE_STAGE = 0x10, CBFS_TYPE_PAYLOAD = 0x20, |
881bb9ab3 fs: cbfs: Add mis... |
25 |
CBFS_TYPE_FIT = 0x21, |
84cd93272 fs: Add a Coreboo... |
26 27 28 29 30 31 |
CBFS_TYPE_OPTIONROM = 0x30, CBFS_TYPE_BOOTSPLASH = 0x40, CBFS_TYPE_RAW = 0x50, CBFS_TYPE_VSA = 0x51, CBFS_TYPE_MBI = 0x52, CBFS_TYPE_MICROCODE = 0x53, |
881bb9ab3 fs: cbfs: Add mis... |
32 33 34 35 36 |
CBFS_TYPE_FSP = 0x60, CBFS_TYPE_MRC = 0x61, CBFS_TYPE_MMA = 0x62, CBFS_TYPE_EFI = 0x63, CBFS_TYPE_STRUCT = 0x70, |
14fdf91eb fs: cbfs: Make al... |
37 |
CBFS_TYPE_CMOS_DEFAULT = 0xaa, |
881bb9ab3 fs: cbfs: Add mis... |
38 39 |
CBFS_TYPE_SPD = 0xab, CBFS_TYPE_MRC_CACHE = 0xac, |
14fdf91eb fs: cbfs: Make al... |
40 |
CBFS_TYPE_CMOS_LAYOUT = 0x01aa |
84cd93272 fs: Add a Coreboo... |
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
}; struct cbfs_header { u32 magic; u32 version; u32 rom_size; u32 boot_block_size; u32 align; u32 offset; u32 pad[2]; } __packed; struct cbfs_fileheader { u8 magic[8]; u32 len; u32 type; u32 checksum; u32 offset; } __packed; struct cbfs_cachenode { struct cbfs_cachenode *next; u32 type; void *data; u32 data_length; char *name; u32 name_length; u32 checksum; } __packed; extern enum cbfs_result file_cbfs_result; |
e3ff797cd cbfs: Add docbook... |
72 73 74 |
/** * file_cbfs_error() - Return a string describing the most recent error * condition. |
84cd93272 fs: Add a Coreboo... |
75 76 77 78 |
* * @return A pointer to the constant string. */ const char *file_cbfs_error(void); |
e3ff797cd cbfs: Add docbook... |
79 80 |
/** * file_cbfs_init() - Initialize the CBFS driver and load metadata into RAM. |
84cd93272 fs: Add a Coreboo... |
81 |
* |
e3ff797cd cbfs: Add docbook... |
82 |
* @end_of_rom: Points to the end of the ROM the CBFS should be read |
84cd93272 fs: Add a Coreboo... |
83 84 85 |
* from. */ void file_cbfs_init(uintptr_t end_of_rom); |
e3ff797cd cbfs: Add docbook... |
86 87 |
/** * file_cbfs_get_header() - Get the header structure for the current CBFS. |
84cd93272 fs: Add a Coreboo... |
88 89 90 91 |
* * @return A pointer to the constant structure, or NULL if there is none. */ const struct cbfs_header *file_cbfs_get_header(void); |
e3ff797cd cbfs: Add docbook... |
92 93 |
/** * file_cbfs_get_first() - Get a handle for the first file in CBFS. |
84cd93272 fs: Add a Coreboo... |
94 95 96 97 |
* * @return A handle for the first file in CBFS, NULL on error. */ const struct cbfs_cachenode *file_cbfs_get_first(void); |
e3ff797cd cbfs: Add docbook... |
98 99 |
/** * file_cbfs_get_next() - Get a handle to the file after this one in CBFS. |
84cd93272 fs: Add a Coreboo... |
100 |
* |
e3ff797cd cbfs: Add docbook... |
101 |
* @file: A pointer to the handle to advance. |
84cd93272 fs: Add a Coreboo... |
102 103 |
*/ void file_cbfs_get_next(const struct cbfs_cachenode **file); |
e3ff797cd cbfs: Add docbook... |
104 105 |
/** * file_cbfs_find() - Find a file with a particular name in CBFS. |
84cd93272 fs: Add a Coreboo... |
106 |
* |
e3ff797cd cbfs: Add docbook... |
107 |
* @name: The name to search for. |
84cd93272 fs: Add a Coreboo... |
108 109 110 111 112 113 114 115 116 |
* * @return A handle to the file, or NULL on error. */ const struct cbfs_cachenode *file_cbfs_find(const char *name); /***************************************************************************/ /* All of the functions below can be used without first initializing CBFS. */ /***************************************************************************/ |
e3ff797cd cbfs: Add docbook... |
117 118 119 |
/** * file_cbfs_find_uncached() - Find a file with a particular name in CBFS * without using the heap. |
84cd93272 fs: Add a Coreboo... |
120 |
* |
e3ff797cd cbfs: Add docbook... |
121 |
* @end_of_rom: Points to the end of the ROM the CBFS should be read |
84cd93272 fs: Add a Coreboo... |
122 |
* from. |
e3ff797cd cbfs: Add docbook... |
123 |
* @name: The name to search for. |
84cd93272 fs: Add a Coreboo... |
124 125 126 127 128 |
* * @return A handle to the file, or NULL on error. */ const struct cbfs_cachenode *file_cbfs_find_uncached(uintptr_t end_of_rom, const char *name); |
e3ff797cd cbfs: Add docbook... |
129 130 |
/** * file_cbfs_name() - Get the name of a file in CBFS. |
84cd93272 fs: Add a Coreboo... |
131 |
* |
e3ff797cd cbfs: Add docbook... |
132 |
* @file: The handle to the file. |
84cd93272 fs: Add a Coreboo... |
133 134 135 136 |
* * @return The name of the file, NULL on error. */ const char *file_cbfs_name(const struct cbfs_cachenode *file); |
e3ff797cd cbfs: Add docbook... |
137 138 |
/** * file_cbfs_size() - Get the size of a file in CBFS. |
84cd93272 fs: Add a Coreboo... |
139 |
* |
e3ff797cd cbfs: Add docbook... |
140 |
* @file: The handle to the file. |
84cd93272 fs: Add a Coreboo... |
141 142 143 144 |
* * @return The size of the file, zero on error. */ u32 file_cbfs_size(const struct cbfs_cachenode *file); |
e3ff797cd cbfs: Add docbook... |
145 146 |
/** * file_cbfs_type() - Get the type of a file in CBFS. |
84cd93272 fs: Add a Coreboo... |
147 |
* |
e3ff797cd cbfs: Add docbook... |
148 |
* @file: The handle to the file. |
84cd93272 fs: Add a Coreboo... |
149 150 151 152 |
* * @return The type of the file, zero on error. */ u32 file_cbfs_type(const struct cbfs_cachenode *file); |
e3ff797cd cbfs: Add docbook... |
153 154 |
/** * file_cbfs_read() - Read a file from CBFS into RAM |
84cd93272 fs: Add a Coreboo... |
155 |
* |
e3ff797cd cbfs: Add docbook... |
156 157 158 |
* @file: A handle to the file to read. * @buffer: Where to read it into memory. * @maxsize: Maximum number of bytes to read |
84cd93272 fs: Add a Coreboo... |
159 160 |
* * @return If positive or zero, the number of characters read. If negative, an |
e3ff797cd cbfs: Add docbook... |
161 |
* error occurred. |
84cd93272 fs: Add a Coreboo... |
162 163 164 165 166 |
*/ long file_cbfs_read(const struct cbfs_cachenode *file, void *buffer, unsigned long maxsize); #endif /* __CBFS_H */ |