Low Latency Ethernet 10G MAC Intel Stratix 10 FPGA IP Design Example User Guide

RSS

UG-20073 | 2019.04.30

Quick Start Guide

The Intel^® FPGA Low Latency 10G Ethernet (LL 10GbE) MAC Intel^® FPGA IP core for Intel^® Stratix^® 10 devices provides the capability of generating design examples for selected configurations.

Figure 1. Development Stages for the Design Example

Directory Structure

Figure 2. Directory Structure for the Design Example

Table 1. Directory and File Description
Directory/File	Description
altera_eth_top.qpf	Intel^® Quartus^® Prime Pro Edition project file.
altera_eth_top.qsf	Intel^® Quartus^® Prime Pro Edition settings file.
altera_eth_top.sv	Design example top-level HDL.
altera_eth_top.sdc	Synopsys Design Constraints (SDC) file.
rtl	The folder that contains the design example synthesizable components.
rtl/altera_eth_10g_mac_base_r.sv rtl/altera_10g_mac_base_r_wrap.v	Design example DUT top-level files for 10GBASE-R Ethernet design example.
rtl/altera_mge_rd.sv rtl/altera_mge_channel.v	Design example DUT top-level files for the following Ethernet design examples: 1G/2.5G with 1588v2 feature 1G/2.5G/10G with IEEE 1588v2 feature 10M/100M/1G/2.5G/10G
rtl/altera_mge_multi_channel.sv rtl/altera_mge_channel.v	Design example DUT top-level files for 10M/100M/1G/2.5G/5G/10G (USXGMII) Ethernet design example.
rtl/<Design Component>	The folder for each synthesizable component including Platform Designer generated IPs, such as LL 10GbE MAC, PHY, and FIFO.
simulation/ed_sim/models	The folder that contains the testbench files.
simulation/ed_sim/cadence simulation/ed_sim/mentor simulation/ed_sim/synopsys/vcs simulation/ed_sim/xcelium	The folder that contains the simulation script. It also serves as a working area for the simulator.
hwtesting/system_console	The folder that contains system console scripts for hardware testing.
output_files	The folder that contains Intel^® Quartus^® Prime Pro Edition output files including Intel^® Quartus^® Prime Pro Edition compilation reports and design programing file (.sof file).

Generating the Design

Procedure

You can generate the design example from the IP Parameter Editor.

Figure 3. Example Design Tab

Select Tools > IP Catalog to open the IP Catalog and select Low Latency Ethernet 10G MAC Intel^® FPGA IP .
The IP parameter editor appears.
Specify a top-level name and the folder for your custom IP variation, and the target device. Click OK.
To generate a design example, select a design example preset from the Presets library and click Apply. When you select a design, the system automatically populates the IP parameters for the design.
The Parameter Editor automatically sets the parameters required to generate the design example. Do not change the preset parameters in the IP tab.
Specify the parameters in the Example Design tab.
Click the Generate Example Design button.

The software generates all design files in sub-directories. You require these files to run simulation, compilation, and hardware testing.

Design Example Parameters

Table 2. Parameters in the Example Design Tab
Parameter	Description
Select Design	Available example designs for the IP parameter settings. When you select an example design from the Preset library, this field shows the selected design.
Example Design Files for Simulation or Synthesis	The files to generate for the different development phase. Simulation—generates the necessary files for simulating the example design. Synthesis—generates the synthesis files. Use these files to compile the design in the Intel^® Quartus^® Prime Pro Edition software for hardware testing and perform static timing analysis.
Generate File Format	The format of the RTL files for simulation—Verilog or VHDL.
Select Board	Supported hardware for design implementation. When you select an Intel FPGA development board, the `Target Device` is the one that matches the device on the Development Kit. If this menu is not available, there is no supported board for the options that you select. Stratix 10 H-Tile GX Transceiver Signal Integrity Development Kit : This option allows you to test the design example on the selected Intel FPGA IP development kit. This option automatically selects the `Target Device` to match the device on the Intel^® FPGA IP development kit. If your board revision has a different device grade, you can change the target device. Custom Development Kit: This option allows you to test the design example on a third party development kit with Intel^® FPGA IP device, a custom designed board with Intel^® FPGA IP device, or a standard Intel^® FPGA IP development kit not available for selection. You can also select a custom device for the custom development kit. No Development Kit: This option excludes the hardware aspects for the design example.
Change Target Device	Select this parameter to display and select all devices for the Intel^® FPGA IP development kit.
Specify Number of Channels	The number of Ethernet channels. For Intel^® Stratix^® 10 devices, the default number of channels is 2 and this parameter is not selectable.
Analog Voltage	`VCCR_GXB` and `VCCT_GXB` supply voltage for the Transceiver. Note: This option is only available from Intel^® Quartus^® Prime Pro Edition version 17.0 onwards
Enable NPDME support	Turn on this option to enable Transceiver NPDME feature. Note: This option is only available from Intel^® Quartus^® Prime Pro Edition version 17.0 onwards

Compiling and Simulating the Design

Procedure

You can compile and simulate the design by running a simulation script from the command prompt.

At the command prompt, change the working directory to <Example Design>\simulation\ed_sim\<Simulator> .

Run the simulation script for the simulator of your choice.

Simulator	Working Directory	Command
ModelSim*	`<Example Design>`/simulation/ed_sim/mentor	`vsim -c -do tb_run.tcl`
VCS*	`<Example Design>`/simulation/ed_sim/synopsys/vcs	`sh tb_run.sh`
NCSim	`<Example Design>`/simulation/ed_sim/cadence	`sh tb_run.sh`
Xcelium*	`<Example Design>`/simulation/ed_sim/xcelium	`sh tb_run.sh`

A successful simulation ends with the following message:

Simulation passed.

After successful completion, you can analyze the results.

Testbench

Figure 4. Block Diagram of the Testbench

Table 3. Testbench Components
Component	Description
Device under test (DUT)	The design example.
Avalon driver	Consists of Avalon-ST master bus functional models (BFMs). This driver forms the TX and RX paths. The driver also provides access to the Avalon-MM interface of the DUT.
Ethernet packet monitors	Monitor TX and RX datapaths, and display the frames in the simulator console.

Compiling and Testing the Design in Hardware

Procedure

You can compile and test the design in the supported Intel FPGA development kit.

Launch the Intel^® Quartus^® Prime Pro Edition software and open the design example project file. Select Processing > Start Compilation to compile the design example.
The timing constraints for the design example and the design components are automatically loaded during compilation.
Connect the development board to the host computer.
Launch the Clock Controller application, which is part of the development kit, and set new frequencies for the design example.

Note: For the frequencies to set, refer to the Hardware Testing section in the respective design example chapter.
In the Intel^® Quartus^® Prime Pro Edition software, select Tools > Programmer to configure the FPGA on the development board using the generated .sof file.
Reset the system by pressing the PB0 push button.
In the Intel^® Quartus^® Prime software, select Tools > System Debugging Tools > System Console to launch the system console.
Change the working directory to <Example Design>\hwtesting\system_console.
Initialize the design command list by running this command: source main.tcl.

Note: For a design example that does not provide the main.tcl file, refer to the Hardware Testing section in the respective design example chapter.

You can now run any of the predefined hardware tests from the System Console.

Observe the test results displayed.

Hardware Setup

Figure 5. Block Diagram of the Hardware Setup

10GBASE-R Ethernet Design Example for Intel Stratix 10 Devices

The 10GBASE-R Ethernet design example demonstrates an Ethernet solution for Intel^® Stratix^® 10 devices using the LL 10GbE MAC IP core, the native PHY IP core, and a small form factor pluggable (SFP +) module.

Generate the design example from the Example Design tab of the LL 10GbE IP parameter editor.

Features

Supports dual Ethernet channel operating at 10G using Intel^® Stratix^® 10 Native PHY.
On the transmit and receive paths:
- Provides packet monitoring system.
- Reports Ethernet MAC statistics counter.
Supports testing using different types of Ethernet packet transfer protocol.

Hardware and Software Requirements

Intel^® uses the following hardware and software to test the design example in a Linux system:

Intel^® Quartus^® Prime Pro Edition software
ModelSim* -AE, ModelSim* -SE, NCSim (Verilog only), VCS, and Xcelium* simulators
For hardware testing:
- Stratix 10 H-Tile GX Transceiver Signal Integrity Development Kit (1SG280HU3F50E3VGS1)
- Cables—SFP+ and fiber optic cable

Functional Description

Figure 6. Block Diagram—10GBASE-R Ethernet Design Example

Design Components

Table 4. Design Components
Component	Description
LL 10GbE MAC	The Low Latency Ethernet 10G MAC Intel^® FPGA IP core with the following configuration: Speed: 10G Datapath options: TX & RX Enable ECC on memory blocks: Not selected Enable 10GBASE-R register mode: Not selected Enable supplementary address: Selected Enable statistics collection: Selected Statistics counters: Memory-based TX and RX datapath Reset/Default To Enable: Selected Use legacy XGMII Interface: Selected. Use legacy Avalon Memory-Mapped Interface: Not Selected Use legacy Avalon Streaming Interface: Not selected
PHY	The L-Tile/H-Tile Transceiver Native PHY Intel Stratix 10 FPGA IP configured for the 10GBASE-R protocol. The preset sets the PHY's TX FIFO MODE to Phase Compensation and RX FIFO MODE to 10GBASE-R.
Transceiver Reset Controller	The Transceiver PHY Reset Controller Intel Stratix 10 FPGA IP core. Resets the transceiver.
Address decoder	Decodes the addresses of the components.
Reset synchronizer	Synchronizes the reset of all design components.
ATX PLL	Generates a TX serial clock for the Intel^® Stratix^® 10 10G transceiver.
FIFO	Avalon^® Streaming ( Avalon^® -ST) single-clock and dual-clock FIFO. Buffers the RX and TX data between the MAC IP core and the client.
Core fPLL	Generates 312.5 MHz and 156.25 MHz clocks to the MAC IP core, reset synchronizer, Ethernet traffic controller, address decoder and FIFO.

Clocking and Reset Scheme

Figure 7. Clocking and Reset Scheme for 10GBASE-R Design Example

Simulation

At the end of the simulation, the simulator generates the statistics of TX and RX packets in the Transcript window.

Hardware Testing

Follow the procedure at the provided link to test the design example in the selected hardware.

In the Clock Controller application, which is part of the development kit, set the following frequencies:

Y1—322.265625 MHz
U5, OUT 8—125 MHz

Test Cases

You can run any of the following tests from the System Console.

Table 5. Hardware Test Cases
Test Case	Command	Description
SFP+ loopback	`source gen_conf.tcl`	The generator generates and sends about 100 000 packets. Wait 30 seconds for it to complete its tasks.
	`source monitor_conf.tcl`	The monitor checks the number of good and bad packets received.
	`source show_stats.tcl`	This script displays the values of the statistics counters.
Avalon-ST loopback	`source loopback_conf.tcl`	This command enables the Avalon-ST loopback. This test is used with an external tester such as Spirent tester.

After the test is completed, observe the output displayed in the System Console.

Figure 8. Sample Test Output—Ethernet Packet Monitor

Figure 9. Sample Test Output—Statistics Counters

Interface Signals

Figure 10. Interface Signals of the 10GBASE-R Ethernet Design Example

Configuration Registers

You can access the 32-bit configuration registers of the design components through the Avalon^® -MM interface.

Table 6. Register Map
Byte Offset	Block
0x0000_0000 – 0x0001_CFFF	Reserved
0x0001_D000 – 0xFFFF_FFFF	Client Logic
Channel 0
0x0000_0000	MAC
0x0000_8000	PHY
0x0000_d400	RX SC FIFO
0x0000_d600	TX SC FIFO
0x0000_c000	Packet Generator and Checker
Channel 1
0x0001_0000	MAC
0x0001_8000	PHY
0x0001_d400	RX SC FIFO
0x0001_d600	TX SC FIFO
0x0001_c000	Packet Generator and Checker

10M/100M/1G/2.5G/10G Ethernet Design Example for Intel Stratix 10 Devices

The 10M/100M/1G/2.5G/10G Ethernet design example demonstrates an Ethernet solution for Intel^® Stratix^® 10 using the LL 10GbE MAC IP core operating at 10M, 100M, 1G, 2.5G, and 10G.

