[thirdparty/linux.git] / lib / devres.c

// SPDX-License-Identifier: GPL-2.0
#include <linux/err.h>
#include <linux/pci.h>
#include <linux/io.h>
#include <linux/gfp.h>
#include <linux/export.h>
#include <linux/of_address.h>

enum devm_ioremap_type {
	DEVM_IOREMAP = 0,
	DEVM_IOREMAP_NC,
	DEVM_IOREMAP_WC,
};

void devm_ioremap_release(struct device *dev, void *res)
{
	iounmap(*(void __iomem **)res);
}

static int devm_ioremap_match(struct device *dev, void *res, void *match_data)
{
	return *(void **)res == match_data;
}

static void __iomem *__devm_ioremap(struct device *dev, resource_size_t offset,
				    resource_size_t size,
				    enum devm_ioremap_type type)
{
	void __iomem **ptr, *addr = NULL;

	ptr = devres_alloc(devm_ioremap_release, sizeof(*ptr), GFP_KERNEL);
	if (!ptr)
		return NULL;

	switch (type) {
	case DEVM_IOREMAP:
		addr = ioremap(offset, size);
		break;
	case DEVM_IOREMAP_NC:
		addr = ioremap_nocache(offset, size);
		break;
	case DEVM_IOREMAP_WC:
		addr = ioremap_wc(offset, size);
		break;
	}

	if (addr) {
		*ptr = addr;
		devres_add(dev, ptr);
	} else
		devres_free(ptr);

	return addr;
}

/**
 * devm_ioremap - Managed ioremap()
 * @dev: Generic device to remap IO address for
 * @offset: Resource address to map
 * @size: Size of map
 *
 * Managed ioremap().  Map is automatically unmapped on driver detach.
 */
void __iomem *devm_ioremap(struct device *dev, resource_size_t offset,
			   resource_size_t size)
{
	return __devm_ioremap(dev, offset, size, DEVM_IOREMAP);
}
EXPORT_SYMBOL(devm_ioremap);

/**
 * devm_ioremap_nocache - Managed ioremap_nocache()
 * @dev: Generic device to remap IO address for
 * @offset: Resource address to map
 * @size: Size of map
 *
 * Managed ioremap_nocache().  Map is automatically unmapped on driver
 * detach.
 */
void __iomem *devm_ioremap_nocache(struct device *dev, resource_size_t offset,
				   resource_size_t size)
{
	return __devm_ioremap(dev, offset, size, DEVM_IOREMAP_NC);
}
EXPORT_SYMBOL(devm_ioremap_nocache);

/**
 * devm_ioremap_wc - Managed ioremap_wc()
 * @dev: Generic device to remap IO address for
 * @offset: Resource address to map
 * @size: Size of map
 *
 * Managed ioremap_wc().  Map is automatically unmapped on driver detach.
 */
void __iomem *devm_ioremap_wc(struct device *dev, resource_size_t offset,
			      resource_size_t size)
{
	return __devm_ioremap(dev, offset, size, DEVM_IOREMAP_WC);
}
EXPORT_SYMBOL(devm_ioremap_wc);

/**
 * devm_iounmap - Managed iounmap()
 * @dev: Generic device to unmap for
 * @addr: Address to unmap
 *
 * Managed iounmap().  @addr must have been mapped using devm_ioremap*().
 */
void devm_iounmap(struct device *dev, void __iomem *addr)
{
	WARN_ON(devres_destroy(dev, devm_ioremap_release, devm_ioremap_match,
			       (__force void *)addr));
	iounmap(addr);
}
EXPORT_SYMBOL(devm_iounmap);

/**
 * devm_ioremap_resource() - check, request region, and ioremap resource
 * @dev: generic device to handle the resource for
 * @res: resource to be handled
 *
 * Checks that a resource is a valid memory region, requests the memory
 * region and ioremaps it. All operations are managed and will be undone
 * on driver detach.
 *
 * Returns a pointer to the remapped memory or an ERR_PTR() encoded error code
 * on failure. Usage example:
 *
 *	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 *	base = devm_ioremap_resource(&pdev->dev, res);
 *	if (IS_ERR(base))
 *		return PTR_ERR(base);
 */
