R-Tile Avalon® Streaming Intel® FPGA IP for PCI Express* Design Example User Guide

Download PDF
ID 683544
Date 1/27/2025
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. Functional Descriptions of the Design Examples 2. Quick Start Guide 3. R-Tile Avalon® Streaming Intel® FPGA IP for PCI Express* Design Example User Guide Archives 4. Document Revision History for the R-Tile Avalon® Streaming Intel® FPGA IP for PCI Express* Design Example User Guide
1. Functional Descriptions of the Design Examples x
1.1. Glossary of Terms 1.2. Overview of the R-Tile Avalon® Streaming Intel® FPGA IP for PCI Express
1.2. Overview of the R-Tile Avalon® Streaming Intel® FPGA IP for PCI Express x
1.2.1. Functional Description for the Programmed Input/Output (PIO) Design Example 1.2.2. Functional Description for the Single Root I/O Virtualization (SR-IOV) Design Example 1.2.3. Functional Description for the Performance Design Example 1.2.4. Functional Description for the Performance Design Example for TL Bypass Mode 1.2.5. Hardware and Software Requirements
1.2.1. Functional Description for the Programmed Input/Output (PIO) Design Example x
1.2.1.1. Credit Initialization Sequence
1.2.1.1. Credit Initialization Sequence x
1.2.1.1.1. Credit Value Initialization and Return 1.2.1.1.2. Credit Distribution
2. Quick Start Guide x
2.1. Directory Structure 2.2. Generating the Design Example 2.3. Simulating the Design Example 2.4. Root Port BFM 2.5. Compiling the Design Example 2.6. Installing the Linux Kernel Driver 2.7. Running the Design Example
2.2. Generating the Design Example x
2.2.1. Generating the Design Example with R-Tile Configured in PIPE Mode 2.2.2. Generating the Performance Design Example for TL Bypass Mode
2.3. Simulating the Design Example x
2.3.1. Steps to Run Simulations 2.3.2. Testbench
2.3.1. Steps to Run Simulations x
2.3.1.1. Siemens EDA QuestaSim* Simulator 2.3.1.2. VCS* Simulator 2.3.1.3. VCS* MX Simulator 2.3.1.4. Xcelium* Simulator
2.3.2. Testbench x
2.3.2.1. Testbench Modules 2.3.2.2. Test Driver Module 2.3.2.3. PIO Design Example Testbench 2.3.2.4. SR-IOV Design Example Testbench
2.4. Root Port BFM x
2.4.1. BFM Memory Map 2.4.2. Configuration Space Bus and Device Numbering 2.4.3. Configuration of Root Port and Endpoint 2.4.4. Issuing Read and Write Transactions to the Application Layer 2.4.5. BFM Procedures and Functions
2.4.5. BFM Procedures and Functions x
2.4.5.1. ebfm_barwr Procedure 2.4.5.2. ebfm_barwr_imm Procedure 2.4.5.3. ebfm_barrd_wait Procedure 2.4.5.4. ebfm_barrd_nowt Procedure 2.4.5.5. ebfm_cfgwr_imm_wait Procedure 2.4.5.6. ebfm_cfgwr_imm_nowt Procedure 2.4.5.7. ebfm_cfgrd_wait Procedure 2.4.5.8. ebfm_cfgrd_nowt Procedure 2.4.5.9. BFM Configuration Procedures 2.4.5.10. BFM Shared Memory Access Procedures 2.4.5.11. BFM Log and Message Procedures 2.4.5.12. Verilog HDL Formatting Functions
2.4.5.9. BFM Configuration Procedures x
2.4.5.9.1. ebfm_cfg_rp_ep Procedure 2.4.5.9.2. ebfm_cfg_decode_bar Procedure
2.4.5.10. BFM Shared Memory Access Procedures x
2.4.5.10.1. Shared Memory Constants 2.4.5.10.2. shmem_write Task 2.4.5.10.3. shmem_read Function 2.4.5.10.4. shmem_display Verilog HDL Function 2.4.5.10.5. shmem_fill Procedure 2.4.5.10.6. shmem_chk_ok Function
2.4.5.11. BFM Log and Message Procedures x
2.4.5.11.1. ebfm_display Verilog HDL Function 2.4.5.11.2. ebfm_log_stop_sim Verilog HDL Function 2.4.5.11.3. ebfm_log_set_suppressed_msg_mask Task 2.4.5.11.4. ebfm_log_set_stop_on_msg_mask Verilog HDL Task 2.4.5.11.5. ebfm_log_open Verilog HDL Function 2.4.5.11.6. ebfm_log_close Verilog HDL Function
2.4.5.12. Verilog HDL Formatting Functions x
2.4.5.12.1. himage1 2.4.5.12.2. himage2 2.4.5.12.3. himage4 2.4.5.12.4. himage8 2.4.5.12.5. himage16 2.4.5.12.6. dimage1 2.4.5.12.7. dimage2 2.4.5.12.8. dimage3 2.4.5.12.9. dimage4 2.4.5.12.10. dimage5 2.4.5.12.11. dimage6 2.4.5.12.12. dimage7
2.7. Running the Design Example x
2.7.1. Running the PIO Design Example 2.7.2. Running the SR-IOV Design Example 2.7.3. Running the Performance Design Example (Endpoint) 2.7.4. Running the Performance Design Example for TL Bypass Mode
1. Functional Descriptions of the Design Examples
2. Quick Start Guide
3. R-Tile Avalon® Streaming Intel® FPGA IP for PCI Express* Design Example User Guide Archives
4. Document Revision History for the R-Tile Avalon® Streaming Intel® FPGA IP for PCI Express* Design Example User Guide

