Input Context Members

All verification scripts have input contexts, special structures that can be used inside of the scripts. The application fills their members. The verification script input contexts have two sets of members:

• Trace event-independent set of members

• Trace event-dependent set of members

If possible values for input context members are not explicitly specified, they should comply with the current USB specifications.

Trace Event-Independent Set of Members

This set of members is defined and can be used for any event passed to a script:

in.Level: Transaction level of the trace event. It can be one of the following constants:

_PKT: Packet level (value = 0)

_TRA: Transaction level (value = 1)

_SPL_TRA: Split Transaction level (value = 2)

_XFER: Transfer level (value = 3)

_SCSI:           SCSI Operation level (value =11)

_PHY_TRA:   PHY Transaction level (value = 15)

in.Index: Index of the event in the trace file (packet number for packets etc).

in.Time: Time of the event (type = list, having format = 2 sec 125 ns -> [2 , 125]. For more information, see VSE Time Object.

in.Channel: Indicates on which channel the event occured. It can be one of the following constants:

_USB2: USB2 traffic (value = 1)

_USB2_1: USB2 Channel 1 traffic (value = 2) (Second channel on platferms that support 2 channels)

_USB2_2: USB2 Channel 2 traffic (value = 3)

_USB2_3: USB2 Channel 3 traffic (value = 4)

_USB3_RX: USB3 Host Receive traffic (Upstream, value = 5)

_USB3_TX: USB3 Host Transmit traffic (Downstream, value = 6)

_USB4_HS_ANALYZER_LEFT: USB4 HS Analyzer Left Port orignated traffic (value = 5)

_USB4_HS_ANALYZER_RIGHT: USB4 HS Analyzer Right Port originated traffic (value = 6)

_USB4_HS_EXERCISER_DUT: USB4 HS Exerciser DUT originated traffic (value = 5)

_USB4_HS_EXERCISER_EXR: USB4 HS Exerciser exerciser originated traffic (value = 6)

_USB4_HS_ANALYZER_LEFT_OR_DUT: USB4 HS Analyzer Left Port or Exerciser DUT orignated traffic (value = 5)

_USB4_HS_ANALYZER_RIGHT_OR_EXR: USB4 HS Analyzer Right Port or Exerciser execiser originated traffic (value = 6)

_USB_PD_0: USB Power Delivery traffic (value = 9)

_USB_CC_0: USB Configuration Channel traffic (value = 10)

_USB4_SB_ANALYZER_LEFT: USB4 SB Analyzer Left Port orignated traffic (value = 15)

_USB4_SB_ANALYZER_RIGHT: USB4 SB Analyzer Right Port originated traffic (value = 16)

_USB4_SB_EXERCISER_DUT: USB4 SB Exerciser DUT originated traffic (value = 15)

_USB4_SB_EXERCISER_EXR: USB4 SB Exerciser exerciser originated traffic (value = 16)

_USB4_SB_ANALYZER_LEFT_OR_DUT: USB4 SB Analyzer Left Port or Exerciser DUT orignated traffic (value = 15)

_USB4_SB_ANALYZER_RIGHT_OR_EXR: USB4 SB Analyzer Right Port or Exerciser exerciser originated traffic (value = 16)

in.Speed: Indicates the speed for the trace event. It can be one of the following constants:

_FS: USB2 Full Speed (value = 1)

_LS: USB2 Low Speed (value = 2)

_HS: USB2 High Speed (value = 0) (NOT 3!)

_SS: USB3 Super Speed (value = 4)

_SSP: USB3.1 Super Speed Plus(value = 5)

_USB4_GEN2: USB4 HS Gen2 Speed (value = 8)

_USB4_GEN3: USB4 HS Gen3 Speed (value = 9)

_USB4_SB: USB4 Sideband Speed (value = 10)

in.Direction: Indicates the direction for the trace event. It can be one of the following constants:

_OUT: Direction is from Host to Device (value = 2)

_IN: Direction is from Device to Host (value = 3)

_BOTH: Trace event involves traffic in both directions (value = 4)

in.TraceEvent: Type of trace events. (Application predefined constants are used. See list of possible events in Verification Script Engine Events.)

in.Notification: Type of notifications. (Application predefined constants are used. Currently no notifications are defined.)

Trace Event-dependent Set of Members

This set of members is defined and can be used only for a specific event or after calling functions that provide values of variables:

USB Packet-Specific Set of Members

Members of this set are valid for all USB packet events:

in.RawPacket: Bit source of the whole packet. Note: Extract any necessary information using GetNBits(), NextNBits(), or PeekNBits() s.

in.RawPacketLength: Length of the packet (in bytes).

in.Duration: Time it took to transmit the packet on the bus (VSE Time object).

in.Errors: A bitmap of packet level errors. The table below describes the current list of possible packet errors and their bit positions in the error bitmap:

V_BUS Power parameter values

in.Power: The value of V_BUS power as measured at the time the packet was transmitted (in microwatts). Will be set to a null value if the power information is not present in the trace.

in.Voltage: The value of the voltage as measured at the time the packet was transmitted (in microvolts). Will be set to a null value if the power information is not present in the trace.

in.Current: The value of the vurrent as measured at the time the packet was transmitted (in microampers). Will be set to a null value if the power information is not present in the trace.

Skew Measurement parameter values

in.SkewL1ToL0: Represents the absolute value (in 10 picosecond units) of skew between lanes L0 and L1. A value of 0xFFFFFFFF indicates that no skew measurement corresponding to the packet is available.

in.SkewL1AfterL0: Indicates whether L1 is ahead of or behind L0. A value of 0 means that that L1 is ahead of L0, while a value of 1 means that L0 is ahead of L1. The value is undefined if no skew measurement corresponding to the packet is available (ie, in.SkewL1ToL0 == 0xFFFFFFFF).

USB Bus Condition-Specific Set of Members

in.BusCondition: Type of Bus Condition events. Possible events and values listed below:

in.BusCondDuration: Duration of the Bus Condition event in nanoseconds.

USB2 Packet-Specific Set of Members

The following input context members apply to most USB2 packets:

in.Pid: Packet Identifier value for the packet. It is the full PID value, the following constants are defined in the VS_constants.inc include file and can be used by scripts:

# USB 2.0 PID values

const PID_OUT = 0x87;

const PID_IN = 0x96;

const PID_SOF = 0xA5;

const PID_SETUP = 0xB4;

const PID_DATA0 = 0xC3;

const PID_DATA1 = 0xD2;

const PID_DATA2 = 0xE1;

const PID_MDATA = 0xF0;

const PID_ACK = 0x4B;

const PID_NAK = 0x5A;

const PID_STALL = 0x78;

const PID_NYET = 0x69;

const PID_PRE = 0x3C;

const PID_ERR = 0x3C;

const PID_SPLIT = 0x1E;

const PID_PING = 0x2D;

const PID_EXT = 0x0F;

in.SubPidPacket: If non-zero, signals that this packet is a protocol extension token as defined by the Link Power Management ECN. In this case the Pid value should be treated as the SubPid (only LPM currently defined).

in.CRC5: CRC5 value for packets (not relevant for Data packets).

USB2 Token Packet Members

in.Addr: Value of the Address (ADDR) field of the Token packet.

in.Endp: Value of the Endpoint (ENDP) field of the Token packet.

USB2 Start Of Frame Packet Members

in.FrmNum: Frame number for the current USB2 frame.

in.MicroFrmNum: Microframe number for the current microframe as determined by the Analyzer (would be zero for Full Speed frames).

USB2 Data Packet Members

in.Payload: Bit source of the packet payload.

in.PayloadLength: Length (in bytes) of the packet payload.

in.CRC16: CRC16 value for the Data packet.

USB2 Split Token Packet Members

in.HubAddr: Hub Address. The USB device address of the hub supporting the specified full-/low-speed device for this full-/low-speed transaction.

in.SC: Start/Complete bit value for the split token.

in.Port: Port field. The port number of the target hub the full-/low-speed transaction is destined for.

in.S: Speed bit value for the split token.

in.E: End bit value for the split token.

in.ET: Endpoint Type field value for the split token.

Link Power Management Extended Token Members

in.HIRD: Value of the Host Initiated Resume Duration field.

in.bLinkState: Value of the bLinkState field for the LPM extended token.

in.bRemoteWake: Value of the bRemoteWake bit for the LPM extended token.

in.Reserved: Value of the reserved field for the LPM extended token.

USB3 Packet-Specific Set of Members

in.LinkWidth:

const LINK_WIDTH_X1 = 0

const LINK_WIDTH_X2 = 1

const LINK_WIDTH_UNKNOWN = 0xFF

in.LaneNumber: Zero-based lane number of the packet. In Bonded mode, lane number of the first symbol.

TSEQ Training Sequence Ordered Set Members

in.Count: Value of TSEQ count, the number of sequential TSEQ sequences sent.

TS1/TS2 Training Sequence Ordered Set Members

in.Count: Value of TS count, the number of sequential TS1 or TS2 sequences sent.

in.LnkFunctionality: Value of the whole Link Functionality (Link Configuration) byte in the training sequence.

in.Reset: Value of the Reset bit in the Link Configuration byte.

in.Rsvd0: Value of reserved bit 1 in the Link Configuration byte.

in.Loopback: Value of the Loopback asserted/deasserted bit in the Link Configuration byte.

in.ScrDisable: Value of the Disable Scrambling bit in the Link Configuration byte.

in.LocalLoopback: Value of the Repeater Local Loopback bit in the Link Configuration byte.

in.RetimerTxCompliance: Value of the Bit-level Re-timer Tx Compliance bit in the Link Configuration byte.

in.Rsvd: Value of reserved bits 6:7 in the Link Configuration byte.

LFPS Packet Members

in.Type: Type of LFPS signaling

in.Duration: Duration of LFPS signaling in nanoseconds

in.DurationSec: Duration of LFPS signaling in second excluding the portion less than 1 second. Should be used together with in.DurationNS. For example returns 3 for duration of 3.845 sec.

in.DurationNS: Duration of LFPS signaling in nanoseconds excluding the portion greater than or equal 1 second. Should be used together with in.DurationSec. For example returns 845000000 for duration of 3.845 sec.

in.PatternType: Type of the pattern that LFPS belongs to. Possible values:

const _NO_PATTERN          = 0x00;

const _SCD1                       = 0x01;

const _SCD2                       = 0x02;

const _PHY_CAP_5             = 0x03;

const _PHY_CAP_10           = 0x04;

const _PHY_READY            = 0x05;

in.StartsPattern: This flag is set when the this packet is first in the pattern it belongs to.

Electrical Idle Packet Members

in.Duration: Duration of Electrical Idle signaling in nanoseconds

in.DurationSec: Duration of Electrical Idle signaling in second excluding the portion less than 1 second. Should be used together with in.DurationNS. For example returns 3 for duration of 3.845 sec.

in.DurationNS: Duration of Electrical Idle signaling in nanoseconds excluding the portion greater than or equal 1 second. Should be used together with in.DurationSec. For example returns 845000000 for duration of 3.845 sec.

in.PatternType: Type of the pattern that Electrical Idle belongs to. Possible values:

const _NO_PATTERN         = 0x00;

const _SCD1                       = 0x01;

const _SCD2                      = 0x02;

const _PHY_CAP_5            = 0x03;

const _PHY_CAP_10           = 0x04;

const _PHY_READY           = 0x05;

in.StartsPattern: This flag is set when the packet is first in the pattern it belongs to.

Inter-Packet Symbols Packet Members

in.NumOfSymbols: Number of symbols in the IPS sequence.

Link Command Packet Members

in.LnkCmd: Index of the Link Command type (constants are defined in VS_constants.inc)

in.LinkCmdInfo: Value of the Link Command Information field for the Link Command Word

in.CRC5: Value of CRC5 for the Link Command Word

in.LinkCmdInfo_2: Value of the Link Command Information field for the replica of the Link Command Word

in.CRC5_2: Value of CRC5 for the replica of the Link Command Word

SKIP Packet Members

in.Count: Count of symbols in the SKIP sequence

Logical Idle Packet Members

in.Count: Count of symbols in the Logical Idle sequence.

Link Management Packet Members

in.SubType: SubType value for LMP. Use constant definitions from VS_constants.inc.

Isochronous Timestamp Packet Members

in.BusICounter: Bus Interval Counter value for ITP, in 1/8 of a millisecond.

in.Delta: Time Delta value for ITP.

in.BusIAdjCtrl: Bus Interval Adjustment Control value for ITP, specifying the device in control of bus interval adjustment.

Transaction Packet Members

in.SubType: SubType value for Transaction Packet. Use constant definitions from VS_constants.inc.

in.Addr: Address of the device that receives this Transaction Packet.

in.Endp: Endpoint number on the device that receives this Transaction Packet.

in.Dir: Direction for the specified Endpoint.

in.StreamID: Value of the StreamID field.

Data Packet Members

in.Addr: Address of the device that is the recipient of this Data Packet.

in.Endp: Endpoint number on the device which is the recipient of this Data Packet.

in.Dir: Direction for the specified Endpoint.

in.StreamID: Value of the StreamID field.

in.SeqN: Value of the Sequence Number for this Data Packet.

in.DataLength: Length of the payload for this Data Packet.

in.PayloadLength: Length of the payload actually recorded for this Data Packet.

in.Payload: Bit source of the packet payload for this Data Packet.

in.CRC32: Value of CRC32 protecting the payload for this Data Packet.

Getting Values of the Fields not Present in Input Context

As mentioned earlier, not all the possible fields of USB3 packets are passed as members of Input Context. The following are examples of using GetHexPktField and GetDecodedPktField functions to get values of the fields not present in the Input Context.

If( in.TraceEvent == _USB3_LMP_PKT )
{
  # Example of using decoded packet information for LMPs.
 
  # ‘SubType’ field,
  # String value
  str = FormatEx("\tSubType(str) = ‘%s’", GetDecodedPktField("SubType"));
  ReportText( str );
 
  # Hex Value
  val = GetHexPktField ( "SubType" );
  str = FormatEx( "\tSubType(hex) = 0x%X\n", val );
  ReportText( str );
 
  # ‘Hseq’ field
  # String value
  str = FormatEx( "\tHseq(str) = ‘%s’", GetDecodedPktField ( "Hseq" ) );
  ReportText( str );
 
  # Hex Value
  val = GetHexPktField ( "Hseq" );
  str = FormatEx( "\tHseq(hex) = 0x%X\n", val );
  ReportText( str );
}
 
if( ( in.TraceEvent == _USB3_TP_PKT ) && ( in.SubType == TP_ACK ) )
{
  # Example of using decoded packet information for TPs.
 
  # ‘SeqN’ field
  # String value
  str = FormatEx( "\tSeqN(str) = ‘%s’", GetDecodedPktField ( "SeqN" ) );
  ReportText( str );
 
  # Hex Value
  val = GetHexPktField ( "SeqN" );
  str = FormatEx( "\tSeqN(hex) = 0x%X\n", val );
  ReportText( str );
 
  # ‘NumP’ field
  # String value
  str = FormatEx( "\tNumP(str) = ‘%s’", GetDecodedPktField ( "NumP" ) );
  ReportText( str );
 
  # Hex Value
  val = GetHexPktField ( "NumP" );
  str = FormatEx( "\tNumP(hex) = 0x%X\n", val );
  ReportText( str );
}
 
if( in.TraceEvent == _USB3_DP_PKT )
{
  # Example of using decoded packet information for DPs.
 
  # ‘SeqN’ field
  # String value
  str = FormatEx( "\tSeqN(str) = ‘%s’", GetDecodedPktField ( "SeqN" ) );
  ReportText( str );
  
  # Hex Value
  val = ( "SeqN" );
  str = FormatEx( "\tSeqN(hex) = 0x%X\n", val );
  ReportText( str );
 
  # ‘ENDP’ field
  # String value
  str = FormatEx( "\tENDP(str) = ‘%s’", GetDecodedPktField ( "ENDP" ) );
  ReportText( str );
 
  # Hex Value
  val = ( "ENDP" );
  str = FormatEx( "\tENDP(hex) = 0x%X\n", val );
  ReportText( str );
}

# Link Control Word
if( ( in.TraceEvent == _USB3_TP_PKT ) || 
  ( in.TraceEvent == _USB3_DP_PKT ) )
{
  ReportText( "LCW:" );
  val = GetHexPktField ( "Hseq" );
  str = FormatEx( "\tHseq = %d", val );
  ReportText( str );

  val = GetHexPktField ( "Hdepth" );
  str = FormatEx( "\tHDepth = %d", val );
  ReportText( str );

  val = GetHexPktField ( "D1" );
  str = FormatEx( "\tDelayed (D1) = %d", val );
  ReportText( str );

  val = GetHexPktField ( "D2" );
  str = FormatEx( "\tDeferred (D2) = %d\n", val );
  ReportText( str );
}

USB4 Sideband Packet-Specific Set of Members

USB4 SB Packet Link Parameters Members

in.PacketPortRole: Value of the PacketPortRole of the Token Packet’s Header. Value in.PacketPortRole: 1 means Host, 2 means Device.

USB4 SB LT Command Members

in.LSESymbol: Value of the LSESymbol field of the Token command.

in.ELT: Value of the ELT field of the Token command.

in.Rsvd: Value of the Reserved field of the Token command.

in.LSELane: Value of the LSELane field of the Token command.

in.StartLT: Value of the StartLT field of the Token command.

USB4 SB ELT Command Members

in.Rsvd: Value of the Reserved field of the Token command.

in.ELT: Value of the ELT field of the Token command.

in.ELTtype: Value of the ELTtype field of the Token command.

in.StartLT: Value of the StartLT field of the Token command.

USB4 SB AT Command Members

in.CmdNotResp: Value of the CmdNotResp field of the Token command.

in.ReturnBounce: Value of the ReturnBounce field of the Token command.

in.Recipient: Value of the Recipient field of the Token command.

in.Bounce: Value of the Bounce field of the Token command.

in.Responder: Value of the Responder field of the Token command.

in.Rsvd: Value of the Reserved field of the Token command.

in.StartAT: Value of the StartAT field of the Token command.

in.REG: Value of the Register field of the Token command.

in.LEN: Value of the Data Len field of the Token command.

in.WnR: Value of the READ/WRITE field of the Token command.

in.RegisterDataLen: Size of array in.RegisterData of the Token command

in.RegisterData: Array that contains register data of the Token command. If in.RegisterDataLen = 0, then the Token command has no register data.

USB4 SB RT Command Members

in.CmdNotResp: Value of the CmdNotResp field of the Token command.

in.RTIndex: Value of the Index field of the Token command.

in.Broadcast: Value of the Broadcast field of the Token command.

in.StartRT: Value of the StartRT field of the Token command.

in.REG: Value of the Register field of the Token command. Valid for Addressed commands only.

in.LEN: Value of the Data Len field of the Token command. Valid for Addressed commands only.

in.WnR: Value of the READ/WRITE field of the Token command. Valid for Addressed commands only.

in.RegisterDataLen: Size of array in.RegisterData of the Token command. Valid for Addressed commands only.

in.RegisterData: Array that contains register data of the Token command. If in.RegisterDataLen = 0, then the Token command has no register data. Valid for Addressed commands only.

in.SelectedGen: Value of the SelectedGen field of the Token command. Valid for Broadcast commands only.

in.Enable3Tx: Value of the Enable3Tx field. Valid for Broadcast commands only.

in.Enable3Rx: Value of the Enable3Rx field. Valid for Broadcast commands only.

in.Lane1: Value of the Lane1Enabled field of the Token command. Valid for Broadcast commands only.

in.Lane0: Value of the Lane0Enabled field of the Token command. Valid for Broadcast commands only.

in.Speed: Value of the TBT3-CompatibleSpeed field of the Token command. Valid for Broadcast commands only.

in.SSCAlwaysOn: Value of the SSCAlwaysOn field of the Token command. Valid for Broadcast commands only.

in.RS_FEC: Value of the RS_FEC field of the Token command. Valid for Broadcast commands only.

in.USB4: Value of the USB4 field of the Token command. Valid for Broadcast commands only.

USB4 SB AT/RT VendorID Register Members

in.VendorIDLow

in.VendorIDHigh

in.VendorIDRsvd1

in.VendorIDRsvd2

USB4 SB AT/RT DeviceID Register Members

in.DeviceIDLow

in.DeviceIDHigh

in.DeviceIDRsvd1

in.DeviceIDRsvd2

USB4 SB AT/RT USB4Version Register Members

in.USB4Version

in.USB4VersionRsvd1

in.USB4VersionRsvd2

in.USB4VersionRsvd3

USB4 SB AT/RT LRDTuning Register Members

in.LRDTuningRespReq

in.LRDTuningData0

in.LRDTuningData1

in.LRDTuningData2

in.LRDTuningData3

USB4 SB AT/RT LinkConfiguration Register Members

in.LinkCfgLane0Enabled

in.LinkCfgLane1Enabled

im.LinkCfgAsymmetricTx

im.LinkCfgAsymmetricRx

in.LinkCfgRsvd1

in.LinkCfgLane0ReqEnabled

in.LinkCfgLane1ReqEnabled

in.LinkCfgRsvd2

in.LinkCfgBonding

in.LinkCfgGen3

in.LinkCfgRS_FEC_GEN_2

in.LinkCfgRS_FEC_GEN_3

in.LinkCfgRevision1

in.LinkCfgLegacySpeed

in.LinkCfgGen4Support

in.LinkCfgAsymSupportTx

in.LinkCfgAsymSupportRx

in.LinkCfgAsymReqTx

in.LinkCfgAsymReqRx

in.LinkCfgRsvd3

USB4 SB AT/RT SBChannelVersion Register Members

in.SBChVersionSubVersion

in.SBChVersionMinorVersion

in.SBChVersionMajorVersionLSB

in.SBChVersionMajorVersionMSB

USB4 SB AT/RT TxFFE Register Members

The following members are common for TxFFE register of non-retimer format and retimer format:

in.Lane0Req, in.Lane0RxLocked, in.Lane0RxActive, in.Lane0ClockSwitchDone, in.Lane0NewReq

in.Lane1Req, in.Lane1RxLocked, in.Lane1RxActive, in.Lane1ClockSwitchDone, in.Lane1NewReq

in.Lane0Setting, in.Lane0ReqDone, in.Lane0TxActive

in.Lane1Setting, in.Lane1ReqDone, in.Lane1TxActive

Members of TxFFE register of non-retimer format:

in.Rsvd1, in.Rsvd2

Members of TxFFE register of retimer format:

in.Lane0FwdSwitchDone, in.RetimerRsvd1

in.Lane1FwdSwitchDone, in.RetimerRsvd2

Members of TxFFE register of additional retimer data:

in.Lane0Req, in.Byte4Rsvd1, in.Lane0RxActive, in.Byte4Rsvd2, in.Lane0NewReq

in.Lane1Req, in.Byte5Rsvd1, in.Lane1RxActive, in.Byte5Rsvd2, in.Lane1NewReq

in.Lane0Setting, in.Byte6Rsvd, in.Lane0TxActive

in.Lane1Setting, in.Byte7Rsvd, in.Lane1TxActive

USB4 SB AT/RT TxFFEGen4 Register Members

in.LinkType: Returns the link type associated with the packet.

Layout of this register depends on the LinkType.

If LinkType is Symmetric, TxFFEGen4 has the following members:

in.G4TxFFEReqRx0, in.G4TxFFERsvdRx0 in.NewRequestRx0

in.G4TxFFEReqRx1, in.G4TxFFERsvdRx1 in.NewRequestRx1

in.G4TxFFESetTx0, in.ReqDoneTx0, in.StartTxFFETx0

in.G4TxFFESetTx1, in.ReqDoneTx1, in.StartTxFFETx1

If LinkType is Aymmetric3Rx, TxFFEGen4 has the following members:

in.G4TxFFEReqRx0, in.G4TxFFERsvdRx0 in.NewRequestRx0

in.G4TxFFEReqRx1, in.G4TxFFERsvdRx1 in.NewRequestRx1

in.G4TxFFEReqRx2, in.G4TxFFERsvdRx2 in.NewRequestRx2

in.G4TxFFESetTx0, in.ReqDoneTx0, in.StartTxFFETx0

If LinkType is Asymmetric3Tx, TxFFEGen4 has the following members:

in.G4TxFFEReqRx0, in.G4TxFFERsvdRx0 in.NewRequestRx0

in.G4TxFFESetTx0, in.ReqDoneTx0, in.StartTxFFETx0

in.G4TxFFESetTx1, in.ReqDoneTx1, in.StartTxFFETx1

in.G4TxFFESetTx2, in.ReqDoneTx2, in.StartTxFFETx2

USB4 SB IPS Packet Members

in.Packet_Len: Value of the Packet Length field of the Token Packet.

in.Data<N>: Value of the N^th byte of the Token Packet, i.e., in.Data0, in.Data1, etc.

USB4 High Speed Packet-Specific Set of Members

USB4 HS Packet Link Parameters Members

in.LinkWidth: Value of the Link Width of the Token Packet’s Header. Value in.LinkWidth = 0 means x1 width, in.LinkWidth = 1 means x2, in.LinkWidth = 2 means x3.

in.IsBonded: Value of the bonding parameter of the Token Packet’s Header. Value in.IsBonded = 0 means that Lanes are unbonded, in.IsBonded = 1 means that Lanes are bonded.

in.LaneNumber: Value of the Lane Number of the Token Packet’s Header. Value in.LaneNumber = 0 means Lane 0, in.LaneNumber = 1 means Lane 1, in.LaneNumber = 2 means Lane 2.

USB4 HS TLP Packet Header Members

in.Header_HEC: Value of the HEC field of the Token Packet’s Header.

in.Header_Length: Value of the Length field of the Token Packet’s Header.

in.Header_HopID: Value of the HopID field of the Token Packet’s Header.

in.Header_SuppID: Value of the SuppID field of the Token Packet’s Header.

in.Header_PDF: Value of the PDF field of the Token Packet’s Header.

USB4 HS Control Packet Members

in.RouteStringLow_TopologyID: Value of the least significant 32 bits of the TopologyID field of the Token Control Packet.

in.RouteStringHigh_TopologyID: Value of the most significant 24 bits of the TopologyID field of the Token Control Packet.

in.RouteStringHigh_Rsvd: Value of the Reserved field of the Route String High field of the Token Control Packet.

in.RouteStringHigh_CM: Value of the CM field of the Route String High field of the Token Control Packet.

in.CRC: Value of CRC protecting the payload for the Token Control Packet.

USB4 HS Read/Write Packet Members

in.Address: Value of the Address field of the Token Packet.

in.DataSize: Value of the DataSize field of the Token Packet.

in.AdapterNum: Value of the AdapterNum field of the Token Packet.

in.CS: Value of the CS field of the Token Packet.

in.SN: Value of the SN field of the Token Packet.

in.Rsvd: Value of the Reserved field of the Token Packet.

USB4 HS Read Response/Write Request Packet Members

in.Data<N>: Value of the N^th byte of Data field of the Token Packet, i.e., in.Data0, in.Data1, etc.

The byte numbers reflect their position within Transport Layer data structures and not the byte order as transmitted (seen in Figure 4-20 of the USB4 specification). For example, in.Data0 represents DWORD 0 bits 7:0.

USB4 HS Power Management Packet Members

in.CLxState: Value of the CLx State field of the Power Management Packet Payload.

USB4 HS SLOS1/SLOS2 Packet Members

in.DataSize: Value of the DataSize field of the Token Packet.

in.Data: Array of bytes representing packet data:

(in.Data[0],

in.Data[1],

…,

in.Data[in.DataSize -1])

in.Rsvd1: Value of the Rsvd1 field of the Token Packet.

in.SN: Value of the SN field of the Token Packet.

in.Rsvd2: Value of the Rsvd2 field of the Token Packet.

USB4 HS Ordered Sets Members

in.IsScrambled: Boolean. Indicates whether or not the Ordered Set contents are scrambled.

in.DataSize: Size of packet data in bytes

in.Data: Array of bytes representing packet data:

(in.Data[0],

in.Data[1],

…,

in.Data[in. DataSize -1])

USB4 HS CL_WAKE1/CL_WAKE2 Packet Members

in.RetimerIndex: Value of the RetimerIndex field of the Token Packet.

in.DataSize: Size of the Data field in bytes of the Token Packet.

in.Data<N>: Value of the N^th byte of Data field of the Token Packet, i.e., in.Data0, in.Data1, etc.

The byte numbers reflect their position within Transport Layer data structures and not the byte order as transmitted (seen in Figure 4-20 of the USB4 specification). For example, in.Data0 represents DWORD 0 bits 7:0.

USB4 HS CL_WAKE1-2 Packet Members

in.DataSize: Size of the Data field in bytes of the Token Packet.

in.Data<N>: Value of the N^th byte of Data field of the Token Packet, i.e., in.Data0, in.Data1, etc.

The byte numbers reflect their position within Transport Layer data structures and not the byte order as transmitted (seen in Figure 4-20 of the USB4 specification). For example, in.Data0 represents DWORD 0 bits 7:0.

in.CLWake1RetimerIndexes: List of CL_WAKE1 Retimer Indexes. in.CLWake1RetimerIndexes[N] – N^th CL_WAKE1 Retimer Index (in.CLWake1RetimerIndexes[0], in.CLWake1RetimerIndexes[1], …, in.CLWake1RetimerIndexes[in.CLWake1RetimerIndexesSize-1]).

in.CLWake1RetimerIndexesSize: Number of the CL_WAKE1 Retimer Indexes.

in.CLWake2RetimerIndexes: List of CL_WAKE1 Retimer Indexes. in.CLWake2RetimerIndexes[N] – N^th CL_WAKE2 Retimer Index (in.CLWake2RetimerIndexes[0], in.CLWake2RetimerIndexes[1], …, in.CLWake2RetimerIndexes[in.CLWake2RetimerIndexesSize-1]).

in.CLWake2RetimerIndexesSize: Number of the CL_WAKE2 Retimer Indexes.

USB4 HS TS1/TS2 Packet Members

in.TSID: Value of the TSID field of the Token Packet.

in.Rsvd0: Value of the Rsvd0 field of the Token Packet.

in.LBT2: Value of the LBT2 field of the Token Packet.

in.Rsvd1: Value of the Rsvd1 field of the Token Packet.

in.Rsvd2: Value of the Rsvd2 field of the Token Packet.

in.TSLaneNumber: Value of the Lane Number field of the Token Packet.

in.LBT: Value of the LBT field of the Token Packet.

in.Rsvd3: Value of the Rsvd3 field of the Token Packet.

in.DataSize: Size of packet data in bytes

in.Data: Array of bytes representing packet data:

(in.Data[0],

in.Data[1],

…,

in.Data[in. DataSize -1]).

USB4 HS LFPS Packet Members

in.State: Value of the State field of the Token Packet.

USB4 HS Follow-Up Packet Members

in.RequestTSLo: Value of the least significant 32 bits of the RequestTS field of the Token Packet.

in.RequestTSMid: Value from the 32^nd to 63^rd bits of the RequestTS field of the Token Packet.

in.RequestTSHi: Value of the most significant 16 bits of the RequestTS field of the Token Packet.

in.ResponseTSLo: Value of the least significant 32 bits of the ResponseTS field of the Token Packet.

in.ResponseTSMid: Value from the 32^nd to 63^rd bits of the ResponseTS field of the Token Packet.

in.ResponseTSHi: Value of the most significant 16 bits of the ResponseTS field of the Token Packet.

in.TimeOffsetFromHRLo: Value of the least significant 32 bits of the TimeOffsetFromHR field of the Token Packet.

in.TimeOffsetFromHRHi: Value of the most significant 32 bits of the TimeOffsetFromHR field of the Token Packet.

in.FreqOffsetFromHR: Value of the FreqOffsetFromHR field of the Token Packet.

in.SleepCyclesN: Value of the SleepCyclesN field of the Token Packet.

in.S2U: Value of the S2U field of the Token Packet.

in.IDTimeStampLo: Value of the least significant 32 bits of the IDTimeStamp field of the Token Packet.

in.IDTimeStampMid: Value from the 32^nd to 63^rd bits of the IDTimeStamp field of the Token Packet.

in.IDTimeStampHi: Value of the most significant 16 bits of the IDTimeStamp field of the Token Packet.

in.TimeOffsetFromInterDomainHRLo: Value of the least significant 32 bits of the TimeOffsetFromInterDomainHR field of the Token Packet.

in.TimeOffsetFromInterDomainHRHi: Value of the most significant 32 bits of the TimeOffsetFromInterDomainHR field of the Token Packet.

in.FreqOffsetFromInterDomainHR: Value of the FreqOffsetFromInterDomainHR field of the Token Packet.

in.CRC32: Value of CRC32 protecting the payload for the Token Packet.

USB4 HS Inter-Domain Time Stamp Packet Members

in.Rsvd: Value of the Reserved field of the Token Packet.

in.IDTimeStampLo: Value of the least significant 32 bits of the IDTimeStamp field of the Token Packet.

in.IDTimeStampMid: Value from the 32^nd to 63^rd bits of the IDTimeStamp field of the Token Packet.

in.IDTimeStampHi: Value of the most significant 16 bits of the IDTimeStamp field of the Token Packet.

in.TimeOffsetFromInterDomainGMLo: Value of the least significant 32 bits of the TimeOffsetFromInterDomainGM field of the Token Packet.

in.TimeOffsetFromInterDomainGMHi: Value of the most significant 32 bits of the TimeOffsetFromInterDomainGM field of the Token Packet.

in.FreqOffsetFromInterDomainGM: Value of the FreqOffsetFromInterDomainGM field of the Token Packet.

in.CRC32: Value of CRC32 protecting the payload for the Token Packet.

USB4 HS Credit Grant Packet Members

in.Records_Number: Value of the RecordCount field of the Token Packet.

in.ECC<N>: Value of the ECC field of the N^th Record of the Token Packet.

in.Credits<N>: Value of the Credits field of the N^th Record of the Token Packet.

in.CreditHopID<N>: Value of the CreditHopID field of the N^th Record of the Token Packet.

in.Rsvd<N>: Value of the Reserved field of the N^th Record of the Token Packet.

in.LFlag<N>: Value of the L Flag field of the N^th Record of the Token Packet.

USB4 HS Path Credit Sync Packet Members

in.ECC: Value of the ECC field of the Token Packet.

in.PCC: Value of the PCC field of the Token Packet.

in.Rsvd: Value of the Reserved field of the Token Packet.

USB4 HS Shared Buffers Credit Sync Packet Members

in.ECC: Value of the ECC field of the Token Packet.

in.SCC: Value of the SCC field of the Token Packet.

in.Rsvd: Value of the Reserved field of the Token Packet.

USB4 HS Notification Packet Members

in.EventCode: Value of the EventCode field of the Token Packet.

in.AdapterNum: Value of the AdapterNum field of the Token Packet. The field is left for compatibility.

in.EventInfo: Value of the EventInfo field of the Token Packet.

in.Rsvd: Value of the Reserved field of the Token Packet.

in.PG: Value of the PG field of the Token Packet.

in.ConnectorNum: Value of the ConnectorNum sub-field of the EventInfo field of the Token Packet.

in.IRQ_HPD: Value of the IRQ_HPD sub-field of the EventInfo field of the Token Packet.

in.PlugUnplug: Value of the PlugUnplug sub-field of the EventInfo field of the Token Packet.

USB4 HS Notification Acknowledgement Packet Members

USB4 HS Hot Plug Event Packet Members

in.AdapterNum: Value of the AdapterNum field of the Token Packet.

in.Rsvd: Value of the Reserved field of the Token Packet.

in.UPG: Value of the UPG field of the Token Packet.

USB4 HS Tunneled Packet Members

in.TunneledData: Bit source of the packet’s tunneled payload.

in.TunneledDataLen: Length (in bytes) of the packet’s tunneled payload.

in.Data<N>: Value of the N^th byte of Data field of the Token Packet, i.e., in.Data0, in.Data1, etc.

The byte numbers reflect their position within Transport Layer data structures and not the byte order as transmitted (seen in Figure 4-20 of the USB4 specification). For example, in.Data0 represents DWORD 0 bits 7:0.

USB4 HS E2E Credit Grant Packet Members

in.ECC: Value of the ECC field of the Token Packet.

in.Credits: Value of the Credits field of the Token Packet.

in.Rsvd: Value of the Reserved field of the Token Packet.

in.CS: Value of the CS field of the Token Packet.

USB4 HS E2E Credit Sync Packet Members

in.ECC: Value of the ECC field of the Token Packet.

in.Credits: Value of the Credits field of the Token Packet.

in.Rsvd: Value of the Reserved field of the Token Packet.

in.CS: Value of the CS field of the Token Packet.

USB4 HS IPS/USS/START_RS_FEC Packet Members

in.Packet_Len: Value of the Packet Length field of the Token Packet.

in.Data<N>: Value of the N^th byte of the Token Packet, i.e., in.Data0, in.Data1, etc.

The byte numbers reflect their position within Transport Layer data structures and not the byte order as transmitted (seen in Figure 4-20 of the USB4 specification). For example, in.Data0 represents DWORD 0 bits 7:0.

USB4 HS Filtered Packet Members

in.Type: Value of the origin packet type of the Token Packet.

in.Count: Value of the OS Count of the Token Packet.

USB4 Gen 4 Training Sequences Members

in.Cursor: Value of the Cursor field of the Token Packet.

in.Indication: Value of the Indication field of the Token Packet.

in.IndicationComplement: Value of the Indication Complement field of the Token Packet.

in.Counter: Value of the Counter field of the Token Packet.

in.CounterComplement: Value of the Counter Complement field of the Token Packet.

in.PacketCount: Partial Filter Count for partially filtered packets; otherwise, 1.

USB4 Gen 4 Ordered Sets Members

USB4 Gen 4 DESKEW Packet Members

in.DeskewIndex: Value of the Index field of the Token Packet.

USB4 Gen 4 TSNOS Packet Members

in.SymbolsDelay: Value of the Symbols Delay field of the Token Packet.

USB4 Gen 4 CL0s_EXIT Packet Members

in.CL0sPhase: Value of the CL0sPhase of the Token Packet.

USB4 Gen 4 CL_OFF Packet Members

in.CLOffIndex: Value of the Index field of the Token Packet.

in.CLState: Value of the CLState field of the Token Packet.

USB4 HS Inter-Domain Packet-Specific Set of Members

USB4 HS Inter-Domain Request/Response Packet Members

in.DataSize: Value of the DataSize field of the Token Packet.

in.Rsvd1: Value of the Rsvd1 field of the Token Packet.

in.SN: Value of the SN field of the Token Packet.

in.Rsvd2: Value of the Rsvd2 field of the Token Packet.

in.IDPProtocolType: Inter-Domain protocol type of the Token Packet. Available values shown below:

USB4 HS Inter-Domain Discovery Packet Members

in.ProtocolUUID<N>: Value of the N^th DWORD of Inter-Domain Discovery Protocol UUID field of the Token Packet’s IDP Header, i.e., in.ProtocolUUID0, in.ProtocolUUID1, etc.

in.IDPPacketType: Value of the Inter-Domain Discovery packet type of the Token Packet. Available values show below:

in.IDPPayloadDataLen: Count of IDP Payload Data bytes of the Token Packet.

in.IDPPayloadData: List of IDP Payload Data bytes. in.IDPPayloadData[N] – N^th IDP Payload Data byte of the Token Packet.

(in.IDPPayloadData[0],

in.IDPPayloadData[1],

…,

in.IDPPayloadData[in.IDPPayloadDataLen-1]).

USB4 HS Inter-Domain Discovery UUID Request Packet Members

USB4 HS Inter-Domain Discovery UUID Response Packet Members

in.SourceUUID<N>: Value of the N^th DWORD of Source UUID field of the Token Packet, i.e., in.SourceUUID0, in.SourceUUID1, etc.

in.HasSourceRoute: Indicates whether the Token Packet has Source Route field.

in.SourceRoute<N>: Value of the N^th DWORD of Source Route field of the Token Packet, i.e., in.SourceRoute0, in.SourceRoute1.

USB4 HS Inter-Domain Discovery Properties Read Request Packet Members

in.SourceUUID<N>: Value of the N^th DWORD of Source UUID field of the Token Packet, i.e.,

in.SourceUUID0, in.SourceUUID1, etc.

in.DestinationUUID<N>: Value of the N^th DWORD of Destination UUID field of the Token Packet, i.e., in.DestinationUUID0, in.DestinationUUID1, etc.

in.Offset: Value of the Offset field of the Token Packet.

in.Rsvd3: Value of the Rsvd3 field of the Token Packet.

USB4 HS Inter-Domain Discovery Properties Read Response Packet Members

in.SourceUUID<N>: Value of the N^th DWORD of Source UUID field of the Token Packet, i.e., in.SourceUUID0, in.SourceUUID1, etc.

in.DestinationUUID<N>: Value of the N^th DWORD of Destination UUID field of the Token Packet, i.e., in.DestinationUUID0, in.DestinationUUID1, etc.

in.Offset: Value of the Offset field of the Token Packet.

in.PropertiesBlockSize: Value of the Properties Block Size field of the Token Packet.

in.PropertiesBlockGeneration: Value of the Properties Block Generation field of the Token Packet.

in.PropertiesBlockDataLen: Count of Properties Block Data bytes of the Token Packet.

in.PropertiesBlockData: List of Properties Block Data bytes. in.PropertiesBlockData[N] – N^th Properties Block Data byte of the Token Packet.

(in.PropertiesBlockData[0],

in.PropertiesBlockData[1],

…,

in.PropertiesBlockData[in.PropertiesBlockDataLen-1]).

USB4 HS Inter-Domain Discovery Properties Changed Notification Packet Members

in.SourceUUID<N>: Value of the N^th DWORD of Source UUID field of the Token Packet, i.e., in.SourceUUID0, in.SourceUUID1, etc.

USB4 HS Inter-Domain Discovery Error Response Packet Members

in.ErrorResponse: Value of the Error Response field of the Token Packet.

USB4 HS Inter-Domain Discovery Link State Status Request Packet Members

USB4 HS Inter-Domain Discovery Link State Status Response Packet Members

in.Status: Value of the Status field of the Token Packet.

in.SLW: Value of the SLW field of the Token Packet.

in.TLW: Value of the TLW field of the Token Packet.

in.SLS: Value of the SLS field of the Token Packet.

in.TLS: Value of the TLS field of the Token Packet.

USB4 HS Inter-Domain Discovery Link State Change Request Packet Members

in.TLW: Value of the TLW field of the Token Packet.

in.TLS: Value of the TLS field of the Token Packet.

in.Rsvd3: Value of the Rsvd3 field of the Token Packet.

USB4 HS Inter-Domain Discovery Link State Change Response Packet Members

in.Status: Value of the Status field of the Token Packet.

USB4 HS Inter-Domain USB4NET Packet Members

in.ProtocolUUID<N>: Value of the N^th DWORD of Inter-Domain USB4NET Protocol UUID field of the Token Packet’s IDP Header, i.e., in.ProtocolUUID0, in.ProtocolUUID1, etc.

in.RequestorUUID<N>: Value of the N^th DWORD of Inter-Domain USB4NET Requestor UUID field of the Token Packet’s IDP Header, i.e., in.RequestorUUID0, in.RequestorUUID1, etc.

in.ResponderUUID<N>: Value of the N^th DWORD of Inter-Domain USB4NET Responder UUID field of the Token Packet’s IDP Header, i.e., in.ResponderUUID0, in.ResponderUUID1, etc.

in.RequestID: Value of RequestID field of the Token Packet.

in.IDPPacketType: Value of the Inter-Domain USB4NET packet type of the Token Packet. Possible values shown below:

in.IDPPayloadDataLen: Count of IDP Payload Data bytes of the Token Packet.

in.IDPPayloadData: List of IDP Payload Data bytes. in.IDPPayloadData[N] – N^th IDP Payload Data byte of the Token Packet.

in.IDPPayloadData[0],

in.IDPPayloadData[1],

…,

in.IDPPayloadData[in.IDPPayloadDataLen-1]).

