linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Philipp Stanner <phasta@kernel.org>
To: "Jonathan Corbet" <corbet@lwn.net>,
	"Bjorn Helgaas" <bhelgaas@google.com>,
	"Philipp Stanner" <phasta@kernel.org>,
	"Mark Brown" <broonie@kernel.org>,
	"David Lechner" <dlechner@baylibre.com>,
	"Andy Shevchenko" <andriy.shevchenko@linux.intel.com>,
	"Zijun Hu" <quic_zijuhu@quicinc.com>,
	"Yang Yingliang" <yangyingliang@huawei.com>,
	"Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
	"Krzysztof Wilczyński" <kw@linux.com>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	linux-pci@vger.kernel.org
Subject: [PATCH v2 2/6] Documentation/driver-api: Update pcim_enable_device()
Date: Fri, 16 May 2025 19:41:37 +0200	[thread overview]
Message-ID: <20250516174141.42527-3-phasta@kernel.org> (raw)
In-Reply-To: <20250516174141.42527-1-phasta@kernel.org>

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


  parent reply	other threads:[~2025-05-16 17:41 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-05-16 17:41 [PATCH v2 0/6] PCI: Remove hybrid-devres region requests Philipp Stanner
2025-05-16 17:41 ` [PATCH v2 1/6] PCI: Remove hybrid devres nature from request functions Philipp Stanner
2025-05-16 22:58   ` Sathyanarayanan Kuppuswamy
2025-05-16 23:14     ` Sathyanarayanan Kuppuswamy
2025-05-19  7:33     ` Philipp Stanner
2025-05-16 17:41 ` Philipp Stanner [this message]
2025-05-16 19:27   ` [PATCH v2 2/6] Documentation/driver-api: Update pcim_enable_device() Randy Dunlap
2025-05-16 21:02   ` ALOK TIWARI
2025-05-16 17:41 ` [PATCH v2 3/6] PCI: Remove pcim_request_region_exclusive() Philipp Stanner
2025-05-16 17:41 ` [PATCH v2 4/6] PCI: Remove request_flags relict from devres Philipp Stanner
2025-05-16 17:41 ` [PATCH v2 5/6] PCI: Remove redundant set of request funcs Philipp Stanner
2025-05-16 17:41 ` [PATCH v2 6/6] PCI: Remove hybrid-devres hazzard warnings from doc Philipp Stanner
2025-05-16 18:25 ` [PATCH v2 0/6] PCI: Remove hybrid-devres region requests Krzysztof Wilczyński
2025-05-16 23:14 ` Sathyanarayanan Kuppuswamy
2025-05-17 16:33   ` Andy Shevchenko
2025-05-17 17:13     ` Sathyanarayanan Kuppuswamy

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250516174141.42527-3-phasta@kernel.org \
    --to=phasta@kernel.org \
    --cc=andriy.shevchenko@linux.intel.com \
    --cc=bhelgaas@google.com \
    --cc=broonie@kernel.org \
    --cc=corbet@lwn.net \
    --cc=dlechner@baylibre.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=kw@linux.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pci@vger.kernel.org \
    --cc=quic_zijuhu@quicinc.com \
    --cc=yangyingliang@huawei.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).