F-Tile Interlaken Intel® FPGA IP User Guide

ID 683622
Date 6/21/2022
Public

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

Document Table of Contents

5.3. Receive User Interface Signals

Table 24.  Receive User Interface Signals
Signal Name Width (Bits) I/O Direction Available In Description
irx_chan 8 Output Interlaken mode Receive logic channel number for the first segment chunk. The IP core supports up to 256 channels. The Interlaken IP core samples this value only when a bit of irx_sop or irx_sob is high and irx_num_valid has a non-zero value.
[Number of lanes - 1] Interlaken Look-aside mode
irx_chan1 8 Output Interlaken mode Receive logic channel number for the second segment chunk. The IP core supports up to 256 channels. This signal is used in DUAL or QUAD segment mode.

The Interlaken IP core samples this value only when a bit of irx_sob[0] is high and irx_num_valid of the second segment chunk has a non-zero value.

irx_num_valid Variable Output Interlaken mode Indicates the number of valid 64-bit words in the current packet in the current data symbol. The width of the irx_num_valid depends on the parameter number of words.

For single segment,

  • If number of words=4, then width=3 using irx_num_valid[2:0]
  • If number of words=8, then width=4 using irx_num_valid[7:4]
  • If number of words=16, then width=5 using irx_num_valid[9:5]
For multi-segment,
  • If number of words=8, then width=8 using irx_num_valid[7:4] (first segment chunk) and irx_num_valid[3:0] (second segment chunk)
  • If number of words=16, then width=10 using irx_num_valid[9:5] (first segment chunk) and irx_num_valid[4:0] (second segment chunk)
If number of words is equal to 8 and Number of segments is equal to 2:
  • irx_num_valid[7:4] indicates the number of valid words in irx_din_words[511:0]. The value can vary from 4’b0000 to 4’b1000.
  • irx_num_valid[3:0] indicates the number of valid words in irx_din_words[255:0]. The values can vary from 4’b0000 to 4’b0100.
For all non-valid cycles, IP core sets the value of irx_num_valid[7:4] and irx_num_valid[3:0]to 4’b0000.
In the end of burst cycle (irx_eob=1), if the value of irx_num_valid[7:4] is equal to or less than 4'b0100 and the Number of segments parameter is set to 2, you can set the value of irx_num_valid[3:0] from 4'b0000 to 4'b0100. If the value of irx_num_valid[3:0] is not equal to zero, you must set the value of irx_sop[0] or irx_sob[0] to 1'b1.
irx_num_valid[7:4] irx_num_valid[3:0]
1, 2, 3, 4 0, 1, 2, 3, 4
5, 6, 7, 8 0
If number of words is equal to 8 and Number of segments is equal to 4:
  • irx_num_valid[7:4] indicates the number of valid words in irx_din_words[511:0]. The value can vary from 4’b0000 to 4’b1000.
  • irx_num_valid[3:0] indicates the number of valid words in irx_din_words[383:0]. The value can vary from 4'b0000 to 4'b0110.
For all non-valid cycles, the value of irx_num_valid[7:4] and irx_num_valid[3:0] must be set to 4’b0000.
In the end of burst cycle (irx_eob=1), if the value of irx_num_valid[7:4] is equal or less than 4'b0110 and the Number of segments parameter is set to 4, you can set the value of irx_num_valid[3:0] from 4'b0000 to 4'b0110. If the value of irx_num_valid[3:0] is not equal to zero, you must set the value of irx_sop[0] or irx_sob[0] to 1'b1.
irx_num_valid[7:4] irx_num_valid[3:0]
1, 2, 0, 1, 2, 3, 4, 5, 6
3, 4 0, 1, 2, 3, 4
5, 6 0, 1, 2
7, 8 0

If number of words is equal to 16 and Number of segments is equal to 2:

