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
18 /****************************************************************
20 ****************************************************************/
67 #define OPTION_ROM_SIGNATURE 0xaa55
68 #define OPTION_ROM_ALIGN 2048
69 #define OPTION_ROM_INITVECTOR offsetof(struct rom_header, initVector[0])
70 #define PCI_ROM_SIGNATURE 0x52494350 // PCIR
71 #define PCIROM_CODETYPE_X86 0
73 // The end of the last deployed rom.
77 /****************************************************************
79 ****************************************************************/
81 // Execute a given option rom.
83 __callrom(struct rom_header *rom, u16 offset, u16 bdf)
85 u16 seg = FLATPTR_TO_SEG(rom);
86 dprintf(1, "Running option rom at %04x:%04x\n", seg, offset);
89 memset(&br, 0, sizeof(br));
95 br.di = get_pnp_offset();
96 br.code = SEGOFF(seg, offset);
102 // Execute a given option rom at the standard entry vector.
104 callrom(struct rom_header *rom, u16 bdf)
106 __callrom(rom, OPTION_ROM_INITVECTOR, bdf);
109 // Execute a BCV option rom registered via add_bcv().
111 call_bcv(u16 seg, u16 ip)
113 __callrom(MAKE_FLATPTR(seg, 0), ip, 0);
116 // Verify that an option rom looks valid
118 is_valid_rom(struct rom_header *rom)
120 dprintf(6, "Checking rom %p (sig %x size %d)\n"
121 , rom, rom->signature, rom->size);
122 if (rom->signature != OPTION_ROM_SIGNATURE)
126 u32 len = rom->size * 512;
127 u8 sum = checksum(rom, len);
129 dprintf(1, "Found option rom with bad checksum: loc=%p len=%d sum=%x\n"
136 // Check if a valid option rom has a pnp struct; return it if so.
137 static struct pnp_data *
138 get_pnp_rom(struct rom_header *rom)
140 struct pnp_data *pnp = (void*)((u8*)rom + rom->pnpoffset);
141 if (pnp->signature != PNP_SIGNATURE)
146 // Check for multiple pnp option rom headers.
147 static struct pnp_data *
148 get_pnp_next(struct rom_header *rom, struct pnp_data *pnp)
150 if (! pnp->nextoffset)
152 pnp = (void*)((u8*)rom + pnp->nextoffset);
153 if (pnp->signature != PNP_SIGNATURE)
158 // Check if a valid option rom has a pci struct; return it if so.
159 static struct pci_data *
160 get_pci_rom(struct rom_header *rom)
162 struct pci_data *pci = (void*)((u32)rom + rom->pcioffset);
163 if (pci->signature != PCI_ROM_SIGNATURE)
168 // Return the memory position up to which roms may be located.
172 extern u8 code32_start[];
173 if ((u32)code32_start > BUILD_BIOS_ADDR)
174 return BUILD_BIOS_ADDR;
175 return (u32)code32_start;
178 // Copy a rom to its permanent location below 1MiB
179 static struct rom_header *
180 copy_rom(struct rom_header *rom)
182 u32 romsize = rom->size * 512;
183 if (RomEnd + romsize > max_rom()) {
184 // Option rom doesn't fit.
185 dprintf(1, "Option rom %p doesn't fit.\n", rom);
188 dprintf(4, "Copying option rom (size %d) from %p to %x\n"
189 , romsize, rom, RomEnd);
190 iomemcpy((void*)RomEnd, rom, romsize);
191 return (void*)RomEnd;
194 // Run rom init code and note rom size.
196 init_optionrom(struct rom_header *rom, u16 bdf, int isvga)
198 if (! is_valid_rom(rom))
201 if (isvga || get_pnp_rom(rom))
202 // Only init vga and PnP roms here.
205 RomEnd = (u32)rom + ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
211 /****************************************************************
213 ****************************************************************/
215 // Check if an option rom is at a hardcoded location or in CBFS.
216 static struct rom_header *
217 lookup_hardcode(u32 vendev)
219 if (OPTIONROM_VENDEV_1
220 && ((OPTIONROM_VENDEV_1 >> 16)
221 | ((OPTIONROM_VENDEV_1 & 0xffff)) << 16) == vendev)
222 return copy_rom((void*)OPTIONROM_MEM_1);
223 if (OPTIONROM_VENDEV_2
224 && ((OPTIONROM_VENDEV_2 >> 16)
225 | ((OPTIONROM_VENDEV_2 & 0xffff)) << 16) == vendev)
226 return copy_rom((void*)OPTIONROM_MEM_2);
227 int ret = cbfs_copy_optionrom((void*)RomEnd, max_rom() - RomEnd, vendev);
230 return (void*)RomEnd;
233 // Run all roms in a given CBFS directory.
235 run_cbfs_roms(const char *prefix, int isvga)
237 struct cbfs_file *file = NULL;
239 file = cbfs_findprefix(prefix, file);
242 int ret = cbfs_copyfile(file, (void*)RomEnd, max_rom() - RomEnd);
244 init_optionrom((void*)RomEnd, 0, isvga);
249 /****************************************************************
251 ****************************************************************/
253 // Map the option rom of a given PCI device.
254 static struct rom_header *
255 map_pcirom(u16 bdf, u32 vendev)
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 u8 htype = pci_config_readb(bdf, PCI_HEADER_TYPE);
261 if ((htype & 0x7f) != PCI_HEADER_TYPE_NORMAL) {
262 dprintf(6, "Skipping non-normal pci device (type=%x)\n", htype);
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 (dv=%08x bdf=%x)\n"
289 if (rom->signature != OPTION_ROM_SIGNATURE) {
290 dprintf(6, "No option rom signature (got %x)\n", rom->signature);
293 struct pci_data *pci = get_pci_rom(rom);
295 dprintf(6, "No valid pci signature found\n");
299 u32 vd = (pci->device << 16) | pci->vendor;
300 if (vd == vendev && pci->type == PCIROM_CODETYPE_X86)
303 dprintf(6, "Didn't match dev/ven (got %08x) or type (got %d)\n"
305 if (pci->indicator & 0x80) {
306 dprintf(6, "No more images left\n");
309 rom = (void*)((u32)rom + pci->ilen * 512);
313 pci_config_writel(bdf, PCI_ROM_ADDRESS, orig);
316 // Not valid - restore original and exit.
317 pci_config_writel(bdf, PCI_ROM_ADDRESS, orig);
321 // Attempt to map and initialize the option rom on a given PCI device.
323 init_pcirom(u16 bdf, int isvga)
325 u32 vendev = pci_config_readl(bdf, PCI_VENDOR_ID);
326 dprintf(4, "Attempting to init PCI bdf %02x:%02x.%x (dev/ven %08x)\n"
327 , pci_bdf_to_bus(bdf), pci_bdf_to_dev(bdf), pci_bdf_to_fn(bdf)
329 struct rom_header *rom = lookup_hardcode(vendev);
331 rom = map_pcirom(bdf, vendev);
335 return init_optionrom(rom, bdf, isvga);
339 /****************************************************************
340 * Non-VGA option rom init
341 ****************************************************************/
346 if (! CONFIG_OPTIONROMS)
349 dprintf(1, "Scan for option roms\n");
351 u32 post_vga = RomEnd;
353 if (CONFIG_OPTIONROMS_DEPLOYED) {
354 // Option roms are already deployed on the system.
356 while (pos < max_rom()) {
357 int ret = init_optionrom((void*)pos, 0, 0);
359 pos += OPTION_ROM_ALIGN;
364 // Find and deploy PCI roms.
366 foreachpci(bdf, max) {
367 u16 v = pci_config_readw(bdf, PCI_CLASS_DEVICE);
368 if (v == 0x0000 || v == 0xffff || v == PCI_CLASS_DISPLAY_VGA
369 || (CONFIG_ATA && v == PCI_CLASS_STORAGE_IDE))
374 // Find and deploy CBFS roms not associated with a device.
375 run_cbfs_roms("genroms/", 0);
378 // All option roms found and deployed - now build BEV/BCV vectors.
381 while (pos < RomEnd) {
382 struct rom_header *rom = (void*)pos;
383 if (! is_valid_rom(rom)) {
384 pos += OPTION_ROM_ALIGN;
387 pos += ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
388 struct pnp_data *pnp = get_pnp_rom(rom);
391 add_bcv(FLATPTR_TO_SEG(rom), OPTION_ROM_INITVECTOR, 0);
396 // Can boot system - add to IPL list.
397 add_bev(FLATPTR_TO_SEG(rom), pnp->bev, pnp->productname);
399 // Check for BCV (there may be multiple).
400 while (pnp && pnp->bcv) {
401 add_bcv(FLATPTR_TO_SEG(rom), pnp->bcv, pnp->productname);
402 pnp = get_pnp_next(rom, pnp);
408 /****************************************************************
410 ****************************************************************/
412 // Call into vga code to turn on console.
417 RomEnd = BUILD_ROM_START;
419 if (! CONFIG_OPTIONROMS)
422 dprintf(1, "Scan for VGA option rom\n");
424 if (CONFIG_OPTIONROMS_DEPLOYED) {
425 // Option roms are already deployed on the system.
426 init_optionrom((void*)BUILD_ROM_START, 0, 1);
428 // Find and deploy PCI VGA rom.
429 int bdf = VGAbdf = pci_find_vga();
433 // Find and deploy CBFS vga-style roms not associated with a device.
434 run_cbfs_roms("vgaroms/", 1);
437 if (RomEnd == BUILD_ROM_START) {
439 RomEnd += OPTION_ROM_ALIGN;
443 dprintf(1, "Turning on vga console\n");
445 memset(&br, 0, sizeof(br));
448 call16_int(0x10, &br);
451 printf("Starting SeaBIOS (version %s)\n\n", VERSION);
457 if (!CONFIG_S3_RESUME_VGA_INIT)
459 struct rom_header *rom = (void*)BUILD_ROM_START;
460 if (! is_valid_rom(rom))