Software Library API naibrd 1.62
See all documentation at naii.docs.com
naibrd_ar.c File Reference
#include "functions/naibrd_ar.h"
#include "functions/naibrd_modCommon.h"
#include "maps/nai_map_ar.h"
#include "advanced/naibrd_adv.h"
#include "naibrd_config.h"
#include "boards/naibrd_gen5.h"
#include <stdlib.h>
#include <string.h>

Functions

NAIBRDFUNC int32_t NAIAPI naibrd_AR_GetChannelCount (uint32_t modid)
 Returns the number of channels for the specified ARINC Module ID.
 
NAIBRDFUNC int32_t NAIAPI naibrd_AR_GetMaxFifoCount (uint32_t modid)
 Returns the max Fifo count for the specified ARINC Module ID.
 
NAIBRDFUNC int32_t NAIAPI naibrd_AR_GetMaxDataRate (uint32_t modid)
 Returns the max Data Rate for the specified ARINC Module ID.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTxEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Enables or disables the Transmitter of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTxEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outenable)
 Reads the state of the Transmitter of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetRxEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Enables or disables the receiver of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetRxEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outenable)
 Reads the receiver enabled / disabled status of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_WriteWord (int32_t cardIndex, int32_t module, int32_t channel, uint32_t wordvalue)
 This function will add a 32-bit word to the transmit FIFO of the specified channel. The single word is passed as a parameter. (For A4 modules, the Tx FIFO is incremented after internally writing the lower 16-bit word).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ReadWord (int32_t cardIndex, int32_t module, int32_t channel, bool_t timeStampEnabled, uint16_t *outstatus, uint32_t *outdata, uint32_t *outtimestamp)
 This function reads the status, 32-bit data, and the timestamp (if enabled) from the receive FIFO of the specified channel. If the channel is an ARINC-568 channel, only data is read (no status or timestamp).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_TransmitBuffer (int32_t cardIndex, int32_t module, int32_t channel, int32_t msglen, uint32_t *msgbuf, int32_t *outmsglen)
 This function will write multiple 32-bit words of data to the transmit FIFO of the specified channel. Pointers to a buffer and a length are passed as parameters. The actual number of words placed in the buffer is returned. If the available space in the FIFO is less than the number of messages being placed in the FIFO, the messages are not placed in the FIFO and instead, the available space in the FIFO is returned in a variable.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ReadFifo (int32_t cardIndex, int32_t module, int32_t channel, bool_t timeStampEnabled, uint32_t msglen, uint32_t *outstatus, uint32_t *outdata, uint32_t *outtimestamp, int32_t *outnummsgs)
 This function reads the status, the 32-bit ARINC data, and the time stamp (if time stamping is enabled) from the receive FIFO of the specified channel for the number of words (of data) specified (up to 255).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ReadFifoMBox (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outdata)
 This function will read one word (A4: 16-bit, AR1: 32-bit) from the FIFO of the specified channel. In MailBox Mode, this word contains the SDI/Label of the MailBox with a new message.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ReadMBox (int32_t cardIndex, int32_t module, int32_t channel, bool_t timeStampEnabled, int32_t label, uint16_t *outstatus, uint32_t *outdata, uint32_t *outtimestamp)
 This will read the ARINC data and associated status (and timestamp, if enabled) from the Mailbox specified by the label for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTxBufferCnt (int32_t cardIndex, int32_t module, int32_t channel, int32_t *outcount)
 Returns the number of 32-bit words in the transmit FIFO of the specified channel.

 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetRxBufferCnt (int32_t cardIndex, int32_t module, int32_t channel, int32_t *outcount)
 Returns the number of ARINC messages in the receive FIFO of the specified channel.

 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTxFifoStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_status_type_t type, nai_ar_status_t *outfifostatus)
 Returns the Transmit FIFO status of the specified channel with the output specified as follows:
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetRxFifoStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_status_type_t type, nai_ar_status_t *outfifostatus)
 Returns the Receive FIFO status of the specified channel with the output specified as follows:
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTxSendSeqStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_status_type_t type, nai_ar_status_t *outstatus)
 Returns the Transmit status of a channel with the output specified as follows:
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetParityErrorStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_status_type_t type, bool_t *outerror)
 Checks for a Parity Error on a given channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetReceiveErrorStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_status_type_t type, bool_t *outerror)
 Checks for a Receive Error on a given channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetBITErrorStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_status_type_t type, bool_t *outerror)
 Checks for BIT Error on a given channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetSchedInterruptStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_status_type_t type, bool_t *outinterrupt)
 Checks whether the Schedule Interrupt has been triggered.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetAsyncDataAvailStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_status_type_t type, bool_t *outavail)
 Checks whether asynchronous data is available.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_status_type_t type, nai_ar_status_t *outstatusword)
 Returns the channel status Word of the specified channel. Logic 1 is active.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ClearStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_status_t statusword)
 Clears the interrupt latch status bits. When an interrupt is generated by the core, the bit corresponding to the interrupt generating event (which is set in the Interrupt Enable register) is raised high in the latch register. This must be cleared by writing a '1' to the bit in order to further receive interrupts for the event.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetDataRate (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_datarate_t datarate)
 Sets the ARINC channel data rate to high or low speed.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetDataRate (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_datarate_t *outdatarate)
 Gets the ARINC channel data rate.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetParityAsData (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_parity_t parityasdata)
 Sets the parity mode of the specified channel. The Parity As Data Enable bit when set to Disabled, causes Arinc bit 32 to be treated as an odd parity bit. The transmitter calculates the Arinc odd parity bit and transmits it as bit 32. The receiver will check the received Arinc word for odd parity and will flag an error if is not. When set to Enabled, parity generation and checking will be disabled and both the transmitter and receiver will treat Arinc bit 32 as data and send the data word with no parity.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetParityAsData (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_parity_t *outparityasdata)
 Gets the parity mode of the specified channel. The Parity As Data Enable bit when set to Disabled, causes Arinc bit 32 to be treated as an odd parity bit. The transmitter calculates the Arinc odd parity bit and transmits it as bit 32. The receiver will check the received Arinc word for odd parity and will flag an error if is not. When set to Enabled, parity generation and checking will be disabled and both the transmitter and receiver will treat Arinc bit 32 as data and send the data word with no parity.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetBITdisable (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_bit_disable_t BITdisable)
 Enables or disables Built-in-Test of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTxBITdisable (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_bit_disable_t BITdisable)
 Enables or disables Tx Built-in-Test of the channel specified (AR-568 and AR-579 only).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetRxBITdisable (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_bit_disable_t BITdisable)
 Enables or disables Tx Built-in-Test of the channel specified (AR-568 and AR-579 only).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetBITdisable (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_bit_disable_t *outBITdisable)
 Reads the Built-in-Test Enable / Disable status of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTxBITdisable (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_bit_disable_t *outBITdisable)
 Reads the Tx Built-in-Test Enable / Disable status of the channel specified (AR-568 and AR-579 only).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetRxBITdisable (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_bit_disable_t *outBITdisable)
 Reads the Rx Built-in-Test Enable / Disable status of the channel specified (AR-568 and AR-579 only).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetRxFifoThreshold (int32_t cardIndex, int32_t module, int32_t channel, int32_t rxfifothreshold)
 Sets the receive FIFO threshold of the channel specified to a number between 0 and 255.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetRxFifoThresholds (int32_t cardIndex, int32_t module, int32_t channel, int32_t aethreshold, int32_t afthreshold)
 Sets the receive FIFO almost empty and almost full thresholds of the channel specified to a number between 0 and 1023.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetRxFifoThreshold (int32_t cardIndex, int32_t module, int32_t channel, int32_t *outrxfifothreshold)
 Reads the receive FIFO threshold of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetRxFifoThresholds (int32_t cardIndex, int32_t module, int32_t channel, int32_t *outaethreshold, int32_t *outafthreshold)
 Reads the receive Almost Empty and Almost Full FIFO thresholds of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetRxFifoSize (int32_t cardIndex, int32_t module, int32_t channel, int32_t rxfifosize)
 Set the receive FIFO/Circular Buffer size (1 to 255) of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetRxFifoSize (int32_t cardIndex, int32_t module, int32_t channel, int32_t *outrxfifosize)
 Get the receive FIFO/Circular Buffer size of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetRxMode (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_rx_mode_t rxmode)
 Sets the receive mode of the channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetRxMode (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_rx_mode_t *outrxmode)
 Gets the receive mode of the channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetRxFifoBounded (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Enables or disables Bounded Rx FIFO mode. If Bounded Rx FIFO is enabled, after the FIFO is full, the circuitry will block additional writes to the FIFO. If Bounded Rx FIFO is disabled, after the FIFO is full, the new data will overwrite the oldest value in the FIFO, essentially behaving like a circular FIFO.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetRxFifoBounded (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outenable)
 Reads the enabled / disabled state of the Bounded Rx FIFO configuration option. If Bounded Rx FIFO is enabled, after the FIFO is full, the circuitry will block additional writes to the FIFO. If Bounded Rx FIFO is disabled, after the FIFO is full, the new data will overwrite the oldest value in the FIFO, essentially behaving like a circular FIFO.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetRxStoreErrorDisable (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_store_on_error_disable_t storedisable)
 Enables or disables Receiver store on error for the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetRxStoreErrorDisable (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_store_on_error_disable_t *outstoredisable)
 Reads the receiver store on error status of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetBITErrorThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t biterrorthreshold)
 Set the BIT Error Threshold (number at which the BIT error count causes a BIT error). AR-568 and AR-579 only.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetBITErrorThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outbiterrorthreshold)
 Get the BIT Error Threshold (number at which the BIT error count causes a BIT error). AR-568 and AR-579 only.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTxFifoThreshold (int32_t cardIndex, int32_t module, int32_t channel, int32_t txfifothreshold)
 Sets the transmit FIFO threshold of the channel specified to a number between 0 and 255.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTxFifoThresholds (int32_t cardIndex, int32_t module, int32_t channel, int32_t aethreshold, int32_t afthreshold)
 Sets the transmit FIFO threshold of the channel specified to a number between 0 and 1023.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTxFifoThreshold (int32_t cardIndex, int32_t module, int32_t channel, int32_t *outtxfifothreshold)
 Reads the transmit FIFO threshold of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTxFifoThresholds (int32_t cardIndex, int32_t module, int32_t channel, int32_t *outaethreshold, int32_t *outafthreshold)
 Reads the transmit FIFO threshold of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTxFifoBounded (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Enables or disables Bounded Tx FIFO mode. If Bounded Tx FIFO is enabled, after the FIFO is full, the circuitry will block additional writes to the FIFO. If Bounded Tx FIFO is disabled, after the FIFO is full, the new data will overwrite the oldest value in the FIFO, essentially behaving like a circular FIFO.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTxFifoBounded (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outenable)
 Reads the enabled / disabled state of the Bounded Tx FIFO configuration option. If Bounded Tx FIFO is enabled, after the FIFO is full, the circuitry will block additional writes to the FIFO. If Bounded Tx FIFO is disabled, after the FIFO is full, the new data will overwrite the oldest value in the FIFO, essentially behaving like a circular FIFO.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTxIntervalRate (int32_t cardIndex, int32_t module, int32_t channel, int32_t txrate)
 Sets the Transmit Interval rate of the channel. This is the Gap time (in bit time) between transmitted ARINC messages in FIFO transmit modes. Rates less than 4 are not valid.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTxIntervalRate (int32_t cardIndex, int32_t module, int32_t channel, int32_t *outtxrate)
 Reads the Transmit Interval rate of the channel. This is the Gap time (in bit time) between transmitted ARINC messages in FIFO transmit modes.

 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTxSendMode (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_tx_mode_t txsendmode)
 Sets the Transmit mode of the channel.

 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTxSendMode (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_tx_mode_t *outtxsendmode)
 Reads the Transmit mode of the channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTxRiseAndFallTime (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_slope_control_t txrisefalltime)
 Set the rise/fall time of the ARINC transmitter (AR-579 only).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTxRiseAndFallTime (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_slope_control_t *outtxrisefalltime)
 Reads the currently set rise/fall time of the ARINC transmitter (AR-579 only).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_Set568LoopbackEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Enable or disable the Tx Loopback option of the 568 channel specified (AR-568 only).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_Get568LoopbackEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outenable)
 Reads the Tx Loopback enabled status of the 568 channel specified (AR-568 only).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ResetModule (int32_t cardIndex, int32_t module)
 Resets the module specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ChannelReset (int32_t cardIndex, int32_t module, int32_t channel)
 Clears out Channel Control Low and Interrupt Enable registers as well as reset the transmit and receive circuits. (This will NOT reset the channel Transmit FIFO Rate, Tx Buffer Almost Empty, and Rx Buffer Almost Full registers)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ClearRxFifo (int32_t cardIndex, int32_t module, int32_t channel)
 Clears the receive FIFO for the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ClearRxValMem (int32_t cardIndex, int32_t module, int32_t channel)
 Clears the receive Validation memory of the channel specified. Allow 100us for command to complete.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetRxValMem (int32_t cardIndex, int32_t module, int32_t channel)
 Enables receive matching of all Label/SDI combinations for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ClearTxFifo (int32_t cardIndex, int32_t module, int32_t channel)
 Clears the transmit FIFO for the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTxSendTrigger (int32_t cardIndex, int32_t module, int32_t channel)
 Sets the transmit trigger for the channel specified, triggering a scheduled or trigger fifo operation. This bit is reset by the hardware.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTxPause (int32_t cardIndex, int32_t module, int32_t channel)
 Pauses the transmitter for the channel specified after the current word and gap time has finished transmitting. To resume, issue Transmit Trigger command or issue a Transmit Stop command to halt transmission.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTxStop (int32_t cardIndex, int32_t module, int32_t channel)
 Stops the transmitter for the channel specified after the current word and gap time has finished transmitting. Also, clears the FIFO.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ClearTxBITError (int32_t cardIndex, int32_t module, int32_t channel)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ClearRxBITError (int32_t cardIndex, int32_t module, int32_t channel)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetRxValidationEn (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Enables or disables receive validation for the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetRxValidationEn (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outenable)
 Reads the receive validation status of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_WrTxMsgMem (int32_t cardIndex, int32_t module, int32_t channel, int32_t address, uint32_t data)
 Writes 32-bit data to the user specified Tx Msg memory address of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_RdTxMsgMem (int32_t cardIndex, int32_t module, int32_t channel, int32_t address, uint32_t *outdata)
 Reads 32-bit data from the user specified Tx Msg memory address of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_WrTxSchMem (int32_t cardIndex, int32_t module, int32_t channel, int32_t address, uint16_t data)
 Writes a schedule data word to the user specified Tx Sch memory address of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_RdTxSchMem (int32_t cardIndex, int32_t module, int32_t channel, int32_t address, uint16_t *outdata)
 Reads a schedule data word from the user specified Tx Sch memory address of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_WrRxValMem (int32_t cardIndex, int32_t module, int32_t channel, int32_t label, uint8_t data)
 Writes to the user specified Rx Validation memory address of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_RdRxValMem (int32_t cardIndex, int32_t module, int32_t channel, int32_t label, uint8_t *outdata)
 Reads the user specified Rx Validation memory address of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_WrRxValMemRange (int32_t cardIndex, int32_t module, int32_t channel, int32_t labello, int32_t labelhi, const bool_t *enablearray)
 Writes to a range of Rx Validation memory addresses of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_RdRxValMemRange (int32_t cardIndex, int32_t module, int32_t channel, int32_t labello, int32_t labelhi, int32_t *outdata)
 Reads a range of Rx Validation memory addresses of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_WrTxAsyncWd (int32_t cardIndex, int32_t module, int32_t channel, uint32_t data)
 Writes to the Tx AsyncData word location of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_RdTxAsyncWd (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outdata)
 Reads the Tx AsyncData word location of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetRxTimeStampEn (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Enables or disables time stamping for the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetRxTimeStampEn (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outenable)
 Reads the time stamp enable status of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ResetTimeStamp (int32_t cardIndex, int32_t module)
 Resets the time stamp for the module specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_PLLErrorCount (int32_t cardIndex, int32_t module, uint32_t *outcount)
 Returns the count of how many times the phase-locked loop (PLL) lost lock. The count resets to 0 upon calling this function.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTimeStampRsln (int32_t cardIndex, int32_t module, nai_ar_tstamp_t resolution)
 Sets the time stamp resolution for the module specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTimeStampRsln (int32_t cardIndex, int32_t module, nai_ar_tstamp_t *outresolution)
 Gets the time stamp resolution for the module specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetModuleTimeStamp (int32_t cardIndex, int32_t module, int32_t *outtimestamp)
 Reads the time stamp for the module specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_InitiateBIT (int32_t cardIndex, int32_t module, int32_t channel, bool_t waitForResult)
 Executes the AR-429 Initiated Built-in Test and returns the result. If the user chooses to wait for the result (waitForResult = NAI_TRUE) then the result of the test is returned in the status, either as NAI_SUCCESS or NAI_ERROR_BIT_FAILED. If the user chooses not to wait for the result, they can call naibrd_AR_CheckBITComplete() and naibrd_AR_GetStatus() at a later time to verify the test has completed and fetch the BIT status.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_CheckBITComplete (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outbitComplete)
 Retrieves the BIT status (complete or incomplete) of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_CheckPowerOnBITComplete (int32_t cardIndex, int32_t module, bool_t *p_outpbitComplete)
 Retrieves the Power-On BIT (PBIT) status (complete or incomplete) for the specified channel. The PBIT result will be in the BIT status register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, int32_t enable)
 Sets the Interrupt Enables of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, int32_t *outenable)
 Gets the Interrupt Enable word of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, int32_t vector)
 Sets the Interrupt Vector for the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, int32_t *outvector)
 Returns the Interrupt Vector of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, uint32_t edgeLevel)
 Sets the Interrupt Edge/Level register value for the specified ARINC channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outEdgeLevel)
 Retrieves the Interrupt Edge/Level register value for the specified ARINC channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_int_steering_t steering)
 Sets the Interrupt Steering which indicates the interrupt direction for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_int_steering_t *outsteering)
 Retrieves the Interrupt Steering which indicates the interrupt direction for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetChannelMappedStatus (int32_t cardIndex, int32_t module, nai_ar_chan_mapped_status_type_t statusType, uint32_t *outstatus)
 Retrieves either the BIT status or Summary (Receive Data Available) status for the module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ClearChannelMappedStatus (int32_t cardIndex, int32_t module, nai_ar_chan_mapped_status_type_t statusType, uint32_t inStatus)
 Clears the latched BIT status or latched Summary (Rx Data Available) status.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetChannelMappedInterruptEnable (int32_t cardIndex, int32_t module, nai_ar_chan_mapped_status_type_t statusType, uint32_t intEnable)
 Sets the Interrupt Enable register value for the specified statusType. Setting any of the bits to a (1) enables the interrupt on the channel in that bit position.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetChannelMappedInterruptEnable (int32_t cardIndex, int32_t module, nai_ar_chan_mapped_status_type_t statusType, uint32_t *outIntEnable)
 Gets the Interrupt Enable register value for the specified statusType. A (1) indicates the interrupt is enabled for that channel, a (0) indicates it is not set. Each bit represents a channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetChannelMappedInterruptTriggerType (int32_t cardIndex, int32_t module, nai_ar_chan_mapped_status_type_t statusType, uint32_t triggerType)
 Sets the Interrupt trigger type (edge/level) register value for the specified statusType. Setting any of the bits to a (0) sets the trigger type to edge, setting any of the bits to a (1) sets the trigger type to level. Each bit represents a channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetChannelMappedInterruptTriggerType (int32_t cardIndex, int32_t module, nai_ar_chan_mapped_status_type_t statusType, uint32_t *outTriggerType)
 Gets the Interrupt trigger type (edge/level) register value for the specified statusType. A (0) indicates the trigger type is set to edge for that channel, a (1) indicates the trigger type is set to level. Each bit represents a channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetChannelMappedInterruptVector (int32_t cardIndex, int32_t module, nai_ar_chan_mapped_status_type_t statusType, uint32_t vector)
 Sets the interrupt vector for the specified statusType interrupt.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetChannelMappedInterruptVector (int32_t cardIndex, int32_t module, nai_ar_chan_mapped_status_type_t statusType, uint32_t *outVector)
 Gets the interrupt vector for the specified statusType interrupt.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetChannelMappedInterruptSteering (int32_t cardIndex, int32_t module, nai_ar_chan_mapped_status_type_t statusType, naibrd_int_steering_t steering)
 Sets the interrupt steering for the specified statusType interrupt, this specifies the interrupt direction for each interrupt.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetChannelMappedInterruptSteering (int32_t cardIndex, int32_t module, nai_ar_chan_mapped_status_type_t statusType, naibrd_int_steering_t *outSteering)
 Gets the interrupt steering for the specified statusType interrupt, this specifies the interrupt direction for each interrupt.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetControlRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_ctrl_t control)
 Sets the control register of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetControlRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_ctrl_t *outcontrol)
 Reads the control register of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTxControlRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_ctrl_t control)
 Sets the Tx control register of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTxControlRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_ctrl_t *outcontrol)
 Reads the Tx control register of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetRxControlRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_ctrl_t control)
 Sets the Rx control register of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetRxControlRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_ctrl_t *outcontrol)
 Reads the Rx control register of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetConfigRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_ctrl_t config)
 Sets the Rx configuration register of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetConfigRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_ctrl_t *outconfig)
 Reads the Rx Configuration register of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTimeCtrlRaw (int32_t cardIndex, int32_t module, nai_ar_tstamp_t value)
 Sets the time stamp control register for the module specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTimeCtrlRaw (int32_t cardIndex, int32_t module, nai_ar_tstamp_t *outvalue)
 Reads the time stamp control register for the module specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetPageReg (int32_t cardIndex, int32_t module, int32_t page)
 Sets the memory page register of the specified module. Note: This function is not supported for AR1.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetPageReg (int32_t cardIndex, int32_t module, int32_t *outpage)
 Reads the memory page register of the specified module. Note: This function is not supported for AR1.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_WrMemLoc (int32_t cardIndex, int32_t module, int32_t address, uint16_t data)
 Writes data to the memory location in the page pointed to by the Memory Page register of the specified module. Note: This function is not supported for AR1.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_RdMemLoc (int32_t cardIndex, int32_t module, int32_t address, uint16_t *outdata)
 Reads the memory location in the page pointed to by the Memory Page register of the specified module. Note: This function is not supported for AR1.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetMemPage (int32_t cardIndex, int32_t module, int32_t channel, int32_t memtype, int32_t page)
 Sets the memory page register of the specified module. Note: This function is not supported for AR1.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetMemPage (int32_t cardIndex, int32_t module, int32_t *outchannel, int32_t *outmemtype, int32_t *outpage)
 Reads the memory page register of the specified module. Note: This function is not supported for AR1.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetDataBlock (int32_t cardIndex, int32_t module, int32_t addroffset, uint16_t *data, int32_t numwords)
 Sets a block of data containing a specified number of words in a specified location in RAM. Note: This function is not supported for AR1.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetDataBlock (int32_t cardIndex, int32_t module, int32_t addroffset, uint16_t *outdata, int32_t numwords)
 Retrieves a block of data containing a specified number of words in a specified location in RAM. Note: This function is not supported for AR1.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetBITStatus (int32_t cardIndex, int32_t module, nai_ar_status_type_t type, uint32_t *outstatusword)
 Reports the Dynamic or Latched BIT status of all channels.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ClearBITStatus (int32_t cardIndex, int32_t module, nai_ar_bit_status_t statusword)
 Clears the BIT status latch register bit for the specified channel. When a BIT error is reported on one or more channels, the bit(s) corresponding to the channel(s) are raised high in the latch register. These bits are held high until they are cleared by writing a '1' to the bit.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetBITInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Sets the BIT Interrupt Enables of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetBITInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outenable)
 Gets the BIT Interrupt Enable state of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetBITInterruptVector (int32_t cardIndex, int32_t module, int32_t vector)
 Sets the BIT Interrupt Vector.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetBITInterruptVector (int32_t cardIndex, int32_t module, int32_t *outvector)
 Gets the BIT Interrupt Vector.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetBITInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, bool_t edgeLevel)
 Sets the BIT Interrupt Edge/Level register value for the specified ARINC channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetBITInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outEdgeLevel)
 Retrieves the BIT Interrupt Edge/Level register value for the specified ARINC channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetBITInterruptSteering (int32_t cardIndex, int32_t module, naibrd_int_steering_t steering)
 Sets the BIT Interrupt Steering to indicate where to direct the interrupt signal.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetBITInterruptSteering (int32_t cardIndex, int32_t module, naibrd_int_steering_t *outsteering)
 Gets the BIT Interrupt Steering, which indicates where to direct the interrupt signal.
 

Function Documentation

◆ naibrd_AR_ClearRxBITError()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ClearRxBITError ( int32_t cardIndex,
int32_t module,
int32_t channel )

◆ naibrd_AR_ClearTxBITError()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ClearTxBITError ( int32_t cardIndex,
int32_t module,
int32_t channel )