XPm_ForcePowerDown - 2023.1 English

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

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

One PU can request a forced poweroff of another PU or its power island or power domain. This can be used for killing an unresponsive PU, in which case all resources of that PU will be automatically released.

Note: Force power down may not be requested by a PU for itself.

Prototype

XStatus XPm_ForcePowerDown(const enum XPmNodeId target, const enum XPmRequestAck ack);

Parameters

The following table lists the XPm_ForcePowerDown function arguments.

Table 1. XPm_ForcePowerDown Arguments
Type Name Description
const enum XPmNodeId target Node ID of the PU node or power island/domain to be powered down.
const enum XPmRequestAck ack Requested acknowledge type

Returns

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