fsl_xecc.h

/*
 * Copyright 2019-2020 NXP
 * All rights reserved.
 *
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef _FSL_XECC_H_
#define _FSL_XECC_H_
 
#include "fsl_common.h"
 
/******************************************************************************
 * Definitions.
 *****************************************************************************/
 
#define FSL_XECC_DRIVER_VERSION (MAKE_VERSION(2U, 0U, 0U))
enum
{
    kXECC_SingleErrorInterruptEnable = XECC_ERR_SIG_EN_SINGLE_ERR_SIG_EN_MASK, 
    kXECC_MultiErrorInterruptEnable  = XECC_ERR_SIG_EN_MULTI_ERR_SIG_EN_MASK, 
    kXECC_AllInterruptsEnable =
        XECC_ERR_SIG_EN_SINGLE_ERR_SIG_EN_MASK | XECC_ERR_SIG_EN_MULTI_ERR_SIG_EN_MASK, 
};
 
enum
{
    kXECC_SingleErrorInterruptStatusEnable =
        XECC_ERR_STAT_EN_SINGLE_ERR_STAT_EN_MASK, 
    kXECC_MultiErrorInterruptStatusEnable =
        XECC_ERR_STAT_EN_MULIT_ERR_STAT_EN_MASK, 
    kXECC_AllInterruptsStatusEnable = XECC_ERR_STAT_EN_SINGLE_ERR_STAT_EN_MASK |
                                      XECC_ERR_STAT_EN_MULIT_ERR_STAT_EN_MASK, 
};
 
enum
{
    kXECC_SingleErrorInterruptFlag =
        XECC_ERR_STATUS_SINGLE_ERR_MASK, 
    kXECC_MultiErrorInterruptFlag =
        XECC_ERR_STATUS_MULTI_ERR_MASK, 
    kXECC_AllInterruptsFlag =
        XECC_ERR_STATUS_SINGLE_ERR_MASK | XECC_ERR_STATUS_MULTI_ERR_MASK, 
};
 
typedef struct _xecc_config
{
    bool enableXECC;     
    bool enableWriteECC; 
    bool enableReadECC;  
    bool enableSwap;     
    uint32_t Region0BaseAddress; 
    uint32_t Region0EndAddress;  
    uint32_t Region1BaseAddress; 
    uint32_t Region1EndAddress;  
    uint32_t Region2BaseAddress; 
    uint32_t Region2EndAddress;  
    uint32_t Region3BaseAddress; 
    uint32_t Region3EndAddress;  
} xecc_config_t;
 
typedef struct _xecc_single_error_info
{
    uint32_t singleErrorAddress;  
    uint32_t singleErrorData;     
    uint32_t singleErrorEccCode;  
    uint32_t singleErrorBitPos;   
    uint32_t singleErrorBitField; 
} xecc_single_error_info_t;
 
typedef struct _xecc_multi_error_info
{
    uint32_t multiErrorAddress;  
    uint32_t multiErrorData;     
    uint32_t multiErrorEccCode;  
    uint32_t multiErrorBitField; 
} xecc_multi_error_info_t;
 
/*******************************************************************************
 * APIs
 ******************************************************************************/
 
#if defined(__cplusplus)
extern "C" {
#endif
 
void XECC_Init(XECC_Type *base, const xecc_config_t *config);
 
void XECC_Deinit(XECC_Type *base);
 
void XECC_GetDefaultConfig(xecc_config_t *config);
 
/* @} */
 
static inline uint32_t XECC_GetStatusFlags(XECC_Type *base)
{
    return base->ERR_STATUS & (uint32_t)kXECC_AllInterruptsFlag;
}
 
static inline void XECC_ClearStatusFlags(XECC_Type *base, uint32_t mask)
{
    base->ERR_STATUS = mask;
}
 
static inline void XECC_EnableInterruptStatus(XECC_Type *base, uint32_t mask)
{
    base->ERR_STAT_EN |= mask;
}
 
static inline void XECC_DisableInterruptStatus(XECC_Type *base, uint32_t mask)
{
    base->ERR_STAT_EN &= ~mask;
}
 
/* @} */
 
static inline void XECC_EnableInterrupts(XECC_Type *base, uint32_t mask)
{
    base->ERR_SIG_EN |= mask;
}
 
static inline void XECC_DisableInterrupts(XECC_Type *base, uint32_t mask)
{
    base->ERR_SIG_EN &= ~mask;
}
/* @} */
 
static inline void XECC_WriteECCEnable(XECC_Type *base, bool enable)
{
    if (enable)
    {
        base->ECC_CTRL |= XECC_ECC_CTRL_WECC_EN(1);
    }
    else
    {
        base->ECC_CTRL |= XECC_ECC_CTRL_WECC_EN(0);
    }
}
 
static inline void XECC_ReadECCEnable(XECC_Type *base, bool enable)
{
    if (enable)
    {
        base->ECC_CTRL |= XECC_ECC_CTRL_RECC_EN(1);
    }
    else
    {
        base->ECC_CTRL |= XECC_ECC_CTRL_RECC_EN(0);
    }
}
 
static inline void XECC_SwapECCEnable(XECC_Type *base, bool enable)
{
    if (enable)
    {
        base->ECC_CTRL |= XECC_ECC_CTRL_SWAP_EN(1);
    }
    else
    {
        base->ECC_CTRL |= XECC_ECC_CTRL_SWAP_EN(0);
    }
}
 
status_t XECC_ErrorInjection(XECC_Type *base, uint32_t errordata, uint8_t erroreccdata);
 
void XECC_GetSingleErrorInfo(XECC_Type *base, xecc_single_error_info_t *info);
 
void XECC_GetMultiErrorInfo(XECC_Type *base, xecc_multi_error_info_t *info);
 
#if defined(__cplusplus)
}
#endif
 
#endif