xref: /openbmc/linux/drivers/gpu/drm/drm_drv.c (revision a8da474e)
1 /*
2  * Created: Fri Jan 19 10:48:35 2001 by faith@acm.org
3  *
4  * Copyright 2001 VA Linux Systems, Inc., Sunnyvale, California.
5  * All Rights Reserved.
6  *
7  * Author Rickard E. (Rik) Faith <faith@valinux.com>
8  *
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:
15  *
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
18  * Software.
19  *
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.
27  */
28 
29 #include <linux/debugfs.h>
30 #include <linux/fs.h>
31 #include <linux/module.h>
32 #include <linux/moduleparam.h>
33 #include <linux/mount.h>
34 #include <linux/slab.h>
35 #include <drm/drmP.h>
36 #include <drm/drm_core.h>
37 #include "drm_legacy.h"
38 #include "drm_internal.h"
39 
40 unsigned int drm_debug = 0;	/* bitmask of DRM_UT_x */
41 EXPORT_SYMBOL(drm_debug);
42 
43 MODULE_AUTHOR(CORE_AUTHOR);
44 MODULE_DESCRIPTION(CORE_DESC);
45 MODULE_LICENSE("GPL and additional rights");
46 MODULE_PARM_DESC(debug, "Enable debug output");
47 MODULE_PARM_DESC(vblankoffdelay, "Delay until vblank irq auto-disable [msecs] (0: never disable, <0: disable immediately)");
48 MODULE_PARM_DESC(timestamp_precision_usec, "Max. error on timestamps [usecs]");
49 MODULE_PARM_DESC(timestamp_monotonic, "Use monotonic timestamps");
50 
51 module_param_named(debug, drm_debug, int, 0600);
52 
53 static DEFINE_SPINLOCK(drm_minor_lock);
54 static struct idr drm_minors_idr;
55 
56 static struct dentry *drm_debugfs_root;
57 
58 void drm_err(const char *format, ...)
59 {
60 	struct va_format vaf;
61 	va_list args;
62 
63 	va_start(args, format);
64 
65 	vaf.fmt = format;
66 	vaf.va = &args;
67 
68 	printk(KERN_ERR "[" DRM_NAME ":%ps] *ERROR* %pV",
69 	       __builtin_return_address(0), &vaf);
70 
71 	va_end(args);
72 }
73 EXPORT_SYMBOL(drm_err);
74 
75 void drm_ut_debug_printk(const char *function_name, const char *format, ...)
76 {
77 	struct va_format vaf;
78 	va_list args;
79 
80 	va_start(args, format);
81 	vaf.fmt = format;
82 	vaf.va = &args;
83 
84 	printk(KERN_DEBUG "[" DRM_NAME ":%s] %pV", function_name, &vaf);
85 
86 	va_end(args);
87 }
88 EXPORT_SYMBOL(drm_ut_debug_printk);
89 
90 struct drm_master *drm_master_create(struct drm_minor *minor)
91 {
92 	struct drm_master *master;
93 
94 	master = kzalloc(sizeof(*master), GFP_KERNEL);
95 	if (!master)
96 		return NULL;
97 
98 	kref_init(&master->refcount);
99 	spin_lock_init(&master->lock.spinlock);
100 	init_waitqueue_head(&master->lock.lock_queue);
101 	idr_init(&master->magic_map);
102 	master->minor = minor;
103 
104 	return master;
105 }
106 
107 struct drm_master *drm_master_get(struct drm_master *master)
108 {
109 	kref_get(&master->refcount);
110 	return master;
111 }
112 EXPORT_SYMBOL(drm_master_get);
113 
114 static void drm_master_destroy(struct kref *kref)
115 {
116 	struct drm_master *master = container_of(kref, struct drm_master, refcount);
117 	struct drm_device *dev = master->minor->dev;
118 	struct drm_map_list *r_list, *list_temp;
119 
120 	mutex_lock(&dev->struct_mutex);
121 	if (dev->driver->master_destroy)
122 		dev->driver->master_destroy(dev, master);
123 
124 	list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head) {
125 		if (r_list->master == master) {
126 			drm_legacy_rmmap_locked(dev, r_list->map);
127 			r_list = NULL;
128 		}
129 	}
130 	mutex_unlock(&dev->struct_mutex);
131 
132 	idr_destroy(&master->magic_map);
133 	kfree(master->unique);
134 	kfree(master);
135 }
136 
137 void drm_master_put(struct drm_master **master)
138 {
139 	kref_put(&(*master)->refcount, drm_master_destroy);
140 	*master = NULL;
141 }
142 EXPORT_SYMBOL(drm_master_put);
143 
144 int drm_setmaster_ioctl(struct drm_device *dev, void *data,
145 			struct drm_file *file_priv)
146 {
147 	int ret = 0;
148 
149 	mutex_lock(&dev->master_mutex);
150 	if (file_priv->is_master)
151 		goto out_unlock;
152 
153 	if (file_priv->minor->master) {
154 		ret = -EINVAL;
155 		goto out_unlock;
156 	}
157 
158 	if (!file_priv->master) {
159 		ret = -EINVAL;
160 		goto out_unlock;
161 	}
162 
163 	file_priv->minor->master = drm_master_get(file_priv->master);
164 	file_priv->is_master = 1;
165 	if (dev->driver->master_set) {
166 		ret = dev->driver->master_set(dev, file_priv, false);
167 		if (unlikely(ret != 0)) {
168 			file_priv->is_master = 0;
169 			drm_master_put(&file_priv->minor->master);
170 		}
171 	}
172 
173 out_unlock:
174 	mutex_unlock(&dev->master_mutex);
175 	return ret;
176 }
177 
178 int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
179 			 struct drm_file *file_priv)
180 {
181 	int ret = -EINVAL;
182 
183 	mutex_lock(&dev->master_mutex);
184 	if (!file_priv->is_master)
185 		goto out_unlock;
186 
187 	if (!file_priv->minor->master)
188 		goto out_unlock;
189 
190 	ret = 0;
191 	if (dev->driver->master_drop)
192 		dev->driver->master_drop(dev, file_priv, false);
193 	drm_master_put(&file_priv->minor->master);
194 	file_priv->is_master = 0;
195 
196 out_unlock:
197 	mutex_unlock(&dev->master_mutex);
198 	return ret;
199 }
200 
201 /*
202  * DRM Minors
203  * A DRM device can provide several char-dev interfaces on the DRM-Major. Each
204  * of them is represented by a drm_minor object. Depending on the capabilities
205  * of the device-driver, different interfaces are registered.
206  *
207  * Minors can be accessed via dev->$minor_name. This pointer is either
208  * NULL or a valid drm_minor pointer and stays valid as long as the device is
209  * valid. This means, DRM minors have the same life-time as the underlying
210  * device. However, this doesn't mean that the minor is active. Minors are
211  * registered and unregistered dynamically according to device-state.
212  */
213 
214 static struct drm_minor **drm_minor_get_slot(struct drm_device *dev,
215 					     unsigned int type)
216 {
217 	switch (type) {
218 	case DRM_MINOR_LEGACY:
219 		return &dev->primary;
220 	case DRM_MINOR_RENDER:
221 		return &dev->render;
222 	case DRM_MINOR_CONTROL:
223 		return &dev->control;
224 	default:
225 		return NULL;
226 	}
227 }
228 
229 static int drm_minor_alloc(struct drm_device *dev, unsigned int type)
230 {
231 	struct drm_minor *minor;
232 	unsigned long flags;
233 	int r;
234 
235 	minor = kzalloc(sizeof(*minor), GFP_KERNEL);
236 	if (!minor)
237 		return -ENOMEM;
238 
239 	minor->type = type;
240 	minor->dev = dev;
241 
242 	idr_preload(GFP_KERNEL);
243 	spin_lock_irqsave(&drm_minor_lock, flags);
244 	r = idr_alloc(&drm_minors_idr,
245 		      NULL,
246 		      64 * type,
247 		      64 * (type + 1),
248 		      GFP_NOWAIT);
249 	spin_unlock_irqrestore(&drm_minor_lock, flags);
250 	idr_preload_end();
251 
252 	if (r < 0)
253 		goto err_free;
254 
255 	minor->index = r;
256 
257 	minor->kdev = drm_sysfs_minor_alloc(minor);
258 	if (IS_ERR(minor->kdev)) {
259 		r = PTR_ERR(minor->kdev);
260 		goto err_index;
261 	}
262 
263 	*drm_minor_get_slot(dev, type) = minor;
264 	return 0;
265 
266 err_index:
267 	spin_lock_irqsave(&drm_minor_lock, flags);
268 	idr_remove(&drm_minors_idr, minor->index);
269 	spin_unlock_irqrestore(&drm_minor_lock, flags);
270 err_free:
271 	kfree(minor);
272 	return r;
273 }
274 
275 static void drm_minor_free(struct drm_device *dev, unsigned int type)
276 {
277 	struct drm_minor **slot, *minor;
278 	unsigned long flags;
279 
280 	slot = drm_minor_get_slot(dev, type);
281 	minor = *slot;
282 	if (!minor)
283 		return;
284 
285 	put_device(minor->kdev);
286 
287 	spin_lock_irqsave(&drm_minor_lock, flags);
288 	idr_remove(&drm_minors_idr, minor->index);
289 	spin_unlock_irqrestore(&drm_minor_lock, flags);
290 
291 	kfree(minor);
292 	*slot = NULL;
293 }
294 
295 static int drm_minor_register(struct drm_device *dev, unsigned int type)
296 {
297 	struct drm_minor *minor;
298 	unsigned long flags;
299 	int ret;
300 
301 	DRM_DEBUG("\n");
302 
303 	minor = *drm_minor_get_slot(dev, type);
304 	if (!minor)
305 		return 0;
306 
307 	ret = drm_debugfs_init(minor, minor->index, drm_debugfs_root);
308 	if (ret) {
309 		DRM_ERROR("DRM: Failed to initialize /sys/kernel/debug/dri.\n");
310 		return ret;
311 	}
312 
313 	ret = device_add(minor->kdev);
314 	if (ret)
315 		goto err_debugfs;
316 
317 	/* replace NULL with @minor so lookups will succeed from now on */
318 	spin_lock_irqsave(&drm_minor_lock, flags);
319 	idr_replace(&drm_minors_idr, minor, minor->index);
320 	spin_unlock_irqrestore(&drm_minor_lock, flags);
321 
322 	DRM_DEBUG("new minor registered %d\n", minor->index);
323 	return 0;
324 
325 err_debugfs:
326 	drm_debugfs_cleanup(minor);
327 	return ret;
328 }
329 
330 static void drm_minor_unregister(struct drm_device *dev, unsigned int type)
331 {
332 	struct drm_minor *minor;
333 	unsigned long flags;
334 
335 	minor = *drm_minor_get_slot(dev, type);
336 	if (!minor || !device_is_registered(minor->kdev))
337 		return;
338 
339 	/* replace @minor with NULL so lookups will fail from now on */
340 	spin_lock_irqsave(&drm_minor_lock, flags);
341 	idr_replace(&drm_minors_idr, NULL, minor->index);
342 	spin_unlock_irqrestore(&drm_minor_lock, flags);
343 
344 	device_del(minor->kdev);
345 	dev_set_drvdata(minor->kdev, NULL); /* safety belt */
346 	drm_debugfs_cleanup(minor);
347 }
348 
349 /**
350  * drm_minor_acquire - Acquire a DRM minor
351  * @minor_id: Minor ID of the DRM-minor
352  *
353  * Looks up the given minor-ID and returns the respective DRM-minor object. The
354  * refence-count of the underlying device is increased so you must release this
355  * object with drm_minor_release().
356  *
357  * As long as you hold this minor, it is guaranteed that the object and the
358  * minor->dev pointer will stay valid! However, the device may get unplugged and
359  * unregistered while you hold the minor.
360  *
361  * Returns:
362  * Pointer to minor-object with increased device-refcount, or PTR_ERR on
363  * failure.
364  */
365 struct drm_minor *drm_minor_acquire(unsigned int minor_id)
366 {
367 	struct drm_minor *minor;
368 	unsigned long flags;
369 
370 	spin_lock_irqsave(&drm_minor_lock, flags);
371 	minor = idr_find(&drm_minors_idr, minor_id);
372 	if (minor)
373 		drm_dev_ref(minor->dev);
374 	spin_unlock_irqrestore(&drm_minor_lock, flags);
375 
376 	if (!minor) {
377 		return ERR_PTR(-ENODEV);
378 	} else if (drm_device_is_unplugged(minor->dev)) {
379 		drm_dev_unref(minor->dev);
380 		return ERR_PTR(-ENODEV);
381 	}
382 
383 	return minor;
384 }
385 
386 /**
387  * drm_minor_release - Release DRM minor
388  * @minor: Pointer to DRM minor object
389  *
390  * Release a minor that was previously acquired via drm_minor_acquire().
391  */
392 void drm_minor_release(struct drm_minor *minor)
393 {
394 	drm_dev_unref(minor->dev);
395 }
396 
397 /**
398  * DOC: driver instance overview
399  *
400  * A device instance for a drm driver is represented by struct &drm_device. This
401  * is allocated with drm_dev_alloc(), usually from bus-specific ->probe()
402  * callbacks implemented by the driver. The driver then needs to initialize all
403  * the various subsystems for the drm device like memory management, vblank
404  * handling, modesetting support and intial output configuration plus obviously
405  * initialize all the corresponding hardware bits. An important part of this is
406  * also calling drm_dev_set_unique() to set the userspace-visible unique name of
407  * this device instance. Finally when everything is up and running and ready for
408  * userspace the device instance can be published using drm_dev_register().
409  *
410  * There is also deprecated support for initalizing device instances using
411  * bus-specific helpers and the ->load() callback. But due to
412  * backwards-compatibility needs the device instance have to be published too
413  * early, which requires unpretty global locking to make safe and is therefore
414  * only support for existing drivers not yet converted to the new scheme.
415  *
416  * When cleaning up a device instance everything needs to be done in reverse:
417  * First unpublish the device instance with drm_dev_unregister(). Then clean up
418  * any other resources allocated at device initialization and drop the driver's
419  * reference to &drm_device using drm_dev_unref().
420  *
421  * Note that the lifetime rules for &drm_device instance has still a lot of
422  * historical baggage. Hence use the reference counting provided by
423  * drm_dev_ref() and drm_dev_unref() only carefully.
424  *
425  * Also note that embedding of &drm_device is currently not (yet) supported (but
426  * it would be easy to add). Drivers can store driver-private data in the
427  * dev_priv field of &drm_device.
428  */
429 
430 /**
431  * drm_put_dev - Unregister and release a DRM device
432  * @dev: DRM device
433  *
434  * Called at module unload time or when a PCI device is unplugged.
435  *
436  * Cleans up all DRM device, calling drm_lastclose().
437  *
438  * Note: Use of this function is deprecated. It will eventually go away
439  * completely.  Please use drm_dev_unregister() and drm_dev_unref() explicitly
440  * instead to make sure that the device isn't userspace accessible any more
441  * while teardown is in progress, ensuring that userspace can't access an
442  * inconsistent state.
443  */
444 void drm_put_dev(struct drm_device *dev)
445 {
446 	DRM_DEBUG("\n");
447 
448 	if (!dev) {
449 		DRM_ERROR("cleanup called no dev\n");
450 		return;
451 	}
452 
453 	drm_dev_unregister(dev);
454 	drm_dev_unref(dev);
455 }
456 EXPORT_SYMBOL(drm_put_dev);
457 
458 void drm_unplug_dev(struct drm_device *dev)
459 {
460 	/* for a USB device */
461 	drm_minor_unregister(dev, DRM_MINOR_LEGACY);
462 	drm_minor_unregister(dev, DRM_MINOR_RENDER);
463 	drm_minor_unregister(dev, DRM_MINOR_CONTROL);
464 
465 	mutex_lock(&drm_global_mutex);
466 
467 	drm_device_set_unplugged(dev);
468 
469 	if (dev->open_count == 0) {
470 		drm_put_dev(dev);
471 	}
472 	mutex_unlock(&drm_global_mutex);
473 }
474 EXPORT_SYMBOL(drm_unplug_dev);
475 
476 /*
477  * DRM internal mount
478  * We want to be able to allocate our own "struct address_space" to control
479  * memory-mappings in VRAM (or stolen RAM, ...). However, core MM does not allow
480  * stand-alone address_space objects, so we need an underlying inode. As there
481  * is no way to allocate an independent inode easily, we need a fake internal
482  * VFS mount-point.
483  *
484  * The drm_fs_inode_new() function allocates a new inode, drm_fs_inode_free()
485  * frees it again. You are allowed to use iget() and iput() to get references to
486  * the inode. But each drm_fs_inode_new() call must be paired with exactly one
487  * drm_fs_inode_free() call (which does not have to be the last iput()).
488  * We use drm_fs_inode_*() to manage our internal VFS mount-point and share it
489  * between multiple inode-users. You could, technically, call
490  * iget() + drm_fs_inode_free() directly after alloc and sometime later do an
491  * iput(), but this way you'd end up with a new vfsmount for each inode.
492  */
493 
494 static int drm_fs_cnt;
495 static struct vfsmount *drm_fs_mnt;
496 
497 static const struct dentry_operations drm_fs_dops = {
498 	.d_dname	= simple_dname,
499 };
500 
501 static const struct super_operations drm_fs_sops = {
502 	.statfs		= simple_statfs,
503 };
504 
505 static struct dentry *drm_fs_mount(struct file_system_type *fs_type, int flags,
506 				   const char *dev_name, void *data)
507 {
508 	return mount_pseudo(fs_type,
509 			    "drm:",
510 			    &drm_fs_sops,
511 			    &drm_fs_dops,
512 			    0x010203ff);
513 }
514 
515 static struct file_system_type drm_fs_type = {
516 	.name		= "drm",
517 	.owner		= THIS_MODULE,
518 	.mount		= drm_fs_mount,
519 	.kill_sb	= kill_anon_super,
520 };
521 
522 static struct inode *drm_fs_inode_new(void)
523 {
524 	struct inode *inode;
525 	int r;
526 
527 	r = simple_pin_fs(&drm_fs_type, &drm_fs_mnt, &drm_fs_cnt);
528 	if (r < 0) {
529 		DRM_ERROR("Cannot mount pseudo fs: %d\n", r);
530 		return ERR_PTR(r);
531 	}
532 
533 	inode = alloc_anon_inode(drm_fs_mnt->mnt_sb);
534 	if (IS_ERR(inode))
535 		simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
536 
537 	return inode;
538 }
539 
540 static void drm_fs_inode_free(struct inode *inode)
541 {
542 	if (inode) {
543 		iput(inode);
544 		simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
545 	}
546 }
547 
548 /**
549  * drm_dev_alloc - Allocate new DRM device
550  * @driver: DRM driver to allocate device for
551  * @parent: Parent device object
552  *
553  * Allocate and initialize a new DRM device. No device registration is done.
554  * Call drm_dev_register() to advertice the device to user space and register it
555  * with other core subsystems. This should be done last in the device
556  * initialization sequence to make sure userspace can't access an inconsistent
557  * state.
558  *
559  * The initial ref-count of the object is 1. Use drm_dev_ref() and
560  * drm_dev_unref() to take and drop further ref-counts.
561  *
562  * Note that for purely virtual devices @parent can be NULL.
563  *
564  * RETURNS:
565  * Pointer to new DRM device, or NULL if out of memory.
566  */
567 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
568 				 struct device *parent)
569 {
570 	struct drm_device *dev;
571 	int ret;
572 
573 	dev = kzalloc(sizeof(*dev), GFP_KERNEL);
574 	if (!dev)
575 		return NULL;
576 
577 	kref_init(&dev->ref);
578 	dev->dev = parent;
579 	dev->driver = driver;
580 
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);
586 
587 	spin_lock_init(&dev->buf_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);
592 
593 	dev->anon_inode = drm_fs_inode_new();
594 	if (IS_ERR(dev->anon_inode)) {
595 		ret = PTR_ERR(dev->anon_inode);
596 		DRM_ERROR("Cannot allocate anonymous inode: %d\n", ret);
597 		goto err_free;
598 	}
599 
600 	if (drm_core_check_feature(dev, DRIVER_MODESET)) {
601 		ret = drm_minor_alloc(dev, DRM_MINOR_CONTROL);
602 		if (ret)
603 			goto err_minors;
604 
605 		WARN_ON(driver->suspend || driver->resume);
606 	}
607 
608 	if (drm_core_check_feature(dev, DRIVER_RENDER)) {
609 		ret = drm_minor_alloc(dev, DRM_MINOR_RENDER);
610 		if (ret)
611 			goto err_minors;
612 	}
613 
614 	ret = drm_minor_alloc(dev, DRM_MINOR_LEGACY);
615 	if (ret)
616 		goto err_minors;
617 
618 	if (drm_ht_create(&dev->map_hash, 12))
619 		goto err_minors;
620 
621 	drm_legacy_ctxbitmap_init(dev);
622 
623 	if (drm_core_check_feature(dev, DRIVER_GEM)) {
624 		ret = drm_gem_init(dev);
625 		if (ret) {
626 			DRM_ERROR("Cannot initialize graphics execution manager (GEM)\n");
627 			goto err_ctxbitmap;
628 		}
629 	}
630 
631 	return dev;
632 
633 err_ctxbitmap:
634 	drm_legacy_ctxbitmap_cleanup(dev);
635 	drm_ht_remove(&dev->map_hash);
636 err_minors:
637 	drm_minor_free(dev, DRM_MINOR_LEGACY);
638 	drm_minor_free(dev, DRM_MINOR_RENDER);
639 	drm_minor_free(dev, DRM_MINOR_CONTROL);
640 	drm_fs_inode_free(dev->anon_inode);
641 err_free:
642 	mutex_destroy(&dev->master_mutex);
643 	kfree(dev);
644 	return NULL;
645 }
646 EXPORT_SYMBOL(drm_dev_alloc);
647 
648 static void drm_dev_release(struct kref *ref)
649 {
650 	struct drm_device *dev = container_of(ref, struct drm_device, ref);
651 
652 	if (drm_core_check_feature(dev, DRIVER_GEM))
653 		drm_gem_destroy(dev);
654 
655 	drm_legacy_ctxbitmap_cleanup(dev);
656 	drm_ht_remove(&dev->map_hash);
657 	drm_fs_inode_free(dev->anon_inode);
658 
659 	drm_minor_free(dev, DRM_MINOR_LEGACY);
660 	drm_minor_free(dev, DRM_MINOR_RENDER);
661 	drm_minor_free(dev, DRM_MINOR_CONTROL);
662 
663 	mutex_destroy(&dev->master_mutex);
664 	kfree(dev->unique);
665 	kfree(dev);
666 }
667 
668 /**
669  * drm_dev_ref - Take reference of a DRM device
670  * @dev: device to take reference of or NULL
671  *
672  * This increases the ref-count of @dev by one. You *must* already own a
673  * reference when calling this. Use drm_dev_unref() to drop this reference
674  * again.
675  *
676  * This function never fails. However, this function does not provide *any*
677  * guarantee whether the device is alive or running. It only provides a
678  * reference to the object and the memory associated with it.
679  */
680 void drm_dev_ref(struct drm_device *dev)
681 {
682 	if (dev)
683 		kref_get(&dev->ref);
684 }
685 EXPORT_SYMBOL(drm_dev_ref);
686 
687 /**
688  * drm_dev_unref - Drop reference of a DRM device
689  * @dev: device to drop reference of or NULL
690  *
691  * This decreases the ref-count of @dev by one. The device is destroyed if the
692  * ref-count drops to zero.
693  */
694 void drm_dev_unref(struct drm_device *dev)
695 {
696 	if (dev)
697 		kref_put(&dev->ref, drm_dev_release);
698 }
699 EXPORT_SYMBOL(drm_dev_unref);
700 
701 /**
702  * drm_dev_register - Register DRM device
703  * @dev: Device to register
704  * @flags: Flags passed to the driver's .load() function
705  *
706  * Register the DRM device @dev with the system, advertise device to user-space
707  * and start normal device operation. @dev must be allocated via drm_dev_alloc()
708  * previously.
709  *
710  * Never call this twice on any device!
711  *
712  * NOTE: To ensure backward compatibility with existing drivers method this
713  * function calls the ->load() method after registering the device nodes,
714  * creating race conditions. Usage of the ->load() methods is therefore
715  * deprecated, drivers must perform all initialization before calling
716  * drm_dev_register().
717  *
718  * RETURNS:
719  * 0 on success, negative error code on failure.
720  */
721 int drm_dev_register(struct drm_device *dev, unsigned long flags)
722 {
723 	int ret;
724 
725 	mutex_lock(&drm_global_mutex);
726 
727 	ret = drm_minor_register(dev, DRM_MINOR_CONTROL);
728 	if (ret)
729 		goto err_minors;
730 
731 	ret = drm_minor_register(dev, DRM_MINOR_RENDER);
732 	if (ret)
733 		goto err_minors;
734 
735 	ret = drm_minor_register(dev, DRM_MINOR_LEGACY);
736 	if (ret)
737 		goto err_minors;
738 
739 	if (dev->driver->load) {
740 		ret = dev->driver->load(dev, flags);
741 		if (ret)
742 			goto err_minors;
743 	}
744 
745 	ret = 0;
746 	goto out_unlock;
747 
748 err_minors:
749 	drm_minor_unregister(dev, DRM_MINOR_LEGACY);
750 	drm_minor_unregister(dev, DRM_MINOR_RENDER);
751 	drm_minor_unregister(dev, DRM_MINOR_CONTROL);
752 out_unlock:
753 	mutex_unlock(&drm_global_mutex);
754 	return ret;
755 }
756 EXPORT_SYMBOL(drm_dev_register);
757 
758 /**
759  * drm_dev_unregister - Unregister DRM device
760  * @dev: Device to unregister
761  *
762  * Unregister the DRM device from the system. This does the reverse of
763  * drm_dev_register() but does not deallocate the device. The caller must call
764  * drm_dev_unref() to drop their final reference.
765  *
766  * This should be called first in the device teardown code to make sure
767  * userspace can't access the device instance any more.
768  */
769 void drm_dev_unregister(struct drm_device *dev)
770 {
771 	struct drm_map_list *r_list, *list_temp;
772 
773 	drm_lastclose(dev);
774 
775 	if (dev->driver->unload)
776 		dev->driver->unload(dev);
777 
778 	if (dev->agp)
779 		drm_pci_agp_destroy(dev);
780 
781 	drm_vblank_cleanup(dev);
782 
783 	list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head)
784 		drm_legacy_rmmap(dev, r_list->map);
785 
786 	drm_minor_unregister(dev, DRM_MINOR_LEGACY);
787 	drm_minor_unregister(dev, DRM_MINOR_RENDER);
788 	drm_minor_unregister(dev, DRM_MINOR_CONTROL);
789 }
790 EXPORT_SYMBOL(drm_dev_unregister);
791 
792 /**
793  * drm_dev_set_unique - Set the unique name of a DRM device
794  * @dev: device of which to set the unique name
795  * @fmt: format string for unique name
796  *
797  * Sets the unique name of a DRM device using the specified format string and
798  * a variable list of arguments. Drivers can use this at driver probe time if
799  * the unique name of the devices they drive is static.
800  *
801  * Return: 0 on success or a negative error code on failure.
802  */
803 int drm_dev_set_unique(struct drm_device *dev, const char *fmt, ...)
804 {
805 	va_list ap;
806 
807 	kfree(dev->unique);
808 
809 	va_start(ap, fmt);
810 	dev->unique = kvasprintf(GFP_KERNEL, fmt, ap);
811 	va_end(ap);
812 
813 	return dev->unique ? 0 : -ENOMEM;
814 }
815 EXPORT_SYMBOL(drm_dev_set_unique);
816 
817 /*
818  * DRM Core
819  * The DRM core module initializes all global DRM objects and makes them
820  * available to drivers. Once setup, drivers can probe their respective
821  * devices.
822  * Currently, core management includes:
823  *  - The "DRM-Global" key/value database
824  *  - Global ID management for connectors
825  *  - DRM major number allocation
826  *  - DRM minor management
827  *  - DRM sysfs class
828  *  - DRM debugfs root
829  *
830  * Furthermore, the DRM core provides dynamic char-dev lookups. For each
831  * interface registered on a DRM device, you can request minor numbers from DRM
832  * core. DRM core takes care of major-number management and char-dev
833  * registration. A stub ->open() callback forwards any open() requests to the
834  * registered minor.
835  */
836 
837 static int drm_stub_open(struct inode *inode, struct file *filp)
838 {
839 	const struct file_operations *new_fops;
840 	struct drm_minor *minor;
841 	int err;
842 
843 	DRM_DEBUG("\n");
844 
845 	mutex_lock(&drm_global_mutex);
846 	minor = drm_minor_acquire(iminor(inode));
847 	if (IS_ERR(minor)) {
848 		err = PTR_ERR(minor);
849 		goto out_unlock;
850 	}
851 
852 	new_fops = fops_get(minor->dev->driver->fops);
853 	if (!new_fops) {
854 		err = -ENODEV;
855 		goto out_release;
856 	}
857 
858 	replace_fops(filp, new_fops);
859 	if (filp->f_op->open)
860 		err = filp->f_op->open(inode, filp);
861 	else
862 		err = 0;
863 
864 out_release:
865 	drm_minor_release(minor);
866 out_unlock:
867 	mutex_unlock(&drm_global_mutex);
868 	return err;
869 }
870 
871 static const struct file_operations drm_stub_fops = {
872 	.owner = THIS_MODULE,
873 	.open = drm_stub_open,
874 	.llseek = noop_llseek,
875 };
876 
877 static int __init drm_core_init(void)
878 {
879 	int ret = -ENOMEM;
880 
881 	drm_global_init();
882 	drm_connector_ida_init();
883 	idr_init(&drm_minors_idr);
884 
885 	if (register_chrdev(DRM_MAJOR, "drm", &drm_stub_fops))
886 		goto err_p1;
887 
888 	ret = drm_sysfs_init();
889 	if (ret < 0) {
890 		printk(KERN_ERR "DRM: Error creating drm class.\n");
891 		goto err_p2;
892 	}
893 
894 	drm_debugfs_root = debugfs_create_dir("dri", NULL);
895 	if (!drm_debugfs_root) {
896 		DRM_ERROR("Cannot create /sys/kernel/debug/dri\n");
897 		ret = -1;
898 		goto err_p3;
899 	}
900 
901 	DRM_INFO("Initialized %s %d.%d.%d %s\n",
902 		 CORE_NAME, CORE_MAJOR, CORE_MINOR, CORE_PATCHLEVEL, CORE_DATE);
903 	return 0;
904 err_p3:
905 	drm_sysfs_destroy();
906 err_p2:
907 	unregister_chrdev(DRM_MAJOR, "drm");
908 
909 	idr_destroy(&drm_minors_idr);
910 err_p1:
911 	return ret;
912 }
913 
914 static void __exit drm_core_exit(void)
915 {
916 	debugfs_remove(drm_debugfs_root);
917 	drm_sysfs_destroy();
918 
919 	unregister_chrdev(DRM_MAJOR, "drm");
920 
921 	drm_connector_ida_destroy();
922 	idr_destroy(&drm_minors_idr);
923 }
924 
925 module_init(drm_core_init);
926 module_exit(drm_core_exit);
927