Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Pattern Generator Functions
Discrete Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_EnablePatternGen (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Starts or stops the RAM Pattern Generator.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetPatternGenPeriod (int32_t cardIndex, int32_t module, int32_t channel, float64_t period_mS)
 Sets the period for the Pattern Generator for the specified Discrete channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetPatternGenPeriod (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outperiod_mS)
 Retrieves the period for the Pattern Generator for the specified Discrete channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetPatternGen_BurstNum (int32_t cardIndex, int32_t module, uint32_t burstNum)
 Sets the number of cycles to output in the PatternGen burst mode for the specified Discrete module. The set value is applicable for enhanced IO PatternGen burst mode.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetPatternGen_BurstNum (int32_t cardIndex, int32_t module, uint32_t *p_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_DT_SetPatternGenBuf (int32_t cardIndex, int32_t module, int32_t dataPatternLen, uint32_t *dataPattern)
 Sets the pattern for RAM Pattern Generator.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetPatternGenBuf (int32_t cardIndex, int32_t module, int32_t dataPatternLen, uint32_t *dataPattern)
 Retrieves the pattern for RAM Pattern Generator.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetPatternGenStartAddr (int32_t cardIndex, int32_t module, uint32_t startAddr)
 Sets the starting address to look at for RAM Pattern Generator.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetPatternGenStartAddr (int32_t cardIndex, int32_t module, uint32_t *outstartAddr)
 Gets the starting address to look at for RAM Pattern Generator.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetPatternGenEndAddr (int32_t cardIndex, int32_t module, uint32_t EndAddr)
 Sets the Ending address to look at for RAM Pattern Generator.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetPatternGenEndAddr (int32_t cardIndex, int32_t module, uint32_t *p_outEndAddr)
 Gets the Ending address to look at for RAM Pattern Generator.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetPatternGenCtrl (int32_t cardIndex, int32_t module, nai_dt_pattern_ctrl_t controlBit, nai_dt_enable_t state)
 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_DT_GetPatternGenCtrl (int32_t cardIndex, int32_t module, nai_dt_pattern_ctrl_t controlBit, nai_dt_enable_t *p_outstate)
 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_DT_SetPatternGenCtrlRaw (int32_t cardIndex, int32_t module, uint32_t controlRaw)
 Sets the control bits for RAM Pattern Generator.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetPatternGenCtrlRaw (int32_t cardIndex, int32_t module, uint32_t *outcontrolRaw)
 Retrieves the control bits for RAM Pattern Generator.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetPatternGen_BurstNum (int32_t cardIndex, int32_t module, uint32_t burstNum)
 Sets the number of cycles to output in the PatternGen burst mode for the specified Discrete module. The set value is applicable for enhanced IO PatternGen burst mode.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetPatternGen_BurstNum (int32_t cardIndex, int32_t module, uint32_t *outburstNum)
 Retrieves the number of cycles set to output in the PatternGen burst mode for the specified Discrete module.
 

Detailed Description


Function Documentation

◆ naibrd_DT_EnablePatternGen()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_EnablePatternGen ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t enable )

Starts or stops the 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]).
enable: (Input) 0 to disable, 1 to enable RAM Pattern Generator.
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 format type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_GetPatternGen_BurstNum()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetPatternGen_BurstNum ( int32_t cardIndex,
int32_t module,
uint32_t * p_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]).
p_outburstNum: (Output)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_VALUE when invalid format type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_GetPatternGenBuf()

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

Retrieves the pattern 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]).
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 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 format type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_GetPatternGenCtrl()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetPatternGenCtrl ( int32_t cardIndex,
int32_t module,
nai_dt_pattern_ctrl_t controlBit,
nai_dt_enable_t * p_outstate )

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]).
controlBit: (Input) Bit Type: refer to nai_dt_pattern_ctrl_t definition.
p_outstate: (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 module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_GetPatternGenCtrlRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetPatternGenCtrlRaw ( int32_t cardIndex,
int32_t module,
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]).
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.
  • NAI_ERROR_INVALID_VALUE when invalid format type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_GetPatternGenEndAddr()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetPatternGenEndAddr ( int32_t cardIndex,
int32_t module,
uint32_t * p_outEndAddr )

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]).
p_outEndAddr: (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.
  • NAI_ERROR_INVALID_VALUE when invalid format type parameter is specified.
    • NAI_ERROR_INVALID_RANGE when invalid range address parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_GetPatternGenPeriod()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetPatternGenPeriod ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_outperiod_mS )

Retrieves the period for the Pattern Generator for the specified Discrete channel.

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) Reserved parameter, not currently used..
p_outperiod_mS: (Output) Period in milliseconds valid from .000008mS to 34360mS .
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 format type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_GetPatternGenStartAddr()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetPatternGenStartAddr ( int32_t cardIndex,
int32_t module,
uint32_t * outstartAddr )

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]).
outstartAddr: (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.
  • NAI_ERROR_INVALID_VALUE when invalid format type parameter is specified.
    • NAI_ERROR_INVALID_RANGE when invalid range address parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_SetPatternGen_BurstNum()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetPatternGen_BurstNum ( int32_t cardIndex,
int32_t module,
uint32_t burstNum )

Sets the number of cycles to output in the PatternGen burst mode for the specified Discrete 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]).
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_VALUE when invalid format type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_SetPatternGenBuf()

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

Sets the pattern 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]).
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 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 format type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_SetPatternGenCtrl()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetPatternGenCtrl ( int32_t cardIndex,
int32_t module,
nai_dt_pattern_ctrl_t controlBit,
nai_dt_enable_t state )

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]).
controlBit: (Input) Bit Type: refer to nai_dt_pattern_ctrl_t definition.
state: (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 module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_SetPatternGenCtrlRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetPatternGenCtrlRaw ( int32_t cardIndex,
int32_t module,
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]).
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.
  • NAI_ERROR_INVALID_VALUE when invalid format type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_SetPatternGenEndAddr()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetPatternGenEndAddr ( int32_t cardIndex,
int32_t module,
uint32_t EndAddr )

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]).
EndAddr: (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.
  • NAI_ERROR_INVALID_VALUE when invalid format type parameter is specified.
    • NAI_ERROR_INVALID_RANGE when invalid range address parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_SetPatternGenPeriod()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetPatternGenPeriod ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t period_mS )

Sets the period for the Pattern Generator for the specified Discrete channel.

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: Reserved parameter, not currently used.
period_mS: (Input) Period in milliseconds valid from .000008mS to 34360mS .
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 format type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_SetPatternGenStartAddr()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetPatternGenStartAddr ( int32_t cardIndex,
int32_t module,
uint32_t startAddr )

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]).
startAddr: (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.
  • NAI_ERROR_INVALID_VALUE when invalid format type parameter is specified.
    • NAI_ERROR_INVALID_RANGE when invalid range address parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_GetPatternGen_BurstNum()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetPatternGen_BurstNum ( int32_t cardIndex,
int32_t module,
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]).
outburstNum: (Output)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 card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid format type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_SetPatternGen_BurstNum()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetPatternGen_BurstNum ( int32_t cardIndex,
int32_t module,
uint32_t burstNum )

Sets the number of cycles to output in the PatternGen burst mode for the specified Discrete 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]).
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 card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid format type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.