[linux.git] / drivers / pci / rom.c

/*
 * drivers/pci/rom.c
 *
 * (C) Copyright 2004 Jon Smirl <[email protected]>
 * (C) Copyright 2004 Silicon Graphics, Inc. Jesse Barnes <[email protected]>
 *
 * PCI ROM access routines
 */
#include <linux/kernel.h>
#include <linux/pci.h>
#include <linux/slab.h>

#include "pci.h"

/**
 * pci_enable_rom - enable ROM decoding for a PCI device
 * @pdev: PCI device to enable
 *
 * Enable ROM decoding on @dev.  This involves simply turning on the last
 * bit of the PCI ROM BAR.  Note that some cards may share address decoders
 * between the ROM and other resources, so enabling it may disable access
 * to MMIO registers or other card memory.
 */
int pci_enable_rom(struct pci_dev *pdev)
{
	struct resource *res = pdev->resource + PCI_ROM_RESOURCE;
	struct pci_bus_region region;
	u32 rom_addr;

	if (!res->flags)
		return -1;

	pcibios_resource_to_bus(pdev, &region, res);
	pci_read_config_dword(pdev, pdev->rom_base_reg, &rom_addr);
	rom_addr &= ~PCI_ROM_ADDRESS_MASK;
	rom_addr |= region.start | PCI_ROM_ADDRESS_ENABLE;
	pci_write_config_dword(pdev, pdev->rom_base_reg, rom_addr);
	return 0;
}

/**
 * pci_disable_rom - disable ROM decoding for a PCI device
 * @pdev: PCI device to disable
 *
 * Disable ROM decoding on a PCI device by turning off the last bit in the
 * ROM BAR.
 */
void pci_disable_rom(struct pci_dev *pdev)
{
	u32 rom_addr;
	pci_read_config_dword(pdev, pdev->rom_base_reg, &rom_addr);
	rom_addr &= ~PCI_ROM_ADDRESS_ENABLE;
	pci_write_config_dword(pdev, pdev->rom_base_reg, rom_addr);
}

/**
 * pci_get_rom_size - obtain the actual size of the ROM image
 * @pdev: target PCI device
 * @rom: kernel virtual pointer to image of ROM
 * @size: size of PCI window
 *  return: size of actual ROM image
 *
 * Determine the actual length of the ROM image.
 * The PCI window size could be much larger than the
 * actual image size.
 */
size_t pci_get_rom_size(struct pci_dev *pdev, void __iomem *rom, size_t size)
{
	void __iomem *image;
	int last_image;

	image = rom;
	do {
		void __iomem *pds;
		/* Standard PCI ROMs start out with these bytes 55 AA */
		if (readb(image) != 0x55) {
			dev_err(&pdev->dev, "Invalid ROM contents\n");
			break;
		}
		if (readb(image + 1) != 0xAA)
			break;
		/* get the PCI data structure and check its signature */
		pds = image + readw(image + 24);
		if (readb(pds) != 'P')
			break;
		if (readb(pds + 1) != 'C')
			break;
		if (readb(pds + 2) != 'I')
			break;
		if (readb(pds + 3) != 'R')
			break;
		last_image = readb(pds + 21) & 0x80;
		/* this length is reliable */
		image += readw(pds + 16) * 512;
	} while (!last_image);

	/* never return a size larger than the PCI resource window */
	/* there are known ROMs that get the size wrong */
	return min((size_t)(image - rom), size);
}

/**
 * pci_map_rom - map a PCI ROM to kernel space
 * @pdev: pointer to pci device struct
 * @size: pointer to receive size of pci window over ROM
 *
 * Return: kernel virtual pointer to image of ROM
 *
 * Map a PCI ROM into kernel space. If ROM is boot video ROM,
 * the shadow BIOS copy will be returned instead of the
 * actual ROM.
 */
