Ethernet Subsystem Intel® FPGA IP User Guide: Early Access Customer Release

Download PDF
ID 773413
Date 4/14/2023
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. Introduction 2. Feature Description 3. Ethernet Subsystem Parameters 4. Subsystem Abstraction Layer (SAL) 5. Dynamic Reconfiguration Extension Subsystem 6. Interfaces and Signals 7. Recommended Clock Connections 8. Register Descriptions 9. Ethernet SS IP Example Design 10. Document Revision History for Ethernet Subsystem Intel FPGA IP User Guide: Early Access Customer Release
1. Introduction x
1.1. Supported Features 1.2. Getting Started 1.3. Resource Utilization
2. Feature Description x
2.1. Ethernet Subsystem Intel FPGA IP Overview 2.2. Supported Features
3. Ethernet Subsystem Parameters x
3.1. Parameter Editor Parameters 3.2. E-Tile Port Enablement Guidelines and Restrictions 3.3. F-tile Ethernet Port to PMA Channel Mapping
4. Subsystem Abstraction Layer (SAL) x
4.1. Subsystem Abstraction Layer (SAL) Commands
4.1. Subsystem Abstraction Layer (SAL) Commands x
4.1.1. NOP(0x0) 4.1.2. get_hssi_profile 4.1.3. set_hssi_profile 4.1.4. read_MAC_statistic (0x3) 4.1.5. get_mtu(0x4) 4.1.6. set_csr for E-Tile (0x5) 4.1.7. set_csr for F-Tile 4.1.8. get_csr for E-Tile (0x6) 4.1.9. get_csr for F-Tile 4.1.10. enable_loopback for E-Tile (0x7) 4.1.11. enable_loopback for F-Tile 4.1.12. disable_loopback for E-Tile (0x8) 4.1.13. disable_loopback for F-Tile 4.1.14. Reset MAC Statistics (0x9) 4.1.15. set_mtu for F-Tile 4.1.16. Ncsi_get_link_status 4.1.17. Reserved 4.1.18. firmware_version (0xFF)
6. Interfaces and Signals x
6.1. AXI4 Interfaces 6.2. Serial Interface 6.3. Clocks 6.4. Resets
6.1. AXI4 Interfaces x
6.1.1. AXI-Lite CSR 6.1.2. AXI-ST Client Interface 6.1.3. AXI-ST PHY Direct 6.1.4. AXI-ST PTP 6.1.5. Flow Control
7. Recommended Clock Connections x
7.1. Driving Multiple Ports with the Same Clock 7.2. Alternate Clock Connections for MAC Async Client FIFO 7.3. F-Tile Clock Connections for PTP Synchronous and Asynchronous cases 7.4. Clock Connections for SyncE Operation 7.5. F-Tile PMA and FEC Direct PHY IP Clock Output
8. Register Descriptions x
8.1. Subsystem Registers 8.2. Port Registers 8.3. F-tile Address Maps 8.4. F-tile ANLT Port Register Map 8.5. F-tile PTP Tile Adapter Register Map
8.1. Subsystem Registers x
8.1.1. Device Feature Header Lo 8.1.2. Device Feature Header Hi 8.1.3. Feature GUID_L 8.1.4. Feature GUID_H 8.1.5. Feature CSR ADDR 8.1.6. Feature CSR Size Group 8.1.7. Version 8.1.8. Feature List 8.1.9. Interface Attribute Port X Parameters 8.1.10. HSSI Command/Status 8.1.11. HSSI Control/Address 8.1.12. HSSI Read Data 8.1.13. HSSI Write Data 8.1.14. HSSI Ethernet Port X Status
8.2. Port Registers x
8.2.1. E-Tile PTP Packet Classifier Registers
8.2.1. E-Tile PTP Packet Classifier Registers x
8.2.1.1. Recognized and Unrecognized Packet Counters 8.2.1.2. Parse Graph Specific Packet Counters
9. Ethernet SS IP Example Design x
9.1. Steps to Generate the Example Design 9.2. Supported Simulators 9.3. Running the Simulation Tests 9.4. Running the Hardware Tests
9.3. Running the Simulation Tests x
9.3.1. Steps to Simulate the Design Example
9.4. Running the Hardware Tests x
9.4.1. Supported Boards 9.4.2. Steps to Compile the Design Example for Hardware 9.4.3. Steps to Run the Design Example on Hardware
1. Introduction
2. Feature Description
3. Ethernet Subsystem Parameters
4. Subsystem Abstraction Layer (SAL)
5. Dynamic Reconfiguration Extension Subsystem
6. Interfaces and Signals
7. Recommended Clock Connections
8. Register Descriptions
9. Ethernet SS IP Example Design
10. Document Revision History for Ethernet Subsystem Intel FPGA IP User Guide: Early Access Customer Release

