1 // SPDX-License-Identifier: GPL-2.0
6 #include <linux/export.h>
7 #include <linux/of_address.h>
9 enum devm_ioremap_type {
16 void devm_ioremap_release(struct device *dev, void *res)
18 iounmap(*(void __iomem **)res);
21 static int devm_ioremap_match(struct device *dev, void *res, void *match_data)
23 return *(void **)res == match_data;
26 static void __iomem *__devm_ioremap(struct device *dev, resource_size_t offset,
28 enum devm_ioremap_type type)
30 void __iomem **ptr, *addr = NULL;
32 ptr = devres_alloc(devm_ioremap_release, sizeof(*ptr), GFP_KERNEL);
38 addr = ioremap(offset, size);
41 addr = ioremap_nocache(offset, size);
44 addr = ioremap_uc(offset, size);
47 addr = ioremap_wc(offset, size);
61 * devm_ioremap - Managed ioremap()
62 * @dev: Generic device to remap IO address for
63 * @offset: Resource address to map
66 * Managed ioremap(). Map is automatically unmapped on driver detach.
68 void __iomem *devm_ioremap(struct device *dev, resource_size_t offset,
71 return __devm_ioremap(dev, offset, size, DEVM_IOREMAP);
73 EXPORT_SYMBOL(devm_ioremap);
76 * devm_ioremap_uc - Managed ioremap_uc()
77 * @dev: Generic device to remap IO address for
78 * @offset: Resource address to map
81 * Managed ioremap_uc(). Map is automatically unmapped on driver detach.
83 void __iomem *devm_ioremap_uc(struct device *dev, resource_size_t offset,
86 return __devm_ioremap(dev, offset, size, DEVM_IOREMAP_UC);
88 EXPORT_SYMBOL_GPL(devm_ioremap_uc);
91 * devm_ioremap_nocache - Managed ioremap_nocache()
92 * @dev: Generic device to remap IO address for
93 * @offset: Resource address to map
96 * Managed ioremap_nocache(). Map is automatically unmapped on driver
99 void __iomem *devm_ioremap_nocache(struct device *dev, resource_size_t offset,
100 resource_size_t size)
102 return __devm_ioremap(dev, offset, size, DEVM_IOREMAP_NC);
104 EXPORT_SYMBOL(devm_ioremap_nocache);
107 * devm_ioremap_wc - Managed ioremap_wc()
108 * @dev: Generic device to remap IO address for
109 * @offset: Resource address to map
112 * Managed ioremap_wc(). Map is automatically unmapped on driver detach.
114 void __iomem *devm_ioremap_wc(struct device *dev, resource_size_t offset,
115 resource_size_t size)
117 return __devm_ioremap(dev, offset, size, DEVM_IOREMAP_WC);
119 EXPORT_SYMBOL(devm_ioremap_wc);
122 * devm_iounmap - Managed iounmap()
123 * @dev: Generic device to unmap for
124 * @addr: Address to unmap
126 * Managed iounmap(). @addr must have been mapped using devm_ioremap*().
128 void devm_iounmap(struct device *dev, void __iomem *addr)
130 WARN_ON(devres_destroy(dev, devm_ioremap_release, devm_ioremap_match,
131 (__force void *)addr));
134 EXPORT_SYMBOL(devm_iounmap);
137 * devm_ioremap_resource() - check, request region, and ioremap resource
138 * @dev: generic device to handle the resource for
139 * @res: resource to be handled
141 * Checks that a resource is a valid memory region, requests the memory
142 * region and ioremaps it. All operations are managed and will be undone
145 * Returns a pointer to the remapped memory or an ERR_PTR() encoded error code
146 * on failure. Usage example:
148 * res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
149 * base = devm_ioremap_resource(&pdev->dev, res);
151 * return PTR_ERR(base);
153 void __iomem *devm_ioremap_resource(struct device *dev,
154 const struct resource *res)
156 resource_size_t size;
157 void __iomem *dest_ptr;
162 if (!res || resource_type(res) != IORESOURCE_MEM) {
163 dev_err(dev, "invalid resource\n");
164 return IOMEM_ERR_PTR(-EINVAL);
167 size = resource_size(res);
170 pretty_name = devm_kasprintf(dev, GFP_KERNEL, "%s %s",
171 dev_name(dev), res->name);
173 pretty_name = devm_kstrdup(dev, dev_name(dev), GFP_KERNEL);
175 return IOMEM_ERR_PTR(-ENOMEM);
177 if (!devm_request_mem_region(dev, res->start, size, pretty_name)) {
178 dev_err(dev, "can't request region for resource %pR\n", res);
179 return IOMEM_ERR_PTR(-EBUSY);
182 dest_ptr = devm_ioremap(dev, res->start, size);
184 dev_err(dev, "ioremap failed for resource %pR\n", res);
185 devm_release_mem_region(dev, res->start, size);
186 dest_ptr = IOMEM_ERR_PTR(-ENOMEM);
191 EXPORT_SYMBOL(devm_ioremap_resource);
194 * devm_of_iomap - Requests a resource and maps the memory mapped IO
195 * for a given device_node managed by a given device
197 * Checks that a resource is a valid memory region, requests the memory
198 * region and ioremaps it. All operations are managed and will be undone
199 * on driver detach of the device.
201 * This is to be used when a device requests/maps resources described
202 * by other device tree nodes (children or otherwise).
204 * @dev: The device "managing" the resource
205 * @node: The device-tree node where the resource resides
206 * @index: index of the MMIO range in the "reg" property
207 * @size: Returns the size of the resource (pass NULL if not needed)
208 * Returns a pointer to the requested and mapped memory or an ERR_PTR() encoded
209 * error code on failure. Usage example:
211 * base = devm_of_iomap(&pdev->dev, node, 0, NULL);
213 * return PTR_ERR(base);
215 void __iomem *devm_of_iomap(struct device *dev, struct device_node *node, int index,
216 resource_size_t *size)
220 if (of_address_to_resource(node, index, &res))
221 return IOMEM_ERR_PTR(-EINVAL);
223 *size = resource_size(&res);
224 return devm_ioremap_resource(dev, &res);
226 EXPORT_SYMBOL(devm_of_iomap);
228 #ifdef CONFIG_HAS_IOPORT_MAP
230 * Generic iomap devres
232 static void devm_ioport_map_release(struct device *dev, void *res)
234 ioport_unmap(*(void __iomem **)res);
237 static int devm_ioport_map_match(struct device *dev, void *res,
240 return *(void **)res == match_data;
244 * devm_ioport_map - Managed ioport_map()
245 * @dev: Generic device to map ioport for
247 * @nr: Number of ports to map
249 * Managed ioport_map(). Map is automatically unmapped on driver
252 void __iomem *devm_ioport_map(struct device *dev, unsigned long port,
255 void __iomem **ptr, *addr;
257 ptr = devres_alloc(devm_ioport_map_release, sizeof(*ptr), GFP_KERNEL);
261 addr = ioport_map(port, nr);
264 devres_add(dev, ptr);
270 EXPORT_SYMBOL(devm_ioport_map);
273 * devm_ioport_unmap - Managed ioport_unmap()
274 * @dev: Generic device to unmap for
275 * @addr: Address to unmap
277 * Managed ioport_unmap(). @addr must have been mapped using
280 void devm_ioport_unmap(struct device *dev, void __iomem *addr)
283 WARN_ON(devres_destroy(dev, devm_ioport_map_release,
284 devm_ioport_map_match, (__force void *)addr));
286 EXPORT_SYMBOL(devm_ioport_unmap);
287 #endif /* CONFIG_HAS_IOPORT_MAP */
293 #define PCIM_IOMAP_MAX PCI_ROM_RESOURCE
295 struct pcim_iomap_devres {
296 void __iomem *table[PCIM_IOMAP_MAX];
299 static void pcim_iomap_release(struct device *gendev, void *res)
301 struct pci_dev *dev = to_pci_dev(gendev);
302 struct pcim_iomap_devres *this = res;
305 for (i = 0; i < PCIM_IOMAP_MAX; i++)
307 pci_iounmap(dev, this->table[i]);
311 * pcim_iomap_table - access iomap allocation table
312 * @pdev: PCI device to access iomap table for
314 * Access iomap allocation table for @dev. If iomap table doesn't
315 * exist and @pdev is managed, it will be allocated. All iomaps
316 * recorded in the iomap table are automatically unmapped on driver
319 * This function might sleep when the table is first allocated but can
320 * be safely called without context and guaranteed to succed once
323 void __iomem * const *pcim_iomap_table(struct pci_dev *pdev)
325 struct pcim_iomap_devres *dr, *new_dr;
327 dr = devres_find(&pdev->dev, pcim_iomap_release, NULL, NULL);
331 new_dr = devres_alloc(pcim_iomap_release, sizeof(*new_dr), GFP_KERNEL);
334 dr = devres_get(&pdev->dev, new_dr, NULL, NULL);
337 EXPORT_SYMBOL(pcim_iomap_table);
340 * pcim_iomap - Managed pcim_iomap()
341 * @pdev: PCI device to iomap for
343 * @maxlen: Maximum length of iomap
345 * Managed pci_iomap(). Map is automatically unmapped on driver
348 void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen)
352 BUG_ON(bar >= PCIM_IOMAP_MAX);
354 tbl = (void __iomem **)pcim_iomap_table(pdev);
355 if (!tbl || tbl[bar]) /* duplicate mappings not allowed */
358 tbl[bar] = pci_iomap(pdev, bar, maxlen);
361 EXPORT_SYMBOL(pcim_iomap);
364 * pcim_iounmap - Managed pci_iounmap()
365 * @pdev: PCI device to iounmap for
366 * @addr: Address to unmap
368 * Managed pci_iounmap(). @addr must have been mapped using pcim_iomap().
370 void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr)
375 pci_iounmap(pdev, addr);
377 tbl = (void __iomem **)pcim_iomap_table(pdev);
380 for (i = 0; i < PCIM_IOMAP_MAX; i++)
381 if (tbl[i] == addr) {
387 EXPORT_SYMBOL(pcim_iounmap);
390 * pcim_iomap_regions - Request and iomap PCI BARs
391 * @pdev: PCI device to map IO resources for
392 * @mask: Mask of BARs to request and iomap
393 * @name: Name used when requesting regions
395 * Request and iomap regions specified by @mask.
397 int pcim_iomap_regions(struct pci_dev *pdev, int mask, const char *name)
399 void __iomem * const *iomap;
402 iomap = pcim_iomap_table(pdev);
406 for (i = 0; i < DEVICE_COUNT_RESOURCE; i++) {
409 if (!(mask & (1 << i)))
413 len = pci_resource_len(pdev, i);
417 rc = pci_request_region(pdev, i, name);
422 if (!pcim_iomap(pdev, i, 0))
429 pci_release_region(pdev, i);
432 if (!(mask & (1 << i)))
434 pcim_iounmap(pdev, iomap[i]);
435 pci_release_region(pdev, i);
440 EXPORT_SYMBOL(pcim_iomap_regions);
443 * pcim_iomap_regions_request_all - Request all BARs and iomap specified ones
444 * @pdev: PCI device to map IO resources for
445 * @mask: Mask of BARs to iomap
446 * @name: Name used when requesting regions
448 * Request all PCI BARs and iomap regions specified by @mask.
450 int pcim_iomap_regions_request_all(struct pci_dev *pdev, int mask,
453 int request_mask = ((1 << 6) - 1) & ~mask;
456 rc = pci_request_selected_regions(pdev, request_mask, name);
460 rc = pcim_iomap_regions(pdev, mask, name);
462 pci_release_selected_regions(pdev, request_mask);
465 EXPORT_SYMBOL(pcim_iomap_regions_request_all);
468 * pcim_iounmap_regions - Unmap and release PCI BARs
469 * @pdev: PCI device to map IO resources for
470 * @mask: Mask of BARs to unmap and release
472 * Unmap and release regions specified by @mask.
474 void pcim_iounmap_regions(struct pci_dev *pdev, int mask)
476 void __iomem * const *iomap;
479 iomap = pcim_iomap_table(pdev);
483 for (i = 0; i < PCIM_IOMAP_MAX; i++) {
484 if (!(mask & (1 << i)))
487 pcim_iounmap(pdev, iomap[i]);
488 pci_release_region(pdev, i);
491 EXPORT_SYMBOL(pcim_iounmap_regions);
492 #endif /* CONFIG_PCI */