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 /**
 118  * devm_ioremap_resource() - check, request region, and ioremap resource
 119  * @dev: generic device to handle the resource for
 120  * @res: resource to be handled
 121  *
 122  * Checks that a resource is a valid memory region, requests the memory
 123  * region and ioremaps it. All operations are managed and will be undone
 124  * on driver detach.
 125  *
 126  * Returns a pointer to the remapped memory or an ERR_PTR() encoded error code
 127  * on failure. Usage example:
 128  *
 129  *      res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 130  *      base = devm_ioremap_resource(&pdev->dev, res);
 131  *      if (IS_ERR(base))
 132  *              return PTR_ERR(base);
 133  */
 134 void __iomem *devm_ioremap_resource(struct device *dev,
 135                                     const struct resource *res)
 136 {
 137         resource_size_t size;
 138         void __iomem *dest_ptr;
 139
 140         BUG_ON(!dev);
 141
 142         if (!res || resource_type(res) != IORESOURCE_MEM) {
 143                 dev_err(dev, "invalid resource\n");
 144                 return IOMEM_ERR_PTR(-EINVAL);
 145         }
 146
 147         size = resource_size(res);
 148
 149         if (!devm_request_mem_region(dev, res->start, size, dev_name(dev))) {
 150                 dev_err(dev, "can't request region for resource %pR\n", res);
 151                 return IOMEM_ERR_PTR(-EBUSY);
 152         }
 153
 154         dest_ptr = devm_ioremap(dev, res->start, size);
 155         if (!dest_ptr) {
 156                 dev_err(dev, "ioremap failed for resource %pR\n", res);
 157                 devm_release_mem_region(dev, res->start, size);
 158                 dest_ptr = IOMEM_ERR_PTR(-ENOMEM);
 159         }
 160
 161         return dest_ptr;
 162 }
 163 EXPORT_SYMBOL(devm_ioremap_resource);
 164
 165 /*
 166  * devm_of_iomap - Requests a resource and maps the memory mapped IO
 167  *                 for a given device_node managed by a given device
 168  *
 169  * Checks that a resource is a valid memory region, requests the memory
 170  * region and ioremaps it. All operations are managed and will be undone
 171  * on driver detach of the device.
 172  *
 173  * This is to be used when a device requests/maps resources described
 174  * by other device tree nodes (children or otherwise).
 175  *
 176  * @dev:        The device "managing" the resource
 177  * @node:       The device-tree node where the resource resides
 178  * @index:      index of the MMIO range in the "reg" property
 179  * @size:       Returns the size of the resource (pass NULL if not needed)
 180  * Returns a pointer to the requested and mapped memory or an ERR_PTR() encoded
 181  * error code on failure. Usage example:
 182  *
 183  *      base = devm_of_iomap(&pdev->dev, node, 0, NULL);
 184  *      if (IS_ERR(base))
 185  *              return PTR_ERR(base);
 186  */
 187 void __iomem *devm_of_iomap(struct device *dev, struct device_node *node, int index,
 188                             resource_size_t *size)
 189 {
 190         struct resource res;
 191
 192         if (of_address_to_resource(node, index, &res))
 193                 return IOMEM_ERR_PTR(-EINVAL);
 194         if (size)
 195                 *size = resource_size(&res);
 196         return devm_ioremap_resource(dev, &res);
 197 }
 198 EXPORT_SYMBOL(devm_of_iomap);
 199
 200 #ifdef CONFIG_HAS_IOPORT_MAP
 201 /*
 202  * Generic iomap devres
 203  */
 204 static void devm_ioport_map_release(struct device *dev, void *res)
 205 {
 206         ioport_unmap(*(void __iomem **)res);
 207 }
 208
 209 static int devm_ioport_map_match(struct device *dev, void *res,
 210                                  void *match_data)
 211 {
 212         return *(void **)res == match_data;
 213 }
 214
 215 /**
 216  * devm_ioport_map - Managed ioport_map()
 217  * @dev: Generic device to map ioport for
 218  * @port: Port to map
 219  * @nr: Number of ports to map
 220  *
 221  * Managed ioport_map().  Map is automatically unmapped on driver
 222  * detach.
 223  */
 224 void __iomem *devm_ioport_map(struct device *dev, unsigned long port,
 225                                unsigned int nr)
 226 {
 227         void __iomem **ptr, *addr;
 228
 229         ptr = devres_alloc(devm_ioport_map_release, sizeof(*ptr), GFP_KERNEL);
 230         if (!ptr)
 231                 return NULL;
 232
 233         addr = ioport_map(port, nr);
 234         if (addr) {
 235                 *ptr = addr;
 236                 devres_add(dev, ptr);
 237         } else
 238                 devres_free(ptr);
 239
 240         return addr;
 241 }
 242 EXPORT_SYMBOL(devm_ioport_map);
 243
 244 /**
 245  * devm_ioport_unmap - Managed ioport_unmap()
 246  * @dev: Generic device to unmap for
 247  * @addr: Address to unmap
 248  *
 249  * Managed ioport_unmap().  @addr must have been mapped using
 250  * devm_ioport_map().
 251  */
 252 void devm_ioport_unmap(struct device *dev, void __iomem *addr)
 253 {
 254         ioport_unmap(addr);
 255         WARN_ON(devres_destroy(dev, devm_ioport_map_release,
 256                                devm_ioport_map_match, (__force void *)addr));
 257 }
 258 EXPORT_SYMBOL(devm_ioport_unmap);
 259 #endif /* CONFIG_HAS_IOPORT_MAP */
 260
 261 #ifdef CONFIG_PCI
 262 /*
 263  * PCI iomap devres
 264  */
 265 #define PCIM_IOMAP_MAX  PCI_ROM_RESOURCE
 266
 267 struct pcim_iomap_devres {
 268         void __iomem *table[PCIM_IOMAP_MAX];
 269 };
 270
 271 static void pcim_iomap_release(struct device *gendev, void *res)
 272 {
 273         struct pci_dev *dev = to_pci_dev(gendev);
 274         struct pcim_iomap_devres *this = res;
 275         int i;
 276
 277         for (i = 0; i < PCIM_IOMAP_MAX; i++)
 278                 if (this->table[i])
 279                         pci_iounmap(dev, this->table[i]);
 280 }
 281
 282 /**
 283  * pcim_iomap_table - access iomap allocation table
 284  * @pdev: PCI device to access iomap table for
 285  *
 286  * Access iomap allocation table for @dev.  If iomap table doesn't
 287  * exist and @pdev is managed, it will be allocated.  All iomaps
 288  * recorded in the iomap table are automatically unmapped on driver
 289  * detach.
 290  *
 291  * This function might sleep when the table is first allocated but can
 292  * be safely called without context and guaranteed to succed once
 293  * allocated.
 294  */
 295 void __iomem * const *pcim_iomap_table(struct pci_dev *pdev)
 296 {
 297         struct pcim_iomap_devres *dr, *new_dr;
 298
 299         dr = devres_find(&pdev->dev, pcim_iomap_release, NULL, NULL);
 300         if (dr)
 301                 return dr->table;
 302
 303         new_dr = devres_alloc(pcim_iomap_release, sizeof(*new_dr), GFP_KERNEL);
 304         if (!new_dr)
 305                 return NULL;
 306         dr = devres_get(&pdev->dev, new_dr, NULL, NULL);
 307         return dr->table;
 308 }
 309 EXPORT_SYMBOL(pcim_iomap_table);
 310
 311 /**
 312  * pcim_iomap - Managed pcim_iomap()
 313  * @pdev: PCI device to iomap for
 314  * @bar: BAR to iomap
 315  * @maxlen: Maximum length of iomap
 316  *
 317  * Managed pci_iomap().  Map is automatically unmapped on driver
 318  * detach.
 319  */
 320 void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen)
 321 {
 322         void __iomem **tbl;
 323
 324         BUG_ON(bar >= PCIM_IOMAP_MAX);
 325
 326         tbl = (void __iomem **)pcim_iomap_table(pdev);
 327         if (!tbl || tbl[bar])   /* duplicate mappings not allowed */
 328                 return NULL;
 329
 330         tbl[bar] = pci_iomap(pdev, bar, maxlen);
 331         return tbl[bar];
 332 }
 333 EXPORT_SYMBOL(pcim_iomap);
 334
 335 /**
 336  * pcim_iounmap - Managed pci_iounmap()
 337  * @pdev: PCI device to iounmap for
 338  * @addr: Address to unmap
 339  *
 340  * Managed pci_iounmap().  @addr must have been mapped using pcim_iomap().
 341  */
 342 void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr)
 343 {
 344         void __iomem **tbl;
 345         int i;
 346
 347         pci_iounmap(pdev, addr);
 348
 349         tbl = (void __iomem **)pcim_iomap_table(pdev);
 350         BUG_ON(!tbl);
 351
 352         for (i = 0; i < PCIM_IOMAP_MAX; i++)
 353                 if (tbl[i] == addr) {
 354                         tbl[i] = NULL;
 355                         return;
 356                 }
 357         WARN_ON(1);
 358 }
 359 EXPORT_SYMBOL(pcim_iounmap);
 360
 361 /**
 362  * pcim_iomap_regions - Request and iomap PCI BARs
 363  * @pdev: PCI device to map IO resources for
 364  * @mask: Mask of BARs to request and iomap
 365  * @name: Name used when requesting regions
 366  *
 367  * Request and iomap regions specified by @mask.
 368  */
 369 int pcim_iomap_regions(struct pci_dev *pdev, int mask, const char *name)
 370 {
 371         void __iomem * const *iomap;
 372         int i, rc;
 373
 374         iomap = pcim_iomap_table(pdev);
 375         if (!iomap)
 376                 return -ENOMEM;
 377
 378         for (i = 0; i < DEVICE_COUNT_RESOURCE; i++) {
 379                 unsigned long len;
 380
 381                 if (!(mask & (1 << i)))
 382                         continue;
 383
 384                 rc = -EINVAL;
 385                 len = pci_resource_len(pdev, i);
 386                 if (!len)
 387                         goto err_inval;
 388
 389                 rc = pci_request_region(pdev, i, name);
 390                 if (rc)
 391                         goto err_inval;
 392
 393                 rc = -ENOMEM;
 394                 if (!pcim_iomap(pdev, i, 0))
 395                         goto err_region;
 396         }
 397
 398         return 0;
 399
 400  err_region:
 401         pci_release_region(pdev, i);
 402  err_inval:
 403         while (--i >= 0) {
 404                 if (!(mask & (1 << i)))
 405                         continue;
 406                 pcim_iounmap(pdev, iomap[i]);
 407                 pci_release_region(pdev, i);
 408         }
 409
 410         return rc;
 411 }
 412 EXPORT_SYMBOL(pcim_iomap_regions);
 413
 414 /**
 415  * pcim_iomap_regions_request_all - Request all BARs and iomap specified ones
 416  * @pdev: PCI device to map IO resources for
 417  * @mask: Mask of BARs to iomap
 418  * @name: Name used when requesting regions
 419  *
 420  * Request all PCI BARs and iomap regions specified by @mask.
 421  */
 422 int pcim_iomap_regions_request_all(struct pci_dev *pdev, int mask,
 423                                    const char *name)
 424 {
 425         int request_mask = ((1 << 6) - 1) & ~mask;
 426         int rc;
 427
 428         rc = pci_request_selected_regions(pdev, request_mask, name);
 429         if (rc)
 430                 return rc;
 431
 432         rc = pcim_iomap_regions(pdev, mask, name);
 433         if (rc)
 434                 pci_release_selected_regions(pdev, request_mask);
 435         return rc;
 436 }
 437 EXPORT_SYMBOL(pcim_iomap_regions_request_all);
 438
 439 /**
 440  * pcim_iounmap_regions - Unmap and release PCI BARs
 441  * @pdev: PCI device to map IO resources for
 442  * @mask: Mask of BARs to unmap and release
 443  *
 444  * Unmap and release regions specified by @mask.
 445  */
 446 void pcim_iounmap_regions(struct pci_dev *pdev, int mask)
 447 {
 448         void __iomem * const *iomap;
 449         int i;
 450
 451         iomap = pcim_iomap_table(pdev);
 452         if (!iomap)
 453                 return;
 454
 455         for (i = 0; i < PCIM_IOMAP_MAX; i++) {
 456                 if (!(mask & (1 << i)))
 457                         continue;
 458
 459                 pcim_iounmap(pdev, iomap[i]);
 460                 pci_release_region(pdev, i);
 461         }
 462 }
 463 EXPORT_SYMBOL(pcim_iounmap_regions);
 464 #endif /* CONFIG_PCI */