1 /*
2  * Copyright © 2008-2015 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 DEALINGS
21  * IN THE SOFTWARE.
22  */
23 
24 #include "i915_drv.h"
25 #include "intel_display_types.h"
26 #include "intel_dp.h"
27 #include "intel_dp_link_training.h"
28 
29 static void intel_dp_reset_lttpr_common_caps(struct intel_dp *intel_dp)
30 {
31 	memset(intel_dp->lttpr_common_caps, 0, sizeof(intel_dp->lttpr_common_caps));
32 }
33 
34 static void intel_dp_reset_lttpr_count(struct intel_dp *intel_dp)
35 {
36 	intel_dp->lttpr_common_caps[DP_PHY_REPEATER_CNT -
37 				    DP_LT_TUNABLE_PHY_REPEATER_FIELD_DATA_STRUCTURE_REV] = 0;
38 }
39 
40 static const char *intel_dp_phy_name(enum drm_dp_phy dp_phy,
41 				     char *buf, size_t buf_size)
42 {
43 	if (dp_phy == DP_PHY_DPRX)
44 		snprintf(buf, buf_size, "DPRX");
45 	else
46 		snprintf(buf, buf_size, "LTTPR %d", dp_phy - DP_PHY_LTTPR1 + 1);
47 
48 	return buf;
49 }
50 
51 static u8 *intel_dp_lttpr_phy_caps(struct intel_dp *intel_dp,
52 				   enum drm_dp_phy dp_phy)
53 {
54 	return intel_dp->lttpr_phy_caps[dp_phy - DP_PHY_LTTPR1];
55 }
56 
57 static void intel_dp_read_lttpr_phy_caps(struct intel_dp *intel_dp,
58 					 const u8 dpcd[DP_RECEIVER_CAP_SIZE],
59 					 enum drm_dp_phy dp_phy)
60 {
61 	struct intel_encoder *encoder = &dp_to_dig_port(intel_dp)->base;
62 	u8 *phy_caps = intel_dp_lttpr_phy_caps(intel_dp, dp_phy);
63 	char phy_name[10];
64 
65 	intel_dp_phy_name(dp_phy, phy_name, sizeof(phy_name));
66 
67 	if (drm_dp_read_lttpr_phy_caps(&intel_dp->aux, dpcd, dp_phy, phy_caps) < 0) {
68 		drm_dbg_kms(&dp_to_i915(intel_dp)->drm,
69 			    "[ENCODER:%d:%s][%s] failed to read the PHY caps\n",
70 			    encoder->base.base.id, encoder->base.name, phy_name);
71 		return;
72 	}
73 
74 	drm_dbg_kms(&dp_to_i915(intel_dp)->drm,
75 		    "[ENCODER:%d:%s][%s] PHY capabilities: %*ph\n",
76 		    encoder->base.base.id, encoder->base.name, phy_name,
77 		    (int)sizeof(intel_dp->lttpr_phy_caps[0]),
78 		    phy_caps);
79 }
80 
81 static bool intel_dp_read_lttpr_common_caps(struct intel_dp *intel_dp,
82 					    const u8 dpcd[DP_RECEIVER_CAP_SIZE])
83 {
84 	struct intel_encoder *encoder = &dp_to_dig_port(intel_dp)->base;
85 	int ret;
86 
87 	ret = drm_dp_read_lttpr_common_caps(&intel_dp->aux, dpcd,
88 					    intel_dp->lttpr_common_caps);
89 	if (ret < 0)
90 		goto reset_caps;
91 
92 	drm_dbg_kms(&dp_to_i915(intel_dp)->drm,
93 		    "[ENCODER:%d:%s] LTTPR common capabilities: %*ph\n",
94 		    encoder->base.base.id, encoder->base.name,
95 		    (int)sizeof(intel_dp->lttpr_common_caps),
96 		    intel_dp->lttpr_common_caps);
97 
98 	/* The minimum value of LT_TUNABLE_PHY_REPEATER_FIELD_DATA_STRUCTURE_REV is 1.4 */
99 	if (intel_dp->lttpr_common_caps[0] < 0x14)
100 		goto reset_caps;
101 
102 	return true;
103 
104 reset_caps:
105 	intel_dp_reset_lttpr_common_caps(intel_dp);
106 	return false;
107 }
108 
109 static bool
110 intel_dp_set_lttpr_transparent_mode(struct intel_dp *intel_dp, bool enable)
111 {
112 	u8 val = enable ? DP_PHY_REPEATER_MODE_TRANSPARENT :
113 			  DP_PHY_REPEATER_MODE_NON_TRANSPARENT;
114 
115 	return drm_dp_dpcd_write(&intel_dp->aux, DP_PHY_REPEATER_MODE, &val, 1) == 1;
116 }
117 
118 static int intel_dp_init_lttpr(struct intel_dp *intel_dp, const u8 dpcd[DP_RECEIVER_CAP_SIZE])
119 {
120 	struct intel_encoder *encoder = &dp_to_dig_port(intel_dp)->base;
121 	struct drm_i915_private *i915 = to_i915(encoder->base.dev);
122 	int lttpr_count;
123 	int i;
124 
125 	if (!intel_dp_read_lttpr_common_caps(intel_dp, dpcd))
126 		return 0;
127 
128 	lttpr_count = drm_dp_lttpr_count(intel_dp->lttpr_common_caps);
129 	/*
130 	 * Prevent setting LTTPR transparent mode explicitly if no LTTPRs are
131 	 * detected as this breaks link training at least on the Dell WD19TB
132 	 * dock.
133 	 */
134 	if (lttpr_count == 0)
135 		return 0;
136 
137 	/*
138 	 * See DP Standard v2.0 3.6.6.1. about the explicit disabling of
139 	 * non-transparent mode and the disable->enable non-transparent mode
140 	 * sequence.
141 	 */
142 	intel_dp_set_lttpr_transparent_mode(intel_dp, true);
143 
144 	/*
145 	 * In case of unsupported number of LTTPRs or failing to switch to
146 	 * non-transparent mode fall-back to transparent link training mode,
147 	 * still taking into account any LTTPR common lane- rate/count limits.
148 	 */
149 	if (lttpr_count < 0)
150 		return 0;
151 
152 	if (!intel_dp_set_lttpr_transparent_mode(intel_dp, false)) {
153 		drm_dbg_kms(&i915->drm,
154 			    "[ENCODER:%d:%s] Switching to LTTPR non-transparent LT mode failed, fall-back to transparent mode\n",
155 			    encoder->base.base.id, encoder->base.name);
156 
157 		intel_dp_set_lttpr_transparent_mode(intel_dp, true);
158 		intel_dp_reset_lttpr_count(intel_dp);
159 
160 		return 0;
161 	}
162 
163 	for (i = 0; i < lttpr_count; i++)
164 		intel_dp_read_lttpr_phy_caps(intel_dp, dpcd, DP_PHY_LTTPR(i));
165 
166 	return lttpr_count;
167 }
168 
169 /**
170  * intel_dp_init_lttpr_and_dprx_caps - detect LTTPR and DPRX caps, init the LTTPR link training mode
171  * @intel_dp: Intel DP struct
172  *
173  * Read the LTTPR common and DPRX capabilities and switch to non-transparent
174  * link training mode if any is detected and read the PHY capabilities for all
175  * detected LTTPRs. In case of an LTTPR detection error or if the number of
176  * LTTPRs is more than is supported (8), fall back to the no-LTTPR,
177  * transparent mode link training mode.
178  *
179  * Returns:
180  *   >0  if LTTPRs were detected and the non-transparent LT mode was set. The
181  *       DPRX capabilities are read out.
182  *    0  if no LTTPRs or more than 8 LTTPRs were detected or in case of a
183  *       detection failure and the transparent LT mode was set. The DPRX
184  *       capabilities are read out.
185  *   <0  Reading out the DPRX capabilities failed.
186  */
187 int intel_dp_init_lttpr_and_dprx_caps(struct intel_dp *intel_dp)
188 {
189 	struct drm_i915_private *i915 = dp_to_i915(intel_dp);
190 	int lttpr_count = 0;
191 
192 	/*
193 	 * Detecting LTTPRs must be avoided on platforms with an AUX timeout
194 	 * period < 3.2ms. (see DP Standard v2.0, 2.11.2, 3.6.6.1).
195 	 */
196 	if (!intel_dp_is_edp(intel_dp) &&
197 	    (DISPLAY_VER(i915) >= 10 && !IS_GEMINILAKE(i915))) {
198 		u8 dpcd[DP_RECEIVER_CAP_SIZE];
199 
200 		if (drm_dp_dpcd_probe(&intel_dp->aux, DP_LT_TUNABLE_PHY_REPEATER_FIELD_DATA_STRUCTURE_REV))
201 			return -EIO;
202 
203 		if (drm_dp_read_dpcd_caps(&intel_dp->aux, dpcd))
204 			return -EIO;
205 
206 		lttpr_count = intel_dp_init_lttpr(intel_dp, dpcd);
207 	}
208 
209 	/*
210 	 * The DPTX shall read the DPRX caps after LTTPR detection, so re-read
211 	 * it here.
212 	 */
213 	if (drm_dp_read_dpcd_caps(&intel_dp->aux, intel_dp->dpcd)) {
214 		intel_dp_reset_lttpr_common_caps(intel_dp);
215 		return -EIO;
216 	}
217 
218 	return lttpr_count;
219 }
220 
221 static u8 dp_voltage_max(u8 preemph)
222 {
223 	switch (preemph & DP_TRAIN_PRE_EMPHASIS_MASK) {
224 	case DP_TRAIN_PRE_EMPH_LEVEL_0:
225 		return DP_TRAIN_VOLTAGE_SWING_LEVEL_3;
226 	case DP_TRAIN_PRE_EMPH_LEVEL_1:
227 		return DP_TRAIN_VOLTAGE_SWING_LEVEL_2;
228 	case DP_TRAIN_PRE_EMPH_LEVEL_2:
229 		return DP_TRAIN_VOLTAGE_SWING_LEVEL_1;
230 	case DP_TRAIN_PRE_EMPH_LEVEL_3:
231 	default:
232 		return DP_TRAIN_VOLTAGE_SWING_LEVEL_0;
233 	}
234 }
235 
236 static u8 intel_dp_lttpr_voltage_max(struct intel_dp *intel_dp,
237 				     enum drm_dp_phy dp_phy)
238 {
239 	const u8 *phy_caps = intel_dp_lttpr_phy_caps(intel_dp, dp_phy);
240 
241 	if (drm_dp_lttpr_voltage_swing_level_3_supported(phy_caps))
242 		return DP_TRAIN_VOLTAGE_SWING_LEVEL_3;
243 	else
244 		return DP_TRAIN_VOLTAGE_SWING_LEVEL_2;
245 }
246 
247 static u8 intel_dp_lttpr_preemph_max(struct intel_dp *intel_dp,
248 				     enum drm_dp_phy dp_phy)
249 {
250 	const u8 *phy_caps = intel_dp_lttpr_phy_caps(intel_dp, dp_phy);
251 
252 	if (drm_dp_lttpr_pre_emphasis_level_3_supported(phy_caps))
253 		return DP_TRAIN_PRE_EMPH_LEVEL_3;
254 	else
255 		return DP_TRAIN_PRE_EMPH_LEVEL_2;
256 }
257 
258 static bool
259 intel_dp_phy_is_downstream_of_source(struct intel_dp *intel_dp,
260 				     enum drm_dp_phy dp_phy)
261 {
262 	struct drm_i915_private *i915 = dp_to_i915(intel_dp);
263 	int lttpr_count = drm_dp_lttpr_count(intel_dp->lttpr_common_caps);
264 
265 	drm_WARN_ON_ONCE(&i915->drm, lttpr_count <= 0 && dp_phy != DP_PHY_DPRX);
266 
267 	return lttpr_count <= 0 || dp_phy == DP_PHY_LTTPR(lttpr_count - 1);
268 }
269 
270 static u8 intel_dp_phy_voltage_max(struct intel_dp *intel_dp,
271 				   const struct intel_crtc_state *crtc_state,
272 				   enum drm_dp_phy dp_phy)
273 {
274 	struct drm_i915_private *i915 = dp_to_i915(intel_dp);
275 	u8 voltage_max;
276 
277 	/*
278 	 * Get voltage_max from the DPTX_PHY (source or LTTPR) upstream from
279 	 * the DPRX_PHY we train.
280 	 */
281 	if (intel_dp_phy_is_downstream_of_source(intel_dp, dp_phy))
282 		voltage_max = intel_dp->voltage_max(intel_dp, crtc_state);
283 	else
284 		voltage_max = intel_dp_lttpr_voltage_max(intel_dp, dp_phy + 1);
285 
286 	drm_WARN_ON_ONCE(&i915->drm,
287 			 voltage_max != DP_TRAIN_VOLTAGE_SWING_LEVEL_2 &&
288 			 voltage_max != DP_TRAIN_VOLTAGE_SWING_LEVEL_3);
289 
290 	return voltage_max;
291 }
292 
293 static u8 intel_dp_phy_preemph_max(struct intel_dp *intel_dp,
294 				   enum drm_dp_phy dp_phy)
295 {
296 	struct drm_i915_private *i915 = dp_to_i915(intel_dp);
297 	u8 preemph_max;
298 
299 	/*
300 	 * Get preemph_max from the DPTX_PHY (source or LTTPR) upstream from
301 	 * the DPRX_PHY we train.
302 	 */
303 	if (intel_dp_phy_is_downstream_of_source(intel_dp, dp_phy))
304 		preemph_max = intel_dp->preemph_max(intel_dp);
305 	else
306 		preemph_max = intel_dp_lttpr_preemph_max(intel_dp, dp_phy + 1);
307 
308 	drm_WARN_ON_ONCE(&i915->drm,
309 			 preemph_max != DP_TRAIN_PRE_EMPH_LEVEL_2 &&
310 			 preemph_max != DP_TRAIN_PRE_EMPH_LEVEL_3);
311 
312 	return preemph_max;
313 }
314 
315 static bool has_per_lane_signal_levels(struct intel_dp *intel_dp,
316 				       enum drm_dp_phy dp_phy)
317 {
318 	struct drm_i915_private *i915 = dp_to_i915(intel_dp);
319 
320 	return !intel_dp_phy_is_downstream_of_source(intel_dp, dp_phy) ||
321 		DISPLAY_VER(i915) >= 11;
322 }
323 
324 /* 128b/132b */
325 static u8 intel_dp_get_lane_adjust_tx_ffe_preset(struct intel_dp *intel_dp,
326 						 const struct intel_crtc_state *crtc_state,
327 						 enum drm_dp_phy dp_phy,
328 						 const u8 link_status[DP_LINK_STATUS_SIZE],
329 						 int lane)
330 {
331 	u8 tx_ffe = 0;
332 
333 	if (has_per_lane_signal_levels(intel_dp, dp_phy)) {
334 		lane = min(lane, crtc_state->lane_count - 1);
335 		tx_ffe = drm_dp_get_adjust_tx_ffe_preset(link_status, lane);
336 	} else {
337 		for (lane = 0; lane < crtc_state->lane_count; lane++)
338 			tx_ffe = max(tx_ffe, drm_dp_get_adjust_tx_ffe_preset(link_status, lane));
339 	}
340 
341 	return tx_ffe;
342 }
343 
344 /* 8b/10b */
345 static u8 intel_dp_get_lane_adjust_vswing_preemph(struct intel_dp *intel_dp,
346 						  const struct intel_crtc_state *crtc_state,
347 						  enum drm_dp_phy dp_phy,
348 						  const u8 link_status[DP_LINK_STATUS_SIZE],
349 						  int lane)
350 {
351 	u8 v = 0;
352 	u8 p = 0;
353 	u8 voltage_max;
354 	u8 preemph_max;
355 
356 	if (has_per_lane_signal_levels(intel_dp, dp_phy)) {
357 		lane = min(lane, crtc_state->lane_count - 1);
358 
359 		v = drm_dp_get_adjust_request_voltage(link_status, lane);
360 		p = drm_dp_get_adjust_request_pre_emphasis(link_status, lane);
361 	} else {
362 		for (lane = 0; lane < crtc_state->lane_count; lane++) {
363 			v = max(v, drm_dp_get_adjust_request_voltage(link_status, lane));
364 			p = max(p, drm_dp_get_adjust_request_pre_emphasis(link_status, lane));
365 		}
366 	}
367 
368 	preemph_max = intel_dp_phy_preemph_max(intel_dp, dp_phy);
369 	if (p >= preemph_max)
370 		p = preemph_max | DP_TRAIN_MAX_PRE_EMPHASIS_REACHED;
371 
372 	v = min(v, dp_voltage_max(p));
373 
374 	voltage_max = intel_dp_phy_voltage_max(intel_dp, crtc_state, dp_phy);
375 	if (v >= voltage_max)
376 		v = voltage_max | DP_TRAIN_MAX_SWING_REACHED;
377 
378 	return v | p;
379 }
380 
381 static u8 intel_dp_get_lane_adjust_train(struct intel_dp *intel_dp,
382 					 const struct intel_crtc_state *crtc_state,
383 					 enum drm_dp_phy dp_phy,
384 					 const u8 link_status[DP_LINK_STATUS_SIZE],
385 					 int lane)
386 {
387 	if (intel_dp_is_uhbr(crtc_state))
388 		return intel_dp_get_lane_adjust_tx_ffe_preset(intel_dp, crtc_state,
389 							      dp_phy, link_status, lane);
390 	else
391 		return intel_dp_get_lane_adjust_vswing_preemph(intel_dp, crtc_state,
392 							       dp_phy, link_status, lane);
393 }
394 
395 #define TRAIN_REQ_FMT "%d/%d/%d/%d"
396 #define _TRAIN_REQ_VSWING_ARGS(link_status, lane) \
397 	(drm_dp_get_adjust_request_voltage((link_status), (lane)) >> DP_TRAIN_VOLTAGE_SWING_SHIFT)
398 #define TRAIN_REQ_VSWING_ARGS(link_status) \
399 	_TRAIN_REQ_VSWING_ARGS(link_status, 0), \
400 	_TRAIN_REQ_VSWING_ARGS(link_status, 1), \
401 	_TRAIN_REQ_VSWING_ARGS(link_status, 2), \
402 	_TRAIN_REQ_VSWING_ARGS(link_status, 3)
403 #define _TRAIN_REQ_PREEMPH_ARGS(link_status, lane) \
404 	(drm_dp_get_adjust_request_pre_emphasis((link_status), (lane)) >> DP_TRAIN_PRE_EMPHASIS_SHIFT)
405 #define TRAIN_REQ_PREEMPH_ARGS(link_status) \
406 	_TRAIN_REQ_PREEMPH_ARGS(link_status, 0), \
407 	_TRAIN_REQ_PREEMPH_ARGS(link_status, 1), \
408 	_TRAIN_REQ_PREEMPH_ARGS(link_status, 2), \
409 	_TRAIN_REQ_PREEMPH_ARGS(link_status, 3)
410 #define _TRAIN_REQ_TX_FFE_ARGS(link_status, lane) \
411 	drm_dp_get_adjust_tx_ffe_preset((link_status), (lane))
412 #define TRAIN_REQ_TX_FFE_ARGS(link_status) \
413 	_TRAIN_REQ_TX_FFE_ARGS(link_status, 0), \
414 	_TRAIN_REQ_TX_FFE_ARGS(link_status, 1), \
415 	_TRAIN_REQ_TX_FFE_ARGS(link_status, 2), \
416 	_TRAIN_REQ_TX_FFE_ARGS(link_status, 3)
417 
418 void
419 intel_dp_get_adjust_train(struct intel_dp *intel_dp,
420 			  const struct intel_crtc_state *crtc_state,
421 			  enum drm_dp_phy dp_phy,
422 			  const u8 link_status[DP_LINK_STATUS_SIZE])
423 {
424 	struct intel_encoder *encoder = &dp_to_dig_port(intel_dp)->base;
425 	struct drm_i915_private *i915 = to_i915(encoder->base.dev);
426 	char phy_name[10];
427 	int lane;
428 
429 	if (intel_dp_is_uhbr(crtc_state)) {
430 		drm_dbg_kms(&i915->drm, "[ENCODER:%d:%s][%s] 128b/132b, lanes: %d, "
431 			    "TX FFE request: " TRAIN_REQ_FMT "\n",
432 			    encoder->base.base.id, encoder->base.name,
433 			    intel_dp_phy_name(dp_phy, phy_name, sizeof(phy_name)),
434 			    crtc_state->lane_count,
435 			    TRAIN_REQ_TX_FFE_ARGS(link_status));
436 	} else {
437 		drm_dbg_kms(&i915->drm, "[ENCODER:%d:%s][%s] 8b/10b, lanes: %d, "
438 			    "vswing request: " TRAIN_REQ_FMT ", "
439 			    "pre-emphasis request: " TRAIN_REQ_FMT "\n",
440 			    encoder->base.base.id, encoder->base.name,
441 			    intel_dp_phy_name(dp_phy, phy_name, sizeof(phy_name)),
442 			    crtc_state->lane_count,
443 			    TRAIN_REQ_VSWING_ARGS(link_status),
444 			    TRAIN_REQ_PREEMPH_ARGS(link_status));
445 	}
446 
447 	for (lane = 0; lane < 4; lane++)
448 		intel_dp->train_set[lane] =
449 			intel_dp_get_lane_adjust_train(intel_dp, crtc_state,
450 						       dp_phy, link_status, lane);
451 }
452 
453 static int intel_dp_training_pattern_set_reg(struct intel_dp *intel_dp,
454 					     enum drm_dp_phy dp_phy)
455 {
456 	return dp_phy == DP_PHY_DPRX ?
457 		DP_TRAINING_PATTERN_SET :
458 		DP_TRAINING_PATTERN_SET_PHY_REPEATER(dp_phy);
459 }
460 
461 static bool
462 intel_dp_set_link_train(struct intel_dp *intel_dp,
463 			const struct intel_crtc_state *crtc_state,
464 			enum drm_dp_phy dp_phy,
465 			u8 dp_train_pat)
466 {
467 	int reg = intel_dp_training_pattern_set_reg(intel_dp, dp_phy);
468 	u8 buf[sizeof(intel_dp->train_set) + 1];
469 	int len;
470 
471 	intel_dp_program_link_training_pattern(intel_dp, crtc_state,
472 					       dp_phy, dp_train_pat);
473 
474 	buf[0] = dp_train_pat;
475 	/* DP_TRAINING_LANEx_SET follow DP_TRAINING_PATTERN_SET */
476 	memcpy(buf + 1, intel_dp->train_set, crtc_state->lane_count);
477 	len = crtc_state->lane_count + 1;
478 
479 	return drm_dp_dpcd_write(&intel_dp->aux, reg, buf, len) == len;
480 }
481 
482 static char dp_training_pattern_name(u8 train_pat)
483 {
484 	switch (train_pat) {
485 	case DP_TRAINING_PATTERN_1:
486 	case DP_TRAINING_PATTERN_2:
487 	case DP_TRAINING_PATTERN_3:
488 		return '0' + train_pat;
489 	case DP_TRAINING_PATTERN_4:
490 		return '4';
491 	default:
492 		MISSING_CASE(train_pat);
493 		return '?';
494 	}
495 }
496 
497 void
498 intel_dp_program_link_training_pattern(struct intel_dp *intel_dp,
499 				       const struct intel_crtc_state *crtc_state,
500 				       enum drm_dp_phy dp_phy,
501 				       u8 dp_train_pat)
502 {
503 	struct intel_encoder *encoder = &dp_to_dig_port(intel_dp)->base;
504 	struct drm_i915_private *i915 = to_i915(encoder->base.dev);
505 	u8 train_pat = intel_dp_training_pattern_symbol(dp_train_pat);
506 	char phy_name[10];
507 
508 	if (train_pat != DP_TRAINING_PATTERN_DISABLE)
509 		drm_dbg_kms(&i915->drm,
510 			    "[ENCODER:%d:%s][%s] Using DP training pattern TPS%c\n",
511 			    encoder->base.base.id, encoder->base.name,
512 			    intel_dp_phy_name(dp_phy, phy_name, sizeof(phy_name)),
513 			    dp_training_pattern_name(train_pat));
514 
515 	intel_dp->set_link_train(intel_dp, crtc_state, dp_train_pat);
516 }
517 
518 #define TRAIN_SET_FMT "%d%s/%d%s/%d%s/%d%s"
519 #define _TRAIN_SET_VSWING_ARGS(train_set) \
520 	((train_set) & DP_TRAIN_VOLTAGE_SWING_MASK) >> DP_TRAIN_VOLTAGE_SWING_SHIFT, \
521 	(train_set) & DP_TRAIN_MAX_SWING_REACHED ? "(max)" : ""
522 #define TRAIN_SET_VSWING_ARGS(train_set) \
523 	_TRAIN_SET_VSWING_ARGS((train_set)[0]), \
524 	_TRAIN_SET_VSWING_ARGS((train_set)[1]), \
525 	_TRAIN_SET_VSWING_ARGS((train_set)[2]), \
526 	_TRAIN_SET_VSWING_ARGS((train_set)[3])
527 #define _TRAIN_SET_PREEMPH_ARGS(train_set) \
528 	((train_set) & DP_TRAIN_PRE_EMPHASIS_MASK) >> DP_TRAIN_PRE_EMPHASIS_SHIFT, \
529 	(train_set) & DP_TRAIN_MAX_PRE_EMPHASIS_REACHED ? "(max)" : ""
530 #define TRAIN_SET_PREEMPH_ARGS(train_set) \
531 	_TRAIN_SET_PREEMPH_ARGS((train_set)[0]), \
532 	_TRAIN_SET_PREEMPH_ARGS((train_set)[1]), \
533 	_TRAIN_SET_PREEMPH_ARGS((train_set)[2]), \
534 	_TRAIN_SET_PREEMPH_ARGS((train_set)[3])
535 #define _TRAIN_SET_TX_FFE_ARGS(train_set) \
536 	((train_set) & DP_TX_FFE_PRESET_VALUE_MASK), ""
537 #define TRAIN_SET_TX_FFE_ARGS(train_set) \
538 	_TRAIN_SET_TX_FFE_ARGS((train_set)[0]), \
539 	_TRAIN_SET_TX_FFE_ARGS((train_set)[1]), \
540 	_TRAIN_SET_TX_FFE_ARGS((train_set)[2]), \
541 	_TRAIN_SET_TX_FFE_ARGS((train_set)[3])
542 
543 void intel_dp_set_signal_levels(struct intel_dp *intel_dp,
544 				const struct intel_crtc_state *crtc_state,
545 				enum drm_dp_phy dp_phy)
546 {
547 	struct intel_encoder *encoder = &dp_to_dig_port(intel_dp)->base;
548 	struct drm_i915_private *i915 = to_i915(encoder->base.dev);
549 	char phy_name[10];
550 
551 	if (intel_dp_is_uhbr(crtc_state)) {
552 		drm_dbg_kms(&i915->drm, "[ENCODER:%d:%s][%s] 128b/132b, lanes: %d, "
553 			    "TX FFE presets: " TRAIN_SET_FMT "\n",
554 			    encoder->base.base.id, encoder->base.name,
555 			    intel_dp_phy_name(dp_phy, phy_name, sizeof(phy_name)),
556 			    crtc_state->lane_count,
557 			    TRAIN_SET_TX_FFE_ARGS(intel_dp->train_set));
558 	} else {
559 		drm_dbg_kms(&i915->drm, "[ENCODER:%d:%s][%s] 8b/10b, lanes: %d, "
560 			    "vswing levels: " TRAIN_SET_FMT ", "
561 			    "pre-emphasis levels: " TRAIN_SET_FMT "\n",
562 			    encoder->base.base.id, encoder->base.name,
563 			    intel_dp_phy_name(dp_phy, phy_name, sizeof(phy_name)),
564 			    crtc_state->lane_count,
565 			    TRAIN_SET_VSWING_ARGS(intel_dp->train_set),
566 			    TRAIN_SET_PREEMPH_ARGS(intel_dp->train_set));
567 	}
568 
569 	if (intel_dp_phy_is_downstream_of_source(intel_dp, dp_phy))
570 		encoder->set_signal_levels(encoder, crtc_state);
571 }
572 
573 static bool
574 intel_dp_reset_link_train(struct intel_dp *intel_dp,
575 			  const struct intel_crtc_state *crtc_state,
576 			  enum drm_dp_phy dp_phy,
577 			  u8 dp_train_pat)
578 {
579 	memset(intel_dp->train_set, 0, sizeof(intel_dp->train_set));
580 	intel_dp_set_signal_levels(intel_dp, crtc_state, dp_phy);
581 	return intel_dp_set_link_train(intel_dp, crtc_state, dp_phy, dp_train_pat);
582 }
583 
584 static bool
585 intel_dp_update_link_train(struct intel_dp *intel_dp,
586 			   const struct intel_crtc_state *crtc_state,
587 			   enum drm_dp_phy dp_phy)
588 {
589 	int reg = dp_phy == DP_PHY_DPRX ?
590 			    DP_TRAINING_LANE0_SET :
591 			    DP_TRAINING_LANE0_SET_PHY_REPEATER(dp_phy);
592 	int ret;
593 
594 	intel_dp_set_signal_levels(intel_dp, crtc_state, dp_phy);
595 
596 	ret = drm_dp_dpcd_write(&intel_dp->aux, reg,
597 				intel_dp->train_set, crtc_state->lane_count);
598 
599 	return ret == crtc_state->lane_count;
600 }
601 
602 /* 128b/132b */
603 static bool intel_dp_lane_max_tx_ffe_reached(u8 train_set_lane)
604 {
605 	return (train_set_lane & DP_TX_FFE_PRESET_VALUE_MASK) ==
606 		DP_TX_FFE_PRESET_VALUE_MASK;
607 }
608 
609 /*
610  * 8b/10b
611  *
612  * FIXME: The DP spec is very confusing here, also the Link CTS spec seems to
613  * have self contradicting tests around this area.
614  *
615  * In lieu of better ideas let's just stop when we've reached the max supported
616  * vswing with its max pre-emphasis, which is either 2+1 or 3+0 depending on
617  * whether vswing level 3 is supported or not.
618  */
619 static bool intel_dp_lane_max_vswing_reached(u8 train_set_lane)
620 {
621 	u8 v = (train_set_lane & DP_TRAIN_VOLTAGE_SWING_MASK) >>
622 		DP_TRAIN_VOLTAGE_SWING_SHIFT;
623 	u8 p = (train_set_lane & DP_TRAIN_PRE_EMPHASIS_MASK) >>
624 		DP_TRAIN_PRE_EMPHASIS_SHIFT;
625 
626 	if ((train_set_lane & DP_TRAIN_MAX_SWING_REACHED) == 0)
627 		return false;
628 
629 	if (v + p != 3)
630 		return false;
631 
632 	return true;
633 }
634 
635 static bool intel_dp_link_max_vswing_reached(struct intel_dp *intel_dp,
636 					     const struct intel_crtc_state *crtc_state)
637 {
638 	int lane;
639 
640 	for (lane = 0; lane < crtc_state->lane_count; lane++) {
641 		u8 train_set_lane = intel_dp->train_set[lane];
642 
643 		if (intel_dp_is_uhbr(crtc_state)) {
644 			if (!intel_dp_lane_max_tx_ffe_reached(train_set_lane))
645 				return false;
646 		} else {
647 			if (!intel_dp_lane_max_vswing_reached(train_set_lane))
648 				return false;
649 		}
650 	}
651 
652 	return true;
653 }
654 
655 /*
656  * Prepare link training by configuring the link parameters. On DDI platforms
657  * also enable the port here.
658  */
659 static bool
660 intel_dp_prepare_link_train(struct intel_dp *intel_dp,
661 			    const struct intel_crtc_state *crtc_state)
662 {
663 	struct intel_encoder *encoder = &dp_to_dig_port(intel_dp)->base;
664 	struct drm_i915_private *i915 = to_i915(encoder->base.dev);
665 	u8 link_config[2];
666 	u8 link_bw, rate_select;
667 
668 	if (intel_dp->prepare_link_retrain)
669 		intel_dp->prepare_link_retrain(intel_dp, crtc_state);
670 
671 	intel_dp_compute_rate(intel_dp, crtc_state->port_clock,
672 			      &link_bw, &rate_select);
673 
674 	/*
675 	 * WaEdpLinkRateDataReload
676 	 *
677 	 * Parade PS8461E MUX (used on varius TGL+ laptops) needs
678 	 * to snoop the link rates reported by the sink when we
679 	 * use LINK_RATE_SET in order to operate in jitter cleaning
680 	 * mode (as opposed to redriver mode). Unfortunately it
681 	 * loses track of the snooped link rates when powered down,
682 	 * so we need to make it re-snoop often. Without this high
683 	 * link rates are not stable.
684 	 */
685 	if (!link_bw) {
686 		struct intel_connector *connector = intel_dp->attached_connector;
687 		__le16 sink_rates[DP_MAX_SUPPORTED_RATES];
688 
689 		drm_dbg_kms(&i915->drm, "[CONNECTOR:%d:%s] Reloading eDP link rates\n",
690 			    connector->base.base.id, connector->base.name);
691 
692 		drm_dp_dpcd_read(&intel_dp->aux, DP_SUPPORTED_LINK_RATES,
693 				 sink_rates, sizeof(sink_rates));
694 	}
695 
696 	if (link_bw)
697 		drm_dbg_kms(&i915->drm,
698 			    "[ENCODER:%d:%s] Using LINK_BW_SET value %02x\n",
699 			    encoder->base.base.id, encoder->base.name, link_bw);
700 	else
701 		drm_dbg_kms(&i915->drm,
702 			    "[ENCODER:%d:%s] Using LINK_RATE_SET value %02x\n",
703 			    encoder->base.base.id, encoder->base.name, rate_select);
704 
705 	/* Write the link configuration data */
706 	link_config[0] = link_bw;
707 	link_config[1] = crtc_state->lane_count;
708 	if (drm_dp_enhanced_frame_cap(intel_dp->dpcd))
709 		link_config[1] |= DP_LANE_COUNT_ENHANCED_FRAME_EN;
710 	drm_dp_dpcd_write(&intel_dp->aux, DP_LINK_BW_SET, link_config, 2);
711 
712 	/* eDP 1.4 rate select method. */
713 	if (!link_bw)
714 		drm_dp_dpcd_write(&intel_dp->aux, DP_LINK_RATE_SET,
715 				  &rate_select, 1);
716 
717 	link_config[0] = crtc_state->vrr.enable ? DP_MSA_TIMING_PAR_IGNORE_EN : 0;
718 	link_config[1] = intel_dp_is_uhbr(crtc_state) ?
719 		DP_SET_ANSI_128B132B : DP_SET_ANSI_8B10B;
720 	drm_dp_dpcd_write(&intel_dp->aux, DP_DOWNSPREAD_CTRL, link_config, 2);
721 
722 	return true;
723 }
724 
725 static bool intel_dp_adjust_request_changed(const struct intel_crtc_state *crtc_state,
726 					    const u8 old_link_status[DP_LINK_STATUS_SIZE],
727 					    const u8 new_link_status[DP_LINK_STATUS_SIZE])
728 {
729 	int lane;
730 
731 	for (lane = 0; lane < crtc_state->lane_count; lane++) {
732 		u8 old, new;
733 
734 		if (intel_dp_is_uhbr(crtc_state)) {
735 			old = drm_dp_get_adjust_tx_ffe_preset(old_link_status, lane);
736 			new = drm_dp_get_adjust_tx_ffe_preset(new_link_status, lane);
737 		} else {
738 			old = drm_dp_get_adjust_request_voltage(old_link_status, lane) |
739 				drm_dp_get_adjust_request_pre_emphasis(old_link_status, lane);
740 			new = drm_dp_get_adjust_request_voltage(new_link_status, lane) |
741 				drm_dp_get_adjust_request_pre_emphasis(new_link_status, lane);
742 		}
743 
744 		if (old != new)
745 			return true;
746 	}
747 
748 	return false;
749 }
750 
751 void
752 intel_dp_dump_link_status(struct intel_dp *intel_dp, enum drm_dp_phy dp_phy,
753 			  const u8 link_status[DP_LINK_STATUS_SIZE])
754 {
755 	struct intel_encoder *encoder = &dp_to_dig_port(intel_dp)->base;
756 	struct drm_i915_private *i915 = to_i915(encoder->base.dev);
757 	char phy_name[10];
758 
759 	drm_dbg_kms(&i915->drm,
760 		    "[ENCODER:%d:%s][%s] ln0_1:0x%x ln2_3:0x%x align:0x%x sink:0x%x adj_req0_1:0x%x adj_req2_3:0x%x\n",
761 		    encoder->base.base.id, encoder->base.name,
762 		    intel_dp_phy_name(dp_phy, phy_name, sizeof(phy_name)),
763 		    link_status[0], link_status[1], link_status[2],
764 		    link_status[3], link_status[4], link_status[5]);
765 }
766 
767 /*
768  * Perform the link training clock recovery phase on the given DP PHY using
769  * training pattern 1.
770  */
771 static bool
772 intel_dp_link_training_clock_recovery(struct intel_dp *intel_dp,
773 				      const struct intel_crtc_state *crtc_state,
774 				      enum drm_dp_phy dp_phy)
775 {
776 	struct intel_encoder *encoder = &dp_to_dig_port(intel_dp)->base;
777 	struct drm_i915_private *i915 = to_i915(encoder->base.dev);
778 	u8 old_link_status[DP_LINK_STATUS_SIZE] = {};
779 	int voltage_tries, cr_tries, max_cr_tries;
780 	u8 link_status[DP_LINK_STATUS_SIZE];
781 	bool max_vswing_reached = false;
782 	char phy_name[10];
783 	int delay_us;
784 
785 	delay_us = drm_dp_read_clock_recovery_delay(&intel_dp->aux,
786 						    intel_dp->dpcd, dp_phy,
787 						    intel_dp_is_uhbr(crtc_state));
788 
789 	intel_dp_phy_name(dp_phy, phy_name, sizeof(phy_name));
790 
791 	/* clock recovery */
792 	if (!intel_dp_reset_link_train(intel_dp, crtc_state, dp_phy,
793 				       DP_TRAINING_PATTERN_1 |
794 				       DP_LINK_SCRAMBLING_DISABLE)) {
795 		drm_err(&i915->drm, "[ENCODER:%d:%s][%s] Failed to enable link training\n",
796 			encoder->base.base.id, encoder->base.name, phy_name);
797 		return false;
798 	}
799 
800 	/*
801 	 * The DP 1.4 spec defines the max clock recovery retries value
802 	 * as 10 but for pre-DP 1.4 devices we set a very tolerant
803 	 * retry limit of 80 (4 voltage levels x 4 preemphasis levels x
804 	 * x 5 identical voltage retries). Since the previous specs didn't
805 	 * define a limit and created the possibility of an infinite loop
806 	 * we want to prevent any sync from triggering that corner case.
807 	 */
808 	if (intel_dp->dpcd[DP_DPCD_REV] >= DP_DPCD_REV_14)
809 		max_cr_tries = 10;
810 	else
811 		max_cr_tries = 80;
812 
813 	voltage_tries = 1;
814 	for (cr_tries = 0; cr_tries < max_cr_tries; ++cr_tries) {
815 		usleep_range(delay_us, 2 * delay_us);
816 
817 		if (drm_dp_dpcd_read_phy_link_status(&intel_dp->aux, dp_phy,
818 						     link_status) < 0) {
819 			drm_err(&i915->drm, "[ENCODER:%d:%s][%s] Failed to get link status\n",
820 				encoder->base.base.id, encoder->base.name, phy_name);
821 			return false;
822 		}
823 
824 		if (drm_dp_clock_recovery_ok(link_status, crtc_state->lane_count)) {
825 			drm_dbg_kms(&i915->drm,
826 				    "[ENCODER:%d:%s][%s] Clock recovery OK\n",
827 				    encoder->base.base.id, encoder->base.name, phy_name);
828 			return true;
829 		}
830 
831 		if (voltage_tries == 5) {
832 			intel_dp_dump_link_status(intel_dp, dp_phy, link_status);
833 			drm_dbg_kms(&i915->drm,
834 				    "[ENCODER:%d:%s][%s] Same voltage tried 5 times\n",
835 				    encoder->base.base.id, encoder->base.name, phy_name);
836 			return false;
837 		}
838 
839 		if (max_vswing_reached) {
840 			intel_dp_dump_link_status(intel_dp, dp_phy, link_status);
841 			drm_dbg_kms(&i915->drm,
842 				    "[ENCODER:%d:%s][%s] Max Voltage Swing reached\n",
843 				    encoder->base.base.id, encoder->base.name, phy_name);
844 			return false;
845 		}
846 
847 		/* Update training set as requested by target */
848 		intel_dp_get_adjust_train(intel_dp, crtc_state, dp_phy,
849 					  link_status);
850 		if (!intel_dp_update_link_train(intel_dp, crtc_state, dp_phy)) {
851 			drm_err(&i915->drm,
852 				"[ENCODER:%d:%s][%s] Failed to update link training\n",
853 				encoder->base.base.id, encoder->base.name, phy_name);
854 			return false;
855 		}
856 
857 		if (!intel_dp_adjust_request_changed(crtc_state, old_link_status, link_status))
858 			++voltage_tries;
859 		else
860 			voltage_tries = 1;
861 
862 		memcpy(old_link_status, link_status, sizeof(link_status));
863 
864 		if (intel_dp_link_max_vswing_reached(intel_dp, crtc_state))
865 			max_vswing_reached = true;
866 	}
867 
868 	intel_dp_dump_link_status(intel_dp, dp_phy, link_status);
869 	drm_err(&i915->drm,
870 		"[ENCODER:%d:%s][%s] Failed clock recovery %d times, giving up!\n",
871 		encoder->base.base.id, encoder->base.name, phy_name, max_cr_tries);
872 
873 	return false;
874 }
875 
876 /*
877  * Pick Training Pattern Sequence (TPS) for channel equalization. 128b/132b TPS2
878  * for UHBR+, TPS4 for HBR3 or for 1.4 devices that support it, TPS3 for HBR2 or
879  * 1.2 devices that support it, TPS2 otherwise.
880  */
881 static u32 intel_dp_training_pattern(struct intel_dp *intel_dp,
882 				     const struct intel_crtc_state *crtc_state,
883 				     enum drm_dp_phy dp_phy)
884 {
885 	struct drm_i915_private *i915 = dp_to_i915(intel_dp);
886 	bool source_tps3, sink_tps3, source_tps4, sink_tps4;
887 
888 	/* UHBR+ use separate 128b/132b TPS2 */
889 	if (intel_dp_is_uhbr(crtc_state))
890 		return DP_TRAINING_PATTERN_2;
891 
892 	/*
893 	 * TPS4 support is mandatory for all downstream devices that
894 	 * support HBR3. There are no known eDP panels that support
895 	 * TPS4 as of Feb 2018 as per VESA eDP_v1.4b_E1 specification.
896 	 * LTTPRs must support TPS4.
897 	 */
898 	source_tps4 = intel_dp_source_supports_tps4(i915);
899 	sink_tps4 = dp_phy != DP_PHY_DPRX ||
900 		    drm_dp_tps4_supported(intel_dp->dpcd);
901 	if (source_tps4 && sink_tps4) {
902 		return DP_TRAINING_PATTERN_4;
903 	} else if (crtc_state->port_clock == 810000) {
904 		if (!source_tps4)
905 			drm_dbg_kms(&i915->drm,
906 				    "8.1 Gbps link rate without source TPS4 support\n");
907 		if (!sink_tps4)
908 			drm_dbg_kms(&i915->drm,
909 				    "8.1 Gbps link rate without sink TPS4 support\n");
910 	}
911 
912 	/*
913 	 * TPS3 support is mandatory for downstream devices that
914 	 * support HBR2. However, not all sinks follow the spec.
915 	 */
916 	source_tps3 = intel_dp_source_supports_tps3(i915);
917 	sink_tps3 = dp_phy != DP_PHY_DPRX ||
918 		    drm_dp_tps3_supported(intel_dp->dpcd);
919 	if (source_tps3 && sink_tps3) {
920 		return  DP_TRAINING_PATTERN_3;
921 	} else if (crtc_state->port_clock >= 540000) {
922 		if (!source_tps3)
923 			drm_dbg_kms(&i915->drm,
924 				    ">=5.4/6.48 Gbps link rate without source TPS3 support\n");
925 		if (!sink_tps3)
926 			drm_dbg_kms(&i915->drm,
927 				    ">=5.4/6.48 Gbps link rate without sink TPS3 support\n");
928 	}
929 
930 	return DP_TRAINING_PATTERN_2;
931 }
932 
933 /*
934  * Perform the link training channel equalization phase on the given DP PHY
935  * using one of training pattern 2, 3 or 4 depending on the source and
936  * sink capabilities.
937  */
938 static bool
939 intel_dp_link_training_channel_equalization(struct intel_dp *intel_dp,
940 					    const struct intel_crtc_state *crtc_state,
941 					    enum drm_dp_phy dp_phy)
942 {
943 	struct intel_encoder *encoder = &dp_to_dig_port(intel_dp)->base;
944 	struct drm_i915_private *i915 = to_i915(encoder->base.dev);
945 	int tries;
946 	u32 training_pattern;
947 	u8 link_status[DP_LINK_STATUS_SIZE];
948 	bool channel_eq = false;
949 	char phy_name[10];
950 	int delay_us;
951 
952 	delay_us = drm_dp_read_channel_eq_delay(&intel_dp->aux,
953 						intel_dp->dpcd, dp_phy,
954 						intel_dp_is_uhbr(crtc_state));
955 
956 	intel_dp_phy_name(dp_phy, phy_name, sizeof(phy_name));
957 
958 	training_pattern = intel_dp_training_pattern(intel_dp, crtc_state, dp_phy);
959 	/* Scrambling is disabled for TPS2/3 and enabled for TPS4 */
960 	if (training_pattern != DP_TRAINING_PATTERN_4)
961 		training_pattern |= DP_LINK_SCRAMBLING_DISABLE;
962 
963 	/* channel equalization */
964 	if (!intel_dp_set_link_train(intel_dp, crtc_state, dp_phy,
965 				     training_pattern)) {
966 		drm_err(&i915->drm,
967 			"[ENCODER:%d:%s][%s] Failed to start channel equalization\n",
968 			encoder->base.base.id, encoder->base.name,
969 			phy_name);
970 		return false;
971 	}
972 
973 	for (tries = 0; tries < 5; tries++) {
974 		usleep_range(delay_us, 2 * delay_us);
975 
976 		if (drm_dp_dpcd_read_phy_link_status(&intel_dp->aux, dp_phy,
977 						     link_status) < 0) {
978 			drm_err(&i915->drm,
979 				"[ENCODER:%d:%s][%s] Failed to get link status\n",
980 				encoder->base.base.id, encoder->base.name, phy_name);
981 			break;
982 		}
983 
984 		/* Make sure clock is still ok */
985 		if (!drm_dp_clock_recovery_ok(link_status,
986 					      crtc_state->lane_count)) {
987 			intel_dp_dump_link_status(intel_dp, dp_phy, link_status);
988 			drm_dbg_kms(&i915->drm,
989 				    "[ENCODER:%d:%s][%s] Clock recovery check failed, cannot "
990 				    "continue channel equalization\n",
991 				    encoder->base.base.id, encoder->base.name, phy_name);
992 			break;
993 		}
994 
995 		if (drm_dp_channel_eq_ok(link_status,
996 					 crtc_state->lane_count)) {
997 			channel_eq = true;
998 			drm_dbg_kms(&i915->drm,
999 				    "[ENCODER:%d:%s][%s] Channel EQ done. DP Training successful\n",
1000 				    encoder->base.base.id, encoder->base.name, phy_name);
1001 			break;
1002 		}
1003 
1004 		/* Update training set as requested by target */
1005 		intel_dp_get_adjust_train(intel_dp, crtc_state, dp_phy,
1006 					  link_status);
1007 		if (!intel_dp_update_link_train(intel_dp, crtc_state, dp_phy)) {
1008 			drm_err(&i915->drm,
1009 				"[ENCODER:%d:%s][%s] Failed to update link training\n",
1010 				encoder->base.base.id, encoder->base.name, phy_name);
1011 			break;
1012 		}
1013 	}
1014 
1015 	/* Try 5 times, else fail and try at lower BW */
1016 	if (tries == 5) {
1017 		intel_dp_dump_link_status(intel_dp, dp_phy, link_status);
1018 		drm_dbg_kms(&i915->drm,
1019 			    "[ENCODER:%d:%s][%s] Channel equalization failed 5 times\n",
1020 			    encoder->base.base.id, encoder->base.name, phy_name);
1021 	}
1022 
1023 	return channel_eq;
1024 }
1025 
1026 static bool intel_dp_disable_dpcd_training_pattern(struct intel_dp *intel_dp,
1027 						   enum drm_dp_phy dp_phy)
1028 {
1029 	int reg = intel_dp_training_pattern_set_reg(intel_dp, dp_phy);
1030 	u8 val = DP_TRAINING_PATTERN_DISABLE;
1031 
1032 	return drm_dp_dpcd_write(&intel_dp->aux, reg, &val, 1) == 1;
1033 }
1034 
1035 static int
1036 intel_dp_128b132b_intra_hop(struct intel_dp *intel_dp,
1037 			    const struct intel_crtc_state *crtc_state)
1038 {
1039 	struct drm_i915_private *i915 = dp_to_i915(intel_dp);
1040 	u8 sink_status;
1041 	int ret;
1042 
1043 	ret = drm_dp_dpcd_readb(&intel_dp->aux, DP_SINK_STATUS, &sink_status);
1044 	if (ret != 1) {
1045 		drm_dbg_kms(&i915->drm, "Failed to read sink status\n");
1046 		return ret < 0 ? ret : -EIO;
1047 	}
1048 
1049 	return sink_status & DP_INTRA_HOP_AUX_REPLY_INDICATION ? 1 : 0;
1050 }
1051 
1052 /**
1053  * intel_dp_stop_link_train - stop link training
1054  * @intel_dp: DP struct
1055  * @crtc_state: state for CRTC attached to the encoder
1056  *
1057  * Stop the link training of the @intel_dp port, disabling the training
1058  * pattern in the sink's DPCD, and disabling the test pattern symbol
1059  * generation on the port.
1060  *
1061  * What symbols are output on the port after this point is
1062  * platform specific: On DDI/VLV/CHV platforms it will be the idle pattern
1063  * with the pipe being disabled, on older platforms it's HW specific if/how an
1064  * idle pattern is generated, as the pipe is already enabled here for those.
1065  *
1066  * This function must be called after intel_dp_start_link_train().
1067  */
1068 void intel_dp_stop_link_train(struct intel_dp *intel_dp,
1069 			      const struct intel_crtc_state *crtc_state)
1070 {
1071 	struct drm_i915_private *i915 = dp_to_i915(intel_dp);
1072 	struct intel_encoder *encoder = &dp_to_dig_port(intel_dp)->base;
1073 
1074 	intel_dp->link_trained = true;
1075 
1076 	intel_dp_disable_dpcd_training_pattern(intel_dp, DP_PHY_DPRX);
1077 	intel_dp_program_link_training_pattern(intel_dp, crtc_state, DP_PHY_DPRX,
1078 					       DP_TRAINING_PATTERN_DISABLE);
1079 
1080 	if (intel_dp_is_uhbr(crtc_state) &&
1081 	    wait_for(intel_dp_128b132b_intra_hop(intel_dp, crtc_state) == 0, 500)) {
1082 		drm_dbg_kms(&i915->drm,
1083 			    "[ENCODER:%d:%s] 128b/132b intra-hop not clearing\n",
1084 			    encoder->base.base.id, encoder->base.name);
1085 	}
1086 }
1087 
1088 static bool
1089 intel_dp_link_train_phy(struct intel_dp *intel_dp,
1090 			const struct intel_crtc_state *crtc_state,
1091 			enum drm_dp_phy dp_phy)
1092 {
1093 	struct intel_connector *connector = intel_dp->attached_connector;
1094 	struct intel_encoder *encoder = &dp_to_dig_port(intel_dp)->base;
1095 	char phy_name[10];
1096 	bool ret = false;
1097 
1098 	if (!intel_dp_link_training_clock_recovery(intel_dp, crtc_state, dp_phy))
1099 		goto out;
1100 
1101 	if (!intel_dp_link_training_channel_equalization(intel_dp, crtc_state, dp_phy))
1102 		goto out;
1103 
1104 	ret = true;
1105 
1106 out:
1107 	drm_dbg_kms(&dp_to_i915(intel_dp)->drm,
1108 		    "[CONNECTOR:%d:%s][ENCODER:%d:%s][%s] Link Training %s at link rate = %d, lane count = %d\n",
1109 		    connector->base.base.id, connector->base.name,
1110 		    encoder->base.base.id, encoder->base.name,
1111 		    intel_dp_phy_name(dp_phy, phy_name, sizeof(phy_name)),
1112 		    ret ? "passed" : "failed",
1113 		    crtc_state->port_clock, crtc_state->lane_count);
1114 
1115 	return ret;
1116 }
1117 
1118 static void intel_dp_schedule_fallback_link_training(struct intel_dp *intel_dp,
1119 						     const struct intel_crtc_state *crtc_state)
1120 {
1121 	struct intel_connector *intel_connector = intel_dp->attached_connector;
1122 	struct intel_encoder *encoder = &dp_to_dig_port(intel_dp)->base;
1123 
1124 	if (intel_dp->hobl_active) {
1125 		drm_dbg_kms(&dp_to_i915(intel_dp)->drm,
1126 			    "[ENCODER:%d:%s] Link Training failed with HOBL active, "
1127 			    "not enabling it from now on",
1128 			    encoder->base.base.id, encoder->base.name);
1129 		intel_dp->hobl_failed = true;
1130 	} else if (intel_dp_get_link_train_fallback_values(intel_dp,
1131 							   crtc_state->port_clock,
1132 							   crtc_state->lane_count)) {
1133 		return;
1134 	}
1135 
1136 	/* Schedule a Hotplug Uevent to userspace to start modeset */
1137 	schedule_work(&intel_connector->modeset_retry_work);
1138 }
1139 
1140 /* Perform the link training on all LTTPRs and the DPRX on a link. */
1141 static bool
1142 intel_dp_link_train_all_phys(struct intel_dp *intel_dp,
1143 			     const struct intel_crtc_state *crtc_state,
1144 			     int lttpr_count)
1145 {
1146 	bool ret = true;
1147 	int i;
1148 
1149 	for (i = lttpr_count - 1; i >= 0; i--) {
1150 		enum drm_dp_phy dp_phy = DP_PHY_LTTPR(i);
1151 
1152 		ret = intel_dp_link_train_phy(intel_dp, crtc_state, dp_phy);
1153 		intel_dp_disable_dpcd_training_pattern(intel_dp, dp_phy);
1154 
1155 		if (!ret)
1156 			break;
1157 	}
1158 
1159 	if (ret)
1160 		ret = intel_dp_link_train_phy(intel_dp, crtc_state, DP_PHY_DPRX);
1161 
1162 	if (intel_dp->set_idle_link_train)
1163 		intel_dp->set_idle_link_train(intel_dp, crtc_state);
1164 
1165 	return ret;
1166 }
1167 
1168 /*
1169  * 128b/132b DP LANEx_EQ_DONE Sequence (DP 2.0 E11 3.5.2.16.1)
1170  */
1171 static bool
1172 intel_dp_128b132b_lane_eq(struct intel_dp *intel_dp,
1173 			  const struct intel_crtc_state *crtc_state)
1174 {
1175 	struct intel_encoder *encoder = &dp_to_dig_port(intel_dp)->base;
1176 	struct drm_i915_private *i915 = to_i915(encoder->base.dev);
1177 	u8 link_status[DP_LINK_STATUS_SIZE];
1178 	int delay_us;
1179 	int try, max_tries = 20;
1180 	unsigned long deadline;
1181 	bool timeout = false;
1182 
1183 	/*
1184 	 * Reset signal levels. Start transmitting 128b/132b TPS1.
1185 	 *
1186 	 * Put DPRX and LTTPRs (if any) into intra-hop AUX mode by writing TPS1
1187 	 * in DP_TRAINING_PATTERN_SET.
1188 	 */
1189 	if (!intel_dp_reset_link_train(intel_dp, crtc_state, DP_PHY_DPRX,
1190 				       DP_TRAINING_PATTERN_1)) {
1191 		drm_err(&i915->drm,
1192 			"[ENCODER:%d:%s] Failed to start 128b/132b TPS1\n",
1193 			encoder->base.base.id, encoder->base.name);
1194 		return false;
1195 	}
1196 
1197 	delay_us = drm_dp_128b132b_read_aux_rd_interval(&intel_dp->aux);
1198 
1199 	/* Read the initial TX FFE settings. */
1200 	if (drm_dp_dpcd_read_link_status(&intel_dp->aux, link_status) < 0) {
1201 		drm_err(&i915->drm,
1202 			"[ENCODER:%d:%s] Failed to read TX FFE presets\n",
1203 			encoder->base.base.id, encoder->base.name);
1204 		return false;
1205 	}
1206 
1207 	/* Update signal levels and training set as requested. */
1208 	intel_dp_get_adjust_train(intel_dp, crtc_state, DP_PHY_DPRX, link_status);
1209 	if (!intel_dp_update_link_train(intel_dp, crtc_state, DP_PHY_DPRX)) {
1210 		drm_err(&i915->drm,
1211 			"[ENCODER:%d:%s] Failed to set initial TX FFE settings\n",
1212 			encoder->base.base.id, encoder->base.name);
1213 		return false;
1214 	}
1215 
1216 	/* Start transmitting 128b/132b TPS2. */
1217 	if (!intel_dp_set_link_train(intel_dp, crtc_state, DP_PHY_DPRX,
1218 				     DP_TRAINING_PATTERN_2)) {
1219 		drm_err(&i915->drm,
1220 			"[ENCODER:%d:%s] Failed to start 128b/132b TPS2\n",
1221 			encoder->base.base.id, encoder->base.name);
1222 		return false;
1223 	}
1224 
1225 	/* Time budget for the LANEx_EQ_DONE Sequence */
1226 	deadline = jiffies + msecs_to_jiffies_timeout(400);
1227 
1228 	for (try = 0; try < max_tries; try++) {
1229 		usleep_range(delay_us, 2 * delay_us);
1230 
1231 		/*
1232 		 * The delay may get updated. The transmitter shall read the
1233 		 * delay before link status during link training.
1234 		 */
1235 		delay_us = drm_dp_128b132b_read_aux_rd_interval(&intel_dp->aux);
1236 
1237 		if (drm_dp_dpcd_read_link_status(&intel_dp->aux, link_status) < 0) {
1238 			drm_err(&i915->drm,
1239 				"[ENCODER:%d:%s] Failed to read link status\n",
1240 				encoder->base.base.id, encoder->base.name);
1241 			return false;
1242 		}
1243 
1244 		if (drm_dp_128b132b_link_training_failed(link_status)) {
1245 			intel_dp_dump_link_status(intel_dp, DP_PHY_DPRX, link_status);
1246 			drm_err(&i915->drm,
1247 				"[ENCODER:%d:%s] Downstream link training failure\n",
1248 				encoder->base.base.id, encoder->base.name);
1249 			return false;
1250 		}
1251 
1252 		if (drm_dp_128b132b_lane_channel_eq_done(link_status, crtc_state->lane_count)) {
1253 			drm_dbg_kms(&i915->drm,
1254 				    "[ENCODER:%d:%s] Lane channel eq done\n",
1255 				    encoder->base.base.id, encoder->base.name);
1256 			break;
1257 		}
1258 
1259 		if (timeout) {
1260 			intel_dp_dump_link_status(intel_dp, DP_PHY_DPRX, link_status);
1261 			drm_err(&i915->drm,
1262 				"[ENCODER:%d:%s] Lane channel eq timeout\n",
1263 				encoder->base.base.id, encoder->base.name);
1264 			return false;
1265 		}
1266 
1267 		if (time_after(jiffies, deadline))
1268 			timeout = true; /* try one last time after deadline */
1269 
1270 		/* Update signal levels and training set as requested. */
1271 		intel_dp_get_adjust_train(intel_dp, crtc_state, DP_PHY_DPRX, link_status);
1272 		if (!intel_dp_update_link_train(intel_dp, crtc_state, DP_PHY_DPRX)) {
1273 			drm_err(&i915->drm,
1274 				"[ENCODER:%d:%s] Failed to update TX FFE settings\n",
1275 				encoder->base.base.id, encoder->base.name);
1276 			return false;
1277 		}
1278 	}
1279 
1280 	if (try == max_tries) {
1281 		intel_dp_dump_link_status(intel_dp, DP_PHY_DPRX, link_status);
1282 		drm_err(&i915->drm,
1283 			"[ENCODER:%d:%s] Max loop count reached\n",
1284 			encoder->base.base.id, encoder->base.name);
1285 		return false;
1286 	}
1287 
1288 	for (;;) {
1289 		if (time_after(jiffies, deadline))
1290 			timeout = true; /* try one last time after deadline */
1291 
1292 		if (drm_dp_dpcd_read_link_status(&intel_dp->aux, link_status) < 0) {
1293 			drm_err(&i915->drm,
1294 				"[ENCODER:%d:%s] Failed to read link status\n",
1295 				encoder->base.base.id, encoder->base.name);
1296 			return false;
1297 		}
1298 
1299 		if (drm_dp_128b132b_link_training_failed(link_status)) {
1300 			intel_dp_dump_link_status(intel_dp, DP_PHY_DPRX, link_status);
1301 			drm_err(&i915->drm,
1302 				"[ENCODER:%d:%s] Downstream link training failure\n",
1303 				encoder->base.base.id, encoder->base.name);
1304 			return false;
1305 		}
1306 
1307 		if (drm_dp_128b132b_eq_interlane_align_done(link_status)) {
1308 			drm_dbg_kms(&i915->drm,
1309 				    "[ENCODER:%d:%s] Interlane align done\n",
1310 				    encoder->base.base.id, encoder->base.name);
1311 			break;
1312 		}
1313 
1314 		if (timeout) {
1315 			intel_dp_dump_link_status(intel_dp, DP_PHY_DPRX, link_status);
1316 			drm_err(&i915->drm,
1317 				"[ENCODER:%d:%s] Interlane align timeout\n",
1318 				encoder->base.base.id, encoder->base.name);
1319 			return false;
1320 		}
1321 
1322 		usleep_range(2000, 3000);
1323 	}
1324 
1325 	return true;
1326 }
1327 
1328 /*
1329  * 128b/132b DP LANEx_CDS_DONE Sequence (DP 2.0 E11 3.5.2.16.2)
1330  */
1331 static bool
1332 intel_dp_128b132b_lane_cds(struct intel_dp *intel_dp,
1333 			   const struct intel_crtc_state *crtc_state,
1334 			   int lttpr_count)
1335 {
1336 	struct intel_encoder *encoder = &dp_to_dig_port(intel_dp)->base;
1337 	struct drm_i915_private *i915 = to_i915(encoder->base.dev);
1338 	u8 link_status[DP_LINK_STATUS_SIZE];
1339 	unsigned long deadline;
1340 
1341 	if (drm_dp_dpcd_writeb(&intel_dp->aux, DP_TRAINING_PATTERN_SET,
1342 			       DP_TRAINING_PATTERN_2_CDS) != 1) {
1343 		drm_err(&i915->drm,
1344 			"[ENCODER:%d:%s] Failed to start 128b/132b TPS2 CDS\n",
1345 			encoder->base.base.id, encoder->base.name);
1346 		return false;
1347 	}
1348 
1349 	/* Time budget for the LANEx_CDS_DONE Sequence */
1350 	deadline = jiffies + msecs_to_jiffies_timeout((lttpr_count + 1) * 20);
1351 
1352 	for (;;) {
1353 		bool timeout = false;
1354 
1355 		if (time_after(jiffies, deadline))
1356 			timeout = true; /* try one last time after deadline */
1357 
1358 		usleep_range(2000, 3000);
1359 
1360 		if (drm_dp_dpcd_read_link_status(&intel_dp->aux, link_status) < 0) {
1361 			drm_err(&i915->drm,
1362 				"[ENCODER:%d:%s] Failed to read link status\n",
1363 				encoder->base.base.id, encoder->base.name);
1364 			return false;
1365 		}
1366 
1367 		if (drm_dp_128b132b_eq_interlane_align_done(link_status) &&
1368 		    drm_dp_128b132b_cds_interlane_align_done(link_status) &&
1369 		    drm_dp_128b132b_lane_symbol_locked(link_status, crtc_state->lane_count)) {
1370 			drm_dbg_kms(&i915->drm,
1371 				    "[ENCODER:%d:%s] CDS interlane align done\n",
1372 				    encoder->base.base.id, encoder->base.name);
1373 			break;
1374 		}
1375 
1376 		if (drm_dp_128b132b_link_training_failed(link_status)) {
1377 			intel_dp_dump_link_status(intel_dp, DP_PHY_DPRX, link_status);
1378 			drm_err(&i915->drm,
1379 				"[ENCODER:%d:%s] Downstream link training failure\n",
1380 				encoder->base.base.id, encoder->base.name);
1381 			return false;
1382 		}
1383 
1384 		if (timeout) {
1385 			intel_dp_dump_link_status(intel_dp, DP_PHY_DPRX, link_status);
1386 			drm_err(&i915->drm,
1387 				"[ENCODER:%d:%s] CDS timeout\n",
1388 				encoder->base.base.id, encoder->base.name);
1389 			return false;
1390 		}
1391 	}
1392 
1393 	/* FIXME: Should DP_TRAINING_PATTERN_DISABLE be written first? */
1394 	if (intel_dp->set_idle_link_train)
1395 		intel_dp->set_idle_link_train(intel_dp, crtc_state);
1396 
1397 	return true;
1398 }
1399 
1400 /*
1401  * 128b/132b link training sequence. (DP 2.0 E11 SCR on link training.)
1402  */
1403 static bool
1404 intel_dp_128b132b_link_train(struct intel_dp *intel_dp,
1405 			     const struct intel_crtc_state *crtc_state,
1406 			     int lttpr_count)
1407 {
1408 	struct drm_i915_private *i915 = dp_to_i915(intel_dp);
1409 	struct intel_connector *connector = intel_dp->attached_connector;
1410 	struct intel_encoder *encoder = &dp_to_dig_port(intel_dp)->base;
1411 	bool passed = false;
1412 
1413 	if (wait_for(intel_dp_128b132b_intra_hop(intel_dp, crtc_state) == 0, 500)) {
1414 		drm_err(&i915->drm,
1415 			"[ENCODER:%d:%s] 128b/132b intra-hop not clear\n",
1416 			encoder->base.base.id, encoder->base.name);
1417 		return false;
1418 	}
1419 
1420 	if (intel_dp_128b132b_lane_eq(intel_dp, crtc_state) &&
1421 	    intel_dp_128b132b_lane_cds(intel_dp, crtc_state, lttpr_count))
1422 		passed = true;
1423 
1424 	drm_dbg_kms(&i915->drm,
1425 		    "[CONNECTOR:%d:%s][ENCODER:%d:%s] 128b/132b Link Training %s at link rate = %d, lane count = %d\n",
1426 		    connector->base.base.id, connector->base.name,
1427 		    encoder->base.base.id, encoder->base.name,
1428 		    passed ? "passed" : "failed",
1429 		    crtc_state->port_clock, crtc_state->lane_count);
1430 
1431 	return passed;
1432 }
1433 
1434 /**
1435  * intel_dp_start_link_train - start link training
1436  * @intel_dp: DP struct
1437  * @crtc_state: state for CRTC attached to the encoder
1438  *
1439  * Start the link training of the @intel_dp port, scheduling a fallback
1440  * retraining with reduced link rate/lane parameters if the link training
1441  * fails.
1442  * After calling this function intel_dp_stop_link_train() must be called.
1443  */
1444 void intel_dp_start_link_train(struct intel_dp *intel_dp,
1445 			       const struct intel_crtc_state *crtc_state)
1446 {
1447 	bool passed;
1448 	/*
1449 	 * TODO: Reiniting LTTPRs here won't be needed once proper connector
1450 	 * HW state readout is added.
1451 	 */
1452 	int lttpr_count = intel_dp_init_lttpr_and_dprx_caps(intel_dp);
1453 
1454 	if (lttpr_count < 0)
1455 		/* Still continue with enabling the port and link training. */
1456 		lttpr_count = 0;
1457 
1458 	intel_dp_prepare_link_train(intel_dp, crtc_state);
1459 
1460 	if (intel_dp_is_uhbr(crtc_state))
1461 		passed = intel_dp_128b132b_link_train(intel_dp, crtc_state, lttpr_count);
1462 	else
1463 		passed = intel_dp_link_train_all_phys(intel_dp, crtc_state, lttpr_count);
1464 
1465 	if (!passed)
1466 		intel_dp_schedule_fallback_link_training(intel_dp, crtc_state);
1467 }
1468