* [PATCH v2] PM: sleep: Add kerneldoc comments to some functions
@ 2019-05-27 10:45 Rafael J. Wysocki
2019-05-31 9:51 ` Rafael J. Wysocki
0 siblings, 1 reply; 2+ messages in thread
From: Rafael J. Wysocki @ 2019-05-27 10:45 UTC (permalink / raw)
To: Linux PM; +Cc: LKML, Keith Busch, Christoph Hellwig
From: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Add kerneldoc comments to pm_suspend_via_firmware(),
pm_resume_via_firmware() and pm_suspend_via_s2idle() to explain
what they do.
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
---
-> v2:
Put more information into the pm_suspend_via_firmware() kerneldoc comment.
---
include/linux/suspend.h | 31 +++++++++++++++++++++++++++++++
kernel/power/suspend.c | 6 ++++++
2 files changed, 37 insertions(+)
Index: linux-pm/include/linux/suspend.h
===================================================================
--- linux-pm.orig/include/linux/suspend.h
+++ linux-pm/include/linux/suspend.h
@@ -227,11 +227,42 @@ static inline void pm_set_resume_via_fir
pm_suspend_global_flags |= PM_SUSPEND_FLAG_FW_RESUME;
}
+/**
+ * pm_suspend_via_firmware - Check if platform firmware will suspend the system.
+ *
+ * To be called during system-wide power management transitions to sleep states
+ * or during the subsequent system-wide transitions back to the working state.
+ *
+ * Return 'true' if the platform firmware is going to be invoked at the end of
+ * the system-wide power management transition (to a sleep state) in progress in
+ * order to complete it, or if the platform firmware has been invoked in order
+ * to complete the last (or preceding) transition of the system to a sleep
+ * state.
+ *
+ * This matters if the caller needs or wants to carry out some special actions
+ * depending on whether or not control will be passed to the platform firmware
+ * subsequently (for example, the device may need to be reset before letting the
+ * platform firmware manipulate it, which is not necessary when the platform
+ * firmware is not going to be invoked) or when such special actions may have
+ * been carried out during the preceding transition of the system to a sleep
+ * state (as they may need to be taken into account).
+ */
static inline bool pm_suspend_via_firmware(void)
{
return !!(pm_suspend_global_flags & PM_SUSPEND_FLAG_FW_SUSPEND);
}
+/**
+ * pm_resume_via_firmware - Check if platform firmware has woken up the system.
+ *
+ * To be called during system-wide power management transitions from sleep
+ * states.
+ *
+ * Return 'true' if the platform firmware has passed control to the kernel at
+ * the beginning of the system-wide power management transition in progress, so
+ * the event that woke up the system from sleep has been handled by the platform
+ * firmware.
+ */
static inline bool pm_resume_via_firmware(void)
{
return !!(pm_suspend_global_flags & PM_SUSPEND_FLAG_FW_RESUME);
Index: linux-pm/kernel/power/suspend.c
===================================================================
--- linux-pm.orig/kernel/power/suspend.c
+++ linux-pm/kernel/power/suspend.c
@@ -62,6 +62,12 @@ static DECLARE_SWAIT_QUEUE_HEAD(s2idle_w
enum s2idle_states __read_mostly s2idle_state;
static DEFINE_RAW_SPINLOCK(s2idle_lock);
+/**
+ * pm_suspend_via_s2idle - Check if suspend-to-idle is the default suspend.
+ *
+ * Return 'true' if suspend-to-idle has been selected as the default system
+ * suspend method.
+ */
bool pm_suspend_via_s2idle(void)
{
return mem_sleep_current == PM_SUSPEND_TO_IDLE;
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: [PATCH v2] PM: sleep: Add kerneldoc comments to some functions
2019-05-27 10:45 [PATCH v2] PM: sleep: Add kerneldoc comments to some functions Rafael J. Wysocki
@ 2019-05-31 9:51 ` Rafael J. Wysocki
0 siblings, 0 replies; 2+ messages in thread
From: Rafael J. Wysocki @ 2019-05-31 9:51 UTC (permalink / raw)
To: Rafael J. Wysocki; +Cc: Linux PM, LKML, Keith Busch, Christoph Hellwig
On Monday, May 27, 2019 12:45:18 PM CEST Rafael J. Wysocki wrote:
> From: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
>
> Add kerneldoc comments to pm_suspend_via_firmware(),
> pm_resume_via_firmware() and pm_suspend_via_s2idle() to explain
> what they do.
>
> Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
> ---
>
> -> v2:
> Put more information into the pm_suspend_via_firmware() kerneldoc comment.
It doesn't look like there are any more comments here, so I'll be queuing up this one.
>
> ---
> include/linux/suspend.h | 31 +++++++++++++++++++++++++++++++
> kernel/power/suspend.c | 6 ++++++
> 2 files changed, 37 insertions(+)
>
> Index: linux-pm/include/linux/suspend.h
> ===================================================================
> --- linux-pm.orig/include/linux/suspend.h
> +++ linux-pm/include/linux/suspend.h
> @@ -227,11 +227,42 @@ static inline void pm_set_resume_via_fir
> pm_suspend_global_flags |= PM_SUSPEND_FLAG_FW_RESUME;
> }
>
> +/**
> + * pm_suspend_via_firmware - Check if platform firmware will suspend the system.
> + *
> + * To be called during system-wide power management transitions to sleep states
> + * or during the subsequent system-wide transitions back to the working state.
> + *
> + * Return 'true' if the platform firmware is going to be invoked at the end of
> + * the system-wide power management transition (to a sleep state) in progress in
> + * order to complete it, or if the platform firmware has been invoked in order
> + * to complete the last (or preceding) transition of the system to a sleep
> + * state.
> + *
> + * This matters if the caller needs or wants to carry out some special actions
> + * depending on whether or not control will be passed to the platform firmware
> + * subsequently (for example, the device may need to be reset before letting the
> + * platform firmware manipulate it, which is not necessary when the platform
> + * firmware is not going to be invoked) or when such special actions may have
> + * been carried out during the preceding transition of the system to a sleep
> + * state (as they may need to be taken into account).
> + */
> static inline bool pm_suspend_via_firmware(void)
> {
> return !!(pm_suspend_global_flags & PM_SUSPEND_FLAG_FW_SUSPEND);
> }
>
> +/**
> + * pm_resume_via_firmware - Check if platform firmware has woken up the system.
> + *
> + * To be called during system-wide power management transitions from sleep
> + * states.
> + *
> + * Return 'true' if the platform firmware has passed control to the kernel at
> + * the beginning of the system-wide power management transition in progress, so
> + * the event that woke up the system from sleep has been handled by the platform
> + * firmware.
> + */
> static inline bool pm_resume_via_firmware(void)
> {
> return !!(pm_suspend_global_flags & PM_SUSPEND_FLAG_FW_RESUME);
> Index: linux-pm/kernel/power/suspend.c
> ===================================================================
> --- linux-pm.orig/kernel/power/suspend.c
> +++ linux-pm/kernel/power/suspend.c
> @@ -62,6 +62,12 @@ static DECLARE_SWAIT_QUEUE_HEAD(s2idle_w
> enum s2idle_states __read_mostly s2idle_state;
> static DEFINE_RAW_SPINLOCK(s2idle_lock);
>
> +/**
> + * pm_suspend_via_s2idle - Check if suspend-to-idle is the default suspend.
> + *
> + * Return 'true' if suspend-to-idle has been selected as the default system
> + * suspend method.
> + */
> bool pm_suspend_via_s2idle(void)
> {
> return mem_sleep_current == PM_SUSPEND_TO_IDLE;
>
>
>
>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2019-05-31 9:51 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-05-27 10:45 [PATCH v2] PM: sleep: Add kerneldoc comments to some functions Rafael J. Wysocki
2019-05-31 9:51 ` Rafael J. Wysocki
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).