grml...
[seabios.git] / src / optionroms.c
index c42968a9f9c558542ba19522c224ebf7fe24bad8..27cfffd82a79e0e8e72b29f58949d4f8ed67c0a9 100644 (file)
@@ -9,70 +9,19 @@
 #include "farptr.h" // FLATPTR_TO_SEG
 #include "config.h" // CONFIG_*
 #include "util.h" // dprintf
-#include "pci.h" // pci_find_class
+#include "pci.h" // foreachpci
 #include "pci_regs.h" // PCI_ROM_ADDRESS
 #include "pci_ids.h" // PCI_CLASS_DISPLAY_VGA
 #include "boot.h" // IPL
-
+#include "paravirt.h" // qemu_cfg_*
+#include "optionroms.h" // struct rom_header
 
 /****************************************************************
  * Definitions
  ****************************************************************/
 
-struct rom_header {
-    u16 signature;
-    u8 size;
-    u8 initVector[4];
-    u8 reserved[17];
-    u16 pcioffset;
-    u16 pnpoffset;
-} PACKED;
-
-struct pci_data {
-    u32 signature;
-    u16 vendor;
-    u16 device;
-    u16 vitaldata;
-    u16 dlen;
-    u8 drevision;
-    u8 class_lo;
-    u16 class_hi;
-    u16 ilen;
-    u16 irevision;
-    u8 type;
-    u8 indicator;
-    u16 reserved;
-} PACKED;
-
-struct pnp_data {
-    u32 signature;
-    u8 revision;
-    u8 len;
-    u16 nextoffset;
-    u8 reserved_08;
-    u8 checksum;
-    u32 devid;
-    u16 manufacturer;
-    u16 productname;
-    u8 type_lo;
-    u16 type_hi;
-    u8 dev_flags;
-    u16 bcv;
-    u16 dv;
-    u16 bev;
-    u16 reserved_1c;
-    u16 staticresource;
-} PACKED;
-
-#define OPTION_ROM_START 0xc0000
-#define OPTION_ROM_SIGNATURE 0xaa55
-#define OPTION_ROM_ALIGN 2048
-#define OPTION_ROM_INITVECTOR offsetof(struct rom_header, initVector[0])
-#define PCI_ROM_SIGNATURE 0x52494350 // PCIR
-#define PCIROM_CODETYPE_X86 0
-
-// Next available position for an option rom.
-static u32 next_rom;
+// The end of the last deployed rom.
+u32 RomEnd = BUILD_ROM_START;
 
 
 /****************************************************************
@@ -81,32 +30,43 @@ static u32 next_rom;
 
 // Execute a given option rom.
 static void
-callrom(struct rom_header *rom, u16 offset, u16 bdf)
+__callrom(struct rom_header *rom, u16 offset, u16 bdf)
 {
     u16 seg = FLATPTR_TO_SEG(rom);
-    dprintf(1, "Running option rom at %x:%x\n", seg, offset);
+    dprintf(1, "Running option rom at %04x:%04x\n", seg, offset);
 
     struct bregs br;
     memset(&br, 0, sizeof(br));
+    br.flags = F_IF;
     br.ax = bdf;
     br.bx = 0xffff;
     br.dx = 0xffff;
     br.es = SEG_BIOS;
     br.di = get_pnp_offset();
-    br.cs = seg;
-    br.ip = offset;
+    br.code = SEGOFF(seg, offset);
+    start_preempt();
     call16big(&br);
+    finish_preempt();
 
     debug_serial_setup();
 }
 
+// Execute a given option rom at the standard entry vector.
+static void
+callrom(struct rom_header *rom, u16 bdf)
+{
+    __callrom(rom, OPTION_ROM_INITVECTOR, bdf);
+}
+
 // Execute a BCV option rom registered via add_bcv().
 void
 call_bcv(u16 seg, u16 ip)
 {
-    callrom(MAKE_FLATPTR(seg, 0), ip, 0);
+    __callrom(MAKE_FLATPTR(seg, 0), ip, 0);
 }
 
+static int EnforceChecksum;
+
 // Verify that an option rom looks valid
 static int
 is_valid_rom(struct rom_header *rom)
@@ -122,7 +82,8 @@ is_valid_rom(struct rom_header *rom)
     if (sum != 0) {
         dprintf(1, "Found option rom with bad checksum: loc=%p len=%d sum=%x\n"
                 , rom, len, sum);
-        return 0;
+        if (EnforceChecksum)
+            return 0;
     }
     return 1;
 }
@@ -131,7 +92,7 @@ is_valid_rom(struct rom_header *rom)
 static struct pnp_data *
 get_pnp_rom(struct rom_header *rom)
 {
-    struct pnp_data *pnp = (struct pnp_data *)((u8*)rom + rom->pnpoffset);
+    struct pnp_data *pnp = (void*)((u8*)rom + rom->pnpoffset);
     if (pnp->signature != PNP_SIGNATURE)
         return NULL;
     return pnp;
@@ -143,7 +104,7 @@ get_pnp_next(struct rom_header *rom, struct pnp_data *pnp)
 {
     if (! pnp->nextoffset)
         return NULL;
-    pnp = (struct pnp_data *)((u8*)rom + pnp->nextoffset);
+    pnp = (void*)((u8*)rom + pnp->nextoffset);
     if (pnp->signature != PNP_SIGNATURE)
         return NULL;
     return pnp;
@@ -153,10 +114,21 @@ get_pnp_next(struct rom_header *rom, struct pnp_data *pnp)
 static struct pci_data *
 get_pci_rom(struct rom_header *rom)
 {
-    struct pci_data *pci = (struct pci_data *)((u32)rom + rom->pcioffset);
-    if (pci->signature != PCI_ROM_SIGNATURE)
+    struct pci_data *pd = (void*)((u32)rom + rom->pcioffset);
+    if (pd->signature != PCI_ROM_SIGNATURE)
         return NULL;
-    return pci;
+    return pd;
+}
+
+// Return start of code in 0xc0000-0xf0000 space.
+static inline u32 _max_rom(void) {
+    extern u8 code32flat_start[], code32init_end[];
+    return CONFIG_RELOCATE_INIT ? (u32)code32init_end : (u32)code32flat_start;
+}
+// Return the memory position up to which roms may be located.
+static inline u32 max_rom(void) {
+    u32 end = _max_rom();
+    return end > BUILD_BIOS_ADDR ? BUILD_BIOS_ADDR : end;
 }
 
 // Copy a rom to its permanent location below 1MiB
@@ -164,45 +136,124 @@ static struct rom_header *
 copy_rom(struct rom_header *rom)
 {
     u32 romsize = rom->size * 512;
-    if (next_rom + romsize > BUILD_BIOS_ADDR) {
+    if (RomEnd + romsize > max_rom()) {
         // Option rom doesn't fit.
-        dprintf(1, "Option rom %p doesn't fit.\n", rom);
+        warn_noalloc();
         return NULL;
     }
     dprintf(4, "Copying option rom (size %d) from %p to %x\n"
-            , romsize, rom, next_rom);
-    memcpy4((void*)next_rom, rom, romsize);
-    return (struct rom_header *)next_rom;
+            , romsize, rom, RomEnd);
+    iomemcpy((void*)RomEnd, rom, romsize);
+    return (void*)RomEnd;
+}
+
+// Run rom init code and note rom size.
+static int
+init_optionrom(struct rom_header *rom, u16 bdf, int isvga)
+{
+    if (! is_valid_rom(rom))
+        return -1;
+
+    if (isvga || get_pnp_rom(rom))
+        // Only init vga and PnP roms here.
+        callrom(rom, bdf);
+
+    RomEnd = (u32)rom + ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
+
+    return 0;
+}
+
+#define RS_PCIROM (1LL<<33)
+
+static void
+setRomSource(u64 *sources, struct rom_header *rom, u64 source)
+{
+    if (sources)
+        sources[((u32)rom - BUILD_ROM_START) / OPTION_ROM_ALIGN] = source;
+}
+
+static int
+getRomPriority(u64 *sources, struct rom_header *rom, int instance)
+{
+    u64 source = sources[((u32)rom - BUILD_ROM_START) / OPTION_ROM_ALIGN];
+    if (!source)
+        return -1;
+    if (source & RS_PCIROM)
+        return bootprio_find_pci_rom((void*)(u32)source, instance);
+    return bootprio_find_named_rom(romfile_name(source), instance);
 }
 
-// Check if an option rom is at a hardcoded location for a device.
+
+/****************************************************************
+ * Roms in CBFS
+ ****************************************************************/
+
+// Check if an option rom is at a hardcoded location or in CBFS.
 static struct rom_header *