USB4 HS Inter-Domain USB4NET Login Request Packet Members

in.Usb4NetServiceRevision: Value of the Usb4NetServiceRevision field of the Token Packet.

in.ServiceHopId: Value of the ServiceHopId field of the Token Packet.

in.Rsvd3: Value of the 3^rd Reserved field of the Token Packet.

in.Rsvd4: Value of the 4^th Reserved field of the Token Packet.

in.Rsvd5: Value of the 5^th Reserved field of the Token Packet.

in.Rsvd6: Value of the 6^th Reserved field of the Token Packet.

USB4 HS Inter-Domain USB4NET Login Response Packet Members

in.Status: Value of the Status field of the Token Packet.

in.ResponderMACAddressLo: Value of the least significant 32 bits of the ResponderMACAddress field of the Token Packet.

in.ResponderMACAddressHi: Value of the most significant 32 bits of the ResponderMACAddress field of the Token Packet.

in.ResponderMACAddressLength: Value of the ResponderMACAddressLength field of the Token Packet.

in.Rsvd3: Value of the 3^rd Reserved field of the Token Packet.

in.Rsvd4: Value of the 4^th Reserved field of the Token Packet.

in.Rsvd5: Value of the 5^th Reserved field of the Token Packet.

in.Rsvd6: Value of the 6^th Reserved field of the Token Packet.

