2 * Copyright © 2014 Intel Corporation
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:
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
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.
25 * DOC: Frame Buffer Compression (FBC)
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.
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.
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.
41 #include <drm/drm_fourcc.h>
44 #include "i915_trace.h"
45 #include "i915_vgpu.h"
46 #include "intel_display_types.h"
47 #include "intel_fbc.h"
48 #include "intel_frontbuffer.h"
51 * In some platforms where the CRTC's x:0/y:0 coordinates doesn't match the
52 * frontbuffer's x:0/y:0 coordinates we lie to the hardware about the plane's
53 * origin so the x and y offsets can actually fit the registers. As a
54 * consequence, the fence doesn't really start exactly at the display plane
55 * address we program because it starts at the real start of the buffer, so we
56 * have to take this into consideration here.
58 static unsigned int get_crtc_fence_y_offset(struct intel_fbc *fbc)
60 return fbc->state_cache.plane.y - fbc->state_cache.plane.adjusted_y;
64 * For SKL+, the plane source size used by the hardware is based on the value we
65 * write to the PLANE_SIZE register. For BDW-, the hardware looks at the value
66 * we wrote to PIPESRC.
68 static void intel_fbc_get_plane_source_size(const struct intel_fbc_state_cache *cache,
69 int *width, int *height)
72 *width = cache->plane.src_w;
74 *height = cache->plane.src_h;
77 static int intel_fbc_calculate_cfb_size(struct drm_i915_private *dev_priv,
78 const struct intel_fbc_state_cache *cache)
82 intel_fbc_get_plane_source_size(cache, NULL, &lines);
83 if (IS_GEN(dev_priv, 7))
84 lines = min(lines, 2048);
85 else if (INTEL_GEN(dev_priv) >= 8)
86 lines = min(lines, 2560);
88 /* Hardware needs the full buffer stride, not just the active area. */
89 return lines * cache->fb.stride;
92 static void i8xx_fbc_deactivate(struct drm_i915_private *dev_priv)
96 /* Disable compression */
97 fbc_ctl = intel_de_read(dev_priv, FBC_CONTROL);
98 if ((fbc_ctl & FBC_CTL_EN) == 0)
101 fbc_ctl &= ~FBC_CTL_EN;
102 intel_de_write(dev_priv, FBC_CONTROL, fbc_ctl);
104 /* Wait for compressing bit to clear */
105 if (intel_de_wait_for_clear(dev_priv, FBC_STATUS,
106 FBC_STAT_COMPRESSING, 10)) {
107 DRM_DEBUG_KMS("FBC idle timed out\n");
112 static void i8xx_fbc_activate(struct drm_i915_private *dev_priv)
114 struct intel_fbc_reg_params *params = &dev_priv->fbc.params;
119 /* Note: fbc.threshold == 1 for i8xx */
120 cfb_pitch = params->cfb_size / FBC_LL_SIZE;
121 if (params->fb.stride < cfb_pitch)
122 cfb_pitch = params->fb.stride;
124 /* FBC_CTL wants 32B or 64B units */
125 if (IS_GEN(dev_priv, 2))
126 cfb_pitch = (cfb_pitch / 32) - 1;
128 cfb_pitch = (cfb_pitch / 64) - 1;
131 for (i = 0; i < (FBC_LL_SIZE / 32) + 1; i++)
132 intel_de_write(dev_priv, FBC_TAG(i), 0);
134 if (IS_GEN(dev_priv, 4)) {
138 fbc_ctl2 = FBC_CTL_FENCE_DBL | FBC_CTL_IDLE_IMM;
139 fbc_ctl2 |= FBC_CTL_PLANE(params->crtc.i9xx_plane);
140 if (params->fence_id >= 0)
141 fbc_ctl2 |= FBC_CTL_CPU_FENCE;
142 intel_de_write(dev_priv, FBC_CONTROL2, fbc_ctl2);
143 intel_de_write(dev_priv, FBC_FENCE_OFF,
144 params->crtc.fence_y_offset);
148 fbc_ctl = intel_de_read(dev_priv, FBC_CONTROL);
149 fbc_ctl &= 0x3fff << FBC_CTL_INTERVAL_SHIFT;
150 fbc_ctl |= FBC_CTL_EN | FBC_CTL_PERIODIC;
151 if (IS_I945GM(dev_priv))
152 fbc_ctl |= FBC_CTL_C3_IDLE; /* 945 needs special SR handling */
153 fbc_ctl |= (cfb_pitch & 0xff) << FBC_CTL_STRIDE_SHIFT;
154 if (params->fence_id >= 0)
155 fbc_ctl |= params->fence_id;
156 intel_de_write(dev_priv, FBC_CONTROL, fbc_ctl);
159 static bool i8xx_fbc_is_active(struct drm_i915_private *dev_priv)
161 return intel_de_read(dev_priv, FBC_CONTROL) & FBC_CTL_EN;
164 static void g4x_fbc_activate(struct drm_i915_private *dev_priv)
166 struct intel_fbc_reg_params *params = &dev_priv->fbc.params;
169 dpfc_ctl = DPFC_CTL_PLANE(params->crtc.i9xx_plane) | DPFC_SR_EN;
170 if (params->fb.format->cpp[0] == 2)
171 dpfc_ctl |= DPFC_CTL_LIMIT_2X;
173 dpfc_ctl |= DPFC_CTL_LIMIT_1X;
175 if (params->fence_id >= 0) {
176 dpfc_ctl |= DPFC_CTL_FENCE_EN | params->fence_id;
177 intel_de_write(dev_priv, DPFC_FENCE_YOFF,
178 params->crtc.fence_y_offset);
180 intel_de_write(dev_priv, DPFC_FENCE_YOFF, 0);
184 intel_de_write(dev_priv, DPFC_CONTROL, dpfc_ctl | DPFC_CTL_EN);
187 static void g4x_fbc_deactivate(struct drm_i915_private *dev_priv)
191 /* Disable compression */
192 dpfc_ctl = intel_de_read(dev_priv, DPFC_CONTROL);
193 if (dpfc_ctl & DPFC_CTL_EN) {
194 dpfc_ctl &= ~DPFC_CTL_EN;
195 intel_de_write(dev_priv, DPFC_CONTROL, dpfc_ctl);
199 static bool g4x_fbc_is_active(struct drm_i915_private *dev_priv)
201 return intel_de_read(dev_priv, DPFC_CONTROL) & DPFC_CTL_EN;
204 /* This function forces a CFB recompression through the nuke operation. */
205 static void intel_fbc_recompress(struct drm_i915_private *dev_priv)
207 struct intel_fbc *fbc = &dev_priv->fbc;
209 trace_intel_fbc_nuke(fbc->crtc);
211 intel_de_write(dev_priv, MSG_FBC_REND_STATE, FBC_REND_NUKE);
212 intel_de_posting_read(dev_priv, MSG_FBC_REND_STATE);
215 static void ilk_fbc_activate(struct drm_i915_private *dev_priv)
217 struct intel_fbc_reg_params *params = &dev_priv->fbc.params;
219 int threshold = dev_priv->fbc.threshold;
221 dpfc_ctl = DPFC_CTL_PLANE(params->crtc.i9xx_plane);
222 if (params->fb.format->cpp[0] == 2)
228 dpfc_ctl |= DPFC_CTL_LIMIT_4X;
231 dpfc_ctl |= DPFC_CTL_LIMIT_2X;
234 dpfc_ctl |= DPFC_CTL_LIMIT_1X;
238 if (params->fence_id >= 0) {
239 dpfc_ctl |= DPFC_CTL_FENCE_EN;
240 if (IS_GEN(dev_priv, 5))
241 dpfc_ctl |= params->fence_id;
242 if (IS_GEN(dev_priv, 6)) {
243 intel_de_write(dev_priv, SNB_DPFC_CTL_SA,
244 SNB_CPU_FENCE_ENABLE | params->fence_id);
245 intel_de_write(dev_priv, DPFC_CPU_FENCE_OFFSET,
246 params->crtc.fence_y_offset);
249 if (IS_GEN(dev_priv, 6)) {
250 intel_de_write(dev_priv, SNB_DPFC_CTL_SA, 0);
251 intel_de_write(dev_priv, DPFC_CPU_FENCE_OFFSET, 0);
255 intel_de_write(dev_priv, ILK_DPFC_FENCE_YOFF,
256 params->crtc.fence_y_offset);
258 intel_de_write(dev_priv, ILK_DPFC_CONTROL, dpfc_ctl | DPFC_CTL_EN);
260 intel_fbc_recompress(dev_priv);
263 static void ilk_fbc_deactivate(struct drm_i915_private *dev_priv)
267 /* Disable compression */
268 dpfc_ctl = intel_de_read(dev_priv, ILK_DPFC_CONTROL);
269 if (dpfc_ctl & DPFC_CTL_EN) {
270 dpfc_ctl &= ~DPFC_CTL_EN;
271 intel_de_write(dev_priv, ILK_DPFC_CONTROL, dpfc_ctl);
275 static bool ilk_fbc_is_active(struct drm_i915_private *dev_priv)
277 return intel_de_read(dev_priv, ILK_DPFC_CONTROL) & DPFC_CTL_EN;
280 static void gen7_fbc_activate(struct drm_i915_private *dev_priv)
282 struct intel_fbc_reg_params *params = &dev_priv->fbc.params;
284 int threshold = dev_priv->fbc.threshold;
286 /* Display WA #0529: skl, kbl, bxt. */
287 if (IS_GEN9_BC(dev_priv) || IS_BROXTON(dev_priv)) {
288 u32 val = intel_de_read(dev_priv, CHICKEN_MISC_4);
290 val &= ~(FBC_STRIDE_OVERRIDE | FBC_STRIDE_MASK);
292 if (params->gen9_wa_cfb_stride)
293 val |= FBC_STRIDE_OVERRIDE | params->gen9_wa_cfb_stride;
295 intel_de_write(dev_priv, CHICKEN_MISC_4, val);
299 if (IS_IVYBRIDGE(dev_priv))
300 dpfc_ctl |= IVB_DPFC_CTL_PLANE(params->crtc.i9xx_plane);
302 if (params->fb.format->cpp[0] == 2)
308 dpfc_ctl |= DPFC_CTL_LIMIT_4X;
311 dpfc_ctl |= DPFC_CTL_LIMIT_2X;
314 dpfc_ctl |= DPFC_CTL_LIMIT_1X;
318 if (params->fence_id >= 0) {
319 dpfc_ctl |= IVB_DPFC_CTL_FENCE_EN;
320 intel_de_write(dev_priv, SNB_DPFC_CTL_SA,
321 SNB_CPU_FENCE_ENABLE | params->fence_id);
322 intel_de_write(dev_priv, DPFC_CPU_FENCE_OFFSET,
323 params->crtc.fence_y_offset);
324 } else if (dev_priv->ggtt.num_fences) {
325 intel_de_write(dev_priv, SNB_DPFC_CTL_SA, 0);
326 intel_de_write(dev_priv, DPFC_CPU_FENCE_OFFSET, 0);
329 if (dev_priv->fbc.false_color)
330 dpfc_ctl |= FBC_CTL_FALSE_COLOR;
332 if (IS_IVYBRIDGE(dev_priv)) {
333 /* WaFbcAsynchFlipDisableFbcQueue:ivb */
334 intel_de_write(dev_priv, ILK_DISPLAY_CHICKEN1,
335 intel_de_read(dev_priv, ILK_DISPLAY_CHICKEN1) | ILK_FBCQ_DIS);
336 } else if (IS_HASWELL(dev_priv) || IS_BROADWELL(dev_priv)) {
337 /* WaFbcAsynchFlipDisableFbcQueue:hsw,bdw */
338 intel_de_write(dev_priv, CHICKEN_PIPESL_1(params->crtc.pipe),
339 intel_de_read(dev_priv, CHICKEN_PIPESL_1(params->crtc.pipe)) | HSW_FBCQ_DIS);
342 if (INTEL_GEN(dev_priv) >= 11)
343 /* Wa_1409120013:icl,ehl,tgl */
344 intel_de_write(dev_priv, ILK_DPFC_CHICKEN,
345 ILK_DPFC_CHICKEN_COMP_DUMMY_PIXEL);
347 intel_de_write(dev_priv, ILK_DPFC_CONTROL, dpfc_ctl | DPFC_CTL_EN);
349 intel_fbc_recompress(dev_priv);
352 static bool intel_fbc_hw_is_active(struct drm_i915_private *dev_priv)
354 if (INTEL_GEN(dev_priv) >= 5)
355 return ilk_fbc_is_active(dev_priv);
356 else if (IS_GM45(dev_priv))
357 return g4x_fbc_is_active(dev_priv);
359 return i8xx_fbc_is_active(dev_priv);
362 static void intel_fbc_hw_activate(struct drm_i915_private *dev_priv)
364 struct intel_fbc *fbc = &dev_priv->fbc;
366 trace_intel_fbc_activate(fbc->crtc);
369 fbc->activated = true;
371 if (INTEL_GEN(dev_priv) >= 7)
372 gen7_fbc_activate(dev_priv);
373 else if (INTEL_GEN(dev_priv) >= 5)
374 ilk_fbc_activate(dev_priv);
375 else if (IS_GM45(dev_priv))
376 g4x_fbc_activate(dev_priv);
378 i8xx_fbc_activate(dev_priv);
381 static void intel_fbc_hw_deactivate(struct drm_i915_private *dev_priv)
383 struct intel_fbc *fbc = &dev_priv->fbc;
385 trace_intel_fbc_deactivate(fbc->crtc);
389 if (INTEL_GEN(dev_priv) >= 5)
390 ilk_fbc_deactivate(dev_priv);
391 else if (IS_GM45(dev_priv))
392 g4x_fbc_deactivate(dev_priv);
394 i8xx_fbc_deactivate(dev_priv);
398 * intel_fbc_is_active - Is FBC active?
399 * @dev_priv: i915 device instance
401 * This function is used to verify the current state of FBC.
403 * FIXME: This should be tracked in the plane config eventually
404 * instead of queried at runtime for most callers.
406 bool intel_fbc_is_active(struct drm_i915_private *dev_priv)
408 return dev_priv->fbc.active;
411 static void intel_fbc_deactivate(struct drm_i915_private *dev_priv,
414 struct intel_fbc *fbc = &dev_priv->fbc;
416 drm_WARN_ON(&dev_priv->drm, !mutex_is_locked(&fbc->lock));
419 intel_fbc_hw_deactivate(dev_priv);
421 fbc->no_fbc_reason = reason;
424 static int find_compression_threshold(struct drm_i915_private *dev_priv,
425 struct drm_mm_node *node,
429 int compression_threshold = 1;
433 /* The FBC hardware for BDW/SKL doesn't have access to the stolen
434 * reserved range size, so it always assumes the maximum (8mb) is used.
435 * If we enable FBC using a CFB on that memory range we'll get FIFO
436 * underruns, even if that range is not reserved by the BIOS. */
437 if (IS_BROADWELL(dev_priv) || IS_GEN9_BC(dev_priv))
438 end = resource_size(&dev_priv->dsm) - 8 * 1024 * 1024;
442 /* HACK: This code depends on what we will do in *_enable_fbc. If that
443 * code changes, this code needs to change as well.
445 * The enable_fbc code will attempt to use one of our 2 compression
446 * thresholds, therefore, in that case, we only have 1 resort.
449 /* Try to over-allocate to reduce reallocations and fragmentation. */
450 ret = i915_gem_stolen_insert_node_in_range(dev_priv, node, size <<= 1,
453 return compression_threshold;
456 /* HW's ability to limit the CFB is 1:4 */
457 if (compression_threshold > 4 ||
458 (fb_cpp == 2 && compression_threshold == 2))
461 ret = i915_gem_stolen_insert_node_in_range(dev_priv, node, size >>= 1,
463 if (ret && INTEL_GEN(dev_priv) <= 4) {
466 compression_threshold <<= 1;
469 return compression_threshold;
473 static int intel_fbc_alloc_cfb(struct drm_i915_private *dev_priv,
474 unsigned int size, unsigned int fb_cpp)
476 struct intel_fbc *fbc = &dev_priv->fbc;
477 struct drm_mm_node *uninitialized_var(compressed_llb);
480 drm_WARN_ON(&dev_priv->drm,
481 drm_mm_node_allocated(&fbc->compressed_fb));
483 ret = find_compression_threshold(dev_priv, &fbc->compressed_fb,
488 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");
492 fbc->threshold = ret;
494 if (INTEL_GEN(dev_priv) >= 5)
495 intel_de_write(dev_priv, ILK_DPFC_CB_BASE,
496 fbc->compressed_fb.start);
497 else if (IS_GM45(dev_priv)) {
498 intel_de_write(dev_priv, DPFC_CB_BASE,
499 fbc->compressed_fb.start);
501 compressed_llb = kzalloc(sizeof(*compressed_llb), GFP_KERNEL);
505 ret = i915_gem_stolen_insert_node(dev_priv, compressed_llb,
510 fbc->compressed_llb = compressed_llb;
512 GEM_BUG_ON(range_overflows_end_t(u64, dev_priv->dsm.start,
513 fbc->compressed_fb.start,
515 GEM_BUG_ON(range_overflows_end_t(u64, dev_priv->dsm.start,
516 fbc->compressed_llb->start,
518 intel_de_write(dev_priv, FBC_CFB_BASE,
519 dev_priv->dsm.start + fbc->compressed_fb.start);
520 intel_de_write(dev_priv, FBC_LL_BASE,
521 dev_priv->dsm.start + compressed_llb->start);
524 DRM_DEBUG_KMS("reserved %llu bytes of contiguous stolen space for FBC, threshold: %d\n",
525 fbc->compressed_fb.size, fbc->threshold);
530 kfree(compressed_llb);
531 i915_gem_stolen_remove_node(dev_priv, &fbc->compressed_fb);
533 if (drm_mm_initialized(&dev_priv->mm.stolen))
534 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);
538 static void __intel_fbc_cleanup_cfb(struct drm_i915_private *dev_priv)
540 struct intel_fbc *fbc = &dev_priv->fbc;
542 if (!drm_mm_node_allocated(&fbc->compressed_fb))
545 if (fbc->compressed_llb) {
546 i915_gem_stolen_remove_node(dev_priv, fbc->compressed_llb);
547 kfree(fbc->compressed_llb);
550 i915_gem_stolen_remove_node(dev_priv, &fbc->compressed_fb);
553 void intel_fbc_cleanup_cfb(struct drm_i915_private *dev_priv)
555 struct intel_fbc *fbc = &dev_priv->fbc;
557 if (!HAS_FBC(dev_priv))
560 mutex_lock(&fbc->lock);
561 __intel_fbc_cleanup_cfb(dev_priv);
562 mutex_unlock(&fbc->lock);
565 static bool stride_is_valid(struct drm_i915_private *dev_priv,
568 /* This should have been caught earlier. */
569 if (drm_WARN_ON_ONCE(&dev_priv->drm, (stride & (64 - 1)) != 0))
572 /* Below are the additional FBC restrictions. */
576 if (IS_GEN(dev_priv, 2) || IS_GEN(dev_priv, 3))
577 return stride == 4096 || stride == 8192;
579 if (IS_GEN(dev_priv, 4) && !IS_G4X(dev_priv) && stride < 2048)
588 static bool pixel_format_is_valid(struct drm_i915_private *dev_priv,
591 switch (pixel_format) {
592 case DRM_FORMAT_XRGB8888:
593 case DRM_FORMAT_XBGR8888:
595 case DRM_FORMAT_XRGB1555:
596 case DRM_FORMAT_RGB565:
597 /* 16bpp not supported on gen2 */
598 if (IS_GEN(dev_priv, 2))
600 /* WaFbcOnly1to1Ratio:ctg */
601 if (IS_G4X(dev_priv))
610 * For some reason, the hardware tracking starts looking at whatever we
611 * programmed as the display plane base address register. It does not look at
612 * the X and Y offset registers. That's why we look at the crtc->adjusted{x,y}
613 * variables instead of just looking at the pipe/plane size.
615 static bool intel_fbc_hw_tracking_covers_screen(struct intel_crtc *crtc)
617 struct drm_i915_private *dev_priv = to_i915(crtc->base.dev);
618 struct intel_fbc *fbc = &dev_priv->fbc;
619 unsigned int effective_w, effective_h, max_w, max_h;
621 if (INTEL_GEN(dev_priv) >= 10 || IS_GEMINILAKE(dev_priv)) {
624 } else if (INTEL_GEN(dev_priv) >= 8 || IS_HASWELL(dev_priv)) {
627 } else if (IS_G4X(dev_priv) || INTEL_GEN(dev_priv) >= 5) {
635 intel_fbc_get_plane_source_size(&fbc->state_cache, &effective_w,
637 effective_w += fbc->state_cache.plane.adjusted_x;
638 effective_h += fbc->state_cache.plane.adjusted_y;
640 return effective_w <= max_w && effective_h <= max_h;
643 static void intel_fbc_update_state_cache(struct intel_crtc *crtc,
644 const struct intel_crtc_state *crtc_state,
645 const struct intel_plane_state *plane_state)
647 struct drm_i915_private *dev_priv = to_i915(crtc->base.dev);
648 struct intel_fbc *fbc = &dev_priv->fbc;
649 struct intel_fbc_state_cache *cache = &fbc->state_cache;
650 struct drm_framebuffer *fb = plane_state->hw.fb;
652 cache->plane.visible = plane_state->uapi.visible;
653 if (!cache->plane.visible)
656 cache->crtc.mode_flags = crtc_state->hw.adjusted_mode.flags;
657 if (IS_HASWELL(dev_priv) || IS_BROADWELL(dev_priv))
658 cache->crtc.hsw_bdw_pixel_rate = crtc_state->pixel_rate;
660 cache->plane.rotation = plane_state->hw.rotation;
662 * Src coordinates are already rotated by 270 degrees for
663 * the 90/270 degree plane rotation cases (to match the
664 * GTT mapping), hence no need to account for rotation here.
666 cache->plane.src_w = drm_rect_width(&plane_state->uapi.src) >> 16;
667 cache->plane.src_h = drm_rect_height(&plane_state->uapi.src) >> 16;
668 cache->plane.adjusted_x = plane_state->color_plane[0].x;
669 cache->plane.adjusted_y = plane_state->color_plane[0].y;
670 cache->plane.y = plane_state->uapi.src.y1 >> 16;
672 cache->plane.pixel_blend_mode = plane_state->hw.pixel_blend_mode;
674 cache->fb.format = fb->format;
675 cache->fb.stride = fb->pitches[0];
677 drm_WARN_ON(&dev_priv->drm, plane_state->flags & PLANE_HAS_FENCE &&
678 !plane_state->vma->fence);
680 if (plane_state->flags & PLANE_HAS_FENCE &&
681 plane_state->vma->fence)
682 cache->fence_id = plane_state->vma->fence->id;
684 cache->fence_id = -1;
687 static bool intel_fbc_cfb_size_changed(struct drm_i915_private *dev_priv)
689 struct intel_fbc *fbc = &dev_priv->fbc;
691 return intel_fbc_calculate_cfb_size(dev_priv, &fbc->state_cache) >
692 fbc->compressed_fb.size * fbc->threshold;
695 static bool intel_fbc_can_enable(struct drm_i915_private *dev_priv)
697 struct intel_fbc *fbc = &dev_priv->fbc;
699 if (intel_vgpu_active(dev_priv)) {
700 fbc->no_fbc_reason = "VGPU is active";
704 if (!i915_modparams.enable_fbc) {
705 fbc->no_fbc_reason = "disabled per module param or by default";
709 if (fbc->underrun_detected) {
710 fbc->no_fbc_reason = "underrun detected";
717 static bool intel_fbc_can_activate(struct intel_crtc *crtc)
719 struct drm_i915_private *dev_priv = to_i915(crtc->base.dev);
720 struct intel_fbc *fbc = &dev_priv->fbc;
721 struct intel_fbc_state_cache *cache = &fbc->state_cache;
723 if (!intel_fbc_can_enable(dev_priv))
726 if (!cache->plane.visible) {
727 fbc->no_fbc_reason = "primary plane not visible";
731 /* We don't need to use a state cache here since this information is
732 * global for all CRTC.
734 if (fbc->underrun_detected) {
735 fbc->no_fbc_reason = "underrun detected";
739 if (cache->crtc.mode_flags & DRM_MODE_FLAG_INTERLACE) {
740 fbc->no_fbc_reason = "incompatible mode";
744 if (!intel_fbc_hw_tracking_covers_screen(crtc)) {
745 fbc->no_fbc_reason = "mode too large for compression";
749 /* The use of a CPU fence is mandatory in order to detect writes
750 * by the CPU to the scanout and trigger updates to the FBC.
752 * Note that is possible for a tiled surface to be unmappable (and
753 * so have no fence associated with it) due to aperture constaints
754 * at the time of pinning.
756 * FIXME with 90/270 degree rotation we should use the fence on
757 * the normal GTT view (the rotated view doesn't even have a
758 * fence). Would need changes to the FBC fence Y offset as well.
759 * For now this will effecively disable FBC with 90/270 degree
762 if (cache->fence_id < 0) {
763 fbc->no_fbc_reason = "framebuffer not tiled or fenced";
766 if (INTEL_GEN(dev_priv) <= 4 && !IS_G4X(dev_priv) &&
767 cache->plane.rotation != DRM_MODE_ROTATE_0) {
768 fbc->no_fbc_reason = "rotation unsupported";
772 if (!stride_is_valid(dev_priv, cache->fb.stride)) {
773 fbc->no_fbc_reason = "framebuffer stride not supported";
777 if (!pixel_format_is_valid(dev_priv, cache->fb.format->format)) {
778 fbc->no_fbc_reason = "pixel format is invalid";
782 if (cache->plane.pixel_blend_mode != DRM_MODE_BLEND_PIXEL_NONE &&
783 cache->fb.format->has_alpha) {
784 fbc->no_fbc_reason = "per-pixel alpha blending is incompatible with FBC";
788 /* WaFbcExceedCdClockThreshold:hsw,bdw */
789 if ((IS_HASWELL(dev_priv) || IS_BROADWELL(dev_priv)) &&
790 cache->crtc.hsw_bdw_pixel_rate >= dev_priv->cdclk.hw.cdclk * 95 / 100) {
791 fbc->no_fbc_reason = "pixel rate is too big";
795 /* It is possible for the required CFB size change without a
796 * crtc->disable + crtc->enable since it is possible to change the
797 * stride without triggering a full modeset. Since we try to
798 * over-allocate the CFB, there's a chance we may keep FBC enabled even
799 * if this happens, but if we exceed the current CFB size we'll have to
800 * disable FBC. Notice that it would be possible to disable FBC, wait
801 * for a frame, free the stolen node, then try to reenable FBC in case
802 * we didn't get any invalidate/deactivate calls, but this would require
803 * a lot of tracking just for a specific case. If we conclude it's an
804 * important case, we can implement it later. */
805 if (intel_fbc_cfb_size_changed(dev_priv)) {
806 fbc->no_fbc_reason = "CFB requirements changed";
811 * Work around a problem on GEN9+ HW, where enabling FBC on a plane
812 * having a Y offset that isn't divisible by 4 causes FIFO underrun
813 * and screen flicker.
815 if (INTEL_GEN(dev_priv) >= 9 &&
816 (fbc->state_cache.plane.adjusted_y & 3)) {
817 fbc->no_fbc_reason = "plane Y offset is misaligned";
824 static void intel_fbc_get_reg_params(struct intel_crtc *crtc,
825 struct intel_fbc_reg_params *params)
827 struct drm_i915_private *dev_priv = to_i915(crtc->base.dev);
828 struct intel_fbc *fbc = &dev_priv->fbc;
829 struct intel_fbc_state_cache *cache = &fbc->state_cache;
831 /* Since all our fields are integer types, use memset here so the
832 * comparison function can rely on memcmp because the padding will be
834 memset(params, 0, sizeof(*params));
836 params->fence_id = cache->fence_id;
838 params->crtc.pipe = crtc->pipe;
839 params->crtc.i9xx_plane = to_intel_plane(crtc->base.primary)->i9xx_plane;
840 params->crtc.fence_y_offset = get_crtc_fence_y_offset(fbc);
842 params->fb.format = cache->fb.format;
843 params->fb.stride = cache->fb.stride;
845 params->cfb_size = intel_fbc_calculate_cfb_size(dev_priv, cache);
847 params->gen9_wa_cfb_stride = cache->gen9_wa_cfb_stride;
849 params->plane_visible = cache->plane.visible;
852 static bool intel_fbc_can_flip_nuke(const struct intel_crtc_state *crtc_state)
854 struct intel_crtc *crtc = to_intel_crtc(crtc_state->uapi.crtc);
855 struct drm_i915_private *dev_priv = to_i915(crtc->base.dev);
856 const struct intel_fbc *fbc = &dev_priv->fbc;
857 const struct intel_fbc_state_cache *cache = &fbc->state_cache;
858 const struct intel_fbc_reg_params *params = &fbc->params;
860 if (drm_atomic_crtc_needs_modeset(&crtc_state->uapi))
863 if (!params->plane_visible)
866 if (!intel_fbc_can_activate(crtc))
869 if (params->fb.format != cache->fb.format)
872 if (params->fb.stride != cache->fb.stride)
875 if (params->cfb_size != intel_fbc_calculate_cfb_size(dev_priv, cache))
878 if (params->gen9_wa_cfb_stride != cache->gen9_wa_cfb_stride)
884 bool intel_fbc_pre_update(struct intel_atomic_state *state,
885 struct intel_crtc *crtc)
887 struct intel_plane *plane = to_intel_plane(crtc->base.primary);
888 const struct intel_crtc_state *crtc_state =
889 intel_atomic_get_new_crtc_state(state, crtc);
890 const struct intel_plane_state *plane_state =
891 intel_atomic_get_new_plane_state(state, plane);
892 struct drm_i915_private *dev_priv = to_i915(crtc->base.dev);
893 struct intel_fbc *fbc = &dev_priv->fbc;
894 const char *reason = "update pending";
895 bool need_vblank_wait = false;
897 if (!plane->has_fbc || !plane_state)
898 return need_vblank_wait;
900 mutex_lock(&fbc->lock);
902 if (fbc->crtc != crtc)
905 intel_fbc_update_state_cache(crtc, crtc_state, plane_state);
906 fbc->flip_pending = true;
908 if (!intel_fbc_can_flip_nuke(crtc_state)) {
909 intel_fbc_deactivate(dev_priv, reason);
912 * Display WA #1198: glk+
913 * Need an extra vblank wait between FBC disable and most plane
914 * updates. Bspec says this is only needed for plane disable, but
915 * that is not true. Touching most plane registers will cause the
916 * corruption to appear. Also SKL/derivatives do not seem to be
919 * TODO: could optimize this a bit by sampling the frame
920 * counter when we disable FBC (if it was already done earlier)
921 * and skipping the extra vblank wait before the plane update
922 * if at least one frame has already passed.
924 if (fbc->activated &&
925 (INTEL_GEN(dev_priv) >= 10 || IS_GEMINILAKE(dev_priv)))
926 need_vblank_wait = true;
927 fbc->activated = false;
930 mutex_unlock(&fbc->lock);
932 return need_vblank_wait;
936 * __intel_fbc_disable - disable FBC
937 * @dev_priv: i915 device instance
939 * This is the low level function that actually disables FBC. Callers should
942 static void __intel_fbc_disable(struct drm_i915_private *dev_priv)
944 struct intel_fbc *fbc = &dev_priv->fbc;
945 struct intel_crtc *crtc = fbc->crtc;
947 drm_WARN_ON(&dev_priv->drm, !mutex_is_locked(&fbc->lock));
948 drm_WARN_ON(&dev_priv->drm, !fbc->crtc);
949 drm_WARN_ON(&dev_priv->drm, fbc->active);
951 DRM_DEBUG_KMS("Disabling FBC on pipe %c\n", pipe_name(crtc->pipe));
953 __intel_fbc_cleanup_cfb(dev_priv);
958 static void __intel_fbc_post_update(struct intel_crtc *crtc)
960 struct drm_i915_private *dev_priv = to_i915(crtc->base.dev);
961 struct intel_fbc *fbc = &dev_priv->fbc;
963 drm_WARN_ON(&dev_priv->drm, !mutex_is_locked(&fbc->lock));
965 if (fbc->crtc != crtc)
968 fbc->flip_pending = false;
970 if (!i915_modparams.enable_fbc) {
971 intel_fbc_deactivate(dev_priv, "disabled at runtime per module param");
972 __intel_fbc_disable(dev_priv);
977 intel_fbc_get_reg_params(crtc, &fbc->params);
979 if (!intel_fbc_can_activate(crtc))
983 intel_fbc_hw_activate(dev_priv);
985 intel_fbc_deactivate(dev_priv, "frontbuffer write");
988 void intel_fbc_post_update(struct intel_atomic_state *state,
989 struct intel_crtc *crtc)
991 struct drm_i915_private *dev_priv = to_i915(crtc->base.dev);
992 struct intel_plane *plane = to_intel_plane(crtc->base.primary);
993 const struct intel_plane_state *plane_state =
994 intel_atomic_get_new_plane_state(state, plane);
995 struct intel_fbc *fbc = &dev_priv->fbc;
997 if (!plane->has_fbc || !plane_state)
1000 mutex_lock(&fbc->lock);
1001 __intel_fbc_post_update(crtc);
1002 mutex_unlock(&fbc->lock);
1005 static unsigned int intel_fbc_get_frontbuffer_bit(struct intel_fbc *fbc)
1008 return to_intel_plane(fbc->crtc->base.primary)->frontbuffer_bit;
1010 return fbc->possible_framebuffer_bits;
1013 void intel_fbc_invalidate(struct drm_i915_private *dev_priv,
1014 unsigned int frontbuffer_bits,
1015 enum fb_op_origin origin)
1017 struct intel_fbc *fbc = &dev_priv->fbc;
1019 if (!HAS_FBC(dev_priv))
1022 if (origin == ORIGIN_GTT || origin == ORIGIN_FLIP)
1025 mutex_lock(&fbc->lock);
1027 fbc->busy_bits |= intel_fbc_get_frontbuffer_bit(fbc) & frontbuffer_bits;
1029 if (fbc->crtc && fbc->busy_bits)
1030 intel_fbc_deactivate(dev_priv, "frontbuffer write");
1032 mutex_unlock(&fbc->lock);
1035 void intel_fbc_flush(struct drm_i915_private *dev_priv,
1036 unsigned int frontbuffer_bits, enum fb_op_origin origin)
1038 struct intel_fbc *fbc = &dev_priv->fbc;
1040 if (!HAS_FBC(dev_priv))
1043 mutex_lock(&fbc->lock);
1045 fbc->busy_bits &= ~frontbuffer_bits;
1047 if (origin == ORIGIN_GTT || origin == ORIGIN_FLIP)
1050 if (!fbc->busy_bits && fbc->crtc &&
1051 (frontbuffer_bits & intel_fbc_get_frontbuffer_bit(fbc))) {
1053 intel_fbc_recompress(dev_priv);
1054 else if (!fbc->flip_pending)
1055 __intel_fbc_post_update(fbc->crtc);
1059 mutex_unlock(&fbc->lock);
1063 * intel_fbc_choose_crtc - select a CRTC to enable FBC on
1064 * @dev_priv: i915 device instance
1065 * @state: the atomic state structure
1067 * This function looks at the proposed state for CRTCs and planes, then chooses
1068 * which pipe is going to have FBC by setting intel_crtc_state->enable_fbc to
1071 * Later, intel_fbc_enable is going to look for state->enable_fbc and then maybe
1072 * enable FBC for the chosen CRTC. If it does, it will set dev_priv->fbc.crtc.
1074 void intel_fbc_choose_crtc(struct drm_i915_private *dev_priv,
1075 struct intel_atomic_state *state)
1077 struct intel_fbc *fbc = &dev_priv->fbc;
1078 struct intel_plane *plane;
1079 struct intel_plane_state *plane_state;
1080 bool crtc_chosen = false;
1083 mutex_lock(&fbc->lock);
1085 /* Does this atomic commit involve the CRTC currently tied to FBC? */
1087 !intel_atomic_get_new_crtc_state(state, fbc->crtc))
1090 if (!intel_fbc_can_enable(dev_priv))
1093 /* Simply choose the first CRTC that is compatible and has a visible
1094 * plane. We could go for fancier schemes such as checking the plane
1095 * size, but this would just affect the few platforms that don't tie FBC
1096 * to pipe or plane A. */
1097 for_each_new_intel_plane_in_state(state, plane, plane_state, i) {
1098 struct intel_crtc_state *crtc_state;
1099 struct intel_crtc *crtc = to_intel_crtc(plane_state->hw.crtc);
1101 if (!plane->has_fbc)
1104 if (!plane_state->uapi.visible)
1107 crtc_state = intel_atomic_get_new_crtc_state(state, crtc);
1109 crtc_state->enable_fbc = true;
1115 fbc->no_fbc_reason = "no suitable CRTC for FBC";
1118 mutex_unlock(&fbc->lock);
1122 * intel_fbc_enable: tries to enable FBC on the CRTC
1124 * @state: corresponding &drm_crtc_state for @crtc
1126 * This function checks if the given CRTC was chosen for FBC, then enables it if
1127 * possible. Notice that it doesn't activate FBC. It is valid to call
1128 * intel_fbc_enable multiple times for the same pipe without an
1129 * intel_fbc_disable in the middle, as long as it is deactivated.
1131 void intel_fbc_enable(struct intel_atomic_state *state,
1132 struct intel_crtc *crtc)
1134 struct drm_i915_private *dev_priv = to_i915(crtc->base.dev);
1135 struct intel_plane *plane = to_intel_plane(crtc->base.primary);
1136 const struct intel_crtc_state *crtc_state =
1137 intel_atomic_get_new_crtc_state(state, crtc);
1138 const struct intel_plane_state *plane_state =
1139 intel_atomic_get_new_plane_state(state, plane);
1140 struct intel_fbc *fbc = &dev_priv->fbc;
1141 struct intel_fbc_state_cache *cache = &fbc->state_cache;
1143 if (!plane->has_fbc || !plane_state)
1146 mutex_lock(&fbc->lock);
1149 if (fbc->crtc != crtc ||
1150 !intel_fbc_cfb_size_changed(dev_priv))
1153 __intel_fbc_disable(dev_priv);
1156 drm_WARN_ON(&dev_priv->drm, fbc->active);
1158 intel_fbc_update_state_cache(crtc, crtc_state, plane_state);
1160 /* FIXME crtc_state->enable_fbc lies :( */
1161 if (!cache->plane.visible)
1164 if (intel_fbc_alloc_cfb(dev_priv,
1165 intel_fbc_calculate_cfb_size(dev_priv, cache),
1166 plane_state->hw.fb->format->cpp[0])) {
1167 cache->plane.visible = false;
1168 fbc->no_fbc_reason = "not enough stolen memory";
1172 if ((IS_GEN9_BC(dev_priv) || IS_BROXTON(dev_priv)) &&
1173 plane_state->hw.fb->modifier != I915_FORMAT_MOD_X_TILED)
1174 cache->gen9_wa_cfb_stride =
1175 DIV_ROUND_UP(cache->plane.src_w, 32 * fbc->threshold) * 8;
1177 cache->gen9_wa_cfb_stride = 0;
1179 DRM_DEBUG_KMS("Enabling FBC on pipe %c\n", pipe_name(crtc->pipe));
1180 fbc->no_fbc_reason = "FBC enabled but not active yet\n";
1184 mutex_unlock(&fbc->lock);
1188 * intel_fbc_disable - disable FBC if it's associated with crtc
1191 * This function disables FBC if it's associated with the provided CRTC.
1193 void intel_fbc_disable(struct intel_crtc *crtc)
1195 struct drm_i915_private *dev_priv = to_i915(crtc->base.dev);
1196 struct intel_plane *plane = to_intel_plane(crtc->base.primary);
1197 struct intel_fbc *fbc = &dev_priv->fbc;
1199 if (!plane->has_fbc)
1202 mutex_lock(&fbc->lock);
1203 if (fbc->crtc == crtc)
1204 __intel_fbc_disable(dev_priv);
1205 mutex_unlock(&fbc->lock);
1209 * intel_fbc_global_disable - globally disable FBC
1210 * @dev_priv: i915 device instance
1212 * This function disables FBC regardless of which CRTC is associated with it.
1214 void intel_fbc_global_disable(struct drm_i915_private *dev_priv)
1216 struct intel_fbc *fbc = &dev_priv->fbc;
1218 if (!HAS_FBC(dev_priv))
1221 mutex_lock(&fbc->lock);
1223 drm_WARN_ON(&dev_priv->drm, fbc->crtc->active);
1224 __intel_fbc_disable(dev_priv);
1226 mutex_unlock(&fbc->lock);
1229 static void intel_fbc_underrun_work_fn(struct work_struct *work)
1231 struct drm_i915_private *dev_priv =
1232 container_of(work, struct drm_i915_private, fbc.underrun_work);
1233 struct intel_fbc *fbc = &dev_priv->fbc;
1235 mutex_lock(&fbc->lock);
1237 /* Maybe we were scheduled twice. */
1238 if (fbc->underrun_detected || !fbc->crtc)
1241 DRM_DEBUG_KMS("Disabling FBC due to FIFO underrun.\n");
1242 fbc->underrun_detected = true;
1244 intel_fbc_deactivate(dev_priv, "FIFO underrun");
1246 mutex_unlock(&fbc->lock);
1250 * intel_fbc_reset_underrun - reset FBC fifo underrun status.
1251 * @dev_priv: i915 device instance
1253 * See intel_fbc_handle_fifo_underrun_irq(). For automated testing we
1254 * want to re-enable FBC after an underrun to increase test coverage.
1256 int intel_fbc_reset_underrun(struct drm_i915_private *dev_priv)
1260 cancel_work_sync(&dev_priv->fbc.underrun_work);
1262 ret = mutex_lock_interruptible(&dev_priv->fbc.lock);
1266 if (dev_priv->fbc.underrun_detected) {
1267 DRM_DEBUG_KMS("Re-allowing FBC after fifo underrun\n");
1268 dev_priv->fbc.no_fbc_reason = "FIFO underrun cleared";
1271 dev_priv->fbc.underrun_detected = false;
1272 mutex_unlock(&dev_priv->fbc.lock);
1278 * intel_fbc_handle_fifo_underrun_irq - disable FBC when we get a FIFO underrun
1279 * @dev_priv: i915 device instance
1281 * Without FBC, most underruns are harmless and don't really cause too many
1282 * problems, except for an annoying message on dmesg. With FBC, underruns can
1283 * become black screens or even worse, especially when paired with bad
1284 * watermarks. So in order for us to be on the safe side, completely disable FBC
1285 * in case we ever detect a FIFO underrun on any pipe. An underrun on any pipe
1286 * already suggests that watermarks may be bad, so try to be as safe as
1289 * This function is called from the IRQ handler.
1291 void intel_fbc_handle_fifo_underrun_irq(struct drm_i915_private *dev_priv)
1293 struct intel_fbc *fbc = &dev_priv->fbc;
1295 if (!HAS_FBC(dev_priv))
1298 /* There's no guarantee that underrun_detected won't be set to true
1299 * right after this check and before the work is scheduled, but that's
1300 * not a problem since we'll check it again under the work function
1301 * while FBC is locked. This check here is just to prevent us from
1302 * unnecessarily scheduling the work, and it relies on the fact that we
1303 * never switch underrun_detect back to false after it's true. */
1304 if (READ_ONCE(fbc->underrun_detected))
1307 schedule_work(&fbc->underrun_work);
1311 * The DDX driver changes its behavior depending on the value it reads from
1312 * i915.enable_fbc, so sanitize it by translating the default value into either
1313 * 0 or 1 in order to allow it to know what's going on.
1315 * Notice that this is done at driver initialization and we still allow user
1316 * space to change the value during runtime without sanitizing it again. IGT
1317 * relies on being able to change i915.enable_fbc at runtime.
1319 static int intel_sanitize_fbc_option(struct drm_i915_private *dev_priv)
1321 if (i915_modparams.enable_fbc >= 0)
1322 return !!i915_modparams.enable_fbc;
1324 if (!HAS_FBC(dev_priv))
1327 if (IS_BROADWELL(dev_priv) || INTEL_GEN(dev_priv) >= 9)
1333 static bool need_fbc_vtd_wa(struct drm_i915_private *dev_priv)
1335 /* WaFbcTurnOffFbcWhenHyperVisorIsUsed:skl,bxt */
1336 if (intel_vtd_active() &&
1337 (IS_SKYLAKE(dev_priv) || IS_BROXTON(dev_priv))) {
1338 DRM_INFO("Disabling framebuffer compression (FBC) to prevent screen flicker with VT-d enabled\n");
1346 * intel_fbc_init - Initialize FBC
1347 * @dev_priv: the i915 device
1349 * This function might be called during PM init process.
1351 void intel_fbc_init(struct drm_i915_private *dev_priv)
1353 struct intel_fbc *fbc = &dev_priv->fbc;
1355 INIT_WORK(&fbc->underrun_work, intel_fbc_underrun_work_fn);
1356 mutex_init(&fbc->lock);
1357 fbc->active = false;
1359 if (!drm_mm_initialized(&dev_priv->mm.stolen))
1360 mkwrite_device_info(dev_priv)->display.has_fbc = false;
1362 if (need_fbc_vtd_wa(dev_priv))
1363 mkwrite_device_info(dev_priv)->display.has_fbc = false;
1365 i915_modparams.enable_fbc = intel_sanitize_fbc_option(dev_priv);
1366 DRM_DEBUG_KMS("Sanitized enable_fbc value: %d\n",
1367 i915_modparams.enable_fbc);
1369 if (!HAS_FBC(dev_priv)) {
1370 fbc->no_fbc_reason = "unsupported by this chipset";
1374 /* This value was pulled out of someone's hat */
1375 if (INTEL_GEN(dev_priv) <= 4 && !IS_GM45(dev_priv))
1376 intel_de_write(dev_priv, FBC_CONTROL,
1377 500 << FBC_CTL_INTERVAL_SHIFT);
1379 /* We still don't have any sort of hardware state readout for FBC, so
1380 * deactivate it in case the BIOS activated it to make sure software
1381 * matches the hardware state. */
1382 if (intel_fbc_hw_is_active(dev_priv))
1383 intel_fbc_hw_deactivate(dev_priv);