ddr/v0/ddr.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright (c) 2021-2022 Texas Instruments Incorporated - https://www.ti.com
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *****************************************************************************/
 
#ifndef DDR_DRIVER_H_
#define DDR_DRIVER_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                             Macros & Typedefs                              */
/* ========================================================================== */
 
#define DDR_ECC_1B_ERROR        (0U)
#define DDR_ECC_2B_ERROR        (1U)
#define DDR_ECC_ERR_ALL         (2U)
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
typedef struct
{
    uint32_t ddrEccStart0;      
    uint32_t ddrEccEnd0;        
    uint32_t ddrEccStart1;      
    uint32_t ddrEccEnd1;        
    uint32_t ddrEccStart2;      
    uint32_t ddrEccEnd2;        
} DDR_EccRegion;
 
typedef struct
{
    uint64_t clk1Freq;             
    uint64_t clk2Freq;             
    uint32_t *ddrssCtlReg;         
    uint32_t *ddrssPhyIndepReg;    
    uint32_t *ddrssPhyReg;         
    uint16_t *ddrssCtlRegNum;      
    uint16_t *ddrssPhyIndepRegNum; 
    uint16_t *ddrssPhyRegNum;      
    uint16_t ddrssCtlRegCount;         
    uint16_t ddrssPhyIndepRegCount;    
    uint16_t ddrssPhyRegCount;         
    uint8_t fshcount;              
    uint8_t enableEccFlag;         
    DDR_EccRegion *eccRegion;      
} DDR_Params;
 
typedef struct
{
    uintptr_t   singlebitErrorAddress;   
    uintptr_t   doublebitErrorAddress;   
    uint32_t    singlebitErrorCount;     
} DDR_ECCErrorInfo;
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void DDR_Params_init(DDR_Params *prms);
 
int32_t DDR_init(DDR_Params *prms);
 
void DDR_enableInlineECC (uint8_t enableFlag);
 
int32_t DDR_clearECCError (uint8_t errorType);
 
int32_t DDR_getECCErrorInfo (DDR_ECCErrorInfo *ECCErrorInfo);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* DDR_DRIVER_H_ */