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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_SetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_tc_chan_mapped_status_type_t type, bool_t enable)
 Sets the TC BIT or Open Status Interrupt Enable state for the specified TC channel. BIT Status and Open Status are part of the background testing. When the interrupt is enabled, a non-compliant channel will trigger an interrupt. By default, interrupts are disabled.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_tc_chan_mapped_status_type_t type, bool_t *p_outenable)
 Retrieves the TC BIT or Open Status Interrupt Enable state for the specified TC channel. BIT Status and Open Status are part of the background testing. When the interrupt is enabled, a non-compliant channel will trigger an interrupt. By default, interrupts are disabled.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_SetInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, naibrd_tc_chan_mapped_status_type_t type, naibrd_int_trigger_type_t triggerType)
 Sets the Interrupt Edge/Level property for the specified channel and interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, naibrd_tc_chan_mapped_status_type_t type, 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_TC_SetInterruptVector (int32_t cardIndex, int32_t module, naibrd_tc_chan_mapped_status_type_t type, uint32_t interruptvector)
 Sets the TC BIT or Open Status Interrupt Vector for the specified TC module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetInterruptVector (int32_t cardIndex, int32_t module, naibrd_tc_chan_mapped_status_type_t type, uint32_t *p_outinterruptvector)
 Retrieves the TC BIT or Open Status Interrupt Vector for the specified TC module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_SetInterruptSteering (int32_t cardIndex, int32_t module, naibrd_tc_chan_mapped_status_type_t type, 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_TC_GetInterruptSteering (int32_t cardIndex, int32_t module, naibrd_tc_chan_mapped_status_type_t type, 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_TC_GetInterruptEdgeLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetInterruptEdgeLevel ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_tc_chan_mapped_status_type_t type,
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]).
type: (Input) Status Type: refer to nai_tc_status_type_t definition.
p_outtriggerType: (Output) Interrupt 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_NOT_OPEN when handle to board is invalid.
  • 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_TC_GetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_tc_chan_mapped_status_type_t type,
bool_t * p_outenable )

Retrieves the TC BIT or Open Status Interrupt Enable state for the specified TC channel. BIT Status and Open Status are part of the background testing. When the interrupt is enabled, a non-compliant channel will trigger an interrupt. 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 nai_tc_status_type_t definition.
p_outenable: (Output) NAI_FALSE to disable, NAI_TRUE 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_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_TC_GetInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetInterruptSteering ( int32_t cardIndex,
int32_t module,
naibrd_tc_chan_mapped_status_type_t type,
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]).
type: (Input) Status Type: refer to nai_tc_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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TC_GetInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetInterruptVector ( int32_t cardIndex,
int32_t module,
naibrd_tc_chan_mapped_status_type_t type,
uint32_t * p_outinterruptvector )

Retrieves the TC BIT or Open Status Interrupt Vector for the specified TC 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 nai_tc_status_type_t definition.
p_outinterruptvector: (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_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TC_SetInterruptEdgeLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_SetInterruptEdgeLevel ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_tc_chan_mapped_status_type_t type,
naibrd_int_trigger_type_t triggerType )

Sets 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]).
type: (Input) Status Type: refer to nai_tc_status_type_t definition.
triggerType: (Input) Interrupt 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter or invalid interruptType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TC_SetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_SetInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_tc_chan_mapped_status_type_t type,
bool_t enable )

Sets the TC BIT or Open Status Interrupt Enable state for the specified TC channel. BIT Status and Open Status are part of the background testing. When the interrupt is enabled, a non-compliant channel will trigger an interrupt. 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 nai_tc_status_type_t definition.
enable: (Input) NAI_FALSE to disable, NAI_TRUE 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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter or invalid statusintenab parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TC_SetInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_SetInterruptSteering ( int32_t cardIndex,
int32_t module,
naibrd_tc_chan_mapped_status_type_t type,
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]).
type: (Input) Status Type: refer to nai_tc_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 type parameter or invalid steering parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TC_SetInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_SetInterruptVector ( int32_t cardIndex,
int32_t module,
naibrd_tc_chan_mapped_status_type_t type,
uint32_t interruptvector )

Sets the TC BIT or Open Status Interrupt Vector for the specified TC 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 nai_tc_status_type_t definition.
interruptvector: (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_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.