sapi_reboot.h File Reference

OS Abstraction Layer - Controlled reboot service (ADR-004 section 3). More...

#include "safeapi/utils/status/sapi_status.h"
#include "safeapi/utils/types/sapi_types.h"

Include dependency graph for sapi_reboot.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
sapi_status_t	sapi_reboot_request (uint16_t reason_code)
	Requests a controlled system restart.

Detailed Description

OS Abstraction Layer - Controlled reboot service (ADR-004 section 3).

Requests a controlled system restart (watchdog trigger, CPU reset instruction, supervisory processor command - backend-defined). Intended as the mechanism a SAPI_REBOOT()/SAPI_SAFESTATE_LEVEL_REBOOT handler calls into (see ADR-004 section 2.3); this header has no dependency on sapi_safestate.h and can be used directly.

REQ-OAL-REBOOT-001: sapi_reboot_request() is not expected to return on success; a return only occurs if the backend cannot perform the reboot.

Definition in file sapi_reboot.h.