11da177e4SLinus Torvalds /* 21da177e4SLinus Torvalds * drivers/pci/rom.c 31da177e4SLinus Torvalds * 41da177e4SLinus Torvalds * (C) Copyright 2004 Jon Smirl <jonsmirl@yahoo.com> 51da177e4SLinus Torvalds * (C) Copyright 2004 Silicon Graphics, Inc. Jesse Barnes <jbarnes@sgi.com> 61da177e4SLinus Torvalds * 71da177e4SLinus Torvalds * PCI ROM access routines 81da177e4SLinus Torvalds */ 91da177e4SLinus Torvalds #include <linux/kernel.h> 101da177e4SLinus Torvalds #include <linux/pci.h> 114e57b681STim Schmielau #include <linux/slab.h> 121da177e4SLinus Torvalds 131da177e4SLinus Torvalds #include "pci.h" 141da177e4SLinus Torvalds 151da177e4SLinus Torvalds /** 161da177e4SLinus Torvalds * pci_enable_rom - enable ROM decoding for a PCI device 1767be2dd1SMartin Waitz * @pdev: PCI device to enable 181da177e4SLinus Torvalds * 191da177e4SLinus Torvalds * Enable ROM decoding on @dev. This involves simply turning on the last 201da177e4SLinus Torvalds * bit of the PCI ROM BAR. Note that some cards may share address decoders 211da177e4SLinus Torvalds * between the ROM and other resources, so enabling it may disable access 221da177e4SLinus Torvalds * to MMIO registers or other card memory. 231da177e4SLinus Torvalds */ 248085ce08SBenjamin Herrenschmidt static int pci_enable_rom(struct pci_dev *pdev) 251da177e4SLinus Torvalds { 268085ce08SBenjamin Herrenschmidt struct resource *res = pdev->resource + PCI_ROM_RESOURCE; 278085ce08SBenjamin Herrenschmidt struct pci_bus_region region; 281da177e4SLinus Torvalds u32 rom_addr; 291da177e4SLinus Torvalds 308085ce08SBenjamin Herrenschmidt if (!res->flags) 318085ce08SBenjamin Herrenschmidt return -1; 328085ce08SBenjamin Herrenschmidt 338085ce08SBenjamin Herrenschmidt pcibios_resource_to_bus(pdev, ®ion, res); 341da177e4SLinus Torvalds pci_read_config_dword(pdev, pdev->rom_base_reg, &rom_addr); 358085ce08SBenjamin Herrenschmidt rom_addr &= ~PCI_ROM_ADDRESS_MASK; 368085ce08SBenjamin Herrenschmidt rom_addr |= region.start | PCI_ROM_ADDRESS_ENABLE; 371da177e4SLinus Torvalds pci_write_config_dword(pdev, pdev->rom_base_reg, rom_addr); 388085ce08SBenjamin Herrenschmidt return 0; 391da177e4SLinus Torvalds } 401da177e4SLinus Torvalds 411da177e4SLinus Torvalds /** 421da177e4SLinus Torvalds * pci_disable_rom - disable ROM decoding for a PCI device 4367be2dd1SMartin Waitz * @pdev: PCI device to disable 441da177e4SLinus Torvalds * 451da177e4SLinus Torvalds * Disable ROM decoding on a PCI device by turning off the last bit in the 461da177e4SLinus Torvalds * ROM BAR. 471da177e4SLinus Torvalds */ 481da177e4SLinus Torvalds static void pci_disable_rom(struct pci_dev *pdev) 491da177e4SLinus Torvalds { 501da177e4SLinus Torvalds u32 rom_addr; 511da177e4SLinus Torvalds pci_read_config_dword(pdev, pdev->rom_base_reg, &rom_addr); 521da177e4SLinus Torvalds rom_addr &= ~PCI_ROM_ADDRESS_ENABLE; 531da177e4SLinus Torvalds pci_write_config_dword(pdev, pdev->rom_base_reg, rom_addr); 541da177e4SLinus Torvalds } 551da177e4SLinus Torvalds 561da177e4SLinus Torvalds /** 57d7ad2254SJohn Keller * pci_get_rom_size - obtain the actual size of the ROM image 58d7ad2254SJohn Keller * @rom: kernel virtual pointer to image of ROM 59d7ad2254SJohn Keller * @size: size of PCI window 60d7ad2254SJohn Keller * return: size of actual ROM image 61d7ad2254SJohn Keller * 62d7ad2254SJohn Keller * Determine the actual length of the ROM image. 63d7ad2254SJohn Keller * The PCI window size could be much larger than the 64d7ad2254SJohn Keller * actual image size. 65d7ad2254SJohn Keller */ 66d7ad2254SJohn Keller size_t pci_get_rom_size(void __iomem *rom, size_t size) 67d7ad2254SJohn Keller { 68d7ad2254SJohn Keller void __iomem *image; 69d7ad2254SJohn Keller int last_image; 70d7ad2254SJohn Keller 71d7ad2254SJohn Keller image = rom; 72d7ad2254SJohn Keller do { 73d7ad2254SJohn Keller void __iomem *pds; 74d7ad2254SJohn Keller /* Standard PCI ROMs start out with these bytes 55 AA */ 75d7ad2254SJohn Keller if (readb(image) != 0x55) 76d7ad2254SJohn Keller break; 77d7ad2254SJohn Keller if (readb(image + 1) != 0xAA) 78d7ad2254SJohn Keller break; 79d7ad2254SJohn Keller /* get the PCI data structure and check its signature */ 80d7ad2254SJohn Keller pds = image + readw(image + 24); 81d7ad2254SJohn Keller if (readb(pds) != 'P') 82d7ad2254SJohn Keller break; 83d7ad2254SJohn Keller if (readb(pds + 1) != 'C') 84d7ad2254SJohn Keller break; 85d7ad2254SJohn Keller if (readb(pds + 2) != 'I') 86d7ad2254SJohn Keller break; 87d7ad2254SJohn Keller if (readb(pds + 3) != 'R') 88d7ad2254SJohn Keller break; 89d7ad2254SJohn Keller last_image = readb(pds + 21) & 0x80; 90d7ad2254SJohn Keller /* this length is reliable */ 91d7ad2254SJohn Keller image += readw(pds + 16) * 512; 92d7ad2254SJohn Keller } while (!last_image); 93d7ad2254SJohn Keller 94d7ad2254SJohn Keller /* never return a size larger than the PCI resource window */ 95d7ad2254SJohn Keller /* there are known ROMs that get the size wrong */ 96d7ad2254SJohn Keller return min((size_t)(image - rom), size); 97d7ad2254SJohn Keller } 98d7ad2254SJohn Keller 99d7ad2254SJohn Keller /** 1001da177e4SLinus Torvalds * pci_map_rom - map a PCI ROM to kernel space 10167be2dd1SMartin Waitz * @pdev: pointer to pci device struct 1021da177e4SLinus Torvalds * @size: pointer to receive size of pci window over ROM 1031da177e4SLinus Torvalds * @return: kernel virtual pointer to image of ROM 1041da177e4SLinus Torvalds * 1051da177e4SLinus Torvalds * Map a PCI ROM into kernel space. If ROM is boot video ROM, 1061da177e4SLinus Torvalds * the shadow BIOS copy will be returned instead of the 1071da177e4SLinus Torvalds * actual ROM. 1081da177e4SLinus Torvalds */ 1091da177e4SLinus Torvalds void __iomem *pci_map_rom(struct pci_dev *pdev, size_t *size) 1101da177e4SLinus Torvalds { 1111da177e4SLinus Torvalds struct resource *res = &pdev->resource[PCI_ROM_RESOURCE]; 1121da177e4SLinus Torvalds loff_t start; 1131da177e4SLinus Torvalds void __iomem *rom; 1141da177e4SLinus Torvalds 115b5e4efe7Seiichiro.oiwa.nm@hitachi.com /* 1166b5c76b8SEiichiro Oiwa * IORESOURCE_ROM_SHADOW set on x86, x86_64 and IA64 supports legacy 1176b5c76b8SEiichiro Oiwa * memory map if the VGA enable bit of the Bridge Control register is 1186b5c76b8SEiichiro Oiwa * set for embedded VGA. 119b5e4efe7Seiichiro.oiwa.nm@hitachi.com */ 1201da177e4SLinus Torvalds if (res->flags & IORESOURCE_ROM_SHADOW) { 1211da177e4SLinus Torvalds /* primary video rom always starts here */ 1221da177e4SLinus Torvalds start = (loff_t)0xC0000; 1231da177e4SLinus Torvalds *size = 0x20000; /* cover C000:0 through E000:0 */ 1241da177e4SLinus Torvalds } else { 125a2302c68SJohn Keller if (res->flags & 126a2302c68SJohn Keller (IORESOURCE_ROM_COPY | IORESOURCE_ROM_BIOS_COPY)) { 1271da177e4SLinus Torvalds *size = pci_resource_len(pdev, PCI_ROM_RESOURCE); 128e31dd6e4SGreg Kroah-Hartman return (void __iomem *)(unsigned long) 129e31dd6e4SGreg Kroah-Hartman pci_resource_start(pdev, PCI_ROM_RESOURCE); 1301da177e4SLinus Torvalds } else { 1311da177e4SLinus Torvalds /* assign the ROM an address if it doesn't have one */ 1328085ce08SBenjamin Herrenschmidt if (res->parent == NULL && 1338085ce08SBenjamin Herrenschmidt pci_assign_resource(pdev,PCI_ROM_RESOURCE)) 1348085ce08SBenjamin Herrenschmidt return NULL; 1351da177e4SLinus Torvalds start = pci_resource_start(pdev, PCI_ROM_RESOURCE); 1361da177e4SLinus Torvalds *size = pci_resource_len(pdev, PCI_ROM_RESOURCE); 1371da177e4SLinus Torvalds if (*size == 0) 1381da177e4SLinus Torvalds return NULL; 1391da177e4SLinus Torvalds 1401da177e4SLinus Torvalds /* Enable ROM space decodes */ 1418085ce08SBenjamin Herrenschmidt if (pci_enable_rom(pdev)) 1428085ce08SBenjamin Herrenschmidt return NULL; 1431da177e4SLinus Torvalds } 1441da177e4SLinus Torvalds } 1451da177e4SLinus Torvalds 1461da177e4SLinus Torvalds rom = ioremap(start, *size); 1471da177e4SLinus Torvalds if (!rom) { 1481da177e4SLinus Torvalds /* restore enable if ioremap fails */ 1491da177e4SLinus Torvalds if (!(res->flags & (IORESOURCE_ROM_ENABLE | 1501da177e4SLinus Torvalds IORESOURCE_ROM_SHADOW | 1511da177e4SLinus Torvalds IORESOURCE_ROM_COPY))) 1521da177e4SLinus Torvalds pci_disable_rom(pdev); 1531da177e4SLinus Torvalds return NULL; 1541da177e4SLinus Torvalds } 1551da177e4SLinus Torvalds 1561da177e4SLinus Torvalds /* 1571da177e4SLinus Torvalds * Try to find the true size of the ROM since sometimes the PCI window 1581da177e4SLinus Torvalds * size is much larger than the actual size of the ROM. 1591da177e4SLinus Torvalds * True size is important if the ROM is going to be copied. 1601da177e4SLinus Torvalds */ 161d7ad2254SJohn Keller *size = pci_get_rom_size(rom, *size); 1621da177e4SLinus Torvalds return rom; 1631da177e4SLinus Torvalds } 1641da177e4SLinus Torvalds 165b09549efSAdrian Bunk #if 0 1661da177e4SLinus Torvalds /** 1671da177e4SLinus Torvalds * pci_map_rom_copy - map a PCI ROM to kernel space, create a copy 16867be2dd1SMartin Waitz * @pdev: pointer to pci device struct 1691da177e4SLinus Torvalds * @size: pointer to receive size of pci window over ROM 1701da177e4SLinus Torvalds * @return: kernel virtual pointer to image of ROM 1711da177e4SLinus Torvalds * 1721da177e4SLinus Torvalds * Map a PCI ROM into kernel space. If ROM is boot video ROM, 1731da177e4SLinus Torvalds * the shadow BIOS copy will be returned instead of the 1741da177e4SLinus Torvalds * actual ROM. 1751da177e4SLinus Torvalds */ 1761da177e4SLinus Torvalds void __iomem *pci_map_rom_copy(struct pci_dev *pdev, size_t *size) 1771da177e4SLinus Torvalds { 1781da177e4SLinus Torvalds struct resource *res = &pdev->resource[PCI_ROM_RESOURCE]; 1791da177e4SLinus Torvalds void __iomem *rom; 1801da177e4SLinus Torvalds 1811da177e4SLinus Torvalds rom = pci_map_rom(pdev, size); 1821da177e4SLinus Torvalds if (!rom) 1831da177e4SLinus Torvalds return NULL; 1841da177e4SLinus Torvalds 185a2302c68SJohn Keller if (res->flags & (IORESOURCE_ROM_COPY | IORESOURCE_ROM_SHADOW | 186a2302c68SJohn Keller IORESOURCE_ROM_BIOS_COPY)) 1871da177e4SLinus Torvalds return rom; 1881da177e4SLinus Torvalds 1891da177e4SLinus Torvalds res->start = (unsigned long)kmalloc(*size, GFP_KERNEL); 1901da177e4SLinus Torvalds if (!res->start) 1911da177e4SLinus Torvalds return rom; 1921da177e4SLinus Torvalds 1931da177e4SLinus Torvalds res->end = res->start + *size; 194e31dd6e4SGreg Kroah-Hartman memcpy_fromio((void*)(unsigned long)res->start, rom, *size); 1951da177e4SLinus Torvalds pci_unmap_rom(pdev, rom); 1961da177e4SLinus Torvalds res->flags |= IORESOURCE_ROM_COPY; 1971da177e4SLinus Torvalds 198e31dd6e4SGreg Kroah-Hartman return (void __iomem *)(unsigned long)res->start; 1991da177e4SLinus Torvalds } 200b09549efSAdrian Bunk #endif /* 0 */ 2011da177e4SLinus Torvalds 2021da177e4SLinus Torvalds /** 2031da177e4SLinus Torvalds * pci_unmap_rom - unmap the ROM from kernel space 20467be2dd1SMartin Waitz * @pdev: pointer to pci device struct 2051da177e4SLinus Torvalds * @rom: virtual address of the previous mapping 2061da177e4SLinus Torvalds * 2071da177e4SLinus Torvalds * Remove a mapping of a previously mapped ROM 2081da177e4SLinus Torvalds */ 2091da177e4SLinus Torvalds void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom) 2101da177e4SLinus Torvalds { 2111da177e4SLinus Torvalds struct resource *res = &pdev->resource[PCI_ROM_RESOURCE]; 2121da177e4SLinus Torvalds 213a2302c68SJohn Keller if (res->flags & (IORESOURCE_ROM_COPY | IORESOURCE_ROM_BIOS_COPY)) 2141da177e4SLinus Torvalds return; 2151da177e4SLinus Torvalds 2161da177e4SLinus Torvalds iounmap(rom); 2171da177e4SLinus Torvalds 2181da177e4SLinus Torvalds /* Disable again before continuing, leave enabled if pci=rom */ 2191da177e4SLinus Torvalds if (!(res->flags & (IORESOURCE_ROM_ENABLE | IORESOURCE_ROM_SHADOW))) 2201da177e4SLinus Torvalds pci_disable_rom(pdev); 2211da177e4SLinus Torvalds } 2221da177e4SLinus Torvalds 223b09549efSAdrian Bunk #if 0 2241da177e4SLinus Torvalds /** 2251da177e4SLinus Torvalds * pci_remove_rom - disable the ROM and remove its sysfs attribute 22667be2dd1SMartin Waitz * @pdev: pointer to pci device struct 2271da177e4SLinus Torvalds * 2281da177e4SLinus Torvalds * Remove the rom file in sysfs and disable ROM decoding. 2291da177e4SLinus Torvalds */ 2301da177e4SLinus Torvalds void pci_remove_rom(struct pci_dev *pdev) 2311da177e4SLinus Torvalds { 2321da177e4SLinus Torvalds struct resource *res = &pdev->resource[PCI_ROM_RESOURCE]; 2331da177e4SLinus Torvalds 2341da177e4SLinus Torvalds if (pci_resource_len(pdev, PCI_ROM_RESOURCE)) 2351da177e4SLinus Torvalds sysfs_remove_bin_file(&pdev->dev.kobj, pdev->rom_attr); 2361da177e4SLinus Torvalds if (!(res->flags & (IORESOURCE_ROM_ENABLE | 2371da177e4SLinus Torvalds IORESOURCE_ROM_SHADOW | 238a2302c68SJohn Keller IORESOURCE_ROM_BIOS_COPY | 2391da177e4SLinus Torvalds IORESOURCE_ROM_COPY))) 2401da177e4SLinus Torvalds pci_disable_rom(pdev); 2411da177e4SLinus Torvalds } 242b09549efSAdrian Bunk #endif /* 0 */ 2431da177e4SLinus Torvalds 2441da177e4SLinus Torvalds /** 245*0643245fSRandy Dunlap * pci_cleanup_rom - free the ROM copy created by pci_map_rom_copy 24667be2dd1SMartin Waitz * @pdev: pointer to pci device struct 2471da177e4SLinus Torvalds * 2481da177e4SLinus Torvalds * Free the copied ROM if we allocated one. 2491da177e4SLinus Torvalds */ 2501da177e4SLinus Torvalds void pci_cleanup_rom(struct pci_dev *pdev) 2511da177e4SLinus Torvalds { 2521da177e4SLinus Torvalds struct resource *res = &pdev->resource[PCI_ROM_RESOURCE]; 2531da177e4SLinus Torvalds if (res->flags & IORESOURCE_ROM_COPY) { 254e31dd6e4SGreg Kroah-Hartman kfree((void*)(unsigned long)res->start); 2551da177e4SLinus Torvalds res->flags &= ~IORESOURCE_ROM_COPY; 2561da177e4SLinus Torvalds res->start = 0; 2571da177e4SLinus Torvalds res->end = 0; 2581da177e4SLinus Torvalds } 2591da177e4SLinus Torvalds } 2601da177e4SLinus Torvalds 2611da177e4SLinus Torvalds EXPORT_SYMBOL(pci_map_rom); 2621da177e4SLinus Torvalds EXPORT_SYMBOL(pci_unmap_rom); 263