USB4 HS Inter-Domain USB4NET Logout Request Packet Members

USB4 HS Inter-Domain USB4NET Logout Response Packet Members

in.Status: Value of the Status field of the Token Packet.

USB4 HS Tunneled DP Main Link Packet-Specific Set of Members

in.TunDPLinkWidth: Value of the DP Link Width of the Token Tunneled Packet. Value in.TunDPLinkWidth = 1 means x1 width, in.TunDPLinkWidth = 2 means x2, in.TunDPLinkWidth = 4 means x4. This value depends on the Tunneled Protocol constant passed to SetUsb4TunProtocol() (_USB4_TUN_DP_X1, _USB4_TUN_DP_X2 or _USB4_TUN_DP_X4).

in.TunDPPacketType: Tunneled DP Main Link packet type of the Token Tunneled Packet. Possible values shown below:

TU Set Based Packets

in.TUSetsCount: Count of TU Sets in the Token Packet.

in.TUSet<N>DataLen: Count of Data Symbols of the N^th TU Set in the Token Packet, i.e., in.TUSet0DataLen, in.TUSet1DataLen, etc.

in.TUSet<N>Data: List of Data Symbols of the N^th TU Set in the Token Packet, i.e., in.TUSet0Data, in.TUSet1Data, etc. Number of Data Symbols in in.TUSet<N>Data is equal to in.TUSet<N>DataLen. Supports indexing (i.e., in.TUSet0Data[0] = value of the first Data Symbol in TU Set 0.)

