Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Interrupt Functions
NAI Board Library - Module Functions » VR Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetChanMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_vr_chan_mapped_status_type_t type, bool_t intEnable)
 Sets the Interrupt Enable associated with the Status Type for the specified channel. By default, interrupts are disabled.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetChanMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_vr_chan_mapped_status_type_t type, bool_t *p_outintEnable)
 Retrieves the Interrupt Enable associated with the Status Type from the specified channel. By default, interrupts are disabled.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetChanMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_vr_chan_mapped_status_type_t type, naibrd_int_trigger_type_t interruptType)
 Sets the Interrupt Edge/Level trigger type property for the specified channel and interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetChanMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_vr_chan_mapped_status_type_t type, naibrd_int_trigger_type_t *p_outinterruptType)
 Retrieves the Interrupt Edge/Level trigger type property for the specified channel and interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetChanMappedInterruptVector (int32_t cardIndex, int32_t module, naibrd_vr_chan_mapped_status_type_t type, uint32_t interruptVector)
 Sets the Interrupt Vector associated with the Status Type for the specified module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetChanMappedInterruptVector (int32_t cardIndex, int32_t module, naibrd_vr_chan_mapped_status_type_t type, uint32_t *p_outinterruptVector)
 Retrieves the Interrupt Vector associated with the Status Type for the specified module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetChanMappedInterruptSteering (int32_t cardIndex, int32_t module, naibrd_vr_chan_mapped_status_type_t type, naibrd_int_steering_t steering)
 Sets the Interrupt Steering, which indicates the interrupt direction, for the specified module and status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetChanMappedInterruptSteering (int32_t cardIndex, int32_t module, naibrd_vr_chan_mapped_status_type_t type, naibrd_int_steering_t *p_outsteering)
 Retrieves the Interrupt Steering, which indicates the interrupt direction, for the specified module and status type.
 

Detailed Description

Function Documentation

◆ naibrd_VR_GetChanMappedInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetChanMappedInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_vr_chan_mapped_status_type_t type,
bool_t * p_outintEnable )

Retrieves the Interrupt Enable associated with the Status Type from the specified channel. By default, interrupts are disabled.

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 naibrd_vr_chan_mapped_status_type_t definition.
p_outintEnable: (Output) 1 if interrupts are enabled, 0 if interrupts are disabled.
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_VR_GetChanMappedInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetChanMappedInterruptSteering ( int32_t cardIndex,
int32_t module,
naibrd_vr_chan_mapped_status_type_t type,
naibrd_int_steering_t * p_outsteering )

Retrieves the Interrupt Steering, which indicates the interrupt direction, for the specified module and status type.

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

◆ naibrd_VR_GetChanMappedInterruptTriggerType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetChanMappedInterruptTriggerType ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_vr_chan_mapped_status_type_t type,
naibrd_int_trigger_type_t * p_outinterruptType )

Retrieves the Interrupt Edge/Level trigger type property for the specified channel and interrupt status type.

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 naibrd_vr_chan_mapped_status_type_t definition.
p_outinterruptType: (Output) Interrupt Edge/Level trigger type: refer to naibrd_int_trigger_type_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_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_VR_GetChanMappedInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetChanMappedInterruptVector ( int32_t cardIndex,
int32_t module,
naibrd_vr_chan_mapped_status_type_t type,
uint32_t * p_outinterruptVector )

Retrieves the Interrupt Vector associated with the Status Type for the specified module.

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 naibrd_vr_chan_mapped_status_type_t definition.
p_outinterruptVector: (Output) Interrupt Vector read from module.
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_VR_SetChanMappedInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetChanMappedInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_vr_chan_mapped_status_type_t type,
bool_t intEnable )

Sets the Interrupt Enable associated with the Status Type for the specified channel. By default, interrupts are disabled.

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 naibrd_vr_chan_mapped_status_type_t definition.
intEnable: (Input) 1 to enable interrupts, 0 to disable interrupts.
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 or intEnable parameters are specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_VR_SetChanMappedInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetChanMappedInterruptSteering ( int32_t cardIndex,
int32_t module,
naibrd_vr_chan_mapped_status_type_t type,
naibrd_int_steering_t steering )

Sets the Interrupt Steering, which indicates the interrupt direction, for the specified module and status type.

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

◆ naibrd_VR_SetChanMappedInterruptTriggerType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetChanMappedInterruptTriggerType ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_vr_chan_mapped_status_type_t type,
naibrd_int_trigger_type_t interruptType )

Sets the Interrupt Edge/Level trigger type property for the specified channel and interrupt status type.

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 naibrd_vr_chan_mapped_status_type_t definition.
interruptType: (Input) Interrupt Edge/Level trigger type to set: refer to naibrd_int_trigger_type_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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type or interruptType parameters are specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_VR_SetChanMappedInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetChanMappedInterruptVector ( int32_t cardIndex,
int32_t module,
naibrd_vr_chan_mapped_status_type_t type,
uint32_t interruptVector )

Sets the Interrupt Vector associated with the Status Type for the specified module.

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 naibrd_vr_chan_mapped_status_type_t definition.
interruptVector: (Input) Interrupt Vector to set.
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.