Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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: 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

authored by

Andy Shevchenko and committed by
Jonathan Corbet
5ccba71f d17ff438

+10 -4
+10 -4
Documentation/driver-api/driver-model/devres.rst
··· 322 322 devm_platform_ioremap_resource_byname() 323 323 devm_platform_get_and_ioremap_resource() 324 324 devm_iounmap() 325 - pcim_iomap() 326 - pcim_iomap_regions() : do request_region() and iomap() on multiple BARs 327 - pcim_iomap_table() : array of mapped addresses indexed by BAR 328 - pcim_iounmap() 325 + 326 + Note: For the PCI devices the specific pcim_*() functions may be used, see below. 329 327 330 328 IRQ 331 329 devm_free_irq() ··· 390 392 devm_pci_alloc_host_bridge() : managed PCI host bridge allocation 391 393 devm_pci_remap_cfgspace() : ioremap PCI configuration space 392 394 devm_pci_remap_cfg_resource() : ioremap PCI configuration space resource 395 + 393 396 pcim_enable_device() : after success, all PCI ops become managed 397 + pcim_iomap() : do iomap() on a single BAR 398 + pcim_iomap_regions() : do request_region() and iomap() on multiple BARs 399 + pcim_iomap_regions_request_all() : do request_region() on all and iomap() on multiple BARs 400 + pcim_iomap_table() : array of mapped addresses indexed by BAR 401 + pcim_iounmap() : do iounmap() on a single BAR 402 + pcim_iounmap_regions() : do iounmap() and release_region() on multiple BARs 394 403 pcim_pin_device() : keep PCI device enabled after release 404 + pcim_set_mwi() : enable Memory-Write-Invalidate PCI transaction 395 405 396 406 PHY 397 407 devm_usb_get_phy()