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"
41 * drm_debug: Enable debug output.
42 * Bitmask of DRM_UT_x. See include/drm/drmP.h for details.
44 unsigned int drm_debug = 0;
45 EXPORT_SYMBOL(drm_debug);
47 MODULE_AUTHOR(CORE_AUTHOR);
48 MODULE_DESCRIPTION(CORE_DESC);
49 MODULE_LICENSE("GPL and additional rights");
50 MODULE_PARM_DESC(debug, "Enable debug output, where each bit enables a debug category.\n"
51 "\t\tBit 0 (0x01) will enable CORE messages (drm core code)\n"
52 "\t\tBit 1 (0x02) will enable DRIVER messages (drm controller code)\n"
53 "\t\tBit 2 (0x04) will enable KMS messages (modesetting code)\n"
54 "\t\tBit 3 (0x08) will enable PRIME messages (prime code)\n"
55 "\t\tBit 4 (0x10) will enable ATOMIC messages (atomic code)\n"
56 "\t\tBit 5 (0x20) will enable VBL messages (vblank code)");
57 module_param_named(debug, drm_debug, int, 0600);
59 static DEFINE_SPINLOCK(drm_minor_lock);
60 static struct idr drm_minors_idr;
62 static struct dentry *drm_debugfs_root;
64 void drm_err(const char *format, ...)
69 va_start(args, format);
74 printk(KERN_ERR "[" DRM_NAME ":%ps] *ERROR* %pV",
75 __builtin_return_address(0), &vaf);
79 EXPORT_SYMBOL(drm_err);
81 void drm_ut_debug_printk(const char *function_name, const char *format, ...)
86 va_start(args, format);
90 printk(KERN_DEBUG "[" DRM_NAME ":%s] %pV", function_name, &vaf);
94 EXPORT_SYMBOL(drm_ut_debug_printk);
98 * A DRM device can provide several char-dev interfaces on the DRM-Major. Each
99 * of them is represented by a drm_minor object. Depending on the capabilities
100 * of the device-driver, different interfaces are registered.
102 * Minors can be accessed via dev->$minor_name. This pointer is either
103 * NULL or a valid drm_minor pointer and stays valid as long as the device is
104 * valid. This means, DRM minors have the same life-time as the underlying
105 * device. However, this doesn't mean that the minor is active. Minors are
106 * registered and unregistered dynamically according to device-state.
109 static struct drm_minor **drm_minor_get_slot(struct drm_device *dev,
113 case DRM_MINOR_LEGACY:
114 return &dev->primary;
115 case DRM_MINOR_RENDER:
117 case DRM_MINOR_CONTROL:
118 return &dev->control;
124 static int drm_minor_alloc(struct drm_device *dev, unsigned int type)
126 struct drm_minor *minor;
130 minor = kzalloc(sizeof(*minor), GFP_KERNEL);
137 idr_preload(GFP_KERNEL);
138 spin_lock_irqsave(&drm_minor_lock, flags);
139 r = idr_alloc(&drm_minors_idr,
144 spin_unlock_irqrestore(&drm_minor_lock, flags);
152 minor->kdev = drm_sysfs_minor_alloc(minor);
153 if (IS_ERR(minor->kdev)) {
154 r = PTR_ERR(minor->kdev);
158 *drm_minor_get_slot(dev, type) = minor;
162 spin_lock_irqsave(&drm_minor_lock, flags);
163 idr_remove(&drm_minors_idr, minor->index);
164 spin_unlock_irqrestore(&drm_minor_lock, flags);
170 static void drm_minor_free(struct drm_device *dev, unsigned int type)
172 struct drm_minor **slot, *minor;
175 slot = drm_minor_get_slot(dev, type);
180 put_device(minor->kdev);
182 spin_lock_irqsave(&drm_minor_lock, flags);
183 idr_remove(&drm_minors_idr, minor->index);
184 spin_unlock_irqrestore(&drm_minor_lock, flags);
190 static int drm_minor_register(struct drm_device *dev, unsigned int type)
192 struct drm_minor *minor;
198 minor = *drm_minor_get_slot(dev, type);
202 ret = drm_debugfs_init(minor, minor->index, drm_debugfs_root);
204 DRM_ERROR("DRM: Failed to initialize /sys/kernel/debug/dri.\n");
208 ret = device_add(minor->kdev);
212 /* replace NULL with @minor so lookups will succeed from now on */
213 spin_lock_irqsave(&drm_minor_lock, flags);
214 idr_replace(&drm_minors_idr, minor, minor->index);
215 spin_unlock_irqrestore(&drm_minor_lock, flags);
217 DRM_DEBUG("new minor registered %d\n", minor->index);
221 drm_debugfs_cleanup(minor);
225 static void drm_minor_unregister(struct drm_device *dev, unsigned int type)
227 struct drm_minor *minor;
230 minor = *drm_minor_get_slot(dev, type);
231 if (!minor || !device_is_registered(minor->kdev))
234 /* replace @minor with NULL so lookups will fail from now on */
235 spin_lock_irqsave(&drm_minor_lock, flags);
236 idr_replace(&drm_minors_idr, NULL, minor->index);
237 spin_unlock_irqrestore(&drm_minor_lock, flags);
239 device_del(minor->kdev);
240 dev_set_drvdata(minor->kdev, NULL); /* safety belt */
241 drm_debugfs_cleanup(minor);
245 * drm_minor_acquire - Acquire a DRM minor
246 * @minor_id: Minor ID of the DRM-minor
248 * Looks up the given minor-ID and returns the respective DRM-minor object. The
249 * refence-count of the underlying device is increased so you must release this
250 * object with drm_minor_release().
252 * As long as you hold this minor, it is guaranteed that the object and the
253 * minor->dev pointer will stay valid! However, the device may get unplugged and
254 * unregistered while you hold the minor.
257 * Pointer to minor-object with increased device-refcount, or PTR_ERR on
260 struct drm_minor *drm_minor_acquire(unsigned int minor_id)
262 struct drm_minor *minor;
265 spin_lock_irqsave(&drm_minor_lock, flags);
266 minor = idr_find(&drm_minors_idr, minor_id);
268 drm_dev_ref(minor->dev);
269 spin_unlock_irqrestore(&drm_minor_lock, flags);
272 return ERR_PTR(-ENODEV);
273 } else if (drm_device_is_unplugged(minor->dev)) {
274 drm_dev_unref(minor->dev);
275 return ERR_PTR(-ENODEV);
282 * drm_minor_release - Release DRM minor
283 * @minor: Pointer to DRM minor object
285 * Release a minor that was previously acquired via drm_minor_acquire().
287 void drm_minor_release(struct drm_minor *minor)
289 drm_dev_unref(minor->dev);
293 * DOC: driver instance overview
295 * A device instance for a drm driver is represented by struct &drm_device. This
296 * is allocated with drm_dev_alloc(), usually from bus-specific ->probe()
297 * callbacks implemented by the driver. The driver then needs to initialize all
298 * the various subsystems for the drm device like memory management, vblank
299 * handling, modesetting support and intial output configuration plus obviously
300 * initialize all the corresponding hardware bits. An important part of this is
301 * also calling drm_dev_set_unique() to set the userspace-visible unique name of
302 * this device instance. Finally when everything is up and running and ready for
303 * userspace the device instance can be published using drm_dev_register().
305 * There is also deprecated support for initalizing device instances using
306 * bus-specific helpers and the ->load() callback. But due to
307 * backwards-compatibility needs the device instance have to be published too
308 * early, which requires unpretty global locking to make safe and is therefore
309 * only support for existing drivers not yet converted to the new scheme.
311 * When cleaning up a device instance everything needs to be done in reverse:
312 * First unpublish the device instance with drm_dev_unregister(). Then clean up
313 * any other resources allocated at device initialization and drop the driver's
314 * reference to &drm_device using drm_dev_unref().
316 * Note that the lifetime rules for &drm_device instance has still a lot of
317 * historical baggage. Hence use the reference counting provided by
318 * drm_dev_ref() and drm_dev_unref() only carefully.
320 * Also note that embedding of &drm_device is currently not (yet) supported (but
321 * it would be easy to add). Drivers can store driver-private data in the
322 * dev_priv field of &drm_device.
326 * drm_put_dev - Unregister and release a DRM device
329 * Called at module unload time or when a PCI device is unplugged.
331 * Cleans up all DRM device, calling drm_lastclose().
333 * Note: Use of this function is deprecated. It will eventually go away
334 * completely. Please use drm_dev_unregister() and drm_dev_unref() explicitly
335 * instead to make sure that the device isn't userspace accessible any more
336 * while teardown is in progress, ensuring that userspace can't access an
337 * inconsistent state.
339 void drm_put_dev(struct drm_device *dev)
344 DRM_ERROR("cleanup called no dev\n");
348 drm_dev_unregister(dev);
351 EXPORT_SYMBOL(drm_put_dev);
353 void drm_unplug_dev(struct drm_device *dev)
355 /* for a USB device */
356 drm_minor_unregister(dev, DRM_MINOR_LEGACY);
357 drm_minor_unregister(dev, DRM_MINOR_RENDER);
358 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
360 mutex_lock(&drm_global_mutex);
362 drm_device_set_unplugged(dev);
364 if (dev->open_count == 0) {
367 mutex_unlock(&drm_global_mutex);
369 EXPORT_SYMBOL(drm_unplug_dev);
373 * We want to be able to allocate our own "struct address_space" to control
374 * memory-mappings in VRAM (or stolen RAM, ...). However, core MM does not allow
375 * stand-alone address_space objects, so we need an underlying inode. As there
376 * is no way to allocate an independent inode easily, we need a fake internal
379 * The drm_fs_inode_new() function allocates a new inode, drm_fs_inode_free()
380 * frees it again. You are allowed to use iget() and iput() to get references to
381 * the inode. But each drm_fs_inode_new() call must be paired with exactly one
382 * drm_fs_inode_free() call (which does not have to be the last iput()).
383 * We use drm_fs_inode_*() to manage our internal VFS mount-point and share it
384 * between multiple inode-users. You could, technically, call
385 * iget() + drm_fs_inode_free() directly after alloc and sometime later do an
386 * iput(), but this way you'd end up with a new vfsmount for each inode.
389 static int drm_fs_cnt;
390 static struct vfsmount *drm_fs_mnt;
392 static const struct dentry_operations drm_fs_dops = {
393 .d_dname = simple_dname,
396 static const struct super_operations drm_fs_sops = {
397 .statfs = simple_statfs,
400 static struct dentry *drm_fs_mount(struct file_system_type *fs_type, int flags,
401 const char *dev_name, void *data)
403 return mount_pseudo(fs_type,
410 static struct file_system_type drm_fs_type = {
412 .owner = THIS_MODULE,
413 .mount = drm_fs_mount,
414 .kill_sb = kill_anon_super,
417 static struct inode *drm_fs_inode_new(void)
422 r = simple_pin_fs(&drm_fs_type, &drm_fs_mnt, &drm_fs_cnt);
424 DRM_ERROR("Cannot mount pseudo fs: %d\n", r);
428 inode = alloc_anon_inode(drm_fs_mnt->mnt_sb);
430 simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
435 static void drm_fs_inode_free(struct inode *inode)
439 simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
444 * drm_dev_alloc - Allocate new DRM device
445 * @driver: DRM driver to allocate device for
446 * @parent: Parent device object
448 * Allocate and initialize a new DRM device. No device registration is done.
449 * Call drm_dev_register() to advertice the device to user space and register it
450 * with other core subsystems. This should be done last in the device
451 * initialization sequence to make sure userspace can't access an inconsistent
454 * The initial ref-count of the object is 1. Use drm_dev_ref() and
455 * drm_dev_unref() to take and drop further ref-counts.
457 * Note that for purely virtual devices @parent can be NULL.
460 * Pointer to new DRM device, or NULL if out of memory.
462 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
463 struct device *parent)
465 struct drm_device *dev;
468 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
472 kref_init(&dev->ref);
474 dev->driver = driver;
476 INIT_LIST_HEAD(&dev->filelist);
477 INIT_LIST_HEAD(&dev->ctxlist);
478 INIT_LIST_HEAD(&dev->vmalist);
479 INIT_LIST_HEAD(&dev->maplist);
480 INIT_LIST_HEAD(&dev->vblank_event_list);
482 spin_lock_init(&dev->buf_lock);
483 spin_lock_init(&dev->event_lock);
484 mutex_init(&dev->struct_mutex);
485 mutex_init(&dev->filelist_mutex);
486 mutex_init(&dev->ctxlist_mutex);
487 mutex_init(&dev->master_mutex);
489 dev->anon_inode = drm_fs_inode_new();
490 if (IS_ERR(dev->anon_inode)) {
491 ret = PTR_ERR(dev->anon_inode);
492 DRM_ERROR("Cannot allocate anonymous inode: %d\n", ret);
496 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
497 ret = drm_minor_alloc(dev, DRM_MINOR_CONTROL);
502 if (drm_core_check_feature(dev, DRIVER_RENDER)) {
503 ret = drm_minor_alloc(dev, DRM_MINOR_RENDER);
508 ret = drm_minor_alloc(dev, DRM_MINOR_LEGACY);
512 if (drm_ht_create(&dev->map_hash, 12))
515 drm_legacy_ctxbitmap_init(dev);
517 if (drm_core_check_feature(dev, DRIVER_GEM)) {
518 ret = drm_gem_init(dev);
520 DRM_ERROR("Cannot initialize graphics execution manager (GEM)\n");
526 ret = drm_dev_set_unique(dev, dev_name(parent));
534 if (drm_core_check_feature(dev, DRIVER_GEM))
535 drm_gem_destroy(dev);
537 drm_legacy_ctxbitmap_cleanup(dev);
538 drm_ht_remove(&dev->map_hash);
540 drm_minor_free(dev, DRM_MINOR_LEGACY);
541 drm_minor_free(dev, DRM_MINOR_RENDER);
542 drm_minor_free(dev, DRM_MINOR_CONTROL);
543 drm_fs_inode_free(dev->anon_inode);
545 mutex_destroy(&dev->master_mutex);
549 EXPORT_SYMBOL(drm_dev_alloc);
551 static void drm_dev_release(struct kref *ref)
553 struct drm_device *dev = container_of(ref, struct drm_device, ref);
555 if (drm_core_check_feature(dev, DRIVER_GEM))
556 drm_gem_destroy(dev);
558 drm_legacy_ctxbitmap_cleanup(dev);
559 drm_ht_remove(&dev->map_hash);
560 drm_fs_inode_free(dev->anon_inode);
562 drm_minor_free(dev, DRM_MINOR_LEGACY);
563 drm_minor_free(dev, DRM_MINOR_RENDER);
564 drm_minor_free(dev, DRM_MINOR_CONTROL);
566 mutex_destroy(&dev->master_mutex);
572 * drm_dev_ref - Take reference of a DRM device
573 * @dev: device to take reference of or NULL
575 * This increases the ref-count of @dev by one. You *must* already own a
576 * reference when calling this. Use drm_dev_unref() to drop this reference
579 * This function never fails. However, this function does not provide *any*
580 * guarantee whether the device is alive or running. It only provides a
581 * reference to the object and the memory associated with it.
583 void drm_dev_ref(struct drm_device *dev)
588 EXPORT_SYMBOL(drm_dev_ref);
591 * drm_dev_unref - Drop reference of a DRM device
592 * @dev: device to drop reference of or NULL
594 * This decreases the ref-count of @dev by one. The device is destroyed if the
595 * ref-count drops to zero.
597 void drm_dev_unref(struct drm_device *dev)
600 kref_put(&dev->ref, drm_dev_release);
602 EXPORT_SYMBOL(drm_dev_unref);
605 * drm_dev_register - Register DRM device
606 * @dev: Device to register
607 * @flags: Flags passed to the driver's .load() function
609 * Register the DRM device @dev with the system, advertise device to user-space
610 * and start normal device operation. @dev must be allocated via drm_dev_alloc()
611 * previously. Right after drm_dev_register() the driver should call
612 * drm_connector_register_all() to register all connectors in sysfs. This is
613 * a separate call for backward compatibility with drivers still using
614 * the deprecated ->load() callback, where connectors are registered from within
615 * the ->load() callback.
617 * Never call this twice on any device!
619 * NOTE: To ensure backward compatibility with existing drivers method this
620 * function calls the ->load() method after registering the device nodes,
621 * creating race conditions. Usage of the ->load() methods is therefore
622 * deprecated, drivers must perform all initialization before calling
623 * drm_dev_register().
626 * 0 on success, negative error code on failure.
628 int drm_dev_register(struct drm_device *dev, unsigned long flags)
632 mutex_lock(&drm_global_mutex);
634 ret = drm_minor_register(dev, DRM_MINOR_CONTROL);
638 ret = drm_minor_register(dev, DRM_MINOR_RENDER);
642 ret = drm_minor_register(dev, DRM_MINOR_LEGACY);
646 if (dev->driver->load) {
647 ret = dev->driver->load(dev, flags);
656 drm_minor_unregister(dev, DRM_MINOR_LEGACY);
657 drm_minor_unregister(dev, DRM_MINOR_RENDER);
658 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
660 mutex_unlock(&drm_global_mutex);
663 EXPORT_SYMBOL(drm_dev_register);
666 * drm_dev_unregister - Unregister DRM device
667 * @dev: Device to unregister
669 * Unregister the DRM device from the system. This does the reverse of
670 * drm_dev_register() but does not deallocate the device. The caller must call
671 * drm_dev_unref() to drop their final reference.
673 * This should be called first in the device teardown code to make sure
674 * userspace can't access the device instance any more.
676 void drm_dev_unregister(struct drm_device *dev)
678 struct drm_map_list *r_list, *list_temp;
682 if (dev->driver->unload)
683 dev->driver->unload(dev);
686 drm_pci_agp_destroy(dev);
688 drm_vblank_cleanup(dev);
690 list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head)
691 drm_legacy_rmmap(dev, r_list->map);
693 drm_minor_unregister(dev, DRM_MINOR_LEGACY);
694 drm_minor_unregister(dev, DRM_MINOR_RENDER);
695 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
697 EXPORT_SYMBOL(drm_dev_unregister);
700 * drm_dev_set_unique - Set the unique name of a DRM device
701 * @dev: device of which to set the unique name
704 * Sets the unique name of a DRM device using the specified string. Drivers
705 * can use this at driver probe time if the unique name of the devices they
708 * Return: 0 on success or a negative error code on failure.
710 int drm_dev_set_unique(struct drm_device *dev, const char *name)
713 dev->unique = kstrdup(name, GFP_KERNEL);
715 return dev->unique ? 0 : -ENOMEM;
717 EXPORT_SYMBOL(drm_dev_set_unique);
721 * The DRM core module initializes all global DRM objects and makes them
722 * available to drivers. Once setup, drivers can probe their respective
724 * Currently, core management includes:
725 * - The "DRM-Global" key/value database
726 * - Global ID management for connectors
727 * - DRM major number allocation
728 * - DRM minor management
732 * Furthermore, the DRM core provides dynamic char-dev lookups. For each
733 * interface registered on a DRM device, you can request minor numbers from DRM
734 * core. DRM core takes care of major-number management and char-dev
735 * registration. A stub ->open() callback forwards any open() requests to the
739 static int drm_stub_open(struct inode *inode, struct file *filp)
741 const struct file_operations *new_fops;
742 struct drm_minor *minor;
747 mutex_lock(&drm_global_mutex);
748 minor = drm_minor_acquire(iminor(inode));
750 err = PTR_ERR(minor);
754 new_fops = fops_get(minor->dev->driver->fops);
760 replace_fops(filp, new_fops);
761 if (filp->f_op->open)
762 err = filp->f_op->open(inode, filp);
767 drm_minor_release(minor);
769 mutex_unlock(&drm_global_mutex);
773 static const struct file_operations drm_stub_fops = {
774 .owner = THIS_MODULE,
775 .open = drm_stub_open,
776 .llseek = noop_llseek,
779 static int __init drm_core_init(void)
784 drm_connector_ida_init();
785 idr_init(&drm_minors_idr);
787 if (register_chrdev(DRM_MAJOR, "drm", &drm_stub_fops))
790 ret = drm_sysfs_init();
792 printk(KERN_ERR "DRM: Error creating drm class.\n");
796 drm_debugfs_root = debugfs_create_dir("dri", NULL);
797 if (!drm_debugfs_root) {
798 DRM_ERROR("Cannot create /sys/kernel/debug/dri\n");
803 DRM_INFO("Initialized %s %d.%d.%d %s\n",
804 CORE_NAME, CORE_MAJOR, CORE_MINOR, CORE_PATCHLEVEL, CORE_DATE);
809 unregister_chrdev(DRM_MAJOR, "drm");
811 idr_destroy(&drm_minors_idr);
816 static void __exit drm_core_exit(void)
818 debugfs_remove(drm_debugfs_root);
821 unregister_chrdev(DRM_MAJOR, "drm");
823 drm_connector_ida_destroy();
824 idr_destroy(&drm_minors_idr);
827 module_init(drm_core_init);
828 module_exit(drm_core_exit);