Generate the design example from the Example Design tab of the LL 10GbE IP parameter editor.

Features

Supports dual Ethernet channel operating at 10M, 100M, 1G, 2.5G, and 10G using Intel^® Stratix^® 10 Multi-rate PHY.
On the transmit and receive paths:
- Provides packet monitoring system.
- Reports Ethernet MAC statistics counter.
Supports testing using different types of Ethernet packet transfer protocol.

Hardware and Software Requirements

Intel uses the following hardware and software to test the design example in a Linux system:

Intel^® Quartus^® Prime Pro Edition software
ModelSim* -AE, ModelSim* -SE, NCSim (Verilog only), VCS, and Xcelium* simulators
For hardware testing:
- Stratix 10 H-Tile GX Transceiver Signal Integrity Development Kit (1SG280HU3F50E3VGS1)
- Cables— SFP+ and fiber optic cable

Functional Description

The design example consists of various components. The following block diagram shows the design components and the top-level signals of the design example.

Figure 11. Block Diagram—10M/100M/1G/2.5G/10G Ethernet Design Example

Design Components

Table 7. Design Components
Component	Description
LL 10GbE MAC	The Low Latency Ethernet 10G MAC Intel^® FPGA IP core with the following configuration: Speed: 10M/100M/1G/2.5G/10G Datapath options: TX & RX Enable ECC on memory blocks: Not selected Enable supplementary address: Selected Enable statistics collection: Selected Statistics counters: Memory-based TX and RX datapath Reset/Default To Enable: Selected All Legacy Ethernet 10G MAC Interfaces options: Selected
PHY	The 1G/2.5G/5G/10G Multi-rate Ethernet PHY Intel^® FPGA IP with the following configuration: Speed: 1G/2.5G/10G SGMII bridge: Selected Connect to MGBASE-T PHY: Selected Connect to NBASE-T PHY: Not selected PHY ID (32 bit): 0x00000000 VCCR_GXB and VCC_GXB supply voltage for the Transceiver: 1_0V Reference clock frequency for 10GbE (MHz): 644.53125 Selected TX PMA local clock division factor for 1 GbE: 1 Selected TX PMA local clock division factor for 2.5 GbE: 1 Enable Native PHY Debug Master Endpoint: Not selected Enable capability registers: Not selected Enable control and status registers: Not selected Enable PRBS soft accumulators: Not selected
Transceiver Reset Controller	The Transceiver PHY Reset Controller Intel^® FPGA IP core. Resets the transceiver.
Address Decoder	Decodes the addresses of the components.
Avalon-MM Mux Transceiver Reconfig	Provides the transceiver reconfig block and system console access to the PHY's Avalon-MM interface.
Transceiver Reconfig	Reconfigures the transceiver channel speed from 1G to 2.5G, or to 10G, and vice versa.
ATX PLL	Generates a TX serial clock for the Intel^® Stratix^® 10 2.5G and 10G transceiver.
fPLL	Generates a TX serial clock for the Intel^® Stratix^® 10 1G transceiver.

Clocking Scheme

Figure 12. Clocking Scheme for 10M/100M/1G/2.5G/10G Ethernet Design Example

Reset Scheme

The global reset signal of the design example is asynchronous and active-high. Asserting this signal resets all channels and their components. Upon power-up, reset the design example.

Figure 13. Reset Scheme for 10M/100M/1G/2.5G/10G Ethernet Design Example

Timing Constraints

When you configure the PHY in 1G/2.5G/10G (MGBASE-T) configuration, Intel^® recommends that you refer to the Timing Constraints section of 1G/2.5G/5G/10G Multi-rate Ethernet PHY Intel^® Stratix^® 10 FPGA IP User Guide for details on the timing constraint examples.

In addition, you can set false path from native PHY 10G clock to Low Latency (LL) Ethernet 10G (10GbE) MAC logic and vice versa. Since the LL 10GbE MAC logic is not running 10G clock, you do not need to ensure timing closure for LL 10GbE MAC datapath at 10G clock. For example:

set_false_path -from [get_clocks \$profile2_clk] \\
                   -to   [get_registers *|alt_em10g32:*|*]
set_false_path -from [get_registers *|alt_em10g32:*|*] \\
                   -to   [get_clocks \$profile2_clk]

where the path indicated by profile2 is associated to the native PHY 10G clock whereas the alt_em10g32 path indicates the LL 10GbE MAC logic.

Simulation

The simulation test case performs the following steps:

Starts up the example design with an operating speed of 10 Gbps.
Configures the MAC, PHY, and FIFO buffer for both channels.
Waits until the design example asserts the channel_tx_ready and channel_rx_ready signals for both channels.
Sends the following packets:
- 64-byte packet
- 1518-byte packet
- 100-byte packet
Repeats steps 2 to 4 for 2.5G, 1G, 100M, and 10M.

When simulation ends, the values of the MAC statistics counters are displayed in the transcript window. The transcript window also displays PASSED if the RX Avalon-ST interface of channel 0 received all packets successfully, all statistics error counters are zero, and the RX MAC statistics counters are equal to the TX MAC statistics counters.

Hardware Testing

Follow the procedure at the provided link to test the design example in the selected hardware.

In the Clock Controller application, which is part of the development kit, set the following frequencies:

Y1— 644.53125 MHz
U5, OUT 1—125 MHz
U5, OUT 8—125 MHz

Test Procedure

Follow these steps to test the design examples in hardware:

Run the following command in the system console to start the test.

TEST_EXT_LB <channel> <speed> <burst_size>

Example: TEST_EXT_LB 0 10G 80000000

Table 8. Command Parameters
Parameter	Valid Values	Description
`channel`	0, 1	The channel number to test.
`speed`	1G, 2.5G, 10G	The PHY speed.
`burst_size`	An integer value	The number of packets to generate for the test.

When the test is completed, observe the output displayed. The following diagrams show excerpts of the output, which shows that the Ethernet packet monitor block receives the same number of packets generated without error, and the TX and RX statistics counters.
Figure 14. Sample Test Output—Ethernet Packet Monitor

Figure 15. Sample Test Output—Statistics Counters

Interface Signals

Figure 16. Interface Signals of the Design Example

Configuration Registers

You can access the 32-bit configuration registers of the design components through the Avalon-MM interface.

Table 9. Register Map
Byte Offset	Block
0x00_0000	Transceiver Reconfiguration
0x00_4000	Reserved
Channel 0
0x01_0000	MAC
0x01_8000	PHY
0x01_A000	Native PHY Reconfiguration
Channel 1
0x02_0000	MAC
0x02_8000	PHY
0x02_A000	Native PHY Reconfiguration
Traffic Controller
0x10_0000	Traffic Controller

1G/2.5G Ethernet Design Example with IEEE 1588v2 Feature for Intel Stratix 10 Devices

The 1G/2.5G Ethernet design example with the IEEE 1588v2 feature demonstrates an Ethernet solution for Intel^® Stratix^® 10 devices using the LL 10GbE MAC IP core operating at 1G and 2.5G.

Generate the design example from the Example Design tab of the LL 10GbE IP parameter editor.

Features

Supports dual Ethernet channel operating at 1G and 2.5G using Intel^® Stratix^® 10 Multi-rate PHY.
On the transmit and receive paths:
- Provides packet monitoring system.
- Reports Ethernet MAC statistics counter.
Supports testing using different types of Ethernet packet transfer protocol.

Hardware and Software Requirements

Intel uses the following hardware and software to test the design example in a Linux system:

Intel^® Quartus^® Prime Pro Edition software
ModelSim* -AE, ModelSim* -SE, NCSim (Verilog only), VCS, and Xcelium* simulators
For hardware testing:
- Stratix 10 H-Tile GX Transceiver Signal Integrity Development Kit (1SG280HU3F50E2VGS1)
- Cables—SFP+ and fiber optic cable

Functional Description

Figure 17. Block Diagram—1G/2.5G Ethernet Design Example with IEEE 1588v2 Feature

Design Components

Table 10. Design Components
Component	Description
LL 10GbE MAC	The Low Latency Ethernet 10G MAC Intel^® FPGA IP core with the following configuration: Speed: 1G/2.5G Datapath options: TX & RX Enable ECC on memory blocks: Not selected Enable supplementary address: Selected Enable statistics collection: Selected Statistics counters: Memory-based TX and RX datapath Reset/Default To Enable: Selected All Legacy Ethernet 10G MAC Interfaces options: Selected For the design example with the IEEE 1588v2 feature, the following additional parameters are configured: Enable time stamping: Selected Enable PTP one-step clock support: Selected Timestamp fingerprint width: 4 Time Of Day format: Enable both 96b and 64b Time of Day Format
PHY	The 1G/2.5G/5G/10G Multi-rate Ethernet PHY Intel^® FPGA IP with the following configuration: Speed: 1G/2.5G Enable SGMII bridge: Not selected Enabled IEEE 1588 Precision Time Protocol: Selected PHY ID (32 bit): 0x00000000 VCCR_GXB and VCC_GXB supply voltage for the Transceiver: 1_0V Selected TX PMA local clock division factor for 1 GbE: 1 Selected TX PMA local clock division factor for 2.5 GbE: 1 Enable Native PHY Debug Master Endpoint: Not selected Enable capability registers: Not selected Enable control and status registers: Not selected Enable PRBS soft accumulators: Not selected
Transceiver Reset Controller	The Transceiver PHY Reset Controller Intel^® Stratix^® 10 FPGA IP core. Resets the transceiver.
Avalon^® -MM Mux Transceiver Reconfig	Provides the transceiver reconfig block and system console access to the PHY's Avalon^® -MM interface.
Transceiver Reconfig	Reconfigures the transceiver channel speed from 1 Gbps to 2.5 Gbps, and vice versa.
ATX PLL	Generates a TX serial clock for the Intel^® Stratix^® 10 2.5G transceiver.
fPLL	Generates a TX serial clock for the Intel^® Stratix^® 10 1G transceiver.
Core fPLL	Generates 156.25 MHz clocks to MAC IP core, reset synchronizer, Ethernet traffic controller, PTP packet classifier, and address decoder.
Design Components for the IEEE 1588v2 Feature
IO PLL	Generates the clocks for the 1588 design components.
Master Time-of-Day (TOD)	The master TOD for all channels.
TOD Synch	Synchronizes the Master TOD to all Local TODs.
Local TOD	The TOD for each channel.
Master Pulse Per Second (PPS)	The master PPS. Returns pulse per second (pps) for all channels.
PPS	The slave PPS. Returns pulse per second (pps) for each channel.
PTP Packet Classifier	Decodes the packet type of incoming PTP packets and returns the decoded information to the LL 10GbE MAC Intel^® FPGA IP core.

Clocking Scheme

Figure 18. Clocking Scheme for 1G/2.5G Ethernet Design Example with IEEE 1588v2 Feature

Reset Scheme

The global reset signal of the design example is asynchronous and active-low. Asserting this signal resets all channels and their components. Upon power-up, reset the design example.

Figure 19. Reset Scheme for 1G/2.5G Ethernet Design Example with IEEE 1588v2 Feature

Timing Constraints

When you configure the PHY in 1G/2.5G configuration, Intel^® recommends that you refer to the Timing Constraints section of 1G/2.5G/5G/10G Multi-rate Ethernet PHY Intel^® Stratix^® 10 FPGA IP User Guide for details on the timing constraint examples.

When the IEEE 1588v2 feature is enabled for 1G/2.5G PHY configuration, add the following constraints to the timing constraint file:

Set false path from native PHY 1G clock to 2.5G 1588 logic and vice versa. Since the 2.5G 1588 logic is not running the native 1G clock, you do not need to ensure timing closure for LL 10GbE MAC data path at 1G clock. For example:

set_false_path -from [get_clocks {DUT|CHANNEL_GEN[*].u_channel|phy|alt_mge_phy_0|profile0|*}] \
               -to   [get_registers {*|alt_mge_1588_tod_2p5g:*|* \
                                     *|alt_mge_1588_tod_sync_*_2p5g:*|*}]
set_false_path -from [get_registers {*|alt_mge_1588_tod_2p5g:*|* \
                                     *|alt_mge_1588_tod_sync_*_2p5g:*|*}] \
               -to   [get_clocks {DUT|CHANNEL_GEN[*].u_channel|phy|alt_mge_phy_0|profile0|*}]

