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