[PATCH v3 6/6] PCI: Remove hybrid-devres hazzard warnings from doc

Philipp Stanner posted 6 patches 7 months ago
There is a newer version of this series
[PATCH v3 6/6] PCI: Remove hybrid-devres hazzard warnings from doc
Posted by Philipp Stanner 7 months ago
pci/iomap.c still contains warnings about those functions not behaving
in a managed manner if pcim_enable_device() was called. Since all hybrid
behavior that users could know about has been removed by now, those
explicit warnings are no longer necessary.

Remove the hybrid-devres warnings from the docstrings.

Signed-off-by: Philipp Stanner <phasta@kernel.org>
Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Reviewed-by: Kuppuswamy Sathyanarayanan <sathyanarayanan.kuppuswamy@linux.intel.com>
---
 drivers/pci/iomap.c | 16 ----------------
 1 file changed, 16 deletions(-)

diff --git a/drivers/pci/iomap.c b/drivers/pci/iomap.c
index fe706ed946df..ea86c282a386 100644
--- a/drivers/pci/iomap.c
+++ b/drivers/pci/iomap.c
@@ -25,10 +25,6 @@
  *
  * @maxlen specifies the maximum length to map. If you want to get access to
  * the complete BAR from offset to the end, pass %0 here.
- *
- * NOTE:
- * This function is never managed, even if you initialized with
- * pcim_enable_device().
  * */
 void __iomem *pci_iomap_range(struct pci_dev *dev,
 			      int bar,
@@ -76,10 +72,6 @@ EXPORT_SYMBOL(pci_iomap_range);
  *
  * @maxlen specifies the maximum length to map. If you want to get access to
  * the complete BAR from offset to the end, pass %0 here.
- *
- * NOTE:
- * This function is never managed, even if you initialized with
- * pcim_enable_device().
  * */
 void __iomem *pci_iomap_wc_range(struct pci_dev *dev,
 				 int bar,
@@ -127,10 +119,6 @@ EXPORT_SYMBOL_GPL(pci_iomap_wc_range);
  *
  * @maxlen specifies the maximum length to map. If you want to get access to
  * the complete BAR without checking for its length first, pass %0 here.
- *
- * NOTE:
- * This function is never managed, even if you initialized with
- * pcim_enable_device(). If you need automatic cleanup, use pcim_iomap().
  * */
 void __iomem *pci_iomap(struct pci_dev *dev, int bar, unsigned long maxlen)
 {
@@ -152,10 +140,6 @@ EXPORT_SYMBOL(pci_iomap);
  *
  * @maxlen specifies the maximum length to map. If you want to get access to
  * the complete BAR without checking for its length first, pass %0 here.
- *
- * NOTE:
- * This function is never managed, even if you initialized with
- * pcim_enable_device().
  * */
 void __iomem *pci_iomap_wc(struct pci_dev *dev, int bar, unsigned long maxlen)
 {
-- 
2.49.0
Re: [PATCH v3 6/6] PCI: Remove hybrid-devres hazzard warnings from doc
Posted by Bjorn Helgaas 7 months ago
s/hazzard/hazard/ (in subject)

On Mon, May 19, 2025 at 01:30:00PM +0200, Philipp Stanner wrote:
> pci/iomap.c still contains warnings about those functions not behaving
> in a managed manner if pcim_enable_device() was called. Since all hybrid
> behavior that users could know about has been removed by now, those
> explicit warnings are no longer necessary.
> 
> Remove the hybrid-devres warnings from the docstrings.
Re: [PATCH v3 6/6] PCI: Remove hybrid-devres hazzard warnings from doc
Posted by Krzysztof Wilczyński 7 months ago
Hello,

> s/hazzard/hazard/ (in subject)

Fixed when applying.  Thank you!

	Krzysztof