xref: /linux/drivers/gpu/drm/i915/display/intel_fbc.c (revision 3027ce13e04eee76539ca65c2cb1028a01c8c508)
1 /*
2  * Copyright © 2014 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 
24 /**
25  * DOC: Frame Buffer Compression (FBC)
26  *
27  * FBC tries to save memory bandwidth (and so power consumption) by
28  * compressing the amount of memory used by the display. It is total
29  * transparent to user space and completely handled in the kernel.
30  *
31  * The benefits of FBC are mostly visible with solid backgrounds and
32  * variation-less patterns. It comes from keeping the memory footprint small
33  * and having fewer memory pages opened and accessed for refreshing the display.
34  *
35  * i915 is responsible to reserve stolen memory for FBC and configure its
36  * offset on proper registers. The hardware takes care of all
37  * compress/decompress. However there are many known cases where we have to
38  * forcibly disable it to allow proper screen updates.
39  */
40 
41 #include <linux/string_helpers.h>
42 
43 #include <drm/drm_blend.h>
44 #include <drm/drm_fourcc.h>
45 
46 #include "i915_drv.h"
47 #include "i915_reg.h"
48 #include "i915_utils.h"
49 #include "i915_vgpu.h"
50 #include "i915_vma.h"
51 #include "intel_cdclk.h"
52 #include "intel_de.h"
53 #include "intel_display_device.h"
54 #include "intel_display_trace.h"
55 #include "intel_display_types.h"
56 #include "intel_fbc.h"
57 #include "intel_frontbuffer.h"
58 
59 #define for_each_fbc_id(__dev_priv, __fbc_id) \
60 	for ((__fbc_id) = INTEL_FBC_A; (__fbc_id) < I915_MAX_FBCS; (__fbc_id)++) \
61 		for_each_if(DISPLAY_RUNTIME_INFO(__dev_priv)->fbc_mask & BIT(__fbc_id))
62 
63 #define for_each_intel_fbc(__dev_priv, __fbc, __fbc_id) \
64 	for_each_fbc_id((__dev_priv), (__fbc_id)) \
65 		for_each_if((__fbc) = (__dev_priv)->display.fbc[(__fbc_id)])
66 
67 struct intel_fbc_funcs {
68 	void (*activate)(struct intel_fbc *fbc);
69 	void (*deactivate)(struct intel_fbc *fbc);
70 	bool (*is_active)(struct intel_fbc *fbc);
71 	bool (*is_compressing)(struct intel_fbc *fbc);
72 	void (*nuke)(struct intel_fbc *fbc);
73 	void (*program_cfb)(struct intel_fbc *fbc);
74 	void (*set_false_color)(struct intel_fbc *fbc, bool enable);
75 };
76 
77 struct intel_fbc_state {
78 	struct intel_plane *plane;
79 	unsigned int cfb_stride;
80 	unsigned int cfb_size;
81 	unsigned int fence_y_offset;
82 	u16 override_cfb_stride;
83 	u16 interval;
84 	s8 fence_id;
85 };
86 
87 struct intel_fbc {
88 	struct drm_i915_private *i915;
89 	const struct intel_fbc_funcs *funcs;
90 
91 	/*
92 	 * This is always the inner lock when overlapping with
93 	 * struct_mutex and it's the outer lock when overlapping
94 	 * with stolen_lock.
95 	 */
96 	struct mutex lock;
97 	unsigned int busy_bits;
98 
99 	struct i915_stolen_fb compressed_fb, compressed_llb;
100 
101 	enum intel_fbc_id id;
102 
103 	u8 limit;
104 
105 	bool false_color;
106 
107 	bool active;
108 	bool activated;
109 	bool flip_pending;
110 
111 	bool underrun_detected;
112 	struct work_struct underrun_work;
113 
114 	/*
115 	 * This structure contains everything that's relevant to program the
116 	 * hardware registers. When we want to figure out if we need to disable
117 	 * and re-enable FBC for a new configuration we just check if there's
118 	 * something different in the struct. The genx_fbc_activate functions
119 	 * are supposed to read from it in order to program the registers.
120 	 */
121 	struct intel_fbc_state state;
122 	const char *no_fbc_reason;
123 };
124 
125 /* plane stride in pixels */
126 static unsigned int intel_fbc_plane_stride(const struct intel_plane_state *plane_state)
127 {
128 	const struct drm_framebuffer *fb = plane_state->hw.fb;
129 	unsigned int stride;
130 
131 	stride = plane_state->view.color_plane[0].mapping_stride;
132 	if (!drm_rotation_90_or_270(plane_state->hw.rotation))
133 		stride /= fb->format->cpp[0];
134 
135 	return stride;
136 }
137 
138 /* plane stride based cfb stride in bytes, assuming 1:1 compression limit */
139 static unsigned int _intel_fbc_cfb_stride(const struct intel_plane_state *plane_state)
140 {
141 	unsigned int cpp = 4; /* FBC always 4 bytes per pixel */
142 
143 	return intel_fbc_plane_stride(plane_state) * cpp;
144 }
145 
146 /* minimum acceptable cfb stride in bytes, assuming 1:1 compression limit */
147 static unsigned int skl_fbc_min_cfb_stride(const struct intel_plane_state *plane_state)
148 {
149 	struct drm_i915_private *i915 = to_i915(plane_state->uapi.plane->dev);
150 	unsigned int limit = 4; /* 1:4 compression limit is the worst case */
151 	unsigned int cpp = 4; /* FBC always 4 bytes per pixel */
152 	unsigned int width = drm_rect_width(&plane_state->uapi.src) >> 16;
153 	unsigned int height = 4; /* FBC segment is 4 lines */
154 	unsigned int stride;
155 
156 	/* minimum segment stride we can use */
157 	stride = width * cpp * height / limit;
158 
159 	/*
160 	 * Wa_16011863758: icl+
161 	 * Avoid some hardware segment address miscalculation.
162 	 */
163 	if (DISPLAY_VER(i915) >= 11)
164 		stride += 64;
165 
166 	/*
167 	 * At least some of the platforms require each 4 line segment to
168 	 * be 512 byte aligned. Just do it always for simplicity.
169 	 */
170 	stride = ALIGN(stride, 512);
171 
172 	/* convert back to single line equivalent with 1:1 compression limit */
173 	return stride * limit / height;
174 }
175 
176 /* properly aligned cfb stride in bytes, assuming 1:1 compression limit */
177 static unsigned int intel_fbc_cfb_stride(const struct intel_plane_state *plane_state)
178 {
179 	struct drm_i915_private *i915 = to_i915(plane_state->uapi.plane->dev);
180 	unsigned int stride = _intel_fbc_cfb_stride(plane_state);
181 
182 	/*
183 	 * At least some of the platforms require each 4 line segment to
184 	 * be 512 byte aligned. Aligning each line to 512 bytes guarantees
185 	 * that regardless of the compression limit we choose later.
186 	 */
187 	if (DISPLAY_VER(i915) >= 9)
188 		return max(ALIGN(stride, 512), skl_fbc_min_cfb_stride(plane_state));
189 	else
190 		return stride;
191 }
192 
193 static unsigned int intel_fbc_cfb_size(const struct intel_plane_state *plane_state)
194 {
195 	struct drm_i915_private *i915 = to_i915(plane_state->uapi.plane->dev);
196 	int lines = drm_rect_height(&plane_state->uapi.src) >> 16;
197 
198 	if (DISPLAY_VER(i915) == 7)
199 		lines = min(lines, 2048);
200 	else if (DISPLAY_VER(i915) >= 8)
201 		lines = min(lines, 2560);
202 
203 	return lines * intel_fbc_cfb_stride(plane_state);
204 }
205 
206 static u16 intel_fbc_override_cfb_stride(const struct intel_plane_state *plane_state)
207 {
208 	struct drm_i915_private *i915 = to_i915(plane_state->uapi.plane->dev);
209 	unsigned int stride_aligned = intel_fbc_cfb_stride(plane_state);
210 	unsigned int stride = _intel_fbc_cfb_stride(plane_state);
211 	const struct drm_framebuffer *fb = plane_state->hw.fb;
212 
213 	/*
214 	 * Override stride in 64 byte units per 4 line segment.
215 	 *
216 	 * Gen9 hw miscalculates cfb stride for linear as
217 	 * PLANE_STRIDE*512 instead of PLANE_STRIDE*64, so
218 	 * we always need to use the override there.
219 	 */
220 	if (stride != stride_aligned ||
221 	    (DISPLAY_VER(i915) == 9 && fb->modifier == DRM_FORMAT_MOD_LINEAR))
222 		return stride_aligned * 4 / 64;
223 
224 	return 0;
225 }
226 
227 static u32 i8xx_fbc_ctl(struct intel_fbc *fbc)
228 {
229 	const struct intel_fbc_state *fbc_state = &fbc->state;
230 	struct drm_i915_private *i915 = fbc->i915;
231 	unsigned int cfb_stride;
232 	u32 fbc_ctl;
233 
234 	cfb_stride = fbc_state->cfb_stride / fbc->limit;
235 
236 	/* FBC_CTL wants 32B or 64B units */
237 	if (DISPLAY_VER(i915) == 2)
238 		cfb_stride = (cfb_stride / 32) - 1;
239 	else
240 		cfb_stride = (cfb_stride / 64) - 1;
241 
242 	fbc_ctl = FBC_CTL_PERIODIC |
243 		FBC_CTL_INTERVAL(fbc_state->interval) |
244 		FBC_CTL_STRIDE(cfb_stride);
245 
246 	if (IS_I945GM(i915))
247 		fbc_ctl |= FBC_CTL_C3_IDLE; /* 945 needs special SR handling */
248 
249 	if (fbc_state->fence_id >= 0)
250 		fbc_ctl |= FBC_CTL_FENCENO(fbc_state->fence_id);
251 
252 	return fbc_ctl;
253 }
254 
255 static u32 i965_fbc_ctl2(struct intel_fbc *fbc)
256 {
257 	const struct intel_fbc_state *fbc_state = &fbc->state;
258 	u32 fbc_ctl2;
259 
260 	fbc_ctl2 = FBC_CTL_FENCE_DBL | FBC_CTL_IDLE_IMM |
261 		FBC_CTL_PLANE(fbc_state->plane->i9xx_plane);
262 
263 	if (fbc_state->fence_id >= 0)
264 		fbc_ctl2 |= FBC_CTL_CPU_FENCE_EN;
265 
266 	return fbc_ctl2;
267 }
268 
269 static void i8xx_fbc_deactivate(struct intel_fbc *fbc)
270 {
271 	struct drm_i915_private *i915 = fbc->i915;
272 	u32 fbc_ctl;
273 
274 	/* Disable compression */
275 	fbc_ctl = intel_de_read(i915, FBC_CONTROL);
276 	if ((fbc_ctl & FBC_CTL_EN) == 0)
277 		return;
278 
279 	fbc_ctl &= ~FBC_CTL_EN;
280 	intel_de_write(i915, FBC_CONTROL, fbc_ctl);
281 
282 	/* Wait for compressing bit to clear */
283 	if (intel_de_wait_for_clear(i915, FBC_STATUS,
284 				    FBC_STAT_COMPRESSING, 10)) {
285 		drm_dbg_kms(&i915->drm, "FBC idle timed out\n");
286 		return;
287 	}
288 }
289 
290 static void i8xx_fbc_activate(struct intel_fbc *fbc)
291 {
292 	const struct intel_fbc_state *fbc_state = &fbc->state;
293 	struct drm_i915_private *i915 = fbc->i915;
294 	int i;
295 
296 	/* Clear old tags */
297 	for (i = 0; i < (FBC_LL_SIZE / 32) + 1; i++)
298 		intel_de_write(i915, FBC_TAG(i), 0);
299 
300 	if (DISPLAY_VER(i915) == 4) {
301 		intel_de_write(i915, FBC_CONTROL2,
302 			       i965_fbc_ctl2(fbc));
303 		intel_de_write(i915, FBC_FENCE_OFF,
304 			       fbc_state->fence_y_offset);
305 	}
306 
307 	intel_de_write(i915, FBC_CONTROL,
308 		       FBC_CTL_EN | i8xx_fbc_ctl(fbc));
309 }
310 
311 static bool i8xx_fbc_is_active(struct intel_fbc *fbc)
312 {
313 	return intel_de_read(fbc->i915, FBC_CONTROL) & FBC_CTL_EN;
314 }
315 
316 static bool i8xx_fbc_is_compressing(struct intel_fbc *fbc)
317 {
318 	return intel_de_read(fbc->i915, FBC_STATUS) &
319 		(FBC_STAT_COMPRESSING | FBC_STAT_COMPRESSED);
320 }
321 
322 static void i8xx_fbc_nuke(struct intel_fbc *fbc)
323 {
324 	struct intel_fbc_state *fbc_state = &fbc->state;
325 	enum i9xx_plane_id i9xx_plane = fbc_state->plane->i9xx_plane;
326 	struct drm_i915_private *dev_priv = fbc->i915;
327 
328 	intel_de_write_fw(dev_priv, DSPADDR(i9xx_plane),
329 			  intel_de_read_fw(dev_priv, DSPADDR(i9xx_plane)));
330 }
331 
332 static void i8xx_fbc_program_cfb(struct intel_fbc *fbc)
333 {
334 	struct drm_i915_private *i915 = fbc->i915;
335 
336 	drm_WARN_ON(&i915->drm,
337 		    range_overflows_end_t(u64, i915_gem_stolen_area_address(i915),
338 					  i915_gem_stolen_node_offset(&fbc->compressed_fb),
339 					  U32_MAX));
340 	drm_WARN_ON(&i915->drm,
341 		    range_overflows_end_t(u64, i915_gem_stolen_area_address(i915),
342 					  i915_gem_stolen_node_offset(&fbc->compressed_llb),
343 					  U32_MAX));
344 	intel_de_write(i915, FBC_CFB_BASE,
345 		       i915_gem_stolen_node_address(i915, &fbc->compressed_fb));
346 	intel_de_write(i915, FBC_LL_BASE,
347 		       i915_gem_stolen_node_address(i915, &fbc->compressed_llb));
348 }
349 
350 static const struct intel_fbc_funcs i8xx_fbc_funcs = {
351 	.activate = i8xx_fbc_activate,
352 	.deactivate = i8xx_fbc_deactivate,
353 	.is_active = i8xx_fbc_is_active,
354 	.is_compressing = i8xx_fbc_is_compressing,
355 	.nuke = i8xx_fbc_nuke,
356 	.program_cfb = i8xx_fbc_program_cfb,
357 };
358 
359 static void i965_fbc_nuke(struct intel_fbc *fbc)
360 {
361 	struct intel_fbc_state *fbc_state = &fbc->state;
362 	enum i9xx_plane_id i9xx_plane = fbc_state->plane->i9xx_plane;
363 	struct drm_i915_private *dev_priv = fbc->i915;
364 
365 	intel_de_write_fw(dev_priv, DSPSURF(i9xx_plane),
366 			  intel_de_read_fw(dev_priv, DSPSURF(i9xx_plane)));
367 }
368 
369 static const struct intel_fbc_funcs i965_fbc_funcs = {
370 	.activate = i8xx_fbc_activate,
371 	.deactivate = i8xx_fbc_deactivate,
372 	.is_active = i8xx_fbc_is_active,
373 	.is_compressing = i8xx_fbc_is_compressing,
374 	.nuke = i965_fbc_nuke,
375 	.program_cfb = i8xx_fbc_program_cfb,
376 };
377 
378 static u32 g4x_dpfc_ctl_limit(struct intel_fbc *fbc)
379 {
380 	switch (fbc->limit) {
381 	default:
382 		MISSING_CASE(fbc->limit);
383 		fallthrough;
384 	case 1:
385 		return DPFC_CTL_LIMIT_1X;
386 	case 2:
387 		return DPFC_CTL_LIMIT_2X;
388 	case 4:
389 		return DPFC_CTL_LIMIT_4X;
390 	}
391 }
392 
393 static u32 g4x_dpfc_ctl(struct intel_fbc *fbc)
394 {
395 	const struct intel_fbc_state *fbc_state = &fbc->state;
396 	struct drm_i915_private *i915 = fbc->i915;
397 	u32 dpfc_ctl;
398 
399 	dpfc_ctl = g4x_dpfc_ctl_limit(fbc) |
400 		DPFC_CTL_PLANE_G4X(fbc_state->plane->i9xx_plane);
401 
402 	if (IS_G4X(i915))
403 		dpfc_ctl |= DPFC_CTL_SR_EN;
404 
405 	if (fbc_state->fence_id >= 0) {
406 		dpfc_ctl |= DPFC_CTL_FENCE_EN_G4X;
407 
408 		if (DISPLAY_VER(i915) < 6)
409 			dpfc_ctl |= DPFC_CTL_FENCENO(fbc_state->fence_id);
410 	}
411 
412 	return dpfc_ctl;
413 }
414 
415 static void g4x_fbc_activate(struct intel_fbc *fbc)
416 {
417 	const struct intel_fbc_state *fbc_state = &fbc->state;
418 	struct drm_i915_private *i915 = fbc->i915;
419 
420 	intel_de_write(i915, DPFC_FENCE_YOFF,
421 		       fbc_state->fence_y_offset);
422 
423 	intel_de_write(i915, DPFC_CONTROL,
424 		       DPFC_CTL_EN | g4x_dpfc_ctl(fbc));
425 }
426 
427 static void g4x_fbc_deactivate(struct intel_fbc *fbc)
428 {
429 	struct drm_i915_private *i915 = fbc->i915;
430 	u32 dpfc_ctl;
431 
432 	/* Disable compression */
433 	dpfc_ctl = intel_de_read(i915, DPFC_CONTROL);
434 	if (dpfc_ctl & DPFC_CTL_EN) {
435 		dpfc_ctl &= ~DPFC_CTL_EN;
436 		intel_de_write(i915, DPFC_CONTROL, dpfc_ctl);
437 	}
438 }
439 
440 static bool g4x_fbc_is_active(struct intel_fbc *fbc)
441 {
442 	return intel_de_read(fbc->i915, DPFC_CONTROL) & DPFC_CTL_EN;
443 }
444 
445 static bool g4x_fbc_is_compressing(struct intel_fbc *fbc)
446 {
447 	return intel_de_read(fbc->i915, DPFC_STATUS) & DPFC_COMP_SEG_MASK;
448 }
449 
450 static void g4x_fbc_program_cfb(struct intel_fbc *fbc)
451 {
452 	struct drm_i915_private *i915 = fbc->i915;
453 
454 	intel_de_write(i915, DPFC_CB_BASE,
455 		       i915_gem_stolen_node_offset(&fbc->compressed_fb));
456 }
457 
458 static const struct intel_fbc_funcs g4x_fbc_funcs = {
459 	.activate = g4x_fbc_activate,
460 	.deactivate = g4x_fbc_deactivate,
461 	.is_active = g4x_fbc_is_active,
462 	.is_compressing = g4x_fbc_is_compressing,
463 	.nuke = i965_fbc_nuke,
464 	.program_cfb = g4x_fbc_program_cfb,
465 };
466 
467 static void ilk_fbc_activate(struct intel_fbc *fbc)
468 {
469 	struct intel_fbc_state *fbc_state = &fbc->state;
470 	struct drm_i915_private *i915 = fbc->i915;
471 
472 	intel_de_write(i915, ILK_DPFC_FENCE_YOFF(fbc->id),
473 		       fbc_state->fence_y_offset);
474 
475 	intel_de_write(i915, ILK_DPFC_CONTROL(fbc->id),
476 		       DPFC_CTL_EN | g4x_dpfc_ctl(fbc));
477 }
478 
479 static void ilk_fbc_deactivate(struct intel_fbc *fbc)
480 {
481 	struct drm_i915_private *i915 = fbc->i915;
482 	u32 dpfc_ctl;
483 
484 	/* Disable compression */
485 	dpfc_ctl = intel_de_read(i915, ILK_DPFC_CONTROL(fbc->id));
486 	if (dpfc_ctl & DPFC_CTL_EN) {
487 		dpfc_ctl &= ~DPFC_CTL_EN;
488 		intel_de_write(i915, ILK_DPFC_CONTROL(fbc->id), dpfc_ctl);
489 	}
490 }
491 
492 static bool ilk_fbc_is_active(struct intel_fbc *fbc)
493 {
494 	return intel_de_read(fbc->i915, ILK_DPFC_CONTROL(fbc->id)) & DPFC_CTL_EN;
495 }
496 
497 static bool ilk_fbc_is_compressing(struct intel_fbc *fbc)
498 {
499 	return intel_de_read(fbc->i915, ILK_DPFC_STATUS(fbc->id)) & DPFC_COMP_SEG_MASK;
500 }
501 
502 static void ilk_fbc_program_cfb(struct intel_fbc *fbc)
503 {
504 	struct drm_i915_private *i915 = fbc->i915;
505 
506 	intel_de_write(i915, ILK_DPFC_CB_BASE(fbc->id),
507 		       i915_gem_stolen_node_offset(&fbc->compressed_fb));
508 }
509 
510 static const struct intel_fbc_funcs ilk_fbc_funcs = {
511 	.activate = ilk_fbc_activate,
512 	.deactivate = ilk_fbc_deactivate,
513 	.is_active = ilk_fbc_is_active,
514 	.is_compressing = ilk_fbc_is_compressing,
515 	.nuke = i965_fbc_nuke,
516 	.program_cfb = ilk_fbc_program_cfb,
517 };
518 
519 static void snb_fbc_program_fence(struct intel_fbc *fbc)
520 {
521 	const struct intel_fbc_state *fbc_state = &fbc->state;
522 	struct drm_i915_private *i915 = fbc->i915;
523 	u32 ctl = 0;
524 
525 	if (fbc_state->fence_id >= 0)
526 		ctl = SNB_DPFC_FENCE_EN | SNB_DPFC_FENCENO(fbc_state->fence_id);
527 
528 	intel_de_write(i915, SNB_DPFC_CTL_SA, ctl);
529 	intel_de_write(i915, SNB_DPFC_CPU_FENCE_OFFSET, fbc_state->fence_y_offset);
530 }
531 
532 static void snb_fbc_activate(struct intel_fbc *fbc)
533 {
534 	snb_fbc_program_fence(fbc);
535 
536 	ilk_fbc_activate(fbc);
537 }
538 
539 static void snb_fbc_nuke(struct intel_fbc *fbc)
540 {
541 	struct drm_i915_private *i915 = fbc->i915;
542 
543 	intel_de_write(i915, MSG_FBC_REND_STATE(fbc->id), FBC_REND_NUKE);
544 	intel_de_posting_read(i915, MSG_FBC_REND_STATE(fbc->id));
545 }
546 
547 static const struct intel_fbc_funcs snb_fbc_funcs = {
548 	.activate = snb_fbc_activate,
549 	.deactivate = ilk_fbc_deactivate,
550 	.is_active = ilk_fbc_is_active,
551 	.is_compressing = ilk_fbc_is_compressing,
552 	.nuke = snb_fbc_nuke,
553 	.program_cfb = ilk_fbc_program_cfb,
554 };
555 
556 static void glk_fbc_program_cfb_stride(struct intel_fbc *fbc)
557 {
558 	const struct intel_fbc_state *fbc_state = &fbc->state;
559 	struct drm_i915_private *i915 = fbc->i915;
560 	u32 val = 0;
561 
562 	if (fbc_state->override_cfb_stride)
563 		val |= FBC_STRIDE_OVERRIDE |
564 			FBC_STRIDE(fbc_state->override_cfb_stride / fbc->limit);
565 
566 	intel_de_write(i915, GLK_FBC_STRIDE(fbc->id), val);
567 }
568 
569 static void skl_fbc_program_cfb_stride(struct intel_fbc *fbc)
570 {
571 	const struct intel_fbc_state *fbc_state = &fbc->state;
572 	struct drm_i915_private *i915 = fbc->i915;
573 	u32 val = 0;
574 
575 	/* Display WA #0529: skl, kbl, bxt. */
576 	if (fbc_state->override_cfb_stride)
577 		val |= CHICKEN_FBC_STRIDE_OVERRIDE |
578 			CHICKEN_FBC_STRIDE(fbc_state->override_cfb_stride / fbc->limit);
579 
580 	intel_de_rmw(i915, CHICKEN_MISC_4,
581 		     CHICKEN_FBC_STRIDE_OVERRIDE |
582 		     CHICKEN_FBC_STRIDE_MASK, val);
583 }
584 
585 static u32 ivb_dpfc_ctl(struct intel_fbc *fbc)
586 {
587 	const struct intel_fbc_state *fbc_state = &fbc->state;
588 	struct drm_i915_private *i915 = fbc->i915;
589 	u32 dpfc_ctl;
590 
591 	dpfc_ctl = g4x_dpfc_ctl_limit(fbc);
592 
593 	if (IS_IVYBRIDGE(i915))
594 		dpfc_ctl |= DPFC_CTL_PLANE_IVB(fbc_state->plane->i9xx_plane);
595 
596 	if (DISPLAY_VER(i915) >= 20)
597 		dpfc_ctl |= DPFC_CTL_PLANE_BINDING(fbc_state->plane->id);
598 
599 	if (fbc_state->fence_id >= 0)
600 		dpfc_ctl |= DPFC_CTL_FENCE_EN_IVB;
601 
602 	if (fbc->false_color)
603 		dpfc_ctl |= DPFC_CTL_FALSE_COLOR;
604 
605 	return dpfc_ctl;
606 }
607 
608 static void ivb_fbc_activate(struct intel_fbc *fbc)
609 {
610 	struct drm_i915_private *i915 = fbc->i915;
611 	u32 dpfc_ctl;
612 
613 	if (DISPLAY_VER(i915) >= 10)
614 		glk_fbc_program_cfb_stride(fbc);
615 	else if (DISPLAY_VER(i915) == 9)
616 		skl_fbc_program_cfb_stride(fbc);
617 
618 	if (intel_gt_support_legacy_fencing(to_gt(i915)))
619 		snb_fbc_program_fence(fbc);
620 
621 	/* wa_14019417088 Alternative WA*/
622 	dpfc_ctl = ivb_dpfc_ctl(fbc);
623 	if (DISPLAY_VER(i915) >= 20)
624 		intel_de_write(i915, ILK_DPFC_CONTROL(fbc->id), dpfc_ctl);
625 
626 	intel_de_write(i915, ILK_DPFC_CONTROL(fbc->id),
627 		       DPFC_CTL_EN | dpfc_ctl);
628 }
629 
630 static bool ivb_fbc_is_compressing(struct intel_fbc *fbc)
631 {
632 	return intel_de_read(fbc->i915, ILK_DPFC_STATUS2(fbc->id)) & DPFC_COMP_SEG_MASK_IVB;
633 }
634 
635 static void ivb_fbc_set_false_color(struct intel_fbc *fbc,
636 				    bool enable)
637 {
638 	intel_de_rmw(fbc->i915, ILK_DPFC_CONTROL(fbc->id),
639 		     DPFC_CTL_FALSE_COLOR, enable ? DPFC_CTL_FALSE_COLOR : 0);
640 }
641 
642 static const struct intel_fbc_funcs ivb_fbc_funcs = {
643 	.activate = ivb_fbc_activate,
644 	.deactivate = ilk_fbc_deactivate,
645 	.is_active = ilk_fbc_is_active,
646 	.is_compressing = ivb_fbc_is_compressing,
647 	.nuke = snb_fbc_nuke,
648 	.program_cfb = ilk_fbc_program_cfb,
649 	.set_false_color = ivb_fbc_set_false_color,
650 };
651 
652 static bool intel_fbc_hw_is_active(struct intel_fbc *fbc)
653 {
654 	return fbc->funcs->is_active(fbc);
655 }
656 
657 static void intel_fbc_hw_activate(struct intel_fbc *fbc)
658 {
659 	trace_intel_fbc_activate(fbc->state.plane);
660 
661 	fbc->active = true;
662 	fbc->activated = true;
663 
664 	fbc->funcs->activate(fbc);
665 }
666 
667 static void intel_fbc_hw_deactivate(struct intel_fbc *fbc)
668 {
669 	trace_intel_fbc_deactivate(fbc->state.plane);
670 
671 	fbc->active = false;
672 
673 	fbc->funcs->deactivate(fbc);
674 }
675 
676 static bool intel_fbc_is_compressing(struct intel_fbc *fbc)
677 {
678 	return fbc->funcs->is_compressing(fbc);
679 }
680 
681 static void intel_fbc_nuke(struct intel_fbc *fbc)
682 {
683 	struct drm_i915_private *i915 = fbc->i915;
684 
685 	lockdep_assert_held(&fbc->lock);
686 	drm_WARN_ON(&i915->drm, fbc->flip_pending);
687 
688 	trace_intel_fbc_nuke(fbc->state.plane);
689 
690 	fbc->funcs->nuke(fbc);
691 }
692 
693 static void intel_fbc_activate(struct intel_fbc *fbc)
694 {
695 	lockdep_assert_held(&fbc->lock);
696 
697 	intel_fbc_hw_activate(fbc);
698 	intel_fbc_nuke(fbc);
699 
700 	fbc->no_fbc_reason = NULL;
701 }
702 
703 static void intel_fbc_deactivate(struct intel_fbc *fbc, const char *reason)
704 {
705 	lockdep_assert_held(&fbc->lock);
706 
707 	if (fbc->active)
708 		intel_fbc_hw_deactivate(fbc);
709 
710 	fbc->no_fbc_reason = reason;
711 }
712 
713 static u64 intel_fbc_cfb_base_max(struct drm_i915_private *i915)
714 {
715 	if (DISPLAY_VER(i915) >= 5 || IS_G4X(i915))
716 		return BIT_ULL(28);
717 	else
718 		return BIT_ULL(32);
719 }
720 
721 static u64 intel_fbc_stolen_end(struct drm_i915_private *i915)
722 {
723 	u64 end;
724 
725 	/* The FBC hardware for BDW/SKL doesn't have access to the stolen
726 	 * reserved range size, so it always assumes the maximum (8mb) is used.
727 	 * If we enable FBC using a CFB on that memory range we'll get FIFO
728 	 * underruns, even if that range is not reserved by the BIOS. */
729 	if (IS_BROADWELL(i915) ||
730 	    (DISPLAY_VER(i915) == 9 && !IS_BROXTON(i915)))
731 		end = i915_gem_stolen_area_size(i915) - 8 * 1024 * 1024;
732 	else
733 		end = U64_MAX;
734 
735 	return min(end, intel_fbc_cfb_base_max(i915));
736 }
737 
738 static int intel_fbc_min_limit(const struct intel_plane_state *plane_state)
739 {
740 	return plane_state->hw.fb->format->cpp[0] == 2 ? 2 : 1;
741 }
742 
743 static int intel_fbc_max_limit(struct drm_i915_private *i915)
744 {
745 	/* WaFbcOnly1to1Ratio:ctg */
746 	if (IS_G4X(i915))
747 		return 1;
748 
749 	/*
750 	 * FBC2 can only do 1:1, 1:2, 1:4, we limit
751 	 * FBC1 to the same out of convenience.
752 	 */
753 	return 4;
754 }
755 
756 static int find_compression_limit(struct intel_fbc *fbc,
757 				  unsigned int size, int min_limit)
758 {
759 	struct drm_i915_private *i915 = fbc->i915;
760 	u64 end = intel_fbc_stolen_end(i915);
761 	int ret, limit = min_limit;
762 
763 	size /= limit;
764 
765 	/* Try to over-allocate to reduce reallocations and fragmentation. */
766 	ret = i915_gem_stolen_insert_node_in_range(i915, &fbc->compressed_fb,
767 						   size <<= 1, 4096, 0, end);
768 	if (ret == 0)
769 		return limit;
770 
771 	for (; limit <= intel_fbc_max_limit(i915); limit <<= 1) {
772 		ret = i915_gem_stolen_insert_node_in_range(i915, &fbc->compressed_fb,
773 							   size >>= 1, 4096, 0, end);
774 		if (ret == 0)
775 			return limit;
776 	}
777 
778 	return 0;
779 }
780 
781 static int intel_fbc_alloc_cfb(struct intel_fbc *fbc,
782 			       unsigned int size, int min_limit)
783 {
784 	struct drm_i915_private *i915 = fbc->i915;
785 	int ret;
786 
787 	drm_WARN_ON(&i915->drm,
788 		    i915_gem_stolen_node_allocated(&fbc->compressed_fb));
789 	drm_WARN_ON(&i915->drm,
790 		    i915_gem_stolen_node_allocated(&fbc->compressed_llb));
791 
792 	if (DISPLAY_VER(i915) < 5 && !IS_G4X(i915)) {
793 		ret = i915_gem_stolen_insert_node(i915, &fbc->compressed_llb,
794 						  4096, 4096);
795 		if (ret)
796 			goto err;
797 	}
798 
799 	ret = find_compression_limit(fbc, size, min_limit);
800 	if (!ret)
801 		goto err_llb;
802 	else if (ret > min_limit)
803 		drm_info_once(&i915->drm,
804 			      "Reducing the compressed framebuffer size. This may lead to less power savings than a non-reduced-size. Try to increase stolen memory size if available in BIOS.\n");
805 
806 	fbc->limit = ret;
807 
808 	drm_dbg_kms(&i915->drm,
809 		    "reserved %llu bytes of contiguous stolen space for FBC, limit: %d\n",
810 		    i915_gem_stolen_node_size(&fbc->compressed_fb), fbc->limit);
811 	return 0;
812 
813 err_llb:
814 	if (i915_gem_stolen_node_allocated(&fbc->compressed_llb))
815 		i915_gem_stolen_remove_node(i915, &fbc->compressed_llb);
816 err:
817 	if (i915_gem_stolen_initialized(i915))
818 		drm_info_once(&i915->drm, "not enough stolen space for compressed buffer (need %d more bytes), disabling. Hint: you may be able to increase stolen memory size in the BIOS to avoid this.\n", size);
819 	return -ENOSPC;
820 }
821 
822 static void intel_fbc_program_cfb(struct intel_fbc *fbc)
823 {
824 	fbc->funcs->program_cfb(fbc);
825 }
826 
827 static void intel_fbc_program_workarounds(struct intel_fbc *fbc)
828 {
829 	struct drm_i915_private *i915 = fbc->i915;
830 
831 	if (IS_SKYLAKE(i915) || IS_BROXTON(i915)) {
832 		/*
833 		 * WaFbcHighMemBwCorruptionAvoidance:skl,bxt
834 		 * Display WA #0883: skl,bxt
835 		 */
836 		intel_de_rmw(i915, ILK_DPFC_CHICKEN(fbc->id),
837 			     0, DPFC_DISABLE_DUMMY0);
838 	}
839 
840 	if (IS_SKYLAKE(i915) || IS_KABYLAKE(i915) ||
841 	    IS_COFFEELAKE(i915) || IS_COMETLAKE(i915)) {
842 		/*
843 		 * WaFbcNukeOnHostModify:skl,kbl,cfl
844 		 * Display WA #0873: skl,kbl,cfl
845 		 */
846 		intel_de_rmw(i915, ILK_DPFC_CHICKEN(fbc->id),
847 			     0, DPFC_NUKE_ON_ANY_MODIFICATION);
848 	}
849 
850 	/* Wa_1409120013:icl,jsl,tgl,dg1 */
851 	if (IS_DISPLAY_VER(i915, 11, 12))
852 		intel_de_rmw(i915, ILK_DPFC_CHICKEN(fbc->id),
853 			     0, DPFC_CHICKEN_COMP_DUMMY_PIXEL);
854 
855 	/* Wa_22014263786:icl,jsl,tgl,dg1,rkl,adls,adlp,mtl */
856 	if (DISPLAY_VER(i915) >= 11 && !IS_DG2(i915))
857 		intel_de_rmw(i915, ILK_DPFC_CHICKEN(fbc->id),
858 			     0, DPFC_CHICKEN_FORCE_SLB_INVALIDATION);
859 }
860 
861 static void __intel_fbc_cleanup_cfb(struct intel_fbc *fbc)
862 {
863 	struct drm_i915_private *i915 = fbc->i915;
864 
865 	if (WARN_ON(intel_fbc_hw_is_active(fbc)))
866 		return;
867 
868 	if (i915_gem_stolen_node_allocated(&fbc->compressed_llb))
869 		i915_gem_stolen_remove_node(i915, &fbc->compressed_llb);
870 	if (i915_gem_stolen_node_allocated(&fbc->compressed_fb))
871 		i915_gem_stolen_remove_node(i915, &fbc->compressed_fb);
872 }
873 
874 void intel_fbc_cleanup(struct drm_i915_private *i915)
875 {
876 	struct intel_fbc *fbc;
877 	enum intel_fbc_id fbc_id;
878 
879 	for_each_intel_fbc(i915, fbc, fbc_id) {
880 		mutex_lock(&fbc->lock);
881 		__intel_fbc_cleanup_cfb(fbc);
882 		mutex_unlock(&fbc->lock);
883 
884 		kfree(fbc);
885 	}
886 }
887 
888 static bool i8xx_fbc_stride_is_valid(const struct intel_plane_state *plane_state)
889 {
890 	const struct drm_framebuffer *fb = plane_state->hw.fb;
891 	unsigned int stride = intel_fbc_plane_stride(plane_state) *
892 		fb->format->cpp[0];
893 
894 	return stride == 4096 || stride == 8192;
895 }
896 
897 static bool i965_fbc_stride_is_valid(const struct intel_plane_state *plane_state)
898 {
899 	const struct drm_framebuffer *fb = plane_state->hw.fb;
900 	unsigned int stride = intel_fbc_plane_stride(plane_state) *
901 		fb->format->cpp[0];
902 
903 	return stride >= 2048 && stride <= 16384;
904 }
905 
906 static bool g4x_fbc_stride_is_valid(const struct intel_plane_state *plane_state)
907 {
908 	return true;
909 }
910 
911 static bool skl_fbc_stride_is_valid(const struct intel_plane_state *plane_state)
912 {
913 	const struct drm_framebuffer *fb = plane_state->hw.fb;
914 	unsigned int stride = intel_fbc_plane_stride(plane_state) *
915 		fb->format->cpp[0];
916 
917 	/* Display WA #1105: skl,bxt,kbl,cfl,glk */
918 	if (fb->modifier == DRM_FORMAT_MOD_LINEAR && stride & 511)
919 		return false;
920 
921 	return true;
922 }
923 
924 static bool icl_fbc_stride_is_valid(const struct intel_plane_state *plane_state)
925 {
926 	return true;
927 }
928 
929 static bool stride_is_valid(const struct intel_plane_state *plane_state)
930 {
931 	struct drm_i915_private *i915 = to_i915(plane_state->uapi.plane->dev);
932 
933 	if (DISPLAY_VER(i915) >= 11)
934 		return icl_fbc_stride_is_valid(plane_state);
935 	else if (DISPLAY_VER(i915) >= 9)
936 		return skl_fbc_stride_is_valid(plane_state);
937 	else if (DISPLAY_VER(i915) >= 5 || IS_G4X(i915))
938 		return g4x_fbc_stride_is_valid(plane_state);
939 	else if (DISPLAY_VER(i915) == 4)
940 		return i965_fbc_stride_is_valid(plane_state);
941 	else
942 		return i8xx_fbc_stride_is_valid(plane_state);
943 }
944 
945 static bool i8xx_fbc_pixel_format_is_valid(const struct intel_plane_state *plane_state)
946 {
947 	struct drm_i915_private *i915 = to_i915(plane_state->uapi.plane->dev);
948 	const struct drm_framebuffer *fb = plane_state->hw.fb;
949 
950 	switch (fb->format->format) {
951 	case DRM_FORMAT_XRGB8888:
952 	case DRM_FORMAT_XBGR8888:
953 		return true;
954 	case DRM_FORMAT_XRGB1555:
955 	case DRM_FORMAT_RGB565:
956 		/* 16bpp not supported on gen2 */
957 		if (DISPLAY_VER(i915) == 2)
958 			return false;
959 		return true;
960 	default:
961 		return false;
962 	}
963 }
964 
965 static bool g4x_fbc_pixel_format_is_valid(const struct intel_plane_state *plane_state)
966 {
967 	struct drm_i915_private *i915 = to_i915(plane_state->uapi.plane->dev);
968 	const struct drm_framebuffer *fb = plane_state->hw.fb;
969 
970 	switch (fb->format->format) {
971 	case DRM_FORMAT_XRGB8888:
972 	case DRM_FORMAT_XBGR8888:
973 		return true;
974 	case DRM_FORMAT_RGB565:
975 		/* WaFbcOnly1to1Ratio:ctg */
976 		if (IS_G4X(i915))
977 			return false;
978 		return true;
979 	default:
980 		return false;
981 	}
982 }
983 
984 static bool lnl_fbc_pixel_format_is_valid(const struct intel_plane_state *plane_state)
985 {
986 	const struct drm_framebuffer *fb = plane_state->hw.fb;
987 
988 	switch (fb->format->format) {
989 	case DRM_FORMAT_XRGB8888:
990 	case DRM_FORMAT_XBGR8888:
991 	case DRM_FORMAT_ARGB8888:
992 	case DRM_FORMAT_ABGR8888:
993 	case DRM_FORMAT_RGB565:
994 		return true;
995 	default:
996 		return false;
997 	}
998 }
999 
1000 static bool pixel_format_is_valid(const struct intel_plane_state *plane_state)
1001 {
1002 	struct drm_i915_private *i915 = to_i915(plane_state->uapi.plane->dev);
1003 
1004 	if (DISPLAY_VER(i915) >= 20)
1005 		return lnl_fbc_pixel_format_is_valid(plane_state);
1006 	else if (DISPLAY_VER(i915) >= 5 || IS_G4X(i915))
1007 		return g4x_fbc_pixel_format_is_valid(plane_state);
1008 	else
1009 		return i8xx_fbc_pixel_format_is_valid(plane_state);
1010 }
1011 
1012 static bool i8xx_fbc_rotation_is_valid(const struct intel_plane_state *plane_state)
1013 {
1014 	return plane_state->hw.rotation == DRM_MODE_ROTATE_0;
1015 }
1016 
1017 static bool g4x_fbc_rotation_is_valid(const struct intel_plane_state *plane_state)
1018 {
1019 	return true;
1020 }
1021 
1022 static bool skl_fbc_rotation_is_valid(const struct intel_plane_state *plane_state)
1023 {
1024 	const struct drm_framebuffer *fb = plane_state->hw.fb;
1025 	unsigned int rotation = plane_state->hw.rotation;
1026 
1027 	if (fb->format->format == DRM_FORMAT_RGB565 &&
1028 	    drm_rotation_90_or_270(rotation))
1029 		return false;
1030 
1031 	return true;
1032 }
1033 
1034 static bool rotation_is_valid(const struct intel_plane_state *plane_state)
1035 {
1036 	struct drm_i915_private *i915 = to_i915(plane_state->uapi.plane->dev);
1037 
1038 	if (DISPLAY_VER(i915) >= 9)
1039 		return skl_fbc_rotation_is_valid(plane_state);
1040 	else if (DISPLAY_VER(i915) >= 5 || IS_G4X(i915))
1041 		return g4x_fbc_rotation_is_valid(plane_state);
1042 	else
1043 		return i8xx_fbc_rotation_is_valid(plane_state);
1044 }
1045 
1046 /*
1047  * For some reason, the hardware tracking starts looking at whatever we
1048  * programmed as the display plane base address register. It does not look at
1049  * the X and Y offset registers. That's why we include the src x/y offsets
1050  * instead of just looking at the plane size.
1051  */
1052 static bool intel_fbc_hw_tracking_covers_screen(const struct intel_plane_state *plane_state)
1053 {
1054 	struct drm_i915_private *i915 = to_i915(plane_state->uapi.plane->dev);
1055 	unsigned int effective_w, effective_h, max_w, max_h;
1056 
1057 	if (DISPLAY_VER(i915) >= 11) {
1058 		max_w = 8192;
1059 		max_h = 4096;
1060 	} else if (DISPLAY_VER(i915) >= 10) {
1061 		max_w = 5120;
1062 		max_h = 4096;
1063 	} else if (DISPLAY_VER(i915) >= 7) {
1064 		max_w = 4096;
1065 		max_h = 4096;
1066 	} else if (IS_G4X(i915) || DISPLAY_VER(i915) >= 5) {
1067 		max_w = 4096;
1068 		max_h = 2048;
1069 	} else {
1070 		max_w = 2048;
1071 		max_h = 1536;
1072 	}
1073 
1074 	effective_w = plane_state->view.color_plane[0].x +
1075 		(drm_rect_width(&plane_state->uapi.src) >> 16);
1076 	effective_h = plane_state->view.color_plane[0].y +
1077 		(drm_rect_height(&plane_state->uapi.src) >> 16);
1078 
1079 	return effective_w <= max_w && effective_h <= max_h;
1080 }
1081 
1082 static bool intel_fbc_plane_size_valid(const struct intel_plane_state *plane_state)
1083 {
1084 	struct drm_i915_private *i915 = to_i915(plane_state->uapi.plane->dev);
1085 	unsigned int w, h, max_w, max_h;
1086 
1087 	if (DISPLAY_VER(i915) >= 10) {
1088 		max_w = 5120;
1089 		max_h = 4096;
1090 	} else if (DISPLAY_VER(i915) >= 8 || IS_HASWELL(i915)) {
1091 		max_w = 4096;
1092 		max_h = 4096;
1093 	} else if (IS_G4X(i915) || DISPLAY_VER(i915) >= 5) {
1094 		max_w = 4096;
1095 		max_h = 2048;
1096 	} else {
1097 		max_w = 2048;
1098 		max_h = 1536;
1099 	}
1100 
1101 	w = drm_rect_width(&plane_state->uapi.src) >> 16;
1102 	h = drm_rect_height(&plane_state->uapi.src) >> 16;
1103 
1104 	return w <= max_w && h <= max_h;
1105 }
1106 
1107 static bool i8xx_fbc_tiling_valid(const struct intel_plane_state *plane_state)
1108 {
1109 	const struct drm_framebuffer *fb = plane_state->hw.fb;
1110 
1111 	return fb->modifier == I915_FORMAT_MOD_X_TILED;
1112 }
1113 
1114 static bool skl_fbc_tiling_valid(const struct intel_plane_state *plane_state)
1115 {
1116 	return true;
1117 }
1118 
1119 static bool tiling_is_valid(const struct intel_plane_state *plane_state)
1120 {
1121 	struct drm_i915_private *i915 = to_i915(plane_state->uapi.plane->dev);
1122 
1123 	if (DISPLAY_VER(i915) >= 9)
1124 		return skl_fbc_tiling_valid(plane_state);
1125 	else
1126 		return i8xx_fbc_tiling_valid(plane_state);
1127 }
1128 
1129 static void intel_fbc_update_state(struct intel_atomic_state *state,
1130 				   struct intel_crtc *crtc,
1131 				   struct intel_plane *plane)
1132 {
1133 	struct drm_i915_private *i915 = to_i915(state->base.dev);
1134 	const struct intel_crtc_state *crtc_state =
1135 		intel_atomic_get_new_crtc_state(state, crtc);
1136 	const struct intel_plane_state *plane_state =
1137 		intel_atomic_get_new_plane_state(state, plane);
1138 	struct intel_fbc *fbc = plane->fbc;
1139 	struct intel_fbc_state *fbc_state = &fbc->state;
1140 
1141 	WARN_ON(plane_state->no_fbc_reason);
1142 	WARN_ON(fbc_state->plane && fbc_state->plane != plane);
1143 
1144 	fbc_state->plane = plane;
1145 
1146 	/* FBC1 compression interval: arbitrary choice of 1 second */
1147 	fbc_state->interval = drm_mode_vrefresh(&crtc_state->hw.adjusted_mode);
1148 
1149 	fbc_state->fence_y_offset = intel_plane_fence_y_offset(plane_state);
1150 
1151 	drm_WARN_ON(&i915->drm, plane_state->flags & PLANE_HAS_FENCE &&
1152 		    !intel_gt_support_legacy_fencing(to_gt(i915)));
1153 
1154 	if (plane_state->flags & PLANE_HAS_FENCE)
1155 		fbc_state->fence_id =  i915_vma_fence_id(plane_state->ggtt_vma);
1156 	else
1157 		fbc_state->fence_id = -1;
1158 
1159 	fbc_state->cfb_stride = intel_fbc_cfb_stride(plane_state);
1160 	fbc_state->cfb_size = intel_fbc_cfb_size(plane_state);
1161 	fbc_state->override_cfb_stride = intel_fbc_override_cfb_stride(plane_state);
1162 }
1163 
1164 static bool intel_fbc_is_fence_ok(const struct intel_plane_state *plane_state)
1165 {
1166 	struct drm_i915_private *i915 = to_i915(plane_state->uapi.plane->dev);
1167 
1168 	/*
1169 	 * The use of a CPU fence is one of two ways to detect writes by the
1170 	 * CPU to the scanout and trigger updates to the FBC.
1171 	 *
1172 	 * The other method is by software tracking (see
1173 	 * intel_fbc_invalidate/flush()), it will manually notify FBC and nuke
1174 	 * the current compressed buffer and recompress it.
1175 	 *
1176 	 * Note that is possible for a tiled surface to be unmappable (and
1177 	 * so have no fence associated with it) due to aperture constraints
1178 	 * at the time of pinning.
1179 	 */
1180 	return DISPLAY_VER(i915) >= 9 ||
1181 		(plane_state->flags & PLANE_HAS_FENCE &&
1182 		 i915_vma_fence_id(plane_state->ggtt_vma) != -1);
1183 }
1184 
1185 static bool intel_fbc_is_cfb_ok(const struct intel_plane_state *plane_state)
1186 {
1187 	struct intel_plane *plane = to_intel_plane(plane_state->uapi.plane);
1188 	struct intel_fbc *fbc = plane->fbc;
1189 
1190 	return intel_fbc_min_limit(plane_state) <= fbc->limit &&
1191 		intel_fbc_cfb_size(plane_state) <= fbc->limit *
1192 			i915_gem_stolen_node_size(&fbc->compressed_fb);
1193 }
1194 
1195 static bool intel_fbc_is_ok(const struct intel_plane_state *plane_state)
1196 {
1197 	return !plane_state->no_fbc_reason &&
1198 		intel_fbc_is_fence_ok(plane_state) &&
1199 		intel_fbc_is_cfb_ok(plane_state);
1200 }
1201 
1202 static int intel_fbc_check_plane(struct intel_atomic_state *state,
1203 				 struct intel_plane *plane)
1204 {
1205 	struct drm_i915_private *i915 = to_i915(state->base.dev);
1206 	struct intel_plane_state *plane_state =
1207 		intel_atomic_get_new_plane_state(state, plane);
1208 	const struct drm_framebuffer *fb = plane_state->hw.fb;
1209 	struct intel_crtc *crtc = to_intel_crtc(plane_state->hw.crtc);
1210 	const struct intel_crtc_state *crtc_state;
1211 	struct intel_fbc *fbc = plane->fbc;
1212 
1213 	if (!fbc)
1214 		return 0;
1215 
1216 	if (!i915_gem_stolen_initialized(i915)) {
1217 		plane_state->no_fbc_reason = "stolen memory not initialised";
1218 		return 0;
1219 	}
1220 
1221 	if (intel_vgpu_active(i915)) {
1222 		plane_state->no_fbc_reason = "VGPU active";
1223 		return 0;
1224 	}
1225 
1226 	if (!i915->display.params.enable_fbc) {
1227 		plane_state->no_fbc_reason = "disabled per module param or by default";
1228 		return 0;
1229 	}
1230 
1231 	if (!plane_state->uapi.visible) {
1232 		plane_state->no_fbc_reason = "plane not visible";
1233 		return 0;
1234 	}
1235 
1236 	crtc_state = intel_atomic_get_new_crtc_state(state, crtc);
1237 
1238 	if (crtc_state->hw.adjusted_mode.flags & DRM_MODE_FLAG_INTERLACE) {
1239 		plane_state->no_fbc_reason = "interlaced mode not supported";
1240 		return 0;
1241 	}
1242 
1243 	if (crtc_state->double_wide) {
1244 		plane_state->no_fbc_reason = "double wide pipe not supported";
1245 		return 0;
1246 	}
1247 
1248 	/*
1249 	 * Display 12+ is not supporting FBC with PSR2.
1250 	 * Recommendation is to keep this combination disabled
1251 	 * Bspec: 50422 HSD: 14010260002
1252 	 */
1253 	if (IS_DISPLAY_VER(i915, 12, 14) && crtc_state->has_psr2) {
1254 		plane_state->no_fbc_reason = "PSR2 enabled";
1255 		return 0;
1256 	}
1257 
1258 	/* Wa_14016291713 */
1259 	if ((IS_DISPLAY_VER(i915, 12, 13) ||
1260 	     IS_DISPLAY_IP_STEP(i915, IP_VER(14, 0), STEP_A0, STEP_C0)) &&
1261 	    crtc_state->has_psr) {
1262 		plane_state->no_fbc_reason = "PSR1 enabled (Wa_14016291713)";
1263 		return 0;
1264 	}
1265 
1266 	if (!pixel_format_is_valid(plane_state)) {
1267 		plane_state->no_fbc_reason = "pixel format not supported";
1268 		return 0;
1269 	}
1270 
1271 	if (!tiling_is_valid(plane_state)) {
1272 		plane_state->no_fbc_reason = "tiling not supported";
1273 		return 0;
1274 	}
1275 
1276 	if (!rotation_is_valid(plane_state)) {
1277 		plane_state->no_fbc_reason = "rotation not supported";
1278 		return 0;
1279 	}
1280 
1281 	if (!stride_is_valid(plane_state)) {
1282 		plane_state->no_fbc_reason = "stride not supported";
1283 		return 0;
1284 	}
1285 
1286 	if (DISPLAY_VER(i915) < 20 &&
1287 	    plane_state->hw.pixel_blend_mode != DRM_MODE_BLEND_PIXEL_NONE &&
1288 	    fb->format->has_alpha) {
1289 		plane_state->no_fbc_reason = "per-pixel alpha not supported";
1290 		return 0;
1291 	}
1292 
1293 	if (!intel_fbc_plane_size_valid(plane_state)) {
1294 		plane_state->no_fbc_reason = "plane size too big";
1295 		return 0;
1296 	}
1297 
1298 	if (!intel_fbc_hw_tracking_covers_screen(plane_state)) {
1299 		plane_state->no_fbc_reason = "surface size too big";
1300 		return 0;
1301 	}
1302 
1303 	/*
1304 	 * Work around a problem on GEN9+ HW, where enabling FBC on a plane
1305 	 * having a Y offset that isn't divisible by 4 causes FIFO underrun
1306 	 * and screen flicker.
1307 	 */
1308 	if (DISPLAY_VER(i915) >= 9 &&
1309 	    plane_state->view.color_plane[0].y & 3) {
1310 		plane_state->no_fbc_reason = "plane start Y offset misaligned";
1311 		return 0;
1312 	}
1313 
1314 	/* Wa_22010751166: icl, ehl, tgl, dg1, rkl */
1315 	if (DISPLAY_VER(i915) >= 11 &&
1316 	    (plane_state->view.color_plane[0].y +
1317 	     (drm_rect_height(&plane_state->uapi.src) >> 16)) & 3) {
1318 		plane_state->no_fbc_reason = "plane end Y offset misaligned";
1319 		return 0;
1320 	}
1321 
1322 	/* WaFbcExceedCdClockThreshold:hsw,bdw */
1323 	if (IS_HASWELL(i915) || IS_BROADWELL(i915)) {
1324 		const struct intel_cdclk_state *cdclk_state;
1325 
1326 		cdclk_state = intel_atomic_get_cdclk_state(state);
1327 		if (IS_ERR(cdclk_state))
1328 			return PTR_ERR(cdclk_state);
1329 
1330 		if (crtc_state->pixel_rate >= cdclk_state->logical.cdclk * 95 / 100) {
1331 			plane_state->no_fbc_reason = "pixel rate too high";
1332 			return 0;
1333 		}
1334 	}
1335 
1336 	plane_state->no_fbc_reason = NULL;
1337 
1338 	return 0;
1339 }
1340 
1341 
1342 static bool intel_fbc_can_flip_nuke(struct intel_atomic_state *state,
1343 				    struct intel_crtc *crtc,
1344 				    struct intel_plane *plane)
1345 {
1346 	const struct intel_crtc_state *new_crtc_state =
1347 		intel_atomic_get_new_crtc_state(state, crtc);
1348 	const struct intel_plane_state *old_plane_state =
1349 		intel_atomic_get_old_plane_state(state, plane);
1350 	const struct intel_plane_state *new_plane_state =
1351 		intel_atomic_get_new_plane_state(state, plane);
1352 	const struct drm_framebuffer *old_fb = old_plane_state->hw.fb;
1353 	const struct drm_framebuffer *new_fb = new_plane_state->hw.fb;
1354 
1355 	if (intel_crtc_needs_modeset(new_crtc_state))
1356 		return false;
1357 
1358 	if (!intel_fbc_is_ok(old_plane_state) ||
1359 	    !intel_fbc_is_ok(new_plane_state))
1360 		return false;
1361 
1362 	if (old_fb->format->format != new_fb->format->format)
1363 		return false;
1364 
1365 	if (old_fb->modifier != new_fb->modifier)
1366 		return false;
1367 
1368 	if (intel_fbc_plane_stride(old_plane_state) !=
1369 	    intel_fbc_plane_stride(new_plane_state))
1370 		return false;
1371 
1372 	if (intel_fbc_cfb_stride(old_plane_state) !=
1373 	    intel_fbc_cfb_stride(new_plane_state))
1374 		return false;
1375 
1376 	if (intel_fbc_cfb_size(old_plane_state) !=
1377 	    intel_fbc_cfb_size(new_plane_state))
1378 		return false;
1379 
1380 	if (intel_fbc_override_cfb_stride(old_plane_state) !=
1381 	    intel_fbc_override_cfb_stride(new_plane_state))
1382 		return false;
1383 
1384 	return true;
1385 }
1386 
1387 static bool __intel_fbc_pre_update(struct intel_atomic_state *state,
1388 				   struct intel_crtc *crtc,
1389 				   struct intel_plane *plane)
1390 {
1391 	struct drm_i915_private *i915 = to_i915(state->base.dev);
1392 	struct intel_fbc *fbc = plane->fbc;
1393 	bool need_vblank_wait = false;
1394 
1395 	lockdep_assert_held(&fbc->lock);
1396 
1397 	fbc->flip_pending = true;
1398 
1399 	if (intel_fbc_can_flip_nuke(state, crtc, plane))
1400 		return need_vblank_wait;
1401 
1402 	intel_fbc_deactivate(fbc, "update pending");
1403 
1404 	/*
1405 	 * Display WA #1198: glk+
1406 	 * Need an extra vblank wait between FBC disable and most plane
1407 	 * updates. Bspec says this is only needed for plane disable, but
1408 	 * that is not true. Touching most plane registers will cause the
1409 	 * corruption to appear. Also SKL/derivatives do not seem to be
1410 	 * affected.
1411 	 *
1412 	 * TODO: could optimize this a bit by sampling the frame
1413 	 * counter when we disable FBC (if it was already done earlier)
1414 	 * and skipping the extra vblank wait before the plane update
1415 	 * if at least one frame has already passed.
1416 	 */
1417 	if (fbc->activated && DISPLAY_VER(i915) >= 10)
1418 		need_vblank_wait = true;
1419 	fbc->activated = false;
1420 
1421 	return need_vblank_wait;
1422 }
1423 
1424 bool intel_fbc_pre_update(struct intel_atomic_state *state,
1425 			  struct intel_crtc *crtc)
1426 {
1427 	const struct intel_plane_state __maybe_unused *plane_state;
1428 	bool need_vblank_wait = false;
1429 	struct intel_plane *plane;
1430 	int i;
1431 
1432 	for_each_new_intel_plane_in_state(state, plane, plane_state, i) {
1433 		struct intel_fbc *fbc = plane->fbc;
1434 
1435 		if (!fbc || plane->pipe != crtc->pipe)
1436 			continue;
1437 
1438 		mutex_lock(&fbc->lock);
1439 
1440 		if (fbc->state.plane == plane)
1441 			need_vblank_wait |= __intel_fbc_pre_update(state, crtc, plane);
1442 
1443 		mutex_unlock(&fbc->lock);
1444 	}
1445 
1446 	return need_vblank_wait;
1447 }
1448 
1449 static void __intel_fbc_disable(struct intel_fbc *fbc)
1450 {
1451 	struct drm_i915_private *i915 = fbc->i915;
1452 	struct intel_plane *plane = fbc->state.plane;
1453 
1454 	lockdep_assert_held(&fbc->lock);
1455 	drm_WARN_ON(&i915->drm, fbc->active);
1456 
1457 	drm_dbg_kms(&i915->drm, "Disabling FBC on [PLANE:%d:%s]\n",
1458 		    plane->base.base.id, plane->base.name);
1459 
1460 	__intel_fbc_cleanup_cfb(fbc);
1461 
1462 	fbc->state.plane = NULL;
1463 	fbc->flip_pending = false;
1464 	fbc->busy_bits = 0;
1465 }
1466 
1467 static void __intel_fbc_post_update(struct intel_fbc *fbc)
1468 {
1469 	lockdep_assert_held(&fbc->lock);
1470 
1471 	fbc->flip_pending = false;
1472 	fbc->busy_bits = 0;
1473 
1474 	intel_fbc_activate(fbc);
1475 }
1476 
1477 void intel_fbc_post_update(struct intel_atomic_state *state,
1478 			   struct intel_crtc *crtc)
1479 {
1480 	const struct intel_plane_state __maybe_unused *plane_state;
1481 	struct intel_plane *plane;
1482 	int i;
1483 
1484 	for_each_new_intel_plane_in_state(state, plane, plane_state, i) {
1485 		struct intel_fbc *fbc = plane->fbc;
1486 
1487 		if (!fbc || plane->pipe != crtc->pipe)
1488 			continue;
1489 
1490 		mutex_lock(&fbc->lock);
1491 
1492 		if (fbc->state.plane == plane)
1493 			__intel_fbc_post_update(fbc);
1494 
1495 		mutex_unlock(&fbc->lock);
1496 	}
1497 }
1498 
1499 static unsigned int intel_fbc_get_frontbuffer_bit(struct intel_fbc *fbc)
1500 {
1501 	if (fbc->state.plane)
1502 		return fbc->state.plane->frontbuffer_bit;
1503 	else
1504 		return 0;
1505 }
1506 
1507 static void __intel_fbc_invalidate(struct intel_fbc *fbc,
1508 				   unsigned int frontbuffer_bits,
1509 				   enum fb_op_origin origin)
1510 {
1511 	if (origin == ORIGIN_FLIP || origin == ORIGIN_CURSOR_UPDATE)
1512 		return;
1513 
1514 	mutex_lock(&fbc->lock);
1515 
1516 	frontbuffer_bits &= intel_fbc_get_frontbuffer_bit(fbc);
1517 	if (!frontbuffer_bits)
1518 		goto out;
1519 
1520 	fbc->busy_bits |= frontbuffer_bits;
1521 	intel_fbc_deactivate(fbc, "frontbuffer write");
1522 
1523 out:
1524 	mutex_unlock(&fbc->lock);
1525 }
1526 
1527 void intel_fbc_invalidate(struct drm_i915_private *i915,
1528 			  unsigned int frontbuffer_bits,
1529 			  enum fb_op_origin origin)
1530 {
1531 	struct intel_fbc *fbc;
1532 	enum intel_fbc_id fbc_id;
1533 
1534 	for_each_intel_fbc(i915, fbc, fbc_id)
1535 		__intel_fbc_invalidate(fbc, frontbuffer_bits, origin);
1536 
1537 }
1538 
1539 static void __intel_fbc_flush(struct intel_fbc *fbc,
1540 			      unsigned int frontbuffer_bits,
1541 			      enum fb_op_origin origin)
1542 {
1543 	mutex_lock(&fbc->lock);
1544 
1545 	frontbuffer_bits &= intel_fbc_get_frontbuffer_bit(fbc);
1546 	if (!frontbuffer_bits)
1547 		goto out;
1548 
1549 	fbc->busy_bits &= ~frontbuffer_bits;
1550 
1551 	if (origin == ORIGIN_FLIP || origin == ORIGIN_CURSOR_UPDATE)
1552 		goto out;
1553 
1554 	if (fbc->busy_bits || fbc->flip_pending)
1555 		goto out;
1556 
1557 	if (fbc->active)
1558 		intel_fbc_nuke(fbc);
1559 	else
1560 		intel_fbc_activate(fbc);
1561 
1562 out:
1563 	mutex_unlock(&fbc->lock);
1564 }
1565 
1566 void intel_fbc_flush(struct drm_i915_private *i915,
1567 		     unsigned int frontbuffer_bits,
1568 		     enum fb_op_origin origin)
1569 {
1570 	struct intel_fbc *fbc;
1571 	enum intel_fbc_id fbc_id;
1572 
1573 	for_each_intel_fbc(i915, fbc, fbc_id)
1574 		__intel_fbc_flush(fbc, frontbuffer_bits, origin);
1575 }
1576 
1577 int intel_fbc_atomic_check(struct intel_atomic_state *state)
1578 {
1579 	struct intel_plane_state __maybe_unused *plane_state;
1580 	struct intel_plane *plane;
1581 	int i;
1582 
1583 	for_each_new_intel_plane_in_state(state, plane, plane_state, i) {
1584 		int ret;
1585 
1586 		ret = intel_fbc_check_plane(state, plane);
1587 		if (ret)
1588 			return ret;
1589 	}
1590 
1591 	return 0;
1592 }
1593 
1594 static void __intel_fbc_enable(struct intel_atomic_state *state,
1595 			       struct intel_crtc *crtc,
1596 			       struct intel_plane *plane)
1597 {
1598 	struct drm_i915_private *i915 = to_i915(state->base.dev);
1599 	const struct intel_plane_state *plane_state =
1600 		intel_atomic_get_new_plane_state(state, plane);
1601 	struct intel_fbc *fbc = plane->fbc;
1602 
1603 	lockdep_assert_held(&fbc->lock);
1604 
1605 	if (fbc->state.plane) {
1606 		if (fbc->state.plane != plane)
1607 			return;
1608 
1609 		if (intel_fbc_is_ok(plane_state)) {
1610 			intel_fbc_update_state(state, crtc, plane);
1611 			return;
1612 		}
1613 
1614 		__intel_fbc_disable(fbc);
1615 	}
1616 
1617 	drm_WARN_ON(&i915->drm, fbc->active);
1618 
1619 	fbc->no_fbc_reason = plane_state->no_fbc_reason;
1620 	if (fbc->no_fbc_reason)
1621 		return;
1622 
1623 	if (!intel_fbc_is_fence_ok(plane_state)) {
1624 		fbc->no_fbc_reason = "framebuffer not fenced";
1625 		return;
1626 	}
1627 
1628 	if (fbc->underrun_detected) {
1629 		fbc->no_fbc_reason = "FIFO underrun";
1630 		return;
1631 	}
1632 
1633 	if (intel_fbc_alloc_cfb(fbc, intel_fbc_cfb_size(plane_state),
1634 				intel_fbc_min_limit(plane_state))) {
1635 		fbc->no_fbc_reason = "not enough stolen memory";
1636 		return;
1637 	}
1638 
1639 	drm_dbg_kms(&i915->drm, "Enabling FBC on [PLANE:%d:%s]\n",
1640 		    plane->base.base.id, plane->base.name);
1641 	fbc->no_fbc_reason = "FBC enabled but not active yet\n";
1642 
1643 	intel_fbc_update_state(state, crtc, plane);
1644 
1645 	intel_fbc_program_workarounds(fbc);
1646 	intel_fbc_program_cfb(fbc);
1647 }
1648 
1649 /**
1650  * intel_fbc_disable - disable FBC if it's associated with crtc
1651  * @crtc: the CRTC
1652  *
1653  * This function disables FBC if it's associated with the provided CRTC.
1654  */
1655 void intel_fbc_disable(struct intel_crtc *crtc)
1656 {
1657 	struct drm_i915_private *i915 = to_i915(crtc->base.dev);
1658 	struct intel_plane *plane;
1659 
1660 	for_each_intel_plane(&i915->drm, plane) {
1661 		struct intel_fbc *fbc = plane->fbc;
1662 
1663 		if (!fbc || plane->pipe != crtc->pipe)
1664 			continue;
1665 
1666 		mutex_lock(&fbc->lock);
1667 		if (fbc->state.plane == plane)
1668 			__intel_fbc_disable(fbc);
1669 		mutex_unlock(&fbc->lock);
1670 	}
1671 }
1672 
1673 void intel_fbc_update(struct intel_atomic_state *state,
1674 		      struct intel_crtc *crtc)
1675 {
1676 	const struct intel_crtc_state *crtc_state =
1677 		intel_atomic_get_new_crtc_state(state, crtc);
1678 	const struct intel_plane_state *plane_state;
1679 	struct intel_plane *plane;
1680 	int i;
1681 
1682 	for_each_new_intel_plane_in_state(state, plane, plane_state, i) {
1683 		struct intel_fbc *fbc = plane->fbc;
1684 
1685 		if (!fbc || plane->pipe != crtc->pipe)
1686 			continue;
1687 
1688 		mutex_lock(&fbc->lock);
1689 
1690 		if (intel_crtc_needs_fastset(crtc_state) &&
1691 		    plane_state->no_fbc_reason) {
1692 			if (fbc->state.plane == plane)
1693 				__intel_fbc_disable(fbc);
1694 		} else {
1695 			__intel_fbc_enable(state, crtc, plane);
1696 		}
1697 
1698 		mutex_unlock(&fbc->lock);
1699 	}
1700 }
1701 
1702 static void intel_fbc_underrun_work_fn(struct work_struct *work)
1703 {
1704 	struct intel_fbc *fbc = container_of(work, typeof(*fbc), underrun_work);
1705 	struct drm_i915_private *i915 = fbc->i915;
1706 
1707 	mutex_lock(&fbc->lock);
1708 
1709 	/* Maybe we were scheduled twice. */
1710 	if (fbc->underrun_detected || !fbc->state.plane)
1711 		goto out;
1712 
1713 	drm_dbg_kms(&i915->drm, "Disabling FBC due to FIFO underrun.\n");
1714 	fbc->underrun_detected = true;
1715 
1716 	intel_fbc_deactivate(fbc, "FIFO underrun");
1717 	if (!fbc->flip_pending)
1718 		intel_crtc_wait_for_next_vblank(intel_crtc_for_pipe(i915, fbc->state.plane->pipe));
1719 	__intel_fbc_disable(fbc);
1720 out:
1721 	mutex_unlock(&fbc->lock);
1722 }
1723 
1724 static void __intel_fbc_reset_underrun(struct intel_fbc *fbc)
1725 {
1726 	struct drm_i915_private *i915 = fbc->i915;
1727 
1728 	cancel_work_sync(&fbc->underrun_work);
1729 
1730 	mutex_lock(&fbc->lock);
1731 
1732 	if (fbc->underrun_detected) {
1733 		drm_dbg_kms(&i915->drm,
1734 			    "Re-allowing FBC after fifo underrun\n");
1735 		fbc->no_fbc_reason = "FIFO underrun cleared";
1736 	}
1737 
1738 	fbc->underrun_detected = false;
1739 	mutex_unlock(&fbc->lock);
1740 }
1741 
1742 /*
1743  * intel_fbc_reset_underrun - reset FBC fifo underrun status.
1744  * @i915: the i915 device
1745  *
1746  * See intel_fbc_handle_fifo_underrun_irq(). For automated testing we
1747  * want to re-enable FBC after an underrun to increase test coverage.
1748  */
1749 void intel_fbc_reset_underrun(struct drm_i915_private *i915)
1750 {
1751 	struct intel_fbc *fbc;
1752 	enum intel_fbc_id fbc_id;
1753 
1754 	for_each_intel_fbc(i915, fbc, fbc_id)
1755 		__intel_fbc_reset_underrun(fbc);
1756 }
1757 
1758 static void __intel_fbc_handle_fifo_underrun_irq(struct intel_fbc *fbc)
1759 {
1760 	/*
1761 	 * There's no guarantee that underrun_detected won't be set to true
1762 	 * right after this check and before the work is scheduled, but that's
1763 	 * not a problem since we'll check it again under the work function
1764 	 * while FBC is locked. This check here is just to prevent us from
1765 	 * unnecessarily scheduling the work, and it relies on the fact that we
1766 	 * never switch underrun_detect back to false after it's true.
1767 	 */
1768 	if (READ_ONCE(fbc->underrun_detected))
1769 		return;
1770 
1771 	queue_work(fbc->i915->unordered_wq, &fbc->underrun_work);
1772 }
1773 
1774 /**
1775  * intel_fbc_handle_fifo_underrun_irq - disable FBC when we get a FIFO underrun
1776  * @i915: i915 device
1777  *
1778  * Without FBC, most underruns are harmless and don't really cause too many
1779  * problems, except for an annoying message on dmesg. With FBC, underruns can
1780  * become black screens or even worse, especially when paired with bad
1781  * watermarks. So in order for us to be on the safe side, completely disable FBC
1782  * in case we ever detect a FIFO underrun on any pipe. An underrun on any pipe
1783  * already suggests that watermarks may be bad, so try to be as safe as
1784  * possible.
1785  *
1786  * This function is called from the IRQ handler.
1787  */
1788 void intel_fbc_handle_fifo_underrun_irq(struct drm_i915_private *i915)
1789 {
1790 	struct intel_fbc *fbc;
1791 	enum intel_fbc_id fbc_id;
1792 
1793 	for_each_intel_fbc(i915, fbc, fbc_id)
1794 		__intel_fbc_handle_fifo_underrun_irq(fbc);
1795 }
1796 
1797 /*
1798  * The DDX driver changes its behavior depending on the value it reads from
1799  * i915.enable_fbc, so sanitize it by translating the default value into either
1800  * 0 or 1 in order to allow it to know what's going on.
1801  *
1802  * Notice that this is done at driver initialization and we still allow user
1803  * space to change the value during runtime without sanitizing it again. IGT
1804  * relies on being able to change i915.enable_fbc at runtime.
1805  */
1806 static int intel_sanitize_fbc_option(struct drm_i915_private *i915)
1807 {
1808 	if (i915->display.params.enable_fbc >= 0)
1809 		return !!i915->display.params.enable_fbc;
1810 
1811 	if (!HAS_FBC(i915))
1812 		return 0;
1813 
1814 	if (IS_BROADWELL(i915) || DISPLAY_VER(i915) >= 9)
1815 		return 1;
1816 
1817 	return 0;
1818 }
1819 
1820 static bool need_fbc_vtd_wa(struct drm_i915_private *i915)
1821 {
1822 	/* WaFbcTurnOffFbcWhenHyperVisorIsUsed:skl,bxt */
1823 	if (i915_vtd_active(i915) &&
1824 	    (IS_SKYLAKE(i915) || IS_BROXTON(i915))) {
1825 		drm_info(&i915->drm,
1826 			 "Disabling framebuffer compression (FBC) to prevent screen flicker with VT-d enabled\n");
1827 		return true;
1828 	}
1829 
1830 	return false;
1831 }
1832 
1833 void intel_fbc_add_plane(struct intel_fbc *fbc, struct intel_plane *plane)
1834 {
1835 	plane->fbc = fbc;
1836 }
1837 
1838 static struct intel_fbc *intel_fbc_create(struct drm_i915_private *i915,
1839 					  enum intel_fbc_id fbc_id)
1840 {
1841 	struct intel_fbc *fbc;
1842 
1843 	fbc = kzalloc(sizeof(*fbc), GFP_KERNEL);
1844 	if (!fbc)
1845 		return NULL;
1846 
1847 	fbc->id = fbc_id;
1848 	fbc->i915 = i915;
1849 	INIT_WORK(&fbc->underrun_work, intel_fbc_underrun_work_fn);
1850 	mutex_init(&fbc->lock);
1851 
1852 	if (DISPLAY_VER(i915) >= 7)
1853 		fbc->funcs = &ivb_fbc_funcs;
1854 	else if (DISPLAY_VER(i915) == 6)
1855 		fbc->funcs = &snb_fbc_funcs;
1856 	else if (DISPLAY_VER(i915) == 5)
1857 		fbc->funcs = &ilk_fbc_funcs;
1858 	else if (IS_G4X(i915))
1859 		fbc->funcs = &g4x_fbc_funcs;
1860 	else if (DISPLAY_VER(i915) == 4)
1861 		fbc->funcs = &i965_fbc_funcs;
1862 	else
1863 		fbc->funcs = &i8xx_fbc_funcs;
1864 
1865 	return fbc;
1866 }
1867 
1868 /**
1869  * intel_fbc_init - Initialize FBC
1870  * @i915: the i915 device
1871  *
1872  * This function might be called during PM init process.
1873  */
1874 void intel_fbc_init(struct drm_i915_private *i915)
1875 {
1876 	enum intel_fbc_id fbc_id;
1877 
1878 	if (need_fbc_vtd_wa(i915))
1879 		DISPLAY_RUNTIME_INFO(i915)->fbc_mask = 0;
1880 
1881 	i915->display.params.enable_fbc = intel_sanitize_fbc_option(i915);
1882 	drm_dbg_kms(&i915->drm, "Sanitized enable_fbc value: %d\n",
1883 		    i915->display.params.enable_fbc);
1884 
1885 	for_each_fbc_id(i915, fbc_id)
1886 		i915->display.fbc[fbc_id] = intel_fbc_create(i915, fbc_id);
1887 }
1888 
1889 /**
1890  * intel_fbc_sanitize - Sanitize FBC
1891  * @i915: the i915 device
1892  *
1893  * Make sure FBC is initially disabled since we have no
1894  * idea eg. into which parts of stolen it might be scribbling
1895  * into.
1896  */
1897 void intel_fbc_sanitize(struct drm_i915_private *i915)
1898 {
1899 	struct intel_fbc *fbc;
1900 	enum intel_fbc_id fbc_id;
1901 
1902 	for_each_intel_fbc(i915, fbc, fbc_id) {
1903 		if (intel_fbc_hw_is_active(fbc))
1904 			intel_fbc_hw_deactivate(fbc);
1905 	}
1906 }
1907 
1908 static int intel_fbc_debugfs_status_show(struct seq_file *m, void *unused)
1909 {
1910 	struct intel_fbc *fbc = m->private;
1911 	struct drm_i915_private *i915 = fbc->i915;
1912 	struct intel_plane *plane;
1913 	intel_wakeref_t wakeref;
1914 
1915 	drm_modeset_lock_all(&i915->drm);
1916 
1917 	wakeref = intel_runtime_pm_get(&i915->runtime_pm);
1918 	mutex_lock(&fbc->lock);
1919 
1920 	if (fbc->active) {
1921 		seq_puts(m, "FBC enabled\n");
1922 		seq_printf(m, "Compressing: %s\n",
1923 			   str_yes_no(intel_fbc_is_compressing(fbc)));
1924 	} else {
1925 		seq_printf(m, "FBC disabled: %s\n", fbc->no_fbc_reason);
1926 	}
1927 
1928 	for_each_intel_plane(&i915->drm, plane) {
1929 		const struct intel_plane_state *plane_state =
1930 			to_intel_plane_state(plane->base.state);
1931 
1932 		if (plane->fbc != fbc)
1933 			continue;
1934 
1935 		seq_printf(m, "%c [PLANE:%d:%s]: %s\n",
1936 			   fbc->state.plane == plane ? '*' : ' ',
1937 			   plane->base.base.id, plane->base.name,
1938 			   plane_state->no_fbc_reason ?: "FBC possible");
1939 	}
1940 
1941 	mutex_unlock(&fbc->lock);
1942 	intel_runtime_pm_put(&i915->runtime_pm, wakeref);
1943 
1944 	drm_modeset_unlock_all(&i915->drm);
1945 
1946 	return 0;
1947 }
1948 
1949 DEFINE_SHOW_ATTRIBUTE(intel_fbc_debugfs_status);
1950 
1951 static int intel_fbc_debugfs_false_color_get(void *data, u64 *val)
1952 {
1953 	struct intel_fbc *fbc = data;
1954 
1955 	*val = fbc->false_color;
1956 
1957 	return 0;
1958 }
1959 
1960 static int intel_fbc_debugfs_false_color_set(void *data, u64 val)
1961 {
1962 	struct intel_fbc *fbc = data;
1963 
1964 	mutex_lock(&fbc->lock);
1965 
1966 	fbc->false_color = val;
1967 
1968 	if (fbc->active)
1969 		fbc->funcs->set_false_color(fbc, fbc->false_color);
1970 
1971 	mutex_unlock(&fbc->lock);
1972 
1973 	return 0;
1974 }
1975 
1976 DEFINE_DEBUGFS_ATTRIBUTE(intel_fbc_debugfs_false_color_fops,
1977 			 intel_fbc_debugfs_false_color_get,
1978 			 intel_fbc_debugfs_false_color_set,
1979 			 "%llu\n");
1980 
1981 static void intel_fbc_debugfs_add(struct intel_fbc *fbc,
1982 				  struct dentry *parent)
1983 {
1984 	debugfs_create_file("i915_fbc_status", 0444, parent,
1985 			    fbc, &intel_fbc_debugfs_status_fops);
1986 
1987 	if (fbc->funcs->set_false_color)
1988 		debugfs_create_file_unsafe("i915_fbc_false_color", 0644, parent,
1989 					   fbc, &intel_fbc_debugfs_false_color_fops);
1990 }
1991 
1992 void intel_fbc_crtc_debugfs_add(struct intel_crtc *crtc)
1993 {
1994 	struct intel_plane *plane = to_intel_plane(crtc->base.primary);
1995 
1996 	if (plane->fbc)
1997 		intel_fbc_debugfs_add(plane->fbc, crtc->base.debugfs_entry);
1998 }
1999 
2000 /* FIXME: remove this once igt is on board with per-crtc stuff */
2001 void intel_fbc_debugfs_register(struct drm_i915_private *i915)
2002 {
2003 	struct drm_minor *minor = i915->drm.primary;
2004 	struct intel_fbc *fbc;
2005 
2006 	fbc = i915->display.fbc[INTEL_FBC_A];
2007 	if (fbc)
2008 		intel_fbc_debugfs_add(fbc, minor->debugfs_root);
2009 }
2010