Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Ram Control Functions
D/A Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetPatternGen_BurstNum (int32_t cardIndex, int32_t module, int32_t channel, uint32_t burstNum)
 Sets the number of cycles to output in the PatternGen burst mode for the specified D/A module. The set value is applicable for enhanced IO PatternGen burst mode.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetPatternGen_BurstNum (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outburstNum)
 Retrieves the number of cycles set to output in the PatternGen burst mode for the specified Discrete module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetPatternGenData (int32_t cardIndex, int32_t module, int32_t channel, uint32_t dataPatternLen, float64_t *dataPattern)
 Sets the pattern for RAM Pattern Generator using floating point data.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetPatternGenDataRaw (int32_t cardIndex, int32_t module, int32_t channel, uint32_t dataPatternLen, uint32_t *dataPattern)
 Sets the pattern for RAM Pattern Generator using raw data.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetPatternGenStartAddr (int32_t cardIndex, int32_t module, int32_t channel, uint32_t startaddress)
 Sets the starting address to look at for RAM Pattern Generator.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetPatternGenStartAddr (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outstartAddress)
 Gets the starting address to look at for RAM Pattern Generator.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetPatternGenEndAddr (int32_t cardIndex, int32_t module, int32_t channel, uint32_t endAddress)
 Sets the Ending address to look at for RAM Pattern Generator.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetPatternGenEndAddr (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outendAddress)
 Gets the Ending address to look at for RAM Pattern Generator.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetPatternGenCtrl (int32_t cardIndex, int32_t module, int32_t channel, nai_da_pattern_ctrl_t patternControl, nai_da_enable_t controlState)
 Sets the state for the RAM Pattern Generator for the selected control bit on the module. Options are enable and disable.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetPatternGenCtrl (int32_t cardIndex, int32_t module, int32_t channel, nai_da_pattern_ctrl_t patternControl, nai_da_enable_t *outcontrolState)
 Gets the state for the RAM Pattern Generator for the selected control bit on the module. Options are enable and disable.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetPatternGenCtrlRaw (int32_t cardIndex, int32_t module, int32_t channel, uint32_t controlRaw)
 Sets the control bits for RAM Pattern Generator.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetPatternGenCtrlRaw (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outcontrolRaw)
 Retrieves the control bits for RAM Pattern Generator.
 

Detailed Description


Function Documentation

◆ naibrd_DA_GetPatternGen_BurstNum()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetPatternGen_BurstNum ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * outburstNum )

Retrieves the number of cycles set to output in the PatternGen burst mode for the specified Discrete 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]).
outburstNum: (Output)Number of cycles to output upon trigger, in PatternGen burst mode.
Returns
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_GetPatternGenCtrl()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetPatternGenCtrl ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_da_pattern_ctrl_t patternControl,
nai_da_enable_t * outcontrolState )

Gets the state for the RAM Pattern Generator for the selected control bit on the module. Options are enable and disable.

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]).
patternControl: (Input) Bit Type: refer to nai_dt_pattern_ctrl_t definition.
outcontrolState: (Input) Enable/Disable: refer to nai_dt_enable_t.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_GetPatternGenCtrlRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetPatternGenCtrlRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * outcontrolRaw )

Retrieves the control bits for RAM Pattern Generator.

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]).
outcontrolRaw: (Output) RAM Pattern control bits .
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_GetPatternGenEndAddr()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetPatternGenEndAddr ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * outendAddress )

Gets the Ending address to look at for RAM Pattern Generator.

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]).
outendAddress: (Output) Ending Address to output RAM pattern generator data from.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_GetPatternGenStartAddr()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetPatternGenStartAddr ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * outstartAddress )

Gets the starting address to look at for RAM Pattern Generator.

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]).
outstartAddress: (Output) Starting Address to output RAM pattern generator data from.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_SetPatternGen_BurstNum()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetPatternGen_BurstNum ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t burstNum )

Sets the number of cycles to output in the PatternGen burst mode for the specified D/A module. The set value is applicable for enhanced IO PatternGen burst mode.

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]).
burstNum: (Input)Number of cycles to output upon trigger, in PatternGen burst mode.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_SetPatternGenCtrl()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetPatternGenCtrl ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_da_pattern_ctrl_t patternControl,
nai_da_enable_t controlState )

Sets the state for the RAM Pattern Generator for the selected control bit on the module. Options are enable and disable.

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]).
patternControl: (Input) Bit Type: refer to nai_dt_pattern_ctrl_t definition.
controlState: (Input) Enable/Disable: refer to nai_dt_enable_t.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_SetPatternGenCtrlRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetPatternGenCtrlRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t controlRaw )

Sets the control bits for RAM Pattern Generator.

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]).
controlRaw: (Input) RAM Pattern Control bits.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_SetPatternGenData()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetPatternGenData ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t dataPatternLen,
float64_t * dataPattern )

Sets the pattern for RAM Pattern Generator using floating point data.

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]).
dataPatternLen: (Input) Length of buffer holding RAM Pattern .
dataPattern: (Input) Buffer holding RAM Pattern .
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 invalid format type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_SetPatternGenDataRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetPatternGenDataRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t dataPatternLen,
uint32_t * dataPattern )

Sets the pattern for RAM Pattern Generator using raw data.

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]).
dataPatternLen: (Input) Length of buffer holding RAM Pattern .
dataPattern: (Input) Buffer holding RAM Pattern .
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 invalid format type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_SetPatternGenEndAddr()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetPatternGenEndAddr ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t endAddress )

Sets the Ending address to look at for RAM Pattern Generator.

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]).
endAddress: (Input) Ending Address to output RAM pattern generator data from.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_SetPatternGenStartAddr()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetPatternGenStartAddr ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t startaddress )

Sets the starting address to look at for RAM Pattern Generator.

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]).
startaddress: (Input) Starting Address to output RAM pattern generator data from.
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_NOT_SUPPORTED when function is not supported.