XPm_GetOpCharacteristic - 2020.2 English

OS and Libraries Document Collection (UG643)

Document ID

UG643

Release Date

2020-11-24

Version

2020.2 English

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

Note: Currently power type is not supported for Versal.

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

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 micro seconds to return to active state), temperature (current temperature in Celsius (Q8.7 format)),
u32 *const	Result	Used to return the requested operating characteristic.

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