[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, struct resource *res)
{
	resource_size_t size;
	const char *name;
	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);
	name = res->name ?: dev_name(dev);

	if (!devm_request_mem_region(dev, res->start, size, name)) {
		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	*/
75096579	134	void __iomem devm_ioremap_resource(struct device dev, struct resource *res)
72f8c0bf WS	135	{
	136	resource_size_t size;
	137	const char *name;
	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);
	148	name = res->name ?: dev_name(dev);
	149
	150	if (!devm_request_mem_region(dev, res->start, size, name)) {
	151	dev_err(dev, "can't request region for resource %pR\n", res);
b104d6a5	152	return IOMEM_ERR_PTR(-EBUSY);
72f8c0bf WS	153	}
72f8c0bf WS	154
92b19ff5	155	dest_ptr = devm_ioremap(dev, res->start, size);
72f8c0bf WS	156	if (!dest_ptr) {
	157	dev_err(dev, "ioremap failed for resource %pR\n", res);
	158	devm_release_mem_region(dev, res->start, size);
b104d6a5	159	dest_ptr = IOMEM_ERR_PTR(-ENOMEM);
72f8c0bf WS	160	}
	161
	162	return dest_ptr;
	163	}
75096579 TR	164	EXPORT_SYMBOL(devm_ioremap_resource);
75096579 TR	165
d5e83827 BH	166	/*
	167	* devm_of_iomap - Requests a resource and maps the memory mapped IO
	168	* for a given device_node managed by a given device
	169	*
	170	* Checks that a resource is a valid memory region, requests the memory
	171	* region and ioremaps it. All operations are managed and will be undone
	172	* on driver detach of the device.
	173	*
	174	* This is to be used when a device requests/maps resources described
	175	* by other device tree nodes (children or otherwise).
	176	*
	177	* @dev: The device "managing" the resource
	178	* @node: The device-tree node where the resource resides
	179	* @index: index of the MMIO range in the "reg" property
	180	* @size: Returns the size of the resource (pass NULL if not needed)
	181	* Returns a pointer to the requested and mapped memory or an ERR_PTR() encoded
	182	* error code on failure. Usage example:
	183	*
	184	* base = devm_of_iomap(&pdev->dev, node, 0, NULL);
	185	* if (IS_ERR(base))
	186	* return PTR_ERR(base);
	187	*/
	188	void __iomem devm_of_iomap(struct device dev, struct device_node *node, int index,
	189	resource_size_t *size)
	190	{
	191	struct resource res;
	192
	193	if (of_address_to_resource(node, index, &res))
	194	return IOMEM_ERR_PTR(-EINVAL);
	195	if (size)
	196	*size = resource_size(&res);
	197	return devm_ioremap_resource(dev, &res);
	198	}
	199	EXPORT_SYMBOL(devm_of_iomap);
	200
ce816fa8	201	#ifdef CONFIG_HAS_IOPORT_MAP
5ea81769 AV	202	/*
	203	* Generic iomap devres
	204	*/
	205	static void devm_ioport_map_release(struct device dev, void res)
	206	{
	207	ioport_unmap((void __iomem *)res);
	208	}
	209
	210	static int devm_ioport_map_match(struct device dev, void res,
	211	void *match_data)
	212	{
	213	return (void *)res == match_data;
	214	}
	215
	216	/**
	217	* devm_ioport_map - Managed ioport_map()
	218	* @dev: Generic device to map ioport for
	219	* @port: Port to map
	220	* @nr: Number of ports to map
	221	*
	222	* Managed ioport_map(). Map is automatically unmapped on driver
	223	* detach.
	224	*/