3.1. Parameter Editor Parameters

The Ethernet Subsystem Intel FPGA IP parameter has two tabs, Ethernet Subsystem tab and an Example Design tab.

For more information about the Example Design tab, refer to Ethernet SS IP Example Design.

Table 6.  Ethernet Subsystem Intel FPGA IP Parameters: HSSI<n> is the enabled port number, ranging from 0 to 15
Parameter Range Default Setting Parameter Description
Number of devices 1 1 Only 1 device is supported in this version.
Device 0 Configuration
Tile 0 Configuration
Tiles E, F E Per tile configuration which shows the supported tiles within the subsystem. The allowed values are based on the FPGA device.
Main Configuration
General Configuration
Product Agilex Agilex Only Agilex is supported in this version.
NUM_ENABLED_PORTS 1-16 1

Set the number of

10GE/25GE/40GE/50GE/100GE/200GE/400GE port(s) to be enabled. The IP will determine the number of transceiver channels based on the port profile.

Enable JTAG to Avalon® Master Bridge
  • Enable
  • Disable
Disable

Enable this parameter to add a JTAG to Avalon® memory-mapped interface Master bridge connecting internally to reconfiguration registers. This allows the Ethernet Toolkit to be run using System Console.

Note that Ethernet Toolkit is not available for multi-port ANLT designs with this Quartus release.

Port_<port_number:1-16>Port_<n>_configuration
Note: Depending on selected port profile, there will be up to 16 ports that can be individually configured.
PORT<n>_ENABLE
  • 0
  • 1
1 Set this parameter to 1 to enable individual port.
Port_PORT<n>_PROFILE
  • 10GbE (E- and F-tile)
  • 25GbE (E- and F-tile)
  • 40GCAUI-4(F-tile only)
  • 50GAUI-1 (F-tile only)
  • 50GAUI-2 (F-tile only)
  • 100GAUI-1 (F-tile only)
  • 100GCAUI-4 (E- and F-tile)
  • 100GCAUI-2 (E- and F- tile)
  • 200GAUI-4 (F-tile only)
  • 200GAUI-2 (F-tile only)
  • 400GAUI-8 (F-tile only)
  • 400GAUI-4 (F-tile only)
  • CPRI (E-Tile only)
 10GbE Select the speed rate profile for each port. For E-tile, 100G CAUI-4 variant can only be selected on ports 0,4,8,12.
PORT<n>_SUB_PROFILE
  • MAC+PCS (E- and F-Tile)
  • PCS (E-tile)
  • OTN (E-tile)
  • FlexE (E-tile)
 MAC+ PCS Select the Ethernet Protocol layer sub-profile for the port.
PORT<n>_RSFEC
  • True
  • False
False

Set this parameter to True to include additional hard logic to perform

Reed-Solomon Forward Error Correction (RS-FEC). This feature is not supported for 10GbE profile.

PORT<n>_PTP
  • True
  • False
False Set this parameter to True to add IEEE 1588 PTP Timestamp offload functions to the core. The core can generate 1-step or 2-step TX timestamps and RX timestamps.
Table 7.  E-Tile Ethernet Subsystem Intel FPGA IP Parameters: Ethernet Subsystem – IP Configuration Tab
Parameter Range Default Setting Parameter Description
IP Configuration
Note: Each enabled port will have individual port configuration tab
P<n> IP
P<n> Core Options
ENABLE AN/LT
  • On
  • Off
 Off Turn on this parameter to enable the IP core to support Auto-negotiation and Link Training (AN/LT).
