MX Foundation 4
Attributes Reference


ADC attributes

Channel Selection

The KMXF_FLEXADC_MODULE_CHN_SELECTION attribute defines the channel selection. The FLEXADC has up to 64 single-ended or up to 32 differential channels. The 64 channels are divided into four groups of 16 channels and in each of these sub-groups, the channels are paired together (0-8, 1-9, ...). Each pair can be selected as a differential pair or two independent single-ended.
This attribute is a 64-bit mask that selects channels. When a channel pair is set to differential, only the first channel of the pair may be selected.

Ex. If the channel pair 0-8 is set to differential (channel 0 is set to a differential mode), the channel 0 (Channel Selection Mask = 0x0000000000000001) must be used to enable the pair. To add channel 1 and 17 that are set in single-ended mode, the Channel Selection Mask will be 0x0000000000020003.

Default value: 0x0000000000000000 (no channel selected).


Conversion Period

The KMXF_FLEXADC_MODULE_CONVERSION_PERIOD attribute defines the conversion period, which is the time between each sample. The attribute value resolution is based on the timebase resolution.

The supported range is:

Range Value
(microsecond)
Minimum 1000 (1 kHz)
Maximum 1000000 (1 Hz)

Default value: 100000 microseconds.


RX FIFO Aging Timeout

The KMXF_FLEXADC_MODULE_FIFO_AGING attribute defines 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 attribute value is rounded down to step of 100 microseconds.

The supported range is:

Range Value
(microsecond)
Minimum 0 (disabled)
Maximum 25500

Default value: 8192 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_FLEXADC_MODULE_FIFO_AF attribute holds the RX FIFO almost full threshold for the module. This attribute value determines the number of received records that must be accumulated in the receive hardware FIFO before an interrupt is generated.

The supported range is:

Range Value
(records)
Minimum 1
Maximum 30

Default value: 16.

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.


Input Range

The KMXF_FLEXADC_CHN_INPUT_RANGE attribute defines the input range.
In differential mode, the channel associated to the positive pin should be used to get or set attributes.
The channel, and its associated pair in differential mode, must be disabled before changing this attribute.

The supported values are:

Constant Description
VMXF_FLEXADC_CHN_INPUT_RANGE_SE_BIPOLAR_2P5V single-ended -2.5 V to +2.5 V
VMXF_FLEXADC_CHN_INPUT_RANGE_SE_BIPOLAR_5V single-ended -5 V to +5 V
VMXF_FLEXADC_CHN_INPUT_RANGE_SE_BIPOLAR_6P25V single-ended -6.25 V to +6.25 V
VMXF_FLEXADC_CHN_INPUT_RANGE_SE_BIPOLAR_10V single-ended -10 V to +10 V (default)
VMXF_FLEXADC_CHN_INPUT_RANGE_SE_BIPOLAR_12P5V single-ended -12.5 V to +12.5 V
VMXF_FLEXADC_CHN_INPUT_RANGE_SE_UNIPOLAR_5V single-ended 0 V to +5 V
VMXF_FLEXADC_CHN_INPUT_RANGE_SE_UNIPOLAR_10V single-ended 0 V to +10 V
VMXF_FLEXADC_CHN_INPUT_RANGE_SE_UNIPOLAR_12P5V single-ended 0 V to +12.5 V
VMXF_FLEXADC_CHN_INPUT_RANGE_DIFF_BIPOLAR_5V differential -5 V to +5 V
VMXF_FLEXADC_CHN_INPUT_RANGE_DIFF_BIPOLAR_10V differential -10 V to +10 V
VMXF_FLEXADC_CHN_INPUT_RANGE_DIFF_BIPOLAR_12P5V differential -12.5 V to +12.5 V
VMXF_FLEXADC_CHN_INPUT_RANGE_DIFF_BIPOLAR_20V differential -20 V to +20 V


Calibration Slope

The KMXF_FLEXADC_CHN_CALIBRATION_SLOPE attribute holds the calibration slope for a channel. The “m” in equation “mx + b”. This is a floating point attribute.