SST Video Data Packet

in.TUSet<N>ECC: ECC field of TU Header of the N^th TU Set in the Token Packet.

in.TUSet<N>VideoCount: Video Count field of TU Header of the N^th TU Set in the Token Packet.

in.TUSet<N>FillCount: Fill Count field of TU Header of the N^th TU Set in the Token Packet.

in.TUSet<N>EOCIndex: EOC Index field of TU Header of the N^th TU Set in the Token Packet.

in.TUSet<N>L: L field of TU Header of the N^th TU Set in the Token Packet.

in.TUSet<N>Rsvd: Reserved field of TU Header of the N^th TU Set in the Token Packet.

in.TUSet<N>EOC: EOC field of TU Header of the N^th TU Set in the Token Packet.

SST Blank Start Packet

in.ECC: ECC field of the Blank Start Header of the Token Packet.

in.FillCount: Fill Count field of the Blank Start Header of the Token Packet.

in.Rsvd: Reserved field of the Blank Start Header of the Token Packet.

in.CP: CP field of the Blank Start Header of the Token Packet.

in.SR: SR field of the Blank Start Header of the Token Packet.

in.VB_ID_0: The 1^st VB_ID field of the payload of the Token Packet.

in.VB_ID_1: The 2^nd VB_ID field of the payload of the Token Packet.

in.VB_ID_2: The 3^rd VB_ID field of the payload of the Token Packet.

in.VB_ID_3: The 4^th VB_ID field of the payload of the Token Packet.

in.Mvid70_0: The 1^st Mvid 7:0 field of the payload of the Token Packet.

in.Mvid70_1: The 2^nd Mvid 7:0 field of the payload of the Token Packet.

in.Mvid70_2: The 3^rd Mvid 7:0 field of the payload of the Token Packet.

in.Mvid70_3: The 4^th Mvid 7:0 field of the payload of the Token Packet.

