intel_fbc.c 38.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/*
 * Copyright © 2014 Intel Corporation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

R
Rodrigo Vivi 已提交
24 25 26 27 28 29
/**
 * DOC: Frame Buffer Compression (FBC)
 *
 * FBC tries to save memory bandwidth (and so power consumption) by
 * compressing the amount of memory used by the display. It is total
 * transparent to user space and completely handled in the kernel.
30 31
 *
 * The benefits of FBC are mostly visible with solid backgrounds and
R
Rodrigo Vivi 已提交
32 33
 * variation-less patterns. It comes from keeping the memory footprint small
 * and having fewer memory pages opened and accessed for refreshing the display.
34
 *
R
Rodrigo Vivi 已提交
35 36 37 38
 * i915 is responsible to reserve stolen memory for FBC and configure its
 * offset on proper registers. The hardware takes care of all
 * compress/decompress. However there are many known cases where we have to
 * forcibly disable it to allow proper screen updates.
39 40
 */

41 42
#include <drm/drm_fourcc.h>

R
Rodrigo Vivi 已提交
43
#include "i915_drv.h"
44
#include "i915_trace.h"
45
#include "intel_display_types.h"
46
#include "intel_fbc.h"
47
#include "intel_frontbuffer.h"
R
Rodrigo Vivi 已提交
48

49 50 51 52 53 54 55 56
/*
 * In some platforms where the CRTC's x:0/y:0 coordinates doesn't match the
 * frontbuffer's x:0/y:0 coordinates we lie to the hardware about the plane's
 * origin so the x and y offsets can actually fit the registers. As a
 * consequence, the fence doesn't really start exactly at the display plane
 * address we program because it starts at the real start of the buffer, so we
 * have to take this into consideration here.
 */
57
static unsigned int get_crtc_fence_y_offset(struct intel_fbc *fbc)
58
{
59
	return fbc->state_cache.plane.y - fbc->state_cache.plane.adjusted_y;
60 61
}

62 63 64 65 66
/*
 * For SKL+, the plane source size used by the hardware is based on the value we
 * write to the PLANE_SIZE register. For BDW-, the hardware looks at the value
 * we wrote to PIPESRC.
 */
67
static void intel_fbc_get_plane_source_size(const struct intel_fbc_state_cache *cache,
68 69 70
					    int *width, int *height)
{
	if (width)
71
		*width = cache->plane.src_w;
72
	if (height)
73
		*height = cache->plane.src_h;
74 75
}

76
static int intel_fbc_calculate_cfb_size(struct drm_i915_private *dev_priv,
77
					const struct intel_fbc_state_cache *cache)
78 79 80
{
	int lines;

81
	intel_fbc_get_plane_source_size(cache, NULL, &lines);
82
	if (IS_GEN(dev_priv, 7))
83
		lines = min(lines, 2048);
84 85
	else if (INTEL_GEN(dev_priv) >= 8)
		lines = min(lines, 2560);
86 87

	/* Hardware needs the full buffer stride, not just the active area. */
88
	return lines * cache->fb.stride;
89 90
}

91
static void i8xx_fbc_deactivate(struct drm_i915_private *dev_priv)
92 93 94 95 96 97 98 99 100 101 102 103
{
	u32 fbc_ctl;

	/* Disable compression */
	fbc_ctl = I915_READ(FBC_CONTROL);
	if ((fbc_ctl & FBC_CTL_EN) == 0)
		return;

	fbc_ctl &= ~FBC_CTL_EN;
	I915_WRITE(FBC_CONTROL, fbc_ctl);

	/* Wait for compressing bit to clear */
104 105
	if (intel_de_wait_for_clear(dev_priv, FBC_STATUS,
				    FBC_STAT_COMPRESSING, 10)) {
106 107 108 109 110
		DRM_DEBUG_KMS("FBC idle timed out\n");
		return;
	}
}

111
static void i8xx_fbc_activate(struct drm_i915_private *dev_priv)
112
{
113
	struct intel_fbc_reg_params *params = &dev_priv->fbc.params;
114 115 116 117
	int cfb_pitch;
	int i;
	u32 fbc_ctl;

118
	/* Note: fbc.threshold == 1 for i8xx */
119 120 121
	cfb_pitch = params->cfb_size / FBC_LL_SIZE;
	if (params->fb.stride < cfb_pitch)
		cfb_pitch = params->fb.stride;
122 123

	/* FBC_CTL wants 32B or 64B units */
124
	if (IS_GEN(dev_priv, 2))
125 126 127 128 129 130
		cfb_pitch = (cfb_pitch / 32) - 1;
	else
		cfb_pitch = (cfb_pitch / 64) - 1;

	/* Clear old tags */
	for (i = 0; i < (FBC_LL_SIZE / 32) + 1; i++)
131
		I915_WRITE(FBC_TAG(i), 0);
132

133
	if (IS_GEN(dev_priv, 4)) {
134 135 136
		u32 fbc_ctl2;

		/* Set it up... */
137
		fbc_ctl2 = FBC_CTL_FENCE_DBL | FBC_CTL_IDLE_IMM;
138
		fbc_ctl2 |= FBC_CTL_PLANE(params->crtc.i9xx_plane);
139 140
		if (params->fence_id >= 0)
			fbc_ctl2 |= FBC_CTL_CPU_FENCE;
141
		I915_WRITE(FBC_CONTROL2, fbc_ctl2);
142
		I915_WRITE(FBC_FENCE_OFF, params->crtc.fence_y_offset);
143 144 145 146 147 148
	}

	/* enable it... */
	fbc_ctl = I915_READ(FBC_CONTROL);
	fbc_ctl &= 0x3fff << FBC_CTL_INTERVAL_SHIFT;
	fbc_ctl |= FBC_CTL_EN | FBC_CTL_PERIODIC;
149
	if (IS_I945GM(dev_priv))
150 151
		fbc_ctl |= FBC_CTL_C3_IDLE; /* 945 needs special SR handling */
	fbc_ctl |= (cfb_pitch & 0xff) << FBC_CTL_STRIDE_SHIFT;
152 153
	if (params->fence_id >= 0)
		fbc_ctl |= params->fence_id;
154 155 156
	I915_WRITE(FBC_CONTROL, fbc_ctl);
}

157
static bool i8xx_fbc_is_active(struct drm_i915_private *dev_priv)
158 159 160 161
{
	return I915_READ(FBC_CONTROL) & FBC_CTL_EN;
}

162
static void g4x_fbc_activate(struct drm_i915_private *dev_priv)
163
{
164
	struct intel_fbc_reg_params *params = &dev_priv->fbc.params;
165 166
	u32 dpfc_ctl;

167
	dpfc_ctl = DPFC_CTL_PLANE(params->crtc.i9xx_plane) | DPFC_SR_EN;
168
	if (params->fb.format->cpp[0] == 2)
169 170 171 172
		dpfc_ctl |= DPFC_CTL_LIMIT_2X;
	else
		dpfc_ctl |= DPFC_CTL_LIMIT_1X;

173 174
	if (params->fence_id >= 0) {
		dpfc_ctl |= DPFC_CTL_FENCE_EN | params->fence_id;
175 176 177 178
		I915_WRITE(DPFC_FENCE_YOFF, params->crtc.fence_y_offset);
	} else {
		I915_WRITE(DPFC_FENCE_YOFF, 0);
	}
179 180 181 182 183

	/* enable it... */
	I915_WRITE(DPFC_CONTROL, dpfc_ctl | DPFC_CTL_EN);
}

