sdl_ip_ccm.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2022-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_IP_CCM_H_
#define SDL_IP_CCM_H_
 
#include <stddef.h>
#include <stdbool.h>
#include "sdl/sdl_ccm.h"
#include "sdl/r5/v0/sdlr_vim.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                            Macros                                          */
/* ========================================================================== */
#define SDL_VIM_MAX_INTR_GROUPS     (32U)
 
#define SDL_VIM_NUM_INTRS_PER_GROUP (32U)
/* ========================================================================== */
/*                             Enums & Typedefs                                 */
/* ========================================================================== */
 
typedef enum {
    SDL_CCM_MONITOR_TYPE_NONE = 0,
    SDL_CCM_MONITOR_TYPE_OUTPUT_COMPARE_BLOCK = 1,
    SDL_CCM_MONITOR_TYPE_VIM = 2,
#ifdef SOC_AM263PX
    SDL_CCM_MONITOR_TYPE_TMU = 3,
    SDL_CCM_MONITOR_TYPE_RL2 = 4,
    SDL_CCM_MONITOR_TYPE_INACTIVITY_MONITOR = 5,
    SDL_CCM_MONITOR_TYPE_INVALID = 6,
#else
    SDL_CCM_MONITOR_TYPE_INACTIVITY_MONITOR = 3,
    SDL_CCM_MONITOR_TYPE_INVALID = 4,
#endif
} SDL_CCM_MonitorType;
 
typedef enum {
    SDL_CCM_SELFTEST_TYPE_NORMAL = 1,
    SDL_CCM_SELFTEST_TYPE_ERROR_FORCING = 2,
    SDL_CCM_SELFTEST_POLARITY_INVERSION = 3,
    SDL_CCM_SELFTEST_TYPE_INVALID = 4,
} SDL_CCM_SelfTestType;
 
 
typedef struct {
    volatile uint32_t CCMKEYR1;          /* MKEY1 value */
    volatile uint32_t CCMKEYR2;          /* MKEY2 value */
    volatile uint32_t CCMKEYR3;          /* MKEY3 value */
    volatile uint32_t CCMPOLCNTRL;       /* POL_INV value */
#ifdef SOC_AM263PX
    volatile uint32_t CCMKEYR5;          /* MKEY5 value */
    volatile uint32_t CCMKEYR6;          /* MKEY6 value */
#endif
} SDL_CCM_staticRegs;
 
typedef struct SDL_CCM_ErrorStatus_s
{
    bool compareErrorFlag;
    bool selfTestErrorFlag;
    bool selfTestErrorTypeFlag;
} SDL_CCM_ErrorStatus_t;
 
typedef uint32_t SDL_VimIntrMap;
 
#define SDL_VIM_INTR_MAP_IRQ    ((uint32_t)0U)
 
#define SDL_VIM_INTR_MAP_FIQ    ((uint32_t)1U)
 
#define SDL_VIM_INTR_MAP_ALL    ((uint32_t)2U)
 
typedef uint32_t SDL_VimIntrType;
 
#define SDL_VIM_INTR_TYPE_LEVEL ((uint32_t)0U)
 
#define SDL_VIM_INTR_TYPE_PULSE ((uint32_t)1U)
 
typedef struct {
    volatile uint32_t INTR_EN_SET;               
    volatile uint32_t INTR_EN_CLR;               
    volatile uint32_t INTMAP;                    
    volatile uint32_t INTTYPE;                   
} SDL_vimStaticRegs_GRP;
typedef struct {
    SDL_vimStaticRegs_GRP GRP[SDL_VIM_MAX_INTR_GROUPS]; 
    SDL_vimRegs_PRI PRI[SDL_VIM_MAX_INTR_GROUPS*SDL_VIM_NUM_INTRS_PER_GROUP]; 
    SDL_vimRegs_VEC VEC[SDL_VIM_MAX_INTR_GROUPS*SDL_VIM_NUM_INTRS_PER_GROUP]; 
    volatile uint32_t PID;                       
    volatile uint32_t INFO;                      
    volatile uint32_t IRQVEC;                    
    volatile uint32_t FIQVEC;                    
    volatile uint32_t DEDVEC;                    
} SDL_vimStaticRegs;
 
/* ========================================================================== */
/*                            Function Declarations                               */
/* ========================================================================== */
 
int32_t SDL_CCM_init(SDL_CCM_Inst instance, uint32_t index);
 
 int32_t SDL_CCM_verifyConfig(SDL_CCM_Inst instance);
 
 int32_t SDL_CCM_selfTest(SDL_CCM_Inst instance, SDL_CCM_MonitorType monitorType, SDL_CCM_SelfTestType testType, \
                            uint32_t polarityInversionMask, uint32_t timeoutCnt);
 
 int32_t SDL_CCM_injectError(SDL_CCM_Inst instance, SDL_CCM_MonitorType monitorType);
 
 int32_t SDL_CCM_getStaticRegisters(SDL_CCM_Inst instance, SDL_CCM_staticRegs *pStaticRegs);
 
 int32_t SDL_CCM_getErrorType(SDL_CCM_Inst instance, uint32_t intSrc, SDL_CCM_MonitorType *monitorType);
 
 int32_t SDL_CCM_clearError(SDL_CCM_Inst instance, SDL_CCM_MonitorType monitorType);
 
int32_t SDL_VIM_cfgIntr(SDL_vimRegs *pRegs, uint32_t intrNum, uint32_t pri, SDL_VimIntrMap intrMap,
                        SDL_VimIntrType intrType, uint32_t vecAddr );
int32_t SDL_VIM_verifyCfgIntr(SDL_vimRegs     *pRegs,
                                uint32_t         intrNum, uint32_t  pri,
                                SDL_VimIntrMap   intrMap,
                                SDL_VimIntrType  intrType,
                                uint32_t         vecAddr);
int32_t SDL_VIM_getStaticRegs( SDL_vimRegs *pRegs, SDL_vimStaticRegs *pStaticRegs);
#ifdef __cplusplus
}
#endif /*extern "C" */
#endif