diff options
| author | Rafael J. Wysocki <rafael.j.wysocki@intel.com> | 2019-05-27 12:45:18 +0200 |
|---|---|---|
| committer | Rafael J. Wysocki <rafael.j.wysocki@intel.com> | 2019-06-03 10:44:21 +0200 |
| commit | a61373476127edac8bcc5ee9d68a74dc1b864f53 (patch) | |
| tree | a3192c4aef4faa88e9bd2655c5934af3b1f56936 /kernel | |
| parent | Linux 5.2-rc3 (diff) | |
| download | linux-a61373476127edac8bcc5ee9d68a74dc1b864f53.tar.xz linux-a61373476127edac8bcc5ee9d68a74dc1b864f53.zip | |
PM: sleep: Add kerneldoc comments to some functions
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>
Diffstat (limited to 'kernel')
| -rw-r--r-- | kernel/power/suspend.c | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/kernel/power/suspend.c b/kernel/power/suspend.c index ef908c134b34..43d869db6c07 100644 --- a/kernel/power/suspend.c +++ b/kernel/power/suspend.c @@ -62,6 +62,12 @@ static DECLARE_SWAIT_QUEUE_HEAD(s2idle_wait_head); 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; |