blob: 2eaff08765e0987312dd7f4f72055c6f769ef1ea [file] [log] [blame]
Stefan Reinauere3f3e2e2008-01-18 15:33:10 +00001#ifndef COREBOOT_TABLES_H
2#define COREBOOT_TABLES_H
Uwe Hermannce1041c2007-02-06 19:53:51 +00003
4#include <stdint.h>
5
Stefan Reinauere3f3e2e2008-01-18 15:33:10 +00006/* The coreboot table information is for conveying information
Uwe Hermannce1041c2007-02-06 19:53:51 +00007 * 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.
10 *
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.
17 *
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).
25 *
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.
32 */
33
Stefan Reinauere3f3e2e2008-01-18 15:33:10 +000034/* Since coreboot is usually compiled 32bit, gcc will align 64bit
35 * types to 32bit boundaries. If the coreboot table is dumped on a
Uwe Hermannce1041c2007-02-06 19:53:51 +000036 * 64bit system, a uint64_t would be aligned to 64bit boundaries,
37 * breaking the table format.
38 *
Stefan Reinauere3f3e2e2008-01-18 15:33:10 +000039 * lb_uint64 will keep 64bit coreboot table values aligned to 32bit
Uwe Hermannce1041c2007-02-06 19:53:51 +000040 * to ensure compatibility. They can be accessed with the two functions
41 * below: unpack_lb64() and pack_lb64()
42 *
43 * See also: util/lbtdump/lbtdump.c
44 */
45
46struct lb_uint64 {
47 uint32_t lo;
48 uint32_t hi;
49};
50
51static inline uint64_t unpack_lb64(struct lb_uint64 value)
52{
Uwe Hermanna7e05482007-05-09 10:17:44 +000053 uint64_t result;
54 result = value.hi;
55 result = (result << 32) + value.lo;
56 return result;
Uwe Hermannce1041c2007-02-06 19:53:51 +000057}
58
59static inline struct lb_uint64 pack_lb64(uint64_t value)
60{
Uwe Hermanna7e05482007-05-09 10:17:44 +000061 struct lb_uint64 result;
62 result.lo = (value >> 0) & 0xffffffff;
63 result.hi = (value >> 32) & 0xffffffff;
64 return result;
Uwe Hermannce1041c2007-02-06 19:53:51 +000065}
66
Uwe Hermanna7e05482007-05-09 10:17:44 +000067struct lb_header {
68 uint8_t signature[4]; /* LBIO */
Uwe Hermannce1041c2007-02-06 19:53:51 +000069 uint32_t header_bytes;
70 uint32_t header_checksum;
71 uint32_t table_bytes;
72 uint32_t table_checksum;
73 uint32_t table_entries;
74};
75
76/* Every entry in the boot enviroment list will correspond to a boot
77 * info record. Encoding both type and size. The type is obviously
78 * so you can tell what it is. The size allows you to skip that
79 * boot enviroment record if you don't know what it easy. This allows
80 * forward compatibility with records not yet defined.
81 */
82struct lb_record {
83 uint32_t tag; /* tag ID */
84 uint32_t size; /* size of record (in bytes) */
85};
86
87#define LB_TAG_UNUSED 0x0000
88
89#define LB_TAG_MEMORY 0x0001
90
91struct lb_memory_range {
92 struct lb_uint64 start;
93 struct lb_uint64 size;
94 uint32_t type;
95#define LB_MEM_RAM 1 /* Memory anyone can use */
96#define LB_MEM_RESERVED 2 /* Don't use this memory region */
97#define LB_MEM_TABLE 16 /* Ram configuration tables are kept in */
98};
99
100struct lb_memory {
101 uint32_t tag;
102 uint32_t size;
103 struct lb_memory_range map[0];
104};
105
106#define LB_TAG_HWRPB 0x0002
107struct lb_hwrpb {
108 uint32_t tag;
109 uint32_t size;
110 uint64_t hwrpb;
111};
112
113#define LB_TAG_MAINBOARD 0x0003
114struct lb_mainboard {
115 uint32_t tag;
116 uint32_t size;
Uwe Hermanna7e05482007-05-09 10:17:44 +0000117 uint8_t vendor_idx;
118 uint8_t part_number_idx;
119 uint8_t strings[0];
Uwe Hermannce1041c2007-02-06 19:53:51 +0000120};
121
122#define LB_TAG_VERSION 0x0004
123#define LB_TAG_EXTRA_VERSION 0x0005
124#define LB_TAG_BUILD 0x0006
125#define LB_TAG_COMPILE_TIME 0x0007
126#define LB_TAG_COMPILE_BY 0x0008
127#define LB_TAG_COMPILE_HOST 0x0009
128#define LB_TAG_COMPILE_DOMAIN 0x000a
129#define LB_TAG_COMPILER 0x000b
130#define LB_TAG_LINKER 0x000c
131#define LB_TAG_ASSEMBLER 0x000d
132struct lb_string {
133 uint32_t tag;
134 uint32_t size;
Uwe Hermanna7e05482007-05-09 10:17:44 +0000135 uint8_t string[0];
Uwe Hermannce1041c2007-02-06 19:53:51 +0000136};
137
Stefan Reinauer2d853bb2009-03-17 14:39:25 +0000138#define LB_TAG_FORWARD 0x0011
139struct lb_forward {
140 uint32_t tag;
141 uint32_t size;
142 uint64_t forward;
143};
144
Uwe Hermannce1041c2007-02-06 19:53:51 +0000145/* The following structures are for the cmos definitions table */
146#define LB_TAG_CMOS_OPTION_TABLE 200
147/* cmos header record */
148struct cmos_option_table {
Uwe Hermanna7e05482007-05-09 10:17:44 +0000149 uint32_t tag; /* CMOS definitions table type */
150 uint32_t size; /* size of the entire table */
151 uint32_t header_length; /* length of header */
Uwe Hermannce1041c2007-02-06 19:53:51 +0000152};
153
154/* cmos entry record
155 This record is variable length. The name field may be
156 shorter than CMOS_MAX_NAME_LENGTH. The entry may start
157 anywhere in the byte, but can not span bytes unless it
158 starts at the beginning of the byte and the length is
159 fills complete bytes.
160*/
161#define LB_TAG_OPTION 201
162struct cmos_entries {
Uwe Hermanna7e05482007-05-09 10:17:44 +0000163 uint32_t tag; /* entry type */
164 uint32_t size; /* length of this record */
165 uint32_t bit; /* starting bit from start of image */
166 uint32_t length; /* length of field in bits */
167 uint32_t config; /* e=enumeration, h=hex, r=reserved */
168 uint32_t config_id; /* a number linking to an enumeration record */
Uwe Hermannce1041c2007-02-06 19:53:51 +0000169#define CMOS_MAX_NAME_LENGTH 32
Uwe Hermanna7e05482007-05-09 10:17:44 +0000170 uint8_t name[CMOS_MAX_NAME_LENGTH]; /* name of entry in ascii,
171 variable length int aligned */
Uwe Hermannce1041c2007-02-06 19:53:51 +0000172};
173
Uwe Hermannce1041c2007-02-06 19:53:51 +0000174/* cmos enumerations record
175 This record is variable length. The text field may be
176 shorter than CMOS_MAX_TEXT_LENGTH.
177*/
178#define LB_TAG_OPTION_ENUM 202
179struct cmos_enums {
Uwe Hermanna7e05482007-05-09 10:17:44 +0000180 uint32_t tag; /* enumeration type */
181 uint32_t size; /* length of this record */
182 uint32_t config_id; /* a number identifying the config id */
183 uint32_t value; /* the value associated with the text */
Uwe Hermannce1041c2007-02-06 19:53:51 +0000184#define CMOS_MAX_TEXT_LENGTH 32
Uwe Hermanna7e05482007-05-09 10:17:44 +0000185 uint8_t text[CMOS_MAX_TEXT_LENGTH]; /* enum description in ascii,
186 variable length int aligned */
Uwe Hermannce1041c2007-02-06 19:53:51 +0000187};
188
189/* cmos defaults record
190 This record contains default settings for the cmos ram.
191*/
192#define LB_TAG_OPTION_DEFAULTS 203
193struct cmos_defaults {
Uwe Hermanna7e05482007-05-09 10:17:44 +0000194 uint32_t tag; /* default type */
195 uint32_t size; /* length of this record */
196 uint32_t name_length; /* length of the following name field */
197 uint8_t name[CMOS_MAX_NAME_LENGTH]; /* name identifying the default */
Uwe Hermannce1041c2007-02-06 19:53:51 +0000198#define CMOS_IMAGE_BUFFER_SIZE 128
Uwe Hermanna7e05482007-05-09 10:17:44 +0000199 uint8_t default_set[CMOS_IMAGE_BUFFER_SIZE]; /* default settings */
Uwe Hermannce1041c2007-02-06 19:53:51 +0000200};
201
202#define LB_TAG_OPTION_CHECKSUM 204
Uwe Hermanna7e05482007-05-09 10:17:44 +0000203struct cmos_checksum {
Uwe Hermannce1041c2007-02-06 19:53:51 +0000204 uint32_t tag;
205 uint32_t size;
206 /* In practice everything is byte aligned, but things are measured
207 * in bits to be consistent.
208 */
209 uint32_t range_start; /* First bit that is checksummed (byte aligned) */
210 uint32_t range_end; /* Last bit that is checksummed (byte aligned) */
211 uint32_t location; /* First bit of the checksum (byte aligned) */
212 uint32_t type; /* Checksum algorithm that is used */
213#define CHECKSUM_NONE 0
214#define CHECKSUM_PCBIOS 1
215};
216
Stefan Reinauere3f3e2e2008-01-18 15:33:10 +0000217#endif /* COREBOOT_TABLES_H */