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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetRaw (int32_t cardIndex, int32_t module, naibrd_ds_raw_module_value_type_t type, uint32_t inRawdata)
 Sets the raw data value in the register associated to the register type specified for a D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetRaw (int32_t cardIndex, int32_t module, naibrd_ds_raw_module_value_type_t type, uint32_t *p_outRawData)
 Gets the raw data value in the register associated to the register type specified from a D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ds_raw_channel_value_type_t type, uint32_t inChanRaw)
 Sets the raw data value for a specified channel associated to a specified type for a D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ds_raw_channel_value_type_t type, uint32_t *p_outChanRaw)
 Gets the raw data value for a specified channel with a specified type from a D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_ds_chan_mapped_status_type_t type, uint32_t *p_outStatusRaw)
 Gets the raw status value for a specified status type from a D/S module. For Gen 5 modules, to unlatch the latched status, write a one to the latched channel mask position.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_ClearChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_ds_chan_mapped_status_type_t type, uint32_t rawdata)
 Clears the latched status data value in the register associated to the status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetStatusRaw (int32_t cardIndex, int32_t module, nai_ds_status_type_t type, uint32_t *p_outStatusRaw)
 Gets the raw status value for a specified status type from a D/S module. For Gen 5 modules, to unlatch the latched status, write a one to the latched channel mask position.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_ClearStatusRaw (int32_t cardIndex, int32_t module, nai_ds_status_type_t type, uint32_t rawdata)
 Clears the latched status data value in the register associated to the status type specified.
 

Detailed Description

Function Documentation

◆ naibrd_DS_ClearChanMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_ClearChanMappedStatusRaw ( int32_t cardIndex,
int32_t module,
naibrd_ds_chan_mapped_status_type_t type,
uint32_t rawdata )

Clears the latched status data value in the register associated to 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_ds_chan_mapped_status_type_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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_ClearStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_ClearStatusRaw ( int32_t cardIndex,
int32_t module,
nai_ds_status_type_t type,
uint32_t rawdata )

Clears the latched status data value in the register associated to 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_ds_chan_mapped_status_type_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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_GetChanMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetChanMappedStatusRaw ( int32_t cardIndex,
int32_t module,
naibrd_ds_chan_mapped_status_type_t type,
uint32_t * p_outStatusRaw )

Gets the raw status value for a specified status type from a D/S module. For Gen 5 modules, to unlatch the latched status, write a one to the latched channel mask position.

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_ds_chan_mapped_status_type_t definitions.
p_outStatusRaw: (Output) Returns the raw data value from a D/S 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_GetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ds_raw_channel_value_type_t type,
uint32_t * p_outChanRaw )

Gets the raw data value for a specified channel with a specified type from a D/S module.

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_ds_raw_channel_value_type_t definition.
p_outChanRaw: (Output) Returns the raw data value from a specified channel of a D/S 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_NOT_OPEN when handle to board is invalid.
  • 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_DS_GetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetRaw ( int32_t cardIndex,
int32_t module,
naibrd_ds_raw_module_value_type_t type,
uint32_t * p_outRawData )

Gets the raw data value in the register associated to the register type specified from a D/S module.

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_ds_raw_module_value_type_t definition.
p_outRawData: (Output) Returns the raw data value from a D/S 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_GetStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetStatusRaw ( int32_t cardIndex,
int32_t module,
nai_ds_status_type_t type,
uint32_t * p_outStatusRaw )

Gets the raw status value for a specified status type from a D/S module. For Gen 5 modules, to unlatch the latched status, write a one to the latched channel mask position.

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_ds_chan_mapped_status_type_t definitions.
p_outStatusRaw: (Output) Returns the raw data value from a D/S 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_SetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ds_raw_channel_value_type_t type,
uint32_t inChanRaw )

Sets the raw data value for a specified channel associated to a specified type for a D/S module.

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_ds_raw_channel_value_type_t definition.
inChanRaw: (Input) Writes the raw data value to a specified channel for a D/S 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_NOT_OPEN when handle to board is invalid.
  • 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_DS_SetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetRaw ( int32_t cardIndex,
int32_t module,
naibrd_ds_raw_module_value_type_t type,
uint32_t inRawdata )

Sets the raw data value in the register associated to the register type specified for a D/S module.

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_ds_raw_module_value_type_t definition.
inRawdata: (Input) Writes the raw data value to a D/S 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.