XPm_SetRequirement - 2023.1 English

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

Document ID
UG643
Release Date
2023-05-16
Version
2023.1 English

This function is used by a PU to announce a change in requirements for a specific slave node which is currently in use.

Note: If this function is called after the last awake CPU within the PU calls SelfSuspend, the requirement change shall be performed after the CPU signals the end of suspend to the power management controller, (e.g. WFI interrupt).

Prototype

XStatus XPm_SetRequirement(const enum XPmNodeId nid, const u32 capabilities, const u32 qos, const enum XPmRequestAck ack);

Parameters

The following table lists the XPm_SetRequirement function arguments.

Table 1. XPm_SetRequirement Arguments
Type Name Description
const enum XPmNodeId nid Node ID of the PM slave.
const u32 capabilities Slave-specific capabilities required.
const u32 qos Quality of Service (0-100) required.
const enum XPmRequestAck ack Requested acknowledge type

Returns

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