void __iomem *devm_ioremap_resource(struct device *dev,
				    const struct resource *res)
{
	resource_size_t size;
	void __iomem *dest_ptr;

	BUG_ON(!dev);

	if (!res || resource_type(res) != IORESOURCE_MEM) {
		dev_err(dev, "invalid resource\n");
		return IOMEM_ERR_PTR(-EINVAL);
	}

	size = resource_size(res);

	if (!devm_request_mem_region(dev, res->start, size, dev_name(dev))) {
		dev_err(dev, "can't request region for resource %pR\n", res);
		return IOMEM_ERR_PTR(-EBUSY);
	}

	dest_ptr = devm_ioremap(dev, res->start, size);
	if (!dest_ptr) {
		dev_err(dev, "ioremap failed for resource %pR\n", res);
		devm_release_mem_region(dev, res->start, size);
		dest_ptr = IOMEM_ERR_PTR(-ENOMEM);
	}

	return dest_ptr;
}
EXPORT_SYMBOL(devm_ioremap_resource);

/*
 * devm_of_iomap - Requests a resource and maps the memory mapped IO
 *		   for a given device_node managed by a given device
 *
 * Checks that a resource is a valid memory region, requests the memory
 * region and ioremaps it. All operations are managed and will be undone
 * on driver detach of the device.
 *
 * This is to be used when a device requests/maps resources described
 * by other device tree nodes (children or otherwise).
 *
 * @dev:	The device "managing" the resource
 * @node:       The device-tree node where the resource resides
 * @index:	index of the MMIO range in the "reg" property
 * @size:	Returns the size of the resource (pass NULL if not needed)
 * Returns a pointer to the requested and mapped memory or an ERR_PTR() encoded
 * error code on failure. Usage example:
 *
 *	base = devm_of_iomap(&pdev->dev, node, 0, NULL);
 *	if (IS_ERR(base))
 *		return PTR_ERR(base);
 */
void __iomem *devm_of_iomap(struct device *dev, struct device_node *node, int index,
			    resource_size_t *size)
{
	struct resource res;

	if (of_address_to_resource(node, index, &res))
		return IOMEM_ERR_PTR(-EINVAL);
	if (size)
		*size = resource_size(&res);
	return devm_ioremap_resource(dev, &res);
}
EXPORT_SYMBOL(devm_of_iomap);

#ifdef CONFIG_HAS_IOPORT_MAP
/*
 * Generic iomap devres
 */
static void devm_ioport_map_release(struct device *dev, void *res)
{
	ioport_unmap(*(void __iomem **)res);
}

static int devm_ioport_map_match(struct device *dev, void *res,
				 void *match_data)
{
	return *(void **)res == match_data;
}

/**
 * devm_ioport_map - Managed ioport_map()
 * @dev: Generic device to map ioport for
 * @port: Port to map
 * @nr: Number of ports to map
 *
 * Managed ioport_map().  Map is automatically unmapped on driver
 * detach.
 */
void __iomem *devm_ioport_map(struct device *dev, unsigned long port,
			       unsigned int nr)
{
	void __iomem **ptr, *addr;

	ptr = devres_alloc(devm_ioport_map_release, sizeof(*ptr), GFP_KERNEL);
	if (!ptr)
		return NULL;

	addr = ioport_map(port, nr);
	if (addr) {
		*ptr = addr;
		devres_add(dev, ptr);
	} else
		devres_free(ptr);

	return addr;
}
EXPORT_SYMBOL(devm_ioport_map);

/**
 * devm_ioport_unmap - Managed ioport_unmap()
 * @dev: Generic device to unmap for
 * @addr: Address to unmap
 *
 * Managed ioport_unmap().  @addr must have been mapped using
 * devm_ioport_map().
 */
void devm_ioport_unmap(struct device *dev, void __iomem *addr)
{
	ioport_unmap(addr);
	WARN_ON(devres_destroy(dev, devm_ioport_map_release,
			       devm_ioport_map_match, (__force void *)addr));
}
EXPORT_SYMBOL(devm_ioport_unmap);
#endif /* CONFIG_HAS_IOPORT_MAP */

