Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Raw Register Access Functions
Encoder Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetRaw (int32_t cardIndex, int32_t module, nai_enc_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_ENC_GetRaw (int32_t cardIndex, int32_t module, nai_enc_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_ENC_SetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_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_ENC_GetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_raw_channel_t type, uint32_t *outrawdata)
 Retrieves the raw data value in the register associated to the channel and register type specified.
 

Detailed Description


Function Documentation

◆ naibrd_ENC_GetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_enc_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_enc_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_ENC_GetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetRaw ( int32_t cardIndex,
int32_t module,
nai_enc_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_enc_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_ENC_SetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_enc_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_enc_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_ENC_SetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetRaw ( int32_t cardIndex,
int32_t module,
nai_enc_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_enc_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.