Commit 5ccba71f authored by Andy Shevchenko's avatar Andy Shevchenko Committed by Jonathan Corbet
Browse files

PCI: Update the devres documentation regarding to pcim_*() 



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: default avatarAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Acked-by: default avatarBjorn Helgaas <bhelgaas@google.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20231006150634.3444251-1-andriy.shevchenko@linux.intel.com
parent d17ff438

Documentation/driver-api/driver-model/devres.rst

+10 −4
Original line number Diff line number Diff line
@@ -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()