XPm_SetMaxLatency - 2023.2 English

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

Document ID
UG643
Release Date
2023-12-13
Version
2023.2 English

This function is used by a CPU to announce a change in the maximum wake-up latency requirements for a specific device currently used by that CPU.

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 u32 DeviceId, const u32 Latency);

Parameters

The following table lists the XPm_SetMaxLatency function arguments.

Table 1. XPm_SetMaxLatency Arguments
Type Name Description
const u32 DeviceId Device ID.
const u32 Latency Maximum wake-up latency required.

Returns

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