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