xous-core/api/xous-api-susres
bunnie 83e26ff4c7 update num-derive dependency
this became mandatory in 1.83 to remove warnings. I think it
should have no impact on functionality.
2024-12-02 18:52:59 +08:00
..
src update formatting on the published crates 2024-09-23 01:43:02 +08:00
Cargo.toml update num-derive dependency 2024-12-02 18:52:59 +08:00
README.md fix inconsistency in Cargo.toml file 2022-10-05 17:00:18 +08:00

Xous Api: susres

This crate defines the Xous suspend/resume API.

The suspend/resume API is responsible for sequencing events before a system powers down, such that all of the SoC hardware blocks will lose state, but the RAM will retain its contents.

Every service that contains hardware state which can be lost when the SoC is powered down must register with the sequencer, and it must atomically back up its hardware state to battery-backed RAM and then call suspend_until_resume, which will block until power is restored. Once power is restored, the service should copy the hardware state out of battery-backed RAM and resume operations.

The API also contains hooks for initiating the suspend process, and for rebooting the device.