sdl/esm/v0/esm.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2023-2024 Texas Instruments Incorporated
 *
 *  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 SDL_ESM_H
#define SDL_ESM_H
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
#include <stdint.h>
#include <stdbool.h>
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define ESM_NUMBER_OF_GROUP_REGS          (32u)
 
typedef uint32_t esmOperationMode_t;
 
#define ESM_OPERATION_MODE_NORMAL 0x0U
 
#define ESM_OPERATION_MODE_ERROR_FORCE 0xAu
 
typedef uint32_t esmErrOutMode_t;
 
#define SDL_ESM_LVL_PINOUT 0x0u
 
#define SDL_ESM_PWM_PINOUT 0xFu
 
typedef uint32_t esmIntrType_t;
 
#define ESM_INTR_TYPE_CONFIG_ERROR   (0x0u)
 
#define ESM_INTR_TYPE_LOW_PRIO_ERROR (0x1u)
 
#define ESM_INTR_TYPE_HIGH_PRIO_ERROR (0x2u)
 
typedef uint32_t esmIntrPriorityLvl_t;
 
#define ESM_INTR_PRIORITY_LEVEL_LOW  (0x0u)
 
#define ESM_INTR_PRIORITY_LEVEL_HIGH (0x1u)
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
typedef struct esmRevisionId
{
    uint32_t scheme;
    uint32_t func;
    uint32_t rtlRev;
    uint32_t major;
    uint32_t custom;
    uint32_t minor;
}esmRevisionId_t;
 
typedef struct esmInfo
{
    uint32_t lastRstType;
    uint32_t plsGrpNum;
    uint32_t lvlGrpNum;
}esmInfo_t;
 
typedef struct esmGroupIntrStatus
{
    uint32_t highestPendPlsIntNum;
    uint32_t highestPendLvlIntNum;
    uint32_t grpIntrStatus;
}esmGroupIntrStatus_t;
 
typedef struct {
    volatile uint32_t RAW;                       /* Config Error Raw Status/Set Register */
    volatile uint32_t INTR_EN_SET;               /* Level Error Interrutp Enable Set Register */
    volatile uint32_t INTR_EN_CLR;               /* Level Error Interrupt Enabled Clear Register */
    volatile uint32_t INT_PRIO;                  /* Level Error Interrupt Enabled Clear Register */
    volatile uint32_t PIN_EN_SET;                /* Level Error Interrupt Enabled Clear Register */
    volatile uint32_t PIN_EN_CLR;                /* Level Error Interrupt Enabled Clear Register */
} SDL_esmRegs_ERR_GRP_STATIC;
 
typedef struct {
    SDL_esmRegs_ERR_GRP_STATIC ERR_GRP[ESM_NUMBER_OF_GROUP_REGS];
    volatile uint32_t PID;                       /* Revision Register */
    volatile uint32_t INFO;                      /* Info Register */
    volatile uint32_t EN;                        /* Global Enable Register */
    volatile uint32_t ERR_EN_SET;                /* Config Error Interrutp Enable Set Register */
    volatile uint32_t ERR_EN_CLR;                /* Config Error Interrupt Enabled Clear Register */
    volatile uint32_t LOW_PRI;                   /* Low Priority Prioritized Register */
    volatile uint32_t HI_PRI;                    /* High Priority Prioritized Register */
    volatile uint32_t LOW;                       /* Low Priority Interrupt Status Register */
    volatile uint32_t HI;                        /* High Priority Interrupt Status Register */
    volatile uint32_t PIN_CTRL;                  /* Error Pin Control Register */
    volatile uint32_t PIN_CNTR_PRE;              /* Error Counter Value Pre-Load Register */
    volatile uint32_t PWMH_PIN_CNTR_PRE;         /* Error PWM High Counter Value Pre-Load Register */
    volatile uint32_t PWML_PIN_CNTR_PRE;         /* Error PWM Low Counter Value Pre-Load Register */
 
}SDL_ESM_staticRegs;
 
 
/* ========================================================================== */
/*                            Global Variables                                */
/* ========================================================================== */
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
int32_t SDL_ESM_setMode(uint32_t baseAddr, esmOperationMode_t mode);
 
int32_t SDL_ESM_getPinMode(uint32_t baseAddr, esmOperationMode_t *pMode);
 
 
int32_t SDL_ESM_getErrorOutMode(uint32_t baseAddr, esmOperationMode_t *pMode);
 
int32_t SDL_ESM_setInfluenceOnErrPin(uint32_t baseAddr, uint32_t intrSrc,
                                     bool enable);
 
int32_t SDL_ESM_getInfluenceOnErrPin(uint32_t baseAddr, uint32_t intrSrc,
                                     uint32_t *pInfluence);
