HDMI Intel® Arria 10 FPGA IP Design Example User Guide

Download PDF
ID 683156
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. HDMI Intel® FPGA IP Design Example Quick Start Guide for Intel® Arria® 10 Devices 2. HDMI 2.1 Design Example (Support FRL = 1) 3. HDMI 2.0 Design Example (Support FRL = 0) 4. HDCP Over HDMI 2.0/2.1 Design Example 5. HDMI Intel® Arria® 10 FPGA IP Design Example User Guide Archives 6. Revision History for HDMI Intel® Arria® 10 FPGA IP Design Example User Guide
1. HDMI Intel® FPGA IP Design Example Quick Start Guide for Intel® Arria® 10 Devices x
1.1. Generating the Design 1.2. Simulating the Design 1.3. Compiling and Testing the Design 1.4. HDMI Intel® FPGA IP Design Example Parameters
2. HDMI 2.1 Design Example (Support FRL = 1) x
2.1. HDMI 2.1 RX-TX Retransmit Design Block Diagram 2.2. Creating RX-Only or TX-Only Designs 2.3. Hardware and Software Requirements 2.4. Directory Structure 2.5. Design Components 2.6. Dynamic Range and Mastering (HDR) InfoFrame Insertion and Filtering 2.7. Design Software Flow 2.8. Running the Design in Different FRL Rates 2.9. Clocking Scheme 2.10. Interface Signals 2.11. Design RTL Parameters 2.12. Hardware Setup 2.13. Simulation Testbench 2.14. Design Limitations 2.15. Debugging Features 2.16. Upgrading Your Design
2.5. Design Components x
2.5.1. HDMI TX Components 2.5.2. HDMI RX Components 2.5.3. Top-Level Common Blocks
2.15. Debugging Features x
2.15.1. Software Debugging Message 2.15.2. SCDC Information from the Sink Connected to TX 2.15.3. Clock Frequency Measurement
3. HDMI 2.0 Design Example (Support FRL = 0) x
3.1. HDMI 2.0 RX-TX Retransmit Design Block Diagram 3.2. Hardware and Software Requirements 3.3. Directory Structure 3.4. Design Components 3.5. Dynamic Range and Mastering (HDR) InfoFrame Insertion and Filtering 3.6. Clocking Scheme 3.7. Interface Signals 3.8. Design RTL Parameters 3.9. Hardware Setup 3.10. Simulation Testbench 3.11. Upgrading Your Design
4. HDCP Over HDMI 2.0/2.1 Design Example x
4.1. High-bandwidth Digital Content Protection (HDCP) 4.2. Nios II Processor Software Flow 4.3. Design Walkthrough 4.4. Protection of Encryption Key Embedded in FPGA Design 4.5. Security Considerations 4.6. Debug Guidelines
4.1. High-bandwidth Digital Content Protection (HDCP) x
4.1.1. HDCP Over HDMI Design Example Architecture
4.3. Design Walkthrough x
4.3.1. Set Up the Hardware 4.3.2. Generate the Design 4.3.3. Include HDCP Production Keys 4.3.4. Compile the Design 4.3.5. View the Results
4.3.3. Include HDCP Production Keys x
4.3.3.1. Store plain HDCP production keys in the FPGA (Support HDCP Key Management = 0) 4.3.3.2. Store encrypted HDCP production keys in the external flash memory or EEPROM (Support HDCP Key Management = 1)
4.3.3.1. Store plain HDCP production keys in the FPGA (Support HDCP Key Management = 0) x
4.3.3.1.1. HDCP Key Mapping from DCP Key Files 4.3.3.1.2. hdcp1x_tx_kmem.v and hdcp1x_rx_kmem.v files 4.3.3.1.3. hdcp2x_rx_kmem.v file 4.3.3.1.4. hdcp2x_tx_kmem.v file
4.3.3.2. Store encrypted HDCP production keys in the external flash memory or EEPROM (Support HDCP Key Management = 1) x
4.3.3.2.1. Intel KEYENC Encrypt Single Key for Single EEPROM Encrypt N Keys for N EEPROMs 4.3.3.2.2. Key Programmer
4.3.5. View the Results x
4.3.5.1. Push Buttons and LED Functions
4.6. Debug Guidelines x
4.6.1. HDCP Status Signals 4.6.2. Modifying HDCP Software Parameters 4.6.3. Frequently Asked Questions (FAQ)
1. HDMI Intel® FPGA IP Design Example Quick Start Guide for Intel® Arria® 10 Devices
2. HDMI 2.1 Design Example (Support FRL = 1)
3. HDMI 2.0 Design Example (Support FRL = 0)
4. HDCP Over HDMI 2.0/2.1 Design Example
5. HDMI Intel® Arria® 10 FPGA IP Design Example User Guide Archives
6. Revision History for HDMI Intel® Arria® 10 FPGA IP Design Example User Guide

