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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetRaw (int32_t cardIndex, int32_t module, naibrd_lvdt_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_LVDT_GetRaw (int32_t cardIndex, int32_t module, naibrd_lvdt_raw_t type, uint32_t *p_outrawData)
 Sets the raw data value in the register associated with the register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_channel_raw_t type, uint32_t rawData)
 Sets the raw data value in the register associated with the channel and channel register type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_channel_raw_t type, uint32_t *p_outrawData)
 Retrieves the raw data value in the register associated with the channel and channel register type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_lvdt_chan_mapped_status_type_t statusType, uint32_t *p_outstatusRaw)
 Retrieves the raw data value in the status register associated with the status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_ClearChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_lvdt_chan_mapped_status_type_t statusType, 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.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetChanMappedInterruptEnableRaw (int32_t cardIndex, int32_t module, naibrd_lvdt_chan_mapped_status_type_t statusType, uint32_t enableRaw)
 Sets the raw data value in the interrupt enable register associated with the status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetChanMappedInterruptEnableRaw (int32_t cardIndex, int32_t module, naibrd_lvdt_chan_mapped_status_type_t statusType, uint32_t *p_outEnableRaw)
 Retrieves the raw data value in the interrupt enable register associated with the status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetEventMappedStatusRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_status_access_type_t accessType, naibrd_lvdt_event_mapped_category_type_t type, uint32_t *p_outstatusRaw)
 Retrieves the raw data value in the event mapped status register associated with the LVDT channel and status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_ClearEventMappedStatusRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_event_mapped_category_type_t type, uint32_t statusRaw)
 Clears the raw data value in the event mapped status register associated with the LVDT channel and status type specified and the bits specified in the parameter statusRaw.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetEventMappedInterruptEnableRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_event_mapped_category_type_t type, uint32_t enableRaw)
 Sets the raw data value in the event mapped interrupt enable register associated with the LVDT channel and status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetEventMappedInterruptEnableRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_event_mapped_category_type_t type, uint32_t *p_outEnableRaw)
 Retrieves the raw data value in the event mapped interrupt enable register associated with the LVDT channel and status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetStatusRaw (int32_t cardIndex, int32_t module, naibrd_lvdt_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.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetStatusRaw (int32_t cardIndex, int32_t module, naibrd_lvdt_status_type_t type, uint32_t *p_outstatusRaw)
 Retrieves the raw data value in the status register associated with the status type specified.
 

Detailed Description

Function Documentation

◆ naibrd_LVDT_ClearChanMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_ClearChanMappedStatusRaw ( int32_t cardIndex,
int32_t module,
naibrd_lvdt_chan_mapped_status_type_t statusType,
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.

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]).
statusType: (Input) Status Type: refer to naibrd_lvdt_chan_mapped_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 statusType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_ClearEventMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_ClearEventMappedStatusRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_event_mapped_category_type_t type,
uint32_t statusRaw )

Clears the raw data value in the event mapped status register associated with the LVDT channel and status type specified and the bits specified in the parameter statusRaw.

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) Event Mapped Status Category Type: refer to naibrd_lvdt_event_mapped_category_type_t definition.
statusRaw: (Input) Raw Status Data Word bits to clear.
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_LVDT_GetChanMappedInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetChanMappedInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
naibrd_lvdt_chan_mapped_status_type_t statusType,
uint32_t * p_outEnableRaw )

Retrieves the raw data value in the interrupt enable register associated with the 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]).
statusType: (Input) Status Type: refer to naibrd_lvdt_chan_mapped_status_type_t definition.
p_outEnableRaw: (Output) Raw Interrupt Enable 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 statusType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetChanMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetChanMappedStatusRaw ( int32_t cardIndex,
int32_t module,
naibrd_lvdt_chan_mapped_status_type_t statusType,
uint32_t * p_outstatusRaw )

Retrieves the raw data value in the status register associated with the 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]).
statusType: (Input) Status Type: refer to naibrd_lvdt_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 statusType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_channel_raw_t type,
uint32_t * p_outrawData )

