RapidIO Intel FPGA IP User Guide

ID 683884
Date 9/15/2021
Public
Document Table of Contents

10. Document Revision History for the RapidIO Intel® FPGA IP User Guide

Document Version Intel® Quartus® Prime Version IP Version Changes
2021.09.15 20.3 19.2.0 Updated Table: RapidIO Release Information for clarity. The RapidIO Intel® FPGA IP is no longer supported in Intel® Quartus® Prime Pro Edition software version 20.3 and later, and Intel® Quartus® Prime Standard Edition software version 18.1 and later.
2020.09.28 20.3 19.2.0
  • Added the Product Discontinuance Notice.
  • Added IP version information.
2018.08.09 18.0 18.0
  • Added txclk and rxclk frequencies into Clock Frequencies for 4x RapidIO IP Core Variations.
  • Added support for Intel® Cyclone® 10 GX devices.
  • Added Xcelium* simulator support.
  • Renamed the document as RapidIO Intel FPGA IP User Guide.
  • Added txclk, rxclk values in Clock Frequencies for 1x and 2x RapidIO IP Core Variations table.
Date Changes
November 2017
  • Updated for Intel® Quartus® Prime 17.1 release.
  • Updated the resource utilization metrics for all device variations in Performance and Resource Utilization section.
  • Modified steps to generate the Platform Designer (Standard) system in Generating the System section.
  • Updated command in Simulating the System section to simulate system with the sample Verilog HDL testbench in ModelSim software.
May 2017
  • Changed the document title from "RapidIO MegaCore Function User Guide" to "RapidIO IP Core User Guide".
  • Changed the document part number from UG-MC_RIOPHY-4.1 to UG-20078 .
  • Updated device support level for Arria® V (GX, GT ,GZ, SX, and ST), Intel® Arria® 10, Cyclone® V (GX, GT, SX, and ST), and Stratix® V device family in Table: Device Family Support.
  • Updated the resource utilization metrics for all device variations in Performance and Resource Utilization.
  • Updated Getting Started chapter for the Intel® Quartus® Prime 17.0 software.
  • Added new section RapidIO IP Core Testbench Files.
  • Made following changes to Simulating the Testbench with the ModelSim Simulator:
    • Updated steps to simulate the testbench.
    • Updated testbench script location for all device variations.
    • Updated commands for all device variations.
    • Corrected TOP_LEVEL_NAME for all device variations.
  • Updated testbench script location for all device variations in Simulating the Testbench with the VCS Simulator.
  • Added new section Transceiver PHY Reset Controller for Intel® Arria® 10 Variations.
  • Made following changes to External Transceiver PLL:
    • Clarified that an fPLL can also implement the required external transceiver PLL in an IP core that targets an Intel® Arria® 10 device.
    • Updated the location of the HDL code for an ATX PLL.
    • Added note to clarify the file name of ATX PLL HDL code for Intel® Arria® 10 devices.
  • Updated the value of rxgxbclk for Arria® V and Cyclone® V devices in Table: Clock Frequencies for 1x and 2x RapidIO IP Core Variations.
  • Clarified the value of default clock frequency for all device variations in Baud Rates and Clock Frequencies.
  • Added information about required parameter value for the Transceiver PHY Reset Controller that connects to the RapidIO IP core in Reset Requirements for Intel® Arria® 10 Variations.
  • Added new signals:
    • input_enable
    • output_enable
    • no_sync_indicator
  • Added information in RapidIO IP Core Clocking to confirm that RapidIO IP core can handle a difference of ±200 ppm between the rxclk and txclk clocks.
  • Added new parameter Packet-Not-Accepted to Link Request timeout in Physical Layer Settings.
  • Implemented Intel® Rebranding.
August 2014
  • Added support for Intel® Arria® 10 devices:

    New parameter Enable transceiver dynamic reconfiguration allows you to hide or make visible the Intel® Arria® 10 Native PHY IP core dynamic reconfiguration interface, an Avalon® -MM interface for programming the hard registers in the Intel® Arria® 10 transceiver.

    New requirement to include TX PLL IP core in the Intel® Arria® 10 design. RapidIO IP core has new individual transceiver channel clock signals tx_bonded_clocks_chN to connect to an ATX PLL to support PLL sharing across the transceiver block.

    New requirement to include a reset controller in the Intel® Arria® 10 design. RapidIO IP core has new transceiver reset signals tx_analogreset, rx_analogreset, tx_digitalreset, and rx_digitalreset to connect to the reset controller.

    Only certain IP core variations support Intel® Arria® 10 devices. Refer to Chapter: Parameter Settings or Upgrading a RapidIO Design to the Intel® Arria® 10 Device Family for information about the supported and unsupported IP core variations.

  • Updated migration information for the v14.0 Intel® Arria® 10 Edition software release in Appendix: Porting a RapidIO Design from the Previous Version of the Software.
