Documentation/driver-api: Update pcim_enable_device()

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@kernel.org>
Signed-off-by: Krzysztof Wilczyński <kwilczynski@kernel.org>
Reviewed-by: Kuppuswamy Sathyanarayanan <sathyanarayanan.kuppuswamy@linux.intel.com>
Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Link: https://lore.kernel.org/r/20250519112959.25487-4-phasta@kernel.org

diff --git a/Documentation/driver-api/driver-model/devres.rst b/Documentation/driver-api/driver-model/devres.rst
index 601f1a74d34dacf27e5d2a258f23c6c00e68221f..3d56f94ac2eef003eee54c0ce80234122ff2931f 100644 (file)
--- 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, the PCI device gets disabled automatically on driver detach
   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