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