linux-kernel - Re: [PATCH v2 2/6] Documentation/driver-api: Update pcim_enable

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <393bdc27-a6a3-416c-93e9-d2a9ee9fb465@infradead.org>
Date: Fri, 16 May 2025 12:27:40 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Philipp Stanner <phasta@...nel.org>, Jonathan Corbet <corbet@....net>,
 Bjorn Helgaas <bhelgaas@...gle.com>, Mark Brown <broonie@...nel.org>,
 David Lechner <dlechner@...libre.com>,
 Andy Shevchenko <andriy.shevchenko@...ux.intel.com>,
 Zijun Hu <quic_zijuhu@...cinc.com>, Yang Yingliang
 <yangyingliang@...wei.com>, Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
 Krzysztof Wilczyński <kw@...ux.com>
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
 linux-pci@...r.kernel.org
Subject: Re: [PATCH v2 2/6] Documentation/driver-api: Update
 pcim_enable_device()

Hi,

On 5/16/25 10:41 AM, Philipp Stanner wrote:
> pcim_enable_device() is not related anymore to switching the mode of
> operation of any functions. It merely sets up a devres callback for
> automatically disabling the PCI device on driver detach.
> 
> Adjust the function's documentation.
> 
> Signed-off-by: Philipp Stanner <phasta@...nel.org>
> ---
>  Documentation/driver-api/driver-model/devres.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/driver-api/driver-model/devres.rst b/Documentation/driver-api/driver-model/devres.rst
> index d75728eb05f8..9443911c4742 100644
> --- a/Documentation/driver-api/driver-model/devres.rst
> +++ b/Documentation/driver-api/driver-model/devres.rst
> @@ -391,7 +391,7 @@ PCI
>    devm_pci_remap_cfgspace()	: ioremap PCI configuration space
>    devm_pci_remap_cfg_resource()	: ioremap PCI configuration space resource
>  
> -  pcim_enable_device()		: after success, some PCI ops become managed
> +  pcim_enable_device()		: after success, PCI dev gets deactivated automatically

I think that the patch description has a better comment that could be put here. ^^^^^

>    pcim_iomap()			: do iomap() on a single BAR
>    pcim_iomap_regions()		: do request_region() and iomap() on multiple BARs
>    pcim_iomap_table()		: array of mapped addresses indexed by BAR

-- 
~Randy