Xpm_DisableEvent - 2023.1 English

Standalone Library Documentation: BSP and Libraries Document Collection (UG643)
Document ID
UG643
Release Date
2023-05-16
Version
2023.1 English

Disables the requested event counter.

Prototype

u32 Xpm_DisableEvent(u32 EventCntrId);

Parameters

The following table lists the Xpm_DisableEvent function arguments.

Table 1. Xpm_DisableEvent Arguments
Name Description
EventCntrId Event Counter ID. The counter ID is the same that was earlier returned through a call to Xpm_SetUpAnEvent. Cortex-R5 supports only 3 counters. The valid values are 0, 1, or 2.

Returns

  • XST_SUCCESS if successful.
  • XST_FAILURE if the passed Counter ID is invalid (i.e. greater than 2).