F-Tile Triple-Speed Ethernet Intel® FPGA IP User Guide

Download PDF
ID 741328
Date 4/03/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. About the F-Tile Triple Speed Ethernet Intel FPGA IP User Guide 2. About This IP 3. Getting Started 4. Parameter Settings 5. Functional Description 6. Configuration Register Space 7. Interface Signals 8. Design Considerations 9. Timing Constraints 10. Software Programming Interface 11. F-Tile Triple-Speed Ethernet Intel® FPGA IP User Guide Archives 12. Document Revision History for the F-tile Triple-Speed Ethernet Intel® FPGA IP User Guide A. Ethernet Frame Format B. Simulation Parameters
2. About This IP x
2.1. Release Information 2.2. Device Family Support 2.3. Features 2.4. 10/100/1000 Ethernet MAC Versus Small MAC 2.5. High-Level Block Diagrams 2.6. Example Applications 2.7. IP Verification 2.8. Performance and Resource Utilization
2.7. IP Verification x
2.7.1. Optical Platform 2.7.2. Copper Platform
3. Getting Started x
3.1. Introduction to Intel® FPGA IP Cores 3.2. Installing and Licensing Intel® FPGA IPs 3.3. Specifying the IP Core Parameters and Options 3.4. IP Core Generation Output 3.5. Simulating Intel® FPGA IP Cores
3.2. Installing and Licensing Intel® FPGA IPs x
3.2.1. Intel® FPGA IP Evaluation Mode
3.4. IP Core Generation Output x
3.4.1. Design Constraint File
4. Parameter Settings x
4.1. Core Configuration 4.2. Ethernet MAC Options 4.3. FIFO Options 4.4. Timestamp Options 4.5. PCS/Transceiver Options
5. Functional Description x
5.1. 10/100/1000 Ethernet MAC 5.2. 1000BASE-X/SGMII PCS With Optional Embedded PMA 5.3. Precision Time Protocol 5.4. Deterministic Latency
5.1. 10/100/1000 Ethernet MAC x
5.1.1. MAC Architecture 5.1.2. MAC Interfaces 5.1.3. MAC Transmit Datapath 5.1.4. MAC Receive Datapath 5.1.5. MAC Transmit and Receive Latencies 5.1.6. FIFO Buffer Thresholds 5.1.7. Congestion and Flow Control 5.1.8. Magic Packets 5.1.9. MAC Local Loopback 5.1.10. MAC Reset 5.1.11. PHY Management (MDIO) 5.1.12. Connecting MAC to External PHYs
5.1.3. MAC Transmit Datapath x
5.1.3.1. IP Payload Re-alignment 5.1.3.2. Address Insertion 5.1.3.3. Frame Payload Padding 5.1.3.4. CRC-32 Generation 5.1.3.5. Interpacket Gap Insertion 5.1.3.6. Collision Detection in Half-Duplex Mode
5.1.4. MAC Receive Datapath x
5.1.4.1. Preamble Processing 5.1.4.2. Collision Detection in Half-Duplex Mode 5.1.4.3. Address Checking 5.1.4.4. Frame Type Validation 5.1.4.5. Payload Pad Removal 5.1.4.6. CRC Checking 5.1.4.7. Length Checking 5.1.4.8. Frame Writing 5.1.4.9. IP Payload Alignment
5.1.4.3. Address Checking x
5.1.4.3.1. Unicast Address Checking 5.1.4.3.2. Multicast Address Resolution
5.1.6. FIFO Buffer Thresholds x
5.1.6.1. Receive Thresholds 5.1.6.2. Transmit Thresholds 5.1.6.3. Transmit FIFO Buffer Underflow
5.1.7. Congestion and Flow Control x
5.1.7.1. Remote Device Congestion 5.1.7.2. Receive FIFO Buffer and Local Device Congestion
5.1.8. Magic Packets x
5.1.8.1. Sleep Mode 5.1.8.2. Magic Packet Detection
5.1.11. PHY Management (MDIO) x
5.1.11.1. MDIO Connection 5.1.11.2. MDIO Frame Format
5.1.12. Connecting MAC to External PHYs x
5.1.12.1. Gigabit Ethernet 5.1.12.2. Programmable 10/100 Ethernet 5.1.12.3. Programmable 10/100/1000 Ethernet Operation
5.2. 1000BASE-X/SGMII PCS With Optional Embedded PMA x
5.2.1. 1000BASE-X/SGMII PCS Architecture 5.2.2. Transmit Operation 5.2.3. Receive Operation 5.2.4. Transmit and Receive Latencies 5.2.5. GMII Converter 5.2.6. SGMII Converter 5.2.7. Auto-Negotiation 5.2.8. Ten-bit Interface 5.2.9. 1000BASE-X/SGMII PCS Reset
5.2.2. Transmit Operation x
5.2.2.1. Frame Encapsulation 5.2.2.2. 8b/10b Encoding
5.2.3. Receive Operation x
5.2.3.1. Comma Detection 5.2.3.2. 8b/10b Decoding 5.2.3.3. Frame De-encapsulation 5.2.3.4. Synchronization 5.2.3.5. Carrier Sense 5.2.3.6. Collision Detection
5.2.6. SGMII Converter x
5.2.6.1. Transmit 5.2.6.2. Receive
5.2.7. Auto-Negotiation x
5.2.7.1. 1000BASE-X Auto-Negotiation 5.2.7.2. SGMII Auto-Negotiation
5.3. Precision Time Protocol x
5.3.1. IEEE 1588v2 Supported Configurations 5.3.2. IEEE 1588v2 Features 5.3.3. IEEE 1588v2 Architecture 5.3.4. IEEE 1588v2 Transmit Datapath 5.3.5. IEEE 1588v2 Receive Datapath 5.3.6. IEEE 1588v2 Frame Format
5.3.6. IEEE 1588v2 Frame Format x
5.3.6.1. PTP Frame in IEEE 802.3 5.3.6.2. PTP Frame over UDP/IPv4 5.3.6.3. PTP Frame over UDP/IPv6
6. Configuration Register Space x
6.1. MAC Configuration Register Space 6.2. PCS Configuration Register Space 6.3. Register Initialization
6.1. MAC Configuration Register Space x
6.1.1. Base Configuration Registers (Dword Offset 0x00 – 0x17) 6.1.2. Statistics Counters (Dword Offset 0x18 – 0x38) 6.1.3. Transmit and Receive Command Registers (Dword Offset 0x3A – 0x3B) 6.1.4. Supplementary Address (Dword Offset 0xC0 – 0xC7) 6.1.5. IEEE 1588v2 Feature (Dword Offset 0xD0 – 0xD6) 6.1.6. Deterministic Latency (Dword Offset 0xE1– 0xE3) 6.1.7. IEEE 1588v2 Feature PMA Delay
6.1.1. Base Configuration Registers (Dword Offset 0x00 – 0x17) x
6.1.1.1. Command_Config Register (Dword Offset 0x02)
6.2. PCS Configuration Register Space x
6.2.1. Control Register (Word Offset 0x00) 6.2.2. Status Register (Word Offset 0x01) 6.2.3. Dev_Ability and Partner_Ability Registers (Word Offset 0x04 – 0x05) 6.2.4. An_Expansion Register (Word Offset 0x06) 6.2.5. If_Mode Register (Word Offset 0x14)
6.2.3. Dev_Ability and Partner_Ability Registers (Word Offset 0x04 – 0x05) x
6.2.3.1. 1000BASE-X 6.2.3.2. SGMII MAC Mode Auto Negotiation 6.2.3.3. SGMII PHY Mode Auto Negotiation
6.3. Register Initialization x
6.3.1. F-tile Triple-Speed Ethernet System with MII/GMII 6.3.2. F-tile Triple-Speed Ethernet System with SGMII 6.3.3. F-tile Triple-Speed Ethernet System with 1000BASE-X Interface
7. Interface Signals x
7.1. Interface Signals 7.2. Timing
7.1. Interface Signals x
7.1.1. 10/100/1000 Ethernet MAC Signals 7.1.2. 10/100/1000 Multiport Ethernet MAC Signals 7.1.3. 10/100/1000 Ethernet MAC with 1000BASE-X/SGMII PCS Signals 7.1.4. 10/100/1000 Ethernet MAC with 1000BASE-X/SGMII 2XTBI PCS and Embedded PMA Signals (F-Tile) 7.1.5. 10/100/1000 Ethernet MAC Without Internal FIFO Buffers with 1000BASE-X/SGMII 2XTBI PCS Signals 7.1.6. 10/100/1000 Ethernet MAC Without Internal FIFO Buffers with IEEE 1588v2 , 1000BASE-X/SGMII 2XTBI PCS, and Embedded Serial PMA Signals 7.1.7. 10/100/1000 Multiport Ethernet MAC with 1000BASE-X/SGMII PCS Signals 7.1.8. 10/100/1000 Ethernet MAC with 1000BASE-X/SGMII PCS and Embedded PMA Signals 7.1.9. 10/100/1000 Multiport Ethernet MAC with 1000BASE-X/SGMII PCS and Embedded PMA Signals 7.1.10. 1000BASE-X/SGMII PCS Signals 7.1.11. 1000BASE-X/SGMII 2XTBI PCS Signals 7.1.12. 1000BASE-X/SGMII PCS and PMA Signals
7.1.1. 10/100/1000 Ethernet MAC Signals x
7.1.1.1. Clock and Reset Signals 7.1.1.2. Clock Enabler Signals 7.1.1.3. MAC Control Interface Signals 7.1.1.4. MAC Status Signals 7.1.1.5. MAC Receive Interface Signals 7.1.1.6. MAC Transmit Interface Signals 7.1.1.7. Pause and Magic Packet Signals 7.1.1.8. MII/GMII/RGMII Signals 7.1.1.9. PHY Management Signals 7.1.1.10. ECC Status Signals
7.1.2. 10/100/1000 Multiport Ethernet MAC Signals x
7.1.2.1. Multiport MAC Clock and Reset Signals 7.1.2.2. Multiport MAC Receive Interface Signals 7.1.2.3. Multiport MAC Transmit Interface Signals 7.1.2.4. Multiport MAC Packet Classification Signals 7.1.2.5. Multiport MAC FIFO Status Signals
7.1.3. 10/100/1000 Ethernet MAC with 1000BASE-X/SGMII PCS Signals x
7.1.3.1. TBI Interface Signals 7.1.3.2. Status LED Control Signals 7.1.3.3. SERDES Control Signals 7.1.3.4. ECC Status Signals
7.1.4. 10/100/1000 Ethernet MAC with 1000BASE-X/SGMII 2XTBI PCS and Embedded PMA Signals (F-Tile) x
7.1.4.1. GMII Clock Signals 7.1.4.2. F-Tile Transceiver Direct PHY Signals
7.1.6. 10/100/1000 Ethernet MAC Without Internal FIFO Buffers with IEEE 1588v2 , 1000BASE-X/SGMII 2XTBI PCS, and Embedded Serial PMA Signals x
7.1.6.1. Deterministic Latency Clock Signals 7.1.6.2. IEEE 1588v2 PCS TX PTP Alignment Interface Signals 7.1.6.3. IEEE 1588v2 RX Timestamp Signals 7.1.6.4. IEEE 1588v2 TX Timestamp Signals 7.1.6.5. IEEE 1588v2 TX Timestamp Request Signals 7.1.6.6. IEEE 1588v2 TX Insert Control Timestamp Signals
7.1.8. 10/100/1000 Ethernet MAC with 1000BASE-X/SGMII PCS and Embedded PMA Signals x
7.1.8.1. 1.25 Gbps Serial Interface 7.1.8.2. Transceiver Native PHY Signal 7.1.8.3. Intel LVDS Transmitter and Receiver Soft-CDR I/O Signals
7.1.9. 10/100/1000 Multiport Ethernet MAC with 1000BASE-X/SGMII PCS and Embedded PMA Signals x
7.1.9.1. IEEE 1588v2 Time-of-Day (TOD) Clock Interface Signals 7.1.9.2. IEEE 1588v2 PCS Phase Measurement Clock Signal
7.1.10. 1000BASE-X/SGMII PCS Signals x
7.1.10.1. PCS Control Interface Signals 7.1.10.2. PCS Reset Signals 7.1.10.3. MII/GMII Clocks and Clock Enablers 7.1.10.4. GMII 7.1.10.5. MII 7.1.10.6. SGMII Status Signals
7.1.11. 1000BASE-X/SGMII 2XTBI PCS Signals x
7.1.11.1. Clock Enablers 7.1.11.2. PCS Reset Signals 7.1.11.3. TBI Interface Signals
7.2. Timing x
7.2.1. Avalon Streaming Receive Interface 7.2.2. Avalon Streaming Transmit Interface 7.2.3. GMII Transmit 7.2.4. GMII Receive 7.2.5. RGMII Transmit 7.2.6. RGMII Receive 7.2.7. MII Transmit 7.2.8. MII Receive 7.2.9. IEEE 1588v2 Timestamp
8. Design Considerations x
8.1. Optimizing Clock Resources in Multiport MAC with PCS and Embedded PMA 8.2. Sharing PLLs in Devices with LVDS Soft-CDR I/O 8.3. Exposed Ports in the New User Interface 8.4. Clocking Scheme of MAC with 2XTBI PCS and Embedded PMA
8.1. Optimizing Clock Resources in Multiport MAC with PCS and Embedded PMA x
8.1.1. MAC and PCS With LVDS Soft-CDR I/O
9. Timing Constraints x
9.1. Creating Clock Constraints 9.2. Recommended Clock Frequency
10. Software Programming Interface x
10.1. Driver Architecture 10.2. Directory Structure 10.3. PHY Definition 10.4. Using Multiple SG-DMA Descriptors 10.5. Using Jumbo Frames 10.6. API Functions 10.7. Constants
10.6. API Functions x
10.6.1. alt_tse_mac_get_common_speed() 10.6.2. alt_tse_mac_set_common_speed() 10.6.3. alt_tse_phy_add_profile() 10.6.4. alt_tse_system_add_sys() 10.6.5. triple_speed_ethernet_init() 10.6.6. tse_mac_close() 10.6.7. tse_mac_raw_send() 10.6.8. tse_mac_setGMII mode() 10.6.9. tse_mac_setMIImode() 10.6.10. tse_mac_SwReset()
A. Ethernet Frame Format x
A.1. Basic Frame Format A.2. VLAN and Stacked VLAN Frame Format A.3. Pause Frame Format
A.3. Pause Frame Format x
A.3.1. Pause Frame Generation
B. Simulation Parameters x
B.1. Functionality Configuration Parameters B.2. Test Configuration Parameters
1. About the F-Tile Triple Speed Ethernet Intel FPGA IP User Guide
2. About This IP
3. Getting Started
4. Parameter Settings
5. Functional Description
6. Configuration Register Space
7. Interface Signals
8. Design Considerations
9. Timing Constraints
10. Software Programming Interface
11. F-Tile Triple-Speed Ethernet Intel® FPGA IP User Guide Archives
12. Document Revision History for the F-tile Triple-Speed Ethernet Intel® FPGA IP User Guide
A. Ethernet Frame Format
B. Simulation Parameters

