MXF_ASYNCEH_DATAREC Struct Reference

ASYNC Enhanced Transmit / Receive Record Structure. More...

#include <mxf_class_async_enhanced.h>

Data Fields
uint64	timeTag
uint32	control
uint32	dataSize
uint32	repeatCount
uint32	reserved
uint8	data [256]

Detailed Description

This record structure is needed when sending (transmission) and receiving (acquisition) ASYNC Enhanced string.

Examples:

async.c, async.cs, async_flexsmp.c, async_flexsmp.cs, async_flexsmp_rs232.c, async_flexsmp_rs232.cs, async_flow_control_hw.c, async_flow_control_hw.cs, async_flow_control_sw.c, async_flow_control_sw.cs, async_rx_acquisition_trigger.c, async_rx_acquisition_trigger.cs, async_tx_error_injection.c, async_tx_error_injection.cs, mil1553_embedded_async_to_1553.c, mil1553_embedded_async_to_1553.cs, multi.c, and multi.cs.

Field Documentation

MXF_ASYNCEH_DATAREC::timeTag

Acquisition mode: Specifies the time when the data record has been received by the device. It is an absolute time expressed on the timebase set for the device. The time tag may also be disabled by the KMXF_ASYNCEH_RX_TIMETAG_ENABLE attribute.

Transmission Mode: For aperiodic transmit operation, the time tag allows the application to specify the time at which the data is to be transmitted. Depending on the usage the time tag can be optional.

Examples:

async.c, async.cs, async_flexsmp.c, async_flexsmp.cs, async_flexsmp_rs232.c, async_flexsmp_rs232.cs, async_flow_control_hw.c, async_flow_control_hw.cs, async_flow_control_sw.c, async_flow_control_sw.cs, async_rx_acquisition_trigger.c, async_rx_acquisition_trigger.cs, async_tx_error_injection.c, async_tx_error_injection.cs, mil1553_embedded_async_to_1553.c, mil1553_embedded_async_to_1553.cs, and multi.c.

MXF_ASYNCEH_DATAREC::control

Acquisition mode: For receive operation, the control field defines the condition under which the related record data was received.

The control bits are defined as follows:

Bit constant	Description
MXF_ASYNCEH_RX_REC_CTRL_STOPBIT_ERROR	Stop bit error detected
MXF_ASYNCEH_RX_REC_CTRL_PARITY_ERROR	Parity error detected

Receive control bit - string mode only:

Bit constant	Description
MXF_ASYNCEH_RX_REC_CTRL_EOS	End of string detected
MXF_ASYNCEH_RX_REC_CTRL_SOS	Start of string detected

Transmission Mode: For transmission, the control field allows the user to inject transmit error or to generate a discrete pulse on transmit.

A control of zero instructs the transmit process to send the data using the current transmitter settings.

The control bits are defined as follows:

Bit constant	Description
MXF_ASYNCEH_TX_REC_CTRL_PARITY_ERROR	Transmit with a parity error. The parity error uses the opposite parity of the channel parity setting. Ignored if the channel parity attribute is set to VMXF_ASYNCEH_PARITY_NONE.
MXF_ASYNCEH_TX_REC_CTRL_DISCRETE_OUTPUT_TRIG	Generate a discrete trigger pulse for the duration of the ASYNC transmit output. On IO-MULTI-EH and IO-ASYNC-EH, the pulse will occur on the channel associated discrete line with mxfChannelDiscreteOutputTriggerEnableSet(). On IPM-MULTI and IPM-ASYNC, the pulse will occur on the associated discrete channel.
MXF_ASYNCEH_TX_REC_CTRL_LONG_WORD_SIZE	Transmit with a bit more. The inserted bit has a value of 0 and is transmitted after the last bit, before the parity bit (if used). If parity is used, the parity bit value is not changed. Not available on IPM-MULTI.
MXF_ASYNCEH_TX_REC_CTRL_SHORT_WORD_SIZE	Transmit with a bit less. Not available on IPM-MULTI.
MXF_ASYNCEH_TX_REC_CTRL_WORD_ERROR	Generate error on a specific byte only. The byte index is set in the 8-bit LSB.

Examples:

async.c, async.cs, async_flexsmp.c, async_flexsmp_rs232.c, async_flow_control_hw.c, async_flow_control_hw.cs, async_flow_control_sw.c, async_flow_control_sw.cs, async_rx_acquisition_trigger.c, async_tx_error_injection.c, async_tx_error_injection.cs, mil1553_embedded_async_to_1553.c, mil1553_embedded_async_to_1553.cs, and multi.c.

MXF_ASYNCEH_DATAREC::dataSize

Acquisition mode: Number of bytes received in data array.

Transmission Mode: Number of bytes to transmit from data array.

Examples:

async.c, async.cs, async_flexsmp.c, async_flexsmp.cs, async_flexsmp_rs232.c, async_flexsmp_rs232.cs, async_flow_control_hw.c, async_flow_control_hw.cs, async_flow_control_sw.c, async_flow_control_sw.cs, async_rx_acquisition_trigger.c, async_rx_acquisition_trigger.cs, async_tx_error_injection.c, async_tx_error_injection.cs, mil1553_embedded_async_to_1553.c, mil1553_embedded_async_to_1553.cs, multi.c, and multi.cs.

MXF_ASYNCEH_DATAREC::repeatCount

Acquisition mode: Not used.

Transmission Mode: Number of times to repeat the transmission of the record. Must be set to one.

Examples:

async.c, async_flexsmp.c, async_flexsmp_rs232.c, async_flow_control_hw.c, async_flow_control_sw.c, async_rx_acquisition_trigger.c, async_tx_error_injection.c, mil1553_embedded_async_to_1553.c, mil1553_embedded_async_to_1553.cs, multi.c, and multi.cs.

MXF_ASYNCEH_DATAREC::reserved

Reserved for future use. Must be set to 0 for transmit operation.

Examples:

async_flexsmp.c, async_flexsmp_rs232.c, async_flow_control_sw.c, async_rx_acquisition_trigger.c, mil1553_embedded_async_to_1553.c, and mil1553_embedded_async_to_1553.cs.

MXF_ASYNCEH_DATAREC::data

Acquisition mode: Data received.

Transmission Mode: Data to transmit.

Examples:

async.c, async.cs, async_flexsmp.c, async_flexsmp.cs, async_flexsmp_rs232.c, async_flexsmp_rs232.cs, async_flow_control_hw.c, async_flow_control_hw.cs, async_flow_control_sw.c, async_flow_control_sw.cs, async_rx_acquisition_trigger.c, async_rx_acquisition_trigger.cs, async_tx_error_injection.c, async_tx_error_injection.cs, mil1553_embedded_async_to_1553.c, mil1553_embedded_async_to_1553.cs, multi.c, and multi.cs.