where the path indicated by profile0 is associated to the native PHY 1G clock, whereas the alt_mge_1588_tod_2p5g and alt_mge_1588_tod_sync_*_2p5g paths indicate the 2.5G 1588 logic.

Set false path from native PHY 2.5G clock to 1G 1588 logic and vice versa. Since the 1G 1588 logic is not running the native 2.5G clock, you do not need to ensure timing closure for LL 10GbE MAC data path at 2.5G clock. For example:

set_false_path -from [get_clocks {DUT|CHANNEL_GEN[*].u_channel|phy|alt_mge_phy_0|profile1|*}] \
               -to   [get_registers {*|alt_mge_1588_tod_1g:*|* \
                                     *|alt_mge_1588_tod_sync_*_1g:*|*}]
set_false_path -from [get_registers {*|alt_mge_1588_tod_1g:*|* \
                                     *|alt_mge_1588_tod_sync_*_1g:*|*}] \
               -to   [get_clocks {DUT|CHANNEL_GEN[*].u_channel|phy|alt_mge_phy_0|profile1|*}]

where the path indicated by profile1 is associated to the native PHY 2.5G clock, whereas the alt_mge_1588_tod_1g and alt_mge_1588_tod_sync_*_1g paths indicate the 1G 1588 logic.

Simulation

Test Case—Design Example with the IEEE 1588v2 Feature

The simulation test case performs the following steps:

Starts up the design example with an operating speed of 2.5G.
Configures the MAC, PHY, and FIFO buffer for both channels.
Waits until the design example asserts the channel_tx_ready and channel_rx_ready signals for each channel.
Sends the following packets:
- Non-PTP
- No VLAN, PTP over Ethernet, PTP Sync Message, 1-step PTP
- VLAN, PTP over UDP/IPv4, PTP Sync Message, 1-step PTP
- Stacked VLAN, PTP over UDP/IPv6, PTP Sync Message, 2-step PTP
- No VLAN, PTP over Ethernet, PTP Delay Request Message, 1-step PTP
- VLAN, PTPover UDP/IPv4, PTP Delay Request Message, 2-step PTP
- Stacked VLAN, PTP over UDP/IPv6, PTP Delay Request Message, 1-step PTP
Repeats steps 2 to 4 for 1G.

Figure 20. Sample Simulation Output

Hardware Testing

Follow the procedure at the provided link to test the design example in the selected hardware.

In the Clock Controller application, which is part of the development kit, set the following frequencies:

U5, OUT 0—125 MHz
U5, OUT 8—125 MHz

Test Procedure

Follow these steps to test the design examples in hardware:

Run the following command in the system console to start the test.

TEST_EXT_LB <channel> <speed> <burst_size>

Example: TEST_EXT_LB 0 2.5G 1000000000

Table 11. Command Parameters
Parameter	Valid Values	Description
`channel`	0, 1	The channel number to test.
`speed`	1G, 2.5G	The PHY speed.
`burst_size`	An integer value	The number of packets to generate for the test.

When the test is completed, observe the output displayed. The following diagrams show excerpts of the output, which shows that the Ethernet packet monitor block receives the same number of packets generated without error, and the TX and RX statistics counters.
Figure 21. Sample Test Output—Ethernet Packet Monitor

Figure 22. Sample Test Output—Statistics Counters

Interface Signals

Figure 23. Interface Signals of the 1G/2.5G Ethernet Design Examples with IEEE 1588v2 Feature

Configuration Registers

You can access the 32-bit configuration registers of the design components through the Avalon-MM interface.

Table 12. Register Map
Byte Offset	Block
0x00_0000	Transceiver Reconfiguration
0x00_4000	TOD Master
Channel 0
0x01_0000	MAC
0x01_8000	PHY
0x01_A000	Native PHY Reconfiguration
Channel 1
0x02_0000	MAC
0x02_8000	PHY
0x02_A000	Native PHY Reconfiguration
Traffic Controller
0x10_0000	Traffic Controller

1G/2.5G/10G Ethernet Design Example with IEEE 1588v2 Feature for Intel Stratix 10 Devices

The 1G/2.5G/10G Ethernet design example with the IEEE 1588v2 feature demonstrates an Ethernet solution for Intel^® Stratix^® 10 using the LL 10GbE MAC IP core operating at 1G, 2.5G, and 10G.

Generate the design example from the Example Design tab of the LL 10GbE IP parameter editor.

Features

Supports dual Ethernet channel operating at 1G, 2.5G, and 10G using Intel^® Stratix^® 10 Multi-rate PHY.
On the transmit and receive paths:
- Provides packet monitoring system.
- Reports Ethernet MAC statistics counter.
Supports testing using different types of Ethernet packet transfer protocol.

Hardware and Software Requirements

Intel uses the following hardware and software to test the design example in a Linux system:

Intel^® Quartus^® Prime Pro Edition software
ModelSim* -AE, ModelSim* -SE, NCSim (Verilog only), VCS, and Xcelium* simulators
For hardware testing:
- Stratix 10 H-Tile GX Transceiver Signal Integrity Development Kit (1SG280HU3F50E2VGS1)
- Cables—SFP+ and fiber optic cable

Functional Description

The design example consists of various components. The following block diagram shows the design components and the top-level signals of the design example.

Figure 24. Block Diagram—1G/2.5G/10G Ethernet Design Example with IEEE 1588v2 Feature

Design Components

Table 13. Design Components
Component	Description
LL 10GbE MAC	The Low Latency Ethernet 10G MAC Intel^® FPGA IP core with the following configuration: Speed: 1G/2.5G/10G Datapath options: TX & RX Enable ECC on memory blocks: Not selected Enable supplementary address: Selected Enable statistics collection: Selected Statistics counters: Memory-based TX and RX datapath Reset/Default To Enable: Selected All Legacy Ethernet 10G MAC Interfaces options: Selected For the design example with the IEEE 1588v2 feature, the following additional parameters are configured: Enable time stamping: Selected Enable PTP one-step clock support: Selected Timestamp fingerprint width: 4 Time Of Day format: Enable both 96b and 64b Time of Day Format
PHY	The 1G/2.5G/5G/10G Multi-rate Ethernet PHY Intel^® FPGA IP with the following configuration: Speed: 1G/2.5G/10G Enable SGMII bridge: Not selected Enabled IEEE 1588 Precision Time Protocol: Selected Connect to MGBASE-T PHY: Selected Connect to NBASE-T PHY: Not selected PHY ID (32 bit): 0x00000000 VCCR_GXB and VCC_GXB supply voltage for the Transceiver: 1_0V Reference clock frequency for 10GbE (MHz): 644.53125 Selected TX PMA local clock division factor for 1 GbE: 1 Selected TX PMA local clock division factor for 2.5 GbE: 1 Enable Native PHY Debug Master Endpoint: Not selected Enable capability registers: Not selected Enable control and status registers: Not selected Enable PRBS soft accumulators: Not selected
Transceiver Reset Controller	The Transceiver PHY Reset Controller Intel^® Stratix^® 10 FPGA IP core. Resets the transceiver.
Avalon-MM Mux Transceiver Reconfig	Provides the transceiver reconfig block and system console access to the PHY's Avalon-MM interface.
Transceiver Reconfig	Reconfigures the transceiver channel speed from 1G to 2.5G, or to 10G, and vice versa.
ATX PLL	Generates a TX serial clock for the Intel^® Stratix^® 10 2.5G and 10G transceiver.
fPLL	Generates a TX serial clock for the Intel^® Stratix^® 10 1G transceiver.
Design Components for the IEEE 1588v2 Feature
ToD Sampling fPLL	Generates the clocks for the 1588 design components.
Master ToD	The master ToD for all channels.
ToD Synch	Synchronizes the Master ToD to all Local ToDs.
Local ToD	The ToD for each channel.
Master PPS	The master PPS. Returns pulse per second (pps) for all channels.
PPS	The slave PPS. Returns pulse per second (pps) for each channel.
PTP Packet Classifier	Decodes the packet type of incoming PTP packets and returns the decoded information to the LL 10GbE MAC Intel^® FPGA IP core.

Clocking Scheme

Figure 25. Clocking Scheme for 1G/2.5G/10G Ethernet Design Example with IEEE 1588v2 Feature

Reset Scheme

The global reset signal of the design example is asynchronous and active-low. Asserting this signal resets all channels and their components. Upon power-up, reset the design example.

Figure 26. Reset Scheme for 1G/2.5G/10G Ethernet Design Example with IEEE 1588v2 Feature

Timing Constraints

When the IEEE 1588v2 feature is enabled for 1G/2.5G/5G (MGBASE-T) PHY configuration, add the following constraints to the timing constraint file:

set_false_path -from [get_clocks {DUT|CHANNEL_GEN[*].u_channel|phy|alt_mge_phy_0|profile0|*}] \
               -to   [get_registers {*|alt_mge_1588_tod_2p5g:*|* \
                                     *|alt_mge_1588_tod_sync_*_2p5g:*|*}]
set_false_path -from [get_registers {*|alt_mge_1588_tod_2p5g:*|* \
                                     *|alt_mge_1588_tod_sync_*_2p5g:*|*}] \
               -to   [get_clocks {DUT|CHANNEL_GEN[*].u_channel|phy|alt_mge_phy_0|profile0|*}]

where the path indicated by profile0 is associated to the native PHY 1G clock, whereas the alt_mge_1588_tod_2p5g and alt_mge_1588_tod_sync_*_2p5g paths indicate the 2.5G 1588 logic.

set_false_path -from [get_clocks {DUT|CHANNEL_GEN[*].u_channel|phy|alt_mge_phy_0|profile1|*}] \
               -to   [get_registers {*|alt_mge_1588_tod_1g:*|* \
                                     *|alt_mge_1588_tod_sync_*_1g:*|*}]
set_false_path -from [get_registers {*|alt_mge_1588_tod_1g:*|* \
                                     *|alt_mge_1588_tod_sync_*_1g:*|*}] \
               -to   [get_clocks {DUT|CHANNEL_GEN[*].u_channel|phy|alt_mge_phy_0|profile1|*}]

where the path indicated by profile1 is associated to the native PHY 2.5G clock, whereas the alt_mge_1588_tod_1g and alt_mge_1588_tod_sync_*_1g paths indicate the 1G 1588 logic.

Set false path from native PHY 10G clock to 1G/2.5G 1588 logic and vice versa. Since the 1G/2.5G 1588 logic is not running the native 10G clock, you do not need to ensure timing closure for LL 10GbE MAC data path at 2.5G clock. For example:
```
set_false_path -from [get_clocks \$profile2_clk] \\
                   -to   [get_registers *|alt_em10g32:*|*]
set_false_path -from [get_registers *|alt_em10g32:*|*] \\
                   -to   [get_clocks \$profile2_clk]
```
where the path indicated by profile2 is associated to the native PHY 10G clock, whereas the alt_em10g32 path indicates the Low Latency Ethernet 10G MAC logic.

Simulation

Test Case—Design Example with the IEEE 1588v2 Feature

The simulation test case performs the following steps:

Starts up the design example with an operating speed of 10G.
Configures the MAC, PHY, and FIFO buffer for both channels.
Waits until the design example asserts the channel_tx_ready and channel_rx_ready signals for each channel.
Sends the following packets:
- Non-PTP
- No VLAN, PTP over Ethernet, PTP Sync Message, 1-step PTP
- VLAN, PTP over UDP/IPv4, PTP Sync Message, 1-step PTP
- Stacked VLAN, PTP over UDP/IPv6, PTP Sync Message, 2-step PTP
- No VLAN, PTP over Ethernet, PTP Delay Request Message, 1-step PTP
- VLAN, PTPover UDP/IPv4, PTP Delay Request Message, 2-step PTP
- Stacked VLAN, PTP over UDP/IPv6, PTP Delay Request Message, 1-step PTP
Repeats steps 2 to 4 for 1G and 2.5G.

When simulation ends, the values of the MAC statistics counters are displayed in the transcript window. The transcript window also displays PASSED if the RX Avalon^® -ST interface of channel 0 received all packets successfully, all statistics error counters are zero, and the RX MAC statistics counters are equal to the TX MAC statistics counters.