in.Maud70_0: The 1^st Maud 7:0 field of the payload of the Token Packet.

in.Maud70_1: The 2^nd Maud 7:0 field of the payload of the Token Packet.

in.Maud70_2: The 3^rd Maud 7:0 field of the payload of the Token Packet.

in.Maud70_3: The 4^th Maud 7:0 field of the payload of the Token Packet.

SST Main Stream Attribute Packet

in.ECC: ECC field of the MSA Header of the Token Packet.

in.FillCount: Fill Count field of the MSA Header Header of the Token Packet.

in.Rsvd: Reserved field of the MSA Header of the Token Packet.

in.Mvid0: The 1^st Mvid field of the payload of the Token Packet.

in.Mvid1: The 2^nd Mvid field of the payload of the Token Packet.

in.Mvid2: The 3^rd Mvid field of the payload of the Token Packet.

in.Mvid3: The 4^th Mvid field of the payload of the Token Packet.

in.Nvid: Nvid field of the payload of the Token Packet.

in.Htotal: Htotal field of the payload of the Token Packet.

in.Hstart: Hstart field of the payload of the Token Packet.

in.Hwidth: Hwidth field of the payload of the Token Packet.

in.Vtotal: Vtotal field of the payload of the Token Packet.

in.Vstart: Vstart field of the payload of the Token Packet.

in.Vheight: Vheight field of the payload of the Token Packet.

in.HSP_HSW: HSP_HSW field of the payload of the Token Packet.

in.VSP_VSW: VSP_VSW field of the payload of the Token Packet.

in.MISC0: MISC0 field of the payload of the Token Packet.

in.MISC1: MISC1 field of the payload of the Token Packet.

SST Secondary Stream Packet

in.TUSet<N>ECC: ECC field of TU Header of the N^th TU Set in the Token Packet.

in.TUSet<N>SecondaryCount: SecondaryCount field of TU Header of the N^th TU Set in the Token Packet.

in.TUSet<N>FillCount: FillCount field of TU Header of the N^th TU Set in the Token Packet.

in.TUSet<N>L: L field of TU Header of the N^th TU Set in the Token Packet.

in.TUSet<N>NSE: NSE field of TU Header of the N^th TU Set in the Token Packet.

in.TUSet<N>NSS: NSS field of TU Header of the N^th TU Set in the Token Packet.

in.TUSet<N>ND: ND field of TU Header of the N^th TU Set in the Token Packet.

DP Clock Sync Packet

in.Rsvd0: The 1^st Reserved field of the Token Packet.

in.Rsvd1: The 2^nd Reserved field of the Token Packet.

in.WindowCount: WindowCount field of the Token Packet.

in.FLCLo: Value of the least significant 32 bits of FLC field of the Token Packet.

in.FLCMid: Value from the 32^nd to 63^rd bits of FLC field of the Token Packet.

in.FLCHi: Value of the most significant 8 bits of FLC field of the Token Packet.

in.Rsvd2: The 3^rd Reserved field of the Token Packet.

in.Rsvd3: The 4^th Reserved field of the Token Packet.

in.CRC32: Value of CRC32 protecting the payload of the Token Packet.

Multi Stream Packet

in.TUSet<N>ECC: ECC field of Sub-MTP TU Header of the N^th Sub-MTP TU Set in the Token Packet.

in.TUSet<N>DataCount: DataCount field of Sub-MTP TU Header of the N^th Sub-MTP TU Set in the Token Packet.

in.TUSet<N>Type: Type field of Sub-MTP TU Header of the N^th Sub-MTP TU Set in the Token Packet.

in.TUSet<N>SlotNumber: SlotNumber field of Sub-MTP TU Header of the N^th Sub-MTP TU Set in the Token Packet.

in.TUSet<N>Parameter: Parameter field of the N^th Sub-MTP TU Set in the Token Packet.

FEC Decode Packet

in.Command0SRCount: SRCount field of the 1^st FEC Command of the Token Packet.

in.Command0FDS: FDS field of the 1^st FEC Command of the Token Packet.

in.Command0FEN: FEN field of the 1^st FEC Command of the Token Packet.

in.Rsvd0: The 1^st Reserved field of the Token Packet.

in.Command1SRCount: SRCount field of the 2^nd FEC Command of the Token Packet.

in.Command1FDS: FDS field of the 2^nd FEC Command of the Token Packet.

in.Command1FEN: FEN field of the 2^nd FEC Command of the Token Packet.

in.Rsvd1: The 2^nd Reserved field of the Token Packet.

in.Command2SRCount: SRCount field of the 3^rd FEC Command of the Token Packet.

in.Command2FDS: FDS field of the 3^rd FEC Command of the Token Packet.

in.Command2FEN: FEN field of the 3^rd FEC Command of the Token Packet.

DP Link Control ALPM Packet

in.SW: SW field of the Token Packet.

in.SRCount: SRCount field of the Token Packet.

in.Type: Type field of the Token Packet.

USB4 HS Tunneled DP AUX Packet-Specific Set of Members

in.TunDPAuxPacketType: Tunneled DP AUX packet type of the Token Tunneled Packet. Possible values shown below:

AUX Packet

in.DPAuxPacketDirection: Tunneled DP AUX packet direction of the Token AUX Packet. Possible values shown below:

in.CRC32: Value of CRC32 protecting the payload of the Token AUX Packet.

in.DataLen: Size in bytes of Data field of the Token AUX Packet.

in.Data: Data field of the Token AUX Packet.

AUX Request Packet

in.RequestCommand: Type of AUX Request Command of the Token Packet. Possible values shown below:

in.RequestAddress: Address field of the Token AUX Request Packet.

in.RequestDataLen: DataLen field of the Token AUX Request Packet.

AUX Reply Packet

in.ReplyCommand: Type of AUX Reply Command of the Token Packet. Possible values shown below:

HDP Status Packet

in.ECC: ECC field of the Token Packet.

in.Rsvd: Reserved field of the Token Packet.

in.Plug: Plug field of the Token Packet.

SET_CONFIG Packet

in.ECC: ECC field of the Token Packet.

in.LinkRate: LinkRate field of the Token Packet.

in.LinkRate = 0 represents 1.62 GHz

in.LinkRate = 1 represents 2.70 GHz

in.LinkRate = 2 represents 5.40 GHz

in.LinkRate = 3 represents 8.10 GHz

in.LaneCount: LaneCount field of the Token Packet.

in.LaneCount = 0 represents LinkDown

in.LaneCount = 1 represents 1 Lane

in.LaneCount = 2 represents 2 Lanes

in.LaneCount = 4 represents 4 Lanes

in.MessageType: MessageType field of the Token Packet.

in.MessageData: MessageData field of the Token Packet.

ACK Packet

in.ECC: ECC field of the Token Packet.

in.ACKType: ACKType field of the Token Packet.

in.Rsvd: Reserved field of the Token Packet.

USB4 HS Tunneled PCIe Packet-Specific Set of Members

in.TunPCIePacketType: Tunneled PCIe packet type of the Token Packet. Possible values shown below:

USB4 HS Tunneled PCIe Ordered Sets

in.OrderedSetType: Tunneled PCIe Ordered Set type of the Token Packet. Possible values shown below:

USB4 HS Tunneled PCIe EIOS

in.EIOS_COMSymbol: EIOS_COMmbols field of the Token Packet.

USB4 HS Tunneled PCIe TS1/TS2 Packet

in.TS_COMSymbol: TS_COMSymbol field of the Token Packet.

in.TS_LinkNumber: TS_LinkNumber field of the Token Packet.

in.TS_LaneNumber: TS_LaneNumber field of the Token Packet.

in.TS_N_FTS: TS_N_FTS field of the Token Packet.

in.TS_TrainingControl: TS_TrainingControl field of the Token Packet.

in.TS_DataRate: TS_DataRate field of the Token Packet.

in.TS_RawSymbols: List of TS1/TS2 Symbols of the Token Packet. The list contains _USB4_TUN_PCIE_TS_SYMBOLS_COUNT (10) elements (in.TS_RawSymbols[0], in.TS_RawSymbols[1], …, in.TS_RawSymbols[_USB4_TUN_PCIE_TS_SYMBOLS_COUNT-1]).

USB4 HS Tunneled PCIe TLP/DLLP Packets

Tunneled TLP/DLLP may contain multiple packets, so every field has index of inner packet, which starts with zero. The following fields are common:

in.TS_ Count: The number of inner packets.

in. IsTlp[i]: Whether an inner packet is a TLP

in.IsDllp[i]: Whether an inner packet is a DLLP.

USB4 HS Tunneled PCIe inner TLP Packets

Every field has index of inner packet, which starts with zero.

in.TLPType[i]: Tunneled PCIe TLP type of the Token Packet. Possible values shown below:

in.TLP_SeqNum[i]: TLP Sequence Number of the of the Token Packet.

in.TLPHeader_Fmt[i]: Fmt field of the TLP Header of the Token Packet.

in.TLPHeader_Type[i]: Type field of the TLP Header of the Token Packet.

in.TLPHeader_T9[i]: T9 field of the TLP Header of the Token Packet.

in.TLPHeader_TC[i]: TC field of the TLP Header of the Token Packet.

in.TLPHeader_T8[i]: T8 field of the TLP Header of the Token Packet.

in.TLPHeader_Attr[i]: Attr field of the TLP Header of the Token Packet.

in.TLPHeader_LN[i]: LN field of the TLP Header of the Token Packet.

in.TLPHeader_TH[i]: TH field of the TLP Header of the Token Packet.

in.TLPHeader_TD[i]: TD field of the TLP Header of the Token Packet.

in.TLPHeader_EP[i]: EP field of the TLP Header of the Token Packet.

in.TLPHeader_Attr2[i]: Attr2 field of the TLP Header of the Token Packet.

in.TLPHeader_AT[i]: AT field of the TLP Header of the Token Packet.

Value in.TLPHeader_AT[i] = 0 means "Untranslated",

in.TLPHeader_AT[i] = 1 means "TranslationRequest",

in.TLPHeader_AT[i] = 2 means "Translated",

in.TLPHeader_AT[i] = 3 means "Reserved".

in.TLPHeader_Length[i]: Length field of the TLP Header of the Token Packet.

in.RequesterID_BusNumber[i]: RequesterID BusNumber field of the of the Token Packet.

in.RequesterID_DeviceNumber[i]: RequesterID DeviceNumber field of the of the Token Packet.

in.RequesterID_FunctionNumber[i]: RequesterID FunctionNumber field of the of the Token Packet.

in.Tag[i]: Tag field of the of the Token Packet.

in.DataLen[i]: Length of Data field in bytes of the Token Packet. If packet has no Data field DataLen = 0.

in.Data[i]: Bit source of Data field Of the Token Packet. Note: Extract any necessary information using GetNBits(), NextNBits(), or PeekNBits().

in.HasCRC32[i]: Presence of CRC32 below in the current packet. May be absent, if PCIe TLP does not fit fully.

in.CRC32[i]: Value of CRC32 protecting the payload of the Token Packet.

in.TLP_CHK[i]: CHK field of the of the Token Packet.

in.PrefixCount[i]: Count of TLP prefixes of the Token Packet.

in.PrefixFmtList[i]: List of Fmt fields of prefixes. in.PrefixFmtList[i] [N] – Fmt field of N^th TLP prefix (in.PrefixFmtList[i][0], in.PrefixFmtList[i][1], …, in.PrefixFmtList[i][in.PrefixCount[i]-1]).

in.PrefixTypeList[i]: List of Type fields of prefixes. in.PrefixTypeList[N] – Type field of N^th TLP prefix (in.PrefixTypeList[i][0], in.PrefixTypeList[i][1], …, in.PrefixTypeList[i][in.PrefixCount[i]-1]). Possible values shown below:

in.PrefixDataList[i]: List of Data fields of prefixes. in.PrefixDataList[i][N] – Data field of N^th TLP prefix.

in.TPHPrefixSTList[i]: List of ST fields of TPH prefixes. in.TPHPrefixSTList[i][N] – ST field of N^th TPH TLP prefix.

in.TPHPrefixRsvdList[i]: List of Rsvd fields of TPH prefixes. in.TPHPrefixRsvdList[i][N] – Rsvd field of N^th TPH TLP prefix.

Example:

