linux-kernel - Re: [PATCH v1 1/1] Documentation: PM: Discourage use of deprecated macros

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <CAJZ5v0h20btyh41vHsXgMDhDrhPGL-CJJNUjzLhgj7Szj3y6Qg@mail.gmail.com>
Date: Wed, 4 Sep 2024 14:38:52 +0200
From: "Rafael J. Wysocki" <rafael@...nel.org>
To: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>
Cc: "Rafael J. Wysocki" <rafael.j.wysocki@...el.com>, Sakari Ailus <sakari.ailus@...ux.intel.com>, 
	linux-pm@...r.kernel.org, linux-kernel@...r.kernel.org, 
	"Rafael J. Wysocki" <rafael@...nel.org>, Len Brown <len.brown@...el.com>, Pavel Machek <pavel@....cz>
Subject: Re: [PATCH v1 1/1] Documentation: PM: Discourage use of deprecated macros

On Tue, Sep 3, 2024 at 7:25 PM Andy Shevchenko
<andriy.shevchenko@...ux.intel.com> wrote:
>
> The Documentation refers to some deprecated macros.
> Update those parts accordingly.
>
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>
> ---
>  Documentation/power/pci.rst        | 11 +++++------
>  Documentation/power/runtime_pm.rst |  4 ++--
>  2 files changed, 7 insertions(+), 8 deletions(-)
>
> diff --git a/Documentation/power/pci.rst b/Documentation/power/pci.rst
> index e2c1fb8a569a..9ebecb7b00b2 100644
> --- a/Documentation/power/pci.rst
> +++ b/Documentation/power/pci.rst
> @@ -979,18 +979,17 @@ subsections can be defined as a separate function, it often is convenient to
>  point two or more members of struct dev_pm_ops to the same routine.  There are
>  a few convenience macros that can be used for this purpose.
>
> -The SIMPLE_DEV_PM_OPS macro declares a struct dev_pm_ops object with one
> +The DEFINE_SIMPLE_DEV_PM_OPS() declares a struct dev_pm_ops object with one
>  suspend routine pointed to by the .suspend(), .freeze(), and .poweroff()
>  members and one resume routine pointed to by the .resume(), .thaw(), and
>  .restore() members.  The other function pointers in this struct dev_pm_ops are
>  unset.
>
> -The UNIVERSAL_DEV_PM_OPS macro is similar to SIMPLE_DEV_PM_OPS, but it
> -additionally sets the .runtime_resume() pointer to the same value as
> -.resume() (and .thaw(), and .restore()) and the .runtime_suspend() pointer to
> -the same value as .suspend() (and .freeze() and .poweroff()).
> +The DEFINE_RUNTIME_DEV_PM_OPS() is similar to DEFINE_SIMPLE_DEV_PM_OPS(), but it
> +additionally sets the .runtime_resume() pointer to pm_runtime_force_resume()
> +and the .runtime_suspend() pointer to pm_runtime_force_suspend().
>
> -The SET_SYSTEM_SLEEP_PM_OPS can be used inside of a declaration of struct
> +The SYSTEM_SLEEP_PM_OPS() can be used inside of a declaration of struct
>  dev_pm_ops to indicate that one suspend routine is to be pointed to by the
>  .suspend(), .freeze(), and .poweroff() members and one resume routine is to
>  be pointed to by the .resume(), .thaw(), and .restore() members.
> diff --git a/Documentation/power/runtime_pm.rst b/Documentation/power/runtime_pm.rst
> index 5c4e730f38d0..53d1996460ab 100644
> --- a/Documentation/power/runtime_pm.rst
> +++ b/Documentation/power/runtime_pm.rst
> @@ -811,8 +811,8 @@ subsystem-level dev_pm_ops structure.
>
>  Device drivers that wish to use the same function as a system suspend, freeze,
>  poweroff and runtime suspend callback, and similarly for system resume, thaw,
> -restore, and runtime resume, can achieve this with the help of the
> -UNIVERSAL_DEV_PM_OPS macro defined in include/linux/pm.h (possibly setting its
> +restore, and runtime resume, can achieve similar behaviour with the help of the
> +DEFINE_RUNTIME_DEV_PM_OPS() defined in include/linux/pm_runtime.h (possibly setting its
>  last argument to NULL).
>
>  8. "No-Callback" Devices
> --

Applied as 6.12 material, thanks!