sdl/esm/v1/esm.h

Go to the documentation of this file.

/*
 *   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 SDL_ESM_H
#define SDL_ESM_H
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
#include <stdint.h>
#include <stdbool.h>
#include <sdl/include/hw_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
 
/* Local Defines */
#define BITS_PER_WORD (32u)
#define ESM_INTR_GRP_NUM (32U)
#define GROUP_NUMBER_BIT_SHIFT  (5u)
#define NO_EVENT_VALUE (0xffffu)
#define SDL_ESM_EN_KEY_ENBALE_VAL (0xFU)
#define INVALID_BIT (0u)
#define FLAG_NO (0u)
#define FLAG_YES (1u)
 
#define ESM_NUM_INTR_PER_GRP              (32U)
#define ESM_MAX_NUM_INTRS                 (1024U)
#define ESM_ESM_PIN_CTRL_KEY_RESET_VAL    (0x5U)
#define ESM_SFT_RST_KEY_RESET_VAL         (0xFU)
#define ESM_EN_KEY_MASK                   (0xFU)
#define ESM_EN_KEY_ENBALE_VAL             (0xFU)
#define ESM_EN_KEY_DISABLE_VAL            (0x0U)
 
 
#define SDL_ESM_ESMIEPSR(m)            ((uint32_t) ESM_ESMIEPSR1 + \
                                    (((m) / 32U) * 0x40U))
 
#define SDL_ESM_ESMIEPCR(m)            ((uint32_t) ESM_ESMIEPCR1 + \
                                    (((m) / 32U) * 0x40U))
 
#define SDL_ESM_ESMIESR(m)             ((uint32_t) ESM_ESMIESR1 + \
                                    (((m) / 32U) * 0x40U))
 
#define SDL_ESM_ESMIECR(m)             ((uint32_t) ESM_ESMIECR1 + \
                                    (((m) / 32U) * 0x40U))
 
#define SDL_ESM_ESMILSR(m)             ((uint32_t) ESM_ESMILSR1 + \
                                    (((m) / 32U) * 0x40U))
 
#define SDL_ESM_ESMILCR(m)             ((uint32_t) ESM_ESMILCR1 + \
                                    (((m) / 32U) * 0x40U))
 
#define SDL_ESM_ESMSR(m)               ((uint32_t) ESM_ESMSR1 + \
                                    (((m) / 32U) * 0x40U))
 
#define SDL_ESM_ESMSR_NUM_ELEMS        (4U)
 
#define ESM_GATING_MASK         (0xFU)
 
#define ESM_GATING_SHIFT        (0x4U)
 
#define ESM_NUM_EVTS_PER_GATING_REG     (0x8U)
 
#define ESM_GATING_GROUP  (0x4U)  
 
#define BITS_PER_WORD (32u)
 
#define ESM_NUMBER_OF_GROUP_REGS          (32u)
 
#define SDL_ESM_NUM_GROUP_MAX                    (3U)
#define SDL_ESM_NUM_INTR_PER_GROUP               (128U)
 
typedef uint32_t esmOperationMode_t;
 
#define SDL_ESM_OPERATION_MODE_NORMAL 0x0U
 
#define SDL_ESM_OPERATION_MODE_ERROR_FORCE 0xAu
 
typedef uint32_t esmIntrType_t;
 
#define SDL_ESM_INTR_TYPE_LOW_PRIO_ERROR (0x1u)
 
#define SDL_ESM_INTR_TYPE_HIGH_PRIO_ERROR (0x2u)
 
typedef uint32_t esmIntrPriorityLvl_t;
 
#define SDL_ESM_INTR_PRIORITY_LEVEL_LOW  (0x0u)
 
#define SDL_ESM_INTR_PRIORITY_LEVEL_HIGH (0x1u)
 
typedef void *SDL_ESM_Handle;
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
typedef struct 
{
    uint32_t grpIntrStatus[SDL_ESM_NUM_INTR_PER_GROUP / ESM_NUM_INTR_PER_GRP];
}SDL_ESM_GroupIntrStatus;
 
typedef struct {
    volatile uint32_t ESMIEPSR1;             /* ESM Enable ERROR Pin Action/Response Register 1 */
    volatile uint32_t ESMIEPCR1;             /* ESM Disable ERROR Pin Action/Response Register 1 */
    volatile uint32_t ESMIESR1;              /* ESM Interrupt Enable Set/Status Register 1 */
    volatile uint32_t ESMIECR1;              /* ESM Interrupt Enable Clear/Status Register 1 */
    volatile uint32_t ESMILSR1;              /* Interrupt Level Set/Status Register 1 */
    volatile uint32_t ESMILCR1;              /* Interrupt Level Clear/Status Register 1 */
    volatile uint32_t ESMSR1;                /* ESM Status Register 1 */
    volatile uint32_t ESMSR2;                /* ESM Status Register 2 */
    volatile uint32_t ESMSR3;                /* ESM Status Register 3 */
    volatile uint32_t ESMEPSR;               /* ESM ERROR Pin Status Register */
    volatile uint32_t ESMIOFFHR;             /* ESM Interrupt Offset High Register */
    volatile uint32_t ESMIOFFLR;             /* ESM Interrupt Offset Low Register */
    volatile uint32_t ESMLTCR;               /* ESM Low-Time Counter Register */
    volatile uint32_t ESMLTCPR;              /* ESM Low-Time Counter Preload Register */
    volatile uint32_t ESMEKR;                /* ESM Error Key Register */
    volatile uint32_t ESMSSR2;               /* ESM Status Shadow Register 2 */
    
}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_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_getErrPinLowTimePreload(uint32_t baseAddr, uint32_t *pLowTime);
 
int32_t SDL_ESM_getCurrErrPinLowTimeCnt(uint32_t baseAddr, uint32_t *pPinCntrPre);
 
int32_t SDL_ESM_getErrPinStatus(uint32_t baseAddr, uint32_t *pStatus);
 
int32_t SDL_ESM_resetErrPin(uint32_t baseAddr);
 
int32_t SDL_ESM_isEnableIntr(uint32_t baseAddr, uint32_t intrSrc, uint32_t *pEnStatus);
 
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_getIntrStatus(uint32_t baseAddr, uint32_t intrSrc, uint32_t *pStaus);
 
int32_t SDL_ESM_getGroupIntrStatus(uint32_t baseAddr, esmIntrPriorityLvl_t intrPrioType,
                                   SDL_ESM_GroupIntrStatus *pIntrstatus);
 
int32_t SDL_ESM_clearIntrStatus(uint32_t baseAddr, uint32_t intrSrc);
 
int32_t SDL_ESM_clearGroupIntrStatus(uint32_t baseAddr, uint32_t grpNum);
 
 
int32_t SDL_ESM_getLowPriorityLvlIntrStatus(uint32_t baseAddr, uint32_t *pstatus);
 
int32_t SDL_ESM_getHighPriorityLvlIntrStatus(uint32_t baseAddr, uint32_t *pstatus);
 
int32_t SDL_ESM_getIntrPriorityLvl(uint32_t baseAddr, uint32_t intrSrc,
                                   esmIntrPriorityLvl_t *pIntrPriorityLvl);
 
#ifdef __cplusplus
}
 
#endif /*extern "C" */
 
#endif /*SDL_ESM_H*/