1 #ifndef COREBOOT_TABLES_H
2 #define COREBOOT_TABLES_H
6 /* The coreboot table information is for conveying information
7 * from the firmware to the loaded OS image. Primarily this
8 * is expected to be information that cannot be discovered by
9 * other means, such as quering the hardware directly.
11 * All of the information should be Position Independent Data.
12 * That is it should be safe to relocated any of the information
13 * without it's meaning/correctnes changing. For table that
14 * can reasonably be used on multiple architectures the data
15 * size should be fixed. This should ease the transition between
16 * 32 bit and 64 bit architectures etc.
18 * The completeness test for the information in this table is:
19 * - Can all of the hardware be detected?
20 * - Are the per motherboard constants available?
21 * - Is there enough to allow a kernel to run that was written before
22 * a particular motherboard is constructed? (Assuming the kernel
23 * has drivers for all of the hardware but it does not have
24 * assumptions on how the hardware is connected together).
26 * With this test it should be straight forward to determine if a
27 * table entry is required or not. This should remove much of the
28 * long term compatibility burden as table entries which are
29 * irrelevant or have been replaced by better alternatives may be
30 * dropped. Of course it is polite and expidite to include extra
31 * table entries and be backwards compatible, but it is not required.
34 /* Since coreboot is usually compiled 32bit, gcc will align 64bit
35 * types to 32bit boundaries. If the coreboot table is dumped on a
36 * 64bit system, a uint64_t would be aligned to 64bit boundaries,
37 * breaking the table format.
39 * lb_uint64 will keep 64bit coreboot table values aligned to 32bit
40 * to ensure compatibility. They can be accessed with the two functions
41 * below: unpack_lb64() and pack_lb64()
43 * See also: util/lbtdump/lbtdump.c
51 static inline uint64_t unpack_lb64(struct lb_uint64 value)
55 result = (result << 32) + value.lo;
59 static inline struct lb_uint64 pack_lb64(uint64_t value)
61 struct lb_uint64 result;
62 result.lo = (value >> 0) & 0xffffffff;
63 result.hi = (value >> 32) & 0xffffffff;
69 uint8_t signature[4]; /* LBIO */
70 uint32_t header_bytes;
71 uint32_t header_checksum;
73 uint32_t table_checksum;
74 uint32_t table_entries;
77 /* Every entry in the boot environment list will correspond to a boot
78 * info record. Encoding both type and size. The type is obviously
79 * so you can tell what it is. The size allows you to skip that
80 * boot environment record if you don't know what it easy. This allows
81 * forward compatibility with records not yet defined.
84 uint32_t tag; /* tag ID */
85 uint32_t size; /* size of record (in bytes) */
88 #define LB_TAG_UNUSED 0x0000
90 #define LB_TAG_MEMORY 0x0001
92 struct lb_memory_range {
93 struct lb_uint64 start;
94 struct lb_uint64 size;
96 #define LB_MEM_RAM 1 /* Memory anyone can use */
97 #define LB_MEM_RESERVED 2 /* Don't use this memory region */
98 #define LB_MEM_ACPI 3 /* ACPI Tables */
99 #define LB_MEM_NVS 4 /* ACPI NVS Memory */
100 #define LB_MEM_UNUSABLE 5 /* Unusable address space */
101 #define LB_MEM_VENDOR_RSVD 6 /* Vendor Reserved */
102 #define LB_MEM_TABLE 16 /* Ram configuration tables are kept in */
108 struct lb_memory_range map[0];
111 #define LB_TAG_HWRPB 0x0002
118 #define LB_TAG_MAINBOARD 0x0003
119 struct lb_mainboard {
123 uint8_t part_number_idx;
127 #define LB_TAG_VERSION 0x0004
128 #define LB_TAG_EXTRA_VERSION 0x0005
129 #define LB_TAG_BUILD 0x0006
130 #define LB_TAG_COMPILE_TIME 0x0007
131 #define LB_TAG_COMPILE_BY 0x0008
132 #define LB_TAG_COMPILE_HOST 0x0009
133 #define LB_TAG_COMPILE_DOMAIN 0x000a
134 #define LB_TAG_COMPILER 0x000b
135 #define LB_TAG_LINKER 0x000c
136 #define LB_TAG_ASSEMBLER 0x000d
143 /* 0xe is taken by v3 */
145 #define LB_TAG_SERIAL 0x000f
149 #define LB_SERIAL_TYPE_IO_MAPPED 1
150 #define LB_SERIAL_TYPE_MEMORY_MAPPED 2
156 #define LB_TAG_CONSOLE 0x0010
163 #define LB_TAG_CONSOLE_SERIAL8250 0
164 #define LB_TAG_CONSOLE_VGA 1 // OBSOLETE
165 #define LB_TAG_CONSOLE_BTEXT 2 // OBSOLETE
166 #define LB_TAG_CONSOLE_LOGBUF 3
167 #define LB_TAG_CONSOLE_SROM 4 // OBSOLETE
168 #define LB_TAG_CONSOLE_EHCI 5
169 #define LB_TAG_CONSOLE_SERIAL8250MEM 6
171 #define LB_TAG_FORWARD 0x0011
178 #define LB_TAG_FRAMEBUFFER 0x0012
179 struct lb_framebuffer {
183 uint64_t physical_address;
184 uint32_t x_resolution;
185 uint32_t y_resolution;
186 uint32_t bytes_per_line;
187 uint8_t bits_per_pixel;
188 uint8_t red_mask_pos;
189 uint8_t red_mask_size;
190 uint8_t green_mask_pos;
191 uint8_t green_mask_size;
192 uint8_t blue_mask_pos;
193 uint8_t blue_mask_size;
194 uint8_t reserved_mask_pos;
195 uint8_t reserved_mask_size;
198 #define LB_TAG_TIMESTAMPS 0x0016
199 #define LB_TAG_CBMEM_CONSOLE 0x0017
200 #define LB_TAG_MRC_CACHE 0x0018
201 struct lb_cbmem_ref {
208 /* The following structures are for the cmos definitions table */
209 #define LB_TAG_CMOS_OPTION_TABLE 200
210 /* cmos header record */
211 struct cmos_option_table {
212 uint32_t tag; /* CMOS definitions table type */
213 uint32_t size; /* size of the entire table */
214 uint32_t header_length; /* length of header */
218 This record is variable length. The name field may be
219 shorter than CMOS_MAX_NAME_LENGTH. The entry may start
220 anywhere in the byte, but can not span bytes unless it
221 starts at the beginning of the byte and the length is
222 fills complete bytes.
224 #define LB_TAG_OPTION 201
225 struct cmos_entries {
226 uint32_t tag; /* entry type */
227 uint32_t size; /* length of this record */
228 uint32_t bit; /* starting bit from start of image */
229 uint32_t length; /* length of field in bits */
230 uint32_t config; /* e=enumeration, h=hex, r=reserved */
231 uint32_t config_id; /* a number linking to an enumeration record */
232 #define CMOS_MAX_NAME_LENGTH 32
233 uint8_t name[CMOS_MAX_NAME_LENGTH]; /* name of entry in ascii,
234 variable length int aligned */
238 /* cmos enumerations record
239 This record is variable length. The text field may be
240 shorter than CMOS_MAX_TEXT_LENGTH.
242 #define LB_TAG_OPTION_ENUM 202
244 uint32_t tag; /* enumeration type */
245 uint32_t size; /* length of this record */
246 uint32_t config_id; /* a number identifying the config id */
247 uint32_t value; /* the value associated with the text */
248 #define CMOS_MAX_TEXT_LENGTH 32
249 uint8_t text[CMOS_MAX_TEXT_LENGTH]; /* enum description in ascii,
250 variable length int aligned */
253 /* cmos defaults record
254 This record contains default settings for the cmos ram.
256 #define LB_TAG_OPTION_DEFAULTS 203
257 struct cmos_defaults {
258 uint32_t tag; /* default type */
259 uint32_t size; /* length of this record */
260 uint32_t name_length; /* length of the following name field */
261 uint8_t name[CMOS_MAX_NAME_LENGTH]; /* name identifying the default */
262 #define CMOS_IMAGE_BUFFER_SIZE 256
263 uint8_t default_set[CMOS_IMAGE_BUFFER_SIZE]; /* default settings */
266 #define LB_TAG_OPTION_CHECKSUM 204
267 struct cmos_checksum {
270 /* In practice everything is byte aligned, but things are measured
271 * in bits to be consistent.
273 uint32_t range_start; /* First bit that is checksummed (byte aligned) */
274 uint32_t range_end; /* Last bit that is checksummed (byte aligned) */
275 uint32_t location; /* First bit of the checksum (byte aligned) */
276 uint32_t type; /* Checksum algorithm that is used */
277 #define CHECKSUM_NONE 0
278 #define CHECKSUM_PCBIOS 1
281 #endif /* COREBOOT_TABLES_H */