XPm_ReleaseNode - 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 is used by a PU to release the usage of a PM slave. This will tell the power management controller that the node is no longer needed by that PU, potentially allowing the node to be placed into an inactive state.

Note: None

Prototype

XStatus XPm_ReleaseNode(const enum XPmNodeId node);

Parameters

The following table lists the XPm_ReleaseNode function arguments.

Table 1. XPm_ReleaseNode Arguments
Type Name Description
const enum XPmNodeId node Node ID of the PM slave.

Returns

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