Callback function to be implemented in each PU, allowing the power management controller to request that the PU suspend itself.
Note: If the PU fails to act on this request the power management controller or the requesting PU may choose to employ the forceful power down option.
Prototype
void XPm_InitSuspendCb(const enum XPmSuspendReason reason, const u32 latency, const u32 state, const u32 timeout);Parameters
The following table lists the XPm_InitSuspendCb function arguments.
| Type | Name | Description |
|---|---|---|
const enum
XPmSuspendReason
|
reason |
Suspend reason:
|
| const u32 | latency | Maximum wake-up latency in us(micro secs). This information can be used by the PU to decide what level of context saving may be required. |
| const u32 | state | Targeted sleep/suspend state. |
| const u32 | timeout | Timeout in ms, specifying how much time a PU has to initiate its suspend procedure before it's being considered unresponsive. |