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