Low Latency 40- and 100-Gbps Ethernet MAC and PHY MegaCore Function User Guide

ID 683628
Date 12/28/2017
Document Table of Contents

C.2. Low Latency 40- and 100-Gbps Ethernet MAC and PHY MegaCore Function User Guide Revision History

Table 52.  Document Revision History


Compatible ACDS Version


2017.12.28 16.0 Added note to clarify that this user guide documents the 16.0 version of the IP core, and that as of 2017.12.28, the 16.0 version of the Stratix® V LL 40-100GbE IP core is the most recent Stratix® V LL 40-100GbE IP core available in the Self-Service Licensing Center. The current versions of the Arria® 10 40GbE and 100GbE IP cores are documented separately in the Low Latency 40-Gbps Ethernet IP Core User Guide and the Low Latency 100-Gbps Ethernet IP Core User Guide, respectively.
2016.05.02 16.0
2015.11.12 15.1
2015.11.02 15.1
  • Updated for new Quartus Prime software v15.1 release.
  • Added new Quick Start Guide chapter to accelerate familiarity with the IP core and document the new hardware design example and supporting parameter editor tab.
  • Added new parameters Enable Altera Debug Master Endpoint and Enable ODI acceleration logic to turn on these features in the Arria 10 Native PHY IP core that specifies the transceiver settings in Arria 10 variations of the LL 40-100GbE IP core. Refer to IP Core Parameters.
  • Updated descriptions of PTP support functionality to incorporate changes to the IP core v15.1.
    • Added support for fingerprint passing.
    • Added 64-bit timestamp interface option to TOD module and LL 40-100GbE IP core.
    • Added new parameters Enable 96b Time of Day Format, Enable 64b Time of Day Format, and Timestamp fingerprint width. Refer to IP Core Parameters.
    • Removed TX_PTP_STATUS register. To specify that the 1588 PTP module should always provide the timestamps in outbound Ethernet frames in V2 format or in V1 format, turn on only one of the new parameters Enable 96b Time of Day Format and Enable 64b Time of Day Format. If you turn on both of these parameters, you can specify the current timestamp format in one-step mode with the relevant format signal. In two-step mode, you can maintain both formats at once. To specify whether the IP core uses the one-step process or the two-step process, assert the appropriate signals for the desired process for the current packet. Refer to PTP Transmit Functionality, PTP Timestamp and TOD Formats, 1588 PTP Registers, IP Core Parameters, and 1588 PTP Interface Signals.
    • Added new 1588 PTP registers TX_PTP_ASYM_DELAY, TX_PTP_PMA_LATENCY, and RX_PTP_PMA_LATENCY. Refer to 1588 PTP Registers.
    • Added new signals and renamed all old top-level 1588 PTP block signals. Refer to 1588 PTP Interface Signals.
  • Corrected information about link fault signaling signals and registers, in Link Fault Signaling Interface and Link Fault Signaling Registers.
  • Clarified that you must assert the reset_async signal for a full ten clk_status cycles to ensure correct reset of the IP core. Refer to Resets.
  • Clarified that if you do not turn on Enable alignment EOP on FCS word, the delay from EOP to FCS error indication is non-deterministic. Refer to IP Core Parameters
  • Updated 40GBASE-KR4 registers. Refer to LL 40GBASE-KR4 Registers.
    • Added default value for 0xB0[12]: LT Failure Reset
    • Added two fields that were new in the 15.0 Update 1 release: 0xD0[18]: VOD Training Enable and 0xD0[19]: Bypass DFE
    • Added default value for 0xD0[21:20]: rx_ctle_mode
  • Added information about IP core behavior in case of loss of signal. Refer to Debugging the 40GbE and 100GbE Link.
  • Fixed description of PHY_FRAME_ERROR register at offset 0x323 to clarify it is not sticky. Refer to PHY Registers.
  • Added figure to help distinguish the TX transceiver PLL from the TX MAC PLL, in Transceiver PLL Required in Arria 10 Designs.
  • Corrected allowed frequency range for clk_status in description of Status clock rate parameter allowed values, in IP Core Parameters. The allowed frequency range remains correct at 100–125 MHz in other locations in the user guide.
  • Added missing reset values for various register fields.
  • Fixed assorted typos and formatting issues, including register field width in IPG_COL_REM register at offset 0x406.