June 2014
  • Removed device support, resource utilization numbers, and speed grade information for the following device families that the Quartus II software v13.1 and later no longer supports: Arria GX, Cyclone II, Stratix II, and Stratix II GX device families.
  • Removed device support for the following HardCopy device families: HardCopy II, HardCopy III, HardCopy IV E, and HardCopy IV GX device families. This device support was removed in the 13.1 release.
  • Removed device support, resource utilization numbers, and speed grade information for the following device families that the Quartus II software v14.0 and later no longer supports: Cyclone III, Cyclone III LS, and Stratix III device families.
  • Renamed and reordered resource utilization tables in Performance and Resource Utilization section.
  • Replaced “Serial RapidIO” with “RapidIO”. The RapidIO IP core supports only the Serial RapidIO specification, since before the Quartus II software release 8.0 in 2008.
  • Modified Chapter: Getting Started to describe the new Quartus II software v14.0 IP design flow.
  • Updated migration information for the v14.0 software release in Appendix: Porting a RapidIO Design from the Previous Version of the Software.
  • Removed support for Physical-layer only variations. The RapidIO IP core no longer supports Physical-layer only variations.

    Removed information about clocking, reset, and testbench for Physical-layer only variations.

    Removed the PHY Maintenance Avalon-MM slave interface signals (phy_mnt_s_clk, phy_mnt_s_chipselect, phy_mnt_s_waitrequest, phy_mnt_s_read, phy_mnt_s_write, phy_mnt_s_addresss, phy_mnt_s_writedata, phy_mnt_s_readdata). This interface is no longer a top-level interface. In variations with a Transport layer, software accesses the Physical layer registers through the system maintenance Avalon-MM slave interface instead.

    Removed the Calculating Resource Utilization for Modular Configurations appendix.

  • Corrected the description of the atxwlevel, atxovf, and arxwlevel Physical-layer buffer status output signals to indicate they are available. These signals were previously described incorrectly as being available only in Physical-layer-only variations.
  • Added section Correcting the Synopsys Design Constraints File to Distinguish RapidIO IP Core Instances. This section describes an additional requirement for ensuring a design with multiple RapidIO IP core instances functions correctly.
  • Added new section Avalon® -MM Interface Widths in the RapidIO IP Core.
  • Clarified that sys_mnt_s_address, mnt_s_address, and drbell_s_address are word addresses and not byte addresses. They each address a four-byte (32-bit) word. Modified Maintenance TX address window translation calculation accordingly in Maintenance Module.
  • Corrected the width of mnt_s_address to 24 bits and in the Maintenance TX address window translation calculation description in Maintenance Module.
  • Clarified that io_s_wr_address and io_s_rd_address are word addresses (and not byte addresses) in RapidIO 1x variations, and are double-word addresses in 2x and 4x variations. Corrected header and note in to specify that the bit that provides the wdptr information is bit [0] rather than bit [2]. Corrected address window translation calculation and examples accordingly in Input/Output Avalon® -MM Slave Module.
  • Updated parameter descriptions in Chapter: Parameter Settings.

    Updated capitalization and minor changes in parameter names.

    Transceiver selection is no longer modifiable. The remaining supported device families do not support an external transceiver option.

    Removed the Transceiver Configuration option.

    Removed Enable Transport Layer parameter. The RapidIO IP core no longer supports Physical-layer only variations: all variations have a Transport layer.

    Removed EDA Settings and Summary sections. These tabs no longer exist in the RapidIO parameter editor in the new Quartus II software v14.0 IP design flow.

  • Updated migration information in Appendix: Porting a RapidIO Design from the Previous Version of the Software and removed information about porting from SOPC Builder.
  • Removed dedicated appendix and other information about the XGMII external transceiver interfaces. This interface is not available for any of the current supported device families.
  • Removed some information about signals exported by Platform Designer (Standard) from Chapter: Signals, and redundant information about Platform Designer (Standard) renaming capability. Platform Designer (Standard) is documented in the Quartus Prime Standard Edition Handbook.
  • Corrected direction of rxgxbclk output clock signal in Transceiver Signals.
