XPm_SelfSuspend - 2021.1 English

Xilinx Standalone Library Documentation OS and Libraries Document Collection (UG643)

Document ID
Release Date
2021.1 English

This function is used by a CPU to declare that it is about to suspend itself.


XStatus XPm_SelfSuspend(const u32 DeviceId, const u32 Latency, const u8 State, const u64 Address);


The following table lists the XPm_SelfSuspend function arguments.

Table 1. XPm_SelfSuspend Arguments
Type Name Description
const u32 DeviceId Device ID of the CPU
const u32 Latency Maximum wake-up latency requirement in us(microsecs)
const u8 State Instead of specifying a maximum latency, a CPU can also explicitly request a certain power state.
const u64 Address Address from which to resume when woken up.


XST_SUCCESS if successful else XST_FAILURE or an error code or a reason code