#ifdef CONFIG_PCI
/*
 * PCI iomap devres
 */
#define PCIM_IOMAP_MAX	PCI_ROM_RESOURCE

struct pcim_iomap_devres {
	void __iomem *table[PCIM_IOMAP_MAX];
};

static void pcim_iomap_release(struct device *gendev, void *res)
{
	struct pci_dev *dev = to_pci_dev(gendev);
	struct pcim_iomap_devres *this = res;
	int i;

	for (i = 0; i < PCIM_IOMAP_MAX; i++)
		if (this->table[i])
			pci_iounmap(dev, this->table[i]);
}

/**
 * pcim_iomap_table - access iomap allocation table
 * @pdev: PCI device to access iomap table for
 *
 * Access iomap allocation table for @dev.  If iomap table doesn't
 * exist and @pdev is managed, it will be allocated.  All iomaps
 * recorded in the iomap table are automatically unmapped on driver
 * detach.
 *
 * This function might sleep when the table is first allocated but can
 * be safely called without context and guaranteed to succed once
 * allocated.
 */
void __iomem * const *pcim_iomap_table(struct pci_dev *pdev)
{
	struct pcim_iomap_devres *dr, *new_dr;

	dr = devres_find(&pdev->dev, pcim_iomap_release, NULL, NULL);
	if (dr)
		return dr->table;

	new_dr = devres_alloc(pcim_iomap_release, sizeof(*new_dr), GFP_KERNEL);
	if (!new_dr)
		return NULL;
	dr = devres_get(&pdev->dev, new_dr, NULL, NULL);
	return dr->table;
}
EXPORT_SYMBOL(pcim_iomap_table);

/**
 * pcim_iomap - Managed pcim_iomap()
 * @pdev: PCI device to iomap for
 * @bar: BAR to iomap
 * @maxlen: Maximum length of iomap
 *
 * Managed pci_iomap().  Map is automatically unmapped on driver
 * detach.
 */
void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen)
{
	void __iomem **tbl;

	BUG_ON(bar >= PCIM_IOMAP_MAX);

	tbl = (void __iomem **)pcim_iomap_table(pdev);
	if (!tbl || tbl[bar])	/* duplicate mappings not allowed */
		return NULL;

	tbl[bar] = pci_iomap(pdev, bar, maxlen);
	return tbl[bar];
}
EXPORT_SYMBOL(pcim_iomap);

/**
 * pcim_iounmap - Managed pci_iounmap()
 * @pdev: PCI device to iounmap for
 * @addr: Address to unmap
 *
 * Managed pci_iounmap().  @addr must have been mapped using pcim_iomap().
 */
void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr)
{
	void __iomem **tbl;
	int i;

	pci_iounmap(pdev, addr);

	tbl = (void __iomem **)pcim_iomap_table(pdev);
	BUG_ON(!tbl);

	for (i = 0; i < PCIM_IOMAP_MAX; i++)
		if (tbl[i] == addr) {
			tbl[i] = NULL;
			return;
		}
	WARN_ON(1);
}
EXPORT_SYMBOL(pcim_iounmap);

/**
 * pcim_iomap_regions - Request and iomap PCI BARs
 * @pdev: PCI device to map IO resources for
 * @mask: Mask of BARs to request and iomap
 * @name: Name used when requesting regions
 *
 * Request and iomap regions specified by @mask.
 */
int pcim_iomap_regions(struct pci_dev *pdev, int mask, const char *name)
{
	void __iomem * const *iomap;
	int i, rc;

	iomap = pcim_iomap_table(pdev);
	if (!iomap)
		return -ENOMEM;

	for (i = 0; i < DEVICE_COUNT_RESOURCE; i++) {
		unsigned long len;

		if (!(mask & (1 << i)))
			continue;

		rc = -EINVAL;
		len = pci_resource_len(pdev, i);
		if (!len)
			goto err_inval;

		rc = pci_request_region(pdev, i, name);
		if (rc)
			goto err_inval;

		rc = -ENOMEM;
		if (!pcim_iomap(pdev, i, 0))
			goto err_region;
	}

	return 0;

 err_region:
	pci_release_region(pdev, i);
 err_inval:
	while (--i >= 0) {
		if (!(mask & (1 << i)))
			continue;
		pcim_iounmap(pdev, iomap[i]);
		pci_release_region(pdev, i);
	}

	return rc;
}
EXPORT_SYMBOL(pcim_iomap_regions);

