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>
36 static struct lb_header *lb_table_init(unsigned long addr)
38 struct lb_header *header;
40 /* 16 byte align the address */
44 header = (void *)addr;
45 header->signature[0] = 'L';
46 header->signature[1] = 'B';
47 header->signature[2] = 'I';
48 header->signature[3] = 'O';
49 header->header_bytes = sizeof(*header);
50 header->header_checksum = 0;
51 header->table_bytes = 0;
52 header->table_checksum = 0;
53 header->table_entries = 0;
57 static struct lb_record *lb_first_record(struct lb_header *header)
59 struct lb_record *rec;
60 rec = (void *)(((char *)header) + sizeof(*header));
64 static struct lb_record *lb_last_record(struct lb_header *header)
66 struct lb_record *rec;
67 rec = (void *)(((char *)header) + sizeof(*header) + header->table_bytes);
72 static struct lb_record *lb_next_record(struct lb_record *rec)
74 rec = (void *)(((char *)rec) + rec->size);
79 static struct lb_record *lb_new_record(struct lb_header *header)
81 struct lb_record *rec;
82 rec = lb_last_record(header);
83 if (header->table_entries) {
84 header->table_bytes += rec->size;
86 rec = lb_last_record(header);
87 header->table_entries++;
88 rec->tag = LB_TAG_UNUSED;
89 rec->size = sizeof(*rec);
94 static struct lb_memory *lb_memory(struct lb_header *header)
96 struct lb_record *rec;
97 struct lb_memory *mem;
98 rec = lb_new_record(header);
99 mem = (struct lb_memory *)rec;
100 mem->tag = LB_TAG_MEMORY;
101 mem->size = sizeof(*mem);
105 static struct lb_serial *lb_serial(struct lb_header *header)
107 #if CONFIG_CONSOLE_SERIAL8250
108 struct lb_record *rec;
109 struct lb_serial *serial;
110 rec = lb_new_record(header);
111 serial = (struct lb_serial *)rec;
112 serial->tag = LB_TAG_SERIAL;
113 serial->size = sizeof(*serial);
114 serial->ioport = CONFIG_TTYS0_BASE;
115 serial->baud = CONFIG_TTYS0_BAUD;
122 static void add_console(struct lb_header *header, u16 consoletype)
124 struct lb_console *console;
126 console = (struct lb_console *)lb_new_record(header);
127 console->tag = LB_TAG_CONSOLE;
128 console->size = sizeof(*console);
129 console->type = consoletype;
132 static void lb_console(struct lb_header *header)
134 #if CONFIG_CONSOLE_SERIAL8250
135 add_console(header, LB_TAG_CONSOLE_SERIAL8250);
137 #if CONFIG_CONSOLE_VGA
138 add_console(header, LB_TAG_CONSOLE_VGA);
140 #if CONFIG_CONSOLE_BTEXT
141 add_console(header, LB_TAG_CONSOLE_BTEXT);
143 #if CONFIG_CONSOLE_LOGBUF
144 add_console(header, LB_TAG_CONSOLE_LOGBUF);
146 #if CONFIG_CONSOLE_SROM
147 add_console(header, LB_TAG_CONSOLE_SROM);
150 add_console(header, LB_TAG_CONSOLE_EHCI);
154 static void lb_framebuffer(struct lb_header *header)
156 #if defined(CONFIG_BOOTSPLASH) && CONFIG_BOOTSPLASH && CONFIG_COREBOOT_KEEP_FRAMEBUFFER
157 void fill_lb_framebuffer(struct lb_framebuffer *framebuffer);
159 struct lb_framebuffer *framebuffer;
160 framebuffer = (struct lb_framebuffer *)lb_new_record(header);
161 framebuffer->tag = LB_TAG_FRAMEBUFFER;
162 framebuffer->size = sizeof(*framebuffer);
163 fill_lb_framebuffer(framebuffer);
167 static struct lb_mainboard *lb_mainboard(struct lb_header *header)
169 struct lb_record *rec;
170 struct lb_mainboard *mainboard;
171 rec = lb_new_record(header);
172 mainboard = (struct lb_mainboard *)rec;
173 mainboard->tag = LB_TAG_MAINBOARD;
175 mainboard->size = (sizeof(*mainboard) +
176 strlen(mainboard_vendor) + 1 +
177 strlen(mainboard_part_number) + 1 +
180 mainboard->vendor_idx = 0;
181 mainboard->part_number_idx = strlen(mainboard_vendor) + 1;
183 memcpy(mainboard->strings + mainboard->vendor_idx,
184 mainboard_vendor, strlen(mainboard_vendor) + 1);
185 memcpy(mainboard->strings + mainboard->part_number_idx,
186 mainboard_part_number, strlen(mainboard_part_number) + 1);
191 #if (CONFIG_USE_OPTION_TABLE == 1)
192 static struct cmos_checksum *lb_cmos_checksum(struct lb_header *header)
194 struct lb_record *rec;
195 struct cmos_checksum *cmos_checksum;
196 rec = lb_new_record(header);
197 cmos_checksum = (struct cmos_checksum *)rec;
198 cmos_checksum->tag = LB_TAG_OPTION_CHECKSUM;
200 cmos_checksum->size = (sizeof(*cmos_checksum));
202 cmos_checksum->range_start = LB_CKS_RANGE_START * 8;
203 cmos_checksum->range_end = ( LB_CKS_RANGE_END * 8 ) + 7;
204 cmos_checksum->location = LB_CKS_LOC * 8;
205 cmos_checksum->type = CHECKSUM_PCBIOS;
207 return cmos_checksum;
211 static void lb_strings(struct lb_header *header)
213 static const struct {
217 { LB_TAG_VERSION, coreboot_version, },
218 { LB_TAG_EXTRA_VERSION, coreboot_extra_version, },
219 { LB_TAG_BUILD, coreboot_build, },
220 { LB_TAG_COMPILE_TIME, coreboot_compile_time, },
221 { LB_TAG_COMPILE_BY, coreboot_compile_by, },
222 { LB_TAG_COMPILE_HOST, coreboot_compile_host, },
223 { LB_TAG_COMPILE_DOMAIN, coreboot_compile_domain, },
224 { LB_TAG_COMPILER, coreboot_compiler, },
225 { LB_TAG_LINKER, coreboot_linker, },
226 { LB_TAG_ASSEMBLER, coreboot_assembler, },
229 for(i = 0; i < ARRAY_SIZE(strings); i++) {
230 struct lb_string *rec;
232 rec = (struct lb_string *)lb_new_record(header);
233 len = strlen(strings[i].string);
234 rec->tag = strings[i].tag;
235 rec->size = (sizeof(*rec) + len + 1 + 3) & ~3;
236 memcpy(rec->string, strings[i].string, len+1);
241 #if CONFIG_WRITE_HIGH_TABLES == 1
242 static struct lb_forward *lb_forward(struct lb_header *header, struct lb_header *next_header)
244 struct lb_record *rec;
245 struct lb_forward *forward;
246 rec = lb_new_record(header);
247 forward = (struct lb_forward *)rec;
248 forward->tag = LB_TAG_FORWARD;
249 forward->size = sizeof(*forward);
250 forward->forward = (uint64_t)(unsigned long)next_header;
255 void lb_memory_range(struct lb_memory *mem,
256 uint32_t type, uint64_t start, uint64_t size)
259 entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
260 mem->map[entries].start = pack_lb64(start);
261 mem->map[entries].size = pack_lb64(size);
262 mem->map[entries].type = type;
263 mem->size += sizeof(mem->map[0]);
266 static void lb_reserve_table_memory(struct lb_header *head)
268 struct lb_record *last_rec;
269 struct lb_memory *mem;
274 last_rec = lb_last_record(head);
276 start = (unsigned long)head;
277 end = (unsigned long)last_rec;
278 entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
279 /* Resize the right two memory areas so this table is in
280 * a reserved area of memory. Everything has been carefully
281 * setup so that is all we need to do.
283 for(i = 0; i < entries; i++ ) {
284 uint64_t map_start = unpack_lb64(mem->map[i].start);
285 uint64_t map_end = map_start + unpack_lb64(mem->map[i].size);
286 /* Does this area need to be expanded? */
287 if (map_end == start) {
288 mem->map[i].size = pack_lb64(end - map_start);
290 /* Does this area need to be contracted? */
291 else if (map_start == start) {
292 mem->map[i].start = pack_lb64(end);
293 mem->map[i].size = pack_lb64(map_end - end);
298 static unsigned long lb_table_fini(struct lb_header *head, int fixup)
300 struct lb_record *rec, *first_rec;
301 rec = lb_last_record(head);
302 if (head->table_entries) {
303 head->table_bytes += rec->size;
307 lb_reserve_table_memory(head);
309 first_rec = lb_first_record(head);
310 head->table_checksum = compute_ip_checksum(first_rec, head->table_bytes);
311 head->header_checksum = 0;
312 head->header_checksum = compute_ip_checksum(head, sizeof(*head));
313 printk(BIOS_DEBUG, "Wrote coreboot table at: %p - %p checksum %x\n",
314 head, rec, head->table_checksum);
315 return (unsigned long)rec;
318 static void lb_cleanup_memory_ranges(struct lb_memory *mem)
322 entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
324 /* Sort the lb memory ranges */
325 for(i = 0; i < entries; i++) {
326 uint64_t entry_start = unpack_lb64(mem->map[i].start);
327 for(j = i; j < entries; j++) {
328 uint64_t temp_start = unpack_lb64(mem->map[j].start);
329 if (temp_start < entry_start) {
330 struct lb_memory_range tmp;
332 mem->map[i] = mem->map[j];
338 /* Merge adjacent entries */
339 for(i = 0; (i + 1) < entries; i++) {
340 uint64_t start, end, nstart, nend;
341 if (mem->map[i].type != mem->map[i + 1].type) {
344 start = unpack_lb64(mem->map[i].start);
345 end = start + unpack_lb64(mem->map[i].size);
346 nstart = unpack_lb64(mem->map[i + 1].start);
347 nend = nstart + unpack_lb64(mem->map[i + 1].size);
348 if ((start <= nstart) && (end > nstart)) {
349 if (start > nstart) {
355 /* Record the new region size */
356 mem->map[i].start = pack_lb64(start);
357 mem->map[i].size = pack_lb64(end - start);
359 /* Delete the entry I have merged with */
360 memmove(&mem->map[i + 1], &mem->map[i + 2],
361 ((entries - i - 2) * sizeof(mem->map[0])));
362 mem->size -= sizeof(mem->map[0]);
364 /* See if I can merge with the next entry as well */
370 static void lb_remove_memory_range(struct lb_memory *mem,
371 uint64_t start, uint64_t size)
378 entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
380 /* Remove a reserved area from the memory map */
381 for(i = 0; i < entries; i++) {
382 uint64_t map_start = unpack_lb64(mem->map[i].start);
383 uint64_t map_end = map_start + unpack_lb64(mem->map[i].size);
384 if ((start <= map_start) && (end >= map_end)) {
385 /* Remove the completely covered range */
386 memmove(&mem->map[i], &mem->map[i + 1],
387 ((entries - i - 1) * sizeof(mem->map[0])));
388 mem->size -= sizeof(mem->map[0]);
390 /* Since the index will disappear revisit what will appear here */
393 else if ((start > map_start) && (end < map_end)) {
394 /* Split the memory range */
395 memmove(&mem->map[i + 1], &mem->map[i],
396 ((entries - i) * sizeof(mem->map[0])));
397 mem->size += sizeof(mem->map[0]);
399 /* Update the first map entry */
400 mem->map[i].size = pack_lb64(start - map_start);
401 /* Update the second map entry */
402 mem->map[i + 1].start = pack_lb64(end);
403 mem->map[i + 1].size = pack_lb64(map_end - end);
404 /* Don't bother with this map entry again */
407 else if ((start <= map_start) && (end > map_start)) {
408 /* Shrink the start of the memory range */
409 mem->map[i].start = pack_lb64(end);
410 mem->map[i].size = pack_lb64(map_end - end);
412 else if ((start < map_end) && (start > map_start)) {
413 /* Shrink the end of the memory range */
414 mem->map[i].size = pack_lb64(start - map_start);
419 /* This function is used in mainboard specific code, too */
420 void lb_add_memory_range(struct lb_memory *mem,
421 uint32_t type, uint64_t start, uint64_t size)
423 lb_remove_memory_range(mem, start, size);
424 lb_memory_range(mem, type, start, size);
425 lb_cleanup_memory_ranges(mem);
428 static void lb_dump_memory_ranges(struct lb_memory *mem)
432 entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
434 printk(BIOS_DEBUG, "coreboot memory table:\n");
435 for(i = 0; i < entries; i++) {
436 uint64_t entry_start = unpack_lb64(mem->map[i].start);
437 uint64_t entry_size = unpack_lb64(mem->map[i].size);
438 const char *entry_type;
440 switch (mem->map[i].type) {
441 case LB_MEM_RAM: entry_type="RAM"; break;
442 case LB_MEM_RESERVED: entry_type="RESERVED"; break;
443 case LB_MEM_ACPI: entry_type="ACPI"; break;
444 case LB_MEM_NVS: entry_type="NVS"; break;
445 case LB_MEM_UNUSABLE: entry_type="UNUSABLE"; break;
446 case LB_MEM_VENDOR_RSVD: entry_type="VENDOR RESERVED"; break;
447 case LB_MEM_TABLE: entry_type="CONFIGURATION TABLES"; break;
448 default: entry_type="UNKNOWN!"; break;
451 printk(BIOS_DEBUG, "%2d. %016llx-%016llx: %s\n",
452 i, entry_start, entry_start+entry_size-1, entry_type);
458 /* Routines to extract part so the coreboot table or
459 * information from the coreboot table after we have written it.
460 * Currently get_lb_mem relies on a global we can change the
463 static struct lb_memory *mem_ranges = 0;
464 struct lb_memory *get_lb_mem(void)
469 static void build_lb_mem_range(void *gp, struct device *dev, struct resource *res)
471 struct lb_memory *mem = gp;
472 lb_memory_range(mem, LB_MEM_RAM, res->base, res->size);
475 static struct lb_memory *build_lb_mem(struct lb_header *head)
477 struct lb_memory *mem;
479 /* Record where the lb memory ranges will live */
480 mem = lb_memory(head);
483 /* Build the raw table of memory */
484 search_global_resources(
485 IORESOURCE_MEM | IORESOURCE_CACHEABLE, IORESOURCE_MEM | IORESOURCE_CACHEABLE,
486 build_lb_mem_range, mem);
487 lb_cleanup_memory_ranges(mem);
491 static void lb_add_rsvd_range(void *gp, struct device *dev, struct resource *res)
493 struct lb_memory *mem = gp;
494 lb_add_memory_range(mem, LB_MEM_RESERVED, res->base, res->size);
497 static void add_lb_reserved(struct lb_memory *mem)
499 /* Add reserved ranges */
500 search_global_resources(
501 IORESOURCE_MEM | IORESOURCE_RESERVE, IORESOURCE_MEM | IORESOURCE_RESERVE,
502 lb_add_rsvd_range, mem);
505 #if CONFIG_WRITE_HIGH_TABLES == 1
506 extern uint64_t high_tables_base, high_tables_size;
509 unsigned long write_coreboot_table(
510 unsigned long low_table_start, unsigned long low_table_end,
511 unsigned long rom_table_start, unsigned long rom_table_end)
513 struct lb_header *head;
514 struct lb_memory *mem;
516 #if CONFIG_WRITE_HIGH_TABLES == 1
517 printk(BIOS_DEBUG, "Writing high table forward entry at 0x%08lx\n",
519 head = lb_table_init(low_table_end);
520 lb_forward(head, (struct lb_header*)rom_table_end);
522 low_table_end = (unsigned long) lb_table_fini(head, 0);
523 printk(BIOS_DEBUG, "New low_table_end: 0x%08lx\n", low_table_end);
524 printk(BIOS_DEBUG, "Now going to write high coreboot table at 0x%08lx\n",
527 head = lb_table_init(rom_table_end);
528 rom_table_end = (unsigned long)head;
529 printk(BIOS_DEBUG, "rom_table_end = 0x%08lx\n", rom_table_end);
531 if(low_table_end > (0x1000 - sizeof(struct lb_header))) { /* after 4K */
532 /* We need to put lbtable on to [0xf0000,0x100000) */
533 head = lb_table_init(rom_table_end);
534 rom_table_end = (unsigned long)head;
536 head = lb_table_init(low_table_end);
537 low_table_end = (unsigned long)head;
541 printk(BIOS_DEBUG, "Adjust low_table_end from 0x%08lx to ", low_table_end);
542 low_table_end += 0xfff; // 4K aligned
543 low_table_end &= ~0xfff;
544 printk(BIOS_DEBUG, "0x%08lx \n", low_table_end);
546 /* The Linux kernel assumes this region is reserved */
547 printk(BIOS_DEBUG, "Adjust rom_table_end from 0x%08lx to ", rom_table_end);
548 rom_table_end += 0xffff; // 64K align
549 rom_table_end &= ~0xffff;
550 printk(BIOS_DEBUG, "0x%08lx \n", rom_table_end);
552 #if (CONFIG_USE_OPTION_TABLE == 1)
554 struct lb_record *rec_dest = lb_new_record(head);
555 /* Copy the option config table, it's already a lb_record... */
556 memcpy(rec_dest, &option_table, option_table.size);
557 /* Create cmos checksum entry in coreboot table */
558 lb_cmos_checksum(head);
561 /* Record where RAM is located */
562 mem = build_lb_mem(head);
564 /* Record the mptable and the the lb_table (This will be adjusted later) */
565 lb_add_memory_range(mem, LB_MEM_TABLE,
566 low_table_start, low_table_end - low_table_start);
568 /* Record the pirq table, acpi tables, and maybe the mptable */
569 lb_add_memory_range(mem, LB_MEM_TABLE,
570 rom_table_start, rom_table_end-rom_table_start);
572 #if CONFIG_WRITE_HIGH_TABLES == 1
573 printk(BIOS_DEBUG, "Adding high table area\n");
574 // should this be LB_MEM_ACPI?
575 lb_add_memory_range(mem, LB_MEM_TABLE,
576 high_tables_base, high_tables_size);
579 /* Add reserved regions */
580 add_lb_reserved(mem);
582 #if (CONFIG_HAVE_MAINBOARD_RESOURCES == 1)
583 add_mainboard_resources(mem);
586 lb_dump_memory_ranges(mem);
589 * I assume that there is always memory at immediately after
590 * the low_table_end. This means that after I setup the coreboot table.
591 * I can trivially fixup the reserved memory ranges to hold the correct
592 * size of the coreboot table.
595 /* Record our motherboard */
597 /* Record the serial port, if present */
599 /* Record our console setup */
601 /* Record our various random string information */
603 /* Record our framebuffer */
604 lb_framebuffer(head);
606 /* Remember where my valid memory ranges are */
607 return lb_table_fini(head, 1);