MX Foundation 4
ASYNC Common Flow Control Attributes

Flow Control RX Index

The KMXF_ASYNCEH_TX_FLOWCTRL_RX_INDEX attribute holds the actual flow control RX channel index.

By default, a transmitter is associated to its corresponding receiver (TX0 with RX0, TX1 with RX1 and so on), but with this attribute, this association can be redefined. More than one transmitter can be linked to the same receiver index. This attribute will be used by both flow control mechanism (XON/XOFF and HANDSHAKE). This attribute must be set before setting the others flow control attributes.

The receiver index must point to a receiver that is already set to ASYNC or HANDSHAKE protocol.

Flow Control TX Index

The KMXF_ASYNCEH_RX_FLOWCTRL_TX_INDEX attribute holds the actual flow control TX channel index.

By default, a receiver is associated to its corresponding transmitter (RX0 with TX0, RX1 with TX1 and so on), but with this attribute, this association can be redefined. More than one receiver can be linked to the same transmitter index. This attribute will be used by both flow control mechanism (XON/XOFF and HANDSHAKE). This attribute must be set before setting the others flow control attributes.

The transmitter index must point to a transmitter that is already set to ASYNC or HANDSHAKE protocol.

Flow Control RX FIFO Almost Empty Threshold

The KMXF_ASYNCEH_MODULE_RX_FLOWCTRL_FIFO_AE attribute holds the flow control almost empty threshold for a receiver channel. This attribute value determines the number of received words that must be accumulated in the receive hardware FIFO before an XON character is generated or CTS is set.

The supported range is:

Module Range Default
MXF_MODULE_ASYNC_EH 0 - 1023 (16-bit word) 16
MXF_MODULE_MULTI_EH 0 - 1023 (16-bit word) 16
MXF_MODULE_MULTI 0 - 254 (16-bit word) 16
MXF_MODULE_FLEXSMP 0 - 4095 (64-bit word) 16



Flow Control RX FIFO Almost Full Threshold

The KMXF_ASYNCEH_MODULE_RX_FLOWCTRL_FIFO_AF attribute holds the flow control almost full threshold for a receiver channel. This attribute value determines the number of received words that must be accumulated in the receive hardware FIFO before an XOFF character is generated or CTS is unset.

The supported range is:

Module Range Default
MXF_MODULE_ASYNC_EH 1 - 1024 (16-bit word) 128
MXF_MODULE_MULTI_EH 1 - 1024 (16-bit word) 128
MXF_MODULE_MULTI 1 - 255 (16-bit word) 128
MXF_MODULE_FLEXSMP 1 - 4095 (64-bit word) 128
Updated 10/23/2023