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

Functions

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.
 

Detailed Description


Function Documentation

◆ naibrd_AR_GetInterruptEdgeLevel()

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.

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) Bitmask of the interrupt events. Bits set to 0 are Edge-Triggered and those set to 1 are Level-Triggered. 
   Bit 15   -  Reserved
   Bit 14   -  Reserved
   Bit 13   -  Reserved
   Bit 12   -  Tx Complete
   Bit 11   -  Async Data Sent
   Bit 10   -  Schedule Interrupt
   Bit 9   -  Built In Test Error
   Bit 8   -  Receive Error
   Bit 7   -  Parity Error
   Bit 6   -  Reserved
   Bit 5   -  Tx FIFO Almost Empty
   Bit 4   -  Tx FIFO Empty
   Bit 3   -  Rx FIFO Overflow
   Bit 2   -  Rx FIFO Full
   Bit 1   -  Rx FIFO Almost Full
   Bit 0   -  Rx Data Available
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_GetInterruptEnable()

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.

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) Enable word. This word is an OR'ed combination of the following bits: 
   Bit 15   -  Reserved
   Bit 14   -  Reserved
   Bit 13   -  Reserved
   Bit 12   -  Tx Complete
   Bit 11   -  Async Data Sent
   Bit 10   -  Schedule Interrupt
   Bit 9   -  Built In Test Error
   Bit 8   -  Receive Error
   Bit 7   -  Parity Error
   Bit 6   -  Reserved
   Bit 5   -  Tx FIFO Almost Empty
   Bit 4   -  Tx FIFO Empty
   Bit 3   -  Rx FIFO Overflow
   Bit 2   -  Rx FIFO Full
   Bit 1   -  Rx FIFO Almost Full
   Bit 0   -  Rx Data Available
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_GetInterruptSteering()

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.

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]).
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 card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid group register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_GetInterruptVector()

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.

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]).
outvector: (Output) Interrupt vector.
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_SetInterruptEdgeLevel()

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.

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) 32-bit bitmask of interrupt events. Set bit to 0 for Edge-Triggered or 1 for Level-Triggered. 
   Bit 15   -  Reserved
   Bit 14   -  Reserved
   Bit 13   -  Reserved
   Bit 12   -  Tx Complete
   Bit 11   -  Async Data Sent
   Bit 10   -  Schedule Interrupt
   Bit 9   -  Built In Test Error
   Bit 8   -  Receive Error
   Bit 7   -  Parity Error
   Bit 6   -  Reserved
   Bit 5   -  Tx FIFO Almost Empty
   Bit 4   -  Tx FIFO Empty
   Bit 3   -  Rx FIFO Overflow
   Bit 2   -  Rx FIFO Full
   Bit 1   -  Rx FIFO Almost Full
   Bit 0   -  Rx Data Available
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_SetInterruptEnable()

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.

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 word. This word is an OR'ed combination of the following bits: 
   Bit 15   -  Reserved
   Bit 14   -  Reserved
   Bit 13   -  Reserved
   Bit 12   -  Tx Complete
   Bit 11   -  Async Data Sent
   Bit 10   -  Schedule Interrupt
   Bit 9   -  Built In Test Error
   Bit 8   -  Receive Error
   Bit 7   -  Parity Error
   Bit 6   -  Reserved
   Bit 5   -  Tx FIFO Almost Empty
   Bit 4   -  Tx FIFO Empty
   Bit 3   -  Rx FIFO Overflow
   Bit 2   -  Rx FIFO Full
   Bit 1   -  Rx FIFO Almost Full
   Bit 0   -  Rx Data Available
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_SetInterruptSteering()

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.

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]).
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 card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid group register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_SetInterruptVector()

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.

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]).
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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid vector parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.