Figure 27. Sample Simulation Output

Hardware Testing

Follow the procedure at the provided link to test the design example in the selected hardware.

The design example is using board trace loopback by default. To use SFP+, follow instruction in Changing to SFP+ Setting.

In the Clock Controller application, which is part of the development kit, set the following frequencies:

For board trace loopback setting:

U5, OUT 0—644.53125 MHz
U5, OUT 4—125 MHz
U5, OUT 8—125 MHz

For SFP+ setting:

Y1—644.53125 MHz
U5, OUT 1—125 MHz
U5, OUT 8—125 MHz

Changing to SFP+ Setting

In order to use SFP+, modify altera_eth_top.qsf file with the following setting:

Test Procedure

Follow these steps to test the design examples in hardware:

Run the following command in the system console to start the test.

TEST_EXT_LB <channel> <speed> <burst_size>

Example: TEST_EXT_LB 0 10G 200000

Table 14. Command Parameters
Parameter	Valid Values	Description
`channel`	0, 1	The channel number to test.
`speed`	1G, 2.5G, 10G	The PHY speed.
`burst_size`	An integer value	The number of packets to generate for the test.

When the test is completed, observe the output displayed. The following diagrams show excerpts of the output, which shows that the Ethernet packet monitor block receives the same number of packets generated without error, and the TX and RX statistics counters.
Figure 28. Sample Test Output—Ethernet Packet Monitor

Figure 29. Sample Test Output—Statistics Counters

Interface Signals

Figure 30. Interface Signals of the 1G/2.5G/10G Ethernet Design Examples with IEEE 1588v2 Feature

Configuration Registers

You can access the 32-bit configuration registers of the design components through the Avalon-MM interface.

Table 15. Register Map
Byte Offset	Block
0x00_0000	Transceiver Reconfiguration
0x00_4000	TOD Master
Channel 0
0x01_0000	MAC
0x01_8000	PHY
0x01_A000	Native PHY Reconfiguration
Channel 1
0x02_0000	MAC
0x02_8000	PHY
0x02_A000	Native PHY Reconfiguration
Traffic Controller
0x10_0000	Traffic Controller

10M/100M/1G/2.5G/5G/10G (USXGMII) Ethernet Design Example for Intel Stratix 10 Devices

The 10M/100M/1G/2.5G/5G/10G (USXGMII) design example demonstrates an Ethernet solution for Intel^® Stratix^® 10 devices using the LL 10GbE MAC Intel^® FPGA IP core operating at 10M, 100M, 1G, 2.5G, 5G, and 10G.

Generate the design example from the Example Design tab of the LL 10GbE Intel^® FPGA IP parameter editor. You can choose to generate the design with or without the IEEE 1588v2 feature.

Features

Supports dual Ethernet channel operating at 10M, 100M, 1G, 2.5G, 5G, and 10G.
On the transmit and receive paths:
- Provides packet monitoring system.
- Reports Ethernet MAC statistics counter.
Option to generate the design example with IEEE 1588v2 feature.
Supports testing using different types of Ethernet packet transfer protocol.

Hardware and Software Requirements

Intel uses the following hardware and software to test the design example in a Linux system:

Intel^® Quartus^® Prime Pro Edition software
ModelSim* -AE, ModelSim* -SE, NCSim (Verilog only), VCS, and Xcelium* simulators
For hardware testing:
- Stratix 10 H-Tile GX Transceiver Signal Integrity Development Kit (1SG280HU3F50E3VGS1)
- Cables—SFP+ and fiber optic cable

Functional Description

The design example consists of various components. The following block diagram shows the design components and the top-level signals of the design example.

Figure 31. Block Diagram—10M/100M/1G/2.5G/5G/10G (USXGMII) Ethernet Design Example Without IEEE 1588v2 Feature

Figure 32. Block Diagram—10M/100M/1G/2.5G/5G/10G (USXGMII) Ethernet Design Example With IEEE 1588v2 Feature

Design Components

Table 16. Design Components
Component	Description
LL 10GbE MAC	The Low Latency Ethernet 10G MAC Intel^® FPGA IP core with the following configuration: Speed: 10M/100M/1G/2.5G/5G/10G (USXGMII) Datapath options: TX & RX Enable ECC on memory blocks: Not selected Enable supplementary address: Selected Enable statistics collection: Selected Statistics counters: Memory-based TX and RX datapath Reset/Default To Enable: Selected Use legacy XGMII Interface: Not selected Use legacy Avalon Memory-Mapped Interface: Not selected Use legacy Avalon Streaming Interface: Selected For the design example with the IEEE 1588v2 feature, the following additional parameters are configured: Enable time stamping: Selected Enable PTP one-step clock support: Selected Timestamp fingerprint width: 4 Time Of Day format: Enable both 96b and 64b Time of Day Format
PHY	The 1G/2.5G/5G/10G Multi-rate Ethernet PHY Intel^® FPGA IP with the following configuration: Speed: 10M/100M/1G/2.5G/5G/10G Enable SGMII bridge: Not selected Enabled IEEE 1588 Precision Time Protocol: Selected Connect to MGBASE-T PHY: Not selected Connect to NBASE-T PHY: Selected VCCR_GXB and VCC_GXB supply voltage for the Transceiver: 1_0V Reference clock frequency for 10GbE (MHz): 644.53125 Enable Native PHY Debug Master Endpoint: Not selected Enable capability registers: Not selected Enable control and status registers: Not selected Enable PRBS soft accumulators: Not selected
Channel address decoder	Decodes the addresses of the components in each Ethernet channel, such as PHY and LL 10GbE MAC.
Multi-channel address decoder	Decodes the addresses of the components used by all channels , such as the Master ToD module.
Top address decoder	Decodes the addresses of the top-level components, such as the Traffic Controller.
Transceiver Reset Controller	The Transceiver PHY Reset Controller Intel^® Stratix^® 10 FPGA IP core. Resets the transceiver.
ATX PLL	Generates a TX serial clock for the Intel^® Stratix^® 10 transceiver.
Core fPLL	Generates clocks for all design components.
Design Components for the IEEE 1588v2 Feature
ToD Sampling fPLL	Generates the clocks for the 1588 design components.
Master ToD	The master ToD for all channels.
ToD Synch	Synchronizes the Master ToD to all Local ToDs.
Local ToD	The ToD for each channel.
Master PPS	The master PPS. Returns pulse per second (pps) for all channels.
PPS	The slave PPS. Returns pulse per second (pps) for each channel.
PTP Packet Classifier	Decodes the packet type of incoming PTP packets and returns the decoded information to the LL 10GbE MAC Intel^® FPGA IP core.

Clocking Scheme

Figure 33. Clocking Scheme for 10M/100M/1G/2.5G/5G/10G (USXGMII) Ethernet Design Example Without IEEE 1588v2 Feature

Figure 34. Clocking Scheme for 10M/100M/1G/2.5G/5G/10G (USXGMII) Ethernet Design Example With IEEE 1588v2 Feature

Reset Scheme

The global reset signal of the design example is asynchronous and active-high. Asserting this signal resets all channels and their components. Upon power-up, reset the design example.

Figure 35. Reset Scheme for 10M/100M/1G/2.5G/5G/10G (USXGMII) Ethernet Design Example With IEEE 1588v2 Feature

Figure 36. Reset Scheme for 10M/100M/1G/2.5G/5G/10G (USXGMII) Ethernet Design Example Without IEEE 1588v2 Feature

Simulation

Test Case—Design Example with the IEEE 1588v2 Feature

The simulation test case performs the following steps:

Starts up the design example with an operating speed of 10G.
Configures the MAC, PHY, and FIFO buffer for both channels.
Waits until the design example asserts the channel_tx_ready and channel_rx_ready signals for each channel.
Sends the following packets:
- Non-PTP
- No VLAN, PTP over Ethernet, PTP Sync Message, 1-step PTP
- VLAN, PTP over UDP/IPv4, PTP Sync Message, 1-step PTP
- Stacked VLAN, PTP over UDP/IPv6, PTP Sync Message, 2-step PTP
- No VLAN, PTP over Ethernet, PTP Delay Request Message, 1-step PTP
- VLAN, PTPover UDP/IPv4, PTP Delay Request Message, 2-step PTP
- Stacked VLAN, PTP over UDP/IPv6, PTP Delay Request Message, 1-step PTP
Repeats steps 2 to 4 for 10M, 100M, 1G, 2.5G, and 5G.

Figure 37. Sample Simulation Output

Test Case—Design Example without the IEEE 1588v2 Feature

The simulation test case performs the following steps:

Starts up the example design with an operating speed of 10G.
Configures the MAC, PHY, and FIFO buffer for both channels.
Waits until the design example asserts the channel_tx_ready and channel_rx_readysignals for both channels.
Sends the following packets:
- 64-byte packet
- 1518-byte packet
- 100-byte packet
Repeats steps 2 to 4 for 10M, 100M, 1G, 2.5G, and 5G.

Figure 38. Sample Simulation Output

Hardware Testing

Follow the procedure at the provided link to test the design example in the selected hardware.

In the Clock Controller application, which is part of the development kit, set the following frequencies:

Y1—644.53125 MHz
U5, OUT 8—125 MHz

Test Procedure

Follow these steps to test the design examples in hardware:

Run the following command in the system console to start the test.

TEST_EXT_LB <channel> <speed> <burst_size>

Example: TEST_EXT_LB 0 10G 80000000

Table 17. Command Parameters
Parameter	Valid Values	Description
`channel`	0, 1	The channel number to test.
`speed`	10M, 100M, 1G, 2P5G, 5G, 10G	The PHY speed.
`burst_size`	An integer value	The number of packets to generate for the test.

When the test is completed, observe the output displayed. The following diagrams show excerpts of the output, which shows that the Ethernet packet monitor block receives the same number of packets generated without error, and the TX and RX statistics counters.

Figure 39. Sample Test Output—Ethernet Packet Monitor

Figure 40. Sample Test Output—Statistics Counters

Interface Signals

Figure 41. Interface Signals of the 10M/100M/1G/2.5G/5G/10G (USXGMII) Ethernet Design Example

Configuration Registers

You can access the 32-bit configuration registers of the design components through the Avalon^® -MM interface.

Table 18. Register Map
Byte Offset	Block
0x00_0000	Reserved
Channel 0
0x02_0000	Reserved
0x02_4000	PHY
0x02_6000	Native PHY Reconfiguration
0x02_8000	MAC
Channel 1
0x03_0000	Reserved
0x03_4000	PHY
0x03_6000	Native PHY Reconfiguration
0x03_8000	MAC
Traffic Controller
0x10_0000	Traffic Controller

Interface Signals Description

Use the following tables to find the description of the signals in the design example. The pinout diagram for each design example specifies the width of the signals.

Clock and Reset Interface Signals

Table 19. Clock and Reset Interface Signals
Signal	Direction	Width	Description
`csr_clk`	In	1	125 MHz configuration clock for the Avalon^® -MM interface and core logic. In Intel^® Stratix^® 10 devices, it also provides clock for core logics.
`csr_rst_n`	In	1	Active-low reset signal for the Avalon^® -MM interface.
`tx_rst_n`	In	1	Active-low reset signal for the TX datapath.
`rx_rst_n`	In	1	Active-low reset signal for the RX datapath.
`mac_clk`	In	1	156.25 MHz configuration clock for the Avalon^® -ST interface and 0 ppm frequency difference with `refclk`.
`refclk`	In	1	125 MHz reference clock for the TX PLLs.
`ref_clk_clk`	In	1	644.53125 MHz clock for the TX PLL.
`core_clk_312`	Out	1	312.5 MHz clock for the fast domain.
`core_clk_156`	Out	1	156.25 MHz clock for the slow domain.
`rx_pma_clkout`	Out	1	CDR recovered clock.
`reset`	In	1	Assert this asynchronous and active-high signal to reset the whole design example.
`tx_digitalreset`	In	`[NUM_CHANNELS]`	Asynchronous and active-high signal to reset PCS TX portion of the transceiver PHY.
`rx_digitalreset`	In	`[NUM_CHANNELS]`	Asynchronous and active-high signal to reset PCS RX portion of the transceiver PHY.
`tx_digitalreset_stat`	Out	`[NUM_CHANNELS]`	Status signal for `tx_digitalreset` from PHY.
`rx_digitalreset_stat`	Out	`[NUM_CHANNELS]`	Status signal for `rx_digitalreset` from PHY.
`tx_analogreset`	In	`[NUM_CHANNELS]`	Asynchronous and active-high signal to reset PMA TX portion of the transceiver PHY
`rx_analogreset`	In	`[NUM_CHANNELS]`	Asynchronous and active-high signal to reset PMA RX portion of the transceiver PHY.
`tx_analogreset_stat`	Out	`[NUM_CHANNELS]`	Status signal for `tx_analogreset` from PHY.
`rx_analogreset_stat`	Out	`[NUM_CHANNELS]`	Status signal for `rx_analogreset` from PHY.

