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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_SetRaw (int32_t cardIndex, int32_t module, nai_ad_raw_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_AD_GetRaw (int32_t cardIndex, int32_t module, nai_ad_raw_t type, uint32_t *p_outrawdata)
 Retrieves the raw data value in the register associated to the register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_SetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_channel_raw_t type, uint32_t rawdata)
 Sets the raw data value in the register associated to the channel and channel register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_channel_raw_t type, uint32_t *p_outrawdata)
 Retrieves the raw data value in the register associated to the channel and channel register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetStatusRaw (int32_t cardIndex, int32_t module, nai_ad_status_type_t type, uint32_t *p_outrawdata)
 Retrieves the raw status data value in the register associated to the group and status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ClearStatusRaw (int32_t cardIndex, int32_t module, nai_ad_status_type_t type, uint32_t rawdata)
 Clears the status data value in the register associated to the group and status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ClearFIFOStatusRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_fifo_status_t mask)
 Clears the FIFO status data value in the latched register associated to the channel specified.
 

Detailed Description


Function Documentation

◆ naibrd_AD_ClearFIFOStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ClearFIFOStatusRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ad_fifo_status_t mask )

Clears the FIFO status data value in the latched register associated to the channel specified.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect 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]).
mask: (Input) FIFO Status bits to clear. For every bit that is set high in "mask", the corresponding bit in the FIFO latched status register of the channel specified is reset to 0. Refer to nai_ad_fifo_status_t definition.
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_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AD_ClearStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ClearStatusRaw ( int32_t cardIndex,
int32_t module,
nai_ad_status_type_t type,
uint32_t rawdata )

Clears the status data value in the register associated to the group and status 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) Status Type: refer to nai_ad_status_type_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 module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid status register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AD_GetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ad_channel_raw_t type,
uint32_t * p_outrawdata )

Retrieves the raw data value in the register associated to 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 Register Type: refer to nai_ad_channel_raw_t definition.
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_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid channel type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AD_GetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetRaw ( int32_t cardIndex,
int32_t module,
nai_ad_raw_t type,
uint32_t * p_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_ad_raw_t definition.
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 register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AD_GetStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetStatusRaw ( int32_t cardIndex,
int32_t module,
nai_ad_status_type_t type,
uint32_t * p_outrawdata )

Retrieves the raw status data value in the register associated to the group and status 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) Status Type: refer to nai_ad_status_type_t definition.
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 status register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AD_SetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_SetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ad_channel_raw_t type,
uint32_t rawdata )

Sets the raw data value in the register associated to 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 Register Type: refer to nai_ad_channel_raw_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 module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid channel type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AD_SetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_SetRaw ( int32_t cardIndex,
int32_t module,
nai_ad_raw_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_ad_raw_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 module 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.