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
   8 void devm_ioremap_release(struct device *dev, void *res)
   9 {
  10         iounmap(*(void __iomem **)res);
  11 }
  12
  13 static 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
  21  * @offset: Resource address to map
  22  * @size: Size of map
  23  *
  24  * Managed ioremap().  Map is automatically unmapped on driver detach.
  25  */
  26 void __iomem *devm_ioremap(struct device *dev, resource_size_t offset,
  27                            resource_size_t size)
  28 {
  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 }
  44 EXPORT_SYMBOL(devm_ioremap);
  45
  46 /**
  47  * devm_ioremap_nocache - Managed ioremap_nocache()
  48  * @dev: Generic device to remap IO address for
  49  * @offset: Resource address to map
  50  * @size: Size of map
  51  *
  52  * Managed ioremap_nocache().  Map is automatically unmapped on driver
  53  * detach.
  54  */
  55 void __iomem *devm_ioremap_nocache(struct device *dev, resource_size_t offset,
  56                                    resource_size_t size)
  57 {
  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 }
  73 EXPORT_SYMBOL(devm_ioremap_nocache);
  74
  75 /**
  76  * devm_ioremap_wc - Managed ioremap_wc()
  77  * @dev: Generic device to remap IO address for
  78  * @offset: Resource address to map
  79  * @size: Size of map
  80  *
  81  * Managed ioremap_wc().  Map is automatically unmapped on driver detach.
  82  */
  83 void __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 }
 101 EXPORT_SYMBOL(devm_ioremap_wc);
 102
 103 /**
 104  * 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  */
 110 void devm_iounmap(struct device *dev, void __iomem *addr)
 111 {
 112         WARN_ON(devres_destroy(dev, devm_ioremap_release, devm_ioremap_match,
 113                                (__force void *)addr));
 114         iounmap(addr);
 115 }
 116 EXPORT_SYMBOL(devm_iounmap);
 117
 118 /**
 119  * 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  *
 123  * 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.
 126  *
 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  */
 135 void __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");
 145                 return IOMEM_ERR_PTR(-EINVAL);
 146         }
 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);
 153                 return IOMEM_ERR_PTR(-EBUSY);
 154         }
 155
 156         dest_ptr = devm_ioremap(dev, res->start, size);
 157         if (!dest_ptr) {
 158                 dev_err(dev, "ioremap failed for resource %pR\n", res);
 159                 devm_release_mem_region(dev, res->start, size);
 160                 dest_ptr = IOMEM_ERR_PTR(-ENOMEM);
 161         }
 162
 163         return dest_ptr;
 164 }
 165 EXPORT_SYMBOL(devm_ioremap_resource);
 166
 167 #ifdef CONFIG_HAS_IOPORT_MAP
 168 /*
 169  * Generic iomap devres
 170  */
 171 static void devm_ioport_map_release(struct device *dev, void *res)
 172 {
 173         ioport_unmap(*(void __iomem **)res);
 174 }
 175
 176 static 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  */
 191 void __iomem *devm_ioport_map(struct device *dev, unsigned long port,
 192                                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 }
 209 EXPORT_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  */
 219 void devm_ioport_unmap(struct device *dev, void __iomem *addr)
 220 {
 221         ioport_unmap(addr);
 222         WARN_ON(devres_destroy(dev, devm_ioport_map_release,
 223                                devm_ioport_map_match, (__force void *)addr));
 224 }
 225 EXPORT_SYMBOL(devm_ioport_unmap);
 226 #endif /* CONFIG_HAS_IOPORT_MAP */
 227
 228 #ifdef CONFIG_PCI
 229 /*
 230  * PCI iomap devres
 231  */
 232 #define PCIM_IOMAP_MAX  PCI_ROM_RESOURCE
 233
 234 struct pcim_iomap_devres {
 235         void __iomem *table[PCIM_IOMAP_MAX];
 236 };
 237
 238 static void pcim_iomap_release(struct device *gendev, void *res)
 239 {
 240         struct pci_dev *dev = to_pci_dev(gendev);
 241         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  */
 262 void __iomem * const *pcim_iomap_table(struct pci_dev *pdev)
 263 {
 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 }
 276 EXPORT_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  */
 287 void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen)
 288 {
 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 }
 300 EXPORT_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  */
 309 void 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 }
 326 EXPORT_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  */
 336 int pcim_iomap_regions(struct pci_dev *pdev, int mask, const char *name)
 337 {
 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)
 358                         goto err_inval;
 359
 360                 rc = -ENOMEM;
 361                 if (!pcim_iomap(pdev, i, 0))
 362                         goto err_region;
 363         }
 364
 365         return 0;
 366
 367  err_region:
 368         pci_release_region(pdev, i);
 369  err_inval:
 370         while (--i >= 0) {
 371                 if (!(mask & (1 << i)))
 372                         continue;
 373                 pcim_iounmap(pdev, iomap[i]);
 374                 pci_release_region(pdev, i);
 375         }
 376
 377         return rc;
 378 }
 379 EXPORT_SYMBOL(pcim_iomap_regions);
 380
 381 /**
 382  * 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  */
 389 int pcim_iomap_regions_request_all(struct pci_dev *pdev, int mask,
 390                                    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 }
 404 EXPORT_SYMBOL(pcim_iomap_regions_request_all);
 405
 406 /**
 407  * 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  *
 411  * Unmap and release regions specified by @mask.
 412  */
 413 void pcim_iounmap_regions(struct pci_dev *pdev, int mask)
 414 {
 415         void __iomem * const *iomap;
 416         int i;
 417
 418         iomap = pcim_iomap_table(pdev);
 419         if (!iomap)
 420                 return;
 421
 422         for (i = 0; i < PCIM_IOMAP_MAX; i++) {
 423                 if (!(mask & (1 << i)))
 424                         continue;
 425
 426                 pcim_iounmap(pdev, iomap[i]);
 427                 pci_release_region(pdev, i);
 428         }
 429 }
 430 EXPORT_SYMBOL(pcim_iounmap_regions);
 431 #endif /* CONFIG_PCI */