Avalon -MM Interface Signals

Table 20. Avalon^® -MM Interface Signals
Signal	Direction	Description
`write` `csr_mac_write` `csr_phy_write` `csr_rcfg_write` `csr_native_phy_rcfg_write` `csr_master_tod_write` `csr_mch_write`	In	Assert this signal to request a write.
`read` `csr_mac_read` `csr_phy_read` `csr_rcfg_read` `csr_native_phy_rcfg_read` `csr_master_tod_read` `csr_mch_read`	In	Assert this signal to request a read.
`address` `csr_mac_address` `csr_phy_address` `csr_rcfg_address` `csr_native_phy_rcfg_address` `csr_master_tod_address` `csr_mch_address`	In	Use this bus to specify the register address you want to read from or write to.
`writedata` `csr_mac_writedata` `csr_phy_writedata` `csr_rcfg_writedata` `csr_native_phy_rcfg_writedata` `csr_master_tod_writedata` `csr_mch_writedata`	In	Carries the data to be written to the specified register.
`readdata` `csr_mac_readdata` `csr_phy_readdata` `csr_rcfg_readdata` `csr_native_phy_rcfg_readdata` `csr_master_tod_readdata` `csr_mch_readdata`	Out	Carries the data read from the specified register.
`waitrequest` `csr_mac_waitrequest` `csr_phy_waitrequest` `csr_native_phy_rcfg_waitrequest` `csr_master_tod_waitrequest` `csr_mch_waitrequest`	Out	When asserted, this signal indicates that the IP core is busy and not ready to accept any read or write requests.

Avalon-ST Interface Signals

Table 21. Avalon-ST Interface Signals
Signal	Direction	width	Description
`avalon_st_tx_startofpacket[]`	In	`[NUM_CHANNELS]`	Assert this signal to indicate the beginning of the TX data.
`avalon_st_tx_endofpacket[]`	In	`[NUM_CHANNELS]`	Assert this signal to indicate the end of the TX data.
`avalon_st_tx_valid[]`	In	`[NUM_CHANNELS]`	Assert this signal to indicate that the `avalon_st_tx_data` signal and other signals on this interface are valid.
`avalon_st_tx_ready[]`	Out	`[NUM_CHANNELS]`	When asserted, indicates that the MAC IP core is ready to accept data. The reset value of this signal is nondeterministic.
`avalon_st_tx_error[]`	In	`[NUM_CHANNELS]`	Assert this signal to indicate that the current TX packet contains errors.
`avalon_st_tx_data[][]`	In	`[NUM_CHANNELS][m]`	TX data from the client. m is 64 when the Use legacy Avalon Streaming Interface parameter is selected. Otherwise, m is 32.
`avalon_st_tx_empty[][]`	In	`[NUM_CHANNELS][m]`	Use this signal to specify the number of empty bytes in the cycle that contain the end of the TX data. m is 3 when the Use legacy Avalon Streaming Interface parameter is selected. Otherwise, m is 2. 0x0—All bytes are valid. 0x1—The last byte is invalid. 0x2—The last two bytes are invalid. 0x3—The last three bytes are invalid.
`avalon_st_rx_startofpacket[]`	Out	`[NUM_CHANNELS]`	When asserted, indicates the beginning of the RX data.
`avalon_st_rx_endofpacket[]`	Out	`[NUM_CHANNELS]`	When asserted, indicates the end of the RX data.
`avalon_st_rx_valid[]`	Out	`[NUM_CHANNELS]`	When asserted, indicates that the `avalon_st_rx_data` signal and other signals on this interface are valid.
`avalon_st_rx_ready[]`	In	`[NUM_CHANNELS]`	Assert this signal when the client is ready to accept data.
`avalon_st_rx_error[][]`	Out	`[NUM_CHANNELS][6]`	When set to 1, the respective bits indicate an error type: Bit 0—PHY error. — For 10 Gbps, the data on `xgmii_rx_data` contains a control error character (FE). For 10 Mbps,100 Mbps,1 Gbps, `gmii_rx_err` or `mii_rx_err` is asserted. Bit 1—CRC error. The computed CRC value does not match the CRC received. Bit 2—Undersized frame. The receive frame length is less than 64 bytes. Bit 3—Oversized frame. The receive frame length is more than `MAX_FRAME_SIZE`. Bit 4—Payload length error. The actual frame payload length is different from the value in the length/type field. Bit 5—Overflow error. The receive FIFO buffer is full while it is still receiving data from the MAC IP core.
`avalon_st_rx_data[][]`	Out	`[NUM_CHANNELS][m]`	RX data to the client. m is 64 when the Use legacy Avalon Streaming Interface parameter is selected. Otherwise, m is 32.
`avalon_st_rx_empty[][]`	Out	`[NUM_CHANNELS][m]`	Contains the number of empty bytes during the cycle that contain the end of the RX data. m is 3 when the Use legacy Avalon Streaming Interface parameter is selected. Otherwise, m is 2.
`avalon_st_tx_status_valid[]`	Out	`[NUM_CHANNELS]`	When asserted, this signal qualifies the `avalon_st_txstatus_data` and `avalon_st_txstatus_error` signals.
`avalon_st_tx_status_data[][]`	Out	`[NUM_CHANNELS][40]`	Contains information about the TX frame. Bits 0 to 15: Payload length. Bits 16 to 31: Packet length. Bit 32: When set to 1, indicates a stacked VLAN frame. Bit 33: When set to 1, indicates a VLAN frame. Bit 34: When set to 1, indicates a control frame. Bit 35: When set to 1, indicates a pause frame. Bit 36: When set to 1, indicates a broadcast frame. Bit 37: When set to 1, indicates a multicast frame. Bit 38: When set to 1, indicates a unicast frame. Bit 39: When set to 1, indicates a PFC frame.
`avalon_st_tx_status_error[][]`	Out	`[NUM_CHANNELS][7]`	When set to 1, the respective bit indicates the following error type in the TX frame: Bit 0: Undersized frame. Bit 1: Oversized frame. Bit 2: Payload length error. Bit 3: Unused. Bit 4: Underflow. Bit 5: Client error. Bit 6: Unused. The error status is invalid when an overflow occurs.
`avalon_st_rx_status_valid[]`	Out	`[NUM_CHANNELS]`	When asserted, this signal qualifies the`avalon_st_rxstatus_data` and avalon_ `st_rxstatus_error` signals. The MAC IP core asserts this signal in the same clock cycle the `avalon_st_rx_ endofpacket` signal is asserted.
`avalon_st_rx_status_data[][]`	Out	`[NUM_CHANNELS][40]`	Contains information about the RX frame. Bits 0 to 15: Payload length. Bits 16 to 31: Packet length. Bit 32: When set to 1, indicates a stacked VLAN frame. Bit 33: When set to 1, indicates a VLAN frame. Bit 34: When set to 1, indicates a control frame. Bit 35: When set to 1, indicates a pause frame. Bit 36: When set to 1, indicates a broadcast frame. Bit 37: When set to 1, indicates a multicast frame. Bit 38: When set to 1, indicates a unicast frame. Bit 39: When set to 1, indicates a PFC frame.
`avalon_st_rx_status_error[][]`	Out	`[NUM_CHANNELS][7]`	When set to 1, the respective bit indicates the following error type in the RX frame. Bit 0: Undersized frame. Bit 1: Oversized frame. Bit 2: Payload length error. Bit 3: Unused. Bit 4: Underflow. Bit 5: Client error. Bit 6: Unused. The error status is invalid when an overflow occurs.
`avalon_st_pause_data[][]`	In	`[NUM_CHANNELS][2]`	This signal takes effect when the register bits,`tx_pauseframe_enable[2:1]`, are both set to the default value 0. Set this signal to the following values to trigger the corresponding actions. 0x0—Stops pause frame generation. 0x1—Generates an XON pause frame. 0x2—Generates an XOFF pause frame. The MAC IP core sets the pause quanta field in the pause frame to the value in the `tx_pauseframe_quanta` register. 0x3—Reserved.

PHY Interface Signals

Table 22. PHY Interface Signals
Signal	Direction	Width	Description
`rx_serial_data`	In	2	RX serial input data
`tx_serial_data`	Out	2	TX serial output data

Status Interface

Table 23. Status Interface Signals
Signal	Direction	Description
`led_link` `block_lock` `rx_block_lock`	Out	Asserted when the link synchronization is successful.
`led_an` `ethernet_1g_an`	Out	Asserted when auto-negotiation is completed.
`led_char_err` `ethernet_1g_char_err`	Out	Asserted when a 10-bit character error is detected in the RX data.
`led_disp_err` `ethernet_1g_disp_err`	Out	Asserted when a 10-bit running disparity error is detected in the RX data.
`channel_ready` `channel_tx_ready` `channel_rx_ready` `tx_ready_export` `rx_ready_export`	Out	Asserted when the channel is ready for data transmission.
`atx_pll_locked`	Out	Asserted when the TX PLL is locked.

IEEE 1588v2 Timestamp Interface Signals

Table 24. IEEE 1588v2 Timestamp Interface Signals
Signal	Direction	Width	Description
`tx_egress_timestamp_96b_valid`	Out	`[NUM_CHANNELS]`	When asserted, this signal qualifies the timestamp, `tx_egress_timestamp_96b_data[]`, and the fingerprint, `tx_egress_timestamp_96b_fingerprint[]`, of the TX frame.
`tx_egress_timestamp_96b_data`	Out	`[NUM_CHANNELS][96]`	Carries the 96-bit egress timestamp in the following format: Bits 48 to 95: 48-bit seconds field Bits 16 to 47: 32-bit nanoseconds field Bits 0 to 15: 16-bit fractional nanoseconds field
`tx_egress_timestamp_96b_fingerprint`	Out	`[NUM_CHANNELS][TSTAMP_FP_WIDTH]`	Specifies the fingerprint of the TX frame that the 96-bit timestamp is for.
`tx_egress_timestamp_64b_valid`	Out	`[NUM_CHANNELS]`	When asserted, this signal qualifies the timestamp, `tx_egress_timestamp_64b_data[]`, and the fingerprint, `tx_egress_timestamp_64b_fingerprint[]`, of the TX frame.
`tx_egress_timestamp_64b_data`	Out	`[NUM_CHANNELS][64]`	Carries the 64-bit egress timestamp in the following format: Bits 16 to 63: 48-bit nanoseconds field Bits 0 to 15: 16-bit fractional nanoseconds field
`tx_egress_timestamp_64b_fingerprint`	Out	`[NUM_CHANNELS][TSTAMP_FP_WIDTH]`	Specifies the fingerprint of the TX frame that the 64-bit timestamp is for.
`rx_egress_timestamp_96b_valid`	Out	`[NUM_CHANNELS]`	When asserted, this signal qualifies the timestamp, `rx_ingress_timestamp_96b_data[]`. The MAC IP core asserts this signal in the same clock cycle it asserts `avalon_st_rx_startofpacket`.
`rx_egress_timestamp_96b_data`	Out	`[NUM_CHANNELS][96]`	Carries the 96-bit ingress timestamp in the following format: Bits 48 to 95: 48-bit seconds field Bits 16 to 47: 32-bit nanoseconds field Bits 0 to 15: 16-bit fractional nanoseconds field
`rx_egress_timestamp_64b_valid`	Out	`[NUM_CHANNELS]`	When asserted, this signal qualifies the timestamp, `rx_ingress_timestamp_64b_data[]`. The MAC IP core asserts this signal in the same clock cycle it asserts `avalon_st_rx_startofpacket`.
`rx_egress_timestamp_64b_data`	Out	`[NUM_CHANNELS][64]`	Carries the 64-bit ingress timestamp in the following format: Bits 16 to 63: 48-bit nanoseconds field Bits 0 to 15: 16-bit fractional nanoseconds field

