MX Foundation 4
Functions
Major Frame Scheduling
Multiprotocol Functions Reference » Transmit Data » Periodic Transmit and Updating

Functions

uint32 mxfTxPeriodicMajorFrameSet (HMXF_CHANNEL channel, uint64 majorIndex, uint64 minorIndex, uint64 count, void *msg, void *properties)
 
uint32 mxfTxPeriodicMajorFrameGet (HMXF_CHANNEL channel, uint64 majorIndex, uint64 minorIndex, uint64 maxCount, uint64 *count, void *msg, void *properties)
 
uint32 mxfTxPeriodicMajorFrameMinorCountGet (HMXF_CHANNEL channel, uint64 majorIndex, uint64 *count)
 
uint32 mxfTxPeriodicMajorFrameStart (HMXF_CHANNEL channel, uint64 majorIndex, uint64 duration, void *properties)
 
uint32 mxfTxPeriodicMajorFrameStop (HMXF_CHANNEL channel, uint64 majorIndex, uint64 stopTime)
 
uint32 mxfTxPeriodicMajorFrameClear (HMXF_CHANNEL channel, uint64 majorIndex)
 
uint32 mxfTxPeriodicMajorFrameStatusGet (HMXF_CHANNEL channel, uint64 majorIndex, uint64 *status)
 

Detailed Description

Function Documentation

uint32 mxfTxPeriodicMajorFrameSet ( HMXF_CHANNEL  channel,
uint64  majorIndex,
uint64  minorIndex,
uint64  count,
void *  msg,
void *  properties 
)

Sets the specified minor frame to the major frame by passing an array of structure of messages.

This function is used before enabling the transmission of the schedule for configuring each minor frame of the major frame.

Parameters
[in]channelchannel handle.
[in]majorIndexmajor frame index. Reserved for future use. Must be set to 0.
[in]minorIndexminor frame index.
[in]countcount of messages in the minor frame.
[in]msgminor frame message structure pointer.
Protocol Structure
MIL-STD-1553 MXF_MIL1553_TXPERIODIC_MJRFRAME_MSG
ARINC 629 MXF_A629_TXPERIODIC_MJRFRAME_MSG
[in]propertiesminor frame properties pointer (optional, MIL-STD-1553 only). MXF_MIL1553_TXPERIODIC_MJRFRAME_MINOR_PROPERTIES for MIL-STD-1553. Pass NULL to ignore this parameter, the default minor frame properties will apply. Default minor frame properties for MIL-STD-1553 are a repeat count and modulo of 1, duration specify by duration parameter of mxfTxPeriodicMajorFrameStart() and no options (branch to the next minor frame or loop to the first for the last minor frame).
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
mxfTxPeriodicMajorFrameStart()
mxfTxPeriodicMajorFrameGet()
mxfMIL1553TxPeriodicMajorFrameSet()
mxfA629TxPeriodicMajorFrameSet()
uint32 mxfTxPeriodicMajorFrameGet ( HMXF_CHANNEL  channel,
uint64  majorIndex,
uint64  minorIndex,
uint64  maxCount,
uint64 *  count,
void *  msg,
void *  properties 
)

Reads the specified minor frame of the major frame.

Parameters
[in]channelchannel handle.
[in]majorIndexmajor frame index. Reserved for future use. Must be set to 0.
[in]minorIndexminor frame index.
[in]maxCountmaximum messages to read within the minor frame.
[out]countreturned messages count.
[out]msgminor frame messages pointer.
[out]propertiespointer to returned properties (optional, MIL-STD-1553 only). MXF_MIL1553_TXPERIODIC_MJRFRAME_MINOR_PROPERTIES for MIL-STD-1553. 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
mxfTxPeriodicMajorFrameSet()
mxfMIL1553TxPeriodicMajorFrameGet()
mxfA629TxPeriodicMajorFrameGet()
uint32 mxfTxPeriodicMajorFrameMinorCountGet ( HMXF_CHANNEL  channel,
uint64  majorIndex,
uint64 *  count 
)
C#
public static extern UInt32 mxfTxPeriodicMajorFrameMinorCountGet(UInt64 channel, UInt64 majorIndex, out UInt64 count);

Returns the minor frame count of a major frame.

Parameters
[in]channelchannel handle.
[in]majorIndexmajor frame index. Reserved for future use. Must be set to 0.
[out]countminor frame count.
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
mxfTxPeriodicMajorFrameSet()
uint32 mxfTxPeriodicMajorFrameStart ( HMXF_CHANNEL  channel,
uint64  majorIndex,
uint64  duration,
void *  properties 
)

Starts the major frame.

If the major frame contains frame errors, erroneous frames are ignored and other frames are started.

The data of the major frame must be initialized using mxfTxPeriodicUpdateMsgWrite().

Parameters
[in]channelchannel handle.
[in]majorIndexmajor frame index. Reserved for future use. Must be set to 0.
[in]durationMIL-STD-1553: default minor frame duration. Minor frame duration can be overridden by each minor frame.
Protocol Range Step
MIL-STD-1553 50 to 26214375 μsec for IPM-1553 Enhanced BC channel (rev 1.0.1 or later).
50 to 6553575 μsec for IPM-1553 Enhanced BC channel (rev 1.0.0). 		25 μsec
ARINC 629 0 0

Example: Major frame with 2 minor frames (minor frame duration = 25000).
  • Minor frame #0 will be sent with a rate of 50 msec.
  • Minor frame #1 will be sent with a rate of 50 msec.

