MACsec Intel® FPGA System Design User Guide

Download PDF
ID 767516
Date 10/02/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents
Document Table of Contents x
1. Introduction 2. Architecture 3. Interface Overview 4. Parameters 5. Configuration Registers 6. Software Architecture 7. Generating the System Design 8. Document Revision History for MACsec System Design User Guide A. Release Notes
1. Introduction x
1.1. Terminology 1.2. Release Information 1.3. System Requirements
2. Architecture x
2.1. System Architecture 2.2. Data Path Between Ethernet MAC and MACsec 2.3. Data Path Between MACsec and MCDMA 2.4. Data Path Between MACsec and Packet Generator/Checker (Packet Client) 2.5. Data Path Illustrations 2.6. Interrupts 2.7. Packet FIFO 2.8. AXI-ST Rate Controller 2.9. Error Handling 2.10. Top Level Signals
2.2. Data Path Between Ethernet MAC and MACsec x
2.2.1. Ethernet Subsystem
2.2.1. Ethernet Subsystem x
2.2.1.1. Data Receiving from MACsec to E/F-Tile Hard IP 2.2.1.2. Data Transmitting from E/F-tile Hard IP to MACsec 2.2.1.3. Order of Ethernet Transmission 2.2.1.4. E/F-Tile Hard IP Reset Sequence
2.3. Data Path Between MACsec and MCDMA x
2.3.1. AXI-ST Multi-Segment to Single-Segment Conversion 2.3.2. MCDMA
2.4. Data Path Between MACsec and Packet Generator/Checker (Packet Client) x
2.4.1. Packet Client 2.4.2. Packet Generation and Check
2.5. Data Path Illustrations x
2.5.1. MACsec Interface Signal Names
2.6. Interrupts x
2.6.1. MCDMA MSI-X Table Configuration
3. Interface Overview x
3.1. Clocking 3.2. Resets
5. Configuration Registers x
5.1. System Register Map
5.1. System Register Map x
5.1.1. Packet Client Register Map 5.1.2. Interrupt Controller Register Map
6. Software Architecture x
6.1. MACsec Key Agreement Protocol 6.2. Driver Functional Requirements 6.3. Software Requirements 6.4. Software Overview 6.5. MACsec IP APIs Sequence 6.6. Functions 6.7. Software Tools
6.4. Software Overview x
6.4.1. McDMA Driver Kernel Module 6.4.2. MACsec IP APIs 6.4.3. Linux MACsec Driver Kernel Module 6.4.4. IP Tool 6.4.5. WPA Supplicant
6.4.2. MACsec IP APIs x
6.4.2.1. SDK
6.5. MACsec IP APIs Sequence x
6.5.1. MACsec Initialization Sequence
6.5.1. MACsec Initialization Sequence x
6.5.1.1. MACsec Reset Sequence 6.5.1.2. TX Configuration Sequence 6.5.1.3. RX Configuration Sequence 6.5.1.4. TX Rekeying Sequence 6.5.1.5. RX Rekeying Sequence 6.5.1.6. Cut Through/Store Forward Mode 6.5.1.7. User Single/Multi Port Settings 6.5.1.8. Encrypt/Decrypt Port 6.5.1.9. Port Priority 6.5.1.10. Interrupt Generation and Register
6.5.1.1. MACsec Reset Sequence x
6.5.1.1.1. GLOBAL Reset 6.5.1.1.2. PORT Reset 6.5.1.1.3. Secure Association (SA) Reset
6.6. Functions x
6.6.1. macsec_initilize 6.6.2. macsec_get_attributes 6.6.3. macsec_get_sa_attributes 6.6.4. macsec_set_attributes 6.6.5. macsec_set_sa_attributes 6.6.6. macsec_read_register 6.6.7. macsec_write_register 6.6.8. macsec_set_port_configuration 6.6.9. macsec_rate_configuration 6.6.10. macsec_single_or_multi_port 6.6.11. macsec_crypto_mode 6.6.12. macsec_port_priority 6.6.13. macsec_register_isr
6.7. Software Tools x
6.7.1. IP Tool 6.7.2. WPA_Supplicant 6.7.3. CLI Debug Tool
6.7.3. CLI Debug Tool x
6.7.3.1. Functional Requirements 6.7.3.2. Features Overview 6.7.3.3. Design with HOST 6.7.3.4. Netlink Interface 6.7.3.5. SDK 6.7.3.6. Design Overview
7. Generating the System Design x
7.1. Software Requirements 7.2. Obtaining the Reference Design 7.3. Reference Design Directory Structure 7.4. Simulation Command Arguments 7.5. Simulation Test Cases 7.6. Complete Simulation Command 7.7. Simulation Requirements 7.8. Running Non-UVM Simulation 7.9. Running UVM Simulation 7.10. Building, Installing, and Running the Software 7.11. Building the Hardware Design
7.4. Simulation Command Arguments x
7.4.1. Simulation -d Options
1. Introduction
2. Architecture
3. Interface Overview
4. Parameters
5. Configuration Registers
6. Software Architecture
7. Generating the System Design
8. Document Revision History for MACsec System Design User Guide
A. Release Notes