for (j = 0; j < in.PrefixCount[i]; ++j)
{
  cur_prefix_fmt = in.PrefixFmtList[i][j];
  cur_preifx_type_name = GetUsb4TunPCIeTLPPrefixName( in.PrefixTypeList[i][j] );
  if (in.PrefixTypeList[i][j] == _USB4_TUN_PCIE_TLP_PT_END_END_TPH)
  {
    cur_TPHPrefix_ST = in.TPHPrefixSTList[i][j];
    cur_TPHPreifx_Rsvd = in.TPHPrefixRsvdList[i][j];
  }
  else
  {
    cur_prefix_data = in.PrefixDataList[i][j];
  }
}

USB4 HS Tunneled PCIe TLP Memory and AtomicOp Request Packets

in.TLPHeader_1stDwBE[i]: 1stDwBE field of the TLP Header of the Token Packet.

in.TLPHeader_LastDwBE[i]: LastDwBE field of the TLP Header of the Token Packet.

in.TLPHeader_PH[i]: PH field of the TLP Header of the Token Packet.

in.TLPHeader_PH[i] = 0 : "Bi-directional data structure";

in.TLPHeader_PH[i] = 1 : "Requester";

in.TLPHeader_PH[i] = 2 : "Target";

in.TLPHeader_PH[i] = 3 : "Target with Priority";

in.TLPHeader_Address[i]: Address field of the TLP Header of the Token Packet. 32-bit packets only.

in.TLPHeader_AddressHi[i]: Value of the most significant DWORD of Address field of the TLP Header of the Token Packet. 64-bit packets only.

in.TLPHeader_AddressLo[i]: Value of the less significant DWORD of Address field of the TLP Header of the Token Packet. 64-bit packets only.

USB4 HS Tunneled PCIe TLP I/O Read Write Request Packets

in.TLPHeader_1stDwBE[i]: 1stDwBE field of the TLP Header of the Token Packet.

in.TLPHeader_LastDwBE[i]: LastDwBE field of the TLP Header of the Token Packet.

in.TLPHeader_Address[i]: Address field of the TLP Header of the Token Packet.

in.TLPHeader_Rsvd[i]: Reserved field of the TLP Header of the Token Packet.

USB4 HS Tunneled PCIe TLP Configuration Packets

in.TLPHeader_1stDwBE[i]: 1stDwBE field of the TLP Header of the Token Packet.

in.TLPHeader_LastDwBE[i]: LastDwBE field of the TLP Header of the Token Packet.

in.DeviceID_BusNumber[i]: DeviceID BusNumber field of the of the Token Packet.

in.DeviceID_DeviceNumber[i]: DeviceID DeviceNumber field of the of the Token Packet.

in.DeviceID_FunctionNumber[i]: DeviceID FunctionNumber field of the of the Token Packet.

in.TLPHeader_Rsvd[i]: Reserved field of the TLP Header of the Token Packet.

in.TLPHeader_Register[i]: Register field of the TLP Header of the Token Packet.

USB4 HS Tunneled PCIe TLP Completion Packets

in.CompleterID_BusNumber[i]: CompleterID BusNumber field of the of the Token Packet.

in.CompleterID_DeviceNumber[i]: CompleterID DeviceNumber field of the of the Token Packet.

in.CompleterID_FunctionNumber[i]: CompleterID FunctionNumber field of the of the Token Packet.

in.TLPHeader_ComplStatus[i]: ComplStatus field of the TLP Header of the Token Packet.

in.TLPHeader_ComplStatus[i] = 0 : "Successful Completion";

in.TLPHeader_ComplStatus[i] = 1 : "Unsupported Request";

in.TLPHeader_ComplStatus[i] = 2 : "Configuration Request Retry Status";

in.TLPHeader_ComplStatus[i] = 4 : "Completer Abort";

in.TLPHeader_BCM[i]: BCM field of the TLP Header of the Token Packet.

in.TLPHeader_ByteCount[i]: ByteCount field of the TLP Header of the Token Packet.

in.TLPHeader_LowerAddress[i]: LowerAddress field of the TLP Header of the Token Packet.

in.TLPHeader_Rsvd[i]: Reserved field of the TLP Header of the Token Packet.

USB4 HS Tunneled PCIe TLP Message Packets

in.TLPHeader_MessageCode[i]: Message Code of the Token TLP Message Packet. Possible values shown below:

USB4 HS Tunneled PCIe TLP Message Reserved Packets

in.TLPHeader_Rsvd0[i]: 1^st Reserved field of the TLP Header of the Token TLP Message Packet.

in.TLPHeader_Rsvd1[i]: 2^nd Reserved field of the TLP Header of the Token TLP Message Packet.

USB4 HS Tunneled PCIe TLP Message LTR Packets

in.TLPHeader_Rsvd[i]: Reserved field of the TLP Header of the Token TLP Message Packet.

in.TLPHeader_NoSnoopLatency[i]: NoSnoopLatency field of the TLP Header of the Token TLP Message Packet.

in.TLPHeader_SnoopLatency[i]: SnoopLatency field of the TLP Header of the Token TLP Message Packet.

USB4 HS Tunneled PCIe TLP Message OBFF Packets

in.TLPHeader_Rsvd0[i]: First Reserved field of the TLP Header of the Token TLP Message Packet.

in.TLPHeader_OBFFCode[i]: OBFF Code field of the TLP Header of the Token TLP Message Packet.

in.TLPHeader_OBFFCode = 0 : "Idle";

in.TLPHeader_OBFFCode = 1 : "OBFF";

in.TLPHeader_OBFFCode = 0b1111 : "CPU Active";

in.TLPHeader_Rsvd1[i]: Second Reserved field of the TLP Header of the Token TLP Message Packet.

USB4 HS Tunneled PCIe TLP PTM Response_ResponseD Packets

in.TLPHeader_PTMMasterTimeHi[i]: Value of the most significant DWORD of PTMMasterTime field of the TLP Header of the Token Packet.

in.TLPHeader_PTMMasterTimeLo[i]: Value of the less significant DWORD of PTMMasterTime field of the TLP Header of the Token Packet.

in.TLPHeader_PropagationDelay[i]: PropagationDelay field of the TLP Header of the Token TLP Message Packet.

USB4 HS Tunneled PCIe TLP Vendor Defined Message Packets

in.TLPHeader_VDMSubtype[i]: Subtype of the Token TLP Vendor Defined Message Packet. Possible values shown below:

in.TLPHeader_VendorID[i]: VendorID field of the TLP Header of the Token TLP Vendor Defined Message Packet.

in.TLPHeader_Rsvd0[i]: 1^st Reserved field of the TLP Header of the Token TLP Vendor Defined Message Packet. in.TLPHeader_Rsvd0[i] value of this packet repeats in.Tag[i] value of TLP Header.

USB4 HS Tunneled PCIe TLP Vendor Defined LN Message Packets

in.DeviceID_BusNumber[i]: DeviceID BusNumber field of the of the Token Packet.

in.DeviceID_DeviceNumber[i]: DeviceID DeviceNumber field of the of the Token Packet.

in.DeviceID_FunctionNumber[i]: DeviceID FunctionNumber field of the of the Token Packet.

in.TLPHeader_VendorRsvd[i]: VendorRsvd field of the of the Token Packet.

in.TLPHeader_Rsvd1[i]: 2^nd Reserved field of the TLP Header of the Token Packet.

in.TLPHeader_CachlineAddressHi[i]: Value of the most significant DWORD of CachlineAddress field of the TLP Header of the Token Packet.

in.TLPHeader_CachlineAddressLo[i]: Value of the less significant DWORD of CachlineAddress field of the TLP Header of the Token Packet.

in.TLPHeader_PropagationDelay[i]: PropagationDelay field of the TLP Header of the Token TLP Message Packet.

in.TLPHeader_Rsvd2[i]: 3^rd Reserved field of the TLP Header of the Token Packet.

in.TLPHeader_NR[i]: NR field of the TLP Header of the Token Packet.

USB4 HS Tunneled PCIe TLP Vendor Defined HierarchyID Message Packets

in.TLPHeader_HierarchyID[i]: HierarchyID field of the of the Token Packet.

in.TLPHeader_GUIDAuthorityID[i]: GUIDAuthorityID field of the of the Token Packet.

in.TLPHeader_GUIDAuthorityID = 0 : None;

in.TLPHeader_GUIDAuthorityID = 1 : Timestamp;

in.TLPHeader_GUIDAuthorityID = 2 : IEEE_EUI_48;

in.TLPHeader_GUIDAuthorityID = 3 : IEEE_EUI_64;

in.TLPHeader_GUIDAuthorityID = 4 : RFC_4122_UUID;

in.TLPHeader_GUIDAuthorityID = 5 : IPv6Address;

0x06 <= in.TLPHeader_GUIDAuthorityID <= 0x7F : Reserved;

0x80 <= in.TLPHeader_GUIDAuthorityID : PCI_SIG_Vendor_Specific;

in.TLPHeader_SystemGUIDLen[i]: Count of SystemGUID symbols of the Token Packet.

in.TLPHeader_SystemGUIDList: List of SystemGUID symbols. in.TLPHeader_SystemGUIDList[i][N] –N^th SystemGUID symbol of the Token Packet.

(in.TLPHeader_SystemGUIDList[i][0],

in.TLPHeader_SystemGUIDList[i][1],

…,

in.TLPHeader_SystemGUIDList[i][in.TLPHeader_SystemGUIDLen[i]-1]).

USB4 HS Tunneled PCIe TLP Vendor Defined DRS Message Packets

in.TLPHeader_VendorRsvd[i]: VendorRsvd field of the of the Token Packet.

in.TLPHeader_Rsvd1[i]: Reserved field of the of the Token Packet.

USB4 HS Tunneled PCIe TLP Vendor Defined FRS Message Packets

in.TLPHeader_VendorRsvd[i]: VendorRsvd field of the of the Token Packet.

in.TLPHeader_Rsvd1[i]: Reserved field of the of the Token Packet.

in.TLPHeader_FRSReason[i]: FRSReason field of the of the Token Packet.

in.TLPHeader_FRSReason[i] = 0b0001 : DRSMessageReceived;

in.TLPHeader_FRSReason[i] = 0b0010 : D3HotD0TransitionCompleted;

in.TLPHeader_FRSReason[i] = 0b0011 : FLR Completed;

in.TLPHeader_FRSReason[i] = 0b1000 : VF Enabled;

in.TLPHeader_FRSReason[i] = 0b1001 : VF Disabled;

USB4 HS Tunneled PCIe inner DLLP Packets

Every field has the index of the inner packet, which starts with zero.

in.DLLPType[i]: Tunneled PCIe DLLP type of the Token Packet. Possible values shown below:

in.CRC16[i]: Value of CRC16 protecting the payload of the Token Packet.

USB4 HS Tunneled PCIe DLLP Ack/Nak Packets

in.AckNak_SeqNum[i]: AckNak_SeqNum field of the of the Token Packet.

in.Rsvd[i]: Reserved field of the of the Token Packet.

USB4 HS Tunneled PCIe DLLP Data Link Feature Packets

in.FeatureAck[i]: FeatureAck field of the of the Token Packet.

in.FeatureSupport[i]: FeatureSupport field of the of the Token Packet.

USB4 HS Tunneled PCIe DLLP Power Management Packets

in.Rsvd[i]: Reserved field of the of the Token Packet.

USB4 HS Tunneled PCIe DLLP Vendor-Specific Packets

in.DLLPData[i]: DLLPData field of the of the Token Packet.

USB4 HS Tunneled PCIe DLLP Init/Update Packets

in.Rsvd[i]: Reserved field of the of the Token Packet.

in.HdrScale[i]: HdrScale field of the of the Token Packet.

in.HdrFC[i]: HdrFC field of the of the Token Packet.

in.DataScale[i]: DataScale field of the of the Token Packet.

in.DataFC[i]: DataFC field of the of the Token Packet.

USB4 HS Tunneled USB3 Packet-Specific Set of Members

in.TunUSB3GenType: Tunneled USB3 Gen type of the Token Packet. Possible values shown below:

in.IsGenX: Boolean value that indicates whether or not Gen type of the Tunneled USB3 Packet is Gen X.

in.IsGenT: Boolean value that indicates whether or not Gen type of the Tunneled USB3 Packet is Gen T.

in.TunUSB3PacketType: Tunneled USB3 packet type of the Token Packet. Possible values shown below:

