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" // foreachbdf
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.
75 u32 RomEnd = BUILD_ROM_START;
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"
134 if (CONFIG_OPTIONROMS_CHECKSUM)
140 // Check if a valid option rom has a pnp struct; return it if so.
141 static struct pnp_data *
142 get_pnp_rom(struct rom_header *rom)
144 struct pnp_data *pnp = (void*)((u8*)rom + rom->pnpoffset);
145 if (pnp->signature != PNP_SIGNATURE)
150 // Check for multiple pnp option rom headers.
151 static struct pnp_data *
152 get_pnp_next(struct rom_header *rom, struct pnp_data *pnp)
154 if (! pnp->nextoffset)
156 pnp = (void*)((u8*)rom + pnp->nextoffset);
157 if (pnp->signature != PNP_SIGNATURE)
162 // Check if a valid option rom has a pci struct; return it if so.
163 static struct pci_data *
164 get_pci_rom(struct rom_header *rom)
166 struct pci_data *pci = (void*)((u32)rom + rom->pcioffset);
167 if (pci->signature != PCI_ROM_SIGNATURE)
172 // Return start of code in 0xc0000-0xf0000 space.
173 static inline u32 _max_rom(void) {
174 extern u8 code32flat_start[], code32init_end[];
175 return CONFIG_RELOCATE_INIT ? (u32)code32init_end : (u32)code32flat_start;
177 // Return the memory position up to which roms may be located.
178 static inline u32 max_rom(void) {
179 u32 end = _max_rom();
180 return end > BUILD_BIOS_ADDR ? BUILD_BIOS_ADDR : end;
183 // Copy a rom to its permanent location below 1MiB
184 static struct rom_header *
185 copy_rom(struct rom_header *rom)
187 u32 romsize = rom->size * 512;
188 if (RomEnd + romsize > max_rom()) {
189 // Option rom doesn't fit.
193 dprintf(4, "Copying option rom (size %d) from %p to %x\n"
194 , romsize, rom, RomEnd);
195 iomemcpy((void*)RomEnd, rom, romsize);
196 return (void*)RomEnd;
199 // Run rom init code and note rom size.
201 init_optionrom(struct rom_header *rom, u16 bdf, int isvga)
203 if (! is_valid_rom(rom))
206 if (isvga || get_pnp_rom(rom))
207 // Only init vga and PnP roms here.
210 RomEnd = (u32)rom + ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
215 #define RS_PCIROM (1LL<<33)
218 setRomSource(u64 *sources, struct rom_header *rom, u64 source)
221 sources[((u32)rom - BUILD_ROM_START) / OPTION_ROM_ALIGN] = source;
225 getRomPriority(u64 *sources, struct rom_header *rom, int instance)
227 u64 source = sources[((u32)rom - BUILD_ROM_START) / OPTION_ROM_ALIGN];
230 if (source & RS_PCIROM)
231 return bootprio_find_pci_rom(source, instance);
232 return bootprio_find_named_rom(romfile_name(source), instance);
235 /****************************************************************
237 ****************************************************************/
239 // Check if an option rom is at a hardcoded location or in CBFS.
240 static struct rom_header *
241 lookup_hardcode(u32 vendev)
244 snprintf(fname, sizeof(fname), "pci%04x,%04x.rom"
245 , pci_vd_to_ven(vendev), pci_vd_to_dev(vendev));
246 int ret = romfile_copy(romfile_find(fname), (void*)RomEnd
247 , max_rom() - RomEnd);
250 return (void*)RomEnd;
253 // Run all roms in a given CBFS directory.
255 run_file_roms(const char *prefix, int isvga, u64 *sources)
259 file = romfile_findprefix(prefix, file);
262 struct rom_header *rom = (void*)RomEnd;
263 int ret = romfile_copy(file, rom, max_rom() - RomEnd);
265 setRomSource(sources, rom, file);
266 init_optionrom(rom, 0, isvga);
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, u64 *sources)
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 setRomSource(sources, rom, RS_PCIROM | bdf);
361 return init_optionrom(rom, bdf, isvga);
365 /****************************************************************
366 * Non-VGA option rom init
367 ****************************************************************/
370 optionrom_setup(void)
372 if (! CONFIG_OPTIONROMS)
375 dprintf(1, "Scan for option roms\n");
376 u64 sources[(BUILD_BIOS_ADDR - BUILD_ROM_START) / OPTION_ROM_ALIGN];
377 memset(sources, 0, sizeof(sources));
378 u32 post_vga = RomEnd;
380 if (CONFIG_OPTIONROMS_DEPLOYED) {
381 // Option roms are already deployed on the system.
383 while (pos < max_rom()) {
384 int ret = init_optionrom((void*)pos, 0, 0);
386 pos += OPTION_ROM_ALIGN;
391 // Find and deploy PCI roms.
393 foreachbdf(bdf, max) {
394 u16 v = pci_config_readw(bdf, PCI_CLASS_DEVICE);
395 if (v == 0x0000 || v == 0xffff || v == PCI_CLASS_DISPLAY_VGA
396 || (CONFIG_ATA && v == PCI_CLASS_STORAGE_IDE))
398 init_pcirom(bdf, 0, sources);
401 // Find and deploy CBFS roms not associated with a device.
402 run_file_roms("genroms/", 0, sources);
405 // All option roms found and deployed - now build BEV/BCV vectors.
408 while (pos < RomEnd) {
409 struct rom_header *rom = (void*)pos;
410 if (! is_valid_rom(rom)) {
411 pos += OPTION_ROM_ALIGN;
414 pos += ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
415 struct pnp_data *pnp = get_pnp_rom(rom);
418 boot_add_bcv(FLATPTR_TO_SEG(rom), OPTION_ROM_INITVECTOR, 0
419 , getRomPriority(sources, rom, 0));
424 // Can boot system - add to IPL list.
425 boot_add_bev(FLATPTR_TO_SEG(rom), pnp->bev, pnp->productname
426 , getRomPriority(sources, rom, 0));
428 // Check for BCV (there may be multiple).
430 while (pnp && pnp->bcv) {
431 boot_add_bcv(FLATPTR_TO_SEG(rom), pnp->bcv, pnp->productname
432 , getRomPriority(sources, rom, instance++));
433 pnp = get_pnp_next(rom, pnp);
440 /****************************************************************
442 ****************************************************************/
444 // Call into vga code to turn on console.
448 if (! CONFIG_OPTIONROMS)
451 dprintf(1, "Scan for VGA option rom\n");
453 if (CONFIG_OPTIONROMS_DEPLOYED) {
454 // Option roms are already deployed on the system.
455 init_optionrom((void*)BUILD_ROM_START, 0, 1);
457 // Clear option rom memory
458 memset((void*)RomEnd, 0, _max_rom() - RomEnd);
460 // Find and deploy PCI VGA rom.
461 int bdf = VGAbdf = pci_find_vga();
463 init_pcirom(bdf, 1, NULL);
465 // Find and deploy CBFS vga-style roms not associated with a device.
466 run_file_roms("vgaroms/", 1, NULL);
469 if (RomEnd == BUILD_ROM_START) {
471 RomEnd += OPTION_ROM_ALIGN;
475 enable_vga_console();
479 s3_resume_vga_init(void)
481 if (!CONFIG_S3_RESUME_VGA_INIT)
483 struct rom_header *rom = (void*)BUILD_ROM_START;
484 if (! is_valid_rom(rom))