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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_dt_status_type_t type, bool_t enable)
 Sets the Interrupt Enable for the specified Discrete channel and interrupt status type. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_dt_status_type_t type, bool_t *p_outenable)
 Retrieves the Interrupt Enable for the specified Discrete channel and interrupt status type. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetEdgeLevelInterrupt (int32_t cardIndex, int32_t module, int32_t channel, nai_dt_status_type_t type, nai_dt_interrupt_t interruptType)
 Sets the Interrupt Edge/Level property for the specified Discrete channel and interrupt status type. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetEdgeLevelInterrupt (int32_t cardIndex, int32_t module, int32_t channel, nai_dt_status_type_t type, nai_dt_interrupt_t *p_outinterruptType)
 Retrieves the Interrupt Edge/Level property for the specified Discrete channel and interrupt status type. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetGroupInterruptVector (int32_t cardIndex, int32_t module, int32_t group, nai_dt_status_type_t type, uint32_t vector)
 Sets the Interrupt Vector for the specified Discrete channel and interrupt status type. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetGroupInterruptVector (int32_t cardIndex, int32_t module, int32_t group, nai_dt_status_type_t type, uint32_t *p_outvector)
 Retrieves the Interrupt Vector for the specified Discrete channel and interrupt status type. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetGroupInterruptSteering (int32_t cardIndex, int32_t module, int32_t group, nai_dt_status_type_t type, naibrd_int_steering_t steering)
 Sets the Interrupt Steering which indicates the interrupt direction for the specified Discrete group and interrupt status type. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetGroupInterruptSteering (int32_t cardIndex, int32_t module, int32_t group, nai_dt_status_type_t type, naibrd_int_steering_t *p_outsteering)
 Retrieves the Interrupt Steering which indicates the interrupt direction for the specified Discrete group and interrupt status type. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.
 

Detailed Description


Function Documentation

◆ naibrd_DT_GetEdgeLevelInterrupt()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetEdgeLevelInterrupt ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dt_status_type_t type,
nai_dt_interrupt_t * p_outinterruptType )

Retrieves the Interrupt Edge/Level property for the specified Discrete channel and interrupt status type. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.

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_dt_status_type_t definition.
p_outinterruptType: (Output) Interrupt Type: refer to nai_dt_interrupt_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_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_DT_GetGroupInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetGroupInterruptSteering ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_dt_status_type_t type,
naibrd_int_steering_t * p_outsteering )

Retrieves the Interrupt Steering which indicates the interrupt direction for the specified Discrete group and interrupt status type. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.

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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Status Type: refer to nai_dt_status_type_t definition.
p_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 parameter or invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_GetGroupInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetGroupInterruptVector ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_dt_status_type_t type,
uint32_t * p_outvector )

Retrieves the Interrupt Vector for the specified Discrete channel and interrupt status type. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.

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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Status Type: refer to nai_dt_status_type_t definition.
p_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 group parameter or invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_GetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dt_status_type_t type,
bool_t * p_outenable )

Retrieves the Interrupt Enable for the specified Discrete channel and interrupt status type. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.

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_dt_status_type_t definition.
p_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_DT_SetEdgeLevelInterrupt()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetEdgeLevelInterrupt ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dt_status_type_t type,
nai_dt_interrupt_t interruptType )

Sets the Interrupt Edge/Level property for the specified Discrete channel and interrupt status type. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.

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_dt_status_type_t definition.
interruptType: (Input) Interrupt Type: refer to nai_dt_interrupt_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_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_DT_SetGroupInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetGroupInterruptSteering ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_dt_status_type_t type,
naibrd_int_steering_t steering )

Sets the Interrupt Steering which indicates the interrupt direction for the specified Discrete group and interrupt status type. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.

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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Status Type: refer to nai_dt_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 parameter or invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_SetGroupInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetGroupInterruptVector ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_dt_status_type_t type,
uint32_t vector )

Sets the Interrupt Vector for the specified Discrete channel and interrupt status type. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.

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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Status Type: refer to nai_dt_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 group parameter or invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_SetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dt_status_type_t type,
bool_t enable )

Sets the Interrupt Enable for the specified Discrete channel and interrupt status type. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.

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_dt_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.