Fix compilation when USE_OPTION_TABLE is not defined.
[coreboot.git] / src / arch / x86 / boot / coreboot_table.c
1 /*
2  * This file is part of the coreboot project.
3  *
4  * Copyright (C) 2003-2004 Eric Biederman
5  * Copyright (C) 2005-2010 coresystems GmbH
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License as
9  * published by the Free Software Foundation; version 2 of
10  * the License.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
20  * MA 02110-1301 USA
21  */
22
23 #include <console/console.h>
24 #include <ip_checksum.h>
25 #include <boot/tables.h>
26 #include <boot/coreboot_tables.h>
27 #include <arch/coreboot_tables.h>
28 #include <string.h>
29 #include <version.h>
30 #include <device/device.h>
31 #include <stdlib.h>
32 #include <cbfs.h>
33 #if CONFIG_USE_OPTION_TABLE
34 #include <option_table.h>
35 #endif
36
37 static struct lb_header *lb_table_init(unsigned long addr)
38 {
39         struct lb_header *header;
40
41         /* 16 byte align the address */
42         addr += 15;
43         addr &= ~15;
44
45         header = (void *)addr;
46         header->signature[0] = 'L';
47         header->signature[1] = 'B';
48         header->signature[2] = 'I';
49         header->signature[3] = 'O';
50         header->header_bytes = sizeof(*header);
51         header->header_checksum = 0;
52         header->table_bytes = 0;
53         header->table_checksum = 0;
54         header->table_entries = 0;
55         return header;
56 }
57
58 static struct lb_record *lb_first_record(struct lb_header *header)
59 {
60         struct lb_record *rec;
61         rec = (void *)(((char *)header) + sizeof(*header));
62         return rec;
63 }
64
65 static struct lb_record *lb_last_record(struct lb_header *header)
66 {
67         struct lb_record *rec;
68         rec = (void *)(((char *)header) + sizeof(*header) + header->table_bytes);
69         return rec;
70 }
71
72 #if 0
73 static struct lb_record *lb_next_record(struct lb_record *rec)
74 {
75         rec = (void *)(((char *)rec) + rec->size);
76         return rec;
77 }
78 #endif
79
80 static struct lb_record *lb_new_record(struct lb_header *header)
81 {
82         struct lb_record *rec;
83         rec = lb_last_record(header);
84         if (header->table_entries) {
85                 header->table_bytes += rec->size;
86         }
87         rec = lb_last_record(header);
88         header->table_entries++;
89         rec->tag = LB_TAG_UNUSED;
90         rec->size = sizeof(*rec);
91         return rec;
92 }
93
94
95 static struct lb_memory *lb_memory(struct lb_header *header)
96 {
97         struct lb_record *rec;
98         struct lb_memory *mem;
99         rec = lb_new_record(header);
100         mem = (struct lb_memory *)rec;
101         mem->tag = LB_TAG_MEMORY;
102         mem->size = sizeof(*mem);
103         return mem;
104 }
105
106 static struct lb_serial *lb_serial(struct lb_header *header)
107 {
108 #if CONFIG_CONSOLE_SERIAL8250
109         struct lb_record *rec;
110         struct lb_serial *serial;
111         rec = lb_new_record(header);
112         serial = (struct lb_serial *)rec;
113         serial->tag = LB_TAG_SERIAL;
114         serial->size = sizeof(*serial);
115         serial->type = LB_SERIAL_TYPE_IO_MAPPED;
116         serial->baseaddr = CONFIG_TTYS0_BASE;
117         serial->baud = CONFIG_TTYS0_BAUD;
118         return serial;
119 #elif CONFIG_CONSOLE_SERIAL8250MEM
120         struct lb_record *rec;
121         struct lb_serial *serial;
122         rec = lb_new_record(header);
123         serial = (struct lb_serial *)rec;
124         serial->tag = LB_TAG_SERIAL;
125         serial->size = sizeof(*serial);
126         serial->type = LB_SERIAL_TYPE_MEMORY_MAPPED;
127         serial->baseaddr = uartmem_getbaseaddr();
128         serial->baud = CONFIG_TTYS0_BAUD;
129         return serial;
130 #else
131         return NULL;
132 #endif
133 }
134
135 #if CONFIG_CONSOLE_SERIAL8250 || CONFIG_CONSOLE_SERIAL8250MEM || \
136     CONFIG_CONSOLE_LOGBUF || CONFIG_USBDEBUG
137 static void add_console(struct lb_header *header, u16 consoletype)
138 {
139         struct lb_console *console;
140
141         console = (struct lb_console *)lb_new_record(header);
142         console->tag = LB_TAG_CONSOLE;
143         console->size = sizeof(*console);
144         console->type = consoletype;
145 }
146 #endif
147
148 static void lb_console(struct lb_header *header)
149 {
150 #if CONFIG_CONSOLE_SERIAL8250
151         add_console(header, LB_TAG_CONSOLE_SERIAL8250);
152 #endif
153 #if CONFIG_CONSOLE_SERIAL8250MEM
154         add_console(header, LB_TAG_CONSOLE_SERIAL8250MEM);
155 #endif
156 #if CONFIG_CONSOLE_LOGBUF
157         add_console(header, LB_TAG_CONSOLE_LOGBUF);
158 #endif
159 #if CONFIG_USBDEBUG
160         add_console(header, LB_TAG_CONSOLE_EHCI);
161 #endif
162 }
163
164 static void lb_framebuffer(struct lb_header *header)
165 {
166 #if CONFIG_FRAMEBUFFER_KEEP_VESA_MODE
167         void fill_lb_framebuffer(struct lb_framebuffer *framebuffer);
168
169         struct lb_framebuffer *framebuffer;
170         framebuffer = (struct lb_framebuffer *)lb_new_record(header);
171         framebuffer->tag = LB_TAG_FRAMEBUFFER;
172         framebuffer->size = sizeof(*framebuffer);
173         fill_lb_framebuffer(framebuffer);
174 #endif
175 }
176
177 static struct lb_mainboard *lb_mainboard(struct lb_header *header)
178 {
179         struct lb_record *rec;
180         struct lb_mainboard *mainboard;
181         rec = lb_new_record(header);
182         mainboard = (struct lb_mainboard *)rec;
183         mainboard->tag = LB_TAG_MAINBOARD;
184
185         mainboard->size = (sizeof(*mainboard) +
186                 strlen(mainboard_vendor) + 1 +
187                 strlen(mainboard_part_number) + 1 +
188                 3) & ~3;
189
190         mainboard->vendor_idx = 0;
191         mainboard->part_number_idx = strlen(mainboard_vendor) + 1;
192
193         memcpy(mainboard->strings + mainboard->vendor_idx,
194                 mainboard_vendor,      strlen(mainboard_vendor) + 1);
195         memcpy(mainboard->strings + mainboard->part_number_idx,
196                 mainboard_part_number, strlen(mainboard_part_number) + 1);
197
198         return mainboard;
199 }
200
201 #if CONFIG_USE_OPTION_TABLE
202 static struct cmos_checksum *lb_cmos_checksum(struct lb_header *header)
203 {
204         struct lb_record *rec;
205         struct cmos_checksum *cmos_checksum;
206         rec = lb_new_record(header);
207         cmos_checksum = (struct cmos_checksum *)rec;
208         cmos_checksum->tag = LB_TAG_OPTION_CHECKSUM;
209
210         cmos_checksum->size = (sizeof(*cmos_checksum));
211
212         cmos_checksum->range_start = LB_CKS_RANGE_START * 8;
213         cmos_checksum->range_end = ( LB_CKS_RANGE_END * 8 ) + 7;
214         cmos_checksum->location = LB_CKS_LOC * 8;
215         cmos_checksum->type = CHECKSUM_PCBIOS;
216
217         return cmos_checksum;
218 }
219 #endif
220
221 static void lb_strings(struct lb_header *header)
222 {
223         static const struct {
224                 uint32_t tag;
225                 const char *string;
226         } strings[] = {
227                 { LB_TAG_VERSION,        coreboot_version,        },
228                 { LB_TAG_EXTRA_VERSION,  coreboot_extra_version,  },
229                 { LB_TAG_BUILD,          coreboot_build,          },
230                 { LB_TAG_COMPILE_TIME,   coreboot_compile_time,   },
231                 { LB_TAG_COMPILE_BY,     coreboot_compile_by,     },
232                 { LB_TAG_COMPILE_HOST,   coreboot_compile_host,   },
233                 { LB_TAG_COMPILE_DOMAIN, coreboot_compile_domain, },
234                 { LB_TAG_COMPILER,       coreboot_compiler,       },
235                 { LB_TAG_LINKER,         coreboot_linker,         },
236                 { LB_TAG_ASSEMBLER,      coreboot_assembler,      },
237         };
238         unsigned int i;
239         for(i = 0; i < ARRAY_SIZE(strings); i++) {
240                 struct lb_string *rec;
241                 size_t len;
242                 rec = (struct lb_string *)lb_new_record(header);
243                 len = strlen(strings[i].string);
244                 rec->tag = strings[i].tag;
245                 rec->size = (sizeof(*rec) + len + 1 + 3) & ~3;
246                 memcpy(rec->string, strings[i].string, len+1);
247         }
248
249 }
250
251 #if CONFIG_WRITE_HIGH_TABLES == 1
252 static struct lb_forward *lb_forward(struct lb_header *header, struct lb_header *next_header)
253 {
254         struct lb_record *rec;
255         struct lb_forward *forward;
256         rec = lb_new_record(header);
257         forward = (struct lb_forward *)rec;
258         forward->tag = LB_TAG_FORWARD;
259         forward->size = sizeof(*forward);
260         forward->forward = (uint64_t)(unsigned long)next_header;
261         return forward;
262 }
263 #endif
264
265 void lb_memory_range(struct lb_memory *mem,
266         uint32_t type, uint64_t start, uint64_t size)
267 {
268         int entries;
269         entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
270         mem->map[entries].start = pack_lb64(start);
271         mem->map[entries].size = pack_lb64(size);
272         mem->map[entries].type = type;
273         mem->size += sizeof(mem->map[0]);
274 }
275
276 static void lb_reserve_table_memory(struct lb_header *head)
277 {
278         struct lb_record *last_rec;
279         struct lb_memory *mem;
280         uint64_t start;
281         uint64_t end;
282         int i, entries;
283
284         last_rec = lb_last_record(head);
285         mem = get_lb_mem();
286         start = (unsigned long)head;
287         end = (unsigned long)last_rec;
288         entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
289         /* Resize the right two memory areas so this table is in
290          * a reserved area of memory.  Everything has been carefully
291          * setup so that is all we need to do.
292          */
293         for(i = 0; i < entries; i++ ) {
294                 uint64_t map_start = unpack_lb64(mem->map[i].start);
295                 uint64_t map_end = map_start + unpack_lb64(mem->map[i].size);
296                 /* Does this area need to be expanded? */
297                 if (map_end == start) {
298                         mem->map[i].size = pack_lb64(end - map_start);
299                 }
300                 /* Does this area need to be contracted? */
301                 else if (map_start == start) {
302                         mem->map[i].start = pack_lb64(end);
303                         mem->map[i].size = pack_lb64(map_end - end);
304                 }
305         }
306 }
307
308 static unsigned long lb_table_fini(struct lb_header *head, int fixup)
309 {
310         struct lb_record *rec, *first_rec;
311         rec = lb_last_record(head);
312         if (head->table_entries) {
313                 head->table_bytes += rec->size;
314         }
315
316         if (fixup)
317                 lb_reserve_table_memory(head);
318
319         first_rec = lb_first_record(head);
320         head->table_checksum = compute_ip_checksum(first_rec, head->table_bytes);
321         head->header_checksum = 0;
322         head->header_checksum = compute_ip_checksum(head, sizeof(*head));
323         printk(BIOS_DEBUG,
324                "Wrote coreboot table at: %p, 0x%x bytes, checksum %x\n",
325                head, head->table_bytes, head->table_checksum);
326         return (unsigned long)rec + rec->size;
327 }
328
329 static void lb_cleanup_memory_ranges(struct lb_memory *mem)
330 {
331         int entries;
332         int i, j;
333         entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
334
335         /* Sort the lb memory ranges */
336         for(i = 0; i < entries; i++) {
337                 uint64_t entry_start = unpack_lb64(mem->map[i].start);
338                 for(j = i; j < entries; j++) {
339                         uint64_t temp_start = unpack_lb64(mem->map[j].start);
340                         if (temp_start < entry_start) {
341                                 struct lb_memory_range tmp;
342                                 tmp = mem->map[i];
343                                 mem->map[i] = mem->map[j];
344                                 mem->map[j] = tmp;
345                         }
346                 }
347         }
348
349         /* Merge adjacent entries */
350         for(i = 0; (i + 1) < entries; i++) {
351                 uint64_t start, end, nstart, nend;
352                 if (mem->map[i].type != mem->map[i + 1].type) {
353                         continue;
354                 }
355                 start  = unpack_lb64(mem->map[i].start);
356                 end    = start + unpack_lb64(mem->map[i].size);
357                 nstart = unpack_lb64(mem->map[i + 1].start);
358                 nend   = nstart + unpack_lb64(mem->map[i + 1].size);
359                 if ((start <= nstart) && (end > nstart)) {
360                         if (start > nstart) {
361                                 start = nstart;
362                         }
363                         if (end < nend) {
364                                 end = nend;
365                         }
366                         /* Record the new region size */
367                         mem->map[i].start = pack_lb64(start);
368                         mem->map[i].size  = pack_lb64(end - start);
369
370                         /* Delete the entry I have merged with */
371                         memmove(&mem->map[i + 1], &mem->map[i + 2],
372                                 ((entries - i - 2) * sizeof(mem->map[0])));
373                         mem->size -= sizeof(mem->map[0]);
374                         entries -= 1;
375                         /* See if I can merge with the next entry as well */
376                         i -= 1;
377                 }
378         }
379 }
380
381 static void lb_remove_memory_range(struct lb_memory *mem,
382         uint64_t start, uint64_t size)
383 {
384         uint64_t end;
385         int entries;
386         int i;
387
388         end = start + size;
389         entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
390
391         /* Remove a reserved area from the memory map */
392         for(i = 0; i < entries; i++) {
393                 uint64_t map_start = unpack_lb64(mem->map[i].start);
394                 uint64_t map_end   = map_start + unpack_lb64(mem->map[i].size);
395                 if ((start <= map_start) && (end >= map_end)) {
396                         /* Remove the completely covered range */
397                         memmove(&mem->map[i], &mem->map[i + 1],
398                                 ((entries - i - 1) * sizeof(mem->map[0])));
399                         mem->size -= sizeof(mem->map[0]);
400                         entries -= 1;
401                         /* Since the index will disappear revisit what will appear here */
402                         i -= 1;
403                 }
404                 else if ((start > map_start) && (end < map_end)) {
405                         /* Split the memory range */
406                         memmove(&mem->map[i + 1], &mem->map[i],
407                                 ((entries - i) * sizeof(mem->map[0])));
408                         mem->size += sizeof(mem->map[0]);
409                         entries += 1;
410                         /* Update the first map entry */
411                         mem->map[i].size = pack_lb64(start - map_start);
412                         /* Update the second map entry */
413                         mem->map[i + 1].start = pack_lb64(end);
414                         mem->map[i + 1].size  = pack_lb64(map_end - end);
415                         /* Don't bother with this map entry again */
416                         i += 1;
417                 }
418                 else if ((start <= map_start) && (end > map_start)) {
419                         /* Shrink the start of the memory range */
420                         mem->map[i].start = pack_lb64(end);
421                         mem->map[i].size  = pack_lb64(map_end - end);
422                 }
423                 else if ((start < map_end) && (start > map_start)) {
424                         /* Shrink the end of the memory range */
425                         mem->map[i].size = pack_lb64(start - map_start);
426                 }
427         }
428 }
429
430 /* This function is used in mainboard specific code, too */
431 void lb_add_memory_range(struct lb_memory *mem,
432         uint32_t type, uint64_t start, uint64_t size)
433 {
434         lb_remove_memory_range(mem, start, size);
435         lb_memory_range(mem, type, start, size);
436         lb_cleanup_memory_ranges(mem);
437 }
438
439 static void lb_dump_memory_ranges(struct lb_memory *mem)
440 {
441         int entries;
442         int i;
443         entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
444
445         printk(BIOS_DEBUG, "coreboot memory table:\n");
446         for(i = 0; i < entries; i++) {
447                 uint64_t entry_start = unpack_lb64(mem->map[i].start);
448                 uint64_t entry_size = unpack_lb64(mem->map[i].size);
449                 const char *entry_type;
450
451                 switch (mem->map[i].type) {
452                 case LB_MEM_RAM: entry_type="RAM"; break;
453                 case LB_MEM_RESERVED: entry_type="RESERVED"; break;
454                 case LB_MEM_ACPI: entry_type="ACPI"; break;
455                 case LB_MEM_NVS: entry_type="NVS"; break;
456                 case LB_MEM_UNUSABLE: entry_type="UNUSABLE"; break;
457                 case LB_MEM_VENDOR_RSVD: entry_type="VENDOR RESERVED"; break;
458                 case LB_MEM_TABLE: entry_type="CONFIGURATION TABLES"; break;
459                 default: entry_type="UNKNOWN!"; break;
460                 }
461
462                 printk(BIOS_DEBUG, "%2d. %016llx-%016llx: %s\n",
463                         i, entry_start, entry_start+entry_size-1, entry_type);
464
465         }
466 }
467
468
469 /* Routines to extract part so the coreboot table or
470  * information from the coreboot table after we have written it.
471  * Currently get_lb_mem relies on a global we can change the
472  * implementaiton.
473  */
474 static struct lb_memory *mem_ranges = 0;
475 struct lb_memory *get_lb_mem(void)
476 {
477         return mem_ranges;
478 }
479
480 static void build_lb_mem_range(void *gp, struct device *dev, struct resource *res)
481 {
482         struct lb_memory *mem = gp;
483         lb_memory_range(mem, LB_MEM_RAM, res->base, res->size);
484 }
485
486 static struct lb_memory *build_lb_mem(struct lb_header *head)
487 {
488         struct lb_memory *mem;
489
490         /* Record where the lb memory ranges will live */
491         mem = lb_memory(head);
492         mem_ranges = mem;
493
494         /* Build the raw table of memory */
495         search_global_resources(
496                 IORESOURCE_MEM | IORESOURCE_CACHEABLE, IORESOURCE_MEM | IORESOURCE_CACHEABLE,
497                 build_lb_mem_range, mem);
498         lb_cleanup_memory_ranges(mem);
499         return mem;
500 }
501
502 static void lb_add_rsvd_range(void *gp, struct device *dev, struct resource *res)
503 {
504         struct lb_memory *mem = gp;
505         lb_add_memory_range(mem, LB_MEM_RESERVED, res->base, res->size);
506 }
507
508 static void add_lb_reserved(struct lb_memory *mem)
509 {
510         /* Add reserved ranges */
511         search_global_resources(
512                 IORESOURCE_MEM | IORESOURCE_RESERVE, IORESOURCE_MEM | IORESOURCE_RESERVE,
513                 lb_add_rsvd_range, mem);
514 }
515
516 #if CONFIG_WRITE_HIGH_TABLES
517 extern uint64_t high_tables_base, high_tables_size;
518 #endif
519
520 unsigned long write_coreboot_table(
521         unsigned long low_table_start, unsigned long low_table_end,
522         unsigned long rom_table_start, unsigned long rom_table_end)
523 {
524         struct lb_header *head;
525         struct lb_memory *mem;
526
527 #if CONFIG_WRITE_HIGH_TABLES
528         printk(BIOS_DEBUG, "Writing high table forward entry at 0x%08lx\n",
529                         low_table_end);
530         head = lb_table_init(low_table_end);
531         lb_forward(head, (struct lb_header*)rom_table_end);
532
533         low_table_end = (unsigned long) lb_table_fini(head, 0);
534         printk(BIOS_DEBUG, "New low_table_end: 0x%08lx\n", low_table_end);
535         printk(BIOS_DEBUG, "Now going to write high coreboot table at 0x%08lx\n",
536                         rom_table_end);
537
538         head = lb_table_init(rom_table_end);
539         rom_table_end = (unsigned long)head;
540         printk(BIOS_DEBUG, "rom_table_end = 0x%08lx\n", rom_table_end);
541 #else
542         if(low_table_end > (0x1000 - sizeof(struct lb_header))) { /* after 4K */
543                 /* We need to put lbtable on  to [0xf0000,0x100000) */
544                 head = lb_table_init(rom_table_end);
545                 rom_table_end = (unsigned long)head;
546         } else {
547                 head = lb_table_init(low_table_end);
548                 low_table_end = (unsigned long)head;
549         }
550 #endif
551
552         printk(BIOS_DEBUG, "Adjust low_table_end from 0x%08lx to ", low_table_end);
553         low_table_end += 0xfff; // 4K aligned
554         low_table_end &= ~0xfff;
555         printk(BIOS_DEBUG, "0x%08lx \n", low_table_end);
556
557         /* The Linux kernel assumes this region is reserved */
558         printk(BIOS_DEBUG, "Adjust rom_table_end from 0x%08lx to ", rom_table_end);
559         rom_table_end += 0xffff; // 64K align
560         rom_table_end &= ~0xffff;
561         printk(BIOS_DEBUG, "0x%08lx \n", rom_table_end);
562
563 #if CONFIG_USE_OPTION_TABLE
564         {
565                 struct cmos_option_table *option_table = cbfs_find_file("cmos_layout.bin", 0x1aa);
566                 if (option_table) {
567                         struct lb_record *rec_dest = lb_new_record(head);
568                         /* Copy the option config table, it's already a lb_record... */
569                         memcpy(rec_dest,  option_table, option_table->size);
570                         /* Create cmos checksum entry in coreboot table */
571                         lb_cmos_checksum(head);
572                 } else {
573                         printk(BIOS_ERR, "cmos_layout.bin could not be found!\n");
574                 }
575         }
576 #endif
577         /* Record where RAM is located */
578         mem = build_lb_mem(head);
579
580         /* Record the mptable and the the lb_table (This will be adjusted later) */
581         lb_add_memory_range(mem, LB_MEM_TABLE,
582                 low_table_start, low_table_end - low_table_start);
583
584         /* Record the pirq table, acpi tables, and maybe the mptable */
585         lb_add_memory_range(mem, LB_MEM_TABLE,
586                 rom_table_start, rom_table_end-rom_table_start);
587
588 #if CONFIG_WRITE_HIGH_TABLES
589         printk(BIOS_DEBUG, "Adding high table area\n");
590         // should this be LB_MEM_ACPI?
591         lb_add_memory_range(mem, LB_MEM_TABLE,
592                 high_tables_base, high_tables_size);
593 #endif
594
595         /* Add reserved regions */
596         add_lb_reserved(mem);
597
598 #if CONFIG_HAVE_MAINBOARD_RESOURCES
599         add_mainboard_resources(mem);
600 #endif
601
602         lb_dump_memory_ranges(mem);
603
604         /* Note:
605          * I assume that there is always memory at immediately after
606          * the low_table_end.  This means that after I setup the coreboot table.
607          * I can trivially fixup the reserved memory ranges to hold the correct
608          * size of the coreboot table.
609          */
610
611         /* Record our motherboard */
612         lb_mainboard(head);
613         /* Record the serial port, if present */
614         lb_serial(head);
615         /* Record our console setup */
616         lb_console(head);
617         /* Record our various random string information */
618         lb_strings(head);
619         /* Record our framebuffer */
620         lb_framebuffer(head);
621
622         /* Remember where my valid memory ranges are */
623         return lb_table_fini(head, 1);
624
625 }