Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DIF_SetRaw (int32_t cardIndex, int32_t module, nai_dif_raw_module_t type, uint32_t rawdata)
	Sets the raw data value in the register associated to the register type specified.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DIF_GetRaw (int32_t cardIndex, int32_t module, nai_dif_raw_module_t type, uint32_t *outrawdata)
	Retrieves the raw data value in the register associated to the register type specified.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DIF_SetGroupRaw (int32_t cardIndex, int32_t module, int32_t group, nai_dif_raw_group_t type, uint32_t rawdata)
	Sets the raw data value in the group register associated to the register type specified.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DIF_GetGroupRaw (int32_t cardIndex, int32_t module, int32_t group, nai_dif_raw_group_t type, uint32_t *outrawdata)
	Retrieves the raw data value in the group register associated to the register type specified.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DIF_SetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_dif_raw_channel_t type, uint32_t rawdata)
	Sets the raw data value in the register associated to the channel and register type specified.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DIF_GetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_dif_raw_channel_t type, uint32_t *outrawdata)
	Retrieves the raw data value in the register associated to the channel and register type specified.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DIF_GetGroupInputStateRaw (int32_t cardIndex, int32_t module, int32_t group, uint32_t *outstateRaw)
	Retrieves the Input State for all channels within the specified group of the DIF module. 'state' has one bit per channel, where the LSB is the 1st channel in 'group'.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DIF_GetGroupStatusRaw (int32_t cardIndex, int32_t module, int32_t group, nai_dif_status_type_t type, uint32_t *outstatusRaw)
	Retrieves the status of the specified type for the specified group. The status of a channel is flagged and latched until read. Reading any status bit will cause that bit to be unlatched.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DIF_ClearGroupStatusRaw (int32_t cardIndex, int32_t module, int32_t group, nai_dif_status_type_t type, uint32_t statusRaw)
	Clears the status of the specified type for the specified group. The status of a channel is flagged and latched until a "1" is written to the bit. Writing a "1" to the status bit will cause that bit to be unlatched.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DIF_SetGroupInterruptEnableRaw (int32_t cardIndex, int32_t module, int32_t group, nai_dif_status_type_t type, uint32_t enableRaw)
	Sets the Interrupt Enable state for the specified type and group.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DIF_GetGroupInterruptEnableRaw (int32_t cardIndex, int32_t module, int32_t group, nai_dif_status_type_t type, uint32_t *enableRaw)
	Retrieves the Interrupt Enable state for the specified type and group.

Detailed Description

Function Documentation

◆ naibrd_DIF_ClearGroupStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_ClearGroupStatusRaw	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	group,
		nai_dif_status_type_t	type,
		uint32_t	statusRaw )

Clears the status of the specified type for the specified group. The status of a channel is flagged and latched until a "1" is written to the bit. Writing a "1" to the status bit will cause that bit to be unlatched.

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]).
group	: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type	: (Input) Status Type: refer to nai_dif_status_type_t definitions.
statusRaw	: (Input) .

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 or type parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_GetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetChannelRaw	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_dif_raw_channel_t	type,
		uint32_t *	outrawdata )

Retrieves the raw data value in the register associated to the channel and register type specified.

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) Channel Register Type: refer to nai_dif_raw_channel_t type definition.
outrawdata	: (Output) Raw Data Code.

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_INVALID_VALUE when invalid channel or channel type is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_GetGroupInputStateRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetGroupInputStateRaw	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	group,
		uint32_t *	outstateRaw )

Retrieves the Input State for all channels within the specified group of the DIF module. 'state' has one bit per channel, where the LSB is the 1st channel in 'group'.

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]).
group	: (Input) Channel Group Number to access (1 - [max channel groups for module]).
outstateRaw	: (Output) for each bit, 1 = logical high and 0 = logical low. Channel bit mapping is as follows: D0 is for the 1st channel in 'group', D1 is for the 2nd channel in 'group', : : : : D31 is for the 32nd channel in 'group'

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 parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_GetGroupInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetGroupInterruptEnableRaw	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	group,
		nai_dif_status_type_t	type,
		uint32_t *	enableRaw )

