Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Channel Configuration Functions
NAI Board Library - Module Functions » AR Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetBaudRate (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_datarate_t dataRate)
 Sets the ARINC channel data rate to high or low speed.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetBaudRate (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_datarate_t *p_outdataRate)
 Gets the ARINC channel data rate.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetParityBitUsage (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_parity_t parityUsage)
 This function sets the usage of the parity bit for the specified channel. When the parity bit usage is set for No Parity (NAIBRD_AR_PAR_NONE), the parity bit (bit 31) in the ARINC word is treated as another data bit and no parity checking occurs. If the parity bit usage is set for Odd Parity (NAIBRD_AR_PAR_ODD), bit 31 is treated as an odd parity bit. When Odd Parity is enabled, the transmitter calculates the odd parity bit and transmits it as bit 31. The receiver will check the received ARINC word for odd parity and will flag an error if even parity is detected.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetParityBitUsage (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_parity_t *p_outparityUsage)
 This function gets the current usage setting of the parity bit for the specified channel. When the parity bit usage is set for No Parity (NAIBRD_AR_PAR_NONE), the parity bit (bit 31) in the ARINC word is treated as another data bit and no parity checking occurs. If the parity bit usage is set for Odd Parity (NAIBRD_AR_PAR_ODD), bit 31 is treated as an odd parity bit. When Odd Parity is enabled, the transmitter calculates the odd parity bit and transmits it as bit 31. The receiver will check the received ARINC word for odd parity and will flag an error if even parity is detected.
 
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. The threshold range is 0 to 255.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetRxFifoThreshold (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outrxFifoThreshold)
 Reads the receive FIFO threshold of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetRxFifoSize (int32_t cardIndex, int32_t module, int32_t channel, int32_t bufferLength)
 Set the receive FIFO 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 *p_outbufferLength)
 Get the receive FIFO Buffer size of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetRxFifoBounded (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 This function enables or disables bounded Rx FIFO mode. If bounded mode is enabled and the FIFO becomes full, the circuitry will block additional writes to the FIFO. If bounded mode is disabled and the FIFO becomes full, any new data will overwrite the oldest value in the FIFO and the FIFO essentially behaves like a circular FIFO.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetRxFifoBounded (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_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_SetReceiveMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_rx_mode_t rxMode)
 Sets the received message storage mode of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetReceiveMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_rx_mode_t *p_outrxMode)
 Gets the receive mode of the channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetRxStoreOnErrorEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 This function enables or disables receive message "store-on-error" for the specified channel. If store-on-error is disabled, errored ARINC messages will be discarded.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetRxStoreOnErrorEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable)
 Reads the receiver store on error status of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTxFifoThreshold (int32_t cardIndex, int32_t module, int32_t channel, int32_t txFifoThreshold)
 This function sets the transmit FIFO threshold of the specified channel. The threshold range is 0 to 255.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTxFifoThreshold (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outtxFifoThreshold)
 Reads the transmit FIFO threshold of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTxGapTime (int32_t cardIndex, int32_t module, int32_t channel, int32_t txRate)
 Sets the Gap time (Transmit Interval Rate) between transmitted ARINC messages in FIFO transmit modes. Gap time is given in bit times. Values less than 4 are not valid.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTxGapTime (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outtxRate)
 Gets the currently configured Gap time (Transmit Interval Rate) interval, which is number of bit times between transmitted ARINC messages when running in FIFO transmit mode.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTransmitSendMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_tx_mode_t txSendMode)
 This function sets the Transmit mode of the specified channel. Three modes are currently supported. In "Immediate FIFO Mode", ARINC messages written to the Tx FIFO are immediately sent out. In "Triggered FIFO Mode", ARINC messages written to the Tx FIFO are sent out only if a Trigger issued with naibrd_AR_SetTxSendTrigger(). In "Scheduled Mode", ARINC messages are sent in accordance with a built-in schedule that is user-programmed.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTransmitSendMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_tx_mode_t *p_outtxSendMode)
 Gets the Transmit mode of the channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetRxValidationEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Enables or disables Message Validation for the channel specified. If message validation is not enabled, all received ARINC messages will be stored (in FIFO or Mailbox, depending on Rx mode). If message validation is enabled, only ARINC messages containing SDI/Labels that are match enabled will be stored. Match enabling for a particular SDI/Label can be enabled/disabled with naibrd_AR_SetLabelEnable(). Match enabling for all SDI/Labels can be enabled/disabled with naibrd_AR_SetLabelEnableAll().
 

