XilPM Zynq UltraScale+ MPSoC APIs

XilPM Zynq UltraScale+ MPSoC APIs - 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

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	const enum `XPmNodeId` target const enum `XPmRequestAck` ack const u32 latency const u8 state
XStatus	XPm_RequestWakeUp	const enum `XPmNodeId` target const bool setAddress const u64 address const enum `XPmRequestAck` ack
XStatus	XPm_ForcePowerDown	const enum `XPmNodeId` target const enum `XPmRequestAck` ack
XStatus	XPm_AbortSuspend	const enum `XPmAbortReason` reason
XStatus	XPm_SetWakeUpSource	const enum `XPmNodeId` target const enum `XPmNodeId` wkup_node const u8 enable
XStatus	XPm_SystemShutdown	u32 type u32 subtype
XStatus	XPm_RequestNode	const enum `XPmNodeId` node const u32 capabilities const u32 qos const enum `XPmRequestAck` ack
XStatus	XPm_SetRequirement	const enum `XPmNodeId` nid const u32 capabilities const u32 qos const enum `XPmRequestAck` ack
XStatus	XPm_ReleaseNode	const enum `XPmNodeId` node
XStatus	XPm_SetMaxLatency	const enum `XPmNodeId` node const u32 latency
void	XPm_InitSuspendCb	const enum `XPmSuspendReason` reason const u32 latency const u32 state const u32 timeout
void	XPm_AcknowledgeCb	const enum `XPmNodeId` node const XStatus status const u32 oppoint
void	XPm_NotifyCb	const enum `XPmNodeId` node const enum `XPmNotifyEvent` event const u32 oppoint
XStatus	XPm_GetApiVersion	u32 * version
XStatus	XPm_GetNodeStatus	const enum `XPmNodeId` node `XPm_NodeStatus` *const nodestatus
XStatus	XPm_GetOpCharacteristic	const enum `XPmNodeId` node const enum `XPmOpCharType` type u32 *const result
XStatus	XPm_ResetAssert	const enum `XPmReset` reset const enum `XPmResetAction` resetaction
XStatus	XPm_ResetGetStatus	const enum `XPmReset` reset u32 * status
XStatus	XPm_RegisterNotifier	`XPm_Notifier` *const notifier
XStatus	XPm_UnregisterNotifier	`XPm_Notifier` *const notifier
XStatus	XPm_MmioWrite	const u32 address const u32 mask const u32 value
XStatus	XPm_MmioRead	const u32 address u32 *const value
XStatus	XPm_ClockEnable	const enum `XPmClock` clk
XStatus	XPm_ClockDisable	const enum `XPmClock` clk
XStatus	XPm_ClockGetStatus	const enum `XPmClock` clk u32 *const status
XStatus	XPm_ClockSetOneDivider	const enum `XPmClock` clk const u32 divider const u32 divId
XStatus	XPm_ClockSetDivider	const enum `XPmClock` clk const u32 divider
XStatus	XPm_ClockGetOneDivider	const enum `XPmClock` clk u32 *const divider const u32 divId
XStatus	XPm_ClockGetDivider	const enum `XPmClock` clk u32 *const divider
XStatus	XPm_ClockSetParent	const enum `XPmClock` clk const enum `XPmClock` parent
XStatus	XPm_ClockGetParent	const enum `XPmClock` clk enum `XPmClock` *const parent
XStatus	XPm_ClockSetRate	const enum `XPmClock` clk const u32 rate
XStatus	XPm_ClockGetRate	const enum `XPmClock` clk u32 *const rate
XStatus	XPm_PllSetParameter	const enum `XPmNodeId` node const enum `XPmPllParam` parameter const u32 value
XStatus	XPm_PllGetParameter	const enum `XPmNodeId` node const enum `XPmPllParam` parameter u32 *const value
XStatus	XPm_PllSetMode	const enum `XPmNodeId` node const enum `XPmPllMode` mode
XStatus	XPm_PllGetMode	const enum `XPmNodeId` node enum `XPmPllMode` *const mode
XStatus	XPm_PinCtrlAction	const u32 pin const enum `XPmApiId` api
XStatus	XPm_PinCtrlRequest	const u32 pin
XStatus	XPm_PinCtrlRelease	const u32 pin
XStatus	XPm_PinCtrlSetFunction	const u32 pin const enum `XPmPinFn` fn
XStatus	XPm_PinCtrlGetFunction	const u32 pin enum `XPmPinFn` *const fn
XStatus	XPm_PinCtrlSetParameter	const u32 pin const enum `XPmPinParam` param const u32 value
XStatus	XPm_PinCtrlGetParameter	const u32 pin const enum `XPmPinParam` param u32 *const value
XStatus	XPm_InitXilpm	XIpiPsu * IpiInst
void	XPm_SuspendFinalize	void
enum `XPmBootStatus`	XPm_GetBootStatus	void