Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Interrupt Functions
DIF Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_dif_status_type_t type, bool_t enable)
 Sets the Interrupt Enable for the specified DIF channel and interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_dif_status_type_t type, bool_t *outenable)
 Retrieves the Interrupt Enable for the specified DIF channel and interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetEdgeLevelInterrupt (int32_t cardIndex, int32_t module, int32_t channel, nai_dif_status_type_t type, nai_dif_interrupt_t interruptType)
 Sets the Interrupt Edge/Level property for the specified DIF channel and interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetEdgeLevelInterrupt (int32_t cardIndex, int32_t module, int32_t channel, nai_dif_status_type_t type, nai_dif_interrupt_t *outinterruptType)
 Retrieves the Interrupt Edge/Level property for the specified DIF channel and interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetGroupInterruptVector (int32_t cardIndex, int32_t module, int32_t group, nai_dif_status_type_t type, uint32_t vector)
 Sets the Interrupt Vector for the specified DIF channel and interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetGroupInterruptVector (int32_t cardIndex, int32_t module, int32_t group, nai_dif_status_type_t type, uint32_t *outvector)
 Retrieves the Interrupt Vector for the specified DIF channel and interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetGroupInterruptSteering (int32_t cardIndex, int32_t module, int32_t group, nai_dif_status_type_t type, naibrd_int_steering_t steering)
 Sets the Interrupt Steering which indicates the interrupt direction for the specified DIF group and interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetGroupInterruptSteering (int32_t cardIndex, int32_t module, int32_t group, nai_dif_status_type_t type, naibrd_int_steering_t *outsteering)
 Retrieves the Interrupt Steering which indicates the interrupt direction for the specified DIF group and interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetBITInterval (int32_t cardIndex, int32_t module, uint32_t bitInterval)
 Sets the BIT Error Interval. The BIT Error Interval essentially filter BIT errors prior to an actual notification of a BIT Error (maybe advantageous in "noisy/unstable" application environments or for general filtering purposes). The BIT Error Interval mechanism uses an up/down counter such that accumulated successive fault detections are counted up and no fault detections are counted down. The BIT Error Interval essentially sets up a threshold requirement of "successive" fault events to accumulate before actual notification of the fault.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetBITInterval (int32_t cardIndex, int32_t module, uint32_t *outbitInterval)
 Retrieves the BIT Error Interval. The BIT Error Interval essentially filter BIT errors prior to an actual notification of a BIT Error (maybe advantageous in "noisy/unstable" application environments or for general filtering purposes). The BIT Error Interval mechanism uses an up/down counter such that accumulated successive fault detections are counted up and no fault detections are counted down. The BIT Error Interval essentially sets up a threshold requirement of "successive" fault events to accumulate before actual notification of the fault.
 

Detailed Description


Function Documentation

◆ naibrd_DIF_GetBITInterval()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetBITInterval ( int32_t cardIndex,
int32_t module,
uint32_t * outbitInterval )

Retrieves the BIT Error Interval. The BIT Error Interval essentially filter BIT errors prior to an actual notification of a BIT Error (maybe advantageous in "noisy/unstable" application environments or for general filtering purposes). The BIT Error Interval mechanism uses an up/down counter such that accumulated successive fault detections are counted up and no fault detections are counted down. The BIT Error Interval essentially sets up a threshold requirement of "successive" fault events to accumulate before actual notification of the fault.

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]).
outbitInterval: (Output) BIT Interval.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card 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_DIF_GetEdgeLevelInterrupt()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetEdgeLevelInterrupt ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dif_status_type_t type,
nai_dif_interrupt_t * outinterruptType )

Retrieves the Interrupt Edge/Level property for the specified DIF 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_dt_status_type_t definition.
outinterruptType: (Output) Interrupt Type: refer to nai_dt_interrupt_t definition.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card 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_DIF_GetGroupInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetGroupInterruptSteering ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_dif_status_type_t type,
naibrd_int_steering_t * outsteering )

Retrieves the Interrupt Steering which indicates the interrupt direction for the specified DIF group 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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Status Type: refer to nai_dt_status_type_t definition.
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 card 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_DIF_GetGroupInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetGroupInterruptVector ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_dif_status_type_t type,
uint32_t * outvector )

Retrieves the Interrupt Vector for the specified DIF 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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Status Type: refer to nai_dif_status_type_t definitions (Latched types only).
outvector: (Output) Interrupt Vector.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card 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_DIF_GetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dif_status_type_t type,
bool_t * outenable )

Retrieves the Interrupt Enable for the specified DIF 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_dif_status_type_t definitions (Latched types only).
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 card 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_DIF_SetBITInterval()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetBITInterval ( int32_t cardIndex,
int32_t module,
uint32_t bitInterval )

Sets the BIT Error Interval. The BIT Error Interval essentially filter BIT errors prior to an actual notification of a BIT Error (maybe advantageous in "noisy/unstable" application environments or for general filtering purposes). The BIT Error Interval mechanism uses an up/down counter such that accumulated successive fault detections are counted up and no fault detections are counted down. The BIT Error Interval essentially sets up a threshold requirement of "successive" fault events to accumulate before actual notification of the fault.

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]).
bitInterval: (Input) BIT Interval.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card 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_DIF_SetEdgeLevelInterrupt()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetEdgeLevelInterrupt ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dif_status_type_t type,
nai_dif_interrupt_t interruptType )

Sets the Interrupt Edge/Level property for the specified DIF 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_dt_status_type_t definition.
interruptType: (Input) Interrupt Type: refer to nai_dt_interrupt_t definition.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card 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_DIF_SetGroupInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetGroupInterruptSteering ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_dif_status_type_t type,
naibrd_int_steering_t steering )

Sets the Interrupt Steering which indicates the interrupt direction for the specified DIF group 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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Status Type: refer to nai_dt_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 card 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_DIF_SetGroupInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetGroupInterruptVector ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_dif_status_type_t type,
uint32_t vector )

Sets the Interrupt Vector for the specified DIF 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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Status Type: refer to nai_dif_status_type_t definitions (Latched types only).
vector: (Input) Interrupt Vector.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card 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_DIF_SetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dif_status_type_t type,
bool_t enable )

Sets the Interrupt Enable for the specified DIF 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_dif_status_type_t definitions (Latched types only).
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 card 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.