Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
FIFO Interrupt Functions
D/A Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetFIFOInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_da_fifo_status_t mask)
 Sets the D/A Interrupt Enable setting for the specified D/A channel's FIFO Buffer.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetFIFOInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_da_fifo_status_t *outmask)
 Retrieves the D/A Interrupt Enable setting for the specified D/A channel's FIFO Buffer.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetFIFOInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, uint16_t vector)
 Sets the Interrupt Vector for the specified D/A channel's FIFO Buffer.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetFIFOInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, uint16_t *outvector)
 Retrieves the Interrupt Vector for the specified D/A channel's FIFO Buffer.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetFIFOInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_int_steering_t steering)
 Sets the steering for FIFO Interrupts on the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetFIFOInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_int_steering_t *outsteering)
 Gets the steering for FIFO Interrupts on the specified channel.
 

Detailed Description


Function Documentation

◆ naibrd_DA_GetFIFOInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetFIFOInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_da_fifo_status_t * outmask )

Retrieves the D/A Interrupt Enable setting for the specified D/A channel's FIFO Buffer. 

FIFO Buffer Interrupt Bit Format:
(LSB) B0 - Empty        Interrupt when the D/A channel's FIFO counter is zero.
B1 - Low Limit    Interrupt when the D/A channel's FIFO counter is less than or equal to the Low Threshold.
B2 - High Limit   Interrupt when the D/A channel's FIFO counter is greater than or equal to the High Threshold.
B3 - Full         Interrupt when the D/A channel's FIFO counter is equal to 26,213.
B4 - Sample Done  Interrupt when the D/A channel's FIFO counter is equal to the FIFO size after the trigger occurs.
B5 - Reserved
B6 - Reserved
(MSB) B7 - Reserved

FIFO Buffer Interrupt Bit Format (GEN5):
(LSB) B0 - Empty        Interrupt when the D/A channel's FIFO counter is zero.
B1 - Almost Empty Interrupt when the D/A channel's FIFO counter is greater than or equal to the Almost Empty Threshold.
B2 - Low Limit    Interrupt when the D/A channel's FIFO counter is less than or equal to the Low Threshold.
B3 - High Limit   Interrupt when the D/A channel's FIFO counter is greater than or equal to the High Threshold.
B4 - Almost Full  Interrupt when the D/A channel's FIFO counter is greater than or equal to the Almost Full Threshold.
B5 - Full         Interrupt when the D/A channel's FIFO counter is equal to NAI_DA_GEN5_FIFO_MAX_SIZE.
B6 - Sample Done  Interrupt when the D/A channel's FIFO counter is equal to the FIFO size after the trigger occurs.
(MSB) B7 - Reserved
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]).
outmask: (Output) D/A FIFO Buffer Interrupt Enable Settings.
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_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_DA_GetFIFOInterruptSteering()

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

Gets the steering for FIFO Interrupts on 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: (Input) The interrupt steering configuration for channel
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_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_DA_GetFIFOInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetFIFOInterruptVector ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint16_t * outvector )

Retrieves the Interrupt Vector for the specified D/A channel's FIFO Buffer.

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]).
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_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_DA_SetFIFOInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetFIFOInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_da_fifo_status_t mask )

Sets the D/A Interrupt Enable setting for the specified D/A channel's FIFO Buffer. 

FIFO Buffer Interrupt Bit Format (GEN3):
(LSB) B0 - Empty        Interrupt when the D/A channel's FIFO counter is zero.
B1 - Low Limit    Interrupt when the D/A channel's FIFO counter is less than or equal to the Low Threshold.
B2 - High Limit   Interrupt when the D/A channel's FIFO counter is greater than or equal to the High Threshold.
B3 - Full         Interrupt when the D/A channel's FIFO counter is equal to NAI_DA_GEN3_FIFO_MAX_SIZE (26,213).
B4 - Sample Done  Interrupt when the D/A channel's FIFO counter is equal to the FIFO size after the trigger occurs.
B5 - Reserved
B6 - Reserved
(MSB) B7 - Reserved

FIFO Buffer Interrupt Bit Format (GEN5):
(LSB) B0 - Empty        Interrupt when the D/A channel's FIFO counter is zero.
B1 - Almost Empty Interrupt when the D/A channel's FIFO counter is greater than or equal to the Almost Empty Threshold.
B2 - Low Limit    Interrupt when the D/A channel's FIFO counter is less than or equal to the Low Threshold.
B3 - High Limit   Interrupt when the D/A channel's FIFO counter is greater than or equal to the High Threshold.
B4 - Almost Full  Interrupt when the D/A channel's FIFO counter is greater than or equal to the Almost Full Threshold.
B5 - Full         Interrupt when the D/A channel's FIFO counter is equal to NAI_DA_GEN5_FIFO_MAX_SIZE.
B6 - Sample Done  Interrupt when the D/A channel's FIFO counter is equal to the FIFO size after the trigger occurs.
(MSB) B7 - Reserved
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]).
mask: (Input) D/A FIFO Buffer Interrupt Enable Settings.
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_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_DA_SetFIFOInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetFIFOInterruptSteering ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_int_steering_t steering )

Sets the steering for FIFO Interrupts on 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) The interrupt steering configuration for channel
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_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_DA_SetFIFOInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetFIFOInterruptVector ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint16_t vector )

Sets the Interrupt Vector for the specified D/A channel's FIFO Buffer.

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]).
vector: (Input) 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_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.