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