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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_FG_SetChanMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_fg_chan_mapped_status_type_t statusType, bool_t enable)
 Sets the Interrupt Enable for the specified channel and interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_FG_GetChanMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_fg_chan_mapped_status_type_t statusType, bool_t *p_outenable)
 Retrieves the Interrupt Enable for the specified channel and interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_FG_SetChanMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_fg_chan_mapped_status_type_t statusType, naibrd_int_trigger_type_t triggerType)
 Sets the Interrupt Edge/Level property for the specified Discrete channel and interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_FG_GetChanMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_fg_chan_mapped_status_type_t statusType, naibrd_int_trigger_type_t *p_outtriggerType)
 Retrieves the Interrupt Edge/Level property for the specified channel and interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_FG_SetChanMappedInterruptVector (int32_t cardIndex, int32_t module, naibrd_fg_chan_mapped_status_type_t statusType, uint32_t vector)
 Sets the Interrupt Vector for the specified channel and interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_FG_GetChanMappedInterruptVector (int32_t cardIndex, int32_t module, naibrd_fg_chan_mapped_status_type_t statusType, uint32_t *p_outVector)
 Retrieves the Interrupt Vector for the specified channel and interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_FG_SetChanMappedInterruptSteering (int32_t cardIndex, int32_t module, naibrd_fg_chan_mapped_status_type_t statusType, naibrd_int_steering_t steering)
 Sets the Interrupt Steering which indicates the interrupt direction for the specified interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_FG_GetChanMappedInterruptSteering (int32_t cardIndex, int32_t module, naibrd_fg_chan_mapped_status_type_t statusType, naibrd_int_steering_t *p_outSteering)
 Retrieves the Interrupt Steering which indicates the interrupt direction for the specified interrupt status type.
 

Detailed Description

Function Documentation

◆ naibrd_FG_GetChanMappedInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_FG_GetChanMappedInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_fg_chan_mapped_status_type_t statusType,
bool_t * p_outenable )

Retrieves the Interrupt Enable 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]).
statusType: (Input) Status Type: refer to naibrd_fg_chan_mapped_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.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_FG_GetChanMappedInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_FG_GetChanMappedInterruptSteering ( int32_t cardIndex,
int32_t module,
naibrd_fg_chan_mapped_status_type_t statusType,
naibrd_int_steering_t * p_outSteering )

Retrieves the Interrupt Steering which indicates the interrupt direction for the specified 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]).
statusType: (Input) Status Type: refer to nai_fg_status_type_t definition.
p_outSteering: (Output) Interrupt Steering.
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_FG_GetChanMappedInterruptTriggerType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_FG_GetChanMappedInterruptTriggerType ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_fg_chan_mapped_status_type_t statusType,
naibrd_int_trigger_type_t * p_outtriggerType )

Retrieves the Interrupt Edge/Level 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]).
statusType: (Input) Status Type: refer to nai_fg_status_type_t definition.
p_outtriggerType: (Output) Interrupt trigger type (NAIBRD_INT_TRIGGER_TYPE_EDGE or NAIBRD_INT_TRIGGER_TYPE_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.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_FG_GetChanMappedInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_FG_GetChanMappedInterruptVector ( int32_t cardIndex,
int32_t module,
naibrd_fg_chan_mapped_status_type_t statusType,
uint32_t * p_outVector )

Retrieves the Interrupt Vector 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]).
statusType: (Input) Status Type: refer to naibrd_fg_chan_mapped_status_type_t definition.
p_outVector: (Output) Interrupt Vector uint32_t.
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_FG_SetChanMappedInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_FG_SetChanMappedInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_fg_chan_mapped_status_type_t statusType,
bool_t enable )

Sets the Interrupt Enable 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]).
statusType: (Input) Status Type: refer to naibrd_fg_chan_mapped_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.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_FG_SetChanMappedInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_FG_SetChanMappedInterruptSteering ( int32_t cardIndex,
int32_t module,
naibrd_fg_chan_mapped_status_type_t statusType,
naibrd_int_steering_t steering )

Sets the Interrupt Steering which indicates the interrupt direction for the specified 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]).
statusType: (Input) Status Type: refer to naibrd_fg_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_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_FG_SetChanMappedInterruptTriggerType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_FG_SetChanMappedInterruptTriggerType ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_fg_chan_mapped_status_type_t statusType,
naibrd_int_trigger_type_t triggerType )

Sets the Interrupt Edge/Level property for the specified Discrete 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]).
statusType: (Input) Status Type: refer to naibrd_fg_chan_mapped_status_type_t definition.
triggerType: (Input) Interrupt trigger type (NAIBRD_INT_TRIGGER_TYPE_EDGE or NAIBRD_INT_TRIGGER_TYPE_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.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_FG_SetChanMappedInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_FG_SetChanMappedInterruptVector ( int32_t cardIndex,
int32_t module,
naibrd_fg_chan_mapped_status_type_t statusType,
uint32_t vector )

Sets the Interrupt Vector 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]).
statusType: (Input) Status Type: refer to naibrd_fg_chan_mapped_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 register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.