csitx_if.h

Go to the documentation of this file.

/**********************************************************************
* Copyright (C) 2012-2019 Cadence Design Systems, Inc.
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. 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.
* 3. Neither the name of the copyright holder 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 HOLDER 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.
**********************************************************************
* WARNING: This file is auto-generated using api-generator utility.
*          api-generator: 13.04.5beed88
*          Do not edit it manually.
**********************************************************************
* Cadence Core Driver for MIPI CSI Host Controller
**********************************************************************/
#ifndef CSITX_IF_H
#define CSITX_IF_H

/* parasoft-begin-suppress MISRA2012-RULE-1_1_a_c90-2 "C90 - limits, DRV-3906" */
/* parasoft-begin-suppress MISRA2012-RULE-1_1_b_c90-2 "C90 - limits, DRV-3906" */


/**********************************************************************
* Defines
**********************************************************************/
#define CSITX_BPP_YUV_420_8_LEGACY (1.5)

#define CSITX_BPP_YUV_420_8 (1U)

#define CSITX_BPP_YUV_420_10 (1.25)

#define CSITX_BPP_YUV422_8 (2U)

#define CSITX_BPP_YUV422_10 (2.5)

#define CSITX_BPP_RGB888 (3U)

#define CSITX_BPP_RGB666 (2.25)

#define CSITX_BPP_RGB565 (2U)

#define CSITX_BPP_RGB555 (2U)

#define CSITX_BPP_RGB444 (2U)

#define CSITX_MAGIC_NUMBER 0x50250300U

/**********************************************************************
* Forward declarations
**********************************************************************/
typedef struct CSITX_Config_s CSITX_Config;
typedef struct CSITX_DeviceConfig_s CSITX_DeviceConfig;
typedef struct CSITX_SysReq_s CSITX_SysReq;
typedef struct CSITX_DphyConfig1_s CSITX_DphyConfig1;
typedef struct CSITX_DphyConfig_s CSITX_DphyConfig;
typedef struct CSITX_DataTypeConfig_s CSITX_DataTypeConfig;
typedef struct CSITX_VirtualChannelConfig_s CSITX_VirtualChannelConfig;
typedef struct CSITX_WaitBurstTimeConfig_s CSITX_WaitBurstTimeConfig;
typedef struct CSITX_StreamConfig_s CSITX_StreamConfig;
typedef struct CSITX_RxCompatibilityConfig_s CSITX_RxCompatibilityConfig;
typedef struct CSITX_EpdConfig_s CSITX_EpdConfig;
typedef struct CSITX_Callbacks_s CSITX_Callbacks;
typedef struct CSITX_AsfInfo_s CSITX_AsfInfo;

typedef struct CSITX_PrivateData_s CSITX_PrivateData;

/**********************************************************************
* Enumerations
**********************************************************************/
typedef enum
{
    CSITX_DPHY_LANE_0 = 0x1U,
    CSITX_DPHY_LANE_1 = 0x2U,
    CSITX_DPHY_LANE_2 = 0x4U,
    CSITX_DPHY_LANE_3 = 0x8U
} CSITX_DataLane;

typedef enum
{
    CSITX_DPHY_ULP_MODE = 0x0U,
    CSITX_DPHY_HS_MODE = 0x1U,
    CSITX_DPHY_STOP_MODE = 0x2U
} CSITX_DphyMode;

typedef enum
{
    CSITX_DPHY_CLOCK_CONT = 0x0U,
    CSITX_DPHY_CLOCK_NON_CONT = 0x1U
} CSITX_DphyClockMode;

typedef enum
{
    CSITX_PIXEL_IF0 = 0U,
    CSITX_PIXEL_IF1 = 1U,
    CSITX_PIXEL_IF2 = 2U,
    CSITX_PIXEL_IF3 = 3U
} CSITX_IfNumber;

typedef enum
{
    CSITX_VC0 = 0U,
    CSITX_VC1 = 1U,
    CSITX_VC2 = 2U,
    CSITX_VC3 = 3U,
    CSITX_VC4 = 4U,
    CSITX_VC5 = 5U,
    CSITX_VC6 = 6U,
    CSITX_VC7 = 7U,
    CSITX_VC8 = 8U,
    CSITX_VC9 = 9U,
    CSITX_VC10 = 10U,
    CSITX_VC11 = 11U,
    CSITX_VC12 = 12U,
    CSITX_VC13 = 13U,
    CSITX_VC14 = 14U,
    CSITX_VC15 = 15U
} CSITX_VcNumber;