2015.05.04 15.0
  • User guide part number change from UG-01150 to UG-01172.
  • Updated release-specific information for the software release v15.0.
  • Added Synchronous Ethernet support for Arria 10 variations. Documented new Enable SyncE parameter and new clk_rx_recover output signal. Described expected usage in Clocks.
  • Updated handling of received malformed packets, in LL 40-100GbE IP Core Malformed Packet Handling, to incorporate these changes in the IP core v15.0:
    • The IP core asserts the l<n>_rx_error[0] or rx_error[0] signal in the case of an unexpected control character that is not an Error character.
    • Both the LL 40GbE IP core and the LL 100GbE IP core handle received malformed packets the same way.
  • Updated the descriptions of l<n>_rx_error[0] and rx_error[0] from PHY error to malformed packet error.
  • Added new three-bit l<n>_rx_status and rx_status signals on the RX client interface. These signals explain the control frames that the IP core passes to the client interface. Refer to Low Latency 40-100GbE IP Core RX Data Bus and Low Latency 40-100GbE IP Core RX Data Bus Without Adapters (Custom Streaming Interface), and to new section Control Frame Identification.
  • Added new TX error insertion feature. User logic can direct the IP core to insert an error in an outgoing Ethernet frame, using the new l<n>_tx_error and tx_error input signals on the TX client interface. Refer to Low Latency 40-100GbE IP Core TX Data Bus with Adapters (Avalon-ST Interface) and Low Latency 40-100GbE IP Core TX Data Bus Without Adapters (Custom Streaming Interface), and to new section Error Insertion Test and Debug Feature.
  • Updated description of priority-based flow control. Priority-based flow control is now available for both LL 40GbE IP core variations and LL 100GbE IP core variations. Previously it was available only in LL 100GbE variations.
  • Added new signal tx_lanes_stable, in PHY Status Interface.
  • Updated description of the rx_ctle_mode 40GBASE-KR4 register and added default value for Enable Arria 10 Calibration 40GBASE-KR4 register. Also corrected the bit range of the LP Coefficients Update register field. For these changes and other 40GBASE-KR4 register information specific to this IP core, refer to LL 40GBASE-KR4 Registers. For changes to the underlying Arria 10 10GBASE-KR PHY registers, refer to the Arria 10 Transceiver PHY User Guide or to the Arria 10 10GBASE-KR Registers appendix.
  • Corrected the addresses of the CNTR_TX_STATUS and CNTR_RX_STATUS registers.
  • Corrected the descriptions of the PHY_PCS_INDIRECT_ADDR and PHY_PCS_INDIRECT_DATA registers at offsets 0x314 and 0x315.
  • Added note recommending that designs with multiple LL 40-100GbE IP cores not use the ATX PLL HDL code that is currently provided with the IP core. This code is deprecated. Refer to Transceiver PLL Required in Arria 10 Designs.
  • Added clock information for multiple IP core top-level signals.
  • Added information about how to check for word lock and alignment marker lock, in Debugging the 40GbE and 100GbE Link.
  • Updated Differences Between Low Latency 40-100GbE IP Core and 40-100GbE IP Core v14.1 appendix with information about the v15.0 IP core.
  • Clarified the different paths to the example design and testbench directories and scripts in variations that target different device families.
  • Added description of the AM_CNT_BITS parameter in Optimizing the Low Latency 40‑100GbE IP Core Simulation With the Testbenches. You might need to modify this parameter in your own simulation environment.
  • Removed text of optimization parameter display initial block from Optimizing the Low Latency 40‑100GbE IP Core Simulation With the Testbenches. Refer to the testbench for your IP core variation for the correct HDL code for the variation.
  • Changed default value of 40GBASE-KR4 link training PMA parameter INITPOSTVAL from 22 to 13, in IP Core Parameters.
  • Updated descriptions of IP core example project. The IP core now generates an example project that is configurable on a device, for most variations. The older type of example projects, which are not configurable, are also generated. Refer to Low Latency 40-100GbE IP Core Design Example.
  • Fixed assorted minor errors and typos.
