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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetInputState (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ttl_state_t *p_inputstate)
 Retrieves the Input State for the specified TTL channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetBankVCCReading (int32_t cardIndex, int32_t module, int32_t bank, float64_t *p_outvoltage)
 Retrieves the Vcc voltage reading for the specified TTL bank, reading is returned in volts. This feature is only supported on X2 TTL modules and up.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ttl_status_type_t type, nai_status_bit_t *p_outstatusbit)
 Retrieves the realtime or continuous status for the specified TTL channel and status type. Realtime status always represents the present status at the time of the read, as opposed to the latched status, which retains transient indications until cleared.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_ClearChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ttl_status_type_t type)
 Clears the latched status for the specified TTL channel and status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ttl_status_type_t type, nai_status_bit_t *outstatusBit)
 Retrieves the status for the specified channel and status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_ClearStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ttl_status_type_t type)
 Clears the latched status for the specified channel and status type.
 

Detailed Description

Function Documentation

◆ naibrd_TTL_ClearChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_ClearChanMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ttl_status_type_t type )

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

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAIBRD_BOARD (0 - NAIBRD_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 nai_ttl_status_type_t definition.
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_TTL_ClearStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_ClearStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ttl_status_type_t type )

Clears the latched status for the specified 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 nai_ttl_status_type_t definition.
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_TTL_GetBankVCCReading()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetBankVCCReading ( int32_t cardIndex,
int32_t module,
int32_t bank,
float64_t * p_outvoltage )

Retrieves the Vcc voltage reading for the specified TTL bank, reading is returned in volts. This feature is only supported on X2 TTL modules and up.

Note
TTL does not yet support Floating point mode.
Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAIBRD_BOARD (0 - NAIBRD_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
bank: (Input) Number of the bank set(1 - [max banks for module]).
p_outvoltage: (Output) Available operation modes: NAIBRD_TTL_VCC_EXTERNAL NAIBRD_TTL_VCC_INTERNAL
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_TTL_GetChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetChanMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ttl_status_type_t type,
nai_status_bit_t * p_outstatusbit )

Retrieves the realtime or continuous status for the specified TTL channel and status type. Realtime status always represents the present status at the time of the read, as opposed to the latched status, which retains transient indications until cleared.

Note
Summary, watchdog and inter FPGA status's are not implemented for TTL modules yet, but will be in the future.
Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAIBRD_BOARD (0 - NAIBRD_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 nai_ttl_status_type_t definitions.
p_outstatusbit: (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 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_TTL_GetInputState()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetInputState ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ttl_state_t * p_inputstate )

Retrieves the Input State for the specified TTL channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAIBRD_BOARD (0 - NAIBRD_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]).
p_inputstate: (Output) NAIBRD_TTL_STATE_LO or NAIBRD_TTL_STATE_HI.
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_TTL_GetStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ttl_status_type_t type,
nai_status_bit_t * outstatusBit )

Retrieves the status for the specified 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 nai_ttl_status_type_t definition.
outstatusBit: (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 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.