Detailed Description

Function Documentation

◆ naibrd_AR_GetBaudRate()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetBaudRate ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ar_datarate_t * p_outdataRate )

Gets the ARINC channel data rate.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outdataRate: (Output) ARINC Data Rate. 
   Low speed (12.5K to 14.5K bps)         NAIBRD_AR_SPEED_LOW
   High speed (100K bps)                  NAIBRD_AR_SPEED_HIGH
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_GetParityBitUsage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetParityBitUsage ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ar_parity_t * p_outparityUsage )

This function gets the current usage setting of the parity bit for the specified channel. When the parity bit usage is set for No Parity (NAIBRD_AR_PAR_NONE), the parity bit (bit 31) in the ARINC word is treated as another data bit and no parity checking occurs. If the parity bit usage is set for Odd Parity (NAIBRD_AR_PAR_ODD), bit 31 is treated as an odd parity bit. When Odd Parity is enabled, the transmitter calculates the odd parity bit and transmits it as bit 31. The receiver will check the received ARINC word for odd parity and will flag an error if even parity is detected.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outparityUsage: (Output) Using parity bit as data (NAIBRD_AR_PAR_NONE) or odd parity (NAIBRD_AR_PAR_ODD).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_GetReceiveMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetReceiveMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ar_rx_mode_t * p_outrxMode )

Gets the receive mode of the channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outrxMode: (Output) Receive FIFO Mode (NAIBRD_AR_RX_FIFO_MODE) or Receive Mailbox Mode (NAIBRD_AR_RX_MBOX_MODE).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_GetRxFifoBounded()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetRxFifoBounded ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * p_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.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outenable: (Output) Disabled (0) or Enabled (1).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_GetRxFifoSize()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetRxFifoSize ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * p_outbufferLength )

Get the receive FIFO Buffer size of the channel specified.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outbufferLength: (Output) Rx FIFO Buffer size.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_GetRxFifoThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetRxFifoThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * p_outrxFifoThreshold )

Reads the receive FIFO threshold of the channel specified.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outrxFifoThreshold: (Output) Threshold value (0 - 255).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_GetRxStoreOnErrorEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetRxStoreOnErrorEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * p_outenable )

Reads the receiver store on error status of the channel specified.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outenable: (Output) Disabled (NAI_FALSE) or Enabled (NAI_TRUE).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_GetTransmitSendMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTransmitSendMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ar_tx_mode_t * p_outtxSendMode )

Gets the Transmit mode of the channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outtxSendMode: (Output) Tx mode. 
   Immediate FIFO Mode        NAIBRD_AR_TX_SENDMODE_IMMED
   Scheduled Mode             NAIBRD_AR_TX_SENDMODE_SCHED
   Triggered FIFO Mode        NAIBRD_AR_TX_SENDMODE_TRGF
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when an invalid send mode is detected by the function.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_GetTxFifoThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTxFifoThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * p_outtxFifoThreshold )

Reads the transmit FIFO threshold of the channel specified.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outtxFifoThreshold: (Output) Tx FIFO threshold value.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_GetTxGapTime()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTxGapTime ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * p_outtxRate )

Gets the currently configured Gap time (Transmit Interval Rate) interval, which is number of bit times between transmitted ARINC messages when running in FIFO transmit mode.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outtxRate: (Output) Gap Time (Transmit interval rate).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_SetBaudRate()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetBaudRate ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ar_datarate_t dataRate )

Sets the ARINC channel data rate to high or low speed.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
dataRate: (Input) ARINC Data Rate. 
   Low speed (12.5K to 14.5K bps)         NAIBRD_AR_SPEED_LOW
   High speed (100K bps)                  NAIBRD_AR_SPEED_HIGH
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid datarate is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_SetParityBitUsage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetParityBitUsage ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ar_parity_t parityUsage )

