xref: /dragonfly/sys/dev/drm/i915/intel_dsi_pll.c (revision 0d27ae55)
1 /*
2  * Copyright © 2013 Intel Corporation
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice (including the next
12  * paragraph) shall be included in all copies or substantial portions of the
13  * Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21  * DEALINGS IN THE SOFTWARE.
22  *
23  * Authors:
24  *	Shobhit Kumar <shobhit.kumar@intel.com>
25  *	Yogesh Mohan Marimuthu <yogesh.mohan.marimuthu@intel.com>
26  */
27 
28 #include <linux/kernel.h>
29 #include "intel_drv.h"
30 #include "i915_drv.h"
31 #include "intel_dsi.h"
32 
33 #define DSI_HSS_PACKET_SIZE		4
34 #define DSI_HSE_PACKET_SIZE		4
35 #define DSI_HSA_PACKET_EXTRA_SIZE	6
36 #define DSI_HBP_PACKET_EXTRA_SIZE	6
37 #define DSI_HACTIVE_PACKET_EXTRA_SIZE	6
38 #define DSI_HFP_PACKET_EXTRA_SIZE	6
39 #define DSI_EOTP_PACKET_SIZE		4
40 
41 struct dsi_mnp {
42 	u32 dsi_pll_ctrl;
43 	u32 dsi_pll_div;
44 };
45 
46 static const u32 lfsr_converts[] = {
47 	426, 469, 234, 373, 442, 221, 110, 311, 411,		/* 62 - 70 */
48 	461, 486, 243, 377, 188, 350, 175, 343, 427, 213,	/* 71 - 80 */
49 	106, 53, 282, 397, 354, 227, 113, 56, 284, 142,		/* 81 - 90 */
50 	71, 35							/* 91 - 92 */
51 };
52 
53 #ifdef DSI_CLK_FROM_RR
54 
55 static u32 dsi_rr_formula(const struct drm_display_mode *mode,
56 			  int pixel_format, int video_mode_format,
57 			  int lane_count, bool eotp)
58 {
59 	u32 bpp;
60 	u32 hactive, vactive, hfp, hsync, hbp, vfp, vsync, vbp;
61 	u32 hsync_bytes, hbp_bytes, hactive_bytes, hfp_bytes;
62 	u32 bytes_per_line, bytes_per_frame;
63 	u32 num_frames;
64 	u32 bytes_per_x_frames, bytes_per_x_frames_x_lanes;
65 	u32 dsi_bit_clock_hz;
66 	u32 dsi_clk;
67 
68 	switch (pixel_format) {
69 	default:
70 	case VID_MODE_FORMAT_RGB888:
71 	case VID_MODE_FORMAT_RGB666_LOOSE:
72 		bpp = 24;
73 		break;
74 	case VID_MODE_FORMAT_RGB666:
75 		bpp = 18;
76 		break;
77 	case VID_MODE_FORMAT_RGB565:
78 		bpp = 16;
79 		break;
80 	}
81 
82 	hactive = mode->hdisplay;
83 	vactive = mode->vdisplay;
84 	hfp = mode->hsync_start - mode->hdisplay;
85 	hsync = mode->hsync_end - mode->hsync_start;
86 	hbp = mode->htotal - mode->hsync_end;
87 
88 	vfp = mode->vsync_start - mode->vdisplay;
89 	vsync = mode->vsync_end - mode->vsync_start;
90 	vbp = mode->vtotal - mode->vsync_end;
91 
92 	hsync_bytes = DIV_ROUND_UP(hsync * bpp, 8);
93 	hbp_bytes = DIV_ROUND_UP(hbp * bpp, 8);
94 	hactive_bytes = DIV_ROUND_UP(hactive * bpp, 8);
95 	hfp_bytes = DIV_ROUND_UP(hfp * bpp, 8);
96 
97 	bytes_per_line = DSI_HSS_PACKET_SIZE + hsync_bytes +
98 		DSI_HSA_PACKET_EXTRA_SIZE + DSI_HSE_PACKET_SIZE +
99 		hbp_bytes + DSI_HBP_PACKET_EXTRA_SIZE +
100 		hactive_bytes + DSI_HACTIVE_PACKET_EXTRA_SIZE +
101 		hfp_bytes + DSI_HFP_PACKET_EXTRA_SIZE;
102 
103 	/*
104 	 * XXX: Need to accurately calculate LP to HS transition timeout and add
105 	 * it to bytes_per_line/bytes_per_frame.
106 	 */
107 
108 	if (eotp && video_mode_format == VIDEO_MODE_BURST)
109 		bytes_per_line += DSI_EOTP_PACKET_SIZE;
110 
111 	bytes_per_frame = vsync * bytes_per_line + vbp * bytes_per_line +
112 		vactive * bytes_per_line + vfp * bytes_per_line;
113 
114 	if (eotp &&
115 	    (video_mode_format == VIDEO_MODE_NON_BURST_WITH_SYNC_PULSE ||
116 	     video_mode_format == VIDEO_MODE_NON_BURST_WITH_SYNC_EVENTS))
117 		bytes_per_frame += DSI_EOTP_PACKET_SIZE;
118 
119 	num_frames = drm_mode_vrefresh(mode);
120 	bytes_per_x_frames = num_frames * bytes_per_frame;
121 
122 	bytes_per_x_frames_x_lanes = bytes_per_x_frames / lane_count;
123 
124 	/* the dsi clock is divided by 2 in the hardware to get dsi ddr clock */
125 	dsi_bit_clock_hz = bytes_per_x_frames_x_lanes * 8;
126 	dsi_clk = dsi_bit_clock_hz / 1000;
127 
128 	if (eotp && video_mode_format == VIDEO_MODE_BURST)
129 		dsi_clk *= 2;
130 
131 	return dsi_clk;
132 }
133 
134 #else
135 
136 /* Get DSI clock from pixel clock */
137 static u32 dsi_clk_from_pclk(u32 pclk, int pixel_format, int lane_count)
138 {
139 	u32 dsi_clk_khz;
140 	u32 bpp;
141 
142 	switch (pixel_format) {
143 	default:
144 	case VID_MODE_FORMAT_RGB888:
145 	case VID_MODE_FORMAT_RGB666_LOOSE:
146 		bpp = 24;
147 		break;
148 	case VID_MODE_FORMAT_RGB666:
149 		bpp = 18;
150 		break;
151 	case VID_MODE_FORMAT_RGB565:
152 		bpp = 16;
153 		break;
154 	}
155 
156 	/* DSI data rate = pixel clock * bits per pixel / lane count
157 	   pixel clock is converted from KHz to Hz */
158 	dsi_clk_khz = DIV_ROUND_CLOSEST(pclk * bpp, lane_count);
159 
160 	return dsi_clk_khz;
161 }
162 
163 #endif
164 
165 static int dsi_calc_mnp(int target_dsi_clk, struct dsi_mnp *dsi_mnp)
166 {
167 	unsigned int calc_m = 0, calc_p = 0;
168 	unsigned int m, n = 1, p;
169 	int ref_clk = 25000;
170 	int delta = target_dsi_clk;
171 	u32 m_seed;
172 
173 	/* target_dsi_clk is expected in kHz */
174 	if (target_dsi_clk < 300000 || target_dsi_clk > 1150000) {
175 		DRM_ERROR("DSI CLK Out of Range\n");
176 		return -ECHRNG;
177 	}
178 
179 	for (m = 62; m <= 92 && delta; m++) {
180 		for (p = 2; p <= 6 && delta; p++) {
181 			/*
182 			 * Find the optimal m and p divisors with minimal delta
183 			 * +/- the required clock
184 			 */
185 			int calc_dsi_clk = (m * ref_clk) / (p * n);
186 			int d = abs(target_dsi_clk - calc_dsi_clk);
187 			if (d < delta) {
188 				delta = d;
189 				calc_m = m;
190 				calc_p = p;
191 			}
192 		}
193 	}
194 
195 	/* register has log2(N1), this works fine for powers of two */
196 	n = ffs(n) - 1;
197 	m_seed = lfsr_converts[calc_m - 62];
198 	dsi_mnp->dsi_pll_ctrl = 1 << (DSI_PLL_P1_POST_DIV_SHIFT + calc_p - 2);
199 	dsi_mnp->dsi_pll_div = n << DSI_PLL_N1_DIV_SHIFT |
200 		m_seed << DSI_PLL_M1_DIV_SHIFT;
201 
202 	return 0;
203 }
204 
205 /*
206  * XXX: The muxing and gating is hard coded for now. Need to add support for
207  * sharing PLLs with two DSI outputs.
208  */
209 static void vlv_configure_dsi_pll(struct intel_encoder *encoder)
210 {
211 	struct drm_i915_private *dev_priv = encoder->base.dev->dev_private;
212 	struct intel_dsi *intel_dsi = enc_to_intel_dsi(&encoder->base);
213 	int ret;
214 	struct dsi_mnp dsi_mnp;
215 	u32 dsi_clk;
216 
217 	dsi_clk = dsi_clk_from_pclk(intel_dsi->pclk, intel_dsi->pixel_format,
218 				    intel_dsi->lane_count);
219 
220 	ret = dsi_calc_mnp(dsi_clk, &dsi_mnp);
221 	if (ret) {
222 		DRM_DEBUG_KMS("dsi_calc_mnp failed\n");
223 		return;
224 	}
225 
226 	if (intel_dsi->ports & (1 << PORT_A))
227 		dsi_mnp.dsi_pll_ctrl |= DSI_PLL_CLK_GATE_DSI0_DSIPLL;
228 
229 	if (intel_dsi->ports & (1 << PORT_C))
230 		dsi_mnp.dsi_pll_ctrl |= DSI_PLL_CLK_GATE_DSI1_DSIPLL;
231 
232 	DRM_DEBUG_KMS("dsi pll div %08x, ctrl %08x\n",
233 		      dsi_mnp.dsi_pll_div, dsi_mnp.dsi_pll_ctrl);
234 
235 	vlv_cck_write(dev_priv, CCK_REG_DSI_PLL_CONTROL, 0);
236 	vlv_cck_write(dev_priv, CCK_REG_DSI_PLL_DIVIDER, dsi_mnp.dsi_pll_div);
237 	vlv_cck_write(dev_priv, CCK_REG_DSI_PLL_CONTROL, dsi_mnp.dsi_pll_ctrl);
238 }
239 
240 void vlv_enable_dsi_pll(struct intel_encoder *encoder)
241 {
242 	struct drm_i915_private *dev_priv = encoder->base.dev->dev_private;
243 	u32 tmp;
244 
245 	DRM_DEBUG_KMS("\n");
246 
247 	mutex_lock(&dev_priv->sb_lock);
248 
249 	vlv_configure_dsi_pll(encoder);
250 
251 	/* wait at least 0.5 us after ungating before enabling VCO */
252 	usleep_range(1, 10);
253 
254 	tmp = vlv_cck_read(dev_priv, CCK_REG_DSI_PLL_CONTROL);
255 	tmp |= DSI_PLL_VCO_EN;
256 	vlv_cck_write(dev_priv, CCK_REG_DSI_PLL_CONTROL, tmp);
257 
258 	if (wait_for(vlv_cck_read(dev_priv, CCK_REG_DSI_PLL_CONTROL) &
259 						DSI_PLL_LOCK, 20)) {
260 
261 		mutex_unlock(&dev_priv->sb_lock);
262 		DRM_ERROR("DSI PLL lock failed\n");
263 		return;
264 	}
265 	mutex_unlock(&dev_priv->sb_lock);
266 
267 	DRM_DEBUG_KMS("DSI PLL locked\n");
268 }
269 
270 void vlv_disable_dsi_pll(struct intel_encoder *encoder)
271 {
272 	struct drm_i915_private *dev_priv = encoder->base.dev->dev_private;
273 	u32 tmp;
274 
275 	DRM_DEBUG_KMS("\n");
276 
277 	mutex_lock(&dev_priv->sb_lock);
278 
279 	tmp = vlv_cck_read(dev_priv, CCK_REG_DSI_PLL_CONTROL);
280 	tmp &= ~DSI_PLL_VCO_EN;
281 	tmp |= DSI_PLL_LDO_GATE;
282 	vlv_cck_write(dev_priv, CCK_REG_DSI_PLL_CONTROL, tmp);
283 
284 	mutex_unlock(&dev_priv->sb_lock);
285 }
286 
287 static void assert_bpp_mismatch(int pixel_format, int pipe_bpp)
288 {
289 	int bpp;
290 
291 	switch (pixel_format) {
292 	default:
293 	case VID_MODE_FORMAT_RGB888:
294 	case VID_MODE_FORMAT_RGB666_LOOSE:
295 		bpp = 24;
296 		break;
297 	case VID_MODE_FORMAT_RGB666:
298 		bpp = 18;
299 		break;
300 	case VID_MODE_FORMAT_RGB565:
301 		bpp = 16;
302 		break;
303 	}
304 
305 	WARN(bpp != pipe_bpp,
306 	     "bpp match assertion failure (expected %d, current %d)\n",
307 	     bpp, pipe_bpp);
308 }
309 
310 u32 vlv_get_dsi_pclk(struct intel_encoder *encoder, int pipe_bpp)
311 {
312 	struct drm_i915_private *dev_priv = encoder->base.dev->dev_private;
313 	struct intel_dsi *intel_dsi = enc_to_intel_dsi(&encoder->base);
314 	u32 dsi_clock, pclk;
315 	u32 pll_ctl, pll_div;
316 	u32 m = 0, p = 0, n;
317 	int refclk = 25000;
318 	int i;
319 
320 	DRM_DEBUG_KMS("\n");
321 
322 	mutex_lock(&dev_priv->sb_lock);
323 	pll_ctl = vlv_cck_read(dev_priv, CCK_REG_DSI_PLL_CONTROL);
324 	pll_div = vlv_cck_read(dev_priv, CCK_REG_DSI_PLL_DIVIDER);
325 	mutex_unlock(&dev_priv->sb_lock);
326 
327 	/* mask out other bits and extract the P1 divisor */
328 	pll_ctl &= DSI_PLL_P1_POST_DIV_MASK;
329 	pll_ctl = pll_ctl >> (DSI_PLL_P1_POST_DIV_SHIFT - 2);
330 
331 	/* N1 divisor */
332 	n = (pll_div & DSI_PLL_N1_DIV_MASK) >> DSI_PLL_N1_DIV_SHIFT;
333 	n = 1 << n; /* register has log2(N1) */
334 
335 	/* mask out the other bits and extract the M1 divisor */
336 	pll_div &= DSI_PLL_M1_DIV_MASK;
337 	pll_div = pll_div >> DSI_PLL_M1_DIV_SHIFT;
338 
339 	while (pll_ctl) {
340 		pll_ctl = pll_ctl >> 1;
341 		p++;
342 	}
343 	p--;
344 
345 	if (!p) {
346 		DRM_ERROR("wrong P1 divisor\n");
347 		return 0;
348 	}
349 
350 	for (i = 0; i < ARRAY_SIZE(lfsr_converts); i++) {
351 		if (lfsr_converts[i] == pll_div)
352 			break;
353 	}
354 
355 	if (i == ARRAY_SIZE(lfsr_converts)) {
356 		DRM_ERROR("wrong m_seed programmed\n");
357 		return 0;
358 	}
359 
360 	m = i + 62;
361 
362 	dsi_clock = (m * refclk) / (p * n);
363 
364 	/* pixel_format and pipe_bpp should agree */
365 	assert_bpp_mismatch(intel_dsi->pixel_format, pipe_bpp);
366 
367 	pclk = DIV_ROUND_CLOSEST(dsi_clock * intel_dsi->lane_count, pipe_bpp);
368 
369 	return pclk;
370 }
371