]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
PCI: Update the devres documentation regarding to pcim_*()
authorAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Fri, 6 Oct 2023 15:06:34 +0000 (18:06 +0300)
committerJonathan Corbet <corbet@lwn.net>
Tue, 10 Oct 2023 19:35:55 +0000 (13:35 -0600)
There were many changes to PCI core in scope of managed resources APIs.
Update documentation to list the current state of affairs.

Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Acked-by: Bjorn Helgaas <bhelgaas@google.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20231006150634.3444251-1-andriy.shevchenko@linux.intel.com
Documentation/driver-api/driver-model/devres.rst

index 8be086b3f8297a0549ba128c3ede0ff76cc0da60..c5f99d834ec56a5e9fff9d10b1bcd8c98c342525 100644 (file)
@@ -322,10 +322,8 @@ IOMAP
   devm_platform_ioremap_resource_byname()
   devm_platform_get_and_ioremap_resource()
   devm_iounmap()
-  pcim_iomap()
-  pcim_iomap_regions() : do request_region() and iomap() on multiple BARs
-  pcim_iomap_table()   : array of mapped addresses indexed by BAR
-  pcim_iounmap()
+
+  Note: For the PCI devices the specific pcim_*() functions may be used, see below.
 
 IRQ
   devm_free_irq()
@@ -392,8 +390,16 @@ PCI
   devm_pci_alloc_host_bridge()  : managed PCI host bridge allocation
   devm_pci_remap_cfgspace()    : ioremap PCI configuration space
   devm_pci_remap_cfg_resource()        : ioremap PCI configuration space resource
+
   pcim_enable_device()         : after success, all PCI ops become managed
+  pcim_iomap()                 : do iomap() on a single BAR
+  pcim_iomap_regions()         : do request_region() and iomap() on multiple BARs
+  pcim_iomap_regions_request_all() : do request_region() on all and iomap() on multiple BARs
+  pcim_iomap_table()           : array of mapped addresses indexed by BAR
+  pcim_iounmap()               : do iounmap() on a single BAR
+  pcim_iounmap_regions()       : do iounmap() and release_region() on multiple BARs
   pcim_pin_device()            : keep PCI device enabled after release
+  pcim_set_mwi()               : enable Memory-Write-Invalidate PCI transaction
 
 PHY
   devm_usb_get_phy()