Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Raw Register Access Functions
NAI Board Library - Module Functions » RTD Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_SetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_rtd_channel_raw_t type, uint32_t rawdata)
 Sets the raw data value in the register associated with the channel and channel register type specified. Note: The registers corresponding to the channel register types NAIBRD_RTD_RAW_RESISTANCE and NAIBRD_RTD_RAW_TEMPERATURE are read-only, and NAI_ERROR_INVALID_VALUE will be returned by this function if either of those types are passed in as the type parameter.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_rtd_channel_raw_t type, uint32_t *p_outrawdata)
 Retrieves the raw data value in the register associated with the channel and channel register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_rtd_chan_mapped_status_type_t type, uint32_t *p_outstatusraw)
 Retrieves the raw status value in the register associated with the status type specified. Module Summary Status: Feature supported in FPGA Version >= X.X.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_ClearChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_rtd_chan_mapped_status_type_t type, uint32_t clearstatusraw)
 Clears the status for the channels specified (bit-masked) of the status type specified. Module Summary Status: Feature supported in FPGA Version >= X.X.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_SetChanMappedInterruptEnableRaw (int32_t cardIndex, int32_t module, naibrd_rtd_chan_mapped_status_type_t type, uint32_t statusintenab)
 Sets the raw interrupt enable data value in the register associated with the status type specified. Module Summary Status: Feature supported in FPGA Version >= X.X.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetChanMappedInterruptEnableRaw (int32_t cardIndex, int32_t module, naibrd_rtd_chan_mapped_status_type_t type, uint32_t *p_outstatusintenab)
 Retrieves the raw interrupt enable data value in the register associated with the status type specified. Module Summary Status: Feature supported in FPGA Version >= X.X.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetStatusRaw (int32_t cardIndex, int32_t module, nai_rtd_status_type_t type, uint32_t *p_outstatusraw)
 Retrieves the raw status value in the register associated with the status type specified. Module Summary Status: Feature supported in FPGA Version >= X.X.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_ClearStatusRaw (int32_t cardIndex, int32_t module, nai_rtd_status_type_t type, uint32_t clearstatusraw)
 Clears the status for the channels specified (bit-masked) of the status type specified. Module Summary Status: Feature supported in FPGA Version >= X.X.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_SetInterruptEnableRaw (int32_t cardIndex, int32_t module, nai_rtd_status_type_t type, uint32_t statusintenab)
 Sets the raw interrupt enable data value in the register associated with the status type specified. Module Summary Status: Feature supported in FPGA Version >= X.X.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetInterruptEnableRaw (int32_t cardIndex, int32_t module, nai_rtd_status_type_t type, uint32_t *p_outstatusintenab)
 Retrieves the raw interrupt enable data value in the register associated with the status type specified. Module Summary Status: Feature supported in FPGA Version >= X.X.
 

Detailed Description

Function Documentation

◆ naibrd_RTD_ClearChanMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_ClearChanMappedStatusRaw ( int32_t cardIndex,
int32_t module,
naibrd_rtd_chan_mapped_status_type_t type,
uint32_t clearstatusraw )

Clears the status for the channels specified (bit-masked) of the status type specified. Module Summary Status: Feature supported in FPGA Version >= X.X.

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 naibrd_rtd_chan_mapped_status_type_t definition.
clearstatusraw: (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_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_RTD_ClearStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_ClearStatusRaw ( int32_t cardIndex,
int32_t module,
nai_rtd_status_type_t type,
uint32_t clearstatusraw )

Clears the status for the channels specified (bit-masked) of the status type specified. Module Summary Status: Feature supported in FPGA Version >= X.X.

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 naibrd_rtd_chan_mapped_status_type_t definition.
clearstatusraw: (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_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_RTD_GetChanMappedInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetChanMappedInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
naibrd_rtd_chan_mapped_status_type_t type,
uint32_t * p_outstatusintenab )

Retrieves the raw interrupt enable data value in the register associated with the status type specified. Module Summary Status: Feature supported in FPGA Version >= X.X.

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 naibrd_rtd_chan_mapped_status_type_t definition.
p_outstatusintenab: (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_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_RTD_GetChanMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetChanMappedStatusRaw ( int32_t cardIndex,
int32_t module,
naibrd_rtd_chan_mapped_status_type_t type,
uint32_t * p_outstatusraw )

Retrieves the raw status value in the register associated with the status type specified. Module Summary Status: Feature supported in FPGA Version >= X.X.

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 naibrd_rtd_chan_mapped_status_type_t definition.
p_outstatusraw: (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_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_RTD_GetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_rtd_channel_raw_t type,
uint32_t * p_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 Register Type : refer to naibrd_rtd_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_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_RTD_GetInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
nai_rtd_status_type_t type,
uint32_t * p_outstatusintenab )

Retrieves the raw interrupt enable data value in the register associated with the status type specified. Module Summary Status: Feature supported in FPGA Version >= X.X.

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 naibrd_rtd_chan_mapped_status_type_t definition.
p_outstatusintenab: (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_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_RTD_GetStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetStatusRaw ( int32_t cardIndex,
int32_t module,
nai_rtd_status_type_t type,
uint32_t * p_outstatusraw )

Retrieves the raw status value in the register associated with the status type specified. Module Summary Status: Feature supported in FPGA Version >= X.X.

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 naibrd_rtd_chan_mapped_status_type_t definition.
p_outstatusraw: (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_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_RTD_SetChanMappedInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_SetChanMappedInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
naibrd_rtd_chan_mapped_status_type_t type,
uint32_t statusintenab )

Sets the raw interrupt enable data value in the register associated with the status type specified. Module Summary Status: Feature supported in FPGA Version >= X.X.

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 naibrd_rtd_chan_mapped_status_type_t definition.
statusintenab: (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_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_RTD_SetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_SetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_rtd_channel_raw_t type,
uint32_t rawdata )

Sets the raw data value in the register associated with the channel and channel register type specified. Note: The registers corresponding to the channel register types NAIBRD_RTD_RAW_RESISTANCE and NAIBRD_RTD_RAW_TEMPERATURE are read-only, and NAI_ERROR_INVALID_VALUE will be returned by this function if either of those types are passed in as the type parameter.

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 naibrd_rtd_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_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_RTD_SetInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_SetInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
nai_rtd_status_type_t type,
uint32_t statusintenab )

Sets the raw interrupt enable data value in the register associated with the status type specified. Module Summary Status: Feature supported in FPGA Version >= X.X.

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 naibrd_rtd_chan_mapped_status_type_t definition.
statusintenab: (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_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.