MACsec Intel® FPGA System Design User Guide

Download PDF
ID 767516
Date 3/31/2024
Public
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.3. Reference Design Directory Structure

After obtaining the reference design, you must first uncompress it. The uncompressed directory structure of the UVM without verification is shown below. 

<Reference Design Name>
      <HW_Release>
          env/
          sim/
          src/
          syn/
      <SW_Release>
          include/
          src/
          mcdma/
          linux_macsec/
          iptool/
          wpa_supplicant/
          utest/
          patches/
Each directory in <HW_Release> is described below:
  • env Directory — Contains the environment setting file which needs to be sourced to get the latest Quartus build and the appropriate Arc Shell.

  • sim Directory — Contains the subdirectories and files for simulation. The testcase directory includes all the testcases for simulation.

    runDir subdirectory — Where you run the simulation and the log files, dump files etc, which are created inside separate subdirectories.

    The tbTop and common subdirectories contain defines and other function call files.

  • src Directory — Contains all the RTL files for the design, the IP source files, and the qsys generated files.
  • syn Directory — Contains the required files for Synthesis. The major files are the Quartus project files, a Quartus settings file, a pin constraints file, clock constraints, and other synthesis settings files.

Each directory in <SW_Release> is described below:

  • include Directory — Contains header files associated with various MACsec IP API/driver modules.
  • src Directory — Contains MACsec APIs/driver source files. They are categorized into the functionalities below:
    • MACsec IP initialization.
    • MACsec IP get/set port attributes.
    • MACsec IP get/set port, sc and sa attributes.
    • MACsec PPBB IP component write/read CSR registers.
  • mcdma Directory — Contains the MCDMA driver as network/ethernet driver.
  • linux_macsec Directory — Contains the open source MACsec driver used between the user applications (i.e. wpa_supplicant and iptool) and drivers (i.e. mcdma driver that supports the MACsec APIs).
  • iptool Directory — Contains the open source which is ip-macsec reference implementation of application to exercise the drivers. The patch provides the new features supported in the MACsec IP HW.
  • wpa_supplicant Directory — Contains the open source which is wpa-macsec reference implementation of application to exercise the drivers. The patch provides the new features supported in the MACsec IP HW.
  • utest Directory — Contains the src code of the unit test.
  • patches Directory — Contains scripts and patches used for the HPS based design and yocto build.
Level Two Title