MX Foundation 4
Protocol Stack Attributes

End System Mode

The KMXF_A664_ES_MODE attribute defines how the end system behaves for the port control.

In redundant mode the end system controls both ports with only port A. For example, speed set to port A will also be set to port B. Data transmitted on port A will also be transmitted by default on port B.

In independent mode, two end systems with one port each is available. In this mode, RM is not possible as both ports are totally independent.

This attribute is accessible with a module handle.

Constant Description
VMXF_A664_ES_MODE_REDUNDANT Select redundant mode (default)
VMXF_A664_ES_MODE_INDEPENDENT Select independent mode


End System VL Header Check

The KMXF_A664_ES_RX_HEADER_CHECK_VL attribute defines the end system VL header check control. Enable/disable check of various fields of IP/UDP header against default protocol value.

This attribute is accessible with a physical channel handle.

Bitmask Description
VMXF_A664_ES_RX_HEADER_IPv4_CHECK_TOS Check of IP TOS field
VMXF_A664_ES_RX_HEADER_IPv4_CHECK_TTL Check of IP TTL field
VMXF_A664_ES_RX_HEADER_IPv4_CHECK_FLAGS Check of IP Flags field
VMXF_A664_ES_RX_HEADER_IPv4_CHECK_CHECKSUM Check of IP Checksum field
VMXF_A664_ES_RX_HEADER_UDP_CHECK_HEADER_SIZE Check of UDP header size
VMXF_A664_ES_RX_HEADER_UDP_CHECK_LENGTH Check of UDP length field
VMXF_A664_ES_RX_HEADER_UDP_CHECK_CHECKSUM Check of UDP checksum field

Default value is all checks enabled.

Raw Rx Error Only

The KMXF_A664_RAW_RX_ERROR_ONLY attribute defines the usage of the raw port.

By default, if reception on a raw port is activated, nothing will be received on any COM/SAP port. When enabled, this attribute allows COM/SAP acquisition to run and enqueue erroneous frames on the raw port for analysis.

This attribute is accessible with a physical channel handle.

Constant Description
VMXF_ENABLE Raw port acquisition receive only erroneous frames
VMXF_DISABLE Raw port acquisition receive every frames (default)



Raw Rx Preamble

The KMXF_A664_RAW_RX_PREAMBLE attribute defines if the raw port returns the preamble and SFD.

By default, the preamble and SFD are not returned. When enabled, the preamble and SFD will be returned in the data array and the number of bytes of preamble and SFD will be set in the MXF_A664_DATAREC.service.rxAcq.preambleCount field. Use that count to know at which offset the payload begins.

This attribute is accessible with a physical channel handle.

Constant Description
VMXF_ENABLE Raw port returns preamble and SFD
VMXF_DISABLE Raw port does not return preamble and SFD (default)
Updated 10/23/2023