XPm_RequestSuspend - 2022.2 English

Xilinx Standalone Library Documentation: BSP and Libraries Document Collection (UG643)

Document ID
UG643
Release Date
2022-10-19
Version
2022.2 English

This function is used by a CPU to request suspend to another CPU.

Prototype

XStatus XPm_RequestSuspend(const u32 TargetSubsystemId, const u32 Ack, const u32 Latency, const u32 State);

Parameters

The following table lists the XPm_RequestSuspend function arguments.

Table 1. XPm_RequestSuspend Arguments
Type Name Description
const u32 TargetSubsystemId Subsystem ID of the target
const u32 Ack Requested acknowledge type
const u32 Latency Maximum wake-up latency requirement in us(microsecs)
const u32 State Power State

Returns

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