src/arch/i386/boot/coreboot_table.c

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