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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_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_AR579_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_AR579_SetTxBITEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Enables or disables Tx Built-in-Test of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_GetTxBITEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable)
 Reads the Tx Built-in-Test Enable / Disable status of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_SetRxBITEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Enables or disables Rx Built-in-Test of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_GetRxBITEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable)
 Reads the Rx Built-in-Test Enable / Disable status of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_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_AR579_GetRxFifoThresholds (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outaeThreshold, int32_t *p_outafThreshold)
 Reads the receive Almost Empty and Almost Full FIFO thresholds of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_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_AR579_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_AR579_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_AR579_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_AR579_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).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_GetBITErrorThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outbitErrorThreshold)
 Get the BIT Error Threshold (number at which the BIT error count causes a BIT error).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_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_AR579_GetTxFifoThresholds (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outaeThreshold, int32_t *p_outafThreshold)
 Reads the transmit FIFO threshold of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_GetTxFifoBounded (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_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_AR579_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_AR579_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_AR579_SetTransmitSendMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_tx_mode_t txSendMode)
 This function sets the Transmit mode of the specified channel. Two 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().
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_GetTransmitSendMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_tx_mode_t *p_outtxSendMode)
 Gets the Transmit mode of the channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_SetTxRiseAndFallTime (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_slope_control_t txRiseFallTime)
 Set the rise/fall time of the ARINC transmitter.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_GetTxRiseAndFallTime (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_slope_control_t *p_outtxRiseFallTime)
 Reads the currently set rise/fall time of the ARINC transmitter.
 

Detailed Description

Function Documentation

◆ naibrd_AR579_GetBITErrorThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_GetBITErrorThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outbitErrorThreshold )

Get the BIT Error Threshold (number at which the BIT error count causes a BIT error).

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_outbitErrorThreshold: (Output) BIT Error Threshold.
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_AR579_GetParityBitUsage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_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_AR579_GetRxBITEnable()

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

Reads the Rx Built-in-Test Enable / Disable 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) BIT Disabled (FALSE) or Enabled (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_AR579_GetRxFifoBounded()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_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 (FALSE) or Enabled (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_AR579_GetRxFifoThresholds()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_GetRxFifoThresholds ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * p_outaeThreshold,
int32_t * p_outafThreshold )

Reads the receive Almost Empty and Almost Full FIFO thresholds 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_outaeThreshold: (Output) Almost Empty Threshold value (0 - 1023).
p_outafThreshold: (Output) Almost Full Threshold value (0 - 1023).
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_AR579_GetRxStoreOnErrorEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_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_AR579_GetTransmitSendMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_GetTransmitSendMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ar579_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_AR579_TX_SENDMODE_IMMED
   Triggered FIFO Mode        NAIBRD_AR579_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_AR579_GetTxBITEnable()

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

Reads the Tx Built-in-Test Enable / Disable 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) BIT Disabled (FALSE) or Enabled (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_AR579_GetTxFifoBounded()

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

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 (FALSE) or Enabled (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_AR579_GetTxFifoThresholds()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_GetTxFifoThresholds ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * p_outaeThreshold,
int32_t * p_outafThreshold )

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_outaeThreshold: (Output) Tx Almost Empty FIFO threshold value.
p_outafThreshold: (Output) Tx Almost Full 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_AR579_GetTxGapTime()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_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_AR579_GetTxRiseAndFallTime()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_GetTxRiseAndFallTime ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ar579_slope_control_t * p_outtxRiseFallTime )

Reads the currently set rise/fall time of the ARINC transmitter.

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_outtxRiseFallTime: (Output) Current setting: 
   NAIBRD_AR579_RISE_FALL_TIME_10_US        1.5 us rise/fall time
   NAIBRD_AR579_RISE_FALL_TIME_1_5_US       10 us rise/fall time
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_AR579_SetBITErrorThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_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).

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]).
bitErrorThreshold: (Input) BIT Error Threshold.
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_AR579_SetParityBitUsage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_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_AR579_SetRxBITEnable()

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

Enables or disables Rx Built-in-Test 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]).
enable: (Input) BIT Enable (TRUE) or Disable (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_AR579_SetRxFifoBounded()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_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.

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 (FALSE) or Enable (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_AR579_SetRxFifoThresholds()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_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.

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]).
aeThreshold: (Input) Almost Empty Threshold value (0 - 1023).
afThreshold: (Input) Almost Full Threshold value (0 - 1023).
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.
  • NAI_ERROR_INVALID_VALUE when invalid aethreshold or afthreshold value is supplied.

◆ naibrd_AR579_SetRxStoreOnErrorEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_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_AR579_SetTransmitSendMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_SetTransmitSendMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ar579_tx_mode_t txSendMode )

This function sets the Transmit mode of the specified channel. Two 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().

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_AR579_TX_SENDMODE_IMMED
   Triggered FIFO Mode        NAIBRD_AR579_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_AR579_SetTxBITEnable()

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

Enables or disables Tx Built-in-Test 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]).
enable: (Input) BIT Enable (TRUE) or Disable (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_AR579_SetTxFifoThresholds()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_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.

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]).
aeThreshold: (Input) Tx Almost Empty FIFO threshold value (0 - 1023).
afThreshold: (Input) Tx Almost Full FIFO threshold value (0 - 1023).
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_AR579_SetTxGapTime()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_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.

◆ naibrd_AR579_SetTxRiseAndFallTime()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_SetTxRiseAndFallTime ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ar579_slope_control_t txRiseFallTime )

Set the rise/fall time of the ARINC transmitter.

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]).
txRiseFallTime: (Input) Set slope control. 
   NAIBRD_AR579_RISE_FALL_TIME_10_US        1.5 us rise/fall time
   NAIBRD_AR579_RISE_FALL_TIME_1_5_US       10 us rise/fall time
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.