/**
 * pcim_iomap_regions_request_all - Request all BARs and iomap specified ones
 * @pdev: PCI device to map IO resources for
 * @mask: Mask of BARs to iomap
 * @name: Name used when requesting regions
 *
 * Request all PCI BARs and iomap regions specified by @mask.
 */
int pcim_iomap_regions_request_all(struct pci_dev *pdev, int mask,
				   const char *name)
{
	int request_mask = ((1 << 6) - 1) & ~mask;
	int rc;

	rc = pci_request_selected_regions(pdev, request_mask, name);
	if (rc)
		return rc;

	rc = pcim_iomap_regions(pdev, mask, name);
	if (rc)
		pci_release_selected_regions(pdev, request_mask);
	return rc;
}
EXPORT_SYMBOL(pcim_iomap_regions_request_all);

/**
 * pcim_iounmap_regions - Unmap and release PCI BARs
 * @pdev: PCI device to map IO resources for
 * @mask: Mask of BARs to unmap and release
 *
 * Unmap and release regions specified by @mask.
 */
void pcim_iounmap_regions(struct pci_dev *pdev, int mask)
{
	void __iomem * const *iomap;
	int i;

	iomap = pcim_iomap_table(pdev);
	if (!iomap)
		return;

	for (i = 0; i < PCIM_IOMAP_MAX; i++) {
		if (!(mask & (1 << i)))
			continue;

		pcim_iounmap(pdev, iomap[i]);
		pci_release_region(pdev, i);
	}
}
EXPORT_SYMBOL(pcim_iounmap_regions);
#endif /* CONFIG_PCI */
Commit	Line	Data
b2441318	1	// SPDX-License-Identifier: GPL-2.0
f4a18312	2	#include <linux/err.h>
5ea81769 AV	3	#include <linux/pci.h>
5ea81769 AV	4	#include <linux/io.h>
5a0e3ad6	5	#include <linux/gfp.h>
8bc3bcc9	6	#include <linux/export.h>
d5e83827	7	#include <linux/of_address.h>
5ea81769	8
1b723413 YX	9	enum devm_ioremap_type {
	10	DEVM_IOREMAP = 0,
	11	DEVM_IOREMAP_NC,
	12	DEVM_IOREMAP_WC,
	13	};
	14
b41e5fff	15	void devm_ioremap_release(struct device dev, void res)
5ea81769 AV	16	{
	17	iounmap((void __iomem *)res);
	18	}
	19
	20	static int devm_ioremap_match(struct device dev, void res, void *match_data)
	21	{
	22	return (void *)res == match_data;
	23	}
	24
1b723413 YX	25	static void __iomem __devm_ioremap(struct device dev, resource_size_t offset,
	26	resource_size_t size,
	27	enum devm_ioremap_type type)
5ea81769	28	{
1b723413	29	void __iomem *ptr, addr = NULL;
5ea81769 AV	30
	31	ptr = devres_alloc(devm_ioremap_release, sizeof(*ptr), GFP_KERNEL);
	32	if (!ptr)
	33	return NULL;
	34
1b723413 YX	35	switch (type) {
	36	case DEVM_IOREMAP:
	37	addr = ioremap(offset, size);
	38	break;
	39	case DEVM_IOREMAP_NC:
	40	addr = ioremap_nocache(offset, size);
	41	break;
	42	case DEVM_IOREMAP_WC:
	43	addr = ioremap_wc(offset, size);
	44	break;
	45	}
	46
5ea81769 AV	47	if (addr) {
	48	*ptr = addr;
	49	devres_add(dev, ptr);
	50	} else
	51	devres_free(ptr);
	52
	53	return addr;
	54	}