5cbb00cc	225	void __iomem devm_ioport_map(struct device dev, unsigned long port,
5ea81769 AV	226	unsigned int nr)
	227	{
	228	void __iomem *ptr, addr;
	229
	230	ptr = devres_alloc(devm_ioport_map_release, sizeof(*ptr), GFP_KERNEL);
	231	if (!ptr)
	232	return NULL;
	233
	234	addr = ioport_map(port, nr);
	235	if (addr) {
	236	*ptr = addr;
	237	devres_add(dev, ptr);
	238	} else
	239	devres_free(ptr);
	240
	241	return addr;
	242	}
	243	EXPORT_SYMBOL(devm_ioport_map);
	244
	245	/**
	246	* devm_ioport_unmap - Managed ioport_unmap()
	247	* @dev: Generic device to unmap for
	248	* @addr: Address to unmap
	249	*
	250	* Managed ioport_unmap(). @addr must have been mapped using
	251	* devm_ioport_map().
	252	*/
	253	void devm_ioport_unmap(struct device dev, void __iomem addr)
	254	{
	255	ioport_unmap(addr);
	256	WARN_ON(devres_destroy(dev, devm_ioport_map_release,
b104d6a5	257	devm_ioport_map_match, (__force void *)addr));
5ea81769 AV	258	}
5ea81769 AV	259	EXPORT_SYMBOL(devm_ioport_unmap);
ce816fa8	260	#endif /* CONFIG_HAS_IOPORT_MAP */
5ea81769 AV	261
	262	#ifdef CONFIG_PCI
	263	/*
	264	* PCI iomap devres
	265	*/
	266	#define PCIM_IOMAP_MAX PCI_ROM_RESOURCE
	267
	268	struct pcim_iomap_devres {
	269	void __iomem *table[PCIM_IOMAP_MAX];
	270	};
	271
	272	static void pcim_iomap_release(struct device gendev, void res)
	273	{
20af74ef	274	struct pci_dev *dev = to_pci_dev(gendev);
5ea81769 AV	275	struct pcim_iomap_devres *this = res;
	276	int i;
	277
	278	for (i = 0; i < PCIM_IOMAP_MAX; i++)
	279	if (this->table[i])
	280	pci_iounmap(dev, this->table[i]);
	281	}
	282
	283	/**
	284	* pcim_iomap_table - access iomap allocation table
	285	* @pdev: PCI device to access iomap table for
	286	*
	287	* Access iomap allocation table for @dev. If iomap table doesn't
	288	* exist and @pdev is managed, it will be allocated. All iomaps
	289	* recorded in the iomap table are automatically unmapped on driver
	290	* detach.
	291	*
	292	* This function might sleep when the table is first allocated but can
	293	* be safely called without context and guaranteed to succed once
	294	* allocated.
	295	*/
5cbb00cc	296	void __iomem * const pcim_iomap_table(struct pci_dev pdev)
5ea81769 AV	297	{
	298	struct pcim_iomap_devres dr, new_dr;
	299
	300	dr = devres_find(&pdev->dev, pcim_iomap_release, NULL, NULL);
	301	if (dr)
	302	return dr->table;
	303
	304	new_dr = devres_alloc(pcim_iomap_release, sizeof(*new_dr), GFP_KERNEL);
	305	if (!new_dr)
	306	return NULL;
	307	dr = devres_get(&pdev->dev, new_dr, NULL, NULL);
	308	return dr->table;
	309	}
	310	EXPORT_SYMBOL(pcim_iomap_table);
	311
	312	/**
	313	* pcim_iomap - Managed pcim_iomap()
	314	* @pdev: PCI device to iomap for
	315	* @bar: BAR to iomap
	316	* @maxlen: Maximum length of iomap
	317	*
	318	* Managed pci_iomap(). Map is automatically unmapped on driver
	319	* detach.
	320	*/
5cbb00cc	321	void __iomem pcim_iomap(struct pci_dev pdev, int bar, unsigned long maxlen)
5ea81769 AV	322	{
	323	void __iomem **tbl;
	324
	325	BUG_ON(bar >= PCIM_IOMAP_MAX);
	326
	327	tbl = (void __iomem **)pcim_iomap_table(pdev);
	328	if (!tbl \|\| tbl[bar]) /* duplicate mappings not allowed */
	329	return NULL;
	330
	331	tbl[bar] = pci_iomap(pdev, bar, maxlen);
	332	return tbl[bar];
	333	}
	334	EXPORT_SYMBOL(pcim_iomap);
	335
	336	/**
	337	* pcim_iounmap - Managed pci_iounmap()
	338	* @pdev: PCI device to iounmap for
	339	* @addr: Address to unmap
	340	*
	341	* Managed pci_iounmap(). @addr must have been mapped using pcim_iomap().
	342	*/
	343	void pcim_iounmap(struct pci_dev pdev, void __iomem addr)
	344	{
	345	void __iomem **tbl;
	346	int i;
	347
	348	pci_iounmap(pdev, addr);
	349
	350	tbl = (void __iomem **)pcim_iomap_table(pdev);
	351	BUG_ON(!tbl);
	352
	353	for (i = 0; i < PCIM_IOMAP_MAX; i++)
	354	if (tbl[i] == addr) {
	355	tbl[i] = NULL;
	356	return;
	357	}
	358	WARN_ON(1);
	359	}
	360	EXPORT_SYMBOL(pcim_iounmap);
	361
	362	/**
	363	* pcim_iomap_regions - Request and iomap PCI BARs
	364	* @pdev: PCI device to map IO resources for
	365	* @mask: Mask of BARs to request and iomap
	366	* @name: Name used when requesting regions
	367	*
	368	* Request and iomap regions specified by @mask.
	369	*/
