[resend, PATCH v1 1/1] PCI: Update the devres documentation regarding to pcim_*()

[resend, PATCH v1 1/1] PCI: Update the devres documentation regarding to pcim_*()

[Andy Shevchenko]

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>
---
 Documentation/driver-api/driver-model/devres.rst | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

diff --git a/Documentation/driver-api/driver-model/devres.rst b/Documentation/driver-api/driver-model/devres.rst
index 8be086b3f829..c5f99d834ec5 100644
--- a/Documentation/driver-api/driver-model/devres.rst
+++ b/Documentation/driver-api/driver-model/devres.rst
@@ -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()
-- 
2.40.0.1.gaa8946217a0b

Re: [resend, PATCH v1 1/1] PCI: Update the devres documentation regarding to pcim_*()

[Bjorn Helgaas]

On Fri, Oct 06, 2023 at 06:06:34PM +0300, Andy Shevchenko wrote:
> 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>

Looks good.

Acked-by: Bjorn Helgaas <bhelgaas@google.com>

> ---
>  Documentation/driver-api/driver-model/devres.rst | 14 ++++++++++----
>  1 file changed, 10 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/driver-api/driver-model/devres.rst b/Documentation/driver-api/driver-model/devres.rst
> index 8be086b3f829..c5f99d834ec5 100644
> --- a/Documentation/driver-api/driver-model/devres.rst
> +++ b/Documentation/driver-api/driver-model/devres.rst
> @@ -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()
> -- 
> 2.40.0.1.gaa8946217a0b
> 

Re: [resend, PATCH v1 1/1] PCI: Update the devres documentation regarding to pcim_*()

[Jonathan Corbet]

Andy Shevchenko <andriy.shevchenko@linux.intel.com> writes:

> 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>
> ---
>  Documentation/driver-api/driver-model/devres.rst | 14 ++++++++++----
>  1 file changed, 10 insertions(+), 4 deletions(-)

Applied, thanks.

jon