sdl_esm.h

Go to the documentation of this file.

/*
 * SDL ESM
 *
 * Software Diagnostics Reference module for Error Signaling Module
 *
 *  Copyright (c) Texas Instruments Incorporated 2022
 *
 *  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 ESM_H_
#define ESM_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
#include <stdint.h>
#include <sdl/include/sdl_types.h>
#include <sdl/include/hw_types.h>
#include <sdl/esm/sdlr_esm.h>
#include <sdl/esm/v1/v1_0/sdlr_esm.h>
#include <sdl/esm/v1/esm.h>
#include <sdl/dpl/sdl_dpl.h>
#include <sdl/esm/soc/sdl_esm_soc.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define SDL_ESM_ERRNO_BASE               (-3000)
 
#define SDL_ESM_INTNUMBER_INVALID (0xffffffffu)
 
#define SDL_ESM_INST_INVALID      (0xfffffffeu)
 
#define SDL_ESM_ERRORADDR_INVALID (0xffffffffu)
 
#define SDL_ESM_ERRORRAMID_INVALID (0xffffffffu)
 
#define SDL_ESM_ERRORBITOFFSET_INVALID (0xffffffffffffffffu)
 
#define SDL_ESM_ERRORBITGROUP_INVALID (0xffffffffu)
 
#define SDL_ESM_MAX_EVENT_MAP_NUM_WORDS (32u)
 
#define SDL_ESM_EINVAL                 (SDL_ESM_ERRNO_BASE-1)
 
#define SDL_ESM_ENOINIT                (SDL_ESM_ERRNO_BASE-2)
 
#define SDL_ESM_EREINIT                (SDL_ESM_ERRNO_BASE-3)
 
#define SDL_ESM_ENOMEM                 (SDL_ESM_ERRNO_BASE-4)
 
#define SDL_ESM_MAX_NOTIFIERS           (256U)
 
#define SDL_ESM_MAX_ISR_COUNT           (256U)
 
 #define CONFIG_ESM0           (0U)
 
typedef int32_t SDL_Result;
 
typedef uint32_t sdlEsmEccErrorSource_t;
 
#define SDL_ESM_ECC_PARAM_MCU_CPU0_SEC_ERROR (1u)
 
#define SDL_ESM_ECC_PARAM_MCU_CPU0_DED_ERROR (2u)
 
#define SDL_ESM_ECC_PARAM_MCU_CPU1_SEC_ERROR (3u)
 
#define SDL_ESM_ECC_PARAM_MCU_CPU1_DED_ERROR (4u)
 
#define SDL_ESM_ECC_PARAM_MCU_CBASS_SEC_ERROR (5u)
 
#define SDL_ESM_ECC_PARAM_MCU_CBASS_DED_ERROR (6u)
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
 typedef int32_t (* SDL_ESM_CallBack) (SDL_ESM_Inst instance, int32_t grpChannel, int32_t vecNum, void *arg);
 
typedef struct 
{
    uint32_t grpIntrStatus[SDL_ESM_NUM_INTR_PER_GROUP / BITS_PER_WORD];
}ESM_GroupIntrStatus;
 
typedef struct SDL_ESM_Errorconfig_s
{
    uint32_t groupNumber;
    uint32_t eventNumber;
} SDL_ESM_ErrorConfig_t;
 
typedef struct 
{
    uint32_t            groupNumber;
    uint32_t            errorNumber;
    uint32_t            setIntrPriorityLvl;
    bool                enableInfluenceOnErrPin;
    void                *arg;
    SDL_ESM_CallBack        callBackFunction;
    SDL_ESM_ErrorConfig_t esmErrorConfig;
} SDL_ESM_NotifyParams;
 
typedef struct
{
    bool bClearErrors;
} SDL_ESM_OpenParams;
 
typedef struct {
    SDL_ESM_ErrorConfig_t esmErrorConfig;
    SDL_esmRegs             *ptrESMRegs;
    SDL_mss_ctrlRegs        *ptrCtrlRegs;
    uint32_t                numGroup1Err; 
    uint32_t                highPrioIntNum;
    uint32_t                lowPrioIntNum;
    uint8_t                 intrHighPriority;
    uint8_t                 intrLowPriority;
} SDL_ESM_Params;
 
typedef struct 
{
    volatile bool selfTestFlag;
    uint32_t                    esmBaseAddr;
    SDL_ESM_OpenParams              params;
    SDL_ESM_Handle                  esmHandle;
    SDL_ESM_NotifyParams            notifyParams[SDL_ESM_MAX_NOTIFIERS];
    uint32_t                    numGroup1Err;
    void *eccCallBackFunctionArg[SDL_ESM_MAX_ISR_COUNT];
    SDL_ESM_CallBack eccCallBackFunction[SDL_ESM_MAX_ISR_COUNT];
    uint32_t eccenableEventBitmap[SDL_ESM_MAX_ISR_COUNT];
    uint32_t                    debugEsmISRCount[SDL_ESM_MAX_ISR_COUNT];
} SDL_ESM_Object;
 
typedef struct  {
    SDL_ESM_Params      *esmConfig;
    SDL_ESM_Object           *object;
} SDL_ESM_Config;
 
/*
 * ESM
 */
