Interrupt Functions

Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_SetInterruptVector (int32_t cardIndex, int32_t module, nai_ds_interrupt_type_t type, uint32_t inInterruptVector)
	Sets the interrupt vector for a D/S module.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetInterruptVector (int32_t cardIndex, int32_t module, nai_ds_interrupt_type_t type, uint32_t *outIntVector)
	Gets the D/S interrupt vector that is assigned to the its interrupt function in the D/S module.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_SetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_interrupt_type_t type, uint32_t inEnable)
	Sets the D/S interrupt enable state for a specific channel in a D/S module.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_interrupt_type_t type, uint32_t *outEnable)
	Gets the D/S interrupt enable state for a specific channel in the D/S module.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_SetInterruptSteering (int32_t cardIndex, int32_t module, nai_ds_status_type_t type, naibrd_int_steering_t steering)
	Sets the Interrupt Steering which indicates the interrupt direction for the DS modules. Interrupt steering used for NAI GEN 5 modules and with latched interrupt types.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetInterruptSteering (int32_t cardIndex, int32_t module, nai_ds_status_type_t type, naibrd_int_steering_t *outsteering)
	Gets the Interrupt Steering which indicates the interrupt direction for the DS modules. Interrupt steering used for NAI GEN 5 modules and with latched interrupt types.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_SetEdgeLevelInterrupt (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_interrupt_type_t type, nai_ds_interruptMode_type_t interruptType)
	Sets the Interrupt Edge/Level mode for the D/S modules. This feature only applies to NAI GEN 5 D/S modules.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetEdgeLevelInterrupt (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_interrupt_type_t type, nai_ds_interruptMode_type_t *outinterruptType)
	Gets the Interrupt Edge/Level mode for the D/S modules. This feature only applies to NAI GEN 5 D/S modules.

Detailed Description

Function Documentation

naibrd_DS_GetEdgeLevelInterrupt()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetEdgeLevelInterrupt	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ds_interrupt_type_t	type,
		nai_ds_interruptMode_type_t *	outinterruptType )

Gets the Interrupt Edge/Level mode for the D/S modules. This feature only applies to NAI GEN 5 D/S modules.

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) Interrupt Type: refer to nai_ds_status_type_t definition
outinterruptType	: (Output) NAI_DS_EDGE_INTERRUPT or NAI_DS_LEVEL_INTERRUPT

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_NOT_SUPPORTED when function is not supported.

naibrd_DS_GetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetInterruptEnable	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ds_interrupt_type_t	type,
		uint32_t *	outEnable )

Gets the D/S interrupt enable state for a specific channel in the D/S 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]).
type	: (Input) Angle Type: refer to nai_ds_interrupt_type_t definitions.
outEnable	: (Output) Return the interrupt enable state for a specified channel in a D/S module.

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_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_DS_GetInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetInterruptSteering	(	int32_t	cardIndex,
		int32_t	module,
		nai_ds_status_type_t	type,
		naibrd_int_steering_t *	outsteering )

Gets the Interrupt Steering which indicates the interrupt direction for the DS modules. Interrupt steering used for NAI GEN 5 modules and with latched interrupt types.

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) Status Type: refer to nai_sd_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 module 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_DS_GetInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetInterruptVector	(	int32_t	cardIndex,
		int32_t	module,
		nai_ds_interrupt_type_t	type,
		uint32_t *	outIntVector )

Gets the D/S interrupt vector that is assigned to the its interrupt function in the D/S 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) Angle Type: refer to nai_ds_interrupt_type_t definitions.
outIntVector	: (Output) Returns interrupt vector from a D/S module.

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_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_DS_SetEdgeLevelInterrupt()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetEdgeLevelInterrupt	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ds_interrupt_type_t	type,
		nai_ds_interruptMode_type_t	interruptType )

Sets the Interrupt Edge/Level mode for the D/S modules. This feature only applies to NAI GEN 5 D/S modules.

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) Interrupt Type: refer to nai_ds_interrupt_type_t definition
interruptType	: (Input) NAI_DS_EDGE_INTERRUPT or NAI_DS_LEVEL_INTERRUPT

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_NOT_SUPPORTED when function is not supported.

naibrd_DS_SetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetInterruptEnable	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ds_interrupt_type_t	type,
		uint32_t	inEnable )

Sets the D/S interrupt enable state for a specific channel in a D/S 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]).
type	: (Input) Angle Type: refer to nai_ds_interrupt_type_t definitions.
inEnable	: (Input) Writes interrupt disable(0), enable(1) to a specified channel of a D/S module.

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_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_DS_SetInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetInterruptSteering	(	int32_t	cardIndex,
		int32_t	module,
		nai_ds_status_type_t	type,
		naibrd_int_steering_t	steering )

Sets the Interrupt Steering which indicates the interrupt direction for the DS modules. Interrupt steering used for NAI GEN 5 modules and with latched interrupt types.

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) Status Type: refer to nai_sd_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 module 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_DS_SetInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetInterruptVector	(	int32_t	cardIndex,
		int32_t	module,
		nai_ds_interrupt_type_t	type,
		uint32_t	inInterruptVector )

Sets the interrupt vector for a D/S 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) Angle Type: refer to nai_ds_interrupt_type_t definitions.
inInterruptVector	: (Input) Writes the interrupt vecotr(0x0 - 0xFF) to a D/S module.

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_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.