Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Channel Mapped Interrupt Functions (BIT & Summary (Rx Data Available))
NAI Board Library - Module Functions » SER Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetChanMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_chan_mapped_status_type_t statusType, bool_t enable)
 This function is used to enable interrupt generation on a single channel mapped status bit. Only BIT or Summary (Rx Data Available) events are supported in this function. Refer to naibrd_SER_SetEventMappedInterruptEnable() to set the interrupt enable/disable setting of event-mapped statuses.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChanMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_chan_mapped_status_type_t statusType, bool_t *p_outenable)
 Get the interrupt enable state for a channel mapped status bit. Only BIT and Summary (Rx Data Available) interrupts are supported in this function. Refer to naibrd_SER_GetEventMappedInterruptEnable() to retrieve the interrupt enable/disable setting of event-mapped statuses.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetChanMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_chan_mapped_status_type_t statusType, naibrd_int_trigger_type_t triggerType)
 Sets the Interrupt trigger mode (edge or level) for a channel mapped status bit. Only BIT and Summary (Rx Data Available) interrupts are supported in this function. Refer to naibrd_SER_SetEventMappedInterruptTriggerType() to set the interrupt trigger mode of event mapped statuses.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChanMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_chan_mapped_status_type_t statusType, naibrd_int_trigger_type_t *p_outtriggerType)
 Gets the Interrupt trigger mode (edge or level) for a channel mapped status bit. Only BIT and Summary (Rx Data Available) interrupts are supported in this function. Refer to naibrd_SER_GetEventMappedInterruptTriggerType() to retrieve the interrupt trigger mode of event mapped statuses.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetChanMappedInterruptVector (int32_t cardIndex, int32_t module, naibrd_ser_chan_mapped_status_type_t statusType, uint32_t vector)
 Sets the Interrupt Vector of the status type specified. The Interrupt Service callback routine passes in this vector value to identify the status that generated the interrupt. This function is only for BIT and Summary (Rx Data Available) interrupts.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChanMappedInterruptVector (int32_t cardIndex, int32_t module, naibrd_ser_chan_mapped_status_type_t statusType, uint32_t *p_outvector)
 Returns the Interrupt Vector of the status type specified. The Interrupt Service callback routine passes in this vector value to identify the status that generated the interrupt. This function is only for BIT and Summary (Rx Data Available) interrupts.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetChanMappedInterruptSteering (int32_t cardIndex, int32_t module, naibrd_ser_chan_mapped_status_type_t statusType, naibrd_int_steering_t steering)
 Sets the Interrupt Steering, which indicates where to direct the interrupt signal, for the specified BIT or Summary (Rx Data Available) status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChanMappedInterruptSteering (int32_t cardIndex, int32_t module, naibrd_ser_chan_mapped_status_type_t statusType, naibrd_int_steering_t *p_outsteering)
 Retrieves the Interrupt Steering, which indicates where to direct the interrupt signal, for the specified BIT or Summary (Rx Data Available) status.
 

Detailed Description

Function Documentation

◆ naibrd_SER_GetChanMappedInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChanMappedInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ser_chan_mapped_status_type_t statusType,
bool_t * p_outenable )

Get the interrupt enable state for a channel mapped status bit. Only BIT and Summary (Rx Data Available) interrupts are supported in this function. Refer to naibrd_SER_GetEventMappedInterruptEnable() to retrieve the interrupt enable/disable setting of event-mapped statuses.

Note
Our interrupts are fired from the latched status, regardless if the user selects realtime or latched for the statusType parameter.
Parameters
cardIndex: (Input) Logical Card Index assigned to connect 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 to check. Refer to the naibrd_ser_chan_mapped_status_type_t definition.
p_outenable: (Output) Interrupt enable state (NAI_TRUE: Enabled, NAI_FALSE: 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_NOT_SUPPORTED when function is not supported.

◆ naibrd_SER_GetChanMappedInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChanMappedInterruptSteering ( int32_t cardIndex,
int32_t module,
naibrd_ser_chan_mapped_status_type_t statusType,
naibrd_int_steering_t * p_outsteering )

Retrieves the Interrupt Steering, which indicates where to direct the interrupt signal, for the specified BIT or Summary (Rx Data Available) status.

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_ser_chan_mapped_status_type_t definition.
p_outsteering: (Output) Interrupt Steering given by one the following: 
   (1) NAIBRD_INT_STEERING_VME             Direct interrupt to VME Bus
   (2) NAIBRD_INT_STEERING_ONBOARD_ARM     Interrupt to the Custom App on ARM / NAI Ethernet Listener App
   (5) NAIBRD_INT_STEERING_PCIE            Interrupt to PCIe Bus
   (6) NAIBRD_INT_STEERING_CPCI            Interrupt to CPCI Bus
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_SER_GetChanMappedInterruptTriggerType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChanMappedInterruptTriggerType ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ser_chan_mapped_status_type_t statusType,
naibrd_int_trigger_type_t * p_outtriggerType )

