GTS Ethernet Intel® FPGA Hard IP User Guide

Download PDF
ID 817676
Date 8/05/2024
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. Overview 2. Install and License the GTS Ethernet Intel® FPGA Hard IP 3. Configure and Generate Ethernet Hard IP variant 4. Integrate GTS Ethernet Intel® FPGA 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 - Auto-Negotiation and Link Training 11. Troubleshoot and Diagnose Issues A. Appendix A: Functional Description B. Appendix B: Configuration Registers C. Appendix C: Document Revision History for the GTS Ethernet Intel® FPGA Hard IP User Guide
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 Intel® FPGA 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
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 Intel® FPGA 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.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 Intel® FPGA IP
4.2.2. Connect the GTS Reset Sequencer Intel® FPGA IP x
4.2.2.1. Requirements and Considerations for GTS Reset Sequencer Intel® FPGA 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 in Hardware 5.5. Validate the Design Example in Hardware
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 in Hardware 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 in Hardware 6.5. Validate the Design Example in Hardware
6.3. Simulate the Design Example x
6.3.1. Simulation Testbench Flow 6.3.2. Simulators Output
6.5. Validate the Design Example in Hardware 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 in Hardware 7.5. Validate the Design Example in Hardware
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 in Hardware 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 in Hardware
8.3. Simulate the Design Example x
8.3.1. Simulation Testbench Flow 8.3.2. Simulator Output
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 in Hardware 9.5. Validate the Design Example in Hardware
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 in Hardware 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 - Auto-Negotiation and Link Training x
10.1. Design Example Features 10.2. Design Example Components 10.3. Simulate the Design Example
10.3. Simulate the Design Example x
10.3.1. Simulation Testbench Flow 10.3.2. Simulation Output 10.3.3. Compile the Design Example in Hardware
11. Troubleshoot and Diagnose Issues x
11.1. Enable Diagnostic Lookback Modes 11.2. Troubleshoot the Reset Sequence 11.3. Use Signal Tap Analyzer for Troubleshooting
11.1. Enable Diagnostic Lookback Modes x
11.1.1. Internal Serial Loopback 11.1.2. Enable MAC Loopback 11.1.3. Enable PCS Loopback 11.1.4. Enable External Loopback 11.1.5. Packet Client Loopback
11.2. Troubleshoot the Reset Sequence x
11.2.1. Debug the Power Up Reset Sequence 11.2.2. Debug the TX Reset Entry Sequence 11.2.3. Debug the TX Reset Exit Sequence 11.2.4. Debug the RX Reset Entry Sequence 11.2.5. Debug the RX Reset Exit Sequence 11.2.6. Debug the Auto Recovery Reset Sequence
A. Appendix A: Functional Description x
A.1. Datapath Description A.2. GTS Ethernet Intel® FPGA Hard IP MAC A.3. PCS, OTN, and FlexE Modes A.4. Precision Time Protocol Interface A.5. Auto-Negotiation and Link Training
A.2. GTS Ethernet Intel® FPGA Hard IP MAC x
A.2.1. MAC TX Datapath A.2.2. MAC RX Datapath A.2.3. Congestion and Flow Control Using PAUSE or Priority Flow Control (PFC) A.2.4. Link Fault Signaling A.2.5. Order of Ethernet Transmission:
A.2.1. MAC TX Datapath x
A.2.1.1. Insert TX Preamble, Start, and SFD A.2.1.2. Insert Source Address A.2.1.3. Process Length/Type Field A.2.1.4. Pad the Client Frame A.2.1.5. Insert Frame Check Sequence (CRC-32) A.2.1.6. Generate and Insert Inter-Packet Gap
A.2.2. MAC RX Datapath x
A.2.2.1. Process RX Preamble A.2.2.2. Check RX Strict SFD A.2.2.3. Check RX FCS A.2.2.4. Handle RX Malformed Packet A.2.2.5. Remove PAD Bytes and FCS Bytes from RX Frames A.2.2.6. RX Undersized Frames, Oversized Frames, and Frames with Length Errors A.2.2.7. Inter-Packet Gap
A.2.3. Congestion and Flow Control Using PAUSE or Priority Flow Control (PFC) x
A.2.3.1. Conditions Triggering XOFF Frame Transmission A.2.3.2. Conditions Triggering XON Frame Transmission A.2.3.3. Pause Control and Generation Interface A.2.3.4. Pause Control Frame Filtering
A.3. PCS, OTN, and FlexE Modes x
A.3.1. PCS Mode A.3.2. OTN Mode A.3.3. FlexE Mode
A.4. Precision Time Protocol Interface x
A.4.1. Features A.4.2. PTP User Flow A.4.3. Make PTP UI Adjustments A.4.4. Reference Time Interval A.4.5. Minimum and Maximum Reference Time (TAM) Interval for UI Measurement (Hardware)
A.4.2. PTP User Flow x
A.4.2.1. PTP TX User Flow A.4.2.2. PTP RX User Flow
A.4.3. Make PTP UI Adjustments x
A.4.3.1. Adjust TX UI A.4.3.2. Adjust RX UI
B. Appendix B: Configuration Registers x
B.1. Ethernet Avalon® Memory-Mapped Interface Address Space B.2. Packet Client Registers
1. Overview
2. Install and License the GTS Ethernet Intel® FPGA Hard IP
3. Configure and Generate Ethernet Hard IP variant
4. Integrate GTS Ethernet Intel® FPGA 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 - Auto-Negotiation and Link Training
11. Troubleshoot and Diagnose Issues
A. Appendix A: Functional Description
B. Appendix B: Configuration Registers
C. Appendix C: Document Revision History for the GTS Ethernet Intel® FPGA Hard IP User Guide

