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 unsigned int drm_vblank_offdelay = 5000; /* Default to 5000 msecs. */
49 EXPORT_SYMBOL(drm_vblank_offdelay);
51 unsigned int drm_timestamp_precision = 20; /* Default to 20 usecs. */
52 EXPORT_SYMBOL(drm_timestamp_precision);
55 * Default to use monotonic timestamps for wait-for-vblank and page-flip
58 unsigned int drm_timestamp_monotonic = 1;
60 MODULE_AUTHOR(CORE_AUTHOR);
61 MODULE_DESCRIPTION(CORE_DESC);
62 MODULE_LICENSE("GPL and additional rights");
63 MODULE_PARM_DESC(debug, "Enable debug output");
64 MODULE_PARM_DESC(rnodes, "Enable experimental render nodes API");
65 MODULE_PARM_DESC(vblankoffdelay, "Delay until vblank irq auto-disable [msecs]");
66 MODULE_PARM_DESC(timestamp_precision_usec, "Max. error on timestamps [usecs]");
67 MODULE_PARM_DESC(timestamp_monotonic, "Use monotonic timestamps");
69 module_param_named(debug, drm_debug, int, 0600);
70 module_param_named(rnodes, drm_rnodes, int, 0600);
71 module_param_named(vblankoffdelay, drm_vblank_offdelay, int, 0600);
72 module_param_named(timestamp_precision_usec, drm_timestamp_precision, int, 0600);
73 module_param_named(timestamp_monotonic, drm_timestamp_monotonic, int, 0600);
75 static DEFINE_SPINLOCK(drm_minor_lock);
76 struct idr drm_minors_idr;
78 struct class *drm_class;
79 struct dentry *drm_debugfs_root;
81 int drm_err(const char *func, const char *format, ...)
87 va_start(args, format);
92 r = printk(KERN_ERR "[" DRM_NAME ":%s] *ERROR* %pV", func, &vaf);
98 EXPORT_SYMBOL(drm_err);
100 void drm_ut_debug_printk(const char *function_name, const char *format, ...)
102 struct va_format vaf;
105 va_start(args, format);
109 printk(KERN_DEBUG "[" DRM_NAME ":%s] %pV", function_name, &vaf);
113 EXPORT_SYMBOL(drm_ut_debug_printk);
115 struct drm_master *drm_master_create(struct drm_minor *minor)
117 struct drm_master *master;
119 master = kzalloc(sizeof(*master), GFP_KERNEL);
123 kref_init(&master->refcount);
124 spin_lock_init(&master->lock.spinlock);
125 init_waitqueue_head(&master->lock.lock_queue);
126 drm_ht_create(&master->magiclist, DRM_MAGIC_HASH_ORDER);
127 INIT_LIST_HEAD(&master->magicfree);
128 master->minor = minor;
133 struct drm_master *drm_master_get(struct drm_master *master)
135 kref_get(&master->refcount);
138 EXPORT_SYMBOL(drm_master_get);
140 static void drm_master_destroy(struct kref *kref)
142 struct drm_master *master = container_of(kref, struct drm_master, refcount);
143 struct drm_magic_entry *pt, *next;
144 struct drm_device *dev = master->minor->dev;
145 struct drm_map_list *r_list, *list_temp;
147 mutex_lock(&dev->struct_mutex);
148 if (dev->driver->master_destroy)
149 dev->driver->master_destroy(dev, master);
151 list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head) {
152 if (r_list->master == master) {
153 drm_rmmap_locked(dev, r_list->map);
158 if (master->unique) {
159 kfree(master->unique);
160 master->unique = NULL;
161 master->unique_len = 0;
167 list_for_each_entry_safe(pt, next, &master->magicfree, head) {
169 drm_ht_remove_item(&master->magiclist, &pt->hash_item);
173 drm_ht_remove(&master->magiclist);
175 mutex_unlock(&dev->struct_mutex);
179 void drm_master_put(struct drm_master **master)
181 kref_put(&(*master)->refcount, drm_master_destroy);
184 EXPORT_SYMBOL(drm_master_put);
186 int drm_setmaster_ioctl(struct drm_device *dev, void *data,
187 struct drm_file *file_priv)
191 mutex_lock(&dev->master_mutex);
192 if (file_priv->is_master)
195 if (file_priv->minor->master) {
200 if (!file_priv->master) {
205 file_priv->minor->master = drm_master_get(file_priv->master);
206 file_priv->is_master = 1;
207 if (dev->driver->master_set) {
208 ret = dev->driver->master_set(dev, file_priv, false);
209 if (unlikely(ret != 0)) {
210 file_priv->is_master = 0;
211 drm_master_put(&file_priv->minor->master);
216 mutex_unlock(&dev->master_mutex);
220 int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
221 struct drm_file *file_priv)
225 mutex_lock(&dev->master_mutex);
226 if (!file_priv->is_master)
229 if (!file_priv->minor->master)
233 if (dev->driver->master_drop)
234 dev->driver->master_drop(dev, file_priv, false);
235 drm_master_put(&file_priv->minor->master);
236 file_priv->is_master = 0;
239 mutex_unlock(&dev->master_mutex);
245 * A DRM device can provide several char-dev interfaces on the DRM-Major. Each
246 * of them is represented by a drm_minor object. Depending on the capabilities
247 * of the device-driver, different interfaces are registered.
249 * Minors can be accessed via dev->$minor_name. This pointer is either
250 * NULL or a valid drm_minor pointer and stays valid as long as the device is
251 * valid. This means, DRM minors have the same life-time as the underlying
252 * device. However, this doesn't mean that the minor is active. Minors are
253 * registered and unregistered dynamically according to device-state.
256 static struct drm_minor **drm_minor_get_slot(struct drm_device *dev,
260 case DRM_MINOR_LEGACY:
261 return &dev->primary;
262 case DRM_MINOR_RENDER:
264 case DRM_MINOR_CONTROL:
265 return &dev->control;
271 static int drm_minor_alloc(struct drm_device *dev, unsigned int type)
273 struct drm_minor *minor;
275 minor = kzalloc(sizeof(*minor), GFP_KERNEL);
282 *drm_minor_get_slot(dev, type) = minor;
286 static void drm_minor_free(struct drm_device *dev, unsigned int type)
288 struct drm_minor **slot;
290 slot = drm_minor_get_slot(dev, type);
297 static int drm_minor_register(struct drm_device *dev, unsigned int type)
299 struct drm_minor *new_minor;
306 new_minor = *drm_minor_get_slot(dev, type);
310 idr_preload(GFP_KERNEL);
311 spin_lock_irqsave(&drm_minor_lock, flags);
312 minor_id = idr_alloc(&drm_minors_idr,
317 spin_unlock_irqrestore(&drm_minor_lock, flags);
323 new_minor->index = minor_id;
325 ret = drm_debugfs_init(new_minor, minor_id, drm_debugfs_root);
327 DRM_ERROR("DRM: Failed to initialize /sys/kernel/debug/dri.\n");
331 ret = drm_sysfs_device_add(new_minor);
333 DRM_ERROR("DRM: Error sysfs_device_add.\n");
337 /* replace NULL with @minor so lookups will succeed from now on */
338 spin_lock_irqsave(&drm_minor_lock, flags);
339 idr_replace(&drm_minors_idr, new_minor, new_minor->index);
340 spin_unlock_irqrestore(&drm_minor_lock, flags);
342 DRM_DEBUG("new minor assigned %d\n", minor_id);
346 drm_debugfs_cleanup(new_minor);
348 spin_lock_irqsave(&drm_minor_lock, flags);
349 idr_remove(&drm_minors_idr, minor_id);
350 spin_unlock_irqrestore(&drm_minor_lock, flags);
351 new_minor->index = 0;
355 static void drm_minor_unregister(struct drm_device *dev, unsigned int type)
357 struct drm_minor *minor;
360 minor = *drm_minor_get_slot(dev, type);
361 if (!minor || !minor->kdev)
364 spin_lock_irqsave(&drm_minor_lock, flags);
365 idr_remove(&drm_minors_idr, minor->index);
366 spin_unlock_irqrestore(&drm_minor_lock, flags);
369 drm_debugfs_cleanup(minor);
370 drm_sysfs_device_remove(minor);
374 * drm_minor_acquire - Acquire a DRM minor
375 * @minor_id: Minor ID of the DRM-minor
377 * Looks up the given minor-ID and returns the respective DRM-minor object. The
378 * refence-count of the underlying device is increased so you must release this
379 * object with drm_minor_release().
381 * As long as you hold this minor, it is guaranteed that the object and the
382 * minor->dev pointer will stay valid! However, the device may get unplugged and
383 * unregistered while you hold the minor.
386 * Pointer to minor-object with increased device-refcount, or PTR_ERR on
389 struct drm_minor *drm_minor_acquire(unsigned int minor_id)
391 struct drm_minor *minor;
394 spin_lock_irqsave(&drm_minor_lock, flags);
395 minor = idr_find(&drm_minors_idr, minor_id);
397 drm_dev_ref(minor->dev);
398 spin_unlock_irqrestore(&drm_minor_lock, flags);
401 return ERR_PTR(-ENODEV);
402 } else if (drm_device_is_unplugged(minor->dev)) {
403 drm_dev_unref(minor->dev);
404 return ERR_PTR(-ENODEV);
411 * drm_minor_release - Release DRM minor
412 * @minor: Pointer to DRM minor object
414 * Release a minor that was previously acquired via drm_minor_acquire().
416 void drm_minor_release(struct drm_minor *minor)
418 drm_dev_unref(minor->dev);
422 * Called via drm_exit() at module unload time or when pci device is
425 * Cleans up all DRM device, calling drm_lastclose().
428 void drm_put_dev(struct drm_device *dev)
433 DRM_ERROR("cleanup called no dev\n");
437 drm_dev_unregister(dev);
440 EXPORT_SYMBOL(drm_put_dev);
442 void drm_unplug_dev(struct drm_device *dev)
444 /* for a USB device */
445 drm_minor_unregister(dev, DRM_MINOR_LEGACY);
446 drm_minor_unregister(dev, DRM_MINOR_RENDER);
447 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
449 mutex_lock(&drm_global_mutex);
451 drm_device_set_unplugged(dev);
453 if (dev->open_count == 0) {
456 mutex_unlock(&drm_global_mutex);
458 EXPORT_SYMBOL(drm_unplug_dev);
462 * We want to be able to allocate our own "struct address_space" to control
463 * memory-mappings in VRAM (or stolen RAM, ...). However, core MM does not allow
464 * stand-alone address_space objects, so we need an underlying inode. As there
465 * is no way to allocate an independent inode easily, we need a fake internal
468 * The drm_fs_inode_new() function allocates a new inode, drm_fs_inode_free()
469 * frees it again. You are allowed to use iget() and iput() to get references to
470 * the inode. But each drm_fs_inode_new() call must be paired with exactly one
471 * drm_fs_inode_free() call (which does not have to be the last iput()).
472 * We use drm_fs_inode_*() to manage our internal VFS mount-point and share it
473 * between multiple inode-users. You could, technically, call
474 * iget() + drm_fs_inode_free() directly after alloc and sometime later do an
475 * iput(), but this way you'd end up with a new vfsmount for each inode.
478 static int drm_fs_cnt;
479 static struct vfsmount *drm_fs_mnt;
481 static const struct dentry_operations drm_fs_dops = {
482 .d_dname = simple_dname,
485 static const struct super_operations drm_fs_sops = {
486 .statfs = simple_statfs,
489 static struct dentry *drm_fs_mount(struct file_system_type *fs_type, int flags,
490 const char *dev_name, void *data)
492 return mount_pseudo(fs_type,
499 static struct file_system_type drm_fs_type = {
501 .owner = THIS_MODULE,
502 .mount = drm_fs_mount,
503 .kill_sb = kill_anon_super,
506 static struct inode *drm_fs_inode_new(void)
511 r = simple_pin_fs(&drm_fs_type, &drm_fs_mnt, &drm_fs_cnt);
513 DRM_ERROR("Cannot mount pseudo fs: %d\n", r);
517 inode = alloc_anon_inode(drm_fs_mnt->mnt_sb);
519 simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
524 static void drm_fs_inode_free(struct inode *inode)
528 simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
533 * drm_dev_alloc - Allocate new drm device
534 * @driver: DRM driver to allocate device for
535 * @parent: Parent device object
537 * Allocate and initialize a new DRM device. No device registration is done.
538 * Call drm_dev_register() to advertice the device to user space and register it
539 * with other core subsystems.
541 * The initial ref-count of the object is 1. Use drm_dev_ref() and
542 * drm_dev_unref() to take and drop further ref-counts.
545 * Pointer to new DRM device, or NULL if out of memory.
547 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
548 struct device *parent)
550 struct drm_device *dev;
553 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
557 kref_init(&dev->ref);
559 dev->driver = driver;
561 INIT_LIST_HEAD(&dev->filelist);
562 INIT_LIST_HEAD(&dev->ctxlist);
563 INIT_LIST_HEAD(&dev->vmalist);
564 INIT_LIST_HEAD(&dev->maplist);
565 INIT_LIST_HEAD(&dev->vblank_event_list);
567 spin_lock_init(&dev->count_lock);
568 spin_lock_init(&dev->event_lock);
569 mutex_init(&dev->struct_mutex);
570 mutex_init(&dev->ctxlist_mutex);
571 mutex_init(&dev->master_mutex);
573 dev->anon_inode = drm_fs_inode_new();
574 if (IS_ERR(dev->anon_inode)) {
575 ret = PTR_ERR(dev->anon_inode);
576 DRM_ERROR("Cannot allocate anonymous inode: %d\n", ret);
580 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
581 ret = drm_minor_alloc(dev, DRM_MINOR_CONTROL);
586 if (drm_core_check_feature(dev, DRIVER_RENDER) && drm_rnodes) {
587 ret = drm_minor_alloc(dev, DRM_MINOR_RENDER);
592 ret = drm_minor_alloc(dev, DRM_MINOR_LEGACY);
596 if (drm_ht_create(&dev->map_hash, 12))
599 ret = drm_ctxbitmap_init(dev);
601 DRM_ERROR("Cannot allocate memory for context bitmap.\n");
605 if (driver->driver_features & DRIVER_GEM) {
606 ret = drm_gem_init(dev);
608 DRM_ERROR("Cannot initialize graphics execution manager (GEM)\n");
616 drm_ctxbitmap_cleanup(dev);
618 drm_ht_remove(&dev->map_hash);
620 drm_minor_free(dev, DRM_MINOR_LEGACY);
621 drm_minor_free(dev, DRM_MINOR_RENDER);
622 drm_minor_free(dev, DRM_MINOR_CONTROL);
623 drm_fs_inode_free(dev->anon_inode);
625 mutex_destroy(&dev->master_mutex);
629 EXPORT_SYMBOL(drm_dev_alloc);
631 static void drm_dev_release(struct kref *ref)
633 struct drm_device *dev = container_of(ref, struct drm_device, ref);
635 if (dev->driver->driver_features & DRIVER_GEM)
636 drm_gem_destroy(dev);
638 drm_ctxbitmap_cleanup(dev);
639 drm_ht_remove(&dev->map_hash);
640 drm_fs_inode_free(dev->anon_inode);
642 drm_minor_free(dev, DRM_MINOR_LEGACY);
643 drm_minor_free(dev, DRM_MINOR_RENDER);
644 drm_minor_free(dev, DRM_MINOR_CONTROL);
648 mutex_destroy(&dev->master_mutex);
653 * drm_dev_ref - Take reference of a DRM device
654 * @dev: device to take reference of or NULL
656 * This increases the ref-count of @dev by one. You *must* already own a
657 * reference when calling this. Use drm_dev_unref() to drop this reference
660 * This function never fails. However, this function does not provide *any*
661 * guarantee whether the device is alive or running. It only provides a
662 * reference to the object and the memory associated with it.
664 void drm_dev_ref(struct drm_device *dev)
669 EXPORT_SYMBOL(drm_dev_ref);
672 * drm_dev_unref - Drop reference of a DRM device
673 * @dev: device to drop reference of or NULL
675 * This decreases the ref-count of @dev by one. The device is destroyed if the
676 * ref-count drops to zero.
678 void drm_dev_unref(struct drm_device *dev)
681 kref_put(&dev->ref, drm_dev_release);
683 EXPORT_SYMBOL(drm_dev_unref);
686 * drm_dev_register - Register DRM device
687 * @dev: Device to register
689 * Register the DRM device @dev with the system, advertise device to user-space
690 * and start normal device operation. @dev must be allocated via drm_dev_alloc()
693 * Never call this twice on any device!
696 * 0 on success, negative error code on failure.
698 int drm_dev_register(struct drm_device *dev, unsigned long flags)
702 mutex_lock(&drm_global_mutex);
704 ret = drm_minor_register(dev, DRM_MINOR_CONTROL);
708 ret = drm_minor_register(dev, DRM_MINOR_RENDER);
712 ret = drm_minor_register(dev, DRM_MINOR_LEGACY);
716 if (dev->driver->load) {
717 ret = dev->driver->load(dev, flags);
722 /* setup grouping for legacy outputs */
723 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
724 ret = drm_mode_group_init_legacy_group(dev,
725 &dev->primary->mode_group);
734 if (dev->driver->unload)
735 dev->driver->unload(dev);
737 drm_minor_unregister(dev, DRM_MINOR_LEGACY);
738 drm_minor_unregister(dev, DRM_MINOR_RENDER);
739 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
741 mutex_unlock(&drm_global_mutex);
744 EXPORT_SYMBOL(drm_dev_register);
747 * drm_dev_unregister - Unregister DRM device
748 * @dev: Device to unregister
750 * Unregister the DRM device from the system. This does the reverse of
751 * drm_dev_register() but does not deallocate the device. The caller must call
752 * drm_dev_unref() to drop their final reference.
754 void drm_dev_unregister(struct drm_device *dev)
756 struct drm_map_list *r_list, *list_temp;
760 if (dev->driver->unload)
761 dev->driver->unload(dev);
764 drm_pci_agp_destroy(dev);
766 drm_vblank_cleanup(dev);
768 list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head)
769 drm_rmmap(dev, r_list->map);
771 drm_minor_unregister(dev, DRM_MINOR_LEGACY);
772 drm_minor_unregister(dev, DRM_MINOR_RENDER);
773 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
775 EXPORT_SYMBOL(drm_dev_unregister);