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 static void add_console(struct lb_header *header, u16 consoletype)
125 struct lb_console *console;
127 console = (struct lb_console *)lb_new_record(header);
128 console->tag = LB_TAG_CONSOLE;
129 console->size = sizeof(*console);
130 console->type = consoletype;
133 static void lb_console(struct lb_header *header)
135 #if CONFIG_CONSOLE_SERIAL8250
136 add_console(header, LB_TAG_CONSOLE_SERIAL8250);
138 #if CONFIG_CONSOLE_LOGBUF
139 add_console(header, LB_TAG_CONSOLE_LOGBUF);
142 add_console(header, LB_TAG_CONSOLE_EHCI);
146 static void lb_framebuffer(struct lb_header *header)
148 #if defined(CONFIG_BOOTSPLASH) && CONFIG_BOOTSPLASH && CONFIG_COREBOOT_KEEP_FRAMEBUFFER
149 void fill_lb_framebuffer(struct lb_framebuffer *framebuffer);
151 struct lb_framebuffer *framebuffer;
152 framebuffer = (struct lb_framebuffer *)lb_new_record(header);
153 framebuffer->tag = LB_TAG_FRAMEBUFFER;
154 framebuffer->size = sizeof(*framebuffer);
155 fill_lb_framebuffer(framebuffer);
159 static struct lb_mainboard *lb_mainboard(struct lb_header *header)
161 struct lb_record *rec;
162 struct lb_mainboard *mainboard;
163 rec = lb_new_record(header);
164 mainboard = (struct lb_mainboard *)rec;
165 mainboard->tag = LB_TAG_MAINBOARD;
167 mainboard->size = (sizeof(*mainboard) +
168 strlen(mainboard_vendor) + 1 +
169 strlen(mainboard_part_number) + 1 +
172 mainboard->vendor_idx = 0;
173 mainboard->part_number_idx = strlen(mainboard_vendor) + 1;
175 memcpy(mainboard->strings + mainboard->vendor_idx,
176 mainboard_vendor, strlen(mainboard_vendor) + 1);
177 memcpy(mainboard->strings + mainboard->part_number_idx,
178 mainboard_part_number, strlen(mainboard_part_number) + 1);
183 #if (CONFIG_USE_OPTION_TABLE == 1)
184 static struct cmos_checksum *lb_cmos_checksum(struct lb_header *header)
186 struct lb_record *rec;
187 struct cmos_checksum *cmos_checksum;
188 rec = lb_new_record(header);
189 cmos_checksum = (struct cmos_checksum *)rec;
190 cmos_checksum->tag = LB_TAG_OPTION_CHECKSUM;
192 cmos_checksum->size = (sizeof(*cmos_checksum));
194 cmos_checksum->range_start = LB_CKS_RANGE_START * 8;
195 cmos_checksum->range_end = ( LB_CKS_RANGE_END * 8 ) + 7;
196 cmos_checksum->location = LB_CKS_LOC * 8;
197 cmos_checksum->type = CHECKSUM_PCBIOS;
199 return cmos_checksum;
203 static void lb_strings(struct lb_header *header)
205 static const struct {
209 { LB_TAG_VERSION, coreboot_version, },
210 { LB_TAG_EXTRA_VERSION, coreboot_extra_version, },
211 { LB_TAG_BUILD, coreboot_build, },
212 { LB_TAG_COMPILE_TIME, coreboot_compile_time, },
213 { LB_TAG_COMPILE_BY, coreboot_compile_by, },
214 { LB_TAG_COMPILE_HOST, coreboot_compile_host, },
215 { LB_TAG_COMPILE_DOMAIN, coreboot_compile_domain, },
216 { LB_TAG_COMPILER, coreboot_compiler, },
217 { LB_TAG_LINKER, coreboot_linker, },
218 { LB_TAG_ASSEMBLER, coreboot_assembler, },
221 for(i = 0; i < ARRAY_SIZE(strings); i++) {
222 struct lb_string *rec;
224 rec = (struct lb_string *)lb_new_record(header);
225 len = strlen(strings[i].string);
226 rec->tag = strings[i].tag;
227 rec->size = (sizeof(*rec) + len + 1 + 3) & ~3;
228 memcpy(rec->string, strings[i].string, len+1);
233 #if CONFIG_WRITE_HIGH_TABLES == 1
234 static struct lb_forward *lb_forward(struct lb_header *header, struct lb_header *next_header)
236 struct lb_record *rec;
237 struct lb_forward *forward;
238 rec = lb_new_record(header);
239 forward = (struct lb_forward *)rec;
240 forward->tag = LB_TAG_FORWARD;
241 forward->size = sizeof(*forward);
242 forward->forward = (uint64_t)(unsigned long)next_header;
247 void lb_memory_range(struct lb_memory *mem,
248 uint32_t type, uint64_t start, uint64_t size)
251 entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
252 mem->map[entries].start = pack_lb64(start);
253 mem->map[entries].size = pack_lb64(size);
254 mem->map[entries].type = type;
255 mem->size += sizeof(mem->map[0]);
258 static void lb_reserve_table_memory(struct lb_header *head)
260 struct lb_record *last_rec;
261 struct lb_memory *mem;
266 last_rec = lb_last_record(head);
268 start = (unsigned long)head;
269 end = (unsigned long)last_rec;
270 entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
271 /* Resize the right two memory areas so this table is in
272 * a reserved area of memory. Everything has been carefully
273 * setup so that is all we need to do.
275 for(i = 0; i < entries; i++ ) {
276 uint64_t map_start = unpack_lb64(mem->map[i].start);
277 uint64_t map_end = map_start + unpack_lb64(mem->map[i].size);
278 /* Does this area need to be expanded? */
279 if (map_end == start) {
280 mem->map[i].size = pack_lb64(end - map_start);
282 /* Does this area need to be contracted? */
283 else if (map_start == start) {
284 mem->map[i].start = pack_lb64(end);
285 mem->map[i].size = pack_lb64(map_end - end);
290 static unsigned long lb_table_fini(struct lb_header *head, int fixup)
292 struct lb_record *rec, *first_rec;
293 rec = lb_last_record(head);
294 if (head->table_entries) {
295 head->table_bytes += rec->size;
299 lb_reserve_table_memory(head);
301 first_rec = lb_first_record(head);
302 head->table_checksum = compute_ip_checksum(first_rec, head->table_bytes);
303 head->header_checksum = 0;
304 head->header_checksum = compute_ip_checksum(head, sizeof(*head));
305 printk(BIOS_DEBUG, "Wrote coreboot table at: %p - %p checksum %x\n",
306 head, rec, head->table_checksum);
307 return (unsigned long)rec;
310 static void lb_cleanup_memory_ranges(struct lb_memory *mem)
314 entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
316 /* Sort the lb memory ranges */
317 for(i = 0; i < entries; i++) {
318 uint64_t entry_start = unpack_lb64(mem->map[i].start);
319 for(j = i; j < entries; j++) {
320 uint64_t temp_start = unpack_lb64(mem->map[j].start);
321 if (temp_start < entry_start) {
322 struct lb_memory_range tmp;
324 mem->map[i] = mem->map[j];
330 /* Merge adjacent entries */
331 for(i = 0; (i + 1) < entries; i++) {
332 uint64_t start, end, nstart, nend;
333 if (mem->map[i].type != mem->map[i + 1].type) {
336 start = unpack_lb64(mem->map[i].start);
337 end = start + unpack_lb64(mem->map[i].size);
338 nstart = unpack_lb64(mem->map[i + 1].start);
339 nend = nstart + unpack_lb64(mem->map[i + 1].size);
340 if ((start <= nstart) && (end > nstart)) {
341 if (start > nstart) {
347 /* Record the new region size */
348 mem->map[i].start = pack_lb64(start);
349 mem->map[i].size = pack_lb64(end - start);
351 /* Delete the entry I have merged with */
352 memmove(&mem->map[i + 1], &mem->map[i + 2],
353 ((entries - i - 2) * sizeof(mem->map[0])));
354 mem->size -= sizeof(mem->map[0]);
356 /* See if I can merge with the next entry as well */
362 static void lb_remove_memory_range(struct lb_memory *mem,
363 uint64_t start, uint64_t size)
370 entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
372 /* Remove a reserved area from the memory map */
373 for(i = 0; i < entries; i++) {
374 uint64_t map_start = unpack_lb64(mem->map[i].start);
375 uint64_t map_end = map_start + unpack_lb64(mem->map[i].size);
376 if ((start <= map_start) && (end >= map_end)) {
377 /* Remove the completely covered range */
378 memmove(&mem->map[i], &mem->map[i + 1],
379 ((entries - i - 1) * sizeof(mem->map[0])));
380 mem->size -= sizeof(mem->map[0]);
382 /* Since the index will disappear revisit what will appear here */
385 else if ((start > map_start) && (end < map_end)) {
386 /* Split the memory range */
387 memmove(&mem->map[i + 1], &mem->map[i],
388 ((entries - i) * sizeof(mem->map[0])));
389 mem->size += sizeof(mem->map[0]);
391 /* Update the first map entry */
392 mem->map[i].size = pack_lb64(start - map_start);
393 /* Update the second map entry */
394 mem->map[i + 1].start = pack_lb64(end);
395 mem->map[i + 1].size = pack_lb64(map_end - end);
396 /* Don't bother with this map entry again */
399 else if ((start <= map_start) && (end > map_start)) {
400 /* Shrink the start of the memory range */
401 mem->map[i].start = pack_lb64(end);
402 mem->map[i].size = pack_lb64(map_end - end);
404 else if ((start < map_end) && (start > map_start)) {
405 /* Shrink the end of the memory range */
406 mem->map[i].size = pack_lb64(start - map_start);
411 /* This function is used in mainboard specific code, too */
412 void lb_add_memory_range(struct lb_memory *mem,
413 uint32_t type, uint64_t start, uint64_t size)
415 lb_remove_memory_range(mem, start, size);
416 lb_memory_range(mem, type, start, size);
417 lb_cleanup_memory_ranges(mem);
420 static void lb_dump_memory_ranges(struct lb_memory *mem)
424 entries = (mem->size - sizeof(*mem))/sizeof(mem->map[0]);
426 printk(BIOS_DEBUG, "coreboot memory table:\n");
427 for(i = 0; i < entries; i++) {
428 uint64_t entry_start = unpack_lb64(mem->map[i].start);
429 uint64_t entry_size = unpack_lb64(mem->map[i].size);
430 const char *entry_type;
432 switch (mem->map[i].type) {
433 case LB_MEM_RAM: entry_type="RAM"; break;
434 case LB_MEM_RESERVED: entry_type="RESERVED"; break;
435 case LB_MEM_ACPI: entry_type="ACPI"; break;
436 case LB_MEM_NVS: entry_type="NVS"; break;
437 case LB_MEM_UNUSABLE: entry_type="UNUSABLE"; break;
438 case LB_MEM_VENDOR_RSVD: entry_type="VENDOR RESERVED"; break;
439 case LB_MEM_TABLE: entry_type="CONFIGURATION TABLES"; break;
440 default: entry_type="UNKNOWN!"; break;
443 printk(BIOS_DEBUG, "%2d. %016llx-%016llx: %s\n",
444 i, entry_start, entry_start+entry_size-1, entry_type);
450 /* Routines to extract part so the coreboot table or
451 * information from the coreboot table after we have written it.
452 * Currently get_lb_mem relies on a global we can change the
455 static struct lb_memory *mem_ranges = 0;
456 struct lb_memory *get_lb_mem(void)
461 static void build_lb_mem_range(void *gp, struct device *dev, struct resource *res)
463 struct lb_memory *mem = gp;
464 lb_memory_range(mem, LB_MEM_RAM, res->base, res->size);
467 static struct lb_memory *build_lb_mem(struct lb_header *head)
469 struct lb_memory *mem;
471 /* Record where the lb memory ranges will live */
472 mem = lb_memory(head);
475 /* Build the raw table of memory */
476 search_global_resources(
477 IORESOURCE_MEM | IORESOURCE_CACHEABLE, IORESOURCE_MEM | IORESOURCE_CACHEABLE,
478 build_lb_mem_range, mem);
479 lb_cleanup_memory_ranges(mem);
483 static void lb_add_rsvd_range(void *gp, struct device *dev, struct resource *res)
485 struct lb_memory *mem = gp;
486 lb_add_memory_range(mem, LB_MEM_RESERVED, res->base, res->size);
489 static void add_lb_reserved(struct lb_memory *mem)
491 /* Add reserved ranges */
492 search_global_resources(
493 IORESOURCE_MEM | IORESOURCE_RESERVE, IORESOURCE_MEM | IORESOURCE_RESERVE,
494 lb_add_rsvd_range, mem);
497 #if CONFIG_WRITE_HIGH_TABLES == 1
498 extern uint64_t high_tables_base, high_tables_size;
501 unsigned long write_coreboot_table(
502 unsigned long low_table_start, unsigned long low_table_end,
503 unsigned long rom_table_start, unsigned long rom_table_end)
505 struct lb_header *head;
506 struct lb_memory *mem;
508 #if CONFIG_WRITE_HIGH_TABLES == 1
509 printk(BIOS_DEBUG, "Writing high table forward entry at 0x%08lx\n",
511 head = lb_table_init(low_table_end);
512 lb_forward(head, (struct lb_header*)rom_table_end);
514 low_table_end = (unsigned long) lb_table_fini(head, 0);
515 printk(BIOS_DEBUG, "New low_table_end: 0x%08lx\n", low_table_end);
516 printk(BIOS_DEBUG, "Now going to write high coreboot table at 0x%08lx\n",
519 head = lb_table_init(rom_table_end);
520 rom_table_end = (unsigned long)head;
521 printk(BIOS_DEBUG, "rom_table_end = 0x%08lx\n", rom_table_end);
523 if(low_table_end > (0x1000 - sizeof(struct lb_header))) { /* after 4K */
524 /* We need to put lbtable on to [0xf0000,0x100000) */
525 head = lb_table_init(rom_table_end);
526 rom_table_end = (unsigned long)head;
528 head = lb_table_init(low_table_end);
529 low_table_end = (unsigned long)head;
533 printk(BIOS_DEBUG, "Adjust low_table_end from 0x%08lx to ", low_table_end);
534 low_table_end += 0xfff; // 4K aligned
535 low_table_end &= ~0xfff;
536 printk(BIOS_DEBUG, "0x%08lx \n", low_table_end);
538 /* The Linux kernel assumes this region is reserved */
539 printk(BIOS_DEBUG, "Adjust rom_table_end from 0x%08lx to ", rom_table_end);
540 rom_table_end += 0xffff; // 64K align
541 rom_table_end &= ~0xffff;
542 printk(BIOS_DEBUG, "0x%08lx \n", rom_table_end);
544 #if (CONFIG_USE_OPTION_TABLE == 1)
546 struct cmos_option_table *option_table = cbfs_find_file("cmos_layout.bin", 0x1aa);
548 struct lb_record *rec_dest = lb_new_record(head);
549 /* Copy the option config table, it's already a lb_record... */
550 memcpy(rec_dest, &option_table, option_table->size);
551 /* Create cmos checksum entry in coreboot table */
552 lb_cmos_checksum(head);
554 printk(BIOS_ERR, "cmos_layout.bin could not be found!\n");
558 /* Record where RAM is located */
559 mem = build_lb_mem(head);
561 /* Record the mptable and the the lb_table (This will be adjusted later) */
562 lb_add_memory_range(mem, LB_MEM_TABLE,
563 low_table_start, low_table_end - low_table_start);
565 /* Record the pirq table, acpi tables, and maybe the mptable */
566 lb_add_memory_range(mem, LB_MEM_TABLE,
567 rom_table_start, rom_table_end-rom_table_start);
569 #if CONFIG_WRITE_HIGH_TABLES == 1
570 printk(BIOS_DEBUG, "Adding high table area\n");
571 // should this be LB_MEM_ACPI?
572 lb_add_memory_range(mem, LB_MEM_TABLE,
573 high_tables_base, high_tables_size);
576 /* Add reserved regions */
577 add_lb_reserved(mem);
579 #if (CONFIG_HAVE_MAINBOARD_RESOURCES == 1)
580 add_mainboard_resources(mem);
583 lb_dump_memory_ranges(mem);
586 * I assume that there is always memory at immediately after
587 * the low_table_end. This means that after I setup the coreboot table.
588 * I can trivially fixup the reserved memory ranges to hold the correct
589 * size of the coreboot table.
592 /* Record our motherboard */
594 /* Record the serial port, if present */
596 /* Record our console setup */
598 /* Record our various random string information */
600 /* Record our framebuffer */
601 lb_framebuffer(head);
603 /* Remember where my valid memory ranges are */
604 return lb_table_fini(head, 1);