From b5e6a74635eba8e6c5fe0a614c6f578380fb1196 Mon Sep 17 00:00:00 2001 From: Kimplul Date: Wed, 1 Jun 2022 22:34:31 +0300 Subject: continue documentation --- include/apos/power.h | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) (limited to 'include/apos/power.h') diff --git a/include/apos/power.h b/include/apos/power.h index 640f056..ed7e29c 100644 --- a/include/apos/power.h +++ b/include/apos/power.h @@ -10,7 +10,26 @@ #include #include -enum poweroff_type { SHUTDOWN, COLD_REBOOT, WARM_REBOOT }; +/** Types of powering off. Still unclear what difference there is between warm + * and cold reboot. */ +enum poweroff_type { + /** Shut down. */ + SHUTDOWN, + + /** Cold or complete reboot. */ + COLD_REBOOT, + + /** Warm or partial reboot. */ + WARM_REBOOT +}; + +/** + * Power off the system. + * + * @param type Type of powering off. \see poweroff_type. + * @return Nothing on success (system shuts down), \ref ERR_INVAL on invalid + * poweroff type or ERR_MISC if studown was not succesful. + */ stat_t poweroff(enum poweroff_type type); #endif -- cgit v1.3