Export CONFIG_ options via #version/kconfig
[akaros.git] / kern / drivers / dev / coreboot.c
1 /*
2  * This file is part of the libpayload project.
3  *
4  * Copyright (C) 2008 Advanced Micro Devices, Inc.
5  * Copyright (C) 2009 coresystems GmbH
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. The name of the author may not be used to endorse or promote products
16  *    derived from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30
31 #include <vfs.h>
32 #include <kfs.h>
33 #include <slab.h>
34 #include <kmalloc.h>
35 #include <kref.h>
36 #include <string.h>
37 #include <stdio.h>
38 #include <assert.h>
39 #include <error.h>
40 #include <cpio.h>
41 #include <pmap.h>
42 #include <smp.h>
43 #include <ip.h>
44 #include <umem.h>
45 #include <coreboot_tables.h>
46
47 /*
48  * Some of this is x86 specific, and the rest of it is generic. Right now,
49  * since we only support x86, we'll avoid trying to make lots of infrastructure
50  * we don't need. If in the future, we want to use coreboot on some other
51  * architecture, then take out the generic parsing code and move it elsewhere.
52  */
53
54 /* === Parsing code === */
55 /* This is the generic parsing code. */
56
57 static void cb_parse_memory(void *ptr, struct sysinfo_t *info)
58 {
59         struct cb_memory *mem = ptr;
60         int count = MEM_RANGE_COUNT(mem);
61         int i;
62
63         if (count > SYSINFO_MAX_MEM_RANGES)
64                 count = SYSINFO_MAX_MEM_RANGES;
65
66         info->n_memranges = 0;
67
68         for (i = 0; i < count; i++) {
69                 struct cb_memory_range *range = MEM_RANGE_PTR(mem, i);
70
71 #ifdef CONFIG_LP_MEMMAP_RAM_ONLY
72                 if (range->type != CB_MEM_RAM)
73                         continue;
74 #endif
75
76                 info->memrange[info->n_memranges].base =
77                     cb_unpack64(range->start);
78
79                 info->memrange[info->n_memranges].size =
80                     cb_unpack64(range->size);
81
82                 info->memrange[info->n_memranges].type = range->type;
83
84                 info->n_memranges++;
85         }
86 }
87
88 static void cb_parse_serial(void *ptr, struct sysinfo_t *info)
89 {
90         info->serial = ((struct cb_serial *)ptr);
91 }
92
93 #ifdef CONFIG_LP_CHROMEOS
94 static void cb_parse_vboot_handoff(unsigned char *ptr, struct sysinfo_t *info)
95 {
96         struct cb_range *vbho = (struct cb_range *)ptr;
97
98         info->vboot_handoff = (void *)(uintptr_t)vbho->range_start;
99         info->vboot_handoff_size = vbho->range_size;
100 }
101
102 static void cb_parse_vbnv(unsigned char *ptr, struct sysinfo_t *info)
103 {
104         struct cb_range *vbnv = (struct cb_range *)ptr;
105
106         info->vbnv_start = vbnv->range_start;
107         info->vbnv_size = vbnv->range_size;
108 }
109
110 static void cb_parse_gpios(unsigned char *ptr, struct sysinfo_t *info)
111 {
112         int i;
113         struct cb_gpios *gpios = (struct cb_gpios *)ptr;
114
115         info->num_gpios = (gpios->count < SYSINFO_MAX_GPIOS) ?
116                                 (gpios->count) : SYSINFO_MAX_GPIOS;
117
118         for (i = 0; i < info->num_gpios; i++)
119                 info->gpios[i] = gpios->gpios[i];
120 }
121
122 static void cb_parse_vdat(unsigned char *ptr, struct sysinfo_t *info)
123 {
124         struct cb_range *vdat = (struct cb_range *) ptr;
125
126         info->vdat_addr = phys_to_virt(vdat->range_start);
127         info->vdat_size = vdat->range_size;
128 }
129 #endif
130
131 static void cb_parse_tstamp(unsigned char *ptr, struct sysinfo_t *info)
132 {
133         struct cb_cbmem_tab *const cbmem = (struct cb_cbmem_tab *)ptr;
134         info->tstamp_table = KADDR(cbmem->cbmem_tab);
135 }
136
137 static void cb_parse_cbmem_cons(unsigned char *ptr, struct sysinfo_t *info)
138 {
139         struct cb_cbmem_tab *const cbmem = (struct cb_cbmem_tab *)ptr;
140         info->cbmem_cons = KADDR(cbmem->cbmem_tab);
141 }
142
143 static void cb_parse_mrc_cache(unsigned char *ptr, struct sysinfo_t *info)
144 {
145         struct cb_cbmem_tab *const cbmem = (struct cb_cbmem_tab *)ptr;
146         info->mrc_cache = KADDR(cbmem->cbmem_tab);
147 }
148
149 static void cb_parse_acpi_gnvs(unsigned char *ptr, struct sysinfo_t *info)
150 {
151         struct cb_cbmem_tab *const cbmem = (struct cb_cbmem_tab *)ptr;
152         info->acpi_gnvs = KADDR(cbmem->cbmem_tab);
153 }
154
155 #ifdef CONFIG_LP_NVRAM
156 static void cb_parse_optiontable(void *ptr, struct sysinfo_t *info)
157 {
158         /* ptr points to a coreboot table entry and is already virtual */
159         info->option_table = ptr;
160 }
161
162 static void cb_parse_checksum(void *ptr, struct sysinfo_t *info)
163 {
164         struct cb_cmos_checksum *cmos_cksum = ptr;
165         info->cmos_range_start = cmos_cksum->range_start;
166         info->cmos_range_end = cmos_cksum->range_end;
167         info->cmos_checksum_location = cmos_cksum->location;
168 }
169 #endif
170
171 #ifdef CONFIG_LP_COREBOOT_VIDEO_CONSOLE
172 static void cb_parse_framebuffer(void *ptr, struct sysinfo_t *info)
173 {
174         /* ptr points to a coreboot table entry and is already virtual */
175         info->framebuffer = ptr;
176 }
177 #endif
178
179 static void cb_parse_x86_rom_var_mtrr(void *ptr, struct sysinfo_t *info)
180 {
181         struct cb_x86_rom_mtrr *rom_mtrr = ptr;
182         info->x86_rom_var_mtrr_index = rom_mtrr->index;
183 }
184
185 static void cb_parse_string(unsigned char *ptr, char **info)
186 {
187         *info = (char *)((struct cb_string *)ptr)->string;
188 }
189
190 static int cb_parse_header(void *addr, int len, struct sysinfo_t *info)
191 {
192         struct cb_header *header;
193         unsigned char *ptr = addr;
194         void *forward;
195         int i;
196
197         for (i = 0; i < len; i += 16, ptr += 16) {
198                 header = (struct cb_header *)ptr;
199                 if (!strncmp((const char *)header->signature, "LBIO", 4))
200                         break;
201         }
202
203         /* We walked the entire space and didn't find anything. */
204         if (i >= len)
205                 return -1;
206
207         if (!header->table_bytes)
208                 return 0;
209
210         /* Make sure the checksums match. */
211         if (ipchecksum((uint8_t *) header, sizeof(*header)) != 0)
212                 return -1;
213
214         if (ipchecksum((uint8_t *) (ptr + sizeof(*header)),
215                      header->table_bytes) != header->table_checksum)
216                 return -1;
217
218         info->header = header;
219
220         /* Now, walk the tables. */
221         ptr += header->header_bytes;
222
223         for (i = 0; i < header->table_entries; i++) {
224                 struct cb_record *rec = (struct cb_record *)ptr;
225
226                 /* We only care about a few tags here (maybe more later). */
227                 switch (rec->tag) {
228                 case CB_TAG_FORWARD:
229                         forward = KADDR((unsigned long)((struct cb_forward *)rec)->forward);
230                         return cb_parse_header(forward, len, info);
231                         continue;
232                 case CB_TAG_MEMORY:
233                         cb_parse_memory(ptr, info);
234                         break;
235                 case CB_TAG_SERIAL:
236                         cb_parse_serial(ptr, info);
237                         break;
238                 case CB_TAG_VERSION:
239                         cb_parse_string(ptr, &info->cb_version);
240                         break;
241                 case CB_TAG_EXTRA_VERSION:
242                         cb_parse_string(ptr, &info->extra_version);
243                         break;
244                 case CB_TAG_BUILD:
245                         cb_parse_string(ptr, &info->build);
246                         break;
247                 case CB_TAG_COMPILE_TIME:
248                         cb_parse_string(ptr, &info->compile_time);
249                         break;
250                 case CB_TAG_COMPILE_BY:
251                         cb_parse_string(ptr, &info->compile_by);
252                         break;
253                 case CB_TAG_COMPILE_HOST:
254                         cb_parse_string(ptr, &info->compile_host);
255                         break;
256                 case CB_TAG_COMPILE_DOMAIN:
257                         cb_parse_string(ptr, &info->compile_domain);
258                         break;
259                 case CB_TAG_COMPILER:
260                         cb_parse_string(ptr, &info->compiler);
261                         break;
262                 case CB_TAG_LINKER:
263                         cb_parse_string(ptr, &info->linker);
264                         break;
265                 case CB_TAG_ASSEMBLER:
266                         cb_parse_string(ptr, &info->assembler);
267                         break;
268 #ifdef CONFIG_LP_NVRAM
269                 case CB_TAG_CMOS_OPTION_TABLE:
270                         cb_parse_optiontable(ptr, info);
271                         break;
272                 case CB_TAG_OPTION_CHECKSUM:
273                         cb_parse_checksum(ptr, info);
274                         break;
275 #endif
276 #ifdef CONFIG_LP_COREBOOT_VIDEO_CONSOLE
277                 // FIXME we should warn on serial if coreboot set up a
278                 // framebuffer buf the payload does not know about it.
279                 case CB_TAG_FRAMEBUFFER:
280                         cb_parse_framebuffer(ptr, info);
281                         break;
282 #endif
283                 case CB_TAG_MAINBOARD:
284                         info->mainboard = (struct cb_mainboard *)ptr;
285 #ifdef CONFIG_LP_CHROMEOS
286                 case CB_TAG_GPIO:
287                         cb_parse_gpios(ptr, info);
288                         break;
289                 case CB_TAG_VDAT:
290                         cb_parse_vdat(ptr, info);
291                         break;
292                 case CB_TAG_VBNV:
293                         cb_parse_vbnv(ptr, info);
294                         break;
295                 case CB_TAG_VBOOT_HANDOFF:
296                         cb_parse_vboot_handoff(ptr, info);
297                         break;
298 #endif
299                 case CB_TAG_TIMESTAMPS:
300                         cb_parse_tstamp(ptr, info);
301                         break;
302                 case CB_TAG_CBMEM_CONSOLE:
303                         cb_parse_cbmem_cons(ptr, info);
304                         break;
305                 case CB_TAG_MRC_CACHE:
306                         cb_parse_mrc_cache(ptr, info);
307                         break;
308                 case CB_TAG_ACPI_GNVS:
309                         cb_parse_acpi_gnvs(ptr, info);
310                         break;
311                 case CB_TAG_X86_ROM_MTRR:
312                         cb_parse_x86_rom_var_mtrr(ptr, info);
313                         break;
314                 }
315
316                 ptr += rec->size;
317         }
318
319         return 1;
320 }
321
322 /* == Architecture specific == */
323 /* This is the x86 specific stuff. */
324
325 int get_coreboot_info(struct sysinfo_t *info)
326 {
327         int ret;
328
329         /* Ensure the variable range MTRR index covering the ROM is set to
330          * an invalid value. */
331         info->x86_rom_var_mtrr_index = -1;
332
333         ret = cb_parse_header(KADDR(0x00000000), 0x1000, info);
334
335         if (ret != 1)
336                 ret = cb_parse_header(KADDR(0x000f0000), 0x1000, info);
337         printk("get_coreboot_info: ret %d\n", ret);
338         return (ret == 1) ? 0 : -1;
339 }