GTS Ethernet Hard IP User Guide: Agilex™ 5 FPGAs and SoCs

Download PDF
ID 817676
Date 8/04/2025
Public
Document Table of Contents
Document Table of Contents x
1. Overview 2. Install and License the GTS Ethernet Hard IP 3. Configure and Generate Ethernet Hard IP variant 4. Integrate GTS Ethernet Hard IP into Your Application 5. Simulate, Compile, and Validate (MAC+PCS) - Single Instance 6. Simulate, Compile, and Validate (MII PCS Only/PCS66 OTN/PCS66 FlexE) - Single Instance 7. Simulate, Compile, and Validate SyncE - Single Instance 8. Simulate and Compile PTP1588 - Single Instance 9. Simulate, Compile, and Validate - Multiple Instance 10. Simulate, Compile, and Validate (Dynamically Reconfigurable Ethernet Mode) 11. Simulate, Compile, and Validate - Auto-Negotiation and Link Training 12. Troubleshoot and Diagnose Issues 13. Appendix A: Functional Description 14. Appendix B: Configuration Registers 15. Appendix C: Document Revision History for the GTS Ethernet Hard IP User Guide: Agilex™ 5 FPGAs and SoCs
1. Overview x
1.1. Release Information 1.2. High-Level Functional Overview 1.3. Acronyms 1.4. Agilex® 5 Ethernet Portfolio and Target Applications 1.5. Agilex® 5 Ethernet Hard IP Features 1.6. GTS Ethernet Hard IP Design Flow
1.5. Agilex® 5 Ethernet Hard IP Features x
1.5.1. Device Family Support 1.5.2. Device Speed Grade Support 1.5.3. Resource Utilization 1.5.4. Round-Trip Latency
3. Configure and Generate Ethernet Hard IP variant x
3.1. Create Quartus Project 3.2. Configure GTS Ethernet Hard IP 3.3. Generate HDL for Synthesis and Simulation 3.4. Generated File Structure 3.5. Generate GTS EHIP Design Example 3.6. Analog Parameter Options
3.5. Generate GTS EHIP Design Example x
3.5.1. Directory Structure
4. Integrate GTS Ethernet Hard IP into Your Application x
4.1. Implement Required Clocking 4.2. Implement Required Resets 4.3. Connect the Status Interface 4.4. Connect the MAC Avalon Streaming Client Interface 4.5. Connect the MII PCS Only Client Interface 4.6. Connect the PCS66 Client Interface – FlexE and OTN 4.7. Connect the Precision Time Protocol Interface 4.8. Connect the Ethernet Hard IP Reconfiguration Interface 4.9. Connect the Auto-Negotiation and Link Training 4.10. Connect the Multirate Auto-Negotiation and Link Training 4.11. Connect the Dynamically Reconfigurable Ethernet Mode
4.1. Implement Required Clocking x
4.1.1. Implement MAC Synchronous Clock Connections to Single Instance 4.1.2. Implement MAC Synchronous Clock Connections to Multiple Instances 4.1.3. Implement Clock Connections to MAC Asynchronous Operation 4.1.4. Implement Clock Connections in Synchronous Ethernet Operation (Sync-E) 4.1.5. Implement Clock Connections in PTP-Based Design
4.2. Implement Required Resets x
4.2.1. Reset Sequence 4.2.2. Connect the GTS Reset Sequencer IP
4.2.2. Connect the GTS Reset Sequencer IP x
4.2.2.1. Requirements and Considerations for GTS Reset Sequencer IP
4.3. Connect the Status Interface x
4.3.1. Use i_stats_snapshot to Read Stats Counters
4.4. Connect the MAC Avalon Streaming Client Interface x
4.4.1. Connect the TX MAC Avalon Streaming Client Interface 4.4.2. Connect the RX MAC Avalon Streaming Client Interface 4.4.3. Connect the MAC Flow Control Interface
4.4.1. Connect the TX MAC Avalon Streaming Client Interface x
4.4.1.1. Drive the Ethernet Packet to the TX MAC Avalon Streaming Client Interface with Disabled Preamble Passthrough 4.4.1.2. Drive the Ethernet Packet on the TX MAC Avalon Streaming Client Interface with Enabled Preamble Passthrough 4.4.1.3. Use i_tx_skip_crc to Control Source Address, PAD, and CRC Insertion 4.4.1.4. Assert the i_tx_error to Invalidate a Packet
4.4.2. Connect the RX MAC Avalon Streaming Client Interface x
4.4.2.1. Receive Ethernet Frame on the RX MAC Avalon Streaming Client Interface with Preamble Passthrough Disabled 4.4.2.2. Receive Ethernet Frame with Preamble Passthrough Enabled 4.4.2.3. Receive Ethernet Frame with Remove CRC bytes Disabled 4.4.2.4. Monitor Status and Errors on the RX MAC Avalon Streaming Client Interface
4.4.3. Connect the MAC Flow Control Interface x
4.4.3.1. Connect the TX MAC Flow Control Interface 4.4.3.2. Connect the RX MAC Flow Control Interface
4.5. Connect the MII PCS Only Client Interface x
4.5.1. Connect the MII PCS Mode TX Interface 4.5.2. Connect the MII PCS Mode RX Interface
4.5.1. Connect the MII PCS Mode TX Interface x
4.5.1.1. Insert Alignment Marker
4.5.2. Connect the MII PCS Mode RX Interface x
4.5.2.1. Receive Alignment Marker
4.6. Connect the PCS66 Client Interface – FlexE and OTN x
4.6.1. Connect the FlexE and OTN Mode TX Interface 4.6.2. Connect the FlexE and OTN Mode RX Interface
4.6.1. Connect the FlexE and OTN Mode TX Interface x
4.6.1.1. Insert Alignment Marker
4.6.2. Connect the FlexE and OTN Mode RX Interface x
4.6.2.1. Receive Alignment Marker
4.7. Connect the Precision Time Protocol Interface x
4.7.1. Connect the Time-of-Day Interface 4.7.2. Connect the TX Two-Step Timestamp Interface 4.7.3. Connect the TX One-Step Timestamp Interface 4.7.4. Connect the RX Timestamp Interface 4.7.5. Connect the PTP Status Interface
4.7.3. Connect the TX One-Step Timestamp Interface x
4.7.3.1. PTP Field Offset for 1-Step Operation
5. Simulate, Compile, and Validate (MAC+PCS) - Single Instance x
5.1. Design Example Features 5.2. Design Example Components 5.3. Simulate the Design Example 5.4. Compile the Design Example 5.5. Validate the Design Example
5.3. Simulate the Design Example x
5.3.1. Simulation Testbench Flow 5.3.2. Verify the Simulation Results
5.5. Validate the Design Example x
5.5.1. Configure the Clocks in Hardware 5.5.2. Program the FPGA 5.5.3. Run the Hardware Test
6. Simulate, Compile, and Validate (MII PCS Only/PCS66 OTN/PCS66 FlexE) - Single Instance x
6.1. Design Example Features 6.2. Design Example Components 6.3. Simulate the Design Example 6.4. Compile the Design Example 6.5. Validate the Design Example
6.3. Simulate the Design Example x
6.3.1. Simulation Testbench Flow 6.3.2. Simulators Output
6.5. Validate the Design Example x
6.5.1. Configure the Clocks in Hardware 6.5.2. Program the FPGA 6.5.3. Run the Hardware Test
7. Simulate, Compile, and Validate SyncE - Single Instance x
7.1. Design Example Features 7.2. Design Example Components 7.3. Simulate the Design Example 7.4. Compile the Design Example 7.5. Validate the Design Example
7.3. Simulate the Design Example x
7.3.1. Simulation Testbench Flow for Single Instance with SyncE 7.3.2. Simulator Output
7.5. Validate the Design Example x
7.5.1. Configure the Clocks in Hardware 7.5.2. Program the FPGA 7.5.3. Run the Hardware Test
8. Simulate and Compile PTP1588 - Single Instance x
8.1. Design Example Features 8.2. Design Example Components 8.3. Simulate the Design Example 8.4. Compile the Design Example 8.5. Validate the Design Example
8.3. Simulate the Design Example x
8.3.1. Simulation Testbench Flow 8.3.2. Simulator Output
8.5. Validate the Design Example x
8.5.1. Configure the Clocks in Hardware 8.5.2. Program the FPGA 8.5.3. Run the Hardware Test
9. Simulate, Compile, and Validate - Multiple Instance x
9.1. Design Example Features 9.2. Design Example Components 9.3. Simulate the Design Example 9.4. Compile the Design Example 9.5. Validate the Design Example
9.3. Simulate the Design Example x
9.3.1. Simulation Testbench Flow for MAC Mode 9.3.2. Simulator Output
9.5. Validate the Design Example x
9.5.1. Configure the Clocks in Hardware 9.5.2. Program the FPGA 9.5.3. Run the Hardware Test
10. Simulate, Compile, and Validate (Dynamically Reconfigurable Ethernet Mode) x
10.1. Design Example Features 10.2. Design Example Components 10.3. Simulate the Design Example 10.4. Compile the Design Example 10.5. Validate the Design Example
10.3. Simulate the Design Example x
10.3.1. Simulation Testbench Flow 10.3.2. Verify the Simulation Results
10.5. Validate the Design Example x
10.5.1. Configure the Clocks in Hardware 10.5.2. Program the FPGA 10.5.3. Run the Hardware Test
11. Simulate, Compile, and Validate - Auto-Negotiation and Link Training x
11.1. Auto-Negotiation and Link Training for General Ethernet Mode 11.2. Multirate Auto-Negotiation and Link Training for Reconfigurable Mode AN/LT 11.3. Design Example Features 11.4. Design Example Components 11.5. Simulate the Design Example 11.6. Compile the Design Example 11.7. Validate the Design Example
11.5. Simulate the Design Example x
11.5.1. Simulation Testbench Flow 11.5.2. Simulation Output
11.7. Validate the Design Example x
11.7.1. Configure the Clocks in Hardware 11.7.2. Program the FPGA 11.7.3. Run the Hardware Test
12. Troubleshoot and Diagnose Issues x
12.1. Enable Diagnostic Lookback Modes 12.2. Troubleshoot the Reset Sequence 12.3. Use Signal Tap Analyzer for Troubleshooting
12.1. Enable Diagnostic Lookback Modes x
12.1.1. Internal Serial Loopback 12.1.2. Enable MAC Loopback 12.1.3. Enable PCS Loopback 12.1.4. Enable External Loopback 12.1.5. Packet Client Loopback
12.2. Troubleshoot the Reset Sequence x
12.2.1. Debug the Power Up Reset Sequence 12.2.2. Debug the TX Reset Entry Sequence 12.2.3. Debug the TX Reset Exit Sequence 12.2.4. Debug the RX Reset Entry Sequence 12.2.5. Debug the RX Reset Exit Sequence 12.2.6. Debug the Auto Recovery Reset Sequence
13. Appendix A: Functional Description x
13.1. Datapath Description 13.2. GTS Ethernet Hard IP MAC 13.3. PCS, OTN, and FlexE Modes 13.4. Precision Time Protocol Interface 13.5. Auto-Negotiation and Link Training
13.2. GTS Ethernet Hard IP MAC x
13.2.1. MAC TX Datapath 13.2.2. MAC RX Datapath 13.2.3. Congestion and Flow Control Using PAUSE or Priority Flow Control (PFC) 13.2.4. Link Fault Signaling 13.2.5. Order of Ethernet Transmission:
13.2.1. MAC TX Datapath x
13.2.1.1. Insert TX Preamble, Start, and SFD 13.2.1.2. Insert Source Address 13.2.1.3. Process Length/Type Field 13.2.1.4. Pad the Client Frame 13.2.1.5. Insert Frame Check Sequence (CRC-32) 13.2.1.6. Generate and Insert Inter-Packet Gap
13.2.2. MAC RX Datapath x
13.2.2.1. Process RX Preamble 13.2.2.2. Check RX Strict SFD 13.2.2.3. Check RX FCS 13.2.2.4. Handle RX Malformed Packet 13.2.2.5. Remove PAD Bytes and FCS Bytes from RX Frames 13.2.2.6. RX Undersized Frames, Oversized Frames, and Frames with Length Errors 13.2.2.7. Inter-Packet Gap
13.2.3. Congestion and Flow Control Using PAUSE or Priority Flow Control (PFC) x
13.2.3.1. Conditions Triggering XOFF Frame Transmission 13.2.3.2. Conditions Triggering XON Frame Transmission 13.2.3.3. Pause Control and Generation Interface 13.2.3.4. Pause Control Frame Filtering
13.3. PCS, OTN, and FlexE Modes x
13.3.1. PCS Mode 13.3.2. OTN Mode 13.3.3. FlexE Mode
13.4. Precision Time Protocol Interface x
13.4.1. Features 13.4.2. PTP User Flow 13.4.3. Make PTP UI Adjustments 13.4.4. Reference Time Interval 13.4.5. Minimum and Maximum Reference Time (TAM) Interval for UI Measurement (Hardware)
13.4.2. PTP User Flow x
13.4.2.1. PTP TX User Flow 13.4.2.2. PTP RX User Flow
13.4.3. Make PTP UI Adjustments x
13.4.3.1. Adjust TX UI 13.4.3.2. Adjust RX UI
14. Appendix B: Configuration Registers x
14.1. Ethernet Avalon® Memory-Mapped Interface Address Space 14.2. Packet Client Registers
1. Overview
2. Install and License the GTS Ethernet Hard IP
3. Configure and Generate Ethernet Hard IP variant
4. Integrate GTS Ethernet Hard IP into Your Application
5. Simulate, Compile, and Validate (MAC+PCS) - Single Instance
6. Simulate, Compile, and Validate (MII PCS Only/PCS66 OTN/PCS66 FlexE) - Single Instance
7. Simulate, Compile, and Validate SyncE - Single Instance
8. Simulate and Compile PTP1588 - Single Instance
9. Simulate, Compile, and Validate - Multiple Instance
10. Simulate, Compile, and Validate (Dynamically Reconfigurable Ethernet Mode)
11. Simulate, Compile, and Validate - Auto-Negotiation and Link Training
12. Troubleshoot and Diagnose Issues
13. Appendix A: Functional Description
14. Appendix B: Configuration Registers
15. Appendix C: Document Revision History for the GTS Ethernet Hard IP User Guide: Agilex™ 5 FPGAs and SoCs

