Xil_WaitForEvents - Xil_WaitForEvents - 2026.1 English - UG643

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

Document ID
UG643
Release Date
2026-06-23
Version
2026.1 English

Read, Modify and Write to an address

Waits for the events. Returns on occurrence of first event / timeout.

Prototype

u32 Xil_WaitForEvents(UINTPTR EventsRegAddr, u32 EventsMask, u32 WaitEvents, u32 Timeout, u32 *Events);

Parameters

The following table lists the Xil_WaitForEvents function arguments.

Table 1. Xil_WaitForEvents Arguments
Type Member Description
UINTPTR EventsRegAddr - Address of register to be checked for event(s) occurrence
u32 EventsMask - Mask indicating event(s) to be checked
u32 WaitEvents - Specific event(s) to be checked
u32 Timeout - Max number of microseconds to wait for an event(s).
u32 * Events - Mask of Events occurred returned in memory pointed by this variable

Returns

XST_SUCCESS - On occurrence of the event(s). XST_FAILURE - Event did not occur before counter reaches 0