sys/dev/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 <sys/types.h>
  38 #include <sys/conf.h>
  39 #include <sys/devfs.h>
  40
  41 #include <drm/drmP.h>
  42 #include <linux/module.h>
  43 #include "drm_legacy.h"
  44 #include "drm_internal.h"
  45
  46 /* from BKL pushdown: note that nothing else serializes idr_find() */
  47 DEFINE_MUTEX(drm_global_mutex);
  48 EXPORT_SYMBOL(drm_global_mutex);
  49
  50 extern drm_pci_id_list_t *drm_find_description(int vendor, int device,
  51     drm_pci_id_list_t *idlist);
  52 extern devclass_t drm_devclass;
  53
  54 static int drm_setup(struct drm_device *dev)
  55 {
  56         drm_local_map_t *map;
  57         int i;
  58
  59         DRM_LOCK_ASSERT(dev);
  60
  61         /* prebuild the SAREA */
  62         i = drm_legacy_addmap(dev, 0, SAREA_MAX, _DRM_SHM,
  63             _DRM_CONTAINS_LOCK, &map);
  64         if (i != 0)
  65                 return i;
  66
  67         if (dev->driver->firstopen)
  68                 dev->driver->firstopen(dev);
  69
  70         dev->buf_use = 0;
  71
  72         if (drm_core_check_feature(dev, DRIVER_HAVE_DMA)) {
  73                 i = drm_legacy_dma_setup(dev);
  74                 if (i != 0)
  75                         return i;
  76         }
  77
  78         drm_ht_create(&dev->magiclist, DRM_MAGIC_HASH_ORDER);
  79         INIT_LIST_HEAD(&dev->magicfree);
  80
  81         init_waitqueue_head(&dev->lock.lock_queue);
  82         if (!drm_core_check_feature(dev, DRIVER_MODESET))
  83                 dev->irq_enabled = 0;
  84         dev->context_flag = 0;
  85         dev->last_context = 0;
  86         dev->if_version = 0;
  87
  88         dev->buf_sigio = NULL;
  89
  90         DRM_DEBUG("\n");
  91
  92         return 0;
  93 }
  94
  95 #define DRIVER_SOFTC(unit) \
  96         ((struct drm_device *)devclass_get_softc(drm_devclass, unit))
  97
  98 int
  99 drm_open(struct dev_open_args *ap)
 100 {
 101         struct cdev *kdev = ap->a_head.a_dev;
 102         int flags = ap->a_oflags;
 103         int fmt = 0;
 104         struct thread *p = curthread;
 105         struct drm_device *dev;
 106         int retcode;
 107
 108         dev = DRIVER_SOFTC(minor(kdev));
 109         if (dev == NULL)
 110                 return (ENXIO);
 111
 112         DRM_DEBUG("open_count = %d\n", dev->open_count);
 113
 114         retcode = drm_open_helper(kdev, flags, fmt, p, dev, ap->a_fp);
 115
 116         if (retcode == 0) {
 117                 atomic_inc(&dev->counts[_DRM_STAT_OPENS]);
 118                 DRM_LOCK(dev);
 119                 device_busy(dev->dev->bsddev);
 120                 if (!dev->open_count++)
 121                         retcode = drm_setup(dev);
 122                 DRM_UNLOCK(dev);
 123         }
 124
 125         DRM_DEBUG("return %d\n", retcode);
 126
 127         return (retcode);
 128 }
 129
 130 /* drm_open_helper is called whenever a process opens /dev/drm. */
 131 int drm_open_helper(struct cdev *kdev, int flags, int fmt, DRM_STRUCTPROC *p,
 132                     struct drm_device *dev, struct file *fp)
 133 {
 134         struct drm_file *priv;
 135         int retcode;
 136
 137         if (flags & O_EXCL)
 138                 return EBUSY; /* No exclusive opens */
 139         dev->flags = flags;
 140
 141         DRM_DEBUG("pid = %d, device = %s\n", DRM_CURRENTPID, devtoname(kdev));
 142
 143         priv = kmalloc(sizeof(*priv), M_DRM, M_WAITOK | M_NULLOK | M_ZERO);
 144         if (priv == NULL) {
 145                 return ENOMEM;
 146         }
 147
 148         DRM_LOCK(dev);
 149         priv->dev               = dev;
 150         priv->uid               = p->td_proc->p_ucred->cr_svuid;
 151         priv->pid               = p->td_proc->p_pid;
 152
 153         /* for compatibility root is always authenticated */
 154         priv->authenticated = capable(CAP_SYS_ADMIN);
 155
 156         INIT_LIST_HEAD(&priv->fbs);
 157         INIT_LIST_HEAD(&priv->event_list);
 158         init_waitqueue_head(&priv->event_wait);
 159         priv->event_space = 4096; /* set aside 4k for event buffer */
 160
 161         if (drm_core_check_feature(dev, DRIVER_GEM))
 162                 drm_gem_open(dev, priv);
 163
 164         if (dev->driver->open) {
 165                 /* shared code returns -errno */
 166                 retcode = -dev->driver->open(dev, priv);
 167                 if (retcode != 0) {
 168                         kfree(priv);
 169                         DRM_UNLOCK(dev);
 170                         return retcode;
 171                 }
 172         }
 173
 174         /* first opener automatically becomes master */
 175         priv->master = list_empty(&dev->filelist);
 176
 177         list_add(&priv->lhead, &dev->filelist);
 178         DRM_UNLOCK(dev);
 179         kdev->si_drv1 = dev;
 180
 181         retcode = devfs_set_cdevpriv(fp, priv, &drm_cdevpriv_dtor);
 182         if (retcode != 0)
 183                 drm_cdevpriv_dtor(priv);
 184
 185         return retcode;
 186 }
 187
 188 /**
 189  * Take down the DRM device.
 190  *
 191  * \param dev DRM device structure.
 192  *
 193  * Frees every resource in \p dev.
 194  *
 195  * \sa drm_device
 196  */
 197 int drm_lastclose(struct drm_device * dev)
 198 {
 199         DRM_DEBUG("\n");
 200
 201         if (dev->driver->lastclose)
 202                 dev->driver->lastclose(dev);
 203         DRM_DEBUG("driver lastclose completed\n");
 204
 205         if (dev->irq_enabled && !drm_core_check_feature(dev, DRIVER_MODESET))
 206                 drm_irq_uninstall(dev);
 207
 208         mutex_lock(&dev->struct_mutex);
 209
 210         if (dev->unique) {
 211                 kfree(dev->unique);
 212                 dev->unique = NULL;
 213                 dev->unique_len = 0;
 214         }
 215
 216         drm_agp_clear(dev);
 217
 218         drm_legacy_sg_cleanup(dev);
 219         drm_legacy_dma_takedown(dev);
 220
 221         if (dev->lock.hw_lock) {
 222                 dev->lock.hw_lock = NULL; /* SHM removed */
 223                 dev->lock.file_priv = NULL;
 224                 wakeup(&dev->lock.lock_queue);
 225         }
 226
 227         mutex_unlock(&dev->struct_mutex);
 228
 229         DRM_DEBUG("lastclose completed\n");
 230         return 0;
 231 }
 232
 233 /**
 234  * Release file.
 235  *
 236  * \param inode device inode
 237  * \param file_priv DRM file private.
 238  * \return zero on success or a negative number on failure.
 239  *
 240  * If the hardware lock is held then free it, and take it again for the kernel
 241  * context since it's necessary to reclaim buffers. Unlink the file private
 242  * data from its list and free it. Decreases the open count and if it reaches
 243  * zero calls drm_lastclose().
 244  */
 245 int drm_release(device_t kdev)
 246 {
 247         struct drm_device *dev = device_get_softc(kdev);
 248         struct drm_magic_entry *pt, *next;
 249         int i;
 250
 251         mutex_lock(&drm_global_mutex);
 252
 253         /* Clear pid list */
 254         if (dev->magicfree.next) {
 255                 list_for_each_entry_safe(pt, next, &dev->magicfree, head) {
 256                         list_del(&pt->head);
 257                         drm_ht_remove_item(&dev->magiclist, &pt->hash_item);
 258                         kfree(pt);
 259                 }
 260                 drm_ht_remove(&dev->magiclist);
 261         }
 262
 263         /* ========================================================
 264          * Begin inline drm_release
 265          */
 266
 267         DRM_DEBUG("\n");
 268
 269         drm_sysctl_cleanup(dev);
 270         if (dev->devnode != NULL)
 271                 destroy_dev(dev->devnode);
 272
 273         if (drm_core_check_feature(dev, DRIVER_GEM))
 274                 drm_gem_destroy(dev);
 275
 276         drm_vblank_cleanup(dev);
 277
 278         DRM_LOCK(dev);
 279         drm_lastclose(dev);
 280         DRM_UNLOCK(dev);
 281
 282         /* Clean up PCI resources allocated by drm_bufs.c.  We're not really
 283          * worried about resource consumption while the DRM is inactive (between
 284          * lastclose and firstopen or unload) because these aren't actually
 285          * taking up KVA, just keeping the PCI resource allocated.
 286          */
 287         for (i = 0; i < DRM_MAX_PCI_RESOURCE; i++) {
 288                 if (dev->pcir[i] == NULL)
 289                         continue;
 290                 bus_release_resource(dev->dev->bsddev, SYS_RES_MEMORY,
 291                     dev->pcirid[i], dev->pcir[i]);
 292                 dev->pcir[i] = NULL;
 293         }
 294
 295         if (dev->agp) {
 296                 kfree(dev->agp);
 297                 dev->agp = NULL;
 298         }
 299
 300         if (dev->driver->unload != NULL) {
 301                 DRM_LOCK(dev);
 302                 dev->driver->unload(dev);
 303                 DRM_UNLOCK(dev);
 304         }
 305
 306         if (pci_disable_busmaster(dev->dev->bsddev))
 307                 DRM_ERROR("Request to disable bus-master failed.\n");
 308
 309         lockuninit(&dev->vbl_lock);
 310         lockuninit(&dev->dev_lock);
 311         lockuninit(&dev->event_lock);
 312         lockuninit(&dev->struct_mutex);
 313
 314         /* ========================================================
 315          * End inline drm_release
 316          */
 317
 318         if (dev->irqr) {
 319                 bus_release_resource(dev->dev->bsddev, SYS_RES_IRQ, dev->irqrid,
 320                     dev->irqr);
 321                 if (dev->irq_type == PCI_INTR_TYPE_MSI) {
 322                         pci_release_msi(dev->dev->bsddev);
 323                         DRM_INFO("MSI released\n");
 324                 }
 325         }
 326
 327         mutex_unlock(&drm_global_mutex);
 328
 329         return (0);
 330 }
 331
 332 static bool
 333 drm_dequeue_event(struct drm_device *dev, struct drm_file *file_priv,
 334     struct uio *uio, struct drm_pending_event **out)
 335 {
 336         struct drm_pending_event *e;
 337         bool ret = false;
 338
 339         lockmgr(&dev->event_lock, LK_EXCLUSIVE);
 340
 341         *out = NULL;
 342         if (list_empty(&file_priv->event_list))
 343                 goto out;
 344         e = list_first_entry(&file_priv->event_list,
 345             struct drm_pending_event, link);
 346         if (e->event->length > uio->uio_resid)
 347                 goto out;
 348
 349         file_priv->event_space += e->event->length;
 350         list_del(&e->link);
 351         *out = e;
 352         ret = true;
 353
 354 out:
 355         lockmgr(&dev->event_lock, LK_RELEASE);
 356         return ret;
 357 }
 358
 359 int
 360 drm_read(struct dev_read_args *ap)
 361 {
 362         struct cdev *kdev = ap->a_head.a_dev;
 363         struct uio *uio = ap->a_uio;
 364         struct drm_file *file_priv;
 365         struct drm_device *dev = drm_get_device_from_kdev(kdev);
 366         struct drm_pending_event *e;
 367         int error;
 368         int ret;
 369
 370         error = devfs_get_cdevpriv(ap->a_fp, (void **)&file_priv);
 371         if (error != 0) {
 372                 DRM_ERROR("can't find authenticator\n");
 373                 return (EINVAL);
 374         }
 375
 376         ret = wait_event_interruptible(file_priv->event_wait,
 377                                        !list_empty(&file_priv->event_list));
 378         if (ret == -ERESTARTSYS)
 379                 ret = -EINTR;
 380         if (ret < 0)
 381                 return -ret;
 382
 383         while (drm_dequeue_event(dev, file_priv, uio, &e)) {
 384                 error = uiomove((caddr_t)e->event, e->event->length, uio);
 385                 e->destroy(e);
 386                 if (error != 0)
 387                         return (error);
 388         }
 389
 390         return (error);
 391 }
 392
 393 static int
 394 drmfilt(struct knote *kn, long hint)
 395 {
 396         struct drm_file *file_priv;
 397         struct drm_device *dev;
 398         int ready = 0;
 399
 400         file_priv = (struct drm_file *)kn->kn_hook;
 401         dev = file_priv->dev;
 402         lockmgr(&dev->event_lock, LK_EXCLUSIVE);
 403         if (!list_empty(&file_priv->event_list))
 404                 ready = 1;
 405         lockmgr(&dev->event_lock, LK_RELEASE);
 406
 407         return (ready);
 408 }
 409
 410 static void
 411 drmfilt_detach(struct knote *kn)
 412 {
 413         struct drm_file *file_priv;
 414         struct drm_device *dev;
 415         struct klist *klist;
 416
 417         file_priv = (struct drm_file *)kn->kn_hook;
 418         dev = file_priv->dev;
 419
 420         klist = &file_priv->dkq.ki_note;
 421         knote_remove(klist, kn);
 422 }
 423
 424 static struct filterops drmfiltops =
 425         { FILTEROP_MPSAFE | FILTEROP_ISFD, NULL, drmfilt_detach, drmfilt };
 426
 427 int
 428 drm_kqfilter(struct dev_kqfilter_args *ap)
 429 {
 430         struct cdev *kdev = ap->a_head.a_dev;
 431         struct drm_file *file_priv;
 432         struct drm_device *dev;
 433         struct knote *kn = ap->a_kn;
 434         struct klist *klist;
 435         int error;
 436
 437         error = devfs_get_cdevpriv(ap->a_fp, (void **)&file_priv);
 438         if (error != 0) {
 439                 DRM_ERROR("can't find authenticator\n");
 440                 return (EINVAL);
 441         }
 442         dev = drm_get_device_from_kdev(kdev);
 443
 444         ap->a_result = 0;
 445
 446         switch (kn->kn_filter) {
 447         case EVFILT_READ:
 448         case EVFILT_WRITE:
 449                 kn->kn_fop = &drmfiltops;
 450                 kn->kn_hook = (caddr_t)file_priv;
 451                 break;
 452         default:
 453                 ap->a_result = EOPNOTSUPP;
 454                 return (0);
 455         }
 456
 457         klist = &file_priv->dkq.ki_note;
 458         knote_insert(klist, kn);
 459
 460         return (0);
 461 }