The slope could take a value in the following range:

Range Value (V)
Minimum -10000.0
Maximum 10000.0

Default value: 1.0.


Calibration Offset

The KMXF_FLEXADC_CHN_CALIBRATION_OFFSET attribute holds the calibration offset for a channel. The “b” in equation “mx + b”. This is a floating point attribute.

The offset could take a value in the following range:

Range Value (V)
Minimum -10000.0
Maximum 10000.0

Default value: 0.0.


DAC attributes

Channel Selection

The KMXF_FLEXDAC_MODULE_CHN_SELECTION attribute defines the channel selection. The FLEXDAC has up to 64 single-ended or up to 32 differential channels. The 64 channels are divided into four groups of 16 channels and in each of these sub-groups, the channels are paired together (0-8, 1-9, ...). Each pair can be selected as a differential pair or two independent single-ended.
This attribute is a 64-bit mask that selects channels. When a channel pair is set to differential, only the first channel of the pair may be selected.

Ex. If the channel pair 0-8 is set to differential (channel 0 is set to a differential mode), the channel 0 (Channel Selection Mask = 0x0000000000000001) must be used to enable the pair. To add channel 1 and 17 that are set in single-ended mode, the Channel Selection Mask will be 0x0000000000020003.

Default value: 0x0000000000000000 (no channel selected).


TX FIFO Almost Full Threshold

The KMXF_FLEXDAC_MODULE_FIFO_AF attribute holds the TX FIFO almost full threshold for the module. This attribute value determines the number of transmit quad-words that are to be queued in the transmit hardware FIFO. The transmit interrupt is automatically cleared once this threshold is reached.

The supported range is:

Range Value
(quad-words)
Minimum 2
Maximum 511

Default value: 180.

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_FLEXDAC_MODULE_FIFO_AE attribute holds the TX FIFO almost empty threshold for the module. This attribute value determines when the transmit interrupt is generated. The transmit interrupt is generated whenever the number of quad-words remaining in the transmit hardware FIFO is less or equal to the value specified by this attribute. The software embedded process is then able to react and fill in the transmit FIFO.

The supported range is:

Range Value
(quad-words)
Minimum 1
Maximum 510

Default value: 90.

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.


Output Range

The KMXF_FLEXDAC_CHN_OUTPUT_RANGE attribute defines the output range.
In differential mode, the channel associated to the positive pin should be used to get or set attributes.
All channels must be disabled before changing this attribute.

The supported values are:

Constant Description
VMXF_FLEXDAC_CHN_OUTPUT_RANGE_SE_BIPOLAR_2P5V single-ended -2.5 V to +2.5 V
VMXF_FLEXDAC_CHN_OUTPUT_RANGE_SE_BIPOLAR_5V single-ended -5 V to +5 V
VMXF_FLEXDAC_CHN_OUTPUT_RANGE_SE_BIPOLAR_10V single-ended -10 V to +10 V (default)
VMXF_FLEXDAC_CHN_OUTPUT_RANGE_SE_UNIPOLAR_5V single-ended 0 V to +5 V
VMXF_FLEXDAC_CHN_OUTPUT_RANGE_SE_UNIPOLAR_10V single-ended 0 V to +10 V
VMXF_FLEXDAC_CHN_OUTPUT_RANGE_DIFF_BIPOLAR_5V differential -5 V to +5 V
VMXF_FLEXDAC_CHN_OUTPUT_RANGE_DIFF_BIPOLAR_10V differential -10 V to +10 V
VMXF_FLEXDAC_CHN_OUTPUT_RANGE_DIFF_BIPOLAR_20V differential -20 V to +20 V
VMXF_FLEXDAC_CHN_OUTPUT_RANGE_DIFF_UNIPOLAR_5V differential 0 V to +5 V
VMXF_FLEXDAC_CHN_OUTPUT_RANGE_DIFF_UNIPOLAR_10V differential 0 V to +10 V
Updated 10/23/2023