blob: 5f2aedd58bc5032eb18e882fbb2e539f0feed550 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001// SPDX-License-Identifier: GPL-2.0
Thierry Redingf4a18312013-01-22 22:24:46 +01002#include <linux/err.h>
Al Viro5ea81762007-02-11 15:41:31 +00003#include <linux/pci.h>
4#include <linux/io.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +09005#include <linux/gfp.h>
Paul Gortmaker8bc3bcc2011-11-16 21:29:17 -05006#include <linux/export.h>
Al Viro5ea81762007-02-11 15:41:31 +00007
Emil Medveb41e5ff2008-05-03 06:34:04 +10008void devm_ioremap_release(struct device *dev, void *res)
Al Viro5ea81762007-02-11 15:41:31 +00009{
10 iounmap(*(void __iomem **)res);
11}
12
13static int devm_ioremap_match(struct device *dev, void *res, void *match_data)
14{
15 return *(void **)res == match_data;
16}
17
18/**
19 * devm_ioremap - Managed ioremap()
20 * @dev: Generic device to remap IO address for
Lorenzo Pieralisi65247542017-04-19 17:48:54 +010021 * @offset: Resource address to map
Al Viro5ea81762007-02-11 15:41:31 +000022 * @size: Size of map
23 *
24 * Managed ioremap(). Map is automatically unmapped on driver detach.
25 */
Kumar Gala4f452e82008-04-29 10:25:48 -050026void __iomem *devm_ioremap(struct device *dev, resource_size_t offset,
Cristian Stoica5559b7b2014-10-07 18:25:43 +030027 resource_size_t size)
Al Viro5ea81762007-02-11 15:41:31 +000028{
29 void __iomem **ptr, *addr;
30
31 ptr = devres_alloc(devm_ioremap_release, sizeof(*ptr), GFP_KERNEL);
32 if (!ptr)
33 return NULL;
34
35 addr = ioremap(offset, size);
36 if (addr) {
37 *ptr = addr;
38 devres_add(dev, ptr);
39 } else
40 devres_free(ptr);
41
42 return addr;
43}
44EXPORT_SYMBOL(devm_ioremap);
45
46/**
47 * devm_ioremap_nocache - Managed ioremap_nocache()
48 * @dev: Generic device to remap IO address for
Lorenzo Pieralisi65247542017-04-19 17:48:54 +010049 * @offset: Resource address to map
Al Viro5ea81762007-02-11 15:41:31 +000050 * @size: Size of map
51 *
52 * Managed ioremap_nocache(). Map is automatically unmapped on driver
53 * detach.
54 */
Kumar Gala4f452e82008-04-29 10:25:48 -050055void __iomem *devm_ioremap_nocache(struct device *dev, resource_size_t offset,
Cristian Stoica5559b7b2014-10-07 18:25:43 +030056 resource_size_t size)
Al Viro5ea81762007-02-11 15:41:31 +000057{
58 void __iomem **ptr, *addr;
59
60 ptr = devres_alloc(devm_ioremap_release, sizeof(*ptr), GFP_KERNEL);
61 if (!ptr)
62 return NULL;
63
64 addr = ioremap_nocache(offset, size);
65 if (addr) {
66 *ptr = addr;
67 devres_add(dev, ptr);
68 } else
69 devres_free(ptr);
70
71 return addr;
72}
73EXPORT_SYMBOL(devm_ioremap_nocache);
74
75/**
Abhilash Kesavan34644522015-02-06 19:15:27 +053076 * devm_ioremap_wc - Managed ioremap_wc()
77 * @dev: Generic device to remap IO address for
Lorenzo Pieralisi65247542017-04-19 17:48:54 +010078 * @offset: Resource address to map
Abhilash Kesavan34644522015-02-06 19:15:27 +053079 * @size: Size of map
80 *
81 * Managed ioremap_wc(). Map is automatically unmapped on driver detach.
82 */
83void __iomem *devm_ioremap_wc(struct device *dev, resource_size_t offset,
84 resource_size_t size)
85{
86 void __iomem **ptr, *addr;
87
88 ptr = devres_alloc(devm_ioremap_release, sizeof(*ptr), GFP_KERNEL);
89 if (!ptr)
90 return NULL;
91
92 addr = ioremap_wc(offset, size);
93 if (addr) {
94 *ptr = addr;
95 devres_add(dev, ptr);
96 } else
97 devres_free(ptr);
98
99 return addr;
100}
101EXPORT_SYMBOL(devm_ioremap_wc);
102
103/**
Al Viro5ea81762007-02-11 15:41:31 +0000104 * devm_iounmap - Managed iounmap()
105 * @dev: Generic device to unmap for
106 * @addr: Address to unmap
107 *
108 * Managed iounmap(). @addr must have been mapped using devm_ioremap*().
109 */
110void devm_iounmap(struct device *dev, void __iomem *addr)
111{
Al Viro5ea81762007-02-11 15:41:31 +0000112 WARN_ON(devres_destroy(dev, devm_ioremap_release, devm_ioremap_match,
Steven Rostedtb104d6a2014-04-03 14:49:07 -0700113 (__force void *)addr));
Maxin B Johnae891a12011-07-25 17:12:59 -0700114 iounmap(addr);
Al Viro5ea81762007-02-11 15:41:31 +0000115}
116EXPORT_SYMBOL(devm_iounmap);
117
Wolfram Sang72f8c0b2011-10-25 15:16:47 +0200118/**
Thierry Reding75096572013-01-21 11:08:54 +0100119 * devm_ioremap_resource() - check, request region, and ioremap resource
120 * @dev: generic device to handle the resource for
121 * @res: resource to be handled
122 *
Dan Williams92b19ff2015-08-10 23:07:06 -0400123 * Checks that a resource is a valid memory region, requests the memory
124 * region and ioremaps it. All operations are managed and will be undone
125 * on driver detach.
Thierry Reding75096572013-01-21 11:08:54 +0100126 *
127 * Returns a pointer to the remapped memory or an ERR_PTR() encoded error code
128 * on failure. Usage example:
129 *
130 * res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
131 * base = devm_ioremap_resource(&pdev->dev, res);
132 * if (IS_ERR(base))
133 * return PTR_ERR(base);
134 */
135void __iomem *devm_ioremap_resource(struct device *dev, struct resource *res)
136{
137 resource_size_t size;
138 const char *name;
139 void __iomem *dest_ptr;
140
141 BUG_ON(!dev);
142
143 if (!res || resource_type(res) != IORESOURCE_MEM) {
144 dev_err(dev, "invalid resource\n");
Steven Rostedtb104d6a2014-04-03 14:49:07 -0700145 return IOMEM_ERR_PTR(-EINVAL);
Thierry Reding75096572013-01-21 11:08:54 +0100146 }
147
148 size = resource_size(res);
149 name = res->name ?: dev_name(dev);
150
151 if (!devm_request_mem_region(dev, res->start, size, name)) {
152 dev_err(dev, "can't request region for resource %pR\n", res);
Steven Rostedtb104d6a2014-04-03 14:49:07 -0700153 return IOMEM_ERR_PTR(-EBUSY);
Thierry Reding75096572013-01-21 11:08:54 +0100154 }
155
Dan Williams92b19ff2015-08-10 23:07:06 -0400156 dest_ptr = devm_ioremap(dev, res->start, size);
Thierry Reding75096572013-01-21 11:08:54 +0100157 if (!dest_ptr) {
158 dev_err(dev, "ioremap failed for resource %pR\n", res);
159 devm_release_mem_region(dev, res->start, size);
Steven Rostedtb104d6a2014-04-03 14:49:07 -0700160 dest_ptr = IOMEM_ERR_PTR(-ENOMEM);
Thierry Reding75096572013-01-21 11:08:54 +0100161 }
162
163 return dest_ptr;
164}
165EXPORT_SYMBOL(devm_ioremap_resource);
166
Uwe Kleine-Königce816fa2014-04-07 15:39:19 -0700167#ifdef CONFIG_HAS_IOPORT_MAP
Al Viro5ea81762007-02-11 15:41:31 +0000168/*
169 * Generic iomap devres
170 */
171static void devm_ioport_map_release(struct device *dev, void *res)
172{
173 ioport_unmap(*(void __iomem **)res);
174}
175
176static int devm_ioport_map_match(struct device *dev, void *res,
177 void *match_data)
178{
179 return *(void **)res == match_data;
180}
181
182/**
183 * devm_ioport_map - Managed ioport_map()
184 * @dev: Generic device to map ioport for
185 * @port: Port to map
186 * @nr: Number of ports to map
187 *
188 * Managed ioport_map(). Map is automatically unmapped on driver
189 * detach.
190 */
Fabian Frederick5cbb00c2014-05-23 22:30:50 +0200191void __iomem *devm_ioport_map(struct device *dev, unsigned long port,
Al Viro5ea81762007-02-11 15:41:31 +0000192 unsigned int nr)
193{
194 void __iomem **ptr, *addr;
195
196 ptr = devres_alloc(devm_ioport_map_release, sizeof(*ptr), GFP_KERNEL);
197 if (!ptr)
198 return NULL;
199
200 addr = ioport_map(port, nr);
201 if (addr) {
202 *ptr = addr;
203 devres_add(dev, ptr);
204 } else
205 devres_free(ptr);
206
207 return addr;
208}
209EXPORT_SYMBOL(devm_ioport_map);
210
211/**
212 * devm_ioport_unmap - Managed ioport_unmap()
213 * @dev: Generic device to unmap for
214 * @addr: Address to unmap
215 *
216 * Managed ioport_unmap(). @addr must have been mapped using
217 * devm_ioport_map().
218 */
219void devm_ioport_unmap(struct device *dev, void __iomem *addr)
220{
221 ioport_unmap(addr);
222 WARN_ON(devres_destroy(dev, devm_ioport_map_release,
Steven Rostedtb104d6a2014-04-03 14:49:07 -0700223 devm_ioport_map_match, (__force void *)addr));
Al Viro5ea81762007-02-11 15:41:31 +0000224}
225EXPORT_SYMBOL(devm_ioport_unmap);
Uwe Kleine-Königce816fa2014-04-07 15:39:19 -0700226#endif /* CONFIG_HAS_IOPORT_MAP */
Al Viro5ea81762007-02-11 15:41:31 +0000227
228#ifdef CONFIG_PCI
229/*
230 * PCI iomap devres
231 */
232#define PCIM_IOMAP_MAX PCI_ROM_RESOURCE
233
234struct pcim_iomap_devres {
235 void __iomem *table[PCIM_IOMAP_MAX];
236};
237
238static void pcim_iomap_release(struct device *gendev, void *res)
239{
Geliang Tang20af74e2015-12-27 18:46:05 +0800240 struct pci_dev *dev = to_pci_dev(gendev);
Al Viro5ea81762007-02-11 15:41:31 +0000241 struct pcim_iomap_devres *this = res;
242 int i;
243
244 for (i = 0; i < PCIM_IOMAP_MAX; i++)
245 if (this->table[i])
246 pci_iounmap(dev, this->table[i]);
247}
248
249/**
250 * pcim_iomap_table - access iomap allocation table
251 * @pdev: PCI device to access iomap table for
252 *
253 * Access iomap allocation table for @dev. If iomap table doesn't
254 * exist and @pdev is managed, it will be allocated. All iomaps
255 * recorded in the iomap table are automatically unmapped on driver
256 * detach.
257 *
258 * This function might sleep when the table is first allocated but can
259 * be safely called without context and guaranteed to succed once
260 * allocated.
261 */
Fabian Frederick5cbb00c2014-05-23 22:30:50 +0200262void __iomem * const *pcim_iomap_table(struct pci_dev *pdev)
Al Viro5ea81762007-02-11 15:41:31 +0000263{
264 struct pcim_iomap_devres *dr, *new_dr;
265
266 dr = devres_find(&pdev->dev, pcim_iomap_release, NULL, NULL);
267 if (dr)
268 return dr->table;
269
270 new_dr = devres_alloc(pcim_iomap_release, sizeof(*new_dr), GFP_KERNEL);
271 if (!new_dr)
272 return NULL;
273 dr = devres_get(&pdev->dev, new_dr, NULL, NULL);
274 return dr->table;
275}
276EXPORT_SYMBOL(pcim_iomap_table);
277
278/**
279 * pcim_iomap - Managed pcim_iomap()
280 * @pdev: PCI device to iomap for
281 * @bar: BAR to iomap
282 * @maxlen: Maximum length of iomap
283 *
284 * Managed pci_iomap(). Map is automatically unmapped on driver
285 * detach.
286 */
Fabian Frederick5cbb00c2014-05-23 22:30:50 +0200287void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen)
Al Viro5ea81762007-02-11 15:41:31 +0000288{
289 void __iomem **tbl;
290
291 BUG_ON(bar >= PCIM_IOMAP_MAX);
292
293 tbl = (void __iomem **)pcim_iomap_table(pdev);
294 if (!tbl || tbl[bar]) /* duplicate mappings not allowed */
295 return NULL;
296
297 tbl[bar] = pci_iomap(pdev, bar, maxlen);
298 return tbl[bar];
299}
300EXPORT_SYMBOL(pcim_iomap);
301
302/**
303 * pcim_iounmap - Managed pci_iounmap()
304 * @pdev: PCI device to iounmap for
305 * @addr: Address to unmap
306 *
307 * Managed pci_iounmap(). @addr must have been mapped using pcim_iomap().
308 */
309void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr)
310{
311 void __iomem **tbl;
312 int i;
313
314 pci_iounmap(pdev, addr);
315
316 tbl = (void __iomem **)pcim_iomap_table(pdev);
317 BUG_ON(!tbl);
318
319 for (i = 0; i < PCIM_IOMAP_MAX; i++)
320 if (tbl[i] == addr) {
321 tbl[i] = NULL;
322 return;
323 }
324 WARN_ON(1);
325}
326EXPORT_SYMBOL(pcim_iounmap);
327
328/**
329 * pcim_iomap_regions - Request and iomap PCI BARs
330 * @pdev: PCI device to map IO resources for
331 * @mask: Mask of BARs to request and iomap
332 * @name: Name used when requesting regions
333 *
334 * Request and iomap regions specified by @mask.
335 */
Yinghai Lufb7ebfe2012-01-04 15:50:02 -0800336int pcim_iomap_regions(struct pci_dev *pdev, int mask, const char *name)
Al Viro5ea81762007-02-11 15:41:31 +0000337{
338 void __iomem * const *iomap;
339 int i, rc;
340
341 iomap = pcim_iomap_table(pdev);
342 if (!iomap)
343 return -ENOMEM;
344
345 for (i = 0; i < DEVICE_COUNT_RESOURCE; i++) {
346 unsigned long len;
347
348 if (!(mask & (1 << i)))
349 continue;
350
351 rc = -EINVAL;
352 len = pci_resource_len(pdev, i);
353 if (!len)
354 goto err_inval;
355
356 rc = pci_request_region(pdev, i, name);
357 if (rc)
Frederik Deweerdtfb4d64e2007-02-16 01:27:15 -0800358 goto err_inval;
Al Viro5ea81762007-02-11 15:41:31 +0000359
360 rc = -ENOMEM;
361 if (!pcim_iomap(pdev, i, 0))
Frederik Deweerdtfb4d64e2007-02-16 01:27:15 -0800362 goto err_region;
Al Viro5ea81762007-02-11 15:41:31 +0000363 }
364
365 return 0;
366
Al Viro5ea81762007-02-11 15:41:31 +0000367 err_region:
368 pci_release_region(pdev, i);
369 err_inval:
370 while (--i >= 0) {
Frederik Deweerdtfb4d64e2007-02-16 01:27:15 -0800371 if (!(mask & (1 << i)))
372 continue;
Al Viro5ea81762007-02-11 15:41:31 +0000373 pcim_iounmap(pdev, iomap[i]);
374 pci_release_region(pdev, i);
375 }
376
377 return rc;
378}
379EXPORT_SYMBOL(pcim_iomap_regions);
Tejun Heoec04b072007-03-09 19:45:58 +0900380
381/**
Tejun Heo916fbfb2008-03-12 15:26:34 +0900382 * pcim_iomap_regions_request_all - Request all BARs and iomap specified ones
383 * @pdev: PCI device to map IO resources for
384 * @mask: Mask of BARs to iomap
385 * @name: Name used when requesting regions
386 *
387 * Request all PCI BARs and iomap regions specified by @mask.
388 */
Yinghai Lufb7ebfe2012-01-04 15:50:02 -0800389int pcim_iomap_regions_request_all(struct pci_dev *pdev, int mask,
Tejun Heo916fbfb2008-03-12 15:26:34 +0900390 const char *name)
391{
392 int request_mask = ((1 << 6) - 1) & ~mask;
393 int rc;
394
395 rc = pci_request_selected_regions(pdev, request_mask, name);
396 if (rc)
397 return rc;
398
399 rc = pcim_iomap_regions(pdev, mask, name);
400 if (rc)
401 pci_release_selected_regions(pdev, request_mask);
402 return rc;
403}
404EXPORT_SYMBOL(pcim_iomap_regions_request_all);
405
406/**
Tejun Heoec04b072007-03-09 19:45:58 +0900407 * pcim_iounmap_regions - Unmap and release PCI BARs
408 * @pdev: PCI device to map IO resources for
409 * @mask: Mask of BARs to unmap and release
410 *
Kulikov Vasiliy4d45ada2010-07-10 14:07:41 +0400411 * Unmap and release regions specified by @mask.
Tejun Heoec04b072007-03-09 19:45:58 +0900412 */
Yinghai Lufb7ebfe2012-01-04 15:50:02 -0800413void pcim_iounmap_regions(struct pci_dev *pdev, int mask)
Tejun Heoec04b072007-03-09 19:45:58 +0900414{
415 void __iomem * const *iomap;
416 int i;
417
418 iomap = pcim_iomap_table(pdev);
419 if (!iomap)
420 return;
421
Dan Carpenter1f35d042015-09-21 19:21:51 +0300422 for (i = 0; i < PCIM_IOMAP_MAX; i++) {
Tejun Heoec04b072007-03-09 19:45:58 +0900423 if (!(mask & (1 << i)))
424 continue;
425
426 pcim_iounmap(pdev, iomap[i]);
427 pci_release_region(pdev, i);
428 }
429}
430EXPORT_SYMBOL(pcim_iounmap_regions);
Wolfram Sang571806a2011-10-25 15:03:42 +0200431#endif /* CONFIG_PCI */