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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_SetChanMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_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 events are supported in this function. Refer to naibrd_AR568_SetEventMappedInterruptEnable() to set the interrupt enable/disable setting of event-mapped statuses.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_GetChanMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_chan_mapped_status_type_t statusType, bool_t *p_outenable)
 Get the interrupt enable state for a channel mapped status bit. Only BIT interrupts are supported in this function. Refer to naibrd_AR568_GetEventMappedInterruptEnable() to retrieve the interrupt enable/disable setting of event-mapped statuses.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_SetChanMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_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 interrupts are supported in this function. Refer to naibrd_AR568_SetEventMappedInterruptTriggerType() to set the interrupt trigger mode of event mapped statuses.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_GetChanMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_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 interrupts are supported in this function. Refer to naibrd_AR568_GetEventMappedInterruptTriggerType() to retrieve the interrupt trigger mode of event mapped statuses.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_SetChanMappedInterruptVector (int32_t cardIndex, int32_t module, naibrd_ar568_chan_mapped_status_type_t statusType, int32_t vector)
 Sets the Interrupt Vector for the status type specified. Only the BIT status type is supported by this function. The Interrupt Service callback routine passes in this vector value to identify the status type that generated the interrupt.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_GetChanMappedInterruptVector (int32_t cardIndex, int32_t module, naibrd_ar568_chan_mapped_status_type_t statusType, int32_t *p_outvector)
 Returns the Interrupt Vector of the status type specified. Only the BIT status type is supported by this function. The Interrupt Service callback routine passes in this vector value to identify the status type that generated the interrupt.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_SetChanMappedInterruptSteering (int32_t cardIndex, int32_t module, naibrd_ar568_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 status type. Only the BIT status type is supported by this function.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_GetChanMappedInterruptSteering (int32_t cardIndex, int32_t module, naibrd_ar568_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 status type. Only the BIT status type is supported by this function.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_SetEventMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_event_mapped_status_type_t statusType, bool_t enable)
 This function is used to enable interrupt generation on a single event mapped status bit. Refer to naibrd_AR568_SetChanMappedInterruptEnable() to set the interrupt enable/disable setting of channel-mapped statuses.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_GetEventMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_event_mapped_status_type_t statusType, bool_t *p_outenable)
 This function is used to retrieve the interrupt enable state on a single event mapped status bit. Refer to naibrd_AR568_GetChanMappedInterruptEnable() to get the interrupt enable/disable setting of channel-mapped statuses.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_SetEventMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_event_mapped_status_type_t statusType, naibrd_int_trigger_type_t triggerType)
 Sets the Interrupt trigger mode (edge or level) for an event mapped status bit. Refer to naibrd_AR568_SetChanMappedInterruptTriggerType() to set the interrupt trigger mode of channel mapped statuses.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_GetEventMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_event_mapped_status_type_t statusType, naibrd_int_trigger_type_t *p_outtriggerType)
 Gets the Interrupt trigger mode (edge or level) for an event mapped status bit. Refer to naibrd_AR568_GetChanMappedInterruptTriggerType() to retrieve the interrupt trigger mode of channel mapped statuses.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_SetEventMappedInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_event_mapped_category_type_t categoryType, uint32_t vector)
 Sets the Interrupt Vector for the channel and category type specified. Only NAIBRD_AR568_EVENT_MAP_GENERAL category is supported by this function. The Interrupt Service callback routine passes in this vector value to identify the channel that generated the interrupt.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_GetEventMappedInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_event_mapped_category_type_t categoryType, uint32_t *p_outvector)
 Retrieves the Interrupt Vector for the channel and category type specified. Only NAIBRD_AR568_EVENT_MAP_GENERAL category is supported by this function. The Interrupt Service callback routine passes in this vector value to identify the channel that generated the interrupt.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_SetEventMappedInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_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 channel and category specified. Only the NAIBRD_AR568_EVENT_MAP_GENERAL category is supported by this function.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_GetEventMappedInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_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 channel and category specified. Only the NAIBRD_AR568_EVENT_MAP_GENERAL category is supported by this function.
 

Detailed Description

Function Documentation

◆ naibrd_AR568_GetChanMappedInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_GetChanMappedInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ar568_chan_mapped_status_type_t statusType,
bool_t * p_outenable )

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

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_ar568_chan_mapped_status_type_t definition. Only BIT is supported.
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_INVALID_VALUE when invalid statusType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR568_GetChanMappedInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_GetChanMappedInterruptSteering ( int32_t cardIndex,
int32_t module,
naibrd_ar568_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 status type. Only the BIT status type is supported by this function.

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_ar568_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_INVALID_VALUE when invalid statusType is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR568_GetChanMappedInterruptTriggerType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_GetChanMappedInterruptTriggerType ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ar568_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 interrupts are supported in this function. Refer to naibrd_AR568_GetEventMappedInterruptTriggerType() to retrieve the interrupt trigger mode of event mapped statuses.

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

◆ naibrd_AR568_GetChanMappedInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_GetChanMappedInterruptVector ( int32_t cardIndex,
int32_t module,
naibrd_ar568_chan_mapped_status_type_t statusType,
int32_t * p_outvector )

Returns the Interrupt Vector of the status type specified. Only the BIT status type is supported by this function. The Interrupt Service callback routine passes in this vector value to identify the status type that generated the interrupt.

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]).
statusType: (Input) Status Type: refer to naibrd_ar568_chan_mapped_status_type_t definition.
p_outvector: (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_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid statusType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR568_GetEventMappedInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_GetEventMappedInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ar568_event_mapped_status_type_t statusType,
bool_t * p_outenable )

