devres.c

  1// SPDX-License-Identifier: GPL-2.0
  2#include <linux/bug.h>
  3#include <linux/device.h>
  4#include <linux/errno.h>
  5#include <linux/export.h>
  6#include <linux/gfp_types.h>
  7#include <linux/io.h>
  8#include <linux/ioport.h>
  9#include <linux/of_address.h>
 10#include <linux/types.h>
 11
 12enum devm_ioremap_type {
 13	DEVM_IOREMAP = 0,
 14	DEVM_IOREMAP_UC,
 15	DEVM_IOREMAP_WC,
 16	DEVM_IOREMAP_NP,
 17};
 18
 19void devm_ioremap_release(struct device *dev, void *res)
 20{
 21	iounmap(*(void __iomem **)res);
 22}
 23
 24static int devm_ioremap_match(struct device *dev, void *res, void *match_data)
 25{
 26	return *(void **)res == match_data;
 27}
 28
 29static void __iomem *__devm_ioremap(struct device *dev, resource_size_t offset,
 30				    resource_size_t size,
 31				    enum devm_ioremap_type type)
 32{
 33	void __iomem **ptr, *addr = NULL;
 34
 35	ptr = devres_alloc_node(devm_ioremap_release, sizeof(*ptr), GFP_KERNEL,
 36				dev_to_node(dev));
 37	if (!ptr)
 38		return NULL;
 39
 40	switch (type) {
 41	case DEVM_IOREMAP:
 42		addr = ioremap(offset, size);
 43		break;
 44	case DEVM_IOREMAP_UC:
 45		addr = ioremap_uc(offset, size);
 46		break;
 47	case DEVM_IOREMAP_WC:
 48		addr = ioremap_wc(offset, size);
 49		break;
 50	case DEVM_IOREMAP_NP:
 51		addr = ioremap_np(offset, size);
 52		break;
 53	}
 54
 55	if (addr) {
 56		*ptr = addr;
 57		devres_add(dev, ptr);
 58	} else
 59		devres_free(ptr);
 60
 61	return addr;
 62}
 63
 64/**
 65 * devm_ioremap - Managed ioremap()
 66 * @dev: Generic device to remap IO address for
 67 * @offset: Resource address to map
 68 * @size: Size of map
 69 *
 70 * Managed ioremap().  Map is automatically unmapped on driver detach.
 71 */
 72void __iomem *devm_ioremap(struct device *dev, resource_size_t offset,
 73			   resource_size_t size)
 74{
 75	return __devm_ioremap(dev, offset, size, DEVM_IOREMAP);
 76}
 77EXPORT_SYMBOL(devm_ioremap);
 78
 79/**
 80 * devm_ioremap_uc - Managed ioremap_uc()
 81 * @dev: Generic device to remap IO address for
 82 * @offset: Resource address to map
 83 * @size: Size of map
 84 *
 85 * Managed ioremap_uc().  Map is automatically unmapped on driver detach.
 86 */
 87void __iomem *devm_ioremap_uc(struct device *dev, resource_size_t offset,
 88			      resource_size_t size)
 89{
 90	return __devm_ioremap(dev, offset, size, DEVM_IOREMAP_UC);
 91}
 92EXPORT_SYMBOL_GPL(devm_ioremap_uc);
 93
 94/**
 95 * devm_ioremap_wc - Managed ioremap_wc()
 96 * @dev: Generic device to remap IO address for
 97 * @offset: Resource address to map
 98 * @size: Size of map
 99 *
100 * Managed ioremap_wc().  Map is automatically unmapped on driver detach.
101 */
102void __iomem *devm_ioremap_wc(struct device *dev, resource_size_t offset,
103			      resource_size_t size)
104{
105	return __devm_ioremap(dev, offset, size, DEVM_IOREMAP_WC);
106}
107EXPORT_SYMBOL(devm_ioremap_wc);
108
109/**
110 * devm_iounmap - Managed iounmap()
111 * @dev: Generic device to unmap for
112 * @addr: Address to unmap
113 *
114 * Managed iounmap().  @addr must have been mapped using devm_ioremap*().
115 */
116void devm_iounmap(struct device *dev, void __iomem *addr)
117{
118	WARN_ON(devres_release(dev, devm_ioremap_release, devm_ioremap_match,
119			       (__force void *)addr));
120}
121EXPORT_SYMBOL(devm_iounmap);
122
123static void __iomem *
124__devm_ioremap_resource(struct device *dev, const struct resource *res,
125			enum devm_ioremap_type type)
126{
127	resource_size_t size;
128	void __iomem *dest_ptr;
129	char *pretty_name;
130	int ret;
131
132	BUG_ON(!dev);
133
134	if (!res || resource_type(res) != IORESOURCE_MEM) {
135		ret = dev_err_probe(dev, -EINVAL, "invalid resource %pR\n", res);
136		return IOMEM_ERR_PTR(ret);
137	}
138
139	if (type == DEVM_IOREMAP && res->flags & IORESOURCE_MEM_NONPOSTED)
140		type = DEVM_IOREMAP_NP;
141
142	size = resource_size(res);
143
144	if (res->name)
145		pretty_name = devm_kasprintf(dev, GFP_KERNEL, "%s %s",
146					     dev_name(dev), res->name);
147	else
148		pretty_name = devm_kstrdup(dev, dev_name(dev), GFP_KERNEL);
149	if (!pretty_name) {
150		ret = dev_err_probe(dev, -ENOMEM, "can't generate pretty name for resource %pR\n", res);
151		return IOMEM_ERR_PTR(ret);
152	}
153
154	if (!devm_request_mem_region(dev, res->start, size, pretty_name)) {
155		ret = dev_err_probe(dev, -EBUSY, "can't request region for resource %pR\n", res);
156		return IOMEM_ERR_PTR(ret);
157	}
158
159	dest_ptr = __devm_ioremap(dev, res->start, size, type);
160	if (!dest_ptr) {
161		devm_release_mem_region(dev, res->start, size);
162		ret = dev_err_probe(dev, -ENOMEM, "ioremap failed for resource %pR\n", res);
163		return IOMEM_ERR_PTR(ret);
164	}
165
166	return dest_ptr;
167}
168
169/**
170 * devm_ioremap_resource() - check, request region, and ioremap resource
171 * @dev: generic device to handle the resource for
172 * @res: resource to be handled
173 *
174 * Checks that a resource is a valid memory region, requests the memory
175 * region and ioremaps it. All operations are managed and will be undone
176 * on driver detach.
177 *
178 * Usage example:
179 *
180 *	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
181 *	base = devm_ioremap_resource(&pdev->dev, res);
182 *	if (IS_ERR(base))
183 *		return PTR_ERR(base);
184 *
185 * Return: a pointer to the remapped memory or an ERR_PTR() encoded error code
186 * on failure.
187 */
188void __iomem *devm_ioremap_resource(struct device *dev,
189				    const struct resource *res)
190{
191	return __devm_ioremap_resource(dev, res, DEVM_IOREMAP);
192}
193EXPORT_SYMBOL(devm_ioremap_resource);
194
195/**
196 * devm_ioremap_resource_wc() - write-combined variant of
197 *				devm_ioremap_resource()
198 * @dev: generic device to handle the resource for
199 * @res: resource to be handled
200 *
201 * Return: a pointer to the remapped memory or an ERR_PTR() encoded error code
202 * on failure.
203 */
204void __iomem *devm_ioremap_resource_wc(struct device *dev,
205				       const struct resource *res)
206{
207	return __devm_ioremap_resource(dev, res, DEVM_IOREMAP_WC);
208}
209EXPORT_SYMBOL(devm_ioremap_resource_wc);
210
211/*
212 * devm_of_iomap - Requests a resource and maps the memory mapped IO
213 *		   for a given device_node managed by a given device
214 *
215 * Checks that a resource is a valid memory region, requests the memory
216 * region and ioremaps it. All operations are managed and will be undone
217 * on driver detach of the device.
218 *
219 * This is to be used when a device requests/maps resources described
220 * by other device tree nodes (children or otherwise).
221 *
222 * @dev:	The device "managing" the resource
223 * @node:       The device-tree node where the resource resides
224 * @index:	index of the MMIO range in the "reg" property
225 * @size:	Returns the size of the resource (pass NULL if not needed)
226 *
227 * Usage example:
228 *
229 *	base = devm_of_iomap(&pdev->dev, node, 0, NULL);
230 *	if (IS_ERR(base))
231 *		return PTR_ERR(base);
232 *
233 * Please Note: This is not a one-to-one replacement for of_iomap() because the
234 * of_iomap() function does not track whether the region is already mapped.  If
235 * two drivers try to map the same memory, the of_iomap() function will succeed
236 * but the devm_of_iomap() function will return -EBUSY.
237 *
238 * Return: a pointer to the requested and mapped memory or an ERR_PTR() encoded
239 * error code on failure.
240 */
241void __iomem *devm_of_iomap(struct device *dev, struct device_node *node, int index,
242			    resource_size_t *size)
243{
244	struct resource res;
245
246	if (of_address_to_resource(node, index, &res))
247		return IOMEM_ERR_PTR(-EINVAL);
248	if (size)
249		*size = resource_size(&res);
250	return devm_ioremap_resource(dev, &res);
251}
252EXPORT_SYMBOL(devm_of_iomap);
253
254#ifdef CONFIG_HAS_IOPORT_MAP
255/*
256 * Generic iomap devres
257 */
258static void devm_ioport_map_release(struct device *dev, void *res)
259{
260	ioport_unmap(*(void __iomem **)res);
261}
262
263static int devm_ioport_map_match(struct device *dev, void *res,
264				 void *match_data)
265{
266	return *(void **)res == match_data;
267}
268
269/**
270 * devm_ioport_map - Managed ioport_map()
271 * @dev: Generic device to map ioport for
272 * @port: Port to map
273 * @nr: Number of ports to map
274 *
275 * Managed ioport_map().  Map is automatically unmapped on driver
276 * detach.
277 *
278 * Return: a pointer to the remapped memory or NULL on failure.
279 */
280void __iomem *devm_ioport_map(struct device *dev, unsigned long port,
281			       unsigned int nr)
282{
283	void __iomem **ptr, *addr;
284
285	ptr = devres_alloc_node(devm_ioport_map_release, sizeof(*ptr), GFP_KERNEL,
286				dev_to_node(dev));
287	if (!ptr)
288		return NULL;
289
290	addr = ioport_map(port, nr);
291	if (addr) {
292		*ptr = addr;
293		devres_add(dev, ptr);
294	} else
295		devres_free(ptr);
296
297	return addr;
298}
299EXPORT_SYMBOL(devm_ioport_map);
300
301/**
302 * devm_ioport_unmap - Managed ioport_unmap()
303 * @dev: Generic device to unmap for
304 * @addr: Address to unmap
305 *
306 * Managed ioport_unmap().  @addr must have been mapped using
307 * devm_ioport_map().
308 */
309void devm_ioport_unmap(struct device *dev, void __iomem *addr)
310{
311	WARN_ON(devres_release(dev, devm_ioport_map_release,
312			       devm_ioport_map_match, (__force void *)addr));
313}
314EXPORT_SYMBOL(devm_ioport_unmap);
315#endif /* CONFIG_HAS_IOPORT_MAP */
316
317static void devm_arch_phys_ac_add_release(struct device *dev, void *res)
318{
319	arch_phys_wc_del(*((int *)res));
320}
321
322/**
323 * devm_arch_phys_wc_add - Managed arch_phys_wc_add()
324 * @dev: Managed device
325 * @base: Memory base address
326 * @size: Size of memory range
327 *
328 * Adds a WC MTRR using arch_phys_wc_add() and sets up a release callback.
329 * See arch_phys_wc_add() for more information.
330 */
331int devm_arch_phys_wc_add(struct device *dev, unsigned long base, unsigned long size)
332{
333	int *mtrr;
334	int ret;
335
336	mtrr = devres_alloc_node(devm_arch_phys_ac_add_release, sizeof(*mtrr), GFP_KERNEL,
337				 dev_to_node(dev));
338	if (!mtrr)
339		return -ENOMEM;
340
341	ret = arch_phys_wc_add(base, size);
342	if (ret < 0) {
343		devres_free(mtrr);
344		return ret;
345	}
346
347	*mtrr = ret;
348	devres_add(dev, mtrr);
349
350	return ret;
351}
352EXPORT_SYMBOL(devm_arch_phys_wc_add);
353
354struct arch_io_reserve_memtype_wc_devres {
355	resource_size_t start;
356	resource_size_t size;
357};
358
359static void devm_arch_io_free_memtype_wc_release(struct device *dev, void *res)
360{
361	const struct arch_io_reserve_memtype_wc_devres *this = res;
362
363	arch_io_free_memtype_wc(this->start, this->size);
364}
365
366/**
367 * devm_arch_io_reserve_memtype_wc - Managed arch_io_reserve_memtype_wc()
368 * @dev: Managed device
369 * @start: Memory base address
370 * @size: Size of memory range
371 *
372 * Reserves a memory range with WC caching using arch_io_reserve_memtype_wc()
373 * and sets up a release callback See arch_io_reserve_memtype_wc() for more
374 * information.
375 */
376int devm_arch_io_reserve_memtype_wc(struct device *dev, resource_size_t start,
377				    resource_size_t size)
378{
379	struct arch_io_reserve_memtype_wc_devres *dr;
380	int ret;
381
382	dr = devres_alloc_node(devm_arch_io_free_memtype_wc_release, sizeof(*dr), GFP_KERNEL,
383			       dev_to_node(dev));
384	if (!dr)
385		return -ENOMEM;
386
387	ret = arch_io_reserve_memtype_wc(start, size);
388	if (ret < 0) {
389		devres_free(dr);
390		return ret;
391	}
392
393	dr->start = start;
394	dr->size = size;
395	devres_add(dev, dr);
396
397	return ret;
398}
399EXPORT_SYMBOL(devm_arch_io_reserve_memtype_wc);