drivers/gpu/drm/drm_stub.c

   1 /**
   2  * \file drm_stub.h
   3  * Stub support
   4  *
   5  * \author Rickard E. (Rik) Faith <faith@valinux.com>
   6  */
   7
   8 /*
   9  * Created: Fri Jan 19 10:48:35 2001 by faith@acm.org
  10  *
  11  * Copyright 2001 VA Linux Systems, Inc., Sunnyvale, California.
  12  * All Rights Reserved.
  13  *
  14  * Permission is hereby granted, free of charge, to any person obtaining a
  15  * copy of this software and associated documentation files (the "Software"),
  16  * to deal in the Software without restriction, including without limitation
  17  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  18  * and/or sell copies of the Software, and to permit persons to whom the
  19  * Software is furnished to do so, subject to the following conditions:
  20  *
  21  * The above copyright notice and this permission notice (including the next
  22  * paragraph) shall be included in all copies or substantial portions of the
  23  * Software.
  24  *
  25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  26  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  27  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  28  * PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  29  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  30  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  31  * DEALINGS IN THE SOFTWARE.
  32  */
  33
  34 #include <linux/module.h>
  35 #include <linux/moduleparam.h>
  36 #include <linux/slab.h>
  37 #include <drm/drmP.h>
  38 #include <drm/drm_core.h>
  39
  40 unsigned int drm_debug = 0;     /* 1 to enable debug output */
  41 EXPORT_SYMBOL(drm_debug);
  42
  43 unsigned int drm_rnodes = 0;    /* 1 to enable experimental render nodes API */
  44 EXPORT_SYMBOL(drm_rnodes);
  45
  46 unsigned int drm_vblank_offdelay = 5000;    /* Default to 5000 msecs. */
  47 EXPORT_SYMBOL(drm_vblank_offdelay);
  48
  49 unsigned int drm_timestamp_precision = 20;  /* Default to 20 usecs. */
  50 EXPORT_SYMBOL(drm_timestamp_precision);
  51
  52 /*
  53  * Default to use monotonic timestamps for wait-for-vblank and page-flip
  54  * complete events.
  55  */
  56 unsigned int drm_timestamp_monotonic = 1;
  57
  58 MODULE_AUTHOR(CORE_AUTHOR);
  59 MODULE_DESCRIPTION(CORE_DESC);
  60 MODULE_LICENSE("GPL and additional rights");
  61 MODULE_PARM_DESC(debug, "Enable debug output");
  62 MODULE_PARM_DESC(rnodes, "Enable experimental render nodes API");
  63 MODULE_PARM_DESC(vblankoffdelay, "Delay until vblank irq auto-disable [msecs]");
  64 MODULE_PARM_DESC(timestamp_precision_usec, "Max. error on timestamps [usecs]");
  65 MODULE_PARM_DESC(timestamp_monotonic, "Use monotonic timestamps");
  66
  67 module_param_named(debug, drm_debug, int, 0600);
  68 module_param_named(rnodes, drm_rnodes, int, 0600);
  69 module_param_named(vblankoffdelay, drm_vblank_offdelay, int, 0600);
  70 module_param_named(timestamp_precision_usec, drm_timestamp_precision, int, 0600);
  71 module_param_named(timestamp_monotonic, drm_timestamp_monotonic, int, 0600);
  72
  73 struct idr drm_minors_idr;
  74
  75 struct class *drm_class;
  76 struct dentry *drm_debugfs_root;
  77
  78 int drm_err(const char *func, const char *format, ...)
  79 {
  80         struct va_format vaf;
  81         va_list args;
  82         int r;
  83
  84         va_start(args, format);
  85
  86         vaf.fmt = format;
  87         vaf.va = &args;
  88
  89         r = printk(KERN_ERR "[" DRM_NAME ":%s] *ERROR* %pV", func, &vaf);
  90
  91         va_end(args);
  92
  93         return r;
  94 }
  95 EXPORT_SYMBOL(drm_err);
  96
  97 void drm_ut_debug_printk(unsigned int request_level,
  98                          const char *prefix,
  99                          const char *function_name,
 100                          const char *format, ...)
 101 {
 102         struct va_format vaf;
 103         va_list args;
 104
 105         if (drm_debug & request_level) {
 106                 va_start(args, format);
 107                 vaf.fmt = format;
 108                 vaf.va = &args;
 109
 110                 if (function_name)
 111                         printk(KERN_DEBUG "[%s:%s], %pV", prefix,
 112                                function_name, &vaf);
 113                 else
 114                         printk(KERN_DEBUG "%pV", &vaf);
 115                 va_end(args);
 116         }
 117 }
 118 EXPORT_SYMBOL(drm_ut_debug_printk);
 119
 120 static int drm_minor_get_id(struct drm_device *dev, int type)
 121 {
 122         int ret;
 123         int base = 0, limit = 63;
 124
 125         if (type == DRM_MINOR_CONTROL) {
 126                 base += 64;
 127                 limit = base + 63;
 128         } else if (type == DRM_MINOR_RENDER) {
 129                 base += 128;
 130                 limit = base + 63;
 131         }
 132
 133         mutex_lock(&dev->struct_mutex);
 134         ret = idr_alloc(&drm_minors_idr, NULL, base, limit, GFP_KERNEL);
 135         mutex_unlock(&dev->struct_mutex);
 136
 137         return ret == -ENOSPC ? -EINVAL : ret;
 138 }
 139
 140 struct drm_master *drm_master_create(struct drm_minor *minor)
 141 {
 142         struct drm_master *master;
 143
 144         master = kzalloc(sizeof(*master), GFP_KERNEL);
 145         if (!master)
 146                 return NULL;
 147
 148         kref_init(&master->refcount);
 149         spin_lock_init(&master->lock.spinlock);
 150         init_waitqueue_head(&master->lock.lock_queue);
 151         drm_ht_create(&master->magiclist, DRM_MAGIC_HASH_ORDER);
 152         INIT_LIST_HEAD(&master->magicfree);
 153         master->minor = minor;
 154
 155         return master;
 156 }
 157
 158 struct drm_master *drm_master_get(struct drm_master *master)
 159 {
 160         kref_get(&master->refcount);
 161         return master;
 162 }
 163 EXPORT_SYMBOL(drm_master_get);
 164
 165 static void drm_master_destroy(struct kref *kref)
 166 {
 167         struct drm_master *master = container_of(kref, struct drm_master, refcount);
 168         struct drm_magic_entry *pt, *next;
 169         struct drm_device *dev = master->minor->dev;
 170         struct drm_map_list *r_list, *list_temp;
 171
 172         if (dev->driver->master_destroy)
 173                 dev->driver->master_destroy(dev, master);
 174
 175         list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head) {
 176                 if (r_list->master == master) {
 177                         drm_rmmap_locked(dev, r_list->map);
 178                         r_list = NULL;
 179                 }
 180         }
 181
 182         if (master->unique) {
 183                 kfree(master->unique);
 184                 master->unique = NULL;
 185                 master->unique_len = 0;
 186         }
 187
 188         kfree(dev->devname);
 189         dev->devname = NULL;
 190
 191         list_for_each_entry_safe(pt, next, &master->magicfree, head) {
 192                 list_del(&pt->head);
 193                 drm_ht_remove_item(&master->magiclist, &pt->hash_item);
 194                 kfree(pt);
 195         }
 196
 197         drm_ht_remove(&master->magiclist);
 198
 199         kfree(master);
 200 }
 201
 202 void drm_master_put(struct drm_master **master)
 203 {
 204         kref_put(&(*master)->refcount, drm_master_destroy);
 205         *master = NULL;
 206 }
 207 EXPORT_SYMBOL(drm_master_put);
 208
 209 int drm_setmaster_ioctl(struct drm_device *dev, void *data,
 210                         struct drm_file *file_priv)
 211 {
 212         int ret = 0;
 213
 214         if (file_priv->is_master)
 215                 return 0;
 216
 217         if (file_priv->minor->master && file_priv->minor->master != file_priv->master)
 218                 return -EINVAL;
 219
 220         if (!file_priv->master)
 221                 return -EINVAL;
 222
 223         if (file_priv->minor->master)
 224                 return -EINVAL;
 225
 226         mutex_lock(&dev->struct_mutex);
 227         file_priv->minor->master = drm_master_get(file_priv->master);
 228         file_priv->is_master = 1;
 229         if (dev->driver->master_set) {
 230                 ret = dev->driver->master_set(dev, file_priv, false);
 231                 if (unlikely(ret != 0)) {
 232                         file_priv->is_master = 0;
 233                         drm_master_put(&file_priv->minor->master);
 234                 }
 235         }
 236         mutex_unlock(&dev->struct_mutex);
 237
 238         return ret;
 239 }
 240
 241 int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
 242                          struct drm_file *file_priv)
 243 {
 244         if (!file_priv->is_master)
 245                 return -EINVAL;
 246
 247         if (!file_priv->minor->master)
 248                 return -EINVAL;
 249
 250         mutex_lock(&dev->struct_mutex);
 251         if (dev->driver->master_drop)
 252                 dev->driver->master_drop(dev, file_priv, false);
 253         drm_master_put(&file_priv->minor->master);
 254         file_priv->is_master = 0;
 255         mutex_unlock(&dev->struct_mutex);
 256         return 0;
 257 }
 258
 259 static struct drm_minor **drm_minor_get_slot(struct drm_device *dev,
 260                                              unsigned int type)
 261 {
 262         switch (type) {
 263         case DRM_MINOR_LEGACY:
 264                 return &dev->primary;
 265         case DRM_MINOR_RENDER:
 266                 return &dev->render;
 267         case DRM_MINOR_CONTROL:
 268                 return &dev->control;
 269         default:
 270                 return NULL;
 271         }
 272 }
 273
 274 static int drm_minor_alloc(struct drm_device *dev, unsigned int type)
 275 {
 276         struct drm_minor *minor;
 277
 278         minor = kzalloc(sizeof(*minor), GFP_KERNEL);
 279         if (!minor)
 280                 return -ENOMEM;
 281
 282         minor->type = type;
 283         minor->dev = dev;
 284
 285         *drm_minor_get_slot(dev, type) = minor;
 286         return 0;
 287 }
 288
 289 /**
 290  * drm_get_minor - Register DRM minor
 291  * @dev: DRM device
 292  * @type: Type of minor
 293  *
 294  * Register minor of given type.
 295  * Caller must hold the global DRM mutex.
 296  *
 297  * RETURNS:
 298  * 0 on success, negative error code on failure.
 299  */
 300 static int drm_get_minor(struct drm_device *dev, unsigned int type)
 301 {
 302         struct drm_minor *new_minor;
 303         int ret;
 304         int minor_id;
 305
 306         DRM_DEBUG("\n");
 307
 308         new_minor = *drm_minor_get_slot(dev, type);
 309         if (!new_minor)
 310                 return 0;
 311
 312         minor_id = drm_minor_get_id(dev, type);
 313         if (minor_id < 0)
 314                 return minor_id;
 315
 316         new_minor->device = MKDEV(DRM_MAJOR, minor_id);
 317         new_minor->index = minor_id;
 318
 319         idr_replace(&drm_minors_idr, new_minor, minor_id);
 320
 321 #if defined(CONFIG_DEBUG_FS)
 322         ret = drm_debugfs_init(new_minor, minor_id, drm_debugfs_root);
 323         if (ret) {
 324                 DRM_ERROR("DRM: Failed to initialize /sys/kernel/debug/dri.\n");
 325                 goto err_mem;
 326         }
 327 #endif
 328
 329         ret = drm_sysfs_device_add(new_minor);
 330         if (ret) {
 331                 printk(KERN_ERR
 332                        "DRM: Error sysfs_device_add.\n");
 333                 goto err_debugfs;
 334         }
 335
 336         DRM_DEBUG("new minor assigned %d\n", minor_id);
 337         return 0;
 338
 339
 340 err_debugfs:
 341 #if defined(CONFIG_DEBUG_FS)
 342         drm_debugfs_cleanup(new_minor);
 343 err_mem:
 344 #endif
 345         idr_remove(&drm_minors_idr, minor_id);
 346         return ret;
 347 }
 348
 349 /**
 350  * drm_unplug_minor - Unplug DRM minor
 351  * @minor: Minor to unplug
 352  *
 353  * Unplugs the given DRM minor but keeps the object. So after this returns,
 354  * minor->dev is still valid so existing open-files can still access it to get
 355  * device information from their drm_file ojects.
 356  * If the minor is already unplugged or if @minor is NULL, nothing is done.
 357  * The global DRM mutex must be held by the caller.
 358  */
 359 static void drm_unplug_minor(struct drm_minor *minor)
 360 {
 361         if (!minor || !minor->kdev)
 362                 return;
 363
 364 #if defined(CONFIG_DEBUG_FS)
 365         drm_debugfs_cleanup(minor);
 366 #endif
 367
 368         drm_sysfs_device_remove(minor);
 369         idr_remove(&drm_minors_idr, minor->index);
 370 }
 371
 372 /**
 373  * drm_minor_acquire - Acquire a DRM minor
 374  * @minor_id: Minor ID of the DRM-minor
 375  *
 376  * Looks up the given minor-ID and returns the respective DRM-minor object. The
 377  * refence-count of the underlying device is increased so you must release this
 378  * object with drm_minor_release().
 379  *
 380  * As long as you hold this minor, it is guaranteed that the object and the
 381  * minor->dev pointer will stay valid! However, the device may get unplugged and
 382  * unregistered while you hold the minor.
 383  *
 384  * Returns:
 385  * Pointer to minor-object with increased device-refcount, or PTR_ERR on
 386  * failure.
 387  */
 388 struct drm_minor *drm_minor_acquire(unsigned int minor_id)
 389 {
 390         struct drm_minor *minor;
 391
 392         minor = idr_find(&drm_minors_idr, minor_id);
 393         if (!minor)
 394                 return ERR_PTR(-ENODEV);
 395
 396         drm_dev_ref(minor->dev);
 397         return minor;
 398 }
 399
 400 /**
 401  * drm_minor_release - Release DRM minor
 402  * @minor: Pointer to DRM minor object
 403  *
 404  * Release a minor that was previously acquired via drm_minor_acquire().
 405  */
 406 void drm_minor_release(struct drm_minor *minor)
 407 {
 408         drm_dev_unref(minor->dev);
 409 }
 410
 411 /**
 412  * drm_put_minor - Destroy DRM minor
 413  * @minor: Minor to destroy
 414  *
 415  * This calls drm_unplug_minor() on the given minor and then frees it. Nothing
 416  * is done if @minor is NULL. It is fine to call this on already unplugged
 417  * minors.
 418  * The global DRM mutex must be held by the caller.
 419  */
 420 static void drm_put_minor(struct drm_minor *minor)
 421 {
 422         if (!minor)
 423                 return;
 424
 425         DRM_DEBUG("release secondary minor %d\n", minor->index);
 426
 427         drm_unplug_minor(minor);
 428         kfree(minor);
 429 }
 430
 431 /**
 432  * Called via drm_exit() at module unload time or when pci device is
 433  * unplugged.
 434  *
 435  * Cleans up all DRM device, calling drm_lastclose().
 436  *
 437  */
 438 void drm_put_dev(struct drm_device *dev)
 439 {
 440         DRM_DEBUG("\n");
 441
 442         if (!dev) {
 443                 DRM_ERROR("cleanup called no dev\n");
 444                 return;
 445         }
 446
 447         drm_dev_unregister(dev);
 448         drm_dev_free(dev);
 449 }
 450 EXPORT_SYMBOL(drm_put_dev);
 451
 452 void drm_unplug_dev(struct drm_device *dev)
 453 {
 454         /* for a USB device */
 455         if (drm_core_check_feature(dev, DRIVER_MODESET))
 456                 drm_unplug_minor(dev->control);
 457         if (dev->render)
 458                 drm_unplug_minor(dev->render);
 459         drm_unplug_minor(dev->primary);
 460
 461         mutex_lock(&drm_global_mutex);
 462
 463         drm_device_set_unplugged(dev);
 464
 465         if (dev->open_count == 0) {
 466                 drm_put_dev(dev);
 467         }
 468         mutex_unlock(&drm_global_mutex);
 469 }
 470 EXPORT_SYMBOL(drm_unplug_dev);
 471
 472 /**
 473  * drm_dev_alloc - Allocate new drm device
 474  * @driver: DRM driver to allocate device for
 475  * @parent: Parent device object
 476  *
 477  * Allocate and initialize a new DRM device. No device registration is done.
 478  * Call drm_dev_register() to advertice the device to user space and register it
 479  * with other core subsystems.
 480  *
 481  * RETURNS:
 482  * Pointer to new DRM device, or NULL if out of memory.
 483  */
 484 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
 485                                  struct device *parent)
 486 {
 487         struct drm_device *dev;
 488         int ret;
 489
 490         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
 491         if (!dev)
 492                 return NULL;
 493
 494         dev->dev = parent;
 495         dev->driver = driver;
 496
 497         INIT_LIST_HEAD(&dev->filelist);
 498         INIT_LIST_HEAD(&dev->ctxlist);
 499         INIT_LIST_HEAD(&dev->vmalist);
 500         INIT_LIST_HEAD(&dev->maplist);
 501         INIT_LIST_HEAD(&dev->vblank_event_list);
 502
 503         spin_lock_init(&dev->count_lock);
 504         spin_lock_init(&dev->event_lock);
 505         mutex_init(&dev->struct_mutex);
 506         mutex_init(&dev->ctxlist_mutex);
 507
 508         if (drm_core_check_feature(dev, DRIVER_MODESET)) {
 509                 ret = drm_minor_alloc(dev, DRM_MINOR_CONTROL);
 510                 if (ret)
 511                         goto err_minors;
 512         }
 513
 514         if (drm_core_check_feature(dev, DRIVER_RENDER) && drm_rnodes) {
 515                 ret = drm_minor_alloc(dev, DRM_MINOR_RENDER);
 516                 if (ret)
 517                         goto err_minors;
 518         }
 519         ret = drm_minor_alloc(dev, DRM_MINOR_LEGACY);
 520         if (ret)
 521                 goto err_minors;
 522
 523         dev->anon_inode = drm_fs_inode_new();
 524         if (IS_ERR(dev->anon_inode)) {
 525                 ret = PTR_ERR(dev->anon_inode);
 526                 DRM_ERROR("Cannot allocate anonymous inode: %d\n", ret);
 527                 goto err_minors;
 528         }
 529
 530         if (drm_ht_create(&dev->map_hash, 12))
 531                 goto err_inode;
 532
 533         ret = drm_ctxbitmap_init(dev);
 534         if (ret) {
 535                 DRM_ERROR("Cannot allocate memory for context bitmap.\n");
 536                 goto err_ht;
 537         }
 538
 539         if (driver->driver_features & DRIVER_GEM) {
 540                 ret = drm_gem_init(dev);
 541                 if (ret) {
 542                         DRM_ERROR("Cannot initialize graphics execution manager (GEM)\n");
 543                         goto err_ctxbitmap;
 544                 }
 545         }
 546
 547         return dev;
 548
 549 err_ctxbitmap:
 550         drm_ctxbitmap_cleanup(dev);
 551 err_ht:
 552         drm_ht_remove(&dev->map_hash);
 553 err_inode:
 554         drm_fs_inode_free(dev->anon_inode);
 555 err_minors:
 556         drm_put_minor(dev->control);
 557         drm_put_minor(dev->render);
 558         drm_put_minor(dev->primary);
 559         kfree(dev);
 560         return NULL;
 561 }
 562 EXPORT_SYMBOL(drm_dev_alloc);
 563
 564 /**
 565  * drm_dev_free - Free DRM device
 566  * @dev: DRM device to free
 567  *
 568  * Free a DRM device that has previously been allocated via drm_dev_alloc().
 569  * You must not use kfree() instead or you will leak memory.
 570  *
 571  * This must not be called once the device got registered. Use drm_put_dev()
 572  * instead, which then calls drm_dev_free().
 573  */
 574 void drm_dev_free(struct drm_device *dev)
 575 {
 576         drm_put_minor(dev->control);
 577         drm_put_minor(dev->render);
 578         drm_put_minor(dev->primary);
 579
 580         if (dev->driver->driver_features & DRIVER_GEM)
 581                 drm_gem_destroy(dev);
 582
 583         drm_ctxbitmap_cleanup(dev);
 584         drm_ht_remove(&dev->map_hash);
 585         drm_fs_inode_free(dev->anon_inode);
 586
 587         kfree(dev->devname);
 588         kfree(dev);
 589 }
 590 EXPORT_SYMBOL(drm_dev_free);
 591
 592 /**
 593  * drm_dev_register - Register DRM device
 594  * @dev: Device to register
 595  *
 596  * Register the DRM device @dev with the system, advertise device to user-space
 597  * and start normal device operation. @dev must be allocated via drm_dev_alloc()
 598  * previously.
 599  *
 600  * Never call this twice on any device!
 601  *
 602  * RETURNS:
 603  * 0 on success, negative error code on failure.
 604  */
 605 int drm_dev_register(struct drm_device *dev, unsigned long flags)
 606 {
 607         int ret;
 608
 609         mutex_lock(&drm_global_mutex);
 610
 611         ret = drm_get_minor(dev, DRM_MINOR_CONTROL);
 612         if (ret)
 613                 goto err_minors;
 614
 615         ret = drm_get_minor(dev, DRM_MINOR_RENDER);
 616         if (ret)
 617                 goto err_minors;
 618
 619         ret = drm_get_minor(dev, DRM_MINOR_LEGACY);
 620         if (ret)
 621                 goto err_minors;
 622
 623         if (dev->driver->load) {
 624                 ret = dev->driver->load(dev, flags);
 625                 if (ret)
 626                         goto err_minors;
 627         }
 628
 629         /* setup grouping for legacy outputs */
 630         if (drm_core_check_feature(dev, DRIVER_MODESET)) {
 631                 ret = drm_mode_group_init_legacy_group(dev,
 632                                 &dev->primary->mode_group);
 633                 if (ret)
 634                         goto err_unload;
 635         }
 636
 637         ret = 0;
 638         goto out_unlock;
 639
 640 err_unload:
 641         if (dev->driver->unload)
 642                 dev->driver->unload(dev);
 643 err_minors:
 644         drm_unplug_minor(dev->control);
 645         drm_unplug_minor(dev->render);
 646         drm_unplug_minor(dev->primary);
 647 out_unlock:
 648         mutex_unlock(&drm_global_mutex);
 649         return ret;
 650 }
 651 EXPORT_SYMBOL(drm_dev_register);
 652
 653 /**
 654  * drm_dev_unregister - Unregister DRM device
 655  * @dev: Device to unregister
 656  *
 657  * Unregister the DRM device from the system. This does the reverse of
 658  * drm_dev_register() but does not deallocate the device. The caller must call
 659  * drm_dev_free() to free all resources.
 660  */
 661 void drm_dev_unregister(struct drm_device *dev)
 662 {
 663         struct drm_map_list *r_list, *list_temp;
 664
 665         drm_lastclose(dev);
 666
 667         if (dev->driver->unload)
 668                 dev->driver->unload(dev);
 669
 670         if (dev->agp)
 671                 drm_pci_agp_destroy(dev);
 672
 673         drm_vblank_cleanup(dev);
 674
 675         list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head)
 676                 drm_rmmap(dev, r_list->map);
 677
 678         drm_unplug_minor(dev->control);
 679         drm_unplug_minor(dev->render);
 680         drm_unplug_minor(dev->primary);
 681 }
 682 EXPORT_SYMBOL(drm_dev_unregister);