Ethernet Subsystem Intel® FPGA IP User Guide

Download PDF
ID 773413
Date 9/16/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. Introduction 2. Feature Description 3. Ethernet Subsystem Parameters 4. Subsystem IP Blocks 5. Interfaces and Signals 6. Recommended Clock Connections 7. Register Descriptions 8. Ethernet SS IP Example Design 9. Document Revision History for the Ethernet Subsystem Intel FPGA IP User Guide
1. Introduction x
1.1. Supported Features 1.2. Device Family Support 1.3. Release Information 1.4. Resource Utilization 1.5. Getting Started
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 3.4. Analog Parameter Options
4. Subsystem IP Blocks x
4.1. AXI Stream Bridge 4.2. CSR Address Decoder 4.3. Subsystem Abstraction Layer (SAL) 4.4. Dynamic Reconfiguration Extension Subsystem 4.5. IEEE 1588v2 PTP 4.6. Auto-Negotation and Link Training 4.7. Priority Flow Control
4.3. Subsystem Abstraction Layer (SAL) x
4.3.1. Subsystem Abstraction Layer (SAL) Commands
4.3.1. Subsystem Abstraction Layer (SAL) Commands x
4.3.1.1. NOP(0x0) 4.3.1.2. get_hssi_profile for E-Tile 4.3.1.3. get_hssi_profile for F-Tile 4.3.1.4. set_hssi_profile for E-Tile 4.3.1.5. set_hssi_profile for F-Tile 4.3.1.6. read_MAC_statistic 4.3.1.7. get_mtu 4.3.1.8. set_csr for E-Tile 4.3.1.9. set_csr for F-Tile 4.3.1.10. get_csr for E-Tile 4.3.1.11. get_csr for F-Tile 4.3.1.12. enable_loopback for E-Tile 4.3.1.13. enable_loopback for F-Tile 4.3.1.14. disable_loopback for E-Tile 4.3.1.15. disable_loopback for F-Tile 4.3.1.16. Reset MAC Statistics 4.3.1.17. set_mtu for F-Tile 4.3.1.18. Ncsi_get_link_status 4.3.1.19. Reserved 4.3.1.20. firmware_version (0xFF)
4.5. IEEE 1588v2 PTP x
4.5.1. TX PTP Classifier
5. Interfaces and Signals x
5.1. AXI4 Interfaces 5.2. Serial Interface 5.3. Clocks 5.4. Resets
5.1. AXI4 Interfaces x
5.1.1. AXI-Lite CSR 5.1.2. AXI-ST Client Interface 5.1.3. AXI-ST PHY Direct 5.1.4. AXI-ST PTP 5.1.5. Flow Control
6. Recommended Clock Connections x
6.1. Driving Multiple Ports with the Same Clock 6.2. Clock Connections for MAC Asynchronous Client FIFO 6.3. F-Tile Clock Connections for PTP Synchronous and Asynchronous cases 6.4. Clock Connections for SyncE Operation on E-Tile 6.5. Clock Connections for SyncE Operation on F-Tile 6.6. F-Tile PMA and FEC Direct PHY IP Clock Output
7. Register Descriptions x
7.1. Subsystem Registers 7.2. Port Registers 7.3. F-Tile Address Maps 7.4. F-Tile ANLT Port Register Map 7.5. F-Tile PTP Tile Adapter Register Map 7.6. F-Tile DR Controller Register Map
7.1. Subsystem Registers x
7.1.1. Device Feature Header Lo 7.1.2. Device Feature Header Hi 7.1.3. Feature GUID_L 7.1.4. Feature GUID_H 7.1.5. Feature CSR ADDR 7.1.6. Feature CSR Size Group 7.1.7. Version 7.1.8. Feature List 7.1.9. Interface Attribute Port X Parameters 7.1.10. HSSI Command/Status 7.1.11. HSSI Control/Address 7.1.12. HSSI Read Data 7.1.13. HSSI Write Data 7.1.14. HSSI Ethernet Port X Status 7.1.15. Priority Flow Control 7.1.16. Priority Flow Control TX Queue Statistics 7.1.17. Priority Flow Control RX Queue Statistics 7.1.18. Priority Flow Control TX Queue Threshold 7.1.19. Priority Flow Control RX Queue Threshold 7.1.20. F-Tile DR Controller Status
7.2. Port Registers x
7.2.1. PTP Packet Classifier Registers
7.2.1. PTP Packet Classifier Registers x
7.2.1.1. Recognized and Unrecognized Packet Counters 7.2.1.2. Parse Graph Specific Packet Counters
8. Ethernet SS IP Example Design x
8.1. Steps to Generate the Example Design 8.2. Supported Simulators 8.3. Running the Simulation Tests 8.4. Running the Hardware Tests
8.3. Running the Simulation Tests x
8.3.1. Steps to Simulate the Design Example
8.4. Running the Hardware Tests x
8.4.1. Supported Boards 8.4.2. Steps to Compile the Design Example for Hardware 8.4.3. Steps to Run the Design Example on Hardware
8.4.2. Steps to Compile the Design Example for Hardware x
8.4.2.1. Steps to generate Routing Delay for PTP Enabled Designs
1. Introduction
2. Feature Description
3. Ethernet Subsystem Parameters
4. Subsystem IP Blocks
5. Interfaces and Signals
6. Recommended Clock Connections
7. Register Descriptions
8. Ethernet SS IP Example Design
9. Document Revision History for the Ethernet Subsystem Intel FPGA IP User Guide

