Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Module Test Functions
DLV Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetTestEnable (int32_t cardIndex, int32_t module, nai_dl_test_type_t type, bool_t inTestEnable)
 Sets the test enable state for D0, on-line(D2), or off-line(D3) test for a DLV module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetTestEnable (int32_t cardIndex, int32_t module, nai_dl_test_type_t type, bool_t *outTestEnable)
 Gets the test enable state for D0, on-line(D2), or off-line(D3) test for a DLV module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetD2TestVerifyValue (int32_t cardIndex, int32_t module, uint32_t inValue)
 Sets the D2 Test Verify value. When the D2 test is enabled, the board will set the D2 Test Verify register to 0x55. An external application can write a value to the D2 Test Verify register and then read it after 30 seconds to verify that the background bit testing (D2 test) is activated.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetD2TestVerifyValue (int32_t cardIndex, int32_t module, uint32_t *outValue)
 Retrieves the D2 Test Verify value. When the D2 test is enabled, the board will set the D2 Test Verify register to 0x55. An external application can write a value to the D2 Test Verify register and then read it after 30 seconds to verify that the background bit testing (D2 test) is activated.
 

Detailed Description


Function Documentation

◆ naibrd_DL_GetD2TestVerifyValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetD2TestVerifyValue ( int32_t cardIndex,
int32_t module,
uint32_t * outValue )

Retrieves the D2 Test Verify value. When the D2 test is enabled, the board will set the D2 Test Verify register to 0x55. An external application can write a value to the D2 Test Verify register and then read it after 30 seconds to verify that the background bit testing (D2 test) is activated.

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]).
outValue: (Output) D2 Test Verify value (0x55 if D2 test is activated and running).
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_SUPPORTED when function is not supported.

◆ naibrd_DL_GetTestEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetTestEnable ( int32_t cardIndex,
int32_t module,
nai_dl_test_type_t type,
bool_t * outTestEnable )

Gets the test enable state for D0, on-line(D2), or off-line(D3) test for a DLV 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 (D0, D2, or D3) to get state of: refer to nai_dl_test_type_t definition.
outTestEnable: (Output) Enable or disable D0, D2, or D3 test for a DLV 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_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DL_SetD2TestVerifyValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetD2TestVerifyValue ( int32_t cardIndex,
int32_t module,
uint32_t inValue )

Sets the D2 Test Verify value. When the D2 test is enabled, the board will set the D2 Test Verify register to 0x55. An external application can write a value to the D2 Test Verify register and then read it after 30 seconds to verify that the background bit testing (D2 test) is activated.

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]).
inValue: (Input) Test Verify Value ( 0 - 65535 )
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_DL_SetTestEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetTestEnable ( int32_t cardIndex,
int32_t module,
nai_dl_test_type_t type,
bool_t inTestEnable )

Sets the test enable state for D0, on-line(D2), or off-line(D3) test for a DLV 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 (D0, D2, or D3) to enable or disable: refer to nai_dl_test_type_t definition.
inTestEnable: (Input) Enable or disable D0, D2, or D3 test for a DLV 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_INVALID_VALUE when invalid type parameter or invalid inTestEnable parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.