Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Channel Configuration Functions
NAI Board Library - Module Functions » DIF Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetIOFormat (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dif_ioformat_t format)
 Sets the Input/Output configuration for the specified DIF channel. Default configuration for the channels is input.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetIOFormat (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dif_ioformat_t *outformat)
 Retrieves the Input/Output configuration for the specified DIF channel. Default configuration for the channels is input.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetOpMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dif_enhanced_mode_t mode)
 Sets the Operation mode for the specified DIF channel. Default power on configuration for the channels is Enhanced Input. Selection of one of the basic modes will switch to transceiver (basic) mode operation with no signal processing.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetOpMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dif_enhanced_mode_t *outmode)
 Retrieves the Operation mode for the specified DIF channel. Retrieves either Basic/Transceiver modes or Enhanced modes, depending whether the Basic Transceiver mode is enabled.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetSlewRate (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dif_slewRate_t rate)
 Sets the slew rate for the specified DIF channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetSlewRate (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dif_slewRate_t *outrate)
 Retrieves the Output slewrate for the specified DIF channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetInputTermination (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dif_input_term_t InputTermination)
 Sets input termination of 120 ohms or >12k ohms (unterminated) for specified DIF channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetInputTermination (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dif_input_term_t *InputTermination)
 Retrieves the input termination configuration for specified DIF channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetEnhanceTriggerEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dif_enable_t enable)
 Sets enhanced operation to disabled or enabled for specified Discrete channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetEnhanceTriggerEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dif_enable_t *outenable)
 Retrieves the present enhance operation enable state for the specified Discrete channel. Power on default configuration for the channels is Enhanced Input.
 

Detailed Description

Function Documentation

◆ naibrd_DIF_GetEnhanceTriggerEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetEnhanceTriggerEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dif_enable_t * outenable )

Retrieves the present enhance operation enable state for the specified Discrete channel. Power on default configuration for the channels is Enhanced Input.

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]).
outenable: (Output) Refer to nai_DIF_enable_t definitions.
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 is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_GetInputTermination()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetInputTermination ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dif_input_term_t * InputTermination )

Retrieves the input termination configuration for specified DIF 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) Channel Number of the channel to access (1 - [max channels for module]).
InputTermination: (Output) NAI_DIF_INPUT_NOT_TERMINATED or NAI_DIF_INPUT_TERMINATED.
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 is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_GetIOFormat()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetIOFormat ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dif_ioformat_t * outformat )

Retrieves the Input/Output configuration for the specified DIF channel. Default configuration for the channels is input.

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]).
outformat: (Output) NAI_DIF_GEN3_IOFORMAT_OUTPUT or NAI_DIF_GEN5_IOFORMAT_OUTPUT.
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 is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_GetOpMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetOpMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dif_enhanced_mode_t * outmode )

Retrieves the Operation mode for the specified DIF channel. Retrieves either Basic/Transceiver modes or Enhanced modes, depending whether the Basic Transceiver mode is enabled.

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]).
outmode: (Input) Available operation modes: Refer to naibrd_dif_enhanced_mode_t mode selections.
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 is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_GetSlewRate()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetSlewRate ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dif_slewRate_t * outrate )

Retrieves the Output slewrate for the specified DIF 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) Channel Number of the channel to access (1 - [max channels for module]).
outrate: (Output)Slew Rate: refer to naibrd_dif_slewRate_t definition.
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 is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_SetEnhanceTriggerEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetEnhanceTriggerEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dif_enable_t enable )

Sets enhanced operation to disabled or enabled for 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) Channel Number of the channel to access (1 - [max channels for module]).
enable: (Input) Refer to nai_DIF_enable_t definitions.
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 is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_SetInputTermination()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetInputTermination ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dif_input_term_t InputTermination )

Sets input termination of 120 ohms or >12k ohms (unterminated) for specified DIF 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) Channel Number of the channel to access (1 - [max channels for module]).
InputTermination: (Input) NAI_DIF_INPUT_NOT_TERMINATED or NAI_DIF_INPUT_TERMINATED.
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 is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.
  • NAI_ERROR_INVALID_RANGE when invalid InputTermination is specified.

◆ naibrd_DIF_SetIOFormat()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetIOFormat ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dif_ioformat_t format )

Sets the Input/Output configuration for the specified DIF channel. Default configuration for the channels is input.

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]).
format: (Input) NAI_DIF_IOFORMAT_INPUT or NAI_DIF_IOFORMAT_OUTPUT.
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 is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_SetOpMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetOpMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dif_enhanced_mode_t mode )

Sets the Operation mode for the specified DIF channel. Default power on configuration for the channels is Enhanced Input. Selection of one of the basic modes will switch to transceiver (basic) mode operation with no signal processing.

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]).
mode: (Input) Available operation modes: Refer to naibrd_dif_enhanced_mode_t mode selections.
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 is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_SetSlewRate()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetSlewRate ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dif_slewRate_t rate )

Sets the slew rate for the specified DIF 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) Channel Number of the channel to access (1 - [max channels for module]).
rate: (Input)Slew Rate: refer to naibrd_dif_slewRate_t definition.
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 is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.
  • NAI_ERROR_INVALID_RANGE when invalid slewrate is specified.