May 2013
  • Removed SOPC Builder design flow, which is no longer available.
May 2013
  • Added 2x mode for variations that target any Arria® V, Cyclone® V, or Stratix® V device, including modification of the descriptions of the PORT_WIDTH and INIT_WIDTH fields in Port 0 Control CSR in to include 2x mode options. This feature is available in the Quartus II software 13.0 release and later.
  • Added support for Arria® V GZ, Arria® V SX, Arria® V ST, Cyclone® V SX, and Cyclone® V ST devices. This support is available in the Quartus II software 12.1 release and later.
  • Updated resource utilization information for Arria® V, Cyclone® V, and Stratix® V devices.
  • Updated Cyclone® V GT and Stratix® V speed grade support information.
  • Corrected entries in , Write Request Size Encoding (32-bit datapath) and, Read Request Size Encoding (64-bit datapath).
  • Corrected and enhanced information about gen_rx_empty output signal .
May 2012
  • Added support for Cyclone® V GT ×1 variation at 5.0 Gbaud.
  • Updated speed grade support for Arria® V, Stratix IV GX, and Stratix® V devices.
  • Moved Modular Configurations section from Chapter 1, About This MegaCore Function to new Appendix D, Calculating Resource Utilization for Modular Configurations.
  • Clarified additional constraints on deassertion of reset_n and phy_mgmt_clk_reset.
November 2011
  • Added support for Arria® V and Cyclone® V devices. Variations that target one of these two device families configure the transceiver with the Custom PHY IP core.
  • Added Chapter: Platform Designer (Standard) Design Example.
  • Enhanced description of arxmty signal.
  • Updated simulation sections in Chapter: Getting Started.
May 2011
  • Upgraded to final support for Arria II GZ, Cyclone III LS, and Cyclone IV GX devices.
  • Upgraded to HardCopy Compilation support for HardCopy III, HardCopy IV E, and HardCopy IV GX devices.
  • Added preliminary support for Stratix® V devices.
  • Added support for Custom PHY IP core in variations that target a Stratix® V device.
December 2010
  • Added beta support for Platform Designer (Standard) system integration tool.
  • Added read-only version of Port 0 Local AckID CSR.
July 2010
  • Added preliminary support for Cyclone IV GX devices.
  • Added support for configurable number of link-request attempts to be sent before fatal error, after time-out on link-response.
  • Added support for order preservation between read and write requests that come in on the Avalon® -MM interface.
  • Removed support for Stratix GX devices.
November 2009
  • Added preliminary support for Cyclone III LS and HardCopy IV GX devices.
  • Added support for 5.0 Gbaud data rate.
  • Added support for order preservation between I/O write requests and DOORBELL requests.
  • Added NWRITE_R completion indication.
  • Added post-reset ackID synchronization.
  • Added transceiver configuration using full transceiver parameter editor.
March 2009
  • Corrected to preliminary support for HardCopy II devices.
  • Clarified the RapidIO IP core uses the transceiver bonded mode where relevant.
  • Updated Table 4–17.
February 2009
  • Added preliminary support for Arria II GX devices.
  • Added preliminary support for HardCopy III and HardCopy IV E devices.
  • Added support for outgoing multicast-event symbol generation.
  • Added support for 16-bit device ID.
  • Added Appendix C, Porting a RapidIO Design from the Previous Version of the Software.
November 2008
  • Added full support for Stratix III devices.
  • Added support for incoming multicast transactions.
  • Added GUI and register support to enable or disable destination ID checking.
  • Added GUI support to set transceiver starting channel number.
  • Added requirement to configure a dynamic reconfiguration block with Stratix IV transceivers, to enable offset cancellation.
  • Updated Figure 4–6 and Figure 7–2.
May 2008
  • Added Arria GX device support for 1x mode 3.125 GBaud variation.
  • Added Stratix IV device support.
  • Added GUI support to set VCCH and reference clock frequency.
  • Simplified Physical layer description in Functional Description chapter.
  • Updated the performance information.
October 2007
  • Added Avalon® -ST pass-through interface to SOPC Builder flow.
  • Added support for EDA page and an option that creates a netlist for use by third-party synthesis tools.
  • Reorganized the user guide to make finding information easier and more efficient.