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         mutex_lock(&dev->struct_mutex);
 173         if (dev->driver->master_destroy)
 174                 dev->driver->master_destroy(dev, master);
 175
 176         list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head) {
 177                 if (r_list->master == master) {
 178                         drm_rmmap_locked(dev, r_list->map);
 179                         r_list = NULL;
 180                 }
 181         }
 182
 183         if (master->unique) {
 184                 kfree(master->unique);
 185                 master->unique = NULL;
 186                 master->unique_len = 0;
 187         }
 188
 189         list_for_each_entry_safe(pt, next, &master->magicfree, head) {
 190                 list_del(&pt->head);
 191                 drm_ht_remove_item(&master->magiclist, &pt->hash_item);
 192                 kfree(pt);
 193         }
 194
 195         drm_ht_remove(&master->magiclist);
 196
 197         mutex_unlock(&dev->struct_mutex);
 198         kfree(master);
 199 }
 200
 201 void drm_master_put(struct drm_master **master)
 202 {
 203         kref_put(&(*master)->refcount, drm_master_destroy);
 204         *master = NULL;
 205 }
 206 EXPORT_SYMBOL(drm_master_put);
 207
 208 int drm_setmaster_ioctl(struct drm_device *dev, void *data,
 209                         struct drm_file *file_priv)
 210 {
 211         int ret = 0;
 212
 213         mutex_lock(&dev->master_mutex);
 214         if (file_priv->is_master)
 215                 goto out_unlock;
 216
 217         if (file_priv->minor->master) {
 218                 ret = -EINVAL;
 219                 goto out_unlock;
 220         }
 221
 222         if (!file_priv->master) {
 223                 ret = -EINVAL;
 224                 goto out_unlock;
 225         }
 226
 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
 237 out_unlock:
 238         mutex_unlock(&dev->master_mutex);
 239         return ret;
 240 }
 241
 242 int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
 243                          struct drm_file *file_priv)
 244 {
 245         int ret = -EINVAL;
 246
 247         mutex_lock(&dev->master_mutex);
 248         if (!file_priv->is_master)
 249                 goto out_unlock;
 250
 251         if (!file_priv->minor->master)
 252                 goto out_unlock;
 253
 254         ret = 0;
 255         if (dev->driver->master_drop)
 256                 dev->driver->master_drop(dev, file_priv, false);
 257         drm_master_put(&file_priv->minor->master);
 258         file_priv->is_master = 0;
 259
 260 out_unlock:
 261         mutex_unlock(&dev->master_mutex);
 262         return ret;
 263 }
 264
 265 static struct drm_minor **drm_minor_get_slot(struct drm_device *dev,
 266                                              unsigned int type)
 267 {
 268         switch (type) {
 269         case DRM_MINOR_LEGACY:
 270                 return &dev->primary;
 271         case DRM_MINOR_RENDER:
 272                 return &dev->render;
 273         case DRM_MINOR_CONTROL:
 274                 return &dev->control;
 275         default:
 276                 return NULL;
 277         }
 278 }
 279
 280 static int drm_minor_alloc(struct drm_device *dev, unsigned int type)
 281 {
 282         struct drm_minor *minor;
 283
 284         minor = kzalloc(sizeof(*minor), GFP_KERNEL);
 285         if (!minor)
 286                 return -ENOMEM;
 287
 288         minor->type = type;
 289         minor->dev = dev;
 290
 291         *drm_minor_get_slot(dev, type) = minor;
 292         return 0;
 293 }
 294
 295 /**
 296  * drm_get_minor - Register DRM minor
 297  * @dev: DRM device
 298  * @type: Type of minor
 299  *
 300  * Register minor of given type.
 301  * Caller must hold the global DRM mutex.
 302  *
 303  * RETURNS:
 304  * 0 on success, negative error code on failure.
 305  */
 306 static int drm_get_minor(struct drm_device *dev, unsigned int type)
 307 {
 308         struct drm_minor *new_minor;
 309         int ret;
 310         int minor_id;
 311
 312         DRM_DEBUG("\n");
 313
 314         new_minor = *drm_minor_get_slot(dev, type);
 315         if (!new_minor)
 316                 return 0;
 317
 318         minor_id = drm_minor_get_id(dev, type);
 319         if (minor_id < 0)
 320                 return minor_id;
 321
 322         new_minor->device = MKDEV(DRM_MAJOR, minor_id);
 323         new_minor->index = minor_id;
 324
 325         idr_replace(&drm_minors_idr, new_minor, minor_id);
 326
 327 #if defined(CONFIG_DEBUG_FS)
 328         ret = drm_debugfs_init(new_minor, minor_id, drm_debugfs_root);
 329         if (ret) {
 330                 DRM_ERROR("DRM: Failed to initialize /sys/kernel/debug/dri.\n");
 331                 goto err_mem;
 332         }
 333 #endif
 334
 335         ret = drm_sysfs_device_add(new_minor);
 336         if (ret) {
 337                 printk(KERN_ERR
 338                        "DRM: Error sysfs_device_add.\n");
 339                 goto err_debugfs;
 340         }
 341
 342         DRM_DEBUG("new minor assigned %d\n", minor_id);
 343         return 0;
 344
 345
 346 err_debugfs:
 347 #if defined(CONFIG_DEBUG_FS)
 348         drm_debugfs_cleanup(new_minor);
 349 err_mem:
 350 #endif
 351         idr_remove(&drm_minors_idr, minor_id);
 352         return ret;
 353 }
 354
 355 /**
 356  * drm_unplug_minor - Unplug DRM minor
 357  * @minor: Minor to unplug
 358  *
 359  * Unplugs the given DRM minor but keeps the object. So after this returns,
 360  * minor->dev is still valid so existing open-files can still access it to get
 361  * device information from their drm_file ojects.
 362  * If the minor is already unplugged or if @minor is NULL, nothing is done.
 363  * The global DRM mutex must be held by the caller.
 364  */
 365 static void drm_unplug_minor(struct drm_minor *minor)
 366 {
 367         if (!minor || !minor->kdev)
 368                 return;
 369
 370 #if defined(CONFIG_DEBUG_FS)
 371         drm_debugfs_cleanup(minor);
 372 #endif
 373
 374         drm_sysfs_device_remove(minor);
 375         idr_remove(&drm_minors_idr, minor->index);
 376 }
 377
 378 /**
 379  * drm_minor_acquire - Acquire a DRM minor
 380  * @minor_id: Minor ID of the DRM-minor
 381  *
 382  * Looks up the given minor-ID and returns the respective DRM-minor object. The
 383  * refence-count of the underlying device is increased so you must release this
 384  * object with drm_minor_release().
 385  *
 386  * As long as you hold this minor, it is guaranteed that the object and the
 387  * minor->dev pointer will stay valid! However, the device may get unplugged and
 388  * unregistered while you hold the minor.
 389  *
 390  * Returns:
 391  * Pointer to minor-object with increased device-refcount, or PTR_ERR on
 392  * failure.
 393  */
 394 struct drm_minor *drm_minor_acquire(unsigned int minor_id)
 395 {
 396         struct drm_minor *minor;
 397
 398         minor = idr_find(&drm_minors_idr, minor_id);
 399         if (!minor)
 400                 return ERR_PTR(-ENODEV);
 401
 402         drm_dev_ref(minor->dev);
 403         return minor;
 404 }
 405
 406 /**
 407  * drm_minor_release - Release DRM minor
 408  * @minor: Pointer to DRM minor object
 409  *
 410  * Release a minor that was previously acquired via drm_minor_acquire().
 411  */
 412 void drm_minor_release(struct drm_minor *minor)
 413 {
 414         drm_dev_unref(minor->dev);
 415 }
 416
 417 /**
 418  * drm_put_minor - Destroy DRM minor
 419  * @minor: Minor to destroy
 420  *
 421  * This calls drm_unplug_minor() on the given minor and then frees it. Nothing
 422  * is done if @minor is NULL. It is fine to call this on already unplugged
 423  * minors.
 424  * The global DRM mutex must be held by the caller.
 425  */
 426 static void drm_put_minor(struct drm_minor *minor)
 427 {
 428         if (!minor)
 429                 return;
 430
 431         DRM_DEBUG("release secondary minor %d\n", minor->index);
 432
 433         drm_unplug_minor(minor);
 434         kfree(minor);
 435 }
 436
 437 /**
 438  * Called via drm_exit() at module unload time or when pci device is
 439  * unplugged.
 440  *
 441  * Cleans up all DRM device, calling drm_lastclose().
 442  *
 443  */
 444 void drm_put_dev(struct drm_device *dev)
 445 {
 446         DRM_DEBUG("\n");
 447
 448         if (!dev) {
 449                 DRM_ERROR("cleanup called no dev\n");
 450                 return;
 451         }
 452
 453         drm_dev_unregister(dev);
 454         drm_dev_free(dev);
 455 }
 456 EXPORT_SYMBOL(drm_put_dev);
 457
 458 void drm_unplug_dev(struct drm_device *dev)
 459 {
 460         /* for a USB device */
 461         if (drm_core_check_feature(dev, DRIVER_MODESET))
 462                 drm_unplug_minor(dev->control);
 463         if (dev->render)
 464                 drm_unplug_minor(dev->render);
 465         drm_unplug_minor(dev->primary);
 466
 467         mutex_lock(&drm_global_mutex);
 468
 469         drm_device_set_unplugged(dev);
 470
 471         if (dev->open_count == 0) {
 472                 drm_put_dev(dev);
 473         }
 474         mutex_unlock(&drm_global_mutex);
 475 }
 476 EXPORT_SYMBOL(drm_unplug_dev);
 477
 478 /**
 479  * drm_dev_alloc - Allocate new drm device
 480  * @driver: DRM driver to allocate device for
 481  * @parent: Parent device object
 482  *
 483  * Allocate and initialize a new DRM device. No device registration is done.
 484  * Call drm_dev_register() to advertice the device to user space and register it
 485  * with other core subsystems.
 486  *
 487  * RETURNS:
 488  * Pointer to new DRM device, or NULL if out of memory.
 489  */
 490 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
 491                                  struct device *parent)
 492 {
 493         struct drm_device *dev;
 494         int ret;
 495
 496         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
 497         if (!dev)
 498                 return NULL;
 499
 500         dev->dev = parent;
 501         dev->driver = driver;
 502
 503         INIT_LIST_HEAD(&dev->filelist);
 504         INIT_LIST_HEAD(&dev->ctxlist);
 505         INIT_LIST_HEAD(&dev->vmalist);
 506         INIT_LIST_HEAD(&dev->maplist);
 507         INIT_LIST_HEAD(&dev->vblank_event_list);
 508
 509         spin_lock_init(&dev->count_lock);
 510         spin_lock_init(&dev->event_lock);
 511         mutex_init(&dev->struct_mutex);
 512         mutex_init(&dev->ctxlist_mutex);
 513         mutex_init(&dev->master_mutex);
 514
 515         if (drm_core_check_feature(dev, DRIVER_MODESET)) {
 516                 ret = drm_minor_alloc(dev, DRM_MINOR_CONTROL);
 517                 if (ret)
 518                         goto err_minors;
 519         }
 520
 521         if (drm_core_check_feature(dev, DRIVER_RENDER) && drm_rnodes) {
 522                 ret = drm_minor_alloc(dev, DRM_MINOR_RENDER);
 523                 if (ret)
 524                         goto err_minors;
 525         }
 526         ret = drm_minor_alloc(dev, DRM_MINOR_LEGACY);
 527         if (ret)
 528                 goto err_minors;
 529
 530         dev->anon_inode = drm_fs_inode_new();
 531         if (IS_ERR(dev->anon_inode)) {
 532                 ret = PTR_ERR(dev->anon_inode);
 533                 DRM_ERROR("Cannot allocate anonymous inode: %d\n", ret);
 534                 goto err_minors;
 535         }
 536
 537         if (drm_ht_create(&dev->map_hash, 12))
 538                 goto err_inode;
 539
 540         ret = drm_ctxbitmap_init(dev);
 541         if (ret) {
 542                 DRM_ERROR("Cannot allocate memory for context bitmap.\n");
 543                 goto err_ht;
 544         }
 545
 546         if (driver->driver_features & DRIVER_GEM) {
 547                 ret = drm_gem_init(dev);
 548                 if (ret) {
 549                         DRM_ERROR("Cannot initialize graphics execution manager (GEM)\n");
 550                         goto err_ctxbitmap;
 551                 }
 552         }
 553
 554         return dev;
 555
 556 err_ctxbitmap:
 557         drm_ctxbitmap_cleanup(dev);
 558 err_ht:
 559         drm_ht_remove(&dev->map_hash);
 560 err_inode:
 561         drm_fs_inode_free(dev->anon_inode);
 562 err_minors:
 563         drm_put_minor(dev->control);
 564         drm_put_minor(dev->render);
 565         drm_put_minor(dev->primary);
 566         mutex_destroy(&dev->master_mutex);
 567         kfree(dev);
 568         return NULL;
 569 }
 570 EXPORT_SYMBOL(drm_dev_alloc);
 571
 572 /**
 573  * drm_dev_free - Free DRM device
 574  * @dev: DRM device to free
 575  *
 576  * Free a DRM device that has previously been allocated via drm_dev_alloc().
 577  * You must not use kfree() instead or you will leak memory.
 578  *
 579  * This must not be called once the device got registered. Use drm_put_dev()
 580  * instead, which then calls drm_dev_free().
 581  */
 582 void drm_dev_free(struct drm_device *dev)
 583 {
 584         drm_put_minor(dev->control);
 585         drm_put_minor(dev->render);
 586         drm_put_minor(dev->primary);
 587
 588         if (dev->driver->driver_features & DRIVER_GEM)
 589                 drm_gem_destroy(dev);
 590
 591         drm_ctxbitmap_cleanup(dev);
 592         drm_ht_remove(&dev->map_hash);
 593         drm_fs_inode_free(dev->anon_inode);
 594
 595         mutex_destroy(&dev->master_mutex);
 596         kfree(dev);
 597 }
 598 EXPORT_SYMBOL(drm_dev_free);
 599
 600 /**
 601  * drm_dev_register - Register DRM device
 602  * @dev: Device to register
 603  *
 604  * Register the DRM device @dev with the system, advertise device to user-space
 605  * and start normal device operation. @dev must be allocated via drm_dev_alloc()
 606  * previously.
 607  *
 608  * Never call this twice on any device!
 609  *
 610  * RETURNS:
 611  * 0 on success, negative error code on failure.
 612  */
 613 int drm_dev_register(struct drm_device *dev, unsigned long flags)
 614 {
 615         int ret;
 616
 617         mutex_lock(&drm_global_mutex);
 618
 619         ret = drm_get_minor(dev, DRM_MINOR_CONTROL);
 620         if (ret)
 621                 goto err_minors;
 622
 623         ret = drm_get_minor(dev, DRM_MINOR_RENDER);
 624         if (ret)
 625                 goto err_minors;
 626
 627         ret = drm_get_minor(dev, DRM_MINOR_LEGACY);
 628         if (ret)
 629                 goto err_minors;
 630
 631         if (dev->driver->load) {
 632                 ret = dev->driver->load(dev, flags);
 633                 if (ret)
 634                         goto err_minors;
 635         }
 636
 637         /* setup grouping for legacy outputs */
 638         if (drm_core_check_feature(dev, DRIVER_MODESET)) {
 639                 ret = drm_mode_group_init_legacy_group(dev,
 640                                 &dev->primary->mode_group);
 641                 if (ret)
 642                         goto err_unload;
 643         }
 644
 645         ret = 0;
 646         goto out_unlock;
 647
 648 err_unload:
 649         if (dev->driver->unload)
 650                 dev->driver->unload(dev);
 651 err_minors:
 652         drm_unplug_minor(dev->control);
 653         drm_unplug_minor(dev->render);
 654         drm_unplug_minor(dev->primary);
 655 out_unlock:
 656         mutex_unlock(&drm_global_mutex);
 657         return ret;
 658 }
 659 EXPORT_SYMBOL(drm_dev_register);
 660
 661 /**
 662  * drm_dev_unregister - Unregister DRM device
 663  * @dev: Device to unregister
 664  *
 665  * Unregister the DRM device from the system. This does the reverse of
 666  * drm_dev_register() but does not deallocate the device. The caller must call
 667  * drm_dev_free() to free all resources.
 668  */
 669 void drm_dev_unregister(struct drm_device *dev)
 670 {
 671         struct drm_map_list *r_list, *list_temp;
 672
 673         drm_lastclose(dev);
 674
 675         if (dev->driver->unload)
 676                 dev->driver->unload(dev);
 677
 678         if (dev->agp)
 679                 drm_pci_agp_destroy(dev);
 680
 681         drm_vblank_cleanup(dev);
 682
 683         list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head)
 684                 drm_rmmap(dev, r_list->map);
 685
 686         drm_unplug_minor(dev->control);
 687         drm_unplug_minor(dev->render);
 688         drm_unplug_minor(dev->primary);
 689 }
 690 EXPORT_SYMBOL(drm_dev_unregister);