Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Built-in Test Functions
NAI Board Library - Module Functions » SD Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetModuleBITEnable (int32_t cardIndex, int32_t module, naibrd_sd_test_enable_t type, bool_t bitEnable)
 Enables/Disables the BIT test specified by the type parameter. BITs are described as follows:
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetModuleBITEnable (int32_t cardIndex, int32_t module, naibrd_sd_test_enable_t type, bool_t *p_outBitEnable)
 Retrieves the state (Enabled or disabled) of the BIT test specified by the type parameter. BITs are described as follows:
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_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. Feature supported in FPGA Version >= 9.28.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetTestAngle (int32_t cardIndex, int32_t module, float64_t testAngle)
 Sets the Test Angle used for the D0 Test.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetTestAngle (int32_t cardIndex, int32_t module, float64_t *p_outTestAngle)
 Retrieves the Test Angle used for the D0 Test.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetD2TestVerifyValue (int32_t cardIndex, int32_t module, uint32_t value)
 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_SD_GetD2TestVerifyValue (int32_t cardIndex, int32_t module, uint32_t *p_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.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetBITErrorLimit (int32_t cardIndex, int32_t module, int32_t channel, float64_t bitErrorLimit)
 Sets the BIT Test Error Limit for the specified SD channel. Feature supported in FPGA Version >= 9.28.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetBITErrorLimit (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outBitErrorLimit)
 Retrieves the BIT Test Error Limit for the specified SD channel. Feature supported in FPGA Version >= 9.28.
 

Detailed Description

Function Documentation

◆ naibrd_SD_CheckPowerOnBITComplete()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_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. Feature supported in FPGA Version >= 9.28.

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_SD_GetBITErrorLimit()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetBITErrorLimit ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_outBitErrorLimit )

Retrieves the BIT Test Error Limit for the specified SD channel. Feature supported in FPGA Version >= 9.28.

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]).
p_outBitErrorLimit: (Output) Floating-Point BIT Test Error Limit read from 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_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetD2TestVerifyValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetD2TestVerifyValue ( int32_t cardIndex,
int32_t module,
uint32_t * p_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]).
p_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_SD_GetModuleBITEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetModuleBITEnable ( int32_t cardIndex,
int32_t module,
naibrd_sd_test_enable_t type,
bool_t * p_outBitEnable )

Retrieves the state (Enabled or disabled) of the BIT test specified by the type parameter. BITs are described as follows:

UBIT (D0) - An off-line test that is used to check the card and interface. This will disconnect all channels from the I/O and connect them across an internal stimulus. Test parameters are controlled by the user and are entered in the D0 Test Level and D0 Test Polarity registers. The outputs from the channels are monitored internally for proper conversion. External stimulus is not required.

IBIT (D3) - An off-line test that starts an initiated BIT test that disconnects all channels from the I/O and then connects them across an internal stimulus. Each channel will be checked to a pre-determined test accuracy. Test cycle is completed when D3 changes from 1 to 0. Results can be read from the Status registers. The test can be enabled or disabled at any time.

Function NAIBRD_SD_TEST_ENABLE_D2 not supported Bare Metal revision >= 9.25

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 check. Refer to naibrd_sd_test_enable_t definition.
p_outBitEnable: (Output) BIT Enabled (0 = disabled, 1 = enabled).
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_SD_GetTestAngle()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetTestAngle ( int32_t cardIndex,
int32_t module,
float64_t * p_outTestAngle )

Retrieves the Test Angle used for the D0 Test.

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_outTestAngle: (Output) 0.0 <= TestAngle <= 360.000 Deg.
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_SD_SetBITErrorLimit()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetBITErrorLimit ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t bitErrorLimit )

Sets the BIT Test Error Limit for the specified SD channel. Feature supported in FPGA Version >= 9.28.

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]).
bitErrorLimit: (Input) Floating-Point BIT Test Error Limit to set.
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_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetD2TestVerifyValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetD2TestVerifyValue ( int32_t cardIndex,
int32_t module,
uint32_t value )

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]).
value: (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 module parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetModuleBITEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetModuleBITEnable ( int32_t cardIndex,
int32_t module,
naibrd_sd_test_enable_t type,
bool_t bitEnable )

Enables/Disables the BIT test specified by the type parameter. BITs are described as follows:

UBIT (D0) - An off-line test that is used to check the card and interface. This will disconnect all channels from the I/O and connect them across an internal stimulus. Test parameters are controlled by the user and are entered in the D0 Test Level and D0 Test Polarity registers. The outputs from the channels are monitored internally for proper conversion. External stimulus is not required.

IBIT (D3) - An off-line test that starts an initiated BIT test that disconnects all channels from the I/O and then connects them across an internal stimulus. Each channel will be checked to a pre-determined test accuracy. Test cycle is completed when D3 changes from 1 to 0. Results can be read from the Status registers. The test can be enabled or disabled at any time.

Function NAIBRD_SD_TEST_ENABLE_D2 not supported Bare Metal revision >= 9.25

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. Refer to naibrd_sd_test_enable_t definition.
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_VALUE when invalid type parameter or invalid bitEnable parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when the function is not supported.

◆ naibrd_SD_SetTestAngle()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetTestAngle ( int32_t cardIndex,
int32_t module,
float64_t testAngle )

Sets the Test Angle used for the D0 Test.

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]).
testAngle: (Input) 0.0 <= TestAngle <= 360.000 Deg.
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 testAngle parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.