This function is used by a CPU to declare that it is about to suspend itself. After the PMU processes this call it will wait for the requesting CPU to complete the suspend procedure and become ready to be put into a sleep state.
Note: This is a blocking call, it will return only once PMU has responded
Prototype
XStatus XPm_SelfSuspend(const enum XPmNodeId nid, const u32 latency, const u8 state, const u64 address);
Parameters
The following table lists the XPm_SelfSuspend
function arguments.
Type | Name | Description |
---|---|---|
const enum
XPmNodeId
|
nid | Node ID of the CPU node to be suspended. |
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. |