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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_SetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_scg_status_t intEnable)
 Sets the Interrupt Enable register value for the specified SCG channel. Setting the bits to 1 enables interrupts. Status is reported in the Interrupt Status register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_GetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_scg_status_t *p_outIntEnable)
 Retrieves the Interrupt Enable register value for the specified SCG channel. Setting the bits to 1 enabled interrupts. Status is reported in the Interrupt Status register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_SetInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, uint32_t edgeLevel)
 Sets the Interrupt Edge/Level register value for the specified SCG channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_GetInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outEdgeLevel)
 Retrieves the Interrupt Edge/Level register value for the specified SCG channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_SetInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, uint32_t vector)
 Sets the interrupt vector for the specified SCG channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_GetInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outvector)
 Retrieves the interrupt vector for the specified SCG channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_SetInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_int_steering_t steering)
 Sets the Interrupt Steering which indicates the interrupt direction for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_GetInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_int_steering_t *p_outsteering)
 Retrieves the Interrupt Steering which indicates the interrupt direction for the specified channel.
 

Detailed Description


Function Documentation

◆ naibrd_SCG_GetInterruptEdgeLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_GetInterruptEdgeLevel ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outEdgeLevel )

Retrieves the Interrupt Edge/Level register value for the specified SCG 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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outEdgeLevel: (Output)Bitmask of the trigger Mode of interrupts (0 = EDGE, 1 = LEVEL).
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_SCG_GetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_GetInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_scg_status_t * p_outIntEnable )

Retrieves the Interrupt Enable register value for the specified SCG channel. Setting the bits to 1 enabled interrupts. Status is reported in the Interrupt Status register.

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]).
p_outIntEnable: (Output) Bitmask of interrupts to enable(1) and/or disable(0).
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_SCG_GetInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_GetInterruptSteering ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_int_steering_t * p_outsteering )

Retrieves the Interrupt Steering which indicates the interrupt direction 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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
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 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_SCG_GetInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_GetInterruptVector ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outvector )

Retrieves the interrupt vector for the specified SCG 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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_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_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SCG_SetInterruptEdgeLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_SetInterruptEdgeLevel ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t edgeLevel )

Sets the Interrupt Edge/Level register value for the specified SCG 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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
edgeLevel: (Input) Bitmask of the trigger Mode of interrupts (0 = EDGE, 1 = LEVEL).
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_SCG_SetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_SetInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_scg_status_t intEnable )

Sets the Interrupt Enable register value for the specified SCG channel. Setting the bits to 1 enables interrupts. Status is reported in the Interrupt Status register.

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]).
intEnable: (Input) Bitmask of interrupts to enable(1) and/or disable(0).
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_SCG_SetInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_SetInterruptSteering ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_int_steering_t steering )

Sets the Interrupt Steering which indicates the interrupt direction 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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
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_SCG_SetInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_SetInterruptVector ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t vector )

Sets the interrupt vector for the specified SCG 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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
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_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.