[PATCH] Documentation: PM: Update platform_pci_wakeup_init() reference

[PATCH] Documentation: PM: Update platform_pci_wakeup_init() reference

[Bjorn Helgaas]

From: Bjorn Helgaas <bhelgaas@google.com>

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.

Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
---

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(-)

diff --git a/Documentation/power/pci.rst b/Documentation/power/pci.rst
index 12070320307e..e2c1fb8a569a 100644
--- a/Documentation/power/pci.rst
+++ b/Documentation/power/pci.rst
@@ -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
-- 
2.34.1

Re: [PATCH] Documentation: PM: Update platform_pci_wakeup_init() reference

[Dhruva Gole]

Hi,

On Mar 25, 2024 at 17:09:53 -0500, Bjorn Helgaas wrote:
> From: Bjorn Helgaas <bhelgaas@google.com>
> 
> 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.

> Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
> ---
> 
> 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(-)
> 
> diff --git a/Documentation/power/pci.rst b/Documentation/power/pci.rst
> index 12070320307e..e2c1fb8a569a 100644
> --- a/Documentation/power/pci.rst
> +++ b/Documentation/power/pci.rst
> @@ -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().

Reviewed-by: Dhruva Gole <d-gole@ti.com>


-- 
Best regards,
Dhruva

Re: [PATCH] Documentation: PM: Update platform_pci_wakeup_init() reference

[Rafael J. Wysocki]

On Mon, Mar 25, 2024 at 11:11 PM Bjorn Helgaas <helgaas@kernel.org> wrote:
>
> From: Bjorn Helgaas <bhelgaas@google.com>
>
> 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.
>
> Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
> ---
>
> 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(-)
>
> diff --git a/Documentation/power/pci.rst b/Documentation/power/pci.rst
> index 12070320307e..e2c1fb8a569a 100644
> --- a/Documentation/power/pci.rst
> +++ b/Documentation/power/pci.rst
> @@ -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.

Re: [PATCH] Documentation: PM: Update platform_pci_wakeup_init() reference

[Bjorn Helgaas]

On Wed, Mar 27, 2024 at 04:23:41PM +0100, Rafael J. Wysocki wrote:
> On Mon, Mar 25, 2024 at 11:11 PM Bjorn Helgaas <helgaas@kernel.org> wrote:
> >
> > From: Bjorn Helgaas <bhelgaas@google.com>
> >
> > 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.
> >
> > Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
> > ---
> >
> > 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(-)
> >
> > diff --git a/Documentation/power/pci.rst b/Documentation/power/pci.rst
> > index 12070320307e..e2c1fb8a569a 100644
> > --- a/Documentation/power/pci.rst
> > +++ b/Documentation/power/pci.rst
> > @@ -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.

Thanks, your tree is fine!

Bjorn