When using ARINC 629, this parameter needs to be 0, as in ARINC 629, the Transmit Interval is used, not the duration parameter.

Parameters
[in]propertiesoptional properties. Pass NULL to use default major frame properties or address of a structure to override default properties.
Protocol Structure Note
MIL-STD-1553 MXF_MIL1553_TXPERIODIC_MJRFRAME_PROPERTIES If no major frame properties is used, default mode uses a first minor index of 0, no start time, no stop time and no options.
ARINC 629 MXF_A629_TXPERIODIC_MJRFRAME_PROPERTIES If no major frame properties is used, default mode is block mode.
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
mxfModuleChannelAllGet()
mxfTxPeriodicMajorFrameStop()
mxfTxPeriodicUpdateMsgWrite()
mxfMIL1553TxPeriodicMajorFrameStart()
mxfA629TxPeriodicMajorFrameStart()
Examples:
ascb_bc.c, mil1553_bc_dual_major_frame.c, mil1553_bc_extclock.c, mil1553_cond_branch_1.c, mil1553_cond_branch_2.c, mil1553_ebr.c, mil1553_errors.c, mil1553_manyErrorInjections.c, and mil1553_rtErrorInjections.c.
uint32 mxfTxPeriodicMajorFrameStop ( HMXF_CHANNEL  channel,
uint64  majorIndex,
uint64  stopTime 
)
C#
public static extern UInt32 mxfTxPeriodicMajorFrameStop(UInt64 channel, UInt64 majorIndex, UInt64 stopTime);

Stops the major frame.

Parameters
[in]channelchannel handle.
[in]majorIndexmajor frame index. Reserved for future use. Must be set to 0.
[in]stopTimestop time in timebase. 0 if no stop time is used. In consequence, always use 0 for ARINC 629.
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
mxfTxPeriodicMajorFrameStart()
mxfSystemTimeBaseSet()
Examples:
ar629_alternate.c, ar629_alternate.cs, ar629_aperiodic_frame.c, ar629_aperiodic_frame.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_freshnessCounter_manyCID.c, ar629_freshnessCounter_manyCID.cs, ar629_independent_mode.c, ar629_independent_mode.cs, ar629_updating_data_sampling.c, ar629_updating_data_sampling.cs, ascb_bc.c, 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_bc_extclock.c, mil1553_bc_extclock.cs, mil1553_bc_rt_data_assignment.c, mil1553_bc_rt_data_assignment.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_embedded_async_to_1553.c, mil1553_embedded_update_embedded.c, mil1553_errors.c, mil1553_errors.cs, mil1553_manyErrorInjections.c, mil1553_manyErrorInjections.cs, mil1553_rtErrorInjections.c, mil1553_rtErrorInjections.cs, multi.c, and multi.cs.
uint32 mxfTxPeriodicMajorFrameClear ( HMXF_CHANNEL  channel,
uint64  majorIndex 
)
C#
public static extern UInt32 mxfTxPeriodicMajorFrameClear(UInt64 channel, UInt64 majorIndex);

Clears the major frame.

Parameters
[in]channelchannel handle.
[in]majorIndexmajor frame index. Reserved for future use. Must be set to 0.
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
mxfTxPeriodicMajorFrameStart()
mxfTxPeriodicMajorFrameStop()
mxfTxPeriodicMajorFrameSet()
Examples:
ar629_alternate.c, ar629_alternate.cs, ar629_aperiodic_frame.c, ar629_aperiodic_frame.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_freshnessCounter_manyCID.c, ar629_freshnessCounter_manyCID.cs, ar629_independent_mode.c, ar629_independent_mode.cs, ar629_updating_data_sampling.c, ar629_updating_data_sampling.cs, ascb_bc.c, 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_extclock.c, mil1553_bc_extclock.cs, mil1553_bc_rt_data_assignment.c, mil1553_bc_rt_data_assignment.cs, mil1553_embedded_async_to_1553.c, and mil1553_embedded_update_embedded.c.
uint32 mxfTxPeriodicMajorFrameStatusGet ( HMXF_CHANNEL  channel,
uint64  majorIndex,
uint64 *  status 
)
C#
public static extern UInt32 mxfTxPeriodicMajorFrameStatusGet(UInt64 channel, UInt64 majorIndex, out UInt64 status);

Returns the current major frame status.

Parameters
[in]channelchannel handle.
[in]majorIndexmajor frame index. Reserved for future use. Must be set to 0.
[out]statusreturned status.
Status Major frame status
MXF_TXPERIODIC_MJRFRAME_STATUS_STARTED The major frame is started.
MXF_TXPERIODIC_MJRFRAME_STATUS_STOPPED The major frame is stopped.
MXF_TXPERIODIC_MJRFRAME_STATUS_HALTED The major frame is stopped after an halt condition was detected.
MXF_TXPERIODIC_MJRFRAME_STATUS_OVERLOAD An overload condition was detected (MIL1553).
MXF_TXPERIODIC_MJRFRAME_STATUS_SIM_ERROR The major frame is stopped after a SIM error (A629).
MXF_TXPERIODIC_MJRFRAME_STATUS_BUS_QUIET A bus quiet condition has been detected (A629).
MXF_TXPERIODIC_MJRFRAME_STATUS_TX_OVERFLOW The major frame is stopped after a TX overflow (A629).
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
mxfTxPeriodicMajorFrameStart()
mxfTxPeriodicMajorFrameStop()
Updated 10/23/2023