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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetStatusIntEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_status_type_t statusType, uint32_t inStatusInt)
 Sets the Interrupt Enable associated with the Status Type for the specified channel. By default, interrupts are disabled.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetStatusIntEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_status_type_t statusType, uint32_t *outStatusInt)
 Sets the Interrupt Edge/Level property for the specified channel and interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetStatusVector (int32_t cardIndex, int32_t module, nai_dl_status_type_t statusType, uint32_t inIntVector)
 Sets the Interrupt Vector associated with the Status Type for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetStatusVector (int32_t cardIndex, int32_t module, nai_dl_status_type_t statusType, uint32_t *outIntVector)
 Retrieves the Interrupt Vector associated with the Status Type from the specified channel.
 

Detailed Description


Function Documentation

◆ naibrd_DL_GetStatusIntEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetStatusIntEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dl_status_type_t statusType,
uint32_t * outStatusInt )

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]).
statusType: (Input) Status Type: refer to nai_dl_status_type_t definition
outStatusInt: (Output) 1 for enabled 0 for 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 the type or intenable parameters are invalid.
  • NAI_ERROR_INVALID_RANGE when invalid range parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DL_GetStatusVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetStatusVector ( int32_t cardIndex,
int32_t module,
nai_dl_status_type_t statusType,
uint32_t * outIntVector )

Retrieves the Interrupt Vector associated with the Status Type from 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]).
statusType: (Input) Status Type: refer to nai_dl_status_type_t definition
outIntVector: (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 the type parameter is invalid.
  • NAI_ERROR_INVALID_RANGE when invalid range parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DL_SetStatusIntEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetStatusIntEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dl_status_type_t statusType,
uint32_t inStatusInt )

Sets the Interrupt Enable associated with the Status Type for the specified channel. 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]).
statusType: (Input) Status Type: refer to nai_dl_status_type_t definition
inStatusInt: (Input) 1 for enabled 0 for 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_RANGE when invalid range parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DL_SetStatusVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetStatusVector ( int32_t cardIndex,
int32_t module,
nai_dl_status_type_t statusType,
uint32_t inIntVector )

Sets the Interrupt Vector associated with the Status Type 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]).
statusType: (Input) Status Type: refer to nai_dl_status_type_t definition.
inIntVector: (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 the type parameter is invalid.
  • NAI_ERROR_INVALID_RANGE when invalid range parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.