csl_dssTop.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_DSSTOP_H_
#define CSL_DSSTOP_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <drivers/dss/v0/hw_include/V3/cslr_dss.h>
#include <drivers/fvid2.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define CSL_DSS_VID_PIPE_TYPE_VID                   ((uint32_t) 0x0)
 
#define CSL_DSS_VID_PIPE_TYPE_VIDL                  ((uint32_t) 0x1)
 
#define CSL_DSS_COMM_REG_ID_0                       ((uint32_t) 0x0U)
 
#define CSL_DSS_COMM_REG_ID_1                       ((uint32_t) 0x1U)
 
#define CSL_DSS_COMM_REG_ID_MAX                     ((uint32_t) 0x2U)
 
#define CSL_DSS_VID_PIPE_ID_VID1                    ((uint32_t) 0x0U)
 
#define CSL_DSS_VID_PIPE_ID_VIDL1                   ((uint32_t) 0x1U)
 
#define CSL_DSS_VID_PIPE_ID_MAX                     ((uint32_t) 0x2U)
 
#define CSL_DSS_VID_PIPE_ID_INVALID                 ((uint32_t) 0xFFU)
 
#define CSL_DSS_OVERLAY_ID_1                        ((uint32_t) 0x0U)
 
#define CSL_DSS_OVERLAY_ID_2                        ((uint32_t) 0x1U)
 
#define CSL_DSS_OVERLAY_ID_MAX                      ((uint32_t) 0x2U)
 
#define CSL_DSS_VP_ID_1                             ((uint32_t) 0x0U)
 
#define CSL_DSS_VP_ID_2                             ((uint32_t) 0x1U)
 
#define CSL_DSS_VP_ID_MAX                           ((uint32_t) 0x2U)
 
#define CSL_DSS_VP_ID_1_MASK                        ((uint32_t) 0x1U)
 
#define CSL_DSS_VP_ID_2_MASK                        ((uint32_t) 0x2U)
 
#define CSL_DSS_CSC_RANGE_LIMITED                   ((uint32_t) 0x0U)
 
#define CSL_DSS_CSC_RANGE_FULL                      ((uint32_t) 0x1U)
 
#define CSL_DSS_CSC_RANGE_CUSTOM                    ((uint32_t) 0x2U)
 
#define CSL_DSS_SAFETY_CHK_FRAME_FREEZE_DETECT     \
        ((uint32_t) CSL_DSS_VID_SAFETY_ATTRIBUTES_CAPTUREMODE_VAL_FRAMEFREEZE)
 
#define CSL_DSS_SAFETY_CHK_DATA_INTEGRITY          \
        ((uint32_t) CSL_DSS_VID_SAFETY_ATTRIBUTES_CAPTUREMODE_VAL_DATACHECK)
 
#define CSL_DSS_SAFETY_CHK_FRAME_SKIP_NO           \
            ((uint32_t) CSL_DSS_VID_SAFETY_ATTRIBUTES_FRAMESKIP_VAL_DISABLE)
 
#define CSL_DSS_SAFETY_CHK_FRAME_SKIP_EVEN         \
            ((uint32_t) CSL_DSS_VID_SAFETY_ATTRIBUTES_FRAMESKIP_VAL_EVEN)
 
#define CSL_DSS_SAFETY_CHK_FRAME_SKIP_ODD          \
            ((uint32_t) CSL_DSS_VID_SAFETY_ATTRIBUTES_FRAMESKIP_VAL_ODD)
 
#define CSL_DSS_NUM_LUT_ENTRIES                     ((uint32_t) 256U)
 
#define CSL_DSS_MODULE_INVALID                      ((uint32_t) 0xFFU)
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct
{
    uint32_t cscRange;
    int32_t c00;
    int32_t c01;
    int32_t c02;
    int32_t c10;
    int32_t c11;
    int32_t c12;
    int32_t c20;
    int32_t c21;
    int32_t c22;
    int32_t preOffset1;
    int32_t preOffset2;
    int32_t preOffset3;
    int32_t postOffset1;
    int32_t postOffset2;
    int32_t postOffset3;
} CSL_DssCscCoeff;
 
typedef struct
{
    uint32_t safetyChkEnable;
    uint32_t safetyChkMode;
    uint32_t seedSelectEnable;
    uint32_t thresholdValue;
    uint32_t frameSkip;
    Fvid2_PosConfig regionPos;
    Fvid2_SizeConfig regionSize;
} CSL_DssSafetyChkCfg;
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                      Static Function Declarations                          */
/* ========================================================================== */
 
static inline void CSL_dssCscCoeffInit(
    CSL_DssCscCoeff *cscCoeff);
 
static inline void CSL_dssSafetyChkCfgInit(
    CSL_DssSafetyChkCfg *safetyCfg);
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
static inline void CSL_dssCscCoeffInit(
    CSL_DssCscCoeff *cscCoeff)
{
    if(NULL != cscCoeff)
    {
        cscCoeff->cscRange = CSL_DSS_CSC_RANGE_LIMITED;
        cscCoeff->c00 = 0;
        cscCoeff->c01 = 0;
        cscCoeff->c02 = 0;
        cscCoeff->c10 = 0;
        cscCoeff->c11 = 0;
        cscCoeff->c12 = 0;
        cscCoeff->c20 = 0;
        cscCoeff->c21 = 0;
        cscCoeff->c22 = 0;
        cscCoeff->preOffset1 = 0;
        cscCoeff->preOffset2 = 0;
        cscCoeff->preOffset3 = 0;
        cscCoeff->postOffset1 = 0;
        cscCoeff->postOffset2 = 0;
        cscCoeff->postOffset3 = 0;
    }
}
 
static inline void CSL_dssSafetyChkCfgInit(
    CSL_DssSafetyChkCfg *safetyCfg)
{
    if(NULL != safetyCfg)
    {
        safetyCfg->safetyChkEnable = FALSE;
        safetyCfg->safetyChkMode = CSL_DSS_SAFETY_CHK_FRAME_FREEZE_DETECT;
        safetyCfg->seedSelectEnable = 0U;
        safetyCfg->thresholdValue = FALSE;
        safetyCfg->frameSkip = CSL_DSS_SAFETY_CHK_FRAME_SKIP_NO;
        safetyCfg->regionPos.startX = 0U;
        safetyCfg->regionPos.startY = 0U;
        safetyCfg->regionSize.width = 0U;
        safetyCfg->regionSize.height = 0U;
    }
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef CSL_DSSTOP_H_ */