csitx_soc.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_SOC_H_
#define CSITX_SOC_H_

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

/* None */

#ifdef __cplusplus
extern "C" {
#endif

/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
#define CSITX_INSTANCE_ID_0               ((uint32_t) 0x0U)

#define CSITX_INSTANCE_ID_MAX             ((uint32_t)CSITX_INSTANCE_ID_0 + 1U)
/* @} */

#define CSITX_NUM_STRMS_TX                       ((uint32_t) 1U)

#define CSITX_NUM_STRMS_COLORBAR                 ((uint32_t) 1U)

#define CSITX_NUM_STRMS_LPBK                     ((uint32_t) 2U)

#define CSITX_NUM_CH_TX                          ((uint32_t) 32U)

#define CSITX_NUM_CH_LPBK                        ((uint32_t) 1U)

#define CSITX_NUM_CH_TX_MAX                      ((uint32_t) (CSITX_NUM_CH_TX *\
                                                        CSITX_INSTANCE_ID_MAX))

#define CSITX_NUM_CH_COLORBAR_MAX                ((uint32_t) 1U)

#define CSITX_NUM_CH_LPBK_MAX                    ((uint32_t) (CSITX_NUM_CH_LPBK * \
                                                             CSITX_NUM_STRMS_LPBK))

#define CSITX_NUM_CH_MAX         ((uint32_t) (CSITX_NUM_CH_TX +\
                                              CSITX_NUM_CH_COLORBAR_MAX +\
                                              CSITX_NUM_CH_LPBK_MAX))

#define CSITX_TX_DATA_LANES_MAX                  ((uint32_t)4U)

#define CSITX_TX_CLK_LANES_MAX                   ((uint32_t)1U)

#define CSITX_TX_VC_CFG_MAX                      ((uint32_t)16U)

#define CSITX_TX_DT_CFG_MAX                      ((uint32_t)16U)

#define CSITX_TX_STRM_NUM_MAX                    ((uint32_t)4U)

#define CSITX_TX_STRM_FIFO_FILL_LVL              ((uint32_t)960U)

#define CSITX_NUM_STRMS_TX_ID                    ((uint32_t) 0U)

#define CSITX_NUM_STRMS_TX_COLORBAR              ((uint32_t) 1U)

#define CSITX_NUM_STRMS_TX_RETRANS_0             ((uint32_t) 2U)

#define CSITX_NUM_STRMS_TX_RETRANS_1             ((uint32_t) 3U)
/* @} */

#define CSITX_LANE_BAND_SPEED_80_TO_100_MBPS              ((uint32_t) 0x00U)

#define CSITX_LANE_BAND_SPEED_100_TO_120_MBPS             ((uint32_t) 0x01U)

#define CSITX_LANE_BAND_SPEED_120_TO_160_MBPS             ((uint32_t) 0x02U)

#define CSITX_LANE_BAND_SPEED_160_TO_200_MBPS             ((uint32_t) 0x03U)

#define CSITX_LANE_BAND_SPEED_200_TO_240_MBPS             ((uint32_t) 0x04U)

#define CSITX_LANE_BAND_SPEED_240_TO_320_MBPS             ((uint32_t) 0x05U)

#define CSITX_LANE_BAND_SPEED_320_TO_390_MBPS             ((uint32_t) 0x06U)

#define CSITX_LANE_BAND_SPEED_390_TO_450_MBPS             ((uint32_t) 0x07U)

#define CSITX_LANE_BAND_SPEED_450_TO_510_MBPS             ((uint32_t) 0x08U)

#define CSITX_LANE_BAND_SPEED_510_TO_560_MBPS             ((uint32_t) 0x09U)

#define CSITX_LANE_BAND_SPEED_560_TO_640_MBPS             ((uint32_t) 0x0AU)

#define CSITX_LANE_BAND_SPEED_640_TO_690_MBPS             ((uint32_t) 0x0BU)

#define CSITX_LANE_BAND_SPEED_690_TO_770_MBPS             ((uint32_t) 0x0CU)