typedef enum
{
    CSITX_DT0 = 0U,
    CSITX_DT1 = 1U,
    CSITX_DT2 = 2U,
    CSITX_DT3 = 3U,
    CSITX_DT4 = 4U,
    CSITX_DT5 = 5U,
    CSITX_DT6 = 6U,
    CSITX_DT7 = 7U,
    CSITX_DT8 = 8U,
    CSITX_DT9 = 9U,
    CSITX_DT10 = 10U,
    CSITX_DT11 = 11U,
    CSITX_DT12 = 12U,
    CSITX_DT13 = 13U,
    CSITX_DT14 = 14U,
    CSITX_DT15 = 15U
} CSITX_DtNumber;

typedef enum
{
    CSITX_DFC_YUV_420_8_LEGACY = 0x1AU,
    CSITX_DFC_YUV_420_8 = 0x18U,
    CSITX_DFC_YUV_420_10 = 0x19U,
    CSITX_DFC_YUV_420_8_CSPS = 0x1CU,
    CSITX_DFC_YUV_420_10_CSPS = 0x1DU,
    CSITX_DFC_YUV422_8 = 0x1EU,
    CSITX_DFC_PACKED_YUV422_8 = 0x5EU,
    CSITX_DFC_YUV422_10 = 0x1FU,
    CSITX_DFC_RGB888 = 0x24U,
    CSITX_DFC_RGB666 = 0x23U,
    CSITX_DFC_RGB565 = 0x22U,
    CSITX_DFC_RGB555 = 0x21U,
    CSITX_DFC_RGB444 = 0x20U,
    CSITX_DFC_RAW6 = 0x28U,
    CSITX_DFC_RAW7 = 0x29U,
    CSITX_DFC_RAW8 = 0x2AU,
    CSITX_DFC_RAW8_DUAL_PIXEL = 0x6AU,
    CSITX_DFC_RAW10 = 0x2BU,
    CSITX_DFC_RAW12 = 0x2CU,
    CSITX_DFC_RAW14 = 0x2DU,
    CSITX_DFC_GENERIC_8BIT_NULL = 0x10U,
    CSITX_DFC_GENERIC_8BIT_BLANKING = 0x11U,
    CSITX_DFC_GENERIC_8BIT_EMBED = 0x12U,
    CSITX_DFC_USER_DEFINED = 0x30U
} CSITX_DataFormatCode;

/**********************************************************************
* Callbacks
**********************************************************************/
typedef void (*CSITX_Event)(CSITX_PrivateData* pD, uint32_t irq_event, uint32_t dphy_event);

/**********************************************************************
* API methods
**********************************************************************/

uint32_t CSITX_Probe(const CSITX_Config* config, CSITX_SysReq* memReq);

uint32_t CSITX_Init(CSITX_PrivateData* pD, const CSITX_Config* config, const CSITX_Callbacks* callbacks);

void CSITX_Isr(CSITX_PrivateData* pD);

void CSITX_Start(CSITX_PrivateData* pD);

void CSITX_Stop(CSITX_PrivateData* pD);

void CSITX_Destroy(void);

uint32_t CSITX_SetConfigurationMode(CSITX_PrivateData* pD, uint32_t enable);

uint32_t CSITX_GetConfigurationMode(CSITX_PrivateData* pD, uint32_t* enable);

uint32_t CSITX_SetDphyConfig(CSITX_PrivateData* pD, const CSITX_DphyConfig* config);

uint32_t CSITX_GetDphyConfig(CSITX_PrivateData* pD, CSITX_DphyConfig* config);

uint32_t CSITX_SetDphyConfig1(CSITX_PrivateData* pD, const CSITX_DphyConfig1* config);

uint32_t CSITX_GetDphyConfig1(CSITX_PrivateData* pD, CSITX_DphyConfig1* config);

uint32_t CSITX_SetVirtualChannelConfig(const CSITX_PrivateData* pD, const CSITX_VirtualChannelConfig* config, CSITX_VcNumber number);

uint32_t CSITX_GetVirtualChannelConfig(const CSITX_PrivateData* pD, CSITX_VirtualChannelConfig* config, CSITX_VcNumber number);

