Application Callback Functions - 1.2 English

HDMI 2.1 Receiver Subsystem v1.2 Product Guide (PG351)

Document ID
PG351
Release Date
2023-10-31
Version
1.2 English

The subsystem driver provides a mechanism for the application to register a user-defined function that gets called within an interrupt context.

Callback functions defined in the application code must be registered with provided handlers, using the following defined API:

int XV_HdmiRxSs1_SetCallback(XV_HdmiRxSs1 *InstancePtr,
                             u32 HandlerType,
                             void *CallbackFuncPtr,
                             void *CallbackRef);

Available handlers are defined in xv_hdmirxss1.h:

  • XV_HDMIRXSS1_HANDLER_CONNECT
  • XV_HDMIRXSS1_HANDLER_AUX
  • XV_HDMIRXSS1_HANDLER_AUD
  • XV_HDMIRXSS1_HANDLER_LNKSTA
  • XV_HDMIRXSS1_HANDLER_STREAM_UP
  • XV_HDMIRXSS1_HANDLER_STREAM_DOWN
  • XV_HDMIRXSS1_HANDLER_STREAM_INIT
  • XV_HDMIRXSS1_HANDLER_FRL_CONFIG
  • XV_HDMIRXSS1_HANDLER_FRL_START
  • XV_HDMIRXSS1_HANDLER_TMDS_CONFIG
  • XV_HDMIRXSS1_HANDLER_HDCP_AUTHENTICATE
  • XV_HDMIRXSS1_HANDLER_VFP_CH
  • XV_HDMIRXSS1_HANDLER_VRR_RDY
  • XV_HDMIRXSS1_HANDLER_DYN_HDR
Note: The following HDMI 2.1 RX Subsystem interrupt callbacks are defined in the driver, but they are not directly programmable in this release.
  • XV_HDMIRXSS1_HANDLER_BRDGOVERFLOW
  • XV_HDMIRXSS1_HANDLER_DDC
  • XV_HDMIRXSS1_HANDLER_TMDS_CLK_RATIO

HDCP related callbacks are not covered in this document.

  • XV_HDMIRXSS1_HANDLER_HDCP
  • XV_HDMIRXSS1_HANDLER_HDCP_AUTHENTICATION_REQUEST
  • XV_HDMIRXSS1_HANDLER_HDCP_AUTHENTICATED
  • XV_HDMIRXSS1_HANDLER_HDCP_UNAUTHENTICATED
  • XV_HDMIRXSS1_HANDLER_HDCP_STREAM_MANAGE_REQUEST
  • XV_HDMIRXSS1_HANDLER_HDCP_TOPOLOGY_UPDATE
  • XV_HDMIRXSS1_HANDLER_HDCP_ENCRYPTION_UPDATE