Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_IOCT_SetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_ioct_group_type_t grouptype, nai_ioct_group_interrupt_t intenable)
	Sets the IOCT Interrupt Enable state for the specified IOCT channel. By default, interrupts are disabled.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_IOCT_GetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_ioct_group_type_t grouptype, nai_ioct_group_interrupt_t *outintenable)
	Retrieves the IOCT Interrupt Enable state for the specified IOCT channel. By default, interrupts are disabled.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_IOCT_SetEdgeLevelInterrupt (int32_t cardIndex, int32_t module, int32_t channel, nai_ioct_interrupt_t interruptType)
	Sets the Interrupt Edge/Level property for the specified IOCT channel and interrupt status type.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_IOCT_GetEdgeLevelInterrupt (int32_t cardIndex, int32_t module, int32_t channel, nai_ioct_interrupt_t *outinterruptType)
	Retrieves the Interrupt Edge/Level property for the specified IOCT channel and interrupt status type.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_IOCT_SetInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, nai_ioct_group_type_t grouptype, uint32_t vector)
	Sets the IOCT Interrupt Vector for the specified IOCT module.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_IOCT_GetInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, nai_ioct_group_type_t grouptype, uint32_t *outvector)
	Retrieves the IOCT Interrupt Vector for the specified IOCT module.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_IOCT_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_IOCT_GetInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_int_steering_t *outsteering)
	Retrieves the Interrupt Steering which indicates the interrupt direction for the specified channel.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_IOCT_GetInterruptStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ioct_group_type_t grouptype, nai_ioct_interrupt_status_type_t type, nai_ioct_group_interrupt_t *outstatus)
	Retrieves the IOCT channel's interrupt status.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_IOCT_ClearInterruptStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ioct_group_type_t grouptype, nai_ioct_group_interrupt_t intstatus)
	Clears the latched status for the specified IOCT channel and status type. (Applicable for latched status types only)

Detailed Description

Function Documentation

◆ naibrd_IOCT_ClearInterruptStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_ClearInterruptStatus	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ioct_group_type_t	grouptype,
		nai_ioct_group_interrupt_t	intstatus )

Clears the latched status for the specified IOCT channel and status type. (Applicable for latched status types only)

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]).
grouptype	: (Input) Specify which Interrupt Group to access, refer to nai_ioct_group_type_t definition
intstatus	: (Output) Interrupt status, refer to nai_ioct_group_interrupt_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_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IOCT_GetEdgeLevelInterrupt()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetEdgeLevelInterrupt	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ioct_interrupt_t *	outinterruptType )

Retrieves the Interrupt Edge/Level property for the specified IOCT 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]).
outinterruptType	: (Output) Interrupt Type: refer to nai_ioct_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_IOCT_GetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetInterruptEnable	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ioct_group_type_t	grouptype,
		nai_ioct_group_interrupt_t *	outintenable )

Retrieves the IOCT Interrupt Enable state for the specified IOCT 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]).
grouptype	: (Input) Specify which Interrupt Group to access, refer to nai_ioct_group_type_t definition
outintenable	: (Output) Specify which interrupts to enable and disable, refer to nai_ioct_group_interrupt_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_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IOCT_GetInterruptStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetInterruptStatus	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ioct_group_type_t	grouptype,
		nai_ioct_interrupt_status_type_t	type,
		nai_ioct_group_interrupt_t *	outstatus )

Retrieves the IOCT channel's interrupt status.

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]).
grouptype	: (Input) Specify which Interrupt Group to access, refer to nai_ioct_group_type_t definition
type	: (Input) Interrupt Status Type: refer to nai_ioct_interrupt_status_type_t definition.
outstatus	: (Output) Interrupt status, refer to nai_ioct_group_interrupt_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_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IOCT_GetInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetInterruptSteering	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_int_steering_t *	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]).
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_IOCT_GetInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetInterruptVector	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ioct_group_type_t	grouptype,
		uint32_t *	outvector )

Retrieves the IOCT Interrupt Vector for the specified IOCT 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]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
grouptype	: (Input) Specify which Interrupt Group to access, refer to nai_ioct_group_type_t definition
outvector	: (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_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IOCT_SetEdgeLevelInterrupt()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_SetEdgeLevelInterrupt	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ioct_interrupt_t	interruptType )

Sets the Interrupt Edge/Level property for the specified IOCT 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]).
interruptType	: (Input) Interrupt Type: refer to nai_ioct_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_IOCT_SetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_SetInterruptEnable	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ioct_group_type_t	grouptype,
		nai_ioct_group_interrupt_t	intenable )

Sets the IOCT Interrupt Enable state for the specified IOCT 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]).
grouptype	: (Input) Specify which Interrupt Group to access, refer to nai_ioct_group_type_t definition
intenable	: (Input) Specify which interrupts to enable and disable, refer to nai_ioct_group_interrupt_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_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IOCT_SetInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_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_IOCT_SetInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_SetInterruptVector	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ioct_group_type_t	grouptype,
		uint32_t	vector )

Sets the IOCT Interrupt Vector for the specified IOCT 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]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
grouptype	: (Input) Specify which Interrupt Group to access, refer to nai_ioct_group_type_t definition
vector	: (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_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

Functions

Detailed Description

Function Documentation

◆ naibrd_IOCT_ClearInterruptStatus()

◆ naibrd_IOCT_GetEdgeLevelInterrupt()

◆ naibrd_IOCT_GetInterruptEnable()

◆ naibrd_IOCT_GetInterruptStatus()

◆ naibrd_IOCT_GetInterruptSteering()

◆ naibrd_IOCT_GetInterruptVector()

◆ naibrd_IOCT_SetEdgeLevelInterrupt()

◆ naibrd_IOCT_SetInterruptEnable()

◆ naibrd_IOCT_SetInterruptSteering()

◆ naibrd_IOCT_SetInterruptVector()