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>
32 #if (CONFIG_USE_OPTION_TABLE == 1)
33 #include <option_table.h>
37 static struct lb_header *lb_table_init(unsigned long addr)
39 struct lb_header *header;
41 /* 16 byte align the address */
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;
58 static struct lb_record *lb_first_record(struct lb_header *header)
60 struct lb_record *rec;
61 rec = (void *)(((char *)header) + sizeof(*header));
65 static struct lb_record *lb_last_record(struct lb_header *header)
67 struct lb_record *rec;
68 rec = (void *)(((char *)header) + sizeof(*header) + header->table_bytes);
73 static struct lb_record *lb_next_record(struct lb_record *rec)
75 rec = (void *)(((char *)rec) + rec->size);
80 static struct lb_record *lb_new_record(struct lb_header *header)
82 struct lb_record *rec;
83 rec = lb_last_record(header);
84 if (header->table_entries) {
85 header->table_bytes += rec->size;
87 rec = lb_last_record(header);
88 header->table_entries++;
89 rec->tag = LB_TAG_UNUSED;
90 rec->size = sizeof(*rec);
95 static struct lb_memory *lb_memory(struct lb_header *header)
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);
106 static struct lb_serial *lb_serial(struct lb_header *header)
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->ioport = CONFIG_TTYS0_BASE;
116 serial->baud = CONFIG_TTYS0_BAUD;
123 #if CONFIG_CONSOLE_SERIAL8250 || CONFIG_CONSOLE_SERIAL8250MEM || \
124 CONFIG_CONSOLE_LOGBUF || CONFIG_USBDEBUG
125 static void add_console(struct lb_header *header, u16 consoletype)
127 struct lb_console *console;
129 console = (struct lb_console *)lb_new_record(header);
130 console->tag = LB_TAG_CONSOLE;
131 console->size = sizeof(*console);
132 console->type = consoletype;
137 static void lb_console(struct lb_header *header)
139 #if CONFIG_CONSOLE_SERIAL8250
140 add_console(header, LB_TAG_CONSOLE_SERIAL8250);
142 #if CONFIG_CONSOLE_SERIAL8250MEM
143 add_console(header, LB_TAG_CONSOLE_SERIAL8250MEM);
145 #if CONFIG_CONSOLE_LOGBUF
146 add_console(header, LB_TAG_CONSOLE_LOGBUF);
149 add_console(header, LB_TAG_CONSOLE_EHCI);
153 static void lb_framebuffer(struct lb_header *header)
155 #if CONFIG_FRAMEBUFFER_KEEP_VESA_MODE
156 void fill_lb_framebuffer(struct lb_framebuffer *framebuffer);
158 struct lb_framebuffer *framebuffer;
159 framebuffer = (struct lb_framebuffer *)lb_new_record(header);
160 framebuffer->tag = LB_TAG_FRAMEBUFFER;
161 framebuffer->size = sizeof(*framebuffer);
162 fill_lb_framebuffer(framebuffer);
166 static struct lb_mainboard *lb_mainboard(struct lb_header *header)
168 struct lb_record *rec;
169 struct lb_mainboard *mainboard;
170 rec = lb_new_record(header);
171 mainboard = (struct lb_mainboard *)rec;
172 mainboard->tag = LB_TAG_MAINBOARD;
174 mainboard->size = (sizeof(*mainboard) +
175 strlen(mainboard_vendor) + 1 +
176 strlen(mainboard_part_number) + 1 +
179 mainboard->vendor_idx = 0;
180 mainboard->part_number_idx = strlen(mainboard_vendor) + 1;
182 memcpy(mainboard->strings + mainboard->vendor_idx,
183 mainboard_vendor, strlen(mainboard_vendor) + 1);
184 memcpy(mainboard->strings + mainboard->part_number_idx,
185 mainboard_part_number, strlen(mainboard_part_number) + 1);
190 #if (CONFIG_USE_OPTION_TABLE == 1)
191 static struct cmos_checksum *lb_cmos_checksum(struct lb_header *header)
193 struct lb_record *rec;
194 struct cmos_checksum *cmos_checksum;
195 rec = lb_new_record(header);
196 cmos_checksum = (struct cmos_checksum *)rec;
197 cmos_checksum->tag = LB_TAG_OPTION_CHECKSUM;
199 cmos_checksum->size = (sizeof(*cmos_checksum));
201 cmos_checksum->range_start = LB_CKS_RANGE_START * 8;
202 cmos_checksum->range_end = ( LB_CKS_RANGE_END * 8 ) + 7;
203 cmos_checksum->location = LB_CKS_LOC * 8;
204 cmos_checksum->type = CHECKSUM_PCBIOS;
206 return cmos_checksum;
210 static void lb_strings(struct lb_header *header)
212 static const struct {
216 { LB_TAG_VERSION, coreboot_version, },
217 { LB_TAG_EXTRA_VERSION, coreboot_extra_version, },
218 { LB_TAG_BUILD, coreboot_build, },
219 { LB_TAG_COMPILE_TIME, coreboot_compile_time, },
220 { LB_TAG_COMPILE_BY, coreboot_compile_by, },
221 { LB_TAG_COMPILE_HOST, coreboot_compile_host, },
222 { LB_TAG_COMPILE_DOMAIN, coreboot_compile_domain, },
223 { LB_TAG_COMPILER, coreboot_compiler, },
224 { LB_TAG_LINKER, coreboot_linker, },
225 { LB_TAG_ASSEMBLER, coreboot_assembler, },
228 for(i = 0; i < ARRAY_SIZE(strings); i++) {
229 struct lb_string *rec;
231 rec = (struct lb_string *)lb_new_record(header);
232 len = strlen(strings[i].string);
233 rec->tag = strings[i].tag;
234 rec->size = (sizeof(*rec) + len + 1 + 3) & ~3;
235 memcpy(rec->string, strings[i].string, len+1);
240 #if CONFIG_WRITE_HIGH_TABLES == 1
241 static struct lb_forward *lb_forward(struct lb_header *header, struct lb_header *next_header)
243 struct lb_record *rec;
244 struct lb_forward *forward;
245 rec = lb_new_record(header);
246 forward = (struct lb_forward *)rec;
247 forward->tag = LB_TAG_FORWARD;
248 forward->size = sizeof(*forward);
249 forward->forward = (uint64_t)(unsigned long)next_header;
254 void lb_memory_range(struct lb_memory *mem,
255 uint32_t type, uint64_t start, uint64_t size)
258 entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
259 mem->map[entries].start = pack_lb64(start);
260 mem->map[entries].size = pack_lb64(size);
261 mem->map[entries].type = type;
262 mem->size += sizeof(mem->map[0]);
265 static void lb_reserve_table_memory(struct lb_header *head)
267 struct lb_record *last_rec;
268 struct lb_memory *mem;
273 last_rec = lb_last_record(head);
275 start = (unsigned long)head;
276 end = (unsigned long)last_rec;
277 entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
278 /* Resize the right two memory areas so this table is in
279 * a reserved area of memory. Everything has been carefully
280 * setup so that is all we need to do.
282 for(i = 0; i < entries; i++ ) {
283 uint64_t map_start = unpack_lb64(mem->map[i].start);
284 uint64_t map_end = map_start + unpack_lb64(mem->map[i].size);
285 /* Does this area need to be expanded? */
286 if (map_end == start) {
287 mem->map[i].size = pack_lb64(end - map_start);
289 /* Does this area need to be contracted? */
290 else if (map_start == start) {
291 mem->map[i].start = pack_lb64(end);
292 mem->map[i].size = pack_lb64(map_end - end);
297 static unsigned long lb_table_fini(struct lb_header *head, int fixup)
299 struct lb_record *rec, *first_rec;
300 rec = lb_last_record(head);
301 if (head->table_entries) {
302 head->table_bytes += rec->size;
306 lb_reserve_table_memory(head);
308 first_rec = lb_first_record(head);
309 head->table_checksum = compute_ip_checksum(first_rec, head->table_bytes);
310 head->header_checksum = 0;
311 head->header_checksum = compute_ip_checksum(head, sizeof(*head));
312 printk(BIOS_DEBUG, "Wrote coreboot table at: %p - %p checksum %x\n",
313 head, rec, head->table_checksum);
314 return (unsigned long)rec;
317 static void lb_cleanup_memory_ranges(struct lb_memory *mem)
321 entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
323 /* Sort the lb memory ranges */
324 for(i = 0; i < entries; i++) {
325 uint64_t entry_start = unpack_lb64(mem->map[i].start);
326 for(j = i; j < entries; j++) {
327 uint64_t temp_start = unpack_lb64(mem->map[j].start);
328 if (temp_start < entry_start) {
329 struct lb_memory_range tmp;
331 mem->map[i] = mem->map[j];
337 /* Merge adjacent entries */
338 for(i = 0; (i + 1) < entries; i++) {
339 uint64_t start, end, nstart, nend;
340 if (mem->map[i].type != mem->map[i + 1].type) {
343 start = unpack_lb64(mem->map[i].start);
344 end = start + unpack_lb64(mem->map[i].size);
345 nstart = unpack_lb64(mem->map[i + 1].start);
346 nend = nstart + unpack_lb64(mem->map[i + 1].size);
347 if ((start <= nstart) && (end > nstart)) {
348 if (start > nstart) {
354 /* Record the new region size */
355 mem->map[i].start = pack_lb64(start);
356 mem->map[i].size = pack_lb64(end - start);
358 /* Delete the entry I have merged with */
359 memmove(&mem->map[i + 1], &mem->map[i + 2],
360 ((entries - i - 2) * sizeof(mem->map[0])));
361 mem->size -= sizeof(mem->map[0]);
363 /* See if I can merge with the next entry as well */
369 static void lb_remove_memory_range(struct lb_memory *mem,
370 uint64_t start, uint64_t size)
377 entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
379 /* Remove a reserved area from the memory map */
380 for(i = 0; i < entries; i++) {
381 uint64_t map_start = unpack_lb64(mem->map[i].start);
382 uint64_t map_end = map_start + unpack_lb64(mem->map[i].size);
383 if ((start <= map_start) && (end >= map_end)) {
384 /* Remove the completely covered range */
385 memmove(&mem->map[i], &mem->map[i + 1],
386 ((entries - i - 1) * sizeof(mem->map[0])));
387 mem->size -= sizeof(mem->map[0]);
389 /* Since the index will disappear revisit what will appear here */
392 else if ((start > map_start) && (end < map_end)) {
393 /* Split the memory range */
394 memmove(&mem->map[i + 1], &mem->map[i],
395 ((entries - i) * sizeof(mem->map[0])));
396 mem->size += sizeof(mem->map[0]);
398 /* Update the first map entry */
399 mem->map[i].size = pack_lb64(start - map_start);
400 /* Update the second map entry */
401 mem->map[i + 1].start = pack_lb64(end);
402 mem->map[i + 1].size = pack_lb64(map_end - end);
403 /* Don't bother with this map entry again */
406 else if ((start <= map_start) && (end > map_start)) {
407 /* Shrink the start of the memory range */
408 mem->map[i].start = pack_lb64(end);
409 mem->map[i].size = pack_lb64(map_end - end);
411 else if ((start < map_end) && (start > map_start)) {
412 /* Shrink the end of the memory range */
413 mem->map[i].size = pack_lb64(start - map_start);
418 /* This function is used in mainboard specific code, too */
419 void lb_add_memory_range(struct lb_memory *mem,
420 uint32_t type, uint64_t start, uint64_t size)
422 lb_remove_memory_range(mem, start, size);
423 lb_memory_range(mem, type, start, size);
424 lb_cleanup_memory_ranges(mem);
427 static void lb_dump_memory_ranges(struct lb_memory *mem)
431 entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
433 printk(BIOS_DEBUG, "coreboot memory table:\n");
434 for(i = 0; i < entries; i++) {
435 uint64_t entry_start = unpack_lb64(mem->map[i].start);
436 uint64_t entry_size = unpack_lb64(mem->map[i].size);
437 const char *entry_type;
439 switch (mem->map[i].type) {
440 case LB_MEM_RAM: entry_type="RAM"; break;
441 case LB_MEM_RESERVED: entry_type="RESERVED"; break;
442 case LB_MEM_ACPI: entry_type="ACPI"; break;
443 case LB_MEM_NVS: entry_type="NVS"; break;
444 case LB_MEM_UNUSABLE: entry_type="UNUSABLE"; break;
445 case LB_MEM_VENDOR_RSVD: entry_type="VENDOR RESERVED"; break;
446 case LB_MEM_TABLE: entry_type="CONFIGURATION TABLES"; break;
447 default: entry_type="UNKNOWN!"; break;
450 printk(BIOS_DEBUG, "%2d. %016llx-%016llx: %s\n",
451 i, entry_start, entry_start+entry_size-1, entry_type);
457 /* Routines to extract part so the coreboot table or
458 * information from the coreboot table after we have written it.
459 * Currently get_lb_mem relies on a global we can change the
462 static struct lb_memory *mem_ranges = 0;
463 struct lb_memory *get_lb_mem(void)
468 static void build_lb_mem_range(void *gp, struct device *dev, struct resource *res)
470 struct lb_memory *mem = gp;
471 lb_memory_range(mem, LB_MEM_RAM, res->base, res->size);
474 static struct lb_memory *build_lb_mem(struct lb_header *head)
476 struct lb_memory *mem;
478 /* Record where the lb memory ranges will live */
479 mem = lb_memory(head);
482 /* Build the raw table of memory */
483 search_global_resources(
484 IORESOURCE_MEM | IORESOURCE_CACHEABLE, IORESOURCE_MEM | IORESOURCE_CACHEABLE,
485 build_lb_mem_range, mem);
486 lb_cleanup_memory_ranges(mem);
490 static void lb_add_rsvd_range(void *gp, struct device *dev, struct resource *res)
492 struct lb_memory *mem = gp;
493 lb_add_memory_range(mem, LB_MEM_RESERVED, res->base, res->size);
496 static void add_lb_reserved(struct lb_memory *mem)
498 /* Add reserved ranges */
499 search_global_resources(
500 IORESOURCE_MEM | IORESOURCE_RESERVE, IORESOURCE_MEM | IORESOURCE_RESERVE,
501 lb_add_rsvd_range, mem);
504 #if CONFIG_WRITE_HIGH_TABLES == 1
505 extern uint64_t high_tables_base, high_tables_size;
508 unsigned long write_coreboot_table(
509 unsigned long low_table_start, unsigned long low_table_end,
510 unsigned long rom_table_start, unsigned long rom_table_end)
512 struct lb_header *head;
513 struct lb_memory *mem;
515 #if CONFIG_WRITE_HIGH_TABLES == 1
516 printk(BIOS_DEBUG, "Writing high table forward entry at 0x%08lx\n",
518 head = lb_table_init(low_table_end);
519 lb_forward(head, (struct lb_header*)rom_table_end);
521 low_table_end = (unsigned long) lb_table_fini(head, 0);
522 printk(BIOS_DEBUG, "New low_table_end: 0x%08lx\n", low_table_end);
523 printk(BIOS_DEBUG, "Now going to write high coreboot table at 0x%08lx\n",
526 head = lb_table_init(rom_table_end);
527 rom_table_end = (unsigned long)head;
528 printk(BIOS_DEBUG, "rom_table_end = 0x%08lx\n", rom_table_end);
530 if(low_table_end > (0x1000 - sizeof(struct lb_header))) { /* after 4K */
531 /* We need to put lbtable on to [0xf0000,0x100000) */
532 head = lb_table_init(rom_table_end);
533 rom_table_end = (unsigned long)head;
535 head = lb_table_init(low_table_end);
536 low_table_end = (unsigned long)head;
540 printk(BIOS_DEBUG, "Adjust low_table_end from 0x%08lx to ", low_table_end);
541 low_table_end += 0xfff; // 4K aligned
542 low_table_end &= ~0xfff;
543 printk(BIOS_DEBUG, "0x%08lx \n", low_table_end);
545 /* The Linux kernel assumes this region is reserved */
546 printk(BIOS_DEBUG, "Adjust rom_table_end from 0x%08lx to ", rom_table_end);
547 rom_table_end += 0xffff; // 64K align
548 rom_table_end &= ~0xffff;
549 printk(BIOS_DEBUG, "0x%08lx \n", rom_table_end);
551 #if (CONFIG_USE_OPTION_TABLE == 1)
553 struct cmos_option_table *option_table = cbfs_find_file("cmos_layout.bin", 0x1aa);
555 struct lb_record *rec_dest = lb_new_record(head);
556 /* Copy the option config table, it's already a lb_record... */
557 memcpy(rec_dest, option_table, option_table->size);
558 /* Create cmos checksum entry in coreboot table */
559 lb_cmos_checksum(head);
561 printk(BIOS_ERR, "cmos_layout.bin could not be found!\n");
565 /* Record where RAM is located */
566 mem = build_lb_mem(head);
568 /* Record the mptable and the the lb_table (This will be adjusted later) */
569 lb_add_memory_range(mem, LB_MEM_TABLE,
570 low_table_start, low_table_end - low_table_start);
572 /* Record the pirq table, acpi tables, and maybe the mptable */
573 lb_add_memory_range(mem, LB_MEM_TABLE,
574 rom_table_start, rom_table_end-rom_table_start);
576 #if CONFIG_WRITE_HIGH_TABLES == 1
577 printk(BIOS_DEBUG, "Adding high table area\n");
578 // should this be LB_MEM_ACPI?
579 lb_add_memory_range(mem, LB_MEM_TABLE,
580 high_tables_base, high_tables_size);
583 /* Add reserved regions */
584 add_lb_reserved(mem);
586 #if (CONFIG_HAVE_MAINBOARD_RESOURCES == 1)
587 add_mainboard_resources(mem);
590 lb_dump_memory_ranges(mem);
593 * I assume that there is always memory at immediately after
594 * the low_table_end. This means that after I setup the coreboot table.
595 * I can trivially fixup the reserved memory ranges to hold the correct
596 * size of the coreboot table.
599 /* Record our motherboard */
601 /* Record the serial port, if present */
603 /* Record our console setup */
605 /* Record our various random string information */
607 /* Record our framebuffer */
608 lb_framebuffer(head);
610 /* Remember where my valid memory ranges are */
611 return lb_table_fini(head, 1);