Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
1553 Summary Status and Interrupt Functions
1553 Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_1553_GetRxSummaryStatus (int32_t cardIndex, int32_t module, nai_1553_status_type_t type, nai_1553_chan_mapped_status_t *outstatusword)
 Reports the Dynamic or Latched Rx Data Available status of all channels. This function is only supported in Message FIFO mode.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_1553_ClearRxSummaryStatus (int32_t cardIndex, int32_t module, nai_1553_chan_mapped_status_t statusword)
 Clears the Rx Data Available status latch register bit for the specified channel. When Rx Data become available 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. This function is only supported in Message FIFO mode.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_1553_SetRxSummaryInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Sets the Rx Data Available Interrupt Enable of the channel specified. This function is only supported in Message FIFO mode.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_1553_GetRxSummaryInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outenable)
 Gets the Rx Data Available Interrupt Enable state of the channel specified. This function is only supported in Message FIFO mode.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_1553_SetRxSummaryInterruptVector (int32_t cardIndex, int32_t module, int32_t vector)
 Sets the Rx Data Available Interrupt Vector. This function is only supported in Message FIFO mode.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_1553_GetRxSummaryInterruptVector (int32_t cardIndex, int32_t module, int32_t *outvector)
 Gets the Rx Data Available Interrupt Vector. This function is only supported in Message FIFO mode.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_1553_SetRxSummaryInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, bool_t edgeLevel)
 Sets the Rx Data Available Interrupt Edge/Level register value for the specified 1553 channel. This function is only supported in Message FIFO mode.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_1553_GetRxSummaryInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outEdgeLevel)
 Retrieves the Rx Data Available Interrupt Edge/Level register value for the specified 1553 channel. This function is only supported in Message FIFO mode.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_1553_SetRxSummaryInterruptSteering (int32_t cardIndex, int32_t module, naibrd_int_steering_t steering)
 Sets the Rx Data Available Interrupt Steering to indicate where to direct the interrupt signal. This function is only supported in Message FIFO mode.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_1553_GetRxSummaryInterruptSteering (int32_t cardIndex, int32_t module, naibrd_int_steering_t *outsteering)
 Gets the Rx Data Available Interrupt Steering, which indicates where to direct the interrupt signal. This function is only supported in Message FIFO mode.
 

Detailed Description


Function Documentation

◆ naibrd_1553_ClearRxSummaryStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_1553_ClearRxSummaryStatus ( int32_t cardIndex,
int32_t module,
nai_1553_chan_mapped_status_t statusword )

Clears the Rx Data Available status latch register bit for the specified channel. When Rx Data become available 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. This function is only supported in Message FIFO 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]).
statusword: (Input) Status bit(s) to clear. This can be an OR'ed combination of the following: 
   M1553_CHAN_MAPPED_STATUS_CHAN_1
   M1553_CHAN_MAPPED_STATUS_CHAN_2
   M1553_CHAN_MAPPED_STATUS_CHAN_3
   M1553_CHAN_MAPPED_STATUS_CHAN_4
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_1553_GetRxSummaryInterruptEdgeLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_1553_GetRxSummaryInterruptEdgeLevel ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * outEdgeLevel )

Retrieves the Rx Data Available Interrupt Edge/Level register value for the specified 1553 channel. This function is only supported in Message FIFO mode.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_1553_GetRxSummaryInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * outenable )

Gets the Rx Data Available Interrupt Enable state of the channel specified. This function is only supported in Message FIFO 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]).
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_1553_GetRxSummaryInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_1553_GetRxSummaryInterruptSteering ( int32_t cardIndex,
int32_t module,
naibrd_int_steering_t * outsteering )

Gets the Rx Data Available Interrupt Steering, which indicates where to direct the interrupt signal. This function is only supported in Message FIFO 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]).
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_1553_GetRxSummaryInterruptVector()

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

Gets the Rx Data Available Interrupt Vector. This function is only supported in Message FIFO 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]).
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_1553_GetRxSummaryStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_1553_GetRxSummaryStatus ( int32_t cardIndex,
int32_t module,
nai_1553_status_type_t type,
nai_1553_chan_mapped_status_t * outstatusword )

Reports the Dynamic or Latched Rx Data Available status of all channels. This function is only supported in Message FIFO 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]).
type: (Input) Status Type (NAI_1553_STATUS_LATCHED or NAI_1553_STATUS_REALTIME).
outstatusword: (Output) Rx Data Available status word (bits 0 to 3 correspond to channels 1 to 4, respectively). Each bit can be set to either Rx Data Available (1) or No Data Available (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_1553_SetRxSummaryInterruptEdgeLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_1553_SetRxSummaryInterruptEdgeLevel ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t edgeLevel )

Sets the Rx Data Available Interrupt Edge/Level register value for the specified 1553 channel. This function is only supported in Message FIFO mode.

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

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

Sets the Rx Data Available Interrupt Enable of the channel specified. This function is only supported in Message FIFO 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]).
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_1553_SetRxSummaryInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_1553_SetRxSummaryInterruptSteering ( int32_t cardIndex,
int32_t module,
naibrd_int_steering_t steering )

Sets the Rx Data Available Interrupt Steering to indicate where to direct the interrupt signal. This function is only supported in Message FIFO 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]).
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_1553_SetRxSummaryInterruptVector()

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

Sets the Rx Data Available Interrupt Vector. This function is only supported in Message FIFO 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]).
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.