Software Library API naibrd 2.24.0
See all documentation at naii.docs.com

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_Reset (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ttl_reset_type_t resetType)
 Resets the TTL channel as specified by the reset type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_ResetAll (int32_t cardIndex, int32_t module, naibrd_ttl_reset_type_t resetType)
 Resets all channels on the module as specified by the reset type.
 

Detailed Description

Function Documentation

◆ naibrd_TTL_Reset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_Reset ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ttl_reset_type_t resetType )

Resets the TTL channel as specified by the reset type.

Note
: Currently there is a known issue with resetting the TTL channels when the Overcurrent condition is detected on multiple channels. To address this issue, when the resetType of NAIBRD_TTL_RESET_OVERCURRENT is passed in, this routine will reset all channel rather than only the specified 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]).
resetType: (Input) TTL Reset Type: refer to nai_ttl_reset_type_t definitions.
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_ResetAll()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_ResetAll ( int32_t cardIndex,
int32_t module,
naibrd_ttl_reset_type_t resetType )

Resets all channels on the module as specified by the reset 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]).
resetType: (Input) TTL Reset Type: refer to nai_ttl_reset_type_t definitions.
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.