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" // pci_find_class
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_START 0xc0000
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 // Next available position for an option 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 %x:%x\n", seg, offset);
90 memset(&br, 0, sizeof(br));
95 br.di = get_pnp_offset();
100 debug_serial_setup();
103 // Execute a BCV option rom registered via add_bcv().
105 call_bcv(u16 seg, u16 ip)
107 callrom(MAKE_FLATPTR(seg, 0), ip, 0);
110 // Verify that an option rom looks valid
112 is_valid_rom(struct rom_header *rom)
114 dprintf(6, "Checking rom %p (sig %x size %d)\n"
115 , rom, rom->signature, rom->size);
116 if (rom->signature != OPTION_ROM_SIGNATURE)
120 u32 len = rom->size * 512;
121 u8 sum = checksum(rom, len);
123 dprintf(1, "Found option rom with bad checksum: loc=%p len=%d sum=%x\n"
130 // Check if a valid option rom has a pnp struct; return it if so.
131 static struct pnp_data *
132 get_pnp_rom(struct rom_header *rom)
134 struct pnp_data *pnp = (struct pnp_data *)((u8*)rom + rom->pnpoffset);
135 if (pnp->signature != PNP_SIGNATURE)
140 // Check for multiple pnp option rom headers.
141 static struct pnp_data *
142 get_pnp_next(struct rom_header *rom, struct pnp_data *pnp)
144 if (! pnp->nextoffset)
146 pnp = (struct pnp_data *)((u8*)rom + pnp->nextoffset);
147 if (pnp->signature != PNP_SIGNATURE)
152 // Check if a valid option rom has a pci struct; return it if so.
153 static struct pci_data *
154 get_pci_rom(struct rom_header *rom)
156 struct pci_data *pci = (struct pci_data *)((u32)rom + rom->pcioffset);
157 if (pci->signature != PCI_ROM_SIGNATURE)
162 // Copy a rom to its permanent location below 1MiB
163 static struct rom_header *
164 copy_rom(struct rom_header *rom)
166 u32 romsize = rom->size * 512;
167 if (next_rom + romsize > BUILD_BIOS_ADDR) {
168 // Option rom doesn't fit.
169 dprintf(1, "Option rom %p doesn't fit.\n", rom);
172 dprintf(4, "Copying option rom (size %d) from %p to %x\n"
173 , romsize, rom, next_rom);
174 memcpy4((void*)next_rom, rom, romsize);
175 return (struct rom_header *)next_rom;
178 // Check if an option rom is at a hardcoded location for a device.
179 static struct rom_header *
180 lookup_hardcode(u32 vendev)
182 if (OPTIONROM_VENDEV_1
183 && ((OPTIONROM_VENDEV_1 >> 16)
184 | ((OPTIONROM_VENDEV_1 & 0xffff)) << 16) == vendev)
185 return copy_rom((struct rom_header *)OPTIONROM_MEM_1);
186 if (OPTIONROM_VENDEV_2
187 && ((OPTIONROM_VENDEV_2 >> 16)
188 | ((OPTIONROM_VENDEV_2 & 0xffff)) << 16) == vendev)
189 return copy_rom((struct rom_header *)OPTIONROM_MEM_2);
190 int ret = cb_copy_optionrom((void*)next_rom, BUILD_BIOS_ADDR - next_rom
194 return (struct rom_header *)next_rom;
197 // Map the option rom of a given PCI device.
198 static struct rom_header *
199 map_optionrom(u16 bdf, u32 vendev)
201 dprintf(6, "Attempting to map option rom on dev %x\n", bdf);
203 u8 htype = pci_config_readb(bdf, PCI_HEADER_TYPE);
204 if ((htype & 0x7f) != PCI_HEADER_TYPE_NORMAL) {
205 dprintf(6, "Skipping non-normal pci device (type=%x)\n", htype);
209 u32 orig = pci_config_readl(bdf, PCI_ROM_ADDRESS);
210 pci_config_writel(bdf, PCI_ROM_ADDRESS, ~PCI_ROM_ADDRESS_ENABLE);
211 u32 sz = pci_config_readl(bdf, PCI_ROM_ADDRESS);
213 dprintf(6, "Option rom sizing returned %x %x\n", orig, sz);
214 orig &= ~PCI_ROM_ADDRESS_ENABLE;
215 if (!sz || sz == 0xffffffff)
218 if (orig == sz || (u32)(orig + 4*1024*1024) < 20*1024*1024) {
219 // Don't try to map to a pci addresses at its max, in the last
220 // 4MiB of ram, or the first 16MiB of ram.
221 dprintf(6, "Preset rom address doesn't look valid\n");
225 // Looks like a rom - enable it.
226 pci_config_writel(bdf, PCI_ROM_ADDRESS, orig | PCI_ROM_ADDRESS_ENABLE);
228 struct rom_header *rom = (struct rom_header *)orig;
230 dprintf(5, "Inspecting possible rom at %p (dv=%x bdf=%x)\n"
232 if (rom->signature != OPTION_ROM_SIGNATURE) {
233 dprintf(6, "No option rom signature (got %x)\n", rom->signature);
236 struct pci_data *pci = get_pci_rom(rom);
238 dprintf(6, "No valid pci signature found\n");
242 u32 vd = (pci->device << 16) | pci->vendor;
243 if (vd == vendev && pci->type == PCIROM_CODETYPE_X86)
246 dprintf(6, "Didn't match dev/ven (got %x) or type (got %d)\n"
248 if (pci->indicator & 0x80) {
249 dprintf(6, "No more images left\n");
252 rom = (struct rom_header *)((u32)rom + pci->ilen * 512);
256 pci_config_writel(bdf, PCI_ROM_ADDRESS, orig);
259 // Not valid - restore original and exit.
260 pci_config_writel(bdf, PCI_ROM_ADDRESS, orig);
264 // Attempt to map and initialize the option rom on a given PCI device.
265 static struct rom_header *
266 init_optionrom(u16 bdf)
268 u32 vendev = pci_config_readl(bdf, PCI_VENDOR_ID);
269 dprintf(4, "Attempting to init PCI bdf %x (dev/ven %x)\n", bdf, vendev);
270 struct rom_header *rom = lookup_hardcode(vendev);
272 rom = map_optionrom(bdf, vendev);
277 if (! is_valid_rom(rom))
280 if (get_pnp_rom(rom))
282 callrom(rom, OPTION_ROM_INITVECTOR, bdf);
284 next_rom += ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
290 /****************************************************************
291 * Non-VGA option rom init
292 ****************************************************************/
297 if (! CONFIG_OPTIONROMS)
300 dprintf(1, "Scan for option roms\n");
302 u32 post_vga = next_rom;
304 if (CONFIG_OPTIONROMS_DEPLOYED) {
305 // Option roms are already deployed on the system.
307 while (pos < BUILD_BIOS_ADDR) {
308 struct rom_header *rom = (struct rom_header *)pos;
309 if (! is_valid_rom(rom)) {
310 pos += OPTION_ROM_ALIGN;
313 if (get_pnp_rom(rom))
314 callrom(rom, OPTION_ROM_INITVECTOR, 0);
315 pos += ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
319 // Find and deploy PCI roms.
321 foreachpci(bdf, max) {
322 u16 v = pci_config_readw(bdf, PCI_CLASS_DEVICE);
323 if (v == 0x0000 || v == 0xffff || v == PCI_CLASS_DISPLAY_VGA
324 || (CONFIG_ATA && v == PCI_CLASS_STORAGE_IDE))
330 // All option roms found and deployed - now build BEV/BCV vectors.
333 while (pos < next_rom) {
334 struct rom_header *rom = (struct rom_header *)pos;
335 if (! is_valid_rom(rom)) {
336 pos += OPTION_ROM_ALIGN;
339 pos += ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
340 struct pnp_data *pnp = get_pnp_rom(rom);
343 add_bcv(FLATPTR_TO_SEG(rom), OPTION_ROM_INITVECTOR, 0);
348 // Can boot system - add to IPL list.
349 add_bev(FLATPTR_TO_SEG(rom), pnp->bev, pnp->productname);
351 // Check for BCV (there may be multiple).
352 while (pnp && pnp->bcv) {
353 add_bcv(FLATPTR_TO_SEG(rom), pnp->bcv, pnp->productname);
354 pnp = get_pnp_next(rom, pnp);
360 /****************************************************************
362 ****************************************************************/
364 // Call into vga code to turn on console.
368 if (! CONFIG_OPTIONROMS)
371 dprintf(1, "Scan for VGA option rom\n");
372 next_rom = OPTION_ROM_START;
374 if (CONFIG_OPTIONROMS_DEPLOYED) {
375 // Option roms are already deployed on the system.
376 struct rom_header *rom = (struct rom_header *)OPTION_ROM_START;
377 if (! is_valid_rom(rom))
379 callrom(rom, OPTION_ROM_INITVECTOR, 0);
380 next_rom += ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
382 // Find and deploy PCI VGA rom.
383 int bdf = pci_find_class(PCI_CLASS_DISPLAY_VGA);
388 struct rom_header *rom = init_optionrom(bdf);
389 if (rom && !get_pnp_rom(rom))
390 // Call rom even if it isn't a pnp rom.
391 callrom(rom, OPTION_ROM_INITVECTOR, bdf);
394 dprintf(1, "Turning on vga console\n");
396 memset(&br, 0, sizeof(br));
398 call16_int(0x10, &br);
401 printf("Starting SeaBIOS\n\n");