csl_dssOverlay.h

Go to the documentation of this file.

/*
 *  Copyright (c) Texas Instruments Incorporated 2018
 *  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_DSSOVERLAY_H_
#define CSL_DSSOVERLAY_H_

/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */

/* None */

#ifdef __cplusplus
extern "C" {
#endif

/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */

typedef CSL_dss_ovr1Regs CSL_dss_overlayRegs;

#define CSL_DSS_OVERLAY_TRANS_COLOR_DEST             \
                    ((uint32_t) CSL_DSS_OVR1_CONFIG_TCKLCDSELECTION_VAL_GDTK)

#define CSL_DSS_OVERLAY_TRANS_COLOR_SRC              \
                    ((uint32_t) CSL_DSS_OVR1_CONFIG_TCKLCDSELECTION_VAL_VSTK)
/* @} */

#define CSL_DSS_OVERLAY_LAYER_NUM_0                     ((uint32_t) 0x0U)

#define CSL_DSS_OVERLAY_LAYER_NUM_1                     ((uint32_t) 0x1U)

#define CSL_DSS_OVERLAY_LAYER_NUM_2                     ((uint32_t) 0x2U)

#define CSL_DSS_OVERLAY_LAYER_NUM_3                     ((uint32_t) 0x3U)

#define CSL_DSS_OVERLAY_LAYER_NUM_4                     ((uint32_t) 0x4U)

#define CSL_DSS_OVERLAY_LAYER_MAX                       ((uint32_t) 0x5U)

#define CSL_DSS_OVERLAY_LAYER_INVALID                   ((uint32_t) 0xFFU)
/* @} */

/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */

typedef struct
{
    uint32_t colorKeyEnable;
    uint32_t colorKeySel;
    uint32_t transColorKeyMin;
    uint32_t transColorKeyMax;
    uint32_t backGroundColor;
} CSL_DssOverlayCfg;

typedef struct
{
    uint32_t layerEnable;
    uint32_t layerNum;
    uint32_t inputPipe;
} CSL_DssOverlayLayerCfg;

typedef struct
{
    Fvid2_PosConfig layerPos;
} CSL_DssOverlayPipePosCfg;

/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */

void CSL_dssOverlaySetConfig(CSL_dss_overlayRegs *overlayRegs,
                             const CSL_DssOverlayCfg *overlayCfg);

void CSL_dssOverlayColorBarEnable(CSL_dss_overlayRegs *overlayRegs,
                                  uint32_t enable);

void CSL_dssOverlaySetLayerConfig(CSL_dss_overlayRegs *overlayRegs,
                                  const CSL_DssOverlayLayerCfg *layerCfg);

void CSL_dssOverlaySetPipePosConfig(CSL_dss_overlayRegs *overlayRegs,
                                    const CSL_DssOverlayPipePosCfg *pipePosCfg,
                                    uint32_t layerNum);

uint32_t CSL_dssOverlayGetEnabledPipeLayerNum(
                                        const CSL_dss_overlayRegs *overlayRegs,
                                        uint32_t pipeId);

/* ========================================================================== */
/*                      Static Function Declarations                          */
/* ========================================================================== */

static inline void CSL_dssOverlayCfgInit(
    CSL_DssOverlayCfg *overlayCfg);

static inline void CSL_dssOverlayLayerCfgInit(
    CSL_DssOverlayLayerCfg *layerCfg);

static inline void CSL_dssOverlayPipePosCfgInit(
    CSL_DssOverlayPipePosCfg *pipePosCfg);

/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */

static inline void CSL_dssOverlayCfgInit(
    CSL_DssOverlayCfg *overlayCfg)
{
    if(NULL != overlayCfg)
    {
        overlayCfg->colorKeyEnable = FALSE;
        overlayCfg->colorKeySel = CSL_DSS_OVERLAY_TRANS_COLOR_DEST;
        overlayCfg->transColorKeyMin = 0x0U;
        overlayCfg->transColorKeyMax = 0x0U;
        overlayCfg->backGroundColor = 0x0U;
    }
}

static inline void CSL_dssOverlayLayerCfgInit(
    CSL_DssOverlayLayerCfg *layerCfg)
{
    if(NULL != layerCfg)
    {
        layerCfg->layerEnable = FALSE;
        layerCfg->inputPipe = CSL_DSS_VID_PIPE_ID_VID1;
        layerCfg->layerNum = CSL_DSS_OVERLAY_LAYER_NUM_0;
    }
}

static inline void CSL_dssOverlayPipePosCfgInit(
    CSL_DssOverlayPipePosCfg *pipePosCfg)
{
    if(NULL != pipePosCfg)
    {
        Fvid2PosConfig_init(&pipePosCfg->layerPos);
    }
}

#ifdef __cplusplus
}
#endif

#endif /* #ifndef CSL_DSSOVERLAY_H_ */

/* @} */