void __iomem *pci_map_rom(struct pci_dev *pdev, size_t *size)
{
	struct resource *res = &pdev->resource[PCI_ROM_RESOURCE];
	loff_t start;
	void __iomem *rom;

	/*
	 * IORESOURCE_ROM_SHADOW set on x86, x86_64 and IA64 supports legacy
	 * memory map if the VGA enable bit of the Bridge Control register is
	 * set for embedded VGA.
	 */
	if (res->flags & IORESOURCE_ROM_SHADOW) {
		/* primary video rom always starts here */
		start = (loff_t)0xC0000;
		*size = 0x20000; /* cover C000:0 through E000:0 */
	} else {
		if (res->flags &
			(IORESOURCE_ROM_COPY | IORESOURCE_ROM_BIOS_COPY)) {
			*size = pci_resource_len(pdev, PCI_ROM_RESOURCE);
			return (void __iomem *)(unsigned long)
				pci_resource_start(pdev, PCI_ROM_RESOURCE);
		} else {
			/* assign the ROM an address if it doesn't have one */
			if (res->parent == NULL &&
			    pci_assign_resource(pdev,PCI_ROM_RESOURCE))
				return NULL;
			start = pci_resource_start(pdev, PCI_ROM_RESOURCE);
			*size = pci_resource_len(pdev, PCI_ROM_RESOURCE);
			if (*size == 0)
				return NULL;

			/* Enable ROM space decodes */
			if (pci_enable_rom(pdev))
				return NULL;
		}
	}

	rom = ioremap(start, *size);
	if (!rom) {
		/* restore enable if ioremap fails */
		if (!(res->flags & (IORESOURCE_ROM_ENABLE |
				    IORESOURCE_ROM_SHADOW |
				    IORESOURCE_ROM_COPY)))
			pci_disable_rom(pdev);
		return NULL;
	}

	/*
	 * Try to find the true size of the ROM since sometimes the PCI window
	 * size is much larger than the actual size of the ROM.
	 * True size is important if the ROM is going to be copied.
	 */
	*size = pci_get_rom_size(pdev, rom, *size);
	return rom;
}

#if 0
/**
 * pci_map_rom_copy - map a PCI ROM to kernel space, create a copy
 * @pdev: pointer to pci device struct
 * @size: pointer to receive size of pci window over ROM
 *
 * Return: kernel virtual pointer to image of ROM
 *
 * Map a PCI ROM into kernel space. If ROM is boot video ROM,
 * the shadow BIOS copy will be returned instead of the
 * actual ROM.
 */
void __iomem *pci_map_rom_copy(struct pci_dev *pdev, size_t *size)
{
	struct resource *res = &pdev->resource[PCI_ROM_RESOURCE];
	void __iomem *rom;

	rom = pci_map_rom(pdev, size);
	if (!rom)
		return NULL;

	if (res->flags & (IORESOURCE_ROM_COPY | IORESOURCE_ROM_SHADOW |
			  IORESOURCE_ROM_BIOS_COPY))
		return rom;

	res->start = (unsigned long)kmalloc(*size, GFP_KERNEL);
	if (!res->start)
		return rom;

	res->end = res->start + *size;
	memcpy_fromio((void*)(unsigned long)res->start, rom, *size);
	pci_unmap_rom(pdev, rom);
	res->flags |= IORESOURCE_ROM_COPY;

	return (void __iomem *)(unsigned long)res->start;
}
#endif  /*  0  */

/**
 * pci_unmap_rom - unmap the ROM from kernel space
 * @pdev: pointer to pci device struct
 * @rom: virtual address of the previous mapping
 *
 * Remove a mapping of a previously mapped ROM
 */
void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom)
{
	struct resource *res = &pdev->resource[PCI_ROM_RESOURCE];

	if (res->flags & (IORESOURCE_ROM_COPY | IORESOURCE_ROM_BIOS_COPY))
		return;

	iounmap(rom);

	/* Disable again before continuing, leave enabled if pci=rom */
	if (!(res->flags & (IORESOURCE_ROM_ENABLE | IORESOURCE_ROM_SHADOW)))
		pci_disable_rom(pdev);
}

#if 0
/**
 * pci_remove_rom - disable the ROM and remove its sysfs attribute
 * @pdev: pointer to pci device struct
 *
 * Remove the rom file in sysfs and disable ROM decoding.
 */
void pci_remove_rom(struct pci_dev *pdev)
{
	struct resource *res = &pdev->resource[PCI_ROM_RESOURCE];

	if (pci_resource_len(pdev, PCI_ROM_RESOURCE))
		sysfs_remove_bin_file(&pdev->dev.kobj, pdev->rom_attr);
	if (!(res->flags & (IORESOURCE_ROM_ENABLE |
			    IORESOURCE_ROM_SHADOW |
			    IORESOURCE_ROM_BIOS_COPY |
			    IORESOURCE_ROM_COPY)))
		pci_disable_rom(pdev);
}
#endif  /*  0  */

/**
 * pci_cleanup_rom - free the ROM copy created by pci_map_rom_copy
 * @pdev: pointer to pci device struct
 *
 * Free the copied ROM if we allocated one.
 */
