drivers/gpu/drm/i915/intel_sprite.c

   1 /*
   2  * Copyright © 2011 Intel Corporation
   3  *
   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:
  10  *
  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
  13  * Software.
  14  *
  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
  21  * SOFTWARE.
  22  *
  23  * Authors:
  24  *   Jesse Barnes <jbarnes@virtuousgeek.org>
  25  *
  26  * New plane/sprite handling.
  27  *
  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
  30  * support.
  31  */
  32 #include <drm/drmP.h>
  33 #include <drm/drm_crtc.h>
  34 #include <drm/drm_fourcc.h>
  35 #include <drm/drm_rect.h>
  36 #include "intel_drv.h"
  37 #include <drm/i915_drm.h>
  38 #include "i915_drv.h"
  39
  40 static void
  41 vlv_update_plane(struct drm_plane *dplane, struct drm_crtc *crtc,
  42                  struct drm_framebuffer *fb,
  43                  struct drm_i915_gem_object *obj, int crtc_x, int crtc_y,
  44                  unsigned int crtc_w, unsigned int crtc_h,
  45                  uint32_t x, uint32_t y,
  46                  uint32_t src_w, uint32_t src_h)
  47 {
  48         struct drm_device *dev = dplane->dev;
  49         struct drm_i915_private *dev_priv = dev->dev_private;
  50         struct intel_plane *intel_plane = to_intel_plane(dplane);
  51         int pipe = intel_plane->pipe;
  52         int plane = intel_plane->plane;
  53         u32 sprctl;
  54         unsigned long sprsurf_offset, linear_offset;
  55         int pixel_size = drm_format_plane_cpp(fb->pixel_format, 0);
  56
  57         sprctl = I915_READ(SPCNTR(pipe, plane));
  58
  59         /* Mask out pixel format bits in case we change it */
  60         sprctl &= ~SP_PIXFORMAT_MASK;
  61         sprctl &= ~SP_YUV_BYTE_ORDER_MASK;
  62         sprctl &= ~SP_TILED;
  63
  64         switch (fb->pixel_format) {
  65         case DRM_FORMAT_YUYV:
  66                 sprctl |= SP_FORMAT_YUV422 | SP_YUV_ORDER_YUYV;
  67                 break;
  68         case DRM_FORMAT_YVYU:
  69                 sprctl |= SP_FORMAT_YUV422 | SP_YUV_ORDER_YVYU;
  70                 break;
  71         case DRM_FORMAT_UYVY:
  72                 sprctl |= SP_FORMAT_YUV422 | SP_YUV_ORDER_UYVY;
  73                 break;
  74         case DRM_FORMAT_VYUY:
  75                 sprctl |= SP_FORMAT_YUV422 | SP_YUV_ORDER_VYUY;
  76                 break;
  77         case DRM_FORMAT_RGB565:
  78                 sprctl |= SP_FORMAT_BGR565;
  79                 break;
  80         case DRM_FORMAT_XRGB8888:
  81                 sprctl |= SP_FORMAT_BGRX8888;
  82                 break;
  83         case DRM_FORMAT_ARGB8888:
  84                 sprctl |= SP_FORMAT_BGRA8888;
  85                 break;
  86         case DRM_FORMAT_XBGR2101010:
  87                 sprctl |= SP_FORMAT_RGBX1010102;
  88                 break;
  89         case DRM_FORMAT_ABGR2101010:
  90                 sprctl |= SP_FORMAT_RGBA1010102;
  91                 break;
  92         case DRM_FORMAT_XBGR8888:
  93                 sprctl |= SP_FORMAT_RGBX8888;
  94                 break;
  95         case DRM_FORMAT_ABGR8888:
  96                 sprctl |= SP_FORMAT_RGBA8888;
  97                 break;
  98         default:
  99                 /*
 100                  * If we get here one of the upper layers failed to filter
 101                  * out the unsupported plane formats
 102                  */
 103                 BUG();
 104                 break;
 105         }
 106
 107         if (obj->tiling_mode != I915_TILING_NONE)
 108                 sprctl |= SP_TILED;
 109
 110         sprctl |= SP_ENABLE;
 111
 112         intel_update_sprite_watermarks(dplane, crtc, src_w, pixel_size, true,
 113                                        src_w != crtc_w || src_h != crtc_h);
 114
 115         /* Sizes are 0 based */
 116         src_w--;
 117         src_h--;
 118         crtc_w--;
 119         crtc_h--;
 120
 121         I915_WRITE(SPSTRIDE(pipe, plane), fb->pitches[0]);
 122         I915_WRITE(SPPOS(pipe, plane), (crtc_y << 16) | crtc_x);
 123
 124         linear_offset = y * fb->pitches[0] + x * pixel_size;
 125         sprsurf_offset = intel_gen4_compute_page_offset(&x, &y,
 126                                                         obj->tiling_mode,
 127                                                         pixel_size,
 128                                                         fb->pitches[0]);
 129         linear_offset -= sprsurf_offset;
 130
 131         if (obj->tiling_mode != I915_TILING_NONE)
 132                 I915_WRITE(SPTILEOFF(pipe, plane), (y << 16) | x);
 133         else
 134                 I915_WRITE(SPLINOFF(pipe, plane), linear_offset);
 135
 136         I915_WRITE(SPSIZE(pipe, plane), (crtc_h << 16) | crtc_w);
 137         I915_WRITE(SPCNTR(pipe, plane), sprctl);
 138         I915_MODIFY_DISPBASE(SPSURF(pipe, plane), i915_gem_obj_ggtt_offset(obj) +
 139                              sprsurf_offset);
 140         POSTING_READ(SPSURF(pipe, plane));
 141 }
 142
 143 static void
 144 vlv_disable_plane(struct drm_plane *dplane, struct drm_crtc *crtc)
 145 {
 146         struct drm_device *dev = dplane->dev;
 147         struct drm_i915_private *dev_priv = dev->dev_private;
 148         struct intel_plane *intel_plane = to_intel_plane(dplane);
 149         int pipe = intel_plane->pipe;
 150         int plane = intel_plane->plane;
 151
 152         I915_WRITE(SPCNTR(pipe, plane), I915_READ(SPCNTR(pipe, plane)) &
 153                    ~SP_ENABLE);
 154         /* Activate double buffered register update */
 155         I915_MODIFY_DISPBASE(SPSURF(pipe, plane), 0);
 156         POSTING_READ(SPSURF(pipe, plane));
 157
 158         intel_update_sprite_watermarks(dplane, crtc, 0, 0, false, false);
 159 }
 160
 161 static int
 162 vlv_update_colorkey(struct drm_plane *dplane,
 163                     struct drm_intel_sprite_colorkey *key)
 164 {
 165         struct drm_device *dev = dplane->dev;
 166         struct drm_i915_private *dev_priv = dev->dev_private;
 167         struct intel_plane *intel_plane = to_intel_plane(dplane);
 168         int pipe = intel_plane->pipe;
 169         int plane = intel_plane->plane;
 170         u32 sprctl;
 171
 172         if (key->flags & I915_SET_COLORKEY_DESTINATION)
 173                 return -EINVAL;
 174
 175         I915_WRITE(SPKEYMINVAL(pipe, plane), key->min_value);
 176         I915_WRITE(SPKEYMAXVAL(pipe, plane), key->max_value);
 177         I915_WRITE(SPKEYMSK(pipe, plane), key->channel_mask);
 178
 179         sprctl = I915_READ(SPCNTR(pipe, plane));
 180         sprctl &= ~SP_SOURCE_KEY;
 181         if (key->flags & I915_SET_COLORKEY_SOURCE)
 182                 sprctl |= SP_SOURCE_KEY;
 183         I915_WRITE(SPCNTR(pipe, plane), sprctl);
 184
 185         POSTING_READ(SPKEYMSK(pipe, plane));
 186
 187         return 0;
 188 }
 189
 190 static void
 191 vlv_get_colorkey(struct drm_plane *dplane,
 192                  struct drm_intel_sprite_colorkey *key)
 193 {
 194         struct drm_device *dev = dplane->dev;
 195         struct drm_i915_private *dev_priv = dev->dev_private;
 196         struct intel_plane *intel_plane = to_intel_plane(dplane);
 197         int pipe = intel_plane->pipe;
 198         int plane = intel_plane->plane;
 199         u32 sprctl;
 200
 201         key->min_value = I915_READ(SPKEYMINVAL(pipe, plane));
 202         key->max_value = I915_READ(SPKEYMAXVAL(pipe, plane));
 203         key->channel_mask = I915_READ(SPKEYMSK(pipe, plane));
 204
 205         sprctl = I915_READ(SPCNTR(pipe, plane));
 206         if (sprctl & SP_SOURCE_KEY)
 207                 key->flags = I915_SET_COLORKEY_SOURCE;
 208         else
 209                 key->flags = I915_SET_COLORKEY_NONE;
 210 }
 211
 212 static void
 213 ivb_update_plane(struct drm_plane *plane, struct drm_crtc *crtc,
 214                  struct drm_framebuffer *fb,
 215                  struct drm_i915_gem_object *obj, int crtc_x, int crtc_y,
 216                  unsigned int crtc_w, unsigned int crtc_h,
 217                  uint32_t x, uint32_t y,
 218                  uint32_t src_w, uint32_t src_h)
 219 {
 220         struct drm_device *dev = plane->dev;
 221         struct drm_i915_private *dev_priv = dev->dev_private;
 222         struct intel_plane *intel_plane = to_intel_plane(plane);
 223         int pipe = intel_plane->pipe;
 224         u32 sprctl, sprscale = 0;
 225         unsigned long sprsurf_offset, linear_offset;
 226         int pixel_size = drm_format_plane_cpp(fb->pixel_format, 0);
 227         bool scaling_was_enabled = dev_priv->sprite_scaling_enabled;
 228
 229         sprctl = I915_READ(SPRCTL(pipe));
 230
 231         /* Mask out pixel format bits in case we change it */
 232         sprctl &= ~SPRITE_PIXFORMAT_MASK;
 233         sprctl &= ~SPRITE_RGB_ORDER_RGBX;
 234         sprctl &= ~SPRITE_YUV_BYTE_ORDER_MASK;
 235         sprctl &= ~SPRITE_TILED;
 236
 237         switch (fb->pixel_format) {
 238         case DRM_FORMAT_XBGR8888:
 239                 sprctl |= SPRITE_FORMAT_RGBX888 | SPRITE_RGB_ORDER_RGBX;
 240                 break;
 241         case DRM_FORMAT_XRGB8888:
 242                 sprctl |= SPRITE_FORMAT_RGBX888;
 243                 break;
 244         case DRM_FORMAT_YUYV:
 245                 sprctl |= SPRITE_FORMAT_YUV422 | SPRITE_YUV_ORDER_YUYV;
 246                 break;
 247         case DRM_FORMAT_YVYU:
 248                 sprctl |= SPRITE_FORMAT_YUV422 | SPRITE_YUV_ORDER_YVYU;
 249                 break;
 250         case DRM_FORMAT_UYVY:
 251                 sprctl |= SPRITE_FORMAT_YUV422 | SPRITE_YUV_ORDER_UYVY;
 252                 break;
 253         case DRM_FORMAT_VYUY:
 254                 sprctl |= SPRITE_FORMAT_YUV422 | SPRITE_YUV_ORDER_VYUY;
 255                 break;
 256         default:
 257                 BUG();
 258         }
 259
 260         if (obj->tiling_mode != I915_TILING_NONE)
 261                 sprctl |= SPRITE_TILED;
 262
 263         if (IS_HASWELL(dev))
 264                 sprctl &= ~SPRITE_TRICKLE_FEED_DISABLE;
 265         else
 266                 sprctl |= SPRITE_TRICKLE_FEED_DISABLE;
 267
 268         sprctl |= SPRITE_ENABLE;
 269
 270         if (IS_HASWELL(dev))
 271                 sprctl |= SPRITE_PIPE_CSC_ENABLE;
 272
 273         intel_update_sprite_watermarks(plane, crtc, src_w, pixel_size, true,
 274                                        src_w != crtc_w || src_h != crtc_h);
 275
 276         /* Sizes are 0 based */
 277         src_w--;
 278         src_h--;
 279         crtc_w--;
 280         crtc_h--;
 281
 282         /*
 283          * IVB workaround: must disable low power watermarks for at least
 284          * one frame before enabling scaling.  LP watermarks can be re-enabled
 285          * when scaling is disabled.
 286          */
 287         if (crtc_w != src_w || crtc_h != src_h) {
 288                 dev_priv->sprite_scaling_enabled |= 1 << pipe;
 289
 290                 if (!scaling_was_enabled) {
 291                         intel_update_watermarks(crtc);
 292                         intel_wait_for_vblank(dev, pipe);
 293                 }
 294                 sprscale = SPRITE_SCALE_ENABLE | (src_w << 16) | src_h;
 295         } else
 296                 dev_priv->sprite_scaling_enabled &= ~(1 << pipe);
 297
 298         I915_WRITE(SPRSTRIDE(pipe), fb->pitches[0]);
 299         I915_WRITE(SPRPOS(pipe), (crtc_y << 16) | crtc_x);
 300
 301         linear_offset = y * fb->pitches[0] + x * pixel_size;
 302         sprsurf_offset =
 303                 intel_gen4_compute_page_offset(&x, &y, obj->tiling_mode,
 304                                                pixel_size, fb->pitches[0]);
 305         linear_offset -= sprsurf_offset;
 306
 307         /* HSW consolidates SPRTILEOFF and SPRLINOFF into a single SPROFFSET
 308          * register */
 309         if (IS_HASWELL(dev))
 310                 I915_WRITE(SPROFFSET(pipe), (y << 16) | x);
 311         else if (obj->tiling_mode != I915_TILING_NONE)
 312                 I915_WRITE(SPRTILEOFF(pipe), (y << 16) | x);
 313         else
 314                 I915_WRITE(SPRLINOFF(pipe), linear_offset);
 315
 316         I915_WRITE(SPRSIZE(pipe), (crtc_h << 16) | crtc_w);
 317         if (intel_plane->can_scale)
 318                 I915_WRITE(SPRSCALE(pipe), sprscale);
 319         I915_WRITE(SPRCTL(pipe), sprctl);
 320         I915_MODIFY_DISPBASE(SPRSURF(pipe),
 321                              i915_gem_obj_ggtt_offset(obj) + sprsurf_offset);
 322         POSTING_READ(SPRSURF(pipe));
 323
 324         /* potentially re-enable LP watermarks */
 325         if (scaling_was_enabled && !dev_priv->sprite_scaling_enabled)
 326                 intel_update_watermarks(crtc);
 327 }
 328
 329 static void
 330 ivb_disable_plane(struct drm_plane *plane, struct drm_crtc *crtc)
 331 {
 332         struct drm_device *dev = plane->dev;
 333         struct drm_i915_private *dev_priv = dev->dev_private;
 334         struct intel_plane *intel_plane = to_intel_plane(plane);
 335         int pipe = intel_plane->pipe;
 336         bool scaling_was_enabled = dev_priv->sprite_scaling_enabled;
 337
 338         I915_WRITE(SPRCTL(pipe), I915_READ(SPRCTL(pipe)) & ~SPRITE_ENABLE);
 339         /* Can't leave the scaler enabled... */
 340         if (intel_plane->can_scale)
 341                 I915_WRITE(SPRSCALE(pipe), 0);
 342         /* Activate double buffered register update */
 343         I915_MODIFY_DISPBASE(SPRSURF(pipe), 0);
 344         POSTING_READ(SPRSURF(pipe));
 345
 346         dev_priv->sprite_scaling_enabled &= ~(1 << pipe);
 347
 348         intel_update_sprite_watermarks(plane, crtc, 0, 0, false, false);
 349
 350         /* potentially re-enable LP watermarks */
 351         if (scaling_was_enabled && !dev_priv->sprite_scaling_enabled)
 352                 intel_update_watermarks(crtc);
 353 }
 354
 355 static int
 356 ivb_update_colorkey(struct drm_plane *plane,
 357                     struct drm_intel_sprite_colorkey *key)
 358 {
 359         struct drm_device *dev = plane->dev;
 360         struct drm_i915_private *dev_priv = dev->dev_private;
 361         struct intel_plane *intel_plane;
 362         u32 sprctl;
 363         int ret = 0;
 364
 365         intel_plane = to_intel_plane(plane);
 366
 367         I915_WRITE(SPRKEYVAL(intel_plane->pipe), key->min_value);
 368         I915_WRITE(SPRKEYMAX(intel_plane->pipe), key->max_value);
 369         I915_WRITE(SPRKEYMSK(intel_plane->pipe), key->channel_mask);
 370
 371         sprctl = I915_READ(SPRCTL(intel_plane->pipe));
 372         sprctl &= ~(SPRITE_SOURCE_KEY | SPRITE_DEST_KEY);
 373         if (key->flags & I915_SET_COLORKEY_DESTINATION)
 374                 sprctl |= SPRITE_DEST_KEY;
 375         else if (key->flags & I915_SET_COLORKEY_SOURCE)
 376                 sprctl |= SPRITE_SOURCE_KEY;
 377         I915_WRITE(SPRCTL(intel_plane->pipe), sprctl);
 378
 379         POSTING_READ(SPRKEYMSK(intel_plane->pipe));
 380
 381         return ret;
 382 }
 383
 384 static void
 385 ivb_get_colorkey(struct drm_plane *plane, struct drm_intel_sprite_colorkey *key)
 386 {
 387         struct drm_device *dev = plane->dev;
 388         struct drm_i915_private *dev_priv = dev->dev_private;
 389         struct intel_plane *intel_plane;
 390         u32 sprctl;
 391
 392         intel_plane = to_intel_plane(plane);
 393
 394         key->min_value = I915_READ(SPRKEYVAL(intel_plane->pipe));
 395         key->max_value = I915_READ(SPRKEYMAX(intel_plane->pipe));
 396         key->channel_mask = I915_READ(SPRKEYMSK(intel_plane->pipe));
 397         key->flags = 0;
 398
 399         sprctl = I915_READ(SPRCTL(intel_plane->pipe));
 400
 401         if (sprctl & SPRITE_DEST_KEY)
 402                 key->flags = I915_SET_COLORKEY_DESTINATION;
 403         else if (sprctl & SPRITE_SOURCE_KEY)
 404                 key->flags = I915_SET_COLORKEY_SOURCE;
 405         else
 406                 key->flags = I915_SET_COLORKEY_NONE;
 407 }
 408
 409 static void
 410 ilk_update_plane(struct drm_plane *plane, struct drm_crtc *crtc,
 411                  struct drm_framebuffer *fb,
 412                  struct drm_i915_gem_object *obj, int crtc_x, int crtc_y,
 413                  unsigned int crtc_w, unsigned int crtc_h,
 414                  uint32_t x, uint32_t y,
 415                  uint32_t src_w, uint32_t src_h)
 416 {
 417         struct drm_device *dev = plane->dev;
 418         struct drm_i915_private *dev_priv = dev->dev_private;
 419         struct intel_plane *intel_plane = to_intel_plane(plane);
 420         int pipe = intel_plane->pipe;
 421         unsigned long dvssurf_offset, linear_offset;
 422         u32 dvscntr, dvsscale;
 423         int pixel_size = drm_format_plane_cpp(fb->pixel_format, 0);
 424
 425         dvscntr = I915_READ(DVSCNTR(pipe));
 426
 427         /* Mask out pixel format bits in case we change it */
 428         dvscntr &= ~DVS_PIXFORMAT_MASK;
 429         dvscntr &= ~DVS_RGB_ORDER_XBGR;
 430         dvscntr &= ~DVS_YUV_BYTE_ORDER_MASK;
 431         dvscntr &= ~DVS_TILED;
 432
 433         switch (fb->pixel_format) {
 434         case DRM_FORMAT_XBGR8888:
 435                 dvscntr |= DVS_FORMAT_RGBX888 | DVS_RGB_ORDER_XBGR;
 436                 break;
 437         case DRM_FORMAT_XRGB8888:
 438                 dvscntr |= DVS_FORMAT_RGBX888;
 439                 break;
 440         case DRM_FORMAT_YUYV:
 441                 dvscntr |= DVS_FORMAT_YUV422 | DVS_YUV_ORDER_YUYV;
 442                 break;
 443         case DRM_FORMAT_YVYU:
 444                 dvscntr |= DVS_FORMAT_YUV422 | DVS_YUV_ORDER_YVYU;
 445                 break;
 446         case DRM_FORMAT_UYVY:
 447                 dvscntr |= DVS_FORMAT_YUV422 | DVS_YUV_ORDER_UYVY;
 448                 break;
 449         case DRM_FORMAT_VYUY:
 450                 dvscntr |= DVS_FORMAT_YUV422 | DVS_YUV_ORDER_VYUY;
 451                 break;
 452         default:
 453                 BUG();
 454         }
 455
 456         if (obj->tiling_mode != I915_TILING_NONE)
 457                 dvscntr |= DVS_TILED;
 458
 459         if (IS_GEN6(dev))
 460                 dvscntr |= DVS_TRICKLE_FEED_DISABLE; /* must disable */
 461         dvscntr |= DVS_ENABLE;
 462
 463         intel_update_sprite_watermarks(plane, crtc, src_w, pixel_size, true,
 464                                        src_w != crtc_w || src_h != crtc_h);
 465
 466         /* Sizes are 0 based */
 467         src_w--;
 468         src_h--;
 469         crtc_w--;
 470         crtc_h--;
 471
 472         dvsscale = 0;
 473         if (IS_GEN5(dev) || crtc_w != src_w || crtc_h != src_h)
 474                 dvsscale = DVS_SCALE_ENABLE | (src_w << 16) | src_h;
 475
 476         I915_WRITE(DVSSTRIDE(pipe), fb->pitches[0]);
 477         I915_WRITE(DVSPOS(pipe), (crtc_y << 16) | crtc_x);
 478
 479         linear_offset = y * fb->pitches[0] + x * pixel_size;
 480         dvssurf_offset =
 481                 intel_gen4_compute_page_offset(&x, &y, obj->tiling_mode,
 482                                                pixel_size, fb->pitches[0]);
 483         linear_offset -= dvssurf_offset;
 484
 485         if (obj->tiling_mode != I915_TILING_NONE)
 486                 I915_WRITE(DVSTILEOFF(pipe), (y << 16) | x);
 487         else
 488                 I915_WRITE(DVSLINOFF(pipe), linear_offset);
 489
 490         I915_WRITE(DVSSIZE(pipe), (crtc_h << 16) | crtc_w);
 491         I915_WRITE(DVSSCALE(pipe), dvsscale);
 492         I915_WRITE(DVSCNTR(pipe), dvscntr);
 493         I915_MODIFY_DISPBASE(DVSSURF(pipe),
 494                              i915_gem_obj_ggtt_offset(obj) + dvssurf_offset);
 495         POSTING_READ(DVSSURF(pipe));
 496 }
 497
 498 static void
 499 ilk_disable_plane(struct drm_plane *plane, struct drm_crtc *crtc)
 500 {
 501         struct drm_device *dev = plane->dev;
 502         struct drm_i915_private *dev_priv = dev->dev_private;
 503         struct intel_plane *intel_plane = to_intel_plane(plane);
 504         int pipe = intel_plane->pipe;
 505
 506         I915_WRITE(DVSCNTR(pipe), I915_READ(DVSCNTR(pipe)) & ~DVS_ENABLE);
 507         /* Disable the scaler */
 508         I915_WRITE(DVSSCALE(pipe), 0);
 509         /* Flush double buffered register updates */
 510         I915_MODIFY_DISPBASE(DVSSURF(pipe), 0);
 511         POSTING_READ(DVSSURF(pipe));
 512
 513         intel_update_sprite_watermarks(plane, crtc, 0, 0, false, false);
 514 }
 515
 516 static void
 517 intel_enable_primary(struct drm_crtc *crtc)
 518 {
 519         struct drm_device *dev = crtc->dev;
 520         struct drm_i915_private *dev_priv = dev->dev_private;
 521         struct intel_crtc *intel_crtc = to_intel_crtc(crtc);
 522         int reg = DSPCNTR(intel_crtc->plane);
 523
 524         if (!intel_crtc->primary_disabled)
 525                 return;
 526
 527         intel_crtc->primary_disabled = false;
 528
 529         I915_WRITE(reg, I915_READ(reg) | DISPLAY_PLANE_ENABLE);
 530
 531         /*
 532          * FIXME IPS should be fine as long as one plane is
 533          * enabled, but in practice it seems to have problems
 534          * when going from primary only to sprite only and vice
 535          * versa.
 536          */
 537         if (intel_crtc->config.ips_enabled) {
 538                 intel_wait_for_vblank(dev, intel_crtc->pipe);
 539                 hsw_enable_ips(intel_crtc);
 540         }
 541
 542         mutex_lock(&dev->struct_mutex);
 543         intel_update_fbc(dev);
 544         mutex_unlock(&dev->struct_mutex);
 545 }
 546
 547 static void
 548 intel_disable_primary(struct drm_crtc *crtc)
 549 {
 550         struct drm_device *dev = crtc->dev;
 551         struct drm_i915_private *dev_priv = dev->dev_private;
 552         struct intel_crtc *intel_crtc = to_intel_crtc(crtc);
 553         int reg = DSPCNTR(intel_crtc->plane);
 554
 555         if (intel_crtc->primary_disabled)
 556                 return;
 557
 558         intel_crtc->primary_disabled = true;
 559
 560         mutex_lock(&dev->struct_mutex);
 561         if (dev_priv->fbc.plane == intel_crtc->plane)
 562                 intel_disable_fbc(dev);
 563         mutex_unlock(&dev->struct_mutex);
 564
 565         /*
 566          * FIXME IPS should be fine as long as one plane is
 567          * enabled, but in practice it seems to have problems
 568          * when going from primary only to sprite only and vice
 569          * versa.
 570          */
 571         hsw_disable_ips(intel_crtc);
 572
 573         I915_WRITE(reg, I915_READ(reg) & ~DISPLAY_PLANE_ENABLE);
 574 }
 575
 576 static int
 577 ilk_update_colorkey(struct drm_plane *plane,
 578                     struct drm_intel_sprite_colorkey *key)
 579 {
 580         struct drm_device *dev = plane->dev;
 581         struct drm_i915_private *dev_priv = dev->dev_private;
 582         struct intel_plane *intel_plane;
 583         u32 dvscntr;
 584         int ret = 0;
 585
 586         intel_plane = to_intel_plane(plane);
 587
 588         I915_WRITE(DVSKEYVAL(intel_plane->pipe), key->min_value);
 589         I915_WRITE(DVSKEYMAX(intel_plane->pipe), key->max_value);
 590         I915_WRITE(DVSKEYMSK(intel_plane->pipe), key->channel_mask);
 591
 592         dvscntr = I915_READ(DVSCNTR(intel_plane->pipe));
 593         dvscntr &= ~(DVS_SOURCE_KEY | DVS_DEST_KEY);
 594         if (key->flags & I915_SET_COLORKEY_DESTINATION)
 595                 dvscntr |= DVS_DEST_KEY;
 596         else if (key->flags & I915_SET_COLORKEY_SOURCE)
 597                 dvscntr |= DVS_SOURCE_KEY;
 598         I915_WRITE(DVSCNTR(intel_plane->pipe), dvscntr);
 599
 600         POSTING_READ(DVSKEYMSK(intel_plane->pipe));
 601
 602         return ret;
 603 }
 604
 605 static void
 606 ilk_get_colorkey(struct drm_plane *plane, struct drm_intel_sprite_colorkey *key)
 607 {
 608         struct drm_device *dev = plane->dev;
 609         struct drm_i915_private *dev_priv = dev->dev_private;
 610         struct intel_plane *intel_plane;
 611         u32 dvscntr;
 612
 613         intel_plane = to_intel_plane(plane);
 614
 615         key->min_value = I915_READ(DVSKEYVAL(intel_plane->pipe));
 616         key->max_value = I915_READ(DVSKEYMAX(intel_plane->pipe));
 617         key->channel_mask = I915_READ(DVSKEYMSK(intel_plane->pipe));
 618         key->flags = 0;
 619
 620         dvscntr = I915_READ(DVSCNTR(intel_plane->pipe));
 621
 622         if (dvscntr & DVS_DEST_KEY)
 623                 key->flags = I915_SET_COLORKEY_DESTINATION;
 624         else if (dvscntr & DVS_SOURCE_KEY)
 625                 key->flags = I915_SET_COLORKEY_SOURCE;
 626         else
 627                 key->flags = I915_SET_COLORKEY_NONE;
 628 }
 629
 630 static bool
 631 format_is_yuv(uint32_t format)
 632 {
 633         switch (format) {
 634         case DRM_FORMAT_YUYV:
 635         case DRM_FORMAT_UYVY:
 636         case DRM_FORMAT_VYUY:
 637         case DRM_FORMAT_YVYU:
 638                 return true;
 639         default:
 640                 return false;
 641         }
 642 }
 643
 644 static int
 645 intel_update_plane(struct drm_plane *plane, struct drm_crtc *crtc,
 646                    struct drm_framebuffer *fb, int crtc_x, int crtc_y,
 647                    unsigned int crtc_w, unsigned int crtc_h,
 648                    uint32_t src_x, uint32_t src_y,
 649                    uint32_t src_w, uint32_t src_h)
 650 {
 651         struct drm_device *dev = plane->dev;
 652         struct intel_crtc *intel_crtc = to_intel_crtc(crtc);
 653         struct intel_plane *intel_plane = to_intel_plane(plane);
 654         struct intel_framebuffer *intel_fb = to_intel_framebuffer(fb);
 655         struct drm_i915_gem_object *obj = intel_fb->obj;
 656         struct drm_i915_gem_object *old_obj = intel_plane->obj;
 657         int ret;
 658         bool disable_primary = false;
 659         bool visible;
 660         int hscale, vscale;
 661         int max_scale, min_scale;
 662         int pixel_size = drm_format_plane_cpp(fb->pixel_format, 0);
 663         struct drm_rect src = {
 664                 /* sample coordinates in 16.16 fixed point */
 665                 .x1 = src_x,
 666                 .x2 = src_x + src_w,
 667                 .y1 = src_y,
 668                 .y2 = src_y + src_h,
 669         };
 670         struct drm_rect dst = {
 671                 /* integer pixels */
 672                 .x1 = crtc_x,
 673                 .x2 = crtc_x + crtc_w,
 674                 .y1 = crtc_y,
 675                 .y2 = crtc_y + crtc_h,
 676         };
 677         const struct drm_rect clip = {
 678                 .x2 = intel_crtc->active ? intel_crtc->config.pipe_src_w : 0,
 679                 .y2 = intel_crtc->active ? intel_crtc->config.pipe_src_h : 0,
 680         };
 681         const struct {
 682                 int crtc_x, crtc_y;
 683                 unsigned int crtc_w, crtc_h;
 684                 uint32_t src_x, src_y, src_w, src_h;
 685         } orig = {
 686                 .crtc_x = crtc_x,
 687                 .crtc_y = crtc_y,
 688                 .crtc_w = crtc_w,
 689                 .crtc_h = crtc_h,
 690                 .src_x = src_x,
 691                 .src_y = src_y,
 692                 .src_w = src_w,
 693                 .src_h = src_h,
 694         };
 695
 696         /* Don't modify another pipe's plane */
 697         if (intel_plane->pipe != intel_crtc->pipe) {
 698                 DRM_DEBUG_KMS("Wrong plane <-> crtc mapping\n");
 699                 return -EINVAL;
 700         }
 701
 702         /* FIXME check all gen limits */
 703         if (fb->width < 3 || fb->height < 3 || fb->pitches[0] > 16384) {
 704                 DRM_DEBUG_KMS("Unsuitable framebuffer for plane\n");
 705                 return -EINVAL;
 706         }
 707
 708         /* Sprite planes can be linear or x-tiled surfaces */
 709         switch (obj->tiling_mode) {
 710                 case I915_TILING_NONE:
 711                 case I915_TILING_X:
 712                         break;
 713                 default:
 714                         DRM_DEBUG_KMS("Unsupported tiling mode\n");
 715                         return -EINVAL;
 716         }
 717
 718         /*
 719          * FIXME the following code does a bunch of fuzzy adjustments to the
 720          * coordinates and sizes. We probably need some way to decide whether
 721          * more strict checking should be done instead.
 722          */
 723         max_scale = intel_plane->max_downscale << 16;
 724         min_scale = intel_plane->can_scale ? 1 : (1 << 16);
 725
 726         hscale = drm_rect_calc_hscale_relaxed(&src, &dst, min_scale, max_scale);
 727         BUG_ON(hscale < 0);
 728
 729         vscale = drm_rect_calc_vscale_relaxed(&src, &dst, min_scale, max_scale);
 730         BUG_ON(vscale < 0);
 731
 732         visible = drm_rect_clip_scaled(&src, &dst, &clip, hscale, vscale);
 733
 734         crtc_x = dst.x1;
 735         crtc_y = dst.y1;
 736         crtc_w = drm_rect_width(&dst);
 737         crtc_h = drm_rect_height(&dst);
 738
 739         if (visible) {
 740                 /* check again in case clipping clamped the results */
 741                 hscale = drm_rect_calc_hscale(&src, &dst, min_scale, max_scale);
 742                 if (hscale < 0) {
 743                         DRM_DEBUG_KMS("Horizontal scaling factor out of limits\n");
 744                         drm_rect_debug_print(&src, true);
 745                         drm_rect_debug_print(&dst, false);
 746
 747                         return hscale;
 748                 }
 749
 750                 vscale = drm_rect_calc_vscale(&src, &dst, min_scale, max_scale);
 751                 if (vscale < 0) {
 752                         DRM_DEBUG_KMS("Vertical scaling factor out of limits\n");
 753                         drm_rect_debug_print(&src, true);
 754                         drm_rect_debug_print(&dst, false);
 755
 756                         return vscale;
 757                 }
 758
 759                 /* Make the source viewport size an exact multiple of the scaling factors. */
 760                 drm_rect_adjust_size(&src,
 761                                      drm_rect_width(&dst) * hscale - drm_rect_width(&src),
 762                                      drm_rect_height(&dst) * vscale - drm_rect_height(&src));
 763
 764                 /* sanity check to make sure the src viewport wasn't enlarged */
 765                 WARN_ON(src.x1 < (int) src_x ||
 766                         src.y1 < (int) src_y ||
 767                         src.x2 > (int) (src_x + src_w) ||
 768                         src.y2 > (int) (src_y + src_h));
 769
 770                 /*
 771                  * Hardware doesn't handle subpixel coordinates.
 772                  * Adjust to (macro)pixel boundary, but be careful not to
 773                  * increase the source viewport size, because that could
 774                  * push the downscaling factor out of bounds.
 775                  */
 776                 src_x = src.x1 >> 16;
 777                 src_w = drm_rect_width(&src) >> 16;
 778                 src_y = src.y1 >> 16;
 779                 src_h = drm_rect_height(&src) >> 16;
 780
 781                 if (format_is_yuv(fb->pixel_format)) {
 782                         src_x &= ~1;
 783                         src_w &= ~1;
 784
 785                         /*
 786                          * Must keep src and dst the
 787                          * same if we can't scale.
 788                          */
 789                         if (!intel_plane->can_scale)
 790                                 crtc_w &= ~1;
 791
 792                         if (crtc_w == 0)
 793                                 visible = false;
 794                 }
 795         }
 796
 797         /* Check size restrictions when scaling */
 798         if (visible && (src_w != crtc_w || src_h != crtc_h)) {
 799                 unsigned int width_bytes;
 800
 801                 WARN_ON(!intel_plane->can_scale);
 802
 803                 /* FIXME interlacing min height is 6 */
 804
 805                 if (crtc_w < 3 || crtc_h < 3)
 806                         visible = false;
 807
 808                 if (src_w < 3 || src_h < 3)
 809                         visible = false;
 810
 811                 width_bytes = ((src_x * pixel_size) & 63) + src_w * pixel_size;
 812
 813                 if (src_w > 2048 || src_h > 2048 ||
 814                     width_bytes > 4096 || fb->pitches[0] > 4096) {
 815                         DRM_DEBUG_KMS("Source dimensions exceed hardware limits\n");
 816                         return -EINVAL;
 817                 }
 818         }
 819
 820         dst.x1 = crtc_x;
 821         dst.x2 = crtc_x + crtc_w;
 822         dst.y1 = crtc_y;
 823         dst.y2 = crtc_y + crtc_h;
 824
 825         /*
 826          * If the sprite is completely covering the primary plane,
 827          * we can disable the primary and save power.
 828          */
 829         disable_primary = drm_rect_equals(&dst, &clip);
 830         WARN_ON(disable_primary && !visible && intel_crtc->active);
 831
 832         mutex_lock(&dev->struct_mutex);
 833
 834         /* Note that this will apply the VT-d workaround for scanouts,
 835          * which is more restrictive than required for sprites. (The
 836          * primary plane requires 256KiB alignment with 64 PTE padding,
 837          * the sprite planes only require 128KiB alignment and 32 PTE padding.
 838          */
 839         ret = intel_pin_and_fence_fb_obj(dev, obj, NULL);
 840
 841         mutex_unlock(&dev->struct_mutex);
 842
 843         if (ret)
 844                 return ret;
 845
 846         intel_plane->crtc_x = orig.crtc_x;
 847         intel_plane->crtc_y = orig.crtc_y;
 848         intel_plane->crtc_w = orig.crtc_w;
 849         intel_plane->crtc_h = orig.crtc_h;
 850         intel_plane->src_x = orig.src_x;
 851         intel_plane->src_y = orig.src_y;
 852         intel_plane->src_w = orig.src_w;
 853         intel_plane->src_h = orig.src_h;
 854         intel_plane->obj = obj;
 855
 856         if (intel_crtc->active) {
 857                 /*
 858                  * Be sure to re-enable the primary before the sprite is no longer
 859                  * covering it fully.
 860                  */
 861                 if (!disable_primary)
 862                         intel_enable_primary(crtc);
 863
 864                 if (visible)
 865                         intel_plane->update_plane(plane, crtc, fb, obj,
 866                                                   crtc_x, crtc_y, crtc_w, crtc_h,
 867                                                   src_x, src_y, src_w, src_h);
 868                 else
 869                         intel_plane->disable_plane(plane, crtc);
 870
 871                 if (disable_primary)
 872                         intel_disable_primary(crtc);
 873         }
 874
 875         /* Unpin old obj after new one is active to avoid ugliness */
 876         if (old_obj) {
 877                 /*
 878                  * It's fairly common to simply update the position of
 879                  * an existing object.  In that case, we don't need to
 880                  * wait for vblank to avoid ugliness, we only need to
 881                  * do the pin & ref bookkeeping.
 882                  */
 883                 if (old_obj != obj && intel_crtc->active)
 884                         intel_wait_for_vblank(dev, intel_crtc->pipe);
 885
 886                 mutex_lock(&dev->struct_mutex);
 887                 intel_unpin_fb_obj(old_obj);
 888                 mutex_unlock(&dev->struct_mutex);
 889         }
 890
 891         return 0;
 892 }
 893
 894 static int
 895 intel_disable_plane(struct drm_plane *plane)
 896 {
 897         struct drm_device *dev = plane->dev;
 898         struct intel_plane *intel_plane = to_intel_plane(plane);
 899         struct intel_crtc *intel_crtc;
 900
 901         if (!plane->fb)
 902                 return 0;
 903
 904         if (WARN_ON(!plane->crtc))
 905                 return -EINVAL;
 906
 907         intel_crtc = to_intel_crtc(plane->crtc);
 908
 909         if (intel_crtc->active) {
 910                 intel_enable_primary(plane->crtc);
 911                 intel_plane->disable_plane(plane, plane->crtc);
 912         }
 913
 914         if (intel_plane->obj) {
 915                 if (intel_crtc->active)
 916                         intel_wait_for_vblank(dev, intel_plane->pipe);
 917
 918                 mutex_lock(&dev->struct_mutex);
 919                 intel_unpin_fb_obj(intel_plane->obj);
 920                 mutex_unlock(&dev->struct_mutex);
 921
 922                 intel_plane->obj = NULL;
 923         }
 924
 925         return 0;
 926 }
 927
 928 static void intel_destroy_plane(struct drm_plane *plane)
 929 {
 930         struct intel_plane *intel_plane = to_intel_plane(plane);
 931         intel_disable_plane(plane);
 932         drm_plane_cleanup(plane);
 933         kfree(intel_plane);
 934 }
 935
 936 int intel_sprite_set_colorkey(struct drm_device *dev, void *data,
 937                               struct drm_file *file_priv)
 938 {
 939         struct drm_intel_sprite_colorkey *set = data;
 940         struct drm_mode_object *obj;
 941         struct drm_plane *plane;
 942         struct intel_plane *intel_plane;
 943         int ret = 0;
 944
 945         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 946                 return -ENODEV;
 947
 948         /* Make sure we don't try to enable both src & dest simultaneously */
 949         if ((set->flags & (I915_SET_COLORKEY_DESTINATION | I915_SET_COLORKEY_SOURCE)) == (I915_SET_COLORKEY_DESTINATION | I915_SET_COLORKEY_SOURCE))
 950                 return -EINVAL;
 951
 952         drm_modeset_lock_all(dev);
 953
 954         obj = drm_mode_object_find(dev, set->plane_id, DRM_MODE_OBJECT_PLANE);
 955         if (!obj) {
 956                 ret = -EINVAL;
 957                 goto out_unlock;
 958         }
 959
 960         plane = obj_to_plane(obj);
 961         intel_plane = to_intel_plane(plane);
 962         ret = intel_plane->update_colorkey(plane, set);
 963
 964 out_unlock:
 965         drm_modeset_unlock_all(dev);
 966         return ret;
 967 }
 968
 969 int intel_sprite_get_colorkey(struct drm_device *dev, void *data,
 970                               struct drm_file *file_priv)
 971 {
 972         struct drm_intel_sprite_colorkey *get = data;
 973         struct drm_mode_object *obj;
 974         struct drm_plane *plane;
 975         struct intel_plane *intel_plane;
 976         int ret = 0;
 977
 978         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 979                 return -ENODEV;
 980
 981         drm_modeset_lock_all(dev);
 982
 983         obj = drm_mode_object_find(dev, get->plane_id, DRM_MODE_OBJECT_PLANE);
 984         if (!obj) {
 985                 ret = -EINVAL;
 986                 goto out_unlock;
 987         }
 988
 989         plane = obj_to_plane(obj);
 990         intel_plane = to_intel_plane(plane);
 991         intel_plane->get_colorkey(plane, get);
 992
 993 out_unlock:
 994         drm_modeset_unlock_all(dev);
 995         return ret;
 996 }
 997
 998 void intel_plane_restore(struct drm_plane *plane)
 999 {
1000         struct intel_plane *intel_plane = to_intel_plane(plane);
1001
1002         if (!plane->crtc || !plane->fb)
1003                 return;
1004
1005         intel_update_plane(plane, plane->crtc, plane->fb,
1006                            intel_plane->crtc_x, intel_plane->crtc_y,
1007                            intel_plane->crtc_w, intel_plane->crtc_h,
1008                            intel_plane->src_x, intel_plane->src_y,
1009                            intel_plane->src_w, intel_plane->src_h);
1010 }
1011
1012 void intel_plane_disable(struct drm_plane *plane)
1013 {
1014         if (!plane->crtc || !plane->fb)
1015                 return;
1016
1017         intel_disable_plane(plane);
1018 }
1019
1020 static const struct drm_plane_funcs intel_plane_funcs = {
1021         .update_plane = intel_update_plane,
1022         .disable_plane = intel_disable_plane,
1023         .destroy = intel_destroy_plane,
1024 };
1025
1026 static uint32_t ilk_plane_formats[] = {
1027         DRM_FORMAT_XRGB8888,
1028         DRM_FORMAT_YUYV,
1029         DRM_FORMAT_YVYU,
1030         DRM_FORMAT_UYVY,
1031         DRM_FORMAT_VYUY,
1032 };
1033
1034 static uint32_t snb_plane_formats[] = {
1035         DRM_FORMAT_XBGR8888,
1036         DRM_FORMAT_XRGB8888,
1037         DRM_FORMAT_YUYV,
1038         DRM_FORMAT_YVYU,
1039         DRM_FORMAT_UYVY,
1040         DRM_FORMAT_VYUY,
1041 };
1042
1043 static uint32_t vlv_plane_formats[] = {
1044         DRM_FORMAT_RGB565,
1045         DRM_FORMAT_ABGR8888,
1046         DRM_FORMAT_ARGB8888,
1047         DRM_FORMAT_XBGR8888,
1048         DRM_FORMAT_XRGB8888,
1049         DRM_FORMAT_XBGR2101010,
1050         DRM_FORMAT_ABGR2101010,
1051         DRM_FORMAT_YUYV,
1052         DRM_FORMAT_YVYU,
1053         DRM_FORMAT_UYVY,
1054         DRM_FORMAT_VYUY,
1055 };
1056
1057 int
1058 intel_plane_init(struct drm_device *dev, enum pipe pipe, int plane)
1059 {
1060         struct intel_plane *intel_plane;
1061         unsigned long possible_crtcs;
1062         const uint32_t *plane_formats;
1063         int num_plane_formats;
1064         int ret;
1065
1066         if (INTEL_INFO(dev)->gen < 5)
1067                 return -ENODEV;
1068
1069         intel_plane = kzalloc(sizeof(*intel_plane), GFP_KERNEL);
1070         if (!intel_plane)
1071                 return -ENOMEM;
1072
1073         switch (INTEL_INFO(dev)->gen) {
1074         case 5:
1075         case 6:
1076                 intel_plane->can_scale = true;
1077                 intel_plane->max_downscale = 16;
1078                 intel_plane->update_plane = ilk_update_plane;
1079                 intel_plane->disable_plane = ilk_disable_plane;
1080                 intel_plane->update_colorkey = ilk_update_colorkey;
1081                 intel_plane->get_colorkey = ilk_get_colorkey;
1082
1083                 if (IS_GEN6(dev)) {
1084                         plane_formats = snb_plane_formats;
1085                         num_plane_formats = ARRAY_SIZE(snb_plane_formats);
1086                 } else {
1087                         plane_formats = ilk_plane_formats;
1088                         num_plane_formats = ARRAY_SIZE(ilk_plane_formats);
1089                 }
1090                 break;
1091
1092         case 7:
1093                 if (IS_IVYBRIDGE(dev)) {
1094                         intel_plane->can_scale = true;
1095                         intel_plane->max_downscale = 2;
1096                 } else {
1097                         intel_plane->can_scale = false;
1098                         intel_plane->max_downscale = 1;
1099                 }
1100
1101                 if (IS_VALLEYVIEW(dev)) {
1102                         intel_plane->update_plane = vlv_update_plane;
1103                         intel_plane->disable_plane = vlv_disable_plane;
1104                         intel_plane->update_colorkey = vlv_update_colorkey;
1105                         intel_plane->get_colorkey = vlv_get_colorkey;
1106
1107                         plane_formats = vlv_plane_formats;
1108                         num_plane_formats = ARRAY_SIZE(vlv_plane_formats);
1109                 } else {
1110                         intel_plane->update_plane = ivb_update_plane;
1111                         intel_plane->disable_plane = ivb_disable_plane;
1112                         intel_plane->update_colorkey = ivb_update_colorkey;
1113                         intel_plane->get_colorkey = ivb_get_colorkey;
1114
1115                         plane_formats = snb_plane_formats;
1116                         num_plane_formats = ARRAY_SIZE(snb_plane_formats);
1117                 }
1118                 break;
1119
1120         default:
1121                 kfree(intel_plane);
1122                 return -ENODEV;
1123         }
1124
1125         intel_plane->pipe = pipe;
1126         intel_plane->plane = plane;
1127         possible_crtcs = (1 << pipe);
1128         ret = drm_plane_init(dev, &intel_plane->base, possible_crtcs,
1129                              &intel_plane_funcs,
1130                              plane_formats, num_plane_formats,
1131                              false);
1132         if (ret)
1133                 kfree(intel_plane);
1134
1135         return ret;
1136 }