MX Foundation 4
|
Functions | |
uint32 | mxfMIL1553ErrorInjectionCompose (uint64 id, uint64 param, uint16 *error) |
uint32 | mxfMIL1553ErrorInjectionSet (HMXF_CHANNEL channel, uint64 errorIndex, MXF_MIL1553_ERROR_INJ *error) |
uint32 | mxfMIL1553ErrorInjectionGet (HMXF_CHANNEL channel, uint64 errorIndex, MXF_MIL1553_ERROR_INJ *error) |
uint32 | mxfMIL1553ErrorInjectionCountGet (HMXF_CHANNEL channel, uint64 *errorCount) |
uint32 | mxfMIL1553CommandCompose (uint64 address, uint64 subAddress, uint64 dir, uint64 wordCount, uint16 *command) |
uint32 | mxfMIL1553CommandDecompose (uint16 command, uint64 *address, uint64 *subAddress, uint64 *dir, uint64 *wordCount) |
uint32 | mxfMIL1553ConditionalBranchCompose (uint64 option, uint64 wordIndex, uint16 *condition) |
uint32 | mxfMIL1553ConditionalBranchOnDiscreteCompose (uint64 option, uint16 *condition) |
uint32 | mxfMIL1553TxAperiodicWrite (HMXF_BUFFER buffer, uint64 options, uint64 startTime, uint64 count, MXF_MIL1553_DATAREC *rec) |
uint32 | mxfMIL1553TxPeriodicMajorFrameStart (HMXF_CHANNEL channel, uint64 majorIndex, uint64 duration, MXF_MIL1553_TXPERIODIC_MJRFRAME_PROPERTIES *properties) |
uint32 | mxfMIL1553TxPeriodicMajorFrameSet (HMXF_CHANNEL channel, uint64 majorIndex, uint64 minorIndex, uint64 count, MXF_MIL1553_TXPERIODIC_MJRFRAME_MSG *msg, MXF_MIL1553_TXPERIODIC_MJRFRAME_MINOR_PROPERTIES *properties) |
uint32 | mxfMIL1553TxPeriodicMajorFrameGet (HMXF_CHANNEL channel, uint64 majorIndex, uint64 minorIndex, uint64 maxCount, uint64 *count, MXF_MIL1553_TXPERIODIC_MJRFRAME_MSG *msg, MXF_MIL1553_TXPERIODIC_MJRFRAME_MINOR_PROPERTIES *properties) |
uint32 | mxfMIL1553TxPeriodicUpdateMsgWrite (HMXF_BUFFER buffer, uint64 count, MXF_MIL1553_DATAREC *rec) |
uint32 | mxfMIL1553RxAcqMsgSelectGet (HMXF_BUFFER buffer, uint64 maxCount, uint64 *count, MXF_MSGID_MIL1553 *msg) |
uint32 | mxfMIL1553RxAcqMsgSelectSet (HMXF_BUFFER buffer, uint64 select, uint64 maxcount, MXF_MSGID_MIL1553 *msg) |
uint32 | mxfMIL1553RxAcqRead (HMXF_BUFFER buffer, uint64 maxRecCount, uint64 maxBytesCount, uint64 *status, uint64 *recCount, uint64 *bytesCount, MXF_MIL1553_DATAREC *rec) |
uint32 | mxfMIL1553RxSamplingExtEnableSet (HMXF_BUFFER buffer, uint64 state, uint64 count, uint64 *address) |
uint32 | mxfMIL1553RxSamplingExtEnableAllGet (HMXF_BUFFER buffer, uint64 maxCount, uint64 *count, uint64 *address) |
uint32 | mxfMIL1553RxSamplingMsgSelectSet (HMXF_BUFFER buffer, uint64 select, uint64 maxcount, MXF_MSGID_MIL1553 *msg) |
uint32 | mxfMIL1553RxSamplingMsgSelectGet (HMXF_BUFFER buffer, uint64 maxCount, uint64 *count, MXF_MSGID_MIL1553 *msg) |
uint32 | mxfMIL1553RxSamplingRead (HMXF_BUFFER buffer, uint64 flags, uint64 maxRecCount, uint64 maxBytesCount, uint64 *recCount, uint64 *byteCount, MXF_MIL1553_SAMPREC *rec) |
uint32 | mxfMIL1553RxSamplingSingleRead (HMXF_BUFFER buffer, uint64 flags, uint64 type, uint64 address, uint64 subaddress, MXF_MIL1553_SAMPREC *rec) |
uint64 | mxfMIL1553AsyncEventRxMsgSelectSet (HMXF_ASYNCEVENT asyncEvent, HMXF_CHANNEL channel, uint64 select, uint64 count, MXF_MSGID_MIL1553 *msg) |
uint32 | mxfMIL1553AsyncEventRxMsgSelectGet (HMXF_ASYNCEVENT asyncEvent, HMXF_CHANNEL channel, uint64 maxCount, uint64 *count, MXF_MSGID_MIL1553 *msg) |
uint32 | mxfMIL1553StatisticErrorGlobalGet (HMXF_CHANNEL channel, MXF_MIL1553_STAT_ERROR_GLOBAL *stats) |
uint32 | mxfMIL1553StatisticErrorGlobalByAddressGet (HMXF_CHANNEL channel, MXF_MIL1553_STAT_ERROR_GLOBAL_ALL_ADDRESS *stats) |
uint32 | mxfMIL1553StatisticErrorGlobalBySubaddressGet (HMXF_CHANNEL channel, MXF_MIL1553_STAT_ERROR_GLOBAL_ALL_SUBADDRESS *stats) |
uint32 | mxfMIL1553StatisticErrorDetailsBySubaddressGet (HMXF_CHANNEL channel, MXF_MIL1553_STAT_ERROR_DETAILS_SUBADDRESS *stats) |
uint32 | mxfMIL1553StatisticTransactionGlobalGet (HMXF_CHANNEL channel, MXF_MIL1553_STAT_TRANSACTION_GLOBAL *stats) |
uint32 | mxfMIL1553StatisticTransactionGlobalByAddressGet (HMXF_CHANNEL channel, MXF_MIL1553_STAT_TRANSACTION_GLOBAL_ALL_ADDRESS *stats) |
uint32 | mxfMIL1553StatisticTransactionGlobalBySubaddressGet (HMXF_CHANNEL channel, MXF_MIL1553_STAT_TRANSACTION_GLOBAL_ALL_SUBADDRESS *stats) |
uint32 | mxfMIL1553StatisticTransactionDetailsBySubaddressGet (HMXF_CHANNEL channel, MXF_MIL1553_STAT_TRANSACTION_DETAILS_SUBADDRESS *stats) |
uint32 | mxfMIL1553NextDataRecordPtrGet (MXF_MIL1553_DATAREC *currentRec, MXF_MIL1553_DATAREC **nextRec) |
uint32 | mxfMIL1553NextSamplingRecordPtrGet (MXF_MIL1553_SAMPREC *currentRec, MXF_MIL1553_SAMPREC **nextRec) |
uint32 | mxfMIL1553DataRecordDecompose (HMXF_CHANNEL channel, uint64 count, MXF_MIL1553_DATAREC *data, MXF_MIL1553_MSGINFO *msginfo) |
uint32 | mxfMIL1553SamplingRecordDecompose (HMXF_CHANNEL channel, uint64 count, MXF_MIL1553_SAMPREC *data, MXF_MIL1553_MSGINFO *msginfo) |
uint32 | mxfMIL1553MsgChecksumEnableSet (HMXF_CHANNEL channel, uint64 type, uint64 address, uint64 subaddress, uint64 value) |
uint32 | mxfMIL1553MsgChecksumEnableGet (HMXF_CHANNEL channel, uint64 type, uint64 address, uint64 subaddress, uint64 *value) |
uint32 | mxfMIL1553RtSubsystemEnableSet (HMXF_CHANNEL channel, uint64 type, uint64 subaddress, uint64 bus, HMXF_BUFFER buffer) |
uint32 | mxfMIL1553RtSubsystemEnableGet (HMXF_CHANNEL channel, uint64 type, uint64 subaddress, uint64 *bus, HMXF_BUFFER *buffer) |
uint32 | mxfMIL1553RtEnableSet (HMXF_CHANNEL channel, uint64 enable) |
uint32 | mxfMIL1553RtEnableGet (HMXF_CHANNEL channel, uint64 *enable) |
uint32 | mxfMIL1553EmbeddedNVStorageFileMsgSelectSet (HMXF_CHANNEL channel, uint64 select, uint64 count, MXF_MSGID_MIL1553 *msgid) |
uint32 | mxfMIL1553EmbeddedNVStorageFileMsgSelectGet (HMXF_CHANNEL channel, uint64 maxCount, uint64 *count, MXF_MSGID_MIL1553 *msgid) |
uint32 | mxfMIL1553EmbeddedNVStorageFileMsgRead (HMXF_NVSTORAGE nvStorage, uint64 fileIndex, uint64 maxMsgCount, uint64 maxBytesCount, uint64 *msgCount, uint64 *byteCount, MXF_MIL1553_DATAREC *msg) |
uint32 | mxfMIL1553EmbeddedNVStorageFileMsgWrite (HMXF_NVSTORAGE nvStorage, uint64 fileIndex, uint64 maxMsgCount, MXF_MIL1553_DATAREC *msg, uint64 *count) |
uint32 | mxfMIL1553RtsHybridRevSet (HMXF_CHANNEL channel, uint64 rev) |
uint32 | mxfMIL1553RtsHybridRevGet (HMXF_CHANNEL channel, uint64 *rev) |
uint32 mxfMIL1553ErrorInjectionCompose | ( | uint64 | id, |
uint64 | param, | ||
uint16 * | error | ||
) |
Helps to generate the errors field of MXF_MIL1553_ERROR_INJ.
[in] | id | error injection ID. |
[in] | param | parameter for the error injection. |
[out] | error | pointer to the error in the errors array. |
uint32 mxfMIL1553ErrorInjectionSet | ( | HMXF_CHANNEL | channel, |
uint64 | errorIndex, | ||
MXF_MIL1553_ERROR_INJ * | error | ||
) |
Updates the specified error injection structure. By default, all errors are set to zero until this function is called.
[in] | channel | Channel handle. |
[in] | errorIndex | Error index (0-99). |
[in] | error | Error structure pointer. |
uint32 mxfMIL1553ErrorInjectionGet | ( | HMXF_CHANNEL | channel, |
uint64 | errorIndex, | ||
MXF_MIL1553_ERROR_INJ * | error | ||
) |
Reads the specified error injection structure.
[in] | channel | Channel handle. |
[in] | errorIndex | Error index (0-99). |
[out] | error | Error structure pointer. |
uint32 mxfMIL1553ErrorInjectionCountGet | ( | HMXF_CHANNEL | channel, |
uint64 * | errorCount | ||
) |
Gets the maximum number of error injections that can be set.
[in] | channel | Channel handle. |
[out] | errorCount | number of error injections. |
uint32 mxfMIL1553CommandCompose | ( | uint64 | address, |
uint64 | subAddress, | ||
uint64 | dir, | ||
uint64 | wordCount, | ||
uint16 * | command | ||
) |
Helps to generate the command field.
[in] | address | command address (0-31). |
[in] | subAddress | command subaddress (0-31). |
[in] | dir | command direction (MXF_MIL1553_COMMAND_DIR_RX for RX command or MXF_MIL1553_COMMAND_DIR_TX for TX command). |
[in] | wordCount | command word count (or mode command) (0-31). |
[out] | command | pointer to the returned command. |
uint32 mxfMIL1553CommandDecompose | ( | uint16 | command, |
uint64 * | address, | ||
uint64 * | subAddress, | ||
uint64 * | dir, | ||
uint64 * | wordCount | ||
) |
Helps to decompose the command field.
[in] | command | command. |
[out] | address | pointer to address. |
[out] | subAddress | pointer to subaddress. |
[out] | dir | pointer to direction (MXF_MIL1553_COMMAND_DIR_RX for RX command or MXF_MIL1553_COMMAND_DIR_TX for TX command). |
[out] | wordCount | pointer to word count (or mode command). |
uint32 mxfMIL1553ConditionalBranchCompose | ( | uint64 | option, |
uint64 | wordIndex, | ||
uint16 * | condition | ||
) |
Helps to generate the conditional branch field (MXF_MIL1553_TXPERIODIC_MJRFRAME_MSG.condBranch).
[in] | option | conditional branch option. |
[in] | wordIndex | data index (0-35). |
[out] | condition | pointer to conditional branch field. |
uint32 mxfMIL1553ConditionalBranchOnDiscreteCompose | ( | uint64 | option, |
uint16 * | condition | ||
) |
Helps to generate the conditional branch field (MXF_MIL1553_TXPERIODIC_MJRFRAME_MSG.condBranch) that uses a discrete input.
[in] | option | conditional branch option |
[out] | condition | pointer to conditional branch field |
uint32 mxfMIL1553TxAperiodicWrite | ( | HMXF_BUFFER | buffer, |
uint64 | options, | ||
uint64 | startTime, | ||
uint64 | count, | ||
MXF_MIL1553_DATAREC * | rec | ||
) |
Sends aperiodic data record for transmission. The data items to be transmitted are specified within the records, along with a time tag and a control word. The first data item is transmitted at the specified starting time.
The records to transmit on time tag must be placed in chronological order in the array. The same time tag must not appear more than once in the array. When record absolute timing is used, the time tag of the first record should be at least 50 msec in advance to be relatively precise otherwise it will be sent as soon as possible.
[in] | buffer | buffer handle. |
[in] | options | options for controlling the transmitter before for sending the data records. The details of the options are explained below.
|
[in] | startTime | this parameter is not used in MIL-STD-1553. It must be set to 0. |
[in] | count | number of records to write |
[in] | rec | records to write. The records in the buffer need to be indexed using mxfMIL1553NextDataRecordPtrGet() function. |
The options modify the transmission scheme as described below:
uint32 mxfMIL1553TxPeriodicMajorFrameStart | ( | HMXF_CHANNEL | channel, |
uint64 | majorIndex, | ||
uint64 | duration, | ||
MXF_MIL1553_TXPERIODIC_MJRFRAME_PROPERTIES * | properties | ||
) |
Starts the major frame.
If the major frame contains frame errors, erroneous frames will be ignored and others frames will be started.
The data of the major frame must be initialized using mxfMIL1553TxPeriodicUpdateMsgWrite() function.
[in] | channel | channel handle. |
[in] | majorIndex | major frame index. Reserved for future use. Must be set to 0. |
[in] | duration | default minor frame duration (50 to 6553575 microseconds in step of 25 microseconds). Expressed in timebase resolution. Minor frame duration can be overridden by each minor frame. Example: Major frame with 2 minor frames (minor frame interval = 25000).
|
[in] | properties | address of a MXF_MIL1553_TXPERIODIC_MJRFRAME_PROPERTIES structure (optional). Pass NULL to use default major frame properties (uses a first minor index of 0, no start time, no stop time and no options). |
uint32 mxfMIL1553TxPeriodicMajorFrameSet | ( | HMXF_CHANNEL | channel, |
uint64 | majorIndex, | ||
uint64 | minorIndex, | ||
uint64 | count, | ||
MXF_MIL1553_TXPERIODIC_MJRFRAME_MSG * | msg, | ||
MXF_MIL1553_TXPERIODIC_MJRFRAME_MINOR_PROPERTIES * | 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.
[in] | channel | channel handle. |
[in] | majorIndex | major frame index. Reserved for future use. Must be set to 0. |
[in] | minorIndex | minor frame index. |
[in] | count | count of messages in the minor frame. |
[in] | msg | minor frame message structure pointer. |
[in] | properties | minor frame properties pointer (optional). MXF_MIL1553_TXPERIODIC_MJRFRAME_MINOR_PROPERTIES for MIL-STD-1553. Pass NULL to ignore this parameter, the default minor frame properties will apply. |
uint32 mxfMIL1553TxPeriodicMajorFrameGet | ( | HMXF_CHANNEL | channel, |
uint64 | majorIndex, | ||
uint64 | minorIndex, | ||
uint64 | maxCount, | ||
uint64 * | count, | ||
MXF_MIL1553_TXPERIODIC_MJRFRAME_MSG * | msg, | ||
MXF_MIL1553_TXPERIODIC_MJRFRAME_MINOR_PROPERTIES * | properties | ||
) |
Reads the specified minor frame of the major frame.
[in] | channel | channel handle. |
[in] | majorIndex | major frame index. Reserved for future use. Must be set to 0. |
[in] | minorIndex | minor frame index. |
[in] | maxCount | maximum messages to read within the minor frame. |
[out] | count | returned messages count. |
[out] | msg | minor frame messages pointer. |
[out] | properties | pointer to returned properties (optional). MXF_MIL1553_TXPERIODIC_MJRFRAME_MINOR_PROPERTIES for MIL-STD-1553. Pass NULL to ignore this parameter. |
uint32 mxfMIL1553TxPeriodicUpdateMsgWrite | ( | HMXF_BUFFER | buffer, |
uint64 | count, | ||
MXF_MIL1553_DATAREC * | rec | ||
) |
Writes messages of the record array into the specified buffer. The last message of each buffer is sent forever until a new message is written into the buffer.
[in] | buffer | buffer handle. |
[in] | count | count of records to write. |
[in] | rec | array of record(s) to write. The records in the buffer need to be indexed using mxfMIL1553NextDataRecordPtrGet() function. |
uint32 mxfMIL1553RxAcqMsgSelectGet | ( | HMXF_BUFFER | buffer, |
uint64 | maxCount, | ||
uint64 * | count, | ||
MXF_MSGID_MIL1553 * | msg | ||
) |
Returns the list of messages selected for acquisition.
[in] | buffer | buffer handle. |
[in] | maxCount | maximum number of labels in the array. |
[out] | count | returned number of messages in the msg array. |
[out] | msg | address of the returned messages array. |
uint32 mxfMIL1553RxAcqMsgSelectSet | ( | HMXF_BUFFER | buffer, |
uint64 | select, | ||
uint64 | maxcount, | ||
MXF_MSGID_MIL1553 * | msg | ||
) |
Selects or deselects the message(s) to be acquired on the specified acquisition buffer.
Upon data arrival, the embedded process will check if the received message is found in the current selection list. The receive data record will be added to the acquisition buffer only if the message is found in the selection list, otherwise it is discarded.
By default, after a device reset, no filtering is performed and all messages are received.
[in] | buffer | buffer handle. | ||||||||
[in] | select | action to perform with the message ID array.
| ||||||||
[in] | maxcount | number of entries in msg. | ||||||||
[in] | msg | address of array of messages |
uint32 mxfMIL1553RxAcqRead | ( | HMXF_BUFFER | buffer, |
uint64 | maxRecCount, | ||
uint64 | maxBytesCount, | ||
uint64 * | status, | ||
uint64 * | recCount, | ||
uint64 * | bytesCount, | ||
MXF_MIL1553_DATAREC * | rec | ||
) |
Transfers the records from the channel acquisition buffer to the calling application.
[in] | buffer | buffer handle. |
[in] | maxRecCount | maximum number records to read (0 means all messages). |
[in] | maxBytesCount | maximum number of bytes to be read. |
[out] | status | last status set. |
[out] | recCount | number of records returned. |
[out] | bytesCount | number of bytes returned. |
[out] | rec | address of data records. The records in the buffer need to be indexed using mxfMIL1553NextDataRecordPtrGet() function. |
uint32 mxfMIL1553RxSamplingExtEnableSet | ( | HMXF_BUFFER | buffer, |
uint64 | state, | ||
uint64 | count, | ||
uint64 * | address | ||
) |
Enables or disables message discrimination using the type/subaddress. The message look-up table will have an entry for each message address/subaddress/type triplet.
[in] | buffer | buffer handle. |
[in] | state | extension filtering state.
|
[in] | count | number of entries in address. For BC and BM, a maximum of 32 addresses are available. For RT, only one address is available. |
[in] | address | address of array of addresses. For BC and BM, address between 0-31. For RT, the address must be set to 0. |
uint32 mxfMIL1553RxSamplingExtEnableAllGet | ( | HMXF_BUFFER | buffer, |
uint64 | maxCount, | ||
uint64 * | count, | ||
uint64 * | address | ||
) |
Returns the list of addresses that have message discrimination using the type/subaddress enabled.
[in] | buffer | buffer handle. |
[in] | maxCount | maximum number of entries in address. |
[out] | count | number of entries in address. |
[out] | address | address array of addresses. |
uint32 mxfMIL1553RxSamplingMsgSelectSet | ( | HMXF_BUFFER | buffer, |
uint64 | select, | ||
uint64 | maxcount, | ||
MXF_MSGID_MIL1553 * | msg | ||
) |
Selects or deselects the message(s) to be received on the specified sampling buffer.
Upon data arrival, the embedded process check if the received message is defined in the current selection list. The receive data record will be added to the sampling buffer only if the message was added previously in the selection list, otherwise it is discarded.
By default, after a device reset, no filtering is performed and all messages are received.
[in] | buffer | buffer handle. | ||||||||
[in] | select | action to perform with the message ID array.
| ||||||||
[in] | maxcount | count of message ID in the array. | ||||||||
[in] | msg | address of array of message ID. |
uint32 mxfMIL1553RxSamplingMsgSelectGet | ( | HMXF_BUFFER | buffer, |
uint64 | maxCount, | ||
uint64 * | count, | ||
MXF_MSGID_MIL1553 * | msg | ||
) |
Returns the list of message ID(s) selected for sampling.
[in] | buffer | buffer handle. |
[in] | maxCount | maximum number of message ID in the array msg. |
[out] | count | returned number of message ID in the msg array. |
[out] | msg | address of the returned message ID array. |
uint32 mxfMIL1553RxSamplingRead | ( | HMXF_BUFFER | buffer, |
uint64 | flags, | ||
uint64 | maxRecCount, | ||
uint64 | maxBytesCount, | ||
uint64 * | recCount, | ||
uint64 * | byteCount, | ||
MXF_MIL1553_SAMPREC * | rec | ||
) |
Reads the sampling records from the sampling buffer to the application buffer.
The sampling process maintains records for all of the received labels. A label is considered received if corresponding data words were received within the kill-time period. A record refresh from the receive port resets the kill-time timer and an updated copy is made available to the application.
The sampling record contains information on the arrival rate and the number of errors, as well as the latest data received for that address.
[in] | buffer | buffer handle. | ||||||
[in] | flags | option flag.
| ||||||
[in] | maxRecCount | maximum number of messages to read (0 means all messages). | ||||||
[in] | maxBytesCount | maximum number of bytes to read. | ||||||
[out] | recCount | number of messages returned. | ||||||
[out] | byteCount | number of bytes returned. | ||||||
[out] | rec | array of message record structure. The records in the buffer must be indexed by using mxfMIL1553NextSamplingRecordPtrGet() function. |
uint32 mxfMIL1553RxSamplingSingleRead | ( | HMXF_BUFFER | buffer, |
uint64 | flags, | ||
uint64 | type, | ||
uint64 | address, | ||
uint64 | subaddress, | ||
MXF_MIL1553_SAMPREC * | rec | ||
) |
Reads a specific sampling record from the sampling buffer.
[in] | buffer | buffer handle. | ||||||
[in] | flags | option flag.
| ||||||
[in] | type | message type. | ||||||
[in] | address | message address. | ||||||
[in] | subaddress | message subaddress. | ||||||
[out] | rec | address of sampling record. |
uint64 mxfMIL1553AsyncEventRxMsgSelectSet | ( | HMXF_ASYNCEVENT | asyncEvent, |
HMXF_CHANNEL | channel, | ||
uint64 | select, | ||
uint64 | count, | ||
MXF_MSGID_MIL1553 * | msg | ||
) |
Selects or deselects the message id for MXF_ASYNCEVENT_COND_RX_MSG condition on a specified RX channel.
The function must be called in addition to the mxfAsyncEventConditionsSet() function with MXF_ASYNCEVENT_COND_RX_MSG condition to cause an asynchronous event to occur when a specific message is received.
The message selection must be made by only one asynchronous event routine for a specific channel. Otherwise, an error code will be returned while conditions of other asynchronous event routines are present.
In this case, you must disable the MXF_ASYNCEVENT_COND_RX_MSG condition using mxfAsyncEventConditionsSet() function using another asynchronous event handle.
[in] | asyncEvent | asynchronous event handle. | ||||||||
[in] | channel | channel handle. | ||||||||
[in] | select | action to perform for the message ID.
| ||||||||
[in] | count | count of messages id. | ||||||||
[in] | msg | address of array of message id. |
uint32 mxfMIL1553AsyncEventRxMsgSelectGet | ( | HMXF_ASYNCEVENT | asyncEvent, |
HMXF_CHANNEL | channel, | ||
uint64 | maxCount, | ||
uint64 * | count, | ||
MXF_MSGID_MIL1553 * | msg | ||
) |
Returns the list of message IDs registered for a specified RX channel for MXF_ASYNCEVENT_COND_RX_MSG asynchronous event condition ID.
[in] | asyncEvent | asynchronous event handle. |
[in] | channel | channel handle. |
[in] | maxCount | maximum messages ID expected. |
[out] | count | number of messages ID returned. |
[out] | msg | returned message ID array. |
uint32 mxfMIL1553StatisticErrorGlobalGet | ( | HMXF_CHANNEL | channel, |
MXF_MIL1553_STAT_ERROR_GLOBAL * | stats | ||
) |
Returns the global error statistics for the specified channel.
[in] | channel | channel handle. |
[out] | stats | pointer to statistical structure returned. |
uint32 mxfMIL1553StatisticErrorGlobalByAddressGet | ( | HMXF_CHANNEL | channel, |
MXF_MIL1553_STAT_ERROR_GLOBAL_ALL_ADDRESS * | stats | ||
) |
Returns the error statistics by address for the specified channel.
[in] | channel | channel handle. |
[out] | stats | pointer to statistical structure returned. |
uint32 mxfMIL1553StatisticErrorGlobalBySubaddressGet | ( | HMXF_CHANNEL | channel, |
MXF_MIL1553_STAT_ERROR_GLOBAL_ALL_SUBADDRESS * | stats | ||
) |
Returns the error statistics by subaddress for the specified channel.
[in] | channel | channel handle. |
[out] | stats | pointer to statistical structure returned. |
uint32 mxfMIL1553StatisticErrorDetailsBySubaddressGet | ( | HMXF_CHANNEL | channel, |
MXF_MIL1553_STAT_ERROR_DETAILS_SUBADDRESS * | stats | ||
) |
Returns the detailed error statistics by subaddress for the specified channel.
[in] | channel | channel handle. |
[out] | stats | pointer to statistical structure returned. |
uint32 mxfMIL1553StatisticTransactionGlobalGet | ( | HMXF_CHANNEL | channel, |
MXF_MIL1553_STAT_TRANSACTION_GLOBAL * | stats | ||
) |
Returns the global transaction statistics for the specified channel.
[in] | channel | channel handle. |
[out] | stats | pointer to statistical structure returned. |
uint32 mxfMIL1553StatisticTransactionGlobalByAddressGet | ( | HMXF_CHANNEL | channel, |
MXF_MIL1553_STAT_TRANSACTION_GLOBAL_ALL_ADDRESS * | stats | ||
) |
Returns the transaction statistics by address for the specified channel.
[in] | channel | channel handle. |
[out] | stats | pointer to statistical structure returned. |
uint32 mxfMIL1553StatisticTransactionGlobalBySubaddressGet | ( | HMXF_CHANNEL | channel, |
MXF_MIL1553_STAT_TRANSACTION_GLOBAL_ALL_SUBADDRESS * | stats | ||
) |
Returns the transaction statistics by subaddress for the specified channel.
[in] | channel | channel handle. |
[out] | stats | pointer to statistical structure returned. |
uint32 mxfMIL1553StatisticTransactionDetailsBySubaddressGet | ( | HMXF_CHANNEL | channel, |
MXF_MIL1553_STAT_TRANSACTION_DETAILS_SUBADDRESS * | stats | ||
) |
Returns the detailed transaction statistics by subaddress for the specified channel.
[in] | channel | channel handle. |
[out] | stats | pointer to statistical structure returned. |
uint32 mxfMIL1553NextDataRecordPtrGet | ( | MXF_MIL1553_DATAREC * | currentRec, |
MXF_MIL1553_DATAREC ** | nextRec | ||
) |
Returns the next buffer address in a MXF_MIL1553_DATAREC buffer array.
[in] | currentRec | pointer to the beginning or the current record in the buffer. |
[out] | nextRec | pointer to next record in the buffer. |
uint32 mxfMIL1553NextSamplingRecordPtrGet | ( | MXF_MIL1553_SAMPREC * | currentRec, |
MXF_MIL1553_SAMPREC ** | nextRec | ||
) |
Returns the next buffer address in a MXF_MIL1553_SAMPREC buffer array.
[in] | currentRec | pointer to the beginning or the current record in the buffer. |
[out] | nextRec | pointer to next record in the buffer. |
uint32 mxfMIL1553DataRecordDecompose | ( | HMXF_CHANNEL | channel, |
uint64 | count, | ||
MXF_MIL1553_DATAREC * | data, | ||
MXF_MIL1553_MSGINFO * | msginfo | ||
) |
Decomposes received messages from the acquisition service.
This function may be used with records coming from message monitor mode only.
[in] | channel | channel handle. |
[in] | count | Number of record in the records array. |
[in] | data | Records array to decompose. |
[out] | msginfo | Decomposed message array. |
uint32 mxfMIL1553SamplingRecordDecompose | ( | HMXF_CHANNEL | channel, |
uint64 | count, | ||
MXF_MIL1553_SAMPREC * | data, | ||
MXF_MIL1553_MSGINFO * | msginfo | ||
) |
Decomposes received messages from the sampling service.
[in] | channel | channel handle. |
[in] | count | Number of record in the records array. |
[in] | data | Records array to decompose. |
[out] | msginfo | Decomposed message array. |
uint32 mxfMIL1553MsgChecksumEnableSet | ( | HMXF_CHANNEL | channel, |
uint64 | type, | ||
uint64 | address, | ||
uint64 | subaddress, | ||
uint64 | value | ||
) |
Sets the checksum of the specified message defined on a channel. Available only on channel with MIL-STD-1760 option.
[in] | channel | channel handle. | ||||||
[in] | type | message type. | ||||||
[in] | address | message address. | ||||||
[in] | subaddress | message subaddress. | ||||||
[in] | value | value to set.
|
uint32 mxfMIL1553MsgChecksumEnableGet | ( | HMXF_CHANNEL | channel, |
uint64 | type, | ||
uint64 | address, | ||
uint64 | subaddress, | ||
uint64 * | value | ||
) |
This function returns the checksum enable state of the specified message defined on a channel. Available only on channel with MIL-STD-1760 option.
[in] | channel | channel handle. | ||||||
[in] | type | message type. | ||||||
[in] | address | message address. | ||||||
[in] | subaddress | message subaddress. | ||||||
[out] | value | pointer to returned value.
|
uint32 mxfMIL1553RtSubsystemEnableSet | ( | HMXF_CHANNEL | channel, |
uint64 | type, | ||
uint64 | subaddress, | ||
uint64 | bus, | ||
HMXF_BUFFER | buffer | ||
) |
Enables or disables buses of a message on MIL-STD-1553 RT channel and associates it to a buffer. To disable the message, use zero (0) as parameter value for bus and buffer.
[in] | channel | channel handle. | ||||||||
[in] | type | message type.
| ||||||||
[in] | subaddress | message subaddress (0-31). | ||||||||
[in] | bus | specifies which bus to enable. 0 to disable both buses.
| ||||||||
[in] | buffer | buffer to link RT message to. |
uint32 mxfMIL1553RtSubsystemEnableGet | ( | HMXF_CHANNEL | channel, |
uint64 | type, | ||
uint64 | subaddress, | ||
uint64 * | bus, | ||
HMXF_BUFFER * | buffer | ||
) |
Get enable/disable state of buses of a message on MIL-STD-1553 RT channel and the buffer associated with it.
[in] | channel | channel handle. | ||||||||
[in] | type | message type.
| ||||||||
[in] | subaddress | message subaddress (0-31). | ||||||||
[out] | bus | specifies which bus is enabled.
| ||||||||
[out] | buffer | buffer RT message is linked to. |
uint32 mxfMIL1553RtEnableSet | ( | HMXF_CHANNEL | channel, |
uint64 | enable | ||
) |
Enables or disables MIL-STD-1553 RT channel.
[in] | channel | channel handle. |
[in] | enable | TRUE to enable RT channel, FALSE to disable it. |
uint32 mxfMIL1553RtEnableGet | ( | HMXF_CHANNEL | channel, |
uint64 * | enable | ||
) |
Gets enable state of an MIL-STD-1553 RT channel.
[in] | channel | channel handle. |
[out] | enable | TRUE when RT channel is enabled, FALSE when it is disabled. |
uint32 mxfMIL1553EmbeddedNVStorageFileMsgSelectSet | ( | HMXF_CHANNEL | channel, |
uint64 | select, | ||
uint64 | count, | ||
MXF_MSGID_MIL1553 * | msgid | ||
) |
Selects / deselects the specified message IDs on a channel for automatic embedded non-volatile storage recording.
[in] | channel | channel handle | ||||||||
[in] | select | action to perform with the provided selection list
| ||||||||
[in] | count | count of messages | ||||||||
[in] | msgid | pointer to an array of message identifiers. |
uint32 mxfMIL1553EmbeddedNVStorageFileMsgSelectGet | ( | HMXF_CHANNEL | channel, |
uint64 | maxCount, | ||
uint64 * | count, | ||
MXF_MSGID_MIL1553 * | msgid | ||
) |
Returns the specific message IDs registered on a channel for automatic embedded non-volatile storage recording.
[in] | channel | channel handle. |
[in] | maxCount | maximum count of messages return in the array |
[out] | count | count of messages returned |
[out] | msgid | pointer to an array of message identifiers. |
uint32 mxfMIL1553EmbeddedNVStorageFileMsgRead | ( | HMXF_NVSTORAGE | nvStorage, |
uint64 | fileIndex, | ||
uint64 | maxMsgCount, | ||
uint64 | maxBytesCount, | ||
uint64 * | msgCount, | ||
uint64 * | byteCount, | ||
MXF_MIL1553_DATAREC * | msg | ||
) |
Reads the records from a specific file. The messages format must be of type MXF_EMBEDDED_NVSTORAGE_MSGTYPE_MIL1553.
[in] | nvStorage | non-volatile storage handle |
[in] | fileIndex | file index |
[in] | maxMsgCount | maximum number of messages that can be returned |
[in] | maxBytesCount | maximum byte count that can be returned |
[out] | msgCount | count of messages returned |
[out] | byteCount | number of bytes returned in the msg buffer |
[out] | msg | pointer to read buffer containing messages. The records in the buffer need to be indexed using the mxfMIL1553NextDataRecordPtrGet() function. |
uint32 mxfMIL1553EmbeddedNVStorageFileMsgWrite | ( | HMXF_NVSTORAGE | nvStorage, |
uint64 | fileIndex, | ||
uint64 | maxMsgCount, | ||
MXF_MIL1553_DATAREC * | msg, | ||
uint64 * | count | ||
) |
Writes messages to the specified file. The messages format must be of type MXF_EMBEDDED_NVSTORAGE_MSGTYPE_MIL1553.
[in] | nvStorage | non-volatile storage handle |
[in] | fileIndex | file index |
[in] | maxMsgCount | maximum number of messages to write |
[in] | msg | pointer to messages to write. The records in the buffer need to be indexed using mxfMIL1553NextDataRecordPtrGet() function. |
[out] | count | number of messages actually written |
uint32 mxfMIL1553RtsHybridRevSet | ( | HMXF_CHANNEL | channel, |
uint64 | rev | ||
) |
Sets the revision (MIL1553A or MIL1553B) for the RTs on a hybrid mode bus.
[in] | channel | channel handle (MIL1553 BC, BM or RT). |
[in] | rev | 32-bit mask, 1-bit for each possible RT on the bus (bit 0: RT0, bit 1: RT1, ...). Bit to set 0 for MIL1553B, bit set to 1 for MIL1553A. |
uint32 mxfMIL1553RtsHybridRevGet | ( | HMXF_CHANNEL | channel, |
uint64 * | rev | ||
) |
Gets the revision (MIL1553A or MIL1553B) for the RTs on a hybrid mode bus.
[in] | channel | channel handle (MIL1553 BC, BM or RT). |
[out] | rev | 32-bit mask, 1-bit for each possible RT on the bus (bit 0: RT0, bit 1: RT1, ...). Bit to set 0 for MIL1553B, bit set to 1 for MIL1553A. |