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