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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_SetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_ioct_channel_raw_t type, uint32_t rawdata)
 Sets the raw data value in the register associated with the channel and channel register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_ioct_channel_raw_t type, uint32_t *outrawdata)
 Retrieves the raw data value in the register associated with the channel and channel register type specified.
 

Detailed Description


Function Documentation

◆ naibrd_IOCT_GetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ioct_channel_raw_t type,
uint32_t * outrawdata )

Retrieves the raw data value in the register associated with the channel and channel 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 Raw Type: refer to nai_ioct_channel_raw_t definition
outrawdata: (Output) Raw Data.
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 invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IOCT_SetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_SetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ioct_channel_raw_t type,
uint32_t rawdata )

Sets the raw data value in the register associated with the channel and channel 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 Raw Type: refer to nai_ioct_channel_raw_t definition
rawdata: (Input) Raw Data.
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 invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.