lib/devres.c

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