Gets the Interrupt trigger mode (edge or level) for a channel mapped status bit. Only BIT and Summary (Rx Data Available) interrupts are supported in this function. Refer to naibrd_SER_GetEventMappedInterruptTriggerType() to retrieve the interrupt trigger mode of event mapped statuses.

Note
Our interrupts are fired from the latched status, regardless if the user selects realtime or latched for the statusType parameter.
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_ser_chan_mapped_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 is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SER_GetChanMappedInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChanMappedInterruptVector ( int32_t cardIndex,
int32_t module,
naibrd_ser_chan_mapped_status_type_t statusType,
uint32_t * p_outvector )

Returns the Interrupt Vector of the status type specified. The Interrupt Service callback routine passes in this vector value to identify the status that generated the interrupt. This function is only for BIT and Summary (Rx Data Available) interrupts.

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) The status interrupt who's steering we want to get.
p_outvector: (Output) Interrupt vector (0x00 - 0xFF).
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 parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SER_SetChanMappedInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetChanMappedInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ser_chan_mapped_status_type_t statusType,
bool_t enable )

This function is used to enable interrupt generation on a single channel mapped status bit. Only BIT or Summary (Rx Data Available) events are supported in this function. Refer to naibrd_SER_SetEventMappedInterruptEnable() to set the interrupt enable/disable setting of event-mapped statuses.

Note
Our interrupts are fired from the latched status, regardless if the user selects realtime or latched for the statusType parameter.
Only SC3 with FPGA revision >= 1.0 has the Summary (Rx Data Available) status.
Parameters
cardIndex: (Input) Logical Card Index assigned to connect 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 to enable or disable. Refer to the naibrd_SER_chan_mapped_status_type_t definition.
enable: (Input) Enable (NAI_TRUE) or disable (NAI_FALSE) interrupts for the channel event.
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_NOT_SUPPORTED when the module does not support the specified statusType.

◆ naibrd_SER_SetChanMappedInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetChanMappedInterruptSteering ( int32_t cardIndex,
int32_t module,
naibrd_ser_chan_mapped_status_type_t statusType,
naibrd_int_steering_t steering )

Sets the Interrupt Steering, which indicates where to direct the interrupt signal, for the specified BIT or Summary (Rx Data Available) 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_ser_chan_mapped_status_type_t definition.
steering: (Input) Interrupt Steering. Select from the following: 
   (1) NAIBRD_INT_STEERING_VME             Direct interrupt to VME Bus
   (2) NAIBRD_INT_STEERING_ONBOARD_ARM     Interrupt to the Custom App on ARM / NAI Ethernet Listener App
   (5) NAIBRD_INT_STEERING_PCIE            Interrupt to PCIe Bus
   (6) NAIBRD_INT_STEERING_CPCI            Interrupt to CPCI Bus
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 statusType or steering is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SER_SetChanMappedInterruptTriggerType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetChanMappedInterruptTriggerType ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ser_chan_mapped_status_type_t statusType,
naibrd_int_trigger_type_t triggerType )

Sets the Interrupt trigger mode (edge or level) for a channel mapped status bit. Only BIT and Summary (Rx Data Available) interrupts are supported in this function. Refer to naibrd_SER_SetEventMappedInterruptTriggerType() to set the interrupt trigger mode of event mapped statuses.

Note
Our interrupts are fired from the latched status, regardless if the user selects realtime or latched for the statusType parameter.
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_ser_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 is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SER_SetChanMappedInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetChanMappedInterruptVector ( int32_t cardIndex,
int32_t module,
naibrd_ser_chan_mapped_status_type_t statusType,
uint32_t vector )

Sets the Interrupt Vector of the status type specified. The Interrupt Service callback routine passes in this vector value to identify the status that generated the interrupt. This function is only for BIT and Summary (Rx Data Available) interrupts.

Note
Our interrupts are fired from the latched status, regardless if the user selects realtime or latched for the statusType parameter.
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) The status interrupt who's vector we want to get.
vector: (Input) Interrupt vector (0x00 - 0xFF).
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 an incorrect parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.