MX Foundation 4

Functions

uint32 mxfChannelInfoGet (HMXF_HANDLE handle, HMXF_DEVICE *device, HMXF_MODULE *module)
 
uint32 mxfChannelDirectionGet (HMXF_CHANNEL channel, uint64 *direction)
 
uint32 mxfChannelLocationGet (HMXF_CHANNEL channel, uint64 *deviceIndex, uint64 *moduleIndex, uint64 *channelIndex)
 
uint32 mxfChannelRecordSizeGet (HMXF_CHANNEL channel, uint64 *size)
 
uint32 mxfChannelRxStatusGet (HMXF_CHANNEL channel, uint64 *status)
 
uint32 mxfChannelTxStatusGet (HMXF_CHANNEL channel, uint64 *status)
 
uint32 mxfChannelTxPortEnableSet (HMXF_CHANNEL channel, uint64 enable)
 
uint32 mxfChannelTxPortEnableGet (HMXF_CHANNEL channel, uint64 *enable)
 
uint32 mxfChannelStatisticGet (HMXF_HANDLE handle, uint64 type, void *stat)
 
uint32 mxfChannelStatisticReset (HMXF_HANDLE handle, uint64 options)
 
uint32 mxfChannelStatisticEnableSet (HMXF_HANDLE handle, uint64 enable)
 
uint32 mxfChannelStatisticEnableGet (HMXF_HANDLE handle, uint64 *enable)
 
uint32 mxfChannelDiscreteOutputTriggerEnableSet (HMXF_CHANNEL channel, uint64 trigEvent, uint64 enable, uint64 discretePort)
 
uint32 mxfChannelDiscreteOutputTriggerEnableGet (HMXF_CHANNEL channel, uint64 trigEvent, uint64 *enable, uint64 *discretePort)
 
uint32 mxfChannelClassSet (HMXF_CHANNEL channelHandle, uint64 chnClassID)
 
uint32 mxfChannelClassGet (HMXF_CHANNEL channelHandle, uint64 *chnClassID)
 
uint32 mxfChannelClassListGet (HMXF_CHANNEL channelHandle, uint64 maxCount, uint64 *count, uint64 chnClassIDList[])
 

Detailed Description

Function Documentation

uint32 mxfChannelInfoGet ( HMXF_HANDLE  handle,
HMXF_DEVICE *  device,
HMXF_MODULE *  module 
)
C#
public static extern UInt32 mxfChannelInfoGet(UInt64 handle, out UInt64 device, out UInt64 module);

public static extern UInt32 mxfChannelInfoGet(UInt64 handle, out UInt64 device, IntPtr module);

public static extern UInt32 mxfChannelInfoGet(UInt64 handle, IntPtr device, out UInt64 module);

Returns the device and module handle related to a logical channel.

Parameters
[in]handlechannel, A664 vl or A664 port handle
[out]devicepointer to device handle. Pass NULL to ignore this parameter.
[out]modulepointer to module handle. Pass NULL to ignore this parameter.
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfChannelLocationGet()
mxfChannelDirectionGet()
Examples:
adc.c, adc_buffer_threshold.c, adc_internal_calib.c, adc_sampling.c, ar429_buffer_threshold.c, ar429_embedded_bridge.c, ar429_rx_event_handler.c, ar429_rx_sampling.c, ar629_freshnessCounter_manyCID.c, ar629_freshnessCounter_manyCID.cs, ascb_bc.c, ascb_bm.c, ascb_user.c, dac.c, dac_buffer_threshold.c, dac_relative_timing.c, discrete_event_handler.c, discrete_event_handler.cs, discrete_fifo.c, discrete_fifo.cs, discrete_rx_acquisition_trigger.c, discrete_rx_acquisition_trigger.cs, flexadc.c, flexadc_buffer_threshold.c, flexadc_sampling.c, flexdac_buffer_threshold.c, flexdac_relative_timing.c, flexdio_event_handler.c, flexdio_fifo.c, flexdio_sync.c, hdlc_aperiodic.c, hdlc_aperiodic.cs, hdlc_buffer_threshold.c, hdlc_buffer_threshold.cs, hfce_aperiodic.c, hfce_buffer_threshold.c, multi.c, multi.cs, and pulse.c.
uint32 mxfChannelDirectionGet ( HMXF_CHANNEL  channel,
uint64 *  direction 
)

