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_master_release(struct drm_device *dev, struct file *filp)
 342 {
 343         struct drm_file *file_priv = filp->private_data;
 344
 345         if (drm_legacy_i_have_hw_lock(dev, file_priv)) {
 346                 DRM_DEBUG("File %p released, freeing lock for context %d\n",
 347                           filp, _DRM_LOCKING_CONTEXT(file_priv->master->lock.hw_lock->lock));
 348                 drm_legacy_lock_free(&file_priv->master->lock,
 349                                      _DRM_LOCKING_CONTEXT(file_priv->master->lock.hw_lock->lock));
 350         }
 351 }
 352
 353 static void drm_events_release(struct drm_file *file_priv)
 354 {
 355         struct drm_device *dev = file_priv->minor->dev;
 356         struct drm_pending_event *e, *et;
 357         unsigned long flags;
 358
 359         spin_lock_irqsave(&dev->event_lock, flags);
 360
 361         /* Unlink pending events */
 362         list_for_each_entry_safe(e, et, &file_priv->pending_event_list,
 363                                  pending_link) {
 364                 list_del(&e->pending_link);
 365                 e->file_priv = NULL;
 366         }
 367
 368         /* Remove unconsumed events */
 369         list_for_each_entry_safe(e, et, &file_priv->event_list, link) {
 370                 list_del(&e->link);
 371                 e->destroy(e);
 372         }
 373
 374         spin_unlock_irqrestore(&dev->event_lock, flags);
 375 }
 376
 377 /*
 378  * drm_legacy_dev_reinit
 379  *
 380  * Reinitializes a legacy/ums drm device in it's lastclose function.
 381  */
 382 static void drm_legacy_dev_reinit(struct drm_device *dev)
 383 {
 384         if (dev->irq_enabled)
 385                 drm_irq_uninstall(dev);
 386
 387         mutex_lock(&dev->struct_mutex);
 388
 389         drm_legacy_agp_clear(dev);
 390
 391         drm_legacy_sg_cleanup(dev);
 392         drm_legacy_vma_flush(dev);
 393         drm_legacy_dma_takedown(dev);
 394
 395         mutex_unlock(&dev->struct_mutex);
 396
 397         dev->sigdata.lock = NULL;
 398
 399         dev->context_flag = 0;
 400         dev->last_context = 0;
 401         dev->if_version = 0;
 402
 403         DRM_DEBUG("lastclose completed\n");
 404 }
 405
 406 /*
 407  * Take down the DRM device.
 408  *
 409  * \param dev DRM device structure.
 410  *
 411  * Frees every resource in \p dev.
 412  *
 413  * \sa drm_device
 414  */
 415 void drm_lastclose(struct drm_device * dev)
 416 {
 417         DRM_DEBUG("\n");
 418
 419         if (dev->driver->lastclose)
 420                 dev->driver->lastclose(dev);
 421         DRM_DEBUG("driver lastclose completed\n");
 422
 423         if (!drm_core_check_feature(dev, DRIVER_MODESET))
 424                 drm_legacy_dev_reinit(dev);
 425 }
 426
 427 /**
 428  * drm_release - release method for DRM file
 429  * @inode: device inode
 430  * @filp: file pointer.
 431  *
 432  * This function must be used by drivers as their .release() #file_operations
 433  * method. It frees any resources associated with the open file, and if this is
 434  * the last open file for the DRM device also proceeds to call drm_lastclose().
 435  *
 436  * RETURNS:
 437  *
 438  * Always succeeds and returns 0.
 439  */
 440 int drm_release(struct inode *inode, struct file *filp)
 441 {
 442         struct drm_file *file_priv = filp->private_data;
 443         struct drm_minor *minor = file_priv->minor;
 444         struct drm_device *dev = minor->dev;
 445
 446         mutex_lock(&drm_global_mutex);
 447
 448         DRM_DEBUG("open_count = %d\n", dev->open_count);
 449
 450         mutex_lock(&dev->filelist_mutex);
 451         list_del(&file_priv->lhead);
 452         mutex_unlock(&dev->filelist_mutex);
 453
 454         mutex_lock(&dev->struct_mutex);
 455         if (file_priv->magic)
 456                 idr_remove(&file_priv->master->magic_map, file_priv->magic);
 457         mutex_unlock(&dev->struct_mutex);
 458
 459         if (dev->driver->preclose)
 460                 dev->driver->preclose(dev, file_priv);
 461
 462         /* ========================================================
 463          * Begin inline drm_release
 464          */
 465
 466         DRM_DEBUG("pid = %d, device = 0x%lx, open_count = %d\n",
 467                   task_pid_nr(current),
 468                   (long)old_encode_dev(file_priv->minor->kdev->devt),
 469                   dev->open_count);
 470
 471         /* if the master has gone away we can't do anything with the lock */
 472         if (file_priv->minor->master)
 473                 drm_master_release(dev, filp);
 474
 475         if (drm_core_check_feature(dev, DRIVER_HAVE_DMA))
 476                 drm_legacy_reclaim_buffers(dev, file_priv);
 477
 478         drm_events_release(file_priv);
 479
 480         if (drm_core_check_feature(dev, DRIVER_MODESET)) {
 481                 drm_fb_release(file_priv);
 482                 drm_property_destroy_user_blobs(dev, file_priv);
 483         }
 484
 485         if (drm_core_check_feature(dev, DRIVER_GEM))
 486                 drm_gem_release(dev, file_priv);
 487
 488         drm_legacy_ctxbitmap_flush(dev, file_priv);
 489
 490         mutex_lock(&dev->master_mutex);
 491
 492         if (file_priv->is_master) {
 493                 struct drm_master *master = file_priv->master;
 494
 495                 /*
 496                  * Since the master is disappearing, so is the
 497                  * possibility to lock.
 498                  */
 499                 mutex_lock(&dev->struct_mutex);
 500                 if (master->lock.hw_lock) {
 501                         if (dev->sigdata.lock == master->lock.hw_lock)
 502                                 dev->sigdata.lock = NULL;
 503                         master->lock.hw_lock = NULL;
 504                         master->lock.file_priv = NULL;
 505                         wake_up_interruptible_all(&master->lock.lock_queue);
 506                 }
 507                 mutex_unlock(&dev->struct_mutex);
 508
 509                 if (file_priv->minor->master == file_priv->master) {
 510                         /* drop the reference held my the minor */
 511                         if (dev->driver->master_drop)
 512                                 dev->driver->master_drop(dev, file_priv, true);
 513                         drm_master_put(&file_priv->minor->master);
 514                 }
 515         }
 516
 517         /* drop the master reference held by the file priv */
 518         if (file_priv->master)
 519                 drm_master_put(&file_priv->master);
 520         file_priv->is_master = 0;
 521         mutex_unlock(&dev->master_mutex);
 522
 523         if (dev->driver->postclose)
 524                 dev->driver->postclose(dev, file_priv);
 525
 526
 527         if (drm_core_check_feature(dev, DRIVER_PRIME))
 528                 drm_prime_destroy_file_private(&file_priv->prime);
 529
 530         WARN_ON(!list_empty(&file_priv->event_list));
 531
 532         put_pid(file_priv->pid);
 533         kfree(file_priv);
 534
 535         /* ========================================================
 536          * End inline drm_release
 537          */
 538
 539         if (!--dev->open_count) {
 540                 drm_lastclose(dev);
 541                 if (drm_device_is_unplugged(dev))
 542                         drm_put_dev(dev);
 543         }
 544         mutex_unlock(&drm_global_mutex);
 545
 546         drm_minor_release(minor);
 547
 548         return 0;
 549 }
 550 EXPORT_SYMBOL(drm_release);
 551
 552 /**
 553  * drm_read - read method for DRM file
 554  * @filp: file pointer
 555  * @buffer: userspace destination pointer for the read
 556  * @count: count in bytes to read
 557  * @offset: offset to read
 558  *
 559  * This function must be used by drivers as their .read() #file_operations
 560  * method iff they use DRM events for asynchronous signalling to userspace.
 561  * Since events are used by the KMS API for vblank and page flip completion this
 562  * means all modern display drivers must use it.
 563  *
 564  * @offset is ignore, DRM events are read like a pipe. Therefore drivers also
 565  * must set the .llseek() #file_operation to no_llseek(). Polling support is
 566  * provided by drm_poll().
 567  *
 568  * This function will only ever read a full event. Therefore userspace must
 569  * supply a big enough buffer to fit any event to ensure forward progress. Since
 570  * the maximum event space is currently 4K it's recommended to just use that for
 571  * safety.
 572  *
 573  * RETURNS:
 574  *
 575  * Number of bytes read (always aligned to full events, and can be 0) or a
 576  * negative error code on failure.
 577  */
 578 ssize_t drm_read(struct file *filp, char __user *buffer,
 579                  size_t count, loff_t *offset)
 580 {
 581         struct drm_file *file_priv = filp->private_data;
 582         struct drm_device *dev = file_priv->minor->dev;
 583         ssize_t ret;
 584
 585         if (!access_ok(VERIFY_WRITE, buffer, count))
 586                 return -EFAULT;
 587
 588         ret = mutex_lock_interruptible(&file_priv->event_read_lock);
 589         if (ret)
 590                 return ret;
 591
 592         for (;;) {
 593                 struct drm_pending_event *e = NULL;
 594
 595                 spin_lock_irq(&dev->event_lock);
 596                 if (!list_empty(&file_priv->event_list)) {
 597                         e = list_first_entry(&file_priv->event_list,
 598                                         struct drm_pending_event, link);
 599                         file_priv->event_space += e->event->length;
 600                         list_del(&e->link);
 601                 }
 602                 spin_unlock_irq(&dev->event_lock);
 603
 604                 if (e == NULL) {
 605                         if (ret)
 606                                 break;
 607
 608                         if (filp->f_flags & O_NONBLOCK) {
 609                                 ret = -EAGAIN;
 610                                 break;
 611                         }
 612
 613                         mutex_unlock(&file_priv->event_read_lock);
 614                         ret = wait_event_interruptible(file_priv->event_wait,
 615                                                        !list_empty(&file_priv->event_list));
 616                         if (ret >= 0)
 617                                 ret = mutex_lock_interruptible(&file_priv->event_read_lock);
 618                         if (ret)
 619                                 return ret;
 620                 } else {
 621                         unsigned length = e->event->length;
 622
 623                         if (length > count - ret) {
 624 put_back_event:
 625                                 spin_lock_irq(&dev->event_lock);
 626                                 file_priv->event_space -= length;
 627                                 list_add(&e->link, &file_priv->event_list);
 628                                 spin_unlock_irq(&dev->event_lock);
 629                                 break;
 630                         }
 631
 632                         if (copy_to_user(buffer + ret, e->event, length)) {
 633                                 if (ret == 0)
 634                                         ret = -EFAULT;
 635                                 goto put_back_event;
 636                         }
 637
 638                         ret += length;
 639                         e->destroy(e);
 640                 }
 641         }
 642         mutex_unlock(&file_priv->event_read_lock);
 643
 644         return ret;
 645 }
 646 EXPORT_SYMBOL(drm_read);
 647
 648 /**
 649  * drm_poll - poll method for DRM file
 650  * @filp: file pointer
 651  * @wait: poll waiter table
 652  *
 653  * This function must be used by drivers as their .read() #file_operations
 654  * method iff they use DRM events for asynchronous signalling to userspace.
 655  * Since events are used by the KMS API for vblank and page flip completion this
 656  * means all modern display drivers must use it.
 657  *
 658  * See also drm_read().
 659  *
 660  * RETURNS:
 661  *
 662  * Mask of POLL flags indicating the current status of the file.
 663  */
 664 unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait)
 665 {
 666         struct drm_file *file_priv = filp->private_data;
 667         unsigned int mask = 0;
 668
 669         poll_wait(filp, &file_priv->event_wait, wait);
 670
 671         if (!list_empty(&file_priv->event_list))
 672                 mask |= POLLIN | POLLRDNORM;
 673
 674         return mask;
 675 }
 676 EXPORT_SYMBOL(drm_poll);
 677
 678 /**
 679  * drm_event_reserve_init_locked - init a DRM event and reserve space for it
 680  * @dev: DRM device
 681  * @file_priv: DRM file private data
 682  * @p: tracking structure for the pending event
 683  * @e: actual event data to deliver to userspace
 684  *
 685  * This function prepares the passed in event for eventual delivery. If the event
 686  * doesn't get delivered (because the IOCTL fails later on, before queuing up
 687  * anything) then the even must be cancelled and freed using
 688  * drm_event_cancel_free(). Successfully initialized events should be sent out
 689  * using drm_send_event() or drm_send_event_locked() to signal completion of the
 690  * asynchronous event to userspace.
 691  *
 692  * If callers embedded @p into a larger structure it must be allocated with
 693  * kmalloc and @p must be the first member element.
 694  *
 695  * This is the locked version of drm_event_reserve_init() for callers which
 696  * already hold dev->event_lock.
 697  *
 698  * RETURNS:
 699  *
 700  * 0 on success or a negative error code on failure.
 701  */
 702 int drm_event_reserve_init_locked(struct drm_device *dev,
 703                                   struct drm_file *file_priv,
 704                                   struct drm_pending_event *p,
 705                                   struct drm_event *e)
 706 {
 707         if (file_priv->event_space < e->length)
 708                 return -ENOMEM;
 709
 710         file_priv->event_space -= e->length;
 711
 712         p->event = e;
 713         list_add(&p->pending_link, &file_priv->pending_event_list);
 714         p->file_priv = file_priv;
 715
 716         /* we *could* pass this in as arg, but everyone uses kfree: */
 717         p->destroy = (void (*) (struct drm_pending_event *)) kfree;
 718
 719         return 0;
 720 }
 721 EXPORT_SYMBOL(drm_event_reserve_init_locked);
 722
 723 /**
 724  * drm_event_reserve_init - init a DRM event and reserve space for it
 725  * @dev: DRM device
 726  * @file_priv: DRM file private data
 727  * @p: tracking structure for the pending event
 728  * @e: actual event data to deliver to userspace
 729  *
 730  * This function prepares the passed in event for eventual delivery. If the event
 731  * doesn't get delivered (because the IOCTL fails later on, before queuing up
 732  * anything) then the even must be cancelled and freed using
 733  * drm_event_cancel_free(). Successfully initialized events should be sent out
 734  * using drm_send_event() or drm_send_event_locked() to signal completion of the
 735  * asynchronous event to userspace.
 736  *
 737  * If callers embedded @p into a larger structure it must be allocated with
 738  * kmalloc and @p must be the first member element.
 739  *
 740  * Callers which already hold dev->event_lock should use
 741  * drm_event_reserve_init() instead.
 742  *
 743  * RETURNS:
 744  *
 745  * 0 on success or a negative error code on failure.
 746  */
 747 int drm_event_reserve_init(struct drm_device *dev,
 748                            struct drm_file *file_priv,
 749                            struct drm_pending_event *p,
 750                            struct drm_event *e)
 751 {
 752         unsigned long flags;
 753         int ret;
 754
 755         spin_lock_irqsave(&dev->event_lock, flags);
 756         ret = drm_event_reserve_init_locked(dev, file_priv, p, e);
 757         spin_unlock_irqrestore(&dev->event_lock, flags);
 758
 759         return ret;
 760 }
 761 EXPORT_SYMBOL(drm_event_reserve_init);
 762
 763 /**
 764  * drm_event_cancel_free - free a DRM event and release it's space
 765  * @dev: DRM device
 766  * @p: tracking structure for the pending event
 767  *
 768  * This function frees the event @p initialized with drm_event_reserve_init()
 769  * and releases any allocated space.
 770  */
 771 void drm_event_cancel_free(struct drm_device *dev,
 772                            struct drm_pending_event *p)
 773 {
 774         unsigned long flags;
 775         spin_lock_irqsave(&dev->event_lock, flags);
 776         if (p->file_priv) {
 777                 p->file_priv->event_space += p->event->length;
 778                 list_del(&p->pending_link);
 779         }
 780         spin_unlock_irqrestore(&dev->event_lock, flags);
 781         p->destroy(p);
 782 }
 783 EXPORT_SYMBOL(drm_event_cancel_free);
 784
 785 /**
 786  * drm_send_event_locked - send DRM event to file descriptor
 787  * @dev: DRM device
 788  * @e: DRM event to deliver
 789  *
 790  * This function sends the event @e, initialized with drm_event_reserve_init(),
 791  * to its associated userspace DRM file. Callers must already hold
 792  * dev->event_lock, see drm_send_event() for the unlocked version.
 793  *
 794  * Note that the core will take care of unlinking and disarming events when the
 795  * corresponding DRM file is closed. Drivers need not worry about whether the
 796  * DRM file for this event still exists and can call this function upon
 797  * completion of the asynchronous work unconditionally.
 798  */
 799 void drm_send_event_locked(struct drm_device *dev, struct drm_pending_event *e)
 800 {
 801         assert_spin_locked(&dev->event_lock);
 802
 803         if (!e->file_priv) {
 804                 e->destroy(e);
 805                 return;
 806         }
 807
 808         list_del(&e->pending_link);
 809         list_add_tail(&e->link,
 810                       &e->file_priv->event_list);
 811         wake_up_interruptible(&e->file_priv->event_wait);
 812 }
 813 EXPORT_SYMBOL(drm_send_event_locked);
 814
 815 /**
 816  * drm_send_event - send DRM event to file descriptor
 817  * @dev: DRM device
 818  * @e: DRM event to deliver
 819  *
 820  * This function sends the event @e, initialized with drm_event_reserve_init(),
 821  * to its associated userspace DRM file. This function acquires dev->event_lock,
 822  * see drm_send_event_locked() for callers which already hold this lock.
 823  *
 824  * Note that the core will take care of unlinking and disarming events when the
 825  * corresponding DRM file is closed. Drivers need not worry about whether the
 826  * DRM file for this event still exists and can call this function upon
 827  * completion of the asynchronous work unconditionally.
 828  */
 829 void drm_send_event(struct drm_device *dev, struct drm_pending_event *e)
 830 {
 831         unsigned long irqflags;
 832
 833         spin_lock_irqsave(&dev->event_lock, irqflags);
 834         drm_send_event_locked(dev, e);
 835         spin_unlock_irqrestore(&dev->event_lock, irqflags);
 836 }
 837 EXPORT_SYMBOL(drm_send_event);