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 GPLv3 license.
8 #include "bregs.h" // struct bregs
9 #include "biosvar.h" // struct ipl_entry_s
10 #include "util.h" // dprintf
11 #include "pci.h" // pci_find_class
12 #include "pci_regs.h" // PCI_ROM_ADDRESS
13 #include "pci_ids.h" // PCI_CLASS_DISPLAY_VGA
16 /****************************************************************
18 ****************************************************************/
20 // $PnP string with special alignment in romlayout.S
21 extern char pnp_string[];
68 #define OPTIONROM_BDF_1 0x0000
69 #define OPTIONROM_MEM_1 0x00000000
70 #define OPTIONROM_BDF_2 0x0000
71 #define OPTIONROM_MEM_2 0x00000000
73 #define OPTION_ROM_START 0xc0000
74 #define OPTION_ROM_SIGNATURE 0xaa55
75 #define OPTION_ROM_ALIGN 2048
76 #define OPTION_ROM_INITVECTOR offsetof(struct rom_header, initVector[0])
78 // Next available position for an option rom.
82 /****************************************************************
84 ****************************************************************/
86 // Execute a given option rom.
88 callrom(struct rom_header *rom, u16 offset, u16 bdf)
90 u16 seg = FARPTR_TO_SEG(rom);
91 dprintf(1, "Running option rom at %x:%x\n", seg, offset);
94 memset(&br, 0, sizeof(br));
99 br.di = (u32)pnp_string - BUILD_BIOS_ADDR;
104 debug_serial_setup();
106 if (GET_BDA(ebda_seg) != SEG_EBDA)
107 BX_PANIC("Option rom at %x:%x attempted to move ebda from %x to %x\n"
108 , seg, offset, SEG_EBDA, GET_BDA(ebda_seg));
111 // Verify that an option rom looks valid
113 is_valid_rom(struct rom_header *rom)
115 if (rom->signature != OPTION_ROM_SIGNATURE)
117 u32 len = rom->size * 512;
118 u8 sum = checksum((void*)rom, len);
120 dprintf(1, "Found option rom with bad checksum: loc=%p len=%d sum=%x\n"
127 // Check if a valid option rom has a pnp struct; return it if so.
128 static struct pnp_data *
129 get_pnp_rom(struct rom_header *rom)
131 struct pnp_data *pnp = (struct pnp_data *)((u8*)rom + rom->pnpoffset);
132 if (pnp->signature != *(u32*)pnp_string)
137 // Add a BEV vector for a given pnp compatible option rom.
139 add_ipl(struct rom_header *rom, struct pnp_data *pnp)
141 #define ebda ((struct extended_bios_data_area_s *)MAKE_FARPTR(SEG_EBDA, 0))
143 // Found a device that thinks it can boot the system. Record
144 // its BEV and product name string.
149 if (ebda->ipl.count >= ARRAY_SIZE(ebda->ipl.table))
152 struct ipl_entry_s *ip = &ebda->ipl.table[ebda->ipl.count];
153 ip->type = IPL_TYPE_BEV;
154 ip->vector = (FARPTR_TO_SEG(rom) << 16) | pnp->bev;
156 u16 desc = pnp->productname;
158 ip->description = MAKE_FARPTR(FARPTR_TO_SEG(rom), desc);
163 // Check if an option rom is at a hardcoded location for a device.
164 static struct rom_header *
165 lookup_hardcode(PCIDevice d)
168 && OPTIONROM_BDF_1 == pci_to_bdf(d))
169 return (struct rom_header *)OPTIONROM_MEM_1;
170 else if (OPTIONROM_BDF_2
171 && OPTIONROM_BDF_2 == pci_to_bdf(d))
172 return (struct rom_header *)OPTIONROM_MEM_2;
173 // XXX - check LAR when in coreboot?
177 // Map the option rom of a given PCI device.
178 static struct rom_header *
179 map_optionrom(PCIDevice d)
181 u32 orig = pci_config_readl(d, PCI_ROM_ADDRESS);
182 pci_config_writel(d, PCI_ROM_ADDRESS, ~PCI_ROM_ADDRESS_ENABLE);
183 u32 sz = pci_config_readl(d, PCI_ROM_ADDRESS);
185 if (!sz || sz == 0xffffffff)
188 // Looks like a rom - map it to just above end of memory.
189 u32 mappos = ALIGN(GET_EBDA(ram_size), OPTION_ROM_ALIGN);
190 pci_config_writel(d, PCI_ROM_ADDRESS, mappos | PCI_ROM_ADDRESS_ENABLE);
192 struct rom_header *rom = (struct rom_header *)mappos;
193 if (rom->signature != OPTION_ROM_SIGNATURE)
198 // Not valid - restore original and exit.
199 pci_config_writel(d, PCI_ROM_ADDRESS, orig);
203 // Attempt to map and initialize the option rom on a given PCI device.
204 static struct rom_header *
205 init_optionrom(PCIDevice d)
207 struct rom_header *rom = lookup_hardcode(d);
209 rom = map_optionrom(d);
214 u32 romsize = rom->size * 512;
215 if (next_rom + romsize > BUILD_BIOS_ADDR) {
216 // Option rom doesn't fit.
217 dprintf(1, "Option rom %x doesn't fit.", pci_to_bdf(d));
218 pci_config_writel(d, PCI_ROM_ADDRESS, next_rom);
221 memcpy((void*)next_rom, rom, romsize);
222 pci_config_writel(d, PCI_ROM_ADDRESS, next_rom);
223 rom = (struct rom_header *)next_rom;
225 if (! is_valid_rom(rom))
228 if (get_pnp_rom(rom))
230 callrom(rom, OPTION_ROM_INITVECTOR, pci_to_bdf(d));
232 next_rom += ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
238 /****************************************************************
239 * Non-VGA option rom init
240 ****************************************************************/
245 if (! CONFIG_OPTIONROMS)
248 dprintf(1, "Scan for option roms\n");
250 u32 post_vga = next_rom;
252 if (CONFIG_OPTIONROMS_DEPLOYED) {
253 // Option roms are already deployed on the system.
255 while (pos < BUILD_BIOS_ADDR) {
256 struct rom_header *rom = (struct rom_header *)pos;
257 if (! is_valid_rom(rom)) {
258 pos += OPTION_ROM_ALIGN;
261 if (get_pnp_rom(rom))
262 callrom(rom, OPTION_ROM_INITVECTOR, 0);
263 pos += ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
267 // Find and deploy PCI roms.
269 for (bus=0; bus < CONFIG_PCI_BUS_COUNT; bus++) {
270 for (devfn=0; devfn<0x100; devfn++) {
271 PCIDevice d = pci_bd(bus, devfn);
272 u16 v = pci_config_readw(d, PCI_CLASS_DEVICE);
273 if (v == 0x0000 || v == 0xffff || v == PCI_CLASS_DISPLAY_VGA)
280 // All option roms found and deployed - now build BEV/BCV vectors.
283 while (pos < next_rom) {
284 struct rom_header *rom = (struct rom_header *)pos;
285 if (! is_valid_rom(rom)) {
286 pos += OPTION_ROM_ALIGN;
289 pos += ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
290 struct pnp_data *pnp = get_pnp_rom(rom);
292 // Legacy rom - run init vector now.
293 callrom(rom, OPTION_ROM_INITVECTOR, 0);
298 // Can boot system - add to IPL list.
301 // Has BCV - run it now.
302 callrom(rom, pnp->bcv, 0);
307 /****************************************************************
309 ****************************************************************/
311 // Call into vga code to turn on console.
315 if (! CONFIG_OPTIONROMS)
318 dprintf(1, "Scan for VGA option rom\n");
319 next_rom = OPTION_ROM_START;
321 if (CONFIG_OPTIONROMS_DEPLOYED) {
322 // Option roms are already deployed on the system.
323 struct rom_header *rom = (struct rom_header *)OPTION_ROM_START;
324 if (! is_valid_rom(rom))
326 callrom(rom, OPTION_ROM_INITVECTOR, 0);
327 next_rom += ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
329 // Find and deploy PCI VGA rom.
331 int ret = pci_find_class(PCI_CLASS_DISPLAY_VGA, 0, &d);
336 struct rom_header *rom = init_optionrom(d);
337 if (rom && !get_pnp_rom(rom))
338 // Call rom even if it isn't a pnp rom.
339 callrom(rom, OPTION_ROM_INITVECTOR, pci_to_bdf(d));
342 dprintf(1, "Turning on vga console\n");
344 memset(&br, 0, sizeof(br));
346 call16_int(0x10, &br);
349 printf("Starting SeaBIOS\n\n");