Enable Native PHY Debug Master Endpoint
  • On
  • Off
 On

If this parameter is turned on, the underlying Transceiver Native PHY IP includes an embedded Native PHY Debug Master Endpoint that connects internally to the Avalon memory-mapped slave interface for dynamic reconfiguration. The Native PHY Debug Master Endpoint can access the reconfiguration registers of the transceiver.

This connection allows the System Console to run the Transceiver Toolkit.

Note that Transceiver Toolkit is not available for multi-port ANLT designs with this Quartus release.
ENABLE SYNCE
  • On
  • Off
 Off Turn on this parameter to enable the IP core to support SyncE operation.
P<n> PTP Options
Note: Only available when PTP is enabled for the port.

Enable Tx PTP Packet

Classifier

  • True
  • False
False Set this parameter to True to include PTP Packet Classifier in transmit direction, where PTP sideband signals will be generated based on PTP packet decoding.
PTP Accuracy Mode
  • Basic Mode
  • Advanced Mode
Basic Mode

When selected, specifies the PTP timestamp accuracy for selected Ethernet variant.

For 10GbE/25GbE variant:

  • Basic Mode: PTP accuracy is ± 3 ns
  • Advanced Mode: PTP accuracy is ±1.5 ns
For 100GbE variant:
  • Basic Mode: PTP accuracy is ± 8 ns
  • Advanced Mode: not supported
P<n> AN/LT Options
P<n> Auto-Negotiation (AN)
Note: Only available when AN/LT is enabled for the port.
Enable Auto-Negotiation on reset
  • On
  • Off
On

If this parameter is turned on, the IP core is configured after reset to implement auto-negotiation as defined in Clause 73 of IEEE Std 802.3–2015.

If this parameter is turned off, the IP core does not perform the auto-negotiation after reset.

Link Fail Inhibit Time 100-4000ms 504ms Specify the time before link status is set to FAIL or OK. A link fails if the time duration specified by this parameter expires before link status is set to OK.
Advertise CR Technology Ability
  • On
  • Off
 On

If this parameter is turned on, the IP core advertises CR capability by default.

If this parameter is turned off, the IP core advertises KR capability by default.

Request RSFEC
  • On
  • Off
 On Turn on this parameter to request RSFEC from remote link partner during auto-negotiation.
Auto-Negotiation Master
  • Lane 0
  • Lane 1
  • Lane 2
  • Lane 3
Lane 0 Select the master channel for auto-negotiation. Available for 100GbE variant.
Advertise both 10G and 25G during AN
  • On
  • Off
 Off

Turn on this parameter to advertise both 10 and 25 Gbps data rate during auto-negotiation. When this parameter is turned off, the IP core advertises only the data rate specified in port profile.

This parameter is not available for 100GbE variant.

Advertise PAUSE ability
  • On
  • Off
 On

If this parameter is turned on, the IP core indicates on the Ethernet link that it supports symmetric pauses as defined in Annex 28B of Section 2 of IEEE Std 802.3–2015.

Advertise PAUSE ASM_DIR ability
  • On
  • Off
 On

If this parameter is turned on, the IP core indicates on the Ethernet link that it supports asymmetric pauses as defined in Annex 28B of Section 2 of IEEE Std 802.3–2015.

P<n> Link Training
Note: Only available when AN/LT is enabled for the port.
Enable Link Training on reset
  • On
  • Off
 On If this parameter is turned on, the IP core is configured after reset to perform link training, which configures the remote link partner TX PMD for the lowest Bit Error Rate (BER).
Enable Link Training for VSR recipe
  • On
  • Off
 Off If this parameter is turned on, the IP core will use the VSR recipe during Link Training. Use during internal loopback or with very short connections.