-lookup_hardcode(u32 vendev)
+lookup_hardcode(struct pci_device *pci)
 {
-    if (OPTIONROM_VENDEV_1
-        && ((OPTIONROM_VENDEV_1 >> 16)
-            | ((OPTIONROM_VENDEV_1 & 0xffff)) << 16) == vendev)
-        return copy_rom((struct rom_header *)OPTIONROM_MEM_1);
-    if (OPTIONROM_VENDEV_2
-        && ((OPTIONROM_VENDEV_2 >> 16)
-            | ((OPTIONROM_VENDEV_2 & 0xffff)) << 16) == vendev)
-        return copy_rom((struct rom_header *)OPTIONROM_MEM_2);
-    int ret = cbfs_copy_optionrom((void*)next_rom, BUILD_BIOS_ADDR - next_rom
-                                  , vendev);
-    if (ret < 0)
+    char fname[17];
+    snprintf(fname, sizeof(fname), "pci%04x,%04x.rom"
+             , pci->vendor, pci->device);
+    int ret = romfile_copy(romfile_find(fname), (void*)RomEnd
+                           , max_rom() - RomEnd);
+    if (ret <= 0)
         return NULL;
-    return (struct rom_header *)next_rom;
+    return (void*)RomEnd;
+}
+
+// Run all roms in a given CBFS directory.
+static void
+run_file_roms(const char *prefix, int isvga, u64 *sources)
+{
+    u32 file = 0;
+    for (;;) {
+        file = romfile_findprefix(prefix, file);
+        if (!file)
+            break;
+        struct rom_header *rom = (void*)RomEnd;
+        int ret = romfile_copy(file, rom, max_rom() - RomEnd);
+        if (ret > 0) {
+            setRomSource(sources, rom, file);
+            init_optionrom(rom, 0, isvga);
+        }
+    }
+}
+
+
+/****************************************************************
+ * PCI roms
+ ****************************************************************/
+
+// Verify device is a vga device with legacy address decoding enabled.
+static int
+is_pci_vga(struct pci_device *pci)
+{
+    if (pci->class != PCI_CLASS_DISPLAY_VGA)
+        return 0;
+    u16 cmd = pci_config_readw(pci->bdf, PCI_COMMAND);
+    if (!(cmd & PCI_COMMAND_IO && cmd & PCI_COMMAND_MEMORY))
+        return 0;
+    while (pci->parent) {
+        pci = pci->parent;
+        u32 ctrl = pci_config_readb(pci->bdf, PCI_BRIDGE_CONTROL);
+        if (!(ctrl & PCI_BRIDGE_CTL_VGA))
+            return 0;
+    }
+    return 1;
 }
 
 // Map the option rom of a given PCI device.
 static struct rom_header *
