| dp12rxss Vitis Drivers API Documentation

- Overview
- Data Structures
- APIs
- File List
- Examples

dp12rxss Documentation

This is the main header file for Xilinx DisplayPort Receiver Subsystem core.It abstracts Subsystem cores and provides high level API's to application developer.

Core Features

For a full description of DisplayPort Receiver Subsystem core, please see the hardware specification.

Software Initialization & Configuration

The application needs to do following steps in order for preparing the DisplayPort Receiver Subsystem core to be ready.

- Call XDpRxSs_LookupConfig using a device ID to find the core configuration.
- Call XDpRxSs_CfgInitialize to initialize the device and the driver instance associated with it.

Interrupts

The DisplayPort RX Subsystem driver provides the interrupt handlers

- XDpRxSs_DpIntrHandler
- XDpRxSs_HdcpIntrHandler
- XDpRxSs_TmrCtrIntrHandler, for handling the interrupt from the DisplayPort, optional HDCP and Timer Counter sub-cores respectively. The users of this driver have to register this handler with the interrupt system and provide the callback functions by using XDpRxSs_SetCallBack API.

Virtual Memory

This driver supports Virtual Memory. The RTOS is responsible for calculating the correct device base address in Virtual Memory space.

Threads

This driver is not thread safe. Any needs for threads or thread mutual exclusion must be satisfied by the layer above this driver.

Asserts

Asserts are used within all Xilinx drivers to enforce constraints on argument values. Asserts can be turned off on a system-wide basis by defining at compile time, the NDEBUG identifier. By default, asserts are turned on and it is recommended that users leave asserts on during development.

Building the driver

The DisplayPort Receiver Subsystem driver is composed of several source files. This allows the user to build and link only those parts of the driver that are necessary.

    MODIFICATION HISTORY:

    Ver  Who Date     Changes

    1.00 sha 05/18/15 Initial release.
    2.00 sha 10/05/15 Removed HDCP interrupt handler types.
                      Added HDCP and Timer Counter support.
    3.0  sha 02/19/16 Removed indexing from enum XDpRxSs_HandlerType.
                      Added handler type as enum for HDCP:
                      XDPRXSS_HANDLER_HDCP_RPTR_TDSA_EVENT.
                      Added function: XDpRxSs_DownstreamReady.
    3.1  als 08/08/16 Added HDCP timeout functionality.
    3.1  aad 09/07/16 Updates to support 64-bit base addresses.
    4.0  aad 12/01/16 Added interrupt handler for HDCP authentication
         ms  01/23/17 Modified xil_printf statement in main function for all
                      examples to ensure that "Successfully ran" and "Failed"
                      strings are available in all examples. This is a fix
                      for CR-965028.
         ms  03/17/17 Modified readme.txt file in examples folder for doxygen
                      generation.
    4.1  tu  09/08/17 Added three driver side interrupt handler for Video,
                      NoVideo and PowerChange events