2014.12.17 14.1
  • Corrected PTP usage figures in Implementing a 1588 System That Includes a LL 40-100GbE IP Core.
  • Clarified that user-defined extra latency is included in calculation of PTP exit timestamp in both one-step mode and two-step mode, in PTP Transmit Functionality.
  • Clarified that TOD module is expected to provide the current continuously updating time of day. The output signals of this module must provide the current time of day on every clock cycle, in V2 format.
  • Moved External Time-of-Day Module for 1588 PTP Variations into the 1588 PTP section of the Functional Description chapter.
2014.12.15 14.1
  • Updated release-specific information for the software release v14.1.
  • Moved licensing information and the description of the OpenCore Plus evaluation feature to Getting Started chapter.
  • Added option to instantiate the TX MAC PLL outside the IP core. The new PLL generates the TX MAC clock. Added new parameter Use external TX MAC PLL. If you turn on this parameter the IP core has an additional input clock signal clk_txmac_in.Changes primarily located in new sections External TX MAC PLL in Getting Started chapter and External TX MAC PLL in Functional Description chapter, in IP Core Parameters section, and in Clocks section.
  • Added support for new 40GBASE-KR4 LL 40GbE IP core variation. Changes located in existing IP Core Parameters section and descriptions of the testbench for these IP core variations in the Low Latency 40-100GbE IP Core Testbenches section. Added new sections Clock Requirements for 40GBASE-KR4 Variations, Low Latency 40GBASE-KR4 IP Core Variations, and LL 40GBASE-KR4 Registers, and a reference appendix Arria 10 10GBASE-KR Registers.
  • Added new six-bit RX error signal on client interface. On Avalon-ST client interface, l<n>_rx_error[5:0] replaces single-bit RX error signal l<n>_rx_error. On custom client interface, rx_error[5:0] is new signal.
  • Added information about how the IP core handles malformed packets it receives. Previously the IP core did not terminate an incoming packet if it receives an unexpected control character. Changes are located in the new LL 40-100GbE IP Core Malformed Packet Handling section.
  • Added two new 64-bit statistics counters RXOctets_OK (offset 0x960) and TxOctetsOK (offset 0x860) to count the payload bytes (octets) in received and transmitted frames with no FCS errors, undersized, oversized, or payload length errors.
  • Added four new signals in new octetsOK interface. These signals provide per-frame information about the octet count in the two new statistics counters: rx_inc_octetsOK, rx_inc_octetsOK_valid, tx_inc_octetsOK, tx_inc_octetsOK_valid. Refer to new section OctetOK Count Interface.
  • Added new CFG_PLEN_CHECK register at offset 0x50A, to support bit[4] of the new six-bit RX error signal.
  • Added new link fault signals unidirectional_en and link_fault_gen_en that provide status from the LINK_FAULT_CONFIG register.
  • Described new method for handling module-specific signals when the module is not included in your IP core variation. TX MAC input clock, link fault signals, pause signals, and PTP signals are not available in newly generated IP cores that do not include the relevant module. However, for backward compatibility, if you upgrade an IP core variation, link fault signals, pause signals, and PTP signals in the earlier release of the IP core variation remain available in the 14.1 version after upgrade.
  • Updated PTP module description and signals for current IP core version to support changes to the IP core 1588 PTP functionality. Corrected description of the tx_in_ptp_overwrite[1:0] signal. Improved usage description. If you turn on Enable 1588 PTP , the PTP module has the following new features and requirements::
    • You must instantiate a time-of-day module and connect it to the IP core. Previously, this module was included in the IP core. The change facilitates TOD module sharing among IP cores.
    • Added new PTP signals tod_rxmac_in and tod_txmac_in to receive the timestamps the TOD module generates in the two clock domains.
    • Removed TX PTP module TOD calculation registers at 0xB06 through 0xB08. The TOD module now provides the functionality the registers supported in previous versions of the IP core.
    • Added support for resetting the TCP checksum to zero if the application does not recalculate it. The new feature adds two new PTP signals tx_in_zero_tcp and tx_in_tcp_offset with which the application communicates such a request to the IP core.
  • Clarified that IP core does not identify frames of eight bytes or less as runts but instead as FCS errors.
  • Clarified that IP core does not generate frames of eight bytes or less.
  • Added waveform to illustrate register access on the control and status interface, in the Control and Status Interface section
  • Updated Differences Between Low Latency 40-100GbE IP Core and 40-100GbE IP Core v14.1 appendix with information about the v14.1 IP core.
  • Corrected misinformation about the IP core variations that support the Enable TX CRC insertion parameter. Only IP core variations that do not support flow control provide this parameter.
  • Corrected order of TX_PFC_DADDRH (offset 0x60E) and TX_PFC_DADDRL (offset 0x60D) registers.
  • Corrected order of TX_PFC_SADDRH (offset 0x610) and TX_PFC_SADDRL (offset 0x60F) registers.
  • Corrected description of RX_PAUSE_DADDR registers at offsets 0x707 and 0x708. These registers are the same for standard flow control and for priority-based flow control.
  • Corrected installation directory figure for Stratix V variations, in Installation and Licensing for LL 40-100GbE IP Core for Stratix V Devices.
  • Corrected erroneous indication that the value in RETRANSMIT_XOFF_HOLDOFF_EN at offset 0x607 is indexed by the value in the TX_PAUSE_QNUMBER register. In fact, the RETRANSMIT_XOFF_HOLDOFF_EN register includes one bit for every flow-control priority queue (one bit in case of standard flow control). Change is in Pause Registers section.
  • Fixed assorted typos and minor errors.
