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