lib/devres.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 #include <linux/err.h>
   3 #include <linux/pci.h>
   4 #include <linux/io.h>
   5 #include <linux/gfp.h>
   6 #include <linux/export.h>
   7 #include <linux/of_address.h>
   8
   9 enum devm_ioremap_type {
  10         DEVM_IOREMAP = 0,
  11         DEVM_IOREMAP_NC,
  12         DEVM_IOREMAP_WC,
  13 };
  14
  15 void devm_ioremap_release(struct device *dev, void *res)
  16 {
  17         iounmap(*(void __iomem **)res);
  18 }
  19
  20 static int devm_ioremap_match(struct device *dev, void *res, void *match_data)
  21 {
  22         return *(void **)res == match_data;
  23 }
  24
  25 static void __iomem *__devm_ioremap(struct device *dev, resource_size_t offset,
  26                                     resource_size_t size,
  27                                     enum devm_ioremap_type type)
  28 {
  29         void __iomem **ptr, *addr = NULL;
  30
  31         ptr = devres_alloc(devm_ioremap_release, sizeof(*ptr), GFP_KERNEL);
  32         if (!ptr)
  33                 return NULL;
  34
  35         switch (type) {
  36         case DEVM_IOREMAP:
  37                 addr = ioremap(offset, size);
  38                 break;
  39         case DEVM_IOREMAP_NC:
  40                 addr = ioremap_nocache(offset, size);
  41                 break;
  42         case DEVM_IOREMAP_WC:
  43                 addr = ioremap_wc(offset, size);
  44                 break;
  45         }
  46
  47         if (addr) {
  48                 *ptr = addr;
  49                 devres_add(dev, ptr);
  50         } else
  51                 devres_free(ptr);
  52
  53         return addr;
  54 }
  55
  56 /**
  57  * devm_ioremap - Managed ioremap()
  58  * @dev: Generic device to remap IO address for
  59  * @offset: Resource address to map
  60  * @size: Size of map
  61  *
  62  * Managed ioremap().  Map is automatically unmapped on driver detach.
  63  */
  64 void __iomem *devm_ioremap(struct device *dev, resource_size_t offset,
  65                            resource_size_t size)
  66 {
  67         return __devm_ioremap(dev, offset, size, DEVM_IOREMAP);
  68 }
  69 EXPORT_SYMBOL(devm_ioremap);
  70
  71 /**
  72  * devm_ioremap_nocache - Managed ioremap_nocache()
  73  * @dev: Generic device to remap IO address for
  74  * @offset: Resource address to map
  75  * @size: Size of map
  76  *
  77  * Managed ioremap_nocache().  Map is automatically unmapped on driver
  78  * detach.
  79  */
  80 void __iomem *devm_ioremap_nocache(struct device *dev, resource_size_t offset,
  81                                    resource_size_t size)
  82 {
  83         return __devm_ioremap(dev, offset, size, DEVM_IOREMAP_NC);
  84 }
  85 EXPORT_SYMBOL(devm_ioremap_nocache);
  86
  87 /**
  88  * devm_ioremap_wc - Managed ioremap_wc()
  89  * @dev: Generic device to remap IO address for
  90  * @offset: Resource address to map
  91  * @size: Size of map
  92  *
  93  * Managed ioremap_wc().  Map is automatically unmapped on driver detach.
  94  */
  95 void __iomem *devm_ioremap_wc(struct device *dev, resource_size_t offset,
  96                               resource_size_t size)
  97 {
  98         return __devm_ioremap(dev, offset, size, DEVM_IOREMAP_WC);
  99 }
 100 EXPORT_SYMBOL(devm_ioremap_wc);
 101
 102 /**
 103  * devm_iounmap - Managed iounmap()
 104  * @dev: Generic device to unmap for
 105  * @addr: Address to unmap
 106  *
 107  * Managed iounmap().  @addr must have been mapped using devm_ioremap*().
 108  */
 109 void devm_iounmap(struct device *dev, void __iomem *addr)
 110 {
 111         WARN_ON(devres_destroy(dev, devm_ioremap_release, devm_ioremap_match,
 112                                (__force void *)addr));
 113         iounmap(addr);
 114 }
 115 EXPORT_SYMBOL(devm_iounmap);
 116
 117 static void __iomem *
 118 __devm_ioremap_resource(struct device *dev, const struct resource *res,
 119                         enum devm_ioremap_type type)
 120 {
 121         resource_size_t size;
 122         void __iomem *dest_ptr;
 123
 124         BUG_ON(!dev);
 125
 126         if (!res || resource_type(res) != IORESOURCE_MEM) {
 127                 dev_err(dev, "invalid resource\n");
 128                 return IOMEM_ERR_PTR(-EINVAL);
 129         }
 130
 131         size = resource_size(res);
 132
 133         if (!devm_request_mem_region(dev, res->start, size, dev_name(dev))) {
 134                 dev_err(dev, "can't request region for resource %pR\n", res);
 135                 return IOMEM_ERR_PTR(-EBUSY);
 136         }
 137
 138         dest_ptr = __devm_ioremap(dev, res->start, size, type);
 139         if (!dest_ptr) {
 140                 dev_err(dev, "ioremap failed for resource %pR\n", res);
 141                 devm_release_mem_region(dev, res->start, size);
 142                 dest_ptr = IOMEM_ERR_PTR(-ENOMEM);
 143         }
 144
 145         return dest_ptr;
 146 }
 147
 148 /**
 149  * devm_ioremap_resource() - check, request region, and ioremap resource
 150  * @dev: generic device to handle the resource for
 151  * @res: resource to be handled
 152  *
 153  * Checks that a resource is a valid memory region, requests the memory
 154  * region and ioremaps it. All operations are managed and will be undone
 155  * on driver detach.
 156  *
 157  * Returns a pointer to the remapped memory or an ERR_PTR() encoded error code
 158  * on failure. Usage example:
 159  *
 160  *      res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 161  *      base = devm_ioremap_resource(&pdev->dev, res);
 162  *      if (IS_ERR(base))
 163  *              return PTR_ERR(base);
 164  */
 165 void __iomem *devm_ioremap_resource(struct device *dev,
 166                                     const struct resource *res)
 167 {
 168         return __devm_ioremap_resource(dev, res, DEVM_IOREMAP);
 169 }
 170 EXPORT_SYMBOL(devm_ioremap_resource);
 171
 172 /**
 173  * devm_ioremap_resource_wc() - write-combined variant of
 174  *                              devm_ioremap_resource()
 175  * @dev: generic device to handle the resource for
 176  * @res: resource to be handled
 177  *
 178  * Returns a pointer to the remapped memory or an ERR_PTR() encoded error code
 179  * on failure. Usage example:
 180  */
 181 void __iomem *devm_ioremap_resource_wc(struct device *dev,
 182                                        const struct resource *res)
 183 {
 184         return __devm_ioremap_resource(dev, res, DEVM_IOREMAP_WC);
 185 }
 186
 187 /*
 188  * devm_of_iomap - Requests a resource and maps the memory mapped IO
 189  *                 for a given device_node managed by a given device
 190  *
 191  * Checks that a resource is a valid memory region, requests the memory
 192  * region and ioremaps it. All operations are managed and will be undone
 193  * on driver detach of the device.
 194  *
 195  * This is to be used when a device requests/maps resources described
 196  * by other device tree nodes (children or otherwise).
 197  *
 198  * @dev:        The device "managing" the resource
 199  * @node:       The device-tree node where the resource resides
 200  * @index:      index of the MMIO range in the "reg" property
 201  * @size:       Returns the size of the resource (pass NULL if not needed)
 202  * Returns a pointer to the requested and mapped memory or an ERR_PTR() encoded
 203  * error code on failure. Usage example:
 204  *
 205  *      base = devm_of_iomap(&pdev->dev, node, 0, NULL);
 206  *      if (IS_ERR(base))
 207  *              return PTR_ERR(base);
 208  */
 209 void __iomem *devm_of_iomap(struct device *dev, struct device_node *node, int index,
 210                             resource_size_t *size)
 211 {
 212         struct resource res;
 213
 214         if (of_address_to_resource(node, index, &res))
 215                 return IOMEM_ERR_PTR(-EINVAL);
 216         if (size)
 217                 *size = resource_size(&res);
 218         return devm_ioremap_resource(dev, &res);
 219 }
 220 EXPORT_SYMBOL(devm_of_iomap);
 221
 222 #ifdef CONFIG_HAS_IOPORT_MAP
 223 /*
 224  * Generic iomap devres
 225  */
 226 static void devm_ioport_map_release(struct device *dev, void *res)
 227 {
 228         ioport_unmap(*(void __iomem **)res);
 229 }
 230
 231 static int devm_ioport_map_match(struct device *dev, void *res,
 232                                  void *match_data)
 233 {
 234         return *(void **)res == match_data;
 235 }
 236
 237 /**
 238  * devm_ioport_map - Managed ioport_map()
 239  * @dev: Generic device to map ioport for
 240  * @port: Port to map
 241  * @nr: Number of ports to map
 242  *
 243  * Managed ioport_map().  Map is automatically unmapped on driver
 244  * detach.
 245  */
 246 void __iomem *devm_ioport_map(struct device *dev, unsigned long port,
 247                                unsigned int nr)
 248 {
 249         void __iomem **ptr, *addr;
 250
 251         ptr = devres_alloc(devm_ioport_map_release, sizeof(*ptr), GFP_KERNEL);
 252         if (!ptr)
 253                 return NULL;
 254
 255         addr = ioport_map(port, nr);
 256         if (addr) {
 257                 *ptr = addr;
 258                 devres_add(dev, ptr);
 259         } else
 260                 devres_free(ptr);
 261
 262         return addr;
 263 }
 264 EXPORT_SYMBOL(devm_ioport_map);
 265
 266 /**
 267  * devm_ioport_unmap - Managed ioport_unmap()
 268  * @dev: Generic device to unmap for
 269  * @addr: Address to unmap
 270  *
 271  * Managed ioport_unmap().  @addr must have been mapped using
 272  * devm_ioport_map().
 273  */
 274 void devm_ioport_unmap(struct device *dev, void __iomem *addr)
 275 {
 276         ioport_unmap(addr);
 277         WARN_ON(devres_destroy(dev, devm_ioport_map_release,
 278                                devm_ioport_map_match, (__force void *)addr));
 279 }
 280 EXPORT_SYMBOL(devm_ioport_unmap);
 281 #endif /* CONFIG_HAS_IOPORT_MAP */
 282
 283 #ifdef CONFIG_PCI
 284 /*
 285  * PCI iomap devres
 286  */
 287 #define PCIM_IOMAP_MAX  PCI_ROM_RESOURCE
 288
 289 struct pcim_iomap_devres {
 290         void __iomem *table[PCIM_IOMAP_MAX];
 291 };
 292
 293 static void pcim_iomap_release(struct device *gendev, void *res)
 294 {
 295         struct pci_dev *dev = to_pci_dev(gendev);
 296         struct pcim_iomap_devres *this = res;
 297         int i;
 298
 299         for (i = 0; i < PCIM_IOMAP_MAX; i++)
 300                 if (this->table[i])
 301                         pci_iounmap(dev, this->table[i]);
 302 }
 303
 304 /**
 305  * pcim_iomap_table - access iomap allocation table
 306  * @pdev: PCI device to access iomap table for
 307  *
 308  * Access iomap allocation table for @dev.  If iomap table doesn't
 309  * exist and @pdev is managed, it will be allocated.  All iomaps
 310  * recorded in the iomap table are automatically unmapped on driver
 311  * detach.
 312  *
 313  * This function might sleep when the table is first allocated but can
 314  * be safely called without context and guaranteed to succed once
 315  * allocated.
 316  */
 317 void __iomem * const *pcim_iomap_table(struct pci_dev *pdev)
 318 {
 319         struct pcim_iomap_devres *dr, *new_dr;
 320
 321         dr = devres_find(&pdev->dev, pcim_iomap_release, NULL, NULL);
 322         if (dr)
 323                 return dr->table;
 324
 325         new_dr = devres_alloc(pcim_iomap_release, sizeof(*new_dr), GFP_KERNEL);
 326         if (!new_dr)
 327                 return NULL;
 328         dr = devres_get(&pdev->dev, new_dr, NULL, NULL);
 329         return dr->table;
 330 }
 331 EXPORT_SYMBOL(pcim_iomap_table);
 332
 333 /**
 334  * pcim_iomap - Managed pcim_iomap()
 335  * @pdev: PCI device to iomap for
 336  * @bar: BAR to iomap
 337  * @maxlen: Maximum length of iomap
 338  *
 339  * Managed pci_iomap().  Map is automatically unmapped on driver
 340  * detach.
 341  */
 342 void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen)
 343 {
 344         void __iomem **tbl;
 345
 346         BUG_ON(bar >= PCIM_IOMAP_MAX);
 347
 348         tbl = (void __iomem **)pcim_iomap_table(pdev);
 349         if (!tbl || tbl[bar])   /* duplicate mappings not allowed */
 350                 return NULL;
 351
 352         tbl[bar] = pci_iomap(pdev, bar, maxlen);
 353         return tbl[bar];
 354 }
 355 EXPORT_SYMBOL(pcim_iomap);
 356
 357 /**
 358  * pcim_iounmap - Managed pci_iounmap()
 359  * @pdev: PCI device to iounmap for
 360  * @addr: Address to unmap
 361  *
 362  * Managed pci_iounmap().  @addr must have been mapped using pcim_iomap().
 363  */
 364 void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr)
 365 {
 366         void __iomem **tbl;
 367         int i;
 368
 369         pci_iounmap(pdev, addr);
 370
 371         tbl = (void __iomem **)pcim_iomap_table(pdev);
 372         BUG_ON(!tbl);
 373
 374         for (i = 0; i < PCIM_IOMAP_MAX; i++)
 375                 if (tbl[i] == addr) {
 376                         tbl[i] = NULL;
 377                         return;
 378                 }
 379         WARN_ON(1);
 380 }
 381 EXPORT_SYMBOL(pcim_iounmap);
 382
 383 /**
 384  * pcim_iomap_regions - Request and iomap PCI BARs
 385  * @pdev: PCI device to map IO resources for
 386  * @mask: Mask of BARs to request and iomap
 387  * @name: Name used when requesting regions
 388  *
 389  * Request and iomap regions specified by @mask.
 390  */
 391 int pcim_iomap_regions(struct pci_dev *pdev, int mask, const char *name)
 392 {
 393         void __iomem * const *iomap;
 394         int i, rc;
 395
 396         iomap = pcim_iomap_table(pdev);
 397         if (!iomap)
 398                 return -ENOMEM;
 399
 400         for (i = 0; i < DEVICE_COUNT_RESOURCE; i++) {
 401                 unsigned long len;
 402
 403                 if (!(mask & (1 << i)))
 404                         continue;
 405
 406                 rc = -EINVAL;
 407                 len = pci_resource_len(pdev, i);
 408                 if (!len)
 409                         goto err_inval;
 410
 411                 rc = pci_request_region(pdev, i, name);
 412                 if (rc)
 413                         goto err_inval;
 414
 415                 rc = -ENOMEM;
 416                 if (!pcim_iomap(pdev, i, 0))
 417                         goto err_region;
 418         }
 419
 420         return 0;
 421
 422  err_region:
 423         pci_release_region(pdev, i);
 424  err_inval:
 425         while (--i >= 0) {
 426                 if (!(mask & (1 << i)))
 427                         continue;
 428                 pcim_iounmap(pdev, iomap[i]);
 429                 pci_release_region(pdev, i);
 430         }
 431
 432         return rc;
 433 }
 434 EXPORT_SYMBOL(pcim_iomap_regions);
 435
 436 /**
 437  * pcim_iomap_regions_request_all - Request all BARs and iomap specified ones
 438  * @pdev: PCI device to map IO resources for
 439  * @mask: Mask of BARs to iomap
 440  * @name: Name used when requesting regions
 441  *
 442  * Request all PCI BARs and iomap regions specified by @mask.
 443  */
 444 int pcim_iomap_regions_request_all(struct pci_dev *pdev, int mask,
 445                                    const char *name)
 446 {
 447         int request_mask = ((1 << 6) - 1) & ~mask;
 448         int rc;
 449
 450         rc = pci_request_selected_regions(pdev, request_mask, name);
 451         if (rc)
 452                 return rc;
 453
 454         rc = pcim_iomap_regions(pdev, mask, name);
 455         if (rc)
 456                 pci_release_selected_regions(pdev, request_mask);
 457         return rc;
 458 }
 459 EXPORT_SYMBOL(pcim_iomap_regions_request_all);
 460
 461 /**
 462  * pcim_iounmap_regions - Unmap and release PCI BARs
 463  * @pdev: PCI device to map IO resources for
 464  * @mask: Mask of BARs to unmap and release
 465  *
 466  * Unmap and release regions specified by @mask.
 467  */
 468 void pcim_iounmap_regions(struct pci_dev *pdev, int mask)
 469 {
 470         void __iomem * const *iomap;
 471         int i;
 472
 473         iomap = pcim_iomap_table(pdev);
 474         if (!iomap)
 475                 return;
 476
 477         for (i = 0; i < PCIM_IOMAP_MAX; i++) {
 478                 if (!(mask & (1 << i)))
 479                         continue;
 480
 481                 pcim_iounmap(pdev, iomap[i]);
 482                 pci_release_region(pdev, i);
 483         }
 484 }
 485 EXPORT_SYMBOL(pcim_iounmap_regions);
 486 #endif /* CONFIG_PCI */