esm/v0/esm.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2021 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 ESM_H_
#define ESM_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
#include <stdint.h>
#include <kernel/dpl/HwiP.h>
#include <drivers/hw_include/cslr_soc.h>
#include <drivers/hw_include/cslr_esm.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
typedef void *ESM_Handle;
 
#define ESM_ERRNO_BASE               (-3000)
 
#define ESM_EINVAL                 (ESM_ERRNO_BASE-1)
 
#define ESM_ENOINIT                (ESM_ERRNO_BASE-2)
 
#define ESM_EREINIT                (ESM_ERRNO_BASE-3)
 
#define ESM_ENOMEM                 (ESM_ERRNO_BASE-4)
 
#define ESM_MAX_NOTIFIERS           (4U)
 
#define ESM_MAX_ISR_COUNT           (4U)
 
#define CSL_APP_ESM_ESMEKR_EKEY_NORMAL_MODE         (0x0U)
#define CSL_APP_ESM_ESMEKR_EKEY_ERROR_PIN_RESET     (0x5U)
#define CSL_APP_ESM_ESMEKR_EKEY_ERROR_FORCE_MODE    (0xAU)
 
/* ========================================================================== */
/*                           enums                                            */
/* ========================================================================== */
 
typedef enum 
{
    ESM_INTR_PRIORITY_LEVEL_LOW = 0x0U,
    ESM_INTR_PRIORITY_LEVEL_HIGH = 0x1U
}ESM_IntrPriorityLvl;
 
typedef enum 
{
    ESM_OPERATION_MODE_NORMAL = CSL_APP_ESM_ESMEKR_EKEY_NORMAL_MODE,
    ESM_OPERATION_MODE_ERROR_FORCE = CSL_APP_ESM_ESMEKR_EKEY_ERROR_FORCE_MODE
}ESM_OperationMode;
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef void (*ESM_CallBack)(void* arg);
 
typedef struct 
{
    uint32_t grpIntrStatus[ESM_NUM_INTR_PER_GROUP / 32U];
}ESM_GroupIntrStatus;
 
typedef struct 
{
    uint32_t            groupNumber;
    uint32_t            errorNumber;
    uint32_t            setIntrPriorityLvl;
    Bool                enableInfluenceOnErrPin;
    void                *arg;
    ESM_CallBack        notify;
} ESM_NotifyParams;
 
typedef struct
{
    Bool bClearErrors;
} ESM_OpenParams;
 
typedef struct {
    CSL_app_esmRegs             *ptrESMRegs;
    CSL_app_ctrlRegs        *ptrCtrlRegs;
    uint32_t                numGroup1Err; 
    uint32_t                highPrioIntNum;
    uint32_t                lowPrioIntNum;
    uint8_t                 intrHighPriority;
    uint8_t                 intrLowPriority;
} ESM_Attrs;
 
typedef struct 
{
    ESM_Handle                  esmHandle;
    uint32_t                    esmBaseAddr;
    ESM_OpenParams              params;
    void                       *hwiHandleHi;
    HwiP_Object                 hwiHiObj;
    void                       *hwiHandleLo;
    HwiP_Object                 hwiLoObj;
    ESM_NotifyParams            notifyParams[ESM_MAX_NOTIFIERS];
    uint32_t                    numGroup1Err;
    uint32_t                    debugEsmISRCount[ESM_MAX_ISR_COUNT];
} ESM_Object;
 
typedef struct  {
    const ESM_Attrs      *hwAttrs;
    ESM_Object           *object;
} ESM_Config;
 
extern ESM_Config            gEsmConfig[];
extern uint32_t              gEsmConfigNum;
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void ESM_init(void);
 
void ESM_deinit(void);
 
ESM_Handle ESM_open(uint32_t index, ESM_OpenParams *params);
 
void ESM_close(ESM_Handle handle);
 
int32_t ESM_registerNotifier(ESM_Handle handle, ESM_NotifyParams* params, int32_t* errCode);
 
int32_t ESM_deregisterNotifier(ESM_Handle handle, int32_t notifyIndex, int32_t* errCode);
 
void ESM_setMode(uint32_t baseAddr, uint32_t mode);
 
int32_t ESM_setErrPinLowTimePreload(uint32_t baseAddr, uint32_t lowTime);
 
uint32_t ESM_getCurrErrPinLowTimeCnt(uint32_t baseAddr);
 
uint32_t ESM_getErrPinStatus(uint32_t baseAddr);
 
void ESM_resetErrPin(uint32_t baseAddr);
 
uint32_t ESM_getIntrStatus(uint32_t baseAddr, uint32_t intrSrc);
 
int32_t ESM_getGroupIntrStatus(uint32_t baseAddr, 
                              uint32_t grpNum,
                              ESM_GroupIntrStatus *intrstatus);
                              
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
static inline void ESM_Params_init(ESM_OpenParams *openPrms)
{
    if (openPrms != NULL)
    {
        openPrms->bClearErrors  = FALSE;
    }
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef ESM_H_ */