1 // Option rom scanning code.
3 // Copyright (C) 2008 Kevin O'Connor <kevin@koconnor.net>
4 // Copyright (C) 2002 MandrakeSoft S.A.
6 // This file may be distributed under the terms of the GNU LGPLv3 license.
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_*
19 /****************************************************************
21 ****************************************************************/
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
74 // The end of the last deployed rom.
78 /****************************************************************
80 ****************************************************************/
82 // Execute a given option rom.
84 __callrom(struct rom_header *rom, u16 offset, u16 bdf)
86 u16 seg = FLATPTR_TO_SEG(rom);
87 dprintf(1, "Running option rom at %04x:%04x\n", seg, offset);
90 memset(&br, 0, sizeof(br));
96 br.di = get_pnp_offset();
97 br.code = SEGOFF(seg, offset);
102 debug_serial_setup();
105 // Execute a given option rom at the standard entry vector.
107 callrom(struct rom_header *rom, u16 bdf)
109 __callrom(rom, OPTION_ROM_INITVECTOR, bdf);
112 // Execute a BCV option rom registered via add_bcv().
114 call_bcv(u16 seg, u16 ip)
116 __callrom(MAKE_FLATPTR(seg, 0), ip, 0);
119 // Verify that an option rom looks valid
121 is_valid_rom(struct rom_header *rom)
123 dprintf(6, "Checking rom %p (sig %x size %d)\n"
124 , rom, rom->signature, rom->size);
125 if (rom->signature != OPTION_ROM_SIGNATURE)
129 u32 len = rom->size * 512;
130 u8 sum = checksum(rom, len);
132 dprintf(1, "Found option rom with bad checksum: loc=%p len=%d sum=%x\n"
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)
143 struct pnp_data *pnp = (void*)((u8*)rom + rom->pnpoffset);
144 if (pnp->signature != PNP_SIGNATURE)
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)
153 if (! pnp->nextoffset)
155 pnp = (void*)((u8*)rom + pnp->nextoffset);
156 if (pnp->signature != PNP_SIGNATURE)
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)
165 struct pci_data *pci = (void*)((u32)rom + rom->pcioffset);
166 if (pci->signature != PCI_ROM_SIGNATURE)
171 // Return the memory position up to which roms may be located.
175 extern u8 code32flat_start[];
176 if ((u32)code32flat_start > BUILD_BIOS_ADDR)
177 return BUILD_BIOS_ADDR;
178 return (u32)code32flat_start;
181 // Copy a rom to its permanent location below 1MiB
182 static struct rom_header *
183 copy_rom(struct rom_header *rom)
185 u32 romsize = rom->size * 512;
186 if (RomEnd + romsize > max_rom()) {
187 // Option rom doesn't fit.
191 dprintf(4, "Copying option rom (size %d) from %p to %x\n"
192 , romsize, rom, RomEnd);
193 iomemcpy((void*)RomEnd, rom, romsize);
194 return (void*)RomEnd;
197 // Run rom init code and note rom size.
199 init_optionrom(struct rom_header *rom, u16 bdf, int isvga)
201 if (! is_valid_rom(rom))
204 if (isvga || get_pnp_rom(rom))
205 // Only init vga and PnP roms here.
208 RomEnd = (u32)rom + ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
214 /****************************************************************
216 ****************************************************************/
218 // Check if an option rom is at a hardcoded location or in CBFS.
219 static struct rom_header *
220 lookup_hardcode(u32 vendev)
222 if (OPTIONROM_VENDEV_1
223 && ((OPTIONROM_VENDEV_1 >> 16)
224 | ((OPTIONROM_VENDEV_1 & 0xffff)) << 16) == vendev)
225 return copy_rom((void*)OPTIONROM_MEM_1);
226 if (OPTIONROM_VENDEV_2
227 && ((OPTIONROM_VENDEV_2 >> 16)
228 | ((OPTIONROM_VENDEV_2 & 0xffff)) << 16) == vendev)
229 return copy_rom((void*)OPTIONROM_MEM_2);
230 int ret = cbfs_copy_optionrom((void*)RomEnd, max_rom() - RomEnd, vendev);
233 return (void*)RomEnd;
236 // Run all roms in a given CBFS directory.
238 run_cbfs_roms(const char *prefix, int isvga)
240 struct cbfs_file *file = NULL;
242 file = cbfs_findprefix(prefix, file);
245 int ret = cbfs_copyfile(file, (void*)RomEnd, max_rom() - RomEnd);
247 init_optionrom((void*)RomEnd, 0, isvga);
252 run_qemu_roms(const char *prefix, int isvga)
254 struct QemuCfgFile entry;
255 int plen = strlen(prefix);
258 rc = qemu_cfg_first_file(&entry);
260 if (memcmp(prefix, entry.name, plen) == 0) {
261 dlen = qemu_cfg_read_file(&entry, (void*)RomEnd, max_rom() - RomEnd);
263 dprintf(1, "init qemu rom: %s\n", entry.name);
264 init_optionrom((void*)RomEnd, 0, isvga);
267 rc = qemu_cfg_next_file(&entry);
272 /****************************************************************
274 ****************************************************************/
276 // Map the option rom of a given PCI device.
277 static struct rom_header *
278 map_pcirom(u16 bdf, u32 vendev)
280 dprintf(6, "Attempting to map option rom on dev %02x:%02x.%x\n"
281 , pci_bdf_to_bus(bdf), pci_bdf_to_dev(bdf), pci_bdf_to_fn(bdf));
283 u8 htype = pci_config_readb(bdf, PCI_HEADER_TYPE);
284 if ((htype & 0x7f) != PCI_HEADER_TYPE_NORMAL) {
285 dprintf(6, "Skipping non-normal pci device (type=%x)\n", htype);
289 u32 orig = pci_config_readl(bdf, PCI_ROM_ADDRESS);
290 pci_config_writel(bdf, PCI_ROM_ADDRESS, ~PCI_ROM_ADDRESS_ENABLE);
291 u32 sz = pci_config_readl(bdf, PCI_ROM_ADDRESS);
293 dprintf(6, "Option rom sizing returned %x %x\n", orig, sz);
294 orig &= ~PCI_ROM_ADDRESS_ENABLE;
295 if (!sz || sz == 0xffffffff)
298 if (orig == sz || (u32)(orig + 4*1024*1024) < 20*1024*1024) {
299 // Don't try to map to a pci addresses at its max, in the last
300 // 4MiB of ram, or the first 16MiB of ram.
301 dprintf(6, "Preset rom address doesn't look valid\n");
305 // Looks like a rom - enable it.
306 pci_config_writel(bdf, PCI_ROM_ADDRESS, orig | PCI_ROM_ADDRESS_ENABLE);
308 struct rom_header *rom = (void*)orig;
310 dprintf(5, "Inspecting possible rom at %p (vd=%04x:%04x"
311 " bdf=%02x:%02x.%x)\n"
312 , rom, pci_vd_to_ven(vendev), pci_vd_to_dev(vendev)
313 , pci_bdf_to_bus(bdf), pci_bdf_to_dev(bdf), pci_bdf_to_fn(bdf));
314 if (rom->signature != OPTION_ROM_SIGNATURE) {
315 dprintf(6, "No option rom signature (got %x)\n", rom->signature);
318 struct pci_data *pci = get_pci_rom(rom);
320 dprintf(6, "No valid pci signature found\n");
324 u32 vd = pci_vd(pci->vendor, pci->device);
325 if (vd == vendev && pci->type == PCIROM_CODETYPE_X86)
328 dprintf(6, "Didn't match dev/ven (got %08x) or type (got %d)\n"
330 if (pci->indicator & 0x80) {
331 dprintf(6, "No more images left\n");
334 rom = (void*)((u32)rom + pci->ilen * 512);
338 pci_config_writel(bdf, PCI_ROM_ADDRESS, orig);
341 // Not valid - restore original and exit.
342 pci_config_writel(bdf, PCI_ROM_ADDRESS, orig);
346 // Attempt to map and initialize the option rom on a given PCI device.
348 init_pcirom(u16 bdf, int isvga)
350 u32 vendev = pci_config_readl(bdf, PCI_VENDOR_ID);
351 dprintf(4, "Attempting to init PCI bdf %02x:%02x.%x (vd %04x:%04x)\n"
352 , pci_bdf_to_bus(bdf), pci_bdf_to_dev(bdf), pci_bdf_to_fn(bdf)
353 , pci_vd_to_ven(vendev), pci_vd_to_dev(vendev));
354 struct rom_header *rom = lookup_hardcode(vendev);
356 rom = map_pcirom(bdf, vendev);
360 return init_optionrom(rom, bdf, isvga);
364 /****************************************************************
365 * Non-VGA option rom init
366 ****************************************************************/
369 optionrom_setup(void)
371 if (! CONFIG_OPTIONROMS)
374 dprintf(1, "Scan for option roms\n");
376 u32 post_vga = RomEnd;
378 if (CONFIG_OPTIONROMS_DEPLOYED) {
379 // Option roms are already deployed on the system.
381 while (pos < max_rom()) {
382 int ret = init_optionrom((void*)pos, 0, 0);
384 pos += OPTION_ROM_ALIGN;
389 // Find and deploy PCI roms.
391 foreachpci(bdf, max) {
392 u16 v = pci_config_readw(bdf, PCI_CLASS_DEVICE);
393 if (v == 0x0000 || v == 0xffff || v == PCI_CLASS_DISPLAY_VGA
394 || (CONFIG_ATA && v == PCI_CLASS_STORAGE_IDE))
399 // Find and deploy CBFS roms not associated with a device.
400 run_cbfs_roms("genroms/", 0);
401 run_qemu_roms("genroms/", 0);
404 // All option roms found and deployed - now build BEV/BCV vectors.
407 while (pos < RomEnd) {
408 struct rom_header *rom = (void*)pos;
409 if (! is_valid_rom(rom)) {
410 pos += OPTION_ROM_ALIGN;
413 pos += ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
414 struct pnp_data *pnp = get_pnp_rom(rom);
417 add_bcv(FLATPTR_TO_SEG(rom), OPTION_ROM_INITVECTOR, 0);
422 // Can boot system - add to IPL list.
423 add_bev(FLATPTR_TO_SEG(rom), pnp->bev, pnp->productname);
425 // Check for BCV (there may be multiple).
426 while (pnp && pnp->bcv) {
427 add_bcv(FLATPTR_TO_SEG(rom), pnp->bcv, pnp->productname);
428 pnp = get_pnp_next(rom, pnp);
434 /****************************************************************
436 ****************************************************************/
438 // Call into vga code to turn on console.
443 RomEnd = BUILD_ROM_START;
445 if (! CONFIG_OPTIONROMS)
448 dprintf(1, "Scan for VGA option rom\n");
450 if (CONFIG_OPTIONROMS_DEPLOYED) {
451 // Option roms are already deployed on the system.
452 init_optionrom((void*)BUILD_ROM_START, 0, 1);
454 // Find and deploy PCI VGA rom.
455 int bdf = VGAbdf = pci_find_vga();
459 // Find and deploy CBFS vga-style roms not associated with a device.
460 run_cbfs_roms("vgaroms/", 1);
461 run_qemu_roms("vgaroms/", 1);
464 if (RomEnd == BUILD_ROM_START) {
466 RomEnd += OPTION_ROM_ALIGN;
470 dprintf(1, "Turning on vga console\n");
472 memset(&br, 0, sizeof(br));
476 call16_int(0x10, &br);
480 printf("Starting SeaBIOS (version %s)\n\n", VERSION);
484 s3_resume_vga_init(void)
486 if (!CONFIG_S3_RESUME_VGA_INIT)
488 struct rom_header *rom = (void*)BUILD_ROM_START;
489 if (! is_valid_rom(rom))