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
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.
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"
139
// Check if a valid option rom has a pnp struct; return it if so.
140
static struct pnp_data *
141
get_pnp_rom(struct rom_header *rom)
143
struct pnp_data *pnp = (void*)((u8*)rom + rom->pnpoffset);
144
if (pnp->signature != PNP_SIGNATURE)
149
// Check for multiple pnp option rom headers.
150
static struct pnp_data *
151
get_pnp_next(struct rom_header *rom, struct pnp_data *pnp)
153
if (! pnp->nextoffset)
155
pnp = (void*)((u8*)rom + pnp->nextoffset);
156
if (pnp->signature != PNP_SIGNATURE)
161
// Check if a valid option rom has a pci struct; return it if so.
162
static struct pci_data *
163
get_pci_rom(struct rom_header *rom)
165
struct pci_data *pci = (void*)((u32)rom + rom->pcioffset);
166
if (pci->signature != PCI_ROM_SIGNATURE)
171
// Return the memory position up to which roms may be located.
175
extern u8 code32flat_start[];
176
if ((u32)code32flat_start > BUILD_BIOS_ADDR)
177
return BUILD_BIOS_ADDR;
178
return (u32)code32flat_start;
181
// Copy a rom to its permanent location below 1MiB
182
static struct rom_header *
183
copy_rom(struct rom_header *rom)
185
u32 romsize = rom->size * 512;
186
if (RomEnd + romsize > max_rom()) {
187
// Option rom doesn't fit.
191
dprintf(4, "Copying option rom (size %d) from %p to %x\n"
192
, romsize, rom, RomEnd);
193
iomemcpy((void*)RomEnd, rom, romsize);
194
return (void*)RomEnd;
197
// Run rom init code and note rom size.
199
init_optionrom(struct rom_header *rom, u16 bdf, int isvga)
201
if (! is_valid_rom(rom))
204
if (isvga || get_pnp_rom(rom))
205
// Only init vga and PnP roms here.
208
RomEnd = (u32)rom + ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
214
/****************************************************************
216
****************************************************************/
218
// Check if an option rom is at a hardcoded location or in CBFS.
219
static struct rom_header *
220
lookup_hardcode(u32 vendev)
222
if (OPTIONROM_VENDEV_1
223
&& ((OPTIONROM_VENDEV_1 >> 16)
224
| ((OPTIONROM_VENDEV_1 & 0xffff)) << 16) == vendev)
225
return copy_rom((void*)OPTIONROM_MEM_1);
226
if (OPTIONROM_VENDEV_2
227
&& ((OPTIONROM_VENDEV_2 >> 16)
228
| ((OPTIONROM_VENDEV_2 & 0xffff)) << 16) == vendev)
229
return copy_rom((void*)OPTIONROM_MEM_2);
231
snprintf(fname, sizeof(fname), "pci%04x,%04x.rom"
232
, pci_vd_to_ven(vendev), pci_vd_to_dev(vendev));
233
int ret = romfile_copy(romfile_find(fname), (void*)RomEnd
234
, max_rom() - RomEnd);
237
return (void*)RomEnd;
240
// Run all roms in a given CBFS directory.
242
run_file_roms(const char *prefix, int isvga)
246
file = romfile_findprefix(prefix, file);
249
int ret = romfile_copy(file, (void*)RomEnd, max_rom() - RomEnd);
251
init_optionrom((void*)RomEnd, 0, isvga);
256
/****************************************************************
258
****************************************************************/
260
// Map the option rom of a given PCI device.
261
static struct rom_header *
262
map_pcirom(u16 bdf, u32 vendev)
264
dprintf(6, "Attempting to map option rom on dev %02x:%02x.%x\n"
265
, pci_bdf_to_bus(bdf), pci_bdf_to_dev(bdf), pci_bdf_to_fn(bdf));
267
u8 htype = pci_config_readb(bdf, PCI_HEADER_TYPE);
268
if ((htype & 0x7f) != PCI_HEADER_TYPE_NORMAL) {
269
dprintf(6, "Skipping non-normal pci device (type=%x)\n", htype);
273
u32 orig = pci_config_readl(bdf, PCI_ROM_ADDRESS);
274
pci_config_writel(bdf, PCI_ROM_ADDRESS, ~PCI_ROM_ADDRESS_ENABLE);
275
u32 sz = pci_config_readl(bdf, PCI_ROM_ADDRESS);
277
dprintf(6, "Option rom sizing returned %x %x\n", orig, sz);
278
orig &= ~PCI_ROM_ADDRESS_ENABLE;
279
if (!sz || sz == 0xffffffff)
282
if (orig == sz || (u32)(orig + 4*1024*1024) < 20*1024*1024) {
283
// Don't try to map to a pci addresses at its max, in the last
284
// 4MiB of ram, or the first 16MiB of ram.
285
dprintf(6, "Preset rom address doesn't look valid\n");
289
// Looks like a rom - enable it.
290
pci_config_writel(bdf, PCI_ROM_ADDRESS, orig | PCI_ROM_ADDRESS_ENABLE);
292
struct rom_header *rom = (void*)orig;
294
dprintf(5, "Inspecting possible rom at %p (vd=%04x:%04x"
295
" bdf=%02x:%02x.%x)\n"
296
, rom, pci_vd_to_ven(vendev), pci_vd_to_dev(vendev)
297
, pci_bdf_to_bus(bdf), pci_bdf_to_dev(bdf), pci_bdf_to_fn(bdf));
298
if (rom->signature != OPTION_ROM_SIGNATURE) {
299
dprintf(6, "No option rom signature (got %x)\n", rom->signature);
302
struct pci_data *pci = get_pci_rom(rom);
304
dprintf(6, "No valid pci signature found\n");
308
u32 vd = pci_vd(pci->vendor, pci->device);
309
if (vd == vendev && pci->type == PCIROM_CODETYPE_X86)
312
dprintf(6, "Didn't match dev/ven (got %08x) or type (got %d)\n"
314
if (pci->indicator & 0x80) {
315
dprintf(6, "No more images left\n");
318
rom = (void*)((u32)rom + pci->ilen * 512);
322
pci_config_writel(bdf, PCI_ROM_ADDRESS, orig);
325
// Not valid - restore original and exit.
326
pci_config_writel(bdf, PCI_ROM_ADDRESS, orig);
330
// Attempt to map and initialize the option rom on a given PCI device.
332
init_pcirom(u16 bdf, int isvga)
334
u32 vendev = pci_config_readl(bdf, PCI_VENDOR_ID);
335
dprintf(4, "Attempting to init PCI bdf %02x:%02x.%x (vd %04x:%04x)\n"
336
, pci_bdf_to_bus(bdf), pci_bdf_to_dev(bdf), pci_bdf_to_fn(bdf)
337
, pci_vd_to_ven(vendev), pci_vd_to_dev(vendev));
338
struct rom_header *rom = lookup_hardcode(vendev);
340
rom = map_pcirom(bdf, vendev);
344
return init_optionrom(rom, bdf, isvga);
348
/****************************************************************
349
* Non-VGA option rom init
350
****************************************************************/
353
optionrom_setup(void)
355
if (! CONFIG_OPTIONROMS)
358
dprintf(1, "Scan for option roms\n");
360
u32 post_vga = RomEnd;
362
if (CONFIG_OPTIONROMS_DEPLOYED) {
363
// Option roms are already deployed on the system.
365
while (pos < max_rom()) {
366
int ret = init_optionrom((void*)pos, 0, 0);
368
pos += OPTION_ROM_ALIGN;
373
// Find and deploy PCI roms.
375
foreachpci(bdf, max) {
376
u16 v = pci_config_readw(bdf, PCI_CLASS_DEVICE);
377
if (v == 0x0000 || v == 0xffff || v == PCI_CLASS_DISPLAY_VGA
378
|| (CONFIG_ATA && v == PCI_CLASS_STORAGE_IDE))
383
// Find and deploy CBFS roms not associated with a device.
384
run_file_roms("genroms/", 0);
387
// All option roms found and deployed - now build BEV/BCV vectors.
390
while (pos < RomEnd) {
391
struct rom_header *rom = (void*)pos;
392
if (! is_valid_rom(rom)) {
393
pos += OPTION_ROM_ALIGN;
396
pos += ALIGN(rom->size * 512, OPTION_ROM_ALIGN);
397
struct pnp_data *pnp = get_pnp_rom(rom);
400
add_bcv(FLATPTR_TO_SEG(rom), OPTION_ROM_INITVECTOR, 0);
405
// Can boot system - add to IPL list.
406
add_bev(FLATPTR_TO_SEG(rom), pnp->bev, pnp->productname);
408
// Check for BCV (there may be multiple).
409
while (pnp && pnp->bcv) {
410
add_bcv(FLATPTR_TO_SEG(rom), pnp->bcv, pnp->productname);
411
pnp = get_pnp_next(rom, pnp);
417
/****************************************************************
419
****************************************************************/
421
// Call into vga code to turn on console.
426
RomEnd = BUILD_ROM_START;
428
if (! CONFIG_OPTIONROMS)
431
dprintf(1, "Scan for VGA option rom\n");
433
if (CONFIG_OPTIONROMS_DEPLOYED) {
434
// Option roms are already deployed on the system.
435
init_optionrom((void*)BUILD_ROM_START, 0, 1);
437
// Find and deploy PCI VGA rom.
438
int bdf = VGAbdf = pci_find_vga();
442
// Find and deploy CBFS vga-style roms not associated with a device.
443
run_file_roms("vgaroms/", 1);
446
if (RomEnd == BUILD_ROM_START) {
448
RomEnd += OPTION_ROM_ALIGN;
452
enable_vga_console();
456
s3_resume_vga_init(void)
458
if (!CONFIG_S3_RESUME_VGA_INIT)
460
struct rom_header *rom = (void*)BUILD_ROM_START;
461
if (! is_valid_rom(rom))