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