P<n> PMA Options Configuration
Enable HOTPLUG
  • On
  • Off
 Off If this parameter is turned on, the IP core will enable autonomous logic to detect a valid signal on the serial interface and tune the link.

The hotplug module supports 10GE, 25GE, and 100GE NRZ rates for LR and VSR recipes. If PAM4 is enabled, the module will always load the VSR recipe.

For ANLT-enabled channels, the Hotplug module will start after the ANLT engine enters "Data Mode". The hotplug module will overwrite the recipe of the ANLT module with either the VSR or LR recipe. If ANLT fails, the hotplug module will never start.

Hotplug is not supported for CPRI rates.
Enable iCAL and pCAL recipe at power on.
  • On
  • Off
 Off Available when AN/LT is disabled. If this parameter is turned on, the IP core will load PMA Configuration 0 prior to running initial calibration. Continuous calibration will run on every power-on or IP cold reset.
Enable custom rate
  • On
  • Off
 Off If this parameter is turned on, the IP core will enable the Custom Rate Interface.
Include deterministic latency measurement interface
  • On
  • Off
 Off If this parameter is turned on, the IP core will enable the Deterministic Latency Interface.
PHY Reference Frequency (MHz) 156.25MHz 156.25MHz Select the expected transceiver reference clock frequency.
P<n>Configuration Tab
P<n>MAC Options Configuration
P<n>Basic Configuration
TX Maximum Frame Size 65-65535 1518 Maximum packet size (in bytes) the IP core can transmit on the Ethernet link without reporting an oversized packet in the TX statistics counters.
RX Maximum Frame Size 65-65535 1518 Maximum packet size (in bytes) the IP core can transmit on the Ethernet link without reporting an oversized packet in the RX statistics counters.
Enforce Maximum Frame Size
  • On
  • Off
 Off Specify whether the IP core can receive an oversized packet or truncates these packets.
Choose Link Fault Generation Mode
  • OFF
  • Unidirectional
  • Bidirectional
 Bidirectional

Specify the IP core response to link fault events.

Bidirectional link fault handling complies with the Ethernet specification. Unidirectional link fault handling implements IEEE 802.3 Clause 66: in response to local faults, the IP core transmits Remote Fault ordered sets in interpacket gaps but does not respond to incoming Remote Fault ordered sets. The OFF option is provided for backward compatibility.

Stop TX Traffic when link partner sends PAUSE
  • Yes
  • No
  • Disable Flow Control
No

Select how the IP core responds to PAUSE frames from the Ethernet link.

This parameter has no effect if flow control is disabled. If you disable flow control, the IP core neither responds to incoming PAUSE and PFC frames nor generates outgoing PAUSE and PFC frames.

If this parameter has the value of No, you can use the i_tx_pause signal on the TX client interface to force the TX MAC to stop TX traffic.

Bytes to remove from RX frames
  • None
  • Remove CRC bytes
  • Remove CRC and PAD bytes
 Remove CRC bytes

Select bytes from incoming RX frames to be removed by the RX MAC before passing the bytes to the RX MAC Client.

If the PAD and CRC bytes are not needed downstream, the remove option can reduce the need for downstream packet processing logic.

Forward RX Pause Requests
  • On
  • Off
 Off

Select whether the RX MAC forwards incoming PAUSE and PFC frames on the RX client interface or drops them after internal processing.

Note: This parameter has no effect if flow control is disabled.
Use Source Address Insertion
  • On
  • Off
 Off

If the parameter is turned on, the IP core overwrites the outgoing packet source address with the value from TXMAC_SADDR registers.

If the parameter is turned off, the IP core does not overwrite the source address.

Enable TX VLAN Detection
  • On
  • Off
 On

If the parameter is turned on, the IP core identifies VLAN or Stacked VLAN frames in TX statistics as VLAN or SVLAN frames.

If the parameter is turned off, the IP core treats these frames as regular control frames.

Enable RX VLAN Detection
  • On
  • Off
 On

If the parameter is turned on, the IP core identifies VLAN or Stacked VLAN frames in RX statistics as VLAN or SVLAN frames.

