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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_da_status_type_t type, bool_t enable)
 Sets the D/A BIT or Overcurrent Status Interrupt Enable state for the specified D/A channel. BIT Status and Overcurrent Status is part of the background testing. When the interrupt is enabled, a non-compliant channel will trigger an interrupt. By default, interrupts are disabled.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_da_status_type_t type, bool_t *outenable)
 Retrieves the D/A BIT or Overcurrent Status Interrupt Enable state for the specified D/A channel. BIT Status and Overcurrent Status is part of the background testing. When the interrupt is enabled, a non-compliant channel will trigger an interrupt. By default, interrupts are disabled.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetInterruptVector (int32_t cardIndex, int32_t module, nai_da_status_type_t type, uint32_t vector)
 Sets the Interrupt Vector associated with a Status Type for the specified D/A module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetInterruptVector (int32_t cardIndex, int32_t module, nai_da_status_type_t type, uint32_t *outvector)
 Retrieves a Interrupt Vector associated with a Status Type for the specified D/A module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetInterruptSteering (int32_t cardIndex, int32_t module, nai_da_status_type_t type, naibrd_int_steering_t steering)
 Sets the Interrupt Steering which indicates the interrupt direction for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetInterruptSteering (int32_t cardIndex, int32_t module, nai_da_status_type_t type, naibrd_int_steering_t *outsteering)
 Retrieves the Interrupt Steering which indicates the interrupt direction for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetInterruptEdgeLevel (int32_t cardIndex, int32_t module, nai_da_status_type_t type, uint32_t edgeLevel)
 Sets the Interrupt Edge/Level register value for the specified DA channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetInterruptEdgeLevel (int32_t cardIndex, int32_t module, nai_da_status_type_t type, uint32_t *outEdgeLevel)
 Retrieves the Interrupt Edge/Level register value for the specified DA channel.
 

Detailed Description


Function Documentation

◆ naibrd_DA_GetInterruptEdgeLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetInterruptEdgeLevel ( int32_t cardIndex,
int32_t module,
nai_da_status_type_t type,
uint32_t * outEdgeLevel )

Retrieves the Interrupt Edge/Level register value for the specified DA channel.

Note: NAI_DA_STATUS_OVERCURRENT_ALERT is mapped to the 'Current Range Exceeded' edge/level register. Please specify NAI_DA_STATUS_OVERCURRENT_ALERT_LATCHED when accessing the 'Current Range Exceeded' edge/level register.

Note: The Watchdog Timer Fault Interrupt Edge/Level setting is mapped to the MSB (bit 31) of the Watchdog Timer Fault/CRC Fault Interrupt Edge/Level setting register. The CRC Fault Interrupt Edge/Level settings of each channel are channel-mapped in this register, starting with bit 0 for channel 1.

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]).
type: (Input) Status Type: refer to nai_da_status_type_t definition.
outEdgeLevel: (Output)Bitmask of the trigger Mode of interrupts (0 = EDGE, 1 = LEVEL).
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_GetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_da_status_type_t type,
bool_t * outenable )

Retrieves the D/A BIT or Overcurrent Status Interrupt Enable state for the specified D/A channel. BIT Status and Overcurrent Status is part of the background testing. When the interrupt is enabled, a non-compliant channel will trigger an interrupt. By default, interrupts are disabled.

Note: NAI_DA_STATUS_OVERCURRENT_ALERT is mapped to the 'Current Range Exceeded' interrupt enable register. Please specify NAI_DA_STATUS_OVERCURRENT_ALERT_LATCHED when accessing the 'Current Range Exceeded' interrupt enable register.

Note: The Watchdog Timer Fault Interrupt Enable setting is mapped to the MSB (bit 31) of the Watchdog Timer Fault/CRC Fault Interrupt Enable setting register. The CRC Fault Interrupt Enable settings of each channel are channel-mapped in this register, starting with bit 0 for channel 1.

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]).
type: (Input) Status Type: refer to nai_da_status_type_t definition.
outenable: (Output) 0 to disable, 1 to enable interrupt.
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_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_GetInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetInterruptSteering ( int32_t cardIndex,
int32_t module,
nai_da_status_type_t type,
naibrd_int_steering_t * outsteering )

Retrieves the Interrupt Steering which indicates the interrupt direction for the specified channel.

Note: NAI_DA_STATUS_OVERCURRENT_ALERT is mapped to the 'Current Range Exceeded' steering register. Please specify NAI_DA_STATUS_OVERCURRENT_ALERT_LATCHED when accessing the 'Current Range Exceeded' steering register.

