| // Option rom scanning code. |
| // |
| // Copyright (C) 2008 Kevin O'Connor <kevin@koconnor.net> |
| // Copyright (C) 2002 MandrakeSoft S.A. |
| // |
| // This file may be distributed under the terms of the GNU LGPLv3 license. |
| |
| #include "bregs.h" // struct bregs |
| #include "farptr.h" // FLATPTR_TO_SEG |
| #include "config.h" // CONFIG_* |
| #include "util.h" // dprintf |
| #include "pci.h" // foreachpci |
| #include "pci_regs.h" // PCI_ROM_ADDRESS |
| #include "pci_ids.h" // PCI_CLASS_DISPLAY_VGA |
| #include "boot.h" // IPL |
| #include "optionroms.h" // struct rom_header |
| |
| |
| /**************************************************************** |
| * Helper functions |
| ****************************************************************/ |
| |
| // Execute a given option rom. |
| static void |
| __callrom(struct rom_header *rom, u16 offset, u16 bdf) |
| { |
| u16 seg = FLATPTR_TO_SEG(rom); |
| 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.code = SEGOFF(seg, offset); |
| start_preempt(); |
| farcall16big(&br); |
| finish_preempt(); |
| |
| debug_serial_preinit(); |
| } |
| |
| // Execute a given option rom at the standard entry vector. |
| 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); |
| } |
| |
| static int EnforceChecksum; |
| |
| // Verify that an option rom looks valid |
| static int |
| is_valid_rom(struct rom_header *rom) |
| { |
| dprintf(6, "Checking rom %p (sig %x size %d)\n" |
| , rom, rom->signature, rom->size); |
| if (rom->signature != OPTION_ROM_SIGNATURE) |
| return 0; |
| if (! rom->size) |
| return 0; |
| u32 len = rom->size * 512; |
| u8 sum = checksum(rom, len); |
| if (sum != 0) { |
| dprintf(1, "Found option rom with bad checksum: loc=%p len=%d sum=%x\n" |
| , rom, len, sum); |
| if (EnforceChecksum) |
| return 0; |
| } |
| return 1; |
| } |
| |
| // Check if a valid option rom has a pnp struct; return it if so. |
| static struct pnp_data * |
| get_pnp_rom(struct rom_header *rom) |
| { |
| struct pnp_data *pnp = (void*)((u8*)rom + rom->pnpoffset); |
| if (pnp->signature != PNP_SIGNATURE) |
| return NULL; |
| return pnp; |
| } |
| |
| // Check for multiple pnp option rom headers. |
| static struct pnp_data * |
| get_pnp_next(struct rom_header *rom, struct pnp_data *pnp) |
| { |
| if (! pnp->nextoffset) |
| return NULL; |
| pnp = (void*)((u8*)rom + pnp->nextoffset); |
| if (pnp->signature != PNP_SIGNATURE) |
| return NULL; |
| return pnp; |
| } |
| |
| // Check if a valid option rom has a pci struct; return it if so. |
| static struct pci_data * |
| get_pci_rom(struct rom_header *rom) |
| { |
| struct pci_data *pd = (void*)((u32)rom + rom->pcioffset); |
| if (pd->signature != PCI_ROM_SIGNATURE) |
| return NULL; |
| if (rom->pcioffset & 3) |
| dprintf(1, "WARNING! Found unaligned PCI rom (vd=%04x:%04x)\n" |
| , pd->vendor, pd->device); |
| return pd; |
| } |
| |
| // 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; |
| struct rom_header *newrom = rom_reserve(rom->size * 512); |
| if (!newrom) { |
| warn_noalloc(); |
| return -1; |
| } |
| if (newrom != rom) |
| memmove(newrom, rom, rom->size * 512); |
| |
| if (isvga || get_pnp_rom(newrom)) |
| // Only init vga and PnP roms here. |
| callrom(newrom, bdf); |
| |
| return rom_confirm(newrom->size * 512); |
| } |
| |
| #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); |
| struct romfile_s *file = (void*)(u32)source; |
| return bootprio_find_named_rom(file->name, instance); |
| } |
| |
| |
| /**************************************************************** |
| * Roms in CBFS |
| ****************************************************************/ |
| |
| static struct rom_header * |
| deploy_romfile(struct romfile_s *file) |
| { |
| u32 size = file->size; |
| struct rom_header *rom = rom_reserve(size); |
| if (!rom) { |
| warn_noalloc(); |
| return NULL; |
| } |
| int ret = file->copy(file, rom, size); |
| if (ret <= 0) |
| return NULL; |
| return rom; |
| } |
| |
| // Check if an option rom is at a hardcoded location or in CBFS. |
| static struct rom_header * |
| lookup_hardcode(struct pci_device *pci) |
| { |
| char fname[17]; |
| snprintf(fname, sizeof(fname), "pci%04x,%04x.rom" |
| , pci->vendor, pci->device); |
| struct romfile_s *file = romfile_find(fname); |
| if (file) |
| return deploy_romfile(file); |
| return NULL; |
| } |
| |
| // Run all roms in a given CBFS directory. |
| static void |
| run_file_roms(const char *prefix, int isvga, u64 *sources) |
| { |
| struct romfile_s *file = NULL; |
| for (;;) { |
| file = romfile_findprefix(prefix, file); |
| if (!file) |
| break; |
| struct rom_header *rom = deploy_romfile(file); |
| if (rom) { |
| setRomSource(sources, rom, (u32)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; |
| } |
| |
| // Copy a rom to its permanent location below 1MiB |
| static struct rom_header * |
| copy_rom(struct rom_header *rom) |
| { |
| u32 romsize = rom->size * 512; |
| struct rom_header *newrom = rom_reserve(romsize); |
| if (!newrom) { |
| warn_noalloc(); |
| return NULL; |
| } |
| dprintf(4, "Copying option rom (size %d) from %p to %p\n" |
| , romsize, rom, newrom); |
| iomemcpy(newrom, rom, romsize); |
| return newrom; |
| } |
| |
| // Map the option rom of a given PCI device. |
| static struct rom_header * |
| map_pcirom(struct pci_device *pci) |
| { |
| 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)); |
| |
| if ((pci->header_type & 0x7f) != PCI_HEADER_TYPE_NORMAL) { |
| dprintf(6, "Skipping non-normal pci device (type=%x)\n" |
| , pci->header_type); |
| return NULL; |
| } |
| |
| u32 orig = pci_config_readl(bdf, PCI_ROM_ADDRESS); |
| pci_config_writel(bdf, PCI_ROM_ADDRESS, ~PCI_ROM_ADDRESS_ENABLE); |
| u32 sz = pci_config_readl(bdf, PCI_ROM_ADDRESS); |
| |
| dprintf(6, "Option rom sizing returned %x %x\n", orig, sz); |
| orig &= ~PCI_ROM_ADDRESS_ENABLE; |
| if (!sz || sz == 0xffffffff) |
| goto fail; |
| |
| if (orig == sz || (u32)(orig + 4*1024*1024) < 20*1024*1024) { |
| // Don't try to map to a pci addresses at its max, in the last |
| // 4MiB of ram, or the first 16MiB of ram. |
| dprintf(6, "Preset rom address doesn't look valid\n"); |
| goto fail; |
| } |
| |
| // Looks like a rom - enable it. |
| pci_config_writel(bdf, PCI_ROM_ADDRESS, orig | PCI_ROM_ADDRESS_ENABLE); |
| |
| struct rom_header *rom = (void*)orig; |
| for (;;) { |
| 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 *pd = get_pci_rom(rom); |
| if (! pd) { |
| dprintf(6, "No valid pci signature found\n"); |
| goto fail; |
| } |
| |
| 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 %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 = (void*)((u32)rom + pd->ilen * 512); |
| } |
| |
| rom = copy_rom(rom); |
| pci_config_writel(bdf, PCI_ROM_ADDRESS, orig); |
| return rom; |
| fail: |
| // Not valid - restore original and exit. |
| pci_config_writel(bdf, PCI_ROM_ADDRESS, orig); |
| return NULL; |
| } |
| |
| // Attempt to map and initialize the option rom on a given PCI device. |
| static int |
| init_pcirom(struct pci_device *pci, int isvga, u64 *sources) |
| { |
| 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_pcirom(pci); |
| if (! rom) |
| // No ROM present. |
| return -1; |
| setRomSource(sources, rom, RS_PCIROM | (u32)pci); |
| return init_optionrom(rom, bdf, isvga); |
| } |
| |
| |
| /**************************************************************** |
| * Non-VGA option rom init |
| ****************************************************************/ |
| |
| void |
| optionrom_setup(void) |
| { |
| if (! CONFIG_OPTIONROMS) |
| return; |
| |
| dprintf(1, "Scan for option roms\n"); |
| u64 sources[(BUILD_BIOS_ADDR - BUILD_ROM_START) / OPTION_ROM_ALIGN]; |
| memset(sources, 0, sizeof(sources)); |
| u32 post_vga = rom_get_last(); |
| |
| if (CONFIG_OPTIONROMS_DEPLOYED) { |
| // Option roms are already deployed on the system. |
| u32 pos = post_vga; |
| while (pos < rom_get_max()) { |
| int ret = init_optionrom((void*)pos, 0, 0); |
| if (ret) |
| pos += OPTION_ROM_ALIGN; |
| else |
| pos = rom_get_last(); |
| } |
| } else { |
| // Find and deploy PCI roms. |
| struct pci_device *pci; |
| foreachpci(pci) { |
| if (pci->class == PCI_CLASS_DISPLAY_VGA || pci->have_driver) |
| continue; |
| init_pcirom(pci, 0, sources); |
| } |
| |
| // Find and deploy CBFS roms not associated with a device. |
| run_file_roms("genroms/", 0, sources); |
| } |
| rom_reserve(0); |
| |
| // All option roms found and deployed - now build BEV/BCV vectors. |
| |
| u32 pos = post_vga; |
| while (pos < rom_get_last()) { |
| struct rom_header *rom = (void*)pos; |
| if (! is_valid_rom(rom)) { |
| pos += OPTION_ROM_ALIGN; |
| continue; |
| } |
| pos += ALIGN(rom->size * 512, OPTION_ROM_ALIGN); |
| struct pnp_data *pnp = get_pnp_rom(rom); |
| if (! pnp) { |
| // Legacy rom. |
| boot_add_bcv(FLATPTR_TO_SEG(rom), OPTION_ROM_INITVECTOR, 0 |
| , getRomPriority(sources, rom, 0)); |
| continue; |
| } |
| // 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); |
| } |
| } |
| } |
| |
| |
| /**************************************************************** |
| * VGA init |
| ****************************************************************/ |
| |
| static int S3ResumeVga; |
| int ScreenAndDebug; |
| struct rom_header *VgaROM; |
| |
| // Call into vga code to turn on console. |
| void |
| vgarom_setup(void) |
| { |
| if (! CONFIG_OPTIONROMS) |
| return; |
| |
| dprintf(1, "Scan for VGA option rom\n"); |
| |
| // Load some config settings that impact VGA. |
| EnforceChecksum = romfile_loadint("etc/optionroms-checksum", 1); |
| S3ResumeVga = romfile_loadint("etc/s3-resume-vga-init", CONFIG_QEMU); |
| ScreenAndDebug = romfile_loadint("etc/screen-and-debug", 1); |
| |
| if (CONFIG_OPTIONROMS_DEPLOYED) { |
| // Option roms are already deployed on the system. |
| init_optionrom((void*)BUILD_ROM_START, 0, 1); |
| } else { |
| // Clear option rom memory |
| memset((void*)BUILD_ROM_START, 0, rom_get_max() - BUILD_ROM_START); |
| |
| // Find and deploy PCI VGA rom. |
| 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); |
| } |
| rom_reserve(0); |
| |
| if (rom_get_last() == BUILD_ROM_START) |
| // No VGA rom found |
| return; |
| |
| VgaROM = (void*)BUILD_ROM_START; |
| enable_vga_console(); |
| } |
| |
| void |
| s3_resume_vga(void) |
| { |
| if (!S3ResumeVga) |
| return; |
| if (!VgaROM || ! is_valid_rom(VgaROM)) |
| return; |
| callrom(VgaROM, 0); |
| } |