am62lx/dss_soc.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2025 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 DSS_SOC_H_
#define DSS_SOC_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
/*
 *  Macros for different driver instance numbers to be passed as instance ID
 *  at the time of driver create.
 *  Note: These are read only macros. Don't modify the value of these macros.
 */
 
#define DSS_DCTRL_INST_0                (0U)
 
#define DSS_DCTRL_INST_MAX              (1U)
 
#define DSS_DISP_INST_VIDL1                      (CSL_DSS_VID_PIPE_ID_VIDL1)
 
#define DSS_DISP_INST_MAX                        (CSL_DSS_VID_PIPE_ID_MAX)
 
#define DSS_DISP_INST_INVALID                    (CSL_DSS_VID_PIPE_ID_INVALID)
 
#define DSS_DCTRL_NODE_TYPE_INVALID    ((uint32_t) 0x0U)
#define DSS_DCTRL_NODE_TYPE_PIPE       ((uint32_t) 0x1U)
#define DSS_DCTRL_NODE_TYPE_OVERLAY    ((uint32_t) 0x2U)
#define DSS_DCTRL_NODE_TYPE_VP         ((uint32_t) 0x3U)
#define DSS_DCTRL_NODE_TYPE_OUTPUT     ((uint32_t) 0x4U)
 
#define DSS_DCTRL_NODE_INVALID         ((uint32_t) 0x0U)
#define DSS_DCTRL_NODE_VIDL1           ((uint32_t) 0x2U)
#define DSS_DCTRL_NODE_OVR1            ((uint32_t) 0x3U)
#define DSS_DCTRL_NODE_VP1             ((uint32_t) 0x5U)
#define DSS_DCTRL_NODE_DPI             ((uint32_t) 0x8U)
 
#define DSS_FWL_REGIONS_MAX         (5U)
 
#define DSS_FWL_COMMON0_ID          CSL_STD_FW_DSS0_COMMON_ID
#define DSS_FWL_COMMON0_START       CSL_STD_FW_DSS0_COMMON_COMMON_START
#define DSS_FWL_COMMON0_END         CSL_STD_FW_DSS0_COMMON_COMMON_END
 
#define DSS_FWL_COMMON1_ID          CSL_STD_FW_DSS0_COMMON1_ID
#define DSS_FWL_COMMON1_START       CSL_STD_FW_DSS0_COMMON1_COMMON1_START
#define DSS_FWL_COMMON1_END         CSL_STD_FW_DSS0_COMMON1_COMMON1_END
 
#define DSS_FWL_VIDL1_ID            CSL_STD_FW_DSS0_VIDL1_ID
#define DSS_FWL_VIDL1_START         CSL_STD_FW_DSS0_VIDL1_VIDL1_START
#define DSS_FWL_VIDL1_END           CSL_STD_FW_DSS0_VIDL1_VIDL1_END
 
#define DSS_FWL_OVR1_ID             CSL_STD_FW_DSS0_OVR1_ID
#define DSS_FWL_OVR1_START          CSL_STD_FW_DSS0_OVR1_OVR1_START
#define DSS_FWL_OVR1_END            CSL_STD_FW_DSS0_OVR1_OVR1_END
 
#define DSS_FWL_VP1_ID              CSL_STD_FW_DSS0_VP1_ID
#define DSS_FWL_VP1_START           CSL_STD_FW_DSS0_VP1_VP1_START
#define DSS_FWL_VP1_END             CSL_STD_FW_DSS0_VP1_VP1_END
 
#define DSS_DCTRL_MAX_NODES            ((uint32_t) 9U)
 
#define DSS_DCTRL_MAX_EDGES            ((uint32_t) 8U)
 
#define DSS_FUNC_IRQ_DEFAULT_NUM       (CSLR_GICSS0_SPI_DSS0_DISPC_INTR_REQ_0_0)
 
#define DSS_EVT_MGR_INST_ID_FUNC              ((uint32_t) 0x00U)
 
#define DSS_EVT_MGR_INST_ID_MAX               ((uint32_t) 0x01U)
 
#define DSS_EVT_MGR_INST_ID_INVALID           ((uint32_t) 0xFFU)
 
/*
 *  SOC specific IOCTLs.
 */
 