USB4 HS Tunneled USB3 LFPS Packet Members

in.Type: Tunneled USB3 LFPS type of the Token Packet. Possible values shown below:

in.LBPM: LBPM field of the Token Packet.

in.RxTermEnable: RxTermEnable field of the Token Packet.

in.SCD1: SCD1 field of the Token Packet.

in.SCD2: SCD2 field of the Token Packet.

in.U2Exit: U2Exit field of the Token Packet.

in.U3Wakeup: SCD2 field of the Token Packet.

in.WarmReset: WarmReset field of the Token Packet.

in.LBPMEnable: LBPMEnable field of the Token Packet.

in.CRC8: Value of CRC8 protecting the payload of the Token Packet.

USB4 HS Tunneled USB3 OOBM Packet Members

in.LinkError: Link Error field of the Token Packet.

in.PortDisabled: Port Disabled field of the Token Packet.

in.PortResetDone: Port Reset Done field of the Token Packet.

in.U3Resume: U3 Resume field of the Token Packet.

in.PortReset: Port Reset field of the Token Packet.

in.LinkReady: Link Ready field of the Token Packet.

in.CRC: Value of CRC protecting the payload of the Token Packet.

USB4 HS Tunneled USB3 TS1/TS2 Ordered Set Members

in.LnkFunctionality: Value of the whole Link Functionality (Link Configuration) byte in the training sequence

in.Reset: Value of the Reset bit in the Link Configuration byte.

in.Loopback: Value of the Loopback asserted/deasserted bit in the Link Configuration byte.

in.ScrDisable: Value of the Disable Scrambling bit in the Link Configuration byte.

in.LocalLoopback: Value of the Repeater Local Loopback bit in the Link Configuration byte.

in.RetimerTxCompliance: Value of the Bit-level Re-timer Tx Compliance bit in the Link Configuration byte.

in.Rsvd0: Rsvd0 field of the of the Token Packet.

in.Rsvd: Rsvd field of the of the Token Packet.

in.CRC8: Value of CRC8 protecting the payload of the Token Packet.

USB4 HS Tunneled USB3 SDS Ordered Set Members

in.CRC8: Value of CRC8 protecting the payload of the Token Packet.

USB4 HS Tunneled USB3 Link Command Packet Members

in.LnkCmd: Index of the Link Command type (constants are defined in VS_constants.inc).

in.LinkCmdInfo: Value of the Link Command Information field for the Link Command Word.

in.CRC5: Value of CRC5 for the Link Command Word.

in.LinkCmdInfo_2: Value of the Link Command Information field for the replica of the Link Command Word.

in.CRC5_2: Value of CRC5 for the replica of the Link Command Word.

in.LnkCmdCount: Count of Link Commands that are encapsulated in the Packet.

in.LnkCmd_i: Index of the Link Command type (constants are defined in VS_constants.inc). Index i in the prefix may take value from 0 to in.LnkCmdCount – 1.

in.LinkCmdInfo_i: Value of the Link Command Information field for the Link Command Word. Index i in the prefix may take value from 0 to in.LnkCmdCount – 1.

in.LinkCmdInfoIndex_i: The value of n in LGOOD_n, n in LKAI_n, x in LCRD1_x or y in LCRD2_y.

USB4 HS Tunneled USB3 Link Management Packet Members

in.SubType: SubType value for LMP. Use constant definitions from VS_constants.inc.

USB4 HS Tunneled USB3 Transaction Packet Members

in.SubType: SubType value for Transaction Packet. Use constant definitions from VS_constants.inc.

in.Addr: Address of the device that receives this Transaction Packet

in.Endp: Endpoint number on the device that receives this Transaction Packet

in.Dir: Direction for the specified Endpoint

in.StreamID: Value of the StreamID field

USB4 HS Tunneled USB3 Deferred Data Packet Header Members

in.Addr: Address of the device which is the recipient of this Data Packet

in.Endp: Endpoint number on the device which is the recipient of this Data Packet

in.Dir: Direction for the specified Endpoint

in.StreamID: Value of the StreamID field

in.SeqN: Value of the Sequence Number for this Data Packett

in.DataLength: Length of the payload for this Data Packet

USB4 HS Tunneled USB3 Isochronous Timestamp Packet Members

in.BusICounter: Bus Interval Counter value for ITP, in 1/8 of a millisecond

in.Delta: Time Delta value for ITP

in.BusIAdjCtrl: Bus Interval Adjustment Control value for ITP, specifying the device in control of bus interval adjustment

USB4 HS Tunneled USB3 Data Packet Segment Members

in.DataLen: Length of Data field in bytes of the Token Packet.

in.Data: Bit source of Data field Of the Token Packet.

USB4 HS Tunneled USB3 Nullified Data Packet Members

in.DataLen: Length of Data field in bytes of the Token Packet.

in.Data: Bit source of Data field Of the Token Packet. Note: Extract any necessary information using GetNBits(), NextNBits(), or PeekNBits().

USB4 LLSM State-Specific Set of Members

in.LaneNumber: Value of the Lane Number of the Trace Event. Value in.LaneNumber = 0 means Lane 0, in.LaneNumber = 1 means Lane 1.

in.LLSMState: LLSM State into which the transition occured. Possible values shown below:

Transaction-Specific Set of Members

in.TraToken: Token PID for the transaction. Possible values:

const PID_OUT = 0x87;

const PID_IN = 0x96;

const PID_SETUP = 0xB4;

const PID_SPLIT = 0x1E;

const PID_PING = 0x2D;

const PID_EXT = 0x0F;

in.Addr: Device Address value for this Usb transaction.

in.Endp: Device Endpoint Number value for this Usb transaction.

in.TraCompletionFlag: Handshake PID for the transaction (if any). Possible values:

const PID_ACK = 0x4B;

const PID_NAK = 0x5A;

const PID_STALL = 0x78;

const PID_NYET = 0x69;

const PID_ERR = 0x3C;

0xFFFFFFFF – in case no handshake was sent for the transaction.

in.Complete: Flag, signaling if the transaction was complete.

in.XferType: Type of the USB Transfer this transaction belongs to. See Transfer Types for possible values.

in.CtrlDirection: For a Setup transaction, represents the direction of the corresponding Control Transfer.

0 = Host-to-device

1 = Device-to-host

in.FirstInXfer: This flag is set when the transaction is first in the transfer it belongs to.

in.LastInXfer: This flag is set when the transaction is last in the transfer it belongs to.

in.Errors: Error code for the transaction, if any error happened.

If the transaction is a Setup transaction, the following input context members provide values of the corresponding fields of the USB Device Request:

in.ReqType

in.ReqRecipient

in.bRequest

in.wIndex

in.wValue

in.wLength

in.Split: Signals that the transaction is a start-split or complete-split.

in.HubAddr: Value of the Hub Address field, the USB device address of the hub supporting the specified full-/low-speed device for this full-/low-speed transaction.

in.SC: Value of the Start/Complete bit for the split token.

in.Port: Value of the Port field – the port number of the target hub for which this full-/low-speed transaction is destined.

in.S: Value of the Speed bit for the split token.

in.E: Value of the End bit for the split token.

in.ET: Value of the Endpoint Type field for the split token.

in.OTGHostId: For USB On-The-Go transactions, indicates if the A-device is acting as the host (value of 0) or the B-device is acting as the host (value of 1).

in.OTGErrorCode: For USB On-The-Go transactions, indicates error code if non-zero.

in.OTGErrorCodeOffset: For USB On-The-Go transactions with errors, indicates the offset from the first packet in the transaction to the packet with error.

in.PayloadLength: Length (in bytes) of the packet payload. If zero, the transaction does not have any payload.

in.Payload: Bit source of the transaction data payload.

Split Transaction-Specific Set of Members

All the input context members that are defined for USB2 transactions are also applicable to Split Transactions. In addition to those, Split Transactions define the following members:

in.TraHalted: Indicates that this split transaction was halted.

Transfer-Specific Set of Members

in.XferType: Type of transfer. Repeats the trace event value for the transfer.

in.Addr: Device Address value for this USB transfer.

in.Endp: Device Endpoint Number value for this USB transfer.

in.Completed: Flag signaling if the transfer was completed.

in.Halted: Flag signaling if the transfer was halted (usually that means STALL handshake sent).

in.CtrlDirection: For a Control Transfer, represents the direction:

0 = Host-to-device

1 = Device-to-host

If the transfer is a Control Transfer, the following input context members provide values of the corresponding fields of the USB Device Request:

in.ReqType

in.ReqRecipient

in.bRequest

in.wIndex

in.wValue

in.wLength

in.ClassicOnHigh: When set, indicates that this transfer was a classic speed transfer that was executed and captured on a high speed branch (upstream from a high speed hub).

in.OTGHostId: For USB On-The-Go transfers, indicates if the A-device is acting as the host (value of 0) or the B-device is acting as the host (value of 1).

in.PayloadLength: Length (in bytes) of the transfer payload. If zero, transfer does not have any payload. Take care not to request payload for the transfers that moved large amounts of data.

in.Payload: Bit source of the transfer payload.

SCSI Operation-Specific Set of Members

SCSI operations define the following members:

in.OperCode: SCSI operation code.

in.Addr: Device address value for this SCSI operation.

in.Tag: SCSI operation tag.

in.Status: SCSI operation status.

Metric parameters which are experessed as following members:

in.XferCount: The total number of transfers that compose this SCSI operation.

in.ResponseTime: Time it took to transmit this SCSI operation on the USB link(s) (VSE Time object).

in.LatencyTime: Time measured from the transmission of the SCSI command to the first data transmitted for this SCSI IO operation (VSE Time object).

in.DataToStatusTime: Time between the end of data transmission for this SCSI operation and the status transfer (VSE Time object).

in.Throughput: payload divided by response time, expressed in kilobytes per second.

in.PldBytes: Number of payload bytes this SCSI operation transferred.

PHY Transaction-Specific Set of Members

PHY Transactions define the following members:

in.Type: PHY Transaction Type. Possible values:

const _SCD1 = 0x01;

const _SCD2 = 0x02;

const _PHY_CAP_5 = 0x03;

const _PHY_CAP_10 = 0x04;

const _PHY_READY = 0x05;

PD Packet-Specific Set of Members

Here is how to use decoder and context methods to retrieve a field's value:

Method 1

field_prefix = "OBJ1_";
field_name = field_prefix + "Rsvd_1";
report_str = GetDecodedPktField (field_name);

Method 2

field_name = "in." + field_prefix + "Rsvd_1";
report_str = FormatEx( FormatString_IntValue, field_name, in.OBJ1_Rsvd_1 );

Information Available Only by Context

The following information can just be accessed using input contexts and cannot be retrieved using Packet and Script Decoded Fields Retrieving Functions:

in.PreambleLength: Indicates the Preamble length in bits.

in.PacketType: The 4-bit Message Type field indicating the type of Message being sent.

Values for Power Delivery Control, Data, Ordered Set Message Types:

_PD_CONTROL_RSV0 = 0,

_PD_CONTROL_GOOD_CRC = 1,

_PD_CONTROL_GOTO_MIN = 2,

_PD_CONTROL_ACCEPT = 3,

_PD_CONTROL_REJECT = 4,

_PD_CONTROL_PING = 5,

_PD_CONTROL_PS_RDY = 6,

_PD_CONTROL_GET_SRC_CAP = 7,

_PD_CONTROL_GET_SINK_CAP = 8,

_PD_CONTROL_DR_SWAP = 9,

_PD_CONTROL_PR_SWAP = 10,

_PD_CONTROL_VCONN_SWAP = 11,

_PD_CONTROL_WAIT = 12,

_PD_CONTROL_SOFT_RESET = 13,

_PD_CONTROL_DATA_RESET = 14,

_PD_CONTROL_DATA_RESET_COMPLETE = 15,

_PD_CONTROL_NOT_SUPPORTED = 16,

_PD_CONTROL_GET_SRC_CAP_EXTENDED = 17,

_PD_CONTROL_GET_STATUS = 18,

_PD_CONTROL_FR_SWAP = 19,

_PD_CONTROL_GET_PPS_STATUS = 20,

_PD_CONTROL_GET_COUNTRY_CODE = 21,

_PD_CONTROL_GET_SNK_CAP_EXTENDED = 22,

