2 * Created: Fri Jan 19 10:48:35 2001 by faith@acm.org
4 * Copyright 2001 VA Linux Systems, Inc., Sunnyvale, California.
7 * Author Rickard E. (Rik) Faith <faith@valinux.com>
9 * Permission is hereby granted, free of charge, to any person obtaining a
10 * copy of this software and associated documentation files (the "Software"),
11 * to deal in the Software without restriction, including without limitation
12 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
13 * and/or sell copies of the Software, and to permit persons to whom the
14 * Software is furnished to do so, subject to the following conditions:
16 * The above copyright notice and this permission notice (including the next
17 * paragraph) shall be included in all copies or substantial portions of the
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
23 * PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
24 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
25 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
26 * DEALINGS IN THE SOFTWARE.
29 #include <linux/debugfs.h>
31 #include <linux/module.h>
32 #include <linux/moduleparam.h>
33 #include <linux/mount.h>
34 #include <linux/slab.h>
36 #include <drm/drm_core.h>
37 #include "drm_legacy.h"
38 #include "drm_internal.h"
40 unsigned int drm_debug = 0; /* 1 to enable debug output */
41 EXPORT_SYMBOL(drm_debug);
43 MODULE_AUTHOR(CORE_AUTHOR);
44 MODULE_DESCRIPTION(CORE_DESC);
45 MODULE_LICENSE("GPL and additional rights");
46 MODULE_PARM_DESC(debug, "Enable debug output");
47 MODULE_PARM_DESC(vblankoffdelay, "Delay until vblank irq auto-disable [msecs] (0: never disable, <0: disable immediately)");
48 MODULE_PARM_DESC(timestamp_precision_usec, "Max. error on timestamps [usecs]");
49 MODULE_PARM_DESC(timestamp_monotonic, "Use monotonic timestamps");
51 module_param_named(debug, drm_debug, int, 0600);
53 static DEFINE_SPINLOCK(drm_minor_lock);
54 static struct idr drm_minors_idr;
56 struct class *drm_class;
57 static struct dentry *drm_debugfs_root;
59 void drm_err(const char *format, ...)
64 va_start(args, format);
69 printk(KERN_ERR "[" DRM_NAME ":%pf] *ERROR* %pV",
70 __builtin_return_address(0), &vaf);
74 EXPORT_SYMBOL(drm_err);
76 void drm_ut_debug_printk(const char *function_name, const char *format, ...)
81 va_start(args, format);
85 printk(KERN_DEBUG "[" DRM_NAME ":%s] %pV", function_name, &vaf);
89 EXPORT_SYMBOL(drm_ut_debug_printk);
91 #define DRM_MAGIC_HASH_ORDER 4 /**< Size of key hash table. Must be power of 2. */
93 struct drm_master *drm_master_create(struct drm_minor *minor)
95 struct drm_master *master;
97 master = kzalloc(sizeof(*master), GFP_KERNEL);
101 kref_init(&master->refcount);
102 spin_lock_init(&master->lock.spinlock);
103 init_waitqueue_head(&master->lock.lock_queue);
104 if (drm_ht_create(&master->magiclist, DRM_MAGIC_HASH_ORDER)) {
108 INIT_LIST_HEAD(&master->magicfree);
109 master->minor = minor;
114 struct drm_master *drm_master_get(struct drm_master *master)
116 kref_get(&master->refcount);
119 EXPORT_SYMBOL(drm_master_get);
121 static void drm_master_destroy(struct kref *kref)
123 struct drm_master *master = container_of(kref, struct drm_master, refcount);
124 struct drm_device *dev = master->minor->dev;
125 struct drm_map_list *r_list, *list_temp;
127 mutex_lock(&dev->struct_mutex);
128 if (dev->driver->master_destroy)
129 dev->driver->master_destroy(dev, master);
131 list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head) {
132 if (r_list->master == master) {
133 drm_legacy_rmmap_locked(dev, r_list->map);
138 if (master->unique) {
139 kfree(master->unique);
140 master->unique = NULL;
141 master->unique_len = 0;
144 drm_ht_remove(&master->magiclist);
146 mutex_unlock(&dev->struct_mutex);
150 void drm_master_put(struct drm_master **master)
152 kref_put(&(*master)->refcount, drm_master_destroy);
155 EXPORT_SYMBOL(drm_master_put);
157 int drm_setmaster_ioctl(struct drm_device *dev, void *data,
158 struct drm_file *file_priv)
162 mutex_lock(&dev->master_mutex);
163 if (file_priv->is_master)
166 if (file_priv->minor->master) {
171 if (!file_priv->master) {
176 file_priv->minor->master = drm_master_get(file_priv->master);
177 file_priv->is_master = 1;
178 if (dev->driver->master_set) {
179 ret = dev->driver->master_set(dev, file_priv, false);
180 if (unlikely(ret != 0)) {
181 file_priv->is_master = 0;
182 drm_master_put(&file_priv->minor->master);
187 mutex_unlock(&dev->master_mutex);
191 int drm_dropmaster_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)
204 if (dev->driver->master_drop)
205 dev->driver->master_drop(dev, file_priv, false);
206 drm_master_put(&file_priv->minor->master);
207 file_priv->is_master = 0;
210 mutex_unlock(&dev->master_mutex);
216 * A DRM device can provide several char-dev interfaces on the DRM-Major. Each
217 * of them is represented by a drm_minor object. Depending on the capabilities
218 * of the device-driver, different interfaces are registered.
220 * Minors can be accessed via dev->$minor_name. This pointer is either
221 * NULL or a valid drm_minor pointer and stays valid as long as the device is
222 * valid. This means, DRM minors have the same life-time as the underlying
223 * device. However, this doesn't mean that the minor is active. Minors are
224 * registered and unregistered dynamically according to device-state.
227 static struct drm_minor **drm_minor_get_slot(struct drm_device *dev,
231 case DRM_MINOR_LEGACY:
232 return &dev->primary;
233 case DRM_MINOR_RENDER:
235 case DRM_MINOR_CONTROL:
236 return &dev->control;
242 static int drm_minor_alloc(struct drm_device *dev, unsigned int type)
244 struct drm_minor *minor;
248 minor = kzalloc(sizeof(*minor), GFP_KERNEL);
255 idr_preload(GFP_KERNEL);
256 spin_lock_irqsave(&drm_minor_lock, flags);
257 r = idr_alloc(&drm_minors_idr,
262 spin_unlock_irqrestore(&drm_minor_lock, flags);
270 minor->kdev = drm_sysfs_minor_alloc(minor);
271 if (IS_ERR(minor->kdev)) {
272 r = PTR_ERR(minor->kdev);
276 *drm_minor_get_slot(dev, type) = minor;
280 spin_lock_irqsave(&drm_minor_lock, flags);
281 idr_remove(&drm_minors_idr, minor->index);
282 spin_unlock_irqrestore(&drm_minor_lock, flags);
288 static void drm_minor_free(struct drm_device *dev, unsigned int type)
290 struct drm_minor **slot, *minor;
293 slot = drm_minor_get_slot(dev, type);
298 drm_mode_group_destroy(&minor->mode_group);
299 put_device(minor->kdev);
301 spin_lock_irqsave(&drm_minor_lock, flags);
302 idr_remove(&drm_minors_idr, minor->index);
303 spin_unlock_irqrestore(&drm_minor_lock, flags);
309 static int drm_minor_register(struct drm_device *dev, unsigned int type)
311 struct drm_minor *minor;
317 minor = *drm_minor_get_slot(dev, type);
321 ret = drm_debugfs_init(minor, minor->index, drm_debugfs_root);
323 DRM_ERROR("DRM: Failed to initialize /sys/kernel/debug/dri.\n");
327 ret = device_add(minor->kdev);
331 /* replace NULL with @minor so lookups will succeed from now on */
332 spin_lock_irqsave(&drm_minor_lock, flags);
333 idr_replace(&drm_minors_idr, minor, minor->index);
334 spin_unlock_irqrestore(&drm_minor_lock, flags);
336 DRM_DEBUG("new minor registered %d\n", minor->index);
340 drm_debugfs_cleanup(minor);
344 static void drm_minor_unregister(struct drm_device *dev, unsigned int type)
346 struct drm_minor *minor;
349 minor = *drm_minor_get_slot(dev, type);
350 if (!minor || !device_is_registered(minor->kdev))
353 /* replace @minor with NULL so lookups will fail from now on */
354 spin_lock_irqsave(&drm_minor_lock, flags);
355 idr_replace(&drm_minors_idr, NULL, minor->index);
356 spin_unlock_irqrestore(&drm_minor_lock, flags);
358 device_del(minor->kdev);
359 dev_set_drvdata(minor->kdev, NULL); /* safety belt */
360 drm_debugfs_cleanup(minor);
364 * drm_minor_acquire - Acquire a DRM minor
365 * @minor_id: Minor ID of the DRM-minor
367 * Looks up the given minor-ID and returns the respective DRM-minor object. The
368 * refence-count of the underlying device is increased so you must release this
369 * object with drm_minor_release().
371 * As long as you hold this minor, it is guaranteed that the object and the
372 * minor->dev pointer will stay valid! However, the device may get unplugged and
373 * unregistered while you hold the minor.
376 * Pointer to minor-object with increased device-refcount, or PTR_ERR on
379 struct drm_minor *drm_minor_acquire(unsigned int minor_id)
381 struct drm_minor *minor;
384 spin_lock_irqsave(&drm_minor_lock, flags);
385 minor = idr_find(&drm_minors_idr, minor_id);
387 drm_dev_ref(minor->dev);
388 spin_unlock_irqrestore(&drm_minor_lock, flags);
391 return ERR_PTR(-ENODEV);
392 } else if (drm_device_is_unplugged(minor->dev)) {
393 drm_dev_unref(minor->dev);
394 return ERR_PTR(-ENODEV);
401 * drm_minor_release - Release DRM minor
402 * @minor: Pointer to DRM minor object
404 * Release a minor that was previously acquired via drm_minor_acquire().
406 void drm_minor_release(struct drm_minor *minor)
408 drm_dev_unref(minor->dev);
412 * drm_put_dev - Unregister and release a DRM device
415 * Called at module unload time or when a PCI device is unplugged.
417 * Use of this function is discouraged. It will eventually go away completely.
418 * Please use drm_dev_unregister() and drm_dev_unref() explicitly instead.
420 * Cleans up all DRM device, calling drm_lastclose().
422 void drm_put_dev(struct drm_device *dev)
427 DRM_ERROR("cleanup called no dev\n");
431 drm_dev_unregister(dev);
434 EXPORT_SYMBOL(drm_put_dev);
436 void drm_unplug_dev(struct drm_device *dev)
438 /* for a USB device */
439 drm_minor_unregister(dev, DRM_MINOR_LEGACY);
440 drm_minor_unregister(dev, DRM_MINOR_RENDER);
441 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
443 mutex_lock(&drm_global_mutex);
445 drm_device_set_unplugged(dev);
447 if (dev->open_count == 0) {
450 mutex_unlock(&drm_global_mutex);
452 EXPORT_SYMBOL(drm_unplug_dev);
456 * We want to be able to allocate our own "struct address_space" to control
457 * memory-mappings in VRAM (or stolen RAM, ...). However, core MM does not allow
458 * stand-alone address_space objects, so we need an underlying inode. As there
459 * is no way to allocate an independent inode easily, we need a fake internal
462 * The drm_fs_inode_new() function allocates a new inode, drm_fs_inode_free()
463 * frees it again. You are allowed to use iget() and iput() to get references to
464 * the inode. But each drm_fs_inode_new() call must be paired with exactly one
465 * drm_fs_inode_free() call (which does not have to be the last iput()).
466 * We use drm_fs_inode_*() to manage our internal VFS mount-point and share it
467 * between multiple inode-users. You could, technically, call
468 * iget() + drm_fs_inode_free() directly after alloc and sometime later do an
469 * iput(), but this way you'd end up with a new vfsmount for each inode.
472 static int drm_fs_cnt;
473 static struct vfsmount *drm_fs_mnt;
475 static const struct dentry_operations drm_fs_dops = {
476 .d_dname = simple_dname,
479 static const struct super_operations drm_fs_sops = {
480 .statfs = simple_statfs,
483 static struct dentry *drm_fs_mount(struct file_system_type *fs_type, int flags,
484 const char *dev_name, void *data)
486 return mount_pseudo(fs_type,
493 static struct file_system_type drm_fs_type = {
495 .owner = THIS_MODULE,
496 .mount = drm_fs_mount,
497 .kill_sb = kill_anon_super,
500 static struct inode *drm_fs_inode_new(void)
505 r = simple_pin_fs(&drm_fs_type, &drm_fs_mnt, &drm_fs_cnt);
507 DRM_ERROR("Cannot mount pseudo fs: %d\n", r);
511 inode = alloc_anon_inode(drm_fs_mnt->mnt_sb);
513 simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
518 static void drm_fs_inode_free(struct inode *inode)
522 simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
527 * drm_dev_alloc - Allocate new DRM device
528 * @driver: DRM driver to allocate device for
529 * @parent: Parent device object
531 * Allocate and initialize a new DRM device. No device registration is done.
532 * Call drm_dev_register() to advertice the device to user space and register it
533 * with other core subsystems.
535 * The initial ref-count of the object is 1. Use drm_dev_ref() and
536 * drm_dev_unref() to take and drop further ref-counts.
539 * Pointer to new DRM device, or NULL if out of memory.
541 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
542 struct device *parent)
544 struct drm_device *dev;
547 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
551 kref_init(&dev->ref);
553 dev->driver = driver;
555 INIT_LIST_HEAD(&dev->filelist);
556 INIT_LIST_HEAD(&dev->ctxlist);
557 INIT_LIST_HEAD(&dev->vmalist);
558 INIT_LIST_HEAD(&dev->maplist);
559 INIT_LIST_HEAD(&dev->vblank_event_list);
561 spin_lock_init(&dev->buf_lock);
562 spin_lock_init(&dev->event_lock);
563 mutex_init(&dev->struct_mutex);
564 mutex_init(&dev->ctxlist_mutex);
565 mutex_init(&dev->master_mutex);
567 dev->anon_inode = drm_fs_inode_new();
568 if (IS_ERR(dev->anon_inode)) {
569 ret = PTR_ERR(dev->anon_inode);
570 DRM_ERROR("Cannot allocate anonymous inode: %d\n", ret);
574 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
575 ret = drm_minor_alloc(dev, DRM_MINOR_CONTROL);
580 if (drm_core_check_feature(dev, DRIVER_RENDER)) {
581 ret = drm_minor_alloc(dev, DRM_MINOR_RENDER);
586 ret = drm_minor_alloc(dev, DRM_MINOR_LEGACY);
590 if (drm_ht_create(&dev->map_hash, 12))
593 ret = drm_legacy_ctxbitmap_init(dev);
595 DRM_ERROR("Cannot allocate memory for context bitmap.\n");
599 if (drm_core_check_feature(dev, DRIVER_GEM)) {
600 ret = drm_gem_init(dev);
602 DRM_ERROR("Cannot initialize graphics execution manager (GEM)\n");
610 drm_legacy_ctxbitmap_cleanup(dev);
612 drm_ht_remove(&dev->map_hash);
614 drm_minor_free(dev, DRM_MINOR_LEGACY);
615 drm_minor_free(dev, DRM_MINOR_RENDER);
616 drm_minor_free(dev, DRM_MINOR_CONTROL);
617 drm_fs_inode_free(dev->anon_inode);
619 mutex_destroy(&dev->master_mutex);
623 EXPORT_SYMBOL(drm_dev_alloc);
625 static void drm_dev_release(struct kref *ref)
627 struct drm_device *dev = container_of(ref, struct drm_device, ref);
629 if (drm_core_check_feature(dev, DRIVER_GEM))
630 drm_gem_destroy(dev);
632 drm_legacy_ctxbitmap_cleanup(dev);
633 drm_ht_remove(&dev->map_hash);
634 drm_fs_inode_free(dev->anon_inode);
636 drm_minor_free(dev, DRM_MINOR_LEGACY);
637 drm_minor_free(dev, DRM_MINOR_RENDER);
638 drm_minor_free(dev, DRM_MINOR_CONTROL);
640 mutex_destroy(&dev->master_mutex);
646 * drm_dev_ref - Take reference of a DRM device
647 * @dev: device to take reference of or NULL
649 * This increases the ref-count of @dev by one. You *must* already own a
650 * reference when calling this. Use drm_dev_unref() to drop this reference
653 * This function never fails. However, this function does not provide *any*
654 * guarantee whether the device is alive or running. It only provides a
655 * reference to the object and the memory associated with it.
657 void drm_dev_ref(struct drm_device *dev)
662 EXPORT_SYMBOL(drm_dev_ref);
665 * drm_dev_unref - Drop reference of a DRM device
666 * @dev: device to drop reference of or NULL
668 * This decreases the ref-count of @dev by one. The device is destroyed if the
669 * ref-count drops to zero.
671 void drm_dev_unref(struct drm_device *dev)
674 kref_put(&dev->ref, drm_dev_release);
676 EXPORT_SYMBOL(drm_dev_unref);
679 * drm_dev_register - Register DRM device
680 * @dev: Device to register
681 * @flags: Flags passed to the driver's .load() function
683 * Register the DRM device @dev with the system, advertise device to user-space
684 * and start normal device operation. @dev must be allocated via drm_dev_alloc()
687 * Never call this twice on any device!
690 * 0 on success, negative error code on failure.
692 int drm_dev_register(struct drm_device *dev, unsigned long flags)
696 mutex_lock(&drm_global_mutex);
698 ret = drm_minor_register(dev, DRM_MINOR_CONTROL);
702 ret = drm_minor_register(dev, DRM_MINOR_RENDER);
706 ret = drm_minor_register(dev, DRM_MINOR_LEGACY);
710 if (dev->driver->load) {
711 ret = dev->driver->load(dev, flags);
716 /* setup grouping for legacy outputs */
717 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
718 ret = drm_mode_group_init_legacy_group(dev,
719 &dev->primary->mode_group);
728 if (dev->driver->unload)
729 dev->driver->unload(dev);
731 drm_minor_unregister(dev, DRM_MINOR_LEGACY);
732 drm_minor_unregister(dev, DRM_MINOR_RENDER);
733 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
735 mutex_unlock(&drm_global_mutex);
738 EXPORT_SYMBOL(drm_dev_register);
741 * drm_dev_unregister - Unregister DRM device
742 * @dev: Device to unregister
744 * Unregister the DRM device from the system. This does the reverse of
745 * drm_dev_register() but does not deallocate the device. The caller must call
746 * drm_dev_unref() to drop their final reference.
748 void drm_dev_unregister(struct drm_device *dev)
750 struct drm_map_list *r_list, *list_temp;
754 if (dev->driver->unload)
755 dev->driver->unload(dev);
758 drm_pci_agp_destroy(dev);
760 drm_vblank_cleanup(dev);
762 list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head)
763 drm_legacy_rmmap(dev, r_list->map);
765 drm_minor_unregister(dev, DRM_MINOR_LEGACY);
766 drm_minor_unregister(dev, DRM_MINOR_RENDER);
767 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
769 EXPORT_SYMBOL(drm_dev_unregister);
772 * drm_dev_set_unique - Set the unique name of a DRM device
773 * @dev: device of which to set the unique name
774 * @fmt: format string for unique name
776 * Sets the unique name of a DRM device using the specified format string and
777 * a variable list of arguments. Drivers can use this at driver probe time if
778 * the unique name of the devices they drive is static.
780 * Return: 0 on success or a negative error code on failure.
782 int drm_dev_set_unique(struct drm_device *dev, const char *fmt, ...)
789 dev->unique = kvasprintf(GFP_KERNEL, fmt, ap);
792 return dev->unique ? 0 : -ENOMEM;
794 EXPORT_SYMBOL(drm_dev_set_unique);
798 * The DRM core module initializes all global DRM objects and makes them
799 * available to drivers. Once setup, drivers can probe their respective
801 * Currently, core management includes:
802 * - The "DRM-Global" key/value database
803 * - Global ID management for connectors
804 * - DRM major number allocation
805 * - DRM minor management
809 * Furthermore, the DRM core provides dynamic char-dev lookups. For each
810 * interface registered on a DRM device, you can request minor numbers from DRM
811 * core. DRM core takes care of major-number management and char-dev
812 * registration. A stub ->open() callback forwards any open() requests to the
816 static int drm_stub_open(struct inode *inode, struct file *filp)
818 const struct file_operations *new_fops;
819 struct drm_minor *minor;
824 mutex_lock(&drm_global_mutex);
825 minor = drm_minor_acquire(iminor(inode));
827 err = PTR_ERR(minor);
831 new_fops = fops_get(minor->dev->driver->fops);
837 replace_fops(filp, new_fops);
838 if (filp->f_op->open)
839 err = filp->f_op->open(inode, filp);
844 drm_minor_release(minor);
846 mutex_unlock(&drm_global_mutex);
850 static const struct file_operations drm_stub_fops = {
851 .owner = THIS_MODULE,
852 .open = drm_stub_open,
853 .llseek = noop_llseek,
856 static int __init drm_core_init(void)
861 drm_connector_ida_init();
862 idr_init(&drm_minors_idr);
864 if (register_chrdev(DRM_MAJOR, "drm", &drm_stub_fops))
867 drm_class = drm_sysfs_create(THIS_MODULE, "drm");
868 if (IS_ERR(drm_class)) {
869 printk(KERN_ERR "DRM: Error creating drm class.\n");
870 ret = PTR_ERR(drm_class);
874 drm_debugfs_root = debugfs_create_dir("dri", NULL);
875 if (!drm_debugfs_root) {
876 DRM_ERROR("Cannot create /sys/kernel/debug/dri\n");
881 DRM_INFO("Initialized %s %d.%d.%d %s\n",
882 CORE_NAME, CORE_MAJOR, CORE_MINOR, CORE_PATCHLEVEL, CORE_DATE);
887 unregister_chrdev(DRM_MAJOR, "drm");
889 idr_destroy(&drm_minors_idr);
894 static void __exit drm_core_exit(void)
896 debugfs_remove(drm_debugfs_root);
899 unregister_chrdev(DRM_MAJOR, "drm");
901 drm_connector_ida_destroy();
902 idr_destroy(&drm_minors_idr);
905 module_init(drm_core_init);
906 module_exit(drm_core_exit);