MX Foundation 4

Functions

uint32 mxfSystemDeviceCountGet (HMXF_SERVER server, uint64 type, uint64 *count)
 
uint32 mxfSystemDeviceGet (HMXF_SERVER server, uint64 index, HMXF_DEVICE *device)
 
uint32 mxfSystemDeviceAllGet (HMXF_SERVER server, uint64 type, uint64 maxCount, uint64 *count, HMXF_DEVICE *devices)
 

Detailed Description

Function Documentation

uint32 mxfSystemDeviceCountGet ( HMXF_SERVER  server,
uint64  type,
uint64 *  count 
)
C#
public static extern UInt32 mxfSystemDeviceCountGet(UInt64 server, UInt64 type, out UInt64 count);

Returns the number of devices detected by MX Foundation. This function can be called before the initialization of MX Foundation.

Parameters
[in]serverserver handle.
[in]typedevice type.
Constant Description
MXF_DEVICE_ALL Used to specify any devices.
MXF_DEVICE_FLEX1553_PCIE Flex1553-PCIe
MXF_DEVICE_FLEXMULTI_1553 FlexMulti 1553
MXF_DEVICE_FLEXMULTI_629 FlexMulti 629
MXF_DEVICE_FLEXMULTI_664 FlexMulti 664
MXF_DEVICE_FLEXMULTI_429 FlexMulti 429
MXF_DEVICE_FLEXMULTI FlexMulti
MXF_DEVICE_PCIE502 PCIe 502 carrier
MXF_DEVICE_PXIE500 PXIe 500 carrier
MXF_DEVICE_FMOB429_PLUS FlexMobile 429+
MXF_DEVICE_PMC429 MAXPMC 429
MXF_DEVICE_XMC429 MAXXMC 429
MXF_DEVICE_FLEXMAX FlexMAX
[out]countnumber of devices detected.
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
mxfSystemDeviceGet()
mxfSystemDeviceAllGet()
uint32 mxfSystemDeviceGet ( HMXF_SERVER  server,
uint64  index,
HMXF_DEVICE *  device 
)
C#
public static extern UInt32 mxfSystemDeviceGet(UInt64 server, UInt64 index, out UInt64 device);

Returns the device handle for the specified index. This function can be called before the initialization of MX Foundation.

This function can be called from within the initialization callback handler, along with mxfDeviceInfoGet().

Parameters
[in]serverserver handle
[in]indexlogical device index (e.g., 0=device 0, 1=device 1, ...)
[out]devicedevice handle
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
mxfSystemDeviceCountGet()
mxfSystemDeviceAllGet()
mxfDeviceInfoGet()
Examples:
adc_buffer_threshold.c, ar429_aperiodic.c, ar429_aperiodic.cs, ar429_buffer_threshold.c, ar429_buffer_threshold.cs, ar429_embedded_bridge.c, ar429_embedded_bridge.cs, ar429_embedded_comm_queues.c, 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, ar429_rx_sampling.c, ar429_rx_sampling.cs, ar629_alternate.c, ar629_alternate.cs, ar629_aperiodic_frame.c, ar629_aperiodic_frame.cs, ar629_aperiodic_mode.c, ar629_aperiodic_mode.cs, ar629_block_mode.c, ar629_block_mode.cs, ar629_dual_xpp.c, ar629_dual_xpp.cs, ar629_error_injection_detection.c, ar629_error_injection_detection.cs, ar629_independent_mode.c, ar629_independent_mode.cs, ar629_updating_data_sampling.c, ar629_updating_data_sampling.cs, ar664_aperiodicSap.c, ar664_aperiodicSap.cs, ar664_com_queuing_basic.c, ar664_com_queuing_basic.cs, ar664_end_system.c, ar664_end_system.cs, ar664_error_injection_detection.c, ar664_error_injection_detection.cs, ar664_error_injection_detection_ede.c, ar664_error_injection_detection_ede.cs, ar664_playback.c, ar664_playback.cs, ar664_raw_rx.c, ar664_raw_rx.cs, ar664_recorder.c, ar664_recorder.cs, ar664_sampling.c, ar664_sampling.cs, ar708.c, ar708.cs, ar708_aperiodic.c, ar708_aperiodic.cs, ar708_buffer_threshold.c, ar708_buffer_threshold.cs, ar708_event_handler.c, ar708_event_handler.cs, ar708_periodic.c, ar708_periodic.cs, ar708_sampling.c, ar708_sampling.cs, ar708_trigger.c, ar708_trigger.cs, ar708_tx_error_injection.c, ar708_tx_error_injection.cs, ar717.c, ar717.cs, ar717_advance.c, ar717_advance.cs, ar717_bridge_from_ar429.c, ar717_bridge_from_ar429.cs, ar717_buffer_threshold.c, ar717_buffer_threshold.cs, ar717_embedded_recorder.c, ar717_embedded_recorder.cs, ar717_rx_acquisition_trigger.c, ar717_rx_acquisition_trigger.cs, async.c, async.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.cs, async_tx_error_injection.c, async_tx_error_injection.cs, can_fd.c, canbus.c, canbus.cs, canbus_periodic.c, canbus_sampling.c, csdb_aperiodic.c, csdb_aperiodic.cs, csdb_buffer_threshold.c, csdb_buffer_threshold.cs, csdb_periodic.c, csdb_periodic.cs, csdb_rx_acquisition_trigger.c, csdb_rx_acquisition_trigger.cs, csdb_rx_event_handler.c, csdb_rx_event_handler.cs, csdb_rx_sampling.c, csdb_rx_sampling.cs, dac_buffer_threshold.c, device_info.c, device_info.cs, discrete_Multi.c, discrete_Multi.cs, discrete_pulse_clock.c, discrete_pulse_clock.cs, flexadc_buffer_threshold.c, flexdac_buffer_threshold.c, hdlc.c, hdlc.cs, hdlc_aperiodic.c, hdlc_aperiodic.cs, hdlc_buffer_threshold.c, hdlc_buffer_threshold.cs, hdlc_trigger.c, hdlc_trigger.cs, hdlc_tx_error_injection.c, hdlc_tx_error_injection.cs, irigb_1pps.c, irigb_1pps.cs, mil1553_bc_extclock.c, mil1553_bc_extclock.cs, mil1553_bc_rt_data_assignment.c, mil1553_bc_rt_data_assignment.cs, mil1553_embedded_async_to_1553.c, mil1553_embedded_async_to_1553.cs, mil1553_embedded_update_embedded.c, mil1553_embedded_update_host.c, mil1553_embedded_update_host.cs, multi.c, multi.cs, pulse.c, selfTests.c, selfTests.cs, usb.c, usb.cs, write_read_async.c, and write_read_async.cs.
uint32 mxfSystemDeviceAllGet ( HMXF_SERVER  server,
uint64  type,
uint64  maxCount,
uint64 *  count,
HMXF_DEVICE *  devices 
)
C#
public static extern UInt32 mxfSystemDeviceAllGet(UInt64 server, UInt64 type, UInt64 maxCount, out UInt64 count, [Out] UInt64[] devices);