Note: The Watchdog Timer Fault Interrupt and the CRC Fault Interrupt both share the same interrupt number.

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]).
type: (Input) Status Type: refer to nai_da_status_type_t definition.
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_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_DA_GetInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetInterruptVector ( int32_t cardIndex,
int32_t module,
nai_da_status_type_t type,
uint32_t * outvector )

Retrieves a Interrupt Vector associated with a Status Type for the specified D/A module.

Note: NAI_DA_STATUS_OVERCURRENT_ALERT is mapped to the 'Current Range Exceeded' interrupt vector. Please specify NAI_DA_STATUS_OVERCURRENT_ALERT_LATCHED when accessing the 'Current Range Exceeded' interrupt vector register.

Note: The Watchdog Timer Fault Interrupt and the CRC Fault Interrupt both share the same interrupt number.

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]).
type: (Input) Status Type: refer to nai_da_status_type_t definition.
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_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_SetInterruptEdgeLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetInterruptEdgeLevel ( int32_t cardIndex,
int32_t module,
nai_da_status_type_t type,
uint32_t edgeLevel )

Sets the Interrupt Edge/Level register value for the specified DA channel.

Note: NAI_DA_STATUS_OVERCURRENT_ALERT is mapped to the 'Current Range Exceeded' edge/level register. Please specify NAI_DA_STATUS_OVERCURRENT_ALERT_LATCHED when accessing the 'Current Range Exceeded' edge/level register.

Note: The Watchdog Timer Fault Interrupt Edge/Level setting is mapped to the MSB (bit 31) of the Watchdog Timer Fault/CRC Fault Interrupt Edge/Level setting register. The CRC Fault Interrupt Edge/Level settings of each channel are channel-mapped in this register, starting with bit 0 for channel 1.

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]).
type: (Input) Status Type: refer to nai_da_status_type_t definition.
edgeLevel: (Input) Bitmask of the trigger Mode of interrupts (0 = EDGE, 1 = LEVEL).
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_SetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_da_status_type_t type,
bool_t enable )

Sets the D/A BIT or Overcurrent Status Interrupt Enable state for the specified D/A channel. BIT Status and Overcurrent Status is part of the background testing. When the interrupt is enabled, a non-compliant channel will trigger an interrupt. By default, interrupts are disabled.

Note: NAI_DA_STATUS_OVERCURRENT_ALERT is mapped to the 'Current Range Exceeded' interrupt enable register. Please specify NAI_DA_STATUS_OVERCURRENT_ALERT_LATCHED when accessing the 'Current Range Exceeded' interrupt enable register.

Note: The Watchdog Timer Fault Interrupt Enable setting is mapped to the MSB (bit 31) of the Watchdog Timer Fault/CRC Fault Interrupt Enable setting register. The CRC Fault Interrupt Enable settings of each channel are channel-mapped in this register, starting with bit 0 for channel 1.

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]).
type: (Input) Status Type: refer to nai_da_status_type_t definition.
enable: (Input) 0 to disable, 1 to enable interrupt.
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_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_SetInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetInterruptSteering ( int32_t cardIndex,
int32_t module,
nai_da_status_type_t type,
naibrd_int_steering_t steering )

Sets the Interrupt Steering which indicates the interrupt direction for the specified channel.

Note: NAI_DA_STATUS_OVERCURRENT_ALERT is mapped to the 'Current Range Exceeded' steering register. Please specify NAI_DA_STATUS_OVERCURRENT_ALERT_LATCHED when accessing the 'Current Range Exceeded' steering register.

Note: The Watchdog Timer Fault Interrupt and the CRC Fault Interrupt both share the same interrupt number.

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]).
type: (Input) Status Type: refer to nai_da_status_type_t definition.
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_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_DA_SetInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetInterruptVector ( int32_t cardIndex,
int32_t module,
nai_da_status_type_t type,
uint32_t vector )

Sets the Interrupt Vector associated with a Status Type for the specified D/A module.

Note: NAI_DA_STATUS_OVERCURRENT_ALERT is mapped to the 'Current Range Exceeded' interrupt vector. Please specify NAI_DA_STATUS_OVERCURRENT_ALERT_LATCHED when accessing the Current Range Exceeded' interrupt vector register.

Note: The Watchdog Timer Fault Interrupt and the CRC Fault Interrupt both share the same interrupt number.

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]).
type: (Input) Status Type: refer to nai_da_status_type_t definition.
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_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.