Raw Register Access Functions

Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_RLY_SetGroupRaw (int32_t cardIndex, int32_t module, int32_t group, naibrd_rly_raw_group_type_t type, uint32_t rawData)
	Sets the raw data value in the register associated with the group and register type specified.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_RLY_GetGroupRaw (int32_t cardIndex, int32_t module, int32_t group, naibrd_rly_raw_group_type_t type, uint32_t *p_outrawData)
	Retrieves the raw data value in the register associated with the group and register type specified.

Detailed Description

Function Documentation

naibrd_RLY_GetGroupRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_GetGroupRaw	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	group,
		naibrd_rly_raw_group_type_t	type,
		uint32_t *	p_outrawData )

Retrieves the raw data value in the register associated with the group 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]).
group	: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type	: (Input) Group Type: Refer to naibrd_rly_raw_group_type_t definitions.
p_outrawData	: (Output) Raw Data Code.

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

naibrd_RLY_SetGroupRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_SetGroupRaw	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	group,
		naibrd_rly_raw_group_type_t	type,
		uint32_t	rawData )

Sets the raw data value in the register associated with the group 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]).
group	: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type	: (Input) Group Type: Refer to naibrd_rly_raw_group_type_t definitions.
rawData	: (Input) Raw Data Code.

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