Packet Classifier Interface Signals

Table 25. Packet Classifier Interface Signals
Signal	Direction	Width	Description
`tx_egress_timestamp_request_ in_valid[]`	In	`[NUM_CHANNELS]`	Assert this signal to request timestamping for the TX frame. This signal must be asserted in the same clock cycle `avalon_st_tx_startofpacket` is asserted.
`tx_egress_timestamp_request_ in_fingerprint[][]`	In	`[NUM_CHANNELS][TSTAMP_ FP_WIDTH]`	Use this bus to specify the fingerprint that validates the timestamp for the incoming packet.
`clock_operation_mode_mode[][]`	In	`[NUM_CHANNELS][2]`	Use this signal to specify the clock mode. 00: Ordinary clock 01: Boundary clock 10: End to end transparent clock 11: Peer to peer transparent clock
`pkt_with_crc_mode[]`	In	`[NUM_CHANNELS]`	Use this signal to specify whether or not a packet contains CRC. 0: Packet contains CRC 1: Packet does not contain CRC
`tx_ingress_timestamp_valid[]`	In	`[NUM_CHANNELS]`	Indicates whether or not the residence time can be updated. 0: Prevents update for residence time 1: Allows update for residence time based on decoded results When this signal is deasserted, the `tx_etstamp_ins_ctrl_out_residence_ti me_update` signal also gets deasserted.
`tx_ingress_timestamp_96b_ data[][]`	In	`[NUM_CHANNELS][96]`	96-bit format of ingress timestamp that holds the data so that the output can align with the start of an incoming packet.
`tx_ingress_timestamp_64b_ data[][]`	In	`[NUM_CHANNELS][64]`	64-bit format of ingress timestamp that holds the data so that the output can align with the start of an incoming packet.
`tx_ingress_timestamp_format[]`	In	`[NUM_CHANNELS]`	The format of the timestamp for calculating the residence time. 0: 96 bits 1: 64 bits This signal must be aligned to the start of an incoming packet.

ToD Interface Signals

Table 26. ToD Interface Signal
Signal	Direction	Width	Description
`master_pulse_per_second`	Out	1	Pulse per second (PPS) from the master PPS module. The signal stay asserted for 10 ms.
`start_tod_sync[]`	In	`[NUM_CHANNELS]`	Use this signal to trigger the ToD synchronization process. The time of day of the local ToD is synchronized to the time of day of the master ToD. The synchronization process continues as long as this signal remains asserted.
`pulse_per_second_10g[]`	Out	`[NUM_CHANNELS]`	PPS from the 10G PPS module of channel n. The signal stay asserted for 10 ms.
`pulse_per_second_1g[]`	Out	`[NUM_CHANNELS]`	PPS from the 1G PPS module of channel n. The signal stay asserted for 10 ms.

Configuration Registers Description

Register Access Definition

Table 27. Types of Register Access
Access	Definition
RO	Read only.
RW	Read and write.
RWC	Read, and write and clear. The user application writes 1 to the register bit(s) to invoke a defined instruction. The IP core clears the bit(s) upon executing the instruction.

Low Latency Ethernet 10G MAC

This topic lists the byte offsets the MAC registers.

Table 28. Primary MAC Address
Byte Offset	R/W	Name	HW Reset
0x2008	RW	`primary_mac_addr0`	0x0
0x200C	RW	`primary_mac_addr1`	0x0

Table 29. TX Configuration and Status Registers
Byte Offset	R/W	Name	HW Reset
0x4000	RW	`tx_packet_control`	0x0
0x4004	RO	`tx_packet_status`	0x0
0x4100	RW	`tx_pad_control`	0x1
0x4200	RW	`tx_crc_control`	0x3
0x4400	RW	`tx_preamble_control`	0x0
0x6004	RW	`tx_frame_maxlength`	0x5EE(1518)
0x4300	RO	`tx_underflow_counter0`	0x0
0x4304	RO	`tx_underflow_counter1`	0x0

Table 30. Flow Control Registers
Byte Offset	R/W	Name	HW Reset
0x4500	RW	`tx_pauseframe_control`	0x0
0x4504	RW	`tx_pauseframe_quanta`	0x0
0x4508	RW	`tx_pauseframe_enable`	0x1
0x4680	RW	`tx_pfc_priority_enable`	0x0
0x4600	RW	`pfc_pause_quanta_0`	0x0
0x4604	RW	`pfc_pause_quanta_1`	0x0
0x4608	RW	`pfc_pause_quanta_2`	0x0
0x460C	RW	`pfc_pause_quanta_3`	0x0
0x4610	RW	`pfc_pause_quanta_4`	0x0
0x4614	RW	`pfc_pause_quanta_5`	0x0
0x4618	RW	`pfc_pause_quanta_6`	0x0
0x461C	RW	`pfc_pause_quanta_7`	0x0
0x4640	RW	`pfc_holdoff_quanta_0`	0x1
0x4644	RW	`pfc_holdoff_quanta_1`	0x1
0x4648	RW	`pfc_holdoff_quanta_2`	0x1
0x464C	RW	`pfc_holdoff_quanta_3`	0x1
0x4650	RW	`pfc_holdoff_quanta_4`	0x1
0x4654	RW	`pfc_holdoff_quanta_5`	0x1
0x4658	RW	`pfc_holdoff_quanta_6`	0x1
0x465C	RW	`pfc_holdoff_quanta_7`	0x1

Table 31. RX Configuration and Status Registers
Byte Offset	R/W	Name	HW Reset
0x0000	RW	`rx_transfer_control`	0x0
0x0004	RO	`rx_transfer_status`	0x0
0x0100	RW	`rx_padcrc_control`	0x1
0x0200	RW	`rx_crccheck_control`	0x2
0x0400	RW	`rx_custom_preamble_forward`	0x0
0x0500	RW	`rx_preamble_control`	0x0
0x2000	RW	`rx_frame_control`	0x3
0x2004	RW	`rx_frame_maxlength`	0x5EE(1518)
0x2010	RW	`rx_frame_spaddr0_0`	0x0
0x2014	RW	`rx_frame_spaddr0_1`	0x0
0x2018	RW	`rx_frame_spaddr1_0`	0x0
0x201C	RW	`rx_frame_spaddr1_1`	0x0
0x2020	RW	`rx_frame_spaddr2_0`	0x0
0x2024	RW	`rx_frame_spaddr2_1`	0x0
0x2028	RW	`rx_frame_spaddr3_0`	0x0
0x202C	RW	`rx_frame_spaddr3_1`	0x0
0x2060	RW	`rx_pfc_control`	0x1
0x0300	RO	`rx_pktovrflow_error`	0x0

Table 32. TX Timestamp Registers
Byte Offset	R/W	Name	HW Reset
0x4440	RW	`tx_period_10G`	0x33333
0x4448	RW	`tx_fns_adjustment_10G`	0x0
0x444C	RW	`tx_ns_adjustment_10G`	0x0
0x4460	RW	`tx_period_mult_speed`	0x80000
0x4468	RW	`tx_fns_adjustment_mult_speed`	0x0
0x446C	RW	`tx_ns_adjustment_mult_speed`	0x0

Table 33. RX Timestamp Registers
Byte Offset	R/W	Name	HW Reset
0x0440	RW	`rx_period_10G`	0x33333
0x0448	RW	`rx_fns_adjustment_10G`	0x0
0x044C	RW	`rx_ns_adjustment_10G`	0x0
0x0460	RW	`rx_period_mult_speed`	0x80000
0x0468	RW	`rx_fns_adjustment_mult_speed`	0x0
0x046C	RW	`rx_ns_adjustment_mult_speed`	0x0

Table 34. TX and RX Statistics Registers
Byte Offset	R/W	Name	HW Reset
0x7000	RO	`tx_stats_clr`	0x0
0x3000	RO	`rx_stats_clr`	0x0
0x7008:0x700C	RO	`tx_stats_framesOK`	0x0
0x3008:0x300C	RO	`rx_stats_framesOK`	0x0
0x7010:0x7014	RO	`tx_stats_framesErr`	0x0
0x3010:0x3014	RO	`rx_stats_framesErr`	0x0
0x7018:0x701C	RO	`tx_stats_framesCRCErr`	0x0
0x3018:0x301C	RO	`rx_stats_framesCRCErr`	0x0
0x7020:0x7024	RO	`tx_stats_octetsOK`	0x0
0x3020:0x3024	RO	`rx_stats_octetsOK`	0x0
0x7028:0x702C	RO	`tx_stats_pauseMACCtrl_Frames`	0x0
0x3028:0x302C	RO	`rx_stats_pauseMACCtrl_Frames`	0x0
0x7030:0x7034	RO	`tx_stats_ifErrors`	0x0
0x3030:0x3034	RO	`rx_stats_ifErrors`	0x0
0x7038:0x703C	RO	`tx_stats_unicast_FramesOK`	0x0
0x3038:0x303C	RO	`rx_stats_unicast_FramesOK`	0x0
0x7040:0x7044	RO	`tx_stats_unicast_FramesErr`	0x0
0x3040:0x3044	RO	`rx_stats_unicast_FramesErr`	0x0
0x7048:0x704C	RO	`tx_stats_multicast_FramesOK`	0x0
0x3048:0x304C	RO	`rx_stats_multicast_FramesOK`	0x0
0x7050:0x7054	RO	`tx_stats_multicast_FramesErr`	0x0
0x3050:0x3054	RO	`rx_stats_multicast_FramesErr`	0x0
0x7058:0x705C	RO	`tx_stats_broadcast_FramesOK`	0x0
0x3058:0x305C	RO	`rx_stats_broadcast_FramesOK`	0x0
0x7060:0x7064	RO	`tx_stats_broadcast_FramesErr`	0x0
0x3060:0x3064	RO	`rx_stats_broadcast_FramesErr`	0x0
0x7068:0x706C	RO	`tx_stats_etherStatsOctets`	0x0
0x3068:0x306C	RO	`rx_stats_etherStatsOctets`	0x0
0x7070:0x7074	RO	`tx_stats_etherStatsPkts`	0x0
0x3070:0x3074	RO	`rx_stats_etherStatsPkts`	0x0
0x7078:0x707C	RO	`tx_stats_etherStatsUndersizePkts`	0x0
0x3078:0x307C	RO	`rx_stats_etherStatsUndersizePkts`	0x0
0x7080:0x7084	RO	`tx_stats_etherStatsOversizePkts`	0x0
0x3080:0x3084	RO	`rx_stats_etherStatsOversizePkts`	0x0
0x7088:0x708C	RO	`tx_stats_etherStatsPkts64Octets`	0x0
0x3088:0x308C	RO	`rx_stats_etherStatsPkts64Octets`	0x0
0x7090:0x7094	RO	`tx_stats_etherStatsPkts65to127Octets`	0x0
0x3090:0x3094	RO	`rx_stats_etherStatsPkts65to127Octets`	0x0
0x7098:0x709C	RO	`tx_stats_etherStatsPkts128to255Octets`	0x0
0x3098:0x309C	RO	`rx_stats_etherStatsPkts128to255Octets`	0x0
0x70A0:0x70A4	RO	`tx_stats_etherStatsPkts256to511Octets`	0x0
0x30A0:0x30A4	RO	`rx_stats_etherStatsPkts256to511Octets`	0x0
0x70A8:0x70AC	RO	`tx_stats_etherStatsPkts512to1023Octets`	0x0
0x30A8:0x30AC	RO	`rx_stats_etherStatsPkts512to1023Octets`	0x0
0x70B0:0x70B4	RO	`tx_stats_etherStatPkts1024to1518Octets`	0x0
0x30B0:0x30B4	RO	`rx_stats_etherStatPkts1024to1518Octets`	0x0
0x70B8:0x70BC	RO	`tx_stats_etherStatsPkts1519toXOctets`	0x0
0x30B8:0x30BC	RO	`rx_stats_etherStatsPkts1519toXOctets`	0x0
0x70C0:0x70C4	RO	`tx_stats_etherStatsFragments`	0x0
0x30C0:0x30C4	RO	`rx_stats_etherStatsFragments`	0x0
0x70C8:0x70CC	RO	`tx_stats_etherStatsJabbers`	0x0
0x30C8:0x30CC	RO	`rx_stats_etherStatsJabbers`	0x0
0x70D0:0x70D4	RO	`tx_stats_etherStatsCRCErr`	0x0
0x30D0:0x30D4	RO	`rx_stats_etherStatsCRCErr`	0x0
0x70D8:0x70DC	RO	`tx_stats_unicastMACCtrlFrames`	0x0
0x30D8:0x30DC	RO	`rx_stats_unicastMACCtrlFrames`	0x0
0x70E0:0x70E4	RO	`tx_stats_multicastMACCtrlFrames`	0x0
0x30E0:0x30E4	RO	`rx_stats_multicastMACCtrlFrames`	0x0
0x70E8:0x70EC	RO	`tx_stats_broadcastMACCtrlFrames`	0x0
0x30E8:0x30EC	RO	`rx_stats_broadcastMACCtrlFrames`	0x0
0x70F0:0x70F4	RO	`tx_stats_PFCMACCtrlFrames`	0x0
0x30F0:0x30F4	RO	`rx_stats_PFCMACCtrlFrames`	0x0

