lib/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
  12 enum devm_ioremap_type {
  13         DEVM_IOREMAP = 0,
  14         DEVM_IOREMAP_UC,
  15         DEVM_IOREMAP_WC,
  16         DEVM_IOREMAP_NP,
  17 };
  18
  19 void devm_ioremap_release(struct device *dev, void *res)
  20 {
  21         iounmap(*(void __iomem **)res);
  22 }
  23
  24 static int devm_ioremap_match(struct device *dev, void *res, void *match_data)
  25 {
  26         return *(void **)res == match_data;
  27 }
  28
  29 static 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  */
  72 void __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 }
  77 EXPORT_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  */
  87 void __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 }
  92 EXPORT_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  */
 102 void __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 }
 107 EXPORT_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  */
 116 void 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 }
 121 EXPORT_SYMBOL(devm_iounmap);
 122
 123 static 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  */
 188 void __iomem *devm_ioremap_resource(struct device *dev,
 189                                     const struct resource *res)
 190 {
 191         return __devm_ioremap_resource(dev, res, DEVM_IOREMAP);
 192 }
 193 EXPORT_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  */
 204 void __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 }
 209
 210 /*
 211  * devm_of_iomap - Requests a resource and maps the memory mapped IO
 212  *                 for a given device_node managed by a given device
 213  *
 214  * Checks that a resource is a valid memory region, requests the memory
 215  * region and ioremaps it. All operations are managed and will be undone
 216  * on driver detach of the device.
 217  *
 218  * This is to be used when a device requests/maps resources described
 219  * by other device tree nodes (children or otherwise).
 220  *
 221  * @dev:        The device "managing" the resource
 222  * @node:       The device-tree node where the resource resides
 223  * @index:      index of the MMIO range in the "reg" property
 224  * @size:       Returns the size of the resource (pass NULL if not needed)
 225  *
 226  * Usage example:
 227  *
 228  *      base = devm_of_iomap(&pdev->dev, node, 0, NULL);
 229  *      if (IS_ERR(base))
 230  *              return PTR_ERR(base);
 231  *
 232  * Please Note: This is not a one-to-one replacement for of_iomap() because the
 233  * of_iomap() function does not track whether the region is already mapped.  If
 234  * two drivers try to map the same memory, the of_iomap() function will succeed
 235  * but the devm_of_iomap() function will return -EBUSY.
 236  *
 237  * Return: a pointer to the requested and mapped memory or an ERR_PTR() encoded
 238  * error code on failure.
 239  */
 240 void __iomem *devm_of_iomap(struct device *dev, struct device_node *node, int index,
 241                             resource_size_t *size)
 242 {
 243         struct resource res;
 244
 245         if (of_address_to_resource(node, index, &res))
 246                 return IOMEM_ERR_PTR(-EINVAL);
 247         if (size)
 248                 *size = resource_size(&res);
 249         return devm_ioremap_resource(dev, &res);
 250 }
 251 EXPORT_SYMBOL(devm_of_iomap);
 252
 253 #ifdef CONFIG_HAS_IOPORT_MAP
 254 /*
 255  * Generic iomap devres
 256  */
 257 static void devm_ioport_map_release(struct device *dev, void *res)
 258 {
 259         ioport_unmap(*(void __iomem **)res);
 260 }
 261
 262 static int devm_ioport_map_match(struct device *dev, void *res,
 263                                  void *match_data)
 264 {
 265         return *(void **)res == match_data;
 266 }
 267
 268 /**
 269  * devm_ioport_map - Managed ioport_map()
 270  * @dev: Generic device to map ioport for
 271  * @port: Port to map
 272  * @nr: Number of ports to map
 273  *
 274  * Managed ioport_map().  Map is automatically unmapped on driver
 275  * detach.
 276  *
 277  * Return: a pointer to the remapped memory or NULL on failure.
 278  */
 279 void __iomem *devm_ioport_map(struct device *dev, unsigned long port,
 280                                unsigned int nr)
 281 {
 282         void __iomem **ptr, *addr;
 283
 284         ptr = devres_alloc_node(devm_ioport_map_release, sizeof(*ptr), GFP_KERNEL,
 285                                 dev_to_node(dev));
 286         if (!ptr)
 287                 return NULL;
 288
 289         addr = ioport_map(port, nr);
 290         if (addr) {
 291                 *ptr = addr;
 292                 devres_add(dev, ptr);
 293         } else
 294                 devres_free(ptr);
 295
 296         return addr;
 297 }
 298 EXPORT_SYMBOL(devm_ioport_map);
 299
 300 /**
 301  * devm_ioport_unmap - Managed ioport_unmap()
 302  * @dev: Generic device to unmap for
 303  * @addr: Address to unmap
 304  *
 305  * Managed ioport_unmap().  @addr must have been mapped using
 306  * devm_ioport_map().
 307  */
 308 void devm_ioport_unmap(struct device *dev, void __iomem *addr)
 309 {
 310         WARN_ON(devres_release(dev, devm_ioport_map_release,
 311                                devm_ioport_map_match, (__force void *)addr));
 312 }
 313 EXPORT_SYMBOL(devm_ioport_unmap);
 314 #endif /* CONFIG_HAS_IOPORT_MAP */
 315
 316 static void devm_arch_phys_ac_add_release(struct device *dev, void *res)
 317 {
 318         arch_phys_wc_del(*((int *)res));
 319 }
 320
 321 /**
 322  * devm_arch_phys_wc_add - Managed arch_phys_wc_add()
 323  * @dev: Managed device
 324  * @base: Memory base address
 325  * @size: Size of memory range
 326  *
 327  * Adds a WC MTRR using arch_phys_wc_add() and sets up a release callback.
 328  * See arch_phys_wc_add() for more information.
 329  */
 330 int devm_arch_phys_wc_add(struct device *dev, unsigned long base, unsigned long size)
 331 {
 332         int *mtrr;
 333         int ret;
 334
 335         mtrr = devres_alloc_node(devm_arch_phys_ac_add_release, sizeof(*mtrr), GFP_KERNEL,
 336                                  dev_to_node(dev));
 337         if (!mtrr)
 338                 return -ENOMEM;
 339
 340         ret = arch_phys_wc_add(base, size);
 341         if (ret < 0) {
 342                 devres_free(mtrr);
 343                 return ret;
 344         }
 345
 346         *mtrr = ret;
 347         devres_add(dev, mtrr);
 348
 349         return ret;
 350 }
 351 EXPORT_SYMBOL(devm_arch_phys_wc_add);
 352
 353 struct arch_io_reserve_memtype_wc_devres {
 354         resource_size_t start;
 355         resource_size_t size;
 356 };
 357
 358 static void devm_arch_io_free_memtype_wc_release(struct device *dev, void *res)
 359 {
 360         const struct arch_io_reserve_memtype_wc_devres *this = res;
 361
 362         arch_io_free_memtype_wc(this->start, this->size);
 363 }
 364
 365 /**
 366  * devm_arch_io_reserve_memtype_wc - Managed arch_io_reserve_memtype_wc()
 367  * @dev: Managed device
 368  * @start: Memory base address
 369  * @size: Size of memory range
 370  *
 371  * Reserves a memory range with WC caching using arch_io_reserve_memtype_wc()
 372  * and sets up a release callback See arch_io_reserve_memtype_wc() for more
 373  * information.
 374  */
 375 int devm_arch_io_reserve_memtype_wc(struct device *dev, resource_size_t start,
 376                                     resource_size_t size)
 377 {
 378         struct arch_io_reserve_memtype_wc_devres *dr;
 379         int ret;
 380
 381         dr = devres_alloc_node(devm_arch_io_free_memtype_wc_release, sizeof(*dr), GFP_KERNEL,
 382                                dev_to_node(dev));
 383         if (!dr)
 384                 return -ENOMEM;
 385
 386         ret = arch_io_reserve_memtype_wc(start, size);
 387         if (ret < 0) {
 388                 devres_free(dr);
 389                 return ret;
 390         }
 391
 392         dr->start = start;
 393         dr->size = size;
 394         devres_add(dev, dr);
 395
 396         return ret;
 397 }
 398 EXPORT_SYMBOL(devm_arch_io_reserve_memtype_wc);