Returns the channel direction (TX or RX or both).

Parameters
[in]channellogical channel handle
[out]directiondirection
Constant Description
MXF_CHANNEL_RX the channel is a receiver
MXF_CHANNEL_TX the channel is a transmitter
MXF_CHANNEL_TXRX the channel is bi-directional
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfChannelLocationGet()
mxfChannelInfoGet()
uint32 mxfChannelLocationGet ( HMXF_CHANNEL  channel,
uint64 *  deviceIndex,
uint64 *  moduleIndex,
uint64 *  channelIndex 
)
C#
public static extern UInt32 mxfChannelLocationGet(UInt64 channel, out UInt64 deviceIndex, out UInt64 moduleIndex, out UInt64 channelIndex);

Returns the physical port location (device, module and port number) for the specified channel.

Parameters
[in]channelchannel handle
[out]deviceIndexdevice index
[out]moduleIndexmodule index
[out]channelIndexchannel index
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfChannelInfoGet()
mxfChannelDirectionGet()
Examples:
adc_buffer_threshold.c, ar429_aperiodic.c, ar429_aperiodic.cs, ar429_comm_queues.c, ar429_comm_queues.cs, ar429_embedded_discrete.c, ar429_embedded_discrete.cs, ar429_embedded_timer.c, ar429_embedded_timer.cs, ar429_periodic.c, ar429_periodic.cs, ar429_rx_acquisition_trigger.c, ar429_rx_acquisition_trigger.cs, ar429_rx_event_handler.c, ar429_rx_event_handler.cs, ar629_block_mode.c, ar629_block_mode.cs, ar629_freshnessCounter_manyCID.c, ar629_freshnessCounter_manyCID.cs, ar629_independent_mode.c, ar629_independent_mode.cs, ar708_aperiodic.c, ar708_aperiodic.cs, ar708_event_handler.c, ar708_event_handler.cs, ar708_periodic.c, ar708_periodic.cs, ar717_embedded_recorder.c, ar717_embedded_recorder.cs, async_rx_acquisition_trigger.c, async_rx_acquisition_trigger.cs, csdb_aperiodic.c, csdb_aperiodic.cs, csdb_periodic.c, csdb_periodic.cs, csdb_rx_event_handler.c, csdb_rx_event_handler.cs, discrete_rx_acquisition_trigger.c, discrete_rx_acquisition_trigger.cs, flexdio.c, flexdio_sampling_acq.c, hdlc_aperiodic.c, hdlc_aperiodic.cs, hfce_aperiodic.c, mil1553_aperiodic.c, mil1553_aperiodic.cs, mil1553_aperiodic_event.c, mil1553_aperiodic_event.cs, mil1553_bc.c, mil1553_bc.cs, mil1553_bm.c, mil1553_bm.cs, mil1553_bm_acquisition_trigger.c, mil1553_bm_acquisition_trigger.cs, mil1553_rt.c, mil1553_rt.cs, usb.c, and usb.cs.
uint32 mxfChannelRecordSizeGet ( HMXF_CHANNEL  channel,
uint64 *  size 
)
C#
public static extern UInt32 mxfChannelRecordSizeGet(UInt64 channel, out UInt64 size);

Returns the channel data record structure size.

Parameters
[in]channelchannel handle
[out]sizereturned record size, in bytes.
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfRxSamplingRecordSizeGet()
uint32 mxfChannelRxStatusGet ( HMXF_CHANNEL  channel,
uint64 *  status 
)
C#
public static extern UInt32 mxfChannelRxStatusGet(UInt64 channel, out UInt64 status);

Returns the RX channel status.

Note
The status bits are cleared after this function is called.
Parameters
[in]channelchannel handle
[out]statusstatus bits
Constant Description
MXF_RX_STATUS_WORD_LENGTH Data length error
MXF_RX_STATUS_OVERFLOW Module port FIFO overflow
MXF_RX_STATUS_GAP_LENGTH Gap error
MXF_RX_STATUS_STRING_ERROR String error. Received string has not been correctly decoded by the module and has been discarded.
MXF_RX_STATUS_OVERHEAT Module overheat
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfChannelTxStatusGet()
Examples:
ar429_periodic.c, canbus_periodic.c, and canbus_sampling.c.
uint32 mxfChannelTxStatusGet ( HMXF_CHANNEL  channel,
uint64 *  status 
)
C#
public static extern UInt32 mxfChannelTxStatusGet(UInt64 channel, out UInt64 status);

