PBIST Low-Level API

Introduction

Data Structures
struct	SDL_PBIST_config
	This structure contains the different configuration used for PBIST. More...
struct	SDL_PBIST_configNeg
	This structure contains the different configuration used for PBIST for the failure insertion test to generate negative result. More...

Functions
int32_t	SDL_PBIST_softReset (SDL_pbistRegs *pPBISTRegs)
	PBIST Soft reset. More...
int32_t	SDL_PBIST_start (SDL_pbistRegs *pPBISTRegs, const SDL_PBIST_config *pConfig)
	PBIST Start. More...
int32_t	SDL_PBIST_startNeg (SDL_pbistRegs *pPBISTRegs, const SDL_PBIST_configNeg *pConfig)
	PBIST Failure Insertion Test Start. More...
int32_t	SDL_PBIST_checkResult (const SDL_pbistRegs *pPBISTRegs, bool *pResult)
	PBIST check result. More...
int32_t	SDL_PBIST_releaseTestMode (SDL_pbistRegs *pPBISTRegs)
	PBIST Release Test mode. More...
int32_t	SDL_PBIST_getPOSTStatus (SDL_PBIST_postResult *pResult)
	PBIST POST result status. More...

Function Documentation

SDL_PBIST_softReset()

int32_t SDL_PBIST_softReset

(

SDL_pbistRegs *

pPBISTRegs

)

PBIST Soft reset.

This function resets PBIST Module. In general called before running a new test.

Parameters

pPBISTRegs

[IN] Pointer to PBIST registers base

Returns

The SDL error code for the API. If pBISTRegs is NULL: SDL_EBADARGS Success: SDL_PASS

SDL_PBIST_start()

int32_t SDL_PBIST_start	(	SDL_pbistRegs *	pPBISTRegs,
		const SDL_PBIST_config *	pConfig
	)

PBIST Start.

This function configures the paramters for PBIST and starts execution.

Parameters

pPBISTRegs	[IN] Pointer to PBIST registers base
pConfig	[IN] Pointer to PBIST configuration

Returns

The SDL error code for the API. If pBISTRegs or pConfig is NULL : SDL_EBADARGS Success: SDL_PASS

SDL_PBIST_startNeg()

int32_t SDL_PBIST_startNeg	(	SDL_pbistRegs *	pPBISTRegs,
		const SDL_PBIST_configNeg *	pConfig
	)

PBIST Failure Insertion Test Start.

This function configures the parameters for PBIST Test for Diagnostics to insert a failure to generate the negative result and starts execution.

Parameters

pPBISTRegs	[IN] Pointer to PBIST registers base
pConfig	[IN] Pointer to PBIST configuration

Returns

The SDL error code for the API. If pBISTRegs or pConfig in NULL : SDL_EBADARGS Success: SDL_PASS

SDL_PBIST_checkResult()

int32_t SDL_PBIST_checkResult	(	const SDL_pbistRegs *	pPBISTRegs,
		bool *	pResult
	)

PBIST check result.

This function checks if PBIST test has passed.

Parameters

pPBISTRegs	[IN] Pointer to PBIST registers base
pResult	[OUT] Pointer to variable to indicate result

Returns

The SDL error code for the API. If pBISTRegs or pResult is NULL: SDL_EBADARGS Success: SDL_PASS

SDL_PBIST_releaseTestMode()

int32_t SDL_PBIST_releaseTestMode

(

SDL_pbistRegs *

pPBISTRegs

)

PBIST Release Test mode.

This function releases test mode. In general called after test is complete to switch back to normal operation.

Parameters

pPBISTRegs

[IN] Pointer to PBIST registers base

Returns

The SDL error code for the API. If pBISTRegs is NULL: SDL_EBADARGS 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