2.3.1.2. VCS* Simulator

Perform the following steps to execute the simulation via a command line:
  1. Change to the simulation working directory: cd <my_design>/pcie_ed_sim_tb/pcie_ed_sim_tb/sim/synopsys/vcs.
  2. Execute the following command: sh vcs_setup.sh USER_DEFINED_COMPILE_OPTIONS="" USER_DEFINED_SIM_OPTIONS="" USER_DEFINED_ELAB_OPTIONS="+define+rnrb_one_lib_RNR_OVERCLK_FASTSIM\ +define+RNR_FASTSIM_AIB_BYPASS\ +define+rnrb_one_lib_RNR_PCIE_TOP_EQ_BYPASS_FASTSIM\ +define+rnrb_one_lib_RNR_PCIE_TOP_EQ_BYPASS_FASTSIM_H2H\ +define+rnrb_one_lib_RNR_FASTSIM_FORCE_PLL_LOCK_TIME\ +define+XTOR_PCIECXL_LM_SVS_SERDES_ARCHITECTURE\ +define+rnrc_one_lib_RNR_OVERCLK_FASTSIM\ +define+rnrc_one_lib_RNR_PCIE_TOP_EQ_BYPASS_FASTSIM\ +define+rnrc_one_lib_RNR_PCIE_TOP_EQ_BYPASS_FASTSIM_H2H\ +define+rnrc_one_lib_RNR_FASTSIM_FORCE_PLL_LOCK_TIME\ +define+XTOR_PCIECXL_LM_SVS_SERDES_ARCHITECTURE" USER_DEFINED_SIM_OPTIONS="" TOP_LEVEL_NAME="pcie_ed_sim_tb" | tee simulation.log
    Note: The command above is a single-line command.
    Note: Only use the +RTILE_PIPE_MODE option when the Enable PIPE Mode Simulation for Example Design parameter is checked.
If R-Tile is configured with Enable PIPE Mode Simulation for Example Design, use the following steps instead:
  1. cd <my_design>/pcie_ed_sim_tb/pcie_ed_sim_tb/sim/synopsys/vcs/
  2. sh run_vcs.sh

A successful simulation includes the following message: "Simulation stopped due to successful completion!"

Perform the following steps to execute the simulation in interactive mode. Note that in case you have already generated a simv executable in non-interactive mode, you need to delete the simv file and simv.diadir directory.
  1. Open the vcs_setup.sh file and add a debug option to the VCS command: vcs -kdb -debug_access+all
  2. Execute the following command: sh vcs_setup.sh USER_DEFINED_COMPILE_OPTIONS="" USER_DEFINED_SIM_OPTIONS="" USER_DEFINED_ELAB_OPTIONS="+define+rnrb_one_lib_RNR_OVERCLK_FASTSIM\ +define+RNR_FASTSIM_AIB_BYPASS\ +define+rnrb_one_lib_RNR_PCIE_TOP_EQ_BYPASS_FASTSIM\ +define+rnrb_one_lib_RNR_PCIE_TOP_EQ_BYPASS_FASTSIM_H2H\ +define+rnrb_one_lib_RNR_FASTSIM_FORCE_PLL_LOCK_TIME\ +define+XTOR_PCIECXL_LM_SVS_SERDES_ARCHITECTURE\ +define+rnrc_one_lib_RNR_OVERCLK_FASTSIM\ +define+rnrc_one_lib_RNR_PCIE_TOP_EQ_BYPASS_FASTSIM\ +define+rnrc_one_lib_RNR_PCIE_TOP_EQ_BYPASS_FASTSIM_H2H\ +define+rnrc_one_lib_RNR_FASTSIM_FORCE_PLL_LOCK_TIME\ +define+XTOR_PCIECXL_LM_SVS_SERDES_ARCHITECTURE" USER_DEFINED_SIM_OPTIONS="" TOP_LEVEL_NAME="pcie_ed_sim_tb" SKIP_SIM=1 | tee simulation.log
    Note: If R-Tile is configured with Enable PIPE Mode Simulation for Example Design active, use the following command:

    sh vcs_setup.sh USER_DEFINED_COMPILE_OPTIONS="" USER_DEFINED_SIM_OPTIONS="" USER_DEFINED_ELAB_OPTIONS="+define+rnrb_one_lib_RNR_OVERCLK_FASTSIM\ +define+RTILE_PIPE_MODE\ +define+RNR_FASTSIM_AIB_BYPASS\ +define+rnrb_one_lib_RNR_PCIE_TOP_EQ_BYPASS_FASTSIM\ +define+rnrb_one_lib_RNR_PCIE_TOP_EQ_BYPASS_FASTSIM_H2H\ +define+rnrb_one_lib_RNR_FASTSIM_FORCE_PLL_LOCK_TIME\ +define+XTOR_PCIECXL_LM_SVS_SERDES_ARCHITECTURE\ +define+rnrc_one_lib_RNR_OVERCLK_FASTSIM\ +define+rnrc_one_lib_RNR_PCIE_TOP_EQ_BYPASS_FASTSIM\ +define+rnrc_one_lib_RNR_PCIE_TOP_EQ_BYPASS_FASTSIM_H2H\ +define+rnrc_one_lib_RNR_FASTSIM_FORCE_PLL_LOCK_TIME\ +define+XTOR_PCIECXL_LM_SVS_SERDES_ARCHITECTURE" USER_DEFINED_SIM_OPTIONS="" TOP_LEVEL_NAME="pcie_ed_sim_tb" SKIP_SIM=1 | tee simulation.log

  3. Start the simulation in interactive mode: simv -gui &
Level Two Title