Commit d7ef570a authored by Yang Li's avatar Yang Li Committed by Rafael J. Wysocki
Browse files

ACPI: PM: Improve kerneldoc comments for suspend and hibernation functions 



This patch enhances the documentation for the ACPI power management
functions related to system suspend and hibernation.

This includes the use of kernel-doc style comments which provide
developers with clearer guidance on the usage and expectations of
these functions.

Signed-off-by: default avatarYang Li <yang.lee@linux.alibaba.com>
Reviewed-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Tested-by: default avatarRandy Dunlap <rdunlap@infradead.org>
[ rjw: Subject edits ]
Signed-off-by: default avatarRafael J. Wysocki <rafael.j.wysocki@intel.com>
parent 0a500b81

drivers/acpi/sleep.c

+14 −10
Original line number Diff line number Diff line
@@ -514,6 +514,7 @@ static void acpi_pm_finish(void) 


/**

 * acpi_pm_start - Start system PM transition.

 * @acpi_state: The target ACPI power state to transition to.

 */

static void acpi_pm_start(u32 acpi_state)

{
@@ -554,6 +555,7 @@ static u32 acpi_suspend_states[] = { 
/**

 * acpi_suspend_begin - Set the target system sleep state to the state

 *	associated with given @pm_state, if supported.

 * @pm_state: The target system power management state.

 */

static int acpi_suspend_begin(suspend_state_t pm_state)

{
@@ -687,6 +689,7 @@ static const struct platform_suspend_ops acpi_suspend_ops = { 
 *	state associated with given @pm_state, if supported, and

 *	execute the _PTS control method.  This function is used if the

 *	pre-ACPI 2.0 suspend ordering has been requested.

 * @pm_state: The target suspend state for the system.

 */

static int acpi_suspend_begin_old(suspend_state_t pm_state)

{
@@ -983,6 +986,7 @@ static const struct platform_hibernation_ops acpi_hibernation_ops = { 
 *	ACPI_STATE_S4 and execute the _PTS control method.  This

 *	function is used if the pre-ACPI 2.0 suspend ordering has been

 *	requested.

 * @stage: The power management event message.

 */

static int acpi_hibernation_begin_old(pm_message_t stage)

{