/* ESM attributes */
static SDL_ESM_Params gEsmParams[SDL_ESM_INST_DSS_ESM] =
{
    {
        .ptrESMRegs             = (SDL_esmRegs *)SDL_MSS_ESM_U_BASE,
        .ptrCtrlRegs            = (SDL_mss_ctrlRegs *)SDL_MSS_CTRL_U_BASE,
        .numGroup1Err           = SDL_ESM_NUM_INTR_PER_GROUP,
        .highPrioIntNum         = SDL_MSS_ESM_HI_INTNO,
        .lowPrioIntNum          = SDL_MSS_ESM_LOW_INTNO,
        .intrHighPriority       = SDL_ESM_EN_KEY_ENBALE_VAL,
        .intrLowPriority        = 8U,
    },
    
    {
        .ptrESMRegs             = (SDL_esmRegs *)SDL_DSS_ESM_U_BASE,
        .ptrCtrlRegs            = (SDL_mss_ctrlRegs *)SDL_DSS_CTRL_U_BASE,
        .numGroup1Err           = SDL_ESM_NUM_INTR_PER_GROUP,
        .highPrioIntNum         = SDL_DSS_ESM_HI_INTNO,
        .lowPrioIntNum          = SDL_DSS_ESM_LOW_INTNO,
        .intrHighPriority       = SDL_ESM_EN_KEY_ENBALE_VAL,
        .intrLowPriority        = 1U,
    },
};
 
/* ESM objects - initialized by the Module */
static SDL_ESM_Object gEsmObjects[CONFIG_ESM0];
 
/* ESM Module handles */
extern SDL_ESM_Handle gEsmHandle;
 
/* ESM Module configuration */
static SDL_ESM_Config gEsmConfig[SDL_ESM_INST_DSS_ESM] =
{
    {
        &gEsmParams[SDL_ESM_INST_MSS_ESM -1U],
        &gEsmObjects[CONFIG_ESM0],
    },
    {
        &gEsmParams[SDL_ESM_INST_DSS_ESM -1U],
        &gEsmObjects[CONFIG_ESM0],
    },
};
 
/* ========================================================================== */
/*                           enums                                            */
/* ========================================================================== */
typedef enum {
   SDL_ESM_INT_TYPE_HI = 1,
   SDL_ESM_INT_TYPE_LO = 2,
   SDL_ESM_INT_TYPE_CFG = 3,
   SDL_ESM_INT_TYPE_MAX = 4,
} SDL_ESM_IntType;
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
int32_t SDL_ESM_getNErrorStatus(SDL_ESM_Inst instance, uint32_t *pStatus);
 
int32_t SDL_ESM_getStaticRegisters(SDL_ESM_Inst instance, SDL_ESM_staticRegs *pStaticRegs);
 
int32_t SDL_ESM_clrNError(SDL_ESM_Inst instance);
 
int32_t SDL_ESM_setNError(SDL_ESM_Inst instance);
 
SDL_Result SDL_ESM_init (const SDL_ESM_Inst esmInstType,
                         SDL_ESM_NotifyParams* params,
                         SDL_ESM_OpenParams *esmOpenParams,
                         void *arg);
 
int32_t SDL_ESM_registerECCCallback(SDL_ESM_Inst esmInstType,uint32_t eccEvent,
                                    SDL_ESM_CallBack callBack,
                                    void *callbackArg);
int32_t SDL_ESM_verifyConfig(SDL_ESM_Inst instance, SDL_ESM_NotifyParams* params);
                                    
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
static inline void SDL_ESM_Params_init(SDL_ESM_OpenParams *openPrms)
{
    if (openPrms != NULL)
    {
        openPrms->bClearErrors  = FALSE;
    }
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef ESM_H_ */