drivers/gpu/drm/vmwgfx/vmwgfx_bo.c

   1 // SPDX-License-Identifier: GPL-2.0 OR MIT
   2 /**************************************************************************
   3  *
   4  * Copyright © 2011-2018 VMware, Inc., Palo Alto, CA., USA
   5  * All Rights Reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the
   9  * "Software"), to deal in the Software without restriction, including
  10  * without limitation the rights to use, copy, modify, merge, publish,
  11  * distribute, sub license, and/or sell copies of the Software, and to
  12  * permit persons to whom the Software is furnished to do so, subject to
  13  * the following conditions:
  14  *
  15  * The above copyright notice and this permission notice (including the
  16  * next paragraph) shall be included in all copies or substantial portions
  17  * of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  22  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
  23  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  24  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  25  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  26  *
  27  **************************************************************************/
  28
  29 #include <drm/ttm/ttm_placement.h>
  30
  31 #include "vmwgfx_drv.h"
  32 #include "ttm_object.h"
  33
  34
  35 /**
  36  * vmw_buffer_object - Convert a struct ttm_buffer_object to a struct
  37  * vmw_buffer_object.
  38  *
  39  * @bo: Pointer to the TTM buffer object.
  40  * Return: Pointer to the struct vmw_buffer_object embedding the
  41  * TTM buffer object.
  42  */
  43 static struct vmw_buffer_object *
  44 vmw_buffer_object(struct ttm_buffer_object *bo)
  45 {
  46         return container_of(bo, struct vmw_buffer_object, base);
  47 }
  48
  49 /**
  50  * bo_is_vmw - check if the buffer object is a &vmw_buffer_object
  51  * @bo: ttm buffer object to be checked
  52  *
  53  * Uses destroy function associated with the object to determine if this is
  54  * a &vmw_buffer_object.
  55  *
  56  * Returns:
  57  * true if the object is of &vmw_buffer_object type, false if not.
  58  */
  59 static bool bo_is_vmw(struct ttm_buffer_object *bo)
  60 {
  61         return bo->destroy == &vmw_bo_bo_free ||
  62                bo->destroy == &vmw_gem_destroy;
  63 }
  64
  65 /**
  66  * vmw_bo_pin_in_placement - Validate a buffer to placement.
  67  *
  68  * @dev_priv:  Driver private.
  69  * @buf:  DMA buffer to move.
  70  * @placement:  The placement to pin it.
  71  * @interruptible:  Use interruptible wait.
  72  * Return: Zero on success, Negative error code on failure. In particular
  73  * -ERESTARTSYS if interrupted by a signal
  74  */
  75 int vmw_bo_pin_in_placement(struct vmw_private *dev_priv,
  76                             struct vmw_buffer_object *buf,
  77                             struct ttm_placement *placement,
  78                             bool interruptible)
  79 {
  80         struct ttm_operation_ctx ctx = {interruptible, false };
  81         struct ttm_buffer_object *bo = &buf->base;
  82         int ret;
  83
  84         vmw_execbuf_release_pinned_bo(dev_priv);
  85
  86         ret = ttm_bo_reserve(bo, interruptible, false, NULL);
  87         if (unlikely(ret != 0))
  88                 goto err;
  89
  90         ret = ttm_bo_validate(bo, placement, &ctx);
  91         if (!ret)
  92                 vmw_bo_pin_reserved(buf, true);
  93
  94         ttm_bo_unreserve(bo);
  95 err:
  96         return ret;
  97 }
  98
  99
 100 /**
 101  * vmw_bo_pin_in_vram_or_gmr - Move a buffer to vram or gmr.
 102  *
 103  * This function takes the reservation_sem in write mode.
 104  * Flushes and unpins the query bo to avoid failures.
 105  *
 106  * @dev_priv:  Driver private.
 107  * @buf:  DMA buffer to move.
 108  * @interruptible:  Use interruptible wait.
 109  * Return: Zero on success, Negative error code on failure. In particular
 110  * -ERESTARTSYS if interrupted by a signal
 111  */
 112 int vmw_bo_pin_in_vram_or_gmr(struct vmw_private *dev_priv,
 113                               struct vmw_buffer_object *buf,
 114                               bool interruptible)
 115 {
 116         struct ttm_operation_ctx ctx = {interruptible, false };
 117         struct ttm_buffer_object *bo = &buf->base;
 118         int ret;
 119
 120         vmw_execbuf_release_pinned_bo(dev_priv);
 121
 122         ret = ttm_bo_reserve(bo, interruptible, false, NULL);
 123         if (unlikely(ret != 0))
 124                 goto err;
 125
 126         ret = ttm_bo_validate(bo, &vmw_vram_gmr_placement, &ctx);
 127         if (likely(ret == 0) || ret == -ERESTARTSYS)
 128                 goto out_unreserve;
 129
 130         ret = ttm_bo_validate(bo, &vmw_vram_placement, &ctx);
 131
 132 out_unreserve:
 133         if (!ret)
 134                 vmw_bo_pin_reserved(buf, true);
 135
 136         ttm_bo_unreserve(bo);
 137 err:
 138         return ret;
 139 }
 140
 141
 142 /**
 143  * vmw_bo_pin_in_vram - Move a buffer to vram.
 144  *
 145  * This function takes the reservation_sem in write mode.
 146  * Flushes and unpins the query bo to avoid failures.
 147  *
 148  * @dev_priv:  Driver private.
 149  * @buf:  DMA buffer to move.
 150  * @interruptible:  Use interruptible wait.
 151  * Return: Zero on success, Negative error code on failure. In particular
 152  * -ERESTARTSYS if interrupted by a signal
 153  */
 154 int vmw_bo_pin_in_vram(struct vmw_private *dev_priv,
 155                        struct vmw_buffer_object *buf,
 156                        bool interruptible)
 157 {
 158         return vmw_bo_pin_in_placement(dev_priv, buf, &vmw_vram_placement,
 159                                        interruptible);
 160 }
 161
 162
 163 /**
 164  * vmw_bo_pin_in_start_of_vram - Move a buffer to start of vram.
 165  *
 166  * This function takes the reservation_sem in write mode.
 167  * Flushes and unpins the query bo to avoid failures.
 168  *
 169  * @dev_priv:  Driver private.
 170  * @buf:  DMA buffer to pin.
 171  * @interruptible:  Use interruptible wait.
 172  * Return: Zero on success, Negative error code on failure. In particular
 173  * -ERESTARTSYS if interrupted by a signal
 174  */
 175 int vmw_bo_pin_in_start_of_vram(struct vmw_private *dev_priv,
 176                                 struct vmw_buffer_object *buf,
 177                                 bool interruptible)
 178 {
 179         struct ttm_operation_ctx ctx = {interruptible, false };
 180         struct ttm_buffer_object *bo = &buf->base;
 181         struct ttm_placement placement;
 182         struct ttm_place place;
 183         int ret = 0;
 184
 185         place = vmw_vram_placement.placement[0];
 186         place.lpfn = PFN_UP(bo->resource->size);
 187         placement.num_placement = 1;
 188         placement.placement = &place;
 189         placement.num_busy_placement = 1;
 190         placement.busy_placement = &place;
 191
 192         vmw_execbuf_release_pinned_bo(dev_priv);
 193         ret = ttm_bo_reserve(bo, interruptible, false, NULL);
 194         if (unlikely(ret != 0))
 195                 goto err_unlock;
 196
 197         /*
 198          * Is this buffer already in vram but not at the start of it?
 199          * In that case, evict it first because TTM isn't good at handling
 200          * that situation.
 201          */
 202         if (bo->resource->mem_type == TTM_PL_VRAM &&
 203             bo->resource->start < PFN_UP(bo->resource->size) &&
 204             bo->resource->start > 0 &&
 205             buf->base.pin_count == 0) {
 206                 ctx.interruptible = false;
 207                 (void) ttm_bo_validate(bo, &vmw_sys_placement, &ctx);
 208         }
 209
 210         ret = ttm_bo_validate(bo, &placement, &ctx);
 211
 212         /* For some reason we didn't end up at the start of vram */
 213         WARN_ON(ret == 0 && bo->resource->start != 0);
 214         if (!ret)
 215                 vmw_bo_pin_reserved(buf, true);
 216
 217         ttm_bo_unreserve(bo);
 218 err_unlock:
 219
 220         return ret;
 221 }
 222
 223
 224 /**
 225  * vmw_bo_unpin - Unpin the buffer given buffer, does not move the buffer.
 226  *
 227  * This function takes the reservation_sem in write mode.
 228  *
 229  * @dev_priv:  Driver private.
 230  * @buf:  DMA buffer to unpin.
 231  * @interruptible:  Use interruptible wait.
 232  * Return: Zero on success, Negative error code on failure. In particular
 233  * -ERESTARTSYS if interrupted by a signal
 234  */
 235 int vmw_bo_unpin(struct vmw_private *dev_priv,
 236                  struct vmw_buffer_object *buf,
 237                  bool interruptible)
 238 {
 239         struct ttm_buffer_object *bo = &buf->base;
 240         int ret;
 241
 242         ret = ttm_bo_reserve(bo, interruptible, false, NULL);
 243         if (unlikely(ret != 0))
 244                 goto err;
 245
 246         vmw_bo_pin_reserved(buf, false);
 247
 248         ttm_bo_unreserve(bo);
 249
 250 err:
 251         return ret;
 252 }
 253
 254 /**
 255  * vmw_bo_get_guest_ptr - Get the guest ptr representing the current placement
 256  * of a buffer.
 257  *
 258  * @bo: Pointer to a struct ttm_buffer_object. Must be pinned or reserved.
 259  * @ptr: SVGAGuestPtr returning the result.
 260  */
 261 void vmw_bo_get_guest_ptr(const struct ttm_buffer_object *bo,
 262                           SVGAGuestPtr *ptr)
 263 {
 264         if (bo->resource->mem_type == TTM_PL_VRAM) {
 265                 ptr->gmrId = SVGA_GMR_FRAMEBUFFER;
 266                 ptr->offset = bo->resource->start << PAGE_SHIFT;
 267         } else {
 268                 ptr->gmrId = bo->resource->start;
 269                 ptr->offset = 0;
 270         }
 271 }
 272
 273
 274 /**
 275  * vmw_bo_pin_reserved - Pin or unpin a buffer object without moving it.
 276  *
 277  * @vbo: The buffer object. Must be reserved.
 278  * @pin: Whether to pin or unpin.
 279  *
 280  */
 281 void vmw_bo_pin_reserved(struct vmw_buffer_object *vbo, bool pin)
 282 {
 283         struct ttm_operation_ctx ctx = { false, true };
 284         struct ttm_place pl;
 285         struct ttm_placement placement;
 286         struct ttm_buffer_object *bo = &vbo->base;
 287         uint32_t old_mem_type = bo->resource->mem_type;
 288         int ret;
 289
 290         dma_resv_assert_held(bo->base.resv);
 291
 292         if (pin == !!bo->pin_count)
 293                 return;
 294
 295         pl.fpfn = 0;
 296         pl.lpfn = 0;
 297         pl.mem_type = bo->resource->mem_type;
 298         pl.flags = bo->resource->placement;
 299
 300         memset(&placement, 0, sizeof(placement));
 301         placement.num_placement = 1;
 302         placement.placement = &pl;
 303
 304         ret = ttm_bo_validate(bo, &placement, &ctx);
 305
 306         BUG_ON(ret != 0 || bo->resource->mem_type != old_mem_type);
 307
 308         if (pin)
 309                 ttm_bo_pin(bo);
 310         else
 311                 ttm_bo_unpin(bo);
 312 }
 313
 314 /**
 315  * vmw_bo_map_and_cache - Map a buffer object and cache the map
 316  *
 317  * @vbo: The buffer object to map
 318  * Return: A kernel virtual address or NULL if mapping failed.
 319  *
 320  * This function maps a buffer object into the kernel address space, or
 321  * returns the virtual kernel address of an already existing map. The virtual
 322  * address remains valid as long as the buffer object is pinned or reserved.
 323  * The cached map is torn down on either
 324  * 1) Buffer object move
 325  * 2) Buffer object swapout
 326  * 3) Buffer object destruction
 327  *
 328  */
 329 void *vmw_bo_map_and_cache(struct vmw_buffer_object *vbo)
 330 {
 331         struct ttm_buffer_object *bo = &vbo->base;
 332         bool not_used;
 333         void *virtual;
 334         int ret;
 335
 336         virtual = ttm_kmap_obj_virtual(&vbo->map, &not_used);
 337         if (virtual)
 338                 return virtual;
 339
 340         ret = ttm_bo_kmap(bo, 0, PFN_UP(bo->base.size), &vbo->map);
 341         if (ret)
 342                 DRM_ERROR("Buffer object map failed: %d.\n", ret);
 343
 344         return ttm_kmap_obj_virtual(&vbo->map, &not_used);
 345 }
 346
 347
 348 /**
 349  * vmw_bo_unmap - Tear down a cached buffer object map.
 350  *
 351  * @vbo: The buffer object whose map we are tearing down.
 352  *
 353  * This function tears down a cached map set up using
 354  * vmw_buffer_object_map_and_cache().
 355  */
 356 void vmw_bo_unmap(struct vmw_buffer_object *vbo)
 357 {
 358         if (vbo->map.bo == NULL)
 359                 return;
 360
 361         ttm_bo_kunmap(&vbo->map);
 362 }
 363
 364
 365 /**
 366  * vmw_bo_bo_free - vmw buffer object destructor
 367  *
 368  * @bo: Pointer to the embedded struct ttm_buffer_object
 369  */
 370 void vmw_bo_bo_free(struct ttm_buffer_object *bo)
 371 {
 372         struct vmw_buffer_object *vmw_bo = vmw_buffer_object(bo);
 373
 374         WARN_ON(vmw_bo->dirty);
 375         WARN_ON(!RB_EMPTY_ROOT(&vmw_bo->res_tree));
 376         vmw_bo_unmap(vmw_bo);
 377         drm_gem_object_release(&bo->base);
 378         kfree(vmw_bo);
 379 }
 380
 381 /* default destructor */
 382 static void vmw_bo_default_destroy(struct ttm_buffer_object *bo)
 383 {
 384         kfree(bo);
 385 }
 386
 387 /**
 388  * vmw_bo_create_kernel - Create a pinned BO for internal kernel use.
 389  *
 390  * @dev_priv: Pointer to the device private struct
 391  * @size: size of the BO we need
 392  * @placement: where to put it
 393  * @p_bo: resulting BO
 394  *
 395  * Creates and pin a simple BO for in kernel use.
 396  */
 397 int vmw_bo_create_kernel(struct vmw_private *dev_priv, unsigned long size,
 398                          struct ttm_placement *placement,
 399                          struct ttm_buffer_object **p_bo)
 400 {
 401         struct ttm_operation_ctx ctx = {
 402                 .interruptible = false,
 403                 .no_wait_gpu = false
 404         };
 405         struct ttm_buffer_object *bo;
 406         struct drm_device *vdev = &dev_priv->drm;
 407         int ret;
 408
 409         bo = kzalloc(sizeof(*bo), GFP_KERNEL);
 410         if (unlikely(!bo))
 411                 return -ENOMEM;
 412
 413         size = ALIGN(size, PAGE_SIZE);
 414
 415         drm_gem_private_object_init(vdev, &bo->base, size);
 416
 417         ret = ttm_bo_init_reserved(&dev_priv->bdev, bo, ttm_bo_type_kernel,
 418                                    placement, 0, &ctx, NULL, NULL,
 419                                    vmw_bo_default_destroy);
 420         if (unlikely(ret))
 421                 goto error_free;
 422
 423         ttm_bo_pin(bo);
 424         ttm_bo_unreserve(bo);
 425         *p_bo = bo;
 426
 427         return 0;
 428
 429 error_free:
 430         kfree(bo);
 431         return ret;
 432 }
 433
 434 int vmw_bo_create(struct vmw_private *vmw,
 435                   size_t size, struct ttm_placement *placement,
 436                   bool interruptible, bool pin,
 437                   void (*bo_free)(struct ttm_buffer_object *bo),
 438                   struct vmw_buffer_object **p_bo)
 439 {
 440         int ret;
 441
 442         BUG_ON(!bo_free);
 443
 444         *p_bo = kmalloc(sizeof(**p_bo), GFP_KERNEL);
 445         if (unlikely(!*p_bo)) {
 446                 DRM_ERROR("Failed to allocate a buffer.\n");
 447                 return -ENOMEM;
 448         }
 449
 450         ret = vmw_bo_init(vmw, *p_bo, size,
 451                           placement, interruptible, pin,
 452                           bo_free);
 453         if (unlikely(ret != 0))
 454                 goto out_error;
 455
 456         return ret;
 457 out_error:
 458         kfree(*p_bo);
 459         *p_bo = NULL;
 460         return ret;
 461 }
 462
 463 /**
 464  * vmw_bo_init - Initialize a vmw buffer object
 465  *
 466  * @dev_priv: Pointer to the device private struct
 467  * @vmw_bo: Pointer to the struct vmw_buffer_object to initialize.
 468  * @size: Buffer object size in bytes.
 469  * @placement: Initial placement.
 470  * @interruptible: Whether waits should be performed interruptible.
 471  * @pin: If the BO should be created pinned at a fixed location.
 472  * @bo_free: The buffer object destructor.
 473  * Returns: Zero on success, negative error code on error.
 474  *
 475  * Note that on error, the code will free the buffer object.
 476  */
 477 int vmw_bo_init(struct vmw_private *dev_priv,
 478                 struct vmw_buffer_object *vmw_bo,
 479                 size_t size, struct ttm_placement *placement,
 480                 bool interruptible, bool pin,
 481                 void (*bo_free)(struct ttm_buffer_object *bo))
 482 {
 483         struct ttm_operation_ctx ctx = {
 484                 .interruptible = interruptible,
 485                 .no_wait_gpu = false
 486         };
 487         struct ttm_device *bdev = &dev_priv->bdev;
 488         struct drm_device *vdev = &dev_priv->drm;
 489         int ret;
 490
 491         WARN_ON_ONCE(!bo_free);
 492         memset(vmw_bo, 0, sizeof(*vmw_bo));
 493         BUILD_BUG_ON(TTM_MAX_BO_PRIORITY <= 3);
 494         vmw_bo->base.priority = 3;
 495         vmw_bo->res_tree = RB_ROOT;
 496
 497         size = ALIGN(size, PAGE_SIZE);
 498         drm_gem_private_object_init(vdev, &vmw_bo->base.base, size);
 499
 500         ret = ttm_bo_init_reserved(bdev, &vmw_bo->base, ttm_bo_type_device,
 501                                    placement, 0, &ctx, NULL, NULL, bo_free);
 502         if (unlikely(ret)) {
 503                 return ret;
 504         }
 505
 506         if (pin)
 507                 ttm_bo_pin(&vmw_bo->base);
 508         ttm_bo_unreserve(&vmw_bo->base);
 509
 510         return 0;
 511 }
 512
 513 /**
 514  * vmw_user_bo_synccpu_grab - Grab a struct vmw_buffer_object for cpu
 515  * access, idling previous GPU operations on the buffer and optionally
 516  * blocking it for further command submissions.
 517  *
 518  * @vmw_bo: Pointer to the buffer object being grabbed for CPU access
 519  * @flags: Flags indicating how the grab should be performed.
 520  * Return: Zero on success, Negative error code on error. In particular,
 521  * -EBUSY will be returned if a dontblock operation is requested and the
 522  * buffer object is busy, and -ERESTARTSYS will be returned if a wait is
 523  * interrupted by a signal.
 524  *
 525  * A blocking grab will be automatically released when @tfile is closed.
 526  */
 527 static int vmw_user_bo_synccpu_grab(struct vmw_buffer_object *vmw_bo,
 528                                     uint32_t flags)
 529 {
 530         bool nonblock = !!(flags & drm_vmw_synccpu_dontblock);
 531         struct ttm_buffer_object *bo = &vmw_bo->base;
 532         int ret;
 533
 534         if (flags & drm_vmw_synccpu_allow_cs) {
 535                 long lret;
 536
 537                 lret = dma_resv_wait_timeout(bo->base.resv, DMA_RESV_USAGE_READ,
 538                                              true, nonblock ? 0 :
 539                                              MAX_SCHEDULE_TIMEOUT);
 540                 if (!lret)
 541                         return -EBUSY;
 542                 else if (lret < 0)
 543                         return lret;
 544                 return 0;
 545         }
 546
 547         ret = ttm_bo_reserve(bo, true, nonblock, NULL);
 548         if (unlikely(ret != 0))
 549                 return ret;
 550
 551         ret = ttm_bo_wait(bo, true, nonblock);
 552         if (likely(ret == 0))
 553                 atomic_inc(&vmw_bo->cpu_writers);
 554
 555         ttm_bo_unreserve(bo);
 556         if (unlikely(ret != 0))
 557                 return ret;
 558
 559         return ret;
 560 }
 561
 562 /**
 563  * vmw_user_bo_synccpu_release - Release a previous grab for CPU access,
 564  * and unblock command submission on the buffer if blocked.
 565  *
 566  * @filp: Identifying the caller.
 567  * @handle: Handle identifying the buffer object.
 568  * @flags: Flags indicating the type of release.
 569  */
 570 static int vmw_user_bo_synccpu_release(struct drm_file *filp,
 571                                        uint32_t handle,
 572                                        uint32_t flags)
 573 {
 574         struct vmw_buffer_object *vmw_bo;
 575         int ret = vmw_user_bo_lookup(filp, handle, &vmw_bo);
 576
 577         if (!ret) {
 578                 if (!(flags & drm_vmw_synccpu_allow_cs)) {
 579                         atomic_dec(&vmw_bo->cpu_writers);
 580                 }
 581                 ttm_bo_put(&vmw_bo->base);
 582         }
 583
 584         return ret;
 585 }
 586
 587
 588 /**
 589  * vmw_user_bo_synccpu_ioctl - ioctl function implementing the synccpu
 590  * functionality.
 591  *
 592  * @dev: Identifies the drm device.
 593  * @data: Pointer to the ioctl argument.
 594  * @file_priv: Identifies the caller.
 595  * Return: Zero on success, negative error code on error.
 596  *
 597  * This function checks the ioctl arguments for validity and calls the
 598  * relevant synccpu functions.
 599  */
 600 int vmw_user_bo_synccpu_ioctl(struct drm_device *dev, void *data,
 601                               struct drm_file *file_priv)
 602 {
 603         struct drm_vmw_synccpu_arg *arg =
 604                 (struct drm_vmw_synccpu_arg *) data;
 605         struct vmw_buffer_object *vbo;
 606         int ret;
 607
 608         if ((arg->flags & (drm_vmw_synccpu_read | drm_vmw_synccpu_write)) == 0
 609             || (arg->flags & ~(drm_vmw_synccpu_read | drm_vmw_synccpu_write |
 610                                drm_vmw_synccpu_dontblock |
 611                                drm_vmw_synccpu_allow_cs)) != 0) {
 612                 DRM_ERROR("Illegal synccpu flags.\n");
 613                 return -EINVAL;
 614         }
 615
 616         switch (arg->op) {
 617         case drm_vmw_synccpu_grab:
 618                 ret = vmw_user_bo_lookup(file_priv, arg->handle, &vbo);
 619                 if (unlikely(ret != 0))
 620                         return ret;
 621
 622                 ret = vmw_user_bo_synccpu_grab(vbo, arg->flags);
 623                 vmw_bo_unreference(&vbo);
 624                 if (unlikely(ret != 0)) {
 625                         if (ret == -ERESTARTSYS || ret == -EBUSY)
 626                                 return -EBUSY;
 627                         DRM_ERROR("Failed synccpu grab on handle 0x%08x.\n",
 628                                   (unsigned int) arg->handle);
 629                         return ret;
 630                 }
 631                 break;
 632         case drm_vmw_synccpu_release:
 633                 ret = vmw_user_bo_synccpu_release(file_priv,
 634                                                   arg->handle,
 635                                                   arg->flags);
 636                 if (unlikely(ret != 0)) {
 637                         DRM_ERROR("Failed synccpu release on handle 0x%08x.\n",
 638                                   (unsigned int) arg->handle);
 639                         return ret;
 640                 }
 641                 break;
 642         default:
 643                 DRM_ERROR("Invalid synccpu operation.\n");
 644                 return -EINVAL;
 645         }
 646
 647         return 0;
 648 }
 649
 650 /**
 651  * vmw_bo_unref_ioctl - Generic handle close ioctl.
 652  *
 653  * @dev: Identifies the drm device.
 654  * @data: Pointer to the ioctl argument.
 655  * @file_priv: Identifies the caller.
 656  * Return: Zero on success, negative error code on error.
 657  *
 658  * This function checks the ioctl arguments for validity and closes a
 659  * handle to a TTM base object, optionally freeing the object.
 660  */
 661 int vmw_bo_unref_ioctl(struct drm_device *dev, void *data,
 662                        struct drm_file *file_priv)
 663 {
 664         struct drm_vmw_unref_dmabuf_arg *arg =
 665             (struct drm_vmw_unref_dmabuf_arg *)data;
 666
 667         drm_gem_handle_delete(file_priv, arg->handle);
 668         return 0;
 669 }
 670
 671
 672 /**
 673  * vmw_user_bo_lookup - Look up a vmw user buffer object from a handle.
 674  *
 675  * @filp: The file the handle is registered with.
 676  * @handle: The user buffer object handle
 677  * @out: Pointer to a where a pointer to the embedded
 678  * struct vmw_buffer_object should be placed.
 679  * Return: Zero on success, Negative error code on error.
 680  *
 681  * The vmw buffer object pointer will be refcounted.
 682  */
 683 int vmw_user_bo_lookup(struct drm_file *filp,
 684                        uint32_t handle,
 685                        struct vmw_buffer_object **out)
 686 {
 687         struct drm_gem_object *gobj;
 688
 689         gobj = drm_gem_object_lookup(filp, handle);
 690         if (!gobj) {
 691                 DRM_ERROR("Invalid buffer object handle 0x%08lx.\n",
 692                           (unsigned long)handle);
 693                 return -ESRCH;
 694         }
 695
 696         *out = gem_to_vmw_bo(gobj);
 697         ttm_bo_get(&(*out)->base);
 698         drm_gem_object_put(gobj);
 699
 700         return 0;
 701 }
 702
 703 /**
 704  * vmw_user_bo_noref_lookup - Look up a vmw user buffer object without reference
 705  * @filp: The TTM object file the handle is registered with.
 706  * @handle: The user buffer object handle.
 707  *
 708  * This function looks up a struct vmw_bo and returns a pointer to the
 709  * struct vmw_buffer_object it derives from without refcounting the pointer.
 710  * The returned pointer is only valid until vmw_user_bo_noref_release() is
 711  * called, and the object pointed to by the returned pointer may be doomed.
 712  * Any persistent usage of the object requires a refcount to be taken using
 713  * ttm_bo_reference_unless_doomed(). Iff this function returns successfully it
 714  * needs to be paired with vmw_user_bo_noref_release() and no sleeping-
 715  * or scheduling functions may be called in between these function calls.
 716  *
 717  * Return: A struct vmw_buffer_object pointer if successful or negative
 718  * error pointer on failure.
 719  */
 720 struct vmw_buffer_object *
 721 vmw_user_bo_noref_lookup(struct drm_file *filp, u32 handle)
 722 {
 723         struct vmw_buffer_object *vmw_bo;
 724         struct ttm_buffer_object *bo;
 725         struct drm_gem_object *gobj = drm_gem_object_lookup(filp, handle);
 726
 727         if (!gobj) {
 728                 DRM_ERROR("Invalid buffer object handle 0x%08lx.\n",
 729                           (unsigned long)handle);
 730                 return ERR_PTR(-ESRCH);
 731         }
 732         vmw_bo = gem_to_vmw_bo(gobj);
 733         bo = ttm_bo_get_unless_zero(&vmw_bo->base);
 734         vmw_bo = vmw_buffer_object(bo);
 735         drm_gem_object_put(gobj);
 736
 737         return vmw_bo;
 738 }
 739
 740
 741 /**
 742  * vmw_bo_fence_single - Utility function to fence a single TTM buffer
 743  *                       object without unreserving it.
 744  *
 745  * @bo:             Pointer to the struct ttm_buffer_object to fence.
 746  * @fence:          Pointer to the fence. If NULL, this function will
 747  *                  insert a fence into the command stream..
 748  *
 749  * Contrary to the ttm_eu version of this function, it takes only
 750  * a single buffer object instead of a list, and it also doesn't
 751  * unreserve the buffer object, which needs to be done separately.
 752  */
 753 void vmw_bo_fence_single(struct ttm_buffer_object *bo,
 754                          struct vmw_fence_obj *fence)
 755 {
 756         struct ttm_device *bdev = bo->bdev;
 757         struct vmw_private *dev_priv =
 758                 container_of(bdev, struct vmw_private, bdev);
 759         int ret;
 760
 761         if (fence == NULL)
 762                 vmw_execbuf_fence_commands(NULL, dev_priv, &fence, NULL);
 763         else
 764                 dma_fence_get(&fence->base);
 765
 766         ret = dma_resv_reserve_fences(bo->base.resv, 1);
 767         if (!ret)
 768                 dma_resv_add_fence(bo->base.resv, &fence->base,
 769                                    DMA_RESV_USAGE_KERNEL);
 770         else
 771                 /* Last resort fallback when we are OOM */
 772                 dma_fence_wait(&fence->base, false);
 773         dma_fence_put(&fence->base);
 774 }
 775
 776
 777 /**
 778  * vmw_dumb_create - Create a dumb kms buffer
 779  *
 780  * @file_priv: Pointer to a struct drm_file identifying the caller.
 781  * @dev: Pointer to the drm device.
 782  * @args: Pointer to a struct drm_mode_create_dumb structure
 783  * Return: Zero on success, negative error code on failure.
 784  *
 785  * This is a driver callback for the core drm create_dumb functionality.
 786  * Note that this is very similar to the vmw_bo_alloc ioctl, except
 787  * that the arguments have a different format.
 788  */
 789 int vmw_dumb_create(struct drm_file *file_priv,
 790                     struct drm_device *dev,
 791                     struct drm_mode_create_dumb *args)
 792 {
 793         struct vmw_private *dev_priv = vmw_priv(dev);
 794         struct vmw_buffer_object *vbo;
 795         int cpp = DIV_ROUND_UP(args->bpp, 8);
 796         int ret;
 797
 798         switch (cpp) {
 799         case 1: /* DRM_FORMAT_C8 */
 800         case 2: /* DRM_FORMAT_RGB565 */
 801         case 4: /* DRM_FORMAT_XRGB8888 */
 802                 break;
 803         default:
 804                 /*
 805                  * Dumb buffers don't allow anything else.
 806                  * This is tested via IGT's dumb_buffers
 807                  */
 808                 return -EINVAL;
 809         }
 810
 811         args->pitch = args->width * cpp;
 812         args->size = ALIGN(args->pitch * args->height, PAGE_SIZE);
 813
 814         ret = vmw_gem_object_create_with_handle(dev_priv, file_priv,
 815                                                 args->size, &args->handle,
 816                                                 &vbo);
 817
 818         return ret;
 819 }
 820
 821 /**
 822  * vmw_bo_swap_notify - swapout notify callback.
 823  *
 824  * @bo: The buffer object to be swapped out.
 825  */
 826 void vmw_bo_swap_notify(struct ttm_buffer_object *bo)
 827 {
 828         /* Is @bo embedded in a struct vmw_buffer_object? */
 829         if (!bo_is_vmw(bo))
 830                 return;
 831
 832         /* Kill any cached kernel maps before swapout */
 833         vmw_bo_unmap(vmw_buffer_object(bo));
 834 }
 835
 836
 837 /**
 838  * vmw_bo_move_notify - TTM move_notify_callback
 839  *
 840  * @bo: The TTM buffer object about to move.
 841  * @mem: The struct ttm_resource indicating to what memory
 842  *       region the move is taking place.
 843  *
 844  * Detaches cached maps and device bindings that require that the
 845  * buffer doesn't move.
 846  */
 847 void vmw_bo_move_notify(struct ttm_buffer_object *bo,
 848                         struct ttm_resource *mem)
 849 {
 850         struct vmw_buffer_object *vbo;
 851
 852         /* Make sure @bo is embedded in a struct vmw_buffer_object? */
 853         if (!bo_is_vmw(bo))
 854                 return;
 855
 856         vbo = container_of(bo, struct vmw_buffer_object, base);
 857
 858         /*
 859          * Kill any cached kernel maps before move to or from VRAM.
 860          * With other types of moves, the underlying pages stay the same,
 861          * and the map can be kept.
 862          */
 863         if (mem->mem_type == TTM_PL_VRAM || bo->resource->mem_type == TTM_PL_VRAM)
 864                 vmw_bo_unmap(vbo);
 865
 866         /*
 867          * If we're moving a backup MOB out of MOB placement, then make sure we
 868          * read back all resource content first, and unbind the MOB from
 869          * the resource.
 870          */
 871         if (mem->mem_type != VMW_PL_MOB && bo->resource->mem_type == VMW_PL_MOB)
 872                 vmw_resource_unbind_list(vbo);
 873 }