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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetRawValueByChannel (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dl_rawByChannel_type_t opMode, uint32_t opValue)
 Writes a raw value to a register based on channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetRawValueByChannel (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dl_rawByChannel_type_t opMode, uint32_t *p_outopValue)
 Retrieves a raw value from a register based on channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetRawValue (int32_t cardIndex, int32_t module, naibrd_dl_raw_type_t opMode, uint32_t opValue)
 Writes the raw value to a register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetRawValue (int32_t cardIndex, int32_t module, naibrd_dl_raw_type_t opMode, uint32_t *p_outopValue)
 Retrieves the raw value from a register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_dl_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_DL_ClearChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_dl_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_DL_SetChanMappedInterruptEnableRaw (int32_t cardIndex, int32_t module, naibrd_dl_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_DL_GetChanMappedInterruptEnableRaw (int32_t cardIndex, int32_t module, naibrd_dl_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.
 

Detailed Description


Function Documentation

◆ naibrd_DL_ClearChanMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_ClearChanMappedStatusRaw ( int32_t cardIndex,
int32_t module,
naibrd_dl_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_dl_chan_mapped_status_type_t definition.
statusRaw: (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 statusType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DL_GetChanMappedInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetChanMappedInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
naibrd_dl_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_dl_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_DL_GetChanMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetChanMappedStatusRaw ( int32_t cardIndex,
int32_t module,
naibrd_dl_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_dl_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_DL_GetRawValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetRawValue ( int32_t cardIndex,
int32_t module,
naibrd_dl_raw_type_t opMode,
uint32_t * p_outopValue )

Retrieves the raw value from a register.

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]).
opMode: (Input) Raw Type: refer to naibrd_dl_raw_type_t definition.
p_outopValue: (Output) Raw value to be read from register.
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 opMode parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DL_GetRawValueByChannel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetRawValueByChannel ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dl_rawByChannel_type_t opMode,
uint32_t * p_outopValue )

Retrieves a raw value from a register based on channel.

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]).
opMode: (Input) Channel Raw Type: refer to naibrd_dl_rawByChannel_type_t definition.
p_outopValue: (Output) Raw value to be read from register.
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 opMode parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DL_SetChanMappedInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetChanMappedInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
naibrd_dl_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_dl_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_DL_SetRawValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetRawValue ( int32_t cardIndex,
int32_t module,
naibrd_dl_raw_type_t opMode,
uint32_t opValue )

Writes the raw value to a register.

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]).
opMode: (Input) Raw Type: refer to naibrd_dl_raw_type_t definition.
opValue: (Input) Raw value to be written to register.
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 opMode parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DL_SetRawValueByChannel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetRawValueByChannel ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dl_rawByChannel_type_t opMode,
uint32_t opValue )

Writes a raw value to a register based on channel.

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]).
opMode: (Input) Channel Raw Type: refer to naibrd_dl_rawByChannel_type_t definition.
opValue: (Input) Raw value to be written to register.
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 opMode parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.