void pci_cleanup_rom(struct pci_dev *pdev)
{
	struct resource *res = &pdev->resource[PCI_ROM_RESOURCE];
	if (res->flags & IORESOURCE_ROM_COPY) {
		kfree((void*)(unsigned long)res->start);
		res->flags &= ~IORESOURCE_ROM_COPY;
		res->start = 0;
		res->end = 0;
	}
}

EXPORT_SYMBOL(pci_map_rom);
EXPORT_SYMBOL(pci_unmap_rom);
EXPORT_SYMBOL_GPL(pci_enable_rom);
EXPORT_SYMBOL_GPL(pci_disable_rom);
Commit	Line	Data
1da177e4 LT	1	/*
	2	* drivers/pci/rom.c
	3	*
	4	* (C) Copyright 2004 Jon Smirl <[email protected]>
	5	* (C) Copyright 2004 Silicon Graphics, Inc. Jesse Barnes <[email protected]>
	6	*
	7	* PCI ROM access routines
	8	*/
1da177e4 LT	9	#include <linux/kernel.h>
1da177e4 LT	10	#include <linux/pci.h>
4e57b681	11	#include <linux/slab.h>
1da177e4 LT	12
	13	#include "pci.h"
	14
	15	/**
	16	* pci_enable_rom - enable ROM decoding for a PCI device
67be2dd1	17	* @pdev: PCI device to enable
1da177e4 LT	18	*
	19	* Enable ROM decoding on @dev. This involves simply turning on the last
	20	* bit of the PCI ROM BAR. Note that some cards may share address decoders
	21	* between the ROM and other resources, so enabling it may disable access
	22	* to MMIO registers or other card memory.
	23	*/
e416de5e	24	int pci_enable_rom(struct pci_dev *pdev)
1da177e4	25	{
8085ce08 BH	26	struct resource *res = pdev->resource + PCI_ROM_RESOURCE;
8085ce08 BH	27	struct pci_bus_region region;
1da177e4 LT	28	u32 rom_addr;
1da177e4 LT	29
8085ce08 BH	30	if (!res->flags)
	31	return -1;
	32
	33	pcibios_resource_to_bus(pdev, &region, res);
1da177e4	34	pci_read_config_dword(pdev, pdev->rom_base_reg, &rom_addr);
8085ce08 BH	35	rom_addr &= ~PCI_ROM_ADDRESS_MASK;
8085ce08 BH	36	rom_addr \|= region.start \| PCI_ROM_ADDRESS_ENABLE;
1da177e4	37	pci_write_config_dword(pdev, pdev->rom_base_reg, rom_addr);
8085ce08	38	return 0;
1da177e4 LT	39	}
	40
	41	/**
	42	* pci_disable_rom - disable ROM decoding for a PCI device
67be2dd1	43	* @pdev: PCI device to disable
1da177e4 LT	44	*
	45	* Disable ROM decoding on a PCI device by turning off the last bit in the
	46	* ROM BAR.
	47	*/
e416de5e	48	void pci_disable_rom(struct pci_dev *pdev)
1da177e4 LT	49	{
	50	u32 rom_addr;
	51	pci_read_config_dword(pdev, pdev->rom_base_reg, &rom_addr);
	52	rom_addr &= ~PCI_ROM_ADDRESS_ENABLE;
	53	pci_write_config_dword(pdev, pdev->rom_base_reg, rom_addr);
	54	}
	55
d7ad2254 JK	56	/**
d7ad2254 JK	57	* pci_get_rom_size - obtain the actual size of the ROM image
4cc59c72	58	* @pdev: target PCI device
d7ad2254 JK	59	* @rom: kernel virtual pointer to image of ROM
	60	* @size: size of PCI window
	61	* return: size of actual ROM image
	62	*
	63	* Determine the actual length of the ROM image.
	64	* The PCI window size could be much larger than the
	65	* actual image size.
	66	*/
97c44836	67	size_t pci_get_rom_size(struct pci_dev pdev, void __iomem rom, size_t size)
d7ad2254 JK	68	{
	69	void __iomem *image;
	70	int last_image;
	71
	72	image = rom;
	73	do {
	74	void __iomem *pds;
	75	/* Standard PCI ROMs start out with these bytes 55 AA */
97c44836 TN	76	if (readb(image) != 0x55) {
97c44836 TN	77	dev_err(&pdev->dev, "Invalid ROM contents\n");
d7ad2254	78	break;
97c44836	79	}
d7ad2254 JK	80	if (readb(image + 1) != 0xAA)
	81	break;
	82	/* get the PCI data structure and check its signature */
	83	pds = image + readw(image + 24);
	84	if (readb(pds) != 'P')
	85	break;
	86	if (readb(pds + 1) != 'C')
	87	break;
	88	if (readb(pds + 2) != 'I')
	89	break;
	90	if (readb(pds + 3) != 'R')
	91	break;
	92	last_image = readb(pds + 21) & 0x80;
	93	/* this length is reliable */
	94	image += readw(pds + 16) * 512;
	95	} while (!last_image);
	96
	97	/* never return a size larger than the PCI resource window */
	98	/* there are known ROMs that get the size wrong */
	99	return min((size_t)(image - rom), size);
	100	}
	101
