SDL API Guide for J721E
PBIST Functions

Introduction

Functions

int32_t SDL_PBIST_selfTest (SDL_PBIST_inst instance, SDL_PBIST_testType testType, const SDL_PBIST_config *pConfig, bool *pResult)
 PBIST self test. More...
 
int32_t SDL_PBIST_getPOSTStatus (SDL_PBIST_postResult *pResult)
 PBIST POST result status. More...
 
int32_t SDL_OSAL_getClecOutputEvent (uint32_t *clecOutputEvt)
 Application-provided API to give the PBIST module a clec output event to use upon request for a PBIST test. More...
 
int32_t SDL_OSAL_releaseClecOutputEvent (uint32_t clecOutputEvt)
 Application-provided API to allow PBIST module to release a clec event. More...
 

Function Documentation

◆ SDL_PBIST_selfTest()

int32_t SDL_PBIST_selfTest ( SDL_PBIST_inst  instance,
SDL_PBIST_testType  testType,
const SDL_PBIST_config pConfig,
bool *  pResult 
)

PBIST self test.

This function executes a PBIST self test of the specified type for a specific PBIST instance. The test types supported are defined in SDL_PBIST_testType. PBIST is a feature that is used for self test of the memory regions in the SoC. Multiple instances may be supported. Note: The PBIST test is destructive to the cores/IP which are being tested. Therefore it should be executed from a different core than the one under test. It is important to note that execution of PBIST self-tests require preparation of the IPS under test by bringing them to a certain power and reset state before executing the test. The application must take care of this sequence before executing the self-test. The SDL examples give a reference for the necessary sequences. The PBIST instances supported are specific to the SoC, and are defined in the soc-specific header file.

Parameters
instance[IN] PBIST instance
testType[IN] PBIST test type to run.
pConfig[IN] Pointer to PBIST test configuration (optional)
pResult[OUT] Pointer to variable to indicate result
Returns
The SDL error code for the API. If pResult is NULL: SDL_EBADARGS If testType is invalid: SDL_EBADARGS If other error happened: SDL_EFAIL Success: SDL_PASS

◆ SDL_PBIST_getPOSTStatus()

int32_t SDL_PBIST_getPOSTStatus ( SDL_PBIST_postResult pResult)

PBIST POST result status.

This function retrieves the status of the PBIST POST test(s) for all the supported PBIST instances which have POST support on the device. PBIST is a feature that is used for self test of the memory regions in the SoC. Multiple instances may be supported.

If supported, HW POST may execute for one or more instances. This function will check if the test was executed, and if it was executed, what was the result of the test.

See the definition of SDL_PBIST_postResult for more information.

Parameters
pResult[OUT] Pointer to variable to indicate the result

◆ SDL_OSAL_getClecOutputEvent()

int32_t SDL_OSAL_getClecOutputEvent ( uint32_t *  clecOutputEvt)

Application-provided API to give the PBIST module a clec output event to use upon request for a PBIST test.

Parameters
clecOutputEvt[OUT] Pointer to clecOuput event
Returns
The SDL error code for the API. If failed to give a CLEC output event: SDL_EFAIL Success: SDL_PASS

◆ SDL_OSAL_releaseClecOutputEvent()

int32_t SDL_OSAL_releaseClecOutputEvent ( uint32_t  clecOutputEvt)

Application-provided API to allow PBIST module to release a clec event.

Parameters
clecOutputEvt[IN] CLEC event to release
Returns
The SDL error code for the API. If failed to release: SDL_EFAIL Success: SDL_PASS