If the parameter is turned off, the IP core treats these frames as regular control frames.

P<n>Specialized Configuration
Enable Preamble Passthrough
  • On
  • Off
 Off If turned on, the IP core is in RX and TX preamble pass-through mode. In RX preamble pass-through mode, the IP core passes the preamble and SFD to the client instead of stripping them out of the Ethernet packet. In TX preamble pass-through mode, the client specifies the preamble to be sent in the Ethernet frame.
Enable strict preamble check
  • On
  • Off
 Off If turned on, the IP core rejects RX packets whose preamble is not the standard Ethernet preamble (0x55_55_55_55_55_55).
Enable strict SFD check
  • On
  • Off
 Off If turned on, the IP core rejects RX packets whose SFD byte is not the standard Ethernet SFD (0xD5).
Average Inter-packet gap
  • 1
  • 8
  • 10
  • 12
 12

Specifies the average minimum inter-packetgap (IPG) the IP core maintains on the TX Ethernet link.

The default value of 12 complies with the Ethernet standard.

The remaining values support increased throughput.

Additional IPG removed as per AM period Integer 0 Specifies the number of inter- packets gaps the IP core removes per alignment marker period, in addition to the default number required for protocol compliance.

For parameters in the P<n> PMA_Adaptation tab, refer to the PMA Adaptation topic in the E-Tile Transceiver PHY User Guide.

Table 8.  F-Tile Ethernet Subsystem Intel FPGA IP Parameters: Ethernet Subsystem – IP Configuration Tab
Parameter Range Default Setting Parameter Description
IP Configuration
Note: Each enabled port will have individual port configuration tab
Port_<n>_configuration
P<n> IP
P<n> Core Options
Client Interface
  • MAC segmented
  • MAC Avalon ST
 MAC segmented Selects which Ethernet protocol layers are provided to the client interface
FEC Mode
  • IEEE 802.3 BASE-R Firecode (CL 76)
  • IEEE 802.3 RS(528,514) (CL 91)
  • IEEE 802.3 RS(544,514) (CL 134)
  • Ethernet Technology Consortium RS (272,258)
 IEEE 802.3 RS(528,514) (CL 91) When FEC is enabled in the Main Configuration tab, this option selects which FEC mode the port will use
P<n> PTP Options
Note: Only available when PTP is enabled for the port.
Enable Tx PTP Classifier false, true false Set this parameter to True to include PTP Packet Classifier in transmit direction, where PTP sideband signals will be generated based on PTP packet decoding.
Timestamp accuracy mode Basic, Advanced Basic

When selected, specifies the PTP timestamp accuracy for selected Ethernet variant.

For 10GbE/25GbE/50GbE variant:
  • Basic Mode: PTP accuracy is ± 3 ns
  • Advanced Mode: PTP accuracy is ±1.5 ns
For 100GbE/200GbE/400GbE variant:
  • Basic Mode: PTP accuracy is ± 8 ns
  • Advanced Mode: not supported

Not applicable for 40GbE variant
Timestamp fingerprint width 8-32 8 Defines the timestamp fingerprint bit width
P<n> Auto-Negotiation and Link Training Options
P<n> ANLT Options
Note: Only available when AN/LT is enabled for the port
Enable Link Training on reset
  • On
  • Off
 On If this parameter is turned on, the IP core is configured after reset to perform link training, which configures the remote link partner TX PMD for the lowest Bit Error Rate (BER).
Enable Auto-Negotiation on reset
  • On
  • Off
On

If this parameter is turned on, the IP core is configured after reset to implement auto-negotiation as defined in Clause 73 of IEEE Std 802.3–2015.

If this parameter is turned off, the IP core does not perform the auto-negotiation after reset.

KR or CR mode
  • CR mode
  • KR mode
 CR mode Selects KR or CR mode for ANLT
