src/optionroms.c

   1 // Option rom scanning code.
   2 //
   3 // Copyright (C) 2008  Kevin O'Connor <kevin@koconnor.net>
   4 // Copyright (C) 2002  MandrakeSoft S.A.
   5 //
   6 // This file may be distributed under the terms of the GNU LGPLv3 license.
   7
   8 #include "bregs.h" // struct bregs
   9 #include "farptr.h" // FLATPTR_TO_SEG
  10 #include "config.h" // CONFIG_*
  11 #include "util.h" // dprintf
  12 #include "pci.h" // foreachpci
  13 #include "pci_regs.h" // PCI_ROM_ADDRESS
  14 #include "pci_ids.h" // PCI_CLASS_DISPLAY_VGA
  15 #include "boot.h" // IPL
  16 #include "paravirt.h" // qemu_cfg_*
  17
  18
  19 /****************************************************************
  20  * Definitions
  21  ****************************************************************/
  22
  23 struct rom_header {
  24     u16 signature;
  25     u8 size;
  26     u8 initVector[4];
  27     u8 reserved[17];
  28     u16 pcioffset;
  29     u16 pnpoffset;
  30 } PACKED;
  31
  32 struct pci_data {
  33     u32 signature;
  34     u16 vendor;
  35     u16 device;
  36     u16 vitaldata;
  37     u16 dlen;
  38     u8 drevision;
  39     u8 class_lo;
  40     u16 class_hi;
  41     u16 ilen;
  42     u16 irevision;
  43     u8 type;
  44     u8 indicator;
  45     u16 reserved;
  46 } PACKED;
  47
  48 struct pnp_data {
  49     u32 signature;
  50     u8 revision;
  51     u8 len;
  52     u16 nextoffset;
  53     u8 reserved_08;
  54     u8 checksum;
  55     u32 devid;
  56     u16 manufacturer;
  57     u16 productname;
  58     u8 type_lo;
  59     u16 type_hi;
  60     u8 dev_flags;
  61     u16 bcv;
  62     u16 dv;
  63     u16 bev;
  64     u16 reserved_1c;
  65     u16 staticresource;
  66 } PACKED;
  67
  68 #define OPTION_ROM_SIGNATURE 0xaa55
  69 #define OPTION_ROM_ALIGN 2048
  70 #define OPTION_ROM_INITVECTOR offsetof(struct rom_header, initVector[0])
  71 #define PCI_ROM_SIGNATURE 0x52494350 // PCIR
  72 #define PCIROM_CODETYPE_X86 0
  73
  74 // The end of the last deployed rom.
  75 u32 RomEnd;
  76
  77
  78 /****************************************************************
  79  * Helper functions
  80  ****************************************************************/
  81
  82 // Execute a given option rom.
  83 static void
  84 __callrom(struct rom_header *rom, u16 offset, u16 bdf)
  85 {
  86     u16 seg = FLATPTR_TO_SEG(rom);
  87     dprintf(1, "Running option rom at %04x:%04x\n", seg, offset);
  88
  89     struct bregs br;
  90     memset(&br, 0, sizeof(br));
  91     br.flags = F_IF;
  92     br.ax = bdf;
  93     br.bx = 0xffff;
  94     br.dx = 0xffff;
  95     br.es = SEG_BIOS;
  96     br.di = get_pnp_offset();
  97     br.code = SEGOFF(seg, offset);
  98     start_preempt();
  99     call16big(&br);
 100     finish_preempt();
 101
 102     debug_serial_setup();
 103 }
 104
 105 // Execute a given option rom at the standard entry vector.
 106 static void
 107 callrom(struct rom_header *rom, u16 bdf)
 108 {
 109     __callrom(rom, OPTION_ROM_INITVECTOR, bdf);
 110 }
 111
 112 // Execute a BCV option rom registered via add_bcv().
 113 void
 114 call_bcv(u16 seg, u16 ip)
 115 {
 116     __callrom(MAKE_FLATPTR(seg, 0), ip, 0);
 117 }
 118
 119 // Verify that an option rom looks valid
 120 static int
 121 is_valid_rom(struct rom_header *rom)
 122 {
 123     dprintf(6, "Checking rom %p (sig %x size %d)\n"
 124             , rom, rom->signature, rom->size);
 125     if (rom->signature != OPTION_ROM_SIGNATURE)
 126         return 0;
 127     if (! rom->size)
 128         return 0;
 129     u32 len = rom->size * 512;
 130     u8 sum = checksum(rom, len);
 131     if (sum != 0) {
 132         dprintf(1, "Found option rom with bad checksum: loc=%p len=%d sum=%x\n"
 133                 , rom, len, sum);
 134         return 0;
 135     }
 136     return 1;
 137 }
 138
 139 // Check if a valid option rom has a pnp struct; return it if so.
 140 static struct pnp_data *
 141 get_pnp_rom(struct rom_header *rom)
 142 {
 143     struct pnp_data *pnp = (void*)((u8*)rom + rom->pnpoffset);
 144     if (pnp->signature != PNP_SIGNATURE)
 145         return NULL;
 146     return pnp;
 147 }
 148
 149 // Check for multiple pnp option rom headers.
 150 static struct pnp_data *
 151 get_pnp_next(struct rom_header *rom, struct pnp_data *pnp)
 152 {
 153     if (! pnp->nextoffset)
 154         return NULL;
 155     pnp = (void*)((u8*)rom + pnp->nextoffset);
 156     if (pnp->signature != PNP_SIGNATURE)
 157         return NULL;
 158     return pnp;
 159 }
 160
 161 // Check if a valid option rom has a pci struct; return it if so.
 162 static struct pci_data *
 163 get_pci_rom(struct rom_header *rom)
 164 {
 165     struct pci_data *pci = (void*)((u32)rom + rom->pcioffset);
 166     if (pci->signature != PCI_ROM_SIGNATURE)
 167         return NULL;
 168     return pci;
 169 }
 170
 171 // Return the memory position up to which roms may be located.
 172 static inline u32
 173 max_rom()
 174 {
 175     extern u8 code32flat_start[];
 176     if ((u32)code32flat_start > BUILD_BIOS_ADDR)
 177         return BUILD_BIOS_ADDR;
 178     return (u32)code32flat_start;
 179 }
 180
 181 // Copy a rom to its permanent location below 1MiB
 182 static struct rom_header *
 183 copy_rom(struct rom_header *rom)
 184 {
 185     u32 romsize = rom->size * 512;
 186     if (RomEnd + romsize > max_rom()) {
 187         // Option rom doesn't fit.
 188         dprintf(1, "Option rom %p doesn't fit.\n", rom);
 189         return NULL;
 190     }
 191     dprintf(4, "Copying option rom (size %d) from %p to %x\n"
 192             , romsize, rom, RomEnd);
 193     iomemcpy((void*)RomEnd, rom, romsize);
 194     return (void*)RomEnd;
 195 }
 196
 197 // Run rom init code and note rom size.
 198 static int
 199 init_optionrom(struct rom_header *rom, u16 bdf, int isvga)
 200 {
 201     if (! is_valid_rom(rom))
 202         return -1;
 203
 204     if (isvga || get_pnp_rom(rom))
 205         // Only init vga and PnP roms here.
 206         callrom(rom, bdf);
 207
 208     RomEnd = (u32)rom + ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
 209
 210     return 0;
 211 }
 212
 213
 214 /****************************************************************
 215  * Roms in CBFS
 216  ****************************************************************/
 217
 218 // Check if an option rom is at a hardcoded location or in CBFS.
 219 static struct rom_header *
 220 lookup_hardcode(u32 vendev)
 221 {
 222     if (OPTIONROM_VENDEV_1
 223         && ((OPTIONROM_VENDEV_1 >> 16)
 224             | ((OPTIONROM_VENDEV_1 & 0xffff)) << 16) == vendev)
 225         return copy_rom((void*)OPTIONROM_MEM_1);
 226     if (OPTIONROM_VENDEV_2
 227         && ((OPTIONROM_VENDEV_2 >> 16)
 228             | ((OPTIONROM_VENDEV_2 & 0xffff)) << 16) == vendev)
 229         return copy_rom((void*)OPTIONROM_MEM_2);
 230     int ret = cbfs_copy_optionrom((void*)RomEnd, max_rom() - RomEnd, vendev);
 231     if (ret < 0)
 232         return NULL;
 233     return (void*)RomEnd;
 234 }
 235
 236 // Run all roms in a given CBFS directory.
 237 static void
 238 run_cbfs_roms(const char *prefix, int isvga)
 239 {
 240     struct cbfs_file *file = NULL;
 241     for (;;) {
 242         file = cbfs_findprefix(prefix, file);
 243         if (!file)
 244             break;
 245         int ret = cbfs_copyfile(file, (void*)RomEnd, max_rom() - RomEnd);
 246         if (ret > 0)
 247             init_optionrom((void*)RomEnd, 0, isvga);
 248     }
 249 }
 250
 251 static void
 252 run_qemu_roms(const char *prefix, int isvga)
 253 {
 254     struct QemuCfgFile entry;
 255     int plen = strlen(prefix);
 256     int rc, dlen;
 257
 258     rc = qemu_cfg_first_file(&entry);
 259     while (rc > 0) {
 260         if (memcmp(prefix, entry.name, plen) == 0) {
 261             dlen = qemu_cfg_read_file(&entry, (void*)RomEnd, max_rom() - RomEnd);
 262             if (dlen > 0) {
 263                 dprintf(1, "init qemu rom: %s\n", entry.name);
 264                 init_optionrom((void*)RomEnd, 0, isvga);
 265             }
 266         }
 267         rc = qemu_cfg_next_file(&entry);
 268     }
 269 }
 270
 271
 272 /****************************************************************
 273  * PCI roms
 274  ****************************************************************/
 275
 276 // Map the option rom of a given PCI device.
 277 static struct rom_header *
 278 map_pcirom(u16 bdf, u32 vendev)
 279 {
 280     dprintf(6, "Attempting to map option rom on dev %02x:%02x.%x\n"
 281             , pci_bdf_to_bus(bdf), pci_bdf_to_dev(bdf), pci_bdf_to_fn(bdf));
 282
 283     u8 htype = pci_config_readb(bdf, PCI_HEADER_TYPE);
 284     if ((htype & 0x7f) != PCI_HEADER_TYPE_NORMAL) {
 285         dprintf(6, "Skipping non-normal pci device (type=%x)\n", htype);
 286         return NULL;
 287     }
 288
 289     u32 orig = pci_config_readl(bdf, PCI_ROM_ADDRESS);
 290     pci_config_writel(bdf, PCI_ROM_ADDRESS, ~PCI_ROM_ADDRESS_ENABLE);
 291     u32 sz = pci_config_readl(bdf, PCI_ROM_ADDRESS);
 292
 293     dprintf(6, "Option rom sizing returned %x %x\n", orig, sz);
 294     orig &= ~PCI_ROM_ADDRESS_ENABLE;
 295     if (!sz || sz == 0xffffffff)
 296         goto fail;
 297
 298     if (orig == sz || (u32)(orig + 4*1024*1024) < 20*1024*1024) {
 299         // Don't try to map to a pci addresses at its max, in the last
 300         // 4MiB of ram, or the first 16MiB of ram.
 301         dprintf(6, "Preset rom address doesn't look valid\n");
 302         goto fail;
 303     }
 304
 305     // Looks like a rom - enable it.
 306     pci_config_writel(bdf, PCI_ROM_ADDRESS, orig | PCI_ROM_ADDRESS_ENABLE);
 307
 308     struct rom_header *rom = (void*)orig;
 309     for (;;) {
 310         dprintf(5, "Inspecting possible rom at %p (dv=%08x bdf=%x)\n"
 311                 , rom, vendev, bdf);
 312         if (rom->signature != OPTION_ROM_SIGNATURE) {
 313             dprintf(6, "No option rom signature (got %x)\n", rom->signature);
 314             goto fail;
 315         }
 316         struct pci_data *pci = get_pci_rom(rom);
 317         if (! pci) {
 318             dprintf(6, "No valid pci signature found\n");
 319             goto fail;
 320         }
 321
 322         u32 vd = (pci->device << 16) | pci->vendor;
 323         if (vd == vendev && pci->type == PCIROM_CODETYPE_X86)
 324             // A match
 325             break;
 326         dprintf(6, "Didn't match dev/ven (got %08x) or type (got %d)\n"
 327                 , vd, pci->type);
 328         if (pci->indicator & 0x80) {
 329             dprintf(6, "No more images left\n");
 330             goto fail;
 331         }
 332         rom = (void*)((u32)rom + pci->ilen * 512);
 333     }
 334
 335     rom = copy_rom(rom);
 336     pci_config_writel(bdf, PCI_ROM_ADDRESS, orig);
 337     return rom;
 338 fail:
 339     // Not valid - restore original and exit.
 340     pci_config_writel(bdf, PCI_ROM_ADDRESS, orig);
 341     return NULL;
 342 }
 343
 344 // Attempt to map and initialize the option rom on a given PCI device.
 345 static int
 346 init_pcirom(u16 bdf, int isvga)
 347 {
 348     u32 vendev = pci_config_readl(bdf, PCI_VENDOR_ID);
 349     dprintf(4, "Attempting to init PCI bdf %02x:%02x.%x (dev/ven %08x)\n"
 350             , pci_bdf_to_bus(bdf), pci_bdf_to_dev(bdf), pci_bdf_to_fn(bdf)
 351             , vendev);
 352     struct rom_header *rom = lookup_hardcode(vendev);
 353     if (! rom)
 354         rom = map_pcirom(bdf, vendev);
 355     if (! rom)
 356         // No ROM present.
 357         return -1;
 358     return init_optionrom(rom, bdf, isvga);
 359 }
 360
 361
 362 /****************************************************************
 363  * Non-VGA option rom init
 364  ****************************************************************/
 365
 366 void
 367 optionrom_setup()
 368 {
 369     if (! CONFIG_OPTIONROMS)
 370         return;
 371
 372     dprintf(1, "Scan for option roms\n");
 373
 374     u32 post_vga = RomEnd;
 375
 376     if (CONFIG_OPTIONROMS_DEPLOYED) {
 377         // Option roms are already deployed on the system.
 378         u32 pos = RomEnd;
 379         while (pos < max_rom()) {
 380             int ret = init_optionrom((void*)pos, 0, 0);
 381             if (ret)
 382                 pos += OPTION_ROM_ALIGN;
 383             else
 384                 pos = RomEnd;
 385         }
 386     } else {
 387         // Find and deploy PCI roms.
 388         int bdf, max;
 389         foreachpci(bdf, max) {
 390             u16 v = pci_config_readw(bdf, PCI_CLASS_DEVICE);
 391             if (v == 0x0000 || v == 0xffff || v == PCI_CLASS_DISPLAY_VGA
 392                 || (CONFIG_ATA && v == PCI_CLASS_STORAGE_IDE))
 393                 continue;
 394             init_pcirom(bdf, 0);
 395         }
 396
 397         // Find and deploy CBFS roms not associated with a device.
 398         run_cbfs_roms("genroms/", 0);
 399         run_qemu_roms("genroms/", 0);
 400     }
 401
 402     // All option roms found and deployed - now build BEV/BCV vectors.
 403
 404     u32 pos = post_vga;
 405     while (pos < RomEnd) {
 406         struct rom_header *rom = (void*)pos;
 407         if (! is_valid_rom(rom)) {
 408             pos += OPTION_ROM_ALIGN;
 409             continue;
 410         }
 411         pos += ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
 412         struct pnp_data *pnp = get_pnp_rom(rom);
 413         if (! pnp) {
 414             // Legacy rom.
 415             add_bcv(FLATPTR_TO_SEG(rom), OPTION_ROM_INITVECTOR, 0);
 416             continue;
 417         }
 418         // PnP rom.
 419         if (pnp->bev)
 420             // Can boot system - add to IPL list.
 421             add_bev(FLATPTR_TO_SEG(rom), pnp->bev, pnp->productname);
 422         else
 423             // Check for BCV (there may be multiple).
 424             while (pnp && pnp->bcv) {
 425                 add_bcv(FLATPTR_TO_SEG(rom), pnp->bcv, pnp->productname);
 426                 pnp = get_pnp_next(rom, pnp);
 427             }
 428     }
 429 }
 430
 431
 432 /****************************************************************
 433  * VGA init
 434  ****************************************************************/
 435
 436 // Call into vga code to turn on console.
 437 void
 438 vga_setup()
 439 {
 440     VGAbdf = -1;
 441     RomEnd = BUILD_ROM_START;
 442
 443     if (! CONFIG_OPTIONROMS)
 444         return;
 445
 446     dprintf(1, "Scan for VGA option rom\n");
 447
 448     if (CONFIG_OPTIONROMS_DEPLOYED) {
 449         // Option roms are already deployed on the system.
 450         init_optionrom((void*)BUILD_ROM_START, 0, 1);
 451     } else {
 452         // Find and deploy PCI VGA rom.
 453         int bdf = VGAbdf = pci_find_vga();
 454         if (bdf >= 0)
 455             init_pcirom(bdf, 1);
 456
 457         // Find and deploy CBFS vga-style roms not associated with a device.
 458         run_cbfs_roms("vgaroms/", 1);
 459         run_qemu_roms("vgaroms/", 1);
 460     }
 461
 462     if (RomEnd == BUILD_ROM_START) {
 463         // No VGA rom found
 464         RomEnd += OPTION_ROM_ALIGN;
 465         return;
 466     }
 467
 468     dprintf(1, "Turning on vga console\n");
 469     struct bregs br;
 470     memset(&br, 0, sizeof(br));
 471     br.flags = F_IF;
 472     br.ax = 0x0003;
 473     call16_int(0x10, &br);
 474
 475     // Write to screen.
 476     printf("Starting SeaBIOS (version %s)\n\n", VERSION);
 477 }
 478
 479 void
 480 s3_resume_vga_init()
 481 {
 482     if (!CONFIG_S3_RESUME_VGA_INIT)
 483         return;
 484     struct rom_header *rom = (void*)BUILD_ROM_START;
 485     if (! is_valid_rom(rom))
 486         return;
 487     callrom(rom, 0);
 488 }