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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_CTS_SetInterruptEnable (int32_t cardIndex, int32_t module, nai_dif_cts_int_t type, bool_t enable)
 Sets Bit for CTS interrupt type for in specified DIF CTS module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_CTS_GetInterruptEnable (int32_t cardIndex, int32_t module, nai_dif_cts_int_t type, bool_t *outenable)
 Gets Bit for Interrupt type for in specified DIF CTS module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_CTS_ClearInterruptStatus (int32_t cardIndex, int32_t module, nai_dif_cts_int_t type)
 Clears Interrupt status for CTS Interrupt type in specified DIF CTS module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_CTS_GetInterruptStatus (int32_t cardIndex, int32_t module, nai_dif_cts_int_t type, nai_dif_cts_timing_t timing, nai_status_bit_t *outstatusVal)
 Gets Interrupt status for CTS Interrupt type in specified DIF CTS module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_CTS_SetEdgeLevelInterrupt (int32_t cardIndex, int32_t module, nai_dif_cts_int_t type, nai_dif_interrupt_t interruptType)
 Set the Interrupt Trigger Type for CTS Interrupt type in specified DIF CTS module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_CTS_GetEdgeLevelInterrupt (int32_t cardIndex, int32_t module, nai_dif_cts_int_t type, nai_dif_interrupt_t *outinterruptType)
 Retrieves the Interrupt Trigger Type for CTS Interrupt type in specified DIF CTS module.
 

Detailed Description


Function Documentation

◆ naibrd_DIF_CTS_ClearInterruptStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_CTS_ClearInterruptStatus ( int32_t cardIndex,
int32_t module,
nai_dif_cts_int_t type )

Clears Interrupt status for CTS Interrupt type in specified DIF CTS 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) IntEn Type: refer to nai_dif_cts_intEn_t definitions.
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 is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_CTS_GetEdgeLevelInterrupt()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_CTS_GetEdgeLevelInterrupt ( int32_t cardIndex,
int32_t module,
nai_dif_cts_int_t type,
nai_dif_interrupt_t * outinterruptType )

Retrieves the Interrupt Trigger Type for CTS Interrupt type in specified DIF CTS 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) CTS Int Type: refer to nai_dif_cts_int_t definitions.
outinterruptType: (Output) Int Trigger Type: refer to nai_dif_interrupt_t definitions.
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 is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_CTS_GetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_CTS_GetInterruptEnable ( int32_t cardIndex,
int32_t module,
nai_dif_cts_int_t type,
bool_t * outenable )

Gets Bit for Interrupt type for in specified DIF CTS 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) IntEn Type: refer to nai_dif_cts_intEn_t definitions.
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 is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_CTS_GetInterruptStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_CTS_GetInterruptStatus ( int32_t cardIndex,
int32_t module,
nai_dif_cts_int_t type,
nai_dif_cts_timing_t timing,
nai_status_bit_t * outstatusVal )

Gets Interrupt status for CTS Interrupt type in specified DIF CTS 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) Interrupt Enable Type: refer to nai_dif_cts_intEn_t definitions.
timing: (Input) Status type (realtime or latched): refer to nai_dif_cts_timing_t definitions.
outstatusVal: (Output) 0 for no Interrupt Detected, 1 Interrupt Detected.
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 is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_CTS_SetEdgeLevelInterrupt()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_CTS_SetEdgeLevelInterrupt ( int32_t cardIndex,
int32_t module,
nai_dif_cts_int_t type,
nai_dif_interrupt_t interruptType )

Set the Interrupt Trigger Type for CTS Interrupt type in specified DIF CTS 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) CTS Int Type: refer to nai_dif_cts_int_t definitions.
interruptType: (Input) Int Trigger Type: refer to nai_dif_interrupt_t definitions.
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 is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_CTS_SetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_CTS_SetInterruptEnable ( int32_t cardIndex,
int32_t module,
nai_dif_cts_int_t type,
bool_t enable )

Sets Bit for CTS interrupt type for in specified DIF CTS 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) IntEn Type: refer to nai_dif_cts_intEn_t definitions.
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 is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.