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 "intel_drv.h"
44 static inline bool fbc_supported(struct drm_i915_private *dev_priv)
46 return dev_priv->fbc.activate != NULL;
49 static inline bool fbc_on_pipe_a_only(struct drm_i915_private *dev_priv)
51 return IS_HASWELL(dev_priv) || INTEL_INFO(dev_priv)->gen >= 8;
54 static inline bool fbc_on_plane_a_only(struct drm_i915_private *dev_priv)
56 return INTEL_INFO(dev_priv)->gen < 4;
60 * In some platforms where the CRTC's x:0/y:0 coordinates doesn't match the
61 * frontbuffer's x:0/y:0 coordinates we lie to the hardware about the plane's
62 * origin so the x and y offsets can actually fit the registers. As a
63 * consequence, the fence doesn't really start exactly at the display plane
64 * address we program because it starts at the real start of the buffer, so we
65 * have to take this into consideration here.
67 static unsigned int get_crtc_fence_y_offset(struct intel_crtc *crtc)
69 return crtc->base.y - crtc->adjusted_y;
73 * For SKL+, the plane source size used by the hardware is based on the value we
74 * write to the PLANE_SIZE register. For BDW-, the hardware looks at the value
75 * we wrote to PIPESRC.
77 static void intel_fbc_get_plane_source_size(struct intel_fbc_state_cache *cache,
78 int *width, int *height)
82 if (intel_rotation_90_or_270(cache->plane.rotation)) {
83 w = cache->plane.src_h;
84 h = cache->plane.src_w;
86 w = cache->plane.src_w;
87 h = cache->plane.src_h;
96 static int intel_fbc_calculate_cfb_size(struct drm_i915_private *dev_priv,
97 struct intel_fbc_state_cache *cache)
101 intel_fbc_get_plane_source_size(cache, NULL, &lines);
102 if (INTEL_INFO(dev_priv)->gen >= 7)
103 lines = min(lines, 2048);
105 /* Hardware needs the full buffer stride, not just the active area. */
106 return lines * cache->fb.stride;
109 static void i8xx_fbc_deactivate(struct drm_i915_private *dev_priv)
113 dev_priv->fbc.active = false;
115 /* Disable compression */
116 fbc_ctl = I915_READ(FBC_CONTROL);
117 if ((fbc_ctl & FBC_CTL_EN) == 0)
120 fbc_ctl &= ~FBC_CTL_EN;
121 I915_WRITE(FBC_CONTROL, fbc_ctl);
123 /* Wait for compressing bit to clear */
124 if (wait_for((I915_READ(FBC_STATUS) & FBC_STAT_COMPRESSING) == 0, 10)) {
125 DRM_DEBUG_KMS("FBC idle timed out\n");
130 static void i8xx_fbc_activate(struct drm_i915_private *dev_priv)
132 struct intel_fbc_reg_params *params = &dev_priv->fbc.params;
137 dev_priv->fbc.active = true;
139 /* Note: fbc.threshold == 1 for i8xx */
140 cfb_pitch = params->cfb_size / FBC_LL_SIZE;
141 if (params->fb.stride < cfb_pitch)
142 cfb_pitch = params->fb.stride;
144 /* FBC_CTL wants 32B or 64B units */
145 if (IS_GEN2(dev_priv))
146 cfb_pitch = (cfb_pitch / 32) - 1;
148 cfb_pitch = (cfb_pitch / 64) - 1;
151 for (i = 0; i < (FBC_LL_SIZE / 32) + 1; i++)
152 I915_WRITE(FBC_TAG(i), 0);
154 if (IS_GEN4(dev_priv)) {
158 fbc_ctl2 = FBC_CTL_FENCE_DBL | FBC_CTL_IDLE_IMM | FBC_CTL_CPU_FENCE;
159 fbc_ctl2 |= FBC_CTL_PLANE(params->crtc.plane);
160 I915_WRITE(FBC_CONTROL2, fbc_ctl2);
161 I915_WRITE(FBC_FENCE_OFF, params->crtc.fence_y_offset);
165 fbc_ctl = I915_READ(FBC_CONTROL);
166 fbc_ctl &= 0x3fff << FBC_CTL_INTERVAL_SHIFT;
167 fbc_ctl |= FBC_CTL_EN | FBC_CTL_PERIODIC;
168 if (IS_I945GM(dev_priv))
169 fbc_ctl |= FBC_CTL_C3_IDLE; /* 945 needs special SR handling */
170 fbc_ctl |= (cfb_pitch & 0xff) << FBC_CTL_STRIDE_SHIFT;
171 fbc_ctl |= params->fb.fence_reg;
172 I915_WRITE(FBC_CONTROL, fbc_ctl);
175 static bool i8xx_fbc_is_active(struct drm_i915_private *dev_priv)
177 return I915_READ(FBC_CONTROL) & FBC_CTL_EN;
180 static void g4x_fbc_activate(struct drm_i915_private *dev_priv)
182 struct intel_fbc_reg_params *params = &dev_priv->fbc.params;
185 dev_priv->fbc.active = true;
187 dpfc_ctl = DPFC_CTL_PLANE(params->crtc.plane) | DPFC_SR_EN;
188 if (drm_format_plane_cpp(params->fb.pixel_format, 0) == 2)
189 dpfc_ctl |= DPFC_CTL_LIMIT_2X;
191 dpfc_ctl |= DPFC_CTL_LIMIT_1X;
192 dpfc_ctl |= DPFC_CTL_FENCE_EN | params->fb.fence_reg;
194 I915_WRITE(DPFC_FENCE_YOFF, params->crtc.fence_y_offset);
197 I915_WRITE(DPFC_CONTROL, dpfc_ctl | DPFC_CTL_EN);
200 static void g4x_fbc_deactivate(struct drm_i915_private *dev_priv)
204 dev_priv->fbc.active = false;
206 /* Disable compression */
207 dpfc_ctl = I915_READ(DPFC_CONTROL);
208 if (dpfc_ctl & DPFC_CTL_EN) {
209 dpfc_ctl &= ~DPFC_CTL_EN;
210 I915_WRITE(DPFC_CONTROL, dpfc_ctl);
214 static bool g4x_fbc_is_active(struct drm_i915_private *dev_priv)
216 return I915_READ(DPFC_CONTROL) & DPFC_CTL_EN;
219 /* This function forces a CFB recompression through the nuke operation. */
220 static void intel_fbc_recompress(struct drm_i915_private *dev_priv)
222 I915_WRITE(MSG_FBC_REND_STATE, FBC_REND_NUKE);
223 POSTING_READ(MSG_FBC_REND_STATE);
226 static void ilk_fbc_activate(struct drm_i915_private *dev_priv)
228 struct intel_fbc_reg_params *params = &dev_priv->fbc.params;
230 int threshold = dev_priv->fbc.threshold;
232 dev_priv->fbc.active = true;
234 dpfc_ctl = DPFC_CTL_PLANE(params->crtc.plane);
235 if (drm_format_plane_cpp(params->fb.pixel_format, 0) == 2)
241 dpfc_ctl |= DPFC_CTL_LIMIT_4X;
244 dpfc_ctl |= DPFC_CTL_LIMIT_2X;
247 dpfc_ctl |= DPFC_CTL_LIMIT_1X;
250 dpfc_ctl |= DPFC_CTL_FENCE_EN;
251 if (IS_GEN5(dev_priv))
252 dpfc_ctl |= params->fb.fence_reg;
254 I915_WRITE(ILK_DPFC_FENCE_YOFF, params->crtc.fence_y_offset);
255 I915_WRITE(ILK_FBC_RT_BASE, params->fb.ggtt_offset | ILK_FBC_RT_VALID);
257 I915_WRITE(ILK_DPFC_CONTROL, dpfc_ctl | DPFC_CTL_EN);
259 if (IS_GEN6(dev_priv)) {
260 I915_WRITE(SNB_DPFC_CTL_SA,
261 SNB_CPU_FENCE_ENABLE | params->fb.fence_reg);
262 I915_WRITE(DPFC_CPU_FENCE_OFFSET, params->crtc.fence_y_offset);
265 intel_fbc_recompress(dev_priv);
268 static void ilk_fbc_deactivate(struct drm_i915_private *dev_priv)
272 dev_priv->fbc.active = false;
274 /* Disable compression */
275 dpfc_ctl = I915_READ(ILK_DPFC_CONTROL);
276 if (dpfc_ctl & DPFC_CTL_EN) {
277 dpfc_ctl &= ~DPFC_CTL_EN;
278 I915_WRITE(ILK_DPFC_CONTROL, dpfc_ctl);
282 static bool ilk_fbc_is_active(struct drm_i915_private *dev_priv)
284 return I915_READ(ILK_DPFC_CONTROL) & DPFC_CTL_EN;
287 static void gen7_fbc_activate(struct drm_i915_private *dev_priv)
289 struct intel_fbc_reg_params *params = &dev_priv->fbc.params;
291 int threshold = dev_priv->fbc.threshold;
293 dev_priv->fbc.active = true;
296 if (IS_IVYBRIDGE(dev_priv))
297 dpfc_ctl |= IVB_DPFC_CTL_PLANE(params->crtc.plane);
299 if (drm_format_plane_cpp(params->fb.pixel_format, 0) == 2)
305 dpfc_ctl |= DPFC_CTL_LIMIT_4X;
308 dpfc_ctl |= DPFC_CTL_LIMIT_2X;
311 dpfc_ctl |= DPFC_CTL_LIMIT_1X;
315 dpfc_ctl |= IVB_DPFC_CTL_FENCE_EN;
317 if (dev_priv->fbc.false_color)
318 dpfc_ctl |= FBC_CTL_FALSE_COLOR;
320 if (IS_IVYBRIDGE(dev_priv)) {
321 /* WaFbcAsynchFlipDisableFbcQueue:ivb */
322 I915_WRITE(ILK_DISPLAY_CHICKEN1,
323 I915_READ(ILK_DISPLAY_CHICKEN1) |
325 } else if (IS_HASWELL(dev_priv) || IS_BROADWELL(dev_priv)) {
326 /* WaFbcAsynchFlipDisableFbcQueue:hsw,bdw */
327 I915_WRITE(CHICKEN_PIPESL_1(params->crtc.pipe),
328 I915_READ(CHICKEN_PIPESL_1(params->crtc.pipe)) |
332 I915_WRITE(ILK_DPFC_CONTROL, dpfc_ctl | DPFC_CTL_EN);
334 I915_WRITE(SNB_DPFC_CTL_SA,
335 SNB_CPU_FENCE_ENABLE | params->fb.fence_reg);
336 I915_WRITE(DPFC_CPU_FENCE_OFFSET, params->crtc.fence_y_offset);
338 intel_fbc_recompress(dev_priv);
342 * intel_fbc_is_active - Is FBC active?
343 * @dev_priv: i915 device instance
345 * This function is used to verify the current state of FBC.
346 * FIXME: This should be tracked in the plane config eventually
347 * instead of queried at runtime for most callers.
349 bool intel_fbc_is_active(struct drm_i915_private *dev_priv)
351 return dev_priv->fbc.active;
354 static void intel_fbc_work_fn(struct work_struct *__work)
356 struct drm_i915_private *dev_priv =
357 container_of(__work, struct drm_i915_private, fbc.work.work);
358 struct intel_fbc *fbc = &dev_priv->fbc;
359 struct intel_fbc_work *work = &fbc->work;
360 struct intel_crtc *crtc = fbc->crtc;
361 struct drm_vblank_crtc *vblank = &dev_priv->dev->vblank[crtc->pipe];
363 if (drm_crtc_vblank_get(&crtc->base)) {
364 DRM_ERROR("vblank not available for FBC on pipe %c\n",
365 pipe_name(crtc->pipe));
367 mutex_lock(&fbc->lock);
368 work->scheduled = false;
369 mutex_unlock(&fbc->lock);
374 /* Delay the actual enabling to let pageflipping cease and the
375 * display to settle before starting the compression. Note that
376 * this delay also serves a second purpose: it allows for a
377 * vblank to pass after disabling the FBC before we attempt
378 * to modify the control registers.
380 * WaFbcWaitForVBlankBeforeEnable:ilk,snb
382 * It is also worth mentioning that since work->scheduled_vblank can be
383 * updated multiple times by the other threads, hitting the timeout is
384 * not an error condition. We'll just end up hitting the "goto retry"
387 wait_event_timeout(vblank->queue,
388 drm_crtc_vblank_count(&crtc->base) != work->scheduled_vblank,
389 msecs_to_jiffies(50));
391 mutex_lock(&fbc->lock);
393 /* Were we cancelled? */
394 if (!work->scheduled)
397 /* Were we delayed again while this function was sleeping? */
398 if (drm_crtc_vblank_count(&crtc->base) == work->scheduled_vblank) {
399 mutex_unlock(&fbc->lock);
403 if (crtc->base.primary->fb == work->fb)
404 fbc->activate(dev_priv);
406 work->scheduled = false;
409 mutex_unlock(&fbc->lock);
410 drm_crtc_vblank_put(&crtc->base);
413 static void intel_fbc_cancel_work(struct drm_i915_private *dev_priv)
415 struct intel_fbc *fbc = &dev_priv->fbc;
417 WARN_ON(!mutex_is_locked(&fbc->lock));
418 fbc->work.scheduled = false;
421 static void intel_fbc_schedule_activation(struct intel_crtc *crtc)
423 struct drm_i915_private *dev_priv = crtc->base.dev->dev_private;
424 struct intel_fbc *fbc = &dev_priv->fbc;
425 struct intel_fbc_work *work = &fbc->work;
427 WARN_ON(!mutex_is_locked(&fbc->lock));
429 if (drm_crtc_vblank_get(&crtc->base)) {
430 DRM_ERROR("vblank not available for FBC on pipe %c\n",
431 pipe_name(crtc->pipe));
435 /* It is useless to call intel_fbc_cancel_work() in this function since
436 * we're not releasing fbc.lock, so it won't have an opportunity to grab
437 * it to discover that it was cancelled. So we just update the expected
439 work->fb = crtc->base.primary->fb;
440 work->scheduled = true;
441 work->scheduled_vblank = drm_crtc_vblank_count(&crtc->base);
442 drm_crtc_vblank_put(&crtc->base);
444 schedule_work(&work->work);
447 static void __intel_fbc_deactivate(struct drm_i915_private *dev_priv)
449 struct intel_fbc *fbc = &dev_priv->fbc;
451 WARN_ON(!mutex_is_locked(&fbc->lock));
453 intel_fbc_cancel_work(dev_priv);
456 fbc->deactivate(dev_priv);
460 * intel_fbc_deactivate - deactivate FBC if it's associated with crtc
463 * This function deactivates FBC if it's associated with the provided CRTC.
465 void intel_fbc_deactivate(struct intel_crtc *crtc)
467 struct drm_i915_private *dev_priv = crtc->base.dev->dev_private;
468 struct intel_fbc *fbc = &dev_priv->fbc;
470 if (!fbc_supported(dev_priv))
473 mutex_lock(&fbc->lock);
474 if (fbc->crtc == crtc)
475 __intel_fbc_deactivate(dev_priv);
476 mutex_unlock(&fbc->lock);
479 static void set_no_fbc_reason(struct drm_i915_private *dev_priv,
482 struct intel_fbc *fbc = &dev_priv->fbc;
484 if (fbc->no_fbc_reason == reason)
487 fbc->no_fbc_reason = reason;
488 DRM_DEBUG_KMS("Disabling FBC: %s\n", reason);
491 static bool crtc_can_fbc(struct intel_crtc *crtc)
493 struct drm_i915_private *dev_priv = crtc->base.dev->dev_private;
495 if (fbc_on_pipe_a_only(dev_priv) && crtc->pipe != PIPE_A)
498 if (fbc_on_plane_a_only(dev_priv) && crtc->plane != PLANE_A)
504 static bool multiple_pipes_ok(struct drm_i915_private *dev_priv)
508 struct drm_crtc *crtc;
510 if (INTEL_INFO(dev_priv)->gen > 4)
513 for_each_pipe(dev_priv, pipe) {
514 crtc = dev_priv->pipe_to_crtc_mapping[pipe];
516 if (intel_crtc_active(crtc) &&
517 to_intel_plane_state(crtc->primary->state)->visible)
521 return (n_pipes < 2);
524 static int find_compression_threshold(struct drm_i915_private *dev_priv,
525 struct drm_mm_node *node,
529 int compression_threshold = 1;
533 /* The FBC hardware for BDW/SKL doesn't have access to the stolen
534 * reserved range size, so it always assumes the maximum (8mb) is used.
535 * If we enable FBC using a CFB on that memory range we'll get FIFO
536 * underruns, even if that range is not reserved by the BIOS. */
537 if (IS_BROADWELL(dev_priv) ||
538 IS_SKYLAKE(dev_priv) || IS_KABYLAKE(dev_priv))
539 end = dev_priv->gtt.stolen_size - 8 * 1024 * 1024;
541 end = dev_priv->gtt.stolen_usable_size;
543 /* HACK: This code depends on what we will do in *_enable_fbc. If that
544 * code changes, this code needs to change as well.
546 * The enable_fbc code will attempt to use one of our 2 compression
547 * thresholds, therefore, in that case, we only have 1 resort.
550 /* Try to over-allocate to reduce reallocations and fragmentation. */
551 ret = i915_gem_stolen_insert_node_in_range(dev_priv, node, size <<= 1,
554 return compression_threshold;
557 /* HW's ability to limit the CFB is 1:4 */
558 if (compression_threshold > 4 ||
559 (fb_cpp == 2 && compression_threshold == 2))
562 ret = i915_gem_stolen_insert_node_in_range(dev_priv, node, size >>= 1,
564 if (ret && INTEL_INFO(dev_priv)->gen <= 4) {
567 compression_threshold <<= 1;
570 return compression_threshold;
574 static int intel_fbc_alloc_cfb(struct intel_crtc *crtc)
576 struct drm_i915_private *dev_priv = crtc->base.dev->dev_private;
577 struct intel_fbc *fbc = &dev_priv->fbc;
578 struct drm_mm_node *uninitialized_var(compressed_llb);
579 int size, fb_cpp, ret;
581 WARN_ON(drm_mm_node_allocated(&fbc->compressed_fb));
583 size = intel_fbc_calculate_cfb_size(dev_priv, &fbc->state_cache);
584 fb_cpp = drm_format_plane_cpp(fbc->state_cache.fb.pixel_format, 0);
586 ret = find_compression_threshold(dev_priv, &fbc->compressed_fb,
591 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");
595 fbc->threshold = ret;
597 if (INTEL_INFO(dev_priv)->gen >= 5)
598 I915_WRITE(ILK_DPFC_CB_BASE, fbc->compressed_fb.start);
599 else if (IS_GM45(dev_priv)) {
600 I915_WRITE(DPFC_CB_BASE, fbc->compressed_fb.start);
602 compressed_llb = kzalloc(sizeof(*compressed_llb), GFP_KERNEL);
606 ret = i915_gem_stolen_insert_node(dev_priv, compressed_llb,
611 fbc->compressed_llb = compressed_llb;
613 I915_WRITE(FBC_CFB_BASE,
614 dev_priv->mm.stolen_base + fbc->compressed_fb.start);
615 I915_WRITE(FBC_LL_BASE,
616 dev_priv->mm.stolen_base + compressed_llb->start);
619 DRM_DEBUG_KMS("reserved %llu bytes of contiguous stolen space for FBC, threshold: %d\n",
620 fbc->compressed_fb.size, fbc->threshold);
625 kfree(compressed_llb);
626 i915_gem_stolen_remove_node(dev_priv, &fbc->compressed_fb);
628 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);
632 static void __intel_fbc_cleanup_cfb(struct drm_i915_private *dev_priv)
634 struct intel_fbc *fbc = &dev_priv->fbc;
636 if (drm_mm_node_allocated(&fbc->compressed_fb))
637 i915_gem_stolen_remove_node(dev_priv, &fbc->compressed_fb);
639 if (fbc->compressed_llb) {
640 i915_gem_stolen_remove_node(dev_priv, fbc->compressed_llb);
641 kfree(fbc->compressed_llb);
645 void intel_fbc_cleanup_cfb(struct drm_i915_private *dev_priv)
647 struct intel_fbc *fbc = &dev_priv->fbc;
649 if (!fbc_supported(dev_priv))
652 mutex_lock(&fbc->lock);
653 __intel_fbc_cleanup_cfb(dev_priv);
654 mutex_unlock(&fbc->lock);
657 static bool stride_is_valid(struct drm_i915_private *dev_priv,
660 /* These should have been caught earlier. */
661 WARN_ON(stride < 512);
662 WARN_ON((stride & (64 - 1)) != 0);
664 /* Below are the additional FBC restrictions. */
666 if (IS_GEN2(dev_priv) || IS_GEN3(dev_priv))
667 return stride == 4096 || stride == 8192;
669 if (IS_GEN4(dev_priv) && !IS_G4X(dev_priv) && stride < 2048)
678 static bool pixel_format_is_valid(struct drm_i915_private *dev_priv,
679 uint32_t pixel_format)
681 switch (pixel_format) {
682 case DRM_FORMAT_XRGB8888:
683 case DRM_FORMAT_XBGR8888:
685 case DRM_FORMAT_XRGB1555:
686 case DRM_FORMAT_RGB565:
687 /* 16bpp not supported on gen2 */
688 if (IS_GEN2(dev_priv))
690 /* WaFbcOnly1to1Ratio:ctg */
691 if (IS_G4X(dev_priv))
700 * For some reason, the hardware tracking starts looking at whatever we
701 * programmed as the display plane base address register. It does not look at
702 * the X and Y offset registers. That's why we look at the crtc->adjusted{x,y}
703 * variables instead of just looking at the pipe/plane size.
705 static bool intel_fbc_hw_tracking_covers_screen(struct intel_crtc *crtc)
707 struct drm_i915_private *dev_priv = crtc->base.dev->dev_private;
708 struct intel_fbc *fbc = &dev_priv->fbc;
709 unsigned int effective_w, effective_h, max_w, max_h;
711 if (INTEL_INFO(dev_priv)->gen >= 8 || IS_HASWELL(dev_priv)) {
714 } else if (IS_G4X(dev_priv) || INTEL_INFO(dev_priv)->gen >= 5) {
722 intel_fbc_get_plane_source_size(&fbc->state_cache, &effective_w,
724 effective_w += crtc->adjusted_x;
725 effective_h += crtc->adjusted_y;
727 return effective_w <= max_w && effective_h <= max_h;
730 static void intel_fbc_update_state_cache(struct intel_crtc *crtc)
732 struct drm_i915_private *dev_priv = crtc->base.dev->dev_private;
733 struct intel_fbc *fbc = &dev_priv->fbc;
734 struct intel_fbc_state_cache *cache = &fbc->state_cache;
735 struct intel_crtc_state *crtc_state = crtc->config;
736 struct intel_plane_state *plane_state =
737 to_intel_plane_state(crtc->base.primary->state);
738 struct drm_framebuffer *fb = plane_state->base.fb;
739 struct drm_i915_gem_object *obj;
741 cache->crtc.mode_flags = crtc_state->base.adjusted_mode.flags;
742 if (IS_HASWELL(dev_priv) || IS_BROADWELL(dev_priv))
743 cache->crtc.hsw_bdw_pixel_rate =
744 ilk_pipe_pixel_rate(crtc_state);
746 cache->plane.rotation = plane_state->base.rotation;
747 cache->plane.src_w = drm_rect_width(&plane_state->src) >> 16;
748 cache->plane.src_h = drm_rect_height(&plane_state->src) >> 16;
749 cache->plane.visible = plane_state->visible;
751 if (!cache->plane.visible)
754 obj = intel_fb_obj(fb);
756 /* FIXME: We lack the proper locking here, so only run this on the
757 * platforms that need. */
758 if (dev_priv->fbc.activate == ilk_fbc_activate)
759 cache->fb.ilk_ggtt_offset = i915_gem_obj_ggtt_offset(obj);
760 cache->fb.id = fb->base.id;
761 cache->fb.pixel_format = fb->pixel_format;
762 cache->fb.stride = fb->pitches[0];
763 cache->fb.fence_reg = obj->fence_reg;
764 cache->fb.tiling_mode = obj->tiling_mode;
767 static bool intel_fbc_can_activate(struct intel_crtc *crtc)
769 struct drm_i915_private *dev_priv = crtc->base.dev->dev_private;
770 struct intel_fbc *fbc = &dev_priv->fbc;
771 struct intel_fbc_state_cache *cache = &fbc->state_cache;
773 if (!cache->plane.visible) {
774 set_no_fbc_reason(dev_priv, "primary plane not visible");
778 if ((cache->crtc.mode_flags & DRM_MODE_FLAG_INTERLACE) ||
779 (cache->crtc.mode_flags & DRM_MODE_FLAG_DBLSCAN)) {
780 set_no_fbc_reason(dev_priv, "incompatible mode");
784 if (!intel_fbc_hw_tracking_covers_screen(crtc)) {
785 set_no_fbc_reason(dev_priv, "mode too large for compression");
789 /* The use of a CPU fence is mandatory in order to detect writes
790 * by the CPU to the scanout and trigger updates to the FBC.
792 if (cache->fb.tiling_mode != I915_TILING_X ||
793 cache->fb.fence_reg == I915_FENCE_REG_NONE) {
794 set_no_fbc_reason(dev_priv, "framebuffer not tiled or fenced");
797 if (INTEL_INFO(dev_priv)->gen <= 4 && !IS_G4X(dev_priv) &&
798 cache->plane.rotation != BIT(DRM_ROTATE_0)) {
799 set_no_fbc_reason(dev_priv, "rotation unsupported");
803 if (!stride_is_valid(dev_priv, cache->fb.stride)) {
804 set_no_fbc_reason(dev_priv, "framebuffer stride not supported");
808 if (!pixel_format_is_valid(dev_priv, cache->fb.pixel_format)) {
809 set_no_fbc_reason(dev_priv, "pixel format is invalid");
813 /* WaFbcExceedCdClockThreshold:hsw,bdw */
814 if ((IS_HASWELL(dev_priv) || IS_BROADWELL(dev_priv)) &&
815 cache->crtc.hsw_bdw_pixel_rate >= dev_priv->cdclk_freq * 95 / 100) {
816 set_no_fbc_reason(dev_priv, "pixel rate is too big");
820 /* It is possible for the required CFB size change without a
821 * crtc->disable + crtc->enable since it is possible to change the
822 * stride without triggering a full modeset. Since we try to
823 * over-allocate the CFB, there's a chance we may keep FBC enabled even
824 * if this happens, but if we exceed the current CFB size we'll have to
825 * disable FBC. Notice that it would be possible to disable FBC, wait
826 * for a frame, free the stolen node, then try to reenable FBC in case
827 * we didn't get any invalidate/deactivate calls, but this would require
828 * a lot of tracking just for a specific case. If we conclude it's an
829 * important case, we can implement it later. */
830 if (intel_fbc_calculate_cfb_size(dev_priv, &fbc->state_cache) >
831 fbc->compressed_fb.size * fbc->threshold) {
832 set_no_fbc_reason(dev_priv, "CFB requirements changed");
839 static bool intel_fbc_can_enable(struct intel_crtc *crtc)
841 struct drm_i915_private *dev_priv = crtc->base.dev->dev_private;
843 if (intel_vgpu_active(dev_priv->dev)) {
844 set_no_fbc_reason(dev_priv, "VGPU is active");
848 if (i915.enable_fbc < 0) {
849 set_no_fbc_reason(dev_priv, "disabled per chip default");
853 if (!i915.enable_fbc) {
854 set_no_fbc_reason(dev_priv, "disabled per module param");
858 if (!crtc_can_fbc(crtc)) {
859 set_no_fbc_reason(dev_priv, "no enabled pipes can have FBC");
866 static void intel_fbc_get_reg_params(struct intel_crtc *crtc,
867 struct intel_fbc_reg_params *params)
869 struct drm_i915_private *dev_priv = crtc->base.dev->dev_private;
870 struct intel_fbc *fbc = &dev_priv->fbc;
871 struct intel_fbc_state_cache *cache = &fbc->state_cache;
873 /* Since all our fields are integer types, use memset here so the
874 * comparison function can rely on memcmp because the padding will be
876 memset(params, 0, sizeof(*params));
878 params->crtc.pipe = crtc->pipe;
879 params->crtc.plane = crtc->plane;
880 params->crtc.fence_y_offset = get_crtc_fence_y_offset(crtc);
882 params->fb.id = cache->fb.id;
883 params->fb.pixel_format = cache->fb.pixel_format;
884 params->fb.stride = cache->fb.stride;
885 params->fb.fence_reg = cache->fb.fence_reg;
887 params->cfb_size = intel_fbc_calculate_cfb_size(dev_priv, cache);
889 params->fb.ggtt_offset = cache->fb.ilk_ggtt_offset;
892 static bool intel_fbc_reg_params_equal(struct intel_fbc_reg_params *params1,
893 struct intel_fbc_reg_params *params2)
895 /* We can use this since intel_fbc_get_reg_params() does a memset. */
896 return memcmp(params1, params2, sizeof(*params1)) == 0;
899 static void intel_fbc_pre_update(struct intel_crtc *crtc)
901 struct drm_i915_private *dev_priv = crtc->base.dev->dev_private;
902 struct intel_fbc *fbc = &dev_priv->fbc;
904 WARN_ON(!mutex_is_locked(&fbc->lock));
906 if (!multiple_pipes_ok(dev_priv)) {
907 set_no_fbc_reason(dev_priv, "more than one pipe active");
911 if (!fbc->enabled || fbc->crtc != crtc)
914 intel_fbc_update_state_cache(crtc);
917 __intel_fbc_deactivate(dev_priv);
920 static void intel_fbc_post_update(struct intel_crtc *crtc)
922 struct drm_i915_private *dev_priv = crtc->base.dev->dev_private;
923 struct intel_fbc *fbc = &dev_priv->fbc;
924 struct intel_fbc_reg_params old_params;
926 WARN_ON(!mutex_is_locked(&fbc->lock));
928 if (!fbc->enabled || fbc->crtc != crtc)
931 if (!intel_fbc_can_activate(crtc)) {
932 WARN_ON(fbc->active);
936 old_params = fbc->params;
937 intel_fbc_get_reg_params(crtc, &fbc->params);
939 /* If the scanout has not changed, don't modify the FBC settings.
940 * Note that we make the fundamental assumption that the fb->obj
941 * cannot be unpinned (and have its GTT offset and fence revoked)
942 * without first being decoupled from the scanout and FBC disabled.
945 intel_fbc_reg_params_equal(&old_params, &fbc->params))
948 __intel_fbc_deactivate(dev_priv);
949 intel_fbc_schedule_activation(crtc);
950 fbc->no_fbc_reason = "FBC enabled (active or scheduled)";
954 * intel_fbc_update - activate/deactivate FBC as needed
955 * @crtc: the CRTC that triggered the update
957 * This function reevaluates the overall state and activates or deactivates FBC.
959 void intel_fbc_update(struct intel_crtc *crtc)
961 struct drm_i915_private *dev_priv = crtc->base.dev->dev_private;
962 struct intel_fbc *fbc = &dev_priv->fbc;
964 if (!fbc_supported(dev_priv))
967 mutex_lock(&fbc->lock);
968 intel_fbc_pre_update(crtc);
969 intel_fbc_post_update(crtc);
970 mutex_unlock(&fbc->lock);
973 static unsigned int intel_fbc_get_frontbuffer_bit(struct intel_fbc *fbc)
976 return to_intel_plane(fbc->crtc->base.primary)->frontbuffer_bit;
978 return fbc->possible_framebuffer_bits;
981 void intel_fbc_invalidate(struct drm_i915_private *dev_priv,
982 unsigned int frontbuffer_bits,
983 enum fb_op_origin origin)
985 struct intel_fbc *fbc = &dev_priv->fbc;
987 if (!fbc_supported(dev_priv))
990 if (origin == ORIGIN_GTT || origin == ORIGIN_FLIP)
993 mutex_lock(&fbc->lock);
995 fbc->busy_bits |= intel_fbc_get_frontbuffer_bit(fbc) & frontbuffer_bits;
998 __intel_fbc_deactivate(dev_priv);
1000 mutex_unlock(&fbc->lock);
1003 void intel_fbc_flush(struct drm_i915_private *dev_priv,
1004 unsigned int frontbuffer_bits, enum fb_op_origin origin)
1006 struct intel_fbc *fbc = &dev_priv->fbc;
1008 if (!fbc_supported(dev_priv))
1011 if (origin == ORIGIN_GTT || origin == ORIGIN_FLIP)
1014 mutex_lock(&fbc->lock);
1016 fbc->busy_bits &= ~frontbuffer_bits;
1018 if (!fbc->busy_bits && fbc->enabled &&
1019 (frontbuffer_bits & intel_fbc_get_frontbuffer_bit(fbc))) {
1021 intel_fbc_recompress(dev_priv);
1023 intel_fbc_post_update(fbc->crtc);
1026 mutex_unlock(&fbc->lock);
1030 * intel_fbc_enable: tries to enable FBC on the CRTC
1033 * This function checks if it's possible to enable FBC on the following CRTC,
1034 * then enables it. Notice that it doesn't activate FBC.
1036 void intel_fbc_enable(struct intel_crtc *crtc)
1038 struct drm_i915_private *dev_priv = crtc->base.dev->dev_private;
1039 struct intel_fbc *fbc = &dev_priv->fbc;
1041 if (!fbc_supported(dev_priv))
1044 mutex_lock(&fbc->lock);
1047 WARN_ON(fbc->crtc == crtc);
1051 WARN_ON(fbc->active);
1052 WARN_ON(fbc->crtc != NULL);
1054 if (!intel_fbc_can_enable(crtc))
1057 intel_fbc_update_state_cache(crtc);
1058 if (intel_fbc_alloc_cfb(crtc)) {
1059 set_no_fbc_reason(dev_priv, "not enough stolen memory");
1063 DRM_DEBUG_KMS("Enabling FBC on pipe %c\n", pipe_name(crtc->pipe));
1064 fbc->no_fbc_reason = "FBC enabled but not active yet\n";
1066 fbc->enabled = true;
1069 mutex_unlock(&fbc->lock);
1073 * __intel_fbc_disable - disable FBC
1074 * @dev_priv: i915 device instance
1076 * This is the low level function that actually disables FBC. Callers should
1077 * grab the FBC lock.
1079 static void __intel_fbc_disable(struct drm_i915_private *dev_priv)
1081 struct intel_fbc *fbc = &dev_priv->fbc;
1082 struct intel_crtc *crtc = fbc->crtc;
1084 WARN_ON(!mutex_is_locked(&fbc->lock));
1085 WARN_ON(!fbc->enabled);
1086 WARN_ON(fbc->active);
1087 assert_pipe_disabled(dev_priv, crtc->pipe);
1089 DRM_DEBUG_KMS("Disabling FBC on pipe %c\n", pipe_name(crtc->pipe));
1091 __intel_fbc_cleanup_cfb(dev_priv);
1093 fbc->enabled = false;
1098 * intel_fbc_disable_crtc - disable FBC if it's associated with crtc
1101 * This function disables FBC if it's associated with the provided CRTC.
1103 void intel_fbc_disable_crtc(struct intel_crtc *crtc)
1105 struct drm_i915_private *dev_priv = crtc->base.dev->dev_private;
1106 struct intel_fbc *fbc = &dev_priv->fbc;
1108 if (!fbc_supported(dev_priv))
1111 mutex_lock(&fbc->lock);
1112 if (fbc->crtc == crtc) {
1113 WARN_ON(!fbc->enabled);
1114 WARN_ON(fbc->active);
1115 __intel_fbc_disable(dev_priv);
1117 mutex_unlock(&fbc->lock);
1121 * intel_fbc_disable - globally disable FBC
1122 * @dev_priv: i915 device instance
1124 * This function disables FBC regardless of which CRTC is associated with it.
1126 void intel_fbc_disable(struct drm_i915_private *dev_priv)
1128 struct intel_fbc *fbc = &dev_priv->fbc;
1130 if (!fbc_supported(dev_priv))
1133 mutex_lock(&fbc->lock);
1135 __intel_fbc_disable(dev_priv);
1136 mutex_unlock(&fbc->lock);
1140 * intel_fbc_init - Initialize FBC
1141 * @dev_priv: the i915 device
1143 * This function might be called during PM init process.
1145 void intel_fbc_init(struct drm_i915_private *dev_priv)
1147 struct intel_fbc *fbc = &dev_priv->fbc;
1150 INIT_WORK(&fbc->work.work, intel_fbc_work_fn);
1151 mutex_init(&fbc->lock);
1152 fbc->enabled = false;
1153 fbc->active = false;
1154 fbc->work.scheduled = false;
1156 if (!HAS_FBC(dev_priv)) {
1157 fbc->no_fbc_reason = "unsupported by this chipset";
1161 for_each_pipe(dev_priv, pipe) {
1162 fbc->possible_framebuffer_bits |=
1163 INTEL_FRONTBUFFER_PRIMARY(pipe);
1165 if (fbc_on_pipe_a_only(dev_priv))
1169 if (INTEL_INFO(dev_priv)->gen >= 7) {
1170 fbc->is_active = ilk_fbc_is_active;
1171 fbc->activate = gen7_fbc_activate;
1172 fbc->deactivate = ilk_fbc_deactivate;
1173 } else if (INTEL_INFO(dev_priv)->gen >= 5) {
1174 fbc->is_active = ilk_fbc_is_active;
1175 fbc->activate = ilk_fbc_activate;
1176 fbc->deactivate = ilk_fbc_deactivate;
1177 } else if (IS_GM45(dev_priv)) {
1178 fbc->is_active = g4x_fbc_is_active;
1179 fbc->activate = g4x_fbc_activate;
1180 fbc->deactivate = g4x_fbc_deactivate;
1182 fbc->is_active = i8xx_fbc_is_active;
1183 fbc->activate = i8xx_fbc_activate;
1184 fbc->deactivate = i8xx_fbc_deactivate;
1186 /* This value was pulled out of someone's hat */
1187 I915_WRITE(FBC_CONTROL, 500 << FBC_CTL_INTERVAL_SHIFT);
1190 /* We still don't have any sort of hardware state readout for FBC, so
1191 * deactivate it in case the BIOS activated it to make sure software
1192 * matches the hardware state. */
1193 if (fbc->is_active(dev_priv))
1194 fbc->deactivate(dev_priv);