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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetRaw (int32_t cardIndex, int32_t module, naibrd_vr_raw_t type, uint32_t rawData)
 Sets the raw data value in the register associated with the register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetRaw (int32_t cardIndex, int32_t module, naibrd_vr_raw_t type, uint32_t *p_outrawData)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_vr_channel_raw_t type, uint32_t rawData)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_vr_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_VR_GetChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_vr_chan_mapped_status_type_t type, 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_VR_ClearChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_vr_chan_mapped_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_VR_SetChanMappedInterruptEnableRaw (int32_t cardIndex, int32_t module, naibrd_vr_chan_mapped_status_type_t type, uint32_t statusIntEnabRaw)
 Sets the raw data value in the interrupt enable register associated with the status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetChanMappedInterruptEnableRaw (int32_t cardIndex, int32_t module, naibrd_vr_chan_mapped_status_type_t type, uint32_t *p_outstatusIntEnabRaw)
 Retrieves the raw data value in the interrupt enable register associated with the status type specified.
 

Detailed Description

Function Documentation

◆ naibrd_VR_ClearChanMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_ClearChanMappedStatusRaw ( int32_t cardIndex,
int32_t module,
naibrd_vr_chan_mapped_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_vr_chan_mapped_status_type_t definition.
statusRaw: (Input) Mask of bits to clear in the status register (bits set to 1 will be cleared).
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_VR_GetChanMappedInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetChanMappedInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
naibrd_vr_chan_mapped_status_type_t type,
uint32_t * p_outstatusIntEnabRaw )

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]).
type: (Input) Status Type: refer to naibrd_vr_chan_mapped_status_type_t definition.
p_outstatusIntEnabRaw: (Output) Raw Data read from module.
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_VR_GetChanMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetChanMappedStatusRaw ( int32_t cardIndex,
int32_t module,
naibrd_vr_chan_mapped_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_vr_chan_mapped_status_type_t definition.
p_outstatusRaw: (Output) Raw Data read from module.
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_VR_GetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_vr_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 Raw Type: refer to naibrd_vr_channel_raw_t definition.
p_outrawData: (Output) Raw Data read from module.
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_VR_GetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetRaw ( int32_t cardIndex,
int32_t module,
naibrd_vr_raw_t type,
uint32_t * p_outrawData ) 
* Retrieves the raw data value in the register associated with the register type specified.
* The following naibrd_vr_raw_t definition is write-only and will return NAI_ERROR_INVALID_VALUE if passed in as type:
*    NAIBRD_VR_RAW_RESET_CYCLE_COUNT
*
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_vr_raw_t definition.
p_outrawData: (Output) Raw Data read from module.
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_VR_SetChanMappedInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetChanMappedInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
naibrd_vr_chan_mapped_status_type_t type,
uint32_t statusIntEnabRaw )

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]).
type: (Input) Status Type: refer to naibrd_vr_chan_mapped_status_type_t definition.
statusIntEnabRaw: (Input) Raw Data to write to module.
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_VR_SetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_vr_channel_raw_t type,
uint32_t rawData ) 
* Sets the raw data value in the register associated with the channel and channel register type specified.
* The following naibrd_vr_channel_raw_t definitions are read-only and will return NAI_ERROR_INVALID_VALUE if passed in as type:
*    NAIBRD_VR_CHAN_RAW_MEASURED_PERIOD,
*    NAIBRD_VR_CHAN_RAW_MEASURED_PHASE,
*    NAIBRD_VR_CHAN_RAW_MEASURED_PERCENT_TORQUE,
*    NAIBRD_VR_CHAN_RAW_MEASURED_AMPLITUDE,
*    NAIBRD_VR_CHAN_RAW_MEASURED_FREQUENCY,
*    NAIBRD_VR_CHAN_RAW_MEASURED_RPM,
*    NAIBRD_VR_CHAN_RAW_CYCLE_COUNT
*
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_vr_channel_raw_t definition.
rawData: (Input) Raw Data to write to module.
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_VR_SetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetRaw ( int32_t cardIndex,
int32_t module,
naibrd_vr_raw_t type,
uint32_t rawData )

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_vr_raw_t definition.
rawData: (Input) Raw Data to write to module.
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.