4.7.3. Connect the TX One-Step Timestamp Interface

When transmitting a One-step PTP packet, the IP core modifies the PTP field on-the-fly. The IP core can change the UDP checksum or add extension bytes to adjust it. PTP headers can be part of the VLAN packets and can be encapsulated by UDP datagrams inside of the IPv4 and IPv6 packets.

Figure 50. Example of Ethernet Packet with a PTP HeaderThe figure depicts an Ethernet packet with PTP header embedded as an Ethernet payload in a simple non-VLAN packet.
Table 42.  One-Step TX Timestamp Interface Signals
Signal Name Width Description
i_ptp_ins_ets[0:0] 1

Insert an Egress Timestamp into the current TX Packet.

1: Insert an egress timestamp into the current TX packet

TX MAC SOP-Aligned Client Interface:

  • i_ptp_ins_ets[0] is valid only when i_tx_valid = 1 and i_tx_startofpacket = 1
  • Must not be used with i_tx_skip_crc = 1; the CRC for the TX Packet must be recalculated after the timestamp is written.
  • Must not be used with i_ptp_ins_cf = 1; you can’t update residence time and insert an egress timestamp on the same packet.
  • i_ptp_ts_offset must be set to the byte position of the start of the timestamp field in the PTP header.
  • If the selected timestamp format requires a 96b timestamp, i_ptp_cf_offset must be set to the byte position of the start of the correction field in the PTP header
i_ptp_ins_cf[0:0] 1

Update correction field with residence time in the current TX packet

1: Insert a residence time timestamp into the correction field in the current TX packet

  • i_ptp_ins_cf[0] is valid only when i_tx_valid = 1 and i_tx_startofpacket = 1

  • Must not be used with i_tx_skip_crc = 1; the CRC for the TX Packet must be recalculated after the residence time is written

  • Must not be used with i_ptp_ins_ets = 1; you can’t update residence time and insert an egress timestamp on the same packet

  • i_ptp_tx_its must be used to provide the core with the ingress timestamp of the current packet when it entered the system, so that a residence time can be calculated

  • i_ptp_cf_offset must be set to the byte position of the start of the correction field, in the PTP header

  • i_ptp_ets_format must be set to 0; correction field is only applicable to IEEE 1588v2

i_ptp_zero_csum[0:0] 1

Overwrite a UDP checksum with zeros in the current TX packet

1: Overwrite the checksum in a UDP packet carried inside the current TX packet with zeros

  • TX MAC SOP-Aligned Client Interface:
  • i_ptp_zero_csum[0] is valid only when i_tx_valid = 1 and i_tx_startofpacket = 1.
  • Must not be used with i_tx_skip_crc = 1; the CRC for the TX Packet must be recalculated after the checksum is changed.
  • Must not be used with i_ptp_update_eb; you can’t set a UDP checksum to 0, and update an extension field to cancel out checksum changes on the same packet.
  • i_ptp_csum_offset must be set to the byte position of the start of the UDP checksum in the TX packet.
i_ptp_update_eb[0:0] 1

Update Extended Bytes field to cancel out checksum changes in the current TX packet

1: Overwrite the extended bytes field in an IPv6 packet carried inside the current TX packet with a value that cancels out changes to the checksum due to changes to the UDP packet.

TX MAC SOP-Aligned Client Interface:

  • i_ptp_update_eb[0] is valid only when i_tx_valid = 1 and i_tx_startofpacket = 1.
  • Must not be used with i_tx_skip_crc = 1; the CRC for the TX Packet must be recalculated after the extended bytes field is changed.
  • Must not be used with i_ptp_zero_csum; you can’t set a UDP checksum to 0, and update an extended bytes field to cancel out checksum changes on the same packet.
  • User do not need to provide the byte position of the start of the UDP extension field in the TX packet. The IP core always assume the byte position starts two bytes before CRC field.
