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" // pci_find_class
  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_START 0xc0000
  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 // Next available position for an option rom.
  75 static u32 next_rom;
  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.ax = bdf;
  92     br.bx = 0xffff;
  93     br.dx = 0xffff;
  94     br.es = SEG_BIOS;
  95     br.di = get_pnp_offset();
  96     br.cs = seg;
  97     br.ip = offset;
  98     call16big(&br);
  99
 100     debug_serial_setup();
 101 }
 102
 103 // Execute a BCV option rom registered via add_bcv().
 104 void
 105 call_bcv(u16 seg, u16 ip)
 106 {
 107     callrom(MAKE_FLATPTR(seg, 0), ip, 0);
 108 }
 109
 110 // Verify that an option rom looks valid
 111 static int
 112 is_valid_rom(struct rom_header *rom)
 113 {
 114     dprintf(6, "Checking rom %p (sig %x size %d)\n"
 115             , rom, rom->signature, rom->size);
 116     if (rom->signature != OPTION_ROM_SIGNATURE)
 117         return 0;
 118     if (! rom->size)
 119         return 0;
 120     u32 len = rom->size * 512;
 121     u8 sum = checksum(rom, len);
 122     if (sum != 0) {
 123         dprintf(1, "Found option rom with bad checksum: loc=%p len=%d sum=%x\n"
 124                 , rom, len, sum);
 125         return 0;
 126     }
 127     return 1;
 128 }
 129
 130 // Check if a valid option rom has a pnp struct; return it if so.
 131 static struct pnp_data *
 132 get_pnp_rom(struct rom_header *rom)
 133 {
 134     struct pnp_data *pnp = (struct pnp_data *)((u8*)rom + rom->pnpoffset);
 135     if (pnp->signature != PNP_SIGNATURE)
 136         return NULL;
 137     return pnp;
 138 }
 139
 140 // Check for multiple pnp option rom headers.
 141 static struct pnp_data *
 142 get_pnp_next(struct rom_header *rom, struct pnp_data *pnp)
 143 {
 144     if (! pnp->nextoffset)
 145         return NULL;
 146     pnp = (struct pnp_data *)((u8*)rom + pnp->nextoffset);
 147     if (pnp->signature != PNP_SIGNATURE)
 148         return NULL;
 149     return pnp;
 150 }
 151
 152 // Check if a valid option rom has a pci struct; return it if so.
 153 static struct pci_data *
 154 get_pci_rom(struct rom_header *rom)
 155 {
 156     struct pci_data *pci = (struct pci_data *)((u32)rom + rom->pcioffset);
 157     if (pci->signature != PCI_ROM_SIGNATURE)
 158         return NULL;
 159     return pci;
 160 }
 161
 162 // Copy a rom to its permanent location below 1MiB
 163 static struct rom_header *
 164 copy_rom(struct rom_header *rom)
 165 {
 166     u32 romsize = rom->size * 512;
 167     if (next_rom + romsize > BUILD_BIOS_ADDR) {
 168         // Option rom doesn't fit.
 169         dprintf(1, "Option rom %p doesn't fit.\n", rom);
 170         return NULL;
 171     }
 172     dprintf(4, "Copying option rom (size %d) from %p to %x\n"
 173             , romsize, rom, next_rom);
 174     memcpy((void*)next_rom, rom, romsize);
 175     return (struct rom_header *)next_rom;
 176 }
 177
 178 // Check if an option rom is at a hardcoded location for a device.
 179 static struct rom_header *
 180 lookup_hardcode(u32 vendev)
 181 {
 182     if (OPTIONROM_VENDEV_1
 183         && ((OPTIONROM_VENDEV_1 >> 16)
 184             | ((OPTIONROM_VENDEV_1 & 0xffff)) << 16) == vendev)
 185         return copy_rom((struct rom_header *)OPTIONROM_MEM_1);
 186     if (OPTIONROM_VENDEV_2
 187         && ((OPTIONROM_VENDEV_2 >> 16)
 188             | ((OPTIONROM_VENDEV_2 & 0xffff)) << 16) == vendev)
 189         return copy_rom((struct rom_header *)OPTIONROM_MEM_2);
 190     int ret = cbfs_copy_optionrom((void*)next_rom, BUILD_BIOS_ADDR - next_rom
 191                                   , vendev);
 192     if (ret < 0)
 193         return NULL;
 194     return (struct rom_header *)next_rom;
 195 }
 196
 197 // Map the option rom of a given PCI device.
 198 static struct rom_header *
 199 map_optionrom(u16 bdf, u32 vendev)
 200 {
 201     dprintf(6, "Attempting to map option rom on dev %02x:%02x.%x\n"
 202             , pci_bdf_to_bus(bdf), pci_bdf_to_dev(bdf), pci_bdf_to_fn(bdf));
 203
 204     u8 htype = pci_config_readb(bdf, PCI_HEADER_TYPE);
 205     if ((htype & 0x7f) != PCI_HEADER_TYPE_NORMAL) {
 206         dprintf(6, "Skipping non-normal pci device (type=%x)\n", htype);
 207         return NULL;
 208     }
 209
 210     u32 orig = pci_config_readl(bdf, PCI_ROM_ADDRESS);
 211     pci_config_writel(bdf, PCI_ROM_ADDRESS, ~PCI_ROM_ADDRESS_ENABLE);
 212     u32 sz = pci_config_readl(bdf, PCI_ROM_ADDRESS);
 213
 214     dprintf(6, "Option rom sizing returned %x %x\n", orig, sz);
 215     orig &= ~PCI_ROM_ADDRESS_ENABLE;
 216     if (!sz || sz == 0xffffffff)
 217         goto fail;
 218
 219     if (orig == sz || (u32)(orig + 4*1024*1024) < 20*1024*1024) {
 220         // Don't try to map to a pci addresses at its max, in the last
 221         // 4MiB of ram, or the first 16MiB of ram.
 222         dprintf(6, "Preset rom address doesn't look valid\n");
 223         goto fail;
 224     }
 225
 226     // Looks like a rom - enable it.
 227     pci_config_writel(bdf, PCI_ROM_ADDRESS, orig | PCI_ROM_ADDRESS_ENABLE);
 228
 229     struct rom_header *rom = (struct rom_header *)orig;
 230     for (;;) {
 231         dprintf(5, "Inspecting possible rom at %p (dv=%x bdf=%x)\n"
 232                 , rom, vendev, bdf);
 233         if (rom->signature != OPTION_ROM_SIGNATURE) {
 234             dprintf(6, "No option rom signature (got %x)\n", rom->signature);
 235             goto fail;
 236         }
 237         struct pci_data *pci = get_pci_rom(rom);
 238         if (! pci) {
 239             dprintf(6, "No valid pci signature found\n");
 240             goto fail;
 241         }
 242
 243         u32 vd = (pci->device << 16) | pci->vendor;
 244         if (vd == vendev && pci->type == PCIROM_CODETYPE_X86)
 245             // A match
 246             break;
 247         dprintf(6, "Didn't match dev/ven (got %x) or type (got %d)\n"
 248                 , vd, pci->type);
 249         if (pci->indicator & 0x80) {
 250             dprintf(6, "No more images left\n");
 251             goto fail;
 252         }
 253         rom = (struct rom_header *)((u32)rom + pci->ilen * 512);
 254     }
 255
 256     rom = copy_rom(rom);
 257     pci_config_writel(bdf, PCI_ROM_ADDRESS, orig);
 258     return rom;
 259 fail:
 260     // Not valid - restore original and exit.
 261     pci_config_writel(bdf, PCI_ROM_ADDRESS, orig);
 262     return NULL;
 263 }
 264
 265 // Adjust for the size of an option rom; allow it to resize.
 266 static struct rom_header *
 267 verifysize_optionrom(struct rom_header *rom, u16 bdf)
 268 {
 269     if (! is_valid_rom(rom))
 270         return NULL;
 271
 272     if (get_pnp_rom(rom))
 273         // Init the PnP rom.
 274         callrom(rom, OPTION_ROM_INITVECTOR, bdf);
 275
 276     next_rom += ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
 277
 278     return rom;
 279 }
 280
 281 // Attempt to map and initialize the option rom on a given PCI device.
 282 static struct rom_header *
 283 init_optionrom(u16 bdf)
 284 {
 285     u32 vendev = pci_config_readl(bdf, PCI_VENDOR_ID);
 286     dprintf(4, "Attempting to init PCI bdf %02x:%02x.%x (dev/ven %x)\n"
 287             , pci_bdf_to_bus(bdf), pci_bdf_to_dev(bdf), pci_bdf_to_fn(bdf)
 288             , vendev);
 289     struct rom_header *rom = lookup_hardcode(vendev);
 290     if (! rom)
 291         rom = map_optionrom(bdf, vendev);
 292     if (! rom)
 293         // No ROM present.
 294         return NULL;
 295     return verifysize_optionrom(rom, bdf);
 296 }
 297
 298
 299 /****************************************************************
 300  * Non-VGA option rom init
 301  ****************************************************************/
 302
 303 void
 304 optionrom_setup()
 305 {
 306     if (! CONFIG_OPTIONROMS)
 307         return;
 308
 309     dprintf(1, "Scan for option roms\n");
 310
 311     u32 post_vga = next_rom;
 312
 313     if (CONFIG_OPTIONROMS_DEPLOYED) {
 314         // Option roms are already deployed on the system.
 315         u32 pos = next_rom;
 316         while (pos < BUILD_BIOS_ADDR) {
 317             struct rom_header *rom = (struct rom_header *)pos;
 318             if (! is_valid_rom(rom)) {
 319                 pos += OPTION_ROM_ALIGN;
 320                 continue;
 321             }
 322             if (get_pnp_rom(rom))
 323                 callrom(rom, OPTION_ROM_INITVECTOR, 0);
 324             pos += ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
 325             next_rom = pos;
 326         }
 327     } else {
 328         // Find and deploy PCI roms.
 329         int bdf, max;
 330         foreachpci(bdf, max) {
 331             u16 v = pci_config_readw(bdf, PCI_CLASS_DEVICE);
 332             if (v == 0x0000 || v == 0xffff || v == PCI_CLASS_DISPLAY_VGA
 333                 || (CONFIG_ATA && v == PCI_CLASS_STORAGE_IDE))
 334                 continue;
 335             init_optionrom(bdf);
 336         }
 337
 338         // Find and deploy CBFS roms not associated with a device.
 339         struct cbfs_file *tmp = NULL;
 340         for (;;) {
 341             tmp = cbfs_copy_gen_optionrom(
 342                 (void*)next_rom, BUILD_BIOS_ADDR - next_rom, tmp);
 343             if (!tmp)
 344                 break;
 345             verifysize_optionrom((void*)next_rom, 0);
 346         }
 347     }
 348
 349     // All option roms found and deployed - now build BEV/BCV vectors.
 350
 351     u32 pos = post_vga;
 352     while (pos < next_rom) {
 353         struct rom_header *rom = (struct rom_header *)pos;
 354         if (! is_valid_rom(rom)) {
 355             pos += OPTION_ROM_ALIGN;
 356             continue;
 357         }
 358         pos += ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
 359         struct pnp_data *pnp = get_pnp_rom(rom);
 360         if (! pnp) {
 361             // Legacy rom.
 362             add_bcv(FLATPTR_TO_SEG(rom), OPTION_ROM_INITVECTOR, 0);
 363             continue;
 364         }
 365         // PnP rom.
 366         if (pnp->bev)
 367             // Can boot system - add to IPL list.
 368             add_bev(FLATPTR_TO_SEG(rom), pnp->bev, pnp->productname);
 369         else
 370             // Check for BCV (there may be multiple).
 371             while (pnp && pnp->bcv) {
 372                 add_bcv(FLATPTR_TO_SEG(rom), pnp->bcv, pnp->productname);
 373                 pnp = get_pnp_next(rom, pnp);
 374             }
 375     }
 376 }
 377
 378
 379 /****************************************************************
 380  * VGA init
 381  ****************************************************************/
 382
 383 // Call into vga code to turn on console.
 384 void
 385 vga_setup()
 386 {
 387     if (! CONFIG_OPTIONROMS)
 388         return;
 389
 390     dprintf(1, "Scan for VGA option rom\n");
 391     next_rom = OPTION_ROM_START;
 392
 393     if (CONFIG_OPTIONROMS_DEPLOYED) {
 394         // Option roms are already deployed on the system.
 395         struct rom_header *rom = (struct rom_header *)OPTION_ROM_START;
 396         if (! is_valid_rom(rom))
 397             return;
 398         callrom(rom, OPTION_ROM_INITVECTOR, 0);
 399         next_rom += ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
 400     } else {
 401         // Find and deploy PCI VGA rom.
 402         int bdf = pci_find_class(PCI_CLASS_DISPLAY_VGA);
 403         if (bdf < 0)
 404             // Device not found
 405             return;
 406
 407         struct rom_header *rom = init_optionrom(bdf);
 408         if (rom && !get_pnp_rom(rom))
 409             // Call rom even if it isn't a pnp rom.
 410             callrom(rom, OPTION_ROM_INITVECTOR, bdf);
 411     }
 412
 413     dprintf(1, "Turning on vga console\n");
 414     struct bregs br;
 415     memset(&br, 0, sizeof(br));
 416     br.ax = 0x0003;
 417     call16_int(0x10, &br);
 418
 419     // Write to screen.
 420     printf("Starting SeaBIOS\n\n");
 421 }