Application Integration - 3.1 English

HDMI 1.4/2.0 Receiver Subsystem Product Guide (PG236)

Document ID
Release Date
3.1 English

The following figure shows example code to show how an HDMI 1.4/2.0 RX Subsystem can be used in your application.

Figure 1. Application Example Code

To integrate and use the HDMI 1.4/2.0 RX Subsystem driver in your application, the following steps must be followed:

  1. Include the subsystem header file xv_hdmirxss.h that defines the subsystem object.
  2. Provide the storage for a subsystem driver instance in your application code. For example:
    XV_HdmiRxSs HdmiRxSs;
  3. In the subsystem driver instance, there is a metadata structure to store the subsystem hardware configuration. Declare a pointer variable in the application code to point to the instance:
    XV_HdmiRxSs_Config *XV_HdmiRxSs_ConfigPtr;
  4. Set the EDID parameter for the HDMI 1.4/2.0 RX Subsystem Subsystem.
    void XV_HdmiRxSs_SetEdidParam(XV_HdmiRxSs *InstancePtr,
                                  u8 *EdidDataPtr,
                                  u16 Length);
  5. For each subsystem instance, the data structures declared in the previous two steps need to be initialized based on its hardware configuration, which is passed through metadata structure from xparameters.h uniquely identified by device ID.

    To initialize the subsystem, call the following two API functions:

    XV_HdmiRxSs_Config* XV_HdmiRxSs_LookupConfig(u32 DeviceId);
    int XV_HdmiRxSs_CfgInitialize(XV_HdmiRxSs *InstancePtr, 
                                  XV_HdmiRxSs_Config *CfgPtr,
                                  u32 EffectiveAddr);

    The Device ID can be found in xparameters.h:

    XPAR_[HDMI RX Subsystem Instance Name in IPI]_DEVICE_ID
  6. Each interrupt source has an associated ISR defined in the subsystem. Register the ISR with the system interrupt controller and enable the interrupt.
    int XIntc_Connect(XIntc *InstancePtr,
                      u8 Id,
                      XInterruptHandler Handler,
                      void *CallBackRef);
    void XIntc_Enable(XIntc *InstancePtr,
                      u8 Id);

    where ID can be found in xparameters.h.

  1. Prepare the 256 bytes of EDID data and store in an array before calling the specified API function.
  2. The EDID data is loaded into the HDMI 1.4/2.0 RX Subsystem during initialization. This is handled by the subsystem driver, no user intervention is needed.