blob: 48ebdb237f3f73d1e37e6e2022940ea5262d459c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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 Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/kernel.h>
Paul Gortmaker363c75d2011-05-27 09:37:25 -040010#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/pci.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080012#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013
14#include "pci.h"
15
16/**
17 * pci_enable_rom - enable ROM decoding for a PCI device
Martin Waitz67be2dd2005-05-01 08:59:26 -070018 * @pdev: PCI device to enable
Linus Torvalds1da177e2005-04-16 15:20:36 -070019 *
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 Coxe416de52008-09-23 17:25:10 +010025int pci_enable_rom(struct pci_dev *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -070026{
Benjamin Herrenschmidt8085ce02005-08-31 14:16:53 +100027 struct resource *res = pdev->resource + PCI_ROM_RESOURCE;
28 struct pci_bus_region region;
Linus Torvalds1da177e2005-04-16 15:20:36 -070029 u32 rom_addr;
30
Benjamin Herrenschmidt8085ce02005-08-31 14:16:53 +100031 if (!res->flags)
32 return -1;
33
34 pcibios_resource_to_bus(pdev, &region, res);
Linus Torvalds1da177e2005-04-16 15:20:36 -070035 pci_read_config_dword(pdev, pdev->rom_base_reg, &rom_addr);
Benjamin Herrenschmidt8085ce02005-08-31 14:16:53 +100036 rom_addr &= ~PCI_ROM_ADDRESS_MASK;
37 rom_addr |= region.start | PCI_ROM_ADDRESS_ENABLE;
Linus Torvalds1da177e2005-04-16 15:20:36 -070038 pci_write_config_dword(pdev, pdev->rom_base_reg, rom_addr);
Benjamin Herrenschmidt8085ce02005-08-31 14:16:53 +100039 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070040}
41
42/**
43 * pci_disable_rom - disable ROM decoding for a PCI device
Martin Waitz67be2dd2005-05-01 08:59:26 -070044 * @pdev: PCI device to disable
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 *
46 * Disable ROM decoding on a PCI device by turning off the last bit in the
47 * ROM BAR.
48 */
Alan Coxe416de52008-09-23 17:25:10 +010049void pci_disable_rom(struct pci_dev *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -070050{
51 u32 rom_addr;
52 pci_read_config_dword(pdev, pdev->rom_base_reg, &rom_addr);
53 rom_addr &= ~PCI_ROM_ADDRESS_ENABLE;
54 pci_write_config_dword(pdev, pdev->rom_base_reg, rom_addr);
55}
56
57/**
John Kellerd7ad2252007-07-09 11:42:24 -070058 * pci_get_rom_size - obtain the actual size of the ROM image
Randy Dunlap4cc59c72009-02-09 09:31:20 -080059 * @pdev: target PCI device
John Kellerd7ad2252007-07-09 11:42:24 -070060 * @rom: kernel virtual pointer to image of ROM
61 * @size: size of PCI window
62 * return: size of actual ROM image
63 *
64 * Determine the actual length of the ROM image.
65 * The PCI window size could be much larger than the
66 * actual image size.
67 */
Timothy S. Nelson97c44832009-01-30 06:12:47 +110068size_t pci_get_rom_size(struct pci_dev *pdev, void __iomem *rom, size_t size)
John Kellerd7ad2252007-07-09 11:42:24 -070069{
70 void __iomem *image;
71 int last_image;
72
73 image = rom;
74 do {
75 void __iomem *pds;
76 /* Standard PCI ROMs start out with these bytes 55 AA */
Timothy S. Nelson97c44832009-01-30 06:12:47 +110077 if (readb(image) != 0x55) {
78 dev_err(&pdev->dev, "Invalid ROM contents\n");
John Kellerd7ad2252007-07-09 11:42:24 -070079 break;
Timothy S. Nelson97c44832009-01-30 06:12:47 +110080 }
John Kellerd7ad2252007-07-09 11:42:24 -070081 if (readb(image + 1) != 0xAA)
82 break;
83 /* get the PCI data structure and check its signature */
84 pds = image + readw(image + 24);
85 if (readb(pds) != 'P')
86 break;
87 if (readb(pds + 1) != 'C')
88 break;
89 if (readb(pds + 2) != 'I')
90 break;
91 if (readb(pds + 3) != 'R')
92 break;
93 last_image = readb(pds + 21) & 0x80;
94 /* this length is reliable */
95 image += readw(pds + 16) * 512;
96 } while (!last_image);
97
98 /* never return a size larger than the PCI resource window */
99 /* there are known ROMs that get the size wrong */
100 return min((size_t)(image - rom), size);
101}
102
103/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 * pci_map_rom - map a PCI ROM to kernel space
Martin Waitz67be2dd2005-05-01 08:59:26 -0700105 * @pdev: pointer to pci device struct
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 * @size: pointer to receive size of pci window over ROM
Randy Dunlapf5dafca2008-10-29 22:35:12 -0700107 *
108 * Return: kernel virtual pointer to image of ROM
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 *
110 * Map a PCI ROM into kernel space. If ROM is boot video ROM,
111 * the shadow BIOS copy will be returned instead of the
112 * actual ROM.
113 */
114void __iomem *pci_map_rom(struct pci_dev *pdev, size_t *size)
115{
116 struct resource *res = &pdev->resource[PCI_ROM_RESOURCE];
117 loff_t start;
118 void __iomem *rom;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
eiichiro.oiwa.nm@hitachi.comb5e4efe2006-09-28 13:55:47 +0900120 /*
Eiichiro Oiwa6b5c76b2006-10-23 15:14:07 +0900121 * IORESOURCE_ROM_SHADOW set on x86, x86_64 and IA64 supports legacy
122 * memory map if the VGA enable bit of the Bridge Control register is
123 * set for embedded VGA.
eiichiro.oiwa.nm@hitachi.comb5e4efe2006-09-28 13:55:47 +0900124 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 if (res->flags & IORESOURCE_ROM_SHADOW) {
126 /* primary video rom always starts here */
127 start = (loff_t)0xC0000;
128 *size = 0x20000; /* cover C000:0 through E000:0 */
129 } else {
John Kellera2302c62006-10-04 16:49:52 -0500130 if (res->flags &
131 (IORESOURCE_ROM_COPY | IORESOURCE_ROM_BIOS_COPY)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 *size = pci_resource_len(pdev, PCI_ROM_RESOURCE);
Greg Kroah-Hartmane31dd6e2006-06-12 17:06:02 -0700133 return (void __iomem *)(unsigned long)
134 pci_resource_start(pdev, PCI_ROM_RESOURCE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 } else {
136 /* assign the ROM an address if it doesn't have one */
Benjamin Herrenschmidt8085ce02005-08-31 14:16:53 +1000137 if (res->parent == NULL &&
138 pci_assign_resource(pdev,PCI_ROM_RESOURCE))
139 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 start = pci_resource_start(pdev, PCI_ROM_RESOURCE);
141 *size = pci_resource_len(pdev, PCI_ROM_RESOURCE);
142 if (*size == 0)
143 return NULL;
144
145 /* Enable ROM space decodes */
Benjamin Herrenschmidt8085ce02005-08-31 14:16:53 +1000146 if (pci_enable_rom(pdev))
147 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 }
149 }
150
151 rom = ioremap(start, *size);
152 if (!rom) {
153 /* restore enable if ioremap fails */
154 if (!(res->flags & (IORESOURCE_ROM_ENABLE |
155 IORESOURCE_ROM_SHADOW |
156 IORESOURCE_ROM_COPY)))
157 pci_disable_rom(pdev);
158 return NULL;
159 }
160
161 /*
162 * Try to find the true size of the ROM since sometimes the PCI window
163 * size is much larger than the actual size of the ROM.
164 * True size is important if the ROM is going to be copied.
165 */
Timothy S. Nelson97c44832009-01-30 06:12:47 +1100166 *size = pci_get_rom_size(pdev, rom, *size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 return rom;
168}
169
Adrian Bunkb09549e2007-10-27 03:06:25 +0200170#if 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171/**
172 * pci_map_rom_copy - map a PCI ROM to kernel space, create a copy
Martin Waitz67be2dd2005-05-01 08:59:26 -0700173 * @pdev: pointer to pci device struct
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 * @size: pointer to receive size of pci window over ROM
Randy Dunlapf5dafca2008-10-29 22:35:12 -0700175 *
176 * Return: kernel virtual pointer to image of ROM
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 *
178 * Map a PCI ROM into kernel space. If ROM is boot video ROM,
179 * the shadow BIOS copy will be returned instead of the
180 * actual ROM.
181 */
182void __iomem *pci_map_rom_copy(struct pci_dev *pdev, size_t *size)
183{
184 struct resource *res = &pdev->resource[PCI_ROM_RESOURCE];
185 void __iomem *rom;
186
187 rom = pci_map_rom(pdev, size);
188 if (!rom)
189 return NULL;
190
John Kellera2302c62006-10-04 16:49:52 -0500191 if (res->flags & (IORESOURCE_ROM_COPY | IORESOURCE_ROM_SHADOW |
192 IORESOURCE_ROM_BIOS_COPY))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 return rom;
194
195 res->start = (unsigned long)kmalloc(*size, GFP_KERNEL);
196 if (!res->start)
197 return rom;
198
199 res->end = res->start + *size;
Greg Kroah-Hartmane31dd6e2006-06-12 17:06:02 -0700200 memcpy_fromio((void*)(unsigned long)res->start, rom, *size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 pci_unmap_rom(pdev, rom);
202 res->flags |= IORESOURCE_ROM_COPY;
203
Greg Kroah-Hartmane31dd6e2006-06-12 17:06:02 -0700204 return (void __iomem *)(unsigned long)res->start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205}
Adrian Bunkb09549e2007-10-27 03:06:25 +0200206#endif /* 0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
208/**
209 * pci_unmap_rom - unmap the ROM from kernel space
Martin Waitz67be2dd2005-05-01 08:59:26 -0700210 * @pdev: pointer to pci device struct
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 * @rom: virtual address of the previous mapping
212 *
213 * Remove a mapping of a previously mapped ROM
214 */
215void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom)
216{
217 struct resource *res = &pdev->resource[PCI_ROM_RESOURCE];
218
John Kellera2302c62006-10-04 16:49:52 -0500219 if (res->flags & (IORESOURCE_ROM_COPY | IORESOURCE_ROM_BIOS_COPY))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 return;
221
222 iounmap(rom);
223
224 /* Disable again before continuing, leave enabled if pci=rom */
225 if (!(res->flags & (IORESOURCE_ROM_ENABLE | IORESOURCE_ROM_SHADOW)))
226 pci_disable_rom(pdev);
227}
228
Adrian Bunkb09549e2007-10-27 03:06:25 +0200229#if 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230/**
231 * pci_remove_rom - disable the ROM and remove its sysfs attribute
Martin Waitz67be2dd2005-05-01 08:59:26 -0700232 * @pdev: pointer to pci device struct
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 *
234 * Remove the rom file in sysfs and disable ROM decoding.
235 */
236void pci_remove_rom(struct pci_dev *pdev)
237{
238 struct resource *res = &pdev->resource[PCI_ROM_RESOURCE];
239
240 if (pci_resource_len(pdev, PCI_ROM_RESOURCE))
241 sysfs_remove_bin_file(&pdev->dev.kobj, pdev->rom_attr);
242 if (!(res->flags & (IORESOURCE_ROM_ENABLE |
243 IORESOURCE_ROM_SHADOW |
John Kellera2302c62006-10-04 16:49:52 -0500244 IORESOURCE_ROM_BIOS_COPY |
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 IORESOURCE_ROM_COPY)))
246 pci_disable_rom(pdev);
247}
Adrian Bunkb09549e2007-10-27 03:06:25 +0200248#endif /* 0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249
250/**
Randy Dunlap06432452008-02-29 22:03:15 -0800251 * pci_cleanup_rom - free the ROM copy created by pci_map_rom_copy
Martin Waitz67be2dd2005-05-01 08:59:26 -0700252 * @pdev: pointer to pci device struct
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 *
254 * Free the copied ROM if we allocated one.
255 */
256void pci_cleanup_rom(struct pci_dev *pdev)
257{
258 struct resource *res = &pdev->resource[PCI_ROM_RESOURCE];
259 if (res->flags & IORESOURCE_ROM_COPY) {
Greg Kroah-Hartmane31dd6e2006-06-12 17:06:02 -0700260 kfree((void*)(unsigned long)res->start);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 res->flags &= ~IORESOURCE_ROM_COPY;
262 res->start = 0;
263 res->end = 0;
264 }
265}
266
267EXPORT_SYMBOL(pci_map_rom);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268EXPORT_SYMBOL(pci_unmap_rom);
Alan Coxe416de52008-09-23 17:25:10 +0100269EXPORT_SYMBOL_GPL(pci_enable_rom);
270EXPORT_SYMBOL_GPL(pci_disable_rom);