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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetRaw (int32_t cardIndex, int32_t module, nai_sd_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_SD_GetRaw (int32_t cardIndex, int32_t module, nai_sd_raw_t type, uint32_t *outrawdata)
 Sets the raw data value in the register associated with the register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_sd_channel_raw_t type, uint32_t rawdata)
 Sets the raw data value in the register associated with the channel and channel register type specified. BIT Error Limit feature supported in FPGA Version >= 9.28.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_sd_channel_raw_t type, uint32_t *outrawdata)
 Retrieves the raw data value in the register associated with the channel and channel register type specified. BIT Error Limit feature supported in FPGA Version >= 9.28.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetStatusRaw (int32_t cardIndex, int32_t module, nai_sd_status_type_t type, uint32_t statusraw)
 Sets the raw data value in the status register associated with the status type specified. This function may be used to clear multiple latched status bits in the status word. NAI_SD_STATUS_SUMMARY supported in FPGA Version >= 9.28.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetStatusRaw (int32_t cardIndex, int32_t module, nai_sd_status_type_t type, uint32_t *outstatusraw)
 Retrieves the raw data value in the status register associated with the status type specified. NAI_SD_STATUS_SUMMARY supported in FPGA Version >= 9.28.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetInterruptEnableRaw (int32_t cardIndex, int32_t module, nai_sd_status_type_t type, uint32_t statusintenabraw)
 Sets the raw data value in the interrupt enable register associated with the status type specified. NAI_SD_STATUS_SUMMARY supported in FPGA Version >= 9.28.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetInterruptEnableRaw (int32_t cardIndex, int32_t module, nai_sd_status_type_t type, uint32_t *outstatusintenabraw)
 Retrieves the raw data value in the interrupt enable register associated with the status type specified. NAI_SD_STATUS_SUMMARY supported in FPGA Version >= 9.28.
 

Detailed Description


Function Documentation

◆ naibrd_SD_GetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_sd_channel_raw_t type,
uint32_t * outrawdata )

Retrieves the raw data value in the register associated with the channel and channel register type specified. BIT Error Limit feature supported in FPGA Version >= 9.28.

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_sd_channel_raw_t definition
outrawdata: (Output) Raw Data Value.
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_SD_GetInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
nai_sd_status_type_t type,
uint32_t * outstatusintenabraw )

Retrieves the raw data value in the interrupt enable register associated with the status type specified. NAI_SD_STATUS_SUMMARY supported in FPGA Version >= 9.28.

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_sd_status_type_t definition
outstatusintenabraw: (Output) Raw Data Value.
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 invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetRaw ( int32_t cardIndex,
int32_t module,
nai_sd_raw_t type,
uint32_t * outrawdata )

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

◆ naibrd_SD_GetStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetStatusRaw ( int32_t cardIndex,
int32_t module,
nai_sd_status_type_t type,
uint32_t * outstatusraw )

Retrieves the raw data value in the status register associated with the status type specified. NAI_SD_STATUS_SUMMARY supported in FPGA Version >= 9.28.

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_sd_status_type_t definition
outstatusraw: (Output) Raw Data Value.
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 invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_sd_channel_raw_t type,
uint32_t rawdata )

Sets the raw data value in the register associated with the channel and channel register type specified. BIT Error Limit feature supported in FPGA Version >= 9.28.

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_sd_channel_raw_t definition
The following nai_sd_channel_raw_t definition are read-only and will return NAI_ERROR_INVALID_VALUE if passed in as type:
   NAI_SD_CHAN_RAW_ANGLE,                (* Read-only *)
   NAI_SD_CHAN_RAW_VELOCITY,             (* Read-only *)
   NAI_SD_CHAN_RAW_FREQUENCY,            (* Read-only *)
   NAI_SD_CHAN_RAW_SIGNAL_VOLTAGE,       (* Read-only *)
   NAI_SD_CHAN_RAW_REF_VOLTAGE,          (* Read-only *)
Parameters
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.

◆ naibrd_SD_SetInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
nai_sd_status_type_t type,
uint32_t statusintenabraw )

Sets the raw data value in the interrupt enable register associated with the status type specified. NAI_SD_STATUS_SUMMARY supported in FPGA Version >= 9.28.

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_sd_status_type_t definition
statusintenabraw: (Input) Raw Data Value.
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 invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetRaw ( int32_t cardIndex,
int32_t module,
nai_sd_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) Raw Type: refer to nai_sd_raw_t definition
rawdata: (Input) Raw Data Value.
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 invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetStatusRaw ( int32_t cardIndex,
int32_t module,
nai_sd_status_type_t type,
uint32_t statusraw )

Sets the raw data value in the status register associated with the status type specified. This function may be used to clear multiple latched status bits in the status word. NAI_SD_STATUS_SUMMARY supported in FPGA Version >= 9.28.

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_sd_status_type_t definition.
statusraw: (Input) Raw Status Data Word.
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 invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.