int32_t SDL_ESM_setErrPinLowTimePreload(uint32_t baseAddr, uint32_t lowTime);
 
int32_t SDL_ESM_PWML_setErrPinLowTimePreload(uint32_t baseAddr, uint32_t lowTime);
 
int32_t SDL_ESM_PWMH_setErrPinHighTimePreload(uint32_t baseAddr, uint32_t highTime);
 
int32_t SDL_ESM_getErrPinLowTimePreload(uint32_t baseAddr, uint32_t *pLowTime);
 
int32_t SDL_ESM_PWML_getErrPinLowTimePreload(uint32_t baseAddr, uint32_t *pPinPWMLCntrPre);
 
int32_t SDL_ESM_PWMH_getErrPinHighTimePreload(uint32_t baseAddr, uint32_t *pPinPWMHCntrPre);
 
 
int32_t SDL_ESM_getCurrErrPinLowTimeCnt(uint32_t baseAddr, uint32_t *pPinCntrPre);
 
int32_t SDL_ESM_PWML_getCurrErrPinLowTimeCnt(uint32_t baseAddr, uint32_t *pLowPWMLTime);
 
int32_t SDL_ESM_PWMH_getCurrErrPinHighTimeCnt(uint32_t baseAddr, uint32_t *pHighPWMHTime);
 
int32_t SDL_ESM_getErrPinStatus(uint32_t baseAddr, uint32_t *pStatus);
 
int32_t SDL_ESM_resetErrPin(uint32_t baseAddr);
 
int32_t SDL_ESM_isEnableCfgIntr(uint32_t baseAddr, uint32_t group, uint32_t *pEnStatus);
 
int32_t SDL_ESM_isEnableIntr(uint32_t baseAddr, uint32_t intrSrc, uint32_t *pEnStatus);
 
int32_t SDL_ESM_disableCfgIntr(uint32_t baseAddr, uint32_t intrNum);
 
int32_t SDL_ESM_enableCfgIntr(uint32_t baseAddr, uint32_t group);
 
int32_t SDL_ESM_enableIntr(uint32_t baseAddr, uint32_t intrNum);
 
int32_t SDL_ESM_disableIntr(uint32_t baseAddr, uint32_t intrNum);
 
int32_t SDL_ESM_setIntrPriorityLvl(uint32_t baseAddr, uint32_t intrSrc,
                                   esmIntrPriorityLvl_t intrPriorityLvl);
 
int32_t SDL_ESM_getIntrPriorityLvl(uint32_t baseAddr, uint32_t intrSrc,
                                   esmIntrPriorityLvl_t *pIntrPriorityLvl);
 
int32_t SDL_ESM_getCfgIntrStatus(uint32_t baseAddr, uint32_t group, uint32_t *pStaus);
 
int32_t SDL_ESM_getIntrStatus(uint32_t baseAddr, uint32_t intrSrc, uint32_t *pStaus);
 
int32_t SDL_ESM_setCfgIntrStatusRAW(uint32_t baseAddr, uint32_t group);
 
int32_t SDL_ESM_setIntrStatusRAW(uint32_t baseAddr, uint32_t intrSrc);
 
int32_t SDL_ESM_getIntrStatusRAW(uint32_t baseAddr, uint32_t intrSrc, uint32_t *pStatus);
 
int32_t SDL_ESM_getGroupIntrStatus(uint32_t baseAddr, esmIntrPriorityLvl_t intrPrioType,
                                   esmGroupIntrStatus_t *pIntrstatus);
 
int32_t SDL_ESM_clearCfgIntrStatus(uint32_t baseAddr, uint32_t group);
 
int32_t SDL_ESM_clearIntrStatus(uint32_t baseAddr, uint32_t intrSrc);
 
int32_t SDL_ESM_writeEOI(uint32_t baseAddr, esmIntrType_t intrType);
 
int32_t SDL_ESM_getRevisionId(uint32_t baseAddr, esmRevisionId_t *pRevId);
 
int32_t SDL_ESM_getInfo(uint32_t baseAddr, esmInfo_t *pInfo);
 
 
int32_t SDL_ESM_getGlobalIntrEnabledStatus(uint32_t baseAddr, uint32_t *pStatus);
 
 
int32_t SDL_ESM_enableGlobalIntr(uint32_t baseAddr);
 
int32_t SDL_ESM_disableGlobalIntr(uint32_t baseAddr);
 
int32_t SDL_ESM_reset(uint32_t baseAddr);
 
#ifdef __cplusplus
}
 
#endif /*extern "C" */
 
#endif /*SDL_ESM_H*/