DisplayPort Intel® FPGA IP User Guide

Download PDF
ID 683273
Date 11/12/2021
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents
Document Table of Contents x
1. DisplayPort Intel® FPGA IP Quick Reference 2. About This IP 3. Getting Started 4. DisplayPort Intel® FPGA IP Hardware Design Examples 5. DisplayPort Source 6. DisplayPort Sink 7. DisplayPort Intel® FPGA IP Parameters 8. DisplayPort Intel® FPGA IP Simulation Example 9. DisplayPort API Reference 10. DisplayPort Source Register Map and DPCD Locations 11. DisplayPort Sink Register Map and DPCD Locations 12. DisplayPort Intel® FPGA IP User Guide Archives 13. Document Revision History for the DisplayPort Intel® FPGA IP User Guide
1. DisplayPort Intel® FPGA IP Quick Reference x
1.1. DisplayPort Terms and Acronyms
2. About This IP x
2.1. Release Information 2.2. Device Family Support 2.3. IP Core Verification 2.4. Performance and Resource Utilization
3. Getting Started x
3.1. Installing and Licensing Intel® FPGA IP Cores 3.2. Specifying IP Parameters and Options 3.3. Simulating the Design 3.4. Compiling the Full Design and Programming the FPGA
3.1. Installing and Licensing Intel® FPGA IP Cores x
3.1.1. Intel® FPGA IP Evaluation Mode
3.3. Simulating the Design x
3.3.1. Simulating with the ModelSim Simulator
4. DisplayPort Intel® FPGA IP Hardware Design Examples x
4.1. DisplayPort Intel® FPGA IP Hardware Design Examples for Intel® Arria® 10, Intel® Cyclone® 10 GX, and Intel® Stratix® 10 Devices 4.2. HDCP Over DisplayPort Design Example for Intel® Arria® 10 and Intel® Stratix® 10 Devices 4.3. DisplayPort Intel® FPGA IP Hardware Design Examples for Arria V, Cyclone V, and Stratix V Devices
4.3. DisplayPort Intel® FPGA IP Hardware Design Examples for Arria V, Cyclone V, and Stratix V Devices x
4.3.1. Clock Recovery Core 4.3.2. Transceiver and Clocking 4.3.3. Required Hardware 4.3.4. Design Walkthrough 4.3.5. DisplayPort Link Training Flow 4.3.6. DisplayPort Post Link Training Adjust Request Flow (LQA) 4.3.7. DisplayPort MST Source User Application
4.3.1. Clock Recovery Core x
4.3.1.1. Clock Recovery Core Parameters 4.3.1.2. Clock Recovery Interface
4.3.1.2. Clock Recovery Interface x
4.3.1.2.1. Video Input Port
4.3.4. Design Walkthrough x
4.3.4.1. Set Up the Hardware 4.3.4.2. Copy the Design Files to Your Working Directory 4.3.4.3. Build the FPGA Design 4.3.4.4. Load and Run the Software 4.3.4.5. View the Results
5. DisplayPort Source x
5.1. Main Data Path 5.2. Controller Interface 5.3. Sideband Channel 5.4. Source Embedded DisplayPort (eDP) Support 5.5. HDCP 1.3 TX Architecture 5.6. HDCP 2.3 TX Architecture 5.7. Source Interfaces 5.8. Source Clock Tree
5.1. Main Data Path x
5.1.1. Video Packetizer Path 5.1.2. Video Geometry Measurement Path 5.1.3. Audio and Secondary Stream Encoder Path 5.1.4. Training and Link Quality Patterns Generator
5.7. Source Interfaces x
5.7.1. Controller Interface 5.7.2. AUX Interface 5.7.3. Video Interface 5.7.4. TX Transceiver Interface 5.7.5. Transceiver Reconfiguration Interface 5.7.6. Transceiver Analog Reconfiguration Interface 5.7.7. Secondary Stream Interface 5.7.8. Audio Interface
5.7.3. Video Interface x
5.7.3.1. Video Interface (TX Video IM Enable = 0) 5.7.3.2. Video Interface (TX Video IM Enable = 1)
6. DisplayPort Sink x
6.1. Sink Embedded DisplayPort (eDP) Support 6.2. Sink Non-GPU Mode Support 6.3. HDCP 1.3 RX Architecture 6.4. HDCP 2.3 RX Architecture 6.5. Sink Interfaces 6.6. Sink Clock Tree
6.5. Sink Interfaces x
6.5.1. Controller Interface 6.5.2. AUX Interface 6.5.3. Debugging Interface 6.5.4. Video Interface 6.5.5. Clocked Video Input Interface 6.5.6. RX Transceiver Interface 6.5.7. Transceiver Reconfiguration Interface 6.5.8. Secondary Stream Interface 6.5.9. Audio Interface 6.5.10. Non-GPU Mode EDID Interface 6.5.11. MSA Interface
6.5.2. AUX Interface x
6.5.2.1. AUX Debug Interface 6.5.2.2. EDID Interface
6.5.3. Debugging Interface x
6.5.3.1. Link Parameters Interface 6.5.3.2. Video Stream Out Interface
7. DisplayPort Intel® FPGA IP Parameters x
7.1. DisplayPort Intel® FPGA IP Source Parameters 7.2. DisplayPort Intel® FPGA IP Sink Parameters
8. DisplayPort Intel® FPGA IP Simulation Example x
8.1. Design Walkthrough
8.1. Design Walkthrough x
8.1.1. Copy the Simulation Files to Your Working Directory 8.1.2. Generate the IP Simulation Files and Scripts, and Compile and Simulate 8.1.3. View the Results
9. DisplayPort API Reference x
9.1. Using the Library 9.2. btc_dprx_syslib API Reference 9.3. btc_dprx_aux_get_request 9.4. btc_dprx_aux_handler 9.5. btc_dprx_aux_post_reply 9.6. btc_dprx_baseaddr 9.7. btc_dprx_dpcd_gpu_access 9.8. btc_dprx_edid_set 9.9. btc_dprx_hpd_get 9.10. btc_dprx_hpd_pulse 9.11. btc_dprx_hpd_set 9.12. btc_dprx_lt_eyeq_init 9.13. btc_dprx_lt_force 9.14. btc_dprx_rtl_ver 9.15. btc_dprx_sw_ver 9.16. btc_dprx_syslib_add_rx 9.17. btc_dprx_syslib_info 9.18. btc_dprx_syslib_init 9.19. btc_dprx_syslib_monitor 9.20. btc_dprx_mst_link_addr_rep_set 9.21. btc_dprx_mst_conn_stat_notify_req 9.22. btc_dprx_mst_conn_stat_notify_rep 9.23. btc_dptx_syslib API Reference 9.24. btc_dptx_aux_i2c_read 9.25. btc_dptx_aux_i2c_write 9.26. btc_dptx_aux_read 9.27. btc_dptx_aux_write 9.28. btc_dptx_baseaddr 9.29. btc_dptx_edid_block_read 9.30. btc_dptx_edid_read 9.31. btc_dptx_fast_link_training 9.32. btc_dptx_hpd_change 9.33. btc_dptx_is_link_up 9.34. btc_dptx_link_bw 9.35. btc_dptx_link_training 9.36. btc_dptx_rtl_ver 9.37. btc_dptx_set_color_space 9.38. btc_dptx_sw_ver 9.39. btc_dptx_syslib_add_tx 9.40. btc_dptx_syslib_init 9.41. btc_dptx_syslib_monitor 9.42. btc_dptx_test_autom 9.43. btc_dptx_video_enable 9.44. btc_dptx_mst_allocate_payload_rep 9.45. btc_dptx_mst_allocate_payload_req 9.46. btc_dptx_mst_clear_payload_table_rep 9.47. btc_dptx_mst_clear_payload_table_req 9.48. btc_dptx_mst_conn_stat_notify_req 9.49. btc_dptx_mst_down_rep_irq 9.50. btc_dptx_mst_enable 9.51. btc_dptx_mst_enum_path_rep 9.52. btc_dptx_mst_enum_path_req 9.53. btc_dptx_mst_get_msg_transact_ver_rep 9.54. btc_dptx_mst_get_msg_transact_ver_req 9.55. btc_dptx_mst_link_address_rep 9.56. btc_dptx_mst_link_address_req 9.57. btc_dptx_mst_remote_dpcd_wr_rep 9.58. btc_dptx_mst_remote_dpcd_wr_req 9.59. btc_dptx_mst_remote_i2c_rd_rep 9.60. btc_dptx_mst_remote_i2c_rd_req 9.61. btc_dptx_mst_set_color_space 9.62. btc_dptx_mst_tavgts_set 9.63. btc_dptx_mst_up_req_irq 9.64. btc_dptx_mst_vcpid_set 9.65. btc_dptx_mst_vcptab_addvc 9.66. btc_dptx_mst_vcptab_clear 9.67. btc_dptx_mst_vcptab_delvc 9.68. btc_dptx_mst_vcptab_update 9.69. btc_dptxll_syslib API Reference 9.70. btc_dptxll_hpd_change 9.71. btc_dptxll_hpd_irq 9.72. btc_dptxll_mst_cmp_ports 9.73. btc_dptxll_mst_edid_read_rep 9.74. btc_dptxll_mst_edid_read_req 9.75. btc_dptxll_mst_get_device_ports 9.76. btc_dptxll_mst_set_csn_callback 9.77. btc_dptxll_mst_topology_discover 9.78. btc_dptxll_stream_allocate_rep 9.79. btc_dptxll_stream_allocate_req 9.80. btc_dptxll_stream_calc_VCP_size 9.81. btc_dptxll_stream_delete_rep 9.82. btc_dptxll_stream_delete_req 9.83. btc_dptxll_stream_get 9.84. btc_dptxll_stream_set_color_space 9.85. btc_dptxll_stream_set_pixel_rate 9.86. btc_dptxll_sw_ver 9.87. btc_dptxll_syslib_add_tx 9.88. btc_dptxll_syslib_init 9.89. btc_dptxll_syslib_monitor 9.90. btc_dpxx_syslib Additional Types 9.91. btc_dprx_syslib Supported DPCD Locations
10. DisplayPort Source Register Map and DPCD Locations x
10.1. Source General Registers 10.2. Source MSA Registers 10.3. Source Link PHY Control and Status 10.4. Source Timestamp 10.5. Source CRC Registers 10.6. Source Audio Registers 10.7. Source MST Registers 10.8. Source AUX Controller Interface 10.9. Source-Supported DPCD Locations
10.1. Source General Registers x
10.1.1. DPTX_TX_CONTROL 10.1.2. DPTX_TX_STATUS 10.1.3. DPTX_TX_VERSION
10.2. Source MSA Registers x
10.2.1. DPTX0_MSA_MVID 10.2.2. DPTX0_MSA_NVID 10.2.3. DPTX0_MSA_HTOTAL 10.2.4. DPTX0_MSA_VTOTAL 10.2.5. DPTX0_MSA_HSP 10.2.6. DPTX0_MSA_HSW 10.2.7. DPTX0_MSA_HSTART 10.2.8. DPTX0_MSA_VSTART 10.2.9. DPTX0_MSA_VSP 10.2.10. DPTX0_MSA_VSW 10.2.11. DPTX0_MSA_HWIDTH 10.2.12. DPTX0_MSA_VHEIGHT 10.2.13. DPTX0_MSA_MISC0 10.2.14. DPTX0_MSA_MISC1 10.2.15. DPTX0_MSA_COLOR 10.2.16. DPTX0_VBID
10.3. Source Link PHY Control and Status x
10.3.1. DPTX_PRE_VOLT0 10.3.2. DPTX_PRE_VOLT1 10.3.3. DPTX_PRE_VOLT2 10.3.4. DPTX_PRE_VOLT3 10.3.5. DPTX_RECONFIG 10.3.6. DPTX_TEST_80BIT_PATTERN1 10.3.7. DPTX_TEST_80BIT_PATTERN2 10.3.8. DPTX_TEST_80BIT_PATTERN3
10.7. Source MST Registers x
10.7.1. DPTX_MST_VCPTAB0 10.7.2. DPTX_MST_VCPTAB1 10.7.3. DPTX_MST_VCPTAB2 10.7.4. DPTX_MST_VCPTAB3 10.7.5. DPTX_MST_VCPTAB4 10.7.6. DPTX_MST_VCPTAB5 10.7.7. DPTX_MST_VCPTAB6 10.7.8. DPTX_MST_VCPTAB7 10.7.9. DPTX_MST_TAVG_TS
10.8. Source AUX Controller Interface x
10.8.1. DPTX_AUX_CONTROL 10.8.2. DPTX_AUX_COMMAND 10.8.3. DPTX_AUX_BYTE0 10.8.4. DPTX_AUX_BYTE1 10.8.5. DPTX_AUX_BYTE2 10.8.6. DPTX_AUX_BYTE3 10.8.7. DPTX_AUX_BYTE4 10.8.8. DPTX_AUX_BYTE5 10.8.9. DPTX_AUX_BYTE6 10.8.10. DPTX_AUX_BYTE7 10.8.11. DPTX_AUX_BYTE8 10.8.12. DPTX_AUX_BYTE9 10.8.13. DPTX_AUX_BYTE10 10.8.14. DPTX_AUX_BYTE11 10.8.15. DPTX_AUX_BYTE12 10.8.16. DPTX_AUX_BYTE13 10.8.17. DPTX_AUX_BYTE14 10.8.18. DPTX_AUX_BYTE15 10.8.19. DPTX_AUX_BYTE16 10.8.20. DPTX_AUX_BYTE17 10.8.21. DPTX_AUX_BYTE18 10.8.22. DPTX_AUX_RESET
11. DisplayPort Sink Register Map and DPCD Locations x
11.1. Sink General Registers 11.2. Sink Timestamp 11.3. Sink Bit-Error Counters 11.4. Sink MSA Registers 11.5. Sink Audio Registers 11.6. Sink MST Registers 11.7. Sink AUX Controller Interface 11.8. Sink CRC Registers 11.9. Sink-Supported DPCD Locations
11.1. Sink General Registers x
11.1.1. DPRX_RX_CONTROL 11.1.2. DPRX_RX_STATUS 11.1.3. DPRX_BER_CONTROL 11.1.4. DPRX_BER_CNT0 11.1.5. DPRX_BER_CNT1
11.3. Sink Bit-Error Counters x
11.3.1. DPRX_BER_CNTI0 11.3.2. DPRX_BER_CNTI1
11.4. Sink MSA Registers x
11.4.1. DPRX0_MSA_MVID 11.4.2. DPRX0_MSA_NVID 11.4.3. DPRX0_MSA_HTOTAL 11.4.4. DPRX0_MSA_VTOTAL 11.4.5. DPRX0_MSA_HSP 11.4.6. DPRX0_MSA_HSW 11.4.7. DPRX0_MSA_HSTART 11.4.8. DPRX0_MSA_VSTART 11.4.9. DPRX0_MSA_VSP 11.4.10. DPRX0_MSA_VSW 11.4.11. DPRX0_MSA_HWIDTH 11.4.12. DPRX0_MSA_VHEIGHT 11.4.13. DPRX0_MSA_MISC0 11.4.14. DPRX0_MSA_MISC1 11.4.15. DPRX0_MSA_COLOR 11.4.16. DPRX0_VBID
11.5. Sink Audio Registers x
11.5.1. DPRX0_AUD_MAUD 11.5.2. DPRX0_AUD_NAUD 11.5.3. DPRX0_AUD_AIF0 11.5.4. DPRX0_AUD_AIF1 11.5.5. DPRX0_AUD_AIF2 11.5.6. DPRX0_AUD_AIF3 11.5.7. DPRX0_AUD_AIF4
11.6. Sink MST Registers x
11.6.1. DPRX_MST_VCPTAB0 11.6.2. DPRX_MST_VCPTAB1 11.6.3. DPRX_MST_VCPTAB2 11.6.4. DPRX_MST_VCPTAB3 11.6.5. DPRX_MST_VCPTAB4 11.6.6. DPRX_MST_VCPTAB5 11.6.7. DPRX_MST_VCPTAB6 11.6.8. DPRX_MST_VCPTAB7
11.7. Sink AUX Controller Interface x
11.7.1. DPRX_AUX_CONTROL 11.7.2. DPRX_AUX_STATUS 11.7.3. DPRX_AUX_COMMAND 11.7.4. DPRX_AUX_BYTE0 11.7.5. DPRX_AUX_BYTE1 11.7.6. DPRX_AUX_BYTE2 11.7.7. DPRX_AUX_BYTE3 11.7.8. DPRX_AUX_BYTE4 11.7.9. DPRX_AUX_BYTE5 11.7.10. DPRX_AUX_BYTE6 11.7.11. DPRX_AUX_BYTE7 11.7.12. DPRX_AUX_BYTE8 11.7.13. DPRX_AUX_BYTE9 11.7.14. DPRX_AUX_BYTE10 11.7.15. DPRX_AUX_BYTE11 11.7.16. DPRX_AUX_BYTE12 11.7.17. DPRX_AUX_BYTE13 11.7.18. DPRX_AUX_BYTE14 11.7.19. DPRX_AUX_BYTE15 11.7.20. DPRX_AUX_BYTE16 11.7.21. DPRX_AUX_BYTE17 11.7.22. DPRX_AUX_BYTE18 11.7.23. DPRX_AUX_I2C0 11.7.24. DPRX_AUX_I2C1 11.7.25. DPRX_AUX_RESET 11.7.26. DPRX_AUX_HPD
1. DisplayPort Intel® FPGA IP Quick Reference
2. About This IP
3. Getting Started
4. DisplayPort Intel® FPGA IP Hardware Design Examples
5. DisplayPort Source
6. DisplayPort Sink
7. DisplayPort Intel® FPGA IP Parameters
8. DisplayPort Intel® FPGA IP Simulation Example
9. DisplayPort API Reference
10. DisplayPort Source Register Map and DPCD Locations
11. DisplayPort Sink Register Map and DPCD Locations
12. DisplayPort Intel® FPGA IP User Guide Archives
13. Document Revision History for the DisplayPort Intel® FPGA IP User Guide

