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