Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * drivers/pci/rom.c |
| 3 | * |
| 4 | * (C) Copyright 2004 Jon Smirl <jonsmirl@yahoo.com> |
| 5 | * (C) Copyright 2004 Silicon Graphics, Inc. Jesse Barnes <jbarnes@sgi.com> |
| 6 | * |
| 7 | * PCI ROM access routines |
| 8 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 9 | #include <linux/kernel.h> |
Paul Gortmaker | 363c75d | 2011-05-27 09:37:25 -0400 | [diff] [blame] | 10 | #include <linux/export.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 11 | #include <linux/pci.h> |
Tim Schmielau | 4e57b68 | 2005-10-30 15:03:48 -0800 | [diff] [blame] | 12 | #include <linux/slab.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 13 | |
| 14 | #include "pci.h" |
| 15 | |
| 16 | /** |
| 17 | * pci_enable_rom - enable ROM decoding for a PCI device |
Martin Waitz | 67be2dd | 2005-05-01 08:59:26 -0700 | [diff] [blame] | 18 | * @pdev: PCI device to enable |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 19 | * |
| 20 | * Enable ROM decoding on @dev. This involves simply turning on the last |
| 21 | * bit of the PCI ROM BAR. Note that some cards may share address decoders |
| 22 | * between the ROM and other resources, so enabling it may disable access |
| 23 | * to MMIO registers or other card memory. |
| 24 | */ |
Alan Cox | e416de5 | 2008-09-23 17:25:10 +0100 | [diff] [blame] | 25 | int pci_enable_rom(struct pci_dev *pdev) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 26 | { |
Bjorn Helgaas | 4708f9a | 2016-03-03 08:53:47 -0600 | [diff] [blame] | 27 | struct resource *res = &pdev->resource[PCI_ROM_RESOURCE]; |
Benjamin Herrenschmidt | 8085ce08 | 2005-08-31 14:16:53 +1000 | [diff] [blame] | 28 | struct pci_bus_region region; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 29 | u32 rom_addr; |
| 30 | |
Benjamin Herrenschmidt | 8085ce08 | 2005-08-31 14:16:53 +1000 | [diff] [blame] | 31 | if (!res->flags) |
| 32 | return -1; |
| 33 | |
Bjorn Helgaas | 4708f9a | 2016-03-03 08:53:47 -0600 | [diff] [blame] | 34 | /* Nothing to enable if we're using a shadow copy in RAM */ |
| 35 | if (res->flags & IORESOURCE_ROM_SHADOW) |
| 36 | return 0; |
| 37 | |
Yinghai Lu | fc27985 | 2013-12-09 22:54:40 -0800 | [diff] [blame] | 38 | pcibios_resource_to_bus(pdev->bus, ®ion, res); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 39 | pci_read_config_dword(pdev, pdev->rom_base_reg, &rom_addr); |
Benjamin Herrenschmidt | 8085ce08 | 2005-08-31 14:16:53 +1000 | [diff] [blame] | 40 | rom_addr &= ~PCI_ROM_ADDRESS_MASK; |
| 41 | rom_addr |= region.start | PCI_ROM_ADDRESS_ENABLE; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 42 | pci_write_config_dword(pdev, pdev->rom_base_reg, rom_addr); |
Benjamin Herrenschmidt | 8085ce08 | 2005-08-31 14:16:53 +1000 | [diff] [blame] | 43 | return 0; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 44 | } |
Ryan Desfosses | b7fe943 | 2014-04-25 14:32:25 -0600 | [diff] [blame] | 45 | EXPORT_SYMBOL_GPL(pci_enable_rom); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 46 | |
| 47 | /** |
| 48 | * pci_disable_rom - disable ROM decoding for a PCI device |
Martin Waitz | 67be2dd | 2005-05-01 08:59:26 -0700 | [diff] [blame] | 49 | * @pdev: PCI device to disable |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 50 | * |
| 51 | * Disable ROM decoding on a PCI device by turning off the last bit in the |
| 52 | * ROM BAR. |
| 53 | */ |
Alan Cox | e416de5 | 2008-09-23 17:25:10 +0100 | [diff] [blame] | 54 | void pci_disable_rom(struct pci_dev *pdev) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 55 | { |
Bjorn Helgaas | 4708f9a | 2016-03-03 08:53:47 -0600 | [diff] [blame] | 56 | struct resource *res = &pdev->resource[PCI_ROM_RESOURCE]; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 57 | u32 rom_addr; |
Bjorn Helgaas | 4708f9a | 2016-03-03 08:53:47 -0600 | [diff] [blame] | 58 | |
| 59 | if (res->flags & IORESOURCE_ROM_SHADOW) |
| 60 | return; |
| 61 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 62 | pci_read_config_dword(pdev, pdev->rom_base_reg, &rom_addr); |
| 63 | rom_addr &= ~PCI_ROM_ADDRESS_ENABLE; |
| 64 | pci_write_config_dword(pdev, pdev->rom_base_reg, rom_addr); |
| 65 | } |
Ryan Desfosses | b7fe943 | 2014-04-25 14:32:25 -0600 | [diff] [blame] | 66 | EXPORT_SYMBOL_GPL(pci_disable_rom); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 67 | |
| 68 | /** |
John Keller | d7ad225 | 2007-07-09 11:42:24 -0700 | [diff] [blame] | 69 | * pci_get_rom_size - obtain the actual size of the ROM image |
Randy Dunlap | 4cc59c7 | 2009-02-09 09:31:20 -0800 | [diff] [blame] | 70 | * @pdev: target PCI device |
John Keller | d7ad225 | 2007-07-09 11:42:24 -0700 | [diff] [blame] | 71 | * @rom: kernel virtual pointer to image of ROM |
| 72 | * @size: size of PCI window |
| 73 | * return: size of actual ROM image |
| 74 | * |
| 75 | * Determine the actual length of the ROM image. |
| 76 | * The PCI window size could be much larger than the |
| 77 | * actual image size. |
| 78 | */ |
Timothy S. Nelson | 97c4483 | 2009-01-30 06:12:47 +1100 | [diff] [blame] | 79 | size_t pci_get_rom_size(struct pci_dev *pdev, void __iomem *rom, size_t size) |
John Keller | d7ad225 | 2007-07-09 11:42:24 -0700 | [diff] [blame] | 80 | { |
| 81 | void __iomem *image; |
| 82 | int last_image; |
Michel Dänzer | 16b036a | 2015-01-19 17:53:20 +0900 | [diff] [blame] | 83 | unsigned length; |
John Keller | d7ad225 | 2007-07-09 11:42:24 -0700 | [diff] [blame] | 84 | |
| 85 | image = rom; |
| 86 | do { |
| 87 | void __iomem *pds; |
| 88 | /* Standard PCI ROMs start out with these bytes 55 AA */ |
Vladis Dronov | 4066df6 | 2015-11-27 18:20:06 +0100 | [diff] [blame] | 89 | if (readw(image) != 0xAA55) { |
| 90 | dev_err(&pdev->dev, "Invalid PCI ROM header signature: expecting 0xaa55, got %#06x\n", |
| 91 | readw(image)); |
John Keller | d7ad225 | 2007-07-09 11:42:24 -0700 | [diff] [blame] | 92 | break; |
Timothy S. Nelson | 97c4483 | 2009-01-30 06:12:47 +1100 | [diff] [blame] | 93 | } |
Vladis Dronov | 4066df6 | 2015-11-27 18:20:06 +0100 | [diff] [blame] | 94 | /* get the PCI data structure and check its "PCIR" signature */ |
John Keller | d7ad225 | 2007-07-09 11:42:24 -0700 | [diff] [blame] | 95 | pds = image + readw(image + 24); |
Vladis Dronov | 4066df6 | 2015-11-27 18:20:06 +0100 | [diff] [blame] | 96 | if (readl(pds) != 0x52494350) { |
| 97 | dev_err(&pdev->dev, "Invalid PCI ROM data signature: expecting 0x52494350, got %#010x\n", |
| 98 | readl(pds)); |
John Keller | d7ad225 | 2007-07-09 11:42:24 -0700 | [diff] [blame] | 99 | break; |
Vladis Dronov | 4066df6 | 2015-11-27 18:20:06 +0100 | [diff] [blame] | 100 | } |
John Keller | d7ad225 | 2007-07-09 11:42:24 -0700 | [diff] [blame] | 101 | last_image = readb(pds + 21) & 0x80; |
Michel Dänzer | 16b036a | 2015-01-19 17:53:20 +0900 | [diff] [blame] | 102 | length = readw(pds + 16); |
| 103 | image += length * 512; |
Edward O'Callaghan | 47b975d | 2016-01-08 12:16:04 -0600 | [diff] [blame] | 104 | /* Avoid iterating through memory outside the resource window */ |
| 105 | if (image > rom + size) |
| 106 | break; |
Michel Dänzer | 16b036a | 2015-01-19 17:53:20 +0900 | [diff] [blame] | 107 | } while (length && !last_image); |
John Keller | d7ad225 | 2007-07-09 11:42:24 -0700 | [diff] [blame] | 108 | |
| 109 | /* never return a size larger than the PCI resource window */ |
| 110 | /* there are known ROMs that get the size wrong */ |
| 111 | return min((size_t)(image - rom), size); |
| 112 | } |
| 113 | |
| 114 | /** |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 115 | * pci_map_rom - map a PCI ROM to kernel space |
Martin Waitz | 67be2dd | 2005-05-01 08:59:26 -0700 | [diff] [blame] | 116 | * @pdev: pointer to pci device struct |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 117 | * @size: pointer to receive size of pci window over ROM |
Randy Dunlap | f5dafca | 2008-10-29 22:35:12 -0700 | [diff] [blame] | 118 | * |
| 119 | * Return: kernel virtual pointer to image of ROM |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 120 | * |
| 121 | * Map a PCI ROM into kernel space. If ROM is boot video ROM, |
| 122 | * the shadow BIOS copy will be returned instead of the |
| 123 | * actual ROM. |
| 124 | */ |
| 125 | void __iomem *pci_map_rom(struct pci_dev *pdev, size_t *size) |
| 126 | { |
| 127 | struct resource *res = &pdev->resource[PCI_ROM_RESOURCE]; |
Matthew Garrett | fffe01f | 2013-03-26 17:25:54 -0400 | [diff] [blame] | 128 | loff_t start; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 129 | void __iomem *rom; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 130 | |
Bjorn Helgaas | f50dd8c | 2016-03-01 11:13:30 -0600 | [diff] [blame] | 131 | /* assign the ROM an address if it doesn't have one */ |
| 132 | if (res->parent == NULL && pci_assign_resource(pdev, PCI_ROM_RESOURCE)) |
| 133 | return NULL; |
| 134 | |
| 135 | start = pci_resource_start(pdev, PCI_ROM_RESOURCE); |
| 136 | *size = pci_resource_len(pdev, PCI_ROM_RESOURCE); |
| 137 | if (*size == 0) |
| 138 | return NULL; |
| 139 | |
| 140 | /* Enable ROM space decodes */ |
| 141 | if (pci_enable_rom(pdev)) |
| 142 | return NULL; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 143 | |
| 144 | rom = ioremap(start, *size); |
| 145 | if (!rom) { |
| 146 | /* restore enable if ioremap fails */ |
Bjorn Helgaas | d9c8bea | 2016-03-02 21:46:50 -0600 | [diff] [blame] | 147 | if (!(res->flags & IORESOURCE_ROM_ENABLE)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 148 | pci_disable_rom(pdev); |
| 149 | return NULL; |
| 150 | } |
| 151 | |
| 152 | /* |
| 153 | * Try to find the true size of the ROM since sometimes the PCI window |
| 154 | * size is much larger than the actual size of the ROM. |
| 155 | * True size is important if the ROM is going to be copied. |
| 156 | */ |
Timothy S. Nelson | 97c4483 | 2009-01-30 06:12:47 +1100 | [diff] [blame] | 157 | *size = pci_get_rom_size(pdev, rom, *size); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 158 | return rom; |
| 159 | } |
Ryan Desfosses | b7fe943 | 2014-04-25 14:32:25 -0600 | [diff] [blame] | 160 | EXPORT_SYMBOL(pci_map_rom); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 161 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 162 | /** |
| 163 | * pci_unmap_rom - unmap the ROM from kernel space |
Martin Waitz | 67be2dd | 2005-05-01 08:59:26 -0700 | [diff] [blame] | 164 | * @pdev: pointer to pci device struct |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 165 | * @rom: virtual address of the previous mapping |
| 166 | * |
| 167 | * Remove a mapping of a previously mapped ROM |
| 168 | */ |
| 169 | void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom) |
| 170 | { |
| 171 | struct resource *res = &pdev->resource[PCI_ROM_RESOURCE]; |
| 172 | |
Matthew Garrett | fffe01f | 2013-03-26 17:25:54 -0400 | [diff] [blame] | 173 | iounmap(rom); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 174 | |
Bjorn Helgaas | 4708f9a | 2016-03-03 08:53:47 -0600 | [diff] [blame] | 175 | /* Disable again before continuing */ |
| 176 | if (!(res->flags & IORESOURCE_ROM_ENABLE)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 177 | pci_disable_rom(pdev); |
| 178 | } |
Ryan Desfosses | b7fe943 | 2014-04-25 14:32:25 -0600 | [diff] [blame] | 179 | EXPORT_SYMBOL(pci_unmap_rom); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 180 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 181 | /** |
Matthew Garrett | fffe01f | 2013-03-26 17:25:54 -0400 | [diff] [blame] | 182 | * pci_platform_rom - provides a pointer to any ROM image provided by the |
| 183 | * platform |
| 184 | * @pdev: pointer to pci device struct |
| 185 | * @size: pointer to receive size of pci window over ROM |
| 186 | */ |
| 187 | void __iomem *pci_platform_rom(struct pci_dev *pdev, size_t *size) |
| 188 | { |
| 189 | if (pdev->rom && pdev->romlen) { |
| 190 | *size = pdev->romlen; |
| 191 | return phys_to_virt((phys_addr_t)pdev->rom); |
| 192 | } |
| 193 | |
| 194 | return NULL; |
| 195 | } |
Matthew Garrett | fffe01f | 2013-03-26 17:25:54 -0400 | [diff] [blame] | 196 | EXPORT_SYMBOL(pci_platform_rom); |