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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_SetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_rtd_status_type_t type, uint32_t statusintenab)
 Sets the RTD BIT or Open Status Interrupt Enable state for the specified RTD channel. BIT Status and Open Status are part of the background testing. When the interrupt is enabled, a non-compliant channel will trigger an interrupt. By default, interrupts are disabled. Module Summary Status: Feature supported in FPGA Version >= X.X.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_rtd_status_type_t type, uint32_t *outstatusintenab)
 Retrieves the RTD BIT or Open Status Interrupt Enable state for the specified RTD channel. BIT Status and Open Status are part of the background testing. When the interrupt is enabled, a non-compliant channel will trigger an interrupt. By default, interrupts are disabled. Module Summary Status: Feature supported in FPGA Version >= X.X.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_SetInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, nai_rtd_status_type_t type, nai_rtd_interrupt_t interruptType)
 Sets the Interrupt Edge/Level property for the specified channel and interrupt status type. Module Summary Status: Feature supported in FPGA Version >= X.X.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, nai_rtd_status_type_t type, nai_rtd_interrupt_t *outinterruptType)
 Retrieves the Interrupt Edge/Level property for the specified channel and interrupt status type. Module Summary Status: Feature supported in FPGA Version >= X.X.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_SetInterruptVector (int32_t cardIndex, int32_t module, nai_rtd_status_type_t type, uint32_t interruptvector)
 Sets the RTD BIT or Open Status Interrupt Vector for the specified RTD module. Module Summary Status: Feature supported in FPGA Version >= X.X.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetInterruptVector (int32_t cardIndex, int32_t module, nai_rtd_status_type_t type, uint32_t *outinterruptvector)
 Retrieves the RTD BIT or Open Status Interrupt Vector for the specified RTD module. Module Summary Status: Feature supported in FPGA Version >= X.X.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_SetInterruptSteering (int32_t cardIndex, int32_t module, nai_rtd_status_type_t type, naibrd_int_steering_t steering)
 Sets the Interrupt Steering which indicates the interrupt direction for the specified interrupt status type. Module Summary Status: Feature supported in FPGA Version >= X.X.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetInterruptSteering (int32_t cardIndex, int32_t module, nai_rtd_status_type_t type, naibrd_int_steering_t *outsteering)
 Retrieves the Interrupt Steering which indicates the interrupt direction for the specified interrupt status type. Module Summary Status: Feature supported in FPGA Version >= X.X.
 

Detailed Description


Function Documentation

◆ naibrd_RTD_GetInterruptEdgeLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetInterruptEdgeLevel ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_rtd_status_type_t type,
nai_rtd_interrupt_t * outinterruptType )

Retrieves the Interrupt Edge/Level property for the specified channel and interrupt status type. Module Summary Status: Feature supported in FPGA Version >= X.X.

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_rtd_status_type_t definition.
outinterruptType: (Output) Interrupt Type: refer to nai_rtd_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_RTD_GetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_rtd_status_type_t type,
uint32_t * outstatusintenab )

Retrieves the RTD BIT or Open Status Interrupt Enable state for the specified RTD channel. BIT Status and Open Status are part of the background testing. When the interrupt is enabled, a non-compliant channel will trigger an interrupt. By default, interrupts are disabled. Module Summary Status: Feature supported in FPGA Version >= X.X.

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_rtd_status_type_t definition
outstatusintenab: (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_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_RTD_GetInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetInterruptSteering ( int32_t cardIndex,
int32_t module,
nai_rtd_status_type_t type,
naibrd_int_steering_t * outsteering )

Retrieves the Interrupt Steering which indicates the interrupt direction for the specified interrupt status type. Module Summary Status: Feature supported in FPGA Version >= X.X.

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_rtd_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 type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_RTD_GetInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetInterruptVector ( int32_t cardIndex,
int32_t module,
nai_rtd_status_type_t type,
uint32_t * outinterruptvector )

Retrieves the RTD BIT or Open Status Interrupt Vector for the specified RTD module. Module Summary Status: Feature supported in FPGA Version >= X.X.

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_rtd_status_type_t definition
outinterruptvector: (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_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_RTD_SetInterruptEdgeLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_SetInterruptEdgeLevel ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_rtd_status_type_t type,
nai_rtd_interrupt_t interruptType )

Sets the Interrupt Edge/Level property for the specified channel and interrupt status type. Module Summary Status: Feature supported in FPGA Version >= X.X.

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_rtd_status_type_t definition.
interruptType: (Input) Interrupt Type: refer to nai_rtd_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 or invalid interruptType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_RTD_SetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_SetInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_rtd_status_type_t type,
uint32_t statusintenab )

Sets the RTD BIT or Open Status Interrupt Enable state for the specified RTD channel. BIT Status and Open Status are part of the background testing. When the interrupt is enabled, a non-compliant channel will trigger an interrupt. By default, interrupts are disabled. Module Summary Status: Feature supported in FPGA Version >= X.X.

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_rtd_status_type_t definition
statusintenab: (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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter or invalid statusintenab parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_RTD_SetInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_SetInterruptSteering ( int32_t cardIndex,
int32_t module,
nai_rtd_status_type_t type,
naibrd_int_steering_t steering )

Sets the Interrupt Steering which indicates the interrupt direction for the specified interrupt status type. Module Summary Status: Feature supported in FPGA Version >= X.X.

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_rtd_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 type parameter or invalid steering parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_RTD_SetInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_SetInterruptVector ( int32_t cardIndex,
int32_t module,
nai_rtd_status_type_t type,
uint32_t interruptvector )

Sets the RTD BIT or Open Status Interrupt Vector for the specified RTD module. Module Summary Status: Feature supported in FPGA Version >= X.X.

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_rtd_status_type_t definition
interruptvector: (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_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.