4.3.3.2.1. Intel KEYENC

KEYENC is a command line software utility that Intel uses to encrypt the HDCP production keys with a 128 bits HDCP protection key that you provide. KEYENC outputs encrypted HDCP production keys in hex or bin or header file format. KEYENC also generates mif file containing your provided 128 bits HDCP protection key. KEYDEC requires the mif file.

System Requirement:
  1. x86 64-bit machine with Windows 10 OS
  2. Visual C++ Redistributable package for Visual Studio 2019(x64)
Note: You must install Microsoft Visual C++ for VS 2019. You can check whether Visual C++ redistributable is installed from Windows > Control Panel > Programs and Features. If Microsoft Visual C++is installed, you can see Visual C++ xxxx Redistributable (x64). Otherwise, you can download and install Visual C++ Redistributable from Microsoft website. Refer to the related information for the download link.
Table 53.  KEYENC Command Line Options
Command Line Options Arguement/Description
-k <HDCP protection key file>

Text file containing only the 128 bits HDCP protection key in hexadecimal. Example: f0f1f2f3f4f5f6f7f8f9fafbfcfdfeff
-hdcp1tx

<HDCP 1.4 TX production keys file>

HDCP 1.4 transmitter production keys file from DCP (.bin file)

-hdcp1rx <HDCP 1.4 RX production keys file>

HDCP 1.4 receiver production keys file from DCP (.bin file)

-hdcp2tx <HDCP 2.3 TX production keys file>

HDCP 2.3 transmitter production keys file from DCP (.bin file)

-hdcp2rx <HDCP 2.3 RX production keys file>

HDCP 2.3 receiver production keys file from DCP (.bin file)

-hdcp1txkeys

<HDCP key range>

Specify the key range for selected input (.bin) files

-hdcp1txkeys|hdcp1rxkeys|hdcp2rxkeys n-m

where

n = key start (1 or >1)

m = key end (n or >n)

Example:

Select 1 to 1000 keys from each HDCP 1.4 TX, HDCP 1.4 RX and HCDP 2.3 RX production keys file.

“-hdcp1txkeys 1-1000 -hdcp1rxkeys 1-1000 -hdcp2rxkeys 1-1000”

Note:
  1. If you are not using any HDCP production keys file, you will not require the HDCP key range. If you are not using the argument in command line, the default key range is 0.
  2. You can also select different index of the keys for HDCP production keys file. However, number of keys should match the selected options.

    Example: Select different 100 keys

    Select first 100 keys from HDCP 1.4 TX production keys file

    “-hdcp1txkeys 1-100”

    Select keys 300 to 400 for HDCP 1.4 RX production keys file

    “-hdcp1rxkeys 300-400”

    Select keys 600 to 700 for HDCP 2.3 RX production keys file

    “-hdcp2rxkeys 600-700”
-hdcp1rxkeys
-hdcp2rxkeys
-o

Output file format <bin|hex|h>. Default is hex file.

Generate encrypted HDCP production keys in binary file format: -o bin