1da177e4 LT	102	/**
1da177e4 LT	103	* pci_map_rom - map a PCI ROM to kernel space
67be2dd1	104	* @pdev: pointer to pci device struct
1da177e4	105	* @size: pointer to receive size of pci window over ROM
f5dafca5 RD	106	*
f5dafca5 RD	107	* Return: kernel virtual pointer to image of ROM
1da177e4 LT	108	*
	109	* Map a PCI ROM into kernel space. If ROM is boot video ROM,
	110	* the shadow BIOS copy will be returned instead of the
	111	* actual ROM.
	112	*/
	113	void __iomem pci_map_rom(struct pci_dev pdev, size_t *size)
	114	{
	115	struct resource *res = &pdev->resource[PCI_ROM_RESOURCE];
	116	loff_t start;
	117	void __iomem *rom;
1da177e4	118
b5e4efe7	119	/*
6b5c76b8 EO	120	* IORESOURCE_ROM_SHADOW set on x86, x86_64 and IA64 supports legacy
	121	* memory map if the VGA enable bit of the Bridge Control register is
	122	* set for embedded VGA.
b5e4efe7	123	*/
1da177e4 LT	124	if (res->flags & IORESOURCE_ROM_SHADOW) {
	125	/* primary video rom always starts here */
	126	start = (loff_t)0xC0000;
	127	size = 0x20000; / cover C000:0 through E000:0 */
	128	} else {
a2302c68 JK	129	if (res->flags &
a2302c68 JK	130	(IORESOURCE_ROM_COPY \| IORESOURCE_ROM_BIOS_COPY)) {
1da177e4	131	*size = pci_resource_len(pdev, PCI_ROM_RESOURCE);
e31dd6e4 GKH	132	return (void __iomem *)(unsigned long)
e31dd6e4 GKH	133	pci_resource_start(pdev, PCI_ROM_RESOURCE);
1da177e4 LT	134	} else {
1da177e4 LT	135	/* assign the ROM an address if it doesn't have one */
8085ce08 BH	136	if (res->parent == NULL &&
	137	pci_assign_resource(pdev,PCI_ROM_RESOURCE))
	138	return NULL;
1da177e4 LT	139	start = pci_resource_start(pdev, PCI_ROM_RESOURCE);
	140	*size = pci_resource_len(pdev, PCI_ROM_RESOURCE);
	141	if (*size == 0)
	142	return NULL;
	143
	144	/* Enable ROM space decodes */
8085ce08 BH	145	if (pci_enable_rom(pdev))
8085ce08 BH	146	return NULL;
1da177e4 LT	147	}
	148	}
	149
	150	rom = ioremap(start, *size);
	151	if (!rom) {
	152	/* restore enable if ioremap fails */
	153	if (!(res->flags & (IORESOURCE_ROM_ENABLE \|
	154	IORESOURCE_ROM_SHADOW \|
	155	IORESOURCE_ROM_COPY)))
	156	pci_disable_rom(pdev);
	157	return NULL;
	158	}
	159
	160	/*
	161	* Try to find the true size of the ROM since sometimes the PCI window
	162	* size is much larger than the actual size of the ROM.
	163	* True size is important if the ROM is going to be copied.
	164	*/
97c44836	165	size = pci_get_rom_size(pdev, rom, size);
1da177e4 LT	166	return rom;
	167	}
	168
