XPm_SetWakeUpSource - XPm_SetWakeUpSource - 2026.1 English - UG643

Standalone Library Documentation: BSP and Libraries Document Collection (UG643)

Document ID
UG643
Release Date
2026-06-23
Version
2026.1 English

This function is called by a PU to add or remove a wake-up source prior to going to suspend. The list of wake sources for a PU is automatically cleared whenever the PU is woken up or when one of its CPUs aborts the suspend procedure.

Note: Declaring a node as a wakeup source ensures that the node is not powered off. It also causes the PMU to configure the GIC Proxy accordingly if the FPD is powered off.

Prototype

XStatus XPm_SetWakeUpSource(const enum XPmNodeId target, const enum XPmNodeId wkup_node, const u8 enable);

Parameters

The following table lists the XPm_SetWakeUpSource function arguments.

Table 1. XPm_SetWakeUpSource Arguments
Type Name Description
const enum XPmNodeId target Node ID of the target to be woken up.
const enum XPmNodeId wkup_node Node ID of the wakeup device.
const u8 enable Enable flag:
  • 1: the wakeup source is added to the list
  • 0: the wakeup source is removed from the list

Returns

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