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.
30 #include <linux/module.h>
31 #include <linux/moduleparam.h>
32 #include <linux/mount.h>
33 #include <linux/slab.h>
35 #include <drm/drm_core.h>
37 unsigned int drm_debug = 0; /* 1 to enable debug output */
38 EXPORT_SYMBOL(drm_debug);
40 unsigned int drm_vblank_offdelay = 5000; /* Default to 5000 msecs. */
42 unsigned int drm_timestamp_precision = 20; /* Default to 20 usecs. */
45 * Default to use monotonic timestamps for wait-for-vblank and page-flip
48 unsigned int drm_timestamp_monotonic = 1;
50 MODULE_AUTHOR(CORE_AUTHOR);
51 MODULE_DESCRIPTION(CORE_DESC);
52 MODULE_LICENSE("GPL and additional rights");
53 MODULE_PARM_DESC(debug, "Enable debug output");
54 MODULE_PARM_DESC(vblankoffdelay, "Delay until vblank irq auto-disable [msecs]");
55 MODULE_PARM_DESC(timestamp_precision_usec, "Max. error on timestamps [usecs]");
56 MODULE_PARM_DESC(timestamp_monotonic, "Use monotonic timestamps");
58 module_param_named(debug, drm_debug, int, 0600);
59 module_param_named(vblankoffdelay, drm_vblank_offdelay, int, 0600);
60 module_param_named(timestamp_precision_usec, drm_timestamp_precision, int, 0600);
61 module_param_named(timestamp_monotonic, drm_timestamp_monotonic, int, 0600);
63 static DEFINE_SPINLOCK(drm_minor_lock);
64 struct idr drm_minors_idr;
66 struct class *drm_class;
67 struct dentry *drm_debugfs_root;
69 int drm_err(const char *func, const char *format, ...)
75 va_start(args, format);
80 r = printk(KERN_ERR "[" DRM_NAME ":%s] *ERROR* %pV", func, &vaf);
86 EXPORT_SYMBOL(drm_err);
88 void drm_ut_debug_printk(const char *function_name, const char *format, ...)
93 va_start(args, format);
97 printk(KERN_DEBUG "[" DRM_NAME ":%s] %pV", function_name, &vaf);
101 EXPORT_SYMBOL(drm_ut_debug_printk);
103 struct drm_master *drm_master_create(struct drm_minor *minor)
105 struct drm_master *master;
107 master = kzalloc(sizeof(*master), GFP_KERNEL);
111 kref_init(&master->refcount);
112 spin_lock_init(&master->lock.spinlock);
113 init_waitqueue_head(&master->lock.lock_queue);
114 if (drm_ht_create(&master->magiclist, DRM_MAGIC_HASH_ORDER)) {
118 INIT_LIST_HEAD(&master->magicfree);
119 master->minor = minor;
124 struct drm_master *drm_master_get(struct drm_master *master)
126 kref_get(&master->refcount);
129 EXPORT_SYMBOL(drm_master_get);
131 static void drm_master_destroy(struct kref *kref)
133 struct drm_master *master = container_of(kref, struct drm_master, refcount);
134 struct drm_magic_entry *pt, *next;
135 struct drm_device *dev = master->minor->dev;
136 struct drm_map_list *r_list, *list_temp;
138 mutex_lock(&dev->struct_mutex);
139 if (dev->driver->master_destroy)
140 dev->driver->master_destroy(dev, master);
142 list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head) {
143 if (r_list->master == master) {
144 drm_rmmap_locked(dev, r_list->map);
149 if (master->unique) {
150 kfree(master->unique);
151 master->unique = NULL;
152 master->unique_len = 0;
155 list_for_each_entry_safe(pt, next, &master->magicfree, head) {
157 drm_ht_remove_item(&master->magiclist, &pt->hash_item);
161 drm_ht_remove(&master->magiclist);
163 mutex_unlock(&dev->struct_mutex);
167 void drm_master_put(struct drm_master **master)
169 kref_put(&(*master)->refcount, drm_master_destroy);
172 EXPORT_SYMBOL(drm_master_put);
174 int drm_setmaster_ioctl(struct drm_device *dev, void *data,
175 struct drm_file *file_priv)
179 mutex_lock(&dev->master_mutex);
180 if (drm_is_master(file_priv))
183 if (file_priv->minor->master) {
188 if (!file_priv->master) {
193 file_priv->minor->master = drm_master_get(file_priv->master);
194 if (dev->driver->master_set) {
195 ret = dev->driver->master_set(dev, file_priv, false);
196 if (unlikely(ret != 0))
197 drm_master_put(&file_priv->minor->master);
201 mutex_unlock(&dev->master_mutex);
205 int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
206 struct drm_file *file_priv)
210 mutex_lock(&dev->master_mutex);
211 if (!drm_is_master(file_priv))
214 if (!file_priv->minor->master)
218 if (dev->driver->master_drop)
219 dev->driver->master_drop(dev, file_priv, false);
220 drm_master_put(&file_priv->minor->master);
223 mutex_unlock(&dev->master_mutex);
229 * A DRM device can provide several char-dev interfaces on the DRM-Major. Each
230 * of them is represented by a drm_minor object. Depending on the capabilities
231 * of the device-driver, different interfaces are registered.
233 * Minors can be accessed via dev->$minor_name. This pointer is either
234 * NULL or a valid drm_minor pointer and stays valid as long as the device is
235 * valid. This means, DRM minors have the same life-time as the underlying
236 * device. However, this doesn't mean that the minor is active. Minors are
237 * registered and unregistered dynamically according to device-state.
240 static struct drm_minor **drm_minor_get_slot(struct drm_device *dev,
244 case DRM_MINOR_LEGACY:
245 return &dev->primary;
246 case DRM_MINOR_RENDER:
248 case DRM_MINOR_CONTROL:
249 return &dev->control;
255 static int drm_minor_alloc(struct drm_device *dev, unsigned int type)
257 struct drm_minor *minor;
259 minor = kzalloc(sizeof(*minor), GFP_KERNEL);
266 *drm_minor_get_slot(dev, type) = minor;
270 static void drm_minor_free(struct drm_device *dev, unsigned int type)
272 struct drm_minor **slot;
274 slot = drm_minor_get_slot(dev, type);
276 drm_mode_group_destroy(&(*slot)->mode_group);
282 static int drm_minor_register(struct drm_device *dev, unsigned int type)
284 struct drm_minor *new_minor;
291 new_minor = *drm_minor_get_slot(dev, type);
295 idr_preload(GFP_KERNEL);
296 spin_lock_irqsave(&drm_minor_lock, flags);
297 minor_id = idr_alloc(&drm_minors_idr,
302 spin_unlock_irqrestore(&drm_minor_lock, flags);
308 new_minor->index = minor_id;
310 ret = drm_debugfs_init(new_minor, minor_id, drm_debugfs_root);
312 DRM_ERROR("DRM: Failed to initialize /sys/kernel/debug/dri.\n");
316 ret = drm_sysfs_device_add(new_minor);
318 DRM_ERROR("DRM: Error sysfs_device_add.\n");
322 /* replace NULL with @minor so lookups will succeed from now on */
323 spin_lock_irqsave(&drm_minor_lock, flags);
324 idr_replace(&drm_minors_idr, new_minor, new_minor->index);
325 spin_unlock_irqrestore(&drm_minor_lock, flags);
327 DRM_DEBUG("new minor assigned %d\n", minor_id);
331 drm_debugfs_cleanup(new_minor);
333 spin_lock_irqsave(&drm_minor_lock, flags);
334 idr_remove(&drm_minors_idr, minor_id);
335 spin_unlock_irqrestore(&drm_minor_lock, flags);
336 new_minor->index = 0;
340 static void drm_minor_unregister(struct drm_device *dev, unsigned int type)
342 struct drm_minor *minor;
345 minor = *drm_minor_get_slot(dev, type);
346 if (!minor || !minor->kdev)
349 spin_lock_irqsave(&drm_minor_lock, flags);
350 idr_remove(&drm_minors_idr, minor->index);
351 spin_unlock_irqrestore(&drm_minor_lock, flags);
354 drm_debugfs_cleanup(minor);
355 drm_sysfs_device_remove(minor);
359 * drm_minor_acquire - Acquire a DRM minor
360 * @minor_id: Minor ID of the DRM-minor
362 * Looks up the given minor-ID and returns the respective DRM-minor object. The
363 * refence-count of the underlying device is increased so you must release this
364 * object with drm_minor_release().
366 * As long as you hold this minor, it is guaranteed that the object and the
367 * minor->dev pointer will stay valid! However, the device may get unplugged and
368 * unregistered while you hold the minor.
371 * Pointer to minor-object with increased device-refcount, or PTR_ERR on
374 struct drm_minor *drm_minor_acquire(unsigned int minor_id)
376 struct drm_minor *minor;
379 spin_lock_irqsave(&drm_minor_lock, flags);
380 minor = idr_find(&drm_minors_idr, minor_id);
382 drm_dev_ref(minor->dev);
383 spin_unlock_irqrestore(&drm_minor_lock, flags);
386 return ERR_PTR(-ENODEV);
387 } else if (drm_device_is_unplugged(minor->dev)) {
388 drm_dev_unref(minor->dev);
389 return ERR_PTR(-ENODEV);
396 * drm_minor_release - Release DRM minor
397 * @minor: Pointer to DRM minor object
399 * Release a minor that was previously acquired via drm_minor_acquire().
401 void drm_minor_release(struct drm_minor *minor)
403 drm_dev_unref(minor->dev);
407 * drm_put_dev - Unregister and release a DRM device
410 * Called at module unload time or when a PCI device is unplugged.
412 * Use of this function is discouraged. It will eventually go away completely.
413 * Please use drm_dev_unregister() and drm_dev_unref() explicitly instead.
415 * Cleans up all DRM device, calling drm_lastclose().
417 void drm_put_dev(struct drm_device *dev)
422 DRM_ERROR("cleanup called no dev\n");
426 drm_dev_unregister(dev);
429 EXPORT_SYMBOL(drm_put_dev);
431 void drm_unplug_dev(struct drm_device *dev)
433 /* for a USB device */
434 drm_minor_unregister(dev, DRM_MINOR_LEGACY);
435 drm_minor_unregister(dev, DRM_MINOR_RENDER);
436 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
438 mutex_lock(&drm_global_mutex);
440 drm_device_set_unplugged(dev);
442 if (dev->open_count == 0) {
445 mutex_unlock(&drm_global_mutex);
447 EXPORT_SYMBOL(drm_unplug_dev);
451 * We want to be able to allocate our own "struct address_space" to control
452 * memory-mappings in VRAM (or stolen RAM, ...). However, core MM does not allow
453 * stand-alone address_space objects, so we need an underlying inode. As there
454 * is no way to allocate an independent inode easily, we need a fake internal
457 * The drm_fs_inode_new() function allocates a new inode, drm_fs_inode_free()
458 * frees it again. You are allowed to use iget() and iput() to get references to
459 * the inode. But each drm_fs_inode_new() call must be paired with exactly one
460 * drm_fs_inode_free() call (which does not have to be the last iput()).
461 * We use drm_fs_inode_*() to manage our internal VFS mount-point and share it
462 * between multiple inode-users. You could, technically, call
463 * iget() + drm_fs_inode_free() directly after alloc and sometime later do an
464 * iput(), but this way you'd end up with a new vfsmount for each inode.
467 static int drm_fs_cnt;
468 static struct vfsmount *drm_fs_mnt;
470 static const struct dentry_operations drm_fs_dops = {
471 .d_dname = simple_dname,
474 static const struct super_operations drm_fs_sops = {
475 .statfs = simple_statfs,
478 static struct dentry *drm_fs_mount(struct file_system_type *fs_type, int flags,
479 const char *dev_name, void *data)
481 return mount_pseudo(fs_type,
488 static struct file_system_type drm_fs_type = {
490 .owner = THIS_MODULE,
491 .mount = drm_fs_mount,
492 .kill_sb = kill_anon_super,
495 static struct inode *drm_fs_inode_new(void)
500 r = simple_pin_fs(&drm_fs_type, &drm_fs_mnt, &drm_fs_cnt);
502 DRM_ERROR("Cannot mount pseudo fs: %d\n", r);
506 inode = alloc_anon_inode(drm_fs_mnt->mnt_sb);
508 simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
513 static void drm_fs_inode_free(struct inode *inode)
517 simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
522 * drm_dev_alloc - Allocate new DRM device
523 * @driver: DRM driver to allocate device for
524 * @parent: Parent device object
526 * Allocate and initialize a new DRM device. No device registration is done.
527 * Call drm_dev_register() to advertice the device to user space and register it
528 * with other core subsystems.
530 * The initial ref-count of the object is 1. Use drm_dev_ref() and
531 * drm_dev_unref() to take and drop further ref-counts.
534 * Pointer to new DRM device, or NULL if out of memory.
536 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
537 struct device *parent)
539 struct drm_device *dev;
542 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
546 kref_init(&dev->ref);
548 dev->driver = driver;
550 INIT_LIST_HEAD(&dev->filelist);
551 INIT_LIST_HEAD(&dev->ctxlist);
552 INIT_LIST_HEAD(&dev->vmalist);
553 INIT_LIST_HEAD(&dev->maplist);
554 INIT_LIST_HEAD(&dev->vblank_event_list);
556 spin_lock_init(&dev->buf_lock);
557 spin_lock_init(&dev->event_lock);
558 mutex_init(&dev->struct_mutex);
559 mutex_init(&dev->ctxlist_mutex);
560 mutex_init(&dev->master_mutex);
562 dev->anon_inode = drm_fs_inode_new();
563 if (IS_ERR(dev->anon_inode)) {
564 ret = PTR_ERR(dev->anon_inode);
565 DRM_ERROR("Cannot allocate anonymous inode: %d\n", ret);
569 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
570 ret = drm_minor_alloc(dev, DRM_MINOR_CONTROL);
575 if (drm_core_check_feature(dev, DRIVER_RENDER)) {
576 ret = drm_minor_alloc(dev, DRM_MINOR_RENDER);
581 ret = drm_minor_alloc(dev, DRM_MINOR_LEGACY);
585 if (drm_ht_create(&dev->map_hash, 12))
588 ret = drm_ctxbitmap_init(dev);
590 DRM_ERROR("Cannot allocate memory for context bitmap.\n");
594 if (driver->driver_features & DRIVER_GEM) {
595 ret = drm_gem_init(dev);
597 DRM_ERROR("Cannot initialize graphics execution manager (GEM)\n");
605 drm_ctxbitmap_cleanup(dev);
607 drm_ht_remove(&dev->map_hash);
609 drm_minor_free(dev, DRM_MINOR_LEGACY);
610 drm_minor_free(dev, DRM_MINOR_RENDER);
611 drm_minor_free(dev, DRM_MINOR_CONTROL);
612 drm_fs_inode_free(dev->anon_inode);
614 mutex_destroy(&dev->master_mutex);
618 EXPORT_SYMBOL(drm_dev_alloc);
620 static void drm_dev_release(struct kref *ref)
622 struct drm_device *dev = container_of(ref, struct drm_device, ref);
624 if (dev->driver->driver_features & DRIVER_GEM)
625 drm_gem_destroy(dev);
627 drm_ctxbitmap_cleanup(dev);
628 drm_ht_remove(&dev->map_hash);
629 drm_fs_inode_free(dev->anon_inode);
631 drm_minor_free(dev, DRM_MINOR_LEGACY);
632 drm_minor_free(dev, DRM_MINOR_RENDER);
633 drm_minor_free(dev, DRM_MINOR_CONTROL);
635 mutex_destroy(&dev->master_mutex);
641 * drm_dev_ref - Take reference of a DRM device
642 * @dev: device to take reference of or NULL
644 * This increases the ref-count of @dev by one. You *must* already own a
645 * reference when calling this. Use drm_dev_unref() to drop this reference
648 * This function never fails. However, this function does not provide *any*
649 * guarantee whether the device is alive or running. It only provides a
650 * reference to the object and the memory associated with it.
652 void drm_dev_ref(struct drm_device *dev)
657 EXPORT_SYMBOL(drm_dev_ref);
660 * drm_dev_unref - Drop reference of a DRM device
661 * @dev: device to drop reference of or NULL
663 * This decreases the ref-count of @dev by one. The device is destroyed if the
664 * ref-count drops to zero.
666 void drm_dev_unref(struct drm_device *dev)
669 kref_put(&dev->ref, drm_dev_release);
671 EXPORT_SYMBOL(drm_dev_unref);
674 * drm_dev_register - Register DRM device
675 * @dev: Device to register
676 * @flags: Flags passed to the driver's .load() function
678 * Register the DRM device @dev with the system, advertise device to user-space
679 * and start normal device operation. @dev must be allocated via drm_dev_alloc()
682 * Never call this twice on any device!
685 * 0 on success, negative error code on failure.
687 int drm_dev_register(struct drm_device *dev, unsigned long flags)
691 mutex_lock(&drm_global_mutex);
693 ret = drm_minor_register(dev, DRM_MINOR_CONTROL);
697 ret = drm_minor_register(dev, DRM_MINOR_RENDER);
701 ret = drm_minor_register(dev, DRM_MINOR_LEGACY);
705 if (dev->driver->load) {
706 ret = dev->driver->load(dev, flags);
711 /* setup grouping for legacy outputs */
712 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
713 ret = drm_mode_group_init_legacy_group(dev,
714 &dev->primary->mode_group);
723 if (dev->driver->unload)
724 dev->driver->unload(dev);
726 drm_minor_unregister(dev, DRM_MINOR_LEGACY);
727 drm_minor_unregister(dev, DRM_MINOR_RENDER);
728 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
730 mutex_unlock(&drm_global_mutex);
733 EXPORT_SYMBOL(drm_dev_register);
736 * drm_dev_unregister - Unregister DRM device
737 * @dev: Device to unregister
739 * Unregister the DRM device from the system. This does the reverse of
740 * drm_dev_register() but does not deallocate the device. The caller must call
741 * drm_dev_unref() to drop their final reference.
743 void drm_dev_unregister(struct drm_device *dev)
745 struct drm_map_list *r_list, *list_temp;
749 if (dev->driver->unload)
750 dev->driver->unload(dev);
753 drm_pci_agp_destroy(dev);
755 drm_vblank_cleanup(dev);
757 list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head)
758 drm_rmmap(dev, r_list->map);
760 drm_minor_unregister(dev, DRM_MINOR_LEGACY);
761 drm_minor_unregister(dev, DRM_MINOR_RENDER);
762 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
764 EXPORT_SYMBOL(drm_dev_unregister);
767 * drm_dev_set_unique - Set the unique name of a DRM device
768 * @dev: device of which to set the unique name
769 * @fmt: format string for unique name
771 * Sets the unique name of a DRM device using the specified format string and
772 * a variable list of arguments. Drivers can use this at driver probe time if
773 * the unique name of the devices they drive is static.
775 * Return: 0 on success or a negative error code on failure.
777 int drm_dev_set_unique(struct drm_device *dev, const char *fmt, ...)
784 dev->unique = kvasprintf(GFP_KERNEL, fmt, ap);
787 return dev->unique ? 0 : -ENOMEM;
789 EXPORT_SYMBOL(drm_dev_set_unique);