4.3.1.18. Ncsi_get_link_status

Ncsi_get_link_status SAL command is intended to provide software abstraction for obtaining all the necessary status in single command to comply with get link status CSR requirement in NCSI specification. Users use this command to obtain the Ethernet link status per the following table.
Table 31.  Register Description for E-Tile
Bit HSSI Read Data Fields Description ANLT Enable ANLT Disable
31:22 Reserved 0 N/A (Return 0) N/A (Return 0)
21 OEM Link Speed Valid 0b = OEM link settings are invalid.

1b = OEM link settings are valid

 N/A (Return 0) N/A (Return 0)
20 SerDes Link

SerDes status (see 4.18")

0b = SerDes not used

1b = SerDes used

This field is mandatory

0x322 tx_pcs_ready AND 0x326 rx_aligned

0x1084 rx_aligned

0x322 tx_pcs_ready AND 0x326 rx_aligned

0x1084 rx_aligned
19:18 Link Partner Advertised Flow Control

00b = Link partner is not pause capable.

01b = Link partner supports symmetric pause.

10b = Link partner supports asymmetric pause toward link partner.

11b = Link partner supports both symmetric and asymmetric pause.

Valid when: SerDes Flag = 0b

Auto-Negotiate = 1b

Auto-Negotiate Complete = 1b

This field is mandatory

0xCB an_lP_adv_pause[29:28] [28] = PAUSE as defined in Annex 28B [29] = ASM_DIR as defined in Annex 28B

 0
17 Rx Flow Control Flag

0b = Reception of Pause frames by the NC from the external network interface is disabled.

1b = Reception of Pause frames by the NC from the external network interface is enabled.

This field is mandatory.

Rx Flow Control Flag

1'b1 = 0x705 en_rx_pause (non zero)

1'b0 = 0x705 en_rx_pause (all zero))

Rx Flow Control Flag

1'b1 = 0x705 en_rx_pause (non zero)

1'b0 = 0x705 en_rx_pause (all zero)
16 TX Flow Control Flag

0b = Transmission of Pause frames by the NC onto the external network interface is disabled.

1b = Transmission of Pause frames by the NC onto the external network interface is enabled.

This field is mandatory interface.

This field is mandatory.

TX Flow Control Flags

1'b1 = 0x605 en_pfc_port (non zero)

1'b0 = 0x605 en_pfc_port (all zero)

Tx Flow Control Flags

1'b1 = 0x605 en_pfc_port (non zero)

1'b0 = 0x605 en_pfc_port (all zero)

15 Link Partner Advertised Speed and Duplex 10THD

1b = Link Partner is 10BASE-T half-duplex capable.

Valid when:

SerDes Flag = 0b

Auto-Negotiate Flag = 1b

Auto-Negotiate Complete = 1b

This field is mandatory.

 0 0
14 Link Partner Advertised Speed and Duplex 10TFD

1b = Link Partner is 10BASE-T full-duplex capable.

Valid when:

SerDes Flag = 0b

Auto-Negotiate Flag = 1b

Auto-Negotiate Complete = 1b

This field is mandatory.

 0 0
13 Link Partner Advertised Speed and Duplex 100TXHD

1b = Link Partner is 100BASE-TX half-duplex capable.

Valid when:

SerDes Flag = 0b

Auto-Negotiate Flag = 1b

Auto-Negotiate Complete = 1b

This field is mandatory.

 0 0
12 Link Partner Advertised Speed and Duplex 100TXFD

1b = Link Partner is 100BASE-TX full-duplex capable.

Valid when:

SerDes Flag = 0b

Auto-Negotiate Flag = 1b

Auto-Negotiate Complete = 1b

This field is mandatory

 0 0
11 Link Partner Advertised Speed and Duplex 100T4

1b = Link Partner is 100BASE-T4 capable.

Valid when:

SerDes Flag = 0b

Auto-Negotiate Flag = 1b

Auto-Negotiate Complete = 1b

This field is mandatory

 0 0
10 Link Partner Advertised Speed and Duplex 1000THD

1b = Link Partner is 1000BASE-T half-duplex capable.

Valid when:

SerDes Flag = 0b

Auto-Negotiate Flag = 1b

Auto-Negotiate Complete = 1b

This field is mandatory.

 0 0
9 Link Partner Advertised Speed and Duplex 1000TFD

1b = Link Partner is 1000BASE-T full-duplex capable.

Valid when:

SerDes Flag = 0b

Auto-Negotiate Flag = 1b

Auto-Negotiate Complete = 1b

This field is mandatory.

 0 0
8 Reserved None 0 0
7 Parallel Detection Flag

1b = Link partner did not support auto-negotiation and parallel detection was used to get link.

This field contains 0b if Parallel Detection was not used to obtain link.

 0xC2 [7:7] an_lp_apability 0
6 Auto Negotiate Complete

1b = Auto-negotiation has completed.

This includes if auto-negotiation was completed using Parallel

Detection. Always returns 0b if auto-negotiation is not supported or is not enabled.

This field is mandatory if the Auto Negotiate Flag is supported.

 0xC2 [2:2] an_complete 0
5 Auto Negotiate Flag

1b = Auto-negotiation is enabled.

This field always returns 0b if auto-negotiation is not supported.

This field is mandatory if supported by the controller.

 0xC0 [0:0] enable_an 0
4:1 Speed and duplex

0x0 = Auto-negotiate not complete [per IEEE 802.3], SerDes

Flag = 1b, or no Highest Common Denominator (HCD) from the following options (0x1 through 0x8) was found.

0x1 = 10BASE-T half-duplex

0x2 = 10BASE-T full-duplex

0x3 = 100BASE-TX half-duplex

0x4 = 100BASE-T4

0x5 = 100BASE-TX full-duplex

0x6 = 1000BASE-T half-duplex

0x7 = 1000BASE-T full-duplex

0x8 = 10G-BASE-T support

0x9 = 20 Gbps (optional for NC-SI 1.1, RESERVED for NCSI 1.0)

0xA = 25 Gbps (optional for NC-SI 1.1, RESERVED for NCSI 1.0)

0xB = 40 Gbps (optional for NC-SI 1.1, RESERVED for NCSI 1.0)

0xC = 50 Gbps (optional for NC-SI 1.1, RESERVED for NCSI 1.0)

0xD = 100 Gbps (optional for NC-SI 1.1, RESERVED for NCSI 1.0)

0xE = 2.5 Gbps (optional for NC-SI 1.1, RESERVED for NCSI 1.0)

0xF = Use values defined in Enhanced Speed and Duplex field starting at bit 24 (optional for NC-SI 1.1, RESERVED for NC-SI 1.0)

Except when SerDes = 1b, the value may reflect forced link setting.

0x0 = 0x308 (Bit [11:11] negotiation_faiilure = 1)

0xA = 0x308 (Bit 17 = 1 or Bit 18 = 1)

0xB = 0x308 (Bit 13 = 1 or Bit 14 = 1)

0xC = 0x308 (Bit 19 = 1)

0xD = 0x308 (Bit 15 or Bit 16 or Bit 20 or Bit 22 = 1)

Remaining all 0xF 		0
0 Link Flag

0b = Link is down

1b = Link is up

This field is mandatory.

 0xC2 [6:6] an_status

0x322 tx_pcs_ready AND 0x326 rx_aligned
Table 32.  Register Description for F-Tile
HSSI Read Data Fields ANLT enable ANLT disable
31:22 Reserved 0 N/A (Return 0) N/A (Return 0)
21 OEM Link Speed Valid 0b = OEM link settings are invalid.

1b = OEM link settings are valid

 N/A (Return 0) N/A (Return 0)
20 SerDes Link

SerDes status (see 4.18")

0b = SerDes not used

1b = SerDes used

This field is mandatory

0x118 tx_lanes_stable AND

0x1084 rx_aligned

0x118 tx_lanes_stable AND

0x1084 rx_aligned
19:18 Link Partner Advertised Flow Control

00b = Link partner is not pause capable.

01b = Link partner supports symmetric pause.

10b = Link partner supports asymmetric pause toward link partner.

11b = Link partner supports both symmetric and asymmetric pause.

Valid when: SerDes Flag = 0b

Auto-Negotiate = 1b

Auto-Negotiate Complete = 1b

This field is mandatory

0x31C Link partner PAUSE bits[12:10] (bit 12 - not defined)

00b = 0x31C (bit 10 and bit 11 = 0)

01b = 0x31C (bit 10 = 1)

10b = 0x31C (bit 11 = 1)

11b = 0x31C (bit 10 or bit 11 = 1)

0
17 Rx Flow Control Flag

0b = Reception of Pause frames by the NC from the external network interface is disabled.

1b = Reception of Pause frames by the NC from the external network interface is enabled.

This field is mandatory.

Rx Flow Control Flag

1'b1 = 0x1260 en_rx_pause (non zero)

1'b0 = 0x1260 en_rx_pause (all zero)

Rx Flow Control Flag

1'b1 = 0x1260 en_rx_pause (non zero)

1'b0 = 0x1260 en_rx_pause (all zero)
16 Tx Flow Control Flag

0b = Transmission of Pause frames by the NC onto the external network interface is disabled.

1b = Transmission of Pause frames by the NC onto the external network interface is enabled.

This field is mandatory interface.

This field is mandatory.

Tx Flow Control Flags

1'b1 = 0x122c en_pfc_port (non zero)

1'b0 = 0x122c en_pfc_port (all zero)

Tx Flow Control Flags

1'b1 = 0x122c en_pfc_port (non zero)

1'b0 = 0x122c en_pfc_port (all zero)

15 Link Partner Advertised Speed and Duplex 10THD

1b = Link Partner is 10BASE-T half-duplex capable.

Valid when:

SerDes Flag = 0b

Auto-Negotiate Flag = 1b

Auto-Negotiate Complete = 1b

This field is mandatory.

 0 0
14 Link Partner Advertised Speed and Duplex 10TFD

1b = Link Partner is 10BASE-T full-duplex capable.

Valid when:

SerDes Flag = 0b

Auto-Negotiate Flag = 1b

Auto-Negotiate Complete = 1b

This field is mandatory.

 0 0
13 Link Partner Advertised Speed and Duplex 100TXHD

1b = Link Partner is 100BASE-TX half-duplex capable.

Valid when:

SerDes Flag = 0b

Auto-Negotiate Flag = 1b

Auto-Negotiate Complete = 1b

This field is mandatory.

 0 0
12 Link Partner Advertised Speed and Duplex 100TXFD

1b = Link Partner is 100BASE-TX full-duplex capable.

Valid when:

SerDes Flag = 0b

Auto-Negotiate Flag = 1b

Auto-Negotiate Complete = 1b

This field is mandatory

 0 0
11 Link Partner Advertised Speed and Duplex 100T4

1b = Link Partner is 100BASE-T4 capable.

Valid when:

SerDes Flag = 0b

Auto-Negotiate Flag = 1b

Auto-Negotiate Complete = 1b

This field is mandatory

 0 0
10 Link Partner Advertised Speed and Duplex 1000THD

1b = Link Partner is 1000BASE-T half-duplex capable.

Valid when:

SerDes Flag = 0b

Auto-Negotiate Flag = 1b

Auto-Negotiate Complete = 1b

This field is mandatory.

 0 0
9 Link Partner Advertised Speed and Duplex 1000TFD

1b = Link Partner is 1000BASE-T full-duplex capable.

Valid when:

SerDes Flag = 0b

Auto-Negotiate Flag = 1b

Auto-Negotiate Complete = 1b

This field is mandatory.

 0 0
8 Reserved None 0 0
7 Parallel Detection Flag

1b = Link partner did not support auto-negotiation and parallel detection was used to get link.

This field contains 0b if Parallel Detection was not used to obtain link.

 0x308 [7:7] an_lp_apability 0
6 Auto Negotiate Complete

1b = Auto-negotiation has completed.

This includes if auto-negotiation was completed using Parallel

Detection. Always returns 0b if auto-negotiation is not supported or is not enabled.

This field is mandatory if the Auto Negotiate Flag is supported.

 0x308 [2:2] an_complete 0
5 Auto Negotiate Flag

1b = Auto-negotiation is enabled.

This field always returns 0b if auto-negotiation is not supported.

This field is mandatory if supported by the controller.

 0x300 [0:0] enable_an 0
4:1 Speed and duplex

0x0 = Auto-negotiate not complete [per IEEE 802.3], SerDes

Flag = 1b, or no Highest Common Denominator (HCD) from the following options (0x1 through 0x8) was found.

0x1 = 10BASE-T half-duplex

0x2 = 10BASE-T full-duplex

0x3 = 100BASE-TX half-duplex

0x4 = 100BASE-T4

0x5 = 100BASE-TX full-duplex

0x6 = 1000BASE-T half-duplex

0x7 = 1000BASE-T full-duplex

0x8 = 10G-BASE-T support

0x9 = 20 Gbps (optional for NC-SI 1.1, RESERVED for NCSI 1.0)

0xA = 25 Gbps (optional for NC-SI 1.1, RESERVED for NCSI 1.0)

0xB = 40 Gbps (optional for NC-SI 1.1, RESERVED for NCSI 1.0)

0xC = 50 Gbps (optional for NC-SI 1.1, RESERVED for NCSI 1.0)

0xD = 100 Gbps (optional for NC-SI 1.1, RESERVED for NCSI 1.0)

0xE = 2.5 Gbps (optional for NC-SI 1.1, RESERVED for NCSI 1.0)

0xF = Use values defined in Enhanced Speed and Duplex field starting at bit 24 (optional for NC-SI 1.1, RESERVED for NC-SI 1.0)

Except when SerDes = 1b, the value may reflect forced link setting.

0x0 = 0x308 (Bit [11:11] negotiation_faiilure = 1) negotiation_faiilure

0xA = C2 (Bit 17 = 1 or Bit 18 = 1)

0xB = C2 (Bit 13 = 1 or Bit 14 = 1)

0xC = C2 (Bit 19 = 1)

0xD = C2 (Bit 15 or Bit 16 or Bit 20 or Bit 22 = 1)

Remaining all zero

 0
0 Link Flag

0b = Link is down

1b = Link is up

This field is mandatory.

 0x308 [6:6] an_status

0x118 tx_lanes_stable AND 0x1084 rx_aligned
Level Two Title