dss_disp.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 DSS_DISP_H_
#define DSS_DISP_H_

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

/* None */

#ifdef __cplusplus
extern "C" {
#endif

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

typedef Fvid2_Frame *(*Dss_DispBufPrgmCbFxn)(Fvid2_Handle handle,
                                             Fvid2_Frame *curFrm,
                                             uint32_t isFrmRepeat,
                                             uint32_t frmRepeatCnt);

typedef int32_t (*Dss_DispPipePrgmCbFxn)(Fvid2_Frame *progFrm,
                                         void *appData);

typedef void (*Dss_DispUnderFlowCbFxn)(void *appData);

typedef void (*Dss_DispSafetyErrCbFxn)(uint32_t capturedSign,
                                       void *appData);

#define DSS_BUFFER_ALIGNMENT                     (16U)

/*
 *  Display driver IOCTLs.
 */

#define IOCTL_DSS_DISP_SET_DSS_PARAMS          (DSS_DISP_IOCTL_BASE + 0x0001U)

#define IOCTL_DSS_DISP_SET_PIPE_MFLAG_PARAMS   (DSS_DISP_IOCTL_BASE + 0x0002U)

#define IOCTL_DSS_DISP_GET_CURRENT_STATUS      (DSS_DISP_IOCTL_BASE + 0x0003U)

#define IOCTL_DSS_DISP_SET_PIPE_SAFETY_CHK_PARAMS      \
                                               (DSS_DISP_IOCTL_BASE + 0x0004U)

#define IOCTL_DSS_DISP_SET_PIPE_CSC_COEFF      (DSS_DISP_IOCTL_BASE + 0x0005U)

#define IOCTL_DSS_DISP_REGISTER_BUF_PRGM_CB    (DSS_DISP_IOCTL_BASE + 0x0006U)

#define IOCTL_DSS_DISP_REGISTER_PIPE_PRGM_CB   (DSS_DISP_IOCTL_BASE + 0x0007U)

#define IOCTL_DSS_DISP_REGISTER_PIPE_UNDERFLOW_CB      \
                                               (DSS_DISP_IOCTL_BASE + 0x0008U)

/* @} */

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

typedef struct
{
    uint32_t periodicCbEnable;
    uint32_t progPipeVsyncEnable;
} Dss_DispCreateParams;

typedef struct
{
    int32_t  retVal;
    uint32_t standard;
    uint32_t dispWidth;
    uint32_t dispHeight;
    uint32_t minNumPrimeBuf;
} Dss_DispCreateStatus;

typedef struct
{
    uint32_t cropEnable;
    Fvid2_EdgeCropConfig cropCfg;
} Dss_DispPipeCropParams;

typedef struct
{
    CSL_DssVidPipeCfg pipeCfg;
    CSL_DssVidPipeDmaCfg dmaCfg;
    CSL_DssVidPipeAlphaCfg alphaCfg;
    CSL_DssVidPipeVC1Cfg vc1Cfg;
    Dss_DispPipeCropParams cropParams;
    Fvid2_PosConfig layerPos;
} Dss_DispParams;

typedef struct
{
    CSL_DssVidPipeMFlagCfg mflagCfg;
} Dss_DispPipeMflagParams;

typedef struct
{
    uint32_t queueCount;
    uint32_t dequeueCount;
    uint32_t dispFrmCount;
    uint32_t repeatFrmCount;
    uint32_t underflowCount;
    uint32_t safetyViolationCount;
} Dss_DispCurrentStatus;

typedef struct
{
    uint32_t safetySignSeedVal;
    uint32_t referenceSign;
    CSL_DssSafetyChkCfg safetyChkCfg;
    Dss_DispSafetyErrCbFxn safetyErrCbFxn;
    uint32_t capturedSign;
    void *appData;
} Dss_DispPipeSafetyChkParams;

typedef struct
{
    Dss_DispBufPrgmCbFxn bufPrgmCbFxn;
} Dss_DispBufPrgmCbParams;

typedef struct
{
    Dss_DispPipePrgmCbFxn pipePrgmCbFxn;
    void *appData;
} Dss_DispPipePrgmCbParams;

typedef struct
{
    Dss_DispUnderFlowCbFxn underFlowCbFxn;
    void *appData;
} Dss_DispUnderFlowCbParams;

typedef struct
{
    uint32_t pixelInc;
} Dss_ScRtParams;

typedef struct
{
    uint32_t width;
    uint32_t height;
    uint32_t pitch[FVID2_MAX_PLANES];
    uint32_t dataFormat;
} Dss_FrameRtParams;

typedef struct
{
    Fvid2_PosConfig *posCfg;
    Dss_FrameRtParams *inFrmParams;
    Dss_FrameRtParams *outFrmParams;
    Dss_ScRtParams *scParams;
} Dss_DispRtParams;

/* ========================================================================== */
/*                  Internal/Private Function Declarations                    */
/* ========================================================================== */

static inline void Dss_dispCreateParamsInit(Dss_DispCreateParams *createParams);

static inline void Dss_dispParamsInit(Dss_DispParams *dssParams);

static inline void Dss_dispPipeMflagParamsInit(
    Dss_DispPipeMflagParams *pipeMflagParams);

static inline void Dss_dispPipeSafetyChkParamsInit(
    Dss_DispPipeSafetyChkParams *pipeSafetyChkParams);

static inline void Dss_dispBufPrgmCbParamsInit(
    Dss_DispBufPrgmCbParams *bufPrgmCbParams);

static inline void Dss_dispPipePrgmCbParamsInit(
    Dss_DispPipePrgmCbParams *pipePrgmCbParams);

static inline void Dss_dispUnderFlowCbParamsInit(
    Dss_DispUnderFlowCbParams *underFlowCbParams);

static inline void Dss_scRtParamsInit(Dss_ScRtParams *scRtParams);

static inline void Dss_frameRtParamsInit(Dss_FrameRtParams *frameRtParams);

static inline void Dss_dispRtParamsInit(Dss_DispRtParams *rtParams);

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

/* None */

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

static inline void Dss_dispCreateParamsInit(Dss_DispCreateParams *createParams)
{
    if(NULL != createParams)
    {
        createParams->periodicCbEnable = TRUE;
        createParams->progPipeVsyncEnable = FALSE;
    }
}

static inline void Dss_dispPipeCropParamsInit(
    Dss_DispPipeCropParams *cropParams)
{
    if(NULL != cropParams)
    {
        cropParams->cropEnable = FALSE;
        Fvid2EdgeCropConfig_init(&(cropParams->cropCfg));
    }
}

static inline void Dss_dispParamsInit(Dss_DispParams *dssParams)
{
    if(NULL != dssParams)
    {
        CSL_dssVidPipeCfgInit(&(dssParams->pipeCfg));
        CSL_dssVidPipeDmaCfgInit(&(dssParams->dmaCfg));
        CSL_dssVidPipeAlphaCfgInit(&(dssParams->alphaCfg));
        CSL_dssVidPipeVC1CfgInit(&(dssParams->vc1Cfg));
        Dss_dispPipeCropParamsInit(&(dssParams->cropParams));
        Fvid2PosConfig_init(&(dssParams->layerPos));
    }
}

static inline void Dss_dispPipeMflagParamsInit(
    Dss_DispPipeMflagParams *pipeMflagParams)
{
    if(NULL != pipeMflagParams)
    {
        CSL_dssVidPipeMFlagCfgInit(&(pipeMflagParams->mflagCfg));
    }
}

static inline void Dss_dispPipeSafetyChkParamsInit(
    Dss_DispPipeSafetyChkParams *pipeSafetyChkParams)
{
    if(NULL != pipeSafetyChkParams)
    {
        pipeSafetyChkParams->safetySignSeedVal = 0U;
        pipeSafetyChkParams->referenceSign = 0U;
        CSL_dssSafetyChkCfgInit(&(pipeSafetyChkParams->safetyChkCfg));
        pipeSafetyChkParams->safetyErrCbFxn = NULL;
        pipeSafetyChkParams->capturedSign = 0U;
        pipeSafetyChkParams->appData = NULL;
    }
}

static inline void Dss_dispBufPrgmCbParamsInit(
    Dss_DispBufPrgmCbParams *bufPrgmCbParams)
{
    if(NULL != bufPrgmCbParams)
    {
        bufPrgmCbParams->bufPrgmCbFxn = NULL;
    }
}

static inline void Dss_dispPipePrgmCbParamsInit(
    Dss_DispPipePrgmCbParams *pipePrgmCbParams)
{
    if(NULL != pipePrgmCbParams)
    {
        pipePrgmCbParams->pipePrgmCbFxn = NULL;
    }
}

static inline void Dss_dispUnderFlowCbParamsInit(
    Dss_DispUnderFlowCbParams *underFlowCbParams)
{
    if(NULL != underFlowCbParams)
    {
        underFlowCbParams->underFlowCbFxn = NULL;
    }
}

static inline void Dss_scRtParamsInit(Dss_ScRtParams *scRtParams)
{
    if(NULL != scRtParams)
    {
        scRtParams->pixelInc = 1U;
    }
}

static inline void Dss_frameRtParamsInit(Dss_FrameRtParams *frameRtParams)
{
    uint32_t i;
    if(NULL != frameRtParams)
    {
        frameRtParams->width = 1920U;
        frameRtParams->height = 1080U;
        frameRtParams->dataFormat = FVID2_DF_YUV422I_YUYV;
        for(i=0U; i<FVID2_MAX_PLANES; i++)
        {
            frameRtParams->pitch[i] = 1920U*3U;
        }
    }
}

static inline void Dss_dispRtParamsInit(Dss_DispRtParams *rtParams)
{
    if(NULL != rtParams)
    {
        rtParams->posCfg = NULL;
        rtParams->inFrmParams = NULL;
        rtParams->outFrmParams = NULL;
        rtParams->scParams = NULL;
    }
}

#ifdef __cplusplus
}
#endif

#endif /* #ifndef DSS_DISP_H_ */

/* @} */