PHY

1G/2.5G/5G/10G Multi-rate PHY

This topic lists the byte offsets of the 1G/2.5G/5G/10G Multi-rate variant registers for Intel^® Stratix^® 10 devices.

Register Map

You can access the 16-bit/32-bit configuration registers via the Avalon^® -MM interface.

Table 35. Register Map Overview
Address Range	Usage	Register Width	Configuration
0x00 : 0x1F	1000BASE-X/SGMII	16	2.5G, 1G/2.5G, 10M/100M/1G/2.5G, 10M/100M/1G/2.5G/10G, 1G/2.5G/10G
0x400 : 0x41F	USXGMII	32	1G/2.5G/5G/10G (USXGMII)
0x461	Serial Loopback	32	1G/2.5G/5G/10G (USXGMII)

Register Definitions

Observe the following guidelines when accessing the registers:

Do not write to reserved or undefined registers.
When writing to the registers, perform read-modify-write operation to ensure that reserved or undefined register bits are not overwritten.

Table 36. 1G/2.5G/5G/10G Multi-rate Register Definitions
Address	Name	Description	Access	HW Reset Value
0x00	`control`	Bit [15]: `RESET`. Set this bit to 1 to trigger a soft reset. The PHY clears the bit when the reset is completed. The register values remain intact during the reset.	RWC	0
		Bit[14]: `LOOPBACK`. Set this bit to 1 to enable loopback on the serial interface.	RW	0
		Bit [12]: `AUTO_NEGOTIATION_ENABLE`. Set this bit to 1 to enable auto-negotiation. Auto-negotiation is supported only in 1GbE. Therefore, set this bit to 0 when you switch to a speed other than 1GbE.	RW	0
		Bit [9]: `RESTART_AUTO_NEGOTIATION`. Set this bit to 1 to restart auto-negotiation. The PHY clears the bit as soon as auto-negotiation is restarted.	RWC	0
		All other bits are reserved.	—	—
0x01	`status`	Bit [5]: `AUTO_NEGOTIATION_COMPLETE`. A value of "1" indicates that the auto-negotiation is completed.	RO	0
		Bit [3]: `AUTO_NEGOTIATION_ABILITY`. A value of "1" indicates that the PCS function supports auto-negotiation.	RO	1
		Bit [2]: `LINK_STATUS`. A value of "0" indicates that the link is lost. A value of "1" indicates that the link is established.	RO	0
		All other bits are reserved.	—	—
0x02:0x03	`phy_identifier`	The value set in the PHY_IDENTIFIER parameter.	RO	Value of PHY_IDENTIFIER parameter
0x04	`dev_ability`	Use this register to advertise the device abilities during auto-negotiation.	—	—
		Bits [13:12]: `RF`. Specify the remote fault. 00: No error. 01: Link failure. 10: Off-line. 11: Auto-negotiation error.	RW	00
		Bits [8:7]: `PS`. Specify the PAUSE support. 00: No PAUSE. 01: Symmetric PAUSE. 10: Asymmetric PAUSE towards the link partner. 11: Asymmetric and symmetric PAUSE towards the link device.	RW	11
		Bit [5]: `FD`. Ensure that this bit is always set to 1.	RW	1
		All other bits are reserved.	—	—
0x05 (1000BASE-X mode)	`partner_ability`	The device abilities of the link partner during auto-negotiation.	—	—
		Bit [14]: `ACK`. A value of "1" indicates that the link partner has received three consecutive matching ability values from the device.	RO	0
		Bits [13:12]: `RF`. The remote fault. 00: No error. 01: Link failure. 10: Off-line. 11: Auto-negotiation error.	RO	0
		Bits [8:7]: `PS`. The PAUSE support. 00: No PAUSE. 01: Symmetric PAUSE. 10: Asymmetric PAUSE towards the link partner. 11: Asymmetric and symmetric PAUSE towards the link device.	RO	0
		Bit [6]: `HD`. A value of "1" indicates that half-duplex is supported.	RO	0
		Bit [5]: `FD`. A value of "1" indicates that full-duplex is supported.	RO	0
		All other bits are reserved.	—	—
0x05 (SGMII mode)	`partner_ability`	The device abilities of the link partner during auto-negotiation.	—	—
		Bit [11:10]: `COPPER_SPEED` Link partner speed: 00: copper interface speed is 10 Mbps 01: copper interface speed is 100 Mbps 10: copper interface speed is 1 Gigabit 11: reserved	RO	00
		Bit [12]: `COPPER_DUPLEX_STATUS` Link partner capability: 1: copper interface is capable of full-duplex operation 0: copper interface is capable of half-duplex operation	RO	0
		Bit [14]: `ACK`. Link partner acknowledge. A value of 1 indicates that the device received three consecutive matching ability values from its link partner.	RO	0
		Bit [15]: `COPPER_LINK_STATUS` Link partner status: 1: copper interface link is up 0: copper interface link is down	RO	0
		All other bits are reserved.	—	—
0x06	`an_expansion`	The PCS capabilities and auto-negotiation status.	—	—
		Bit [1]: `PAGE_RECEIVE`. A value of "1" indicates that the partner_ability register has been updated. This bit is automatically cleared once it is read.	RO	0
		Bit [0]: `LINK_PARTNER_AUTO_NEGOTIATION_ABLE`. A value of "1" indicates that the link partner supports auto-negotiation.	RO	0
0x07	`device_next_page`	The PHY does not support the next page feature. These registers are always set to 0.	RO	0
0x08	`partner_next_page`		RO	0
0x09:0x0F	Reserved	—	—	—
0x10	`scratch`	Provides a memory location to test read and write operations.	RW	0
0x10	`scratch`	Bit [31:16]: Reserved	—	—
0x11	`rev`	The current version of the PHY IP core.	RO	Current version of the PHY
0x11	`rev`	Bit [31:16]: Reserved	—	—
0x12:0x13	`link_timer`	21-bit auto-negotiation link timer. Offset 0x12: link_timer[15:0]. Bits [8:0] are always be set to 0. Offset 0x13: link_timer[20:16] occupies the lower 5 bits. The remaining 11 bits are reserved and must always be set to 0.	RW	0
0x14	`if_mode`	Interface Mode Register	—	—
		Bit [0]: `SGMII_ENA` Determines the PCS function operating mode. Setting this bit to 1b'1 enables SGMII mode. Setting this bit to 1b'0 enables 1000BASE-X gigabit mode.	RW	0
		Bit [1]: `USE_SGMII_AN` In SGMII mode, setting this bit to 1b'1 configures the PCS with the link partner abilities advertised during auto-negotiation. If this bit is set to 1b'0, the PCS function should be configured with the `SGMII_SPEED` bits.	RW	0
		Bit [3:2]: `SGMII_SPEED` When the PCS operates in SGMII mode (`SGMII_ENA` = 1) and is not programmed for automatic configuration (`USE_SGMII_AN` = 0), the following encodings specify the speed: 2'b00: 10 Mbps 2'b01: 100 Mbps 2'b10: Gigabit 2'b11: Reserved These bits are not used when `SGMII_ENA` = 0 or `USE_SGMII_AN` = 1.	RW	0
		All other bits are reserved.	—	—
0x15:0x1F	Reserved	—	—	—
0x400	`usxgmii_control`	Control Register	—	—
		Bit [0]: `USXGMII_ENA`: 0: 10GBASE-R mode 1: USXGMII mode	RW	0
		Bit [1]: `USXGMII_AN_ENA` is used when `USXGMII_ENA` is set to 1: 0: Disables USXGMII Auto-Negotiation and manually configures the operating speed with the `USXGMII_SPEED` register. 1: Enables USXGMII Auto-Negotiation, and automatically configures operating speed with link partner ability advertised during USXGMII Auto-Negotiation.	RW	1
		Bit [4:2]: `USXGMII_SPEED` is the operating speed of the PHY in USXGMII mode and `USE_USXGMII_AN` is set to 0. 3’b000: 10M 3’b001: 100M 3’b010: 1G 3’b011: 10G 3’b100: 2.5G 3’b101: 5G 3’b110: Reserved 3’b111: Reserved	RW	0
		Bit [8:5]: Reserved	—	—
		Bit [9]: RESTART_AUTO_NEGOTIATION Write 1 to restart Auto-Negotiation sequence The bit is cleared by hardware when Auto-Negotiation is restarted.	RWC	0
		Bit [31:10]: Reserved	—	—
0x401	`usxgmii_status`	Status Register	—	—
		Bit [1:0]: Reserved	—	—
		Bit [2]: `LINK_STATUS` indicates link status for USXGMII all speeds 1: Link is established 0: Link synchronization is lost, a 0 is latched	RO	0
		Bit [4:3]: Reserved	—	—
		Bit [5]: `AUTO_NEGOTIATION_COMPLETE` A value of 1 indicates the Auto-Negotiation process is completed.	RO	0
		Bit [31:6]: Reserved	—	—
0x402:0x404	Reserved	—	—	—
0x405	`usxgmii_partner_ability`	Device abilities advertised to the link partner during Auto-Negotiation	—	—
		Bit [6:0]: Reserved	—	—
		Bit [7]: `EEE_CLOCK_STOP_CAPABILITY` Indicates whether or not energy efficient Ethernet (EEE) clock stop is supported. 0: Not supported 1: Supported	RO	0
		Bit [8]: `EEE_CAPABILITY` Indicates whether or not EEE is supported. 0: Not supported 1: Supported	RO	0
		Bit [11:9]: `SPEED` 3'b000: 10M 3'b001: 100M 3'b010: 1G 3'b011: 10G 3'b100: 2.5G 3'b101: 5G 3'b110: Reserved 3'b111: Reserved	RO	0
		Bit [12]: `DUPLEX` Indicates the duplex mode. 0: Half duplex 1: Full duplex	RO	0
		Bit [13]: Reserved	—	—
		Bit [14]: `ACKNOWLEDGE` A value of 1 indicates that the device has received three consecutive matching ability values from its link partner.	RO	0
		Bit [15]: `LINK` Indicates the link status. 0: Link down 1: Link up	RO	0
		Bit [31:16]: Reserved	—	—
0x406:0x411	Reserved	—	—	—
0x412	`usxgmii_link_timer`	Auto-Negotiation link timer. Sets the link timer value in bit [19:14] from 0 to 2 ms in approximately 0.05-ms steps. You must program the link timer to ensure that it matches the link timer value of the external NBASE-T PHY IP Core. The reset value sets the link timer to approximately 1.6 ms. Bits [13:0] are reserved and always set to 0.	[19:14]: RW [13:0]: RO	[19:14]: 1F [13:0]: 0
0x413:0x41F	Reserved	—	—	—
0x461	`phy_serial_loopback`	Configures the transceiver serial loopback in the PMA from TX to RX.	—	—
		Bit [0] 0: Disables the PHY serial loopback 1: Enables the PHY serial loopback	RW	0
		Bit [31:1]: Reserved	—	—

