This function is used to obtain information about the current state of a component. The caller must pass a pointer to an
XPm_NodeStatus
structure, which must be pre-allocated by the caller.
-
status - The current power state of the requested node.
-
For CPU nodes:
- 0 : if CPU is off (powered down),
- 1 : if CPU is active (powered up),
- 2 : if CPU is in sleep (powered down),
- 3 : 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 PM slaves:
- 0 : if slave is powered down,
- 1 : if slave is powered up,
- 2 : if slave is in retention
-
For CPU nodes:
- requirement - Slave nodes only: Returns current requirements the requesting PU has requested of the node.
-
usage - Slave nodes only: Returns current usage status of the node:
- 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)
Note: None
Prototype
XStatus XPm_GetNodeStatus(const enum XPmNodeId node, XPm_NodeStatus *const nodestatus);Parameters
The following table lists the XPm_GetNodeStatus function arguments.
| Type | Name | Description |
|---|---|---|
const enum
XPmNodeId
|
node | ID of the component or sub-system in question. |
XPm_NodeStatus
*const |
nodestatus | Used to return the complete status of the node. |