F-Tile SDI II Intel® Agilex™ FPGA IP Design Example User Guide

Download PDF
ID 710496
Date 1/28/2022
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. F-Tile SDI II Intel® Agilex™ FPGA IP Design Example Quick Start Guide 2. Design Example Detailed Description 3. Document Revision History for the F-Tile SDI II Intel® Agilex™ Design Example User Guide
1. F-Tile SDI II Intel® Agilex™ FPGA IP Design Example Quick Start Guide x
1.1. Directory Structure 1.2. Generating the Design 1.3. Simulating the Design 1.4. Compiling and Testing the Design in Hardware 1.5. Design Example Parameters
2. Design Example Detailed Description x
2.1. Features 2.2. Hardware and Software Requirements 2.3. Functional Description 2.4. Simulation
2.3. Functional Description x
2.3.1. Design Components 2.3.2. Clocking Scheme
2.3.2. Clocking Scheme x
2.3.2.1. Clocking Scheme Component
2.4. Simulation x
2.4.1. Testbench Components 2.4.2. Test Description 2.4.3. Hardware Testing 2.4.4. Signal
2.4.3. Hardware Testing x
2.4.3.1. Parallel loopback 2.4.3.2. Serial loopback
1. F-Tile SDI II Intel® Agilex™ FPGA IP Design Example Quick Start Guide
2. Design Example Detailed Description
3. Document Revision History for the F-Tile SDI II Intel® Agilex™ Design Example User Guide

2.4.4. Signal

Table 15.  Top Level Signals
Signal Name Direction Width Description
On-board Oscillators
clk_a_12c_fgt_p_7 Input 1 156.25 Mhz dedicated transceiver reference clock.
clk_a_12c_fgt_p_3 Input 1 148.5 Mhz dedicated transceiver reference clock.
clk_3a_gpio_p_2 Input 1 148.5 Mhz GPIO clock.
User DIP switches, pushbuttons and LEDs
f_gpio_00 Input 1 Pushbutton to powerdown LMK03328 after switching the jumper settings.
fpga_resetn Input 1 Global reset
fpga_sgpio_clk Input 1 SGPIO slave signals. These groups of signals connect to the MAX device to control the on-board LEDs and DIPSW.
fpga_sgpio_sync Input 1
fpga_sgpi Input 1
fgpa_sgpo Output 1
Nextera SDI FMC daughter card pins on FMC port A
clk_a_12c_fgt_p_1 Input 1 297/296.7 Mhz dedicated transceiver reference clock from FMC port A.
fmc_a_rx_p_2/fmc_a_rx_n_2 Input 1 SDI RX serial data from FMC port A.
fmc_a_la_p4 Input 1 RX cable equalizer lock status on Nextera daughter card.
fmc_a_tx_p_0/fmc_a_tx_n_0 Output 1 SDI TX serial data from FMC port A.
fmc_a_la_p24 Output 1 Initialize LMH1983 on Nextera daughter card.
fmc_a_la_n24 Output 1 F sync signal to LMH1983 on Nextera daughter card.
fmc_a_la_p28 Output 1 V sync signal to LMH1983 on Nextera daughter card.
fmc_a_la_n28 Output 1 H sync signal to LMH1983 on Nextera daughter card.
fmc_a_la_p30 Output 1 Powerdown signal to LMK03328 on Nextera daughter card.
Table 16.  RX top/ TX top/ Du top parameters
Parameter name Valid value Default Value Description
NUM_STREAMS 1, 4 1 Define the number of 20-bit data streams from SDI IP. For multi rate mode, the value should be set to 4 while for other modes, the value should be set to 1.
Table 17.  RX top/ TX top/ Du top signals
Signal Name Direction Width Description
Clocks
system_pll_clk Input 1 System PLL output clock. This port must be connected to the system PLL output port from Reference and System PLL Clocks IP.
rx_cdr_refclk Input 1 RX transceiver reference clock. This port must be connected to one of the output ports from Reference and System PLL Clocks IP.
rx_core_refclk Input 1 SDI RX core clock. This clock must be a free-running clock and ranges between 100-156.25 MHz.
tx_pll_refclk Input 1 TX PLL reference clock. This port must be connected to one of the output ports from Reference and System PLL Clocks IP.
sdi_tx_pclk Input 1

SDI TX core parallel clock. This clock must be driven by one of the TX transceivers recovered parallel clocks.

If there are multiple SDI Tx which are getting video data from the same source, you may connect this