_PD_CONTROL_GET_SOURCE_INFO = 23,

_PD_CONTROL_GET_REVISION = 24,

_PD_DATA_SRC_CAP = 33,

_PD_DATA_REQ = 34,

_PD_DATA_BIST = 35,

_PD_DATA_SNK_CAP = 36,

_PD_DATA_BATTERY_STATUS = 37,

_PD_DATA_ALERT = 38,

_PD_DATA_GET_COUNTRY_INFO = 39,

_PD_DATA_ENTER_USB = 40,

_PD_DATA_EPR_REQ = 41,

_PD_DATA_EPR_MODE = 42,

_PD_DATA_SRC_INFO = 43,

_PD_DATA_REVISION = 44,

_PD_DATA_VENDOR_DEF = 47,

_PD_EXTENDED_SRC_CAP_EXTENDED = 65,

_PD_EXTENDED_STATUS = 66,

_PD_EXTENDED_GET_BATTERY_CAP = 67,

_PD_EXTENDED_GET_BATTERY_STATUS = 68,

_PD_EXTENDED_BATTERY_CAP = 69,

_PD_EXTENDED_GET_MANUFACTURER_INFO = 70,

_PD_EXTENDED_MANUFACTURER_INFO = 71,

_PD_EXTENDED_SECURITY_REQ = 72,

_PD_EXTENDED_SECURITY_RESP = 73,

_PD_EXTENDED_FW_UPDATE_REQ = 74,

_PD_EXTENDED_FW_UPDATE_RESP = 75,

_PD_EXTENDED_PPS_STATUS = 76,

_PD_EXTENDED_COUNTRY_INFO = 77,

_PD_EXTENDED_COUNTRY_CODE = 78,

_PD_EXTENDED_SNK_CAP_EXTENDED = 79,

_PD_EXTENDED_EPR_SRC_CAPABILITIES……..= 81,

_PD_EXTENDED_EPR_SNK_CAPABILITIES = 82,

_PD_EXTENDED_VENDOR_DEFINED_EXT = 83

_PD_EXTENDED_CONTROL_EPR_GET_SRC_CAP = 97,

_PD_EXTENDED_CONTROL_EPR_GET_SNK_CAP = 98,

_PD_EXTENDED_CONTROL_EPR_KEEP_ALIVE = 99,

_PD_EXTENDED_CONTROL_EPR_KEEP_ALIVE_ACK = 100,

_PD_MESSAGE_TYPE_END___ = 249

_PD_MSG_EVENT_FAST_POWER_ROLE_SWAP = 0xfa,

_PD_MSG_HARD_RESET = 0xfb,

_PD_MSG_CABLE_RESET = 0xfc,

_PD_OTHER_MSG_BIST_TEST_STREAM = 0xfd,

_PD_MSG_UNKNOWN = 0xfe,

in.SenderPort: The port sent this packet according to data provided by Bus Engine (front end acquizition hardware).

Possible values:

_PD_PORT_UNKNOWN = 0

_PD_PORT_LEFT = 1

_PD_PORT_RIGHT = 2

_PD_PORT_CABLE = 3

in.SOP_Type: Value of SOP Type for Start of Packet

Possible values:

_PD_FRAMING_TYPE_NO_FRAMING = 0,

_PD_FRAMING_TYPE_SOP = 1,

_PD_FRAMING_TYPE_SOP_PRIM = 2,

_PD_FRAMING_TYPE_SOP_DOUBLE_PRIM = 3,

_PD_FRAMING_TYPE_SOP_PRIM_DBG = 4,

_PD_FRAMING_TYPE_SOP_DBL_PRIM_DBG = 5,

_PD_FRAMING_TYPE_HARD_RESET = 6,

_PD_FRAMING_TYPE_CABLE_RESET = 7,

in.DataObjectCount: The 3-bit Number of Data Objects field indicates the number of 32-bit Data Objects that follow the Message Header. When this field is zero the Message is either a Control Message or an unchunked extended message, otherwise the message is either a Data Message or a chunked extended message.

in.OBJX_CapType: Capability type of the data object X which can be either _PD_DATA_SNK_CAP or _PD_DATA_SRC_CAP for Source_Capabilities or Sink_Capabilities capability messages.

in.OBJ1_MinOprCurPow: Minimum Operating Current/Power field in the Request Message. Set to the lowest current the Sink requires to maintain operation. The values returned are in 10mA and 250mW for Current and Power members respectively.

in.OBJ1_MaxOprCurPow: Maximum Operating Current/Power field in the Request Message. Set to the highest current the Sink will ever require. The values returned are in 10mA and 250mW for Current and Power members respectively.

in.OprCurPow: Operating Current field in the Request Data Object. Set to the actual amount of current the Sink needs to operate at a given time. The values returned are in 10mA and 250mW for Current and Power members respectively.

in.BISTFunction: Type of the BIST message function. Possible values:

5: BIST Carrier Mode 2

8: BIST Test Data

The following constants are defined:

_PD_BIST_REQ_TYPE_CARRIER_MODE

_PD_BIST_REQ_TYPE_TEST_DATA

in.IsStructuredVDM: A value of 1 indicates current Vendor Defined Message is a Structured VDM, 0 means an Unstructured VDM.

in.VDMCommand: The VDM Header for a Structured VDM Message defines Commands used to retrieve a list of SVIDs the device supports, to discover the Modes associated with each SVID, and to enter/exit the Modes.

The Commands include:

_PD_VDM_CMD_DISCOVER_IDENTITY: Discover Identity

_PD_VDM_CMD_DISCOVER_SVIDS: Discover SVIDs

_PD_VDM_CMD_DISCOVER_MODES: Discover Modes

_PD_VDM_CMD_ENTER_MODE: Enter Mode

_PD_VDM_CMD_EXIT_MODE: Exit Mode

_PD_VDM_CMD_ATTENTION: Attention

_PD_VDM_CMD_SVID_SPECIFIC_FIRST___

_PD_VDM_CMD_SVID_SPECIFIC_LAST___

_PD_VDM_CMD_SVID_SPECIFIC_1

_PD_VDM_CMD_SVID_SPECIFIC_15

Additional Command space is also reserved for Standard and Vendor use and for future extensions.

in.VDMCommandType: Indicates the type of Command request/response being sent.

in.VDMVendorID: Unique 16-bit unsigned integer. Assigned by the USB-IF to the Vendor.

in.UndefinedObjectsCount: When data objects are decoded, some data may be recognized as undefined depending on the packet type being decoded, this member gives the number of these undefined data objects.

in.BufferLen: Size of power delivery message in bytes, this includes header and data objects.

Message Header Members

in.Msg_Type (Given in PacketType format in Context too): The Message Type field indicates the type of Message being sent.

in.Rsvd_1: Reserved

in.DR: The 1-bit Port Data Role field indicates the current data role of the Port:

0b UFP

1b DFP

in.Spec_Rev: The 2-bit Specification Revision field indicates the revision of the Power Delivery Specification supported by the Device.

00b – Revision 1.0

01b – Revision 2.0

10b – Revision 3.0

11b – Reserved, not used

Available constants:

_PD_SPEC_REV_1

_PD_SPEC_REV_2

_PD_SPEC_REV_3

_PD_SPEC_REV_UNDEF

in.PR: The 1-bit Port Data Role field indicates the current data role of the Port:

0b UFP

1b DFP

in.Cable_Plug: Indicates whether or not this Message originated from a Cable Plug:

0b Message originated from a DFP or UFP

1b Message originated from a Cable Plug

The Cable Plug field only applies to SOP’ and SOP’’ Packet types.

in.Msg_ID: The 3-bit MessageID field is the value generated by a rolling counter maintained by the originator of the Message.

in.Obj_Cnt: The 3-bit Number of Data Objects field indicates the number of 32-bit Data Objects that follow the Message Header. When this field is zero the Message is a Control Message and when it is non-zero, the Message is a Data Message.

The Number of Data Objects field applies to all SOP* Packet types.

Rev2: in.Rsvd_2: Reserved

Rev3: in.Extended: The 1-bit flag indicates if this is an Extended message or not.

Capability Message

Source Capabilities Message

This can be decided using in.Supply_Type:

_PD_CAP_PWR_FIXED = 0,

_PD_CAP_PWR_BATTERY = 1,

_PD_CAP_PWR_VARIABLE = 2,

Rev 2.0 : _PD_CAP_PWR_RSVD = 3,

Rev 3.0 : _PD_CAP_PWR_APDO = 3,

Source Fixed Power Supply Data Object Field Names

in.Max_Cur: Maximum Current in 10mA units

in.Voltage: Voltage in 50mV units

in.Peak_Curr:

00 Peak current equals IOC (default)

01 Overload Capabilities:

1. Peak current equals 150% IOC for 1ms @ 5% duty cycle (low current equals 97% IOC for 19ms)

2. Peak current equals 125% IOC for 2ms @ 10% duty cycle (low current equals 97% IOC for 18ms)

3. Peak current equals 110% IOC for 10ms @ 50% duty cycle (low current equals 90% IOC for 10ms)

10 Overload Capabilities:

1. Peak current equals 200% IOC for 1ms @ 5% duty cycle (low current equals 95% IOC for 19ms)

2. Peak current equals 150% IOC for 2ms @ 10% duty cycle (low current equals 94% IOC for 18ms)

3. Peak current equals 125% IOC for 10ms @ 50% duty cycle (low current equals 75% IOC for 10ms)

11 Overload Capabilities:

1. Peak current equals 200% IOC for 1ms @ 5% duty cycle (low current equals 95% IOC for 19ms)

2. Peak current equals 175% IOC for 2ms @ 10% duty cycle (low current equals 92% IOC for 18ms)

3. Peak current equals 150% IOC for 10ms @ 50% duty cycle (low current equals 50% IOC for 10ms)

in.Rsvd: Reserved

in.Unchunked_Ext: The 1-bit flag indicates whether the port supports unchunked extended messages or not.

in.DR_Swap_Supp: Data Role Swap bit. Set when the Port is Type-C (see [USBType-C 1.0]) and supports the DR_Swap Message. This is a static capability that remains fixed for a given device.

in.USB_Com_Cap: USB Communications Capable bit. Only for devices capable of communication over USB data lines (e.g. D+/- or SS Tx/Rx).

in.Ext_Pow: Externally Powered bit.

in.USB_Suspend: Prior to a Contract or when the USB Communications Capable bit is set to zero, this flag is undefined and Sinks follow the rules for suspend as defined in [USB 2.0], [USB 3.1], [USBType-C 1.0] or [BC 1.2]. After a Contract has been negotiated:

If the USB Suspend Supported flag is set, then the Sink follows the [USB 2.0] or [USB 3.1] rules for suspend and resume. A PDUSB Peripheral may draw up to pSnkSusp during suspend; a PDUSB Hub may draw up to pHubSusp during suspend.

If the USB Suspend Supported flag is cleared, then the Sink does not apply the [USB 2.0] or [USB 3.1] rules for suspend and may continue to draw the negotiated power. Note that when USB is suspended, the USB device state is also suspended.

Sinks may indicate to the Source that they would prefer to have the USB Suspend Supported flag cleared by setting the No USB Suspend flag in a Request Message

in.Dual_Role: Dual-Role Power bit. Set when the Port is Dual-Role Power capable i.e. supports the PR_Swap Message. This is a static capability that remains fixed for a given device.

in.Supply_Type: Fixed Supply (00b) PDO

Source Battery Power Supply Data Object Field Names

in.Max_Allowed_Pwr: Maximum Allowable Power in 250mW units

in.Min_Volt: Minimum Voltage in 50mV units

in.Max_Volt: Maximum Voltage in 50mV units

in.Supply_Type: Battery

Source Variable Power Supply Data Object Field Names

in.Max_Cur: Maximum Current in 10mA units

in.Min_Volt: Minimum Voltage in 50mV units

in.Max_Volt: Maximum Voltage in 50mV units

in.Supply_Type: Variable Supply (non-battery)

Source Augmented Power Data Object (APDO) Field Names

Decided using the following member:

in.Sub_Type:

_PD_CAP_APDO_PPS = 0,

_PD_CAP_APDO_EPR_AVS = 1,

_PD_CAP_APDO_SPR_AVS = 2,

_PD_CAP_APDO_RSVD2 = 3,

SPR Programmable Power Supply (PPS) APDO Field Names