184
static void g4x_fbc_deactivate(struct drm_i915_private *dev_priv)
185 186 187 188 189 190 191 192 193 194 195
{
	u32 dpfc_ctl;

	/* Disable compression */
	dpfc_ctl = I915_READ(DPFC_CONTROL);
	if (dpfc_ctl & DPFC_CTL_EN) {
		dpfc_ctl &= ~DPFC_CTL_EN;
		I915_WRITE(DPFC_CONTROL, dpfc_ctl);
	}
}

196
static bool g4x_fbc_is_active(struct drm_i915_private *dev_priv)
197 198 199 200
{
	return I915_READ(DPFC_CONTROL) & DPFC_CTL_EN;
}

201 202
/* This function forces a CFB recompression through the nuke operation. */
static void intel_fbc_recompress(struct drm_i915_private *dev_priv)
203
{
204 205 206 207
	struct intel_fbc *fbc = &dev_priv->fbc;

	trace_intel_fbc_nuke(fbc->crtc);

208 209
	I915_WRITE(MSG_FBC_REND_STATE, FBC_REND_NUKE);
	POSTING_READ(MSG_FBC_REND_STATE);
210 211
}

212
static void ilk_fbc_activate(struct drm_i915_private *dev_priv)
213
{
214
	struct intel_fbc_reg_params *params = &dev_priv->fbc.params;
215
	u32 dpfc_ctl;
216
	int threshold = dev_priv->fbc.threshold;
217

218
	dpfc_ctl = DPFC_CTL_PLANE(params->crtc.i9xx_plane);
219
	if (params->fb.format->cpp[0] == 2)
220
		threshold++;
221

222
	switch (threshold) {
223 224 225 226 227 228 229 230 231 232 233
	case 4:
	case 3:
		dpfc_ctl |= DPFC_CTL_LIMIT_4X;
		break;
	case 2:
		dpfc_ctl |= DPFC_CTL_LIMIT_2X;
		break;
	case 1:
		dpfc_ctl |= DPFC_CTL_LIMIT_1X;
		break;
	}
234

235
	if (params->fence_id >= 0) {
236
		dpfc_ctl |= DPFC_CTL_FENCE_EN;
237
		if (IS_GEN(dev_priv, 5))
238
			dpfc_ctl |= params->fence_id;
239
		if (IS_GEN(dev_priv, 6)) {
240
			I915_WRITE(SNB_DPFC_CTL_SA,
241
				   SNB_CPU_FENCE_ENABLE |
242
				   params->fence_id);
243 244 245 246
			I915_WRITE(DPFC_CPU_FENCE_OFFSET,
				   params->crtc.fence_y_offset);
		}
	} else {
247
		if (IS_GEN(dev_priv, 6)) {
248 249 250 251
			I915_WRITE(SNB_DPFC_CTL_SA, 0);
			I915_WRITE(DPFC_CPU_FENCE_OFFSET, 0);
		}
	}
252

253
	I915_WRITE(ILK_DPFC_FENCE_YOFF, params->crtc.fence_y_offset);
254 255 256
	/* enable it... */
	I915_WRITE(ILK_DPFC_CONTROL, dpfc_ctl | DPFC_CTL_EN);

257
	intel_fbc_recompress(dev_priv);
258 259
}

260
static void ilk_fbc_deactivate(struct drm_i915_private *dev_priv)
261 262 263 264 265 266 267 268 269 270 271
{
	u32 dpfc_ctl;

	/* Disable compression */
	dpfc_ctl = I915_READ(ILK_DPFC_CONTROL);
	if (dpfc_ctl & DPFC_CTL_EN) {
		dpfc_ctl &= ~DPFC_CTL_EN;
		I915_WRITE(ILK_DPFC_CONTROL, dpfc_ctl);
	}
}

272
static bool ilk_fbc_is_active(struct drm_i915_private *dev_priv)
273 274 275 276
{
	return I915_READ(ILK_DPFC_CONTROL) & DPFC_CTL_EN;
}

277
static void gen7_fbc_activate(struct drm_i915_private *dev_priv)
278
{
279
	struct intel_fbc_reg_params *params = &dev_priv->fbc.params;
280
	u32 dpfc_ctl;
281
	int threshold = dev_priv->fbc.threshold;
282

283
	/* Display WA #0529: skl, kbl, bxt. */
284
	if (IS_GEN9_BC(dev_priv) || IS_BROXTON(dev_priv)) {
285 286 287 288
		u32 val = I915_READ(CHICKEN_MISC_4);

		val &= ~(FBC_STRIDE_OVERRIDE | FBC_STRIDE_MASK);

289
		if (params->gen9_wa_cfb_stride)
290 291 292 293 294
			val |= FBC_STRIDE_OVERRIDE | params->gen9_wa_cfb_stride;

		I915_WRITE(CHICKEN_MISC_4, val);
	}

295
	dpfc_ctl = 0;
296
	if (IS_IVYBRIDGE(dev_priv))
297
		dpfc_ctl |= IVB_DPFC_CTL_PLANE(params->crtc.i9xx_plane);
298

299
	if (params->fb.format->cpp[0] == 2)
300
		threshold++;
301

302
	switch (threshold) {
303 304 305 306 307 308 309 310 311 312 313 314
	case 4:
	case 3:
		dpfc_ctl |= DPFC_CTL_LIMIT_4X;
		break;
	case 2:
		dpfc_ctl |= DPFC_CTL_LIMIT_2X;
		break;
	case 1:
		dpfc_ctl |= DPFC_CTL_LIMIT_1X;
		break;
	}

315
	if (params->fence_id >= 0) {
316 317
		dpfc_ctl |= IVB_DPFC_CTL_FENCE_EN;
		I915_WRITE(SNB_DPFC_CTL_SA,
318
			   SNB_CPU_FENCE_ENABLE |
319
			   params->fence_id);
320 321 322 323 324
		I915_WRITE(DPFC_CPU_FENCE_OFFSET, params->crtc.fence_y_offset);
	} else {
		I915_WRITE(SNB_DPFC_CTL_SA,0);
		I915_WRITE(DPFC_CPU_FENCE_OFFSET, 0);
	}
325 326 327 328

	if (dev_priv->fbc.false_color)
		dpfc_ctl |= FBC_CTL_FALSE_COLOR;

329
	if (IS_IVYBRIDGE(dev_priv)) {
330 331 332 333
		/* WaFbcAsynchFlipDisableFbcQueue:ivb */
		I915_WRITE(ILK_DISPLAY_CHICKEN1,
			   I915_READ(ILK_DISPLAY_CHICKEN1) |
			   ILK_FBCQ_DIS);
334
	} else if (IS_HASWELL(dev_priv) || IS_BROADWELL(dev_priv)) {
335
		/* WaFbcAsynchFlipDisableFbcQueue:hsw,bdw */
336 337
		I915_WRITE(CHICKEN_PIPESL_1(params->crtc.pipe),
			   I915_READ(CHICKEN_PIPESL_1(params->crtc.pipe)) |
338 339 340
			   HSW_FBCQ_DIS);
	}

341 342
	if (INTEL_GEN(dev_priv) >= 11)
		/* Wa_1409120013:icl,ehl,tgl */
M
Matt Roper 已提交
343 344
		I915_WRITE(ILK_DPFC_CHICKEN, ILK_DPFC_CHICKEN_COMP_DUMMY_PIXEL);

345 346
	I915_WRITE(ILK_DPFC_CONTROL, dpfc_ctl | DPFC_CTL_EN);

347
	intel_fbc_recompress(dev_priv);
348 349
}