rx_vid_clkout Output 1 RX transceiver recovered parallel clock for video data.
tx_vid_clkout Output 1 TX transceiver recovered parallel clock for video data.
Reset
tx_resetn Input 1 TX core and PHY reset signal.
rx_resetn Input 1 RX core and PHY reset signal
sdi_rx_rst_proto_out Output 1 Reset signal generated to reset the receiver downstream protocol logic. This generated reset signal is synchronous to rx_vid_clkout clock domain
Video signal interfaces (Interfacing with VIP components)
rx_vid_data Output 20*N Receiver parallel video data out.
rx_vid_datavalid Output 1

Data valid signal generated from SDI RX core and has the following timing synchronous to rx_vid_clkout:

SD-SDI: 1H 4L 1H 5L

HD/3G/6G/12G-SDI: H
rx_vid_std Output N

Received video standard.

  • 3’b000: SD-SDI
  • 3’b001: HD-SDI
  • 3’b011: 3G-SDI Level A 10-bit Multiplex
  • 3’b010: 3G-SDI Level B 10-bit Multiplex
  • 3’b101: 6G-SDI 10-bit Multiplex Type 1
  • 3’b100: 6G-SDI 10-bit Multiplex Type 2
  • 3’b111: 12G-SDI 10-bit Multiplex Type 1
  • 3’b110: 12G-SDI 10-bit Multiplex Type 2
rx_vid_locked Output 1 Frame locked indicating multiple frames with same timing have been spotted.
rx_vid_hsync Output N Horizontal blanking interval timing signal. The receiver asserts this signal when the horizontal blanking interval is active.
rx_vid_vsync Output   Vertical blanking interval timing signal. The receiver asserts this signal when the vertical blanking interval is active.
rx_vid_f Output N Field bit timing signal. This signal indicates which video field is currently active. For interfaced frame, 0 means first field (F0) while 1 means second field (F1). For progressive frame, the value is always 0.
rx_vid_trs Output N Receiver output signal that indicates current word is TRS. This signal is asserted at the first word of 3FF 000 000 TRS.
tx_vid_data Input 20*N Transmitter parallel video data input
tx_vid_datavalid Input 1

Data valid for the transmitter parallel data. The timing (H:High, L:Low) must be as follows and synchronous to tx_pclk clock domain:

SD-SDI: 1H 4L 1H 5L

HD-SDI: 1H 1L (for triple/multi rate)

H (for single rate)

3G/6G/12G-SDI: H
tx_vid_std Input 3

Indicates the desired transmit video standard.

  • 3’b000: SD-SDI
  • 3’b001: HD-SDI
  • 3’b011: 3G-SDI Level A 10-bit Multiplex
  • 3’b010: 3G-SDI Level B 10-bit Multiplex
  • 3’b101: 6G-SDI 10-bit Multiplex Type 1
  • 3’b100: 6G-SDI 10-bit Multiplex Type 2
  • 3’b111: 12G-SDI 10-bit Multiplex Type 1
  • 3’b110: 12G-SDI 10-bit Multiplex Type 2
Other SDI video protocol interfaces
sdi_tx_enable_crc Input 1 Enable CRC insertion for all SDI video standards except SD-SDI.
sdi_tx_enable_ln Input 1 Enable Line Number insertion for all SDI video standards except SD-SDI.
sdi_tx_ln Input 11*N Line number to be inserted in the data stream when sdi_tx_enable_ln = 1.
sdi_tx_ln_b Input 11*N Line number to be inserted in the data stream when sdi_tx_enable_ln = 1. For 3G level B and 6G/12G 10-bit Multiplex Type 2.
sdi_tx_vpid_overwrite Input 1 Enable this signal to overwrite the existing payload ID embedded in the data stream.
sdi_tx_line_f0 Input 11*N Indicates the line number to be inserted with Payload ID.
sdi_tx_line_f1 Input 11*N
sdi_tx_vpid_byte1 Input 8*N Payload ID byte to be inserted in the payload ID field.
sdi_tx_vpid_byte2 Input 8*N
sdi_tx_vpid_byte3 Input 8*N
sdi_tx_vpid_byte4 Input 8*N
sdi_tx_vpid_byte1_b Input 8*N
sdi_tx_vpid_byte2_b Input 8*N
sdi_tx_vpid_byte3_b Input 8*N
sdi_tx_vpid_byte4_b Input 8*N
sdi_tx_datavalid Output 1

Data valid signal generated from SDI TX core and has the following timing synchronous to tx_vid_clkout:

  • SD-SDI: 1H 4L 1H 5L

  • HD-SDI: 1H 1L (for triple/multi rate)
  • H (for single rate)
  • 3G/6G/12G-SDI: H
sdi_rx_align_locked Output 1 Alignment locked indicating a TRS has been spotted and word alignment performed.
sdi_rx_trs_locked Output N TRS locked indicating six consecutive TRS with same timing have been spotted.
sdi_rx_clkout_is_ntsc_paln Output 1

