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 "config.h" // CONFIG_*
10 #include "farptr.h" // FLATPTR_TO_SEG
11 #include "hw/pci.h" // foreachpci
12 #include "hw/pci_ids.h" // PCI_CLASS_DISPLAY_VGA
13 #include "hw/pci_regs.h" // PCI_ROM_ADDRESS
14 #include "malloc.h" // rom_confirm
15 #include "output.h" // dprintf
16 #include "romfile.h" // romfile_loadint
17 #include "stacks.h" // farcall16big
18 #include "std/optionrom.h" // struct rom_header
19 #include "std/pnpbios.h" // PNP_SIGNATURE
20 #include "string.h" // memset
21 #include "util.h" // get_pnp_offset
24 /****************************************************************
26 ****************************************************************/
28 // Execute a given option rom.
30 __callrom(struct rom_header *rom, u16 offset, u16 bdf)
32 u16 seg = FLATPTR_TO_SEG(rom);
33 dprintf(1, "Running option rom at %04x:%04x\n", seg, offset);
36 memset(&br, 0, sizeof(br));
42 br.di = get_pnp_offset();
43 br.code = SEGOFF(seg, offset);
49 // Execute a given option rom at the standard entry vector.
51 callrom(struct rom_header *rom, u16 bdf)
53 __callrom(rom, OPTION_ROM_INITVECTOR, bdf);
56 // Execute a BCV option rom registered via add_bcv().
58 call_bcv(u16 seg, u16 ip)
60 __callrom(MAKE_FLATPTR(seg, 0), ip, 0);
63 static int EnforceChecksum;
65 // Verify that an option rom looks valid
67 is_valid_rom(struct rom_header *rom)
69 dprintf(6, "Checking rom %p (sig %x size %d)\n"
70 , rom, rom->signature, rom->size);
71 if (rom->signature != OPTION_ROM_SIGNATURE)
75 u32 len = rom->size * 512;
76 u8 sum = checksum(rom, len);
78 dprintf(1, "Found option rom with bad checksum: loc=%p len=%d sum=%x\n"
86 // Check if a valid option rom has a pnp struct; return it if so.
87 static struct pnp_data *
88 get_pnp_rom(struct rom_header *rom)
90 struct pnp_data *pnp = (void*)((u8*)rom + rom->pnpoffset);
91 if (pnp->signature != PNP_SIGNATURE)
96 // Check for multiple pnp option rom headers.
97 static struct pnp_data *
98 get_pnp_next(struct rom_header *rom, struct pnp_data *pnp)
100 if (! pnp->nextoffset)
102 pnp = (void*)((u8*)rom + pnp->nextoffset);
103 if (pnp->signature != PNP_SIGNATURE)
108 // Check if a valid option rom has a pci struct; return it if so.
109 static struct pci_data *
110 get_pci_rom(struct rom_header *rom)
112 struct pci_data *pd = (void*)((u32)rom + rom->pcioffset);
113 if (pd->signature != PCI_ROM_SIGNATURE)
115 if (rom->pcioffset & 3)
116 dprintf(1, "WARNING! Found unaligned PCI rom (vd=%04x:%04x)\n"
117 , pd->vendor, pd->device);
121 // Run rom init code and note rom size.
123 init_optionrom(struct rom_header *rom, u16 bdf, int isvga)
125 if (! is_valid_rom(rom))
127 struct rom_header *newrom = rom_reserve(rom->size * 512);
133 memmove(newrom, rom, rom->size * 512);
135 if (isvga || get_pnp_rom(newrom))
136 // Only init vga and PnP roms here.
137 callrom(newrom, bdf);
139 return rom_confirm(newrom->size * 512);
142 #define RS_PCIROM (1LL<<33)
145 setRomSource(u64 *sources, struct rom_header *rom, u64 source)
148 sources[((u32)rom - BUILD_ROM_START) / OPTION_ROM_ALIGN] = source;
152 getRomPriority(u64 *sources, struct rom_header *rom, int instance)
154 u64 source = sources[((u32)rom - BUILD_ROM_START) / OPTION_ROM_ALIGN];
157 if (source & RS_PCIROM)
158 return bootprio_find_pci_rom((void*)(u32)source, instance);
159 struct romfile_s *file = (void*)(u32)source;
160 return bootprio_find_named_rom(file->name, instance);
164 /****************************************************************
166 ****************************************************************/
168 static struct rom_header *
169 deploy_romfile(struct romfile_s *file)
171 u32 size = file->size;
172 struct rom_header *rom = rom_reserve(size);
177 int ret = file->copy(file, rom, size);
183 // Check if an option rom is at a hardcoded location or in CBFS.
184 static struct rom_header *
185 lookup_hardcode(struct pci_device *pci)
188 snprintf(fname, sizeof(fname), "pci%04x,%04x.rom"
189 , pci->vendor, pci->device);
190 struct romfile_s *file = romfile_find(fname);
192 return deploy_romfile(file);
196 // Run all roms in a given CBFS directory.
198 run_file_roms(const char *prefix, int isvga, u64 *sources)
200 struct romfile_s *file = NULL;
202 file = romfile_findprefix(prefix, file);
205 struct rom_header *rom = deploy_romfile(file);
207 setRomSource(sources, rom, (u32)file);
208 init_optionrom(rom, 0, isvga);
214 /****************************************************************
216 ****************************************************************/
218 // Verify device is a vga device with legacy address decoding enabled.
220 is_pci_vga(struct pci_device *pci)
222 if (pci->class != PCI_CLASS_DISPLAY_VGA)
224 u16 cmd = pci_config_readw(pci->bdf, PCI_COMMAND);
225 if (!(cmd & PCI_COMMAND_IO && cmd & PCI_COMMAND_MEMORY))
227 while (pci->parent) {
229 u32 ctrl = pci_config_readb(pci->bdf, PCI_BRIDGE_CONTROL);
230 if (!(ctrl & PCI_BRIDGE_CTL_VGA))
236 // Copy a rom to its permanent location below 1MiB
237 static struct rom_header *
238 copy_rom(struct rom_header *rom)
240 u32 romsize = rom->size * 512;
241 struct rom_header *newrom = rom_reserve(romsize);
246 dprintf(4, "Copying option rom (size %d) from %p to %p\n"
247 , romsize, rom, newrom);
248 iomemcpy(newrom, rom, romsize);
252 // Map the option rom of a given PCI device.
253 static struct rom_header *
254 map_pcirom(struct pci_device *pci)
257 dprintf(6, "Attempting to map option rom on dev %02x:%02x.%x\n"
258 , pci_bdf_to_bus(bdf), pci_bdf_to_dev(bdf), pci_bdf_to_fn(bdf));
260 if ((pci->header_type & 0x7f) != PCI_HEADER_TYPE_NORMAL) {
261 dprintf(6, "Skipping non-normal pci device (type=%x)\n"
266 u32 orig = pci_config_readl(bdf, PCI_ROM_ADDRESS);
267 pci_config_writel(bdf, PCI_ROM_ADDRESS, ~PCI_ROM_ADDRESS_ENABLE);
268 u32 sz = pci_config_readl(bdf, PCI_ROM_ADDRESS);
270 dprintf(6, "Option rom sizing returned %x %x\n", orig, sz);
271 orig &= ~PCI_ROM_ADDRESS_ENABLE;
272 if (!sz || sz == 0xffffffff)
275 if (orig == sz || (u32)(orig + 4*1024*1024) < 20*1024*1024) {
276 // Don't try to map to a pci addresses at its max, in the last
277 // 4MiB of ram, or the first 16MiB of ram.
278 dprintf(6, "Preset rom address doesn't look valid\n");
282 // Looks like a rom - enable it.
283 pci_config_writel(bdf, PCI_ROM_ADDRESS, orig | PCI_ROM_ADDRESS_ENABLE);
285 struct rom_header *rom = (void*)orig;
287 dprintf(5, "Inspecting possible rom at %p (vd=%04x:%04x"
288 " bdf=%02x:%02x.%x)\n"
289 , rom, pci->vendor, pci->device
290 , pci_bdf_to_bus(bdf), pci_bdf_to_dev(bdf), pci_bdf_to_fn(bdf));
291 if (rom->signature != OPTION_ROM_SIGNATURE) {
292 dprintf(6, "No option rom signature (got %x)\n", rom->signature);
295 struct pci_data *pd = get_pci_rom(rom);
297 dprintf(6, "No valid pci signature found\n");
301 if (pd->vendor == pci->vendor && pd->device == pci->device
302 && pd->type == PCIROM_CODETYPE_X86)
305 dprintf(6, "Didn't match dev/ven (got %04x:%04x) or type (got %d)\n"
306 , pd->vendor, pd->device, pd->type);
307 if (pd->indicator & 0x80) {
308 dprintf(6, "No more images left\n");
311 rom = (void*)((u32)rom + pd->ilen * 512);
315 pci_config_writel(bdf, PCI_ROM_ADDRESS, orig);
318 // Not valid - restore original and exit.
319 pci_config_writel(bdf, PCI_ROM_ADDRESS, orig);
323 // Attempt to map and initialize the option rom on a given PCI device.
325 init_pcirom(struct pci_device *pci, int isvga, u64 *sources)
328 dprintf(4, "Attempting to init PCI bdf %02x:%02x.%x (vd %04x:%04x)\n"
329 , pci_bdf_to_bus(bdf), pci_bdf_to_dev(bdf), pci_bdf_to_fn(bdf)
330 , pci->vendor, pci->device);
331 struct rom_header *rom = lookup_hardcode(pci);
333 rom = map_pcirom(pci);
337 setRomSource(sources, rom, RS_PCIROM | (u32)pci);
338 return init_optionrom(rom, bdf, isvga);
342 /****************************************************************
343 * Non-VGA option rom init
344 ****************************************************************/
347 optionrom_setup(void)
349 if (! CONFIG_OPTIONROMS)
352 dprintf(1, "Scan for option roms\n");
353 u64 sources[(BUILD_BIOS_ADDR - BUILD_ROM_START) / OPTION_ROM_ALIGN];
354 memset(sources, 0, sizeof(sources));
355 u32 post_vga = rom_get_last();
357 if (CONFIG_OPTIONROMS_DEPLOYED) {
358 // Option roms are already deployed on the system.
360 while (pos < rom_get_max()) {
361 int ret = init_optionrom((void*)pos, 0, 0);
363 pos += OPTION_ROM_ALIGN;
365 pos = rom_get_last();
368 // Find and deploy PCI roms.
369 struct pci_device *pci;
371 if (pci->class == PCI_CLASS_DISPLAY_VGA || pci->have_driver)
373 init_pcirom(pci, 0, sources);
376 // Find and deploy CBFS roms not associated with a device.
377 run_file_roms("genroms/", 0, sources);
381 // All option roms found and deployed - now build BEV/BCV vectors.
384 while (pos < rom_get_last()) {
385 struct rom_header *rom = (void*)pos;
386 if (! is_valid_rom(rom)) {
387 pos += OPTION_ROM_ALIGN;
390 pos += ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
391 struct pnp_data *pnp = get_pnp_rom(rom);
394 boot_add_bcv(FLATPTR_TO_SEG(rom), OPTION_ROM_INITVECTOR, 0
395 , getRomPriority(sources, rom, 0));
398 // PnP rom - check for BEV and BCV boot capabilities.
402 boot_add_bev(FLATPTR_TO_SEG(rom), pnp->bev, pnp->productname
403 , getRomPriority(sources, rom, instance++));
405 boot_add_bcv(FLATPTR_TO_SEG(rom), pnp->bcv, pnp->productname
406 , getRomPriority(sources, rom, instance++));
409 pnp = get_pnp_next(rom, pnp);
415 /****************************************************************
417 ****************************************************************/
419 static int S3ResumeVga;
421 struct rom_header *VgaROM;
423 // Call into vga code to turn on console.
427 if (! CONFIG_OPTIONROMS)
430 dprintf(1, "Scan for VGA option rom\n");
432 // Load some config settings that impact VGA.
433 EnforceChecksum = romfile_loadint("etc/optionroms-checksum", 1);
434 S3ResumeVga = romfile_loadint("etc/s3-resume-vga-init", CONFIG_QEMU);
435 ScreenAndDebug = romfile_loadint("etc/screen-and-debug", 1);
437 if (CONFIG_OPTIONROMS_DEPLOYED) {
438 // Option roms are already deployed on the system.
439 init_optionrom((void*)BUILD_ROM_START, 0, 1);
441 // Clear option rom memory
442 memset((void*)BUILD_ROM_START, 0, rom_get_max() - BUILD_ROM_START);
444 // Find and deploy PCI VGA rom.
445 struct pci_device *pci;
447 if (!is_pci_vga(pci))
450 init_pcirom(pci, 1, NULL);
454 // Find and deploy CBFS vga-style roms not associated with a device.
455 run_file_roms("vgaroms/", 1, NULL);
459 if (rom_get_last() == BUILD_ROM_START)
463 VgaROM = (void*)BUILD_ROM_START;
464 enable_vga_console();
472 if (!VgaROM || ! is_valid_rom(VgaROM))