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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetRaw (int32_t cardIndex, int32_t module, nai_dt_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_DT_GetRaw (int32_t cardIndex, int32_t module, nai_dt_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_DT_SetGroupRaw (int32_t cardIndex, int32_t module, int32_t group, nai_dt_raw_group_t type, uint32_t rawdata)
 Sets the raw data value in the register associated to the group and register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetGroupRaw (int32_t cardIndex, int32_t module, int32_t group, nai_dt_raw_group_t type, uint32_t *outrawdata)
 Retrieves the raw data value in the register associated to the group and register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetGroupStatusRaw (int32_t cardIndex, int32_t module, int32_t group, nai_dt_status_type_t type, uint32_t *outrawdata)
 Retrieves the raw status data value in the register associated to the group and status type specified. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_ClearGroupStatusRaw (int32_t cardIndex, int32_t module, int32_t group, nai_dt_status_type_t type, uint32_t rawdata)
 Clears the status data value in the register associated to the group and status type specified. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetGroupInterruptEnableRaw (int32_t cardIndex, int32_t module, int32_t group, nai_dt_status_type_t type, uint32_t rawdata)
 Sets the raw interrupt enable data value in the register associated to the group and status type specified. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetGroupInterruptEnableRaw (int32_t cardIndex, int32_t module, int32_t group, nai_dt_status_type_t type, uint32_t *outrawdata)
 Retrieves the raw interrupt enable data value in the register associated to the group and status type specified. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetBitStatusRaw (int32_t cardIndex, int32_t module, nai_dt_bit_status_type_t type, uint32_t *p_outstatus)
 Retrieves the BIT error trigger type for the specified channel and BIT status error trigger type, when BIT status has been set. A return of 1 indicates the BIT was a result of the queried trigger type (voltage measurement, or driver error).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetBankRaw (int32_t cardIndex, int32_t module, int32_t bank, nai_dt_raw_bank_t type, uint32_t rawdata)
 Sets the raw data value in the register associated to the bank and bank register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetBankRaw (int32_t cardIndex, int32_t module, int32_t bank, nai_dt_raw_bank_t type, uint32_t *outrawdata)
 Retrieves the raw data value in the register associated to the bank and bank register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_dt_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_DT_GetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_dt_raw_channel_t type, uint32_t *outrawdata)
 Retrieves the raw data value in the register associated to the channel and register type specified.
 

Detailed Description


Function Documentation

◆ naibrd_DT_ClearGroupStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_ClearGroupStatusRaw ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_dt_status_type_t type,
uint32_t rawdata )

Clears the status data value in the register associated to the group and status type specified. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.

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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Status Type: refer to nai_dt_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 status register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_GetBankRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetBankRaw ( int32_t cardIndex,
int32_t module,
int32_t bank,
nai_dt_raw_bank_t type,
uint32_t * outrawdata )

Retrieves the raw data value in the register associated to the bank and bank 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]).
bank: (Input) Channel Bank Number to access (1 - [max channel banks for module]).
type: (Input) Bank Register Type: refer to nai_dt_raw_bank_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 bank or bank type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_GetBitStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetBitStatusRaw ( int32_t cardIndex,
int32_t module,
nai_dt_bit_status_type_t type,
uint32_t * p_outstatus )

Retrieves the BIT error trigger type for the specified channel and BIT status error trigger type, when BIT status has been set. A return of 1 indicates the BIT was a result of the queried trigger type (voltage measurement, or driver error).

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 Query Type: refer to nai_dt_bit_status_type_t definition.
p_outstatus: uint with contents of bit error type 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_GetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dt_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 nai_dt_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 module 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 invalid channel or channel type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_GetGroupInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetGroupInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_dt_status_type_t type,
uint32_t * outrawdata )

Retrieves the raw interrupt enable data value in the register associated to the group and status type specified. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.

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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Status Type: refer to nai_dt_status_type_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 status register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_GetGroupRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetGroupRaw ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_dt_raw_group_t type,
uint32_t * outrawdata )

Retrieves the raw data value in the register associated to the group 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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Group Register Type: refer to nai_dt_raw_group_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 group register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_GetGroupStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetGroupStatusRaw ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_dt_status_type_t type,
uint32_t * outrawdata )

Retrieves the raw status data value in the register associated to the group and status type specified. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.

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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Status Type: refer to nai_dt_status_type_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 status register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_GetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetRaw ( int32_t cardIndex,
int32_t module,
nai_dt_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 nai_dt_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 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_DT_SetBankRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetBankRaw ( int32_t cardIndex,
int32_t module,
int32_t bank,
nai_dt_raw_bank_t type,
uint32_t rawdata )

Sets the raw data value in the register associated to the bank and bank 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]).
bank: (Input) Channel Bank Number to access (1 - [max channel banks for module]).
type: (Input) Bank Register Type: refer to nai_dt_raw_bank_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 bank or bank type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_SetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dt_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 nai_dt_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 module 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 invalid channel or channel type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_SetGroupInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetGroupInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_dt_status_type_t type,
uint32_t rawdata )

Sets the raw interrupt enable data value in the register associated to the group and status type specified. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.

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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Status Type: refer to nai_dt_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 status register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_SetGroupRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetGroupRaw ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_dt_raw_group_t type,
uint32_t rawdata )

Sets the raw data value in the register associated to the group 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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Group Register Type: refer to nai_dt_raw_group_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 group register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_SetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetRaw ( int32_t cardIndex,
int32_t module,
nai_dt_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 nai_dt_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 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.