fb7ebfe4	370	int pcim_iomap_regions(struct pci_dev pdev, int mask, const char name)
5ea81769 AV	371	{
	372	void __iomem * const *iomap;
	373	int i, rc;
	374
	375	iomap = pcim_iomap_table(pdev);
	376	if (!iomap)
	377	return -ENOMEM;
	378
	379	for (i = 0; i < DEVICE_COUNT_RESOURCE; i++) {
	380	unsigned long len;
	381
	382	if (!(mask & (1 << i)))
	383	continue;
	384
	385	rc = -EINVAL;
	386	len = pci_resource_len(pdev, i);
	387	if (!len)
	388	goto err_inval;
	389
	390	rc = pci_request_region(pdev, i, name);
	391	if (rc)
fb4d64e7	392	goto err_inval;
5ea81769 AV	393
	394	rc = -ENOMEM;
	395	if (!pcim_iomap(pdev, i, 0))
fb4d64e7	396	goto err_region;
5ea81769 AV	397	}
	398
	399	return 0;
	400
5ea81769 AV	401	err_region:
	402	pci_release_region(pdev, i);
	403	err_inval:
	404	while (--i >= 0) {
fb4d64e7 FD	405	if (!(mask & (1 << i)))
fb4d64e7 FD	406	continue;
5ea81769 AV	407	pcim_iounmap(pdev, iomap[i]);
	408	pci_release_region(pdev, i);
	409	}
	410
	411	return rc;
	412	}
	413	EXPORT_SYMBOL(pcim_iomap_regions);
ec04b075	414
916fbfb7 TH	415	/**
	416	* pcim_iomap_regions_request_all - Request all BARs and iomap specified ones
	417	* @pdev: PCI device to map IO resources for
	418	* @mask: Mask of BARs to iomap
	419	* @name: Name used when requesting regions
	420	*
	421	* Request all PCI BARs and iomap regions specified by @mask.
	422	*/
fb7ebfe4	423	int pcim_iomap_regions_request_all(struct pci_dev *pdev, int mask,
916fbfb7 TH	424	const char *name)
	425	{
	426	int request_mask = ((1 << 6) - 1) & ~mask;
	427	int rc;
	428
	429	rc = pci_request_selected_regions(pdev, request_mask, name);
	430	if (rc)
	431	return rc;
	432
	433	rc = pcim_iomap_regions(pdev, mask, name);
	434	if (rc)
	435	pci_release_selected_regions(pdev, request_mask);
	436	return rc;
	437	}
	438	EXPORT_SYMBOL(pcim_iomap_regions_request_all);
	439
ec04b075 TH	440	/**
	441	* pcim_iounmap_regions - Unmap and release PCI BARs
	442	* @pdev: PCI device to map IO resources for
	443	* @mask: Mask of BARs to unmap and release
	444	*
4d45ada3	445	* Unmap and release regions specified by @mask.
ec04b075	446	*/
fb7ebfe4	447	void pcim_iounmap_regions(struct pci_dev *pdev, int mask)
ec04b075 TH	448	{
	449	void __iomem * const *iomap;
	450	int i;
	451
	452	iomap = pcim_iomap_table(pdev);
	453	if (!iomap)
	454	return;
	455
1f35d04a	456	for (i = 0; i < PCIM_IOMAP_MAX; i++) {
ec04b075 TH	457	if (!(mask & (1 << i)))
	458	continue;
	459
	460	pcim_iounmap(pdev, iomap[i]);
	461	pci_release_region(pdev, i);
	462	}
	463	}
	464	EXPORT_SYMBOL(pcim_iounmap_regions);
571806a9	465	#endif /* CONFIG_PCI */