Retrieves the Interrupt Enable state for the specified type and group.

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]).
group	: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type	: (Input) Status Type: refer to nai_dif_status_type_t definition.
enableRaw	: (Input) 0 to disable, 1 to enable interrupt.

Channel bit mapping is as follows:
D0  is for the 1st channel in 'group',
D1  is for the 2nd channel in 'group',
:                  :
:                  :
D31 is for the 32nd channel in 'group'

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

◆ naibrd_DIF_GetGroupRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetGroupRaw	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	group,
		nai_dif_raw_group_t	type,
		uint32_t *	outrawdata )

Retrieves the raw data value in the group register associated to the register type specified.

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]).
group	: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type	: (Input) Module Register Type: refer to nai_dif_raw_group_t definition.
outrawdata	: (Output) Raw Data Code.

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 register type is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_GetGroupStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetGroupStatusRaw	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	group,
		nai_dif_status_type_t	type,
		uint32_t *	outstatusRaw )

Retrieves the status of the specified type for the specified group. The status of a channel is flagged and latched until read. Reading any status bit will cause that bit to be unlatched.

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]).
group	: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type	: (Input) Status Type: refer to nai_dif_status_type_t definition.
outstatusRaw	: (Output) for each bit, 0 for Normal, 1 Failure 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_VALUE when invalid group or type parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_GetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetRaw	(	int32_t	cardIndex,
		int32_t	module,
		nai_dif_raw_module_t	type,
		uint32_t *	outrawdata )

Retrieves the raw data value in the register associated to the register type specified.

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) Module Register Type: refer to nai_dif_raw_module_t definition.
outrawdata	: (Output) Raw Data Code.

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 register type is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_SetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetChannelRaw	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_dif_raw_channel_t	type,
		uint32_t	rawdata )

Sets the raw data value in the register associated to the channel and register type specified.

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) Channel Register Type: refer to nai_dif_raw_channel_t definition.
rawdata	: (Input) Raw Data Code.

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_INVALID_VALUE when invalid channel or channel type is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_SetGroupInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetGroupInterruptEnableRaw	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	group,
		nai_dif_status_type_t	type,
		uint32_t	enableRaw )

Sets the Interrupt Enable state for the specified type and group.

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]).
group	: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type	: (Input) Status Type: refer to nai_dif_status_type_t definition.
enableRaw	: (Input) 0 to disable, 1 to enable interrupt.

Channel bit mapping is as follows:
D0  is for the 1st channel in 'group',
D1  is for the 2nd channel in 'group',
:                  :
:                  :
D31 is for the 32nd channel in 'group'

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

◆ naibrd_DIF_SetGroupRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetGroupRaw	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	group,
		nai_dif_raw_group_t	type,
		uint32_t	rawdata )

Sets the raw data value in the group register associated to the register type specified.

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]).
group	: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type	: (Input) Module Register Type: refer to nai_dif_raw_group_t definition.
rawdata	: (Input) Raw Data Code.

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 register type is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_SetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetRaw	(	int32_t	cardIndex,
		int32_t	module,
		nai_dif_raw_module_t	type,
		uint32_t	rawdata )

Sets the raw data value in the register associated to the register type specified.

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) Module Register Type: refer to nai_dif_raw_module_t definition.
rawdata	: (Input) Raw Data Code.

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 register type is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

Functions

Detailed Description

Function Documentation

◆ naibrd_DIF_ClearGroupStatusRaw()

◆ naibrd_DIF_GetChannelRaw()

◆ naibrd_DIF_GetGroupInputStateRaw()

◆ naibrd_DIF_GetGroupInterruptEnableRaw()

◆ naibrd_DIF_GetGroupRaw()

◆ naibrd_DIF_GetGroupStatusRaw()

◆ naibrd_DIF_GetRaw()

◆ naibrd_DIF_SetChannelRaw()

◆ naibrd_DIF_SetGroupInterruptEnableRaw()

◆ naibrd_DIF_SetGroupRaw()

◆ naibrd_DIF_SetRaw()