Returns the TX channel status.

Note
The status bits are cleared after this function is called.
Parameters
[in]channelchannel handle
[out]statusstatus bits
Constant Description
MXF_TX_STATUS_OVERLOAD Transmitter overload
MXF_TX_STATUS_TIMING_LOST Late data transmitted
MXF_TX_STATUS_OVERFLOW Module port FIFO overflow
MXF_TX_STATUS_OVERHEAT Transmitter has overheated and has been disabled. Transmitter temperature has gone over 105 °C (100 °C IPM-MULTI) and has been disabled. It will be automatically re-enabled when it's temperature will go below 95 °C (60 °C IPM-MULTI).
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfChannelRxStatusGet()
Examples:
ar429_periodic.c, canbus_periodic.c, and canbus_sampling.c.
uint32 mxfChannelTxPortEnableSet ( HMXF_CHANNEL  channel,
uint64  enable 
)
C#
public static extern UInt32 mxfChannelTxPortEnableSet(UInt64 channel, UInt64 enable);

Enables or disables the channel physical port. Set value to FALSE to disable the transmitter and to TRUE to enable it. When the transmitter is disabled, everything will work exactly the same as if it's enabled, but the data will not be sent. This function has no effect when internal loopback is enabled.

Note
This function is only available for TX channel of CSDB and ASYNC on IO-ASYNC-EH and IO-MULTI-EH.
Parameters
[in]channelchannel handle
[in]enablenew state for the channel
Constant Description
VMXF_ENABLE Enables TX channel
VMXF_DISABLE Disables TX channel
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfChannelTxPortEnableGet()
uint32 mxfChannelTxPortEnableGet ( HMXF_CHANNEL  channel,
uint64 *  enable 
)
C#
public static extern UInt32 mxfChannelTxPortEnableGet(UInt64 channel, out UInt64 enable);

Returns the channel physical port state.

Note
This function is only available for TX channel of CSDB and ASYNC on IO-ASYNC-EH and IO-MULTI-EH.
Parameters
[in]channelchannel handle
[out]enableport state
Constant Description
VMXF_ENABLE TX channel is enabled
VMXF_DISABLE TX channel is disabled
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfChannelTxPortEnableSet()
uint32 mxfChannelStatisticGet ( HMXF_HANDLE  handle,
uint64  type,
void *  stat 
)

Returns the statistics for the specified channel.

