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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetOutputState (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dif_state_t state)
 Sets the Output State for the specified DIF channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetOutputState (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dif_state_t *outstate)
 Retrieves the Output State for the specified DIF channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetInputState (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dif_state_t *outstate)
 Retrieves the Input State for the specified DIF channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dif_chan_mapped_status_type_t type, nai_status_bit_t *outstatusVal)
 Retrieves the status for the specified DF1 channel and status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_ClearChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dif_chan_mapped_status_type_t type)
 Clears the latched status for the specified DIF channel and status type.
 

Detailed Description

Function Documentation

◆ naibrd_DIF_ClearChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_ClearChanMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dif_chan_mapped_status_type_t type )

Clears the latched status for the specified DIF channel and status type.

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) Status Type: refer to naibrd_dif_chan_mapped_status_type_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_INVALID_VALUE when an invalid naibrd_dif_chan_mapped_status_type_t type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_GetChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetChanMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dif_chan_mapped_status_type_t type,
nai_status_bit_t * outstatusVal )

Retrieves the status for the specified DF1 channel and status type.

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) Status Type: refer to naibrd_dif_chan_mapped_status_type_t definition.
outstatusVal: (Output) 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 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_INVALID_VALUE when an invalid naibrd_dif_chan_mapped_status_type_t type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_GetInputState()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetInputState ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dif_state_t * outstate )

Retrieves the Input State 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]).
outstate: (Output) NAI_DIF_STATE_LO or NAI_DIF_STATE_HI.
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_GetOutputState()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_GetOutputState ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dif_state_t * outstate )

Retrieves the Output State 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]).
outstate: (Output) NAI_DIF_STATE_LO or NAI_DIF_STATE_HI.
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_SetOutputState()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_SetOutputState ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dif_state_t state )

Sets the Output State 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]).
state: (Input) NAI_DIF_STATE_LO or NAI_DIF_STATE_HI.
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.