350 351
static bool intel_fbc_hw_is_active(struct drm_i915_private *dev_priv)
{
352
	if (INTEL_GEN(dev_priv) >= 5)
353 354 355 356 357 358 359 360 361
		return ilk_fbc_is_active(dev_priv);
	else if (IS_GM45(dev_priv))
		return g4x_fbc_is_active(dev_priv);
	else
		return i8xx_fbc_is_active(dev_priv);
}

static void intel_fbc_hw_activate(struct drm_i915_private *dev_priv)
{
362 363
	struct intel_fbc *fbc = &dev_priv->fbc;

364 365
	trace_intel_fbc_activate(fbc->crtc);

366
	fbc->active = true;
367
	fbc->activated = true;
368

369
	if (INTEL_GEN(dev_priv) >= 7)
370
		gen7_fbc_activate(dev_priv);
371
	else if (INTEL_GEN(dev_priv) >= 5)
372 373 374 375 376 377 378 379 380
		ilk_fbc_activate(dev_priv);
	else if (IS_GM45(dev_priv))
		g4x_fbc_activate(dev_priv);
	else
		i8xx_fbc_activate(dev_priv);
}

static void intel_fbc_hw_deactivate(struct drm_i915_private *dev_priv)
{
381 382
	struct intel_fbc *fbc = &dev_priv->fbc;

383 384
	trace_intel_fbc_deactivate(fbc->crtc);

385 386
	fbc->active = false;

387
	if (INTEL_GEN(dev_priv) >= 5)
388 389 390 391 392 393 394
		ilk_fbc_deactivate(dev_priv);
	else if (IS_GM45(dev_priv))
		g4x_fbc_deactivate(dev_priv);
	else
		i8xx_fbc_deactivate(dev_priv);
}

R
Rodrigo Vivi 已提交
395
/**
396
 * intel_fbc_is_active - Is FBC active?
397
 * @dev_priv: i915 device instance
R
Rodrigo Vivi 已提交
398 399
 *
 * This function is used to verify the current state of FBC.
D
Daniel Vetter 已提交
400
 *
R
Rodrigo Vivi 已提交
401
 * FIXME: This should be tracked in the plane config eventually
D
Daniel Vetter 已提交
402
 * instead of queried at runtime for most callers.
R
Rodrigo Vivi 已提交
403
 */
404
bool intel_fbc_is_active(struct drm_i915_private *dev_priv)
405
{
406
	return dev_priv->fbc.active;
407 408
}

409 410
static void intel_fbc_deactivate(struct drm_i915_private *dev_priv,
				 const char *reason)
P
Paulo Zanoni 已提交
411
{
412 413 414
	struct intel_fbc *fbc = &dev_priv->fbc;

	WARN_ON(!mutex_is_locked(&fbc->lock));
P
Paulo Zanoni 已提交
415

416
	if (fbc->active)
417
		intel_fbc_hw_deactivate(dev_priv);
418 419

	fbc->no_fbc_reason = reason;
420 421
}

422
static int find_compression_threshold(struct drm_i915_private *dev_priv,
423
				      struct drm_mm_node *node,
424 425
				      unsigned int size,
				      unsigned int fb_cpp)
426 427 428
{
	int compression_threshold = 1;
	int ret;
429 430 431 432 433 434
	u64 end;

	/* The FBC hardware for BDW/SKL doesn't have access to the stolen
	 * reserved range size, so it always assumes the maximum (8mb) is used.
	 * If we enable FBC using a CFB on that memory range we'll get FIFO
	 * underruns, even if that range is not reserved by the BIOS. */
435
	if (IS_BROADWELL(dev_priv) || IS_GEN9_BC(dev_priv))
436
		end = resource_size(&dev_priv->dsm) - 8 * 1024 * 1024;
437
	else
438
		end = U64_MAX;
439 440 441 442 443 444 445 446 447

	/* HACK: This code depends on what we will do in *_enable_fbc. If that
	 * code changes, this code needs to change as well.
	 *
	 * The enable_fbc code will attempt to use one of our 2 compression
	 * thresholds, therefore, in that case, we only have 1 resort.
	 */

	/* Try to over-allocate to reduce reallocations and fragmentation. */
448 449
	ret = i915_gem_stolen_insert_node_in_range(dev_priv, node, size <<= 1,
						   4096, 0, end);
450 451 452 453 454 455 456 457 458
	if (ret == 0)
		return compression_threshold;

again:
	/* HW's ability to limit the CFB is 1:4 */
	if (compression_threshold > 4 ||
	    (fb_cpp == 2 && compression_threshold == 2))
		return 0;

459 460
	ret = i915_gem_stolen_insert_node_in_range(dev_priv, node, size >>= 1,
						   4096, 0, end);
461
	if (ret && INTEL_GEN(dev_priv) <= 4) {
462 463 464 465 466 467 468 469 470
		return 0;
	} else if (ret) {
		compression_threshold <<= 1;
		goto again;
	} else {
		return compression_threshold;
	}
}

471 472
static int intel_fbc_alloc_cfb(struct drm_i915_private *dev_priv,
			       unsigned int size, unsigned int fb_cpp)
