XSem_RegisterEvent - 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 to register/un-register event notification with XilSEM Server. Primarily this function sends an IPI request to PLM to invoke SEM Event Notifier registration, waits for PLM to process the request and check the status. Since SLR slave devices do not support IPI, registering events to mater registers events on all slave SLRs.

Note: The caller shall initialize the notifier object before invoking the XSem_RegisterEvent function.

Prototype

XStatus XSem_RegisterEvent(XIpiPsu *IpiInst, XSem_Notifier *Notifier);

Parameters

The following table lists the XSem_RegisterEvent function arguments.

Table 1. XSem_RegisterEvent Arguments
Type Member Description
XIpiPsu * IpiInst Pointer to IPI driver instance
XSem_Notifier * Notifier Pointer of the notifier object to be associated with the requested notification
  • Notifier->Module: The SEM module from which notification is required
  • Notifier->Event: Event(s) belonging to the Module for which notifications are required
  • Notifier->Flag: Flags to enable or disable notifications

Returns

This API returns the success or failure.
  • XST_FAILURE: On event registration/un-registration failure
  • XST_SUCCESS: On event registration/un-registration success