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 FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 * Daniel Vetter <daniel@ffwll.ch>
26 * Derived from Xorg ddx, xf86-video-intel, src/i830_video.c
29 #include <drm/i915_drm.h>
32 #include "intel_drv.h"
33 #include "intel_frontbuffer.h"
35 /* Limits for overlay size. According to intel doc, the real limits are:
36 * Y width: 4095, UV width (planar): 2047, Y height: 2047,
37 * UV width (planar): * 1023. But the xorg thinks 2048 for height and width. Use
38 * the mininum of both. */
39 #define IMAGE_MAX_WIDTH 2048
40 #define IMAGE_MAX_HEIGHT 2046 /* 2 * 1023 */
41 /* on 830 and 845 these large limits result in the card hanging */
42 #define IMAGE_MAX_WIDTH_LEGACY 1024
43 #define IMAGE_MAX_HEIGHT_LEGACY 1088
45 /* overlay register definitions */
47 #define OCMD_TILED_SURFACE (0x1<<19)
48 #define OCMD_MIRROR_MASK (0x3<<17)
49 #define OCMD_MIRROR_MODE (0x3<<17)
50 #define OCMD_MIRROR_HORIZONTAL (0x1<<17)
51 #define OCMD_MIRROR_VERTICAL (0x2<<17)
52 #define OCMD_MIRROR_BOTH (0x3<<17)
53 #define OCMD_BYTEORDER_MASK (0x3<<14) /* zero for YUYV or FOURCC YUY2 */
54 #define OCMD_UV_SWAP (0x1<<14) /* YVYU */
55 #define OCMD_Y_SWAP (0x2<<14) /* UYVY or FOURCC UYVY */
56 #define OCMD_Y_AND_UV_SWAP (0x3<<14) /* VYUY */
57 #define OCMD_SOURCE_FORMAT_MASK (0xf<<10)
58 #define OCMD_RGB_888 (0x1<<10) /* not in i965 Intel docs */
59 #define OCMD_RGB_555 (0x2<<10) /* not in i965 Intel docs */
60 #define OCMD_RGB_565 (0x3<<10) /* not in i965 Intel docs */
61 #define OCMD_YUV_422_PACKED (0x8<<10)
62 #define OCMD_YUV_411_PACKED (0x9<<10) /* not in i965 Intel docs */
63 #define OCMD_YUV_420_PLANAR (0xc<<10)
64 #define OCMD_YUV_422_PLANAR (0xd<<10)
65 #define OCMD_YUV_410_PLANAR (0xe<<10) /* also 411 */
66 #define OCMD_TVSYNCFLIP_PARITY (0x1<<9)
67 #define OCMD_TVSYNCFLIP_ENABLE (0x1<<7)
68 #define OCMD_BUF_TYPE_MASK (0x1<<5)
69 #define OCMD_BUF_TYPE_FRAME (0x0<<5)
70 #define OCMD_BUF_TYPE_FIELD (0x1<<5)
71 #define OCMD_TEST_MODE (0x1<<4)
72 #define OCMD_BUFFER_SELECT (0x3<<2)
73 #define OCMD_BUFFER0 (0x0<<2)
74 #define OCMD_BUFFER1 (0x1<<2)
75 #define OCMD_FIELD_SELECT (0x1<<2)
76 #define OCMD_FIELD0 (0x0<<1)
77 #define OCMD_FIELD1 (0x1<<1)
78 #define OCMD_ENABLE (0x1<<0)
80 /* OCONFIG register */
81 #define OCONF_PIPE_MASK (0x1<<18)
82 #define OCONF_PIPE_A (0x0<<18)
83 #define OCONF_PIPE_B (0x1<<18)
84 #define OCONF_GAMMA2_ENABLE (0x1<<16)
85 #define OCONF_CSC_MODE_BT601 (0x0<<5)
86 #define OCONF_CSC_MODE_BT709 (0x1<<5)
87 #define OCONF_CSC_BYPASS (0x1<<4)
88 #define OCONF_CC_OUT_8BIT (0x1<<3)
89 #define OCONF_TEST_MODE (0x1<<2)
90 #define OCONF_THREE_LINE_BUFFER (0x1<<0)
91 #define OCONF_TWO_LINE_BUFFER (0x0<<0)
93 /* DCLRKM (dst-key) register */
94 #define DST_KEY_ENABLE (0x1<<31)
95 #define CLK_RGB24_MASK 0x0
96 #define CLK_RGB16_MASK 0x070307
97 #define CLK_RGB15_MASK 0x070707
98 #define CLK_RGB8I_MASK 0xffffff
100 #define RGB16_TO_COLORKEY(c) \
101 (((c & 0xF800) << 8) | ((c & 0x07E0) << 5) | ((c & 0x001F) << 3))
102 #define RGB15_TO_COLORKEY(c) \
103 (((c & 0x7c00) << 9) | ((c & 0x03E0) << 6) | ((c & 0x001F) << 3))
105 /* overlay flip addr flag */
106 #define OFC_UPDATE 0x1
108 /* polyphase filter coefficients */
109 #define N_HORIZ_Y_TAPS 5
110 #define N_VERT_Y_TAPS 3
111 #define N_HORIZ_UV_TAPS 3
112 #define N_VERT_UV_TAPS 3
116 /* memory bufferd overlay registers */
117 struct overlay_registers {
145 u32 RESERVED1; /* 0x6C */
158 u32 FASTHSCALE; /* 0xA0 */
159 u32 UVSCALEV; /* 0xA4 */
160 u32 RESERVEDC[(0x200 - 0xA8) / 4]; /* 0xA8 - 0x1FC */
161 u16 Y_VCOEFS[N_VERT_Y_TAPS * N_PHASES]; /* 0x200 */
162 u16 RESERVEDD[0x100 / 2 - N_VERT_Y_TAPS * N_PHASES];
163 u16 Y_HCOEFS[N_HORIZ_Y_TAPS * N_PHASES]; /* 0x300 */
164 u16 RESERVEDE[0x200 / 2 - N_HORIZ_Y_TAPS * N_PHASES];
165 u16 UV_VCOEFS[N_VERT_UV_TAPS * N_PHASES]; /* 0x500 */
166 u16 RESERVEDF[0x100 / 2 - N_VERT_UV_TAPS * N_PHASES];
167 u16 UV_HCOEFS[N_HORIZ_UV_TAPS * N_PHASES]; /* 0x600 */
168 u16 RESERVEDG[0x100 / 2 - N_HORIZ_UV_TAPS * N_PHASES];
171 struct intel_overlay {
172 struct drm_i915_private *i915;
173 struct intel_crtc *crtc;
174 struct i915_vma *vma;
175 struct i915_vma *old_vma;
178 u32 pfit_vscale_ratio; /* shifted-point number, (1<<12) == 1.0 */
180 u32 color_key_enabled:1;
181 u32 brightness, contrast, saturation;
182 u32 old_xscale, old_yscale;
183 /* register access */
184 struct drm_i915_gem_object *reg_bo;
185 struct overlay_registers __iomem *regs;
188 struct i915_gem_active last_flip;
191 static void i830_overlay_clock_gating(struct drm_i915_private *dev_priv,
194 struct pci_dev *pdev = dev_priv->drm.pdev;
197 /* WA_OVERLAY_CLKGATE:alm */
199 I915_WRITE(DSPCLK_GATE_D, 0);
201 I915_WRITE(DSPCLK_GATE_D, OVRUNIT_CLOCK_GATE_DISABLE);
203 /* WA_DISABLE_L2CACHE_CLOCK_GATING:alm */
204 pci_bus_read_config_byte(pdev->bus,
205 PCI_DEVFN(0, 0), I830_CLOCK_GATE, &val);
207 val &= ~I830_L2_CACHE_CLOCK_GATE_DISABLE;
209 val |= I830_L2_CACHE_CLOCK_GATE_DISABLE;
210 pci_bus_write_config_byte(pdev->bus,
211 PCI_DEVFN(0, 0), I830_CLOCK_GATE, val);
214 static void intel_overlay_submit_request(struct intel_overlay *overlay,
215 struct i915_request *rq,
216 i915_gem_retire_fn retire)
218 GEM_BUG_ON(i915_gem_active_peek(&overlay->last_flip,
219 &overlay->i915->drm.struct_mutex));
220 i915_gem_active_set_retire_fn(&overlay->last_flip, retire,
221 &overlay->i915->drm.struct_mutex);
222 i915_gem_active_set(&overlay->last_flip, rq);
223 i915_request_add(rq);
226 static int intel_overlay_do_wait_request(struct intel_overlay *overlay,
227 struct i915_request *rq,
228 i915_gem_retire_fn retire)
230 intel_overlay_submit_request(overlay, rq, retire);
231 return i915_gem_active_retire(&overlay->last_flip,
232 &overlay->i915->drm.struct_mutex);
235 static struct i915_request *alloc_request(struct intel_overlay *overlay)
237 struct drm_i915_private *dev_priv = overlay->i915;
238 struct intel_engine_cs *engine = dev_priv->engine[RCS];
240 return i915_request_alloc(engine, dev_priv->kernel_context);
243 /* overlay needs to be disable in OCMD reg */
244 static int intel_overlay_on(struct intel_overlay *overlay)
246 struct drm_i915_private *dev_priv = overlay->i915;
247 struct i915_request *rq;
250 WARN_ON(overlay->active);
252 rq = alloc_request(overlay);
256 cs = intel_ring_begin(rq, 4);
258 i915_request_add(rq);
262 overlay->active = true;
264 if (IS_I830(dev_priv))
265 i830_overlay_clock_gating(dev_priv, false);
267 *cs++ = MI_OVERLAY_FLIP | MI_OVERLAY_ON;
268 *cs++ = overlay->flip_addr | OFC_UPDATE;
269 *cs++ = MI_WAIT_FOR_EVENT | MI_WAIT_FOR_OVERLAY_FLIP;
271 intel_ring_advance(rq, cs);
273 return intel_overlay_do_wait_request(overlay, rq, NULL);
276 static void intel_overlay_flip_prepare(struct intel_overlay *overlay,
277 struct i915_vma *vma)
279 enum pipe pipe = overlay->crtc->pipe;
281 WARN_ON(overlay->old_vma);
283 i915_gem_track_fb(overlay->vma ? overlay->vma->obj : NULL,
284 vma ? vma->obj : NULL,
285 INTEL_FRONTBUFFER_OVERLAY(pipe));
287 intel_frontbuffer_flip_prepare(overlay->i915,
288 INTEL_FRONTBUFFER_OVERLAY(pipe));
290 overlay->old_vma = overlay->vma;
292 overlay->vma = i915_vma_get(vma);
297 /* overlay needs to be enabled in OCMD reg */
298 static int intel_overlay_continue(struct intel_overlay *overlay,
299 struct i915_vma *vma,
300 bool load_polyphase_filter)
302 struct drm_i915_private *dev_priv = overlay->i915;
303 struct i915_request *rq;
304 u32 flip_addr = overlay->flip_addr;
307 WARN_ON(!overlay->active);
309 if (load_polyphase_filter)
310 flip_addr |= OFC_UPDATE;
312 /* check for underruns */
313 tmp = I915_READ(DOVSTA);
315 DRM_DEBUG("overlay underrun, DOVSTA: %x\n", tmp);
317 rq = alloc_request(overlay);
321 cs = intel_ring_begin(rq, 2);
323 i915_request_add(rq);
327 *cs++ = MI_OVERLAY_FLIP | MI_OVERLAY_CONTINUE;
329 intel_ring_advance(rq, cs);
331 intel_overlay_flip_prepare(overlay, vma);
333 intel_overlay_submit_request(overlay, rq, NULL);
338 static void intel_overlay_release_old_vma(struct intel_overlay *overlay)
340 struct i915_vma *vma;
342 vma = fetch_and_zero(&overlay->old_vma);
346 intel_frontbuffer_flip_complete(overlay->i915,
347 INTEL_FRONTBUFFER_OVERLAY(overlay->crtc->pipe));
349 i915_gem_object_unpin_from_display_plane(vma);
353 static void intel_overlay_release_old_vid_tail(struct i915_gem_active *active,
354 struct i915_request *rq)
356 struct intel_overlay *overlay =
357 container_of(active, typeof(*overlay), last_flip);
359 intel_overlay_release_old_vma(overlay);
362 static void intel_overlay_off_tail(struct i915_gem_active *active,
363 struct i915_request *rq)
365 struct intel_overlay *overlay =
366 container_of(active, typeof(*overlay), last_flip);
367 struct drm_i915_private *dev_priv = overlay->i915;
369 intel_overlay_release_old_vma(overlay);
371 overlay->crtc->overlay = NULL;
372 overlay->crtc = NULL;
373 overlay->active = false;
375 if (IS_I830(dev_priv))
376 i830_overlay_clock_gating(dev_priv, true);
379 /* overlay needs to be disabled in OCMD reg */
380 static int intel_overlay_off(struct intel_overlay *overlay)
382 struct i915_request *rq;
383 u32 *cs, flip_addr = overlay->flip_addr;
385 WARN_ON(!overlay->active);
387 /* According to intel docs the overlay hw may hang (when switching
388 * off) without loading the filter coeffs. It is however unclear whether
389 * this applies to the disabling of the overlay or to the switching off
390 * of the hw. Do it in both cases */
391 flip_addr |= OFC_UPDATE;
393 rq = alloc_request(overlay);
397 cs = intel_ring_begin(rq, 6);
399 i915_request_add(rq);
403 /* wait for overlay to go idle */
404 *cs++ = MI_OVERLAY_FLIP | MI_OVERLAY_CONTINUE;
406 *cs++ = MI_WAIT_FOR_EVENT | MI_WAIT_FOR_OVERLAY_FLIP;
408 /* turn overlay off */
409 *cs++ = MI_OVERLAY_FLIP | MI_OVERLAY_OFF;
411 *cs++ = MI_WAIT_FOR_EVENT | MI_WAIT_FOR_OVERLAY_FLIP;
413 intel_ring_advance(rq, cs);
415 intel_overlay_flip_prepare(overlay, NULL);
417 return intel_overlay_do_wait_request(overlay, rq,
418 intel_overlay_off_tail);
421 /* recover from an interruption due to a signal
422 * We have to be careful not to repeat work forever an make forward progess. */
423 static int intel_overlay_recover_from_interrupt(struct intel_overlay *overlay)
425 return i915_gem_active_retire(&overlay->last_flip,
426 &overlay->i915->drm.struct_mutex);
429 /* Wait for pending overlay flip and release old frame.
430 * Needs to be called before the overlay register are changed
431 * via intel_overlay_(un)map_regs
433 static int intel_overlay_release_old_vid(struct intel_overlay *overlay)
435 struct drm_i915_private *dev_priv = overlay->i915;
439 lockdep_assert_held(&dev_priv->drm.struct_mutex);
441 /* Only wait if there is actually an old frame to release to
442 * guarantee forward progress.
444 if (!overlay->old_vma)
447 if (I915_READ(ISR) & I915_OVERLAY_PLANE_FLIP_PENDING_INTERRUPT) {
448 /* synchronous slowpath */
449 struct i915_request *rq;
451 rq = alloc_request(overlay);
455 cs = intel_ring_begin(rq, 2);
457 i915_request_add(rq);
461 *cs++ = MI_WAIT_FOR_EVENT | MI_WAIT_FOR_OVERLAY_FLIP;
463 intel_ring_advance(rq, cs);
465 ret = intel_overlay_do_wait_request(overlay, rq,
466 intel_overlay_release_old_vid_tail);
470 intel_overlay_release_old_vid_tail(&overlay->last_flip, NULL);
475 void intel_overlay_reset(struct drm_i915_private *dev_priv)
477 struct intel_overlay *overlay = dev_priv->overlay;
482 intel_overlay_release_old_vid(overlay);
484 overlay->old_xscale = 0;
485 overlay->old_yscale = 0;
486 overlay->crtc = NULL;
487 overlay->active = false;
490 struct put_image_params {
507 static int packed_depth_bytes(u32 format)
509 switch (format & I915_OVERLAY_DEPTH_MASK) {
510 case I915_OVERLAY_YUV422:
512 case I915_OVERLAY_YUV411:
513 /* return 6; not implemented */
519 static int packed_width_bytes(u32 format, short width)
521 switch (format & I915_OVERLAY_DEPTH_MASK) {
522 case I915_OVERLAY_YUV422:
529 static int uv_hsubsampling(u32 format)
531 switch (format & I915_OVERLAY_DEPTH_MASK) {
532 case I915_OVERLAY_YUV422:
533 case I915_OVERLAY_YUV420:
535 case I915_OVERLAY_YUV411:
536 case I915_OVERLAY_YUV410:
543 static int uv_vsubsampling(u32 format)
545 switch (format & I915_OVERLAY_DEPTH_MASK) {
546 case I915_OVERLAY_YUV420:
547 case I915_OVERLAY_YUV410:
549 case I915_OVERLAY_YUV422:
550 case I915_OVERLAY_YUV411:
557 static u32 calc_swidthsw(struct drm_i915_private *dev_priv, u32 offset, u32 width)
561 if (IS_GEN2(dev_priv))
562 sw = ALIGN((offset & 31) + width, 32);
564 sw = ALIGN((offset & 63) + width, 64);
569 return (sw - 32) >> 3;
572 static const u16 y_static_hcoeffs[N_PHASES][N_HORIZ_Y_TAPS] = {
573 [ 0] = { 0x3000, 0xb4a0, 0x1930, 0x1920, 0xb4a0, },
574 [ 1] = { 0x3000, 0xb500, 0x19d0, 0x1880, 0xb440, },
575 [ 2] = { 0x3000, 0xb540, 0x1a88, 0x2f80, 0xb3e0, },
576 [ 3] = { 0x3000, 0xb580, 0x1b30, 0x2e20, 0xb380, },
577 [ 4] = { 0x3000, 0xb5c0, 0x1bd8, 0x2cc0, 0xb320, },
578 [ 5] = { 0x3020, 0xb5e0, 0x1c60, 0x2b80, 0xb2c0, },
579 [ 6] = { 0x3020, 0xb5e0, 0x1cf8, 0x2a20, 0xb260, },
580 [ 7] = { 0x3020, 0xb5e0, 0x1d80, 0x28e0, 0xb200, },
581 [ 8] = { 0x3020, 0xb5c0, 0x1e08, 0x3f40, 0xb1c0, },
582 [ 9] = { 0x3020, 0xb580, 0x1e78, 0x3ce0, 0xb160, },
583 [10] = { 0x3040, 0xb520, 0x1ed8, 0x3aa0, 0xb120, },
584 [11] = { 0x3040, 0xb4a0, 0x1f30, 0x3880, 0xb0e0, },
585 [12] = { 0x3040, 0xb400, 0x1f78, 0x3680, 0xb0a0, },
586 [13] = { 0x3020, 0xb340, 0x1fb8, 0x34a0, 0xb060, },
587 [14] = { 0x3020, 0xb240, 0x1fe0, 0x32e0, 0xb040, },
588 [15] = { 0x3020, 0xb140, 0x1ff8, 0x3160, 0xb020, },
589 [16] = { 0xb000, 0x3000, 0x0800, 0x3000, 0xb000, },
592 static const u16 uv_static_hcoeffs[N_PHASES][N_HORIZ_UV_TAPS] = {
593 [ 0] = { 0x3000, 0x1800, 0x1800, },
594 [ 1] = { 0xb000, 0x18d0, 0x2e60, },
595 [ 2] = { 0xb000, 0x1990, 0x2ce0, },
596 [ 3] = { 0xb020, 0x1a68, 0x2b40, },
597 [ 4] = { 0xb040, 0x1b20, 0x29e0, },
598 [ 5] = { 0xb060, 0x1bd8, 0x2880, },
599 [ 6] = { 0xb080, 0x1c88, 0x3e60, },
600 [ 7] = { 0xb0a0, 0x1d28, 0x3c00, },
601 [ 8] = { 0xb0c0, 0x1db8, 0x39e0, },
602 [ 9] = { 0xb0e0, 0x1e40, 0x37e0, },
603 [10] = { 0xb100, 0x1eb8, 0x3620, },
604 [11] = { 0xb100, 0x1f18, 0x34a0, },
605 [12] = { 0xb100, 0x1f68, 0x3360, },
606 [13] = { 0xb0e0, 0x1fa8, 0x3240, },
607 [14] = { 0xb0c0, 0x1fe0, 0x3140, },
608 [15] = { 0xb060, 0x1ff0, 0x30a0, },
609 [16] = { 0x3000, 0x0800, 0x3000, },
612 static void update_polyphase_filter(struct overlay_registers __iomem *regs)
614 memcpy_toio(regs->Y_HCOEFS, y_static_hcoeffs, sizeof(y_static_hcoeffs));
615 memcpy_toio(regs->UV_HCOEFS, uv_static_hcoeffs,
616 sizeof(uv_static_hcoeffs));
619 static bool update_scaling_factors(struct intel_overlay *overlay,
620 struct overlay_registers __iomem *regs,
621 struct put_image_params *params)
623 /* fixed point with a 12 bit shift */
624 u32 xscale, yscale, xscale_UV, yscale_UV;
626 #define FRACT_MASK 0xfff
627 bool scale_changed = false;
628 int uv_hscale = uv_hsubsampling(params->format);
629 int uv_vscale = uv_vsubsampling(params->format);
631 if (params->dst_w > 1)
632 xscale = ((params->src_scan_w - 1) << FP_SHIFT)
635 xscale = 1 << FP_SHIFT;
637 if (params->dst_h > 1)
638 yscale = ((params->src_scan_h - 1) << FP_SHIFT)
641 yscale = 1 << FP_SHIFT;
643 /*if (params->format & I915_OVERLAY_YUV_PLANAR) {*/
644 xscale_UV = xscale/uv_hscale;
645 yscale_UV = yscale/uv_vscale;
646 /* make the Y scale to UV scale ratio an exact multiply */
647 xscale = xscale_UV * uv_hscale;
648 yscale = yscale_UV * uv_vscale;
654 if (xscale != overlay->old_xscale || yscale != overlay->old_yscale)
655 scale_changed = true;
656 overlay->old_xscale = xscale;
657 overlay->old_yscale = yscale;
659 iowrite32(((yscale & FRACT_MASK) << 20) |
660 ((xscale >> FP_SHIFT) << 16) |
661 ((xscale & FRACT_MASK) << 3),
664 iowrite32(((yscale_UV & FRACT_MASK) << 20) |
665 ((xscale_UV >> FP_SHIFT) << 16) |
666 ((xscale_UV & FRACT_MASK) << 3),
669 iowrite32((((yscale >> FP_SHIFT) << 16) |
670 ((yscale_UV >> FP_SHIFT) << 0)),
674 update_polyphase_filter(regs);
676 return scale_changed;
679 static void update_colorkey(struct intel_overlay *overlay,
680 struct overlay_registers __iomem *regs)
682 const struct intel_plane_state *state =
683 to_intel_plane_state(overlay->crtc->base.primary->state);
684 u32 key = overlay->color_key;
688 if (overlay->color_key_enabled)
689 flags |= DST_KEY_ENABLE;
691 if (state->base.visible)
692 format = state->base.fb->format->format;
697 flags |= CLK_RGB8I_MASK;
699 case DRM_FORMAT_XRGB1555:
700 key = RGB15_TO_COLORKEY(key);
701 flags |= CLK_RGB15_MASK;
703 case DRM_FORMAT_RGB565:
704 key = RGB16_TO_COLORKEY(key);
705 flags |= CLK_RGB16_MASK;
708 flags |= CLK_RGB24_MASK;
712 iowrite32(key, ®s->DCLRKV);
713 iowrite32(flags, ®s->DCLRKM);
716 static u32 overlay_cmd_reg(struct put_image_params *params)
718 u32 cmd = OCMD_ENABLE | OCMD_BUF_TYPE_FRAME | OCMD_BUFFER0;
720 if (params->format & I915_OVERLAY_YUV_PLANAR) {
721 switch (params->format & I915_OVERLAY_DEPTH_MASK) {
722 case I915_OVERLAY_YUV422:
723 cmd |= OCMD_YUV_422_PLANAR;
725 case I915_OVERLAY_YUV420:
726 cmd |= OCMD_YUV_420_PLANAR;
728 case I915_OVERLAY_YUV411:
729 case I915_OVERLAY_YUV410:
730 cmd |= OCMD_YUV_410_PLANAR;
733 } else { /* YUV packed */
734 switch (params->format & I915_OVERLAY_DEPTH_MASK) {
735 case I915_OVERLAY_YUV422:
736 cmd |= OCMD_YUV_422_PACKED;
738 case I915_OVERLAY_YUV411:
739 cmd |= OCMD_YUV_411_PACKED;
743 switch (params->format & I915_OVERLAY_SWAP_MASK) {
744 case I915_OVERLAY_NO_SWAP:
746 case I915_OVERLAY_UV_SWAP:
749 case I915_OVERLAY_Y_SWAP:
752 case I915_OVERLAY_Y_AND_UV_SWAP:
753 cmd |= OCMD_Y_AND_UV_SWAP;
761 static int intel_overlay_do_put_image(struct intel_overlay *overlay,
762 struct drm_i915_gem_object *new_bo,
763 struct put_image_params *params)
765 struct overlay_registers __iomem *regs = overlay->regs;
766 struct drm_i915_private *dev_priv = overlay->i915;
767 u32 swidth, swidthsw, sheight, ostride;
768 enum pipe pipe = overlay->crtc->pipe;
769 bool scale_changed = false;
770 struct i915_vma *vma;
773 lockdep_assert_held(&dev_priv->drm.struct_mutex);
774 WARN_ON(!drm_modeset_is_locked(&dev_priv->drm.mode_config.connection_mutex));
776 ret = intel_overlay_release_old_vid(overlay);
780 atomic_inc(&dev_priv->gpu_error.pending_fb_pin);
782 vma = i915_gem_object_pin_to_display_plane(new_bo,
783 0, NULL, PIN_MAPPABLE);
786 goto out_pin_section;
788 intel_fb_obj_flush(new_bo, ORIGIN_DIRTYFB);
790 ret = i915_vma_put_fence(vma);
794 if (!overlay->active) {
797 oconfig = OCONF_CC_OUT_8BIT;
798 if (IS_GEN4(dev_priv))
799 oconfig |= OCONF_CSC_MODE_BT709;
800 oconfig |= pipe == 0 ?
801 OCONF_PIPE_A : OCONF_PIPE_B;
802 iowrite32(oconfig, ®s->OCONFIG);
804 ret = intel_overlay_on(overlay);
809 iowrite32((params->dst_y << 16) | params->dst_x, ®s->DWINPOS);
810 iowrite32((params->dst_h << 16) | params->dst_w, ®s->DWINSZ);
812 if (params->format & I915_OVERLAY_YUV_PACKED)
813 tmp_width = packed_width_bytes(params->format, params->src_w);
815 tmp_width = params->src_w;
817 swidth = params->src_w;
818 swidthsw = calc_swidthsw(dev_priv, params->offset_Y, tmp_width);
819 sheight = params->src_h;
820 iowrite32(i915_ggtt_offset(vma) + params->offset_Y, ®s->OBUF_0Y);
821 ostride = params->stride_Y;
823 if (params->format & I915_OVERLAY_YUV_PLANAR) {
824 int uv_hscale = uv_hsubsampling(params->format);
825 int uv_vscale = uv_vsubsampling(params->format);
827 swidth |= (params->src_w/uv_hscale) << 16;
828 tmp_U = calc_swidthsw(dev_priv, params->offset_U,
829 params->src_w/uv_hscale);
830 tmp_V = calc_swidthsw(dev_priv, params->offset_V,
831 params->src_w/uv_hscale);
832 swidthsw |= max_t(u32, tmp_U, tmp_V) << 16;
833 sheight |= (params->src_h/uv_vscale) << 16;
834 iowrite32(i915_ggtt_offset(vma) + params->offset_U,
836 iowrite32(i915_ggtt_offset(vma) + params->offset_V,
838 ostride |= params->stride_UV << 16;
841 iowrite32(swidth, ®s->SWIDTH);
842 iowrite32(swidthsw, ®s->SWIDTHSW);
843 iowrite32(sheight, ®s->SHEIGHT);
844 iowrite32(ostride, ®s->OSTRIDE);
846 scale_changed = update_scaling_factors(overlay, regs, params);
848 update_colorkey(overlay, regs);
850 iowrite32(overlay_cmd_reg(params), ®s->OCMD);
852 ret = intel_overlay_continue(overlay, vma, scale_changed);
859 i915_gem_object_unpin_from_display_plane(vma);
861 atomic_dec(&dev_priv->gpu_error.pending_fb_pin);
866 int intel_overlay_switch_off(struct intel_overlay *overlay)
868 struct drm_i915_private *dev_priv = overlay->i915;
871 lockdep_assert_held(&dev_priv->drm.struct_mutex);
872 WARN_ON(!drm_modeset_is_locked(&dev_priv->drm.mode_config.connection_mutex));
874 ret = intel_overlay_recover_from_interrupt(overlay);
878 if (!overlay->active)
881 ret = intel_overlay_release_old_vid(overlay);
885 iowrite32(0, &overlay->regs->OCMD);
887 return intel_overlay_off(overlay);
890 static int check_overlay_possible_on_crtc(struct intel_overlay *overlay,
891 struct intel_crtc *crtc)
896 /* can't use the overlay with double wide pipe */
897 if (crtc->config->double_wide)
903 static void update_pfit_vscale_ratio(struct intel_overlay *overlay)
905 struct drm_i915_private *dev_priv = overlay->i915;
906 u32 pfit_control = I915_READ(PFIT_CONTROL);
909 /* XXX: This is not the same logic as in the xorg driver, but more in
910 * line with the intel documentation for the i965
912 if (INTEL_GEN(dev_priv) >= 4) {
913 /* on i965 use the PGM reg to read out the autoscaler values */
914 ratio = I915_READ(PFIT_PGM_RATIOS) >> PFIT_VERT_SCALE_SHIFT_965;
916 if (pfit_control & VERT_AUTO_SCALE)
917 ratio = I915_READ(PFIT_AUTO_RATIOS);
919 ratio = I915_READ(PFIT_PGM_RATIOS);
920 ratio >>= PFIT_VERT_SCALE_SHIFT;
923 overlay->pfit_vscale_ratio = ratio;
926 static int check_overlay_dst(struct intel_overlay *overlay,
927 struct drm_intel_overlay_put_image *rec)
929 const struct intel_crtc_state *pipe_config =
930 overlay->crtc->config;
932 if (rec->dst_x < pipe_config->pipe_src_w &&
933 rec->dst_x + rec->dst_width <= pipe_config->pipe_src_w &&
934 rec->dst_y < pipe_config->pipe_src_h &&
935 rec->dst_y + rec->dst_height <= pipe_config->pipe_src_h)
941 static int check_overlay_scaling(struct put_image_params *rec)
945 /* downscaling limit is 8.0 */
946 tmp = ((rec->src_scan_h << 16) / rec->dst_h) >> 16;
949 tmp = ((rec->src_scan_w << 16) / rec->dst_w) >> 16;
956 static int check_overlay_src(struct drm_i915_private *dev_priv,
957 struct drm_intel_overlay_put_image *rec,
958 struct drm_i915_gem_object *new_bo)
960 int uv_hscale = uv_hsubsampling(rec->flags);
961 int uv_vscale = uv_vsubsampling(rec->flags);
966 /* check src dimensions */
967 if (IS_I845G(dev_priv) || IS_I830(dev_priv)) {
968 if (rec->src_height > IMAGE_MAX_HEIGHT_LEGACY ||
969 rec->src_width > IMAGE_MAX_WIDTH_LEGACY)
972 if (rec->src_height > IMAGE_MAX_HEIGHT ||
973 rec->src_width > IMAGE_MAX_WIDTH)
977 /* better safe than sorry, use 4 as the maximal subsampling ratio */
978 if (rec->src_height < N_VERT_Y_TAPS*4 ||
979 rec->src_width < N_HORIZ_Y_TAPS*4)
982 /* check alignment constraints */
983 switch (rec->flags & I915_OVERLAY_TYPE_MASK) {
984 case I915_OVERLAY_RGB:
985 /* not implemented */
988 case I915_OVERLAY_YUV_PACKED:
992 depth = packed_depth_bytes(rec->flags);
996 /* ignore UV planes */
1000 /* check pixel alignment */
1001 if (rec->offset_Y % depth)
1005 case I915_OVERLAY_YUV_PLANAR:
1006 if (uv_vscale < 0 || uv_hscale < 0)
1008 /* no offset restrictions for planar formats */
1015 if (rec->src_width % uv_hscale)
1018 /* stride checking */
1019 if (IS_I830(dev_priv) || IS_I845G(dev_priv))
1024 if (rec->stride_Y & stride_mask || rec->stride_UV & stride_mask)
1026 if (IS_GEN4(dev_priv) && rec->stride_Y < 512)
1029 tmp = (rec->flags & I915_OVERLAY_TYPE_MASK) == I915_OVERLAY_YUV_PLANAR ?
1031 if (rec->stride_Y > tmp || rec->stride_UV > 2*1024)
1034 /* check buffer dimensions */
1035 switch (rec->flags & I915_OVERLAY_TYPE_MASK) {
1036 case I915_OVERLAY_RGB:
1037 case I915_OVERLAY_YUV_PACKED:
1038 /* always 4 Y values per depth pixels */
1039 if (packed_width_bytes(rec->flags, rec->src_width) > rec->stride_Y)
1042 tmp = rec->stride_Y*rec->src_height;
1043 if (rec->offset_Y + tmp > new_bo->base.size)
1047 case I915_OVERLAY_YUV_PLANAR:
1048 if (rec->src_width > rec->stride_Y)
1050 if (rec->src_width/uv_hscale > rec->stride_UV)
1053 tmp = rec->stride_Y * rec->src_height;
1054 if (rec->offset_Y + tmp > new_bo->base.size)
1057 tmp = rec->stride_UV * (rec->src_height / uv_vscale);
1058 if (rec->offset_U + tmp > new_bo->base.size ||
1059 rec->offset_V + tmp > new_bo->base.size)
1067 int intel_overlay_put_image_ioctl(struct drm_device *dev, void *data,
1068 struct drm_file *file_priv)
1070 struct drm_intel_overlay_put_image *put_image_rec = data;
1071 struct drm_i915_private *dev_priv = to_i915(dev);
1072 struct intel_overlay *overlay;
1073 struct drm_crtc *drmmode_crtc;
1074 struct intel_crtc *crtc;
1075 struct drm_i915_gem_object *new_bo;
1076 struct put_image_params *params;
1079 overlay = dev_priv->overlay;
1081 DRM_DEBUG("userspace bug: no overlay\n");
1085 if (!(put_image_rec->flags & I915_OVERLAY_ENABLE)) {
1086 drm_modeset_lock_all(dev);
1087 mutex_lock(&dev->struct_mutex);
1089 ret = intel_overlay_switch_off(overlay);
1091 mutex_unlock(&dev->struct_mutex);
1092 drm_modeset_unlock_all(dev);
1097 params = kmalloc(sizeof(*params), GFP_KERNEL);
1101 drmmode_crtc = drm_crtc_find(dev, file_priv, put_image_rec->crtc_id);
1102 if (!drmmode_crtc) {
1106 crtc = to_intel_crtc(drmmode_crtc);
1108 new_bo = i915_gem_object_lookup(file_priv, put_image_rec->bo_handle);
1114 drm_modeset_lock_all(dev);
1115 mutex_lock(&dev->struct_mutex);
1117 if (i915_gem_object_is_tiled(new_bo)) {
1118 DRM_DEBUG_KMS("buffer used for overlay image can not be tiled\n");
1123 ret = intel_overlay_recover_from_interrupt(overlay);
1127 if (overlay->crtc != crtc) {
1128 ret = intel_overlay_switch_off(overlay);
1132 ret = check_overlay_possible_on_crtc(overlay, crtc);
1136 overlay->crtc = crtc;
1137 crtc->overlay = overlay;
1139 /* line too wide, i.e. one-line-mode */
1140 if (crtc->config->pipe_src_w > 1024 &&
1141 crtc->config->gmch_pfit.control & PFIT_ENABLE) {
1142 overlay->pfit_active = true;
1143 update_pfit_vscale_ratio(overlay);
1145 overlay->pfit_active = false;
1148 ret = check_overlay_dst(overlay, put_image_rec);
1152 if (overlay->pfit_active) {
1153 params->dst_y = ((((u32)put_image_rec->dst_y) << 12) /
1154 overlay->pfit_vscale_ratio);
1155 /* shifting right rounds downwards, so add 1 */
1156 params->dst_h = ((((u32)put_image_rec->dst_height) << 12) /
1157 overlay->pfit_vscale_ratio) + 1;
1159 params->dst_y = put_image_rec->dst_y;
1160 params->dst_h = put_image_rec->dst_height;
1162 params->dst_x = put_image_rec->dst_x;
1163 params->dst_w = put_image_rec->dst_width;
1165 params->src_w = put_image_rec->src_width;
1166 params->src_h = put_image_rec->src_height;
1167 params->src_scan_w = put_image_rec->src_scan_width;
1168 params->src_scan_h = put_image_rec->src_scan_height;
1169 if (params->src_scan_h > params->src_h ||
1170 params->src_scan_w > params->src_w) {
1175 ret = check_overlay_src(dev_priv, put_image_rec, new_bo);
1178 params->format = put_image_rec->flags & ~I915_OVERLAY_FLAGS_MASK;
1179 params->stride_Y = put_image_rec->stride_Y;
1180 params->stride_UV = put_image_rec->stride_UV;
1181 params->offset_Y = put_image_rec->offset_Y;
1182 params->offset_U = put_image_rec->offset_U;
1183 params->offset_V = put_image_rec->offset_V;
1185 /* Check scaling after src size to prevent a divide-by-zero. */
1186 ret = check_overlay_scaling(params);
1190 ret = intel_overlay_do_put_image(overlay, new_bo, params);
1194 mutex_unlock(&dev->struct_mutex);
1195 drm_modeset_unlock_all(dev);
1196 i915_gem_object_put(new_bo);
1203 mutex_unlock(&dev->struct_mutex);
1204 drm_modeset_unlock_all(dev);
1205 i915_gem_object_put(new_bo);
1212 static void update_reg_attrs(struct intel_overlay *overlay,
1213 struct overlay_registers __iomem *regs)
1215 iowrite32((overlay->contrast << 18) | (overlay->brightness & 0xff),
1217 iowrite32(overlay->saturation, ®s->OCLRC1);
1220 static bool check_gamma_bounds(u32 gamma1, u32 gamma2)
1224 if (gamma1 & 0xff000000 || gamma2 & 0xff000000)
1227 for (i = 0; i < 3; i++) {
1228 if (((gamma1 >> i*8) & 0xff) >= ((gamma2 >> i*8) & 0xff))
1235 static bool check_gamma5_errata(u32 gamma5)
1239 for (i = 0; i < 3; i++) {
1240 if (((gamma5 >> i*8) & 0xff) == 0x80)
1247 static int check_gamma(struct drm_intel_overlay_attrs *attrs)
1249 if (!check_gamma_bounds(0, attrs->gamma0) ||
1250 !check_gamma_bounds(attrs->gamma0, attrs->gamma1) ||
1251 !check_gamma_bounds(attrs->gamma1, attrs->gamma2) ||
1252 !check_gamma_bounds(attrs->gamma2, attrs->gamma3) ||
1253 !check_gamma_bounds(attrs->gamma3, attrs->gamma4) ||
1254 !check_gamma_bounds(attrs->gamma4, attrs->gamma5) ||
1255 !check_gamma_bounds(attrs->gamma5, 0x00ffffff))
1258 if (!check_gamma5_errata(attrs->gamma5))
1264 int intel_overlay_attrs_ioctl(struct drm_device *dev, void *data,
1265 struct drm_file *file_priv)
1267 struct drm_intel_overlay_attrs *attrs = data;
1268 struct drm_i915_private *dev_priv = to_i915(dev);
1269 struct intel_overlay *overlay;
1272 overlay = dev_priv->overlay;
1274 DRM_DEBUG("userspace bug: no overlay\n");
1278 drm_modeset_lock_all(dev);
1279 mutex_lock(&dev->struct_mutex);
1282 if (!(attrs->flags & I915_OVERLAY_UPDATE_ATTRS)) {
1283 attrs->color_key = overlay->color_key;
1284 attrs->brightness = overlay->brightness;
1285 attrs->contrast = overlay->contrast;
1286 attrs->saturation = overlay->saturation;
1288 if (!IS_GEN2(dev_priv)) {
1289 attrs->gamma0 = I915_READ(OGAMC0);
1290 attrs->gamma1 = I915_READ(OGAMC1);
1291 attrs->gamma2 = I915_READ(OGAMC2);
1292 attrs->gamma3 = I915_READ(OGAMC3);
1293 attrs->gamma4 = I915_READ(OGAMC4);
1294 attrs->gamma5 = I915_READ(OGAMC5);
1297 if (attrs->brightness < -128 || attrs->brightness > 127)
1299 if (attrs->contrast > 255)
1301 if (attrs->saturation > 1023)
1304 overlay->color_key = attrs->color_key;
1305 overlay->brightness = attrs->brightness;
1306 overlay->contrast = attrs->contrast;
1307 overlay->saturation = attrs->saturation;
1309 update_reg_attrs(overlay, overlay->regs);
1311 if (attrs->flags & I915_OVERLAY_UPDATE_GAMMA) {
1312 if (IS_GEN2(dev_priv))
1315 if (overlay->active) {
1320 ret = check_gamma(attrs);
1324 I915_WRITE(OGAMC0, attrs->gamma0);
1325 I915_WRITE(OGAMC1, attrs->gamma1);
1326 I915_WRITE(OGAMC2, attrs->gamma2);
1327 I915_WRITE(OGAMC3, attrs->gamma3);
1328 I915_WRITE(OGAMC4, attrs->gamma4);
1329 I915_WRITE(OGAMC5, attrs->gamma5);
1332 overlay->color_key_enabled = (attrs->flags & I915_OVERLAY_DISABLE_DEST_COLORKEY) == 0;
1336 mutex_unlock(&dev->struct_mutex);
1337 drm_modeset_unlock_all(dev);
1342 static int get_registers(struct intel_overlay *overlay, bool use_phys)
1344 struct drm_i915_gem_object *obj;
1345 struct i915_vma *vma;
1348 obj = i915_gem_object_create_stolen(overlay->i915, PAGE_SIZE);
1350 obj = i915_gem_object_create_internal(overlay->i915, PAGE_SIZE);
1352 return PTR_ERR(obj);
1354 vma = i915_gem_object_ggtt_pin(obj, NULL, 0, 0, PIN_MAPPABLE);
1361 overlay->flip_addr = sg_dma_address(obj->mm.pages->sgl);
1363 overlay->flip_addr = i915_ggtt_offset(vma);
1364 overlay->regs = i915_vma_pin_iomap(vma);
1365 i915_vma_unpin(vma);
1367 if (IS_ERR(overlay->regs)) {
1368 err = PTR_ERR(overlay->regs);
1372 overlay->reg_bo = obj;
1376 i915_gem_object_put(obj);
1380 void intel_setup_overlay(struct drm_i915_private *dev_priv)
1382 struct intel_overlay *overlay;
1385 if (!HAS_OVERLAY(dev_priv))
1388 overlay = kzalloc(sizeof(*overlay), GFP_KERNEL);
1392 overlay->i915 = dev_priv;
1394 overlay->color_key = 0x0101fe;
1395 overlay->color_key_enabled = true;
1396 overlay->brightness = -19;
1397 overlay->contrast = 75;
1398 overlay->saturation = 146;
1400 init_request_active(&overlay->last_flip, NULL);
1402 mutex_lock(&dev_priv->drm.struct_mutex);
1404 ret = get_registers(overlay, OVERLAY_NEEDS_PHYSICAL(dev_priv));
1408 ret = i915_gem_object_set_to_gtt_domain(overlay->reg_bo, true);
1412 mutex_unlock(&dev_priv->drm.struct_mutex);
1414 memset_io(overlay->regs, 0, sizeof(struct overlay_registers));
1415 update_polyphase_filter(overlay->regs);
1416 update_reg_attrs(overlay, overlay->regs);
1418 dev_priv->overlay = overlay;
1419 DRM_INFO("Initialized overlay support.\n");
1423 i915_gem_object_put(overlay->reg_bo);
1425 mutex_unlock(&dev_priv->drm.struct_mutex);
1429 void intel_cleanup_overlay(struct drm_i915_private *dev_priv)
1431 struct intel_overlay *overlay;
1433 overlay = fetch_and_zero(&dev_priv->overlay);
1438 * The bo's should be free'd by the generic code already.
1439 * Furthermore modesetting teardown happens beforehand so the
1440 * hardware should be off already.
1442 WARN_ON(overlay->active);
1444 i915_gem_object_put(overlay->reg_bo);
1449 #if IS_ENABLED(CONFIG_DRM_I915_CAPTURE_ERROR)
1451 struct intel_overlay_error_state {
1452 struct overlay_registers regs;
1458 struct intel_overlay_error_state *
1459 intel_overlay_capture_error_state(struct drm_i915_private *dev_priv)
1461 struct intel_overlay *overlay = dev_priv->overlay;
1462 struct intel_overlay_error_state *error;
1464 if (!overlay || !overlay->active)
1467 error = kmalloc(sizeof(*error), GFP_ATOMIC);
1471 error->dovsta = I915_READ(DOVSTA);
1472 error->isr = I915_READ(ISR);
1473 error->base = overlay->flip_addr;
1475 memcpy_fromio(&error->regs, overlay->regs, sizeof(error->regs));
1481 intel_overlay_print_error_state(struct drm_i915_error_state_buf *m,
1482 struct intel_overlay_error_state *error)
1484 i915_error_printf(m, "Overlay, status: 0x%08x, interrupt: 0x%08x\n",
1485 error->dovsta, error->isr);
1486 i915_error_printf(m, " Register file at 0x%08lx:\n",
1489 #define P(x) i915_error_printf(m, " " #x ": 0x%08x\n", error->regs.x)