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

A PU can call this function to request that the power management controller call its notify callback whenever a qualifying event occurs. One can request to be notified for a specific or any event related to a specific node.

Note: The caller shall initialize the notifier object before invoking the XPm_RegisteredNotifier function. While notifier is registered, the notifier object shall not be modified by the caller.

Prototype

int XPm_RegisterNotifier(XPm_Notifier *const Notifier);

Parameters

The following table lists the XPm_RegisterNotifier function arguments.

Table 1. XPm_RegisterNotifier Arguments
Type Name Description
XPm_Notifier *const Notifier Pointer to the notifier object to be associated with the requested notification.

Returns

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