diff options
| author | Kimplul <kimi.h.kuparinen@gmail.com> | 2022-06-01 22:34:31 +0300 |
|---|---|---|
| committer | Kimplul <kimi.h.kuparinen@gmail.com> | 2022-06-01 22:34:31 +0300 |
| commit | b5e6a74635eba8e6c5fe0a614c6f578380fb1196 (patch) | |
| tree | 994be097e18720c0062014db255ad8c06538641a /include/apos/power.h | |
| parent | 6295648f04d1d5d7e8b99d3fdaa8d497406eadf9 (diff) | |
| download | kmi-b5e6a74635eba8e6c5fe0a614c6f578380fb1196.tar.gz kmi-b5e6a74635eba8e6c5fe0a614c6f578380fb1196.zip | |
continue documentation
Diffstat (limited to 'include/apos/power.h')
| -rw-r--r-- | include/apos/power.h | 21 |
1 files changed, 20 insertions, 1 deletions
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 <apos/types.h> #include <apos/attrs.h> -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 |