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