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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetEventMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_event_mapped_status_type_t statusType, bool_t enable)
 Sets the Interrupt Enable for the specified Serial channel and interrupt status type. The interrupt statusType must be a latched status and be of the category NAIBRD_SER_EVENT_MAP_COMM.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetEventMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_event_mapped_status_type_t statusType, bool_t *p_outenable)
 Retrieves the Interrupt Enable for the specified Serial channel and interrupt status type. The interrupt statusType must be a latched status and be of the category NAIBRD_SER_EVENT_MAP_COMM.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetEventMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_event_mapped_status_type_t statusType, naibrd_int_trigger_type_t triggerType)
 Sets the Interrupt Edge/Level property for the specified Serial channel and interrupt status type. The interrupt statusType must be a latched status and be of the category NAIBRD_SER_EVENT_MAP_COMM.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetEventMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_event_mapped_status_type_t statusType, naibrd_int_trigger_type_t *p_outtriggerType)
 Gets the Interrupt Edge/Level property for the specified Serial channel and interrupt status type. The interrupt statusType must be a latched status and be of the category NAIBRD_SER_EVENT_MAP_COMM.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetEventMappedInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_event_mapped_category_type_t categoryType, uint32_t vector)
 Sets the Interrupt Vector for the channel number specified. The Interrupt Service callback routine passes in this vector value to identify the channel that generated the interrupt.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetEventMappedInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_event_mapped_category_type_t categoryType, uint32_t *p_outvector)
 Retrieves the Interrupt Vector for the channel number specified. The Interrupt Service callback routine passes in this vector value to identify the channel that generated the interrupt.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetEventMappedInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_event_mapped_category_type_t categoryType, naibrd_int_steering_t steering)
 Sets the Interrupt Steering, which indicates where to direct the interrupt signal, for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetEventMappedInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_event_mapped_category_type_t categoryType, naibrd_int_steering_t *p_outsteering)
 Retrieves the Interrupt Steering, which indicates where to direct the interrupt signal, for the specified channel.
 

Detailed Description

Function Documentation

◆ naibrd_SER_GetEventMappedInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetEventMappedInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ser_event_mapped_status_type_t statusType,
bool_t * p_outenable )

Retrieves the Interrupt Enable for the specified Serial channel and interrupt status type. The interrupt statusType must be a latched status and be of the category NAIBRD_SER_EVENT_MAP_COMM.

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) The latched interrupt to enable. If a realtime status or FIFO category status is passed in, NAI_ERROR_INVALID_VALUE will be returned.
p_outenable: (Output) NAI_TRUE if the interrupt is enabled, NAI_FALSE if the interrupt is not enabled.
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.

◆ naibrd_SER_GetEventMappedInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetEventMappedInterruptSteering ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ser_event_mapped_category_type_t categoryType,
naibrd_int_steering_t * p_outsteering )

Retrieves the Interrupt Steering, which indicates where to direct the interrupt signal, for the specified channel.

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) The channel of the steering we want to get.
categoryType: (Input) The category of the event mapped status. Interrupts are only supported on statuses with the NAIBRD_SER_EVENT_MAP_COMM category.
p_outsteering: (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 parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SER_GetEventMappedInterruptTriggerType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetEventMappedInterruptTriggerType ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ser_event_mapped_status_type_t statusType,
naibrd_int_trigger_type_t * p_outtriggerType )

Gets the Interrupt Edge/Level property for the specified Serial channel and interrupt status type. The interrupt statusType must be a latched status and be of the category NAIBRD_SER_EVENT_MAP_COMM.

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) The latched interrupt to enable. If a realtime status or FIFO category status is passed in, NAI_ERROR_INVALID_VALUE will be returned.
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_INVALID_VALUE when an incorrect parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SER_GetEventMappedInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetEventMappedInterruptVector ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ser_event_mapped_category_type_t categoryType,
uint32_t * p_outvector )

Retrieves the Interrupt Vector for the channel number specified. The Interrupt Service callback routine passes in this vector value to identify the channel that generated the interrupt.

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) The channel of the vector we want to get.
categoryType: (Input) The category of the event mapped status. Interrupts are only supported on statuses with the NAIBRD_SER_EVENT_MAP_COMM category.
p_outvector: (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.

◆ naibrd_SER_SetEventMappedInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetEventMappedInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ser_event_mapped_status_type_t statusType,
bool_t enable )

Sets the Interrupt Enable for the specified Serial channel and interrupt status type. The interrupt statusType must be a latched status and be of the category NAIBRD_SER_EVENT_MAP_COMM.

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) The latched interrupt to enable. If a realtime status or FIFO category status is passed in, NAI_ERROR_INVALID_VALUE will be returned.
enable: (Input) NAI_TRUE to enable interrupt, NAI_FALSE to disable 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 an incorrect parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SER_SetEventMappedInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetEventMappedInterruptSteering ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ser_event_mapped_category_type_t categoryType,
naibrd_int_steering_t steering )

Sets the Interrupt Steering, which indicates where to direct the interrupt signal, for the specified channel.

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) The channel of the steering we want to set.
categoryType: (Input) The category of the event mapped status. Interrupts are only supported on statuses with the NAIBRD_SER_EVENT_MAP_COMM category.
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 parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SER_SetEventMappedInterruptTriggerType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetEventMappedInterruptTriggerType ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ser_event_mapped_status_type_t statusType,
naibrd_int_trigger_type_t triggerType )

Sets the Interrupt Edge/Level property for the specified Serial channel and interrupt status type. The interrupt statusType must be a latched status and be of the category NAIBRD_SER_EVENT_MAP_COMM.

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) The latched interrupt to enable. If a realtime status or FIFO category status is passed in, NAI_ERROR_INVALID_VALUE will be returned.
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_INVALID_VALUE when an incorrect parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SER_SetEventMappedInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetEventMappedInterruptVector ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ser_event_mapped_category_type_t categoryType,
uint32_t vector )

Sets the Interrupt Vector for the channel number specified. The Interrupt Service callback routine passes in this vector value to identify the channel that generated the interrupt.

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) The channel of the vector we want to set.
categoryType: (Input) The category of the event mapped status. Interrupts are only supported on statuses with the NAIBRD_SER_EVENT_MAP_COMM category.
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.