#define IOCTL_DSS_DCTRL_SET_OLDI_PARAMS       (DSS_DCTRL_SOC_IOCTL_BASE + 0x01U)
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct
{
    uint32_t dssCommonRegionId;
    uint32_t numValidIrq;
    uint32_t irqNum[DSS_EVT_MGR_INST_ID_MAX];
} Dss_IrqParams;
 
typedef struct
{
    uint32_t isCommRegAvailable[CSL_DSS_COMM_REG_ID_MAX];
    uint32_t isPipeAvailable[CSL_DSS_VID_PIPE_ID_MAX];
    uint32_t isOverlayAvailable[CSL_DSS_OVERLAY_ID_MAX];
    uint32_t isPortAvailable[CSL_DSS_VP_ID_MAX];
} Dss_RmInfo;
 
typedef struct
{
    Dss_IrqParams irqParams;
    Dss_RmInfo rmInfo;
} Dss_SocParams;
 
typedef struct
{
    uint32_t vpId;
    CSL_DssVpOldiCfg oldiCfg;
} Dss_DctrlOldiParams;
 
/* ========================================================================== */
/*                  Internal/Private Function Declarations                    */
/* ========================================================================== */
 
static inline uint32_t Dss_dispIsVidInst(uint32_t instId);
 
static inline uint32_t Dss_dispIsVidLInst(uint32_t instId);
 
static inline void Dss_irqParamsInit(Dss_IrqParams *irqParams);
 
static inline void Dss_rmInfoInit(Dss_RmInfo *rmInfo);
 
static inline void Dss_socParamsInit(Dss_SocParams *socParams);
 
static inline void Dss_dctrlOldiParamsInit(Dss_DctrlOldiParams *oldiParams);
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void Dss_setDssSoftReset(void);
 
void Dss_setOLDITxPowerDown(uint32_t oldiLinkMode, bool powerState);
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
static inline uint32_t Dss_dispIsVidInst(uint32_t instId)
{
    uint32_t isVidInst = FALSE;
 
    return (isVidInst);
}
 
static inline uint32_t Dss_dispIsVidLInst(uint32_t instId)
{
    uint32_t isVidLInst = FALSE;
 
    if(DSS_DISP_INST_VIDL1 == instId)
    {
        isVidLInst = TRUE;
    }
 
    return (isVidLInst);
}
 
static inline void Dss_irqParamsInit(Dss_IrqParams *irqParams)
{
    if(NULL != irqParams)
    {
        irqParams->dssCommonRegionId = CSL_DSS_COMM_REG_ID_0;
        irqParams->numValidIrq = DSS_EVT_MGR_INST_ID_MAX;
        irqParams->irqNum[DSS_EVT_MGR_INST_ID_FUNC] = DSS_FUNC_IRQ_DEFAULT_NUM;
    }
}
 
static inline void Dss_rmInfoInit(Dss_RmInfo *rmInfo)
{
    uint32_t i = 0U;
    if(NULL != rmInfo)
    {
        for(i=CSL_DSS_COMM_REG_ID_0; i<CSL_DSS_COMM_REG_ID_MAX; i++)
        {
            rmInfo->isCommRegAvailable[i] = TRUE;
        }
        for(i=CSL_DSS_VID_PIPE_ID_VIDL1; i<CSL_DSS_VID_PIPE_ID_MAX; i++)
        {
            rmInfo->isPipeAvailable[i] = TRUE;
        }
        for(i=CSL_DSS_OVERLAY_ID_1; i<CSL_DSS_OVERLAY_ID_MAX; i++)
        {
            rmInfo->isOverlayAvailable[i] = TRUE;
        }
        for(i=CSL_DSS_VP_ID_1; i<CSL_DSS_VP_ID_MAX; i++)
        {
            rmInfo->isPortAvailable[i] = TRUE;
        }
    }
}
 
static inline void Dss_socParamsInit(Dss_SocParams *socParams)
{
    if(NULL != socParams)
    {
        Dss_irqParamsInit(&(socParams->irqParams));
        Dss_rmInfoInit(&(socParams->rmInfo));
    }
}
 
static inline void Dss_dctrlOldiParamsInit(Dss_DctrlOldiParams *oldiParams)
{
    if(NULL != oldiParams)
    {
        oldiParams->vpId = CSL_DSS_VP_ID_1;
        CSL_dssVpOldiCfgInit(&(oldiParams->oldiCfg));
    }
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef DSS_SOC_VO_H_ */