XPm_GetOpCharacteristic - 2021.1 English

Xilinx Standalone Library Documentation OS and Libraries Document Collection (UG643)

Document ID
UG643
Release Date
2021-06-16
Version
2021.1 English

Call this function to request the power management controller to return information about an operating characteristic of a component.

Prototype

XStatus XPm_GetOpCharacteristic(const u32 DeviceId, const enum XPmOpCharType Type, u32 *const Result);

Parameters

The following table lists the XPm_GetOpCharacteristic function arguments.

Table 1. XPm_GetOpCharacteristic Arguments
Type Name Description
const u32 DeviceId Device ID.
const enum XPmOpCharType Type Type of operating characteristic requested:
  • power (current power consumption),
  • latency (current latency in us to return to active state),
  • temperature (current temperature),
u32 *const Result Used to return the requested operating characteristic.

Returns

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