csl_dssCommon.h

Go to the documentation of this file.

/*
 *  Copyright (c) Texas Instruments Incorporated 2023
 *  All rights reserved.
 *
 *  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 CSL_DSSCOMMON_H_
#define CSL_DSSCOMMON_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
typedef CSL_dss_commonRegs CSL_dss_commRegs;
 
#define CSL_DSS_DISPC_INTR_VIDL1_MASK      ((uint32_t) 0x20U)
 
#define CSL_DSS_DISPC_INTR_VP1_MASK        ((uint32_t) 0x01U)
 
#define CSL_DSS_VID_PIPE_INTR_SAFETYVIOLATION_MASK    \
        ((uint32_t) CSL_DSS_COMMON_VID_IRQENABLE_1_SAFETYREGION_EN_MASK)
 
#define CSL_DSS_VID_PIPE_INTR_WINDOWEND_MASK          \
        ((uint32_t) CSL_DSS_COMMON_VID_IRQENABLE_1_VIDENDWINDOW_EN_MASK)
 
#define CSL_DSS_VID_PIPE_INTR_BUFUNDERFLOW_MASK       \
        ((uint32_t) CSL_DSS_COMMON_VID_IRQENABLE_1_VIDBUFFERUNDERFLOW_EN_MASK)
 
#define CSL_DSS_VID_PIPE_INTR_ALL_MASK         \
                            (CSL_DSS_VID_PIPE_INTR_SAFETYVIOLATION_MASK | \
                             CSL_DSS_VID_PIPE_INTR_WINDOWEND_MASK | \
                             CSL_DSS_VID_PIPE_INTR_BUFUNDERFLOW_MASK)
 
#define CSL_DSS_VP_INTR_FRAMEDONE_MASK          \
    ((uint32_t) CSL_DSS_COMMON_VP_IRQENABLE_0_VPFRAMEDONE_EN_MASK)
 
#define CSL_DSS_VP_INTR_VSYNC_MASK              \
    ((uint32_t) CSL_DSS_COMMON_VP_IRQENABLE_0_VPVSYNC_EN_MASK)
 
#define CSL_DSS_VP_INTR_ODDVSYNC_MASK           \
    ((uint32_t) CSL_DSS_COMMON_VP_IRQENABLE_0_VPVSYNC_ODD_EN_MASK)
 
#define CSL_DSS_VP_INTR_PROGLINENUM_MASK        \
    ((uint32_t) CSL_DSS_COMMON_VP_IRQENABLE_0_VPPROGRAMMEDLINENUMBER_EN_MASK)
 
#define CSL_DSS_VP_INTR_SYNCLOST_MASK           \
        ((uint32_t) CSL_DSS_COMMON_VP_IRQENABLE_0_VPSYNCLOST_EN_MASK)
 
#define CSL_DSS_VP_INTR_ACBIASCOUNT_MASK        \
        ((uint32_t) CSL_DSS_COMMON_VP_IRQENABLE_0_ACBIASCOUNTSTATUS_EN_MASK)
 
#define CSL_DSS_VP_INTR_SAFETYVIOLATION_REGION0_MASK    \
        ((uint32_t) 0x40U)
 
#define CSL_DSS_VP_INTR_SAFETYVIOLATION_REGION1_MASK    \
        ((uint32_t) 0x80U)
 
#define CSL_DSS_VP_INTR_SAFETYVIOLATION_REGION2_MASK    \
        ((uint32_t) 0x100U)
 
#define CSL_DSS_VP_INTR_SAFETYVIOLATION_REGION3_MASK    \
        ((uint32_t) 0x200U)
 
#define CSL_DSS_VP_INTR_SECURITYVIOLATION_MASK  \
        ((uint32_t) CSL_DSS_COMMON_VP_IRQENABLE_0_SECURITYVIOLATION_EN_MASK)
 
#define CSL_DSS_VP_INTR_GOBITCLEAR_MASK         \
        ((uint32_t) CSL_DSS_COMMON_VP_IRQENABLE_0_VPSYNC_EN_MASK)
 
#define CSL_DSS_VP_INTR_ALL_MASK         \
                            (CSL_DSS_VP_INTR_FRAMEDONE_MASK | \
                             CSL_DSS_VP_INTR_VSYNC_MASK | \
                             CSL_DSS_VP_INTR_ODDVSYNC_MASK | \
                             CSL_DSS_VP_INTR_PROGLINENUM_MASK | \
                             CSL_DSS_VP_INTR_SYNCLOST_MASK | \
                             CSL_DSS_VP_INTR_ACBIASCOUNT_MASK | \
                             CSL_DSS_VP_INTR_SAFETYVIOLATION_REGION0_MASK | \
                             CSL_DSS_VP_INTR_SAFETYVIOLATION_REGION1_MASK | \
                             CSL_DSS_VP_INTR_SAFETYVIOLATION_REGION2_MASK | \
                             CSL_DSS_VP_INTR_SAFETYVIOLATION_REGION3_MASK | \
                             CSL_DSS_VP_INTR_SECURITYVIOLATION_MASK | \
                             CSL_DSS_VP_INTR_GOBITCLEAR_MASK)
 
#define CSL_DSS_MFLAG_START_NORMAL             \
    ((uint32_t) CSL_DSS_COMMON_DISPC_GLOBAL_MFLAG_ATTRIBUTE_MFLAG_START_VAL_MFLAGNORMALSTARTMODE)
 
#define CSL_DSS_MFLAG_START_FORCED             \
    ((uint32_t) CSL_DSS_COMMON_DISPC_GLOBAL_MFLAG_ATTRIBUTE_MFLAG_START_VAL_MFLAGFORCESTARTMODE)
 
#define CSL_DSS_MFLAG_CTRL_DISABLED             \
    ((uint32_t) CSL_DSS_COMMON_DISPC_GLOBAL_MFLAG_ATTRIBUTE_MFLAG_CTRL_VAL_MFLAGDIS)
 
#define CSL_DSS_MFLAG_CTRL_FORCE_ENABLE         \
    ((uint32_t) CSL_DSS_COMMON_DISPC_GLOBAL_MFLAG_ATTRIBUTE_MFLAG_CTRL_VAL_MFLAGFORCE)
 
#define CSL_DSS_MFLAG_CTRL_DYNAMIC              \
    ((uint32_t) CSL_DSS_COMMON_DISPC_GLOBAL_MFLAG_ATTRIBUTE_MFLAG_CTRL_VAL_MFLAGEN)
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct
{
    uint32_t globalMflagStart;
    uint32_t globalMflagCtrl;
} CSL_DssGlobalMFlagCfg;
 
typedef struct
{
    uint32_t priHigh;
    uint32_t priLow;
} CSL_DssCbaCfg;
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void CSL_dssModuleReset(CSL_dss_commRegs *commRegs);
 
uint32_t CSL_dssIsOldiResetDone(const CSL_dss_commRegs *commRegs);
 
void CSL_dssEnableDispcIntr(CSL_dss_commRegs *commRegs,
                            uint32_t intrMask,
                            uint32_t intrEnable);
 
void CSL_dssEnablePipeIntr(CSL_dss_commRegs *commRegs,
                           uint32_t vidPipeId,
                           uint32_t intrMask,
                           uint32_t intrEnable);
 
void CSL_dssEnableVpIntr(CSL_dss_commRegs *commRegs,
                         uint32_t portId,
                         uint32_t intrMask,
                         uint32_t intrEnable);
 
void CSL_dssClearDispcIntr(CSL_dss_commRegs *commRegs,
                           uint32_t intrMask);
 
void CSL_dssClearPipeIntr(CSL_dss_commRegs *commRegs,
                          uint32_t vidPipeId,
                          uint32_t intrMask);
 
void CSL_dssClearVpIntr(CSL_dss_commRegs *commRegs,
                        uint32_t portId,
                        uint32_t intrMask);
 
uint32_t CSL_dssGetDispcIntrStatus(const CSL_dss_commRegs *commRegs);
 
uint32_t CSL_dssGetPipeIntrStatus(const CSL_dss_commRegs *commRegs,
                                  uint32_t vidPipeId);
 
uint32_t CSL_dssGetVpIntrStatus(const CSL_dss_commRegs *commRegs,
                                uint32_t portId);
 
void CSL_dssSetGlobalMflagConfig(CSL_dss_commRegs *commRegs,
                                 const CSL_DssGlobalMFlagCfg *mflagCfg);
 
void CSL_dssGlobalVpEnable(CSL_dss_commRegs *commRegs,
                           uint32_t portIdMask,
                           uint32_t enable);
 
void CSL_dssGlobalVpGoBitEnable(CSL_dss_commRegs *commRegs,
                                uint32_t portIdMask);
 
void CSL_dssSetCbaConfig(CSL_dss_commRegs *commRegs,
                         const CSL_DssCbaCfg *cbaCfg);
 
/* ========================================================================== */
/*                      Static Function Declarations                          */
/* ========================================================================== */
 
static inline void CSL_dssGlobalMFlagCfgInit(
    CSL_DssGlobalMFlagCfg *mflagCfg);
 
static inline void CSL_dssCbaCfgInit(
    CSL_DssCbaCfg *cbaCfg);
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
static inline void CSL_dssGlobalMFlagCfgInit(
    CSL_DssGlobalMFlagCfg *mflagCfg)
{
    if(NULL != mflagCfg)
    {
        mflagCfg->globalMflagStart = CSL_DSS_MFLAG_START_NORMAL;
        mflagCfg->globalMflagCtrl = CSL_DSS_MFLAG_CTRL_DISABLED;
    }
}
 
static inline void CSL_dssCbaCfgInit(
    CSL_DssCbaCfg *cbaCfg)
{
    if(NULL != cbaCfg)
    {
        cbaCfg->priHigh = 0x1U;
        cbaCfg->priLow = 0x4U;
    }
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef CSL_DSSCOMMON_H_ */