2014.08.18 14.0 and 14.0 Arria 10 Edition
  • Updated for new Quartus II IP Catalog, which replaces the MegaWizard Plug-In Manager starting in the Quartus II sofware v14.0. Changes are located primarily in Getting Started chapter. Reordered the chapter to accommodate the new descriptions.
  • Updated the Installation section to clarify that the LL 40-100GbE IP core v14.0 is available from the Self-Service Licensing Center, and the LL 40-100GbE IP core v14.0 Arria 10 Edition is included in the Quartus II software installation.
  • Added new, additional allowed value for PHY reference clock frequency: 322.265625 MHz.
  • Added new parameter option to configure an inter-packet gap of 8.
  • Added new parameter option to configure the IP core without adapters, exposing a custom streaming client interface that is narrower than the Avalon-ST interface. This option is available in IP cores configured without a 1588 PTP module and without an internal flow control scheme. You must select the custom streaming client interface or the Avalon-ST client interface. Your selection applies to both the RX and TX client interfaces.
  • Added new parameter option to configure priority-based flow control. This option is available in 100GbE variations with Tx CRC insertion turned on and with an Avalon-ST client interface.
    • Adds a new parameter to specify between 1 and 8 priority queues, inclusive.
    • Expands the width of the pause signals to the number of priority queues. Each bit refers to the corresponding priority queue.
    • Modifies the pause registers to apply to both standard and priority-based flow control. In some cases the register fields do not change and in others the register field widens to one bit per priority queue. In the case of three registers, modifies them drastically so they are essentially different registers in the case of priority-based flow control:
      • TX_XOF_EN at offset 0x60A has no equivalent register in priority-based flow control. The replacement register at this offset, TX_PAUSE_QNUMBER, holds the queue number of the queue to which the current contents of the RETRANSMIT_XOFF_HOLDOFF_EN, RETRANSMIT_XOFF_HOLDOFF_QUANTA, and TX_PAUSE_QUANTA apply.
      • RX_PAUSE_DADDR1 and RX_PAUSE_DADDR0 are replaced with RX_PFC_DADDRH and RX_PFC_DADDRL, which divide the 48-bit destination address for matching differently than the standard flow-control registers.
  • Stratix V variations no longer support an internal transceiver reconfiguration controller. User logic must instantiate a transceiver reconfiguration controller.
    • Removed registers at offsets 0x350, 0x351, 0x352, and 0x353.
    • Added signals reconfig_from_xcvr, reconfig_to_xcvr, and reconfig_busy in Stratix V variations.
  • Updated Differences Between Low Latency 40-100GbE IP Core and 40-100GbE IP Core v14.1 appendix with new Low Latency 40-100GbE IP core features.
  • Updated description of example project to clarify the Arria 10 project no longer implements additional input clocks to demonstrate static timing derivation.
  • Added instructions to generate the testbench and example project in the 14.0 and 14.0 Arria 10 Edition versions of the IP core.
  • Reorganized the testbench sections of Chapter 2, Getting Started.
  • Corrected addresses of the following statistics registers:
    • CNTR_TX_CRCERR registers from 0x804-0x805 to 0x806-0x807.
    • CNTR_TX_FCS registers from 0x806-0x807 to 0x804-0x805
    • CNTR_RX_CRCERR registers from 0x904-0x8905 to 0x906-0x907.
    • CNTR_RX_FCS registers from 0x906-0x907 to 0x904-0x905
  • Corrected direction of clk_txmac and clk_rxmac in table in Signals section to Output.
  • Added HW reset values for PHY registers that have them. All PHY register listings except those for the identifier string registers and the frequency registers now list a HW reset value.
  • Added basic information to description of HI BER field of PHY_RXPCS_STATUS register.


