csirx_ss.h

Go to the documentation of this file.

/*
 *   Copyright (c) Texas Instruments Incorporated 2018
 *
 *  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.
 *
 */
/* @} */
/*  Sequence for configuring Video port/DMA:
 *  1. Disable VP/DMA
 *  2. Configure VP/DMA
 *  3. Enable VP/DMA
 */
#ifndef CSL_CSIRX_SS_H_
#define CSL_CSIRX_SS_H_

/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
#include <ti/csl/cslr_csirx.h>

#ifdef __cplusplus
extern "C" {
#endif

/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
#define CSL_CSIRX_PSI_L_THREAD_NUM_MAX                          ((uint32_t)32U)

/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
typedef enum
{
    CSL_CSIRX_VP_INSTANCE_0 = CSL_CSI_RX_IF_VP0,
    CSL_CSIRX_VP_INSTANCE_1 = CSL_CSI_RX_IF_VP1,
}CSL_CsirxVPInstance;

typedef enum
{
    CSL_CSIRX_DMA_DATA_SIZE_SHIFT_8BITS = 0U,
    CSL_CSIRX_DMA_DATA_SIZE_SHIFT_16BITS = 1U,
    CSL_CSIRX_DMA_DATA_SIZE_SHIFT_32BITS = 2U,
}CSL_CsirxDMADataSizeShift;

typedef enum
{
    CSL_CSIRX_YUV422_MODE_UYVY = 0U,
    CSL_CSIRX_YUV422_MODE_VYUY = 1U,
    CSL_CSIRX_YUV422_MODE_YUYV = 2U,
    CSL_CSIRX_YUV422_MODE_YVYU = 3U,
}CSL_CsirxYUV422Mode;

typedef struct
{
    uint32_t instance;
    uint32_t inWidth;
    uint32_t inHeight;
}CSL_CsirxVPConfig;

typedef struct
{
    uint32_t chNum;
    uint32_t virtCh;
    uint32_t dataType;
    uint32_t pck12CfgEnable;
    uint32_t dataSizeShift;
    uint32_t dualPkgEnable;
    uint32_t yuv422Mode;
    uint32_t dstTag;
    uint32_t srcTag;
    uint32_t psFlags;
    uint32_t pktType;
}CSL_CsirxDMAConfig;

typedef struct
{
    uint32_t scheme;
    uint32_t bu;
    uint32_t function;
    uint32_t rtlRev;
    uint32_t major;
    uint32_t custom;
    uint32_t minor;
}CSL_CsirxRevisionId;
/* ========================================================================== */
/*                            Global Variables                                */
/* ========================================================================== */

/* None */

/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
void CSL_csirxGetRevisionId(const CSL_csi_rx_ifRegs *ifRegisters,
                            CSL_CsirxRevisionId *revId);

int32_t CSL_csirxEnableVP(CSL_csi_rx_ifRegs *ifRegisters,
                          uint32_t instance,
                          uint32_t enable);

int32_t CSL_csirxConfigVP(CSL_csi_rx_ifRegs *ifRegisters,
                          const CSL_CsirxVPConfig* config);

void CSL_csirxAssertPixelIfReset(CSL_csi_rx_ifRegs *ifRegisters, uint32_t assert);
int32_t CSL_csirxEnableDMA(CSL_csi_rx_ifRegs *ifRegisters,
                           uint32_t threadNum,
                           uint32_t enable);

int32_t CSL_csirxConfigDMA(CSL_csi_rx_ifRegs *ifRegisters,
                           const CSL_CsirxDMAConfig* config);

#ifdef __cplusplus
}

#endif /*extern "C" */

#endif