-map_optionrom(u16 bdf, u32 vendev)
+map_pcirom(struct pci_device *pci)
 {
-    dprintf(6, "Attempting to map option rom on dev %x\n", bdf);
+    u16 bdf = pci->bdf;
+    dprintf(6, "Attempting to map option rom on dev %02x:%02x.%x\n"
+            , pci_bdf_to_bus(bdf), pci_bdf_to_dev(bdf), pci_bdf_to_fn(bdf));
 
-    u8 htype = pci_config_readb(bdf, PCI_HEADER_TYPE);
-    if ((htype & 0x7f) != PCI_HEADER_TYPE_NORMAL) {
-        dprintf(6, "Skipping non-normal pci device (type=%x)\n", htype);
+    if ((pci->header_type & 0x7f) != PCI_HEADER_TYPE_NORMAL) {
+        dprintf(6, "Skipping non-normal pci device (type=%x)\n"
+                , pci->header_type);
         return NULL;
     }
 
@@ -225,31 +276,33 @@ map_optionrom(u16 bdf, u32 vendev)
     // Looks like a rom - enable it.
     pci_config_writel(bdf, PCI_ROM_ADDRESS, orig | PCI_ROM_ADDRESS_ENABLE);
 
-    struct rom_header *rom = (struct rom_header *)orig;
+    struct rom_header *rom = (void*)orig;
     for (;;) {
-        dprintf(5, "Inspecting possible rom at %p (dv=%x bdf=%x)\n"
-                , rom, vendev, bdf);
+        dprintf(5, "Inspecting possible rom at %p (vd=%04x:%04x"
+                " bdf=%02x:%02x.%x)\n"
+                , rom, pci->vendor, pci->device
+                , pci_bdf_to_bus(bdf), pci_bdf_to_dev(bdf), pci_bdf_to_fn(bdf));
         if (rom->signature != OPTION_ROM_SIGNATURE) {
             dprintf(6, "No option rom signature (got %x)\n", rom->signature);
             goto fail;
         }
-        struct pci_data *pci = get_pci_rom(rom);
-        if (! pci) {
+        struct pci_data *pd = get_pci_rom(rom);
+        if (! pd) {
             dprintf(6, "No valid pci signature found\n");
             goto fail;
         }
 
-        u32 vd = (pci->device << 16) | pci->vendor;
-        if (vd == vendev && pci->type == PCIROM_CODETYPE_X86)
+        if (pd->vendor == pci->vendor && pd->device == pci->device
+            && pd->type == PCIROM_CODETYPE_X86)
             // A match
             break;
-        dprintf(6, "Didn't match dev/ven (got %x) or type (got %d)\n"
-                , vd, pci->type);
-        if (pci->indicator & 0x80) {
+        dprintf(6, "Didn't match dev/ven (got %04x:%04x) or type (got %d)\n"
+                , pd->vendor, pd->device, pd->type);
+        if (pd->indicator & 0x80) {
             dprintf(6, "No more images left\n");
             goto fail;
         }
-        rom = (struct rom_header *)((u32)rom + pci->ilen * 512);
+        rom = (void*)((u32)rom + pd->ilen * 512);
     }
 
     rom = copy_rom(rom);
@@ -261,35 +314,22 @@ fail:
     return NULL;
 }
 
-// Adjust for the size of an option rom; allow it to resize.
-static struct rom_header *
-verifysize_optionrom(struct rom_header *rom, u16 bdf)
-{
-    if (! is_valid_rom(rom))
-        return NULL;
-
-    if (get_pnp_rom(rom))
-        // Init the PnP rom.
-        callrom(rom, OPTION_ROM_INITVECTOR, bdf);
-
-    next_rom += ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
-
-    return rom;
-}
-
 // Attempt to map and initialize the option rom on a given PCI device.
-static struct rom_header *
-init_optionrom(u16 bdf)
+static int
+init_pcirom(struct pci_device *pci, int isvga, u64 *sources)
 {
-    u32 vendev = pci_config_readl(bdf, PCI_VENDOR_ID);
-    dprintf(4, "Attempting to init PCI bdf %x (dev/ven %x)\n", bdf, vendev);
-    struct rom_header *rom = lookup_hardcode(vendev);
+    u16 bdf = pci->bdf;
+    dprintf(4, "Attempting to init PCI bdf %02x:%02x.%x (vd %04x:%04x)\n"
+            , pci_bdf_to_bus(bdf), pci_bdf_to_dev(bdf), pci_bdf_to_fn(bdf)
+            , pci->vendor, pci->device);
+    struct rom_header *rom = lookup_hardcode(pci);
     if (! rom)
-        rom = map_optionrom(bdf, vendev);
+        rom = map_pcirom(pci);
     if (! rom)
         // No ROM present.
-        return NULL;
-    return verifysize_optionrom(rom, bdf);
+        return -1;
+    setRomSource(sources, rom, RS_PCIROM | (u32)pci);
+    return init_optionrom(rom, bdf, isvga);
 }
 
 
@@ -298,56 +338,44 @@ init_optionrom(u16 bdf)
  ****************************************************************/
 
 void
-optionrom_setup()
+optionrom_setup(void)
 {
     if (! CONFIG_OPTIONROMS)
         return;
 
     dprintf(1, "Scan for option roms\n");
-
-    u32 post_vga = next_rom;
+    u64 sources[(BUILD_BIOS_ADDR - BUILD_ROM_START) / OPTION_ROM_ALIGN];
+    memset(sources, 0, sizeof(sources));
+    u32 post_vga = RomEnd;
 
     if (CONFIG_OPTIONROMS_DEPLOYED) {
         // Option roms are already deployed on the system.
-        u32 pos = next_rom;
-        while (pos < BUILD_BIOS_ADDR) {
-            struct rom_header *rom = (struct rom_header *)pos;
-            if (! is_valid_rom(rom)) {
+        u32 pos = RomEnd;
+        while (pos < max_rom()) {
+            int ret = init_optionrom((void*)pos, 0, 0);
+            if (ret)
                 pos += OPTION_ROM_ALIGN;
-                continue;
-            }
-            if (get_pnp_rom(rom))
-                callrom(rom, OPTION_ROM_INITVECTOR, 0);
-            pos += ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
-            next_rom = pos;
+            else
+                pos = RomEnd;
         }
     } else {
         // Find and deploy PCI roms.
-        int bdf, max;
-        foreachpci(bdf, max) {
-            u16 v = pci_config_readw(bdf, PCI_CLASS_DEVICE);
-            if (v == 0x0000 || v == 0xffff || v == PCI_CLASS_DISPLAY_VGA
-                || (CONFIG_ATA && v == PCI_CLASS_STORAGE_IDE))
+        struct pci_device *pci;
+        foreachpci(pci) {
+            if (pci->class == PCI_CLASS_DISPLAY_VGA || pci->have_driver)
                 continue;
-            init_optionrom(bdf);
+            init_pcirom(pci, 0, sources);
         }
 
         // Find and deploy CBFS roms not associated with a device.
-        struct cbfs_file *tmp = NULL;
-        for (;;) {
-            tmp = cbfs_copy_gen_optionrom(
-                (void*)next_rom, BUILD_BIOS_ADDR - next_rom, tmp);
-            if (!tmp)
-                break;
-            verifysize_optionrom((void*)next_rom, 0);
-        }
+        run_file_roms("genroms/", 0, sources);
     }
 
     // All option roms found and deployed - now build BEV/BCV vectors.
 
     u32 pos = post_vga;
-    while (pos < next_rom) {
-        struct rom_header *rom = (struct rom_header *)pos;
+    while (pos < RomEnd) {
+        struct rom_header *rom = (void*)pos;
         if (! is_valid_rom(rom)) {
             pos += OPTION_ROM_ALIGN;
             continue;
@@ -356,19 +384,23 @@ optionrom_setup()
         struct pnp_data *pnp = get_pnp_rom(rom);
         if (! pnp) {
             // Legacy rom.
-            add_bcv(FLATPTR_TO_SEG(rom), OPTION_ROM_INITVECTOR, 0);
+            boot_add_bcv(FLATPTR_TO_SEG(rom), OPTION_ROM_INITVECTOR, 0
+                         , getRomPriority(sources, rom, 0));
             continue;
         }
-        // PnP rom.
-        if (pnp->bev)
-            // Can boot system - add to IPL list.
-            add_bev(FLATPTR_TO_SEG(rom), pnp->bev, pnp->productname);
-        else
-            // Check for BCV (there may be multiple).
-            while (pnp && pnp->bcv) {
-                add_bcv(FLATPTR_TO_SEG(rom), pnp->bcv, pnp->productname);
-                pnp = get_pnp_next(rom, pnp);
-            }
+        // PnP rom - check for BEV and BCV boot capabilities.
+        int instance = 0;
+        while (pnp) {
+            if (pnp->bev)
+                boot_add_bev(FLATPTR_TO_SEG(rom), pnp->bev, pnp->productname
+                             , getRomPriority(sources, rom, instance++));
+            else if (pnp->bcv)
+                boot_add_bcv(FLATPTR_TO_SEG(rom), pnp->bcv, pnp->productname
+                             , getRomPriority(sources, rom, instance++));
+            else
+                break;
+            pnp = get_pnp_next(rom, pnp);
+        }
     }
 }
 
@@ -377,42 +409,60 @@ optionrom_setup()
  * VGA init
  ****************************************************************/
 
+static int S3ResumeVgaInit;
+int ScreenAndDebug;
+
 // Call into vga code to turn on console.
 void
-vga_setup()
+vga_setup(void)
 {
     if (! CONFIG_OPTIONROMS)
         return;
 
     dprintf(1, "Scan for VGA option rom\n");
-    next_rom = OPTION_ROM_START;
+
+    // Load some config settings that impact VGA.
+    EnforceChecksum = romfile_loadint("etc/optionroms-checksum", 1);
+    S3ResumeVgaInit = romfile_loadint("etc/s3-resume-vga-init", 0);
+    ScreenAndDebug = romfile_loadint("etc/screen-and-debug", 1);
 
     if (CONFIG_OPTIONROMS_DEPLOYED) {
         // Option roms are already deployed on the system.
-        struct rom_header *rom = (struct rom_header *)OPTION_ROM_START;
-        if (! is_valid_rom(rom))
-            return;
-        callrom(rom, OPTION_ROM_INITVECTOR, 0);
-        next_rom += ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
+        init_optionrom((void*)BUILD_ROM_START, 0, 1);
     } else {
+        // Clear option rom memory
+        memset((void*)RomEnd, 0, max_rom() - RomEnd);
+
         // Find and deploy PCI VGA rom.
-        int bdf = pci_find_class(PCI_CLASS_DISPLAY_VGA);
-        if (bdf < 0)
-            // Device not found
-            return;
-
-        struct rom_header *rom = init_optionrom(bdf);
-        if (rom && !get_pnp_rom(rom))
-            // Call rom even if it isn't a pnp rom.
-            callrom(rom, OPTION_ROM_INITVECTOR, bdf);
+        struct pci_device *pci;
+        foreachpci(pci) {
+            if (!is_pci_vga(pci))
+                continue;
+            vgahook_setup(pci);
+            init_pcirom(pci, 1, NULL);
+            break;
+        }
+
+        // Find and deploy CBFS vga-style roms not associated with a device.
+        run_file_roms("vgaroms/", 1, NULL);
     }
 
-    dprintf(1, "Turning on vga console\n");
-    struct bregs br;
-    memset(&br, 0, sizeof(br));
-    br.ax = 0x0003;
-    call16_int(0x10, &br);
+    if (RomEnd == BUILD_ROM_START) {
+        // No VGA rom found
+        RomEnd += OPTION_ROM_ALIGN;
+        return;
+    }
+
+    enable_vga_console();
+}
 
-    // Write to screen.
-    printf("Starting SeaBIOS\n\n");
+void
+s3_resume_vga_init(void)
+{
+    if (!S3ResumeVgaInit)
+        return;
+    struct rom_header *rom = (void*)BUILD_ROM_START;
+    if (! is_valid_rom(rom))
+        return;
+    callrom(rom, 0);
 }