5 * \author Rickard E. (Rik) Faith <faith@valinux.com>
9 * Created: Fri Jan 19 10:48:35 2001 by faith@acm.org
11 * Copyright 2001 VA Linux Systems, Inc., Sunnyvale, California.
12 * All Rights Reserved.
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:
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
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.
35 #include <linux/module.h>
36 #include <linux/moduleparam.h>
37 #include <linux/mount.h>
38 #include <linux/slab.h>
40 #include <drm/drm_core.h>
42 unsigned int drm_debug = 0; /* 1 to enable debug output */
43 EXPORT_SYMBOL(drm_debug);
45 unsigned int drm_rnodes = 0; /* 1 to enable experimental render nodes API */
46 EXPORT_SYMBOL(drm_rnodes);
48 /* 1 to allow user space to request universal planes (experimental) */
49 unsigned int drm_universal_planes = 0;
50 EXPORT_SYMBOL(drm_universal_planes);
52 unsigned int drm_vblank_offdelay = 5000; /* Default to 5000 msecs. */
53 EXPORT_SYMBOL(drm_vblank_offdelay);
55 unsigned int drm_timestamp_precision = 20; /* Default to 20 usecs. */
56 EXPORT_SYMBOL(drm_timestamp_precision);
59 * Default to use monotonic timestamps for wait-for-vblank and page-flip
62 unsigned int drm_timestamp_monotonic = 1;
64 MODULE_AUTHOR(CORE_AUTHOR);
65 MODULE_DESCRIPTION(CORE_DESC);
66 MODULE_LICENSE("GPL and additional rights");
67 MODULE_PARM_DESC(debug, "Enable debug output");
68 MODULE_PARM_DESC(rnodes, "Enable experimental render nodes API");
69 MODULE_PARM_DESC(vblankoffdelay, "Delay until vblank irq auto-disable [msecs]");
70 MODULE_PARM_DESC(timestamp_precision_usec, "Max. error on timestamps [usecs]");
71 MODULE_PARM_DESC(timestamp_monotonic, "Use monotonic timestamps");
73 module_param_named(debug, drm_debug, int, 0600);
74 module_param_named(rnodes, drm_rnodes, int, 0600);
75 module_param_named(universal_planes, drm_universal_planes, int, 0600);
76 module_param_named(vblankoffdelay, drm_vblank_offdelay, int, 0600);
77 module_param_named(timestamp_precision_usec, drm_timestamp_precision, int, 0600);
78 module_param_named(timestamp_monotonic, drm_timestamp_monotonic, int, 0600);
80 static DEFINE_SPINLOCK(drm_minor_lock);
81 struct idr drm_minors_idr;
83 struct class *drm_class;
84 struct dentry *drm_debugfs_root;
86 int drm_err(const char *func, const char *format, ...)
92 va_start(args, format);
97 r = printk(KERN_ERR "[" DRM_NAME ":%s] *ERROR* %pV", func, &vaf);
103 EXPORT_SYMBOL(drm_err);
105 void drm_ut_debug_printk(const char *function_name, const char *format, ...)
107 struct va_format vaf;
110 va_start(args, format);
114 printk(KERN_DEBUG "[" DRM_NAME ":%s] %pV", function_name, &vaf);
118 EXPORT_SYMBOL(drm_ut_debug_printk);
120 struct drm_master *drm_master_create(struct drm_minor *minor)
122 struct drm_master *master;
124 master = kzalloc(sizeof(*master), GFP_KERNEL);
128 kref_init(&master->refcount);
129 spin_lock_init(&master->lock.spinlock);
130 init_waitqueue_head(&master->lock.lock_queue);
131 if (drm_ht_create(&master->magiclist, DRM_MAGIC_HASH_ORDER)) {
135 INIT_LIST_HEAD(&master->magicfree);
136 master->minor = minor;
141 struct drm_master *drm_master_get(struct drm_master *master)
143 kref_get(&master->refcount);
146 EXPORT_SYMBOL(drm_master_get);
148 static void drm_master_destroy(struct kref *kref)
150 struct drm_master *master = container_of(kref, struct drm_master, refcount);
151 struct drm_magic_entry *pt, *next;
152 struct drm_device *dev = master->minor->dev;
153 struct drm_map_list *r_list, *list_temp;
155 mutex_lock(&dev->struct_mutex);
156 if (dev->driver->master_destroy)
157 dev->driver->master_destroy(dev, master);
159 list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head) {
160 if (r_list->master == master) {
161 drm_rmmap_locked(dev, r_list->map);
166 if (master->unique) {
167 kfree(master->unique);
168 master->unique = NULL;
169 master->unique_len = 0;
172 list_for_each_entry_safe(pt, next, &master->magicfree, head) {
174 drm_ht_remove_item(&master->magiclist, &pt->hash_item);
178 drm_ht_remove(&master->magiclist);
180 mutex_unlock(&dev->struct_mutex);
184 void drm_master_put(struct drm_master **master)
186 kref_put(&(*master)->refcount, drm_master_destroy);
189 EXPORT_SYMBOL(drm_master_put);
191 int drm_setmaster_ioctl(struct drm_device *dev, void *data,
192 struct drm_file *file_priv)
196 mutex_lock(&dev->master_mutex);
197 if (file_priv->is_master)
200 if (file_priv->minor->master) {
205 if (!file_priv->master) {
210 file_priv->minor->master = drm_master_get(file_priv->master);
211 file_priv->is_master = 1;
212 if (dev->driver->master_set) {
213 ret = dev->driver->master_set(dev, file_priv, false);
214 if (unlikely(ret != 0)) {
215 file_priv->is_master = 0;
216 drm_master_put(&file_priv->minor->master);
221 mutex_unlock(&dev->master_mutex);
225 int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
226 struct drm_file *file_priv)
230 mutex_lock(&dev->master_mutex);
231 if (!file_priv->is_master)
234 if (!file_priv->minor->master)
238 if (dev->driver->master_drop)
239 dev->driver->master_drop(dev, file_priv, false);
240 drm_master_put(&file_priv->minor->master);
241 file_priv->is_master = 0;
244 mutex_unlock(&dev->master_mutex);
250 * A DRM device can provide several char-dev interfaces on the DRM-Major. Each
251 * of them is represented by a drm_minor object. Depending on the capabilities
252 * of the device-driver, different interfaces are registered.
254 * Minors can be accessed via dev->$minor_name. This pointer is either
255 * NULL or a valid drm_minor pointer and stays valid as long as the device is
256 * valid. This means, DRM minors have the same life-time as the underlying
257 * device. However, this doesn't mean that the minor is active. Minors are
258 * registered and unregistered dynamically according to device-state.
261 static struct drm_minor **drm_minor_get_slot(struct drm_device *dev,
265 case DRM_MINOR_LEGACY:
266 return &dev->primary;
267 case DRM_MINOR_RENDER:
269 case DRM_MINOR_CONTROL:
270 return &dev->control;
276 static int drm_minor_alloc(struct drm_device *dev, unsigned int type)
278 struct drm_minor *minor;
280 minor = kzalloc(sizeof(*minor), GFP_KERNEL);
287 *drm_minor_get_slot(dev, type) = minor;
291 static void drm_minor_free(struct drm_device *dev, unsigned int type)
293 struct drm_minor **slot;
295 slot = drm_minor_get_slot(dev, type);
297 drm_mode_group_destroy(&(*slot)->mode_group);
303 static int drm_minor_register(struct drm_device *dev, unsigned int type)
305 struct drm_minor *new_minor;
312 new_minor = *drm_minor_get_slot(dev, type);
316 idr_preload(GFP_KERNEL);
317 spin_lock_irqsave(&drm_minor_lock, flags);
318 minor_id = idr_alloc(&drm_minors_idr,
323 spin_unlock_irqrestore(&drm_minor_lock, flags);
329 new_minor->index = minor_id;
331 ret = drm_debugfs_init(new_minor, minor_id, drm_debugfs_root);
333 DRM_ERROR("DRM: Failed to initialize /sys/kernel/debug/dri.\n");
337 ret = drm_sysfs_device_add(new_minor);
339 DRM_ERROR("DRM: Error sysfs_device_add.\n");
343 /* replace NULL with @minor so lookups will succeed from now on */
344 spin_lock_irqsave(&drm_minor_lock, flags);
345 idr_replace(&drm_minors_idr, new_minor, new_minor->index);
346 spin_unlock_irqrestore(&drm_minor_lock, flags);
348 DRM_DEBUG("new minor assigned %d\n", minor_id);
352 drm_debugfs_cleanup(new_minor);
354 spin_lock_irqsave(&drm_minor_lock, flags);
355 idr_remove(&drm_minors_idr, minor_id);
356 spin_unlock_irqrestore(&drm_minor_lock, flags);
357 new_minor->index = 0;
361 static void drm_minor_unregister(struct drm_device *dev, unsigned int type)
363 struct drm_minor *minor;
366 minor = *drm_minor_get_slot(dev, type);
367 if (!minor || !minor->kdev)
370 spin_lock_irqsave(&drm_minor_lock, flags);
371 idr_remove(&drm_minors_idr, minor->index);
372 spin_unlock_irqrestore(&drm_minor_lock, flags);
375 drm_debugfs_cleanup(minor);
376 drm_sysfs_device_remove(minor);
380 * drm_minor_acquire - Acquire a DRM minor
381 * @minor_id: Minor ID of the DRM-minor
383 * Looks up the given minor-ID and returns the respective DRM-minor object. The
384 * refence-count of the underlying device is increased so you must release this
385 * object with drm_minor_release().
387 * As long as you hold this minor, it is guaranteed that the object and the
388 * minor->dev pointer will stay valid! However, the device may get unplugged and
389 * unregistered while you hold the minor.
392 * Pointer to minor-object with increased device-refcount, or PTR_ERR on
395 struct drm_minor *drm_minor_acquire(unsigned int minor_id)
397 struct drm_minor *minor;
400 spin_lock_irqsave(&drm_minor_lock, flags);
401 minor = idr_find(&drm_minors_idr, minor_id);
403 drm_dev_ref(minor->dev);
404 spin_unlock_irqrestore(&drm_minor_lock, flags);
407 return ERR_PTR(-ENODEV);
408 } else if (drm_device_is_unplugged(minor->dev)) {
409 drm_dev_unref(minor->dev);
410 return ERR_PTR(-ENODEV);
417 * drm_minor_release - Release DRM minor
418 * @minor: Pointer to DRM minor object
420 * Release a minor that was previously acquired via drm_minor_acquire().
422 void drm_minor_release(struct drm_minor *minor)
424 drm_dev_unref(minor->dev);
428 * Called via drm_exit() at module unload time or when pci device is
431 * Cleans up all DRM device, calling drm_lastclose().
434 void drm_put_dev(struct drm_device *dev)
439 DRM_ERROR("cleanup called no dev\n");
443 drm_dev_unregister(dev);
446 EXPORT_SYMBOL(drm_put_dev);
448 void drm_unplug_dev(struct drm_device *dev)
450 /* for a USB device */
451 drm_minor_unregister(dev, DRM_MINOR_LEGACY);
452 drm_minor_unregister(dev, DRM_MINOR_RENDER);
453 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
455 mutex_lock(&drm_global_mutex);
457 drm_device_set_unplugged(dev);
459 if (dev->open_count == 0) {
462 mutex_unlock(&drm_global_mutex);
464 EXPORT_SYMBOL(drm_unplug_dev);
468 * We want to be able to allocate our own "struct address_space" to control
469 * memory-mappings in VRAM (or stolen RAM, ...). However, core MM does not allow
470 * stand-alone address_space objects, so we need an underlying inode. As there
471 * is no way to allocate an independent inode easily, we need a fake internal
474 * The drm_fs_inode_new() function allocates a new inode, drm_fs_inode_free()
475 * frees it again. You are allowed to use iget() and iput() to get references to
476 * the inode. But each drm_fs_inode_new() call must be paired with exactly one
477 * drm_fs_inode_free() call (which does not have to be the last iput()).
478 * We use drm_fs_inode_*() to manage our internal VFS mount-point and share it
479 * between multiple inode-users. You could, technically, call
480 * iget() + drm_fs_inode_free() directly after alloc and sometime later do an
481 * iput(), but this way you'd end up with a new vfsmount for each inode.
484 static int drm_fs_cnt;
485 static struct vfsmount *drm_fs_mnt;
487 static const struct dentry_operations drm_fs_dops = {
488 .d_dname = simple_dname,
491 static const struct super_operations drm_fs_sops = {
492 .statfs = simple_statfs,
495 static struct dentry *drm_fs_mount(struct file_system_type *fs_type, int flags,
496 const char *dev_name, void *data)
498 return mount_pseudo(fs_type,
505 static struct file_system_type drm_fs_type = {
507 .owner = THIS_MODULE,
508 .mount = drm_fs_mount,
509 .kill_sb = kill_anon_super,
512 static struct inode *drm_fs_inode_new(void)
517 r = simple_pin_fs(&drm_fs_type, &drm_fs_mnt, &drm_fs_cnt);
519 DRM_ERROR("Cannot mount pseudo fs: %d\n", r);
523 inode = alloc_anon_inode(drm_fs_mnt->mnt_sb);
525 simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
530 static void drm_fs_inode_free(struct inode *inode)
534 simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
539 * drm_dev_alloc - Allocate new drm device
540 * @driver: DRM driver to allocate device for
541 * @parent: Parent device object
543 * Allocate and initialize a new DRM device. No device registration is done.
544 * Call drm_dev_register() to advertice the device to user space and register it
545 * with other core subsystems.
547 * The initial ref-count of the object is 1. Use drm_dev_ref() and
548 * drm_dev_unref() to take and drop further ref-counts.
551 * Pointer to new DRM device, or NULL if out of memory.
553 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
554 struct device *parent)
556 struct drm_device *dev;
559 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
563 kref_init(&dev->ref);
565 dev->driver = driver;
567 INIT_LIST_HEAD(&dev->filelist);
568 INIT_LIST_HEAD(&dev->ctxlist);
569 INIT_LIST_HEAD(&dev->vmalist);
570 INIT_LIST_HEAD(&dev->maplist);
571 INIT_LIST_HEAD(&dev->vblank_event_list);
573 spin_lock_init(&dev->buf_lock);
574 spin_lock_init(&dev->event_lock);
575 mutex_init(&dev->struct_mutex);
576 mutex_init(&dev->ctxlist_mutex);
577 mutex_init(&dev->master_mutex);
579 dev->anon_inode = drm_fs_inode_new();
580 if (IS_ERR(dev->anon_inode)) {
581 ret = PTR_ERR(dev->anon_inode);
582 DRM_ERROR("Cannot allocate anonymous inode: %d\n", ret);
586 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
587 ret = drm_minor_alloc(dev, DRM_MINOR_CONTROL);
592 if (drm_core_check_feature(dev, DRIVER_RENDER) && drm_rnodes) {
593 ret = drm_minor_alloc(dev, DRM_MINOR_RENDER);
598 ret = drm_minor_alloc(dev, DRM_MINOR_LEGACY);
602 if (drm_ht_create(&dev->map_hash, 12))
605 ret = drm_ctxbitmap_init(dev);
607 DRM_ERROR("Cannot allocate memory for context bitmap.\n");
611 if (driver->driver_features & DRIVER_GEM) {
612 ret = drm_gem_init(dev);
614 DRM_ERROR("Cannot initialize graphics execution manager (GEM)\n");
622 drm_ctxbitmap_cleanup(dev);
624 drm_ht_remove(&dev->map_hash);
626 drm_minor_free(dev, DRM_MINOR_LEGACY);
627 drm_minor_free(dev, DRM_MINOR_RENDER);
628 drm_minor_free(dev, DRM_MINOR_CONTROL);
629 drm_fs_inode_free(dev->anon_inode);
631 mutex_destroy(&dev->master_mutex);
635 EXPORT_SYMBOL(drm_dev_alloc);
637 static void drm_dev_release(struct kref *ref)
639 struct drm_device *dev = container_of(ref, struct drm_device, ref);
641 if (dev->driver->driver_features & DRIVER_GEM)
642 drm_gem_destroy(dev);
644 drm_ctxbitmap_cleanup(dev);
645 drm_ht_remove(&dev->map_hash);
646 drm_fs_inode_free(dev->anon_inode);
648 drm_minor_free(dev, DRM_MINOR_LEGACY);
649 drm_minor_free(dev, DRM_MINOR_RENDER);
650 drm_minor_free(dev, DRM_MINOR_CONTROL);
652 mutex_destroy(&dev->master_mutex);
657 * drm_dev_ref - Take reference of a DRM device
658 * @dev: device to take reference of or NULL
660 * This increases the ref-count of @dev by one. You *must* already own a
661 * reference when calling this. Use drm_dev_unref() to drop this reference
664 * This function never fails. However, this function does not provide *any*
665 * guarantee whether the device is alive or running. It only provides a
666 * reference to the object and the memory associated with it.
668 void drm_dev_ref(struct drm_device *dev)
673 EXPORT_SYMBOL(drm_dev_ref);
676 * drm_dev_unref - Drop reference of a DRM device
677 * @dev: device to drop reference of or NULL
679 * This decreases the ref-count of @dev by one. The device is destroyed if the
680 * ref-count drops to zero.
682 void drm_dev_unref(struct drm_device *dev)
685 kref_put(&dev->ref, drm_dev_release);
687 EXPORT_SYMBOL(drm_dev_unref);
690 * drm_dev_register - Register DRM device
691 * @dev: Device to register
693 * Register the DRM device @dev with the system, advertise device to user-space
694 * and start normal device operation. @dev must be allocated via drm_dev_alloc()
697 * Never call this twice on any device!
700 * 0 on success, negative error code on failure.
702 int drm_dev_register(struct drm_device *dev, unsigned long flags)
706 mutex_lock(&drm_global_mutex);
708 ret = drm_minor_register(dev, DRM_MINOR_CONTROL);
712 ret = drm_minor_register(dev, DRM_MINOR_RENDER);
716 ret = drm_minor_register(dev, DRM_MINOR_LEGACY);
720 if (dev->driver->load) {
721 ret = dev->driver->load(dev, flags);
726 /* setup grouping for legacy outputs */
727 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
728 ret = drm_mode_group_init_legacy_group(dev,
729 &dev->primary->mode_group);
738 if (dev->driver->unload)
739 dev->driver->unload(dev);
741 drm_minor_unregister(dev, DRM_MINOR_LEGACY);
742 drm_minor_unregister(dev, DRM_MINOR_RENDER);
743 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
745 mutex_unlock(&drm_global_mutex);
748 EXPORT_SYMBOL(drm_dev_register);
751 * drm_dev_unregister - Unregister DRM device
752 * @dev: Device to unregister
754 * Unregister the DRM device from the system. This does the reverse of
755 * drm_dev_register() but does not deallocate the device. The caller must call
756 * drm_dev_unref() to drop their final reference.
758 void drm_dev_unregister(struct drm_device *dev)
760 struct drm_map_list *r_list, *list_temp;
764 if (dev->driver->unload)
765 dev->driver->unload(dev);
768 drm_pci_agp_destroy(dev);
770 drm_vblank_cleanup(dev);
772 list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head)
773 drm_rmmap(dev, r_list->map);
775 drm_minor_unregister(dev, DRM_MINOR_LEGACY);
776 drm_minor_unregister(dev, DRM_MINOR_RENDER);
777 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
779 EXPORT_SYMBOL(drm_dev_unregister);