irx_num_valid[7:4] irx_num_valid[3:0]
1, 2, 3, 4, 5, 6, 7, 8 0, 1, 2, 3, 4, 5, 6, 7, 8
9, 10, 11, 12, 13, 14, 15, 16 0
If number of words is equal to 16 and Number of segments is equal to 4:
irx_num_valid[7:4] irx_num_valid[3:0]
1, 2, 3,4 0 to 12
5, 6, 7, 8 0 to 8
9, 10, 11, 12 0 to 4
13, 14, 15, 16 0
irx_eob 1 Output Interlaken mode Indicates the end of the burst (EOB) for the first segment chunk. This signal toggles in Packet Mode and in Interleaved Mode.

When irx_eopbits has valid value of 4’b1xxx or 4’b0001, the irx_eob is valid too, but not vice-versa.

Whenever parameter RX_PKTMOD_ONLY is set to 0, you must provide this signal. Otherwise, when parameter RX_PKTMOD_ONLY is set to 1, the IP core ignores this signal. You are responsible to comply with the BurstMax and BurstMin setting.

irx_eob1 1 Output Interlaken mode Indicates the end of the burst (EOB) for the second segment chunk.

Only DUAL or QUAD segment interface defines this signal.

When irx_eopbits1 has valid value of 4’b1xxx or 4’b0001, the irx_eob1 is valid too, but not vice-versa.

Whenever parameter RX_PKTMOD_ONLY is set to 0, you must provide this signal. Otherwise, when parameter RX_PKTMOD_ONLY is set to 1, the IP core ignores this signal. You are responsible to comply with the BurstMax and BurstMin setting.

irx_eopbits 4 Output Interlaken mode Specifies the number of bytes at the end of packet (EOP) for the first segment chunk. Indicates whether the current data symbol contains the EOP with or without an error, and specifies the number of valid bytes in the current end-of-packet, non-error 8-byte data word, if relevant.
IP core sets the value of irx_eopbits as following:
  • 4b’0000: no end of packet, no error.
  • 4b’0001: Error and end of packet.
  • 4b’1xxx: End of packet. xxx indicates the number of valid bytes in the final valid 8-byte word of the packet, as following:
    • 000: all 8 bytes are valid.
    • 001: 1 byte is valid.
    • ...
    • 111: 7 bytes are valid.
All other values (4'b01xx, 4'b001x) are undefined. The valid bytes always start in bit positions [63:56] of the final valid data word of the packet.
[(Number of lanes * 4) -1 : 0] Interlaken Look-aside mode Specifies the number of valid bytes of the corresponding data symbol AND Indicates the end of packet transfer (EOP).
IP core sets the value of irx_eopbits as following:
  • 4b’0000: no end of packet, no error.
  • 4b’0001: Error and end of packet.
  • 4b’1xxx: End of packet. xxx indicates the number of valid bytes in the final valid 8-byte word of the packet, as following:
    • 000: all 8 bytes are valid.
    • 001: 1 byte is valid.
    • ...
    • 111: 7 bytes are valid.
All other values (4'b01xx, 4'b001x) are undefined.
irx_eopbits1 4 Output Interlaken mode Specifies number of bytes at the end of packet (EOP) for the second segment chunk. This signal is used in DUAL or QUAD segment mode.
You must set the value of irx_eopbits1 as following:
  • 4b’0000: no end of packet, no error.
  • 4b’0001: Error and end of packet.
  • 4b’1xxx: End of packet. xxx indicates the number of valid bytes in the final valid 8-byte word of the packet, as following:
    • 000: all 8 bytes are valid.
    • 001: 1 byte is valid.
    • ...
    • 111: 7 bytes are valid.
All other values (4'b01xx, 4'b001x) are undefined. The valid bytes always start in bit positions [63:56] of the final valid data word of the packet.
irx_sob 1, 2 or 4 Output Interlaken mode Indicates the start of a burst (SOB).

This signal toggles in Packet Mode and in Interleaved Mode. If the IP core is in Interleaved mode, you are responsible for providing the start of the burst signal. If the IP core is in Packet mode, the IP core ignores this signal. The IP core samples the irx_chan signal during this cycle.
  • [1]— single segment
  • [1:0]—dual segment
  • [3:0]—four segment

{segment 3, segment 2, segment 1, segment 0} defines the segment order with segment 3 starts at the most significant bit location (left aligned).

