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_crtc_internal.h"
38 #include "drm_legacy.h"
39 #include "drm_internal.h"
40 #include "drm_crtc_internal.h"
43 * drm_debug: Enable debug output.
44 * Bitmask of DRM_UT_x. See include/drm/drmP.h for details.
46 unsigned int drm_debug = 0;
47 EXPORT_SYMBOL(drm_debug);
49 MODULE_AUTHOR(CORE_AUTHOR);
50 MODULE_DESCRIPTION(CORE_DESC);
51 MODULE_LICENSE("GPL and additional rights");
52 MODULE_PARM_DESC(debug, "Enable debug output, where each bit enables a debug category.\n"
53 "\t\tBit 0 (0x01) will enable CORE messages (drm core code)\n"
54 "\t\tBit 1 (0x02) will enable DRIVER messages (drm controller code)\n"
55 "\t\tBit 2 (0x04) will enable KMS messages (modesetting code)\n"
56 "\t\tBit 3 (0x08) will enable PRIME messages (prime code)\n"
57 "\t\tBit 4 (0x10) will enable ATOMIC messages (atomic code)\n"
58 "\t\tBit 5 (0x20) will enable VBL messages (vblank code)");
59 module_param_named(debug, drm_debug, int, 0600);
61 static DEFINE_SPINLOCK(drm_minor_lock);
62 static struct idr drm_minors_idr;
64 static struct dentry *drm_debugfs_root;
66 void drm_err(const char *format, ...)
71 va_start(args, format);
76 printk(KERN_ERR "[" DRM_NAME ":%ps] *ERROR* %pV",
77 __builtin_return_address(0), &vaf);
81 EXPORT_SYMBOL(drm_err);
83 void drm_ut_debug_printk(const char *function_name, const char *format, ...)
88 va_start(args, format);
92 printk(KERN_DEBUG "[" DRM_NAME ":%s] %pV", function_name, &vaf);
96 EXPORT_SYMBOL(drm_ut_debug_printk);
100 * A DRM device can provide several char-dev interfaces on the DRM-Major. Each
101 * of them is represented by a drm_minor object. Depending on the capabilities
102 * of the device-driver, different interfaces are registered.
104 * Minors can be accessed via dev->$minor_name. This pointer is either
105 * NULL or a valid drm_minor pointer and stays valid as long as the device is
106 * valid. This means, DRM minors have the same life-time as the underlying
107 * device. However, this doesn't mean that the minor is active. Minors are
108 * registered and unregistered dynamically according to device-state.
111 static struct drm_minor **drm_minor_get_slot(struct drm_device *dev,
115 case DRM_MINOR_LEGACY:
116 return &dev->primary;
117 case DRM_MINOR_RENDER:
119 case DRM_MINOR_CONTROL:
120 return &dev->control;
126 static int drm_minor_alloc(struct drm_device *dev, unsigned int type)
128 struct drm_minor *minor;
132 minor = kzalloc(sizeof(*minor), GFP_KERNEL);
139 idr_preload(GFP_KERNEL);
140 spin_lock_irqsave(&drm_minor_lock, flags);
141 r = idr_alloc(&drm_minors_idr,
146 spin_unlock_irqrestore(&drm_minor_lock, flags);
154 minor->kdev = drm_sysfs_minor_alloc(minor);
155 if (IS_ERR(minor->kdev)) {
156 r = PTR_ERR(minor->kdev);
160 *drm_minor_get_slot(dev, type) = minor;
164 spin_lock_irqsave(&drm_minor_lock, flags);
165 idr_remove(&drm_minors_idr, minor->index);
166 spin_unlock_irqrestore(&drm_minor_lock, flags);
172 static void drm_minor_free(struct drm_device *dev, unsigned int type)
174 struct drm_minor **slot, *minor;
177 slot = drm_minor_get_slot(dev, type);
182 put_device(minor->kdev);
184 spin_lock_irqsave(&drm_minor_lock, flags);
185 idr_remove(&drm_minors_idr, minor->index);
186 spin_unlock_irqrestore(&drm_minor_lock, flags);
192 static int drm_minor_register(struct drm_device *dev, unsigned int type)
194 struct drm_minor *minor;
200 minor = *drm_minor_get_slot(dev, type);
204 ret = drm_debugfs_init(minor, minor->index, drm_debugfs_root);
206 DRM_ERROR("DRM: Failed to initialize /sys/kernel/debug/dri.\n");
210 ret = device_add(minor->kdev);
214 /* replace NULL with @minor so lookups will succeed from now on */
215 spin_lock_irqsave(&drm_minor_lock, flags);
216 idr_replace(&drm_minors_idr, minor, minor->index);
217 spin_unlock_irqrestore(&drm_minor_lock, flags);
219 DRM_DEBUG("new minor registered %d\n", minor->index);
223 drm_debugfs_cleanup(minor);
227 static void drm_minor_unregister(struct drm_device *dev, unsigned int type)
229 struct drm_minor *minor;
232 minor = *drm_minor_get_slot(dev, type);
233 if (!minor || !device_is_registered(minor->kdev))
236 /* replace @minor with NULL so lookups will fail from now on */
237 spin_lock_irqsave(&drm_minor_lock, flags);
238 idr_replace(&drm_minors_idr, NULL, minor->index);
239 spin_unlock_irqrestore(&drm_minor_lock, flags);
241 device_del(minor->kdev);
242 dev_set_drvdata(minor->kdev, NULL); /* safety belt */
243 drm_debugfs_cleanup(minor);
247 * drm_minor_acquire - Acquire a DRM minor
248 * @minor_id: Minor ID of the DRM-minor
250 * Looks up the given minor-ID and returns the respective DRM-minor object. The
251 * refence-count of the underlying device is increased so you must release this
252 * object with drm_minor_release().
254 * As long as you hold this minor, it is guaranteed that the object and the
255 * minor->dev pointer will stay valid! However, the device may get unplugged and
256 * unregistered while you hold the minor.
259 * Pointer to minor-object with increased device-refcount, or PTR_ERR on
262 struct drm_minor *drm_minor_acquire(unsigned int minor_id)
264 struct drm_minor *minor;
267 spin_lock_irqsave(&drm_minor_lock, flags);
268 minor = idr_find(&drm_minors_idr, minor_id);
270 drm_dev_ref(minor->dev);
271 spin_unlock_irqrestore(&drm_minor_lock, flags);
274 return ERR_PTR(-ENODEV);
275 } else if (drm_device_is_unplugged(minor->dev)) {
276 drm_dev_unref(minor->dev);
277 return ERR_PTR(-ENODEV);
284 * drm_minor_release - Release DRM minor
285 * @minor: Pointer to DRM minor object
287 * Release a minor that was previously acquired via drm_minor_acquire().
289 void drm_minor_release(struct drm_minor *minor)
291 drm_dev_unref(minor->dev);
295 * DOC: driver instance overview
297 * A device instance for a drm driver is represented by struct &drm_device. This
298 * is allocated with drm_dev_alloc(), usually from bus-specific ->probe()
299 * callbacks implemented by the driver. The driver then needs to initialize all
300 * the various subsystems for the drm device like memory management, vblank
301 * handling, modesetting support and intial output configuration plus obviously
302 * initialize all the corresponding hardware bits. An important part of this is
303 * also calling drm_dev_set_unique() to set the userspace-visible unique name of
304 * this device instance. Finally when everything is up and running and ready for
305 * userspace the device instance can be published using drm_dev_register().
307 * There is also deprecated support for initalizing device instances using
308 * bus-specific helpers and the ->load() callback. But due to
309 * backwards-compatibility needs the device instance have to be published too
310 * early, which requires unpretty global locking to make safe and is therefore
311 * only support for existing drivers not yet converted to the new scheme.
313 * When cleaning up a device instance everything needs to be done in reverse:
314 * First unpublish the device instance with drm_dev_unregister(). Then clean up
315 * any other resources allocated at device initialization and drop the driver's
316 * reference to &drm_device using drm_dev_unref().
318 * Note that the lifetime rules for &drm_device instance has still a lot of
319 * historical baggage. Hence use the reference counting provided by
320 * drm_dev_ref() and drm_dev_unref() only carefully.
322 * Also note that embedding of &drm_device is currently not (yet) supported (but
323 * it would be easy to add). Drivers can store driver-private data in the
324 * dev_priv field of &drm_device.
328 * drm_put_dev - Unregister and release a DRM device
331 * Called at module unload time or when a PCI device is unplugged.
333 * Cleans up all DRM device, calling drm_lastclose().
335 * Note: Use of this function is deprecated. It will eventually go away
336 * completely. Please use drm_dev_unregister() and drm_dev_unref() explicitly
337 * instead to make sure that the device isn't userspace accessible any more
338 * while teardown is in progress, ensuring that userspace can't access an
339 * inconsistent state.
341 void drm_put_dev(struct drm_device *dev)
346 DRM_ERROR("cleanup called no dev\n");
350 drm_dev_unregister(dev);
353 EXPORT_SYMBOL(drm_put_dev);
355 void drm_unplug_dev(struct drm_device *dev)
357 /* for a USB device */
358 drm_minor_unregister(dev, DRM_MINOR_LEGACY);
359 drm_minor_unregister(dev, DRM_MINOR_RENDER);
360 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
362 mutex_lock(&drm_global_mutex);
364 drm_device_set_unplugged(dev);
366 if (dev->open_count == 0) {
369 mutex_unlock(&drm_global_mutex);
371 EXPORT_SYMBOL(drm_unplug_dev);
375 * We want to be able to allocate our own "struct address_space" to control
376 * memory-mappings in VRAM (or stolen RAM, ...). However, core MM does not allow
377 * stand-alone address_space objects, so we need an underlying inode. As there
378 * is no way to allocate an independent inode easily, we need a fake internal
381 * The drm_fs_inode_new() function allocates a new inode, drm_fs_inode_free()
382 * frees it again. You are allowed to use iget() and iput() to get references to
383 * the inode. But each drm_fs_inode_new() call must be paired with exactly one
384 * drm_fs_inode_free() call (which does not have to be the last iput()).
385 * We use drm_fs_inode_*() to manage our internal VFS mount-point and share it
386 * between multiple inode-users. You could, technically, call
387 * iget() + drm_fs_inode_free() directly after alloc and sometime later do an
388 * iput(), but this way you'd end up with a new vfsmount for each inode.
391 static int drm_fs_cnt;
392 static struct vfsmount *drm_fs_mnt;
394 static const struct dentry_operations drm_fs_dops = {
395 .d_dname = simple_dname,
398 static const struct super_operations drm_fs_sops = {
399 .statfs = simple_statfs,
402 static struct dentry *drm_fs_mount(struct file_system_type *fs_type, int flags,
403 const char *dev_name, void *data)
405 return mount_pseudo(fs_type,
412 static struct file_system_type drm_fs_type = {
414 .owner = THIS_MODULE,
415 .mount = drm_fs_mount,
416 .kill_sb = kill_anon_super,
419 static struct inode *drm_fs_inode_new(void)
424 r = simple_pin_fs(&drm_fs_type, &drm_fs_mnt, &drm_fs_cnt);
426 DRM_ERROR("Cannot mount pseudo fs: %d\n", r);
430 inode = alloc_anon_inode(drm_fs_mnt->mnt_sb);
432 simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
437 static void drm_fs_inode_free(struct inode *inode)
441 simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
446 * drm_dev_init - Initialise new DRM device
448 * @driver: DRM driver
449 * @parent: Parent device object
451 * Initialize a new DRM device. No device registration is done.
452 * Call drm_dev_register() to advertice the device to user space and register it
453 * with other core subsystems. This should be done last in the device
454 * initialization sequence to make sure userspace can't access an inconsistent
457 * The initial ref-count of the object is 1. Use drm_dev_ref() and
458 * drm_dev_unref() to take and drop further ref-counts.
460 * Note that for purely virtual devices @parent can be NULL.
462 * Drivers that do not want to allocate their own device struct
463 * embedding struct &drm_device can call drm_dev_alloc() instead.
466 * 0 on success, or error code on failure.
468 int drm_dev_init(struct drm_device *dev,
469 struct drm_driver *driver,
470 struct device *parent)
474 kref_init(&dev->ref);
476 dev->driver = driver;
478 INIT_LIST_HEAD(&dev->filelist);
479 INIT_LIST_HEAD(&dev->ctxlist);
480 INIT_LIST_HEAD(&dev->vmalist);
481 INIT_LIST_HEAD(&dev->maplist);
482 INIT_LIST_HEAD(&dev->vblank_event_list);
484 spin_lock_init(&dev->buf_lock);
485 spin_lock_init(&dev->event_lock);
486 mutex_init(&dev->struct_mutex);
487 mutex_init(&dev->filelist_mutex);
488 mutex_init(&dev->ctxlist_mutex);
489 mutex_init(&dev->master_mutex);
491 dev->anon_inode = drm_fs_inode_new();
492 if (IS_ERR(dev->anon_inode)) {
493 ret = PTR_ERR(dev->anon_inode);
494 DRM_ERROR("Cannot allocate anonymous inode: %d\n", ret);
498 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
499 ret = drm_minor_alloc(dev, DRM_MINOR_CONTROL);
504 if (drm_core_check_feature(dev, DRIVER_RENDER)) {
505 ret = drm_minor_alloc(dev, DRM_MINOR_RENDER);
510 ret = drm_minor_alloc(dev, DRM_MINOR_LEGACY);
514 ret = drm_ht_create(&dev->map_hash, 12);
518 drm_legacy_ctxbitmap_init(dev);
520 if (drm_core_check_feature(dev, DRIVER_GEM)) {
521 ret = drm_gem_init(dev);
523 DRM_ERROR("Cannot initialize graphics execution manager (GEM)\n");
529 ret = drm_dev_set_unique(dev, dev_name(parent));
537 if (drm_core_check_feature(dev, DRIVER_GEM))
538 drm_gem_destroy(dev);
540 drm_legacy_ctxbitmap_cleanup(dev);
541 drm_ht_remove(&dev->map_hash);
543 drm_minor_free(dev, DRM_MINOR_LEGACY);
544 drm_minor_free(dev, DRM_MINOR_RENDER);
545 drm_minor_free(dev, DRM_MINOR_CONTROL);
546 drm_fs_inode_free(dev->anon_inode);
548 mutex_destroy(&dev->master_mutex);
551 EXPORT_SYMBOL(drm_dev_init);
554 * drm_dev_alloc - Allocate new DRM device
555 * @driver: DRM driver to allocate device for
556 * @parent: Parent device object
558 * Allocate and initialize a new DRM device. No device registration is done.
559 * Call drm_dev_register() to advertice the device to user space and register it
560 * with other core subsystems. This should be done last in the device
561 * initialization sequence to make sure userspace can't access an inconsistent
564 * The initial ref-count of the object is 1. Use drm_dev_ref() and
565 * drm_dev_unref() to take and drop further ref-counts.
567 * Note that for purely virtual devices @parent can be NULL.
569 * Drivers that wish to subclass or embed struct &drm_device into their
570 * own struct should look at using drm_dev_init() instead.
573 * Pointer to new DRM device, or NULL if out of memory.
575 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
576 struct device *parent)
578 struct drm_device *dev;
581 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
585 ret = drm_dev_init(dev, driver, parent);
593 EXPORT_SYMBOL(drm_dev_alloc);
595 static void drm_dev_release(struct kref *ref)
597 struct drm_device *dev = container_of(ref, struct drm_device, ref);
599 if (drm_core_check_feature(dev, DRIVER_GEM))
600 drm_gem_destroy(dev);
602 drm_legacy_ctxbitmap_cleanup(dev);
603 drm_ht_remove(&dev->map_hash);
604 drm_fs_inode_free(dev->anon_inode);
606 drm_minor_free(dev, DRM_MINOR_LEGACY);
607 drm_minor_free(dev, DRM_MINOR_RENDER);
608 drm_minor_free(dev, DRM_MINOR_CONTROL);
610 mutex_destroy(&dev->master_mutex);
616 * drm_dev_ref - Take reference of a DRM device
617 * @dev: device to take reference of or NULL
619 * This increases the ref-count of @dev by one. You *must* already own a
620 * reference when calling this. Use drm_dev_unref() to drop this reference
623 * This function never fails. However, this function does not provide *any*
624 * guarantee whether the device is alive or running. It only provides a
625 * reference to the object and the memory associated with it.
627 void drm_dev_ref(struct drm_device *dev)
632 EXPORT_SYMBOL(drm_dev_ref);
635 * drm_dev_unref - Drop reference of a DRM device
636 * @dev: device to drop reference of or NULL
638 * This decreases the ref-count of @dev by one. The device is destroyed if the
639 * ref-count drops to zero.
641 void drm_dev_unref(struct drm_device *dev)
644 kref_put(&dev->ref, drm_dev_release);
646 EXPORT_SYMBOL(drm_dev_unref);
649 * drm_dev_register - Register DRM device
650 * @dev: Device to register
651 * @flags: Flags passed to the driver's .load() function
653 * Register the DRM device @dev with the system, advertise device to user-space
654 * and start normal device operation. @dev must be allocated via drm_dev_alloc()
657 * Never call this twice on any device!
659 * NOTE: To ensure backward compatibility with existing drivers method this
660 * function calls the ->load() method after registering the device nodes,
661 * creating race conditions. Usage of the ->load() methods is therefore
662 * deprecated, drivers must perform all initialization before calling
663 * drm_dev_register().
666 * 0 on success, negative error code on failure.
668 int drm_dev_register(struct drm_device *dev, unsigned long flags)
672 mutex_lock(&drm_global_mutex);
674 ret = drm_minor_register(dev, DRM_MINOR_CONTROL);
678 ret = drm_minor_register(dev, DRM_MINOR_RENDER);
682 ret = drm_minor_register(dev, DRM_MINOR_LEGACY);
686 if (dev->driver->load) {
687 ret = dev->driver->load(dev, flags);
692 if (drm_core_check_feature(dev, DRIVER_MODESET))
693 drm_modeset_register_all(dev);
699 drm_minor_unregister(dev, DRM_MINOR_LEGACY);
700 drm_minor_unregister(dev, DRM_MINOR_RENDER);
701 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
703 mutex_unlock(&drm_global_mutex);
706 EXPORT_SYMBOL(drm_dev_register);
709 * drm_dev_unregister - Unregister DRM device
710 * @dev: Device to unregister
712 * Unregister the DRM device from the system. This does the reverse of
713 * drm_dev_register() but does not deallocate the device. The caller must call
714 * drm_dev_unref() to drop their final reference.
716 * This should be called first in the device teardown code to make sure
717 * userspace can't access the device instance any more.
719 void drm_dev_unregister(struct drm_device *dev)
721 struct drm_map_list *r_list, *list_temp;
725 if (drm_core_check_feature(dev, DRIVER_MODESET))
726 drm_modeset_unregister_all(dev);
728 if (dev->driver->unload)
729 dev->driver->unload(dev);
732 drm_pci_agp_destroy(dev);
734 drm_vblank_cleanup(dev);
736 list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head)
737 drm_legacy_rmmap(dev, r_list->map);
739 drm_minor_unregister(dev, DRM_MINOR_LEGACY);
740 drm_minor_unregister(dev, DRM_MINOR_RENDER);
741 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
743 EXPORT_SYMBOL(drm_dev_unregister);
746 * drm_dev_set_unique - Set the unique name of a DRM device
747 * @dev: device of which to set the unique name
750 * Sets the unique name of a DRM device using the specified string. Drivers
751 * can use this at driver probe time if the unique name of the devices they
754 * Return: 0 on success or a negative error code on failure.
756 int drm_dev_set_unique(struct drm_device *dev, const char *name)
759 dev->unique = kstrdup(name, GFP_KERNEL);
761 return dev->unique ? 0 : -ENOMEM;
763 EXPORT_SYMBOL(drm_dev_set_unique);
767 * The DRM core module initializes all global DRM objects and makes them
768 * available to drivers. Once setup, drivers can probe their respective
770 * Currently, core management includes:
771 * - The "DRM-Global" key/value database
772 * - Global ID management for connectors
773 * - DRM major number allocation
774 * - DRM minor management
778 * Furthermore, the DRM core provides dynamic char-dev lookups. For each
779 * interface registered on a DRM device, you can request minor numbers from DRM
780 * core. DRM core takes care of major-number management and char-dev
781 * registration. A stub ->open() callback forwards any open() requests to the
785 static int drm_stub_open(struct inode *inode, struct file *filp)
787 const struct file_operations *new_fops;
788 struct drm_minor *minor;
793 mutex_lock(&drm_global_mutex);
794 minor = drm_minor_acquire(iminor(inode));
796 err = PTR_ERR(minor);
800 new_fops = fops_get(minor->dev->driver->fops);
806 replace_fops(filp, new_fops);
807 if (filp->f_op->open)
808 err = filp->f_op->open(inode, filp);
813 drm_minor_release(minor);
815 mutex_unlock(&drm_global_mutex);
819 static const struct file_operations drm_stub_fops = {
820 .owner = THIS_MODULE,
821 .open = drm_stub_open,
822 .llseek = noop_llseek,
825 static int __init drm_core_init(void)
830 drm_connector_ida_init();
831 idr_init(&drm_minors_idr);
833 if (register_chrdev(DRM_MAJOR, "drm", &drm_stub_fops))
836 ret = drm_sysfs_init();
838 printk(KERN_ERR "DRM: Error creating drm class.\n");
842 drm_debugfs_root = debugfs_create_dir("dri", NULL);
843 if (!drm_debugfs_root) {
844 DRM_ERROR("Cannot create /sys/kernel/debug/dri\n");
849 DRM_INFO("Initialized %s %d.%d.%d %s\n",
850 CORE_NAME, CORE_MAJOR, CORE_MINOR, CORE_PATCHLEVEL, CORE_DATE);
855 unregister_chrdev(DRM_MAJOR, "drm");
857 idr_destroy(&drm_minors_idr);
862 static void __exit drm_core_exit(void)
864 debugfs_remove(drm_debugfs_root);
867 unregister_chrdev(DRM_MAJOR, "drm");
869 drm_connector_ida_destroy();
870 idr_destroy(&drm_minors_idr);
873 module_init(drm_core_init);
874 module_exit(drm_core_exit);