XPm_SetRequirement - 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 to set the requirement for specified device.

Prototype

XStatus XPm_SetRequirement(const u32 DeviceId, const u32 Capabilities, const u32 QoS, const u32 Ack);

Parameters

The following table lists the XPm_SetRequirement function arguments.

Table 1. XPm_SetRequirement Arguments
Type Name Description
const u32 DeviceId Device for which requirement needs to be set
const u32 Capabilities Device Capabilities, can be combined
  • PM_CAP_ACCESS : full access / functionality
  • PM_CAP_CONTEXT : preserve context
  • PM_CAP_WAKEUP : emit wake interrupts
const u32 QoS Quality of Service (0-100) required
const u32 Ack Requested acknowledge type

Returns

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