MACsec Intel® FPGA IP User Guide

ID 736108
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

2.2.1.3. Controlled Port Mux Interface

Table 9.  Controlled Port Mux InterfaceThe variable <n> in this table refers to the specific port number being referenced.
Signal Name Width Direction Description
encrypt_user_ss_p<n>_app_pp_axi_st_aclk 1 Input Clock for AXI-ST Interface
encrypt_user_ss_p<n>_app_pp_axi_st_areset_n 1 Input Reset for AXI-ST Interface
encrypt_user_ss_p<n>_app_pp_tvalid 1 Input

TVALID indicates that the master is driving a valid transfer.

A transfer takes place when both TVALID and TREADY are asserted.

encrypt_user_ss_p<n>_app_pp_tdata

64

128

256

512

Input

TDATA is the primary payload that is used to provide the data that is passing across the interface.

encrypt_user_ss_p<n>_app_pp_tkeep

8

16

32

64

Input

TKEEP is the byte qualifier that indicates whether the content of the associated byte of TDATA is processed as part of the data stream.

encrypt_user_ss_p<n>_app_pp_tlast 1 Input TLAST indicates the boundary of a packet.
encrypt_user_ss_p<n>_app_pp_tid 6 Input

TID is the data stream identifier that indicates different stream of data. This can be used as a Channel ID for different streams sharing the same port.

encrypt_user_ss_p<n>_pp_app_tready 1 Output TREADY indicates that the slave can accept a transfer on the current cycle.
encrypt_user_ss_p<n>_app_pp_tuser_last_segment <segment_number> 1 Output

Port<n> packet segmentation boundary indication for higher bandwidth transfer.

*last_segment indicates which 64-bit segment of the data bus the last segment is aligned to.

segment_number ranges from 0 to 7.

For the following data widths, the corresponding segment number bit applies:
  • 64—NA
  • 128—last_segment[1:0]
  • 256—last_segment[3:0]
  • 512—last_segment[7:0]
encrypt_user_ss_p<n>_app_pp_tx_tuser_client 7 Input

Ethernet Packet error status:

  • [6] - PHY error
  • [5] - CRC error
  • [4] - Length error => Payload that arrives longer than advertised length
  • [3] - Oversize error
  • [2] - Undersized (frame shorter than 64B) or oversized (larger than max_frame)
  • [1] - FCS error
  • [0] - Malformed
encrypt_user_ss_p<n>_app_pp_tuser_usermetadata 16 Input

User metadata which is tag along with incoming/outgoing packet into the MACsec IP. This metadata is not processed by MACsec IP and it is passed through the IP. One of the use cases supports PTP use case where a local timestamp or timer can be sent through this metadata on the MACsec ingress. The user can compare this local timestamp or timer at MACsec egress to determine the time taken for the request to go through the MACsec IP pipeline.

encrypt_user_ss_p<n>_pp_app_tuser_ppmetadata 415 Output

Packet Processing metadata which is tag along with incoming/outgoing packet into the MACsec IP to indicate:

[414:188] - Reserved

[187:173] - Pkt_len (packet length valid with AXI-ST first data phase signal.)

[172:3] - Reserved

[1] - tlast_buf_pkt_truncation (packet truncation error pulse valid with AXI-ST tlast signal.)

[2] - tlast_uerr_fatal (uncorrectable fatal error which causes the packet to drop in port demux. It can be present anytime during a valid with AXI ST packet.)

[0] - tlast_empty (indicates the Multi Interface Buffering Port for Stream TID is empty and no incoming packet detected when this indication is asserted. Used in MACsec framer to flush the buffer without waiting for next packet for data packing. Valid with AXI-ST tlast signal.)