APIs for DDR

Introduction

This module contains APIs to program and use the DDR module. See DDR for more details.

Files
file	ddr/v0/ddr.h
	This file contains DDR APIs.

Data Structures
struct	DDR_EccRegion
	DDR Inline ECC region The structure specifies the DDR inline ECC region start and End address. More...
struct	DDR_Params
	DDR config structure. More...
struct	DDR_ECCErrorInfo
	Emif ECC Error Information structure. More...

Functions
void	DDR_Params_init (DDR_Params *prms)
	Set default values to DDR_Params. More...
int32_t	DDR_init (DDR_Params *prms)
	DDR4 Initialization function. More...
void	DDR_enableInlineECC (uint8_t enableFlag)
	Enable/Disable DDR inline ECC. More...
int32_t	DDR_clearECCError (uint8_t errorType)
	Clear ECC errors for DDR. More...
int32_t	DDR_getECCErrorInfo (DDR_ECCErrorInfo *ECCErrorInfo)
	Get ECC error status. More...
uint8_t	DDR_isInitDone (void)
	Check if DDR init is done. More...

DDR ECC error type
#define	DDR_ECC_1B_ERROR   (0U)
#define	DDR_ECC_2B_ERROR   (1U)
#define	DDR_ECC_ERR_ALL   (2U)

Macro Definition Documentation

DDR_ECC_1B_ERROR

#define DDR_ECC_1B_ERROR   (0U)

DDR_ECC_2B_ERROR

#define DDR_ECC_2B_ERROR   (1U)

DDR_ECC_ERR_ALL

#define DDR_ECC_ERR_ALL   (2U)

Function Documentation

DDR_Params_init()

void DDR_Params_init

(

DDR_Params *

prms

)

Set default values to DDR_Params.

Parameters

prms	[out] Pointer to DDR configuration.

DDR_init()

int32_t DDR_init

(

DDR_Params *

prms

)

DDR4 Initialization function.

       Initializes the DDR timing parameters. Sets the DDR timing parameters
       based in the DDR PLL controller configuration.
       Any changes to DDR PLL requires change to DDR timing.

Parameters

prms	[in] Pointer to DDR configuration.

Returns

status SystemP_SUCCESS in case of success or appropriate error code

DDR_enableInlineECC()

void DDR_enableInlineECC

(

uint8_t

enableFlag

)

Enable/Disable DDR inline ECC.

Parameters

enableFlag

[in] Flag to enable or disable DDR Inline ECC

DDR_clearECCError()

int32_t DDR_clearECCError

(

uint8_t

errorType

)

Clear ECC errors for DDR.

Parameters

errorType

[in] DDR ECC error type (single bit/two bit ECC)

Returns

status SystemP_SUCCESS in case of success or appropriate error code

DDR_getECCErrorInfo()

int32_t DDR_getECCErrorInfo

(

DDR_ECCErrorInfo *

ECCErrorInfo

)

Get ECC error status.

Parameters

ECCErrorInfo

[out] Get DDR ECC error bit status

Returns

status SystemP_SUCCESS in case of success or appropriate error code

DDR_isInitDone()

uint8_t DDR_isInitDone

(

void

)

Check if DDR init is done.

Returns

0 if DDR init is not completed else 1