XPm_RequestWakeUp - 2023.1 English

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

Document ID
UG643
Release Date
2023-05-16
Version
2023.1 English

This function can be used to request power up of a CPU node within the same PU, or to power up another PU.

Note: If acknowledge is requested, the calling PU will be notified by the power management controller once the wake-up is completed.

Prototype

XStatus XPm_RequestWakeUp(const enum XPmNodeId target, const bool setAddress, const u64 address, const enum XPmRequestAck ack);

Parameters

The following table lists the XPm_RequestWakeUp function arguments.

Table 1. XPm_RequestWakeUp Arguments
Type Name Description
const enum XPmNodeId target Node ID of the CPU or PU to be powered/woken up.
const bool setAddress Specifies whether the start address argument is being passed.
  • 0 : do not set start address
  • 1 : set start address
const u64 address Address from which to resume when woken up. Will only be used if set_address is 1.
const enum XPmRequestAck ack Requested acknowledge type

Returns

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