2 * This file is part of the coreboot project.
4 * Copyright (C) 2003-2004 Eric Biederman
5 * Copyright (C) 2005-2010 coresystems GmbH
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
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.
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,
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>
30 #include <device/device.h>
34 #if CONFIG_USE_OPTION_TABLE
35 #include <option_table.h>
38 static struct lb_header *lb_table_init(unsigned long addr)
40 struct lb_header *header;
42 /* 16 byte align the address */
46 header = (void *)addr;
47 header->signature[0] = 'L';
48 header->signature[1] = 'B';
49 header->signature[2] = 'I';
50 header->signature[3] = 'O';
51 header->header_bytes = sizeof(*header);
52 header->header_checksum = 0;
53 header->table_bytes = 0;
54 header->table_checksum = 0;
55 header->table_entries = 0;
59 static struct lb_record *lb_first_record(struct lb_header *header)
61 struct lb_record *rec;
62 rec = (void *)(((char *)header) + sizeof(*header));
66 static struct lb_record *lb_last_record(struct lb_header *header)
68 struct lb_record *rec;
69 rec = (void *)(((char *)header) + sizeof(*header) + header->table_bytes);
74 static struct lb_record *lb_next_record(struct lb_record *rec)
76 rec = (void *)(((char *)rec) + rec->size);
81 static struct lb_record *lb_new_record(struct lb_header *header)
83 struct lb_record *rec;
84 rec = lb_last_record(header);
85 if (header->table_entries) {
86 header->table_bytes += rec->size;
88 rec = lb_last_record(header);
89 header->table_entries++;
90 rec->tag = LB_TAG_UNUSED;
91 rec->size = sizeof(*rec);
96 static struct lb_memory *lb_memory(struct lb_header *header)
98 struct lb_record *rec;
99 struct lb_memory *mem;
100 rec = lb_new_record(header);
101 mem = (struct lb_memory *)rec;
102 mem->tag = LB_TAG_MEMORY;
103 mem->size = sizeof(*mem);
107 static struct lb_serial *lb_serial(struct lb_header *header)
109 #if CONFIG_CONSOLE_SERIAL8250
110 struct lb_record *rec;
111 struct lb_serial *serial;
112 rec = lb_new_record(header);
113 serial = (struct lb_serial *)rec;
114 serial->tag = LB_TAG_SERIAL;
115 serial->size = sizeof(*serial);
116 serial->type = LB_SERIAL_TYPE_IO_MAPPED;
117 serial->baseaddr = CONFIG_TTYS0_BASE;
118 serial->baud = CONFIG_TTYS0_BAUD;
120 #elif CONFIG_CONSOLE_SERIAL8250MEM
121 if (uartmem_getbaseaddr()) {
122 struct lb_record *rec;
123 struct lb_serial *serial;
124 rec = lb_new_record(header);
125 serial = (struct lb_serial *)rec;
126 serial->tag = LB_TAG_SERIAL;
127 serial->size = sizeof(*serial);
128 serial->type = LB_SERIAL_TYPE_MEMORY_MAPPED;
129 serial->baseaddr = uartmem_getbaseaddr();
130 serial->baud = CONFIG_TTYS0_BAUD;
140 #if CONFIG_CONSOLE_SERIAL8250 || CONFIG_CONSOLE_SERIAL8250MEM || \
141 CONFIG_CONSOLE_LOGBUF || CONFIG_USBDEBUG
142 static void add_console(struct lb_header *header, u16 consoletype)
144 struct lb_console *console;
146 console = (struct lb_console *)lb_new_record(header);
147 console->tag = LB_TAG_CONSOLE;
148 console->size = sizeof(*console);
149 console->type = consoletype;
153 static void lb_console(struct lb_header *header)
155 #if CONFIG_CONSOLE_SERIAL8250
156 add_console(header, LB_TAG_CONSOLE_SERIAL8250);
158 #if CONFIG_CONSOLE_SERIAL8250MEM
159 add_console(header, LB_TAG_CONSOLE_SERIAL8250MEM);
161 #if CONFIG_CONSOLE_LOGBUF
162 add_console(header, LB_TAG_CONSOLE_LOGBUF);
165 add_console(header, LB_TAG_CONSOLE_EHCI);
169 static void lb_framebuffer(struct lb_header *header)
171 #if CONFIG_FRAMEBUFFER_KEEP_VESA_MODE
172 void fill_lb_framebuffer(struct lb_framebuffer *framebuffer);
174 struct lb_framebuffer *framebuffer;
175 framebuffer = (struct lb_framebuffer *)lb_new_record(header);
176 framebuffer->tag = LB_TAG_FRAMEBUFFER;
177 framebuffer->size = sizeof(*framebuffer);
178 fill_lb_framebuffer(framebuffer);
182 static void add_cbmem_pointers(struct lb_header *header)
185 * These CBMEM sections' addresses are included in the coreboot table
186 * with the appropriate tags.
188 const struct section_id {
192 {CBMEM_ID_TIMESTAMP, LB_TAG_TIMESTAMPS},
193 {CBMEM_ID_CONSOLE, LB_TAG_CBMEM_CONSOLE}
197 for (i = 0; i < ARRAY_SIZE(section_ids); i++) {
198 const struct section_id *sid = section_ids + i;
199 struct lb_cbmem_ref *cbmem_ref;
200 void *cbmem_addr = cbmem_find(sid->cbmem_id);
203 continue; /* This section is not present */
205 cbmem_ref = (struct lb_cbmem_ref *)lb_new_record(header);
207 printk(BIOS_ERR, "No more room in coreboot table!\n");
210 cbmem_ref->tag = sid->table_tag;
211 cbmem_ref->size = sizeof(*cbmem_ref);
212 cbmem_ref->cbmem_addr = cbmem_addr;
216 static struct lb_mainboard *lb_mainboard(struct lb_header *header)
218 struct lb_record *rec;
219 struct lb_mainboard *mainboard;
220 rec = lb_new_record(header);
221 mainboard = (struct lb_mainboard *)rec;
222 mainboard->tag = LB_TAG_MAINBOARD;
224 mainboard->size = (sizeof(*mainboard) +
225 strlen(mainboard_vendor) + 1 +
226 strlen(mainboard_part_number) + 1 +
229 mainboard->vendor_idx = 0;
230 mainboard->part_number_idx = strlen(mainboard_vendor) + 1;
232 memcpy(mainboard->strings + mainboard->vendor_idx,
233 mainboard_vendor, strlen(mainboard_vendor) + 1);
234 memcpy(mainboard->strings + mainboard->part_number_idx,
235 mainboard_part_number, strlen(mainboard_part_number) + 1);
240 #if CONFIG_USE_OPTION_TABLE
241 static struct cmos_checksum *lb_cmos_checksum(struct lb_header *header)
243 struct lb_record *rec;
244 struct cmos_checksum *cmos_checksum;
245 rec = lb_new_record(header);
246 cmos_checksum = (struct cmos_checksum *)rec;
247 cmos_checksum->tag = LB_TAG_OPTION_CHECKSUM;
249 cmos_checksum->size = (sizeof(*cmos_checksum));
251 cmos_checksum->range_start = LB_CKS_RANGE_START * 8;
252 cmos_checksum->range_end = ( LB_CKS_RANGE_END * 8 ) + 7;
253 cmos_checksum->location = LB_CKS_LOC * 8;
254 cmos_checksum->type = CHECKSUM_PCBIOS;
256 return cmos_checksum;
260 static void lb_strings(struct lb_header *header)
262 static const struct {
266 { LB_TAG_VERSION, coreboot_version, },
267 { LB_TAG_EXTRA_VERSION, coreboot_extra_version, },
268 { LB_TAG_BUILD, coreboot_build, },
269 { LB_TAG_COMPILE_TIME, coreboot_compile_time, },
270 { LB_TAG_COMPILE_BY, coreboot_compile_by, },
271 { LB_TAG_COMPILE_HOST, coreboot_compile_host, },
272 { LB_TAG_COMPILE_DOMAIN, coreboot_compile_domain, },
273 { LB_TAG_COMPILER, coreboot_compiler, },
274 { LB_TAG_LINKER, coreboot_linker, },
275 { LB_TAG_ASSEMBLER, coreboot_assembler, },
278 for(i = 0; i < ARRAY_SIZE(strings); i++) {
279 struct lb_string *rec;
281 rec = (struct lb_string *)lb_new_record(header);
282 len = strlen(strings[i].string);
283 rec->tag = strings[i].tag;
284 rec->size = (sizeof(*rec) + len + 1 + 3) & ~3;
285 memcpy(rec->string, strings[i].string, len+1);
290 #if CONFIG_WRITE_HIGH_TABLES == 1
291 static struct lb_forward *lb_forward(struct lb_header *header, struct lb_header *next_header)
293 struct lb_record *rec;
294 struct lb_forward *forward;
295 rec = lb_new_record(header);
296 forward = (struct lb_forward *)rec;
297 forward->tag = LB_TAG_FORWARD;
298 forward->size = sizeof(*forward);
299 forward->forward = (uint64_t)(unsigned long)next_header;
304 void lb_memory_range(struct lb_memory *mem,
305 uint32_t type, uint64_t start, uint64_t size)
308 entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
309 mem->map[entries].start = pack_lb64(start);
310 mem->map[entries].size = pack_lb64(size);
311 mem->map[entries].type = type;
312 mem->size += sizeof(mem->map[0]);
315 static void lb_reserve_table_memory(struct lb_header *head)
317 struct lb_record *last_rec;
318 struct lb_memory *mem;
323 last_rec = lb_last_record(head);
325 start = (unsigned long)head;
326 end = (unsigned long)last_rec;
327 entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
328 /* Resize the right two memory areas so this table is in
329 * a reserved area of memory. Everything has been carefully
330 * setup so that is all we need to do.
332 for(i = 0; i < entries; i++ ) {
333 uint64_t map_start = unpack_lb64(mem->map[i].start);
334 uint64_t map_end = map_start + unpack_lb64(mem->map[i].size);
335 /* Does this area need to be expanded? */
336 if (map_end == start) {
337 mem->map[i].size = pack_lb64(end - map_start);
339 /* Does this area need to be contracted? */
340 else if (map_start == start) {
341 mem->map[i].start = pack_lb64(end);
342 mem->map[i].size = pack_lb64(map_end - end);
347 static unsigned long lb_table_fini(struct lb_header *head, int fixup)
349 struct lb_record *rec, *first_rec;
350 rec = lb_last_record(head);
351 if (head->table_entries) {
352 head->table_bytes += rec->size;
356 lb_reserve_table_memory(head);
358 first_rec = lb_first_record(head);
359 head->table_checksum = compute_ip_checksum(first_rec, head->table_bytes);
360 head->header_checksum = 0;
361 head->header_checksum = compute_ip_checksum(head, sizeof(*head));
363 "Wrote coreboot table at: %p, 0x%x bytes, checksum %x\n",
364 head, head->table_bytes, head->table_checksum);
365 return (unsigned long)rec + rec->size;
368 static void lb_cleanup_memory_ranges(struct lb_memory *mem)
372 entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
374 /* Sort the lb memory ranges */
375 for(i = 0; i < entries; i++) {
376 uint64_t entry_start = unpack_lb64(mem->map[i].start);
377 for(j = i; j < entries; j++) {
378 uint64_t temp_start = unpack_lb64(mem->map[j].start);
379 if (temp_start < entry_start) {
380 struct lb_memory_range tmp;
382 mem->map[i] = mem->map[j];
388 /* Merge adjacent entries */
389 for(i = 0; (i + 1) < entries; i++) {
390 uint64_t start, end, nstart, nend;
391 if (mem->map[i].type != mem->map[i + 1].type) {
394 start = unpack_lb64(mem->map[i].start);
395 end = start + unpack_lb64(mem->map[i].size);
396 nstart = unpack_lb64(mem->map[i + 1].start);
397 nend = nstart + unpack_lb64(mem->map[i + 1].size);
398 if ((start <= nstart) && (end > nstart)) {
399 if (start > nstart) {
405 /* Record the new region size */
406 mem->map[i].start = pack_lb64(start);
407 mem->map[i].size = pack_lb64(end - start);
409 /* Delete the entry I have merged with */
410 memmove(&mem->map[i + 1], &mem->map[i + 2],
411 ((entries - i - 2) * sizeof(mem->map[0])));
412 mem->size -= sizeof(mem->map[0]);
414 /* See if I can merge with the next entry as well */
420 static void lb_remove_memory_range(struct lb_memory *mem,
421 uint64_t start, uint64_t size)
428 entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
430 /* Remove a reserved area from the memory map */
431 for(i = 0; i < entries; i++) {
432 uint64_t map_start = unpack_lb64(mem->map[i].start);
433 uint64_t map_end = map_start + unpack_lb64(mem->map[i].size);
434 if ((start <= map_start) && (end >= map_end)) {
435 /* Remove the completely covered range */
436 memmove(&mem->map[i], &mem->map[i + 1],
437 ((entries - i - 1) * sizeof(mem->map[0])));
438 mem->size -= sizeof(mem->map[0]);
440 /* Since the index will disappear revisit what will appear here */
443 else if ((start > map_start) && (end < map_end)) {
444 /* Split the memory range */
445 memmove(&mem->map[i + 1], &mem->map[i],
446 ((entries - i) * sizeof(mem->map[0])));
447 mem->size += sizeof(mem->map[0]);
449 /* Update the first map entry */
450 mem->map[i].size = pack_lb64(start - map_start);
451 /* Update the second map entry */
452 mem->map[i + 1].start = pack_lb64(end);
453 mem->map[i + 1].size = pack_lb64(map_end - end);
454 /* Don't bother with this map entry again */
457 else if ((start <= map_start) && (end > map_start)) {
458 /* Shrink the start of the memory range */
459 mem->map[i].start = pack_lb64(end);
460 mem->map[i].size = pack_lb64(map_end - end);
462 else if ((start < map_end) && (start > map_start)) {
463 /* Shrink the end of the memory range */
464 mem->map[i].size = pack_lb64(start - map_start);
469 /* This function is used in mainboard specific code, too */
470 void lb_add_memory_range(struct lb_memory *mem,
471 uint32_t type, uint64_t start, uint64_t size)
473 lb_remove_memory_range(mem, start, size);
474 lb_memory_range(mem, type, start, size);
475 lb_cleanup_memory_ranges(mem);
478 static void lb_dump_memory_ranges(struct lb_memory *mem)
482 entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
484 printk(BIOS_DEBUG, "coreboot memory table:\n");
485 for(i = 0; i < entries; i++) {
486 uint64_t entry_start = unpack_lb64(mem->map[i].start);
487 uint64_t entry_size = unpack_lb64(mem->map[i].size);
488 const char *entry_type;
490 switch (mem->map[i].type) {
491 case LB_MEM_RAM: entry_type="RAM"; break;
492 case LB_MEM_RESERVED: entry_type="RESERVED"; break;
493 case LB_MEM_ACPI: entry_type="ACPI"; break;
494 case LB_MEM_NVS: entry_type="NVS"; break;
495 case LB_MEM_UNUSABLE: entry_type="UNUSABLE"; break;
496 case LB_MEM_VENDOR_RSVD: entry_type="VENDOR RESERVED"; break;
497 case LB_MEM_TABLE: entry_type="CONFIGURATION TABLES"; break;
498 default: entry_type="UNKNOWN!"; break;
501 printk(BIOS_DEBUG, "%2d. %016llx-%016llx: %s\n",
502 i, entry_start, entry_start+entry_size-1, entry_type);
508 /* Routines to extract part so the coreboot table or
509 * information from the coreboot table after we have written it.
510 * Currently get_lb_mem relies on a global we can change the
513 static struct lb_memory *mem_ranges = 0;
514 struct lb_memory *get_lb_mem(void)
519 static void build_lb_mem_range(void *gp, struct device *dev, struct resource *res)
521 struct lb_memory *mem = gp;
522 lb_memory_range(mem, LB_MEM_RAM, res->base, res->size);
525 static struct lb_memory *build_lb_mem(struct lb_header *head)
527 struct lb_memory *mem;
529 /* Record where the lb memory ranges will live */
530 mem = lb_memory(head);
533 /* Build the raw table of memory */
534 search_global_resources(
535 IORESOURCE_MEM | IORESOURCE_CACHEABLE, IORESOURCE_MEM | IORESOURCE_CACHEABLE,
536 build_lb_mem_range, mem);
537 lb_cleanup_memory_ranges(mem);
541 static void lb_add_rsvd_range(void *gp, struct device *dev, struct resource *res)
543 struct lb_memory *mem = gp;
544 lb_add_memory_range(mem, LB_MEM_RESERVED, res->base, res->size);
547 static void add_lb_reserved(struct lb_memory *mem)
549 /* Add reserved ranges */
550 search_global_resources(
551 IORESOURCE_MEM | IORESOURCE_RESERVE, IORESOURCE_MEM | IORESOURCE_RESERVE,
552 lb_add_rsvd_range, mem);
555 unsigned long write_coreboot_table(
556 unsigned long low_table_start, unsigned long low_table_end,
557 unsigned long rom_table_start, unsigned long rom_table_end)
559 struct lb_header *head;
560 struct lb_memory *mem;
562 #if CONFIG_WRITE_HIGH_TABLES
563 printk(BIOS_DEBUG, "Writing high table forward entry at 0x%08lx\n",
565 head = lb_table_init(low_table_end);
566 lb_forward(head, (struct lb_header*)rom_table_end);
568 low_table_end = (unsigned long) lb_table_fini(head, 0);
569 printk(BIOS_DEBUG, "New low_table_end: 0x%08lx\n", low_table_end);
570 printk(BIOS_DEBUG, "Now going to write high coreboot table at 0x%08lx\n",
573 head = lb_table_init(rom_table_end);
574 rom_table_end = (unsigned long)head;
575 printk(BIOS_DEBUG, "rom_table_end = 0x%08lx\n", rom_table_end);
577 if(low_table_end > (0x1000 - sizeof(struct lb_header))) { /* after 4K */
578 /* We need to put lbtable on to [0xf0000,0x100000) */
579 head = lb_table_init(rom_table_end);
580 rom_table_end = (unsigned long)head;
582 head = lb_table_init(low_table_end);
583 low_table_end = (unsigned long)head;
587 printk(BIOS_DEBUG, "Adjust low_table_end from 0x%08lx to ", low_table_end);
588 low_table_end += 0xfff; // 4K aligned
589 low_table_end &= ~0xfff;
590 printk(BIOS_DEBUG, "0x%08lx \n", low_table_end);
592 /* The Linux kernel assumes this region is reserved */
593 printk(BIOS_DEBUG, "Adjust rom_table_end from 0x%08lx to ", rom_table_end);
594 rom_table_end += 0xffff; // 64K align
595 rom_table_end &= ~0xffff;
596 printk(BIOS_DEBUG, "0x%08lx \n", rom_table_end);
598 #if CONFIG_USE_OPTION_TABLE
600 struct cmos_option_table *option_table = cbfs_find_file("cmos_layout.bin", 0x1aa);
602 struct lb_record *rec_dest = lb_new_record(head);
603 /* Copy the option config table, it's already a lb_record... */
604 memcpy(rec_dest, option_table, option_table->size);
605 /* Create cmos checksum entry in coreboot table */
606 lb_cmos_checksum(head);
608 printk(BIOS_ERR, "cmos_layout.bin could not be found!\n");
612 /* Record where RAM is located */
613 mem = build_lb_mem(head);
615 /* Record the mptable and the the lb_table (This will be adjusted later) */
616 lb_add_memory_range(mem, LB_MEM_TABLE,
617 low_table_start, low_table_end - low_table_start);
619 /* Record the pirq table, acpi tables, and maybe the mptable */
620 lb_add_memory_range(mem, LB_MEM_TABLE,
621 rom_table_start, rom_table_end-rom_table_start);
623 #if CONFIG_WRITE_HIGH_TABLES
624 printk(BIOS_DEBUG, "Adding high table area\n");
625 // should this be LB_MEM_ACPI?
626 lb_add_memory_range(mem, LB_MEM_TABLE,
627 high_tables_base, high_tables_size);
630 /* Add reserved regions */
631 add_lb_reserved(mem);
633 #if CONFIG_HAVE_MAINBOARD_RESOURCES
634 add_mainboard_resources(mem);
637 lb_dump_memory_ranges(mem);
640 * I assume that there is always memory at immediately after
641 * the low_table_end. This means that after I setup the coreboot table.
642 * I can trivially fixup the reserved memory ranges to hold the correct
643 * size of the coreboot table.
646 /* Record our motherboard */
648 /* Record the serial port, if present */
650 /* Record our console setup */
652 /* Record our various random string information */
654 /* Record our framebuffer */
655 lb_framebuffer(head);
657 add_cbmem_pointers(head);
659 /* Remember where my valid memory ranges are */
660 return lb_table_fini(head, 1);