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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_SetModuleBITEnable (int32_t cardIndex, int32_t module, naibrd_cd_test_type_t type, bool_t bitEnable)
 Enables/Disables the BIT test specified by the type parameter.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_CheckPowerOnBITComplete (int32_t cardIndex, int32_t module, bool_t *p_outpbitComplete)
 Retrieves the Power-On BIT (PBIT) status (complete or incomplete) for the specified module. The PBIT result will be in the BIT status register.
 

Detailed Description

Function Documentation

◆ naibrd_CD_CheckPowerOnBITComplete()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_CheckPowerOnBITComplete ( int32_t cardIndex,
int32_t module,
bool_t * p_outpbitComplete )

Retrieves the Power-On BIT (PBIT) status (complete or incomplete) for the specified module. The PBIT result will be in the BIT status register.

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_outpbitComplete: (Output) NAI_TRUE = PBIT complete, NAI_FALSE = PBIT not complete.
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 the module does not support Power-On BIT.

◆ naibrd_CD_SetModuleBITEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_SetModuleBITEnable ( int32_t cardIndex,
int32_t module,
naibrd_cd_test_type_t type,
bool_t bitEnable )

Enables/Disables the BIT test specified by the type parameter.

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]).
type: (Input) The BIT type to enable/disable.
bitEnable: (Input) BIT Enable (0 = disable, 1 = enable).
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 the function is not supported.