1b723413 YX	55
	56	/**
	57	* devm_ioremap - Managed ioremap()
	58	* @dev: Generic device to remap IO address for
	59	* @offset: Resource address to map
	60	* @size: Size of map
	61	*
	62	* Managed ioremap(). Map is automatically unmapped on driver detach.
	63	*/
	64	void __iomem devm_ioremap(struct device dev, resource_size_t offset,
	65	resource_size_t size)
	66	{
	67	return __devm_ioremap(dev, offset, size, DEVM_IOREMAP);
	68	}
5ea81769 AV	69	EXPORT_SYMBOL(devm_ioremap);
	70
	71	/**
	72	* devm_ioremap_nocache - Managed ioremap_nocache()
	73	* @dev: Generic device to remap IO address for
6524754e	74	* @offset: Resource address to map
5ea81769 AV	75	* @size: Size of map
	76	*
	77	* Managed ioremap_nocache(). Map is automatically unmapped on driver
	78	* detach.
	79	*/
4f452e8a	80	void __iomem devm_ioremap_nocache(struct device dev, resource_size_t offset,
5559b7bc	81	resource_size_t size)
5ea81769	82	{
1b723413	83	return __devm_ioremap(dev, offset, size, DEVM_IOREMAP_NC);
5ea81769 AV	84	}
	85	EXPORT_SYMBOL(devm_ioremap_nocache);
	86
34644524 AK	87	/**
	88	* devm_ioremap_wc - Managed ioremap_wc()
	89	* @dev: Generic device to remap IO address for
6524754e	90	* @offset: Resource address to map
34644524 AK	91	* @size: Size of map
	92	*
	93	* Managed ioremap_wc(). Map is automatically unmapped on driver detach.
	94	*/
	95	void __iomem devm_ioremap_wc(struct device dev, resource_size_t offset,
	96	resource_size_t size)
	97	{
1b723413	98	return __devm_ioremap(dev, offset, size, DEVM_IOREMAP_WC);
34644524 AK	99	}
	100	EXPORT_SYMBOL(devm_ioremap_wc);
	101
5ea81769 AV	102	/**
	103	* devm_iounmap - Managed iounmap()
	104	* @dev: Generic device to unmap for
	105	* @addr: Address to unmap
	106	*
	107	* Managed iounmap(). @addr must have been mapped using devm_ioremap*().
	108	*/
	109	void devm_iounmap(struct device dev, void __iomem addr)
	110	{
5ea81769	111	WARN_ON(devres_destroy(dev, devm_ioremap_release, devm_ioremap_match,
b104d6a5	112	(__force void *)addr));
ae891a1b	113	iounmap(addr);
5ea81769 AV	114	}
	115	EXPORT_SYMBOL(devm_iounmap);
	116
72f8c0bf	117	/**
75096579 TR	118	* devm_ioremap_resource() - check, request region, and ioremap resource
75096579 TR	119	* @dev: generic device to handle the resource for
72f8c0bf WS	120	* @res: resource to be handled
72f8c0bf WS	121	*
92b19ff5 DW	122	* Checks that a resource is a valid memory region, requests the memory
	123	* region and ioremaps it. All operations are managed and will be undone
	124	* on driver detach.
75096579 TR	125	*
	126	* Returns a pointer to the remapped memory or an ERR_PTR() encoded error code
	127	* on failure. Usage example:
72f8c0bf WS	128	*
72f8c0bf WS	129	* res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
75096579 TR	130	* base = devm_ioremap_resource(&pdev->dev, res);
	131	* if (IS_ERR(base))
	132	* return PTR_ERR(base);
72f8c0bf	133	*/
eef778c9 AB	134	void __iomem devm_ioremap_resource(struct device dev,
eef778c9 AB	135	const struct resource *res)
72f8c0bf WS	136	{
72f8c0bf WS	137	resource_size_t size;
72f8c0bf WS	138	void __iomem *dest_ptr;
	139
	140	BUG_ON(!dev);
	141
	142	if (!res \|\| resource_type(res) != IORESOURCE_MEM) {
	143	dev_err(dev, "invalid resource\n");
b104d6a5	144	return IOMEM_ERR_PTR(-EINVAL);
72f8c0bf WS	145	}
	146
	147	size = resource_size(res);
72f8c0bf	148
8d84b18f	149	if (!devm_request_mem_region(dev, res->start, size, dev_name(dev))) {
72f8c0bf	150	dev_err(dev, "can't request region for resource %pR\n", res);
b104d6a5	151	return IOMEM_ERR_PTR(-EBUSY);
72f8c0bf WS	152	}
72f8c0bf WS	153
92b19ff5	154	dest_ptr = devm_ioremap(dev, res->start, size);
72f8c0bf WS	155	if (!dest_ptr) {
	156	dev_err(dev, "ioremap failed for resource %pR\n", res);
	157	devm_release_mem_region(dev, res->start, size);
b104d6a5	158	dest_ptr = IOMEM_ERR_PTR(-ENOMEM);
72f8c0bf WS	159	}
	160
	161	return dest_ptr;
	162	}
