drivers/gpu/drm/i915/i915_gem_tiling.c

   1 /*
   2  * Copyright © 2008 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
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *    Eric Anholt <eric@anholt.net>
  25  *
  26  */
  27
  28 #include "linux/string.h"
  29 #include "linux/bitops.h"
  30 #include "drmP.h"
  31 #include "drm.h"
  32 #include "i915_drm.h"
  33 #include "i915_drv.h"
  34
  35 /** @file i915_gem_tiling.c
  36  *
  37  * Support for managing tiling state of buffer objects.
  38  *
  39  * The idea behind tiling is to increase cache hit rates by rearranging
  40  * pixel data so that a group of pixel accesses are in the same cacheline.
  41  * Performance improvement from doing this on the back/depth buffer are on
  42  * the order of 30%.
  43  *
  44  * Intel architectures make this somewhat more complicated, though, by
  45  * adjustments made to addressing of data when the memory is in interleaved
  46  * mode (matched pairs of DIMMS) to improve memory bandwidth.
  47  * For interleaved memory, the CPU sends every sequential 64 bytes
  48  * to an alternate memory channel so it can get the bandwidth from both.
  49  *
  50  * The GPU also rearranges its accesses for increased bandwidth to interleaved
  51  * memory, and it matches what the CPU does for non-tiled.  However, when tiled
  52  * it does it a little differently, since one walks addresses not just in the
  53  * X direction but also Y.  So, along with alternating channels when bit
  54  * 6 of the address flips, it also alternates when other bits flip --  Bits 9
  55  * (every 512 bytes, an X tile scanline) and 10 (every two X tile scanlines)
  56  * are common to both the 915 and 965-class hardware.
  57  *
  58  * The CPU also sometimes XORs in higher bits as well, to improve
  59  * bandwidth doing strided access like we do so frequently in graphics.  This
  60  * is called "Channel XOR Randomization" in the MCH documentation.  The result
  61  * is that the CPU is XORing in either bit 11 or bit 17 to bit 6 of its address
  62  * decode.
  63  *
  64  * All of this bit 6 XORing has an effect on our memory management,
  65  * as we need to make sure that the 3d driver can correctly address object
  66  * contents.
  67  *
  68  * If we don't have interleaved memory, all tiling is safe and no swizzling is
  69  * required.
  70  *
  71  * When bit 17 is XORed in, we simply refuse to tile at all.  Bit
  72  * 17 is not just a page offset, so as we page an objet out and back in,
  73  * individual pages in it will have different bit 17 addresses, resulting in
  74  * each 64 bytes being swapped with its neighbor!
  75  *
  76  * Otherwise, if interleaved, we have to tell the 3d driver what the address
  77  * swizzling it needs to do is, since it's writing with the CPU to the pages
  78  * (bit 6 and potentially bit 11 XORed in), and the GPU is reading from the
  79  * pages (bit 6, 9, and 10 XORed in), resulting in a cumulative bit swizzling
  80  * required by the CPU of XORing in bit 6, 9, 10, and potentially 11, in order
  81  * to match what the GPU expects.
  82  */
  83
  84 /**
  85  * Detects bit 6 swizzling of address lookup between IGD access and CPU
  86  * access through main memory.
  87  */
  88 void
  89 i915_gem_detect_bit_6_swizzle(struct drm_device *dev)
  90 {
  91         drm_i915_private_t *dev_priv = dev->dev_private;
  92         uint32_t swizzle_x = I915_BIT_6_SWIZZLE_UNKNOWN;
  93         uint32_t swizzle_y = I915_BIT_6_SWIZZLE_UNKNOWN;
  94
  95         if (!IS_I9XX(dev)) {
  96                 /* As far as we know, the 865 doesn't have these bit 6
  97                  * swizzling issues.
  98                  */
  99                 swizzle_x = I915_BIT_6_SWIZZLE_NONE;
 100                 swizzle_y = I915_BIT_6_SWIZZLE_NONE;
 101         } else if (IS_MOBILE(dev)) {
 102                 uint32_t dcc;
 103
 104                 /* On mobile 9xx chipsets, channel interleave by the CPU is
 105                  * determined by DCC.  For single-channel, neither the CPU
 106                  * nor the GPU do swizzling.  For dual channel interleaved,
 107                  * the GPU's interleave is bit 9 and 10 for X tiled, and bit
 108                  * 9 for Y tiled.  The CPU's interleave is independent, and
 109                  * can be based on either bit 11 (haven't seen this yet) or
 110                  * bit 17 (common).
 111                  */
 112                 dcc = I915_READ(DCC);
 113                 switch (dcc & DCC_ADDRESSING_MODE_MASK) {
 114                 case DCC_ADDRESSING_MODE_SINGLE_CHANNEL:
 115                 case DCC_ADDRESSING_MODE_DUAL_CHANNEL_ASYMMETRIC:
 116                         swizzle_x = I915_BIT_6_SWIZZLE_NONE;
 117                         swizzle_y = I915_BIT_6_SWIZZLE_NONE;
 118                         break;
 119                 case DCC_ADDRESSING_MODE_DUAL_CHANNEL_INTERLEAVED:
 120                         if (dcc & DCC_CHANNEL_XOR_DISABLE) {
 121                                 /* This is the base swizzling by the GPU for
 122                                  * tiled buffers.
 123                                  */
 124                                 swizzle_x = I915_BIT_6_SWIZZLE_9_10;
 125                                 swizzle_y = I915_BIT_6_SWIZZLE_9;
 126                         } else if ((dcc & DCC_CHANNEL_XOR_BIT_17) == 0) {
 127                                 /* Bit 11 swizzling by the CPU in addition. */
 128                                 swizzle_x = I915_BIT_6_SWIZZLE_9_10_11;
 129                                 swizzle_y = I915_BIT_6_SWIZZLE_9_11;
 130                         } else {
 131                                 /* Bit 17 swizzling by the CPU in addition. */
 132                                 swizzle_x = I915_BIT_6_SWIZZLE_9_10_17;
 133                                 swizzle_y = I915_BIT_6_SWIZZLE_9_17;
 134                         }
 135                         break;
 136                 }
 137                 if (dcc == 0xffffffff) {
 138                         DRM_ERROR("Couldn't read from MCHBAR.  "
 139                                   "Disabling tiling.\n");
 140                         swizzle_x = I915_BIT_6_SWIZZLE_UNKNOWN;
 141                         swizzle_y = I915_BIT_6_SWIZZLE_UNKNOWN;
 142                 }
 143         } else {
 144                 /* The 965, G33, and newer, have a very flexible memory
 145                  * configuration.  It will enable dual-channel mode
 146                  * (interleaving) on as much memory as it can, and the GPU
 147                  * will additionally sometimes enable different bit 6
 148                  * swizzling for tiled objects from the CPU.
 149                  *
 150                  * Here's what I found on the G965:
 151                  *    slot fill         memory size  swizzling
 152                  * 0A   0B   1A   1B    1-ch   2-ch
 153                  * 512  0    0    0     512    0     O
 154                  * 512  0    512  0     16     1008  X
 155                  * 512  0    0    512   16     1008  X
 156                  * 0    512  0    512   16     1008  X
 157                  * 1024 1024 1024 0     2048   1024  O
 158                  *
 159                  * We could probably detect this based on either the DRB
 160                  * matching, which was the case for the swizzling required in
 161                  * the table above, or from the 1-ch value being less than
 162                  * the minimum size of a rank.
 163                  */
 164                 if (I915_READ16(C0DRB3) != I915_READ16(C1DRB3)) {
 165                         swizzle_x = I915_BIT_6_SWIZZLE_NONE;
 166                         swizzle_y = I915_BIT_6_SWIZZLE_NONE;
 167                 } else {
 168                         swizzle_x = I915_BIT_6_SWIZZLE_9_10;
 169                         swizzle_y = I915_BIT_6_SWIZZLE_9;
 170                 }
 171         }
 172
 173         dev_priv->mm.bit_6_swizzle_x = swizzle_x;
 174         dev_priv->mm.bit_6_swizzle_y = swizzle_y;
 175 }
 176
 177
 178 /**
 179  * Returns the size of the fence for a tiled object of the given size.
 180  */
 181 static int
 182 i915_get_fence_size(struct drm_device *dev, int size)
 183 {
 184         int i;
 185         int start;
 186
 187         if (IS_I965G(dev)) {
 188                 /* The 965 can have fences at any page boundary. */
 189                 return ALIGN(size, 4096);
 190         } else {
 191                 /* Align the size to a power of two greater than the smallest
 192                  * fence size.
 193                  */
 194                 if (IS_I9XX(dev))
 195                         start = 1024 * 1024;
 196                 else
 197                         start = 512 * 1024;
 198
 199                 for (i = start; i < size; i <<= 1)
 200                         ;
 201
 202                 return i;
 203         }
 204 }
 205
 206 /* Check pitch constriants for all chips & tiling formats */
 207 static bool
 208 i915_tiling_ok(struct drm_device *dev, int stride, int size, int tiling_mode)
 209 {
 210         int tile_width;
 211
 212         /* Linear is always fine */
 213         if (tiling_mode == I915_TILING_NONE)
 214                 return true;
 215
 216         if (tiling_mode == I915_TILING_Y && HAS_128_BYTE_Y_TILING(dev))
 217                 tile_width = 128;
 218         else
 219                 tile_width = 512;
 220
 221         /* check maximum stride & object size */
 222         if (IS_I965G(dev)) {
 223                 /* i965 stores the end address of the gtt mapping in the fence
 224                  * reg, so dont bother to check the size */
 225                 if (stride / 128 > I965_FENCE_MAX_PITCH_VAL)
 226                         return false;
 227         } else if (IS_I9XX(dev)) {
 228                 if (stride / tile_width > I830_FENCE_MAX_PITCH_VAL ||
 229                     size > (I830_FENCE_MAX_SIZE_VAL << 20))
 230                         return false;
 231         } else {
 232                 if (stride / 128 > I830_FENCE_MAX_PITCH_VAL ||
 233                     size > (I830_FENCE_MAX_SIZE_VAL << 19))
 234                         return false;
 235         }
 236
 237         /* 965+ just needs multiples of tile width */
 238         if (IS_I965G(dev)) {
 239                 if (stride & (tile_width - 1))
 240                         return false;
 241                 return true;
 242         }
 243
 244         /* Pre-965 needs power of two tile widths */
 245         if (stride < tile_width)
 246                 return false;
 247
 248         if (stride & (stride - 1))
 249                 return false;
 250
 251         /* We don't handle the aperture area covered by the fence being bigger
 252          * than the object size.
 253          */
 254         if (i915_get_fence_size(dev, size) != size)
 255                 return false;
 256
 257         return true;
 258 }
 259
 260 /**
 261  * Sets the tiling mode of an object, returning the required swizzling of
 262  * bit 6 of addresses in the object.
 263  */
 264 int
 265 i915_gem_set_tiling(struct drm_device *dev, void *data,
 266                    struct drm_file *file_priv)
 267 {
 268         struct drm_i915_gem_set_tiling *args = data;
 269         drm_i915_private_t *dev_priv = dev->dev_private;
 270         struct drm_gem_object *obj;
 271         struct drm_i915_gem_object *obj_priv;
 272
 273         obj = drm_gem_object_lookup(dev, file_priv, args->handle);
 274         if (obj == NULL)
 275                 return -EINVAL;
 276         obj_priv = obj->driver_private;
 277
 278         if (!i915_tiling_ok(dev, args->stride, obj->size, args->tiling_mode)) {
 279                 drm_gem_object_unreference(obj);
 280                 return -EINVAL;
 281         }
 282
 283         mutex_lock(&dev->struct_mutex);
 284
 285         if (args->tiling_mode == I915_TILING_NONE) {
 286                 obj_priv->tiling_mode = I915_TILING_NONE;
 287                 args->swizzle_mode = I915_BIT_6_SWIZZLE_NONE;
 288         } else {
 289                 if (args->tiling_mode == I915_TILING_X)
 290                         args->swizzle_mode = dev_priv->mm.bit_6_swizzle_x;
 291                 else
 292                         args->swizzle_mode = dev_priv->mm.bit_6_swizzle_y;
 293
 294                 /* Hide bit 17 swizzling from the user.  This prevents old Mesa
 295                  * from aborting the application on sw fallbacks to bit 17,
 296                  * and we use the pread/pwrite bit17 paths to swizzle for it.
 297                  * If there was a user that was relying on the swizzle
 298                  * information for drm_intel_bo_map()ed reads/writes this would
 299                  * break it, but we don't have any of those.
 300                  */
 301                 if (args->swizzle_mode == I915_BIT_6_SWIZZLE_9_17)
 302                         args->swizzle_mode = I915_BIT_6_SWIZZLE_9;
 303                 if (args->swizzle_mode == I915_BIT_6_SWIZZLE_9_10_17)
 304                         args->swizzle_mode = I915_BIT_6_SWIZZLE_9_10;
 305
 306                 /* If we can't handle the swizzling, make it untiled. */
 307                 if (args->swizzle_mode == I915_BIT_6_SWIZZLE_UNKNOWN) {
 308                         args->tiling_mode = I915_TILING_NONE;
 309                         args->swizzle_mode = I915_BIT_6_SWIZZLE_NONE;
 310                 }
 311         }
 312         if (args->tiling_mode != obj_priv->tiling_mode) {
 313                 int ret;
 314
 315                 /* Unbind the object, as switching tiling means we're
 316                  * switching the cache organization due to fencing, probably.
 317                  */
 318                 ret = i915_gem_object_unbind(obj);
 319                 if (ret != 0) {
 320                         WARN(ret != -ERESTARTSYS,
 321                              "failed to unbind object for tiling switch");
 322                         args->tiling_mode = obj_priv->tiling_mode;
 323                         mutex_unlock(&dev->struct_mutex);
 324                         drm_gem_object_unreference(obj);
 325
 326                         return ret;
 327                 }
 328                 obj_priv->tiling_mode = args->tiling_mode;
 329         }
 330         obj_priv->stride = args->stride;
 331
 332         drm_gem_object_unreference(obj);
 333         mutex_unlock(&dev->struct_mutex);
 334
 335         return 0;
 336 }
 337
 338 /**
 339  * Returns the current tiling mode and required bit 6 swizzling for the object.
 340  */
 341 int
 342 i915_gem_get_tiling(struct drm_device *dev, void *data,
 343                    struct drm_file *file_priv)
 344 {
 345         struct drm_i915_gem_get_tiling *args = data;
 346         drm_i915_private_t *dev_priv = dev->dev_private;
 347         struct drm_gem_object *obj;
 348         struct drm_i915_gem_object *obj_priv;
 349
 350         obj = drm_gem_object_lookup(dev, file_priv, args->handle);
 351         if (obj == NULL)
 352                 return -EINVAL;
 353         obj_priv = obj->driver_private;
 354
 355         mutex_lock(&dev->struct_mutex);
 356
 357         args->tiling_mode = obj_priv->tiling_mode;
 358         switch (obj_priv->tiling_mode) {
 359         case I915_TILING_X:
 360                 args->swizzle_mode = dev_priv->mm.bit_6_swizzle_x;
 361                 break;
 362         case I915_TILING_Y:
 363                 args->swizzle_mode = dev_priv->mm.bit_6_swizzle_y;
 364                 break;
 365         case I915_TILING_NONE:
 366                 args->swizzle_mode = I915_BIT_6_SWIZZLE_NONE;
 367                 break;
 368         default:
 369                 DRM_ERROR("unknown tiling mode\n");
 370         }
 371
 372         /* Hide bit 17 from the user -- see comment in i915_gem_set_tiling */
 373         if (args->swizzle_mode == I915_BIT_6_SWIZZLE_9_17)
 374                 args->swizzle_mode = I915_BIT_6_SWIZZLE_9;
 375         if (args->swizzle_mode == I915_BIT_6_SWIZZLE_9_10_17)
 376                 args->swizzle_mode = I915_BIT_6_SWIZZLE_9_10;
 377
 378         drm_gem_object_unreference(obj);
 379         mutex_unlock(&dev->struct_mutex);
 380
 381         return 0;
 382 }
 383
 384 /**
 385  * Swap every 64 bytes of this page around, to account for it having a new
 386  * bit 17 of its physical address and therefore being interpreted differently
 387  * by the GPU.
 388  */
 389 static int
 390 i915_gem_swizzle_page(struct page *page)
 391 {
 392         char *vaddr;
 393         int i;
 394         char temp[64];
 395
 396         vaddr = kmap(page);
 397         if (vaddr == NULL)
 398                 return -ENOMEM;
 399
 400         for (i = 0; i < PAGE_SIZE; i += 128) {
 401                 memcpy(temp, &vaddr[i], 64);
 402                 memcpy(&vaddr[i], &vaddr[i + 64], 64);
 403                 memcpy(&vaddr[i + 64], temp, 64);
 404         }
 405
 406         kunmap(page);
 407
 408         return 0;
 409 }
 410
 411 void
 412 i915_gem_object_do_bit_17_swizzle(struct drm_gem_object *obj)
 413 {
 414         struct drm_device *dev = obj->dev;
 415         drm_i915_private_t *dev_priv = dev->dev_private;
 416         struct drm_i915_gem_object *obj_priv = obj->driver_private;
 417         int page_count = obj->size >> PAGE_SHIFT;
 418         int i;
 419
 420         if (dev_priv->mm.bit_6_swizzle_x != I915_BIT_6_SWIZZLE_9_10_17)
 421                 return;
 422
 423         if (obj_priv->bit_17 == NULL)
 424                 return;
 425
 426         for (i = 0; i < page_count; i++) {
 427                 char new_bit_17 = page_to_phys(obj_priv->pages[i]) >> 17;
 428                 if ((new_bit_17 & 0x1) !=
 429                     (test_bit(i, obj_priv->bit_17) != 0)) {
 430                         int ret = i915_gem_swizzle_page(obj_priv->pages[i]);
 431                         if (ret != 0) {
 432                                 DRM_ERROR("Failed to swizzle page\n");
 433                                 return;
 434                         }
 435                         set_page_dirty(obj_priv->pages[i]);
 436                 }
 437         }
 438 }
 439
 440 void
 441 i915_gem_object_save_bit_17_swizzle(struct drm_gem_object *obj)
 442 {
 443         struct drm_device *dev = obj->dev;
 444         drm_i915_private_t *dev_priv = dev->dev_private;
 445         struct drm_i915_gem_object *obj_priv = obj->driver_private;
 446         int page_count = obj->size >> PAGE_SHIFT;
 447         int i;
 448
 449         if (dev_priv->mm.bit_6_swizzle_x != I915_BIT_6_SWIZZLE_9_10_17)
 450                 return;
 451
 452         if (obj_priv->bit_17 == NULL) {
 453                 obj_priv->bit_17 = kmalloc(BITS_TO_LONGS(page_count) *
 454                                            sizeof(long), GFP_KERNEL);
 455                 if (obj_priv->bit_17 == NULL) {
 456                         DRM_ERROR("Failed to allocate memory for bit 17 "
 457                                   "record\n");
 458                         return;
 459                 }
 460         }
 461
 462         for (i = 0; i < page_count; i++) {
 463                 if (page_to_phys(obj_priv->pages[i]) & (1 << 17))
 464                         __set_bit(i, obj_priv->bit_17);
 465                 else
 466                         __clear_bit(i, obj_priv->bit_17);
 467         }
 468 }