1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * drivers/media/i2c/ccs-pll.h 4 * 5 * Generic MIPI CCS/SMIA/SMIA++ PLL calculator 6 * 7 * Copyright (C) 2020 Intel Corporation 8 * Copyright (C) 2012 Nokia Corporation 9 * Contact: Sakari Ailus <sakari.ailus@linux.intel.com> 10 */ 11 12 #ifndef CCS_PLL_H 13 #define CCS_PLL_H 14 15 #include <linux/bits.h> 16 17 /* CSI-2 or CCP-2 */ 18 #define CCS_PLL_BUS_TYPE_CSI2_DPHY 0x00 19 #define CCS_PLL_BUS_TYPE_CSI2_CPHY 0x01 20 21 /* Old SMIA and implementation specific flags */ 22 /* op pix clock is for all lanes in total normally */ 23 #define CCS_PLL_FLAG_OP_PIX_CLOCK_PER_LANE BIT(0) 24 #define CCS_PLL_FLAG_NO_OP_CLOCKS BIT(1) 25 /* CCS PLL flags */ 26 #define CCS_PLL_FLAG_LANE_SPEED_MODEL BIT(2) 27 #define CCS_PLL_FLAG_LINK_DECOUPLED BIT(3) 28 #define CCS_PLL_FLAG_EXT_IP_PLL_DIVIDER BIT(4) 29 30 /** 31 * struct ccs_pll_branch_fr - CCS PLL configuration (front) 32 * 33 * A single branch front-end of the CCS PLL tree. 34 * 35 * @pre_pll_clk_div: Pre-PLL clock divisor 36 * @pll_multiplier: PLL multiplier 37 * @pll_ip_clk_freq_hz: PLL input clock frequency 38 * @pll_op_clk_freq_hz: PLL output clock frequency 39 */ 40 struct ccs_pll_branch_fr { 41 uint16_t pre_pll_clk_div; 42 uint16_t pll_multiplier; 43 uint32_t pll_ip_clk_freq_hz; 44 uint32_t pll_op_clk_freq_hz; 45 }; 46 47 /** 48 * struct ccs_pll_branch_bk - CCS PLL configuration (back) 49 * 50 * A single branch back-end of the CCS PLL tree. 51 * 52 * @sys_clk_div: System clock divider 53 * @pix_clk_div: Pixel clock divider 54 * @sys_clk_freq_hz: System clock frequency 55 * @pix_clk_freq_hz: Pixel clock frequency 56 */ 57 struct ccs_pll_branch_bk { 58 uint16_t sys_clk_div; 59 uint16_t pix_clk_div; 60 uint32_t sys_clk_freq_hz; 61 uint32_t pix_clk_freq_hz; 62 }; 63 64 /** 65 * struct ccs_pll - Full CCS PLL configuration 66 * 67 * All information required to calculate CCS PLL configuration. 68 * 69 * @bus_type: Type of the data bus, CCS_PLL_BUS_TYPE_* (input) 70 * @op_lanes: Number of operational lanes (input) 71 * @vt_lanes: Number of video timing lanes (input) 72 * @csi2: CSI-2 related parameters 73 * @csi2.lanes: The number of the CSI-2 data lanes (input) 74 * @binning_vertical: Vertical binning factor (input) 75 * @binning_horizontal: Horizontal binning factor (input) 76 * @scale_m: Downscaling factor, M component, [16, max] (input) 77 * @scale_n: Downscaling factor, N component, typically 16 (input) 78 * @bits_per_pixel: Bits per pixel on the output data bus (input) 79 * @op_bits_per_lane: Number of bits per OP lane (input) 80 * @flags: CCS_PLL_FLAG_* (input) 81 * @link_freq: Chosen link frequency (input) 82 * @ext_clk_freq_hz: External clock frequency, i.e. the sensor's input clock 83 * (input) 84 * @vt_fr: Video timing front-end configuration (output) 85 * @vt_bk: Video timing back-end configuration (output) 86 * @op_bk: Operational timing back-end configuration (output) 87 * @pixel_rate_csi: Pixel rate on the output data bus (output) 88 * @pixel_rate_pixel_array: Nominal pixel rate in the sensor's pixel array 89 * (output) 90 */ 91 struct ccs_pll { 92 /* input values */ 93 uint8_t bus_type; 94 uint8_t op_lanes; 95 uint8_t vt_lanes; 96 struct { 97 uint8_t lanes; 98 } csi2; 99 uint8_t binning_horizontal; 100 uint8_t binning_vertical; 101 uint8_t scale_m; 102 uint8_t scale_n; 103 uint8_t bits_per_pixel; 104 uint8_t op_bits_per_lane; 105 uint16_t flags; 106 uint32_t link_freq; 107 uint32_t ext_clk_freq_hz; 108 109 /* output values */ 110 struct ccs_pll_branch_fr vt_fr; 111 struct ccs_pll_branch_bk vt_bk; 112 struct ccs_pll_branch_bk op_bk; 113 114 uint32_t pixel_rate_csi; 115 uint32_t pixel_rate_pixel_array; 116 }; 117 118 /** 119 * struct ccs_pll_branch_limits_fr - CCS PLL front-end limits 120 * 121 * @min_pre_pll_clk_div: Minimum pre-PLL clock divider 122 * @max_pre_pll_clk_div: Maximum pre-PLL clock divider 123 * @min_pll_ip_clk_freq_hz: Minimum PLL input clock frequency 124 * @max_pll_ip_clk_freq_hz: Maximum PLL input clock frequency 125 * @min_pll_multiplier: Minimum PLL multiplier 126 * @max_pll_multiplier: Maximum PLL multiplier 127 * @min_pll_op_clk_freq_hz: Minimum PLL output clock frequency 128 * @max_pll_op_clk_freq_hz: Maximum PLL output clock frequency 129 */ 130 struct ccs_pll_branch_limits_fr { 131 uint16_t min_pre_pll_clk_div; 132 uint16_t max_pre_pll_clk_div; 133 uint32_t min_pll_ip_clk_freq_hz; 134 uint32_t max_pll_ip_clk_freq_hz; 135 uint16_t min_pll_multiplier; 136 uint16_t max_pll_multiplier; 137 uint32_t min_pll_op_clk_freq_hz; 138 uint32_t max_pll_op_clk_freq_hz; 139 }; 140 141 /** 142 * struct ccs_pll_branch_limits_bk - CCS PLL back-end limits 143 * 144 * @min_sys_clk_div: Minimum system clock divider 145 * @max_sys_clk_div: Maximum system clock divider 146 * @min_sys_clk_freq_hz: Minimum system clock frequency 147 * @max_sys_clk_freq_hz: Maximum system clock frequency 148 * @min_pix_clk_div: Minimum pixel clock divider 149 * @max_pix_clk_div: Maximum pixel clock divider 150 * @min_pix_clk_freq_hz: Minimum pixel clock frequency 151 * @max_pix_clk_freq_hz: Maximum pixel clock frequency 152 */ 153 struct ccs_pll_branch_limits_bk { 154 uint16_t min_sys_clk_div; 155 uint16_t max_sys_clk_div; 156 uint32_t min_sys_clk_freq_hz; 157 uint32_t max_sys_clk_freq_hz; 158 uint16_t min_pix_clk_div; 159 uint16_t max_pix_clk_div; 160 uint32_t min_pix_clk_freq_hz; 161 uint32_t max_pix_clk_freq_hz; 162 }; 163 164 /** 165 * struct ccs_pll_limits - CCS PLL limits 166 * 167 * @min_ext_clk_freq_hz: Minimum external clock frequency 168 * @max_ext_clk_freq_hz: Maximum external clock frequency 169 * @vt_fr: Video timing front-end limits 170 * @vt_bk: Video timing back-end limits 171 * @op_bk: Operational timing back-end limits 172 * @min_line_length_pck_bin: Minimum line length in pixels, with binning 173 * @min_line_length_pck: Minimum line length in pixels without binning 174 */ 175 struct ccs_pll_limits { 176 /* Strict PLL limits */ 177 uint32_t min_ext_clk_freq_hz; 178 uint32_t max_ext_clk_freq_hz; 179 180 struct ccs_pll_branch_limits_fr vt_fr; 181 struct ccs_pll_branch_limits_bk vt_bk; 182 struct ccs_pll_branch_limits_bk op_bk; 183 184 /* Other relevant limits */ 185 uint32_t min_line_length_pck_bin; 186 uint32_t min_line_length_pck; 187 }; 188 189 struct device; 190 191 /** 192 * ccs_pll_calculate - Calculate CCS PLL configuration based on input parameters 193 * 194 * @dev: Device pointer, used for printing messages 195 * @limits: Limits specific to the sensor 196 * @pll: Given PLL configuration 197 * 198 * Calculate the CCS PLL configuration based on the limits as well as given 199 * device specific, system specific or user configured input data. 200 */ 201 int ccs_pll_calculate(struct device *dev, const struct ccs_pll_limits *limits, 202 struct ccs_pll *pll); 203 204 #endif /* CCS_PLL_H */ 205