75096579 TR	163	EXPORT_SYMBOL(devm_ioremap_resource);
75096579 TR	164
d5e83827 BH	165	/*
	166	* devm_of_iomap - Requests a resource and maps the memory mapped IO
	167	* for a given device_node managed by a given device
	168	*
	169	* Checks that a resource is a valid memory region, requests the memory
	170	* region and ioremaps it. All operations are managed and will be undone
	171	* on driver detach of the device.
	172	*
	173	* This is to be used when a device requests/maps resources described
	174	* by other device tree nodes (children or otherwise).
	175	*
	176	* @dev: The device "managing" the resource
	177	* @node: The device-tree node where the resource resides
	178	* @index: index of the MMIO range in the "reg" property
	179	* @size: Returns the size of the resource (pass NULL if not needed)
	180	* Returns a pointer to the requested and mapped memory or an ERR_PTR() encoded
	181	* error code on failure. Usage example:
	182	*
	183	* base = devm_of_iomap(&pdev->dev, node, 0, NULL);
	184	* if (IS_ERR(base))
	185	* return PTR_ERR(base);
	186	*/
	187	void __iomem devm_of_iomap(struct device dev, struct device_node *node, int index,
	188	resource_size_t *size)
	189	{
	190	struct resource res;
	191
	192	if (of_address_to_resource(node, index, &res))
	193	return IOMEM_ERR_PTR(-EINVAL);
	194	if (size)
	195	*size = resource_size(&res);
	196	return devm_ioremap_resource(dev, &res);
	197	}
	198	EXPORT_SYMBOL(devm_of_iomap);
	199
ce816fa8	200	#ifdef CONFIG_HAS_IOPORT_MAP
5ea81769 AV	201	/*
	202	* Generic iomap devres
	203	*/
	204	static void devm_ioport_map_release(struct device dev, void res)
	205	{
	206	ioport_unmap((void __iomem *)res);
	207	}
	208
	209	static int devm_ioport_map_match(struct device dev, void res,
	210	void *match_data)
	211	{
	212	return (void *)res == match_data;
	213	}
	214
	215	/**
	216	* devm_ioport_map - Managed ioport_map()
	217	* @dev: Generic device to map ioport for
	218	* @port: Port to map
	219	* @nr: Number of ports to map
	220	*
	221	* Managed ioport_map(). Map is automatically unmapped on driver
	222	* detach.
	223	*/
