drivers/gpu/drm/drm_fops.c

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