Skip to contentSkip to conversation

Documentation: PM: Update platform_pci_wakeup_init() reference

PATCH Applied Bjorn Helgaas 3 participants 4 messages Mar 25, 2024 – Mar 27, 2024 Suspend to RAM

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Documentation: PM: Update platform_pci_wakeup_init() reference

From: Bjorn Helgaas <[email protected]>

platform_pci_wakeup_init() was removed by d2e5f0c16ad6 ("ACPI / PCI: Rework the setup and cleanup of device wakeup") but was still mentioned in the documentation.

Update the doc to refer to pci_acpi_setup(), which does the equivalent work.

---

pci_acpi_setup() is a firmware-specific wart in this otherwise generic paragraph, so maybe there's some better way to express this?

 Documentation/power/pci.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/power/pci.rst +1 -1
index 12070320307e..e2c1fb8a569a 100644
@@ -333,7 +333,7 @@ struct pci_dev.
 The PCI subsystem's first task related to device power management is to
 prepare the device for power management and initialize the fields of struct
 pci_dev used for this purpose.  This happens in two functions defined in
-drivers/pci/pci.c, pci_pm_init() and platform_pci_wakeup_init().
+drivers/pci/, pci_pm_init() and pci_acpi_setup().
 
 The first of these functions checks if the device supports native PCI PM
 and if that's the case the offset of its power management capability structure
Signature · 1 line
2.34.1
Reviewed-by on v1 1/1
#1 lore raw

Hi,

Quoted 9 lines · Bjorn Helgaas

From: Bjorn Helgaas <[email protected]>

platform_pci_wakeup_init() was removed by d2e5f0c16ad6 ("ACPI / PCI: Rework the setup and cleanup of device wakeup") but was still mentioned in the documentation.

Update the doc to refer to pci_acpi_setup(), which does the equivalent work.

Thanks! Documentation does go unnoticed sometimes.

Quoted 14 lines

---

pci_acpi_setup() is a firmware-specific wart in this otherwise generic paragraph, so maybe there's some better way to express this?

 Documentation/power/pci.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/power/pci.rst +0 -0
index 12070320307e..e2c1fb8a569a 100644

Documentation/power/pci.rst struct pci_dev. · line 336

Quoted 5 lines
Documentation/power/pci.rst +1 -1
@@ -333,7 +333,7 @@ struct pci_dev.
 The PCI subsystem's first task related to device power management is to
 prepare the device for power management and initialize the fields of struct
 pci_dev used for this purpose.  This happens in two functions defined in
-drivers/pci/pci.c, pci_pm_init() and platform_pci_wakeup_init().
+drivers/pci/, pci_pm_init() and pci_acpi_setup().
Signature · 2 lines
Best regards,
Dhruva
maintainer Applied
#2 lore raw
In reply to Bjorn Helgaas
Quoted 24 lines · Bjorn Helgaas

From: Bjorn Helgaas <[email protected]>

platform_pci_wakeup_init() was removed by d2e5f0c16ad6 ("ACPI / PCI: Rework the setup and cleanup of device wakeup") but was still mentioned in the documentation.

Update the doc to refer to pci_acpi_setup(), which does the equivalent work.

---

pci_acpi_setup() is a firmware-specific wart in this otherwise generic paragraph, so maybe there's some better way to express this?

 Documentation/power/pci.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/power/pci.rst +0 -0
index 12070320307e..e2c1fb8a569a 100644

Documentation/power/pci.rst struct pci_dev.

Quoted 9 lines
Documentation/power/pci.rst +1 -2
@@ -333,7 +333,7 @@ struct pci_dev.
 The PCI subsystem's first task related to device power management is to
 prepare the device for power management and initialize the fields of struct
 pci_dev used for this purpose.  This happens in two functions defined in
-drivers/pci/pci.c, pci_pm_init() and platform_pci_wakeup_init().
+drivers/pci/, pci_pm_init() and pci_acpi_setup().
 
 The first of these functions checks if the device supports native PCI PM
 and if that's the case the offset of its power management capability structure
--

Applied as 6.10 material, or if you'd rather take it to the PCI tree, please let me know.

#3 lore raw
Quoted 31 lines · Rafael J. Wysocki
Quoted 30 lines · Bjorn Helgaas

From: Bjorn Helgaas <[email protected]>

platform_pci_wakeup_init() was removed by d2e5f0c16ad6 ("ACPI / PCI: Rework the setup and cleanup of device wakeup") but was still mentioned in the documentation.

Update the doc to refer to pci_acpi_setup(), which does the equivalent work.

---

pci_acpi_setup() is a firmware-specific wart in this otherwise generic paragraph, so maybe there's some better way to express this?

 Documentation/power/pci.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/power/pci.rst +1 -1
index 12070320307e..e2c1fb8a569a 100644
@@ -333,7 +333,7 @@ struct pci_dev.
 The PCI subsystem's first task related to device power management is to
 prepare the device for power management and initialize the fields of struct
 pci_dev used for this purpose.  This happens in two functions defined in
-drivers/pci/pci.c, pci_pm_init() and platform_pci_wakeup_init().
+drivers/pci/, pci_pm_init() and pci_acpi_setup().
 
Quoted 6 lines

Documentation/power/pci.rst struct pci_dev.

Quoted 3 lines
Documentation/power/pci.rst +0 -1
 The first of these functions checks if the device supports native PCI PM
 and if that's the case the offset of its power management capability structure
--

Applied as 6.10 material, or if you'd rather take it to the PCI tree, please let me know.

Thanks, your tree is fine!

Bjorn