Indicates that the receiver is receiving video rate at integer or fractional frame rate.

  • 0 – Integer frame rate
  • 1 – Fractional frame rate
sdi_rx_format Output 4*N Received video transport format. Refer to IP User Guide for the encoding value.
sdi_rx_ap Output N Active picture interval timing signal. This signal is asserted when the active picture interval is active
sdi_rx_eav Output N Receiver output signal that indicates current TRS is EAV. This signal is asserted at the fourth word of TRS, which is the XYZ word.
sdi_rx_ln Output 11*N Received line number output from protocol
sdi_rx_ln_b Output 11*N
sdi_rx_crc_error_c Output N CRC error status signal from protocol
sdi_rx_crc_error_y Output N
sdi_rx_crc_error_c_b Output N
sdi_rx_crc_error_y_b Output N
sdi_rx_line_f0 Output 11*N Payload ID status signal from protocol.
sdi_rx_line_f1 Output 11*N
sdi_rx_vpid_byte1 Output 8*N
sdi_rx_vpid_byte2 Output 8*N
sdi_rx_vpid_byte3 Output 8*N
sdi_rx_vpid_byte4 Output 8*N
sdi_rx_vpid_checksum_error Output N
sdi_rx_vpid_valid Output N
sdi_rx_vpid_byte1_b Output 8*N
sdi_rx_vpid_byte2_b Output 8*N
sdi_rx_vpid_byte3_b Output 8*N
sdi_rx_vpid_byte4_b Output 8*N
sdi_rx_vpid_checksum_error_b Output N
sdi_rx_vpid_valid_b Output N
Transceiver Interfaces
gxb_rx_serial_data Input 1 RX transceiver serial data
gxb_rx_serial_data_n Input 1 Differential pair of gxb_rx_serial_data.
gxb_tx_serial_data Output 1 TX transceiver serial data
gxb_tx_serial_data_n Output 1 Differential pair of gxb_tx_serial_data.
gxb_rx_ready Output 1 Indicates that RX transceiver is out of reset and ready for data transfer.
gxb_tx_ready Output 1 Indicates that TX transceiver is out of reset and ready for data transfer.
gxb_tx_reset_ack Output 1 Indicates that TX transceiver is reset.
gxb_rx_reset_ack Output 1 Indicates that RX transceiver is reset.
tx_pll_locked Output 1 TX PLL lock status
cdr_reconfig_busy Output 1 RX CDR reconfiguration status
tx_reconfig_busy Output 1 TX PLL / transceiver reconfiguration status
Table 18.  Loopback top signals
Signal Name Direction Width Description
Clocks
sdi_tx_clkout Input 1 TX transceiver recovered parallel clock for video data.
sdi_rx_clkout Input 1 RX transceiver recovered parallel clock for video data.
Resets
sdi_rx_rst_proto Input 1 Reset signal from RX SDI core to indicate that the protocol is currently held in reset.
gxb_tx_ready Input 1 Used as a reset signal to internal FIFO to indicate that the TX is ready to receive.
SDI related signals
sdi_rx_dataout Input 20*N Receiver recovered parallel video data
sdi_rx_dataout_valid Input 1 Data valid signal generated from SDI RX core
sdi_rx_std Input 3 Received video standard from SDI RX core
sdi_rx_trs Input N Receiver output signal from SDI core that indicates current word is TRS.
sdi_rx_trs_locked Input N TRS locked status signal from SDI RX core
sdi_rx_frame_locked Input 1 Frame locked status signal from SDI RX core
sdi_tx_dataout_valid Input 1 Data valid signal generated from SDI TX core
sdi_tx_datain Output 20*N Parallel video data input to SDI TX core.
sdi_tx_datain_valid Output 1 Data valid for the transmitter parallel data to SDI TX core.
sdi_tx_trs Output 1 Transmitter TRS input to indicate that the current word is a TRS to SDI TX core.
sdi_tx_std Output 3 Indicates the desired transmit video standard to SDI TX core.
Note: N=4 for multi rate, otherwise N=1.
Table 19.  Video pattern generator parameters
Parameter name Valid value Default Value Description
OUTW_MULTP 1, 4 1 Define the output ports width. Select 4 for a multi rate design, otherwise select 1.
SD_BIT_WIDTH 10, 20 10 Define the generated SD interface bit width. This value must match with the SD interface bit width parameter of SDI II TX core in the same design.
TEST_GEN_ANC 0, 1 0 Enable to generate ancillary data packet in output stream. The module inserts the embedded Data ID (DID) packet with 10’h242 if TEST_GEN_VPID is not enabled.
TEST_GEN_VPID 0, 1 0 Enable to generate payload ID packet in output streams. The module inserts the embedded Data ID (DID) packet with 10’h242 if TEST_GEN_VPID is not enabled.
Table 20.  Video pattern generator signals
Signal names Direction Width Description
clk Input 1 Clock signal. This clock must be connected to tx_vid_clkout clock signal from TX/Du top.
rst Input 1 Reset signal. This reset signal should be synchronized with tx_vid_clkout clock signal from TX/Du top.
bar_100_75n Input 1 Enable this signal to generate 100% colorbar pattern, else 75% colorbar pattern.
enable Input 1 This signal acts as a data valid signal to this module. This signal should be connected to sdi_tx_datavalid signal from TX/Du top.
patho Input 1 Enable this signal to generate pathological pattern.
blank Input 1 Enable this signal to generate black signal.
no_color Input 1 Enable this signal to generate bar with no color.
sgmt_frame Input 1 Enable this signal to generate payload ID for segmented frame video format when generating 1080i50 or 1080i60 video.
tx_std Input 3 Indicates the desired transmit video standard. This input signal must match with tx_vid_std on TX/Du top.
tx_format Input 4 Indicates the desired transmit video format.
dl_mapping Input 1 Enable this signal to generate data streams with dual-link mapping. This is only applicable for HD dual link or 3G Level B Dual link video standard.
ntsc_paln Input 1 Enable this signal to generate payload ID for fractional frame rate video format, else the module generates integer frame rate version.
dout Output 20*N Data output signal to be connected to tx_vid_data input signal on TX/Du top.
dout_valid Output 1 Data valid output signal to be connected to tx_vid_datavalid input signal on TX/Du top.
trs Output 1 TRS output signal to be connected to tx_vid_trs input signal on TX/Du top.
ln Output 11*N Line number output signal to be connected to sdi_tx_ln input signal on TX/Du top.
dout_b Output 20 Data output signal for link B (HD dual-link).
dout_valid_b Output 1 Data valid output signal for link B (HD dual-link).
trs_b Output 1 TRS output signal for link B (HD dual-link).
ln_b Output 11*N Line number output signal to be connected to sdi_tx_ln_b input signal on TX/Du top.
vpid_byte1 Output 8*N Payload ID output signal to be connected to sdi_tx_vpid_byte1 input signal on TX/Du top.
vpid_byte2 Output 8*N Payload ID output signal to be connected to sdi_tx_vpid_byte2 input signal on TX/Du top.
vpid_byte3 Output 8*N Payload ID output signal to be connected to sdi_tx_vpid_byte3 input signal on TX/Du top.
vpid_byte4 Output 8*N Payload ID output signal to be connected to sdi_tx_vpid_byte4 input signal on TX/Du top.
vpid_byte1_b Output 8*N Payload ID output signal to be connected to sdi_tx_vpid_byte1_b input signal on TX/Du top.
vpid_byte2_b Output 8*N Payload ID output signal to be connected to sdi_tx_vpid_byte2_b input signal on TX/Du top.
vpid_byte3_b Output 8*N Payload ID output signal to be connected to sdi_tx_vpid_byte3_b input signal on TX/Du top.
vpid_byte4_b Output 8*N Payload ID output signal to be connected to sdi_tx_vpid_byte4_b input signal on TX/Du top.
line_f0 Output 11*N Line number output signal to be inserted with Payload ID. This signal must be connected to sdi_tx_line_f0 input signal on TX/Du top.
line_f1 Output 11*N Line number output signal to be inserted with Payload ID. This signal must be connected to sdi_tx_line_f1 input signal on TX/Du top.
Table 21.  Pattern Generator control module signals
Signal name Direction Width Description
avmm_clk_in_clk Input 1 Clock signal to AVMM interface.
tx_clkout_in_clk Input 1 Clock signal to Parallel I/O (PIO) IP. This clock must share the same clock as video pattern generator.
avmm_clk_reset_n Input 1 Reset signal to AVMM interface.
pattgen_rst_reset_in0 Input 1 Input reset signals to a reset synchronizer which synchronize the reset to tx_clkout_in_clk clock domain.
pattgen_rst_reset_in1 Input 1
pattgen_rst_reset_out Input 1 Output reset from reset synchronizer. This reset is synchronized to tx_clkout_in_clk clock domain and connected to video pattern generator’s input reset.
pattgen_ctrl_pio_out_port Output 12 Output control signal from PIO to control video pattern generator.
Table 22.  Device Init module signals
Signal name Direction Width Description
clk Input 1 Clock signal to reset delay module
init_done Output 1

Indicates device has finished its initialization stage after a programmable delay which is determined by CNTR_BITS parameter.

Note: CNTR_BITS parameter determines the bit width of the delay counter. Default value is set to 16.

Level Two Title