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