10.7. Constants

The following lists all constants defined for the MAC registers manipulation and provides links to detailed descriptions of the registers. It also list the constants that define the MAC operating mode and timeout values.

Table 106.  Constants Mapping
Constant Value Description
ALTERA_TSE_DUPLEX_MODE_DEFAULT 1 0: Half-duplex

1:Full-duplex
ALTERA_TSE_MAC_SPEED_DEFAULT 0 0: 10 Mbps

1: 100 Mbps

2: 1000 Mbps

ALTERA_TSE_SGDMA_RX_DESC_CHAIN_SIZE 1 The number of SG-DMA descriptors required for the current operating mode.
ALTERA_CHECKLINK_TIMEOUT_THRESHOLD 1000000 The timeout value when the MAC tries to establish a link with a PHY.
ALTERA_AUTONEG_TIMEOUT_THRESHOLD 250000 The auto-negotiation timeout value.
Command_Config Register (Command_Config Register (Dword Offset 0x02))
ALTERA_TSEMAC_CMD_TX_ENA_OFST 0 Configures the TX_ENA bit.
ALTERA_TSEMAC_CMD_TX_ENA_MSK 0x1
ALTERA_TSEMAC_CMD_RX_ENA_OFST 1 Configures the RX_ENA bit.
ALTERA_TSEMAC_CMD_RX_ENA_MSK 0x2
ALTERA_TSEMAC_CMD_XON_GEN_OFST 2 Configures the XON_GEN bit.
ALTERA_TSEMAC_CMD_XON_GEN_MSK 0x4
ALTERA_TSEMAC_CMD_ETH_SPEED_OFST 3 Configures the ETH_SPEED bit.
ALTERA_TSEMAC_CMD_ETH_SPEED_MSK 0x8
ALTERA_TSEMAC_CMD_PROMIS_EN_OFST 4 Configures the PROMIS_EN bit.
ALTERA_TSEMAC_CMD_PROMIS_EN_MSK 0x10
ALTERA_TSEMAC_CMD_PAD_EN_OFST 5 Configures the PAD_EN bit.
ALTERA_TSEMAC_CMD_PAD_EN_MSK 0x20
ALTERA_TSEMAC_CMD_CRC_FWD_OFST 6 Configures the CRC_FWD bit.
ALTERA_TSEMAC_CMD_CRC_FWD_MSK 0x40
ALTERA_TSEMAC_CMD_PAUSE_FWD_OFST 7 Configures the PAUSE_FWD bit.
ALTERA_TSEMAC_CMD_PAUSE_FWD_MSK 0x80
ALTERA_TSEMAC_CMD_PAUSE_IGNORE_OFST 8 Configures the PAUSE_IGNORE bit.
ALTERA_TSEMAC_CMD_PAUSE_IGNORE_MSK 0x100
ALTERA_TSEMAC_CMD_TX_ADDR_INS_OFST 9 Configures the TX_ADDR_INS bit.
ALTERA_TSEMAC_CMD_TX_ADDR_INS_MSK 0x200
ALTERA_TSEMAC_CMD_HD_ENA_OFST 10 Configures the HD_ENA bit.
ALTERA_TSEMAC_CMD_HD_ENA_MSK 0x400
ALTERA_TSEMAC_CMD_EXCESS_COL_OFST 11 Configures the EXCESS_COL bit.
ALTERA_TSEMAC_CMD_EXCESS_COL_MSK 0x800
ALTERA_TSEMAC_CMD_LATE_COL_OFST 12 Configures the LATE_COL bit.
ALTERA_TSEMAC_CMD_LATE_COL_MSK 0x1000
ALTERA_TSEMAC_CMD_SW_RESET_OFST 13 Configures the SW_RESET bit.
ALTERA_TSEMAC_CMD_SW_RESET_MSK 0x2000
ALTERA_TSEMAC_CMD_MHASH_SEL_OFST 14 Configures the MHASH_SEL bit.
ALTERA_TSEMAC_CMD_MHASH_SEL_MSK 0x4000
ALTERA_TSEMAC_CMD_LOOPBACK_OFST 15 Configures the LOOP_ENA bit.
ALTERA_TSEMAC_CMD_LOOPBACK_MSK 0x8000
ALTERA_TSEMAC_CMD_TX_ADDR_SEL_OFST 16 Configures the TX_ADDR_SEL bits (bits 16 - 18).
ALTERA_TSEMAC_CMD_TX_ADDR_SEL_MSK 0x70000
ALTERA_TSEMAC_CMD_MAGIC_ENA_OFST 19 Configures the MAGIC_ENA bit.
ALTERA_TSEMAC_CMD_MAGIC_ENA_MSK 0x80000
ALTERA_TSEMAC_CMD_SLEEP_OFST 20 Configures the SLEEP bit.
ALTERA_TSEMAC_CMD_SLEEP_MSK 0x100000
ALTERA_TSEMAC_CMD_WAKEUP_OFST 21 Configures the WAKEUP bit.
ALTERA_TSEMAC_CMD_WAKEUP_MSK 0x200000
ALTERA_TSEMAC_CMD_XOFF_GEN_OFST 22 Configures the XOFF_GEN bit.
ALTERA_TSEMAC_CMD_XOFF_GEN_MSK 0x400000
ALTERA_TSEMAC_CMD_CNTL_FRM_ENA_OFST 23 Configures the CNTL_FRM_ENA bit.
ALTERA_TSEMAC_CMD_CNTL_FRM_ENA_MSK 0x800000
ALTERA_TSEMAC_CMD_NO_LENGTH_CHECK_OFST 24 Configures the NO_LENGTH_CHECK bit.
ALTERA_TSEMAC_CMD_NO_LENGTH_CHECK_MSK 0x1000000
ALTERA_TSEMAC_CMD_ENA_10_OFST 25 Configures the ENA_10 bit.
ALTERA_TSEMAC_CMD_ENA_10_MSK 0x2000000
ALTERA_TSEMAC_CMD_RX_ERR_DISC_OFST 26 Configures the RX_ERR_DISC bit.
ALTERA_TSEMAC_CMD_RX_ERR_DISC_MSK 0x4000000
ALTERA_TSEMAC_CMD_CNT_RESET_OFST 31 Configures the CNT_RESET bit.
ALTERA_TSEMAC_CMD_CNT_RESET_MSK 0x80000000
Tx_Cmd_Stat Register (Transmit and Receive Command Registers (Dword Offset 0x3A – 0x3B))
ALTERA_TSEMAC_TX_CMD_STAT_OMITCRC_OFST 17 Configures the OMIT_CRC bit.
ALTERA_TSEMAC_TX_CMD_STAT_OMITCRC_MSK 0x20000
ALTERA_TSEMAC_TX_CMD_STAT_TXSHIFT16_OFST 18 Configures the TX_SHIFT16 bit.
ALTERA_TSEMAC_TX_CMD_STAT_TXSHIFT16_MSK 0x40000
Rx_Cmd_Stat Register (Transmit and Receive Command Registers (Dword Offset 0x3A – 0x3B))
ALTERA_TSEMAC_RX_CMD_STAT_RXSHIFT16_OFST 25 Configures the RX_SHIFT16 bit
ALTERA_TSEMAC_RX_CMD_STAT_RXSHIFT16_MSK 0x2000000
Level Two Title