Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Deprecated Functions
ARINC Module Functions

Functions

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.
 

Detailed Description


Function Documentation

◆ naibrd_AR_ClearBITStatus()

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.

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]).
statusword: (Input) Status bit(s) to clear. This can be an OR'ed combination of the following: 
   AR_BIT_STATUS_CHAN_1
   AR_BIT_STATUS_CHAN_2
   AR_BIT_STATUS_CHAN_3
   AR_BIT_STATUS_CHAN_4
   AR_BIT_STATUS_CHAN_5
   AR_BIT_STATUS_CHAN_6
   AR_BIT_STATUS_CHAN_7
   AR_BIT_STATUS_CHAN_8
   AR_BIT_STATUS_CHAN_9
   AR_BIT_STATUS_CHAN_10
   AR_BIT_STATUS_CHAN_11
   AR_BIT_STATUS_CHAN_12
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • 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_GetBITInterruptEdgeLevel()

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.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection 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]).
outEdgeLevel: (Output) 0 = EDGE, 1 = LEVEL.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_GetBITInterruptEnable()

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.

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_GetBITInterruptSteering()

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.

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]).
outsteering: (Output) Interrupt Steering: refer to naibrd_int_steering_t definition.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_GetBITInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetBITInterruptVector ( int32_t cardIndex,
int32_t module,
int32_t * outvector )

Gets the BIT Interrupt Vector.

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]).
outvector: (Output) Interrupt vector (0x00 - 0xFF).
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_GetBITStatus()

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.

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]).
type: (Input) Status Type (NAI_AR_STATUS_LATCHED or NAI_AR_STATUS_REALTIME).
outstatusword: (Output) BIT status word (bits 0 to 5 (for A4) or 11 (for AR1) correspond to channels 1 to 6 (for A4) or 12 (for AR1), respectively). The output of each bit is either Error Detected (1) or No Error (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_VALUE when invalid type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_SetBITInterruptEdgeLevel()

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.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection 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]).
edgeLevel: (Input) 0 = EDGE, 1 = LEVEL.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_SetBITInterruptEnable()

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.

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_SetBITInterruptSteering()

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.

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]).
steering: (Input) Interrupt Steering: refer to naibrd_int_steering_t definition.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_SetBITInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetBITInterruptVector ( int32_t cardIndex,
int32_t module,
int32_t vector )

Sets the BIT Interrupt Vector.

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]).
vector: (Input) Interrupt vector (0x00 - 0xFF).
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_NOT_SUPPORTED when function is not supported.