5cbb00cc	224	void __iomem devm_ioport_map(struct device dev, unsigned long port,
5ea81769 AV	225	unsigned int nr)
	226	{
	227	void __iomem *ptr, addr;
	228
	229	ptr = devres_alloc(devm_ioport_map_release, sizeof(*ptr), GFP_KERNEL);
	230	if (!ptr)
	231	return NULL;
	232
	233	addr = ioport_map(port, nr);
	234	if (addr) {
	235	*ptr = addr;
	236	devres_add(dev, ptr);
	237	} else
	238	devres_free(ptr);
	239
	240	return addr;
	241	}
	242	EXPORT_SYMBOL(devm_ioport_map);
	243
	244	/**
	245	* devm_ioport_unmap - Managed ioport_unmap()
	246	* @dev: Generic device to unmap for
	247	* @addr: Address to unmap
	248	*
	249	* Managed ioport_unmap(). @addr must have been mapped using
	250	* devm_ioport_map().
	251	*/
	252	void devm_ioport_unmap(struct device dev, void __iomem addr)
	253	{
	254	ioport_unmap(addr);
	255	WARN_ON(devres_destroy(dev, devm_ioport_map_release,
b104d6a5	256	devm_ioport_map_match, (__force void *)addr));
5ea81769 AV	257	}
5ea81769 AV	258	EXPORT_SYMBOL(devm_ioport_unmap);
ce816fa8	259	#endif /* CONFIG_HAS_IOPORT_MAP */
5ea81769 AV	260
	261	#ifdef CONFIG_PCI
	262	/*
	263	* PCI iomap devres
	264	*/
	265	#define PCIM_IOMAP_MAX PCI_ROM_RESOURCE
	266
	267	struct pcim_iomap_devres {
	268	void __iomem *table[PCIM_IOMAP_MAX];
	269	};
	270
	271	static void pcim_iomap_release(struct device gendev, void res)
	272	{
20af74ef	273	struct pci_dev *dev = to_pci_dev(gendev);
5ea81769 AV	274	struct pcim_iomap_devres *this = res;
	275	int i;
	276
	277	for (i = 0; i < PCIM_IOMAP_MAX; i++)
	278	if (this->table[i])
	279	pci_iounmap(dev, this->table[i]);
	280	}
	281
	282	/**
	283	* pcim_iomap_table - access iomap allocation table
	284	* @pdev: PCI device to access iomap table for
	285	*
	286	* Access iomap allocation table for @dev. If iomap table doesn't
	287	* exist and @pdev is managed, it will be allocated. All iomaps
	288	* recorded in the iomap table are automatically unmapped on driver
	289	* detach.
	290	*
	291	* This function might sleep when the table is first allocated but can
	292	* be safely called without context and guaranteed to succed once
	293	* allocated.
	294	*/
5cbb00cc	295	void __iomem * const pcim_iomap_table(struct pci_dev pdev)
5ea81769 AV	296	{
	297	struct pcim_iomap_devres dr, new_dr;
	298
	299	dr = devres_find(&pdev->dev, pcim_iomap_release, NULL, NULL);
	300	if (dr)
	301	return dr->table;
	302
	303	new_dr = devres_alloc(pcim_iomap_release, sizeof(*new_dr), GFP_KERNEL);
	304	if (!new_dr)
	305	return NULL;
	306	dr = devres_get(&pdev->dev, new_dr, NULL, NULL);
	307	return dr->table;
	308	}
	309	EXPORT_SYMBOL(pcim_iomap_table);
	310
	311	/**
	312	* pcim_iomap - Managed pcim_iomap()
	313	* @pdev: PCI device to iomap for
	314	* @bar: BAR to iomap
	315	* @maxlen: Maximum length of iomap
	316	*
	317	* Managed pci_iomap(). Map is automatically unmapped on driver
	318	* detach.
	319	*/
5cbb00cc	320	void __iomem pcim_iomap(struct pci_dev pdev, int bar, unsigned long maxlen)
5ea81769 AV	321	{
	322	void __iomem **tbl;
	323
	324	BUG_ON(bar >= PCIM_IOMAP_MAX);
	325
	326	tbl = (void __iomem **)pcim_iomap_table(pdev);
	327	if (!tbl \|\| tbl[bar]) /* duplicate mappings not allowed */
	328	return NULL;
	329
	330	tbl[bar] = pci_iomap(pdev, bar, maxlen);
	331	return tbl[bar];
	332	}
	333	EXPORT_SYMBOL(pcim_iomap);
	334
	335	/**
	336	* pcim_iounmap - Managed pci_iounmap()
	337	* @pdev: PCI device to iounmap for
	338	* @addr: Address to unmap
	339	*
	340	* Managed pci_iounmap(). @addr must have been mapped using pcim_iomap().
	341	*/
	342	void pcim_iounmap(struct pci_dev pdev, void __iomem addr)
	343	{
	344	void __iomem **tbl;
	345	int i;
	346
	347	pci_iounmap(pdev, addr);
	348
	349	tbl = (void __iomem **)pcim_iomap_table(pdev);
	350	BUG_ON(!tbl);
	351
	352	for (i = 0; i < PCIM_IOMAP_MAX; i++)
	353	if (tbl[i] == addr) {
	354	tbl[i] = NULL;
	355	return;
	356	}
	357	WARN_ON(1);
	358	}
	359	EXPORT_SYMBOL(pcim_iounmap);
	360
	361	/**
	362	* pcim_iomap_regions - Request and iomap PCI BARs
	363	* @pdev: PCI device to map IO resources for
	364	* @mask: Mask of BARs to request and iomap
	365	* @name: Name used when requesting regions
	366	*
	367	* Request and iomap regions specified by @mask.
	368	*/