uint32_t CSITX_SetDataTypeConfig(const CSITX_PrivateData* pD, const CSITX_DataTypeConfig* config, CSITX_DtNumber number);

uint32_t CSITX_GetDataTypeConfig(const CSITX_PrivateData* pD, CSITX_DataTypeConfig* config, CSITX_DtNumber number);

uint32_t CSITX_SetStreamConfig(const CSITX_PrivateData* pD, const CSITX_StreamConfig* config, CSITX_IfNumber number);

uint32_t CSITX_GetStreamConfig(const CSITX_PrivateData* pD, CSITX_StreamConfig* config, CSITX_IfNumber number);

uint32_t CSITX_SetBypassModeEnable(CSITX_PrivateData* pD, bool enable);

uint32_t CSITX_GetBypassModeEnable(CSITX_PrivateData* pD, bool* enable);

uint32_t CSITX_SetSoftResetRequest(CSITX_PrivateData* pD, bool enable);

uint32_t CSITX_GetSoftResetRequest(CSITX_PrivateData* pD, bool* enable);

uint32_t CSITX_SetInterruptsEnable(CSITX_PrivateData* pD, bool enable);

uint32_t CSITX_GetInterruptsEnable(CSITX_PrivateData* pD, bool* enable);

uint32_t CSITX_GetStatusRegister(CSITX_PrivateData* pD, uint32_t* value);

uint32_t CSITX_GetDphyStatusRegister(CSITX_PrivateData* pD, uint32_t* value);

uint32_t CSITX_SetRegWaitBurstTime(CSITX_PrivateData* pD, CSITX_WaitBurstTimeConfig* config);

uint32_t CSITX_GetRegWaitBurstTime(CSITX_PrivateData* pD, CSITX_WaitBurstTimeConfig* config);

uint32_t CSITX_SetDphyClkWakeup(CSITX_PrivateData* pD, uint16_t value);

uint32_t CSITX_GetDphyClkWakeup(CSITX_PrivateData* pD, uint16_t* value);

uint32_t CSITX_SetDphyUlpsWakeup(CSITX_PrivateData* pD, uint16_t value);

uint32_t CSITX_GetDphyUlpsWakeup(CSITX_PrivateData* pD, uint16_t* value);

uint32_t CSITX_SetDebugEnable(CSITX_PrivateData* pD, bool enable);

uint32_t CSITX_GetDebugEnable(CSITX_PrivateData* pD, bool* enable);

uint32_t CSITX_GetDebugProtFsm(CSITX_PrivateData* pD, uint32_t* value, CSITX_IfNumber number);

uint32_t CSITX_GetDebugLnFsm(CSITX_PrivateData* pD, uint32_t* value);

uint32_t CSITX_GetDebugClkLnFsm(CSITX_PrivateData* pD, uint32_t* value);

uint32_t CSITX_GetDebugDataLnFsm(CSITX_PrivateData* pD, uint32_t* value);

uint32_t CSITX_SetTestGenericCtrl(CSITX_PrivateData* pD, uint16_t value);

uint32_t CSITX_GetTestGenericCtrl(CSITX_PrivateData* pD, uint16_t* value);

uint32_t CSITX_GetTestGenericStatus(CSITX_PrivateData* pD, uint16_t* value);

uint32_t CSITX_GetAsfInfo(const CSITX_PrivateData* pD, CSITX_AsfInfo* asfInfo);

uint32_t CSITX_GetDeviceConfig(const CSITX_PrivateData* pD, CSITX_DeviceConfig* value);

uint32_t CSITX_SetEpdConfig(CSITX_PrivateData* pD, const CSITX_EpdConfig* config);

uint32_t CSITX_GetEpdConfig(CSITX_PrivateData* pD, CSITX_EpdConfig* config);

uint32_t CSITX_SetScramblerMode(CSITX_PrivateData* pD, bool enable);

uint32_t CSITX_GetScramblerMode(CSITX_PrivateData* pD, bool* enable);

uint32_t CSITX_SetRxCompatibility(CSITX_PrivateData* pD, CSITX_RxCompatibilityConfig* config);

uint32_t CSITX_GetRxCompatibility(CSITX_PrivateData* pD, CSITX_RxCompatibilityConfig* config);

/* parasoft-end-suppress MISRA2012-RULE-1_1_b_c90-2 */
/* parasoft-end-suppress MISRA2012-RULE-1_1_a_c90-2 */

#endif  /* CSITX_IF_H */