13.1 Update 3

13.1 Arria 10 Edition Update 2

  • Corrected presentation of resource utilization numbers for Stratix V device family to clarify size of IP core without 1588 PTP module
  • Renamed Pause Registers tables to Ethernet Flow Control (Pause Functionality) Registers for consistency
  • In Low Latency 40-100GbE IP Core Address Map table, clarified that the 1588 PTP registers are only available if you turn on the parameter to include the 1588 PTP module in your IP core instance. The same information was already available in the table for other registers that are only available if you turn on the associated parameter.
  • Fixed assorted typos (column width in TX MAC Configuration Registers table, reset value widths of RX_PAUSE_DADDR0 register in RX Ethernet Flow Control Registers table and of TX_PTP_CLOCK_PERIOD register in TX 1588 PTP Registers table)


13.1 Update 3

13.1 Arria 10 Edition Update 2

  • Added resource utilization numbers for Stratix V device family.
  • Corrected supported Stratix V device speed grade information for Low Latency 100GbE IP cores.
  • Added note to supported Stratix V device speed grade information table clarifying that Quartus II seed sweeping might be required for variations that include a 1588 PTP module to achieve a comfortable timing margin.


13.1 Update 3

13.1 Arria 10 Edition Update 2

  • Corrected descriptions of pause enable registers:
    • Added description for TX_XOF_EN register at offset 0x60A.
    • Enhanced description of cfg_enable field of RX_PAUSE_ENABLE register at offset 0x705 to clarify the different functions of the TX_XOF_EN and RX_PAUSE_ENABLE registers in enabling the IP core to incoming pause frames.
    • Enhanced description of the TX_PAUSE_EN register at offset 0x605 to clarify the different functions of the TX_XOF_EN and TX_PAUSE_EN registers.
  • In "Differences Between Low Latency 40-100GbE IP Core and 40-100GbE IP Core v13.1", enhanced the description of the differences in pause frame control and processing and in use of maximum frame size register information.
  • Updated "Congestion and Flow Control Using Pause Frames" with the enable register field information.
  • Updated "Pause Control Frame Filtering" with the new enable register field information and to clarify that by default, RX pause frame processing is enabled.
  • Enhanced "Low Latency 40-100GbE Example Project" to clarify that some project aspects are relevant only for Arria 10 devices.
  • Corrected "Clocks" section to include tx_serial_clk input clocks and to list clk_rxmac and clk_txmac as output clocks.


13.1 Update 3

13.1 Arria 10 Edition Update 2

Initial release.

Did you find the information on this page useful?

Characters remaining:

Feedback Message