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 = BUILD_ROM_START;
  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         if (CONFIG_OPTIONROMS_CHECKSUM)
 135             return 0;
 136     }
 137     return 1;
 138 }
 139
 140 // Check if a valid option rom has a pnp struct; return it if so.
 141 static struct pnp_data *
 142 get_pnp_rom(struct rom_header *rom)
 143 {
 144     struct pnp_data *pnp = (void*)((u8*)rom + rom->pnpoffset);
 145     if (pnp->signature != PNP_SIGNATURE)
 146         return NULL;
 147     return pnp;
 148 }
 149
 150 // Check for multiple pnp option rom headers.
 151 static struct pnp_data *
 152 get_pnp_next(struct rom_header *rom, struct pnp_data *pnp)
 153 {
 154     if (! pnp->nextoffset)
 155         return NULL;
 156     pnp = (void*)((u8*)rom + pnp->nextoffset);
 157     if (pnp->signature != PNP_SIGNATURE)
 158         return NULL;
 159     return pnp;
 160 }
 161
 162 // Check if a valid option rom has a pci struct; return it if so.
 163 static struct pci_data *
 164 get_pci_rom(struct rom_header *rom)
 165 {
 166     struct pci_data *pd = (void*)((u32)rom + rom->pcioffset);
 167     if (pd->signature != PCI_ROM_SIGNATURE)
 168         return NULL;
 169     return pd;
 170 }
 171
 172 // Return start of code in 0xc0000-0xf0000 space.
 173 static inline u32 _max_rom(void) {
 174     extern u8 code32flat_start[], code32init_end[];
 175     return CONFIG_RELOCATE_INIT ? (u32)code32init_end : (u32)code32flat_start;
 176 }
 177 // Return the memory position up to which roms may be located.
 178 static inline u32 max_rom(void) {
 179     u32 end = _max_rom();
 180     return end > BUILD_BIOS_ADDR ? BUILD_BIOS_ADDR : end;
 181 }
 182
 183 // Copy a rom to its permanent location below 1MiB
 184 static struct rom_header *
 185 copy_rom(struct rom_header *rom)
 186 {
 187     u32 romsize = rom->size * 512;
 188     if (RomEnd + romsize > max_rom()) {
 189         // Option rom doesn't fit.
 190         warn_noalloc();
 191         return NULL;
 192     }
 193     dprintf(4, "Copying option rom (size %d) from %p to %x\n"
 194             , romsize, rom, RomEnd);
 195     iomemcpy((void*)RomEnd, rom, romsize);
 196     return (void*)RomEnd;
 197 }
 198
 199 // Run rom init code and note rom size.
 200 static int
 201 init_optionrom(struct rom_header *rom, u16 bdf, int isvga)
 202 {
 203     if (! is_valid_rom(rom))
 204         return -1;
 205
 206     if (isvga || get_pnp_rom(rom))
 207         // Only init vga and PnP roms here.
 208         callrom(rom, bdf);
 209
 210     RomEnd = (u32)rom + ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
 211
 212     return 0;
 213 }
 214
 215 #define RS_PCIROM (1LL<<33)
 216
 217 static void
 218 setRomSource(u64 *sources, struct rom_header *rom, u64 source)
 219 {
 220     if (sources)
 221         sources[((u32)rom - BUILD_ROM_START) / OPTION_ROM_ALIGN] = source;
 222 }
 223
 224 static int
 225 getRomPriority(u64 *sources, struct rom_header *rom, int instance)
 226 {
 227     u64 source = sources[((u32)rom - BUILD_ROM_START) / OPTION_ROM_ALIGN];
 228     if (!source)
 229         return -1;
 230     if (source & RS_PCIROM)
 231         return bootprio_find_pci_rom(source, instance);
 232     return bootprio_find_named_rom(romfile_name(source), instance);
 233 }
 234
 235
 236 /****************************************************************
 237  * Roms in CBFS
 238  ****************************************************************/
 239
 240 // Check if an option rom is at a hardcoded location or in CBFS.
 241 static struct rom_header *
 242 lookup_hardcode(struct pci_device *pci)
 243 {
 244     char fname[17];
 245     snprintf(fname, sizeof(fname), "pci%04x,%04x.rom"
 246              , pci->vendor, pci->device);
 247     int ret = romfile_copy(romfile_find(fname), (void*)RomEnd
 248                            , max_rom() - RomEnd);
 249     if (ret <= 0)
 250         return NULL;
 251     return (void*)RomEnd;
 252 }
 253
 254 // Run all roms in a given CBFS directory.
 255 static void
 256 run_file_roms(const char *prefix, int isvga, u64 *sources)
 257 {
 258     u32 file = 0;
 259     for (;;) {
 260         file = romfile_findprefix(prefix, file);
 261         if (!file)
 262             break;
 263         struct rom_header *rom = (void*)RomEnd;
 264         int ret = romfile_copy(file, rom, max_rom() - RomEnd);
 265         if (ret > 0) {
 266             setRomSource(sources, rom, file);
 267             init_optionrom(rom, 0, isvga);
 268         }
 269     }
 270 }
 271
 272
 273 /****************************************************************
 274  * PCI roms
 275  ****************************************************************/
 276
 277 // Verify device is a vga device with legacy address decoding enabled.
 278 static int
 279 is_pci_vga(struct pci_device *pci)
 280 {
 281     if (pci->class != PCI_CLASS_DISPLAY_VGA)
 282         return 0;
 283     u16 cmd = pci_config_readw(pci->bdf, PCI_COMMAND);
 284     if (!(cmd & PCI_COMMAND_IO && cmd & PCI_COMMAND_MEMORY))
 285         return 0;
 286     while (pci->parent) {
 287         pci = pci->parent;
 288         u32 ctrl = pci_config_readb(pci->bdf, PCI_BRIDGE_CONTROL);
 289         if (!(ctrl & PCI_BRIDGE_CTL_VGA))
 290             return 0;
 291     }
 292     return 1;
 293 }
 294
 295 // Map the option rom of a given PCI device.
 296 static struct rom_header *
 297 map_pcirom(struct pci_device *pci)
 298 {
 299     u16 bdf = pci->bdf;
 300     dprintf(6, "Attempting to map option rom on dev %02x:%02x.%x\n"
 301             , pci_bdf_to_bus(bdf), pci_bdf_to_dev(bdf), pci_bdf_to_fn(bdf));
 302
 303     if ((pci->header_type & 0x7f) != PCI_HEADER_TYPE_NORMAL) {
 304         dprintf(6, "Skipping non-normal pci device (type=%x)\n"
 305                 , pci->header_type);
 306         return NULL;
 307     }
 308
 309     u32 orig = pci_config_readl(bdf, PCI_ROM_ADDRESS);
 310     pci_config_writel(bdf, PCI_ROM_ADDRESS, ~PCI_ROM_ADDRESS_ENABLE);
 311     u32 sz = pci_config_readl(bdf, PCI_ROM_ADDRESS);
 312
 313     dprintf(6, "Option rom sizing returned %x %x\n", orig, sz);
 314     orig &= ~PCI_ROM_ADDRESS_ENABLE;
 315     if (!sz || sz == 0xffffffff)
 316         goto fail;
 317
 318     if (orig == sz || (u32)(orig + 4*1024*1024) < 20*1024*1024) {
 319         // Don't try to map to a pci addresses at its max, in the last
 320         // 4MiB of ram, or the first 16MiB of ram.
 321         dprintf(6, "Preset rom address doesn't look valid\n");
 322         goto fail;
 323     }
 324
 325     // Looks like a rom - enable it.
 326     pci_config_writel(bdf, PCI_ROM_ADDRESS, orig | PCI_ROM_ADDRESS_ENABLE);
 327
 328     struct rom_header *rom = (void*)orig;
 329     for (;;) {
 330         dprintf(5, "Inspecting possible rom at %p (vd=%04x:%04x"
 331                 " bdf=%02x:%02x.%x)\n"
 332                 , rom, pci->vendor, pci->device
 333                 , pci_bdf_to_bus(bdf), pci_bdf_to_dev(bdf), pci_bdf_to_fn(bdf));
 334         if (rom->signature != OPTION_ROM_SIGNATURE) {
 335             dprintf(6, "No option rom signature (got %x)\n", rom->signature);
 336             goto fail;
 337         }
 338         struct pci_data *pd = get_pci_rom(rom);
 339         if (! pd) {
 340             dprintf(6, "No valid pci signature found\n");
 341             goto fail;
 342         }
 343
 344         if (pd->vendor == pci->vendor && pd->device == pci->device
 345             && pd->type == PCIROM_CODETYPE_X86)
 346             // A match
 347             break;
 348         dprintf(6, "Didn't match dev/ven (got %04x:%04x) or type (got %d)\n"
 349                 , pd->vendor, pd->device, pd->type);
 350         if (pd->indicator & 0x80) {
 351             dprintf(6, "No more images left\n");
 352             goto fail;
 353         }
 354         rom = (void*)((u32)rom + pd->ilen * 512);
 355     }
 356
 357     rom = copy_rom(rom);
 358     pci_config_writel(bdf, PCI_ROM_ADDRESS, orig);
 359     return rom;
 360 fail:
 361     // Not valid - restore original and exit.
 362     pci_config_writel(bdf, PCI_ROM_ADDRESS, orig);
 363     return NULL;
 364 }
 365
 366 // Attempt to map and initialize the option rom on a given PCI device.
 367 static int
 368 init_pcirom(struct pci_device *pci, int isvga, u64 *sources)
 369 {
 370     u16 bdf = pci->bdf;
 371     dprintf(4, "Attempting to init PCI bdf %02x:%02x.%x (vd %04x:%04x)\n"
 372             , pci_bdf_to_bus(bdf), pci_bdf_to_dev(bdf), pci_bdf_to_fn(bdf)
 373             , pci->vendor, pci->device);
 374     struct rom_header *rom = lookup_hardcode(pci);
 375     if (! rom)
 376         rom = map_pcirom(pci);
 377     if (! rom)
 378         // No ROM present.
 379         return -1;
 380     setRomSource(sources, rom, RS_PCIROM | bdf);
 381     return init_optionrom(rom, bdf, isvga);
 382 }
 383
 384
 385 /****************************************************************
 386  * Non-VGA option rom init
 387  ****************************************************************/
 388
 389 void
 390 optionrom_setup(void)
 391 {
 392     if (! CONFIG_OPTIONROMS)
 393         return;
 394
 395     dprintf(1, "Scan for option roms\n");
 396     u64 sources[(BUILD_BIOS_ADDR - BUILD_ROM_START) / OPTION_ROM_ALIGN];
 397     memset(sources, 0, sizeof(sources));
 398     u32 post_vga = RomEnd;
 399
 400     if (CONFIG_OPTIONROMS_DEPLOYED) {
 401         // Option roms are already deployed on the system.
 402         u32 pos = RomEnd;
 403         while (pos < max_rom()) {
 404             int ret = init_optionrom((void*)pos, 0, 0);
 405             if (ret)
 406                 pos += OPTION_ROM_ALIGN;
 407             else
 408                 pos = RomEnd;
 409         }
 410     } else {
 411         // Find and deploy PCI roms.
 412         struct pci_device *pci;
 413         foreachpci(pci) {
 414             if (pci->class == PCI_CLASS_DISPLAY_VGA || pci->have_driver)
 415                 continue;
 416             init_pcirom(pci, 0, sources);
 417         }
 418
 419         // Find and deploy CBFS roms not associated with a device.
 420         run_file_roms("genroms/", 0, sources);
 421     }
 422
 423     // All option roms found and deployed - now build BEV/BCV vectors.
 424
 425     u32 pos = post_vga;
 426     while (pos < RomEnd) {
 427         struct rom_header *rom = (void*)pos;
 428         if (! is_valid_rom(rom)) {
 429             pos += OPTION_ROM_ALIGN;
 430             continue;
 431         }
 432         pos += ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
 433         struct pnp_data *pnp = get_pnp_rom(rom);
 434         if (! pnp) {
 435             // Legacy rom.
 436             boot_add_bcv(FLATPTR_TO_SEG(rom), OPTION_ROM_INITVECTOR, 0
 437                          , getRomPriority(sources, rom, 0));
 438             continue;
 439         }
 440         // PnP rom.
 441         if (pnp->bev) {
 442             // Can boot system - add to IPL list.
 443             boot_add_bev(FLATPTR_TO_SEG(rom), pnp->bev, pnp->productname
 444                          , getRomPriority(sources, rom, 0));
 445         } else {
 446             // Check for BCV (there may be multiple).
 447             int instance = 0;
 448             while (pnp && pnp->bcv) {
 449                 boot_add_bcv(FLATPTR_TO_SEG(rom), pnp->bcv, pnp->productname
 450                              , getRomPriority(sources, rom, instance++));
 451                 pnp = get_pnp_next(rom, pnp);
 452             }
 453         }
 454     }
 455 }
 456
 457
 458 /****************************************************************
 459  * VGA init
 460  ****************************************************************/
 461
 462 // Call into vga code to turn on console.
 463 void
 464 vga_setup(void)
 465 {
 466     if (! CONFIG_OPTIONROMS)
 467         return;
 468
 469     dprintf(1, "Scan for VGA option rom\n");
 470
 471     if (CONFIG_OPTIONROMS_DEPLOYED) {
 472         // Option roms are already deployed on the system.
 473         init_optionrom((void*)BUILD_ROM_START, 0, 1);
 474     } else {
 475         // Clear option rom memory
 476         memset((void*)RomEnd, 0, _max_rom() - RomEnd);
 477
 478         // Find and deploy PCI VGA rom.
 479         struct pci_device *pci;
 480         foreachpci(pci) {
 481             if (!is_pci_vga(pci))
 482                 continue;
 483             vgahook_setup(pci);
 484             init_pcirom(pci, 1, NULL);
 485             break;
 486         }
 487
 488         // Find and deploy CBFS vga-style roms not associated with a device.
 489         run_file_roms("vgaroms/", 1, NULL);
 490     }
 491
 492     if (RomEnd == BUILD_ROM_START) {
 493         // No VGA rom found
 494         RomEnd += OPTION_ROM_ALIGN;
 495         return;
 496     }
 497
 498     enable_vga_console();
 499 }
 500
 501 void
 502 s3_resume_vga_init(void)
 503 {
 504     if (!CONFIG_S3_RESUME_VGA_INIT)
 505         return;
 506     struct rom_header *rom = (void*)BUILD_ROM_START;
 507     if (! is_valid_rom(rom))
 508         return;
 509     callrom(rom, 0);
 510 }