Generate encrypted HDCP production keys in hex file format: -o hex

Generate encrypted HDCP production keys in header file format: -o h

--check-keys

Print number of keys available in input files.

Example:

keyenc.exe -hdcp1tx <HDCP 1.4 TX production keys file> -hdcp1rx <HDCP 1.4 RX production keys file> -hdcp2tx <HDCP 2.3 TX production keys file> -hdcp2rx <HDCP 2.3 RX production keys file> --check-keys
Note: use parameter --check-keys at the end of the command line as mentioned in above example.
--version Print KEYENC version number

You can selectively choose HDCP 1.4 and/or HDCP 2.3 production keys to encrypt. For example, to use only HDCP 2.3 RX production keys to encrypt, use only -hdcp2rx <HDCP 2.3 RX production keys file> -hdcp2rxkeys <HDCP key range> in command line parameters.

Table 54.  KEYENC Common Error Message Guideline
Error Message Guideline
ERROR: HDCP protection key file missing Missing command line parameter -k <HDCP protection key file>
ERROR: key should be 32 hex digits (e.g. f0f1f2f3f4f5f6f7f8f9fafbfcfdfeff) HDCP protection key file should contain only the HDCP protection key in 32 hexadecimal digits.
ERROR: Please specify the key range Key range is not specified for the given input HDCP production keys file.
ERROR: Invalid key range Key range specified for -hdcp1txkeys or -hdcp1rxkeys or -hdcp2rxkeys is not correct.
ERROR: cannot create <Filename> Check the folder permission from the keyenc.exe is being run.
ERROR: -hdcp1txkeys input is invalid Input key range format for HDCP 1.4 TX production keys is invalid.

Correct format is “-hdcp1txkeys n-m” where n >= 1, m >= n

ERROR: -hdcp1rxkeys input is invalid Input key range format for HDCP 1.4 RX production keys is invalid.

Correct format is “-hdcp1rxkeys n-m” where n >= 1, m >= n

ERROR: -hdcp2rxkeys input is invalid Input key range format for HDCP 2.3 RX production keys is invalid.

Correct format is “-hdcp2rxkeys n-m” where n >= 1, m >= n

ERROR: Invalid file <filename> Invalid HDCP production keys file.
ERROR: file type missing for -o option Command line parameter missing for –o <bin|hex|h>.
ERROR: invalid filename - <filename> <filename> is invalid, please use the valid filename without special characters.

Encrypt Single Key for Single EEPROM

Run the following command line from Windows command prompt to encrypt single key of HDCP 1.4 TX, HDCP 1.4 RX, HDCP 2.3 TX and HDCP 2.3 RX with output file format of header file for single EEPROM: 
keyenc.exe -k <HDCP protection key file> -hdcp1tx <HDCP 1.4 TX production keys file> -hdcp1rx <HDCP 1.4 RX production keys file> -hdcp2tx <HDCP 2.3 TX production keys file> -hdcp2rx <HDCP 2.3 RX production keys file> -hdcp1txkeys 1-1 -hdcp1rxkeys 1-1 -hdcp2rxkeys 1-1 -o h

Encrypt N Keys for N EEPROMs

Run the following command line from Windows command prompt to encrypt N keys (starting from key 1) of HDCP 1.4 TX, HDCP 1.4 RX, HDCP 2.3 TX and HDCP 2.3 RX with output file format of hex file for N EEPROMs: 
keyenc.exe -k <HDCP protection key file> -hdcp1tx <HDCP 1.4 TX production keys file> -hdcp1rx <HDCP 1.4 RX production keys file> -hdcp2tx <HDCP 2.3 TX production keys file> -hdcp2rx <HDCP 2.3 RX production keys file> -hdcp1txkeys 1-<N> -hdcp1rxkeys 1-<N> -hdcp2rxkeys 1-<N> -o hex

where N is >= 1 and should match for all the options.

Related Information
Level Two Title