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