b09549ef	169	#if 0
1da177e4 LT	170	/**
1da177e4 LT	171	* pci_map_rom_copy - map a PCI ROM to kernel space, create a copy
67be2dd1	172	* @pdev: pointer to pci device struct
1da177e4	173	* @size: pointer to receive size of pci window over ROM
f5dafca5 RD	174	*
f5dafca5 RD	175	* Return: kernel virtual pointer to image of ROM
1da177e4 LT	176	*
	177	* Map a PCI ROM into kernel space. If ROM is boot video ROM,
	178	* the shadow BIOS copy will be returned instead of the
	179	* actual ROM.
	180	*/
	181	void __iomem pci_map_rom_copy(struct pci_dev pdev, size_t *size)
	182	{
	183	struct resource *res = &pdev->resource[PCI_ROM_RESOURCE];
	184	void __iomem *rom;
	185
	186	rom = pci_map_rom(pdev, size);
	187	if (!rom)
	188	return NULL;
	189
a2302c68 JK	190	if (res->flags & (IORESOURCE_ROM_COPY \| IORESOURCE_ROM_SHADOW \|
a2302c68 JK	191	IORESOURCE_ROM_BIOS_COPY))
1da177e4 LT	192	return rom;
	193
	194	res->start = (unsigned long)kmalloc(*size, GFP_KERNEL);
	195	if (!res->start)
	196	return rom;
	197
	198	res->end = res->start + *size;
e31dd6e4	199	memcpy_fromio((void)(unsigned long)res->start, rom, size);
1da177e4 LT	200	pci_unmap_rom(pdev, rom);
	201	res->flags \|= IORESOURCE_ROM_COPY;
	202
e31dd6e4	203	return (void __iomem *)(unsigned long)res->start;
1da177e4	204	}
b09549ef	205	#endif /* 0 */
1da177e4 LT	206
	207	/**
	208	* pci_unmap_rom - unmap the ROM from kernel space
67be2dd1	209	* @pdev: pointer to pci device struct
1da177e4 LT	210	* @rom: virtual address of the previous mapping
	211	*
	212	* Remove a mapping of a previously mapped ROM
	213	*/
	214	void pci_unmap_rom(struct pci_dev pdev, void __iomem rom)
	215	{
	216	struct resource *res = &pdev->resource[PCI_ROM_RESOURCE];
	217
a2302c68	218	if (res->flags & (IORESOURCE_ROM_COPY \| IORESOURCE_ROM_BIOS_COPY))
1da177e4 LT	219	return;
	220
	221	iounmap(rom);
	222
	223	/* Disable again before continuing, leave enabled if pci=rom */
	224	if (!(res->flags & (IORESOURCE_ROM_ENABLE \| IORESOURCE_ROM_SHADOW)))
	225	pci_disable_rom(pdev);
	226	}
	227
b09549ef	228	#if 0
1da177e4 LT	229	/**
1da177e4 LT	230	* pci_remove_rom - disable the ROM and remove its sysfs attribute
67be2dd1	231	* @pdev: pointer to pci device struct
1da177e4 LT	232	*
	233	* Remove the rom file in sysfs and disable ROM decoding.
	234	*/
	235	void pci_remove_rom(struct pci_dev *pdev)
	236	{
	237	struct resource *res = &pdev->resource[PCI_ROM_RESOURCE];
	238
	239	if (pci_resource_len(pdev, PCI_ROM_RESOURCE))
	240	sysfs_remove_bin_file(&pdev->dev.kobj, pdev->rom_attr);
	241	if (!(res->flags & (IORESOURCE_ROM_ENABLE \|
	242	IORESOURCE_ROM_SHADOW \|
a2302c68	243	IORESOURCE_ROM_BIOS_COPY \|
1da177e4 LT	244	IORESOURCE_ROM_COPY)))
	245	pci_disable_rom(pdev);
	246	}
b09549ef	247	#endif /* 0 */
1da177e4 LT	248
1da177e4 LT	249	/**
0643245f	250	* pci_cleanup_rom - free the ROM copy created by pci_map_rom_copy
67be2dd1	251	* @pdev: pointer to pci device struct
1da177e4 LT	252	*
	253	* Free the copied ROM if we allocated one.
	254	*/
	255	void pci_cleanup_rom(struct pci_dev *pdev)
	256	{
	257	struct resource *res = &pdev->resource[PCI_ROM_RESOURCE];
	258	if (res->flags & IORESOURCE_ROM_COPY) {
e31dd6e4	259	kfree((void*)(unsigned long)res->start);
1da177e4 LT	260	res->flags &= ~IORESOURCE_ROM_COPY;
	261	res->start = 0;
	262	res->end = 0;
	263	}
	264	}
	265
	266	EXPORT_SYMBOL(pci_map_rom);
1da177e4	267	EXPORT_SYMBOL(pci_unmap_rom);
e416de5e AC	268	EXPORT_SYMBOL_GPL(pci_enable_rom);
e416de5e AC	269	EXPORT_SYMBOL_GPL(pci_disable_rom);