4.3.7. DisplayPort MST Source User Application

For MST source instantiations, you need to create a user application at the top software layer to invoke the Link Layer level API functions of the btc_dptxll_syslib library.

The btc_dptxll_syslib library handles most of the Link Layer functionality. The library performs marginal SST operation, which in turn, becomes evident for MST operations. The btc_dptxll_syslib library uses the services provided by the btc_dptx_syslib library.

You can use the user application to perform MST discovery topology by invoking a single API function (btc_dptxll_mst_get_device_port()). In turn, the btc_dptxll_syslib library implements this functionality by invoking a number of btc_dptx_syslib MST messaging functions such as btc_dptx_mst_link_address_req(), btc_dptx_mst_enum_path_req(), and btc_dptx_mst_remote_i2c_rd_req().

A typical MST source user application must perform the following steps to display an image on a connected DisplayPort sink device:
  1. Wait for HPD signal to become 1.
  2. Read the connected sink DPCD version and MST capabilities.
    • If the sink is not MST capable, only a single-stream (SST) connection is possible. In this case, no further action is required as SST connections are mostly handled automatically.
    • If the sink supports MST, skip this step.
  3. Perform MST topology discovery by collecting all device ports reachable through the connected sink. Invoke btc_dptxll_mst_get_device_ports() until either its outcome is valid or an error is returned. For a successful return value, move to the following step.
  4. Browse through the list of the device ports and search for a suitable device output port. This step highly depends on the definition of suitable device port. Some applications may require reading of the device port EDID to check the desired resolution supported by the port (use btc_dptxll_mst_edid_read_req() and btc_dptxll_mst_edid_read_rep() API functions). If a suitable device output port is found, move to the next step.
  5. Verify if the main link connection between the DisplayPort source and connected sink is still up.
    • If the link is down, perform a new Link Training.
    • If the link is up, move to the next step.
    Note: While you can perform the earlier steps even when the main link connection is down, the following steps require the connection to be up. The source needs the connection to calculate the available data bandwidth and make allocation.
  6. Set the video pixel rate of the desired stream by invoking btc_dptxll_stream_set_pixel_rate().
  7. Calculate the required VCP size for the stream by invoking btc_dptxll_stream_calc_VCP_size().
  8. Verify if the required VCP size (number of time slots needed to transport the stream) is available to transport to the desired device output port. Then, move to the next step.
  9. Allocate the stream data to be transported to the desired device output port by invoking btc_dptxll_stream_allocate_req()
  10. Wait for the source to make allocation. Invoke btc_dptxll_stream_allocate_rep() until either the allocation is complete or an error is returned. For a successful allocation, move to the following step.
  11. The allocation of the stream to the device output port completes. MST data transport is now active.
  12. Handle received CONNECTION_STATUS_NOTIFY messages according to the changed topology.
Level Two Title