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