XPm_SetMaxLatency - 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 the maximum wake-up latency requirements for a specific slave node currently used by that PU.

Note: Setting maximum wake-up latency can constrain the set of possible power states a resource can be put into.

Prototype

XStatus XPm_SetMaxLatency(const enum XPmNodeId node, const u32 latency);

Parameters

The following table lists the XPm_SetMaxLatency function arguments.

Table 1. XPm_SetMaxLatency Arguments
Type Name Description
const enum XPmNodeId node Node ID of the PM slave.
const u32 latency Maximum wake-up latency required.

Returns

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