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