i_ptp_p2p[0:0] 1

Add peer-to-peer mean path delay to correction field for current TX packet.

1: Add peer-to-peer mean path delay to the correction field for the current PTP packet

TX MAC SOP-Aligned Client Interface:

  • i_ptp_p2p[0] is valid only when i_tx_valid = 1 and i_tx_startofpacket = 1.
  • Must not be used with i_tx_skip_crc = 1; the CRC for the TX Packet must be recalculated after the timestamp is written.
i_ptp_asym[0:0] 1

Add asymmetry to correction field for current TX packet.

1: Add asymmetric latency to the correction field for the current PTP packet.

TX MAC SOP-Aligned Client Interface:

  • i_ptp_asym[0] is valid only when i_tx_valid = 1 and i_tx_startofpacket = 1.
  • Must not be used with i_tx_skip_crc = 1; the CRC for the TX Packet must be recalculated after the timestamp is written.
i_ptp_asym_sign[0:0] 1

Sign of asymmetry delay add to correction field for current TX packet.

0: Asymmetry delay is positive value

1: Asymmetry delay is negative value

TX MAC SOP-Aligned Client Interface:

i_ptp_asym_sign[0] is valid only when i_tx_valid = 1 and i_tx_startofpacket = 1

i_ptp_asym_p2p_idx[6:0] 7

Index of asymmetry delay and peer-to-peer mean path delay in the configurable lookup table.

TX MAC SOP-Aligned Client Interface:

i_ptp_asym_p2p_idx[6:0] is valid only when i_tx_valid = 1 and i_tx_startofpacket = 1

i_ptp_ts_offset[15:0] 16

Position of PTP Timestamp Field in TX packet.

This bus is used to present the position of the PTP timestamp field in the current TX packet.

TX MAC SOP-Aligned Client Interface:

  • i_ptp_ts_offset[15:0] is valid only when i_tx_valid = 1 and i_tx_startofpacket = 1.
  • It is the offset of the first octet of the field from the start of the frame, where the first byte of the frame (the first destination MAC address octet) is position 0.
  • The PTP timestamp field is 10 octets long, starting from the position given by the offset; 96 bit timestamps add their lower 2 octets to the correction field.
  • WARNING: The offset must be set to a position within the TX packet, or the PTP insertion operation will fail. Furthermore, it is critical that PTP fields do not overlap
i_ptp_cf_offset[15:0] 16

Position of PTP Correction Field in TX packet.

This bus is used to present the position of the PTP correction field in the current TX packet.

TX MAC SOP-Aligned Client Interface:

  • i_ptp_cf_offset[15:0] is valid only when i_tx_valid = 1 and i_tx_startofpacket = 1
  • It is the offset of the first octet of the field from the start of the frame, where the first byte of the frame (the first destination MAC address octet) is position 0
  • The PTP correction field is 8 octets long, starting from the position given by the offset; 96 bit timestamps add their lower 2 octets to the correction field
  • WARNING: The offset must be set to a position within the TX packet, or the PTP insertion operation will fail. Furthermore, it is critical that PTP fields do not overlap.
i_ptp_csum_offset[15:0] 16

Position of UDP Checksum Field in TX packet.

This bus is used to indicate the position of the first byte of a UDP checksum in the TX Packet

TX MAC SOP-Aligned Client Interface:

  • i_ptp_csum_offset[15:0] is valid only when i_tx_valid = 1 and i_tx_startofpacket = 1
  • Is the offset of the first octet of the field from the start of the frame, where the first byte of the frame (the first destination MAC address octet) is position 0
  • WARNING: The offset must be set to a position within the TX packet, or the PTP insertion operation will fail. Furthermore, it is critical that PTP fields do not overlap.
i_ptp_tx_its[95:0] 96

Ingress Timestamp for TX Packet Residence Time Calculation.

This bus is used to present the ingress timestamp for a TX Packet that requires a residence time calculation (i_ptp_ins_cf=1).

This timestamp is the time at which the packet arrived in the system: the TX MAC will compare it to the time at which the packet will leave the system to generate a residence time.

TX MAC SOP-Aligned Client Interface:

  • i_ptp_tx_its[95:0] is valid only when i_tx_valid = 1 and i_tx_startofpacket = 1

  • Residence time value updated in CorrectionField is not valid if TX egress timestamp is larger than TX ingress timestamp by 4 seconds.

Section Content
PTP Field Offset for 1-Step Operation

Level Two Title