#define CSITX_LANE_BAND_SPEED_770_TO_870_MBPS             ((uint32_t) 0x0DU)

#define CSITX_LANE_BAND_SPEED_870_TO_950_MBPS             ((uint32_t) 0x0EU)

#define CSITX_LANE_BAND_SPEED_950_TO_1000_MBPS            ((uint32_t) 0x0FU)

#define CSITX_LANE_BAND_SPEED_1000_TO_1200_MBPS           ((uint32_t) 0x10U)

#define CSITX_LANE_BAND_SPEED_1200_TO_1400_MBPS           ((uint32_t) 0x11U)

#define CSITX_LANE_BAND_SPEED_1400_TO_1600_MBPS           ((uint32_t) 0x12U)

#define CSITX_LANE_BAND_SPEED_1600_TO_1800_MBPS           ((uint32_t) 0x13U)

#define CSITX_LANE_BAND_SPEED_1800_TO_2000_MBPS           ((uint32_t) 0x14U)

#define CSITX_LANE_BAND_SPEED_2000_TO_2200_MBPS           ((uint32_t) 0x15U)

#define CSITX_LANE_BAND_SPEED_2200_TO_2500_MBPS           ((uint32_t) 0x16U)

#define CSITX_LANE_BAND_SPEED_RESERVED                    ((uint32_t) 0x17U)
/* @} */

#define CSITX_CLK_MODE_CONTINUOUS                         ((uint32_t) 0x0U)

#define CSITX_CLK_MODE_NON_CONTINUOUS                     ((uint32_t) 0x1U)
/* @} */

#define CSITX_DPHY_MODE_ULP                               ((uint32_t) 0x0U)

#define CSITX_DPHY_MODE_HIGH_SPEED                        ((uint32_t) 0x1U)

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

#define CSITX_NUM_STREAM                             (1U)

#if defined (BUILD_MCU2_0) || defined (BUILD_MCU2_1)

#define CSITX_CORE_INTR_NUM_MOD_0_TX_INTR                (267U)

#define CSITX_CORE_INTR_NUM_MOD_0_LVL_INTR               (268U)
#endif
#if defined (BUILD_MPU1_0)

#define CSITX_CORE_INTR_NUM_MOD_0_TX_INTR                (180U)

#define CSITX_CORE_INTR_NUM_MOD_0_LVL_INTR               (181U)
#endif
/* @} */

#define CSITX_STREAM_ID_INST_0_STRM_0                      ((uint32_t) 0x0U)

#define CSITX_STREAM_ID_INST_0_STRM_1                      ((uint32_t) 0x1U)

#define CSITX_STREAM_ID_INST_0_STRM_2                      ((uint32_t) 0x2U)

#define CSITX_STREAM_ID_INST_0_STRM_3                      ((uint32_t) 0x3U)
/* @} */
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
typedef struct
{
    uint32_t inst;
    uint32_t psmClkFreqDiv;
    uint32_t pllByteClkDiv;
    uint32_t pwmCtrlDivLow;
    uint32_t pwmCtrlDivHigh;
    uint32_t pllLockThreshold;
    uint32_t pllLockStart;
    uint32_t pllIpDiv;
    uint32_t pllOpDiv;
    uint32_t pllFbDiv;
    uint32_t pllPd;
    uint32_t laneBandSpeed;
    uint32_t waitBurstTime;
    uint32_t txClkExitTime;
    uint32_t dlWkupTime;
    uint32_t clWkupTime;
    uint32_t clkMode;
    uint32_t dphyMode;
    uint32_t clSlewRateCtrl;
    uint32_t dlSlewRateCtrl;
    uint32_t laneSpeedMbps;
} Csitx_DPhyCfg;

/* ========================================================================== */
/*                            Global Variables                                */
/* ========================================================================== */

/* None */

/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
void Csitx_initDPhyCfgParams(Csitx_DPhyCfg *dphyCfg);
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */

/* None */

#ifdef __cplusplus
}
#endif

#endif /* #ifndef CSITX_SOC_H_ */

/* @} */