Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Message, Schedule, Validation I/O Functions
ARINC Module Functions

Functions

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.
 

Detailed Description


Function Documentation

◆ naibrd_AR_GetRxValidationEn()

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.

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]).
outenable: (Output) Enabled (1) or Disabled (0).
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_RdRxValMem()

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.

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]).
label: (Input) The lower 10 bits of the Arinc Word to match, also referred to as SDI/Label (0 - 1023).
outdata: (Output) 0 matching for this label disabled. 1 matching for this label enabled.
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_RdRxValMemRange()

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.

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]).
labello: (Input) The lower limit of SDI/Labels to set (0 - 1023).
labelhi: (Input) The upper limit of SDI/Labels to set. Must be greater than/equal to labello. (0 - 1023).
outdata: (Output) Array of zeros or ones where 0 disables matching and 1 enables matching. The first element in the array will be written to the memory location corresponding to labello. The second element in the array will be written to the memory location corresponding to labello + 1. The n-th element in the array will be written to the memory location corresponding to labello + n. The array size must equal labelhi - labello + 1.
  • 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 labello and/or labelhi parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_RdTxAsyncWd()

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.

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]).
outdata: (Output) 32-bit data.
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_RdTxMsgMem()

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.

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]).
address: (Input) Transmit Message memory address.
outdata: (Output) 32-bit data word.
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 address parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_RdTxSchMem()

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.

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]).
address: (Input) Transmit Schedule memory address (A4: 0 - 511, AR1: ).
outdata: (Output) 16-bit data word.
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 address parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_SetRxValidationEn()

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.

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 (1) or Disable (0).
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_WrRxValMem()

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.

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]).
label: (Input) The lower 10 bits of the Arinc Word to match, also referred to as SDI/Label (0 - 1023).
data: (Input) 0 to disable matching for this label. 1 to enable matching for this label.
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 label or data parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_WrRxValMemRange()

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.

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]).
labello: (Input) The lower limit of SDI/Labels to set (0 - 1023).
labelhi: (Input) The upper limit of SDI/Labels to set. Must be greater than/equal to labello. (0 - 1023).
enablearray: (Input) Array of zeros (FALSE) or ones (TRUE) for which 0 disables matching and 1 enables matching for the subset of SDI/Labels that are in the range of labello to labelhi. The value (either TRUE or FALSE) of array index 0 determines whether to enable or disable matching for labello. The value of array index 1 determines whether to enable or disable matching for labello + 1. The value of array index n determines whether to enable or disable matching for labello + n. The array size must equal labelhi - labello + 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_INVALID_VALUE when invalid labello and/or labelhi parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_WrTxAsyncWd()

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.

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]).
data: (Input) 32-bit data.
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_WrTxMsgMem()

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.

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]).
address: (Input) Transmit Message memory address.
data: (Input) 32-bit data word.
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 address parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_WrTxSchMem()

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.

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]).
address: (Input) Transmit Schedule memory address (0 - 511).
data: (Input) 16-bit data word.
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 address parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.