This function sets the usage of the parity bit for the specified channel. When the parity bit usage is set for No Parity (NAIBRD_AR_PAR_NONE), the parity bit (bit 31) in the ARINC word is treated as another data bit and no parity checking occurs. If the parity bit usage is set for Odd Parity (NAIBRD_AR_PAR_ODD), bit 31 is treated as an odd parity bit. When Odd Parity is enabled, the transmitter calculates the odd parity bit and transmits it as bit 31. The receiver will check the received ARINC word for odd parity and will flag an error if even parity is detected.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
parityUsage: (Input) Use parity bit as data (NAIBRD_AR_PAR_NONE) or odd parity (NAIBRD_AR_PAR_ODD).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid parityasdata is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_SetReceiveMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetReceiveMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ar_rx_mode_t rxMode )

Sets the received message storage mode of the specified channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
rxMode: (Input) Receive FIFO Mode (NAIBRD_AR_RX_FIFO_MODE) or Receive Mailbox Mode (NAIBRD_AR_RX_MBOX_MODE).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_SetRxFifoBounded()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetRxFifoBounded ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t enable )

This function enables or disables bounded Rx FIFO mode. If bounded mode is enabled and the FIFO becomes full, the circuitry will block additional writes to the FIFO. If bounded mode is disabled and the FIFO becomes full, any new data will overwrite the oldest value in the FIFO and the FIFO essentially behaves like a circular FIFO.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
enable: (Input) Disable (NAI_FALSE) or Enable (NAI_TRUE).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_SetRxFifoSize()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetRxFifoSize ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t bufferLength )

Set the receive FIFO Buffer size (1 to 255) of the channel specified.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
bufferLength: (Input) Rx FIFO Buffer size (1 - 255).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid bufferLength is supplied.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_SetRxFifoThreshold()

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. The threshold range is 0 to 255.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
rxFifoThreshold: (Input) Threshold value (0 - 255).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid rxFifoThreshold value is supplied.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_SetRxStoreOnErrorEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetRxStoreOnErrorEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t enable )

This function enables or disables receive message "store-on-error" for the specified channel. If store-on-error is disabled, errored ARINC messages will be discarded.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
enable: (Input) Disable (NAI_FALSE) or Enable (NAI_TRUE).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_SetRxValidationEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetRxValidationEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t enable )

Enables or disables Message Validation for the channel specified. If message validation is not enabled, all received ARINC messages will be stored (in FIFO or Mailbox, depending on Rx mode). If message validation is enabled, only ARINC messages containing SDI/Labels that are match enabled will be stored. Match enabling for a particular SDI/Label can be enabled/disabled with naibrd_AR_SetLabelEnable(). Match enabling for all SDI/Labels can be enabled/disabled with naibrd_AR_SetLabelEnableAll().

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
enable: (Input) Enable (NAI_TRUE) or Disable (NAI_FALSE).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_SetTransmitSendMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTransmitSendMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ar_tx_mode_t txSendMode )

This function sets the Transmit mode of the specified channel. Three modes are currently supported. In "Immediate FIFO Mode", ARINC messages written to the Tx FIFO are immediately sent out. In "Triggered FIFO Mode", ARINC messages written to the Tx FIFO are sent out only if a Trigger issued with naibrd_AR_SetTxSendTrigger(). In "Scheduled Mode", ARINC messages are sent in accordance with a built-in schedule that is user-programmed.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
txSendMode: (Input) Tx mode. 
   Immediate FIFO Mode        NAIBRD_AR_TX_SENDMODE_IMMED
   Scheduled Mode             NAIBRD_AR_TX_SENDMODE_SCHED
   Triggered FIFO Mode        NAIBRD_AR_TX_SENDMODE_TRGF
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid txSendMode parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_SetTxFifoThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTxFifoThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t txFifoThreshold )

This function sets the transmit FIFO threshold of the specified channel. The threshold range is 0 to 255.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
txFifoThreshold: (Input) Tx FIFO threshold value (0 - 255).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid txFifoThreshold parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_SetTxGapTime()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTxGapTime ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t txRate )

Sets the Gap time (Transmit Interval Rate) between transmitted ARINC messages in FIFO transmit modes. Gap time is given in bit times. Values less than 4 are not valid.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
txRate: (Input) Gap Time (0x00004 - 0xFFFFF).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid txrate parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.