Using four segment as example, the signal has the following valid values:
  • [3]: indicates SOB for the first segment.
  • [2:0]: only one bit can be set to indicate SOB for the second segment.

For example:

If number of words= 16, Number of segments=4, rx_num_valid[9:5]= 3, rx_num_valid[4:0]= 9, then the second segment starts at word[11], sob[3:0]= 4'1100

If number of words= 16, Number of segments=4, rx_num_valid[9:5]= 9, rx_num_valid[4:0]= 4, then the second segment starts at word[3], sob[3:0]= 4'1001

irx_sop 1, 2 or 4 Output Interlaken mode Indicates the current data symbol on irx_din_words contains the start of a packet (SOP).
  • [1]— single segment
  • [1:0]—dual segment
  • [3:0]—four segment
{segment 3, segment 2, segment 1, segment 0} defines the segment order with segment 3 starts at the most significant bit location (left aligned).
Using four segment as example, the signal has the following valid values:
  • [3]: indicates SOP for the first segment.
  • [2:0]: only one bit can be set to indicate SOP for the second segment.

For example:

If number of words= 16, Number of segments=4, rx_num_valid[9:5]= 3, rx_num_valid[4:0]= 9, then the second segment starts at word[11], sop[3:0]= 4'1100

If number of words= 16, Number of segments=4, rx_num_valid[9:5]= 9, rx_num_valid[4:0]= 4, then the second segment starts at word[3], sop[0]= 4'1001

[(Number of lanes -1) : 0] Interlaken Look-aside mode Each bit indicates the start of a packet (SOP) for the data burst following corresponding control symbol.
irx_dout_words Variable Output Interlaken mode The 64-bit words of input data (one data symbol). The width of the itx_din_words depends on the parameter external_words.
  • If number of words=4, then width=256 bits.
  • If number of words=8, then width=512 bits.
  • If number of words=16, then width=1024 bits.

The first and last data word is in [511:448] and [63:0] respectively. When irx_ num_valid has the value of zero, you should ignore irx_dout_words.

[(Number of lanes * 64 -1) : 0] Interlaken Look-aside mode

The 64-bit words of input data (one data

symbol). When irx_idle or rx_sob is one, the matching irx_dout_words is invalid. The first data word is in [511:448] and last data word is in [63:0].

irx_calendar N * 16 Output Interlaken mode Multiple pages (16 bits per page) of calendar input bits. The value is the in-band flow control bits from N control words on the incoming Interlaken link. N is the value of the Number of calendar pages parameter, which can be any of 1, 2, 4, 8. or 16. This signal is synchronous with rx_usr_clk, although it is not part of the user data transfer protocol.
irx_err 1 Output Interlaken mode Indicates an errored packet. This signal is valid only when irx_eob is asserted.
irx_err1 1 Output Interlaken mode Indicates an errored packet in second segment chunk. This signal is valid only when irx_eob1 is asserted.

This signal is only valid in DUAL or QUAD mode.

irx_ch0_xon 1 Output Interlaken Look-aside mode Indicates channel 0 flow control.
irx_ch1_xon 1 Output Interlaken Look-aside mode Indicates channel 1 flow control.
irx_valid 1 Output Interlaken Look-aside mode Valid signal for entire output bus.
irx_idle [(Number of lanes -1) : 0] Output Interlaken Look-aside mode Each bit indicates unused 64-bit words in the current data symbol and it is also not part of a burst. User logic can ignore the irx_dout_words, irx_sop, irx_eopbits, and irx_chan when irx_idle is equal to one. The irx_idle is equal to one may imply the end of a previous burst.
irx_ctrl [(Number of lanes * 29 -1) : 0] Output Interlaken Look-aside mode Eight 29 bits signal indicates the application specific 0 (15 bits), specific 1 (6 bits), and specific 2 (8 bits) data for Interlaken Look-aside mode.

This signal can be valid only when irx_sop is asserted. The most significant 29 control bits data is aligned with the most significant bit of irx_sop. {specific 0, specific 1, specific 2} = {[28:14],[13:8],[7:0]}.