Transceiver Reconfiguration

Table 37. Transceiver Reconfiguration Register Map
Word Offset	Name	Bits	Description	Access	HW Reset
0x00	`logical_channel_number`	[9:0]	The logical number of the reconfiguration block.	RW	0x000
0x00	`logical_channel_number`	[31:10]	Reserved
0x01	`control`	[1:0]	Specify the new operating speed: 00: 1 Gbps 01: 2.5 Gbps 10: Reserved 11: 10 Gbps	RW	0x00
		[15:2]	Reserved	—	0x000
		[16]	Writing 1 to this bit when it is 0 starts the reconfiguration process. The bit clears when the process is completed.	RWC	0x0
		[31:17]	Reserved	—	0x000000
0x02	`status`	[0]	When set to 1, indicates the reconfiguration process is in progress.	RO	0x0
0x02	`status`	[31:1]	Reserved	—	—

TOD

Table 38. **TOD Register Map**
Byte Offset	Name	Bits	Description	Access	HW Reset
0x0000	`SecondsH`	[15:0]	The upper 16 bits of the second field.	RW	0x0
0x0000	`SecondsH`	[31:16]	Reserved.	—	—
0x0004	`SecondsL`	32	The lower 32 bits of the second field.	RW	0x0
0x0008	`NanoSec`	30	The nanosecond field.	RW	0x0
0x0010	`Period`	[15:0]	The time of day. The period in fractional nanosecond.	RW	n ¹
		[19:16]	The time of day. The period in nanosecond.	RW	n ¹
		[31:20]	Reserved.	—	—
0x0014	`AdjustPeriod`	[15:0]	The offset adjustment period. The period in fractional nanosecond.	RW	0x0
		[19:16]	The offset adjustment period. The period in nanosecond.	RW	0x0
		[31:20]	Reserved.	—	—
0x0018	`AdjustCount`	[19:0]	The number of adjusted period in clock cycles.	RW	0x0
0x0018	`AdjustCount`	[31:20]	Not used.	—	—

¹ The default value for the period depends on the frequency of the PHY speed. For example, if frequency is 125 MHz, the period is 8 ns (PERIOD_NS = 0x0008 and PERIOD_FNS = 0x0000).

Low Latency Ethernet 10G MAC Intel Stratix 10 FPGA IP Design Example User Guide Archives

If an IP core version is not listed, the user guide for the previous IP core version applies.

IP Core Version	User Guide
18.0	Low Latency Ethernet 10G MAC Intel^® Stratix^® 10 FPGA IP Design Example User Guide
17.1	Intel FPGA Low Latency Ethernet 10G MAC Design Example User Guide for Intel^® Stratix^® 10 Devices

Document Revision History for the Low Latency Ethernet 10G MAC Intel Stratix 10 FPGA IP Design Example User Guide

Document Version	Intel^® Quartus^® Prime Version	Changes
2019.04.30	19.1	Updated Table: Parameters in the Example Design Tab to update the description for Select Board. Updated Figure: Block Diagram of the Hardware Setup. Updated the hardware requirements in the Hardware and Software Requirements topics for all design examples.
2019.04.24	19.1	Changed Altera Debug Master Endpoint (ADME) to Native PHY Debug Master Endpoint (NPDME).
2018.09.24	18.0	Updated Table: Parameters in the Example Design Tab to include a note to parameters Enable NPDME support and Analog Voltage to clarify that these options are only available from Intel Quartus Prime Pro Edition version 17.0 onwards. Removed Debug Signals topic from the 10GBASE-R Ethernet Design Example for Intel Stratix 10 Devices chapter. Updated the Configuration Registers Description chapter: Added the following topics: Register Access Definition 1G/2.5G/5G/10G PHY Removed the Register Map topic. Added Timing Constraints topic to the following design example chapters: 10M/100M/1G/2.5G/10G Ethernet Design for Intel Stratix 10 Devices 1G/2.5G Ethernet Design Example with IEEE 1588v2 Feature for Intel Stratix 10 Devices 1G/2.5G/10G Ethernet Design Example with IEEE 1588v2 Feature for Intel Stratix 10 Devices
2018.08.08	18.0	Updated Table: Hardware Test Cases of the 10GBASE-R Ethernet Design Example for Intel Stratix 10 Devices chapter to update the description for `source gen_conf.tcl` command of the SFP+ loopback test case. Updated Figure: Interface Signals of the 10M/100M/1G/2.5G/5G/10G (USXGMII) Ethernet Design Example. Updated Table: Avalon-MM Interface Signals: Added the following signals: `csr_mch_write` `csr_mch_writedata` `csr_mch_read` `csr_mch_readdata` `csr_mch_address` `csr_mch_waitrequest` Removed the following signals: `csr_write` `csr_writedata` `csr_read` `csr_readdata` `csr_address` `csr_waitrequest`
2018.05.16	18.0	Updated for latest branding standards. Made editorial text updates throughout the document. Added support for Xcelium simulator. Renamed the document as Low Latency Ethernet 10G MAC Intel Stratix 10 FPGA IP Design Example User Guide. Updated the procedure steps of the Compiling and Testing the Design in Hardware topic. Updated the Test Cases topic of the 10BASE-R Ethernet Design Example for Intel Stratix 10 Devices chapter. Updated the 10G USXGMII Ethernet Design Example for Intel Stratix 10 Devices chapter: Updated all references to 10G USXGMII references to 10M/100M/1G/2.5G/5G/10G (USXGMII). Added 1588v2 feature support to the 10M/100M/1G/2.5G/5G/10G (USXGMII) Ethernet design example chapter. Added new Simulation topics: Test Case—Design Example with the IEEE 1588v2 Feature Test Case—Design Example without the IEEE 1588v2 Feature Updated Table: Command Parameters. Updated Table: Register Map to include byte offset for Native PHY Reconfiguration block. Updated the Test Procedure topic of the 10M/100M/1G/2.5G Ethernet Design Example for Intel Stratix 10 Devices chapter. Updated the Hardware and Software Requirements, Design Components, and Hardware Testing topics for all design example chapters. Updated the following Tables: Directory and File Description Parameters in the Example Design Tab Clock and Reset Interface Signals Updated the following Figures: Block Diagram—10GBASE-R Ethernet Design Example Clocking and Reset Scheme for 10GBASE-R Design Example Reset Scheme for 10M/100M/1G/2.5G/10G Ethernet Design Example Block Diagram—1G/2.5G Ethernet Design Example with IEEE 1588v2 Feature Block Diagram—1G/2.5G/10G Ethernet Design Example with IEEE 1588v2 Feature Reset Scheme for 1G/2.5G/10G Ethernet Design Example with IEEE 1588v2 Feature Clocking Scheme for 10M/100M/1G/2.5G/5G/10G (USXGMII) Ethernet Design Example Without IEEE 1588v2 Feature Interface Signals of the 10M/100M/1G/2.5G/5G/10G (USXGMII) Ethernet Design Example
2018.03.28	17.1	Updated Figure: Clocking Scheme for 10G USXGMII Ethernet Design Example.

Date	Version	Changes
November 2017	2017.12.04	Updated Figure: Example Design Tab. Added Hardware Testing, Test Cases, and Debug Signals topics for the 10BASE-R Ethernet Design Examplechapter. Updated the description in the Hardware Testing topic for the following Ethernet design examples: 10M/100M/1G/2.5G/10G 1G/2.5G with IEEE 1588v2 Feature 1G/2.5G/10G with IEEE 1588v2 Feature 10G USXGMII Added Changing to SFP+ Setting topic for 1G/2.5G/10G Ethernet design example with IEEE 1588v2 Feature chapter. Made editorial text and structure update.
November 2017	2017.11.06	Rebranded as Intel. Renamed the document as Intel FPGA Low Latency Ethernet 10G MAC Design Example User Guide for Intel Stratix 10 Devices. Updated the Quick Start Guide section: Updated the "Directory and File Description" table. Removed rtl directory from the "Directory and File Description" table. Changed heading title of the Design Parameters Description topic to Design Example Parameters. Updated the "Parameters in the Example Design Tab" table: Added Analog Voltage and Enable ADME support parameters and descriptions. Updated the descriptions for Generate File Format and Select Board parameters. Updated the Procedure subtopic under the Compiling and Simulating the Design topic. Updated the Procedure subtopic under the Compiling and Testing the Design in Hardware topic. Updated entire 1G/2.5G/10G Ethernet Design Example chapter to 10M/100M/1G/2.5G/10G Ethernet Design Example chapter. Updated the 1G/2.5G Ethernet Design Example with IEEE 1588v2 Feature for Intel Stratix 10 Devices topic. Added 10G USXGMII Ethernet Design Example chapter. Added 1G/2.5G/10G Ethernet Design Example with IEEE 1588v2 Feature chapter. Updated the description in the "Features" topic for the 10GBASE-R, 10M/100M/1G/2.5G/10G, 1G/2.5G with IEEE 1588v2 Feature, 1G/2.5G, 1G/2.5G/10G with IEEE 1588v2 Feature, and 10G USXGMII Ethernet design examples. Updated the "Design Component" table for the 10GBASE-R, 10M/100M/1G/2.5G/10G, 1G/2.5G with IEEE 1588v2 Feature, 1G/2.5G, 1G/2.5G/10G with IEEE 1588v2 Feature, and 10G USXGMII Ethernet design examples. Updated the Hardware and Software Requirements topic for the 10GBASE-R, 10M/100M/1G/2.5G/10G, 1G/2.5G with IEEE 1588v2 Feature, 1G/2.5G, 1G/2.5G/10G with IEEE 1588v2 Feature, and 10G USXGMII Ethernet design examples. Updated Figures: Example Design Tab Block Diagram of the Hardware Setup Block Diagram—10GBASE-R Design Example Clocking and Reset Scheme for 10GBASE-R Design Example Clocking Scheme for 10M/100M/1G/2.5G/10G Ethernet Design Example Reset Scheme for 10M/100M/1G/2.5G/10G Ethernet Design Example Clocking Scheme for 1G/2.5G Ethernet Design Example with IEEE 1588v2 Feature Reset Scheme for 1G/2.5G Ethernet Design Example with IEEE 1588v2 Feature Interface Signals of the 1G/2.5G Ethernet Design Example with IEEE 1588v2 Feature Clocking Scheme for 1G/2.5G/10G Ethernet Design Example with IEEE 1588v2 Feature Reset Scheme for 1G/2.5G/10G Ethernet Design Example with IEEE 1588v2 Feature Interface Signals of the 1G/2.5G/10G Ethernet Design Examples with IEEE 1588v2 Feature Clocking Scheme for 10G USXGMII Ethernet Design Example Reset Scheme for 10G USXGMII Ethernet Design Example Interface Signals of the 10G USXGMII Ethernet Design Example Updated the "RX Configuration and Status Registers" table: Updated the HW Reset value for 0x2004 from 1518 to 0x5EE(1518). Updated the Configuration Registers Description chapter: Updated the PHY topic: Removed the "PMA Registers", "PCS Registers", and "Stratix 10 GMII PCS Registers" tables. Added Register Map and Register Definitions subtopics. Merged the 10G TOD and 1G TOD topics with the Master TOD and changed heading title to ToD. Updated "ToD Register Map" table: Added bits information. Made text updates throughout the document.
May 2017	2017.05.08	Updated the Procedure topic in the Quick Start Guide chapter. Added the Compiling and Testing the Design in Hardware topic in the Quick Start Guide chapter. Updated the Software Requirements topic in the 10GBASE-R Design Example for Stratix 10 chapter. Updated the Register Map table in the 10GBASE-R Design Example for Stratix 10 chapter. Updated the Clocking and Reset Scheme for 10GBASE-R Design Example figure. Added 1G/2.5G Ethernet Design Example with IEEE 1588v2 Feature chapter. Added 1G/2.5G/10G Ethernet Design Example chapter. Added Interface Signals Description for Stratix 10 chapter. Added Configuration Registers Description for Stratix 10 chapter. Updated the description for `csr_clk` signal in the Clock and Reset Interface Signals table. Editorial fix to the Interface Signals and Configuration Registers topics for 10GBASE-R Design Example chapter. Updated document part number from UG-20016-S10 to UG-20073.
October 2016	2016.10.31	Initial release.