csitx.h

Go to the documentation of this file.

/*
 *  Copyright (c) Texas Instruments Incorporated 2020
 *  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 CSITX_H_
#define CSITX_H_

/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
#include <ti/csl/csl_csitx.h>
#include <ti/drv/fvid2/fvid2.h>
#include <ti/drv/csitx/include/csitx_cfg.h>
#include <ti/drv/csitx/soc/csitx_soc.h>
#include <ti/drv/csitx/include/csitx_event.h>
#include <ti/drv/udma/udma.h>

#ifdef __cplusplus
extern "C" {
#endif

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

#define CSITX_TX_DRV_ID               (FVID2_CSITX_DRV_BASE + 0x00000000U)

/* transmit IOCTL's */
#define IOCTL_CSITX_GET_INST_STATUS     (FVID2_CSITX_DRV_IOCTL_BASE + 0x0000U)

#define IOCTL_CSITX_PRINT_DEBUG_LOGS    (FVID2_CSITX_DRV_IOCTL_BASE + 0x0100U)
/* @} */

#define CSITX_CH_TYPE_TX                          ((uint32_t) 0x0U)

#define CSITX_CH_TYPE_COLORBAR                    ((uint32_t) 0x1U)

#define CSITX_CH_TYPE_LPBK                        ((uint32_t) 0x2U)
/* @} */

#define CSITX_BUF_ALIGNMENT                       (UDMA_CACHELINE_ALIGNMENT)

/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
typedef struct
{
    uint32_t chId;
    uint32_t chType;
    uint32_t vcNum;
    uint32_t outCsiDataType;
    Fvid2_Format inFmt;
    uint32_t vBlank;
    uint32_t hBlank;
    uint32_t startDelayPeriod;
    Udma_ChTxPrms txChParams;
    uint8_t ringOrderId;
} Csitx_ChCfg;

typedef struct
{
    uint32_t rxCompEnable;
    uint32_t rxv1p3MapEnable;
    uint32_t numDataLanes;
    uint32_t lanePolarityCtrl[(CSITX_TX_DATA_LANES_MAX + CSITX_TX_CLK_LANES_MAX)];
    uint32_t enableFrameRepeat;
    Csitx_DPhyCfg dphyCfg;
    uint32_t eventGrpNum;
    Csitx_EventPrms eventParams[CSITX_EVENT_GROUP_MAX];
    uint32_t lpbkCsiRxInst;
    /*< Input CSIRX instance for the loopback stream */
    CSL_CsitxRetransCfg retransCfg;
    /*< Retransmission stream configurations */
} Csitx_InstCfg;

typedef struct
{
    uint32_t        numCh;
    Csitx_ChCfg     chCfg[CSITX_NUM_CH];
    Csitx_InstCfg   instCfg;
} Csitx_CreateParams;

typedef struct
{
    Udma_DrvHandle  drvHandle;
} Csitx_InitParams;

typedef struct
{
    int32_t retVal;
} Csitx_CreateStatus;

typedef struct
{
    uint32_t queueCount[CSITX_NUM_CH];
    uint32_t dequeueCount[CSITX_NUM_CH];
     uint32_t frmRepeatCount[CSITX_NUM_CH];
    uint32_t overflowCount;
    uint32_t frameStartCount[CSITX_NUM_PIXEL_IF];
    /* *<Counter to keep track of how many frame start events occured*/
    uint32_t frameEndCount[CSITX_NUM_PIXEL_IF];
    /* *<Counter to keep track of how many frame end events occured*/
    uint32_t fifoUnderflowCount[CSITX_NUM_PIXEL_IF];
    /* *<Counter to keep track of how many fifo underflow events occured*/
    uint32_t dataFlowErrCount[CSITX_NUM_PIXEL_IF];
    /* *<Counter to keep track of how many data flow error events occured*/
    uint32_t byteCountMismatchCount[CSITX_NUM_PIXEL_IF];
    /* *<Counter to keep track of how many byte count mismatch events occured*/
    uint32_t lineNumerrorCount[CSITX_NUM_PIXEL_IF];
    /* *<Counter to keep track of how many line number error events occured*/
} Csitx_InstStatus;

/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
int32_t Csitx_init(const Csitx_InitParams *initParams);

int32_t Csitx_deInit(void);

void Csitx_initParamsInit(Csitx_InitParams *initPrms);

void Csitx_createParamsInit(Csitx_CreateParams *createPrms);

void Csitx_chCfgInit(Csitx_ChCfg *chCfg);

void Csitx_instCfgInit(Csitx_InstCfg *instCfg);

void Csitx_instStatusInit(Csitx_InstStatus *status);
/* ========================================================================== */
/*                       Function Definitions                          */
/* ========================================================================== */

/* None */

#ifdef __cplusplus
}
#endif

#endif /* #ifndef CSITX_H_ */
/* @} */