From f7fe18ad10d228a203588a7427d3681da874f993 Mon Sep 17 00:00:00 2001 From: Imre Deak Date: Fri, 14 Oct 2016 17:51:14 +0300 Subject: lib/igt_aux: Improve documentation for igt_system_suspend_autoresume() While at it fix the order of states for consistency. Suggested by Daniel. Cc: Daniel Vetter Signed-off-by: Imre Deak Reviewed-by: Daniel Vetter --- lib/igt_aux.c | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) (limited to 'lib/igt_aux.c') diff --git a/lib/igt_aux.c b/lib/igt_aux.c index f225c2f6..421f6d4e 100644 --- a/lib/igt_aux.c +++ b/lib/igt_aux.c @@ -628,8 +628,8 @@ void igt_cleanup_aperture_trashers(void) static const char *suspend_state_name[] = { [SUSPEND_STATE_FREEZE] = "freeze", - [SUSPEND_STATE_MEM] = "mem", [SUSPEND_STATE_STANDBY] = "standby", + [SUSPEND_STATE_MEM] = "mem", [SUSPEND_STATE_DISK] = "disk", }; @@ -744,11 +744,22 @@ static uint32_t get_supported_suspend_states(int power_dir) /** * igt_system_suspend_autoresume: + * @state: an #igt_suspend_state, the target suspend state + * @test: an #igt_suspend_test, test point at which to complete the suspend + * cycle + * + * Execute a system suspend cycle targeting the given @state optionally + * completing the cycle at the given @test point and automaically wake up + * again. Waking up is either achieved using the RTC wake-up alarm for a full + * suspend cycle or a kernel timer for a suspend test cycle. The kernel timer + * delay for a test cycle can be configured by the suspend.pm_test_delay + * kernel parameter (5 sec by default). * - * Execute a system suspend (to idle, memory, disk) cycle optionally - * completing the cycle at a given test point and automaically wake up again. - * Waking up is either achieved using the RTC wake-up alarm for a full suspend - * cycle or a kernel timer for a suspend test cycle. + * #SUSPEND_TEST_NONE specifies a full suspend cycle. + * The #SUSPEND_TEST_FREEZER..#SUSPEND_TEST_CORE test points can make it + * possible to collect error logs in case a full suspend cycle would prevent + * this by hanging the machine, or they can provide an idea of the faulty + * component by comparing fail/no-fail results at different test points. * * This is very handy for implementing any kind of suspend/resume test. */ -- cgit v1.2.3