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 struct idr drm_minors_idr;
77 struct class *drm_class;
78 struct dentry *drm_debugfs_root;
80 int drm_err(const char *func, const char *format, ...)
86 va_start(args, format);
91 r = printk(KERN_ERR "[" DRM_NAME ":%s] *ERROR* %pV", func, &vaf);
97 EXPORT_SYMBOL(drm_err);
99 void drm_ut_debug_printk(unsigned int request_level,
101 const char *function_name,
102 const char *format, ...)
104 struct va_format vaf;
107 if (drm_debug & request_level) {
108 va_start(args, format);
113 printk(KERN_DEBUG "[%s:%s], %pV", prefix,
114 function_name, &vaf);
116 printk(KERN_DEBUG "%pV", &vaf);
120 EXPORT_SYMBOL(drm_ut_debug_printk);
122 static int drm_minor_get_id(struct drm_device *dev, int type)
125 int base = 0, limit = 63;
127 if (type == DRM_MINOR_CONTROL) {
130 } else if (type == DRM_MINOR_RENDER) {
135 mutex_lock(&dev->struct_mutex);
136 ret = idr_alloc(&drm_minors_idr, NULL, base, limit, GFP_KERNEL);
137 mutex_unlock(&dev->struct_mutex);
139 return ret == -ENOSPC ? -EINVAL : ret;
142 struct drm_master *drm_master_create(struct drm_minor *minor)
144 struct drm_master *master;
146 master = kzalloc(sizeof(*master), GFP_KERNEL);
150 kref_init(&master->refcount);
151 spin_lock_init(&master->lock.spinlock);
152 init_waitqueue_head(&master->lock.lock_queue);
153 drm_ht_create(&master->magiclist, DRM_MAGIC_HASH_ORDER);
154 INIT_LIST_HEAD(&master->magicfree);
155 master->minor = minor;
160 struct drm_master *drm_master_get(struct drm_master *master)
162 kref_get(&master->refcount);
165 EXPORT_SYMBOL(drm_master_get);
167 static void drm_master_destroy(struct kref *kref)
169 struct drm_master *master = container_of(kref, struct drm_master, refcount);
170 struct drm_magic_entry *pt, *next;
171 struct drm_device *dev = master->minor->dev;
172 struct drm_map_list *r_list, *list_temp;
174 mutex_lock(&dev->struct_mutex);
175 if (dev->driver->master_destroy)
176 dev->driver->master_destroy(dev, master);
178 list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head) {
179 if (r_list->master == master) {
180 drm_rmmap_locked(dev, r_list->map);
185 if (master->unique) {
186 kfree(master->unique);
187 master->unique = NULL;
188 master->unique_len = 0;
191 list_for_each_entry_safe(pt, next, &master->magicfree, head) {
193 drm_ht_remove_item(&master->magiclist, &pt->hash_item);
197 drm_ht_remove(&master->magiclist);
199 mutex_unlock(&dev->struct_mutex);
203 void drm_master_put(struct drm_master **master)
205 kref_put(&(*master)->refcount, drm_master_destroy);
208 EXPORT_SYMBOL(drm_master_put);
210 int drm_setmaster_ioctl(struct drm_device *dev, void *data,
211 struct drm_file *file_priv)
215 mutex_lock(&dev->master_mutex);
216 if (file_priv->is_master)
219 if (file_priv->minor->master) {
224 if (!file_priv->master) {
229 file_priv->minor->master = drm_master_get(file_priv->master);
230 file_priv->is_master = 1;
231 if (dev->driver->master_set) {
232 ret = dev->driver->master_set(dev, file_priv, false);
233 if (unlikely(ret != 0)) {
234 file_priv->is_master = 0;
235 drm_master_put(&file_priv->minor->master);
240 mutex_unlock(&dev->master_mutex);
244 int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
245 struct drm_file *file_priv)
249 mutex_lock(&dev->master_mutex);
250 if (!file_priv->is_master)
253 if (!file_priv->minor->master)
257 if (dev->driver->master_drop)
258 dev->driver->master_drop(dev, file_priv, false);
259 drm_master_put(&file_priv->minor->master);
260 file_priv->is_master = 0;
263 mutex_unlock(&dev->master_mutex);
267 static struct drm_minor **drm_minor_get_slot(struct drm_device *dev,
271 case DRM_MINOR_LEGACY:
272 return &dev->primary;
273 case DRM_MINOR_RENDER:
275 case DRM_MINOR_CONTROL:
276 return &dev->control;
282 static int drm_minor_alloc(struct drm_device *dev, unsigned int type)
284 struct drm_minor *minor;
286 minor = kzalloc(sizeof(*minor), GFP_KERNEL);
293 *drm_minor_get_slot(dev, type) = minor;
298 * drm_get_minor - Register DRM minor
300 * @type: Type of minor
302 * Register minor of given type.
303 * Caller must hold the global DRM mutex.
306 * 0 on success, negative error code on failure.
308 static int drm_get_minor(struct drm_device *dev, unsigned int type)
310 struct drm_minor *new_minor;
316 new_minor = *drm_minor_get_slot(dev, type);
320 minor_id = drm_minor_get_id(dev, type);
324 new_minor->device = MKDEV(DRM_MAJOR, minor_id);
325 new_minor->index = minor_id;
327 idr_replace(&drm_minors_idr, new_minor, minor_id);
329 #if defined(CONFIG_DEBUG_FS)
330 ret = drm_debugfs_init(new_minor, minor_id, drm_debugfs_root);
332 DRM_ERROR("DRM: Failed to initialize /sys/kernel/debug/dri.\n");
337 ret = drm_sysfs_device_add(new_minor);
340 "DRM: Error sysfs_device_add.\n");
344 DRM_DEBUG("new minor assigned %d\n", minor_id);
349 #if defined(CONFIG_DEBUG_FS)
350 drm_debugfs_cleanup(new_minor);
353 idr_remove(&drm_minors_idr, minor_id);
358 * drm_unplug_minor - Unplug DRM minor
359 * @minor: Minor to unplug
361 * Unplugs the given DRM minor but keeps the object. So after this returns,
362 * minor->dev is still valid so existing open-files can still access it to get
363 * device information from their drm_file ojects.
364 * If the minor is already unplugged or if @minor is NULL, nothing is done.
365 * The global DRM mutex must be held by the caller.
367 static void drm_unplug_minor(struct drm_minor *minor)
369 if (!minor || !minor->kdev)
372 #if defined(CONFIG_DEBUG_FS)
373 drm_debugfs_cleanup(minor);
376 drm_sysfs_device_remove(minor);
377 idr_remove(&drm_minors_idr, minor->index);
381 * drm_minor_acquire - Acquire a DRM minor
382 * @minor_id: Minor ID of the DRM-minor
384 * Looks up the given minor-ID and returns the respective DRM-minor object. The
385 * refence-count of the underlying device is increased so you must release this
386 * object with drm_minor_release().
388 * As long as you hold this minor, it is guaranteed that the object and the
389 * minor->dev pointer will stay valid! However, the device may get unplugged and
390 * unregistered while you hold the minor.
393 * Pointer to minor-object with increased device-refcount, or PTR_ERR on
396 struct drm_minor *drm_minor_acquire(unsigned int minor_id)
398 struct drm_minor *minor;
400 minor = idr_find(&drm_minors_idr, minor_id);
402 return ERR_PTR(-ENODEV);
404 drm_dev_ref(minor->dev);
409 * drm_minor_release - Release DRM minor
410 * @minor: Pointer to DRM minor object
412 * Release a minor that was previously acquired via drm_minor_acquire().
414 void drm_minor_release(struct drm_minor *minor)
416 drm_dev_unref(minor->dev);
420 * drm_put_minor - Destroy DRM minor
421 * @minor: Minor to destroy
423 * This calls drm_unplug_minor() on the given minor and then frees it. Nothing
424 * is done if @minor is NULL. It is fine to call this on already unplugged
426 * The global DRM mutex must be held by the caller.
428 static void drm_put_minor(struct drm_minor *minor)
433 DRM_DEBUG("release secondary minor %d\n", minor->index);
435 drm_unplug_minor(minor);
440 * Called via drm_exit() at module unload time or when pci device is
443 * Cleans up all DRM device, calling drm_lastclose().
446 void drm_put_dev(struct drm_device *dev)
451 DRM_ERROR("cleanup called no dev\n");
455 drm_dev_unregister(dev);
458 EXPORT_SYMBOL(drm_put_dev);
460 void drm_unplug_dev(struct drm_device *dev)
462 /* for a USB device */
463 if (drm_core_check_feature(dev, DRIVER_MODESET))
464 drm_unplug_minor(dev->control);
466 drm_unplug_minor(dev->render);
467 drm_unplug_minor(dev->primary);
469 mutex_lock(&drm_global_mutex);
471 drm_device_set_unplugged(dev);
473 if (dev->open_count == 0) {
476 mutex_unlock(&drm_global_mutex);
478 EXPORT_SYMBOL(drm_unplug_dev);
482 * We want to be able to allocate our own "struct address_space" to control
483 * memory-mappings in VRAM (or stolen RAM, ...). However, core MM does not allow
484 * stand-alone address_space objects, so we need an underlying inode. As there
485 * is no way to allocate an independent inode easily, we need a fake internal
488 * The drm_fs_inode_new() function allocates a new inode, drm_fs_inode_free()
489 * frees it again. You are allowed to use iget() and iput() to get references to
490 * the inode. But each drm_fs_inode_new() call must be paired with exactly one
491 * drm_fs_inode_free() call (which does not have to be the last iput()).
492 * We use drm_fs_inode_*() to manage our internal VFS mount-point and share it
493 * between multiple inode-users. You could, technically, call
494 * iget() + drm_fs_inode_free() directly after alloc and sometime later do an
495 * iput(), but this way you'd end up with a new vfsmount for each inode.
498 static int drm_fs_cnt;
499 static struct vfsmount *drm_fs_mnt;
501 static const struct dentry_operations drm_fs_dops = {
502 .d_dname = simple_dname,
505 static const struct super_operations drm_fs_sops = {
506 .statfs = simple_statfs,
509 static struct dentry *drm_fs_mount(struct file_system_type *fs_type, int flags,
510 const char *dev_name, void *data)
512 return mount_pseudo(fs_type,
519 static struct file_system_type drm_fs_type = {
521 .owner = THIS_MODULE,
522 .mount = drm_fs_mount,
523 .kill_sb = kill_anon_super,
526 static struct inode *drm_fs_inode_new(void)
531 r = simple_pin_fs(&drm_fs_type, &drm_fs_mnt, &drm_fs_cnt);
533 DRM_ERROR("Cannot mount pseudo fs: %d\n", r);
537 inode = alloc_anon_inode(drm_fs_mnt->mnt_sb);
539 simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
544 static void drm_fs_inode_free(struct inode *inode)
548 simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
553 * drm_dev_alloc - Allocate new drm device
554 * @driver: DRM driver to allocate device for
555 * @parent: Parent device object
557 * Allocate and initialize a new DRM device. No device registration is done.
558 * Call drm_dev_register() to advertice the device to user space and register it
559 * with other core subsystems.
561 * The initial ref-count of the object is 1. Use drm_dev_ref() and
562 * drm_dev_unref() to take and drop further ref-counts.
565 * Pointer to new DRM device, or NULL if out of memory.
567 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
568 struct device *parent)
570 struct drm_device *dev;
573 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
577 kref_init(&dev->ref);
579 dev->driver = driver;
581 INIT_LIST_HEAD(&dev->filelist);
582 INIT_LIST_HEAD(&dev->ctxlist);
583 INIT_LIST_HEAD(&dev->vmalist);
584 INIT_LIST_HEAD(&dev->maplist);
585 INIT_LIST_HEAD(&dev->vblank_event_list);
587 spin_lock_init(&dev->count_lock);
588 spin_lock_init(&dev->event_lock);
589 mutex_init(&dev->struct_mutex);
590 mutex_init(&dev->ctxlist_mutex);
591 mutex_init(&dev->master_mutex);
593 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
594 ret = drm_minor_alloc(dev, DRM_MINOR_CONTROL);
599 if (drm_core_check_feature(dev, DRIVER_RENDER) && drm_rnodes) {
600 ret = drm_minor_alloc(dev, DRM_MINOR_RENDER);
604 ret = drm_minor_alloc(dev, DRM_MINOR_LEGACY);
608 dev->anon_inode = drm_fs_inode_new();
609 if (IS_ERR(dev->anon_inode)) {
610 ret = PTR_ERR(dev->anon_inode);
611 DRM_ERROR("Cannot allocate anonymous inode: %d\n", ret);
615 if (drm_ht_create(&dev->map_hash, 12))
618 ret = drm_ctxbitmap_init(dev);
620 DRM_ERROR("Cannot allocate memory for context bitmap.\n");
624 if (driver->driver_features & DRIVER_GEM) {
625 ret = drm_gem_init(dev);
627 DRM_ERROR("Cannot initialize graphics execution manager (GEM)\n");
635 drm_ctxbitmap_cleanup(dev);
637 drm_ht_remove(&dev->map_hash);
639 drm_fs_inode_free(dev->anon_inode);
641 drm_put_minor(dev->control);
642 drm_put_minor(dev->render);
643 drm_put_minor(dev->primary);
644 mutex_destroy(&dev->master_mutex);
648 EXPORT_SYMBOL(drm_dev_alloc);
650 static void drm_dev_release(struct kref *ref)
652 struct drm_device *dev = container_of(ref, struct drm_device, ref);
654 drm_put_minor(dev->control);
655 drm_put_minor(dev->render);
656 drm_put_minor(dev->primary);
658 if (dev->driver->driver_features & DRIVER_GEM)
659 drm_gem_destroy(dev);
661 drm_ctxbitmap_cleanup(dev);
662 drm_ht_remove(&dev->map_hash);
663 drm_fs_inode_free(dev->anon_inode);
665 mutex_destroy(&dev->master_mutex);
671 * drm_dev_ref - Take reference of a DRM device
672 * @dev: device to take reference of or NULL
674 * This increases the ref-count of @dev by one. You *must* already own a
675 * reference when calling this. Use drm_dev_unref() to drop this reference
678 * This function never fails. However, this function does not provide *any*
679 * guarantee whether the device is alive or running. It only provides a
680 * reference to the object and the memory associated with it.
682 void drm_dev_ref(struct drm_device *dev)
687 EXPORT_SYMBOL(drm_dev_ref);
690 * drm_dev_unref - Drop reference of a DRM device
691 * @dev: device to drop reference of or NULL
693 * This decreases the ref-count of @dev by one. The device is destroyed if the
694 * ref-count drops to zero.
696 void drm_dev_unref(struct drm_device *dev)
699 kref_put(&dev->ref, drm_dev_release);
701 EXPORT_SYMBOL(drm_dev_unref);
704 * drm_dev_register - Register DRM device
705 * @dev: Device to register
707 * Register the DRM device @dev with the system, advertise device to user-space
708 * and start normal device operation. @dev must be allocated via drm_dev_alloc()
711 * Never call this twice on any device!
714 * 0 on success, negative error code on failure.
716 int drm_dev_register(struct drm_device *dev, unsigned long flags)
720 mutex_lock(&drm_global_mutex);
722 ret = drm_get_minor(dev, DRM_MINOR_CONTROL);
726 ret = drm_get_minor(dev, DRM_MINOR_RENDER);
730 ret = drm_get_minor(dev, DRM_MINOR_LEGACY);
734 if (dev->driver->load) {
735 ret = dev->driver->load(dev, flags);
740 /* setup grouping for legacy outputs */
741 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
742 ret = drm_mode_group_init_legacy_group(dev,
743 &dev->primary->mode_group);
752 if (dev->driver->unload)
753 dev->driver->unload(dev);
755 drm_unplug_minor(dev->control);
756 drm_unplug_minor(dev->render);
757 drm_unplug_minor(dev->primary);
759 mutex_unlock(&drm_global_mutex);
762 EXPORT_SYMBOL(drm_dev_register);
765 * drm_dev_unregister - Unregister DRM device
766 * @dev: Device to unregister
768 * Unregister the DRM device from the system. This does the reverse of
769 * drm_dev_register() but does not deallocate the device. The caller must call
770 * drm_dev_unref() to drop their final reference.
772 void drm_dev_unregister(struct drm_device *dev)
774 struct drm_map_list *r_list, *list_temp;
778 if (dev->driver->unload)
779 dev->driver->unload(dev);
782 drm_pci_agp_destroy(dev);
784 drm_vblank_cleanup(dev);
786 list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head)
787 drm_rmmap(dev, r_list->map);
789 drm_unplug_minor(dev->control);
790 drm_unplug_minor(dev->render);
791 drm_unplug_minor(dev->primary);
793 EXPORT_SYMBOL(drm_dev_unregister);
796 * drm_dev_set_unique - Set the unique name of a DRM device
797 * @dev: device of which to set the unique name
798 * @fmt: format string for unique name
800 * Sets the unique name of a DRM device using the specified format string and
801 * a variable list of arguments. Drivers can use this at driver probe time if
802 * the unique name of the devices they drive is static.
804 * Return: 0 on success or a negative error code on failure.
806 int drm_dev_set_unique(struct drm_device *dev, const char *fmt, ...)
813 dev->unique = kvasprintf(GFP_KERNEL, fmt, ap);
816 return dev->unique ? 0 : -ENOMEM;
818 EXPORT_SYMBOL(drm_dev_set_unique);