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