Parameters
[in]handlechannel or vl handle
[in]typestatistic type
Statistic type (MIL1553 Enhanced) Description
MXF_MIL1553_STAT_TYPE_TRANSACTION_GLOBAL Transaction statistics by message type and by bus
MXF_MIL1553_STAT_TYPE_TRANSACTION_GLOBAL_ALL_ADDRESS Transaction statistics by RT
MXF_MIL1553_STAT_TYPE_TRANSACTION_GLOBAL_ALL_SUBADDRESS Transaction statistics by subaddress for a RT
MXF_MIL1553_STAT_TYPE_TRANSACTION_DETAILS_SUBADDRESS Transaction statistics by message type and bus for a RT/subaddress
MXF_MIL1553_STAT_TYPE_ERROR_GLOBAL Error statistics by message type and by bus
MXF_MIL1553_STAT_TYPE_ERROR_GLOBAL_ALL_ADDRESS Error statistics by RT
MXF_MIL1553_STAT_TYPE_ERROR_GLOBAL_ALL_SUBADDRESS Error statistics by subaddress for a RT
MXF_MIL1553_STAT_TYPE_ERROR_DETAILS_SUBADDRESS Error statistics by message type and bus for a RT/subaddress
and
Statistic type (A664) Description
MXF_A664_STAT_TYPE_PORT_TX Transmit port (COM/SAP) statistics
MXF_A664_STAT_TYPE_PORT_RX Receive port (COM/SAP) statistics
MXF_A664_STAT_TYPE_VL_TX Virtual Link Transmit Statistics
MXF_A664_STAT_TYPE_VL_RX Virtual Link Receive Statistics
MXF_A664_STAT_TYPE_PORT_RX_MAC_REDUNDANCY Receive port (MAC layer) statistics
MXF_A664_STAT_TYPE_PORT_RX_EDE_REDUNDANCY Receive port (layer) EDE statistics
MXF_A664_STAT_TYPE_IP IP statistics
MXF_A664_STAT_TYPE_UDP UDP statistics
MXF_A664_STAT_TYPE_MAC_RX Receive MAC statistics
[out]statpointer to statistical structure returned
Statistic type (MIL1553 Enhanced) Structure to use
MXF_MIL1553_STAT_TYPE_TRANSACTION_GLOBAL MXF_MIL1553_STAT_TRANSACTION_GLOBAL
MXF_MIL1553_STAT_TYPE_TRANSACTION_GLOBAL_ALL_ADDRESS MXF_MIL1553_STAT_TRANSACTION_GLOBAL_ALL_ADDRESS
MXF_MIL1553_STAT_TYPE_TRANSACTION_GLOBAL_ALL_SUBADDRESS MXF_MIL1553_STAT_TRANSACTION_GLOBAL_ALL_SUBADDRESS
MXF_MIL1553_STAT_TYPE_TRANSACTION_DETAILS_SUBADDRESS MXF_MIL1553_STAT_TRANSACTION_DETAILS_SUBADDRESS
MXF_MIL1553_STAT_TYPE_ERROR_GLOBAL MXF_MIL1553_STAT_ERROR_GLOBAL
MXF_MIL1553_STAT_TYPE_ERROR_GLOBAL_ALL_ADDRESS MXF_MIL1553_STAT_ERROR_GLOBAL_ALL_ADDRESS
MXF_MIL1553_STAT_TYPE_ERROR_GLOBAL_ALL_SUBADDRESS MXF_MIL1553_STAT_ERROR_GLOBAL_ALL_SUBADDRESS
MXF_MIL1553_STAT_TYPE_ERROR_DETAILS_SUBADDRESS MXF_MIL1553_STAT_ERROR_DETAILS_SUBADDRESS
and
Statistic type (A664) Structure to use
MXF_A664_STAT_TYPE_PORT_TX MXF_A664_STAT_PORT_TX
MXF_A664_STAT_TYPE_PORT_RX MXF_A664_STAT_PORT_RX
MXF_A664_STAT_TYPE_VL_TX MXF_A664_STAT_VL_TX
MXF_A664_STAT_TYPE_VL_RX MXF_A664_STAT_VL_RX
MXF_A664_STAT_TYPE_PORT_RX_MAC_REDUNDANCY MXF_A664_STAT_VL_RX_MAC_REDUNDANCY
MXF_A664_STAT_TYPE_PORT_RX_EDE_REDUNDANCY MXF_A664_STAT_VL_RX_EDE_REDUNDANCY
MXF_A664_STAT_TYPE_IP MXF_A664_STAT_IP
MXF_A664_STAT_TYPE_UDP MXF_A664_STAT_UDP
MXF_A664_STAT_TYPE_MAC_RX MXF_A664_STAT_MAC_RX
Note
This function is only supported with the MIL-STD-1553 and ARINC 664 channel class.
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfChannelStatisticReset()
mxfChannelStatisticEnableSet()
mxfChannelStatisticEnableGet()
mxfMIL1553StatisticErrorGlobalGet()
mxfMIL1553StatisticErrorGlobalByAddressGet()
mxfMIL1553StatisticErrorGlobalBySubaddressGet()
mxfMIL1553StatisticErrorDetailsBySubaddressGet()
mxfMIL1553StatisticTransactionGlobalGet()
mxfMIL1553StatisticTransactionGlobalByAddressGet()
mxfMIL1553StatisticTransactionGlobalBySubaddressGet()
mxfMIL1553StatisticTransactionDetailsBySubaddressGet()
mxfA664StatisticPortTxGet()
mxfA664StatisticPortRxGet()
mxfA664StatisticVlTxGet()
mxfA664StatisticVlRxGet()
mxfA664StatisticVlRxMacRedundancyGet()
mxfA664StatisticVlRxEDERedundancyGet()
mxfA664StatisticIPGet()
mxfA664StatisticUDPGet()
mxfA664StatisticMacRxGet()
uint32 mxfChannelStatisticReset ( HMXF_HANDLE  handle,
uint64  options 
)
C#
public static extern UInt32 mxfChannelStatisticReset(UInt64 handle, UInt64 type, IntPtr stat);

