XPm_GetOpCharacteristic - 2023.1 English

Standalone Library Documentation: BSP and Libraries Document Collection (UG643)
Document ID
UG643
Release Date
2023-05-16
Version
2023.1 English

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

Note: Power value is not actual power consumption of device. It is default dummy power value which is fixed in PMUFW. Temperature type is not supported for ZynqMP.

Prototype

XStatus XPm_GetOpCharacteristic(const enum XPmNodeId node, 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 enum XPmNodeId node ID of the component or sub-system in question.
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),
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