Returns the handle(s) of all devices specified by type for the server. This function can be called before the initialization of MX Foundation.

Parameters
[in]serverserver handle
[in]typedevice type
Constant Description
MXF_DEVICE_ALL Used to specify any devices.
MXF_DEVICE_FLEX1553_PCIE Flex1553-PCIe
MXF_DEVICE_FLEXMULTI_1553 FlexMulti 1553
MXF_DEVICE_FLEXMULTI_629 FlexMulti 629
MXF_DEVICE_FLEXMULTI_664 FlexMulti 664
MXF_DEVICE_FLEXMULTI_429 FlexMulti 429
MXF_DEVICE_FLEXMULTI FlexMulti
MXF_DEVICE_PCIE502 PCIe 502 carrier
MXF_DEVICE_PXIE500 PXIe 500 carrier
MXF_DEVICE_FMOB429_PLUS FlexMobile 429+
MXF_DEVICE_PMC429 MAXPMC 429
MXF_DEVICE_XMC429 MAXXMC 429
MXF_DEVICE_FLEXMAX FlexMAX
[in]maxCountmaximum number of device handles that can be returned in devices array
[out]countnumber of device handles returned
[out]devicesarray of devices handles
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
mxfSystemDeviceGet()
mxfSystemDeviceCountGet()
Examples:
ar429_comm_queues.c, ar429_comm_queues.cs, ar429_embedded_recorder.c, ar429_embedded_recorder.cs, ar717_bridge_from_ar429.c, ar717_bridge_from_ar429.cs, discrete.c, discrete.cs, flexdac.c, flexdio.c, mil1553_aperiodic.c, mil1553_aperiodic.cs, mil1553_aperiodic_event.c, mil1553_aperiodic_event.cs, mil1553_aperiodic_frame.c, mil1553_aperiodic_frame.cs, mil1553_bc.c, mil1553_bc.cs, mil1553_bc_buserror_trigger.c, mil1553_bc_buserror_trigger.cs, mil1553_bc_dual_major_frame.c, mil1553_bc_dual_major_frame.cs, mil1553_bm.c, mil1553_bm.cs, mil1553_cond_branch_1.c, mil1553_cond_branch_1.cs, mil1553_cond_branch_2.c, mil1553_cond_branch_2.cs, mil1553_ebr.c, mil1553_ebr.cs, mil1553_errors.c, mil1553_errors.cs, mil1553_manyErrorInjections.c, mil1553_manyErrorInjections.cs, mil1553_rt.c, mil1553_rt.cs, mil1553_rtErrorInjections.c, mil1553_rtErrorInjections.cs, multi.c, and multi.cs.
Updated 03/30/2022