Resets all statistical counters for the specified channel.

Note
Supported on MIL1553 Enhanced and A664 only.
Parameters
[in]handlechannel or vl handle
[in]optionsreserved for future. Must be set to 0.
Option Description
MXF_A664_RESET_STACK_LAYERS_STATS Reset IP and UDP statistics (A664 only)
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfChannelStatisticGet()
mxfChannelStatisticEnableSet()
mxfChannelStatisticEnableGet()
uint32 mxfChannelStatisticEnableSet ( HMXF_HANDLE  handle,
uint64  enable 
)
C#
public static extern UInt32 mxfChannelStatisticEnableSet(UInt64 handle, UInt64 enable);

Sets the statistics enable state for the specified channel.

Note
Supported on MIL1553 Enhanced and A664 only.
Parameters
[in]handlechannel or vl handle
[in]enablestate
Constant Description
VMXF_ENABLE Enables statistics
VMXF_DISABLE Disables statistics
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfChannelStatisticGet()
mxfChannelStatisticEnableGet()
mxfChannelStatisticReset()
Examples:
mil1553_bc_buserror_trigger.c, mil1553_bc_buserror_trigger.cs, mil1553_errors.c, and mil1553_errors.cs.
uint32 mxfChannelStatisticEnableGet ( HMXF_HANDLE  handle,
uint64 *  enable 
)
C#
public static extern UInt32 mxfChannelStatisticEnableGet(UInt64 handle, out UInt64 enable);

Gets the statistics enable state for the specified channel.

Note
Supported on MIL1553 Enhanced and A664 only.
Parameters
[in]handlechannel or vl handle
[out]enablepointer to the state variable
Constant Description
VMXF_ENABLE Statistics enabled
VMXF_DISABLE Statistics disabled
Returns
MAXT_SUCCESS
MAXT_ERROR_HANDLE
MAXT_ERROR_NULLPTR
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfChannelStatisticEnableSet()
mxfChannelStatisticGet()
mxfChannelStatisticReset()
uint32 mxfChannelDiscreteOutputTriggerEnableSet ( HMXF_CHANNEL  channel,
uint64  trigEvent,
uint64  enable,
uint64  discretePort 
)
C#
public static extern UInt32 mxfChannelDiscreteOutputTriggerEnableSet(UInt64 channel, UInt64 trigEvent, UInt64 enable, UInt64 discretePort);

Configures the discrete output trigger event.
This function is not supported for channels of IPM or FlexMAX modules.

Parameters
[in]channelchannel handle
[in]trigEventtrigger event
Channel Class Constant / Description
MIL-1553/EBR

MXF_MIL1553_DISCRETE_OUTPUT_TRIG_ON_BUSA_ERROR:

send a 500ns (50ns for EBR) discrete output pulse when bus error is detected on bus A

MXF_MIL1553_DISCRETE_OUTPUT_TRIG_ON_BUSB_ERROR:

send a 500ns (50ns for EBR) discrete output pulse when bus error is detected on bus B

MXF_MIL1553_DISCRETE_OUTPUT_TRIG_ON_BUSA_PROTOCOL_ERROR:

send a 500ns (50ns for EBR) discrete output pulse when protocol error is detected on bus A

MXF_MIL1553_DISCRETE_OUTPUT_TRIG_ON_BUSB_PROTOCOL_ERROR:

send a 500ns (50ns for EBR) discrete output pulse when protocol error is detected on bus B

ARINC 429

MXF_A429_DISCRETE_OUTPUT_TRIG_ON_TX:

generate a discrete output pulse for the duration of the ARINC 429 transmission (TX channel only).
Used with MXF_A429_TX_REC_CTRL_DISCRETE_OUTPUT_TRIG of MXF_A429_DATAREC.control.

MXF_A429_DISCRETE_OUTPUT_TRIG_ON_BUS_ERROR:

send a 100ns (50us on FlexMobile) discrete output pulse when bus error is detected (RX channel only)

ASYNC

MXF_ASYNCEH_DISCRETE_OUTPUT_TRIG_ON_TX:

generate a discrete output pulse for the duration of the ASYNC transmission (TX channel only).
Used with MXF_ASYNCEH_TX_REC_CTRL_DISCRETE_OUTPUT_TRIG of MXF_ASYNCEH_DATAREC.control.

