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