Retrieves the raw data value in the register associated with the channel and channel register type.

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 naibrd_lvdt_channel_raw_t definition.
p_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_LVDT_GetEventMappedInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetEventMappedInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_event_mapped_category_type_t type,
uint32_t * p_outEnableRaw )

Retrieves the raw data value in the event mapped interrupt enable register associated with the LVDT channel 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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
type: (Input) Event Mapped Status Category Type: refer to naibrd_lvdt_event_mapped_category_type_t definition.
p_outEnableRaw: (Output) Raw Interrupt Enable 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_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_LVDT_GetEventMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetEventMappedStatusRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_status_access_type_t accessType,
naibrd_lvdt_event_mapped_category_type_t type,
uint32_t * p_outstatusRaw )

Retrieves the raw data value in the event mapped status register associated with the LVDT channel 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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
type: (Input) Event Mapped Status Category Type: refer to naibrd_lvdt_event_mapped_category_type_t definition.
accessType: (Input) nai_status_access_type_t type (NAI_STATUS_LATCHED or NAI_STATUS_REALTIME).
p_outstatusRaw: (Output) 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_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter or invalid accessType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetRaw ( int32_t cardIndex,
int32_t module,
naibrd_lvdt_raw_t type,
uint32_t * p_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 naibrd_lvdt_raw_t definition.
p_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_LVDT_GetStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetStatusRaw ( int32_t cardIndex,
int32_t module,
naibrd_lvdt_status_type_t type,
uint32_t * p_outstatusRaw )

Retrieves the raw data value in the status register associated with the 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 naibrd_lvdt_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_LVDT_SetChanMappedInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetChanMappedInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
naibrd_lvdt_chan_mapped_status_type_t statusType,
uint32_t enableRaw )

Sets the raw data value in the interrupt enable register associated with the 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]).
statusType: (Input) Status Type: refer to naibrd_lvdt_chan_mapped_status_type_t definition.
enableRaw: (Input) Raw Interrupt Enable 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 statusType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_channel_raw_t type,
uint32_t rawData )

Sets the raw data value in the register associated with the channel and channel register type.

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 naibrd_lvdt_channel_raw_t definition.
* The following naibrd_lvdt_channel_raw_t definition are read-only and will return NAI_ERROR_INVALID_VALUE if passed in as type:
*    NAIBRD_LVDT_CHAN_RAW_POSITION,             (* Read-only *)
*    NAIBRD_LVDT_CHAN_RAW_POSITION_B,           (* Read-only *)
*    NAIBRD_LVDT_CHAN_RAW_VELOCITY,             (* Read-only *)
*    NAIBRD_LVDT_CHAN_RAW_VELOCITY_B,           (* Read-only *)
*    NAIBRD_LVDT_CHAN_RAW_FREQUENCY,            (* Read-only *)
*    NAIBRD_LVDT_CHAN_RAW_SIGNAL_VOLTAGE,       (* Read-only *)
*    NAIBRD_LVDT_CHAN_RAW_REF_VOLTAGE,          (* Read-only *)
*    NAIBRD_LVDT_CHAN_RAW_VA,                   (* Read-only *)
*    NAIBRD_LVDT_CHAN_RAW_VB,                   (* Read-only *)
*    NAIBRD_LVDT_CHAN_RAW_VA_AND_VB,            (* Read-only *)
*    NAIBRD_LVDT_CHAN_RAW_VA_DETECT,            (* Read-only *)
*    NAIBRD_LVDT_CHAN_RAW_VB_DETECT             (* 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_LVDT_SetEventMappedInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetEventMappedInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_event_mapped_category_type_t type,
uint32_t enableRaw )

Sets the raw data value in the event mapped interrupt enable register associated with the LVDT channel 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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
type: (Input) Event Mapped Status Category Type: refer to naibrd_lvdt_event_mapped_category_type_t definition.
enableRaw: (Input) Raw Interrupt Enable 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_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_LVDT_SetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetRaw ( int32_t cardIndex,
int32_t module,
naibrd_lvdt_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 naibrd_lvdt_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_LVDT_SetStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetStatusRaw ( int32_t cardIndex,
int32_t module,
naibrd_lvdt_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.

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_lvdt_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.