Merge branch 'next' of git://git.kernel.org/pub/scm/linux/kernel/git/rzhang/linux
[linux-2.6.git] / lib / devres.c
blob823533138fa04e8f43445323a2118bfb4ac0d646
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>
7 void devm_ioremap_release(struct device *dev, void *res)
9 iounmap(*(void __iomem **)res);
12 static int devm_ioremap_match(struct device *dev, void *res, void *match_data)
14 return *(void **)res == match_data;
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
23 * Managed ioremap(). Map is automatically unmapped on driver detach.
25 void __iomem *devm_ioremap(struct device *dev, resource_size_t offset,
26 unsigned long size)
28 void __iomem **ptr, *addr;
30 ptr = devres_alloc(devm_ioremap_release, sizeof(*ptr), GFP_KERNEL);
31 if (!ptr)
32 return NULL;
34 addr = ioremap(offset, size);
35 if (addr) {
36 *ptr = addr;
37 devres_add(dev, ptr);
38 } else
39 devres_free(ptr);
41 return addr;
43 EXPORT_SYMBOL(devm_ioremap);
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
51 * Managed ioremap_nocache(). Map is automatically unmapped on driver
52 * detach.
54 void __iomem *devm_ioremap_nocache(struct device *dev, resource_size_t offset,
55 unsigned long size)
57 void __iomem **ptr, *addr;
59 ptr = devres_alloc(devm_ioremap_release, sizeof(*ptr), GFP_KERNEL);
60 if (!ptr)
61 return NULL;
63 addr = ioremap_nocache(offset, size);
64 if (addr) {
65 *ptr = addr;
66 devres_add(dev, ptr);
67 } else
68 devres_free(ptr);
70 return addr;
72 EXPORT_SYMBOL(devm_ioremap_nocache);
74 /**
75 * devm_iounmap - Managed iounmap()
76 * @dev: Generic device to unmap for
77 * @addr: Address to unmap
79 * Managed iounmap(). @addr must have been mapped using devm_ioremap*().
81 void devm_iounmap(struct device *dev, void __iomem *addr)
83 WARN_ON(devres_destroy(dev, devm_ioremap_release, devm_ioremap_match,
84 (void *)addr));
85 iounmap(addr);
87 EXPORT_SYMBOL(devm_iounmap);
89 /**
90 * devm_ioremap_resource() - check, request region, and ioremap resource
91 * @dev: generic device to handle the resource for
92 * @res: resource to be handled
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.
99 * Returns a pointer to the remapped memory or an ERR_PTR() encoded error code
100 * on failure. Usage example:
102 * res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
103 * base = devm_ioremap_resource(&pdev->dev, res);
104 * if (IS_ERR(base))
105 * return PTR_ERR(base);
107 void __iomem *devm_ioremap_resource(struct device *dev, struct resource *res)
109 resource_size_t size;
110 const char *name;
111 void __iomem *dest_ptr;
113 BUG_ON(!dev);
115 if (!res || resource_type(res) != IORESOURCE_MEM) {
116 dev_err(dev, "invalid resource\n");
117 return ERR_PTR(-EINVAL);
120 size = resource_size(res);
121 name = res->name ?: dev_name(dev);
123 if (!devm_request_mem_region(dev, res->start, size, name)) {
124 dev_err(dev, "can't request region for resource %pR\n", res);
125 return ERR_PTR(-EBUSY);
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);
133 if (!dest_ptr) {
134 dev_err(dev, "ioremap failed for resource %pR\n", res);
135 devm_release_mem_region(dev, res->start, size);
136 dest_ptr = ERR_PTR(-ENOMEM);
139 return dest_ptr;
141 EXPORT_SYMBOL(devm_ioremap_resource);
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
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:
153 * res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
154 * base = devm_request_and_ioremap(&pdev->dev, res);
155 * if (!base)
156 * return -EADDRNOTAVAIL;
158 void __iomem *devm_request_and_ioremap(struct device *device,
159 struct resource *res)
161 void __iomem *dest_ptr;
163 dest_ptr = devm_ioremap_resource(device, res);
164 if (IS_ERR(dest_ptr))
165 return NULL;
167 return dest_ptr;
169 EXPORT_SYMBOL(devm_request_and_ioremap);
171 #ifdef CONFIG_HAS_IOPORT
173 * Generic iomap devres
175 static void devm_ioport_map_release(struct device *dev, void *res)
177 ioport_unmap(*(void __iomem **)res);
180 static int devm_ioport_map_match(struct device *dev, void *res,
181 void *match_data)
183 return *(void **)res == match_data;
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
192 * Managed ioport_map(). Map is automatically unmapped on driver
193 * detach.
195 void __iomem * devm_ioport_map(struct device *dev, unsigned long port,
196 unsigned int nr)
198 void __iomem **ptr, *addr;
200 ptr = devres_alloc(devm_ioport_map_release, sizeof(*ptr), GFP_KERNEL);
201 if (!ptr)
202 return NULL;
204 addr = ioport_map(port, nr);
205 if (addr) {
206 *ptr = addr;
207 devres_add(dev, ptr);
208 } else
209 devres_free(ptr);
211 return addr;
213 EXPORT_SYMBOL(devm_ioport_map);
216 * devm_ioport_unmap - Managed ioport_unmap()
217 * @dev: Generic device to unmap for
218 * @addr: Address to unmap
220 * Managed ioport_unmap(). @addr must have been mapped using
221 * devm_ioport_map().
223 void devm_ioport_unmap(struct device *dev, void __iomem *addr)
225 ioport_unmap(addr);
226 WARN_ON(devres_destroy(dev, devm_ioport_map_release,
227 devm_ioport_map_match, (void *)addr));
229 EXPORT_SYMBOL(devm_ioport_unmap);
230 #endif /* CONFIG_HAS_IOPORT */
232 #ifdef CONFIG_PCI
234 * PCI iomap devres
236 #define PCIM_IOMAP_MAX PCI_ROM_RESOURCE
238 struct pcim_iomap_devres {
239 void __iomem *table[PCIM_IOMAP_MAX];
242 static void pcim_iomap_release(struct device *gendev, void *res)
244 struct pci_dev *dev = container_of(gendev, struct pci_dev, dev);
245 struct pcim_iomap_devres *this = res;
246 int i;
248 for (i = 0; i < PCIM_IOMAP_MAX; i++)
249 if (this->table[i])
250 pci_iounmap(dev, this->table[i]);
254 * pcim_iomap_table - access iomap allocation table
255 * @pdev: PCI device to access iomap table for
257 * Access iomap allocation table for @dev. If iomap table doesn't
258 * exist and @pdev is managed, it will be allocated. All iomaps
259 * recorded in the iomap table are automatically unmapped on driver
260 * detach.
262 * This function might sleep when the table is first allocated but can
263 * be safely called without context and guaranteed to succed once
264 * allocated.
266 void __iomem * const * pcim_iomap_table(struct pci_dev *pdev)
268 struct pcim_iomap_devres *dr, *new_dr;
270 dr = devres_find(&pdev->dev, pcim_iomap_release, NULL, NULL);
271 if (dr)
272 return dr->table;
274 new_dr = devres_alloc(pcim_iomap_release, sizeof(*new_dr), GFP_KERNEL);
275 if (!new_dr)
276 return NULL;
277 dr = devres_get(&pdev->dev, new_dr, NULL, NULL);
278 return dr->table;
280 EXPORT_SYMBOL(pcim_iomap_table);
283 * pcim_iomap - Managed pcim_iomap()
284 * @pdev: PCI device to iomap for
285 * @bar: BAR to iomap
286 * @maxlen: Maximum length of iomap
288 * Managed pci_iomap(). Map is automatically unmapped on driver
289 * detach.
291 void __iomem * pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen)
293 void __iomem **tbl;
295 BUG_ON(bar >= PCIM_IOMAP_MAX);
297 tbl = (void __iomem **)pcim_iomap_table(pdev);
298 if (!tbl || tbl[bar]) /* duplicate mappings not allowed */
299 return NULL;
301 tbl[bar] = pci_iomap(pdev, bar, maxlen);
302 return tbl[bar];
304 EXPORT_SYMBOL(pcim_iomap);
307 * pcim_iounmap - Managed pci_iounmap()
308 * @pdev: PCI device to iounmap for
309 * @addr: Address to unmap
311 * Managed pci_iounmap(). @addr must have been mapped using pcim_iomap().
313 void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr)
315 void __iomem **tbl;
316 int i;
318 pci_iounmap(pdev, addr);
320 tbl = (void __iomem **)pcim_iomap_table(pdev);
321 BUG_ON(!tbl);
323 for (i = 0; i < PCIM_IOMAP_MAX; i++)
324 if (tbl[i] == addr) {
325 tbl[i] = NULL;
326 return;
328 WARN_ON(1);
330 EXPORT_SYMBOL(pcim_iounmap);
333 * pcim_iomap_regions - Request and iomap PCI BARs
334 * @pdev: PCI device to map IO resources for
335 * @mask: Mask of BARs to request and iomap
336 * @name: Name used when requesting regions
338 * Request and iomap regions specified by @mask.
340 int pcim_iomap_regions(struct pci_dev *pdev, int mask, const char *name)
342 void __iomem * const *iomap;
343 int i, rc;
345 iomap = pcim_iomap_table(pdev);
346 if (!iomap)
347 return -ENOMEM;
349 for (i = 0; i < DEVICE_COUNT_RESOURCE; i++) {
350 unsigned long len;
352 if (!(mask & (1 << i)))
353 continue;
355 rc = -EINVAL;
356 len = pci_resource_len(pdev, i);
357 if (!len)
358 goto err_inval;
360 rc = pci_request_region(pdev, i, name);
361 if (rc)
362 goto err_inval;
364 rc = -ENOMEM;
365 if (!pcim_iomap(pdev, i, 0))
366 goto err_region;
369 return 0;
371 err_region:
372 pci_release_region(pdev, i);
373 err_inval:
374 while (--i >= 0) {
375 if (!(mask & (1 << i)))
376 continue;
377 pcim_iounmap(pdev, iomap[i]);
378 pci_release_region(pdev, i);
381 return rc;
383 EXPORT_SYMBOL(pcim_iomap_regions);
386 * pcim_iomap_regions_request_all - Request all BARs and iomap specified ones
387 * @pdev: PCI device to map IO resources for
388 * @mask: Mask of BARs to iomap
389 * @name: Name used when requesting regions
391 * Request all PCI BARs and iomap regions specified by @mask.
393 int pcim_iomap_regions_request_all(struct pci_dev *pdev, int mask,
394 const char *name)
396 int request_mask = ((1 << 6) - 1) & ~mask;
397 int rc;
399 rc = pci_request_selected_regions(pdev, request_mask, name);
400 if (rc)
401 return rc;
403 rc = pcim_iomap_regions(pdev, mask, name);
404 if (rc)
405 pci_release_selected_regions(pdev, request_mask);
406 return rc;
408 EXPORT_SYMBOL(pcim_iomap_regions_request_all);
411 * pcim_iounmap_regions - Unmap and release PCI BARs
412 * @pdev: PCI device to map IO resources for
413 * @mask: Mask of BARs to unmap and release
415 * Unmap and release regions specified by @mask.
417 void pcim_iounmap_regions(struct pci_dev *pdev, int mask)
419 void __iomem * const *iomap;
420 int i;
422 iomap = pcim_iomap_table(pdev);
423 if (!iomap)
424 return;
426 for (i = 0; i < DEVICE_COUNT_RESOURCE; i++) {
427 if (!(mask & (1 << i)))
428 continue;
430 pcim_iounmap(pdev, iomap[i]);
431 pci_release_region(pdev, i);
434 EXPORT_SYMBOL(pcim_iounmap_regions);
435 #endif /* CONFIG_PCI */