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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetTestModeEnable (int32_t cardIndex, int32_t module, nai_ds_test_mode_type_t type, bool_t inEnable)
 Sets the test enable state for on-line(D2), and off-line(D3) test for a D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetTestModeEnable (int32_t cardIndex, int32_t module, nai_ds_test_mode_type_t type, bool_t *outEnable)
 Gets the test enable state for on-line(D2), and off-line(D3) test for a D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetTestVerify (int32_t cardIndex, int32_t module, uint32_t inTestVerify)
 Sets the test verify value for for on-line(D2) test for a D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetTestVerify (int32_t cardIndex, int32_t module, uint32_t *outTestVerify)
 Gets the test verify value for for on-line(D2) test for a D/S module.
 

Detailed Description


Function Documentation

◆ naibrd_DS_GetTestModeEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetTestModeEnable ( int32_t cardIndex,
int32_t module,
nai_ds_test_mode_type_t type,
bool_t * outEnable )

Gets the test enable state for on-line(D2), and off-line(D3) test for a D/S module.

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) Test Type: Refer to nai_ds_test_mode_type_t definitions.
outEnable: (Output) Returns the enable or disable state for on-line, off-line test for a D/S module.
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_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_GetTestVerify()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetTestVerify ( int32_t cardIndex,
int32_t module,
uint32_t * outTestVerify )

Gets the test verify value for for on-line(D2) test for a D/S module.

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]).
outTestVerify: (Output) Returns the on-line test verify value from a D/S module.
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.

◆ naibrd_DS_SetTestModeEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetTestModeEnable ( int32_t cardIndex,
int32_t module,
nai_ds_test_mode_type_t type,
bool_t inEnable )

Sets the test enable state for on-line(D2), and off-line(D3) test for a D/S module.

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) Test Type: Refer to nai_ds_test_mode_type_t definitions.
inEnable: (Input) Enable or disable on/off line test for a D/S module.
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_VALUE when invalid type or invalid value.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_SetTestVerify()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetTestVerify ( int32_t cardIndex,
int32_t module,
uint32_t inTestVerify )

Sets the test verify value for for on-line(D2) test for a D/S module.

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]).
inTestVerify: (Input) Writes a test value to the on-line test verify register for a D/S module.
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.