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.
34 #include <linux/module.h>
35 #include <linux/moduleparam.h>
36 #include <linux/slab.h>
38 #include <drm/drm_core.h>
40 unsigned int drm_debug = 0; /* 1 to enable debug output */
41 EXPORT_SYMBOL(drm_debug);
43 unsigned int drm_rnodes = 0; /* 1 to enable experimental render nodes API */
44 EXPORT_SYMBOL(drm_rnodes);
46 unsigned int drm_vblank_offdelay = 5000; /* Default to 5000 msecs. */
47 EXPORT_SYMBOL(drm_vblank_offdelay);
49 unsigned int drm_timestamp_precision = 20; /* Default to 20 usecs. */
50 EXPORT_SYMBOL(drm_timestamp_precision);
53 * Default to use monotonic timestamps for wait-for-vblank and page-flip
56 unsigned int drm_timestamp_monotonic = 1;
58 MODULE_AUTHOR(CORE_AUTHOR);
59 MODULE_DESCRIPTION(CORE_DESC);
60 MODULE_LICENSE("GPL and additional rights");
61 MODULE_PARM_DESC(debug, "Enable debug output");
62 MODULE_PARM_DESC(rnodes, "Enable experimental render nodes API");
63 MODULE_PARM_DESC(vblankoffdelay, "Delay until vblank irq auto-disable [msecs]");
64 MODULE_PARM_DESC(timestamp_precision_usec, "Max. error on timestamps [usecs]");
65 MODULE_PARM_DESC(timestamp_monotonic, "Use monotonic timestamps");
67 module_param_named(debug, drm_debug, int, 0600);
68 module_param_named(rnodes, drm_rnodes, int, 0600);
69 module_param_named(vblankoffdelay, drm_vblank_offdelay, int, 0600);
70 module_param_named(timestamp_precision_usec, drm_timestamp_precision, int, 0600);
71 module_param_named(timestamp_monotonic, drm_timestamp_monotonic, int, 0600);
73 struct idr drm_minors_idr;
75 struct class *drm_class;
76 struct dentry *drm_debugfs_root;
78 int drm_err(const char *func, const char *format, ...)
84 va_start(args, format);
89 r = printk(KERN_ERR "[" DRM_NAME ":%s] *ERROR* %pV", func, &vaf);
95 EXPORT_SYMBOL(drm_err);
97 void drm_ut_debug_printk(unsigned int request_level,
99 const char *function_name,
100 const char *format, ...)
102 struct va_format vaf;
105 if (drm_debug & request_level) {
106 va_start(args, format);
111 printk(KERN_DEBUG "[%s:%s], %pV", prefix,
112 function_name, &vaf);
114 printk(KERN_DEBUG "%pV", &vaf);
118 EXPORT_SYMBOL(drm_ut_debug_printk);
120 static int drm_minor_get_id(struct drm_device *dev, int type)
123 int base = 0, limit = 63;
125 if (type == DRM_MINOR_CONTROL) {
128 } else if (type == DRM_MINOR_RENDER) {
133 mutex_lock(&dev->struct_mutex);
134 ret = idr_alloc(&drm_minors_idr, NULL, base, limit, GFP_KERNEL);
135 mutex_unlock(&dev->struct_mutex);
137 return ret == -ENOSPC ? -EINVAL : ret;
140 struct drm_master *drm_master_create(struct drm_minor *minor)
142 struct drm_master *master;
144 master = kzalloc(sizeof(*master), GFP_KERNEL);
148 kref_init(&master->refcount);
149 spin_lock_init(&master->lock.spinlock);
150 init_waitqueue_head(&master->lock.lock_queue);
151 drm_ht_create(&master->magiclist, DRM_MAGIC_HASH_ORDER);
152 INIT_LIST_HEAD(&master->magicfree);
153 master->minor = minor;
155 list_add_tail(&master->head, &minor->master_list);
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 list_del(&master->head);
176 if (dev->driver->master_destroy)
177 dev->driver->master_destroy(dev, master);
179 list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head) {
180 if (r_list->master == master) {
181 drm_rmmap_locked(dev, r_list->map);
186 if (master->unique) {
187 kfree(master->unique);
188 master->unique = NULL;
189 master->unique_len = 0;
195 list_for_each_entry_safe(pt, next, &master->magicfree, head) {
197 drm_ht_remove_item(&master->magiclist, &pt->hash_item);
201 drm_ht_remove(&master->magiclist);
206 void drm_master_put(struct drm_master **master)
208 kref_put(&(*master)->refcount, drm_master_destroy);
211 EXPORT_SYMBOL(drm_master_put);
213 int drm_setmaster_ioctl(struct drm_device *dev, void *data,
214 struct drm_file *file_priv)
218 if (file_priv->is_master)
221 if (file_priv->minor->master && file_priv->minor->master != file_priv->master)
224 if (!file_priv->master)
227 if (file_priv->minor->master)
230 mutex_lock(&dev->struct_mutex);
231 file_priv->minor->master = drm_master_get(file_priv->master);
232 file_priv->is_master = 1;
233 if (dev->driver->master_set) {
234 ret = dev->driver->master_set(dev, file_priv, false);
235 if (unlikely(ret != 0)) {
236 file_priv->is_master = 0;
237 drm_master_put(&file_priv->minor->master);
240 mutex_unlock(&dev->struct_mutex);
245 int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
246 struct drm_file *file_priv)
248 if (!file_priv->is_master)
251 if (!file_priv->minor->master)
254 mutex_lock(&dev->struct_mutex);
255 if (dev->driver->master_drop)
256 dev->driver->master_drop(dev, file_priv, false);
257 drm_master_put(&file_priv->minor->master);
258 file_priv->is_master = 0;
259 mutex_unlock(&dev->struct_mutex);
263 static struct drm_minor **drm_minor_get_slot(struct drm_device *dev,
267 case DRM_MINOR_LEGACY:
268 return &dev->primary;
269 case DRM_MINOR_RENDER:
271 case DRM_MINOR_CONTROL:
272 return &dev->control;
278 static int drm_minor_alloc(struct drm_device *dev, unsigned int type)
280 struct drm_minor *minor;
282 minor = kzalloc(sizeof(*minor), GFP_KERNEL);
288 INIT_LIST_HEAD(&minor->master_list);
290 *drm_minor_get_slot(dev, type) = minor;
295 * drm_get_minor - Register DRM minor
297 * @type: Type of minor
299 * Register minor of given type.
300 * Caller must hold the global DRM mutex.
303 * 0 on success, negative error code on failure.
305 static int drm_get_minor(struct drm_device *dev, unsigned int type)
307 struct drm_minor *new_minor;
313 new_minor = *drm_minor_get_slot(dev, type);
317 minor_id = drm_minor_get_id(dev, type);
321 new_minor->device = MKDEV(DRM_MAJOR, minor_id);
322 new_minor->index = minor_id;
324 idr_replace(&drm_minors_idr, new_minor, minor_id);
326 #if defined(CONFIG_DEBUG_FS)
327 ret = drm_debugfs_init(new_minor, minor_id, drm_debugfs_root);
329 DRM_ERROR("DRM: Failed to initialize /sys/kernel/debug/dri.\n");
334 ret = drm_sysfs_device_add(new_minor);
337 "DRM: Error sysfs_device_add.\n");
341 DRM_DEBUG("new minor assigned %d\n", minor_id);
346 #if defined(CONFIG_DEBUG_FS)
347 drm_debugfs_cleanup(new_minor);
350 idr_remove(&drm_minors_idr, minor_id);
355 * drm_unplug_minor - Unplug DRM minor
356 * @minor: Minor to unplug
358 * Unplugs the given DRM minor but keeps the object. So after this returns,
359 * minor->dev is still valid so existing open-files can still access it to get
360 * device information from their drm_file ojects.
361 * If the minor is already unplugged or if @minor is NULL, nothing is done.
362 * The global DRM mutex must be held by the caller.
364 static void drm_unplug_minor(struct drm_minor *minor)
366 if (!minor || !minor->kdev)
369 #if defined(CONFIG_DEBUG_FS)
370 drm_debugfs_cleanup(minor);
373 drm_sysfs_device_remove(minor);
374 idr_remove(&drm_minors_idr, minor->index);
378 * drm_minor_acquire - Acquire a DRM minor
379 * @minor_id: Minor ID of the DRM-minor
381 * Looks up the given minor-ID and returns the respective DRM-minor object. The
382 * refence-count of the underlying device is increased so you must release this
383 * object with drm_minor_release().
385 * As long as you hold this minor, it is guaranteed that the object and the
386 * minor->dev pointer will stay valid! However, the device may get unplugged and
387 * unregistered while you hold the minor.
390 * Pointer to minor-object with increased device-refcount, or PTR_ERR on
393 struct drm_minor *drm_minor_acquire(unsigned int minor_id)
395 struct drm_minor *minor;
397 minor = idr_find(&drm_minors_idr, minor_id);
399 return ERR_PTR(-ENODEV);
401 drm_dev_ref(minor->dev);
406 * drm_minor_release - Release DRM minor
407 * @minor: Pointer to DRM minor object
409 * Release a minor that was previously acquired via drm_minor_acquire().
411 void drm_minor_release(struct drm_minor *minor)
413 drm_dev_unref(minor->dev);
417 * drm_put_minor - Destroy DRM minor
418 * @minor: Minor to destroy
420 * This calls drm_unplug_minor() on the given minor and then frees it. Nothing
421 * is done if @minor is NULL. It is fine to call this on already unplugged
423 * The global DRM mutex must be held by the caller.
425 static void drm_put_minor(struct drm_minor *minor)
430 DRM_DEBUG("release secondary minor %d\n", minor->index);
432 drm_unplug_minor(minor);
437 * Called via drm_exit() at module unload time or when pci device is
440 * Cleans up all DRM device, calling drm_lastclose().
443 void drm_put_dev(struct drm_device *dev)
448 DRM_ERROR("cleanup called no dev\n");
452 drm_dev_unregister(dev);
455 EXPORT_SYMBOL(drm_put_dev);
457 void drm_unplug_dev(struct drm_device *dev)
459 /* for a USB device */
460 if (drm_core_check_feature(dev, DRIVER_MODESET))
461 drm_unplug_minor(dev->control);
463 drm_unplug_minor(dev->render);
464 drm_unplug_minor(dev->primary);
466 mutex_lock(&drm_global_mutex);
468 drm_device_set_unplugged(dev);
470 if (dev->open_count == 0) {
473 mutex_unlock(&drm_global_mutex);
475 EXPORT_SYMBOL(drm_unplug_dev);
478 * drm_dev_alloc - Allocate new drm device
479 * @driver: DRM driver to allocate device for
480 * @parent: Parent device object
482 * Allocate and initialize a new DRM device. No device registration is done.
483 * Call drm_dev_register() to advertice the device to user space and register it
484 * with other core subsystems.
486 * The initial ref-count of the object is 1. Use drm_dev_ref() and
487 * drm_dev_unref() to take and drop further ref-counts.
490 * Pointer to new DRM device, or NULL if out of memory.
492 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
493 struct device *parent)
495 struct drm_device *dev;
498 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
502 kref_init(&dev->ref);
504 dev->driver = driver;
506 INIT_LIST_HEAD(&dev->filelist);
507 INIT_LIST_HEAD(&dev->ctxlist);
508 INIT_LIST_HEAD(&dev->vmalist);
509 INIT_LIST_HEAD(&dev->maplist);
510 INIT_LIST_HEAD(&dev->vblank_event_list);
512 spin_lock_init(&dev->count_lock);
513 spin_lock_init(&dev->event_lock);
514 mutex_init(&dev->struct_mutex);
515 mutex_init(&dev->ctxlist_mutex);
517 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
518 ret = drm_minor_alloc(dev, DRM_MINOR_CONTROL);
523 if (drm_core_check_feature(dev, DRIVER_RENDER) && drm_rnodes) {
524 ret = drm_minor_alloc(dev, DRM_MINOR_RENDER);
529 ret = drm_minor_alloc(dev, DRM_MINOR_LEGACY);
533 if (drm_ht_create(&dev->map_hash, 12))
536 ret = drm_ctxbitmap_init(dev);
538 DRM_ERROR("Cannot allocate memory for context bitmap.\n");
542 if (driver->driver_features & DRIVER_GEM) {
543 ret = drm_gem_init(dev);
545 DRM_ERROR("Cannot initialize graphics execution manager (GEM)\n");
553 drm_ctxbitmap_cleanup(dev);
555 drm_ht_remove(&dev->map_hash);
557 drm_put_minor(dev->control);
558 drm_put_minor(dev->render);
559 drm_put_minor(dev->primary);
563 EXPORT_SYMBOL(drm_dev_alloc);
565 static void drm_dev_release(struct kref *ref)
567 struct drm_device *dev = container_of(ref, struct drm_device, ref);
569 drm_put_minor(dev->control);
570 drm_put_minor(dev->render);
571 drm_put_minor(dev->primary);
573 if (dev->driver->driver_features & DRIVER_GEM)
574 drm_gem_destroy(dev);
576 drm_ctxbitmap_cleanup(dev);
577 drm_ht_remove(&dev->map_hash);
584 * drm_dev_ref - Take reference of a DRM device
585 * @dev: device to take reference of or NULL
587 * This increases the ref-count of @dev by one. You *must* already own a
588 * reference when calling this. Use drm_dev_unref() to drop this reference
591 * This function never fails. However, this function does not provide *any*
592 * guarantee whether the device is alive or running. It only provides a
593 * reference to the object and the memory associated with it.
595 void drm_dev_ref(struct drm_device *dev)
600 EXPORT_SYMBOL(drm_dev_ref);
603 * drm_dev_unref - Drop reference of a DRM device
604 * @dev: device to drop reference of or NULL
606 * This decreases the ref-count of @dev by one. The device is destroyed if the
607 * ref-count drops to zero.
609 void drm_dev_unref(struct drm_device *dev)
612 kref_put(&dev->ref, drm_dev_release);
614 EXPORT_SYMBOL(drm_dev_unref);
617 * drm_dev_register - Register DRM device
618 * @dev: Device to register
620 * Register the DRM device @dev with the system, advertise device to user-space
621 * and start normal device operation. @dev must be allocated via drm_dev_alloc()
624 * Never call this twice on any device!
627 * 0 on success, negative error code on failure.
629 int drm_dev_register(struct drm_device *dev, unsigned long flags)
633 mutex_lock(&drm_global_mutex);
635 ret = drm_get_minor(dev, DRM_MINOR_CONTROL);
639 ret = drm_get_minor(dev, DRM_MINOR_RENDER);
643 ret = drm_get_minor(dev, DRM_MINOR_LEGACY);
647 if (dev->driver->load) {
648 ret = dev->driver->load(dev, flags);
653 /* setup grouping for legacy outputs */
654 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
655 ret = drm_mode_group_init_legacy_group(dev,
656 &dev->primary->mode_group);
665 if (dev->driver->unload)
666 dev->driver->unload(dev);
668 drm_unplug_minor(dev->control);
669 drm_unplug_minor(dev->render);
670 drm_unplug_minor(dev->primary);
672 mutex_unlock(&drm_global_mutex);
675 EXPORT_SYMBOL(drm_dev_register);
678 * drm_dev_unregister - Unregister DRM device
679 * @dev: Device to unregister
681 * Unregister the DRM device from the system. This does the reverse of
682 * drm_dev_register() but does not deallocate the device. The caller must call
683 * drm_dev_unref() to drop their final reference.
685 void drm_dev_unregister(struct drm_device *dev)
687 struct drm_map_list *r_list, *list_temp;
691 if (dev->driver->unload)
692 dev->driver->unload(dev);
695 drm_pci_agp_destroy(dev);
697 drm_vblank_cleanup(dev);
699 list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head)
700 drm_rmmap(dev, r_list->map);
702 drm_unplug_minor(dev->control);
703 drm_unplug_minor(dev->render);
704 drm_unplug_minor(dev->primary);
706 EXPORT_SYMBOL(drm_dev_unregister);