15. Appendix C: Document Revision History for the GTS Ethernet Hard IP User Guide: Agilex™ 5 FPGAs and SoCs

Document Version Quartus® Prime Version Changes
2025.08.04 25.1.1 Made the following changes:
  • Added HVIO acronyms in Acronyms section.
  • Updated the GTS Ethernet Hard IP Parameters: IP tab to include the Use HVIO PLL Parameter in the IP tab display.
  • Updated the Enable IEEE 1588 PTP parameter description in the Configure GTS Ethernet Hard IP section.
  • Added the following new parameters in the GTS Ethernet Hard IP Parameters: IP tab table:
    • Use HVIO PLL
    • Additional IPG removed per AM period
    • Added footnote for the 25G-1 Ethernet Mode parameter.
  • Updated Analog Parameters GUI in Analog Parameters Options section.
  • Updated the IEEE 802.3 RS(528,514) FEC support for 25GE to clause 108 instead of clause 91 as mentioned in all previous versions.
  • Added a new parameter Selects value of RX termination mode in the GTS PMA Analog Parameter Settings table.
  • Updated the Implement Required Clocking section.
  • Removed MAC from the Simulate, Compile, and Validate (Dynamically Reconfigurable Ethernet Mode) chapter title.
  • Added the following parameters in the IP Parameter Settings for 10GE Dynamically Reconfigurable Mode Single Instance Design Example with Optional FEC table in the Simulate, Compile, and Validate (Dynamically Reconfigurable Ethernet Mode chapter:
    • USE HVIO PLL
    • PTP Options: Enable IEEE 1588 PTP - Disable
  • Added a new parameter Enable fast simulation in the following sections:
    • Auto-Negotiation and Link Training for General Ethernet Mode
    • Multirate Auto-Negotiation and Link Training for Reconfigurable Mode AN/LT
    • Added link to the Agilex 5 Auto-Negotiation and Link Training for Ethernet Hard IP Register map in the Ethernet Avalon Memory-Mapped Interface Address Space section.
2025.04.07 25.1 Made the following changes:
  • Added a topic Round-Trip Latency in Overview section.
  • Updated the Resource Utilization topic to include the following IP core variation names:
    • MRIP AVST 10G NO FEC to 25G RS-FEC
    • MRIP AVST 10G FEC to 10G NO FEC
  • Updated range and description of the Ethernet Operation Mode parameter in the Configure GTS Ethernet Hard IP section.
  • Moved the following parameters from Base_Port(Port #0) > Port #0 IP Configuration > Port #0 MAC Option > P0 BasicBase to the IP Tab: General Options in the Configure GTS Ethernet Hard IP section:
    • Ready latency
    • Enable asynchronous adapter clocks
  • Added a footnote to the following tabs in the Configure GTS Ethernet Hard IP section:
    • Base_Port > Port #0 IP Configuration
    • Base_Port(Port #0) > Port #0 IP Configuration > Port #0 MAC Option > P0 BasicBase
    • Base_Port(Port #0) > Port #0 IP Configuration > Port #0 MAC Option > P0 Specialized
  • Updated the diagram HDL Generation for Synthesis and Simulation in Generate HDL for Synthesis and Simulation section.
  • Updated a Directory Structure for GTS Ethernet Hard IP Design Example diagram to add a new folder support_logic inside the hardware_test_design folder.
  • Updated Directory and File Description table in the Directory Structure.
  • Updated Analog Parameters tab in the GTS Ethernet Hard IP GUI.
  • Removed the following parameters from the GTS PMA Analog Parameter Settings table:
    • Selects value of RX termination mode
    • Enable VSR mode
  • Updated the values for the Selects value of RX onchip termination parameter under the Analog RX tab.
  • Updated the GTS Ethernet Hard IP Interfaces diagram to show o_refclk_bus_out signal.
  • Updated GTS Ethernet Hard IP Clock Signals and Clock Status diagram to show o_refclk_bus_out signal.
  • Added the clock signal o_refclk_bus_out in the Implement Required Clocking section.
  • Updated Connect to the GTS Reset Sequencer IP diagram in the Connect the GTS Reset Sequencer IP section.
  • Added a note under Example of o_rx_pause Toggling in the Connect the RX MAC Flow Control Interface section.
  • Added a new chapter Simulate, Compile, and Validate (Dynamically Reconfigurable Ethernet Mode - MAC)
  • Added a note to the address range 0x0010_0000 - 0x0010_0054 in the Ethernet Avalon Memory-Mapped Interface Address Space section.
2024.01.23 24.3.1 Made the following changes:
  • Updated GTS Ethernet Hard IP GUI to show the Ethernet Operation Mode parameter in Configure GTS Ethernet Hard IP.
  • Added the following parameters in the GTS Ethernet Hard IP Parameters table:
    • Ethernet Operation Mode
    • MAC Use case
  • Updated the diagram and table in the Directory Structure section to show ed_debug_signals.stp file.
  • Updated the GTS Ethernet Hard IP Interfaces diagram to include a note in Integrate GTS Ethernet Hard IP into Your Application section.
  • Updated the Analog Parameters tab in the GTS Ethernet Hard IP GUI to show Enable VSR Mode parameter.
  • Added new parameter Enable VSR mode in the GTS PMA Analog Parameters Settings table.
  • Added a new topic Connect the Multirate Auto-Negotiation and Link Training under Integrate to your Application.
  • Added new parameters Ethernet Operation Mode and MAC Use case in the following sections:
    • Simulate, Compile, and Validate (MAC+PCS)- Single Instance
    • Simulate, Compile, and Validate (MII PCS Only/PCS66 OTN/PCS66 FlexE)- Single Instance
    • Simulate, Compile, and Validate - Single Instance
    • Simulate and Compile PTP1588- Single Instance
    • Simulate, Compile, and Validate - Multiple Instance
  • Added the following new topics under Simulate, Compile, and Validate- Auto-Negotiation and Link Training:
    • Auto-Negotiation and Link Training for General Ethernet Mode
    • Multirate Auto-Negotiation and Link Training for Reconfigurable mode AN/LT
  • Added new parameter Enable Multirate AN/LT in the Selected IP Parameter for Auto-Negotiation and Link Training table.
  • Removed the parameter Status Clock Frequency from the Selected IP Parameter for Auto-Negotiation and Link Training table.
  • Updated the following in the Use Signal Tap Analyzer for Troubleshooting section:
    • Updated the diagram
    • Added the signal rx_lane_current_status
    • Removed the signal rx_am_lock_stp_dbg
  • Added timestamp accuracy support in advanced mode in the Features section.
2024.10.12 24.3 Made the following changes:
  • Updated Resource Utilization table.
  • Updated Supported Ethernet Protocol table in Agilex™ 5 Ethernet Hard IP Features.
  • Added Aldec Riviera-PRO* simulator support in Simulate the Design Example.
  • Updated GTS Ethernet Hard IP Interfaces block diagram in the Integrate GTS Ethernet Hard IP into Your Application.
  • Removed o_rx_am_lock port from the Connect the Status Interface.
  • Updated clock connections in PTP-Based synchronous and asynchronous operation diagrams in Implement Clock Connections in PTP-Based Design.
  • Added design example generation and simulation support for D-Series and E-Series Device Group A.
  • Updated the clock controller configurations for example designs.
  • Updated Verify the Simulation Results topic in the Simulate, Compile, and Validate (MAC+PCS) - Single Instance section.
  • Corrected the script command from chkmac_status to chkmac_stats in Run the Hardware Test.
  • Updated the Simulators Output and Waveform in the Simulate, Compile, and Validate (MII PCS Only /PCS66 OTN/PCS66 FlexE) - Single Instance section.
  • Updated Simulators Output and Waveform in the Simulate, Compile, and Validate SyncE - Single Instance design example section.
  • Updated IP parameters settings for Multiple Instance and AN/LT Design Example.
  • Added hardware support for PTP1588 design example in Simulate and Compile PTP1588 - Single Instance.
  • Updated Simulators Output in the Simulate, Compile, and Validate - Auto Negotiation and Link Training.
  • Revised the per-defined signal tap debug signals and description in the Use Signal Tap Analyzer for Troubleshooting section.
  • Added Riviera-PRO script location in the IP and design example Directory Structure.
  • Updated Byte Order on the Client Interface Channels with Preamble Pass-Through in the Appendix: Order of Ethernet Transmission.
  • Updated the Appendix section: PTP RX Flow.
2024.08.05 24.2 (patch 0.01) Made the following changes:
  • Updated Select Design parameter description in the Design Example Parameters table of Generate GTS Ethernet Hard IP Design Example section.
  • Updated Clock Connections for MAC Synchronous Operation diagram in Implement MAC Synchronous Clock Connections to Single Instance section.
  • Updated Insert Alignment Markers diagram in Insert Alignment Marker section.
  • Added the following Auto-Negotiation and Link Training sections:
    • Enable Auto-Negotiation and Link Training Parameter in the Configure GTS Ethernet Hard IP.
    • Connect the Auto-Negotiation and Link Training topic in the Integrate GTS Ethernet Hard IP into Your Application chapter.
    • Simulate, Compile, and Validate - Auto-Negotiation and Link Training.
    • Auto-Negotiation and Link Training in the Block Description chapter.
2024.07.08 24.2 Made the following changes:
  • Reorganized the document structure and content.
  • Updated the following chapters:
    • Overview
    • Install and License the GTS Ethernet Hard IP
    • Configure and Generate Ethernet Hard IP Variant
    • Integrate GTS Ethernet Hard IP into Your Application
  • Added the following design example chapters and updated their content and diagrams:
    • Simulate, Compile, and Validate (MAC+PCS) - Single Instance
    • Simulate, Compile, and Validate (MII PCS Only/PCS66 OTN/PCS66 FlexE) - Single Instance
    • Simulate, Compile, and Validate SyncE - Single Instance
    • Simulate and Compile PTP 1588 - Single Instance
    • Simulate, Compile, and Validate - Multiple Instance
  • Added a new chapter: Troubleshoot and Diagnose Issues
  • Moved the following chapters to Appendix:
    • Functional Description
    • Configuration Registers
    • Document Revision History
2024.04.01 24.1 Initial release.
Level Two Title