Merge tag 'xfs-4.18-merge-3' of git://git.kernel.org/pub/scm/fs/xfs/xfs-linux
[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>
5ea81769 7
1b723413
YX
8enum devm_ioremap_type {
9 DEVM_IOREMAP = 0,
10 DEVM_IOREMAP_NC,
11 DEVM_IOREMAP_WC,
12};
13
b41e5fff 14void devm_ioremap_release(struct device *dev, void *res)
5ea81769
AV
15{
16 iounmap(*(void __iomem **)res);
17}
18
19static int devm_ioremap_match(struct device *dev, void *res, void *match_data)
20{
21 return *(void **)res == match_data;
22}
23
1b723413
YX
24static void __iomem *__devm_ioremap(struct device *dev, resource_size_t offset,
25 resource_size_t size,
26 enum devm_ioremap_type type)
5ea81769 27{
1b723413 28 void __iomem **ptr, *addr = NULL;
5ea81769
AV
29
30 ptr = devres_alloc(devm_ioremap_release, sizeof(*ptr), GFP_KERNEL);
31 if (!ptr)
32 return NULL;
33
1b723413
YX
34 switch (type) {
35 case DEVM_IOREMAP:
36 addr = ioremap(offset, size);
37 break;
38 case DEVM_IOREMAP_NC:
39 addr = ioremap_nocache(offset, size);
40 break;
41 case DEVM_IOREMAP_WC:
42 addr = ioremap_wc(offset, size);
43 break;
44 }
45
5ea81769
AV
46 if (addr) {
47 *ptr = addr;
48 devres_add(dev, ptr);
49 } else
50 devres_free(ptr);
51
52 return addr;
53}
1b723413
YX
54
55/**
56 * devm_ioremap - Managed ioremap()
57 * @dev: Generic device to remap IO address for
58 * @offset: Resource address to map
59 * @size: Size of map
60 *
61 * Managed ioremap(). Map is automatically unmapped on driver detach.
62 */
63void __iomem *devm_ioremap(struct device *dev, resource_size_t offset,
64 resource_size_t size)
65{
66 return __devm_ioremap(dev, offset, size, DEVM_IOREMAP);
67}
5ea81769
AV
68EXPORT_SYMBOL(devm_ioremap);
69
70/**
71 * devm_ioremap_nocache - Managed ioremap_nocache()
72 * @dev: Generic device to remap IO address for
6524754e 73 * @offset: Resource address to map
5ea81769
AV
74 * @size: Size of map
75 *
76 * Managed ioremap_nocache(). Map is automatically unmapped on driver
77 * detach.
78 */
4f452e8a 79void __iomem *devm_ioremap_nocache(struct device *dev, resource_size_t offset,
5559b7bc 80 resource_size_t size)
5ea81769 81{
1b723413 82 return __devm_ioremap(dev, offset, size, DEVM_IOREMAP_NC);
5ea81769
AV
83}
84EXPORT_SYMBOL(devm_ioremap_nocache);
85
34644524
AK
86/**
87 * devm_ioremap_wc - Managed ioremap_wc()
88 * @dev: Generic device to remap IO address for
6524754e 89 * @offset: Resource address to map
34644524
AK
90 * @size: Size of map
91 *
92 * Managed ioremap_wc(). Map is automatically unmapped on driver detach.
93 */
94void __iomem *devm_ioremap_wc(struct device *dev, resource_size_t offset,
95 resource_size_t size)
96{
1b723413 97 return __devm_ioremap(dev, offset, size, DEVM_IOREMAP_WC);
34644524
AK
98}
99EXPORT_SYMBOL(devm_ioremap_wc);
100
5ea81769
AV
101/**
102 * devm_iounmap - Managed iounmap()
103 * @dev: Generic device to unmap for
104 * @addr: Address to unmap
105 *
106 * Managed iounmap(). @addr must have been mapped using devm_ioremap*().
107 */
108void devm_iounmap(struct device *dev, void __iomem *addr)
109{
5ea81769 110 WARN_ON(devres_destroy(dev, devm_ioremap_release, devm_ioremap_match,
b104d6a5 111 (__force void *)addr));
ae891a1b 112 iounmap(addr);
5ea81769
AV
113}
114EXPORT_SYMBOL(devm_iounmap);
115
72f8c0bf 116/**
75096579
TR
117 * devm_ioremap_resource() - check, request region, and ioremap resource
118 * @dev: generic device to handle the resource for
72f8c0bf
WS
119 * @res: resource to be handled
120 *
92b19ff5
DW
121 * Checks that a resource is a valid memory region, requests the memory
122 * region and ioremaps it. All operations are managed and will be undone
123 * on driver detach.
75096579
TR
124 *
125 * Returns a pointer to the remapped memory or an ERR_PTR() encoded error code
126 * on failure. Usage example:
72f8c0bf
WS
127 *
128 * res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
75096579
TR
129 * base = devm_ioremap_resource(&pdev->dev, res);
130 * if (IS_ERR(base))
131 * return PTR_ERR(base);
72f8c0bf 132 */
75096579 133void __iomem *devm_ioremap_resource(struct device *dev, struct resource *res)
72f8c0bf
WS
134{
135 resource_size_t size;
136 const char *name;
137 void __iomem *dest_ptr;
138
139 BUG_ON(!dev);
140
141 if (!res || resource_type(res) != IORESOURCE_MEM) {
142 dev_err(dev, "invalid resource\n");
b104d6a5 143 return IOMEM_ERR_PTR(-EINVAL);
72f8c0bf
WS
144 }
145
146 size = resource_size(res);
147 name = res->name ?: dev_name(dev);
148
149 if (!devm_request_mem_region(dev, res->start, size, name)) {
150 dev_err(dev, "can't request region for resource %pR\n", res);
b104d6a5 151 return IOMEM_ERR_PTR(-EBUSY);
72f8c0bf
WS
152 }
153
92b19ff5 154 dest_ptr = devm_ioremap(dev, res->start, size);
72f8c0bf
WS
155 if (!dest_ptr) {
156 dev_err(dev, "ioremap failed for resource %pR\n", res);
157 devm_release_mem_region(dev, res->start, size);
b104d6a5 158 dest_ptr = IOMEM_ERR_PTR(-ENOMEM);
72f8c0bf
WS
159 }
160
161 return dest_ptr;
162}
75096579
TR
163EXPORT_SYMBOL(devm_ioremap_resource);
164
ce816fa8 165#ifdef CONFIG_HAS_IOPORT_MAP
5ea81769
AV
166/*
167 * Generic iomap devres
168 */
169static void devm_ioport_map_release(struct device *dev, void *res)
170{
171 ioport_unmap(*(void __iomem **)res);
172}
173
174static int devm_ioport_map_match(struct device *dev, void *res,
175 void *match_data)
176{
177 return *(void **)res == match_data;
178}
179
180/**
181 * devm_ioport_map - Managed ioport_map()
182 * @dev: Generic device to map ioport for
183 * @port: Port to map
184 * @nr: Number of ports to map
185 *
186 * Managed ioport_map(). Map is automatically unmapped on driver
187 * detach.
188 */
5cbb00cc 189void __iomem *devm_ioport_map(struct device *dev, unsigned long port,
5ea81769
AV
190 unsigned int nr)
191{
192 void __iomem **ptr, *addr;
193
194 ptr = devres_alloc(devm_ioport_map_release, sizeof(*ptr), GFP_KERNEL);
195 if (!ptr)
196 return NULL;
197
198 addr = ioport_map(port, nr);
199 if (addr) {
200 *ptr = addr;
201 devres_add(dev, ptr);
202 } else
203 devres_free(ptr);
204
205 return addr;
206}
207EXPORT_SYMBOL(devm_ioport_map);
208
209/**
210 * devm_ioport_unmap - Managed ioport_unmap()
211 * @dev: Generic device to unmap for
212 * @addr: Address to unmap
213 *
214 * Managed ioport_unmap(). @addr must have been mapped using
215 * devm_ioport_map().
216 */
217void devm_ioport_unmap(struct device *dev, void __iomem *addr)
218{
219 ioport_unmap(addr);
220 WARN_ON(devres_destroy(dev, devm_ioport_map_release,
b104d6a5 221 devm_ioport_map_match, (__force void *)addr));
5ea81769
AV
222}
223EXPORT_SYMBOL(devm_ioport_unmap);
ce816fa8 224#endif /* CONFIG_HAS_IOPORT_MAP */
5ea81769
AV
225
226#ifdef CONFIG_PCI
227/*
228 * PCI iomap devres
229 */
230#define PCIM_IOMAP_MAX PCI_ROM_RESOURCE
231
232struct pcim_iomap_devres {
233 void __iomem *table[PCIM_IOMAP_MAX];
234};
235
236static void pcim_iomap_release(struct device *gendev, void *res)
237{
20af74ef 238 struct pci_dev *dev = to_pci_dev(gendev);
5ea81769
AV
239 struct pcim_iomap_devres *this = res;
240 int i;
241
242 for (i = 0; i < PCIM_IOMAP_MAX; i++)
243 if (this->table[i])
244 pci_iounmap(dev, this->table[i]);
245}
246
247/**
248 * pcim_iomap_table - access iomap allocation table
249 * @pdev: PCI device to access iomap table for
250 *
251 * Access iomap allocation table for @dev. If iomap table doesn't
252 * exist and @pdev is managed, it will be allocated. All iomaps
253 * recorded in the iomap table are automatically unmapped on driver
254 * detach.
255 *
256 * This function might sleep when the table is first allocated but can
257 * be safely called without context and guaranteed to succed once
258 * allocated.
259 */
5cbb00cc 260void __iomem * const *pcim_iomap_table(struct pci_dev *pdev)
5ea81769
AV
261{
262 struct pcim_iomap_devres *dr, *new_dr;
263
264 dr = devres_find(&pdev->dev, pcim_iomap_release, NULL, NULL);
265 if (dr)
266 return dr->table;
267
268 new_dr = devres_alloc(pcim_iomap_release, sizeof(*new_dr), GFP_KERNEL);
269 if (!new_dr)
270 return NULL;
271 dr = devres_get(&pdev->dev, new_dr, NULL, NULL);
272 return dr->table;
273}
274EXPORT_SYMBOL(pcim_iomap_table);
275
276/**
277 * pcim_iomap - Managed pcim_iomap()
278 * @pdev: PCI device to iomap for
279 * @bar: BAR to iomap
280 * @maxlen: Maximum length of iomap
281 *
282 * Managed pci_iomap(). Map is automatically unmapped on driver
283 * detach.
284 */
5cbb00cc 285void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen)
5ea81769
AV
286{
287 void __iomem **tbl;
288
289 BUG_ON(bar >= PCIM_IOMAP_MAX);
290
291 tbl = (void __iomem **)pcim_iomap_table(pdev);
292 if (!tbl || tbl[bar]) /* duplicate mappings not allowed */
293 return NULL;
294
295 tbl[bar] = pci_iomap(pdev, bar, maxlen);
296 return tbl[bar];
297}
298EXPORT_SYMBOL(pcim_iomap);
299
300/**
301 * pcim_iounmap - Managed pci_iounmap()
302 * @pdev: PCI device to iounmap for
303 * @addr: Address to unmap
304 *
305 * Managed pci_iounmap(). @addr must have been mapped using pcim_iomap().
306 */
307void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr)
308{
309 void __iomem **tbl;
310 int i;
311
312 pci_iounmap(pdev, addr);
313
314 tbl = (void __iomem **)pcim_iomap_table(pdev);
315 BUG_ON(!tbl);
316
317 for (i = 0; i < PCIM_IOMAP_MAX; i++)
318 if (tbl[i] == addr) {
319 tbl[i] = NULL;
320 return;
321 }
322 WARN_ON(1);
323}
324EXPORT_SYMBOL(pcim_iounmap);
325
326/**
327 * pcim_iomap_regions - Request and iomap PCI BARs
328 * @pdev: PCI device to map IO resources for
329 * @mask: Mask of BARs to request and iomap
330 * @name: Name used when requesting regions
331 *
332 * Request and iomap regions specified by @mask.
333 */
fb7ebfe4 334int pcim_iomap_regions(struct pci_dev *pdev, int mask, const char *name)
5ea81769
AV
335{
336 void __iomem * const *iomap;
337 int i, rc;
338
339 iomap = pcim_iomap_table(pdev);
340 if (!iomap)
341 return -ENOMEM;
342
343 for (i = 0; i < DEVICE_COUNT_RESOURCE; i++) {
344 unsigned long len;
345
346 if (!(mask & (1 << i)))
347 continue;
348
349 rc = -EINVAL;
350 len = pci_resource_len(pdev, i);
351 if (!len)
352 goto err_inval;
353
354 rc = pci_request_region(pdev, i, name);
355 if (rc)
fb4d64e7 356 goto err_inval;
5ea81769
AV
357
358 rc = -ENOMEM;
359 if (!pcim_iomap(pdev, i, 0))
fb4d64e7 360 goto err_region;
5ea81769
AV
361 }
362
363 return 0;
364
5ea81769
AV
365 err_region:
366 pci_release_region(pdev, i);
367 err_inval:
368 while (--i >= 0) {
fb4d64e7
FD
369 if (!(mask & (1 << i)))
370 continue;
5ea81769
AV
371 pcim_iounmap(pdev, iomap[i]);
372 pci_release_region(pdev, i);
373 }
374
375 return rc;
376}
377EXPORT_SYMBOL(pcim_iomap_regions);
ec04b075 378
916fbfb7
TH
379/**
380 * pcim_iomap_regions_request_all - Request all BARs and iomap specified ones
381 * @pdev: PCI device to map IO resources for
382 * @mask: Mask of BARs to iomap
383 * @name: Name used when requesting regions
384 *
385 * Request all PCI BARs and iomap regions specified by @mask.
386 */
fb7ebfe4 387int pcim_iomap_regions_request_all(struct pci_dev *pdev, int mask,
916fbfb7
TH
388 const char *name)
389{
390 int request_mask = ((1 << 6) - 1) & ~mask;
391 int rc;
392
393 rc = pci_request_selected_regions(pdev, request_mask, name);
394 if (rc)
395 return rc;
396
397 rc = pcim_iomap_regions(pdev, mask, name);
398 if (rc)
399 pci_release_selected_regions(pdev, request_mask);
400 return rc;
401}
402EXPORT_SYMBOL(pcim_iomap_regions_request_all);
403
ec04b075
TH
404/**
405 * pcim_iounmap_regions - Unmap and release PCI BARs
406 * @pdev: PCI device to map IO resources for
407 * @mask: Mask of BARs to unmap and release
408 *
4d45ada3 409 * Unmap and release regions specified by @mask.
ec04b075 410 */
fb7ebfe4 411void pcim_iounmap_regions(struct pci_dev *pdev, int mask)
ec04b075
TH
412{
413 void __iomem * const *iomap;
414 int i;
415
416 iomap = pcim_iomap_table(pdev);
417 if (!iomap)
418 return;
419
1f35d04a 420 for (i = 0; i < PCIM_IOMAP_MAX; i++) {
ec04b075
TH
421 if (!(mask & (1 << i)))
422 continue;
423
424 pcim_iounmap(pdev, iomap[i]);
425 pci_release_region(pdev, i);
426 }
427}
428EXPORT_SYMBOL(pcim_iounmap_regions);
571806a9 429#endif /* CONFIG_PCI */