XPm_GetNodeStatus - 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

This function is used to get the device status.

Prototype

XStatus XPm_GetNodeStatus(const u32 DeviceId, XPm_NodeStatus *const NodeStatus);

Parameters

The following table lists the XPm_GetNodeStatus function arguments.

Table 1. XPm_GetNodeStatus Arguments
Type Name Description
const u32 DeviceId Device for which status is requested
XPm_NodeStatus *const NodeStatus Structure pointer to store device status
  • Status - The current power state of the device
    • For CPU nodes:
      • 0 : if CPU is powered down,
      • 1 : if CPU is active (powered up),
      • 2 : if CPU is suspending (powered up)
    • For power islands and power domains:
      • 0 : if island is powered down,
      • 1 : if island is powered up
    • For slaves:
      • 0 : if slave is powered down,
      • 1 : if slave is powered up,
      • 2 : if slave is in retention
  • Requirement - Requirements placed on the device by the caller
  • Usage
    • 0 : node is not used by any PU,
    • 1 : node is used by caller exclusively,
    • 2 : node is used by other PU(s) only,
    • 3 : node is used by caller and by other PU(s)

Returns

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