Link Fail Inhibit Time 100-4000ms 504ms Specify the time before link status is set to FAIL or OK. A link fails if the time duration specified by this parameter expires before link status is set to OK.
P<n>MAC Options
P<n>Basic
TX Maximum Frame Size 65-65535 1518 Maximum packet size (in bytes) the IP core can transmit on the Ethernet link without reporting an oversized packet in the TX statistics counters.
RX Maximum Frame Size 65-65535 1518 Maximum packet size (in bytes) the IP core can transmit on the Ethernet link without reporting an oversized packet in the RX statistics counters.
Enforce Maximum Frame Size
  • On
  • Off
 Off Specify whether the IP core can receive an oversized packet or truncates these packets.
Link Fault Generation Mode
  • OFF
  • Unidirectional
  • Bidirectional
 Bidirectional

Specify the IP core response to link fault events.

Bidirectional link fault handling complies with the Ethernet specification. Unidirectional link fault handling implements IEEE 802.3 Clause 66: in response to local faults, the IP core transmits Remote Fault ordered sets in interpacket gaps but does not respond to incoming Remote Fault ordered sets. The OFF option is provided for backward compatibility.

Stop TX Traffic when link partner sends PAUSE
  • Yes
  • No
  • Disable Flow Control
No

Select how the IP core responds to PAUSE frames from the Ethernet link.

This parameter has no effect if flow control is disabled. If you disable flow control, the IP core neither responds to incoming PAUSE and PFC frames nor generates outgoing PAUSE and PFC frames.

If this parameter has the value of No, you can use the i_tx_pause signal on the TX client interface to force the TX MAC to stop TX traffic.

Bytes to remove from RX frames
  • None
  • Remove CRC bytes
  • Remove CRC and PAD bytes
 Remove CRC bytes

Select bytes from incoming RX frames to be removed by the RX MAC before passing the bytes to the RX MAC Client.

If the PAD and CRC bytes are not needed downstream, the remove option can reduce the need for downstream packet processing logic.

Forward RX Pause Requests
  • On
  • Off
 Off

Select whether the RX MAC forwards incoming PAUSE and PFC frames on the RX client interface or drops them after internal processing.

Note: This parameter has no effect if flow control is disabled.
Use Source Address Insertion
  • On
  • Off
 Off

If the parameter is turned on, the IP core overwrites the outgoing packet source address with the value from TXMAC_SADDR registers.

If the parameter is turned off, the IP core does not overwrite the source address.

Enable TX VLAN Detection
  • On
  • Off
 On

If the parameter is turned on, the IP core identifies VLAN or Stacked VLAN frames in TX statistics as VLAN or SVLAN frames.

If the parameter is turned off, the IP core treats these frames as regular control frames.

Enable RX VLAN Detection
  • On
  • Off
 On

If the parameter is turned on, the IP core identifies VLAN or Stacked VLAN frames in RX statistics as VLAN or SVLAN frames.

If the parameter is turned off, the IP core treats these frames as regular control frames.

P<n>Specialized Configuration
Enable Preamble Passthrough
  • On
  • Off
 Off If turned on, the IP core is in RX and TX preamble pass-through mode. In RX preamble pass- through mode, the IP core passes the preamble and SFD to the client instead of stripping them out of the Ethernet packet. In TX preamble pass-through mode, the client specifies the preamble to be sent in the Ethernet frame.
Enable strict preamble check
  • On
  • Off
 Off If turned on, the IP core rejects RX packets whose preamble is not the standard Ethernet preamble (0x55_55_55_55_55_55).
Enable strict SFD check
  • On
  • Off
 Off If turned on, the IP core rejects RX packets whose SFD byte is not the standard Ethernet SFD (0xD5).
Average Inter-packet gap
  • 1
  • 8
  • 10
  • 12
 12

Specifies the average minimum inter-packetgap (IPG) the IP core maintains on the TX Ethernet link.

The default value of 12 complies with the Ethernet standard.

The remaining values support increased throughput.

Additional IPG removed as per AM period Integer 0 Specifies the number of inter- packetsgaps the IP core removes per alignment marker period, in addition to the default number required for protocol compliance.
Level Two Title