XilPM Zynq UltraScale+ MPSoC APIs - 2021.1 English

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

Document ID
Release Date
2021.1 English

Xilinx Power Management (XilPM) provides Embedded Energy Management Interface (EEMI) APIs for power management on Zynq UltraScale+ MPSoC. For more details about EEMI, see the Embedded Energy Management Interface (EEMI) API User Guide (UG1200).

Table 1. Quick Function Reference
Type Name Arguments
XStatus XPm_SelfSuspend
  • const enum XPmNodeId nid
  • const u32 latency
  • const u8 state
  • const u64 address
XStatus XPm_SetConfiguration
  • const u32 address
XStatus XPm_InitFinalize
  • void
XStatus XPm_RequestSuspend
XStatus XPm_RequestWakeUp
XStatus XPm_ForcePowerDown
XStatus XPm_AbortSuspend
XStatus XPm_SetWakeUpSource
XStatus XPm_SystemShutdown
  • u32 type
  • u32 subtype
XStatus XPm_RequestNode
XStatus XPm_SetRequirement
XStatus XPm_ReleaseNode
XStatus XPm_SetMaxLatency
void XPm_InitSuspendCb
void XPm_AcknowledgeCb
  • const enum XPmNodeId node
  • const XStatus status
  • const u32 oppoint
void XPm_NotifyCb
XStatus XPm_GetApiVersion
  • u32 * version
XStatus XPm_GetNodeStatus
XStatus XPm_GetOpCharacteristic
XStatus XPm_ResetAssert
XStatus XPm_ResetGetStatus
XStatus XPm_RegisterNotifier
XStatus XPm_UnregisterNotifier
XStatus XPm_MmioWrite
  • const u32 address
  • const u32 mask
  • const u32 value
XStatus XPm_MmioRead
  • const u32 address
  • u32 *const value
XStatus XPm_ClockEnable
XStatus XPm_ClockDisable
XStatus XPm_ClockGetStatus
XStatus XPm_ClockSetOneDivider
  • const enum XPmClock clk
  • const u32 divider
  • const u32 divId
XStatus XPm_ClockSetDivider
XStatus XPm_ClockGetOneDivider
  • const enum XPmClock clk
  • u32 *const divider
  • const u32 divId
XStatus XPm_ClockGetDivider
XStatus XPm_ClockSetParent
XStatus XPm_ClockGetParent
XStatus XPm_ClockSetRate
XStatus XPm_ClockGetRate
XStatus XPm_PllSetParameter
XStatus XPm_PllGetParameter
XStatus XPm_PllSetMode
XStatus XPm_PllGetMode
XStatus XPm_PinCtrlAction
XStatus XPm_PinCtrlRequest
  • const u32 pin
XStatus XPm_PinCtrlRelease
  • const u32 pin
XStatus XPm_PinCtrlSetFunction
XStatus XPm_PinCtrlGetFunction
XStatus XPm_PinCtrlSetParameter
XStatus XPm_PinCtrlGetParameter
XStatus XPm_InitXilpm
  • XIpiPsu * IpiInst
void XPm_SuspendFinalize
  • void
enum XPmBootStatus XPm_GetBootStatus
  • void