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);
45 MODULE_AUTHOR(CORE_AUTHOR);
46 MODULE_DESCRIPTION(CORE_DESC);
47 MODULE_LICENSE("GPL and additional rights");
48 MODULE_PARM_DESC(debug, "Enable debug output");
49 MODULE_PARM_DESC(vblankoffdelay, "Delay until vblank irq auto-disable [msecs] (0: never disable, <0: disable immediately)");
50 MODULE_PARM_DESC(timestamp_precision_usec, "Max. error on timestamps [usecs]");
51 MODULE_PARM_DESC(timestamp_monotonic, "Use monotonic timestamps");
53 module_param_named(debug, drm_debug, int, 0600);
55 static DEFINE_SPINLOCK(drm_minor_lock);
56 static struct idr drm_minors_idr;
58 static struct dentry *drm_debugfs_root;
60 void drm_err(const char *format, ...)
65 va_start(args, format);
70 printk(KERN_ERR "[" DRM_NAME ":%ps] *ERROR* %pV",
71 __builtin_return_address(0), &vaf);
75 EXPORT_SYMBOL(drm_err);
77 void drm_ut_debug_printk(const char *function_name, const char *format, ...)
82 va_start(args, format);
86 printk(KERN_DEBUG "[" DRM_NAME ":%s] %pV", function_name, &vaf);
90 EXPORT_SYMBOL(drm_ut_debug_printk);
92 struct drm_master *drm_master_create(struct drm_minor *minor)
94 struct drm_master *master;
96 master = kzalloc(sizeof(*master), GFP_KERNEL);
100 kref_init(&master->refcount);
101 spin_lock_init(&master->lock.spinlock);
102 init_waitqueue_head(&master->lock.lock_queue);
103 idr_init(&master->magic_map);
104 master->minor = minor;
109 struct drm_master *drm_master_get(struct drm_master *master)
111 kref_get(&master->refcount);
114 EXPORT_SYMBOL(drm_master_get);
116 static void drm_master_destroy(struct kref *kref)
118 struct drm_master *master = container_of(kref, struct drm_master, refcount);
119 struct drm_device *dev = master->minor->dev;
120 struct drm_map_list *r_list, *list_temp;
122 mutex_lock(&dev->struct_mutex);
123 if (dev->driver->master_destroy)
124 dev->driver->master_destroy(dev, master);
126 list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head) {
127 if (r_list->master == master) {
128 drm_legacy_rmmap_locked(dev, r_list->map);
132 mutex_unlock(&dev->struct_mutex);
134 idr_destroy(&master->magic_map);
135 kfree(master->unique);
139 void drm_master_put(struct drm_master **master)
141 kref_put(&(*master)->refcount, drm_master_destroy);
144 EXPORT_SYMBOL(drm_master_put);
146 int drm_setmaster_ioctl(struct drm_device *dev, void *data,
147 struct drm_file *file_priv)
151 mutex_lock(&dev->master_mutex);
152 if (file_priv->is_master)
155 if (file_priv->minor->master) {
160 if (!file_priv->master) {
165 file_priv->minor->master = drm_master_get(file_priv->master);
166 file_priv->is_master = 1;
167 if (dev->driver->master_set) {
168 ret = dev->driver->master_set(dev, file_priv, false);
169 if (unlikely(ret != 0)) {
170 file_priv->is_master = 0;
171 drm_master_put(&file_priv->minor->master);
176 mutex_unlock(&dev->master_mutex);
180 int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
181 struct drm_file *file_priv)
185 mutex_lock(&dev->master_mutex);
186 if (!file_priv->is_master)
189 if (!file_priv->minor->master)
193 if (dev->driver->master_drop)
194 dev->driver->master_drop(dev, file_priv, false);
195 drm_master_put(&file_priv->minor->master);
196 file_priv->is_master = 0;
199 mutex_unlock(&dev->master_mutex);
205 * A DRM device can provide several char-dev interfaces on the DRM-Major. Each
206 * of them is represented by a drm_minor object. Depending on the capabilities
207 * of the device-driver, different interfaces are registered.
209 * Minors can be accessed via dev->$minor_name. This pointer is either
210 * NULL or a valid drm_minor pointer and stays valid as long as the device is
211 * valid. This means, DRM minors have the same life-time as the underlying
212 * device. However, this doesn't mean that the minor is active. Minors are
213 * registered and unregistered dynamically according to device-state.
216 static struct drm_minor **drm_minor_get_slot(struct drm_device *dev,
220 case DRM_MINOR_LEGACY:
221 return &dev->primary;
222 case DRM_MINOR_RENDER:
224 case DRM_MINOR_CONTROL:
225 return &dev->control;
231 static int drm_minor_alloc(struct drm_device *dev, unsigned int type)
233 struct drm_minor *minor;
237 minor = kzalloc(sizeof(*minor), GFP_KERNEL);
244 idr_preload(GFP_KERNEL);
245 spin_lock_irqsave(&drm_minor_lock, flags);
246 r = idr_alloc(&drm_minors_idr,
251 spin_unlock_irqrestore(&drm_minor_lock, flags);
259 minor->kdev = drm_sysfs_minor_alloc(minor);
260 if (IS_ERR(minor->kdev)) {
261 r = PTR_ERR(minor->kdev);
265 *drm_minor_get_slot(dev, type) = minor;
269 spin_lock_irqsave(&drm_minor_lock, flags);
270 idr_remove(&drm_minors_idr, minor->index);
271 spin_unlock_irqrestore(&drm_minor_lock, flags);
277 static void drm_minor_free(struct drm_device *dev, unsigned int type)
279 struct drm_minor **slot, *minor;
282 slot = drm_minor_get_slot(dev, type);
287 put_device(minor->kdev);
289 spin_lock_irqsave(&drm_minor_lock, flags);
290 idr_remove(&drm_minors_idr, minor->index);
291 spin_unlock_irqrestore(&drm_minor_lock, flags);
297 static int drm_minor_register(struct drm_device *dev, unsigned int type)
299 struct drm_minor *minor;
305 minor = *drm_minor_get_slot(dev, type);
309 ret = drm_debugfs_init(minor, minor->index, drm_debugfs_root);
311 DRM_ERROR("DRM: Failed to initialize /sys/kernel/debug/dri.\n");
315 ret = device_add(minor->kdev);
319 /* replace NULL with @minor so lookups will succeed from now on */
320 spin_lock_irqsave(&drm_minor_lock, flags);
321 idr_replace(&drm_minors_idr, minor, minor->index);
322 spin_unlock_irqrestore(&drm_minor_lock, flags);
324 DRM_DEBUG("new minor registered %d\n", minor->index);
328 drm_debugfs_cleanup(minor);
332 static void drm_minor_unregister(struct drm_device *dev, unsigned int type)
334 struct drm_minor *minor;
337 minor = *drm_minor_get_slot(dev, type);
338 if (!minor || !device_is_registered(minor->kdev))
341 /* replace @minor with NULL so lookups will fail from now on */
342 spin_lock_irqsave(&drm_minor_lock, flags);
343 idr_replace(&drm_minors_idr, NULL, minor->index);
344 spin_unlock_irqrestore(&drm_minor_lock, flags);
346 device_del(minor->kdev);
347 dev_set_drvdata(minor->kdev, NULL); /* safety belt */
348 drm_debugfs_cleanup(minor);
352 * drm_minor_acquire - Acquire a DRM minor
353 * @minor_id: Minor ID of the DRM-minor
355 * Looks up the given minor-ID and returns the respective DRM-minor object. The
356 * refence-count of the underlying device is increased so you must release this
357 * object with drm_minor_release().
359 * As long as you hold this minor, it is guaranteed that the object and the
360 * minor->dev pointer will stay valid! However, the device may get unplugged and
361 * unregistered while you hold the minor.
364 * Pointer to minor-object with increased device-refcount, or PTR_ERR on
367 struct drm_minor *drm_minor_acquire(unsigned int minor_id)
369 struct drm_minor *minor;
372 spin_lock_irqsave(&drm_minor_lock, flags);
373 minor = idr_find(&drm_minors_idr, minor_id);
375 drm_dev_ref(minor->dev);
376 spin_unlock_irqrestore(&drm_minor_lock, flags);
379 return ERR_PTR(-ENODEV);
380 } else if (drm_device_is_unplugged(minor->dev)) {
381 drm_dev_unref(minor->dev);
382 return ERR_PTR(-ENODEV);
389 * drm_minor_release - Release DRM minor
390 * @minor: Pointer to DRM minor object
392 * Release a minor that was previously acquired via drm_minor_acquire().
394 void drm_minor_release(struct drm_minor *minor)
396 drm_dev_unref(minor->dev);
400 * drm_put_dev - Unregister and release a DRM device
403 * Called at module unload time or when a PCI device is unplugged.
405 * Use of this function is discouraged. It will eventually go away completely.
406 * Please use drm_dev_unregister() and drm_dev_unref() explicitly instead.
408 * Cleans up all DRM device, calling drm_lastclose().
410 void drm_put_dev(struct drm_device *dev)
415 DRM_ERROR("cleanup called no dev\n");
419 drm_dev_unregister(dev);
422 EXPORT_SYMBOL(drm_put_dev);
424 void drm_unplug_dev(struct drm_device *dev)
426 /* for a USB device */
427 drm_minor_unregister(dev, DRM_MINOR_LEGACY);
428 drm_minor_unregister(dev, DRM_MINOR_RENDER);
429 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
431 mutex_lock(&drm_global_mutex);
433 drm_device_set_unplugged(dev);
435 if (dev->open_count == 0) {
438 mutex_unlock(&drm_global_mutex);
440 EXPORT_SYMBOL(drm_unplug_dev);
444 * We want to be able to allocate our own "struct address_space" to control
445 * memory-mappings in VRAM (or stolen RAM, ...). However, core MM does not allow
446 * stand-alone address_space objects, so we need an underlying inode. As there
447 * is no way to allocate an independent inode easily, we need a fake internal
450 * The drm_fs_inode_new() function allocates a new inode, drm_fs_inode_free()
451 * frees it again. You are allowed to use iget() and iput() to get references to
452 * the inode. But each drm_fs_inode_new() call must be paired with exactly one
453 * drm_fs_inode_free() call (which does not have to be the last iput()).
454 * We use drm_fs_inode_*() to manage our internal VFS mount-point and share it
455 * between multiple inode-users. You could, technically, call
456 * iget() + drm_fs_inode_free() directly after alloc and sometime later do an
457 * iput(), but this way you'd end up with a new vfsmount for each inode.
460 static int drm_fs_cnt;
461 static struct vfsmount *drm_fs_mnt;
463 static const struct dentry_operations drm_fs_dops = {
464 .d_dname = simple_dname,
467 static const struct super_operations drm_fs_sops = {
468 .statfs = simple_statfs,
471 static struct dentry *drm_fs_mount(struct file_system_type *fs_type, int flags,
472 const char *dev_name, void *data)
474 return mount_pseudo(fs_type,
481 static struct file_system_type drm_fs_type = {
483 .owner = THIS_MODULE,
484 .mount = drm_fs_mount,
485 .kill_sb = kill_anon_super,
488 static struct inode *drm_fs_inode_new(void)
493 r = simple_pin_fs(&drm_fs_type, &drm_fs_mnt, &drm_fs_cnt);
495 DRM_ERROR("Cannot mount pseudo fs: %d\n", r);
499 inode = alloc_anon_inode(drm_fs_mnt->mnt_sb);
501 simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
506 static void drm_fs_inode_free(struct inode *inode)
510 simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
515 * drm_dev_alloc - Allocate new DRM device
516 * @driver: DRM driver to allocate device for
517 * @parent: Parent device object
519 * Allocate and initialize a new DRM device. No device registration is done.
520 * Call drm_dev_register() to advertice the device to user space and register it
521 * with other core subsystems.
523 * The initial ref-count of the object is 1. Use drm_dev_ref() and
524 * drm_dev_unref() to take and drop further ref-counts.
526 * Note that for purely virtual devices @parent can be NULL.
529 * Pointer to new DRM device, or NULL if out of memory.
531 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
532 struct device *parent)
534 struct drm_device *dev;
537 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
541 kref_init(&dev->ref);
543 dev->driver = driver;
545 INIT_LIST_HEAD(&dev->filelist);
546 INIT_LIST_HEAD(&dev->ctxlist);
547 INIT_LIST_HEAD(&dev->vmalist);
548 INIT_LIST_HEAD(&dev->maplist);
549 INIT_LIST_HEAD(&dev->vblank_event_list);
551 spin_lock_init(&dev->buf_lock);
552 spin_lock_init(&dev->event_lock);
553 mutex_init(&dev->struct_mutex);
554 mutex_init(&dev->ctxlist_mutex);
555 mutex_init(&dev->master_mutex);
557 dev->anon_inode = drm_fs_inode_new();
558 if (IS_ERR(dev->anon_inode)) {
559 ret = PTR_ERR(dev->anon_inode);
560 DRM_ERROR("Cannot allocate anonymous inode: %d\n", ret);
564 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
565 ret = drm_minor_alloc(dev, DRM_MINOR_CONTROL);
569 WARN_ON(driver->suspend || driver->resume);
572 if (drm_core_check_feature(dev, DRIVER_RENDER)) {
573 ret = drm_minor_alloc(dev, DRM_MINOR_RENDER);
578 ret = drm_minor_alloc(dev, DRM_MINOR_LEGACY);
582 if (drm_ht_create(&dev->map_hash, 12))
585 drm_legacy_ctxbitmap_init(dev);
587 if (drm_core_check_feature(dev, DRIVER_GEM)) {
588 ret = drm_gem_init(dev);
590 DRM_ERROR("Cannot initialize graphics execution manager (GEM)\n");
598 drm_legacy_ctxbitmap_cleanup(dev);
599 drm_ht_remove(&dev->map_hash);
601 drm_minor_free(dev, DRM_MINOR_LEGACY);
602 drm_minor_free(dev, DRM_MINOR_RENDER);
603 drm_minor_free(dev, DRM_MINOR_CONTROL);
604 drm_fs_inode_free(dev->anon_inode);
606 mutex_destroy(&dev->master_mutex);
610 EXPORT_SYMBOL(drm_dev_alloc);
612 static void drm_dev_release(struct kref *ref)
614 struct drm_device *dev = container_of(ref, struct drm_device, ref);
616 if (drm_core_check_feature(dev, DRIVER_GEM))
617 drm_gem_destroy(dev);
619 drm_legacy_ctxbitmap_cleanup(dev);
620 drm_ht_remove(&dev->map_hash);
621 drm_fs_inode_free(dev->anon_inode);
623 drm_minor_free(dev, DRM_MINOR_LEGACY);
624 drm_minor_free(dev, DRM_MINOR_RENDER);
625 drm_minor_free(dev, DRM_MINOR_CONTROL);
627 mutex_destroy(&dev->master_mutex);
633 * drm_dev_ref - Take reference of a DRM device
634 * @dev: device to take reference of or NULL
636 * This increases the ref-count of @dev by one. You *must* already own a
637 * reference when calling this. Use drm_dev_unref() to drop this reference
640 * This function never fails. However, this function does not provide *any*
641 * guarantee whether the device is alive or running. It only provides a
642 * reference to the object and the memory associated with it.
644 void drm_dev_ref(struct drm_device *dev)
649 EXPORT_SYMBOL(drm_dev_ref);
652 * drm_dev_unref - Drop reference of a DRM device
653 * @dev: device to drop reference of or NULL
655 * This decreases the ref-count of @dev by one. The device is destroyed if the
656 * ref-count drops to zero.
658 void drm_dev_unref(struct drm_device *dev)
661 kref_put(&dev->ref, drm_dev_release);
663 EXPORT_SYMBOL(drm_dev_unref);
666 * drm_dev_register - Register DRM device
667 * @dev: Device to register
668 * @flags: Flags passed to the driver's .load() function
670 * Register the DRM device @dev with the system, advertise device to user-space
671 * and start normal device operation. @dev must be allocated via drm_dev_alloc()
674 * Never call this twice on any device!
677 * 0 on success, negative error code on failure.
679 int drm_dev_register(struct drm_device *dev, unsigned long flags)
683 mutex_lock(&drm_global_mutex);
685 ret = drm_minor_register(dev, DRM_MINOR_CONTROL);
689 ret = drm_minor_register(dev, DRM_MINOR_RENDER);
693 ret = drm_minor_register(dev, DRM_MINOR_LEGACY);
697 if (dev->driver->load) {
698 ret = dev->driver->load(dev, flags);
707 drm_minor_unregister(dev, DRM_MINOR_LEGACY);
708 drm_minor_unregister(dev, DRM_MINOR_RENDER);
709 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
711 mutex_unlock(&drm_global_mutex);
714 EXPORT_SYMBOL(drm_dev_register);
717 * drm_dev_unregister - Unregister DRM device
718 * @dev: Device to unregister
720 * Unregister the DRM device from the system. This does the reverse of
721 * drm_dev_register() but does not deallocate the device. The caller must call
722 * drm_dev_unref() to drop their final reference.
724 void drm_dev_unregister(struct drm_device *dev)
726 struct drm_map_list *r_list, *list_temp;
730 if (dev->driver->unload)
731 dev->driver->unload(dev);
734 drm_pci_agp_destroy(dev);
736 drm_vblank_cleanup(dev);
738 list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head)
739 drm_legacy_rmmap(dev, r_list->map);
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 EXPORT_SYMBOL(drm_dev_unregister);
748 * drm_dev_set_unique - Set the unique name of a DRM device
749 * @dev: device of which to set the unique name
750 * @fmt: format string for unique name
752 * Sets the unique name of a DRM device using the specified format string and
753 * a variable list of arguments. Drivers can use this at driver probe time if
754 * the unique name of the devices they drive is static.
756 * Return: 0 on success or a negative error code on failure.
758 int drm_dev_set_unique(struct drm_device *dev, const char *fmt, ...)
765 dev->unique = kvasprintf(GFP_KERNEL, fmt, ap);
768 return dev->unique ? 0 : -ENOMEM;
770 EXPORT_SYMBOL(drm_dev_set_unique);
774 * The DRM core module initializes all global DRM objects and makes them
775 * available to drivers. Once setup, drivers can probe their respective
777 * Currently, core management includes:
778 * - The "DRM-Global" key/value database
779 * - Global ID management for connectors
780 * - DRM major number allocation
781 * - DRM minor management
785 * Furthermore, the DRM core provides dynamic char-dev lookups. For each
786 * interface registered on a DRM device, you can request minor numbers from DRM
787 * core. DRM core takes care of major-number management and char-dev
788 * registration. A stub ->open() callback forwards any open() requests to the
792 static int drm_stub_open(struct inode *inode, struct file *filp)
794 const struct file_operations *new_fops;
795 struct drm_minor *minor;
800 mutex_lock(&drm_global_mutex);
801 minor = drm_minor_acquire(iminor(inode));
803 err = PTR_ERR(minor);
807 new_fops = fops_get(minor->dev->driver->fops);
813 replace_fops(filp, new_fops);
814 if (filp->f_op->open)
815 err = filp->f_op->open(inode, filp);
820 drm_minor_release(minor);
822 mutex_unlock(&drm_global_mutex);
826 static const struct file_operations drm_stub_fops = {
827 .owner = THIS_MODULE,
828 .open = drm_stub_open,
829 .llseek = noop_llseek,
832 static int __init drm_core_init(void)
837 drm_connector_ida_init();
838 idr_init(&drm_minors_idr);
840 if (register_chrdev(DRM_MAJOR, "drm", &drm_stub_fops))
843 ret = drm_sysfs_init();
845 printk(KERN_ERR "DRM: Error creating drm class.\n");
849 drm_debugfs_root = debugfs_create_dir("dri", NULL);
850 if (!drm_debugfs_root) {
851 DRM_ERROR("Cannot create /sys/kernel/debug/dri\n");
856 DRM_INFO("Initialized %s %d.%d.%d %s\n",
857 CORE_NAME, CORE_MAJOR, CORE_MINOR, CORE_PATCHLEVEL, CORE_DATE);
862 unregister_chrdev(DRM_MAJOR, "drm");
864 idr_destroy(&drm_minors_idr);
869 static void __exit drm_core_exit(void)
871 debugfs_remove(drm_debugfs_root);
874 unregister_chrdev(DRM_MAJOR, "drm");
876 drm_connector_ida_destroy();
877 idr_destroy(&drm_minors_idr);
880 module_init(drm_core_init);
881 module_exit(drm_core_exit);