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