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 INCLUDE_SDL_ESM_H_
#define INCLUDE_SDL_ESM_H_
 
#include <stdint.h>
#include <stdbool.h>
#include <sdl/esm/soc/sdl_esm_soc.h>
#include <sdl/esm/v0/esm.h>
#include <sdl/esm/sdlr_esm.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef int32_t SDL_Result;
 
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;
 
 
#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)
 
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)
 
#define SDL_ESM_ECC_PARAM_MAIN_MSMC_AGGR0_SEC_ERROR (10001u)
 
#define SDL_ESM_ECC_PARAM_MAIN_MSMC_AGGR0_DED_ERROR (10002u)
 
#define SDL_ESM_ECC_PARAM_MAIN_A72_AGGR0_SEC_ERROR (10003u)
 
#define SDL_ESM_ECC_PARAM_MAIN_A72_AGGR0_DED_ERROR (10004u)
 
typedef int32_t (* SDL_ESM_applicationCallback) (SDL_ESM_Inst instance, SDL_ESM_IntType intrType, uint32_t grpChannel, uint32_t index, uint32_t intSrc, void *arg);
 
typedef struct SDL_ESM_Errorconfig_s
{
    uint32_t groupNumber;
    uint32_t bitNumber;
} SDL_ESM_ErrorConfig_t;
 
typedef struct SDL_ESM_InitConfig_s
{
    SDL_ESM_ErrorConfig_t esmErrorConfig;
    uint32_t enableBitmap[SDL_ESM_MAX_EVENT_MAP_NUM_WORDS];
    uint32_t priorityBitmap[SDL_ESM_MAX_EVENT_MAP_NUM_WORDS];
    uint32_t errorpinBitmap[SDL_ESM_MAX_EVENT_MAP_NUM_WORDS];
    uint32_t pinmininterval;
} SDL_ESM_config;
 
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_verifyConfig(SDL_ESM_Inst instance, const SDL_ESM_config *pConfig);
 
int32_t SDL_ESM_clrNError(SDL_ESM_Inst instance);
 
int32_t SDL_ESM_setNError(SDL_ESM_Inst instance);
 
int32_t SDL_ESM_registerECCCallback(SDL_ESM_Inst instance, uint32_t eventBitMap[],
                                    SDL_ESM_applicationCallback eccCallback,
                                    void *callbackArg);
 
int32_t SDL_ESM_init(SDL_ESM_Inst instance, const SDL_ESM_config *pConfig,
                     SDL_ESM_applicationCallback applicationCallback, void *appArg);
 
void SDL_ESM_hiInterruptHandler (void *arg);
 
void SDL_ESM_loInterruptHandler (void *arg);
 
void SDL_ESM_configInterruptHandler(void *arg);
 
int32_t SDL_ESM_getIntNumber(SDL_ESM_Inst esmInstType,
                              SDL_ESM_IntType esmIntType);
 
 
#ifdef __cplusplus
}
#endif  /* extern "C" */
 
#endif /* INCLUDE_SDL_ESM_H_ */