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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetRaw (int32_t cardIndex, int32_t module, naibrd_dif_raw_module_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_DIF_GetRaw (int32_t cardIndex, int32_t module, naibrd_dif_raw_module_t type, uint32_t *outrawdata)
 Retrieves the raw data value in the register associated to the register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dif_raw_channel_t type, uint32_t rawdata)
 Sets the raw data value in the register associated to the channel and register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dif_raw_channel_t type, uint32_t *outrawdata)
 Retrieves the raw data value in the register associated to the channel and register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_dif_chan_mapped_status_type_t type, uint32_t *outrawStatus)
 Retrieves the status for the specified DF1 channel and status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_ClearChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_dif_chan_mapped_status_type_t type, uint32_t statusRaw)
 Clears the latched status for the specified DIF channel and status type.
 

Detailed Description

Function Documentation

◆ naibrd_DIF_ClearChanMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_ClearChanMappedStatusRaw ( int32_t cardIndex,
int32_t module,
naibrd_dif_chan_mapped_status_type_t type,
uint32_t statusRaw )

Clears the latched status for the specified DIF channel and status 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]).
type: (Input) Status Type: refer to naibrd_dif_chan_mapped_status_type_t definition.
statusRaw: (Input) Raw data bits of channels to clear.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when an invalid naibrd_dif_chan_mapped_status_type_t type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_GetChanMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetChanMappedStatusRaw ( int32_t cardIndex,
int32_t module,
naibrd_dif_chan_mapped_status_type_t type,
uint32_t * outrawStatus )

Retrieves the status for the specified DF1 channel and status 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]).
type: (Input) Status Type: refer to naibrd_dif_chan_mapped_status_type_t definition.
outrawStatus: (Output) Raw data bits of the channel status register.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when an invalid naibrd_dif_chan_mapped_status_type_t type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_GetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dif_raw_channel_t type,
uint32_t * outrawdata )

Retrieves the raw data value in the register associated to the channel and 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_dif_raw_channel_t type definition.
outrawdata: (Output) Raw Data Code.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter.
  • NAI_ERROR_INVALID_VALUE when an invalid naibrd_dif_raw_channel_t type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_GetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetRaw ( int32_t cardIndex,
int32_t module,
naibrd_dif_raw_module_t type,
uint32_t * outrawdata )

Retrieves 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) Module Register Type: refer to naibrd_dif_raw_module_t definition.
outrawdata: (Output) Raw Data Code.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when an invalid naibrd_dif_raw_module_t type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_SetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dif_raw_channel_t type,
uint32_t rawdata )

Sets the raw data value in the register associated to the channel and 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_dif_raw_channel_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 card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter.
  • NAI_ERROR_INVALID_VALUE when an invalid naibrd_dif_raw_channel_t type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_SetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetRaw ( int32_t cardIndex,
int32_t module,
naibrd_dif_raw_module_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) Module Register Type: refer to naibrd_dif_raw_module_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 card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when an invalid naibrd_dif_raw_module_t type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.