Raw Register Access Functions

Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DL_SetRawValueByChannel (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_rawByChannel_type_t opMode, uint32_t opValue)
	Writes a raw value to a register based on channel.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DL_GetRawValueByChannel (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_rawByChannel_type_t opMode, uint32_t *opValue)
	Reads a raw value from a register based on channel.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DL_SetRawValue (int32_t cardIndex, int32_t module, nai_dl_raw_type_t opMode, uint32_t opValue)
	Writes the raw value to a register.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DL_GetRawValue (int32_t cardIndex, int32_t module, nai_dl_raw_type_t opMode, uint32_t *opValue)
	Reads the raw value from a register.

Detailed Description

Function Documentation

naibrd_DL_GetRawValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetRawValue	(	int32_t	cardIndex,
		int32_t	module,
		nai_dl_raw_type_t	opMode,
		uint32_t *	opValue )

Reads the raw value from a 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]).
opMode	: (Input) Raw Type: refer to nai_dl_raw_type_t definition
opValue	: (Output) Raw value to be read from register.

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

naibrd_DL_GetRawValueByChannel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetRawValueByChannel	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_dl_rawByChannel_type_t	opMode,
		uint32_t *	opValue )

Reads a raw value from a register based on 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]).
opMode	: (Input) Raw Type: refer to nai_dl_rawByChannel_type_t definition
opValue	: (Output) Raw value to be read from register.

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

naibrd_DL_SetRawValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetRawValue	(	int32_t	cardIndex,
		int32_t	module,
		nai_dl_raw_type_t	opMode,
		uint32_t	opValue )

Writes the raw value to a 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]).
opMode	: (Input) Raw Type: refer to nai_dl_raw_type_t definition
opValue	: (Input) Raw value to be written to register.

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_RANGE when the opMode parameter is invalid.
• NAI_ERROR_INVALID_RANGE when invalid range parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_DL_SetRawValueByChannel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetRawValueByChannel	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_dl_rawByChannel_type_t	opMode,
		uint32_t	opValue )

Writes a raw value to a register based on 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]).
opMode	: (Input) Raw Type: refer to nai_dl_rawByChannel_type_t definition
opValue	: (Input) Raw value to be written to register.

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