473
{
474
	struct intel_fbc *fbc = &dev_priv->fbc;
475
	struct drm_mm_node *uninitialized_var(compressed_llb);
476
	int ret;
477

478
	WARN_ON(drm_mm_node_allocated(&fbc->compressed_fb));
479

480
	ret = find_compression_threshold(dev_priv, &fbc->compressed_fb,
481 482 483 484 485 486 487 488
					 size, fb_cpp);
	if (!ret)
		goto err_llb;
	else if (ret > 1) {
		DRM_INFO("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");

	}

489
	fbc->threshold = ret;
490

491
	if (INTEL_GEN(dev_priv) >= 5)
492
		I915_WRITE(ILK_DPFC_CB_BASE, fbc->compressed_fb.start);
493
	else if (IS_GM45(dev_priv)) {
494
		I915_WRITE(DPFC_CB_BASE, fbc->compressed_fb.start);
495 496 497 498 499 500 501 502 503 504
	} else {
		compressed_llb = kzalloc(sizeof(*compressed_llb), GFP_KERNEL);
		if (!compressed_llb)
			goto err_fb;

		ret = i915_gem_stolen_insert_node(dev_priv, compressed_llb,
						  4096, 4096);
		if (ret)
			goto err_fb;

505
		fbc->compressed_llb = compressed_llb;
506

507 508 509 510 511 512
		GEM_BUG_ON(range_overflows_t(u64, dev_priv->dsm.start,
					     fbc->compressed_fb.start,
					     U32_MAX));
		GEM_BUG_ON(range_overflows_t(u64, dev_priv->dsm.start,
					     fbc->compressed_llb->start,
					     U32_MAX));
513
		I915_WRITE(FBC_CFB_BASE,
514
			   dev_priv->dsm.start + fbc->compressed_fb.start);
515
		I915_WRITE(FBC_LL_BASE,
516
			   dev_priv->dsm.start + compressed_llb->start);
517 518
	}

519
	DRM_DEBUG_KMS("reserved %llu bytes of contiguous stolen space for FBC, threshold: %d\n",
520
		      fbc->compressed_fb.size, fbc->threshold);
521 522 523 524 525

	return 0;

err_fb:
	kfree(compressed_llb);
526
	i915_gem_stolen_remove_node(dev_priv, &fbc->compressed_fb);
527
err_llb:
528 529
	if (drm_mm_initialized(&dev_priv->mm.stolen))
		pr_info_once("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);
530 531 532
	return -ENOSPC;
}

533
static void __intel_fbc_cleanup_cfb(struct drm_i915_private *dev_priv)
534
{
535 536 537 538 539 540 541 542
	struct intel_fbc *fbc = &dev_priv->fbc;

	if (drm_mm_node_allocated(&fbc->compressed_fb))
		i915_gem_stolen_remove_node(dev_priv, &fbc->compressed_fb);

	if (fbc->compressed_llb) {
		i915_gem_stolen_remove_node(dev_priv, fbc->compressed_llb);
		kfree(fbc->compressed_llb);
543 544 545
	}
}

546
void intel_fbc_cleanup_cfb(struct drm_i915_private *dev_priv)
P
Paulo Zanoni 已提交
547
{
548 549
	struct intel_fbc *fbc = &dev_priv->fbc;

550
	if (!HAS_FBC(dev_priv))
551 552
		return;

553
	mutex_lock(&fbc->lock);
554
	__intel_fbc_cleanup_cfb(dev_priv);
555
	mutex_unlock(&fbc->lock);
P
Paulo Zanoni 已提交
556 557
}

558 559 560
static bool stride_is_valid(struct drm_i915_private *dev_priv,
			    unsigned int stride)
{
561 562 563
	/* This should have been caught earlier. */
	if (WARN_ON_ONCE((stride & (64 - 1)) != 0))
		return false;
564 565

	/* Below are the additional FBC restrictions. */
566 567
	if (stride < 512)
		return false;
568

569
	if (IS_GEN(dev_priv, 2) || IS_GEN(dev_priv, 3))
570 571
		return stride == 4096 || stride == 8192;

572
	if (IS_GEN(dev_priv, 4) && !IS_G4X(dev_priv) && stride < 2048)
573 574 575 576 577 578 579 580
		return false;

	if (stride > 16384)
		return false;

	return true;
}

581
static bool pixel_format_is_valid(struct drm_i915_private *dev_priv,
582
				  u32 pixel_format)
583
{
584
	switch (pixel_format) {
585 586 587 588 589 590
	case DRM_FORMAT_XRGB8888:
	case DRM_FORMAT_XBGR8888:
		return true;
	case DRM_FORMAT_XRGB1555:
	case DRM_FORMAT_RGB565:
		/* 16bpp not supported on gen2 */
591
		if (IS_GEN(dev_priv, 2))
592 593 594 595 596 597 598 599 600 601
			return false;
		/* WaFbcOnly1to1Ratio:ctg */
		if (IS_G4X(dev_priv))
			return false;
		return true;
	default:
		return false;
	}
}

602 603 604 605 606 607 608
/*
 * For some reason, the hardware tracking starts looking at whatever we
 * programmed as the display plane base address register. It does not look at
 * the X and Y offset registers. That's why we look at the crtc->adjusted{x,y}
 * variables instead of just looking at the pipe/plane size.
 */
static bool intel_fbc_hw_tracking_covers_screen(struct intel_crtc *crtc)
609
{
610
	struct drm_i915_private *dev_priv = to_i915(crtc->base.dev);
611
	struct intel_fbc *fbc = &dev_priv->fbc;
612
	unsigned int effective_w, effective_h, max_w, max_h;
613

614 615 616 617
	if (INTEL_GEN(dev_priv) >= 10 || IS_GEMINILAKE(dev_priv)) {
		max_w = 5120;
		max_h = 4096;
	} else if (INTEL_GEN(dev_priv) >= 8 || IS_HASWELL(dev_priv)) {
618 619
		max_w = 4096;
		max_h = 4096;
620
	} else if (IS_G4X(dev_priv) || INTEL_GEN(dev_priv) >= 5) {
621 622 623 624 625 626 627
		max_w = 4096;
		max_h = 2048;
	} else {
		max_w = 2048;
		max_h = 1536;
	}

628 629
	intel_fbc_get_plane_source_size(&fbc->state_cache, &effective_w,
					&effective_h);
630 631
	effective_w += fbc->state_cache.plane.adjusted_x;
	effective_h += fbc->state_cache.plane.adjusted_y;
632 633

	return effective_w <= max_w && effective_h <= max_h;
634 635
}

636
static void intel_fbc_update_state_cache(struct intel_crtc *crtc,
637 638
					 const struct intel_crtc_state *crtc_state,
					 const struct intel_plane_state *plane_state)
639
{
640
	struct drm_i915_private *dev_priv = to_i915(crtc->base.dev);
641
	struct intel_fbc *fbc = &dev_priv->fbc;
642
	struct intel_fbc_state_cache *cache = &fbc->state_cache;
643
	struct drm_framebuffer *fb = plane_state->hw.fb;
644

645 646 647
	cache->plane.visible = plane_state->uapi.visible;
	if (!cache->plane.visible)
		return;
648

649
	cache->crtc.mode_flags = crtc_state->hw.adjusted_mode.flags;
650
	if (IS_HASWELL(dev_priv) || IS_BROADWELL(dev_priv))
651
		cache->crtc.hsw_bdw_pixel_rate = crtc_state->pixel_rate;
652

653
	cache->plane.rotation = plane_state->hw.rotation;
654 655 656 657 658
	/*
	 * Src coordinates are already rotated by 270 degrees for
	 * the 90/270 degree plane rotation cases (to match the
	 * GTT mapping), hence no need to account for rotation here.
	 */
659 660
	cache->plane.src_w = drm_rect_width(&plane_state->uapi.src) >> 16;
	cache->plane.src_h = drm_rect_height(&plane_state->uapi.src) >> 16;
661 662
	cache->plane.adjusted_x = plane_state->color_plane[0].x;
	cache->plane.adjusted_y = plane_state->color_plane[0].y;
663
	cache->plane.y = plane_state->uapi.src.y1 >> 16;
664

665
	cache->plane.pixel_blend_mode = plane_state->hw.pixel_blend_mode;
666

667
	cache->fb.format = fb->format;
668
	cache->fb.stride = fb->pitches[0];
669

670 671 672 673 674 675 676 677
	WARN_ON(plane_state->flags & PLANE_HAS_FENCE &&
		!plane_state->vma->fence);

	if (plane_state->flags & PLANE_HAS_FENCE &&
	    plane_state->vma->fence)
		cache->fence_id = plane_state->vma->fence->id;
	else
		cache->fence_id = -1;
678 679
}

680 681 682 683 684 685 686 687
static bool intel_fbc_cfb_size_changed(struct drm_i915_private *dev_priv)
{
	struct intel_fbc *fbc = &dev_priv->fbc;

	return intel_fbc_calculate_cfb_size(dev_priv, &fbc->state_cache) >
		fbc->compressed_fb.size * fbc->threshold;
}

688 689
static bool intel_fbc_can_activate(struct intel_crtc *crtc)
{
690
	struct drm_i915_private *dev_priv = to_i915(crtc->base.dev);
691 692 693
	struct intel_fbc *fbc = &dev_priv->fbc;
	struct intel_fbc_state_cache *cache = &fbc->state_cache;

694 695 696 697 698
	if (!cache->plane.visible) {
		fbc->no_fbc_reason = "primary plane not visible";
		return false;
	}

699 700 701 702 703 704 705 706
	/* We don't need to use a state cache here since this information is
	 * global for all CRTC.
	 */
	if (fbc->underrun_detected) {
		fbc->no_fbc_reason = "underrun detected";
		return false;
	}

707
	if (cache->crtc.mode_flags & DRM_MODE_FLAG_INTERLACE) {
708
		fbc->no_fbc_reason = "incompatible mode";
709
		return false;
710 711
	}

712
	if (!intel_fbc_hw_tracking_covers_screen(crtc)) {
713
		fbc->no_fbc_reason = "mode too large for compression";
714
		return false;
715
	}
716

717 718
	/* The use of a CPU fence is mandatory in order to detect writes
	 * by the CPU to the scanout and trigger updates to the FBC.
719 720 721 722
	 *
	 * Note that is possible for a tiled surface to be unmappable (and
	 * so have no fence associated with it) due to aperture constaints
	 * at the time of pinning.
723 724 725 726 727 728
	 *
	 * FIXME with 90/270 degree rotation we should use the fence on
	 * the normal GTT view (the rotated view doesn't even have a
	 * fence). Would need changes to the FBC fence Y offset as well.
	 * For now this will effecively disable FBC with 90/270 degree
	 * rotation.
729
	 */
730
	if (cache->fence_id < 0) {
731 732
		fbc->no_fbc_reason = "framebuffer not tiled or fenced";
		return false;
733
	}
734
	if (INTEL_GEN(dev_priv) <= 4 && !IS_G4X(dev_priv) &&
735
	    cache->plane.rotation != DRM_MODE_ROTATE_0) {
736
		fbc->no_fbc_reason = "rotation unsupported";
737
		return false;
738 739
	}

740
	if (!stride_is_valid(dev_priv, cache->fb.stride)) {
741
		fbc->no_fbc_reason = "framebuffer stride not supported";
742
		return false;
743 744
	}

745
	if (!pixel_format_is_valid(dev_priv, cache->fb.format->format)) {
746
		fbc->no_fbc_reason = "pixel format is invalid";
747
		return false;
748 749
	}

750 751 752 753 754 755
	if (cache->plane.pixel_blend_mode != DRM_MODE_BLEND_PIXEL_NONE &&
	    cache->fb.format->has_alpha) {
		fbc->no_fbc_reason = "per-pixel alpha blending is incompatible with FBC";
		return false;
	}

756 757
	/* WaFbcExceedCdClockThreshold:hsw,bdw */
	if ((IS_HASWELL(dev_priv) || IS_BROADWELL(dev_priv)) &&
758
	    cache->crtc.hsw_bdw_pixel_rate >= dev_priv->cdclk.hw.cdclk * 95 / 100) {
759
		fbc->no_fbc_reason = "pixel rate is too big";
760
		return false;
761 762
	}

763 764 765 766 767 768 769 770 771 772
	/* It is possible for the required CFB size change without a
	 * crtc->disable + crtc->enable since it is possible to change the
	 * stride without triggering a full modeset. Since we try to
	 * over-allocate the CFB, there's a chance we may keep FBC enabled even
	 * if this happens, but if we exceed the current CFB size we'll have to
	 * disable FBC. Notice that it would be possible to disable FBC, wait
	 * for a frame, free the stolen node, then try to reenable FBC in case
	 * we didn't get any invalidate/deactivate calls, but this would require
	 * a lot of tracking just for a specific case. If we conclude it's an
	 * important case, we can implement it later. */
773
	if (intel_fbc_cfb_size_changed(dev_priv)) {
774
		fbc->no_fbc_reason = "CFB requirements changed";
775 776 777
		return false;
	}

778 779 780 781 782
	/*
	 * Work around a problem on GEN9+ HW, where enabling FBC on a plane
	 * having a Y offset that isn't divisible by 4 causes FIFO underrun
	 * and screen flicker.
	 */
783
	if (INTEL_GEN(dev_priv) >= 9 &&
784 785 786 787 788
	    (fbc->state_cache.plane.adjusted_y & 3)) {
		fbc->no_fbc_reason = "plane Y offset is misaligned";
		return false;
	}

789 790 791
	return true;
}

792
static bool intel_fbc_can_enable(struct drm_i915_private *dev_priv)
793
{
794
	struct intel_fbc *fbc = &dev_priv->fbc;
795

796
	if (intel_vgpu_active(dev_priv)) {
797
		fbc->no_fbc_reason = "VGPU is active";
798 799 800
		return false;
	}

801
	if (!i915_modparams.enable_fbc) {
802
		fbc->no_fbc_reason = "disabled per module param or by default";
803 804 805
		return false;
	}

806 807 808 809 810
	if (fbc->underrun_detected) {
		fbc->no_fbc_reason = "underrun detected";
		return false;
	}

811 812 813
	return true;
}

814 815 816
static void intel_fbc_get_reg_params(struct intel_crtc *crtc,
				     struct intel_fbc_reg_params *params)
{
817
	struct drm_i915_private *dev_priv = to_i915(crtc->base.dev);
818 819
	struct intel_fbc *fbc = &dev_priv->fbc;
	struct intel_fbc_state_cache *cache = &fbc->state_cache;
820 821 822 823 824 825

	/* Since all our fields are integer types, use memset here so the
	 * comparison function can rely on memcmp because the padding will be
	 * zero. */
	memset(params, 0, sizeof(*params));

826
	params->fence_id = cache->fence_id;
827

828
	params->crtc.pipe = crtc->pipe;
V
Ville Syrjälä 已提交
829
	params->crtc.i9xx_plane = to_intel_plane(crtc->base.primary)->i9xx_plane;
830
	params->crtc.fence_y_offset = get_crtc_fence_y_offset(fbc);
831

832
	params->fb.format = cache->fb.format;
833
	params->fb.stride = cache->fb.stride;
834

835
	params->cfb_size = intel_fbc_calculate_cfb_size(dev_priv, cache);
836

837
	params->gen9_wa_cfb_stride = cache->gen9_wa_cfb_stride;
838 839

	params->plane_visible = cache->plane.visible;
840 841
}

842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
static bool intel_fbc_can_flip_nuke(const struct intel_crtc_state *crtc_state)
{
	struct intel_crtc *crtc = to_intel_crtc(crtc_state->uapi.crtc);
	struct drm_i915_private *dev_priv = to_i915(crtc->base.dev);
	const struct intel_fbc *fbc = &dev_priv->fbc;
	const struct intel_fbc_state_cache *cache = &fbc->state_cache;
	const struct intel_fbc_reg_params *params = &fbc->params;

	if (drm_atomic_crtc_needs_modeset(&crtc_state->uapi))
		return false;

	if (!params->plane_visible)
		return false;

	if (!intel_fbc_can_activate(crtc))
		return false;

	if (params->fb.format != cache->fb.format)
		return false;

	if (params->fb.stride != cache->fb.stride)
		return false;

	if (params->cfb_size != intel_fbc_calculate_cfb_size(dev_priv, cache))
		return false;

	if (params->gen9_wa_cfb_stride != cache->gen9_wa_cfb_stride)
		return false;

	return true;
}

874 875
bool intel_fbc_pre_update(struct intel_atomic_state *state,
			  struct intel_crtc *crtc)
876
{
877 878 879 880 881
	struct intel_plane *plane = to_intel_plane(crtc->base.primary);
	const struct intel_crtc_state *crtc_state =
		intel_atomic_get_new_crtc_state(state, crtc);
	const struct intel_plane_state *plane_state =
		intel_atomic_get_new_plane_state(state, plane);
882
	struct drm_i915_private *dev_priv = to_i915(crtc->base.dev);
883
	struct intel_fbc *fbc = &dev_priv->fbc;
884
	const char *reason = "update pending";
885
	bool need_vblank_wait = false;
886

887
	if (!plane->has_fbc || !plane_state)
888 889
		return need_vblank_wait;

890
	mutex_lock(&fbc->lock);
891

V
Ville Syrjälä 已提交
892
	if (fbc->crtc != crtc)
893
		goto unlock;
894

895
	intel_fbc_update_state_cache(crtc, crtc_state, plane_state);
896
	fbc->flip_pending = true;
897

898
	if (!intel_fbc_can_flip_nuke(crtc_state)) {
899
		intel_fbc_deactivate(dev_priv, reason);
900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918

		/*
		 * Display WA #1198: glk+
		 * Need an extra vblank wait between FBC disable and most plane
		 * updates. Bspec says this is only needed for plane disable, but
		 * that is not true. Touching most plane registers will cause the
		 * corruption to appear. Also SKL/derivatives do not seem to be
		 * affected.
		 *
		 * TODO: could optimize this a bit by sampling the frame
		 * counter when we disable FBC (if it was already done earlier)
		 * and skipping the extra vblank wait before the plane update
		 * if at least one frame has already passed.
		 */
		if (fbc->activated &&
		    (INTEL_GEN(dev_priv) >= 10 || IS_GEMINILAKE(dev_priv)))
			need_vblank_wait = true;
		fbc->activated = false;
	}
919 920
unlock:
	mutex_unlock(&fbc->lock);
921 922

	return need_vblank_wait;
923 924
}

925 926 927 928 929 930 931 932 933 934 935 936 937
/**
 * __intel_fbc_disable - disable FBC
 * @dev_priv: i915 device instance
 *
 * This is the low level function that actually disables FBC. Callers should
 * grab the FBC lock.
 */
static void __intel_fbc_disable(struct drm_i915_private *dev_priv)
{
	struct intel_fbc *fbc = &dev_priv->fbc;
	struct intel_crtc *crtc = fbc->crtc;

	WARN_ON(!mutex_is_locked(&fbc->lock));
V
Ville Syrjälä 已提交
938
	WARN_ON(!fbc->crtc);
939 940 941 942 943 944 945 946 947
	WARN_ON(fbc->active);

	DRM_DEBUG_KMS("Disabling FBC on pipe %c\n", pipe_name(crtc->pipe));

	__intel_fbc_cleanup_cfb(dev_priv);

	fbc->crtc = NULL;
}

948
static void __intel_fbc_post_update(struct intel_crtc *crtc)
949
{
950
	struct drm_i915_private *dev_priv = to_i915(crtc->base.dev);
951 952 953 954
	struct intel_fbc *fbc = &dev_priv->fbc;

	WARN_ON(!mutex_is_locked(&fbc->lock));

V
Ville Syrjälä 已提交
955
	if (fbc->crtc != crtc)
956 957
		return;

958 959
	fbc->flip_pending = false;

960 961 962 963 964 965 966
	if (!i915_modparams.enable_fbc) {
		intel_fbc_deactivate(dev_priv, "disabled at runtime per module param");
		__intel_fbc_disable(dev_priv);

		return;
	}

967
	intel_fbc_get_reg_params(crtc, &fbc->params);
968

969
	if (!intel_fbc_can_activate(crtc))
970 971
		return;

972
	if (!fbc->busy_bits)
973
		intel_fbc_hw_activate(dev_priv);
974
	else
975
		intel_fbc_deactivate(dev_priv, "frontbuffer write");
P
Paulo Zanoni 已提交
976 977
}

978 979
void intel_fbc_post_update(struct intel_atomic_state *state,
			   struct intel_crtc *crtc)
P
Paulo Zanoni 已提交
980
{
981
	struct drm_i915_private *dev_priv = to_i915(crtc->base.dev);
982 983 984
	struct intel_plane *plane = to_intel_plane(crtc->base.primary);
	const struct intel_plane_state *plane_state =
		intel_atomic_get_new_plane_state(state, plane);
985
	struct intel_fbc *fbc = &dev_priv->fbc;
986

987
	if (!plane->has_fbc || !plane_state)
988 989
		return;

990
	mutex_lock(&fbc->lock);
991
	__intel_fbc_post_update(crtc);
992
	mutex_unlock(&fbc->lock);
993 994
}

995 996
static unsigned int intel_fbc_get_frontbuffer_bit(struct intel_fbc *fbc)
{
V
Ville Syrjälä 已提交
997
	if (fbc->crtc)
998 999 1000 1001 1002
		return to_intel_plane(fbc->crtc->base.primary)->frontbuffer_bit;
	else
		return fbc->possible_framebuffer_bits;
}

1003 1004 1005 1006
void intel_fbc_invalidate(struct drm_i915_private *dev_priv,
			  unsigned int frontbuffer_bits,
			  enum fb_op_origin origin)
{
1007
	struct intel_fbc *fbc = &dev_priv->fbc;
1008

1009
	if (!HAS_FBC(dev_priv))
1010 1011
		return;

1012
	if (origin == ORIGIN_GTT || origin == ORIGIN_FLIP)
1013 1014
		return;

1015
	mutex_lock(&fbc->lock);
P
Paulo Zanoni 已提交
1016

1017
	fbc->busy_bits |= intel_fbc_get_frontbuffer_bit(fbc) & frontbuffer_bits;
1018

V
Ville Syrjälä 已提交
1019
	if (fbc->crtc && fbc->busy_bits)
1020
		intel_fbc_deactivate(dev_priv, "frontbuffer write");
P
Paulo Zanoni 已提交
1021

1022
	mutex_unlock(&fbc->lock);
1023 1024 1025
}

void intel_fbc_flush(struct drm_i915_private *dev_priv,
1026
		     unsigned int frontbuffer_bits, enum fb_op_origin origin)
1027
{
1028 1029
	struct intel_fbc *fbc = &dev_priv->fbc;

1030
	if (!HAS_FBC(dev_priv))
1031 1032
		return;

1033
	mutex_lock(&fbc->lock);
1034

1035
	fbc->busy_bits &= ~frontbuffer_bits;
1036

1037 1038 1039
	if (origin == ORIGIN_GTT || origin == ORIGIN_FLIP)
		goto out;

V
Ville Syrjälä 已提交
1040
	if (!fbc->busy_bits && fbc->crtc &&
1041
	    (frontbuffer_bits & intel_fbc_get_frontbuffer_bit(fbc))) {
1042
		if (fbc->active)
1043
			intel_fbc_recompress(dev_priv);
1044
		else if (!fbc->flip_pending)
1045
			__intel_fbc_post_update(fbc->crtc);
1046
	}
P
Paulo Zanoni 已提交
1047

1048
out:
1049
	mutex_unlock(&fbc->lock);
1050 1051
}

1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
/**
 * intel_fbc_choose_crtc - select a CRTC to enable FBC on
 * @dev_priv: i915 device instance
 * @state: the atomic state structure
 *
 * This function looks at the proposed state for CRTCs and planes, then chooses
 * which pipe is going to have FBC by setting intel_crtc_state->enable_fbc to
 * true.
 *
 * Later, intel_fbc_enable is going to look for state->enable_fbc and then maybe
 * enable FBC for the chosen CRTC. If it does, it will set dev_priv->fbc.crtc.
 */
void intel_fbc_choose_crtc(struct drm_i915_private *dev_priv,
1065
			   struct intel_atomic_state *state)
1066 1067
{
	struct intel_fbc *fbc = &dev_priv->fbc;
1068 1069
	struct intel_plane *plane;
	struct intel_plane_state *plane_state;
1070
	bool crtc_chosen = false;
1071
	int i;
1072 1073 1074

	mutex_lock(&fbc->lock);

1075 1076
	/* Does this atomic commit involve the CRTC currently tied to FBC? */
	if (fbc->crtc &&
1077
	    !intel_atomic_get_new_crtc_state(state, fbc->crtc))
1078 1079
		goto out;

1080 1081 1082
	if (!intel_fbc_can_enable(dev_priv))
		goto out;

1083 1084 1085 1086
	/* Simply choose the first CRTC that is compatible and has a visible
	 * plane. We could go for fancier schemes such as checking the plane
	 * size, but this would just affect the few platforms that don't tie FBC
	 * to pipe or plane A. */
1087 1088
	for_each_new_intel_plane_in_state(state, plane, plane_state, i) {
		struct intel_crtc_state *crtc_state;
1089
		struct intel_crtc *crtc = to_intel_crtc(plane_state->hw.crtc);
1090

1091
		if (!plane->has_fbc)
1092 1093
			continue;

1094
		if (!plane_state->uapi.visible)
1095 1096
			continue;

1097
		crtc_state = intel_atomic_get_new_crtc_state(state, crtc);
1098

1099
		crtc_state->enable_fbc = true;
1100
		crtc_chosen = true;
1101
		break;
1102 1103
	}

1104 1105 1106
	if (!crtc_chosen)
		fbc->no_fbc_reason = "no suitable CRTC for FBC";

1107 1108 1109 1110
out:
	mutex_unlock(&fbc->lock);
}

1111 1112 1113
/**
 * intel_fbc_enable: tries to enable FBC on the CRTC
 * @crtc: the CRTC
1114
 * @state: corresponding &drm_crtc_state for @crtc
1115
 *
1116
 * This function checks if the given CRTC was chosen for FBC, then enables it if
1117 1118 1119
 * possible. Notice that it doesn't activate FBC. It is valid to call
 * intel_fbc_enable multiple times for the same pipe without an
 * intel_fbc_disable in the middle, as long as it is deactivated.
1120
 */
1121 1122
void intel_fbc_enable(struct intel_atomic_state *state,
		      struct intel_crtc *crtc)
1123
{
1124
	struct drm_i915_private *dev_priv = to_i915(crtc->base.dev);
1125 1126 1127 1128 1129
	struct intel_plane *plane = to_intel_plane(crtc->base.primary);
	const struct intel_crtc_state *crtc_state =
		intel_atomic_get_new_crtc_state(state, crtc);
	const struct intel_plane_state *plane_state =
		intel_atomic_get_new_plane_state(state, plane);
1130
	struct intel_fbc *fbc = &dev_priv->fbc;
1131
	struct intel_fbc_state_cache *cache = &fbc->state_cache;
1132

1133
	if (!plane->has_fbc || !plane_state)
1134 1135
		return;

1136
	mutex_lock(&fbc->lock);
1137

V
Ville Syrjälä 已提交
1138
	if (fbc->crtc) {
1139 1140 1141
		if (fbc->crtc != crtc ||
		    !intel_fbc_cfb_size_changed(dev_priv))
			goto out;
1142

1143 1144
		__intel_fbc_disable(dev_priv);
	}
1145

1146
	WARN_ON(fbc->active);
1147

1148
	intel_fbc_update_state_cache(crtc, crtc_state, plane_state);
1149 1150 1151 1152 1153 1154 1155

	/* FIXME crtc_state->enable_fbc lies :( */
	if (!cache->plane.visible)
		goto out;

	if (intel_fbc_alloc_cfb(dev_priv,
				intel_fbc_calculate_cfb_size(dev_priv, cache),
1156
				plane_state->hw.fb->format->cpp[0])) {
1157
		cache->plane.visible = false;
1158
		fbc->no_fbc_reason = "not enough stolen memory";
1159 1160 1161
		goto out;
	}

1162
	if ((IS_GEN9_BC(dev_priv) || IS_BROXTON(dev_priv)) &&
1163
	    plane_state->hw.fb->modifier != I915_FORMAT_MOD_X_TILED)
1164 1165 1166 1167 1168
		cache->gen9_wa_cfb_stride =
			DIV_ROUND_UP(cache->plane.src_w, 32 * fbc->threshold) * 8;
	else
		cache->gen9_wa_cfb_stride = 0;

1169
	DRM_DEBUG_KMS("Enabling FBC on pipe %c\n", pipe_name(crtc->pipe));
1170
	fbc->no_fbc_reason = "FBC enabled but not active yet\n";
1171

1172
	fbc->crtc = crtc;
1173
out:
1174
	mutex_unlock(&fbc->lock);
1175 1176 1177
}

/**
1178
 * intel_fbc_disable - disable FBC if it's associated with crtc
1179 1180 1181 1182
 * @crtc: the CRTC
 *
 * This function disables FBC if it's associated with the provided CRTC.
 */
1183
void intel_fbc_disable(struct intel_crtc *crtc)
1184
{
1185
	struct drm_i915_private *dev_priv = to_i915(crtc->base.dev);
1186
	struct intel_plane *plane = to_intel_plane(crtc->base.primary);
1187
	struct intel_fbc *fbc = &dev_priv->fbc;
1188

1189
	if (!plane->has_fbc)
1190 1191
		return;

1192
	mutex_lock(&fbc->lock);
1193
	if (fbc->crtc == crtc)
1194
		__intel_fbc_disable(dev_priv);
1195
	mutex_unlock(&fbc->lock);
1196 1197 1198
}

/**
1199
 * intel_fbc_global_disable - globally disable FBC
1200 1201 1202 1203
 * @dev_priv: i915 device instance
 *
 * This function disables FBC regardless of which CRTC is associated with it.
 */
1204
void intel_fbc_global_disable(struct drm_i915_private *dev_priv)
1205
{
1206 1207
	struct intel_fbc *fbc = &dev_priv->fbc;

1208
	if (!HAS_FBC(dev_priv))
1209 1210
		return;

1211
	mutex_lock(&fbc->lock);
V
Ville Syrjälä 已提交
1212
	if (fbc->crtc) {
1213
		WARN_ON(fbc->crtc->active);
1214
		__intel_fbc_disable(dev_priv);
1215
	}
1216
	mutex_unlock(&fbc->lock);
1217 1218
}

1219 1220 1221 1222 1223 1224 1225 1226 1227
static void intel_fbc_underrun_work_fn(struct work_struct *work)
{
	struct drm_i915_private *dev_priv =
		container_of(work, struct drm_i915_private, fbc.underrun_work);
	struct intel_fbc *fbc = &dev_priv->fbc;

	mutex_lock(&fbc->lock);

	/* Maybe we were scheduled twice. */
V
Ville Syrjälä 已提交
1228
	if (fbc->underrun_detected || !fbc->crtc)
1229 1230 1231 1232 1233
		goto out;

	DRM_DEBUG_KMS("Disabling FBC due to FIFO underrun.\n");
	fbc->underrun_detected = true;

1234
	intel_fbc_deactivate(dev_priv, "FIFO underrun");
1235 1236 1237 1238
out:
	mutex_unlock(&fbc->lock);
}

1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266
/*
 * intel_fbc_reset_underrun - reset FBC fifo underrun status.
 * @dev_priv: i915 device instance
 *
 * See intel_fbc_handle_fifo_underrun_irq(). For automated testing we
 * want to re-enable FBC after an underrun to increase test coverage.
 */
int intel_fbc_reset_underrun(struct drm_i915_private *dev_priv)
{
	int ret;

	cancel_work_sync(&dev_priv->fbc.underrun_work);

	ret = mutex_lock_interruptible(&dev_priv->fbc.lock);
	if (ret)
		return ret;

	if (dev_priv->fbc.underrun_detected) {
		DRM_DEBUG_KMS("Re-allowing FBC after fifo underrun\n");
		dev_priv->fbc.no_fbc_reason = "FIFO underrun cleared";
	}

	dev_priv->fbc.underrun_detected = false;
	mutex_unlock(&dev_priv->fbc.lock);

	return 0;
}

1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284
/**
 * intel_fbc_handle_fifo_underrun_irq - disable FBC when we get a FIFO underrun
 * @dev_priv: i915 device instance
 *
 * Without FBC, most underruns are harmless and don't really cause too many
 * problems, except for an annoying message on dmesg. With FBC, underruns can
 * become black screens or even worse, especially when paired with bad
 * watermarks. So in order for us to be on the safe side, completely disable FBC
 * in case we ever detect a FIFO underrun on any pipe. An underrun on any pipe
 * already suggests that watermarks may be bad, so try to be as safe as
 * possible.
 *
 * This function is called from the IRQ handler.
 */
void intel_fbc_handle_fifo_underrun_irq(struct drm_i915_private *dev_priv)
{
	struct intel_fbc *fbc = &dev_priv->fbc;

1285
	if (!HAS_FBC(dev_priv))
1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299
		return;

	/* There's no guarantee that underrun_detected won't be set to true
	 * right after this check and before the work is scheduled, but that's
	 * not a problem since we'll check it again under the work function
	 * while FBC is locked. This check here is just to prevent us from
	 * unnecessarily scheduling the work, and it relies on the fact that we
	 * never switch underrun_detect back to false after it's true. */
	if (READ_ONCE(fbc->underrun_detected))
		return;

	schedule_work(&fbc->underrun_work);
}

1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310
/*
 * The DDX driver changes its behavior depending on the value it reads from
 * i915.enable_fbc, so sanitize it by translating the default value into either
 * 0 or 1 in order to allow it to know what's going on.
 *
 * Notice that this is done at driver initialization and we still allow user
 * space to change the value during runtime without sanitizing it again. IGT
 * relies on being able to change i915.enable_fbc at runtime.
 */
static int intel_sanitize_fbc_option(struct drm_i915_private *dev_priv)
{
1311 1312
	if (i915_modparams.enable_fbc >= 0)
		return !!i915_modparams.enable_fbc;
1313

1314 1315 1316
	if (!HAS_FBC(dev_priv))
		return 0;

P
Paulo Zanoni 已提交
1317
	if (IS_BROADWELL(dev_priv) || INTEL_GEN(dev_priv) >= 9)
1318 1319 1320 1321 1322
		return 1;

	return 0;
}

1323 1324 1325
static bool need_fbc_vtd_wa(struct drm_i915_private *dev_priv)
{
	/* WaFbcTurnOffFbcWhenHyperVisorIsUsed:skl,bxt */
1326
	if (intel_vtd_active() &&
1327 1328 1329 1330 1331 1332 1333 1334
	    (IS_SKYLAKE(dev_priv) || IS_BROXTON(dev_priv))) {
		DRM_INFO("Disabling framebuffer compression (FBC) to prevent screen flicker with VT-d enabled\n");
		return true;
	}

	return false;
}

R
Rodrigo Vivi 已提交
1335 1336 1337 1338 1339 1340
/**
 * intel_fbc_init - Initialize FBC
 * @dev_priv: the i915 device
 *
 * This function might be called during PM init process.
 */
1341 1342
void intel_fbc_init(struct drm_i915_private *dev_priv)
{
1343
	struct intel_fbc *fbc = &dev_priv->fbc;
1344

1345
	INIT_WORK(&fbc->underrun_work, intel_fbc_underrun_work_fn);
1346 1347
	mutex_init(&fbc->lock);
	fbc->active = false;
P
Paulo Zanoni 已提交
1348

1349 1350 1351
	if (!drm_mm_initialized(&dev_priv->mm.stolen))
		mkwrite_device_info(dev_priv)->display.has_fbc = false;

1352
	if (need_fbc_vtd_wa(dev_priv))
1353
		mkwrite_device_info(dev_priv)->display.has_fbc = false;
1354

1355 1356 1357
	i915_modparams.enable_fbc = intel_sanitize_fbc_option(dev_priv);
	DRM_DEBUG_KMS("Sanitized enable_fbc value: %d\n",
		      i915_modparams.enable_fbc);
1358

1359
	if (!HAS_FBC(dev_priv)) {
1360
		fbc->no_fbc_reason = "unsupported by this chipset";
1361 1362 1363
		return;
	}

1364
	/* This value was pulled out of someone's hat */
1365
	if (INTEL_GEN(dev_priv) <= 4 && !IS_GM45(dev_priv))
1366 1367
		I915_WRITE(FBC_CONTROL, 500 << FBC_CTL_INTERVAL_SHIFT);

1368
	/* We still don't have any sort of hardware state readout for FBC, so
1369 1370
	 * deactivate it in case the BIOS activated it to make sure software
	 * matches the hardware state. */
1371 1372
	if (intel_fbc_hw_is_active(dev_priv))
		intel_fbc_hw_deactivate(dev_priv);
1373
}