Controlled Reboot

Backend-defined controlled system restart (ADR-004 section 3). More...

Files
file	src/oal/reboot/sapi_reboot.c
	Reboot service: dispatches to the backend registered via sapi_reboot_register_backend() (ADR-005).

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

Detailed Description

Backend-defined controlled system restart (ADR-004 section 3).

Function Documentation

sapi_reboot_request()

sapi_status_t sapi_reboot_request

(

uint16_t

reason_code

)

Requests a controlled system restart.

Parameters

reason_code

Backend-visible diagnostic code (e.g. persisted to NVM/black-box storage before the reset, backend-defined).

Returns

Does not return on success (the CPU resets). Returns SAPI_STATUS_NOT_INITIALIZED if no backend is registered, SAPI_STATUS_NOT_SUPPORTED if the backend cannot perform a reboot, or a backend-defined error status.

REQ-OAL-REBOOT-010

Definition at line 44 of file sapi_reboot.c.