zephyr/include/sys/reboot.h
Christoph Thurnheer ef97121d74 lib: os: add gcc noreturn attribute for sys_reboot
sys_reboot doesn't return so mark it with noreturn

Signed-off-by: Christoph Thurnheer <c.thurnheer@gmx.ch>
2021-08-13 07:32:51 -04:00

45 lines
821 B
C

/*
* Copyright (c) 2015 Wind River Systems, Inc.
*
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @file
* @brief Common target reboot functionality
*
* @details See subsys/os/Kconfig and the reboot help for details.
*/
#ifndef ZEPHYR_INCLUDE_SYS_REBOOT_H_
#define ZEPHYR_INCLUDE_SYS_REBOOT_H_
#include <toolchain.h>
#ifdef __cplusplus
extern "C" {
#endif
#define SYS_REBOOT_WARM 0
#define SYS_REBOOT_COLD 1
/**
* @brief Reboot the system
*
* Reboot the system in the manner specified by @a type. Not all architectures
* or platforms support the various reboot types (SYS_REBOOT_COLD,
* SYS_REBOOT_WARM).
*
* When successful, this routine does not return.
*
* @return N/A
*/
extern FUNC_NORETURN void sys_reboot(int type);
#ifdef __cplusplus
}
#endif
#endif /* ZEPHYR_INCLUDE_SYS_REBOOT_H_ */