MXF_ASYNCEH_DISCRETE_OUTPUT_TRIG_ON_BUS_ERROR:

send a 100ns discrete output pulse when bus error is detected (RX channel only)

CSDB

MXF_CSDB_DISCRETE_OUTPUT_TRIG_ON_TX:

generate a discrete output pulse for the duration of the CSDB transmission (TX channel only).
Used with MXF_CSDB_TX_REC_CTRL_DISCRETE_OUTPUT_TRIG of MXF_CSDB_DATAREC.control.

MXF_CSDB_DISCRETE_OUTPUT_TRIG_ON_BUS_ERROR:

send a 100ns discrete output pulse when bus error is detected (RX channel only)

ARINC 629

MXF_A629_DISCRETE_OUTPUT_TRIG_ON_TX:

generate a discrete output pulse for the duration of the ARINC 629 transmission (TX channel only)

MXF_A629_DISCRETE_OUTPUT_TRIG_ON_BUS_ERROR:

send a 100ns discrete output pulse when bus error is detected (RX channel only)

ARINC 708

MXF_A708_DISCRETE_OUTPUT_TRIG_ON_TX:

generate a discrete output pulse for the duration of the ARINC 708 transmission (TX channel only)

MXF_A708_DISCRETE_OUTPUT_TRIG_ON_BUS_ERROR:

send a 100ns discrete output pulse when bus error is detected (RX channel only)

ARINC 717
(MXF_MODULE_MULTI_EH only)

MXF_A717_DISCRETE_OUTPUT_TRIG_ON_TX:

generate a discrete output pulse for the duration of the ARINC 717 transmission (TX channel only).
Used with MXF_A717_TX_REC_CTRL_DISCRETE_OUTPUT_TRIG of MXF_A717_DATAREC.control.

HDLC
(MXF_MODULE_MULTI_EH only)

MXF_HDLC_DISCRETE_OUTPUT_TRIG_ON_TX:

generate a discrete output pulse for the duration of the HDLC transmission (TX channel only).
Used with MXF_HDLC_TX_REC_CTRL_DISCRETE_OUTPUT_TRIG of MXF_HDLC_DATAREC.control.

MXF_HDLC_DISCRETE_OUTPUT_TRIG_ON_BUS_ERROR:

send a 100ns discrete output pulse when bus error is detected (RX channel only)

CAN

MXF_CANBUS_DISCRETE_OUTPUT_TRIG_ON_TX:

generate a discrete output pulse for the duration of the CAN transmission

MXF_CANBUS_DISCRETE_OUTPUT_TRIG_ON_BUS_ERROR:

send a 100ns discrete output pulse when bus error is detected

[in]enableenable state
Constant Description
VMXF_ENABLE Enables discrete output trigger event
VMXF_DISABLE Disables discrete output trigger event
[in]discretePortDiscrete output pin to use (pin 0 to 7)
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfChannelDiscreteOutputTriggerEnableGet()
Examples:
async_tx_error_injection.c, async_tx_error_injection.cs, can_fd.c, canbus.c, canbus.cs, mil1553_bc_buserror_trigger.c, mil1553_bc_buserror_trigger.cs, mil1553_errors.c, and mil1553_errors.cs.
uint32 mxfChannelDiscreteOutputTriggerEnableGet ( HMXF_CHANNEL  channel,
uint64  trigEvent,
uint64 *  enable,
uint64 *  discretePort 
)
C#
public static extern UInt32 mxfChannelDiscreteOutputTriggerEnableGet(UInt64 channel, UInt64 trigEvent, out UInt64 enable, out UInt64 discretePort);

Gets the configuration of the discrete output trigger event. This function is not supported for channels of IPM or FlexMAX modules.

Parameters
[in]channelchannel handle
[in]trigEventtrigger event
Channel Class Constant / Description
MIL-1553/EBR

MXF_MIL1553_DISCRETE_OUTPUT_TRIG_ON_BUSA_ERROR:

send a 500ns (50ns for EBR) discrete output pulse when bus error is detected on bus A

MXF_MIL1553_DISCRETE_OUTPUT_TRIG_ON_BUSB_ERROR:

send a 500ns (50ns for EBR) discrete output pulse when bus error is detected on bus B