fb7ebfe4	369	int pcim_iomap_regions(struct pci_dev pdev, int mask, const char name)
5ea81769 AV	370	{
	371	void __iomem * const *iomap;
	372	int i, rc;
	373
	374	iomap = pcim_iomap_table(pdev);
	375	if (!iomap)
	376	return -ENOMEM;
	377
	378	for (i = 0; i < DEVICE_COUNT_RESOURCE; i++) {
	379	unsigned long len;
	380
	381	if (!(mask & (1 << i)))
	382	continue;
	383
	384	rc = -EINVAL;
	385	len = pci_resource_len(pdev, i);
	386	if (!len)
	387	goto err_inval;
	388
	389	rc = pci_request_region(pdev, i, name);
	390	if (rc)
fb4d64e7	391	goto err_inval;
5ea81769 AV	392
	393	rc = -ENOMEM;
	394	if (!pcim_iomap(pdev, i, 0))
fb4d64e7	395	goto err_region;
5ea81769 AV	396	}
	397
	398	return 0;
	399
5ea81769 AV	400	err_region:
	401	pci_release_region(pdev, i);
	402	err_inval:
	403	while (--i >= 0) {
fb4d64e7 FD	404	if (!(mask & (1 << i)))
fb4d64e7 FD	405	continue;
5ea81769 AV	406	pcim_iounmap(pdev, iomap[i]);
	407	pci_release_region(pdev, i);
	408	}
	409
	410	return rc;
	411	}
	412	EXPORT_SYMBOL(pcim_iomap_regions);
ec04b075	413
916fbfb7 TH	414	/**
	415	* pcim_iomap_regions_request_all - Request all BARs and iomap specified ones
	416	* @pdev: PCI device to map IO resources for
	417	* @mask: Mask of BARs to iomap
	418	* @name: Name used when requesting regions
	419	*
	420	* Request all PCI BARs and iomap regions specified by @mask.
	421	*/
fb7ebfe4	422	int pcim_iomap_regions_request_all(struct pci_dev *pdev, int mask,
916fbfb7 TH	423	const char *name)
	424	{
	425	int request_mask = ((1 << 6) - 1) & ~mask;
	426	int rc;
	427
	428	rc = pci_request_selected_regions(pdev, request_mask, name);
	429	if (rc)
	430	return rc;
	431
	432	rc = pcim_iomap_regions(pdev, mask, name);
	433	if (rc)
	434	pci_release_selected_regions(pdev, request_mask);
	435	return rc;
	436	}
	437	EXPORT_SYMBOL(pcim_iomap_regions_request_all);
	438
ec04b075 TH	439	/**
	440	* pcim_iounmap_regions - Unmap and release PCI BARs
	441	* @pdev: PCI device to map IO resources for
	442	* @mask: Mask of BARs to unmap and release
	443	*
4d45ada3	444	* Unmap and release regions specified by @mask.
ec04b075	445	*/
fb7ebfe4	446	void pcim_iounmap_regions(struct pci_dev *pdev, int mask)
ec04b075 TH	447	{
	448	void __iomem * const *iomap;
	449	int i;
	450
	451	iomap = pcim_iomap_table(pdev);
	452	if (!iomap)
	453	return;
	454
1f35d04a	455	for (i = 0; i < PCIM_IOMAP_MAX; i++) {
ec04b075 TH	456	if (!(mask & (1 << i)))
	457	continue;
	458
	459	pcim_iounmap(pdev, iomap[i]);
	460	pci_release_region(pdev, i);
	461	}
	462	}
	463	EXPORT_SYMBOL(pcim_iounmap_regions);
571806a9	464	#endif /* CONFIG_PCI */