Loading...
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 */
1// SPDX-License-Identifier: GPL-2.0
2#include <linux/bug.h>
3#include <linux/device.h>
4#include <linux/errno.h>
5#include <linux/export.h>
6#include <linux/gfp_types.h>
7#include <linux/io.h>
8#include <linux/ioport.h>
9#include <linux/of_address.h>
10#include <linux/types.h>
11
12enum devm_ioremap_type {
13 DEVM_IOREMAP = 0,
14 DEVM_IOREMAP_UC,
15 DEVM_IOREMAP_WC,
16 DEVM_IOREMAP_NP,
17};
18
19void devm_ioremap_release(struct device *dev, void *res)
20{
21 iounmap(*(void __iomem **)res);
22}
23
24static int devm_ioremap_match(struct device *dev, void *res, void *match_data)
25{
26 return *(void **)res == match_data;
27}
28
29static void __iomem *__devm_ioremap(struct device *dev, resource_size_t offset,
30 resource_size_t size,
31 enum devm_ioremap_type type)
32{
33 void __iomem **ptr, *addr = NULL;
34
35 ptr = devres_alloc_node(devm_ioremap_release, sizeof(*ptr), GFP_KERNEL,
36 dev_to_node(dev));
37 if (!ptr)
38 return NULL;
39
40 switch (type) {
41 case DEVM_IOREMAP:
42 addr = ioremap(offset, size);
43 break;
44 case DEVM_IOREMAP_UC:
45 addr = ioremap_uc(offset, size);
46 break;
47 case DEVM_IOREMAP_WC:
48 addr = ioremap_wc(offset, size);
49 break;
50 case DEVM_IOREMAP_NP:
51 addr = ioremap_np(offset, size);
52 break;
53 }
54
55 if (addr) {
56 *ptr = addr;
57 devres_add(dev, ptr);
58 } else
59 devres_free(ptr);
60
61 return addr;
62}
63
64/**
65 * devm_ioremap - Managed ioremap()
66 * @dev: Generic device to remap IO address for
67 * @offset: Resource address to map
68 * @size: Size of map
69 *
70 * Managed ioremap(). Map is automatically unmapped on driver detach.
71 */
72void __iomem *devm_ioremap(struct device *dev, resource_size_t offset,
73 resource_size_t size)
74{
75 return __devm_ioremap(dev, offset, size, DEVM_IOREMAP);
76}
77EXPORT_SYMBOL(devm_ioremap);
78
79/**
80 * devm_ioremap_uc - Managed ioremap_uc()
81 * @dev: Generic device to remap IO address for
82 * @offset: Resource address to map
83 * @size: Size of map
84 *
85 * Managed ioremap_uc(). Map is automatically unmapped on driver detach.
86 */
87void __iomem *devm_ioremap_uc(struct device *dev, resource_size_t offset,
88 resource_size_t size)
89{
90 return __devm_ioremap(dev, offset, size, DEVM_IOREMAP_UC);
91}
92EXPORT_SYMBOL_GPL(devm_ioremap_uc);
93
94/**
95 * devm_ioremap_wc - Managed ioremap_wc()
96 * @dev: Generic device to remap IO address for
97 * @offset: Resource address to map
98 * @size: Size of map
99 *
100 * Managed ioremap_wc(). Map is automatically unmapped on driver detach.
101 */
102void __iomem *devm_ioremap_wc(struct device *dev, resource_size_t offset,
103 resource_size_t size)
104{
105 return __devm_ioremap(dev, offset, size, DEVM_IOREMAP_WC);
106}
107EXPORT_SYMBOL(devm_ioremap_wc);
108
109/**
110 * devm_iounmap - Managed iounmap()
111 * @dev: Generic device to unmap for
112 * @addr: Address to unmap
113 *
114 * Managed iounmap(). @addr must have been mapped using devm_ioremap*().
115 */
116void devm_iounmap(struct device *dev, void __iomem *addr)
117{
118 WARN_ON(devres_release(dev, devm_ioremap_release, devm_ioremap_match,
119 (__force void *)addr));
120}
121EXPORT_SYMBOL(devm_iounmap);
122
123static void __iomem *
124__devm_ioremap_resource(struct device *dev, const struct resource *res,
125 enum devm_ioremap_type type)
126{
127 resource_size_t size;
128 void __iomem *dest_ptr;
129 char *pretty_name;
130 int ret;
131
132 BUG_ON(!dev);
133
134 if (!res || resource_type(res) != IORESOURCE_MEM) {
135 ret = dev_err_probe(dev, -EINVAL, "invalid resource %pR\n", res);
136 return IOMEM_ERR_PTR(ret);
137 }
138
139 if (type == DEVM_IOREMAP && res->flags & IORESOURCE_MEM_NONPOSTED)
140 type = DEVM_IOREMAP_NP;
141
142 size = resource_size(res);
143
144 if (res->name)
145 pretty_name = devm_kasprintf(dev, GFP_KERNEL, "%s %s",
146 dev_name(dev), res->name);
147 else
148 pretty_name = devm_kstrdup(dev, dev_name(dev), GFP_KERNEL);
149 if (!pretty_name) {
150 ret = dev_err_probe(dev, -ENOMEM, "can't generate pretty name for resource %pR\n", res);
151 return IOMEM_ERR_PTR(ret);
152 }
153
154 if (!devm_request_mem_region(dev, res->start, size, pretty_name)) {
155 ret = dev_err_probe(dev, -EBUSY, "can't request region for resource %pR\n", res);
156 return IOMEM_ERR_PTR(ret);
157 }
158
159 dest_ptr = __devm_ioremap(dev, res->start, size, type);
160 if (!dest_ptr) {
161 devm_release_mem_region(dev, res->start, size);
162 ret = dev_err_probe(dev, -ENOMEM, "ioremap failed for resource %pR\n", res);
163 return IOMEM_ERR_PTR(ret);
164 }
165
166 return dest_ptr;
167}
168
169/**
170 * devm_ioremap_resource() - check, request region, and ioremap resource
171 * @dev: generic device to handle the resource for
172 * @res: resource to be handled
173 *
174 * Checks that a resource is a valid memory region, requests the memory
175 * region and ioremaps it. All operations are managed and will be undone
176 * on driver detach.
177 *
178 * Usage example:
179 *
180 * res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
181 * base = devm_ioremap_resource(&pdev->dev, res);
182 * if (IS_ERR(base))
183 * return PTR_ERR(base);
184 *
185 * Return: a pointer to the remapped memory or an ERR_PTR() encoded error code
186 * on failure.
187 */
188void __iomem *devm_ioremap_resource(struct device *dev,
189 const struct resource *res)
190{
191 return __devm_ioremap_resource(dev, res, DEVM_IOREMAP);
192}
193EXPORT_SYMBOL(devm_ioremap_resource);
194
195/**
196 * devm_ioremap_resource_wc() - write-combined variant of
197 * devm_ioremap_resource()
198 * @dev: generic device to handle the resource for
199 * @res: resource to be handled
200 *
201 * Return: a pointer to the remapped memory or an ERR_PTR() encoded error code
202 * on failure.
203 */
204void __iomem *devm_ioremap_resource_wc(struct device *dev,
205 const struct resource *res)
206{
207 return __devm_ioremap_resource(dev, res, DEVM_IOREMAP_WC);
208}
209
210/*
211 * devm_of_iomap - Requests a resource and maps the memory mapped IO
212 * for a given device_node managed by a given device
213 *
214 * Checks that a resource is a valid memory region, requests the memory
215 * region and ioremaps it. All operations are managed and will be undone
216 * on driver detach of the device.
217 *
218 * This is to be used when a device requests/maps resources described
219 * by other device tree nodes (children or otherwise).
220 *
221 * @dev: The device "managing" the resource
222 * @node: The device-tree node where the resource resides
223 * @index: index of the MMIO range in the "reg" property
224 * @size: Returns the size of the resource (pass NULL if not needed)
225 *
226 * Usage example:
227 *
228 * base = devm_of_iomap(&pdev->dev, node, 0, NULL);
229 * if (IS_ERR(base))
230 * return PTR_ERR(base);
231 *
232 * Please Note: This is not a one-to-one replacement for of_iomap() because the
233 * of_iomap() function does not track whether the region is already mapped. If
234 * two drivers try to map the same memory, the of_iomap() function will succeed
235 * but the devm_of_iomap() function will return -EBUSY.
236 *
237 * Return: a pointer to the requested and mapped memory or an ERR_PTR() encoded
238 * error code on failure.
239 */
240void __iomem *devm_of_iomap(struct device *dev, struct device_node *node, int index,
241 resource_size_t *size)
242{
243 struct resource res;
244
245 if (of_address_to_resource(node, index, &res))
246 return IOMEM_ERR_PTR(-EINVAL);
247 if (size)
248 *size = resource_size(&res);
249 return devm_ioremap_resource(dev, &res);
250}
251EXPORT_SYMBOL(devm_of_iomap);
252
253#ifdef CONFIG_HAS_IOPORT_MAP
254/*
255 * Generic iomap devres
256 */
257static void devm_ioport_map_release(struct device *dev, void *res)
258{
259 ioport_unmap(*(void __iomem **)res);
260}
261
262static int devm_ioport_map_match(struct device *dev, void *res,
263 void *match_data)
264{
265 return *(void **)res == match_data;
266}
267
268/**
269 * devm_ioport_map - Managed ioport_map()
270 * @dev: Generic device to map ioport for
271 * @port: Port to map
272 * @nr: Number of ports to map
273 *
274 * Managed ioport_map(). Map is automatically unmapped on driver
275 * detach.
276 *
277 * Return: a pointer to the remapped memory or NULL on failure.
278 */
279void __iomem *devm_ioport_map(struct device *dev, unsigned long port,
280 unsigned int nr)
281{
282 void __iomem **ptr, *addr;
283
284 ptr = devres_alloc_node(devm_ioport_map_release, sizeof(*ptr), GFP_KERNEL,
285 dev_to_node(dev));
286 if (!ptr)
287 return NULL;
288
289 addr = ioport_map(port, nr);
290 if (addr) {
291 *ptr = addr;
292 devres_add(dev, ptr);
293 } else
294 devres_free(ptr);
295
296 return addr;
297}
298EXPORT_SYMBOL(devm_ioport_map);
299
300/**
301 * devm_ioport_unmap - Managed ioport_unmap()
302 * @dev: Generic device to unmap for
303 * @addr: Address to unmap
304 *
305 * Managed ioport_unmap(). @addr must have been mapped using
306 * devm_ioport_map().
307 */
308void devm_ioport_unmap(struct device *dev, void __iomem *addr)
309{
310 WARN_ON(devres_release(dev, devm_ioport_map_release,
311 devm_ioport_map_match, (__force void *)addr));
312}
313EXPORT_SYMBOL(devm_ioport_unmap);
314#endif /* CONFIG_HAS_IOPORT_MAP */
315
316static void devm_arch_phys_ac_add_release(struct device *dev, void *res)
317{
318 arch_phys_wc_del(*((int *)res));
319}
320
321/**
322 * devm_arch_phys_wc_add - Managed arch_phys_wc_add()
323 * @dev: Managed device
324 * @base: Memory base address
325 * @size: Size of memory range
326 *
327 * Adds a WC MTRR using arch_phys_wc_add() and sets up a release callback.
328 * See arch_phys_wc_add() for more information.
329 */
330int devm_arch_phys_wc_add(struct device *dev, unsigned long base, unsigned long size)
331{
332 int *mtrr;
333 int ret;
334
335 mtrr = devres_alloc_node(devm_arch_phys_ac_add_release, sizeof(*mtrr), GFP_KERNEL,
336 dev_to_node(dev));
337 if (!mtrr)
338 return -ENOMEM;
339
340 ret = arch_phys_wc_add(base, size);
341 if (ret < 0) {
342 devres_free(mtrr);
343 return ret;
344 }
345
346 *mtrr = ret;
347 devres_add(dev, mtrr);
348
349 return ret;
350}
351EXPORT_SYMBOL(devm_arch_phys_wc_add);
352
353struct arch_io_reserve_memtype_wc_devres {
354 resource_size_t start;
355 resource_size_t size;
356};
357
358static void devm_arch_io_free_memtype_wc_release(struct device *dev, void *res)
359{
360 const struct arch_io_reserve_memtype_wc_devres *this = res;
361
362 arch_io_free_memtype_wc(this->start, this->size);
363}
364
365/**
366 * devm_arch_io_reserve_memtype_wc - Managed arch_io_reserve_memtype_wc()
367 * @dev: Managed device
368 * @start: Memory base address
369 * @size: Size of memory range
370 *
371 * Reserves a memory range with WC caching using arch_io_reserve_memtype_wc()
372 * and sets up a release callback See arch_io_reserve_memtype_wc() for more
373 * information.
374 */
375int devm_arch_io_reserve_memtype_wc(struct device *dev, resource_size_t start,
376 resource_size_t size)
377{
378 struct arch_io_reserve_memtype_wc_devres *dr;
379 int ret;
380
381 dr = devres_alloc_node(devm_arch_io_free_memtype_wc_release, sizeof(*dr), GFP_KERNEL,
382 dev_to_node(dev));
383 if (!dr)
384 return -ENOMEM;
385
386 ret = arch_io_reserve_memtype_wc(start, size);
387 if (ret < 0) {
388 devres_free(dr);
389 return ret;
390 }
391
392 dr->start = start;
393 dr->size = size;
394 devres_add(dev, dr);
395
396 return ret;
397}
398EXPORT_SYMBOL(devm_arch_io_reserve_memtype_wc);