MXF_MIL1553_DISCRETE_OUTPUT_TRIG_ON_BUSA_PROTOCOL_ERROR:

send a 500ns (50ns for EBR) discrete output pulse when protocol error is detected on bus A

MXF_MIL1553_DISCRETE_OUTPUT_TRIG_ON_BUSB_PROTOCOL_ERROR:

send a 500ns (50ns for EBR) discrete output pulse when protocol error is detected on bus B

ARINC 429

MXF_A429_DISCRETE_OUTPUT_TRIG_ON_TX:

generate a discrete output pulse for the duration of the ARINC 429 transmission (TX channel only). Used with MXF_A429_TX_REC_CTRL_DISCRETE_OUTPUT_TRIG of MXF_A429_DATAREC.control.

MXF_A429_DISCRETE_OUTPUT_TRIG_ON_BUS_ERROR:

send a 100ns discrete output pulse when bus error is detected (RX channel only)

ASYNC

MXF_ASYNCEH_DISCRETE_OUTPUT_TRIG_ON_TX:

generate a discrete output pulse for the duration of the ASYNC transmission (TX channel only). Used with MXF_ASYNCEH_TX_REC_CTRL_DISCRETE_OUTPUT_TRIG of MXF_ASYNCEH_DATAREC.control.

MXF_ASYNCEH_DISCRETE_OUTPUT_TRIG_ON_BUS_ERROR:

send a 100ns discrete output pulse when bus error is detected (RX channel only)

CSDB

MXF_CSDB_DISCRETE_OUTPUT_TRIG_ON_TX:

generate a discrete output pulse for the duration of the CSDB transmission (TX channel only). Used with MXF_CSDB_TX_REC_CTRL_DISCRETE_OUTPUT_TRIG of MXF_CSDB_DATAREC.control.

MXF_CSDB_DISCRETE_OUTPUT_TRIG_ON_BUS_ERROR:

send a 100ns discrete output pulse when bus error is detected (RX channel only)

ARINC 629

MXF_A629_DISCRETE_OUTPUT_TRIG_ON_TX:

generate a discrete output pulse for the duration of the ARINC 629 transmission (TX channel only)

MXF_A629_DISCRETE_OUTPUT_TRIG_ON_BUS_ERROR:

send a 100ns discrete output pulse when bus error is detected (RX channel only)

ARINC 708

MXF_A708_DISCRETE_OUTPUT_TRIG_ON_TX:

generate a discrete output pulse for the duration of the ARINC 708 transmission (TX channel only)

MXF_A708_DISCRETE_OUTPUT_TRIG_ON_BUS_ERROR:

send a 100ns discrete output pulse when bus error is detected (RX channel only)

ARINC 717
(MXF_MODULE_MULTI_EH only)

MXF_A717_DISCRETE_OUTPUT_TRIG_ON_TX:

generate a discrete output pulse for the duration of the ARINC 717 transmission (TX channel only). Used with MXF_A717_TX_REC_CTRL_DISCRETE_OUTPUT_TRIG of MXF_A717_DATAREC.control.

HDLC
(MXF_MODULE_MULTI_EH only)

MXF_HDLC_DISCRETE_OUTPUT_TRIG_ON_TX:

generate a discrete output pulse for the duration of the HDLC transmission (TX channel only). Used with MXF_HDLC_TX_REC_CTRL_DISCRETE_OUTPUT_TRIG of MXF_HDLC_DATAREC.control

MXF_HDLC_DISCRETE_OUTPUT_TRIG_ON_BUS_ERROR:

send a 100ns discrete output pulse when bus error is detected (RX channel only)

CAN

MXF_CANBUS_DISCRETE_OUTPUT_TRIG_ON_TX:

generate a discrete output pulse for the duration of the CAN transmission

MXF_CANBUS_DISCRETE_OUTPUT_TRIG_ON_BUS_ERROR:

send a 100ns discrete output pulse when bus error is detected

[out]enableenable state
Constant Description
VMXF_ENABLE Discrete output trigger event enabled
VMXF_DISABLE Discrete output trigger event disabled
[out]discretePortDiscrete output pin that is used
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfChannelDiscreteOutputTriggerEnableSet()
uint32 mxfChannelClassSet ( HMXF_CHANNEL  channelHandle,
uint64  chnClassID 
)
C#
public static extern UInt32 mxfChannelClassSet(UInt64 channelHandle, UInt64 chnClassID);

