drivers/gpu/drm/drm_file.c

   1 /*
   2  * \author Rickard E. (Rik) Faith <faith@valinux.com>
   3  * \author Daryll Strauss <daryll@valinux.com>
   4  * \author Gareth Hughes <gareth@valinux.com>
   5  */
   6
   7 /*
   8  * Created: Mon Jan  4 08:58:31 1999 by faith@valinux.com
   9  *
  10  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
  11  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
  12  * All Rights Reserved.
  13  *
  14  * Permission is hereby granted, free of charge, to any person obtaining a
  15  * copy of this software and associated documentation files (the "Software"),
  16  * to deal in the Software without restriction, including without limitation
  17  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  18  * and/or sell copies of the Software, and to permit persons to whom the
  19  * Software is furnished to do so, subject to the following conditions:
  20  *
  21  * The above copyright notice and this permission notice (including the next
  22  * paragraph) shall be included in all copies or substantial portions of the
  23  * Software.
  24  *
  25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  26  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  27  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  28  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  29  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  30  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  31  * OTHER DEALINGS IN THE SOFTWARE.
  32  */
  33
  34 #include <linux/poll.h>
  35 #include <linux/slab.h>
  36 #include <linux/module.h>
  37
  38 #include <drm/drm_file.h>
  39 #include <drm/drmP.h>
  40
  41 #include "drm_legacy.h"
  42 #include "drm_internal.h"
  43 #include "drm_crtc_internal.h"
  44
  45 /* from BKL pushdown */
  46 DEFINE_MUTEX(drm_global_mutex);
  47
  48 /**
  49  * DOC: file operations
  50  *
  51  * Drivers must define the file operations structure that forms the DRM
  52  * userspace API entry point, even though most of those operations are
  53  * implemented in the DRM core. The resulting &struct file_operations must be
  54  * stored in the &drm_driver.fops field. The mandatory functions are drm_open(),
  55  * drm_read(), drm_ioctl() and drm_compat_ioctl() if CONFIG_COMPAT is enabled
  56  * Note that drm_compat_ioctl will be NULL if CONFIG_COMPAT=n, so there's no
  57  * need to sprinkle #ifdef into the code. Drivers which implement private ioctls
  58  * that require 32/64 bit compatibility support must provide their own
  59  * &file_operations.compat_ioctl handler that processes private ioctls and calls
  60  * drm_compat_ioctl() for core ioctls.
  61  *
  62  * In addition drm_read() and drm_poll() provide support for DRM events. DRM
  63  * events are a generic and extensible means to send asynchronous events to
  64  * userspace through the file descriptor. They are used to send vblank event and
  65  * page flip completions by the KMS API. But drivers can also use it for their
  66  * own needs, e.g. to signal completion of rendering.
  67  *
  68  * For the driver-side event interface see drm_event_reserve_init() and
  69  * drm_send_event() as the main starting points.
  70  *
  71  * The memory mapping implementation will vary depending on how the driver
  72  * manages memory. Legacy drivers will use the deprecated drm_legacy_mmap()
  73  * function, modern drivers should use one of the provided memory-manager
  74  * specific implementations. For GEM-based drivers this is drm_gem_mmap(), and
  75  * for drivers which use the CMA GEM helpers it's drm_gem_cma_mmap().
  76  *
  77  * No other file operations are supported by the DRM userspace API. Overall the
  78  * following is an example #file_operations structure::
  79  *
  80  *     static const example_drm_fops = {
  81  *             .owner = THIS_MODULE,
  82  *             .open = drm_open,
  83  *             .release = drm_release,
  84  *             .unlocked_ioctl = drm_ioctl,
  85  *             .compat_ioctl = drm_compat_ioctl, // NULL if CONFIG_COMPAT=n
  86  *             .poll = drm_poll,
  87  *             .read = drm_read,
  88  *             .llseek = no_llseek,
  89  *             .mmap = drm_gem_mmap,
  90  *     };
  91  *
  92  * For plain GEM based drivers there is the DEFINE_DRM_GEM_FOPS() macro, and for
  93  * CMA based drivers there is the DEFINE_DRM_GEM_CMA_FOPS() macro to make this
  94  * simpler.
  95  */
  96
  97 static int drm_open_helper(struct file *filp, struct drm_minor *minor);
  98
  99 static int drm_setup(struct drm_device * dev)
 100 {
 101         int ret;
 102
 103         if (dev->driver->firstopen &&
 104             drm_core_check_feature(dev, DRIVER_LEGACY)) {
 105                 ret = dev->driver->firstopen(dev);
 106                 if (ret != 0)
 107                         return ret;
 108         }
 109
 110         ret = drm_legacy_dma_setup(dev);
 111         if (ret < 0)
 112                 return ret;
 113
 114
 115         DRM_DEBUG("\n");
 116         return 0;
 117 }
 118
 119 /**
 120  * drm_open - open method for DRM file
 121  * @inode: device inode
 122  * @filp: file pointer.
 123  *
 124  * This function must be used by drivers as their &file_operations.open method.
 125  * It looks up the correct DRM device and instantiates all the per-file
 126  * resources for it. It also calls the &drm_driver.open driver callback.
 127  *
 128  * RETURNS:
 129  *
 130  * 0 on success or negative errno value on falure.
 131  */
 132 int drm_open(struct inode *inode, struct file *filp)
 133 {
 134         struct drm_device *dev;
 135         struct drm_minor *minor;
 136         int retcode;
 137         int need_setup = 0;
 138
 139         minor = drm_minor_acquire(iminor(inode));
 140         if (IS_ERR(minor))
 141                 return PTR_ERR(minor);
 142
 143         dev = minor->dev;
 144         if (!dev->open_count++)
 145                 need_setup = 1;
 146
 147         /* share address_space across all char-devs of a single device */
 148         filp->f_mapping = dev->anon_inode->i_mapping;
 149
 150         retcode = drm_open_helper(filp, minor);
 151         if (retcode)
 152                 goto err_undo;
 153         if (need_setup) {
 154                 retcode = drm_setup(dev);
 155                 if (retcode)
 156                         goto err_undo;
 157         }
 158         return 0;
 159
 160 err_undo:
 161         dev->open_count--;
 162         drm_minor_release(minor);
 163         return retcode;
 164 }
 165 EXPORT_SYMBOL(drm_open);
 166
 167 /*
 168  * Check whether DRI will run on this CPU.
 169  *
 170  * \return non-zero if the DRI will run on this CPU, or zero otherwise.
 171  */
 172 static int drm_cpu_valid(void)
 173 {
 174 #if defined(__sparc__) && !defined(__sparc_v9__)
 175         return 0;               /* No cmpxchg before v9 sparc. */
 176 #endif
 177         return 1;
 178 }
 179
 180 /*
 181  * Called whenever a process opens /dev/drm.
 182  *
 183  * \param filp file pointer.
 184  * \param minor acquired minor-object.
 185  * \return zero on success or a negative number on failure.
 186  *
 187  * Creates and initializes a drm_file structure for the file private data in \p
 188  * filp and add it into the double linked list in \p dev.
 189  */
 190 static int drm_open_helper(struct file *filp, struct drm_minor *minor)
 191 {
 192         struct drm_device *dev = minor->dev;
 193         struct drm_file *priv;
 194         int ret;
 195
 196         if (filp->f_flags & O_EXCL)
 197                 return -EBUSY;  /* No exclusive opens */
 198         if (!drm_cpu_valid())
 199                 return -EINVAL;
 200         if (dev->switch_power_state != DRM_SWITCH_POWER_ON && dev->switch_power_state != DRM_SWITCH_POWER_DYNAMIC_OFF)
 201                 return -EINVAL;
 202
 203         DRM_DEBUG("pid = %d, minor = %d\n", task_pid_nr(current), minor->index);
 204
 205         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
 206         if (!priv)
 207                 return -ENOMEM;
 208
 209         filp->private_data = priv;
 210         priv->filp = filp;
 211         priv->pid = get_pid(task_pid(current));
 212         priv->minor = minor;
 213
 214         /* for compatibility root is always authenticated */
 215         priv->authenticated = capable(CAP_SYS_ADMIN);
 216         priv->lock_count = 0;
 217
 218         INIT_LIST_HEAD(&priv->lhead);
 219         INIT_LIST_HEAD(&priv->fbs);
 220         mutex_init(&priv->fbs_lock);
 221         INIT_LIST_HEAD(&priv->blobs);
 222         INIT_LIST_HEAD(&priv->pending_event_list);
 223         INIT_LIST_HEAD(&priv->event_list);
 224         init_waitqueue_head(&priv->event_wait);
 225         priv->event_space = 4096; /* set aside 4k for event buffer */
 226
 227         mutex_init(&priv->event_read_lock);
 228
 229         if (drm_core_check_feature(dev, DRIVER_GEM))
 230                 drm_gem_open(dev, priv);
 231
 232         if (drm_core_check_feature(dev, DRIVER_SYNCOBJ))
 233                 drm_syncobj_open(priv);
 234
 235         if (drm_core_check_feature(dev, DRIVER_PRIME))
 236                 drm_prime_init_file_private(&priv->prime);
 237
 238         if (dev->driver->open) {
 239                 ret = dev->driver->open(dev, priv);
 240                 if (ret < 0)
 241                         goto out_prime_destroy;
 242         }
 243
 244         if (drm_is_primary_client(priv)) {
 245                 ret = drm_master_open(priv);
 246                 if (ret)
 247                         goto out_close;
 248         }
 249
 250         mutex_lock(&dev->filelist_mutex);
 251         list_add(&priv->lhead, &dev->filelist);
 252         mutex_unlock(&dev->filelist_mutex);
 253
 254 #ifdef __alpha__
 255         /*
 256          * Default the hose
 257          */
 258         if (!dev->hose) {
 259                 struct pci_dev *pci_dev;
 260                 pci_dev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, NULL);
 261                 if (pci_dev) {
 262                         dev->hose = pci_dev->sysdata;
 263                         pci_dev_put(pci_dev);
 264                 }
 265                 if (!dev->hose) {
 266                         struct pci_bus *b = list_entry(pci_root_buses.next,
 267                                 struct pci_bus, node);
 268                         if (b)
 269                                 dev->hose = b->sysdata;
 270                 }
 271         }
 272 #endif
 273
 274         return 0;
 275
 276 out_close:
 277         if (dev->driver->postclose)
 278                 dev->driver->postclose(dev, priv);
 279 out_prime_destroy:
 280         if (drm_core_check_feature(dev, DRIVER_PRIME))
 281                 drm_prime_destroy_file_private(&priv->prime);
 282         if (drm_core_check_feature(dev, DRIVER_SYNCOBJ))
 283                 drm_syncobj_release(priv);
 284         if (drm_core_check_feature(dev, DRIVER_GEM))
 285                 drm_gem_release(dev, priv);
 286         put_pid(priv->pid);
 287         kfree(priv);
 288         filp->private_data = NULL;
 289         return ret;
 290 }
 291
 292 static void drm_events_release(struct drm_file *file_priv)
 293 {
 294         struct drm_device *dev = file_priv->minor->dev;
 295         struct drm_pending_event *e, *et;
 296         unsigned long flags;
 297
 298         spin_lock_irqsave(&dev->event_lock, flags);
 299
 300         /* Unlink pending events */
 301         list_for_each_entry_safe(e, et, &file_priv->pending_event_list,
 302                                  pending_link) {
 303                 list_del(&e->pending_link);
 304                 e->file_priv = NULL;
 305         }
 306
 307         /* Remove unconsumed events */
 308         list_for_each_entry_safe(e, et, &file_priv->event_list, link) {
 309                 list_del(&e->link);
 310                 kfree(e);
 311         }
 312
 313         spin_unlock_irqrestore(&dev->event_lock, flags);
 314 }
 315
 316 static void drm_legacy_dev_reinit(struct drm_device *dev)
 317 {
 318         if (dev->irq_enabled)
 319                 drm_irq_uninstall(dev);
 320
 321         mutex_lock(&dev->struct_mutex);
 322
 323         drm_legacy_agp_clear(dev);
 324
 325         drm_legacy_sg_cleanup(dev);
 326         drm_legacy_vma_flush(dev);
 327         drm_legacy_dma_takedown(dev);
 328
 329         mutex_unlock(&dev->struct_mutex);
 330
 331         dev->sigdata.lock = NULL;
 332
 333         dev->context_flag = 0;
 334         dev->last_context = 0;
 335         dev->if_version = 0;
 336
 337         DRM_DEBUG("lastclose completed\n");
 338 }
 339
 340 void drm_lastclose(struct drm_device * dev)
 341 {
 342         DRM_DEBUG("\n");
 343
 344         if (dev->driver->lastclose)
 345                 dev->driver->lastclose(dev);
 346         DRM_DEBUG("driver lastclose completed\n");
 347
 348         if (drm_core_check_feature(dev, DRIVER_LEGACY))
 349                 drm_legacy_dev_reinit(dev);
 350 }
 351
 352 /**
 353  * drm_release - release method for DRM file
 354  * @inode: device inode
 355  * @filp: file pointer.
 356  *
 357  * This function must be used by drivers as their &file_operations.release
 358  * method. It frees any resources associated with the open file, and calls the
 359  * &drm_driver.postclose driver callback. If this is the last open file for the
 360  * DRM device also proceeds to call the &drm_driver.lastclose driver callback.
 361  *
 362  * RETURNS:
 363  *
 364  * Always succeeds and returns 0.
 365  */
 366 int drm_release(struct inode *inode, struct file *filp)
 367 {
 368         struct drm_file *file_priv = filp->private_data;
 369         struct drm_minor *minor = file_priv->minor;
 370         struct drm_device *dev = minor->dev;
 371
 372         mutex_lock(&drm_global_mutex);
 373
 374         DRM_DEBUG("open_count = %d\n", dev->open_count);
 375
 376         mutex_lock(&dev->filelist_mutex);
 377         list_del(&file_priv->lhead);
 378         mutex_unlock(&dev->filelist_mutex);
 379
 380         if (drm_core_check_feature(dev, DRIVER_LEGACY) &&
 381             dev->driver->preclose)
 382                 dev->driver->preclose(dev, file_priv);
 383
 384         /* ========================================================
 385          * Begin inline drm_release
 386          */
 387
 388         DRM_DEBUG("pid = %d, device = 0x%lx, open_count = %d\n",
 389                   task_pid_nr(current),
 390                   (long)old_encode_dev(file_priv->minor->kdev->devt),
 391                   dev->open_count);
 392
 393         if (drm_core_check_feature(dev, DRIVER_LEGACY))
 394                 drm_legacy_lock_release(dev, filp);
 395
 396         if (drm_core_check_feature(dev, DRIVER_HAVE_DMA))
 397                 drm_legacy_reclaim_buffers(dev, file_priv);
 398
 399         drm_events_release(file_priv);
 400
 401         if (drm_core_check_feature(dev, DRIVER_MODESET)) {
 402                 drm_fb_release(file_priv);
 403                 drm_property_destroy_user_blobs(dev, file_priv);
 404         }
 405
 406         if (drm_core_check_feature(dev, DRIVER_SYNCOBJ))
 407                 drm_syncobj_release(file_priv);
 408
 409         if (drm_core_check_feature(dev, DRIVER_GEM))
 410                 drm_gem_release(dev, file_priv);
 411
 412         drm_legacy_ctxbitmap_flush(dev, file_priv);
 413
 414         if (drm_is_primary_client(file_priv))
 415                 drm_master_release(file_priv);
 416
 417         if (dev->driver->postclose)
 418                 dev->driver->postclose(dev, file_priv);
 419
 420         if (drm_core_check_feature(dev, DRIVER_PRIME))
 421                 drm_prime_destroy_file_private(&file_priv->prime);
 422
 423         WARN_ON(!list_empty(&file_priv->event_list));
 424
 425         put_pid(file_priv->pid);
 426         kfree(file_priv);
 427
 428         /* ========================================================
 429          * End inline drm_release
 430          */
 431
 432         if (!--dev->open_count) {
 433                 drm_lastclose(dev);
 434                 if (drm_device_is_unplugged(dev))
 435                         drm_put_dev(dev);
 436         }
 437         mutex_unlock(&drm_global_mutex);
 438
 439         drm_minor_release(minor);
 440
 441         return 0;
 442 }
 443 EXPORT_SYMBOL(drm_release);
 444
 445 /**
 446  * drm_read - read method for DRM file
 447  * @filp: file pointer
 448  * @buffer: userspace destination pointer for the read
 449  * @count: count in bytes to read
 450  * @offset: offset to read
 451  *
 452  * This function must be used by drivers as their &file_operations.read
 453  * method iff they use DRM events for asynchronous signalling to userspace.
 454  * Since events are used by the KMS API for vblank and page flip completion this
 455  * means all modern display drivers must use it.
 456  *
 457  * @offset is ignored, DRM events are read like a pipe. Therefore drivers also
 458  * must set the &file_operation.llseek to no_llseek(). Polling support is
 459  * provided by drm_poll().
 460  *
 461  * This function will only ever read a full event. Therefore userspace must
 462  * supply a big enough buffer to fit any event to ensure forward progress. Since
 463  * the maximum event space is currently 4K it's recommended to just use that for
 464  * safety.
 465  *
 466  * RETURNS:
 467  *
 468  * Number of bytes read (always aligned to full events, and can be 0) or a
 469  * negative error code on failure.
 470  */
 471 ssize_t drm_read(struct file *filp, char __user *buffer,
 472                  size_t count, loff_t *offset)
 473 {
 474         struct drm_file *file_priv = filp->private_data;
 475         struct drm_device *dev = file_priv->minor->dev;
 476         ssize_t ret;
 477
 478         if (!access_ok(VERIFY_WRITE, buffer, count))
 479                 return -EFAULT;
 480
 481         ret = mutex_lock_interruptible(&file_priv->event_read_lock);
 482         if (ret)
 483                 return ret;
 484
 485         for (;;) {
 486                 struct drm_pending_event *e = NULL;
 487
 488                 spin_lock_irq(&dev->event_lock);
 489                 if (!list_empty(&file_priv->event_list)) {
 490                         e = list_first_entry(&file_priv->event_list,
 491                                         struct drm_pending_event, link);
 492                         file_priv->event_space += e->event->length;
 493                         list_del(&e->link);
 494                 }
 495                 spin_unlock_irq(&dev->event_lock);
 496
 497                 if (e == NULL) {
 498                         if (ret)
 499                                 break;
 500
 501                         if (filp->f_flags & O_NONBLOCK) {
 502                                 ret = -EAGAIN;
 503                                 break;
 504                         }
 505
 506                         mutex_unlock(&file_priv->event_read_lock);
 507                         ret = wait_event_interruptible(file_priv->event_wait,
 508                                                        !list_empty(&file_priv->event_list));
 509                         if (ret >= 0)
 510                                 ret = mutex_lock_interruptible(&file_priv->event_read_lock);
 511                         if (ret)
 512                                 return ret;
 513                 } else {
 514                         unsigned length = e->event->length;
 515
 516                         if (length > count - ret) {
 517 put_back_event:
 518                                 spin_lock_irq(&dev->event_lock);
 519                                 file_priv->event_space -= length;
 520                                 list_add(&e->link, &file_priv->event_list);
 521                                 spin_unlock_irq(&dev->event_lock);
 522                                 break;
 523                         }
 524
 525                         if (copy_to_user(buffer + ret, e->event, length)) {
 526                                 if (ret == 0)
 527                                         ret = -EFAULT;
 528                                 goto put_back_event;
 529                         }
 530
 531                         ret += length;
 532                         kfree(e);
 533                 }
 534         }
 535         mutex_unlock(&file_priv->event_read_lock);
 536
 537         return ret;
 538 }
 539 EXPORT_SYMBOL(drm_read);
 540
 541 /**
 542  * drm_poll - poll method for DRM file
 543  * @filp: file pointer
 544  * @wait: poll waiter table
 545  *
 546  * This function must be used by drivers as their &file_operations.read method
 547  * iff they use DRM events for asynchronous signalling to userspace.  Since
 548  * events are used by the KMS API for vblank and page flip completion this means
 549  * all modern display drivers must use it.
 550  *
 551  * See also drm_read().
 552  *
 553  * RETURNS:
 554  *
 555  * Mask of POLL flags indicating the current status of the file.
 556  */
 557 unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait)
 558 {
 559         struct drm_file *file_priv = filp->private_data;
 560         unsigned int mask = 0;
 561
 562         poll_wait(filp, &file_priv->event_wait, wait);
 563
 564         if (!list_empty(&file_priv->event_list))
 565                 mask |= POLLIN | POLLRDNORM;
 566
 567         return mask;
 568 }
 569 EXPORT_SYMBOL(drm_poll);
 570
 571 /**
 572  * drm_event_reserve_init_locked - init a DRM event and reserve space for it
 573  * @dev: DRM device
 574  * @file_priv: DRM file private data
 575  * @p: tracking structure for the pending event
 576  * @e: actual event data to deliver to userspace
 577  *
 578  * This function prepares the passed in event for eventual delivery. If the event
 579  * doesn't get delivered (because the IOCTL fails later on, before queuing up
 580  * anything) then the even must be cancelled and freed using
 581  * drm_event_cancel_free(). Successfully initialized events should be sent out
 582  * using drm_send_event() or drm_send_event_locked() to signal completion of the
 583  * asynchronous event to userspace.
 584  *
 585  * If callers embedded @p into a larger structure it must be allocated with
 586  * kmalloc and @p must be the first member element.
 587  *
 588  * This is the locked version of drm_event_reserve_init() for callers which
 589  * already hold &drm_device.event_lock.
 590  *
 591  * RETURNS:
 592  *
 593  * 0 on success or a negative error code on failure.
 594  */
 595 int drm_event_reserve_init_locked(struct drm_device *dev,
 596                                   struct drm_file *file_priv,
 597                                   struct drm_pending_event *p,
 598                                   struct drm_event *e)
 599 {
 600         if (file_priv->event_space < e->length)
 601                 return -ENOMEM;
 602
 603         file_priv->event_space -= e->length;
 604
 605         p->event = e;
 606         list_add(&p->pending_link, &file_priv->pending_event_list);
 607         p->file_priv = file_priv;
 608
 609         return 0;
 610 }
 611 EXPORT_SYMBOL(drm_event_reserve_init_locked);
 612
 613 /**
 614  * drm_event_reserve_init - init a DRM event and reserve space for it
 615  * @dev: DRM device
 616  * @file_priv: DRM file private data
 617  * @p: tracking structure for the pending event
 618  * @e: actual event data to deliver to userspace
 619  *
 620  * This function prepares the passed in event for eventual delivery. If the event
 621  * doesn't get delivered (because the IOCTL fails later on, before queuing up
 622  * anything) then the even must be cancelled and freed using
 623  * drm_event_cancel_free(). Successfully initialized events should be sent out
 624  * using drm_send_event() or drm_send_event_locked() to signal completion of the
 625  * asynchronous event to userspace.
 626  *
 627  * If callers embedded @p into a larger structure it must be allocated with
 628  * kmalloc and @p must be the first member element.
 629  *
 630  * Callers which already hold &drm_device.event_lock should use
 631  * drm_event_reserve_init_locked() instead.
 632  *
 633  * RETURNS:
 634  *
 635  * 0 on success or a negative error code on failure.
 636  */
 637 int drm_event_reserve_init(struct drm_device *dev,
 638                            struct drm_file *file_priv,
 639                            struct drm_pending_event *p,
 640                            struct drm_event *e)
 641 {
 642         unsigned long flags;
 643         int ret;
 644
 645         spin_lock_irqsave(&dev->event_lock, flags);
 646         ret = drm_event_reserve_init_locked(dev, file_priv, p, e);
 647         spin_unlock_irqrestore(&dev->event_lock, flags);
 648
 649         return ret;
 650 }
 651 EXPORT_SYMBOL(drm_event_reserve_init);
 652
 653 /**
 654  * drm_event_cancel_free - free a DRM event and release it's space
 655  * @dev: DRM device
 656  * @p: tracking structure for the pending event
 657  *
 658  * This function frees the event @p initialized with drm_event_reserve_init()
 659  * and releases any allocated space. It is used to cancel an event when the
 660  * nonblocking operation could not be submitted and needed to be aborted.
 661  */
 662 void drm_event_cancel_free(struct drm_device *dev,
 663                            struct drm_pending_event *p)
 664 {
 665         unsigned long flags;
 666         spin_lock_irqsave(&dev->event_lock, flags);
 667         if (p->file_priv) {
 668                 p->file_priv->event_space += p->event->length;
 669                 list_del(&p->pending_link);
 670         }
 671         spin_unlock_irqrestore(&dev->event_lock, flags);
 672
 673         if (p->fence)
 674                 dma_fence_put(p->fence);
 675
 676         kfree(p);
 677 }
 678 EXPORT_SYMBOL(drm_event_cancel_free);
 679
 680 /**
 681  * drm_send_event_locked - send DRM event to file descriptor
 682  * @dev: DRM device
 683  * @e: DRM event to deliver
 684  *
 685  * This function sends the event @e, initialized with drm_event_reserve_init(),
 686  * to its associated userspace DRM file. Callers must already hold
 687  * &drm_device.event_lock, see drm_send_event() for the unlocked version.
 688  *
 689  * Note that the core will take care of unlinking and disarming events when the
 690  * corresponding DRM file is closed. Drivers need not worry about whether the
 691  * DRM file for this event still exists and can call this function upon
 692  * completion of the asynchronous work unconditionally.
 693  */
 694 void drm_send_event_locked(struct drm_device *dev, struct drm_pending_event *e)
 695 {
 696         assert_spin_locked(&dev->event_lock);
 697
 698         if (e->completion) {
 699                 complete_all(e->completion);
 700                 e->completion_release(e->completion);
 701                 e->completion = NULL;
 702         }
 703
 704         if (e->fence) {
 705                 dma_fence_signal(e->fence);
 706                 dma_fence_put(e->fence);
 707         }
 708
 709         if (!e->file_priv) {
 710                 kfree(e);
 711                 return;
 712         }
 713
 714         list_del(&e->pending_link);
 715         list_add_tail(&e->link,
 716                       &e->file_priv->event_list);
 717         wake_up_interruptible(&e->file_priv->event_wait);
 718 }
 719 EXPORT_SYMBOL(drm_send_event_locked);
 720
 721 /**
 722  * drm_send_event - send DRM event to file descriptor
 723  * @dev: DRM device
 724  * @e: DRM event to deliver
 725  *
 726  * This function sends the event @e, initialized with drm_event_reserve_init(),
 727  * to its associated userspace DRM file. This function acquires
 728  * &drm_device.event_lock, see drm_send_event_locked() for callers which already
 729  * hold this lock.
 730  *
 731  * Note that the core will take care of unlinking and disarming events when the
 732  * corresponding DRM file is closed. Drivers need not worry about whether the
 733  * DRM file for this event still exists and can call this function upon
 734  * completion of the asynchronous work unconditionally.
 735  */
 736 void drm_send_event(struct drm_device *dev, struct drm_pending_event *e)
 737 {
 738         unsigned long irqflags;
 739
 740         spin_lock_irqsave(&dev->event_lock, irqflags);
 741         drm_send_event_locked(dev, e);
 742         spin_unlock_irqrestore(&dev->event_lock, irqflags);
 743 }
 744 EXPORT_SYMBOL(drm_send_event);