Fixes bug in cpu_relax_vc()
[akaros.git] / kern / include / coreboot_tables.h
1 /*
2  * This file is part of the libpayload project.
3  *
4  * Copyright (C) 2008 Advanced Micro Devices, Inc.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. The name of the author may not be used to endorse or promote products
15  *    derived from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29
30 #ifndef _COREBOOT_TABLES_H
31 #define _COREBOOT_TABLES_H
32
33 #include <arch/types.h>
34
35 /* Maximum number of memory range definitions. */
36 #define SYSINFO_MAX_MEM_RANGES 32
37 /* Allow a maximum of 8 GPIOs */
38 #define SYSINFO_MAX_GPIOS 8
39
40 struct cb_serial;
41
42 struct sysinfo_t {
43         unsigned int cpu_khz;
44         struct cb_serial *serial;
45         unsigned short ser_ioport;
46         unsigned long ser_base; // for mmapped serial
47
48         int n_memranges;
49
50         struct memrange {
51                 unsigned long long base;
52                 unsigned long long size;
53                 unsigned int type;
54         } memrange[SYSINFO_MAX_MEM_RANGES];
55
56         struct cb_cmos_option_table *option_table;
57         uint32_t cmos_range_start;
58         uint32_t cmos_range_end;
59         uint32_t cmos_checksum_location;
60 #ifdef CONFIG_CHROMEOS
61         uint32_t vbnv_start;
62         uint32_t vbnv_size;
63 #endif
64
65         char *version;
66         char *extra_version;
67         char *build;
68         char *compile_time;
69         char *compile_by;
70         char *compile_host;
71         char *compile_domain;
72         char *compiler;
73         char *linker;
74         char *assembler;
75
76         char *cb_version;
77
78         struct cb_framebuffer *framebuffer;
79
80 #ifdef CONFIG_CHROMEOS
81         int num_gpios;
82         struct cb_gpio gpios[SYSINFO_MAX_GPIOS];
83 #endif
84
85         unsigned long *mbtable; /** Pointer to the multiboot table */
86
87         struct cb_header *header;
88         struct cb_mainboard *mainboard;
89
90         /* these are chromeos specific and may or may not be valid. */
91         void    *vboot_handoff;
92         uint32_t        vboot_handoff_size;
93         void    *vdat_addr;
94         uint32_t        vdat_size;
95
96 #ifdef CONFIG_X86
97         int x86_rom_var_mtrr_index;
98 #endif
99
100         void    *tstamp_table;
101         void    *cbmem_cons;
102         void    *mrc_cache;
103         void    *acpi_gnvs;
104 };
105
106 extern struct sysinfo_t lib_sysinfo;
107
108 struct cbuint64 {
109         uint32_t lo;
110         uint32_t hi;
111 };
112
113 struct cb_header {
114         uint8_t signature[4];
115         uint32_t header_bytes;
116         uint32_t header_checksum;
117         uint32_t table_bytes;
118         uint32_t table_checksum;
119         uint32_t table_entries;
120 };
121
122 struct cb_record {
123         uint32_t tag;
124         uint32_t size;
125 };
126
127 #define CB_TAG_UNUSED     0x0000
128 #define CB_TAG_MEMORY     0x0001
129
130 struct cb_memory_range {
131         struct cbuint64 start;
132         struct cbuint64 size;
133         uint32_t type;
134 };
135
136 #define CB_MEM_RAM          1
137 #define CB_MEM_RESERVED     2
138 #define CB_MEM_ACPI         3
139 #define CB_MEM_NVS          4
140 #define CB_MEM_UNUSABLE     5
141 #define CB_MEM_VENDOR_RSVD  6
142 #define CB_MEM_TABLE       16
143
144 struct cb_memory {
145         uint32_t tag;
146         uint32_t size;
147         struct cb_memory_range map[0];
148 };
149
150 #define CB_TAG_HWRPB      0x0002
151
152 struct cb_hwrpb {
153         uint32_t tag;
154         uint32_t size;
155         uint64_t hwrpb;
156 };
157
158 #define CB_TAG_MAINBOARD  0x0003
159
160 struct cb_mainboard {
161         uint32_t tag;
162         uint32_t size;
163         uint8_t vendor_idx;
164         uint8_t part_number_idx;
165         uint8_t strings[0];
166 };
167
168 #define CB_TAG_VERSION        0x0004
169 #define CB_TAG_EXTRA_VERSION  0x0005
170 #define CB_TAG_BUILD          0x0006
171 #define CB_TAG_COMPILE_TIME   0x0007
172 #define CB_TAG_COMPILE_BY     0x0008
173 #define CB_TAG_COMPILE_HOST   0x0009
174 #define CB_TAG_COMPILE_DOMAIN 0x000a
175 #define CB_TAG_COMPILER       0x000b
176 #define CB_TAG_LINKER         0x000c
177 #define CB_TAG_ASSEMBLER      0x000d
178
179 struct cb_string {
180         uint32_t tag;
181         uint32_t size;
182         uint8_t string[0];
183 };
184
185 #define CB_TAG_SERIAL         0x000f
186
187 struct cb_serial {
188         uint32_t tag;
189         uint32_t size;
190 #define CB_SERIAL_TYPE_IO_MAPPED     1
191 #define CB_SERIAL_TYPE_MEMORY_MAPPED 2
192         uint32_t type;
193         uint32_t baseaddr;
194         uint32_t baud;
195 };
196
197 #define CB_TAG_CONSOLE       0x00010
198
199 struct cb_console {
200         uint32_t tag;
201         uint32_t size;
202         uint16_t type;
203 };
204
205 #define CB_TAG_CONSOLE_SERIAL8250 0
206 #define CB_TAG_CONSOLE_VGA        1 // OBSOLETE
207 #define CB_TAG_CONSOLE_BTEXT      2 // OBSOLETE
208 #define CB_TAG_CONSOLE_LOGBUF     3 // OBSOLETE
209 #define CB_TAG_CONSOLE_SROM       4 // OBSOLETE
210 #define CB_TAG_CONSOLE_EHCI       5
211
212 #define CB_TAG_FORWARD       0x00011
213
214 struct cb_forward {
215         uint32_t tag;
216         uint32_t size;
217         uint64_t forward;
218 };
219
220 #define CB_TAG_FRAMEBUFFER      0x0012
221 struct cb_framebuffer {
222         uint32_t tag;
223         uint32_t size;
224
225         uint64_t physical_address;
226         uint32_t x_resolution;
227         uint32_t y_resolution;
228         uint32_t bytes_per_line;
229         uint8_t bits_per_pixel;
230         uint8_t red_mask_pos;
231         uint8_t red_mask_size;
232         uint8_t green_mask_pos;
233         uint8_t green_mask_size;
234         uint8_t blue_mask_pos;
235         uint8_t blue_mask_size;
236         uint8_t reserved_mask_pos;
237         uint8_t reserved_mask_size;
238 };
239
240 #define CB_TAG_GPIO 0x0013
241 #define CB_GPIO_ACTIVE_LOW 0
242 #define CB_GPIO_ACTIVE_HIGH 1
243 #define CB_GPIO_MAX_NAME_LENGTH 16
244 struct cb_gpio {
245         uint32_t port;
246         uint32_t polarity;
247         uint32_t value;
248         uint8_t name[CB_GPIO_MAX_NAME_LENGTH];
249 };
250
251 struct cb_gpios {
252         uint32_t tag;
253         uint32_t size;
254
255         uint32_t count;
256         struct cb_gpio gpios[0];
257 };
258
259 #define CB_TAG_VDAT             0x0015
260 #define CB_TAG_VBNV             0x0019
261 #define CB_TAG_VBOOT_HANDOFF    0x0020
262 #define CB_TAG_DMA              0x0022
263 struct cb_range {
264         uint32_t tag;
265         uint32_t size;
266         uint64_t range_start;
267         uint32_t range_size;
268 };
269
270 #define CB_TAG_TIMESTAMPS       0x0016
271 #define CB_TAG_CBMEM_CONSOLE    0x0017
272 #define CB_TAG_MRC_CACHE        0x0018
273 #define CB_TAG_ACPI_GNVS        0x0024
274 struct cb_cbmem_tab {
275         uint32_t tag;
276         uint32_t size;
277         uint64_t cbmem_tab;
278 };
279
280 #define CB_TAG_X86_ROM_MTRR     0x0021
281 struct cb_x86_rom_mtrr {
282         uint32_t tag;
283         uint32_t size;
284         /* The variable range MTRR index covering the ROM. If one wants to
285          * enable caching the ROM, the variable MTRR needs to be set to
286          * write-protect. To disable the caching after enabling set the
287          * type to uncacheable. */
288         uint32_t index;
289 };
290
291
292 #define CB_TAG_CMOS_OPTION_TABLE 0x00c8
293 struct cb_cmos_option_table {
294         uint32_t tag;
295         uint32_t size;
296         uint32_t header_length;
297 };
298
299 #define CB_TAG_OPTION         0x00c9
300 #define CB_CMOS_MAX_NAME_LENGTH    32
301 struct cb_cmos_entries {
302         uint32_t tag;
303         uint32_t size;
304         uint32_t bit;
305         uint32_t length;
306         uint32_t config;
307         uint32_t config_id;
308         uint8_t name[CB_CMOS_MAX_NAME_LENGTH];
309 };
310
311
312 #define CB_TAG_OPTION_ENUM    0x00ca
313 #define CB_CMOS_MAX_TEXT_LENGTH 32
314 struct cb_cmos_enums {
315         uint32_t tag;
316         uint32_t size;
317         uint32_t config_id;
318         uint32_t value;
319         uint8_t text[CB_CMOS_MAX_TEXT_LENGTH];
320 };
321
322 #define CB_TAG_OPTION_DEFAULTS 0x00cb
323 #define CB_CMOS_IMAGE_BUFFER_SIZE 128
324 struct cb_cmos_defaults {
325         uint32_t tag;
326         uint32_t size;
327         uint32_t name_length;
328         uint8_t name[CB_CMOS_MAX_NAME_LENGTH];
329         uint8_t default_set[CB_CMOS_IMAGE_BUFFER_SIZE];
330 };
331
332 #define CB_TAG_OPTION_CHECKSUM 0x00cc
333 #define CB_CHECKSUM_NONE        0
334 #define CB_CHECKSUM_PCBIOS      1
335 struct  cb_cmos_checksum {
336         uint32_t tag;
337         uint32_t size;
338         uint32_t range_start;
339         uint32_t range_end;
340         uint32_t location;
341         uint32_t type;
342 };
343
344 /* Helpful inlines */
345
346 static inline uint64_t cb_unpack64(struct cbuint64 val)
347 {
348         return (((uint64_t) val.hi) << 32) | val.lo;
349 }
350
351 static inline uint16_t cb_checksum(const void *ptr, unsigned len)
352 {
353         return ipchecksum((uint8_t *)ptr, len);
354 }
355
356 static inline const char *cb_mb_vendor_string(const struct cb_mainboard *cbm)
357 {
358         return (char *)(cbm->strings + cbm->vendor_idx);
359 }
360
361 static inline const char *cb_mb_part_string(const struct cb_mainboard *cbm)
362 {
363         return (char *)(cbm->strings + cbm->part_number_idx);
364 }
365
366 /* Helpful macros */
367
368 #define MEM_RANGE_COUNT(_rec) \
369         (((_rec)->size - sizeof(*(_rec))) / sizeof((_rec)->map[0]))
370
371 #define MEM_RANGE_PTR(_rec, _idx) \
372         (void *)(((uint8_t *) (_rec)) + sizeof(*(_rec)) \
373                 + (sizeof((_rec)->map[0]) * (_idx)))
374
375 int get_coreboot_info(struct sysinfo_t *info);
376 #endif