Sets the channel class for the specified channel.

Note
Supported only on multi-protocol channel.
Parameters
[in]channelHandlechannel handle
[in]chnClassIDchannel class to set
Constant Description
MXF_CLASS_A429 ARINC 429 channel
MXF_CLASS_DISCRETE Discrete channel
MXF_CLASS_ASYNC_ENHANCED ASYNC-EH channel
MXF_CLASS_CSDB CSDB channel
MXF_CLASS_A717 ARINC 717 channel
MXF_CLASS_HDLC HDLC channel
MXF_CLASS_CLOCK CLOCK channel
MXF_CLASS_PULSE PULSE channel
MXF_CLASS_HANDSHAKE Handshake channel
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.5.2 and later.
See also
mxfChannelClassGet()
mxfChannelClassListGet()
uint32 mxfChannelClassGet ( HMXF_CHANNEL  channelHandle,
uint64 *  chnClassID 
)
C#
public static extern UInt32 mxfChannelClassGet(UInt64 channelHandle, out UInt64 chnClassID);

Gets the current channel class for the specified channel.

Parameters
[in]channelHandlechannel handle
[out]chnClassIDpointer to the channel class variable
Constant Description
MXF_CLASS_A429 ARINC 429 channel
MXF_CLASS_CSDB CSDB channel
MXF_CLASS_ANALOG Analog channel
MXF_CLASS_DISCRETE Discrete channel
MXF_CLASS_A629 ARINC 629 channel
MXF_CLASS_ASCB ASCB channel
MXF_CLASS_MIL1553 MIL-1553 channel
MXF_CLASS_A717 ARINC 717 channel
MXF_CLASS_A708 ARINC 708 channel
MXF_CLASS_PULSE PULSE channel
MXF_CLASS_HDLC HDLC channel
MXF_CLASS_CLOCK CLOCK channel
MXF_CLASS_HFCE HFCE channel
MXF_CLASS_HANDSHAKE Handshake channel
MXF_CLASS_A664 ARINC 664 channel
MXF_CLASS_ASYNC_ENHANCED ASYNC-EH channel
MXF_CLASS_CANBUS CAN bus channel
MXF_CLASS_FLEXDIO Flex DIO channel
MXF_CLASS_FLEXANALOG Flex Analog channel
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.5.2 and later.
See also
mxfChannelClassSet()
mxfChannelClassListGet()
uint32 mxfChannelClassListGet ( HMXF_CHANNEL  channelHandle,
uint64  maxCount,
uint64 *  count,
uint64  chnClassIDList[] 
)
C#
public static extern UInt32 mxfChannelClassListGet(UInt64 channelHandle, UInt64 maxCount, out UInt64 count, [Out] UInt64[] chnClassIDList);

Gets the list of available channel class for the specified channel.

Parameters
[in]channelHandlechannel handle
[in]maxCountmaximum count of channel class to be returned in chnClassIDList
[out]countactual count of channel class to be returned chnClassIDList
[out]chnClassIDListpointer to the channel class array variable
Constant Description
MXF_CLASS_A429 ARINC 429 channel
MXF_CLASS_CSDB CSDB channel
MXF_CLASS_ANALOG Analog channel
MXF_CLASS_DISCRETE Discrete channel
MXF_CLASS_A629 ARINC 629 channel
MXF_CLASS_ASCB ASCB channel
MXF_CLASS_MIL1553 MIL-1553 channel
MXF_CLASS_A717 ARINC 717 channel
MXF_CLASS_A708 ARINC 708 channel
MXF_CLASS_PULSE PULSE channel
MXF_CLASS_HDLC HDLC channel
MXF_CLASS_CLOCK CLOCK channel
MXF_CLASS_HFCE HFCE channel
MXF_CLASS_HANDSHAKE Handshake channel
MXF_CLASS_A664 ARINC 664 channel
MXF_CLASS_ASYNC_ENHANCED ASYNC-EH channel
MXF_CLASS_CANBUS CAN bus channel
MXF_CLASS_FLEXDIO Flex DIO channel
MXF_CLASS_FLEXANALOG Flex Analog channel
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.5.2 and later.
See also
mxfChannelClassSet()
mxfChannelClassGet()
Updated 03/30/2022