Re: [PATCH 4/8] PM: runtime: Add DEFINE_RUNTIME_DEV_PM_OPS() macro

[Jonathan Cameron <Jonathan.Cameron@Huawei.com>]

On Tue, 4 Jan 2022 21:42:10 +0000
Paul Cercueil <paul@crapouillou.net> wrote:

> A lot of drivers create a dev_pm_ops struct with the system sleep
> suspend/resume callbacks set to pm_runtime_force_suspend() and
> pm_runtime_force_resume().
> 
> These drivers can now use the DEFINE_RUNTIME_DEV_PM_OPS() macro, which
> will use pm_runtime_force_{suspend,resume}() as the system sleep
> callbacks, while having the same dead code removal characteristic that
> is already provided by DEFINE_SIMPLE_DEV_PM_OPS().
> 
> Signed-off-by: Paul Cercueil <paul@crapouillou.net>

I guess this is common enough to bother with a macro.

Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

> ---
>  include/linux/pm.h         |  3 +++
>  include/linux/pm_runtime.h | 14 ++++++++++++++
>  2 files changed, 17 insertions(+)
> 
> diff --git a/include/linux/pm.h b/include/linux/pm.h
> index a1ce29566aea..01c4fe495b7a 100644
> --- a/include/linux/pm.h
> +++ b/include/linux/pm.h
> @@ -411,6 +411,9 @@ const struct dev_pm_ops __maybe_unused name = { \
>   * suspend and "early" resume callback pointers, .suspend_late() and
>   * .resume_early(), to the same routines as .runtime_suspend() and
>   * .runtime_resume(), respectively (and analogously for hibernation).
> + *
> + * Deprecated. You most likely don't want this macro. Use
> + * DEFINE_RUNTIME_DEV_PM_OPS() instead.
>   */
>  #define UNIVERSAL_DEV_PM_OPS(name, suspend_fn, resume_fn, idle_fn) \
>  const struct dev_pm_ops __maybe_unused name = { \
> diff --git a/include/linux/pm_runtime.h b/include/linux/pm_runtime.h
> index 016de5776b6d..4af454d29281 100644
> --- a/include/linux/pm_runtime.h
> +++ b/include/linux/pm_runtime.h
> @@ -22,6 +22,20 @@
>  					    usage_count */
>  #define RPM_AUTO		0x08	/* Use autosuspend_delay */
>  
> +/*
> + * Use this for defining a set of PM operations to be used in all situations
> + * (system suspend, hibernation or runtime PM).
> + *
> + * Note that the behaviour differs from the deprecated UNIVERSAL_DEV_PM_OPS()
> + * macro, which uses the provided callbacks for both runtime PM and system
> + * sleep, while DEFINE_RUNTIME_DEV_PM_OPS() uses pm_runtime_force_suspend()
> + * and pm_runtime_force_resume() for its system sleep callbacks.
> + */
> +#define DEFINE_RUNTIME_DEV_PM_OPS(name, suspend_fn, resume_fn, idle_fn) \
> +	_DEFINE_DEV_PM_OPS(name, pm_runtime_force_suspend, \
> +			   pm_runtime_force_resume, suspend_fn, \
> +			   resume_fn, idle_fn)
> +
>  #ifdef CONFIG_PM
>  extern struct workqueue_struct *pm_wq;
>