mm: numa: fix minor typo in numa_next_scan
[deliverable/linux.git] / lib / devres.c
CommitLineData
f4a18312 1#include <linux/err.h>
5ea81769
AV
2#include <linux/pci.h>
3#include <linux/io.h>
5a0e3ad6 4#include <linux/gfp.h>
8bc3bcc9 5#include <linux/export.h>
5ea81769 6
b41e5fff 7void devm_ioremap_release(struct device *dev, void *res)
5ea81769
AV
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 */
4f452e8a 25void __iomem *devm_ioremap(struct device *dev, resource_size_t offset,
5ea81769
AV
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 */
4f452e8a 54void __iomem *devm_ioremap_nocache(struct device *dev, resource_size_t offset,
5ea81769
AV
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{
5ea81769
AV
83 WARN_ON(devres_destroy(dev, devm_ioremap_release, devm_ioremap_match,
84 (void *)addr));
ae891a1b 85 iounmap(addr);
5ea81769
AV
86}
87EXPORT_SYMBOL(devm_iounmap);
88
72f8c0bf 89/**
75096579
TR
90 * devm_ioremap_resource() - check, request region, and ioremap resource
91 * @dev: generic device to handle the resource for
72f8c0bf
WS
92 * @res: resource to be handled
93 *
75096579
TR
94 * Checks that a resource is a valid memory region, requests the memory region
95 * and ioremaps it either as cacheable or as non-cacheable memory depending on
96 * the resource's flags. All operations are managed and will be undone on
97 * driver detach.
98 *
99 * Returns a pointer to the remapped memory or an ERR_PTR() encoded error code
100 * on failure. Usage example:
72f8c0bf
WS
101 *
102 * res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
75096579
TR
103 * base = devm_ioremap_resource(&pdev->dev, res);
104 * if (IS_ERR(base))
105 * return PTR_ERR(base);
72f8c0bf 106 */
75096579 107void __iomem *devm_ioremap_resource(struct device *dev, struct resource *res)
72f8c0bf
WS
108{
109 resource_size_t size;
110 const char *name;
111 void __iomem *dest_ptr;
112
113 BUG_ON(!dev);
114
115 if (!res || resource_type(res) != IORESOURCE_MEM) {
116 dev_err(dev, "invalid resource\n");
75096579 117 return ERR_PTR(-EINVAL);
72f8c0bf
WS
118 }
119
120 size = resource_size(res);
121 name = res->name ?: dev_name(dev);
122
123 if (!devm_request_mem_region(dev, res->start, size, name)) {
124 dev_err(dev, "can't request region for resource %pR\n", res);
75096579 125 return ERR_PTR(-EBUSY);
72f8c0bf
WS
126 }
127
128 if (res->flags & IORESOURCE_CACHEABLE)
129 dest_ptr = devm_ioremap(dev, res->start, size);
130 else
131 dest_ptr = devm_ioremap_nocache(dev, res->start, size);
132
133 if (!dest_ptr) {
134 dev_err(dev, "ioremap failed for resource %pR\n", res);
135 devm_release_mem_region(dev, res->start, size);
75096579 136 dest_ptr = ERR_PTR(-ENOMEM);
72f8c0bf
WS
137 }
138
139 return dest_ptr;
140}
75096579
TR
141EXPORT_SYMBOL(devm_ioremap_resource);
142
143/**
144 * devm_request_and_ioremap() - Check, request region, and ioremap resource
145 * @dev: Generic device to handle the resource for
146 * @res: resource to be handled
147 *
148 * Takes all necessary steps to ioremap a mem resource. Uses managed device, so
149 * everything is undone on driver detach. Checks arguments, so you can feed
150 * it the result from e.g. platform_get_resource() directly. Returns the
151 * remapped pointer or NULL on error. Usage example:
152 *
153 * res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
154 * base = devm_request_and_ioremap(&pdev->dev, res);
155 * if (!base)
156 * return -EADDRNOTAVAIL;
157 */
158void __iomem *devm_request_and_ioremap(struct device *device,
159 struct resource *res)
160{
161 void __iomem *dest_ptr;
162
163 dest_ptr = devm_ioremap_resource(device, res);
164 if (IS_ERR(dest_ptr))
165 return NULL;
166
167 return dest_ptr;
168}
72f8c0bf
WS
169EXPORT_SYMBOL(devm_request_and_ioremap);
170
5ea81769
AV
171#ifdef CONFIG_HAS_IOPORT
172/*
173 * Generic iomap devres
174 */
175static void devm_ioport_map_release(struct device *dev, void *res)
176{
177 ioport_unmap(*(void __iomem **)res);
178}
179
180static int devm_ioport_map_match(struct device *dev, void *res,
181 void *match_data)
182{
183 return *(void **)res == match_data;
184}
185
186/**
187 * devm_ioport_map - Managed ioport_map()
188 * @dev: Generic device to map ioport for
189 * @port: Port to map
190 * @nr: Number of ports to map
191 *
192 * Managed ioport_map(). Map is automatically unmapped on driver
193 * detach.
194 */
195void __iomem * devm_ioport_map(struct device *dev, unsigned long port,
196 unsigned int nr)
197{
198 void __iomem **ptr, *addr;
199
200 ptr = devres_alloc(devm_ioport_map_release, sizeof(*ptr), GFP_KERNEL);
201 if (!ptr)
202 return NULL;
203
204 addr = ioport_map(port, nr);
205 if (addr) {
206 *ptr = addr;
207 devres_add(dev, ptr);
208 } else
209 devres_free(ptr);
210
211 return addr;
212}
213EXPORT_SYMBOL(devm_ioport_map);
214
215/**
216 * devm_ioport_unmap - Managed ioport_unmap()
217 * @dev: Generic device to unmap for
218 * @addr: Address to unmap
219 *
220 * Managed ioport_unmap(). @addr must have been mapped using
221 * devm_ioport_map().
222 */
223void devm_ioport_unmap(struct device *dev, void __iomem *addr)
224{
225 ioport_unmap(addr);
226 WARN_ON(devres_destroy(dev, devm_ioport_map_release,
227 devm_ioport_map_match, (void *)addr));
228}
229EXPORT_SYMBOL(devm_ioport_unmap);
230
231#ifdef CONFIG_PCI
232/*
233 * PCI iomap devres
234 */
235#define PCIM_IOMAP_MAX PCI_ROM_RESOURCE
236
237struct pcim_iomap_devres {
238 void __iomem *table[PCIM_IOMAP_MAX];
239};
240
241static void pcim_iomap_release(struct device *gendev, void *res)
242{
243 struct pci_dev *dev = container_of(gendev, struct pci_dev, dev);
244 struct pcim_iomap_devres *this = res;
245 int i;
246
247 for (i = 0; i < PCIM_IOMAP_MAX; i++)
248 if (this->table[i])
249 pci_iounmap(dev, this->table[i]);
250}
251
252/**
253 * pcim_iomap_table - access iomap allocation table
254 * @pdev: PCI device to access iomap table for
255 *
256 * Access iomap allocation table for @dev. If iomap table doesn't
257 * exist and @pdev is managed, it will be allocated. All iomaps
258 * recorded in the iomap table are automatically unmapped on driver
259 * detach.
260 *
261 * This function might sleep when the table is first allocated but can
262 * be safely called without context and guaranteed to succed once
263 * allocated.
264 */
265void __iomem * const * pcim_iomap_table(struct pci_dev *pdev)
266{
267 struct pcim_iomap_devres *dr, *new_dr;
268
269 dr = devres_find(&pdev->dev, pcim_iomap_release, NULL, NULL);
270 if (dr)
271 return dr->table;
272
273 new_dr = devres_alloc(pcim_iomap_release, sizeof(*new_dr), GFP_KERNEL);
274 if (!new_dr)
275 return NULL;
276 dr = devres_get(&pdev->dev, new_dr, NULL, NULL);
277 return dr->table;
278}
279EXPORT_SYMBOL(pcim_iomap_table);
280
281/**
282 * pcim_iomap - Managed pcim_iomap()
283 * @pdev: PCI device to iomap for
284 * @bar: BAR to iomap
285 * @maxlen: Maximum length of iomap
286 *
287 * Managed pci_iomap(). Map is automatically unmapped on driver
288 * detach.
289 */
290void __iomem * pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen)
291{
292 void __iomem **tbl;
293
294 BUG_ON(bar >= PCIM_IOMAP_MAX);
295
296 tbl = (void __iomem **)pcim_iomap_table(pdev);
297 if (!tbl || tbl[bar]) /* duplicate mappings not allowed */
298 return NULL;
299
300 tbl[bar] = pci_iomap(pdev, bar, maxlen);
301 return tbl[bar];
302}
303EXPORT_SYMBOL(pcim_iomap);
304
305/**
306 * pcim_iounmap - Managed pci_iounmap()
307 * @pdev: PCI device to iounmap for
308 * @addr: Address to unmap
309 *
310 * Managed pci_iounmap(). @addr must have been mapped using pcim_iomap().
311 */
312void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr)
313{
314 void __iomem **tbl;
315 int i;
316
317 pci_iounmap(pdev, addr);
318
319 tbl = (void __iomem **)pcim_iomap_table(pdev);
320 BUG_ON(!tbl);
321
322 for (i = 0; i < PCIM_IOMAP_MAX; i++)
323 if (tbl[i] == addr) {
324 tbl[i] = NULL;
325 return;
326 }
327 WARN_ON(1);
328}
329EXPORT_SYMBOL(pcim_iounmap);
330
331/**
332 * pcim_iomap_regions - Request and iomap PCI BARs
333 * @pdev: PCI device to map IO resources for
334 * @mask: Mask of BARs to request and iomap
335 * @name: Name used when requesting regions
336 *
337 * Request and iomap regions specified by @mask.
338 */
fb7ebfe4 339int pcim_iomap_regions(struct pci_dev *pdev, int mask, const char *name)
5ea81769
AV
340{
341 void __iomem * const *iomap;
342 int i, rc;
343
344 iomap = pcim_iomap_table(pdev);
345 if (!iomap)
346 return -ENOMEM;
347
348 for (i = 0; i < DEVICE_COUNT_RESOURCE; i++) {
349 unsigned long len;
350
351 if (!(mask & (1 << i)))
352 continue;
353
354 rc = -EINVAL;
355 len = pci_resource_len(pdev, i);
356 if (!len)
357 goto err_inval;
358
359 rc = pci_request_region(pdev, i, name);
360 if (rc)
fb4d64e7 361 goto err_inval;
5ea81769
AV
362
363 rc = -ENOMEM;
364 if (!pcim_iomap(pdev, i, 0))
fb4d64e7 365 goto err_region;
5ea81769
AV
366 }
367
368 return 0;
369
5ea81769
AV
370 err_region:
371 pci_release_region(pdev, i);
372 err_inval:
373 while (--i >= 0) {
fb4d64e7
FD
374 if (!(mask & (1 << i)))
375 continue;
5ea81769
AV
376 pcim_iounmap(pdev, iomap[i]);
377 pci_release_region(pdev, i);
378 }
379
380 return rc;
381}
382EXPORT_SYMBOL(pcim_iomap_regions);
ec04b075 383
916fbfb7
TH
384/**
385 * pcim_iomap_regions_request_all - Request all BARs and iomap specified ones
386 * @pdev: PCI device to map IO resources for
387 * @mask: Mask of BARs to iomap
388 * @name: Name used when requesting regions
389 *
390 * Request all PCI BARs and iomap regions specified by @mask.
391 */
fb7ebfe4 392int pcim_iomap_regions_request_all(struct pci_dev *pdev, int mask,
916fbfb7
TH
393 const char *name)
394{
395 int request_mask = ((1 << 6) - 1) & ~mask;
396 int rc;
397
398 rc = pci_request_selected_regions(pdev, request_mask, name);
399 if (rc)
400 return rc;
401
402 rc = pcim_iomap_regions(pdev, mask, name);
403 if (rc)
404 pci_release_selected_regions(pdev, request_mask);
405 return rc;
406}
407EXPORT_SYMBOL(pcim_iomap_regions_request_all);
408
ec04b075
TH
409/**
410 * pcim_iounmap_regions - Unmap and release PCI BARs
411 * @pdev: PCI device to map IO resources for
412 * @mask: Mask of BARs to unmap and release
413 *
4d45ada3 414 * Unmap and release regions specified by @mask.
ec04b075 415 */
fb7ebfe4 416void pcim_iounmap_regions(struct pci_dev *pdev, int mask)
ec04b075
TH
417{
418 void __iomem * const *iomap;
419 int i;
420
421 iomap = pcim_iomap_table(pdev);
422 if (!iomap)
423 return;
424
425 for (i = 0; i < DEVICE_COUNT_RESOURCE; i++) {
426 if (!(mask & (1 << i)))
427 continue;
428
429 pcim_iounmap(pdev, iomap[i]);
430 pci_release_region(pdev, i);
431 }
432}
433EXPORT_SYMBOL(pcim_iounmap_regions);
571806a9
WS
434#endif /* CONFIG_PCI */
435#endif /* CONFIG_HAS_IOPORT */
This page took 0.561191 seconds and 5 git commands to generate.