7.9. Running UVM Simulation

Follow these steps to run Synopsys UVM simulation. These steps are only applicable if your Synopsys simulator supports UVM simulation.

  1. Before running the steps below, you must follow steps 1-4 of the Running Verilog Simulation section.
  2. Go to $SRD_ROOTDIR/verification/testbench.
  3. Run the makefile for your corresponding design.
    • For E-tile: make -f Makefile.mk cmplib
    • For F-tile: make -f Makefile.mk cmplib MACSEC_SRD_FTILE=1
  4. Run the following simulation command for your corresponding design. The simulation is run using a Makefile. Refer to the following for some example commands and explanation of Makefile targets, options, and behaviors.

Example commands:

  • For E-tile:
    • To build and run in a single step for a 25G design: 
      make -f Makefile.mk build run
TESTNAME=macsec_srd_csr_hw_rst_test DUMP=1 25G=1
    • To build and run in a single step for a 100G design:
      make -f Makefile.mk build ru
TESTNAME=macsec_srd_csr_hw_rst_test DUMP=1
  • For F-tile:
    • To build and run in a single step for a 25G design:
      make -f Makefile.mk build run
TESTNAME=macsec_srd_csr_hw_rst_test DUMP=1 25G=1
MACSEC_SRD_FTILE=1
    • To build and run in a single step for a 100G design:
      make -f Makefile.mk build ru
TESTNAME=macsec_srd_csr_hw_rst_test DUMP=1
MACSEC_SRD_FTILE=1
Table 13.  Makefile Behavior
Makefile Tasks Options
Makefile targets for running tests
  • build: Compiles the design and the testbench.
  • run: Executes the simulation.
Makefile target options
  • TESTNAME: Mandatory option to provide the test to be run out of a list of test cases.
  • DUMP: Enables waveform dumping.
    Note: This is a mandatory option (due to simulation limitation) that must be added when calling the build target of the Makefile.
  • MSG: Sets the UVM messaging verbosity, such as UVM_LOW/UVM_HIGH/UVM_DEBUG.
  • MACSEC_SRD_FTILE: Mandatory option for F-Tile simulation.
  • 25G: Mandatory option to run 25G. Otherwise, 100G is auto-selected.

Running build and make targets in a single step with DUMP=1 enables waveform dump generation.

To avoid waveform dump generation, you can call the "make targets" separately. For example, for a 25G design: 
make -f Makefile.mk build DUMP=1 25G=1
make -f Makefile.mk run
TESTNAME=macsec_srd_csr_hw_rst_test

You can also add DUMP=1 to run target if you desire waveform dumping.

Level Two Title