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  * drm_new_set_master - Allocate a new master object and become master for the
 172  * associated master realm.
 173  *
 174  * @dev: The associated device.
 175  * @fpriv: File private identifying the client.
 176  *
 177  * This function must be called with dev::struct_mutex held.
 178  * Returns negative error code on failure. Zero on success.
 179  */
 180 int drm_new_set_master(struct drm_device *dev, struct drm_file *fpriv)
 181 {
 182         struct drm_master *old_master;
 183         int ret;
 184
 185         lockdep_assert_held_once(&dev->master_mutex);
 186
 187         /* create a new master */
 188         fpriv->minor->master = drm_master_create(fpriv->minor);
 189         if (!fpriv->minor->master)
 190                 return -ENOMEM;
 191
 192         /* take another reference for the copy in the local file priv */
 193         old_master = fpriv->master;
 194         fpriv->master = drm_master_get(fpriv->minor->master);
 195
 196         if (dev->driver->master_create) {
 197                 ret = dev->driver->master_create(dev, fpriv->master);
 198                 if (ret)
 199                         goto out_err;
 200         }
 201         if (dev->driver->master_set) {
 202                 ret = dev->driver->master_set(dev, fpriv, true);
 203                 if (ret)
 204                         goto out_err;
 205         }
 206
 207         fpriv->is_master = 1;
 208         fpriv->allowed_master = 1;
 209         fpriv->authenticated = 1;
 210         if (old_master)
 211                 drm_master_put(&old_master);
 212
 213         return 0;
 214
 215 out_err:
 216         /* drop both references and restore old master on failure */
 217         drm_master_put(&fpriv->minor->master);
 218         drm_master_put(&fpriv->master);
 219         fpriv->master = old_master;
 220
 221         return ret;
 222 }
 223
 224 /*
 225  * Called whenever a process opens /dev/drm.
 226  *
 227  * \param filp file pointer.
 228  * \param minor acquired minor-object.
 229  * \return zero on success or a negative number on failure.
 230  *
 231  * Creates and initializes a drm_file structure for the file private data in \p
 232  * filp and add it into the double linked list in \p dev.
 233  */
 234 static int drm_open_helper(struct file *filp, struct drm_minor *minor)
 235 {
 236         struct drm_device *dev = minor->dev;
 237         struct drm_file *priv;
 238         int ret;
 239
 240         if (filp->f_flags & O_EXCL)
 241                 return -EBUSY;  /* No exclusive opens */
 242         if (!drm_cpu_valid())
 243                 return -EINVAL;
 244         if (dev->switch_power_state != DRM_SWITCH_POWER_ON && dev->switch_power_state != DRM_SWITCH_POWER_DYNAMIC_OFF)
 245                 return -EINVAL;
 246
 247         DRM_DEBUG("pid = %d, minor = %d\n", task_pid_nr(current), minor->index);
 248
 249         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
 250         if (!priv)
 251                 return -ENOMEM;
 252
 253         filp->private_data = priv;
 254         priv->filp = filp;
 255         priv->uid = current_euid();
 256         priv->pid = get_pid(task_pid(current));
 257         priv->minor = minor;
 258
 259         /* for compatibility root is always authenticated */
 260         priv->authenticated = capable(CAP_SYS_ADMIN);
 261         priv->lock_count = 0;
 262
 263         INIT_LIST_HEAD(&priv->lhead);
 264         INIT_LIST_HEAD(&priv->fbs);
 265         mutex_init(&priv->fbs_lock);
 266         INIT_LIST_HEAD(&priv->blobs);
 267         INIT_LIST_HEAD(&priv->pending_event_list);
 268         INIT_LIST_HEAD(&priv->event_list);
 269         init_waitqueue_head(&priv->event_wait);
 270         priv->event_space = 4096; /* set aside 4k for event buffer */
 271
 272         mutex_init(&priv->event_read_lock);
 273
 274         if (drm_core_check_feature(dev, DRIVER_GEM))
 275                 drm_gem_open(dev, priv);
 276
 277         if (drm_core_check_feature(dev, DRIVER_PRIME))
 278                 drm_prime_init_file_private(&priv->prime);
 279
 280         if (dev->driver->open) {
 281                 ret = dev->driver->open(dev, priv);
 282                 if (ret < 0)
 283                         goto out_prime_destroy;
 284         }
 285
 286         /* if there is no current master make this fd it, but do not create
 287          * any master object for render clients */
 288         mutex_lock(&dev->master_mutex);
 289         if (drm_is_primary_client(priv) && !priv->minor->master) {
 290                 /* create a new master */
 291                 ret = drm_new_set_master(dev, priv);
 292                 if (ret)
 293                         goto out_close;
 294         } else if (drm_is_primary_client(priv)) {
 295                 /* get a reference to the master */
 296                 priv->master = drm_master_get(priv->minor->master);
 297         }
 298         mutex_unlock(&dev->master_mutex);
 299
 300         mutex_lock(&dev->filelist_mutex);
 301         list_add(&priv->lhead, &dev->filelist);
 302         mutex_unlock(&dev->filelist_mutex);
 303
 304 #ifdef __alpha__
 305         /*
 306          * Default the hose
 307          */
 308         if (!dev->hose) {
 309                 struct pci_dev *pci_dev;
 310                 pci_dev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, NULL);
 311                 if (pci_dev) {
 312                         dev->hose = pci_dev->sysdata;
 313                         pci_dev_put(pci_dev);
 314                 }
 315                 if (!dev->hose) {
 316                         struct pci_bus *b = list_entry(pci_root_buses.next,
 317                                 struct pci_bus, node);
 318                         if (b)
 319                                 dev->hose = b->sysdata;
 320                 }
 321         }
 322 #endif
 323
 324         return 0;
 325
 326 out_close:
 327         mutex_unlock(&dev->master_mutex);
 328         if (dev->driver->postclose)
 329                 dev->driver->postclose(dev, priv);
 330 out_prime_destroy:
 331         if (drm_core_check_feature(dev, DRIVER_PRIME))
 332                 drm_prime_destroy_file_private(&priv->prime);
 333         if (drm_core_check_feature(dev, DRIVER_GEM))
 334                 drm_gem_release(dev, priv);
 335         put_pid(priv->pid);
 336         kfree(priv);
 337         filp->private_data = NULL;
 338         return ret;
 339 }
 340
 341 static void drm_events_release(struct drm_file *file_priv)
 342 {
 343         struct drm_device *dev = file_priv->minor->dev;
 344         struct drm_pending_event *e, *et;
 345         unsigned long flags;
 346
 347         spin_lock_irqsave(&dev->event_lock, flags);
 348
 349         /* Unlink pending events */
 350         list_for_each_entry_safe(e, et, &file_priv->pending_event_list,
 351                                  pending_link) {
 352                 list_del(&e->pending_link);
 353                 e->file_priv = NULL;
 354         }
 355
 356         /* Remove unconsumed events */
 357         list_for_each_entry_safe(e, et, &file_priv->event_list, link) {
 358                 list_del(&e->link);
 359                 kfree(e);
 360         }
 361
 362         spin_unlock_irqrestore(&dev->event_lock, flags);
 363 }
 364
 365 /*
 366  * drm_legacy_dev_reinit
 367  *
 368  * Reinitializes a legacy/ums drm device in it's lastclose function.
 369  */
 370 static void drm_legacy_dev_reinit(struct drm_device *dev)
 371 {
 372         if (dev->irq_enabled)
 373                 drm_irq_uninstall(dev);
 374
 375         mutex_lock(&dev->struct_mutex);
 376
 377         drm_legacy_agp_clear(dev);
 378
 379         drm_legacy_sg_cleanup(dev);
 380         drm_legacy_vma_flush(dev);
 381         drm_legacy_dma_takedown(dev);
 382
 383         mutex_unlock(&dev->struct_mutex);
 384
 385         dev->sigdata.lock = NULL;
 386
 387         dev->context_flag = 0;
 388         dev->last_context = 0;
 389         dev->if_version = 0;
 390
 391         DRM_DEBUG("lastclose completed\n");
 392 }
 393
 394 /*
 395  * Take down the DRM device.
 396  *
 397  * \param dev DRM device structure.
 398  *
 399  * Frees every resource in \p dev.
 400  *
 401  * \sa drm_device
 402  */
 403 void drm_lastclose(struct drm_device * dev)
 404 {
 405         DRM_DEBUG("\n");
 406
 407         if (dev->driver->lastclose)
 408                 dev->driver->lastclose(dev);
 409         DRM_DEBUG("driver lastclose completed\n");
 410
 411         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 412                 drm_legacy_dev_reinit(dev);
 413 }
 414
 415 /**
 416  * drm_release - release method for DRM file
 417  * @inode: device inode
 418  * @filp: file pointer.
 419  *
 420  * This function must be used by drivers as their .release() #file_operations
 421  * method. It frees any resources associated with the open file, and if this is
 422  * the last open file for the DRM device also proceeds to call drm_lastclose().
 423  *
 424  * RETURNS:
 425  *
 426  * Always succeeds and returns 0.
 427  */
 428 int drm_release(struct inode *inode, struct file *filp)
 429 {
 430         struct drm_file *file_priv = filp->private_data;
 431         struct drm_minor *minor = file_priv->minor;
 432         struct drm_device *dev = minor->dev;
 433
 434         mutex_lock(&drm_global_mutex);
 435
 436         DRM_DEBUG("open_count = %d\n", dev->open_count);
 437
 438         mutex_lock(&dev->filelist_mutex);
 439         list_del(&file_priv->lhead);
 440         mutex_unlock(&dev->filelist_mutex);
 441
 442         mutex_lock(&dev->struct_mutex);
 443         if (file_priv->magic)
 444                 idr_remove(&file_priv->master->magic_map, file_priv->magic);
 445         mutex_unlock(&dev->struct_mutex);
 446
 447         if (dev->driver->preclose)
 448                 dev->driver->preclose(dev, file_priv);
 449
 450         /* ========================================================
 451          * Begin inline drm_release
 452          */
 453
 454         DRM_DEBUG("pid = %d, device = 0x%lx, open_count = %d\n",
 455                   task_pid_nr(current),
 456                   (long)old_encode_dev(file_priv->minor->kdev->devt),
 457                   dev->open_count);
 458
 459         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 460                 drm_legacy_lock_release(dev, filp);
 461
 462         if (drm_core_check_feature(dev, DRIVER_HAVE_DMA))
 463                 drm_legacy_reclaim_buffers(dev, file_priv);
 464
 465         drm_events_release(file_priv);
 466
 467         if (drm_core_check_feature(dev, DRIVER_MODESET)) {
 468                 drm_fb_release(file_priv);
 469                 drm_property_destroy_user_blobs(dev, file_priv);
 470         }
 471
 472         if (drm_core_check_feature(dev, DRIVER_GEM))
 473                 drm_gem_release(dev, file_priv);
 474
 475         drm_legacy_ctxbitmap_flush(dev, file_priv);
 476
 477         mutex_lock(&dev->master_mutex);
 478
 479         if (file_priv->is_master) {
 480                 struct drm_master *master = file_priv->master;
 481
 482                 /*
 483                  * Since the master is disappearing, so is the
 484                  * possibility to lock.
 485                  */
 486                 mutex_lock(&dev->struct_mutex);
 487                 if (master->lock.hw_lock) {
 488                         if (dev->sigdata.lock == master->lock.hw_lock)
 489                                 dev->sigdata.lock = NULL;
 490                         master->lock.hw_lock = NULL;
 491                         master->lock.file_priv = NULL;
 492                         wake_up_interruptible_all(&master->lock.lock_queue);
 493                 }
 494                 mutex_unlock(&dev->struct_mutex);
 495
 496                 if (file_priv->minor->master == file_priv->master) {
 497                         /* drop the reference held my the minor */
 498                         if (dev->driver->master_drop)
 499                                 dev->driver->master_drop(dev, file_priv, true);
 500                         drm_master_put(&file_priv->minor->master);
 501                 }
 502         }
 503
 504         /* drop the master reference held by the file priv */
 505         if (file_priv->master)
 506                 drm_master_put(&file_priv->master);
 507         file_priv->is_master = 0;
 508         mutex_unlock(&dev->master_mutex);
 509
 510         if (dev->driver->postclose)
 511                 dev->driver->postclose(dev, file_priv);
 512
 513
 514         if (drm_core_check_feature(dev, DRIVER_PRIME))
 515                 drm_prime_destroy_file_private(&file_priv->prime);
 516
 517         WARN_ON(!list_empty(&file_priv->event_list));
 518
 519         put_pid(file_priv->pid);
 520         kfree(file_priv);
 521
 522         /* ========================================================
 523          * End inline drm_release
 524          */
 525
 526         if (!--dev->open_count) {
 527                 drm_lastclose(dev);
 528                 if (drm_device_is_unplugged(dev))
 529                         drm_put_dev(dev);
 530         }
 531         mutex_unlock(&drm_global_mutex);
 532
 533         drm_minor_release(minor);
 534
 535         return 0;
 536 }
 537 EXPORT_SYMBOL(drm_release);
 538
 539 /**
 540  * drm_read - read method for DRM file
 541  * @filp: file pointer
 542  * @buffer: userspace destination pointer for the read
 543  * @count: count in bytes to read
 544  * @offset: offset to read
 545  *
 546  * This function must be used by drivers as their .read() #file_operations
 547  * method iff they use DRM events for asynchronous signalling to userspace.
 548  * Since events are used by the KMS API for vblank and page flip completion this
 549  * means all modern display drivers must use it.
 550  *
 551  * @offset is ignore, DRM events are read like a pipe. Therefore drivers also
 552  * must set the .llseek() #file_operation to no_llseek(). Polling support is
 553  * provided by drm_poll().
 554  *
 555  * This function will only ever read a full event. Therefore userspace must
 556  * supply a big enough buffer to fit any event to ensure forward progress. Since
 557  * the maximum event space is currently 4K it's recommended to just use that for
 558  * safety.
 559  *
 560  * RETURNS:
 561  *
 562  * Number of bytes read (always aligned to full events, and can be 0) or a
 563  * negative error code on failure.
 564  */
 565 ssize_t drm_read(struct file *filp, char __user *buffer,
 566                  size_t count, loff_t *offset)
 567 {
 568         struct drm_file *file_priv = filp->private_data;
 569         struct drm_device *dev = file_priv->minor->dev;
 570         ssize_t ret;
 571
 572         if (!access_ok(VERIFY_WRITE, buffer, count))
 573                 return -EFAULT;
 574
 575         ret = mutex_lock_interruptible(&file_priv->event_read_lock);
 576         if (ret)
 577                 return ret;
 578
 579         for (;;) {
 580                 struct drm_pending_event *e = NULL;
 581
 582                 spin_lock_irq(&dev->event_lock);
 583                 if (!list_empty(&file_priv->event_list)) {
 584                         e = list_first_entry(&file_priv->event_list,
 585                                         struct drm_pending_event, link);
 586                         file_priv->event_space += e->event->length;
 587                         list_del(&e->link);
 588                 }
 589                 spin_unlock_irq(&dev->event_lock);
 590
 591                 if (e == NULL) {
 592                         if (ret)
 593                                 break;
 594
 595                         if (filp->f_flags & O_NONBLOCK) {
 596                                 ret = -EAGAIN;
 597                                 break;
 598                         }
 599
 600                         mutex_unlock(&file_priv->event_read_lock);
 601                         ret = wait_event_interruptible(file_priv->event_wait,
 602                                                        !list_empty(&file_priv->event_list));
 603                         if (ret >= 0)
 604                                 ret = mutex_lock_interruptible(&file_priv->event_read_lock);
 605                         if (ret)
 606                                 return ret;
 607                 } else {
 608                         unsigned length = e->event->length;
 609
 610                         if (length > count - ret) {
 611 put_back_event:
 612                                 spin_lock_irq(&dev->event_lock);
 613                                 file_priv->event_space -= length;
 614                                 list_add(&e->link, &file_priv->event_list);
 615                                 spin_unlock_irq(&dev->event_lock);
 616                                 break;
 617                         }
 618
 619                         if (copy_to_user(buffer + ret, e->event, length)) {
 620                                 if (ret == 0)
 621                                         ret = -EFAULT;
 622                                 goto put_back_event;
 623                         }
 624
 625                         ret += length;
 626                         kfree(e);
 627                 }
 628         }
 629         mutex_unlock(&file_priv->event_read_lock);
 630
 631         return ret;
 632 }
 633 EXPORT_SYMBOL(drm_read);
 634
 635 /**
 636  * drm_poll - poll method for DRM file
 637  * @filp: file pointer
 638  * @wait: poll waiter table
 639  *
 640  * This function must be used by drivers as their .read() #file_operations
 641  * method iff they use DRM events for asynchronous signalling to userspace.
 642  * Since events are used by the KMS API for vblank and page flip completion this
 643  * means all modern display drivers must use it.
 644  *
 645  * See also drm_read().
 646  *
 647  * RETURNS:
 648  *
 649  * Mask of POLL flags indicating the current status of the file.
 650  */
 651 unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait)
 652 {
 653         struct drm_file *file_priv = filp->private_data;
 654         unsigned int mask = 0;
 655
 656         poll_wait(filp, &file_priv->event_wait, wait);
 657
 658         if (!list_empty(&file_priv->event_list))
 659                 mask |= POLLIN | POLLRDNORM;
 660
 661         return mask;
 662 }
 663 EXPORT_SYMBOL(drm_poll);
 664
 665 /**
 666  * drm_event_reserve_init_locked - init a DRM event and reserve space for it
 667  * @dev: DRM device
 668  * @file_priv: DRM file private data
 669  * @p: tracking structure for the pending event
 670  * @e: actual event data to deliver to userspace
 671  *
 672  * This function prepares the passed in event for eventual delivery. If the event
 673  * doesn't get delivered (because the IOCTL fails later on, before queuing up
 674  * anything) then the even must be cancelled and freed using
 675  * drm_event_cancel_free(). Successfully initialized events should be sent out
 676  * using drm_send_event() or drm_send_event_locked() to signal completion of the
 677  * asynchronous event to userspace.
 678  *
 679  * If callers embedded @p into a larger structure it must be allocated with
 680  * kmalloc and @p must be the first member element.
 681  *
 682  * This is the locked version of drm_event_reserve_init() for callers which
 683  * already hold dev->event_lock.
 684  *
 685  * RETURNS:
 686  *
 687  * 0 on success or a negative error code on failure.
 688  */
 689 int drm_event_reserve_init_locked(struct drm_device *dev,
 690                                   struct drm_file *file_priv,
 691                                   struct drm_pending_event *p,
 692                                   struct drm_event *e)
 693 {
 694         if (file_priv->event_space < e->length)
 695                 return -ENOMEM;
 696
 697         file_priv->event_space -= e->length;
 698
 699         p->event = e;
 700         list_add(&p->pending_link, &file_priv->pending_event_list);
 701         p->file_priv = file_priv;
 702
 703         return 0;
 704 }
 705 EXPORT_SYMBOL(drm_event_reserve_init_locked);
 706
 707 /**
 708  * drm_event_reserve_init - init a DRM event and reserve space for it
 709  * @dev: DRM device
 710  * @file_priv: DRM file private data
 711  * @p: tracking structure for the pending event
 712  * @e: actual event data to deliver to userspace
 713  *
 714  * This function prepares the passed in event for eventual delivery. If the event
 715  * doesn't get delivered (because the IOCTL fails later on, before queuing up
 716  * anything) then the even must be cancelled and freed using
 717  * drm_event_cancel_free(). Successfully initialized events should be sent out
 718  * using drm_send_event() or drm_send_event_locked() to signal completion of the
 719  * asynchronous event to userspace.
 720  *
 721  * If callers embedded @p into a larger structure it must be allocated with
 722  * kmalloc and @p must be the first member element.
 723  *
 724  * Callers which already hold dev->event_lock should use
 725  * drm_event_reserve_init() instead.
 726  *
 727  * RETURNS:
 728  *
 729  * 0 on success or a negative error code on failure.
 730  */
 731 int drm_event_reserve_init(struct drm_device *dev,
 732                            struct drm_file *file_priv,
 733                            struct drm_pending_event *p,
 734                            struct drm_event *e)
 735 {
 736         unsigned long flags;
 737         int ret;
 738
 739         spin_lock_irqsave(&dev->event_lock, flags);
 740         ret = drm_event_reserve_init_locked(dev, file_priv, p, e);
 741         spin_unlock_irqrestore(&dev->event_lock, flags);
 742
 743         return ret;
 744 }
 745 EXPORT_SYMBOL(drm_event_reserve_init);
 746
 747 /**
 748  * drm_event_cancel_free - free a DRM event and release it's space
 749  * @dev: DRM device
 750  * @p: tracking structure for the pending event
 751  *
 752  * This function frees the event @p initialized with drm_event_reserve_init()
 753  * and releases any allocated space.
 754  */
 755 void drm_event_cancel_free(struct drm_device *dev,
 756                            struct drm_pending_event *p)
 757 {
 758         unsigned long flags;
 759         spin_lock_irqsave(&dev->event_lock, flags);
 760         if (p->file_priv) {
 761                 p->file_priv->event_space += p->event->length;
 762                 list_del(&p->pending_link);
 763         }
 764         spin_unlock_irqrestore(&dev->event_lock, flags);
 765         kfree(p);
 766 }
 767 EXPORT_SYMBOL(drm_event_cancel_free);
 768
 769 /**
 770  * drm_send_event_locked - send DRM event to file descriptor
 771  * @dev: DRM device
 772  * @e: DRM event to deliver
 773  *
 774  * This function sends the event @e, initialized with drm_event_reserve_init(),
 775  * to its associated userspace DRM file. Callers must already hold
 776  * dev->event_lock, see drm_send_event() for the unlocked version.
 777  *
 778  * Note that the core will take care of unlinking and disarming events when the
 779  * corresponding DRM file is closed. Drivers need not worry about whether the
 780  * DRM file for this event still exists and can call this function upon
 781  * completion of the asynchronous work unconditionally.
 782  */
 783 void drm_send_event_locked(struct drm_device *dev, struct drm_pending_event *e)
 784 {
 785         assert_spin_locked(&dev->event_lock);
 786
 787         if (e->completion) {
 788                 /* ->completion might disappear as soon as it signalled. */
 789                 complete_all(e->completion);
 790                 e->completion = NULL;
 791         }
 792
 793         if (e->fence) {
 794                 fence_signal(e->fence);
 795                 fence_put(e->fence);
 796         }
 797
 798         if (!e->file_priv) {
 799                 kfree(e);
 800                 return;
 801         }
 802
 803         list_del(&e->pending_link);
 804         list_add_tail(&e->link,
 805                       &e->file_priv->event_list);
 806         wake_up_interruptible(&e->file_priv->event_wait);
 807 }
 808 EXPORT_SYMBOL(drm_send_event_locked);
 809
 810 /**
 811  * drm_send_event - send DRM event to file descriptor
 812  * @dev: DRM device
 813  * @e: DRM event to deliver
 814  *
 815  * This function sends the event @e, initialized with drm_event_reserve_init(),
 816  * to its associated userspace DRM file. This function acquires dev->event_lock,
 817  * see drm_send_event_locked() for callers which already hold this lock.
 818  *
 819  * Note that the core will take care of unlinking and disarming events when the
 820  * corresponding DRM file is closed. Drivers need not worry about whether the
 821  * DRM file for this event still exists and can call this function upon
 822  * completion of the asynchronous work unconditionally.
 823  */
 824 void drm_send_event(struct drm_device *dev, struct drm_pending_event *e)
 825 {
 826         unsigned long irqflags;
 827
 828         spin_lock_irqsave(&dev->event_lock, irqflags);
 829         drm_send_event_locked(dev, e);
 830         spin_unlock_irqrestore(&dev->event_lock, irqflags);
 831 }
 832 EXPORT_SYMBOL(drm_send_event);