Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Raw Register Access Functions
D/A Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetRaw (int32_t cardIndex, int32_t module, nai_da_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_DA_GetRaw (int32_t cardIndex, int32_t module, nai_da_raw_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_DA_SetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_da_channel_raw_t type, uint32_t rawdata)
 Sets the raw data value in the register associated to the channel and channel register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_da_channel_raw_t type, uint32_t *outrawdata)
 Retrieves the raw data value in the register associated to the channel and channel register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetStatusRaw (int32_t cardIndex, int32_t module, nai_da_status_type_t type, uint32_t *outstatusRaw)
 Retrieves the status of the specified type. The status of a channel is flagged and latched. For Generation 3 DA modules status is latched until read. Reading any status bit will cause that bit to be unlatched. For Generation 5 DA modules status is latched until cleared. Writing a "1" to the bit will clear the latched status.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_ClearStatusRaw (int32_t cardIndex, int32_t module, nai_da_status_type_t type, uint32_t statusRaw)
 Clears the status of the specified type. For Generation 5 DA modules, the status of a channel is flagged and latched until a "1" is written to the bit. Writing a "1" to the status bit will cause that bit to be unlatched.
 

Detailed Description


Function Documentation

◆ naibrd_DA_ClearStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_ClearStatusRaw ( int32_t cardIndex,
int32_t module,
nai_da_status_type_t type,
uint32_t statusRaw )

Clears the status of the specified type. For Generation 5 DA modules, the status of a channel is flagged and latched until a "1" is written to the bit. Writing a "1" to the status bit will cause that bit to be unlatched.

Note: NAI_DA_STATUS_OVERCURRENT_ALERT is mapped to the 'Current Range Exceeded' status register. Please specify NAI_DA_STATUS_OVERCURRENT_ALERT_LATCHED or NAI_DA_STATUS_OVERCURRENT_ALERT_REALTIME when accessing the 'Current Range Exceeded' status 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]).
type: (Input) Status Type: refer to nai_da_status_type_t definitions.
statusRaw: (Input) Raw value to set.
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_DA_GetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_da_channel_raw_t type,
uint32_t * outrawdata )

Retrieves the raw data value in the register associated to 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 Register Type: refer to nai_da_channel_raw_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 module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid channel type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_GetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetRaw ( int32_t cardIndex,
int32_t module,
nai_da_raw_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 nai_da_raw_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 module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_GetStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetStatusRaw ( int32_t cardIndex,
int32_t module,
nai_da_status_type_t type,
uint32_t * outstatusRaw )

Retrieves the status of the specified type. The status of a channel is flagged and latched. For Generation 3 DA modules status is latched until read. Reading any status bit will cause that bit to be unlatched. For Generation 5 DA modules status is latched until cleared. Writing a "1" to the bit will clear the latched status.

Note: NAI_DA_STATUS_OVERCURRENT_ALERT is mapped to the 'Current Range Exceeded' status register. Please specify NAI_DA_STATUS_OVERCURRENT_ALERT_LATCHED or NAI_DA_STATUS_OVERCURRENT_ALERT_REALTIME when accessing the 'Current Range Exceeded' status 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]).
type: (Input) Status Type: refer to nai_da_status_type_t definitions.
outstatusRaw: (Output) for each bit, 0 for Normal, 1 Failure Detected.
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_DA_SetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_da_channel_raw_t type,
uint32_t rawdata )

Sets the raw data value in the register associated to 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 Register Type: refer to nai_da_channel_raw_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 channel type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_SetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetRaw ( int32_t cardIndex,
int32_t module,
nai_da_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) Module Register Type: refer to nai_da_raw_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 register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.