This function is used to retrieve the interrupt enable state on a single event mapped status bit. Refer to naibrd_AR568_GetChanMappedInterruptEnable() to get the interrupt enable/disable setting of channel-mapped statuses.

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

◆ naibrd_AR568_GetEventMappedInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_GetEventMappedInterruptSteering ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ar568_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 channel and category specified. Only the NAIBRD_AR568_EVENT_MAP_GENERAL category is supported by this function.

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]).
categoryType: (Input) Category Type: refer to naibrd_ar568_event_mapped_category_type_t definition.
p_outsteering: (Output) Interrupt Steering given by one of 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 categoryType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR568_GetEventMappedInterruptTriggerType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_GetEventMappedInterruptTriggerType ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ar568_event_mapped_status_type_t statusType,
naibrd_int_trigger_type_t * p_outtriggerType )

Gets the Interrupt trigger mode (edge or level) for an event mapped status bit. Refer to naibrd_AR568_GetChanMappedInterruptTriggerType() to retrieve the interrupt trigger mode of channel mapped statuses.

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

◆ naibrd_AR568_GetEventMappedInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_GetEventMappedInterruptVector ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ar568_event_mapped_category_type_t categoryType,
uint32_t * p_outvector )

Retrieves the Interrupt Vector for the channel and category type specified. Only NAIBRD_AR568_EVENT_MAP_GENERAL category is supported by this function. 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 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]).
categoryType: (Input) Category Type: refer to naibrd_ar568_event_mapped_category_type_t definition.
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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid categoryType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR568_SetChanMappedInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_SetChanMappedInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ar568_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 events are supported in this function. Refer to naibrd_AR568_SetEventMappedInterruptEnable() to set the interrupt enable/disable setting of event-mapped statuses.

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_ar568_chan_mapped_status_type_t definition. Only BIT is supported.
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_INVALID_VALUE when invalid statusType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR568_SetChanMappedInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_SetChanMappedInterruptSteering ( int32_t cardIndex,
int32_t module,
naibrd_ar568_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 status type. Only the BIT status type is supported by this function.

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_ar568_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_AR568_SetChanMappedInterruptTriggerType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_SetChanMappedInterruptTriggerType ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ar568_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 interrupts are supported in this function. Refer to naibrd_AR568_SetEventMappedInterruptTriggerType() to set the interrupt trigger mode of event mapped statuses.

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

◆ naibrd_AR568_SetChanMappedInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_SetChanMappedInterruptVector ( int32_t cardIndex,
int32_t module,
naibrd_ar568_chan_mapped_status_type_t statusType,
int32_t vector )

Sets the Interrupt Vector for the status type specified. Only the BIT status type is supported by this function. The Interrupt Service callback routine passes in this vector value to identify the status type that generated the interrupt.

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]).
statusType: (Input) Status Type: refer to naibrd_ar568_chan_mapped_status_type_t definition.
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_INVALID_VALUE when invalid statysType or vector parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR568_SetEventMappedInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_SetEventMappedInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ar568_event_mapped_status_type_t statusType,
bool_t enable )

This function is used to enable interrupt generation on a single event mapped status bit. Refer to naibrd_AR568_SetChanMappedInterruptEnable() to set the interrupt enable/disable setting of channel-mapped statuses.

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

◆ naibrd_AR568_SetEventMappedInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_SetEventMappedInterruptSteering ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ar568_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 channel and category specified. Only the NAIBRD_AR568_EVENT_MAP_GENERAL category is supported by this function.

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]).
categoryType: (Input) Category Type: refer to naibrd_ar568_event_mapped_category_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 categoryType or steering parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR568_SetEventMappedInterruptTriggerType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_SetEventMappedInterruptTriggerType ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ar568_event_mapped_status_type_t statusType,
naibrd_int_trigger_type_t triggerType )

Sets the Interrupt trigger mode (edge or level) for an event mapped status bit. Refer to naibrd_AR568_SetChanMappedInterruptTriggerType() to set the interrupt trigger mode of channel mapped statuses.

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

◆ naibrd_AR568_SetEventMappedInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR568_SetEventMappedInterruptVector ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ar568_event_mapped_category_type_t categoryType,
uint32_t vector )

Sets the Interrupt Vector for the channel and category type specified. Only NAIBRD_AR568_EVENT_MAP_GENERAL category is supported by this function. 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 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]).
categoryType: (Input) Category Type: refer to naibrd_ar568_event_mapped_category_type_t definition.
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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid categoryType or vector parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.