2 * Copyright © 2011 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 FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 * Jesse Barnes <jbarnes@virtuousgeek.org>
26 * New plane/sprite handling.
28 * The older chips had a separate interface for programming plane related
29 * registers; newer ones are much simpler and we can use the new DRM plane
33 #include <drm/drm_crtc.h>
34 #include <drm/drm_fourcc.h>
35 #include "intel_drv.h"
36 #include <drm/i915_drm.h>
40 ivb_update_plane(struct drm_plane *plane, struct drm_framebuffer *fb,
41 struct drm_i915_gem_object *obj, int crtc_x, int crtc_y,
42 unsigned int crtc_w, unsigned int crtc_h,
43 uint32_t x, uint32_t y,
44 uint32_t src_w, uint32_t src_h)
46 struct drm_device *dev = plane->dev;
47 struct drm_i915_private *dev_priv = dev->dev_private;
48 struct intel_plane *intel_plane = to_intel_plane(plane);
49 int pipe = intel_plane->pipe;
50 u32 sprctl, sprscale = 0;
53 sprctl = I915_READ(SPRCTL(pipe));
55 /* Mask out pixel format bits in case we change it */
56 sprctl &= ~SPRITE_PIXFORMAT_MASK;
57 sprctl &= ~SPRITE_RGB_ORDER_RGBX;
58 sprctl &= ~SPRITE_YUV_BYTE_ORDER_MASK;
59 sprctl &= ~SPRITE_TILED;
61 switch (fb->pixel_format) {
62 case DRM_FORMAT_XBGR8888:
63 sprctl |= SPRITE_FORMAT_RGBX888 | SPRITE_RGB_ORDER_RGBX;
66 case DRM_FORMAT_XRGB8888:
67 sprctl |= SPRITE_FORMAT_RGBX888;
71 sprctl |= SPRITE_FORMAT_YUV422 | SPRITE_YUV_ORDER_YUYV;
75 sprctl |= SPRITE_FORMAT_YUV422 | SPRITE_YUV_ORDER_YVYU;
79 sprctl |= SPRITE_FORMAT_YUV422 | SPRITE_YUV_ORDER_UYVY;
83 sprctl |= SPRITE_FORMAT_YUV422 | SPRITE_YUV_ORDER_VYUY;
87 DRM_DEBUG_DRIVER("bad pixel format, assuming RGBX888\n");
88 sprctl |= SPRITE_FORMAT_RGBX888;
93 if (obj->tiling_mode != I915_TILING_NONE)
94 sprctl |= SPRITE_TILED;
97 sprctl |= SPRITE_TRICKLE_FEED_DISABLE;
98 sprctl |= SPRITE_ENABLE;
100 /* Sizes are 0 based */
106 intel_update_sprite_watermarks(dev, pipe, crtc_w, pixel_size);
109 * IVB workaround: must disable low power watermarks for at least
110 * one frame before enabling scaling. LP watermarks can be re-enabled
111 * when scaling is disabled.
113 if (crtc_w != src_w || crtc_h != src_h) {
114 if (!dev_priv->sprite_scaling_enabled) {
115 dev_priv->sprite_scaling_enabled = true;
116 intel_update_watermarks(dev);
117 intel_wait_for_vblank(dev, pipe);
119 sprscale = SPRITE_SCALE_ENABLE | (src_w << 16) | src_h;
121 if (dev_priv->sprite_scaling_enabled) {
122 dev_priv->sprite_scaling_enabled = false;
123 /* potentially re-enable LP watermarks */
124 intel_update_watermarks(dev);
128 I915_WRITE(SPRSTRIDE(pipe), fb->pitches[0]);
129 I915_WRITE(SPRPOS(pipe), (crtc_y << 16) | crtc_x);
130 if (obj->tiling_mode != I915_TILING_NONE) {
131 I915_WRITE(SPRTILEOFF(pipe), (y << 16) | x);
133 unsigned long offset;
135 offset = y * fb->pitches[0] + x * (fb->bits_per_pixel / 8);
136 I915_WRITE(SPRLINOFF(pipe), offset);
138 I915_WRITE(SPRSIZE(pipe), (crtc_h << 16) | crtc_w);
139 if (intel_plane->can_scale)
140 I915_WRITE(SPRSCALE(pipe), sprscale);
141 I915_WRITE(SPRCTL(pipe), sprctl);
142 I915_MODIFY_DISPBASE(SPRSURF(pipe), obj->gtt_offset);
143 POSTING_READ(SPRSURF(pipe));
147 ivb_disable_plane(struct drm_plane *plane)
149 struct drm_device *dev = plane->dev;
150 struct drm_i915_private *dev_priv = dev->dev_private;
151 struct intel_plane *intel_plane = to_intel_plane(plane);
152 int pipe = intel_plane->pipe;
154 I915_WRITE(SPRCTL(pipe), I915_READ(SPRCTL(pipe)) & ~SPRITE_ENABLE);
155 /* Can't leave the scaler enabled... */
156 if (intel_plane->can_scale)
157 I915_WRITE(SPRSCALE(pipe), 0);
158 /* Activate double buffered register update */
159 I915_MODIFY_DISPBASE(SPRSURF(pipe), 0);
160 POSTING_READ(SPRSURF(pipe));
162 dev_priv->sprite_scaling_enabled = false;
163 intel_update_watermarks(dev);
167 ivb_update_colorkey(struct drm_plane *plane,
168 struct drm_intel_sprite_colorkey *key)
170 struct drm_device *dev = plane->dev;
171 struct drm_i915_private *dev_priv = dev->dev_private;
172 struct intel_plane *intel_plane;
176 intel_plane = to_intel_plane(plane);
178 I915_WRITE(SPRKEYVAL(intel_plane->pipe), key->min_value);
179 I915_WRITE(SPRKEYMAX(intel_plane->pipe), key->max_value);
180 I915_WRITE(SPRKEYMSK(intel_plane->pipe), key->channel_mask);
182 sprctl = I915_READ(SPRCTL(intel_plane->pipe));
183 sprctl &= ~(SPRITE_SOURCE_KEY | SPRITE_DEST_KEY);
184 if (key->flags & I915_SET_COLORKEY_DESTINATION)
185 sprctl |= SPRITE_DEST_KEY;
186 else if (key->flags & I915_SET_COLORKEY_SOURCE)
187 sprctl |= SPRITE_SOURCE_KEY;
188 I915_WRITE(SPRCTL(intel_plane->pipe), sprctl);
190 POSTING_READ(SPRKEYMSK(intel_plane->pipe));
196 ivb_get_colorkey(struct drm_plane *plane, struct drm_intel_sprite_colorkey *key)
198 struct drm_device *dev = plane->dev;
199 struct drm_i915_private *dev_priv = dev->dev_private;
200 struct intel_plane *intel_plane;
203 intel_plane = to_intel_plane(plane);
205 key->min_value = I915_READ(SPRKEYVAL(intel_plane->pipe));
206 key->max_value = I915_READ(SPRKEYMAX(intel_plane->pipe));
207 key->channel_mask = I915_READ(SPRKEYMSK(intel_plane->pipe));
210 sprctl = I915_READ(SPRCTL(intel_plane->pipe));
212 if (sprctl & SPRITE_DEST_KEY)
213 key->flags = I915_SET_COLORKEY_DESTINATION;
214 else if (sprctl & SPRITE_SOURCE_KEY)
215 key->flags = I915_SET_COLORKEY_SOURCE;
217 key->flags = I915_SET_COLORKEY_NONE;
221 ilk_update_plane(struct drm_plane *plane, struct drm_framebuffer *fb,
222 struct drm_i915_gem_object *obj, int crtc_x, int crtc_y,
223 unsigned int crtc_w, unsigned int crtc_h,
224 uint32_t x, uint32_t y,
225 uint32_t src_w, uint32_t src_h)
227 struct drm_device *dev = plane->dev;
228 struct drm_i915_private *dev_priv = dev->dev_private;
229 struct intel_plane *intel_plane = to_intel_plane(plane);
230 int pipe = intel_plane->pipe, pixel_size;
231 u32 dvscntr, dvsscale;
233 dvscntr = I915_READ(DVSCNTR(pipe));
235 /* Mask out pixel format bits in case we change it */
236 dvscntr &= ~DVS_PIXFORMAT_MASK;
237 dvscntr &= ~DVS_RGB_ORDER_XBGR;
238 dvscntr &= ~DVS_YUV_BYTE_ORDER_MASK;
239 dvscntr &= ~DVS_TILED;
241 switch (fb->pixel_format) {
242 case DRM_FORMAT_XBGR8888:
243 dvscntr |= DVS_FORMAT_RGBX888 | DVS_RGB_ORDER_XBGR;
246 case DRM_FORMAT_XRGB8888:
247 dvscntr |= DVS_FORMAT_RGBX888;
250 case DRM_FORMAT_YUYV:
251 dvscntr |= DVS_FORMAT_YUV422 | DVS_YUV_ORDER_YUYV;
254 case DRM_FORMAT_YVYU:
255 dvscntr |= DVS_FORMAT_YUV422 | DVS_YUV_ORDER_YVYU;
258 case DRM_FORMAT_UYVY:
259 dvscntr |= DVS_FORMAT_YUV422 | DVS_YUV_ORDER_UYVY;
262 case DRM_FORMAT_VYUY:
263 dvscntr |= DVS_FORMAT_YUV422 | DVS_YUV_ORDER_VYUY;
267 DRM_DEBUG_DRIVER("bad pixel format, assuming RGBX888\n");
268 dvscntr |= DVS_FORMAT_RGBX888;
273 if (obj->tiling_mode != I915_TILING_NONE)
274 dvscntr |= DVS_TILED;
277 dvscntr |= DVS_TRICKLE_FEED_DISABLE; /* must disable */
278 dvscntr |= DVS_ENABLE;
280 /* Sizes are 0 based */
286 intel_update_sprite_watermarks(dev, pipe, crtc_w, pixel_size);
289 if (IS_GEN5(dev) || crtc_w != src_w || crtc_h != src_h)
290 dvsscale = DVS_SCALE_ENABLE | (src_w << 16) | src_h;
292 I915_WRITE(DVSSTRIDE(pipe), fb->pitches[0]);
293 I915_WRITE(DVSPOS(pipe), (crtc_y << 16) | crtc_x);
294 if (obj->tiling_mode != I915_TILING_NONE) {
295 I915_WRITE(DVSTILEOFF(pipe), (y << 16) | x);
297 unsigned long offset;
299 offset = y * fb->pitches[0] + x * (fb->bits_per_pixel / 8);
300 I915_WRITE(DVSLINOFF(pipe), offset);
302 I915_WRITE(DVSSIZE(pipe), (crtc_h << 16) | crtc_w);
303 I915_WRITE(DVSSCALE(pipe), dvsscale);
304 I915_WRITE(DVSCNTR(pipe), dvscntr);
305 I915_MODIFY_DISPBASE(DVSSURF(pipe), obj->gtt_offset);
306 POSTING_READ(DVSSURF(pipe));
310 ilk_disable_plane(struct drm_plane *plane)
312 struct drm_device *dev = plane->dev;
313 struct drm_i915_private *dev_priv = dev->dev_private;
314 struct intel_plane *intel_plane = to_intel_plane(plane);
315 int pipe = intel_plane->pipe;
317 I915_WRITE(DVSCNTR(pipe), I915_READ(DVSCNTR(pipe)) & ~DVS_ENABLE);
318 /* Disable the scaler */
319 I915_WRITE(DVSSCALE(pipe), 0);
320 /* Flush double buffered register updates */
321 I915_MODIFY_DISPBASE(DVSSURF(pipe), 0);
322 POSTING_READ(DVSSURF(pipe));
326 intel_enable_primary(struct drm_crtc *crtc)
328 struct drm_device *dev = crtc->dev;
329 struct drm_i915_private *dev_priv = dev->dev_private;
330 struct intel_crtc *intel_crtc = to_intel_crtc(crtc);
331 int reg = DSPCNTR(intel_crtc->plane);
333 if (!intel_crtc->primary_disabled)
336 intel_crtc->primary_disabled = false;
337 intel_update_fbc(dev);
339 I915_WRITE(reg, I915_READ(reg) | DISPLAY_PLANE_ENABLE);
343 intel_disable_primary(struct drm_crtc *crtc)
345 struct drm_device *dev = crtc->dev;
346 struct drm_i915_private *dev_priv = dev->dev_private;
347 struct intel_crtc *intel_crtc = to_intel_crtc(crtc);
348 int reg = DSPCNTR(intel_crtc->plane);
350 if (intel_crtc->primary_disabled)
353 I915_WRITE(reg, I915_READ(reg) & ~DISPLAY_PLANE_ENABLE);
355 intel_crtc->primary_disabled = true;
356 intel_update_fbc(dev);
360 ilk_update_colorkey(struct drm_plane *plane,
361 struct drm_intel_sprite_colorkey *key)
363 struct drm_device *dev = plane->dev;
364 struct drm_i915_private *dev_priv = dev->dev_private;
365 struct intel_plane *intel_plane;
369 intel_plane = to_intel_plane(plane);
371 I915_WRITE(DVSKEYVAL(intel_plane->pipe), key->min_value);
372 I915_WRITE(DVSKEYMAX(intel_plane->pipe), key->max_value);
373 I915_WRITE(DVSKEYMSK(intel_plane->pipe), key->channel_mask);
375 dvscntr = I915_READ(DVSCNTR(intel_plane->pipe));
376 dvscntr &= ~(DVS_SOURCE_KEY | DVS_DEST_KEY);
377 if (key->flags & I915_SET_COLORKEY_DESTINATION)
378 dvscntr |= DVS_DEST_KEY;
379 else if (key->flags & I915_SET_COLORKEY_SOURCE)
380 dvscntr |= DVS_SOURCE_KEY;
381 I915_WRITE(DVSCNTR(intel_plane->pipe), dvscntr);
383 POSTING_READ(DVSKEYMSK(intel_plane->pipe));
389 ilk_get_colorkey(struct drm_plane *plane, struct drm_intel_sprite_colorkey *key)
391 struct drm_device *dev = plane->dev;
392 struct drm_i915_private *dev_priv = dev->dev_private;
393 struct intel_plane *intel_plane;
396 intel_plane = to_intel_plane(plane);
398 key->min_value = I915_READ(DVSKEYVAL(intel_plane->pipe));
399 key->max_value = I915_READ(DVSKEYMAX(intel_plane->pipe));
400 key->channel_mask = I915_READ(DVSKEYMSK(intel_plane->pipe));
403 dvscntr = I915_READ(DVSCNTR(intel_plane->pipe));
405 if (dvscntr & DVS_DEST_KEY)
406 key->flags = I915_SET_COLORKEY_DESTINATION;
407 else if (dvscntr & DVS_SOURCE_KEY)
408 key->flags = I915_SET_COLORKEY_SOURCE;
410 key->flags = I915_SET_COLORKEY_NONE;
414 intel_update_plane(struct drm_plane *plane, struct drm_crtc *crtc,
415 struct drm_framebuffer *fb, int crtc_x, int crtc_y,
416 unsigned int crtc_w, unsigned int crtc_h,
417 uint32_t src_x, uint32_t src_y,
418 uint32_t src_w, uint32_t src_h)
420 struct drm_device *dev = plane->dev;
421 struct drm_i915_private *dev_priv = dev->dev_private;
422 struct intel_crtc *intel_crtc = to_intel_crtc(crtc);
423 struct intel_plane *intel_plane = to_intel_plane(plane);
424 struct intel_framebuffer *intel_fb;
425 struct drm_i915_gem_object *obj, *old_obj;
426 int pipe = intel_plane->pipe;
428 int x = src_x >> 16, y = src_y >> 16;
429 int primary_w = crtc->mode.hdisplay, primary_h = crtc->mode.vdisplay;
430 bool disable_primary = false;
432 intel_fb = to_intel_framebuffer(fb);
435 old_obj = intel_plane->obj;
440 /* Pipe must be running... */
441 if (!(I915_READ(PIPECONF(pipe)) & PIPECONF_ENABLE))
444 if (crtc_x >= primary_w || crtc_y >= primary_h)
447 /* Don't modify another pipe's plane */
448 if (intel_plane->pipe != intel_crtc->pipe)
452 * Clamp the width & height into the visible area. Note we don't
453 * try to scale the source if part of the visible region is offscreen.
454 * The caller must handle that by adjusting source offset and size.
456 if ((crtc_x < 0) && ((crtc_x + crtc_w) > 0)) {
460 if ((crtc_x + crtc_w) <= 0) /* Nothing to display */
462 if ((crtc_x + crtc_w) > primary_w)
463 crtc_w = primary_w - crtc_x;
465 if ((crtc_y < 0) && ((crtc_y + crtc_h) > 0)) {
469 if ((crtc_y + crtc_h) <= 0) /* Nothing to display */
471 if (crtc_y + crtc_h > primary_h)
472 crtc_h = primary_h - crtc_y;
474 if (!crtc_w || !crtc_h) /* Again, nothing to display */
478 * We may not have a scaler, eg. HSW does not have it any more
480 if (!intel_plane->can_scale && (crtc_w != src_w || crtc_h != src_h))
484 * We can take a larger source and scale it down, but
485 * only so much... 16x is the max on SNB.
487 if (((src_w * src_h) / (crtc_w * crtc_h)) > intel_plane->max_downscale)
491 * If the sprite is completely covering the primary plane,
492 * we can disable the primary and save power.
494 if ((crtc_x == 0) && (crtc_y == 0) &&
495 (crtc_w == primary_w) && (crtc_h == primary_h))
496 disable_primary = true;
498 mutex_lock(&dev->struct_mutex);
500 ret = intel_pin_and_fence_fb_obj(dev, obj, NULL);
504 intel_plane->obj = obj;
507 * Be sure to re-enable the primary before the sprite is no longer
510 if (!disable_primary)
511 intel_enable_primary(crtc);
513 intel_plane->update_plane(plane, fb, obj, crtc_x, crtc_y,
514 crtc_w, crtc_h, x, y, src_w, src_h);
517 intel_disable_primary(crtc);
519 /* Unpin old obj after new one is active to avoid ugliness */
522 * It's fairly common to simply update the position of
523 * an existing object. In that case, we don't need to
524 * wait for vblank to avoid ugliness, we only need to
525 * do the pin & ref bookkeeping.
527 if (old_obj != obj) {
528 mutex_unlock(&dev->struct_mutex);
529 intel_wait_for_vblank(dev, to_intel_crtc(crtc)->pipe);
530 mutex_lock(&dev->struct_mutex);
532 intel_unpin_fb_obj(old_obj);
536 mutex_unlock(&dev->struct_mutex);
542 intel_disable_plane(struct drm_plane *plane)
544 struct drm_device *dev = plane->dev;
545 struct intel_plane *intel_plane = to_intel_plane(plane);
549 intel_enable_primary(plane->crtc);
550 intel_plane->disable_plane(plane);
552 if (!intel_plane->obj)
555 mutex_lock(&dev->struct_mutex);
556 intel_unpin_fb_obj(intel_plane->obj);
557 intel_plane->obj = NULL;
558 mutex_unlock(&dev->struct_mutex);
564 static void intel_destroy_plane(struct drm_plane *plane)
566 struct intel_plane *intel_plane = to_intel_plane(plane);
567 intel_disable_plane(plane);
568 drm_plane_cleanup(plane);
572 int intel_sprite_set_colorkey(struct drm_device *dev, void *data,
573 struct drm_file *file_priv)
575 struct drm_intel_sprite_colorkey *set = data;
576 struct drm_mode_object *obj;
577 struct drm_plane *plane;
578 struct intel_plane *intel_plane;
581 if (!drm_core_check_feature(dev, DRIVER_MODESET))
584 /* Make sure we don't try to enable both src & dest simultaneously */
585 if ((set->flags & (I915_SET_COLORKEY_DESTINATION | I915_SET_COLORKEY_SOURCE)) == (I915_SET_COLORKEY_DESTINATION | I915_SET_COLORKEY_SOURCE))
588 mutex_lock(&dev->mode_config.mutex);
590 obj = drm_mode_object_find(dev, set->plane_id, DRM_MODE_OBJECT_PLANE);
596 plane = obj_to_plane(obj);
597 intel_plane = to_intel_plane(plane);
598 ret = intel_plane->update_colorkey(plane, set);
601 mutex_unlock(&dev->mode_config.mutex);
605 int intel_sprite_get_colorkey(struct drm_device *dev, void *data,
606 struct drm_file *file_priv)
608 struct drm_intel_sprite_colorkey *get = data;
609 struct drm_mode_object *obj;
610 struct drm_plane *plane;
611 struct intel_plane *intel_plane;
614 if (!drm_core_check_feature(dev, DRIVER_MODESET))
617 mutex_lock(&dev->mode_config.mutex);
619 obj = drm_mode_object_find(dev, get->plane_id, DRM_MODE_OBJECT_PLANE);
625 plane = obj_to_plane(obj);
626 intel_plane = to_intel_plane(plane);
627 intel_plane->get_colorkey(plane, get);
630 mutex_unlock(&dev->mode_config.mutex);
634 static const struct drm_plane_funcs intel_plane_funcs = {
635 .update_plane = intel_update_plane,
636 .disable_plane = intel_disable_plane,
637 .destroy = intel_destroy_plane,
640 static uint32_t ilk_plane_formats[] = {
648 static uint32_t snb_plane_formats[] = {
658 intel_plane_init(struct drm_device *dev, enum pipe pipe)
660 struct intel_plane *intel_plane;
661 unsigned long possible_crtcs;
662 const uint32_t *plane_formats;
663 int num_plane_formats;
666 if (INTEL_INFO(dev)->gen < 5)
669 intel_plane = kzalloc(sizeof(struct intel_plane), GFP_KERNEL);
673 switch (INTEL_INFO(dev)->gen) {
676 intel_plane->can_scale = true;
677 intel_plane->max_downscale = 16;
678 intel_plane->update_plane = ilk_update_plane;
679 intel_plane->disable_plane = ilk_disable_plane;
680 intel_plane->update_colorkey = ilk_update_colorkey;
681 intel_plane->get_colorkey = ilk_get_colorkey;
684 plane_formats = snb_plane_formats;
685 num_plane_formats = ARRAY_SIZE(snb_plane_formats);
687 plane_formats = ilk_plane_formats;
688 num_plane_formats = ARRAY_SIZE(ilk_plane_formats);
694 intel_plane->can_scale = false;
696 intel_plane->can_scale = true;
697 intel_plane->max_downscale = 2;
698 intel_plane->update_plane = ivb_update_plane;
699 intel_plane->disable_plane = ivb_disable_plane;
700 intel_plane->update_colorkey = ivb_update_colorkey;
701 intel_plane->get_colorkey = ivb_get_colorkey;
703 plane_formats = snb_plane_formats;
704 num_plane_formats = ARRAY_SIZE(snb_plane_formats);
712 intel_plane->pipe = pipe;
713 possible_crtcs = (1 << pipe);
714 ret = drm_plane_init(dev, &intel_plane->base, possible_crtcs,
716 plane_formats, num_plane_formats,