MX Foundation 4
Attributes Reference


Mode

The KMXF_CANBUS_MODULE_MODE attribute defines the module CAN Mode.

Constant Value
VMXF_CANBUS_MODULE_MODE_CAN Classical CAN (default)
VMXF_CANBUS_MODULE_MODE_CAN_FD CAN FD


FD Mode

The KMXF_CANBUS_FD_MODE attribute defines the channel CAN FD mode. This attribute is available when KMXF_CANBUS_MODULE_MODE is set to VMXF_CANBUS_MODULE_MODE_CAN_FD.

Constant Value
VMXF_CANBUS_FD_MODE_ISO ISO CAN FD (default)
VMXF_CANBUS_FD_MODE_NON_ISO non-ISO CAN FD


Bus-off

The KMXF_CANBUS_BUS_OFF_ENABLE attribute defines if the channel will go to Bus-off state when the transmit error counter is greater than 255.

Constant Value
VMXF_ENABLE Bus-off state enable (default)
VMXF_DISABLE Bus-off state disable


RX Timetag Enable

The KMXF_CANBUS_RX_TIMETAG_ENABLE attribute defines if the time tag is returned in the record.
Not available on MXF_MODULE_FLEXSMP, timetag always enabled.

Constant Value
VMXF_ENABLE Enable time tag (default)
VMXF_DISABLE Disable time tag


RX FIFO Aging Timeout

The KMXF_CANBUS_RX_FIFO_AGING (IO-CANBUS) and KMXF_MODULE_RX_FIFO_AGING (IO-FLEXSMP) attributes define the FIFO aging timeout value for a receiver channel. It defines the longest delay that a received word can wait in the hardware FIFO before a receive interrupt is generated. The attribute value resolution is based on the timebase resolution. A RX FIFO Aging Timeout value of 0 disables the aging timeout.

The supported range is:

Module Range (microsecond) Default (microsecond) Note
MXF_MODULE_CANBUS 0 - 16256 8192 Value is rounded down to step of 64 microseconds
MXF_MODULE_FLEXSMP 0 - 25000 8000 Value is rounded down to step of 100 microseconds
Note
MX Foundation takes care of initializing this attribute using the optimal value. It is not recommended to change to this attribute unless told to do so by a MAX Technologies support engineer.


RX FIFO Almost Full Threshold

The KMXF_CANBUS_RX_FIFO_AF (IO-CANBUS) and KMXF_MODULE_RX_FIFO_AF (IO-FLEXSMP) attributes hold the 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 interrupt is generated.

The supported range is:

Module Range Default
MXF_MODULE_CANBUS 1 - 255 (32-bit word) 64
MXF_MODULE_FLEXSMP 1 - 511 (64-bit word) 128
Note
MX Foundation takes care of initializing this attribute using the optimal value. It is not recommended to change to this attribute unless told to do so by a MAX Technologies support engineer.


TX FIFO Almost Full Threshold

The KMXF_CANBUS_TX_FIFO_AF (IO-CANBUS) and KMXF_MODULE_TX_FIFO_AF (IO-FLEXSMP) attributes hold the almost full threshold for a transmitter channel. This attribute value determines the number of transmit 16-bit words that are to be queued in the transmit hardware FIFO. The transmit interrupt will be cleared automatically once this threshold is reached.

The supported range is:

Module Range Default
MXF_MODULE_ASYNC 2 - 255 (32-bit word) 128
MXF_MODULE_FLEXSMP 2 - 256 (64-bit word) 256
Note
MX Foundation takes care of initializing this attribute using the optimal value. It is not recommended to change to this attribute unless told to do so by a MAX Technologies support engineer.


TX FIFO Almost Empty Threshold

The KMXF_CANBUS_TX_FIFO_AE (IO-CANBUS) and KMXF_MODULE_TX_FIFO_AE (IO-FLEXSMP) attributes hold the almost empty threshold for a transmitter channel. The transmit interrupt will be generated whenever the number of 16-bit words remaining in the transmit hardware FIFO is less or equal to the value specified by this attribute. The software embedded process will then be able to react and fill in the transmit FIFO.

The supported range is:

Module Range Default
MXF_MODULE_CANBUS 1 - 254 (32-bit word) 64
MXF_MODULE_FLEXSMP 1 - 255 (64-bit word) 64
Note
MX Foundation takes care of initializing this attribute using the optimal value. It is not recommended to change to this attribute unless told to do so by a MAX Technologies support engineer.
Updated 10/23/2023