XPm_RequestNode - 2023.1 English

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

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

Used to request the usage of a PM-slave. Using this API call a PU requests access to a slave device and asserts its requirements on that device. Provided the PU is sufficiently privileged, the PMU will enable access to the memory mapped region containing the control registers of that device. For devices that can only be serving a single PU, any other privileged PU will now be blocked from accessing this device until the node is released.

Note: None

Prototype

XStatus XPm_RequestNode(const enum XPmNodeId node, const u32 capabilities, const u32 qos, const enum XPmRequestAck ack);

Parameters

The following table lists the XPm_RequestNode function arguments.

Table 1. XPm_RequestNode Arguments
Type Name Description
const enum XPmNodeId node Node ID of the PM slave requested
const u32 capabilities Slave-specific capabilities required, can be combined
  • PM_CAP_ACCESS : full access / functionality
  • PM_CAP_CONTEXT : preserve context
  • PM_CAP_WAKEUP : emit wake interrupts
const u32 qos Quality of Service (0-100) required
const enum XPmRequestAck ack Requested acknowledge type

Returns

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