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

Convert legacy interrupt id to encoded interrupt ID needed by interrupt wrapper layer.

Prototype

s32 XGetEncodedIntrId(u32 LegacyIntrId, u32 TriggerType, u8 IntrType, u8 IntcType, u32 *IntrId);

Parameters

The following table lists the XGetEncodedIntrId function arguments.

Table 1. XGetEncodedIntrId Arguments
Name Description
LegacyIntrId Interrupt ID of specific peripheral/PL-PS interrupt port documented in TRM of targeted SoC.
u32 TriggerType TriggerType Trigger type for targted interrupt ID (documented in TRM of targeted SoC) 1 = low-to-high edge triggered 2 = high-to-low edge triggered 4 = active high level-sensitive 8 = active low level-sensitive
IntrType Interrupt type of targeted interrupt ID. 0 = SPI 1 = PPI (not applicable for AXI INTC) 2 = SGI
IntcType Parent interrupt contoller of targeted interrupt ID 1 = AXI INTC 0 = GIC
IntrId Interrupt ID in encoded format compliant with interrupt wrapper layer. It is output parameter.

Returns

XST_SUCCESS if LegacyIntrId is encoded successfully and copied to IntrId XST_FAILURE in case of incorrect input parameter