blob: 40fb4352432ced38876e23fbf2dfaa18535ae4cd [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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 *
Thierry Redingc6a1af8a2014-05-19 13:39:07 +02007 * Author Rickard E. (Rik) Faith <faith@valinux.com>
8 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * 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
David Herrmann1b7199f2014-07-23 12:29:56 +020029#include <linux/debugfs.h>
David Herrmann31bbe162014-01-03 14:09:47 +010030#include <linux/fs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include <linux/module.h>
32#include <linux/moduleparam.h>
David Herrmann31bbe162014-01-03 14:09:47 +010033#include <linux/mount.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090034#include <linux/slab.h>
David Howells760285e2012-10-02 18:01:07 +010035#include <drm/drmP.h>
36#include <drm/drm_core.h>
David Herrmanne7b960702014-07-24 12:10:04 +020037#include "drm_legacy.h"
Daniel Vetter67d0ec42014-09-10 12:43:53 +020038#include "drm_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
Ezequiel Garcia6dc3e222016-04-20 13:45:03 -030040/*
41 * drm_debug: Enable debug output.
42 * Bitmask of DRM_UT_x. See include/drm/drmP.h for details.
43 */
44unsigned int drm_debug = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070045EXPORT_SYMBOL(drm_debug);
46
Dave Airlieb5e89ed2005-09-25 14:28:13 +100047MODULE_AUTHOR(CORE_AUTHOR);
48MODULE_DESCRIPTION(CORE_DESC);
Linus Torvalds1da177e2005-04-16 15:20:36 -070049MODULE_LICENSE("GPL and additional rights");
Ezequiel Garcia6dc3e222016-04-20 13:45:03 -030050MODULE_PARM_DESC(debug, "Enable debug output, where each bit enables a debug category.\n"
51"\t\tBit 0 (0x01) will enable CORE messages (drm core code)\n"
52"\t\tBit 1 (0x02) will enable DRIVER messages (drm controller code)\n"
53"\t\tBit 2 (0x04) will enable KMS messages (modesetting code)\n"
54"\t\tBit 3 (0x08) will enable PRIME messages (prime code)\n"
55"\t\tBit 4 (0x10) will enable ATOMIC messages (atomic code)\n"
56"\t\tBit 5 (0x20) will enable VBL messages (vblank code)");
Dave Jonesc0758142005-10-03 15:02:20 -040057module_param_named(debug, drm_debug, int, 0600);
Linus Torvalds1da177e2005-04-16 15:20:36 -070058
David Herrmann0d639882014-02-24 15:53:25 +010059static DEFINE_SPINLOCK(drm_minor_lock);
David Herrmann1b7199f2014-07-23 12:29:56 +020060static struct idr drm_minors_idr;
Dave Airlie2c14f282008-04-21 16:47:32 +100061
David Herrmann1b7199f2014-07-23 12:29:56 +020062static struct dentry *drm_debugfs_root;
Joe Perches5ad3d882011-04-17 20:35:51 -070063
Joe Perchesa1f1a792014-10-11 22:08:57 -070064void drm_err(const char *format, ...)
Joe Perches5ad3d882011-04-17 20:35:51 -070065{
66 struct va_format vaf;
67 va_list args;
Joe Perches5ad3d882011-04-17 20:35:51 -070068
69 va_start(args, format);
70
71 vaf.fmt = format;
72 vaf.va = &args;
73
Scott Wood2ee762b2015-03-11 22:13:50 -050074 printk(KERN_ERR "[" DRM_NAME ":%ps] *ERROR* %pV",
Joe Perchesa1f1a792014-10-11 22:08:57 -070075 __builtin_return_address(0), &vaf);
Joe Perches5ad3d882011-04-17 20:35:51 -070076
77 va_end(args);
Joe Perches5ad3d882011-04-17 20:35:51 -070078}
79EXPORT_SYMBOL(drm_err);
80
Lespiau, Damien1287aa92014-03-24 15:53:17 +000081void drm_ut_debug_printk(const char *function_name, const char *format, ...)
yakui_zhao4fefcb22009-06-02 14:09:47 +080082{
Daniel Vetterfffb9062013-11-17 22:25:02 +010083 struct va_format vaf;
yakui_zhao4fefcb22009-06-02 14:09:47 +080084 va_list args;
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Lespiau, Damiena73d4e92014-03-24 15:53:15 +000086 va_start(args, format);
87 vaf.fmt = format;
88 vaf.va = &args;
Daniel Vetterfffb9062013-11-17 22:25:02 +010089
Lespiau, Damien0ed02982014-03-24 15:53:18 +000090 printk(KERN_DEBUG "[" DRM_NAME ":%s] %pV", function_name, &vaf);
Lespiau, Damiena73d4e92014-03-24 15:53:15 +000091
92 va_end(args);
yakui_zhao4fefcb22009-06-02 14:09:47 +080093}
94EXPORT_SYMBOL(drm_ut_debug_printk);
Joe Perches5ad3d882011-04-17 20:35:51 -070095
David Herrmann0d639882014-02-24 15:53:25 +010096/*
97 * DRM Minors
98 * A DRM device can provide several char-dev interfaces on the DRM-Major. Each
99 * of them is represented by a drm_minor object. Depending on the capabilities
100 * of the device-driver, different interfaces are registered.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 *
David Herrmann0d639882014-02-24 15:53:25 +0100102 * Minors can be accessed via dev->$minor_name. This pointer is either
103 * NULL or a valid drm_minor pointer and stays valid as long as the device is
104 * valid. This means, DRM minors have the same life-time as the underlying
105 * device. However, this doesn't mean that the minor is active. Minors are
106 * registered and unregistered dynamically according to device-state.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 */
David Herrmann0d639882014-02-24 15:53:25 +0100108
David Herrmann05b701f2014-01-29 12:43:56 +0100109static struct drm_minor **drm_minor_get_slot(struct drm_device *dev,
110 unsigned int type)
111{
112 switch (type) {
113 case DRM_MINOR_LEGACY:
114 return &dev->primary;
115 case DRM_MINOR_RENDER:
116 return &dev->render;
117 case DRM_MINOR_CONTROL:
118 return &dev->control;
119 default:
120 return NULL;
121 }
122}
123
124static int drm_minor_alloc(struct drm_device *dev, unsigned int type)
125{
126 struct drm_minor *minor;
David Herrmannf1b85962014-07-23 10:34:52 +0200127 unsigned long flags;
128 int r;
David Herrmann05b701f2014-01-29 12:43:56 +0100129
130 minor = kzalloc(sizeof(*minor), GFP_KERNEL);
131 if (!minor)
132 return -ENOMEM;
133
134 minor->type = type;
135 minor->dev = dev;
David Herrmann05b701f2014-01-29 12:43:56 +0100136
David Herrmannf1b85962014-07-23 10:34:52 +0200137 idr_preload(GFP_KERNEL);
138 spin_lock_irqsave(&drm_minor_lock, flags);
139 r = idr_alloc(&drm_minors_idr,
140 NULL,
141 64 * type,
142 64 * (type + 1),
143 GFP_NOWAIT);
144 spin_unlock_irqrestore(&drm_minor_lock, flags);
145 idr_preload_end();
146
147 if (r < 0)
148 goto err_free;
149
150 minor->index = r;
151
David Herrmanne1728072014-07-23 11:38:38 +0200152 minor->kdev = drm_sysfs_minor_alloc(minor);
153 if (IS_ERR(minor->kdev)) {
154 r = PTR_ERR(minor->kdev);
155 goto err_index;
156 }
157
David Herrmann05b701f2014-01-29 12:43:56 +0100158 *drm_minor_get_slot(dev, type) = minor;
159 return 0;
David Herrmannf1b85962014-07-23 10:34:52 +0200160
David Herrmanne1728072014-07-23 11:38:38 +0200161err_index:
162 spin_lock_irqsave(&drm_minor_lock, flags);
163 idr_remove(&drm_minors_idr, minor->index);
164 spin_unlock_irqrestore(&drm_minor_lock, flags);
David Herrmannf1b85962014-07-23 10:34:52 +0200165err_free:
166 kfree(minor);
167 return r;
David Herrmann05b701f2014-01-29 12:43:56 +0100168}
169
David Herrmannbd9dfa92014-01-29 12:55:48 +0100170static void drm_minor_free(struct drm_device *dev, unsigned int type)
171{
David Herrmannf1b85962014-07-23 10:34:52 +0200172 struct drm_minor **slot, *minor;
173 unsigned long flags;
David Herrmannbd9dfa92014-01-29 12:55:48 +0100174
175 slot = drm_minor_get_slot(dev, type);
David Herrmannf1b85962014-07-23 10:34:52 +0200176 minor = *slot;
177 if (!minor)
178 return;
179
David Herrmanne1728072014-07-23 11:38:38 +0200180 put_device(minor->kdev);
David Herrmannf1b85962014-07-23 10:34:52 +0200181
182 spin_lock_irqsave(&drm_minor_lock, flags);
183 idr_remove(&drm_minors_idr, minor->index);
184 spin_unlock_irqrestore(&drm_minor_lock, flags);
185
186 kfree(minor);
187 *slot = NULL;
David Herrmannbd9dfa92014-01-29 12:55:48 +0100188}
189
David Herrmannafcdbc82014-01-29 12:57:05 +0100190static int drm_minor_register(struct drm_device *dev, unsigned int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191{
David Herrmannf1b85962014-07-23 10:34:52 +0200192 struct drm_minor *minor;
David Herrmann0d639882014-02-24 15:53:25 +0100193 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
196 DRM_DEBUG("\n");
197
David Herrmannf1b85962014-07-23 10:34:52 +0200198 minor = *drm_minor_get_slot(dev, type);
199 if (!minor)
David Herrmann05b701f2014-01-29 12:43:56 +0100200 return 0;
201
David Herrmannf1b85962014-07-23 10:34:52 +0200202 ret = drm_debugfs_init(minor, minor->index, drm_debugfs_root);
Ben Gamari955b12d2009-02-17 20:08:49 -0500203 if (ret) {
GeunSik Lim156f5a72009-06-02 15:01:37 +0900204 DRM_ERROR("DRM: Failed to initialize /sys/kernel/debug/dri.\n");
David Herrmannf1b85962014-07-23 10:34:52 +0200205 return ret;
Ben Gamari955b12d2009-02-17 20:08:49 -0500206 }
Dave Airlie2c14f282008-04-21 16:47:32 +1000207
David Herrmanne1728072014-07-23 11:38:38 +0200208 ret = device_add(minor->kdev);
209 if (ret)
Daniel Vettercb6458f2013-08-08 15:41:34 +0200210 goto err_debugfs;
Dave Airlie2c14f282008-04-21 16:47:32 +1000211
David Herrmann0d639882014-02-24 15:53:25 +0100212 /* replace NULL with @minor so lookups will succeed from now on */
213 spin_lock_irqsave(&drm_minor_lock, flags);
David Herrmannf1b85962014-07-23 10:34:52 +0200214 idr_replace(&drm_minors_idr, minor, minor->index);
David Herrmann0d639882014-02-24 15:53:25 +0100215 spin_unlock_irqrestore(&drm_minor_lock, flags);
Dave Airlie2c14f282008-04-21 16:47:32 +1000216
David Herrmannf1b85962014-07-23 10:34:52 +0200217 DRM_DEBUG("new minor registered %d\n", minor->index);
Dave Airlie2c14f282008-04-21 16:47:32 +1000218 return 0;
219
Daniel Vettercb6458f2013-08-08 15:41:34 +0200220err_debugfs:
David Herrmannf1b85962014-07-23 10:34:52 +0200221 drm_debugfs_cleanup(minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 return ret;
223}
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000224
David Herrmannafcdbc82014-01-29 12:57:05 +0100225static void drm_minor_unregister(struct drm_device *dev, unsigned int type)
David Herrmannf73aca52013-10-20 18:55:40 +0200226{
David Herrmannafcdbc82014-01-29 12:57:05 +0100227 struct drm_minor *minor;
David Herrmann0d639882014-02-24 15:53:25 +0100228 unsigned long flags;
David Herrmannafcdbc82014-01-29 12:57:05 +0100229
230 minor = *drm_minor_get_slot(dev, type);
David Herrmanne1728072014-07-23 11:38:38 +0200231 if (!minor || !device_is_registered(minor->kdev))
David Herrmannf73aca52013-10-20 18:55:40 +0200232 return;
233
David Herrmannf1b85962014-07-23 10:34:52 +0200234 /* replace @minor with NULL so lookups will fail from now on */
David Herrmann0d639882014-02-24 15:53:25 +0100235 spin_lock_irqsave(&drm_minor_lock, flags);
David Herrmannf1b85962014-07-23 10:34:52 +0200236 idr_replace(&drm_minors_idr, NULL, minor->index);
David Herrmann0d639882014-02-24 15:53:25 +0100237 spin_unlock_irqrestore(&drm_minor_lock, flags);
David Herrmann0d639882014-02-24 15:53:25 +0100238
David Herrmanne1728072014-07-23 11:38:38 +0200239 device_del(minor->kdev);
240 dev_set_drvdata(minor->kdev, NULL); /* safety belt */
David Herrmann865fb472013-10-20 18:55:43 +0200241 drm_debugfs_cleanup(minor);
David Herrmannf73aca52013-10-20 18:55:40 +0200242}
243
244/**
David Herrmann1616c522014-01-29 10:49:19 +0100245 * drm_minor_acquire - Acquire a DRM minor
246 * @minor_id: Minor ID of the DRM-minor
David Herrmannf73aca52013-10-20 18:55:40 +0200247 *
David Herrmann1616c522014-01-29 10:49:19 +0100248 * Looks up the given minor-ID and returns the respective DRM-minor object. The
249 * refence-count of the underlying device is increased so you must release this
250 * object with drm_minor_release().
251 *
252 * As long as you hold this minor, it is guaranteed that the object and the
253 * minor->dev pointer will stay valid! However, the device may get unplugged and
254 * unregistered while you hold the minor.
255 *
256 * Returns:
257 * Pointer to minor-object with increased device-refcount, or PTR_ERR on
258 * failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 */
David Herrmann1616c522014-01-29 10:49:19 +0100260struct drm_minor *drm_minor_acquire(unsigned int minor_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261{
David Herrmann1616c522014-01-29 10:49:19 +0100262 struct drm_minor *minor;
David Herrmann0d639882014-02-24 15:53:25 +0100263 unsigned long flags;
Eric Anholt673a3942008-07-30 12:06:12 -0700264
David Herrmann0d639882014-02-24 15:53:25 +0100265 spin_lock_irqsave(&drm_minor_lock, flags);
David Herrmann1616c522014-01-29 10:49:19 +0100266 minor = idr_find(&drm_minors_idr, minor_id);
David Herrmann0d639882014-02-24 15:53:25 +0100267 if (minor)
268 drm_dev_ref(minor->dev);
269 spin_unlock_irqrestore(&drm_minor_lock, flags);
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000270
David Herrmann0d639882014-02-24 15:53:25 +0100271 if (!minor) {
272 return ERR_PTR(-ENODEV);
273 } else if (drm_device_is_unplugged(minor->dev)) {
274 drm_dev_unref(minor->dev);
275 return ERR_PTR(-ENODEV);
276 }
277
David Herrmann1616c522014-01-29 10:49:19 +0100278 return minor;
279}
280
281/**
282 * drm_minor_release - Release DRM minor
283 * @minor: Pointer to DRM minor object
284 *
285 * Release a minor that was previously acquired via drm_minor_acquire().
286 */
287void drm_minor_release(struct drm_minor *minor)
288{
289 drm_dev_unref(minor->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290}
Kristian Høgsberg112b7152009-01-04 16:55:33 -0500291
292/**
Daniel Vetter6e3f7972015-09-28 21:46:35 +0200293 * DOC: driver instance overview
294 *
295 * A device instance for a drm driver is represented by struct &drm_device. This
296 * is allocated with drm_dev_alloc(), usually from bus-specific ->probe()
297 * callbacks implemented by the driver. The driver then needs to initialize all
298 * the various subsystems for the drm device like memory management, vblank
299 * handling, modesetting support and intial output configuration plus obviously
300 * initialize all the corresponding hardware bits. An important part of this is
301 * also calling drm_dev_set_unique() to set the userspace-visible unique name of
302 * this device instance. Finally when everything is up and running and ready for
303 * userspace the device instance can be published using drm_dev_register().
304 *
305 * There is also deprecated support for initalizing device instances using
306 * bus-specific helpers and the ->load() callback. But due to
307 * backwards-compatibility needs the device instance have to be published too
308 * early, which requires unpretty global locking to make safe and is therefore
309 * only support for existing drivers not yet converted to the new scheme.
310 *
311 * When cleaning up a device instance everything needs to be done in reverse:
312 * First unpublish the device instance with drm_dev_unregister(). Then clean up
313 * any other resources allocated at device initialization and drop the driver's
314 * reference to &drm_device using drm_dev_unref().
315 *
316 * Note that the lifetime rules for &drm_device instance has still a lot of
317 * historical baggage. Hence use the reference counting provided by
318 * drm_dev_ref() and drm_dev_unref() only carefully.
319 *
320 * Also note that embedding of &drm_device is currently not (yet) supported (but
321 * it would be easy to add). Drivers can store driver-private data in the
322 * dev_priv field of &drm_device.
323 */
324
325/**
Thierry Redingc6a1af8a2014-05-19 13:39:07 +0200326 * drm_put_dev - Unregister and release a DRM device
327 * @dev: DRM device
328 *
329 * Called at module unload time or when a PCI device is unplugged.
330 *
Kristian Høgsberg112b7152009-01-04 16:55:33 -0500331 * Cleans up all DRM device, calling drm_lastclose().
Daniel Vetter6e3f7972015-09-28 21:46:35 +0200332 *
333 * Note: Use of this function is deprecated. It will eventually go away
334 * completely. Please use drm_dev_unregister() and drm_dev_unref() explicitly
335 * instead to make sure that the device isn't userspace accessible any more
336 * while teardown is in progress, ensuring that userspace can't access an
337 * inconsistent state.
Kristian Høgsberg112b7152009-01-04 16:55:33 -0500338 */
339void drm_put_dev(struct drm_device *dev)
340{
Kristian Høgsberg112b7152009-01-04 16:55:33 -0500341 DRM_DEBUG("\n");
342
343 if (!dev) {
344 DRM_ERROR("cleanup called no dev\n");
345 return;
346 }
347
David Herrmannc3a49732013-10-02 11:23:38 +0200348 drm_dev_unregister(dev);
David Herrmann099d1c22014-01-29 10:21:36 +0100349 drm_dev_unref(dev);
Kristian Høgsberg112b7152009-01-04 16:55:33 -0500350}
351EXPORT_SYMBOL(drm_put_dev);
Dave Airlie2c07a212012-02-20 14:18:07 +0000352
353void drm_unplug_dev(struct drm_device *dev)
354{
355 /* for a USB device */
David Herrmannafcdbc82014-01-29 12:57:05 +0100356 drm_minor_unregister(dev, DRM_MINOR_LEGACY);
357 drm_minor_unregister(dev, DRM_MINOR_RENDER);
358 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
Dave Airlie2c07a212012-02-20 14:18:07 +0000359
360 mutex_lock(&drm_global_mutex);
361
362 drm_device_set_unplugged(dev);
363
364 if (dev->open_count == 0) {
365 drm_put_dev(dev);
366 }
367 mutex_unlock(&drm_global_mutex);
368}
369EXPORT_SYMBOL(drm_unplug_dev);
David Herrmann1bb72532013-10-02 11:23:34 +0200370
David Herrmann31bbe162014-01-03 14:09:47 +0100371/*
372 * DRM internal mount
373 * We want to be able to allocate our own "struct address_space" to control
374 * memory-mappings in VRAM (or stolen RAM, ...). However, core MM does not allow
375 * stand-alone address_space objects, so we need an underlying inode. As there
376 * is no way to allocate an independent inode easily, we need a fake internal
377 * VFS mount-point.
378 *
379 * The drm_fs_inode_new() function allocates a new inode, drm_fs_inode_free()
380 * frees it again. You are allowed to use iget() and iput() to get references to
381 * the inode. But each drm_fs_inode_new() call must be paired with exactly one
382 * drm_fs_inode_free() call (which does not have to be the last iput()).
383 * We use drm_fs_inode_*() to manage our internal VFS mount-point and share it
384 * between multiple inode-users. You could, technically, call
385 * iget() + drm_fs_inode_free() directly after alloc and sometime later do an
386 * iput(), but this way you'd end up with a new vfsmount for each inode.
387 */
388
389static int drm_fs_cnt;
390static struct vfsmount *drm_fs_mnt;
391
392static const struct dentry_operations drm_fs_dops = {
393 .d_dname = simple_dname,
394};
395
396static const struct super_operations drm_fs_sops = {
397 .statfs = simple_statfs,
398};
399
400static struct dentry *drm_fs_mount(struct file_system_type *fs_type, int flags,
401 const char *dev_name, void *data)
402{
403 return mount_pseudo(fs_type,
404 "drm:",
405 &drm_fs_sops,
406 &drm_fs_dops,
407 0x010203ff);
408}
409
410static struct file_system_type drm_fs_type = {
411 .name = "drm",
412 .owner = THIS_MODULE,
413 .mount = drm_fs_mount,
414 .kill_sb = kill_anon_super,
415};
416
417static struct inode *drm_fs_inode_new(void)
418{
419 struct inode *inode;
420 int r;
421
422 r = simple_pin_fs(&drm_fs_type, &drm_fs_mnt, &drm_fs_cnt);
423 if (r < 0) {
424 DRM_ERROR("Cannot mount pseudo fs: %d\n", r);
425 return ERR_PTR(r);
426 }
427
428 inode = alloc_anon_inode(drm_fs_mnt->mnt_sb);
429 if (IS_ERR(inode))
430 simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
431
432 return inode;
433}
434
435static void drm_fs_inode_free(struct inode *inode)
436{
437 if (inode) {
438 iput(inode);
439 simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
440 }
441}
442
David Herrmann1bb72532013-10-02 11:23:34 +0200443/**
Chris Wilsonb209aca2016-06-15 13:17:46 +0100444 * drm_dev_init - Initialise new DRM device
445 * @dev: DRM device
446 * @driver: DRM driver
David Herrmann1bb72532013-10-02 11:23:34 +0200447 * @parent: Parent device object
448 *
Chris Wilsonb209aca2016-06-15 13:17:46 +0100449 * Initialize a new DRM device. No device registration is done.
David Herrmannc22f0ac2013-10-02 11:23:35 +0200450 * Call drm_dev_register() to advertice the device to user space and register it
Daniel Vetter6e3f7972015-09-28 21:46:35 +0200451 * with other core subsystems. This should be done last in the device
452 * initialization sequence to make sure userspace can't access an inconsistent
453 * state.
David Herrmann1bb72532013-10-02 11:23:34 +0200454 *
David Herrmann099d1c22014-01-29 10:21:36 +0100455 * The initial ref-count of the object is 1. Use drm_dev_ref() and
456 * drm_dev_unref() to take and drop further ref-counts.
457 *
Daniel Vetterb0ff4b92014-11-24 20:01:58 +0100458 * Note that for purely virtual devices @parent can be NULL.
459 *
Chris Wilsonb209aca2016-06-15 13:17:46 +0100460 * Drivers that do not want to allocate their own device struct
461 * embedding struct &drm_device can call drm_dev_alloc() instead.
462 *
David Herrmann1bb72532013-10-02 11:23:34 +0200463 * RETURNS:
Chris Wilsonb209aca2016-06-15 13:17:46 +0100464 * 0 on success, or error code on failure.
David Herrmann1bb72532013-10-02 11:23:34 +0200465 */
Chris Wilsonb209aca2016-06-15 13:17:46 +0100466int drm_dev_init(struct drm_device *dev,
467 struct drm_driver *driver,
468 struct device *parent)
David Herrmann1bb72532013-10-02 11:23:34 +0200469{
David Herrmann1bb72532013-10-02 11:23:34 +0200470 int ret;
471
David Herrmann099d1c22014-01-29 10:21:36 +0100472 kref_init(&dev->ref);
David Herrmann1bb72532013-10-02 11:23:34 +0200473 dev->dev = parent;
474 dev->driver = driver;
475
476 INIT_LIST_HEAD(&dev->filelist);
477 INIT_LIST_HEAD(&dev->ctxlist);
478 INIT_LIST_HEAD(&dev->vmalist);
479 INIT_LIST_HEAD(&dev->maplist);
480 INIT_LIST_HEAD(&dev->vblank_event_list);
481
Daniel Vetter2177a212013-12-16 11:21:06 +0100482 spin_lock_init(&dev->buf_lock);
David Herrmann1bb72532013-10-02 11:23:34 +0200483 spin_lock_init(&dev->event_lock);
484 mutex_init(&dev->struct_mutex);
Daniel Vetter1d2ac402016-04-26 19:29:41 +0200485 mutex_init(&dev->filelist_mutex);
David Herrmann1bb72532013-10-02 11:23:34 +0200486 mutex_init(&dev->ctxlist_mutex);
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100487 mutex_init(&dev->master_mutex);
David Herrmann1bb72532013-10-02 11:23:34 +0200488
David Herrmann6796cb12014-01-03 14:24:19 +0100489 dev->anon_inode = drm_fs_inode_new();
490 if (IS_ERR(dev->anon_inode)) {
491 ret = PTR_ERR(dev->anon_inode);
492 DRM_ERROR("Cannot allocate anonymous inode: %d\n", ret);
David Herrmann1bb72532013-10-02 11:23:34 +0200493 goto err_free;
David Herrmann6796cb12014-01-03 14:24:19 +0100494 }
495
David Herrmann05b701f2014-01-29 12:43:56 +0100496 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
497 ret = drm_minor_alloc(dev, DRM_MINOR_CONTROL);
498 if (ret)
499 goto err_minors;
500 }
501
David Herrmann6d6dfcf2014-03-16 14:38:40 +0100502 if (drm_core_check_feature(dev, DRIVER_RENDER)) {
David Herrmann05b701f2014-01-29 12:43:56 +0100503 ret = drm_minor_alloc(dev, DRM_MINOR_RENDER);
504 if (ret)
505 goto err_minors;
506 }
507
508 ret = drm_minor_alloc(dev, DRM_MINOR_LEGACY);
509 if (ret)
510 goto err_minors;
511
Chris Wilsonb209aca2016-06-15 13:17:46 +0100512 ret = drm_ht_create(&dev->map_hash, 12);
513 if (ret)
David Herrmann05b701f2014-01-29 12:43:56 +0100514 goto err_minors;
David Herrmann1bb72532013-10-02 11:23:34 +0200515
Daniel Vetterba6976c2015-06-23 11:22:36 +0200516 drm_legacy_ctxbitmap_init(dev);
David Herrmann1bb72532013-10-02 11:23:34 +0200517
Andrzej Hajda1bcecfa2014-09-30 16:49:56 +0200518 if (drm_core_check_feature(dev, DRIVER_GEM)) {
David Herrmann1bb72532013-10-02 11:23:34 +0200519 ret = drm_gem_init(dev);
520 if (ret) {
521 DRM_ERROR("Cannot initialize graphics execution manager (GEM)\n");
522 goto err_ctxbitmap;
523 }
524 }
525
Nicolas Ioosse112e592015-12-11 11:20:28 +0100526 if (parent) {
527 ret = drm_dev_set_unique(dev, dev_name(parent));
528 if (ret)
529 goto err_setunique;
530 }
531
Chris Wilsonb209aca2016-06-15 13:17:46 +0100532 return 0;
David Herrmann1bb72532013-10-02 11:23:34 +0200533
Nicolas Ioosse112e592015-12-11 11:20:28 +0100534err_setunique:
535 if (drm_core_check_feature(dev, DRIVER_GEM))
536 drm_gem_destroy(dev);
David Herrmann1bb72532013-10-02 11:23:34 +0200537err_ctxbitmap:
David Herrmanne7b960702014-07-24 12:10:04 +0200538 drm_legacy_ctxbitmap_cleanup(dev);
David Herrmann1bb72532013-10-02 11:23:34 +0200539 drm_ht_remove(&dev->map_hash);
David Herrmann05b701f2014-01-29 12:43:56 +0100540err_minors:
David Herrmannbd9dfa92014-01-29 12:55:48 +0100541 drm_minor_free(dev, DRM_MINOR_LEGACY);
542 drm_minor_free(dev, DRM_MINOR_RENDER);
543 drm_minor_free(dev, DRM_MINOR_CONTROL);
David Herrmann6796cb12014-01-03 14:24:19 +0100544 drm_fs_inode_free(dev->anon_inode);
David Herrmann1bb72532013-10-02 11:23:34 +0200545err_free:
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100546 mutex_destroy(&dev->master_mutex);
Chris Wilsonb209aca2016-06-15 13:17:46 +0100547 return ret;
548}
549EXPORT_SYMBOL(drm_dev_init);
550
551/**
552 * drm_dev_alloc - Allocate new DRM device
553 * @driver: DRM driver to allocate device for
554 * @parent: Parent device object
555 *
556 * Allocate and initialize a new DRM device. No device registration is done.
557 * Call drm_dev_register() to advertice the device to user space and register it
558 * with other core subsystems. This should be done last in the device
559 * initialization sequence to make sure userspace can't access an inconsistent
560 * state.
561 *
562 * The initial ref-count of the object is 1. Use drm_dev_ref() and
563 * drm_dev_unref() to take and drop further ref-counts.
564 *
565 * Note that for purely virtual devices @parent can be NULL.
566 *
567 * Drivers that wish to subclass or embed struct &drm_device into their
568 * own struct should look at using drm_dev_init() instead.
569 *
570 * RETURNS:
571 * Pointer to new DRM device, or NULL if out of memory.
572 */
573struct drm_device *drm_dev_alloc(struct drm_driver *driver,
574 struct device *parent)
575{
576 struct drm_device *dev;
577 int ret;
578
579 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
580 if (!dev)
581 return NULL;
582
583 ret = drm_dev_init(dev, driver, parent);
584 if (ret) {
585 kfree(dev);
586 return NULL;
587 }
588
589 return dev;
David Herrmann1bb72532013-10-02 11:23:34 +0200590}
591EXPORT_SYMBOL(drm_dev_alloc);
David Herrmannc22f0ac2013-10-02 11:23:35 +0200592
David Herrmann099d1c22014-01-29 10:21:36 +0100593static void drm_dev_release(struct kref *ref)
David Herrmann0dc8fe52013-10-02 11:23:37 +0200594{
David Herrmann099d1c22014-01-29 10:21:36 +0100595 struct drm_device *dev = container_of(ref, struct drm_device, ref);
David Herrmann8f6599d2013-10-20 18:55:45 +0200596
Andrzej Hajda1bcecfa2014-09-30 16:49:56 +0200597 if (drm_core_check_feature(dev, DRIVER_GEM))
David Herrmann0dc8fe52013-10-02 11:23:37 +0200598 drm_gem_destroy(dev);
599
David Herrmanne7b960702014-07-24 12:10:04 +0200600 drm_legacy_ctxbitmap_cleanup(dev);
David Herrmann0dc8fe52013-10-02 11:23:37 +0200601 drm_ht_remove(&dev->map_hash);
David Herrmann6796cb12014-01-03 14:24:19 +0100602 drm_fs_inode_free(dev->anon_inode);
David Herrmann0dc8fe52013-10-02 11:23:37 +0200603
David Herrmannbd9dfa92014-01-29 12:55:48 +0100604 drm_minor_free(dev, DRM_MINOR_LEGACY);
605 drm_minor_free(dev, DRM_MINOR_RENDER);
606 drm_minor_free(dev, DRM_MINOR_CONTROL);
607
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100608 mutex_destroy(&dev->master_mutex);
Thierry Redingca8e2ad2014-04-11 15:23:00 +0200609 kfree(dev->unique);
David Herrmann0dc8fe52013-10-02 11:23:37 +0200610 kfree(dev);
611}
David Herrmann099d1c22014-01-29 10:21:36 +0100612
613/**
614 * drm_dev_ref - Take reference of a DRM device
615 * @dev: device to take reference of or NULL
616 *
617 * This increases the ref-count of @dev by one. You *must* already own a
618 * reference when calling this. Use drm_dev_unref() to drop this reference
619 * again.
620 *
621 * This function never fails. However, this function does not provide *any*
622 * guarantee whether the device is alive or running. It only provides a
623 * reference to the object and the memory associated with it.
624 */
625void drm_dev_ref(struct drm_device *dev)
626{
627 if (dev)
628 kref_get(&dev->ref);
629}
630EXPORT_SYMBOL(drm_dev_ref);
631
632/**
633 * drm_dev_unref - Drop reference of a DRM device
634 * @dev: device to drop reference of or NULL
635 *
636 * This decreases the ref-count of @dev by one. The device is destroyed if the
637 * ref-count drops to zero.
638 */
639void drm_dev_unref(struct drm_device *dev)
640{
641 if (dev)
642 kref_put(&dev->ref, drm_dev_release);
643}
644EXPORT_SYMBOL(drm_dev_unref);
David Herrmann0dc8fe52013-10-02 11:23:37 +0200645
646/**
David Herrmannc22f0ac2013-10-02 11:23:35 +0200647 * drm_dev_register - Register DRM device
648 * @dev: Device to register
Thierry Redingc6a1af8a2014-05-19 13:39:07 +0200649 * @flags: Flags passed to the driver's .load() function
David Herrmannc22f0ac2013-10-02 11:23:35 +0200650 *
651 * Register the DRM device @dev with the system, advertise device to user-space
652 * and start normal device operation. @dev must be allocated via drm_dev_alloc()
Alexey Brodkin54d2c2d2016-04-19 15:24:51 +0300653 * previously. Right after drm_dev_register() the driver should call
654 * drm_connector_register_all() to register all connectors in sysfs. This is
655 * a separate call for backward compatibility with drivers still using
656 * the deprecated ->load() callback, where connectors are registered from within
657 * the ->load() callback.
David Herrmannc22f0ac2013-10-02 11:23:35 +0200658 *
659 * Never call this twice on any device!
660 *
Daniel Vetter6e3f7972015-09-28 21:46:35 +0200661 * NOTE: To ensure backward compatibility with existing drivers method this
662 * function calls the ->load() method after registering the device nodes,
663 * creating race conditions. Usage of the ->load() methods is therefore
664 * deprecated, drivers must perform all initialization before calling
665 * drm_dev_register().
666 *
David Herrmannc22f0ac2013-10-02 11:23:35 +0200667 * RETURNS:
668 * 0 on success, negative error code on failure.
669 */
670int drm_dev_register(struct drm_device *dev, unsigned long flags)
671{
672 int ret;
673
674 mutex_lock(&drm_global_mutex);
675
David Herrmannafcdbc82014-01-29 12:57:05 +0100676 ret = drm_minor_register(dev, DRM_MINOR_CONTROL);
David Herrmannc22f0ac2013-10-02 11:23:35 +0200677 if (ret)
David Herrmann05b701f2014-01-29 12:43:56 +0100678 goto err_minors;
679
David Herrmannafcdbc82014-01-29 12:57:05 +0100680 ret = drm_minor_register(dev, DRM_MINOR_RENDER);
David Herrmann05b701f2014-01-29 12:43:56 +0100681 if (ret)
682 goto err_minors;
683
David Herrmannafcdbc82014-01-29 12:57:05 +0100684 ret = drm_minor_register(dev, DRM_MINOR_LEGACY);
David Herrmann05b701f2014-01-29 12:43:56 +0100685 if (ret)
686 goto err_minors;
David Herrmannc22f0ac2013-10-02 11:23:35 +0200687
688 if (dev->driver->load) {
689 ret = dev->driver->load(dev, flags);
690 if (ret)
David Herrmann05b701f2014-01-29 12:43:56 +0100691 goto err_minors;
David Herrmannc22f0ac2013-10-02 11:23:35 +0200692 }
693
David Herrmannc22f0ac2013-10-02 11:23:35 +0200694 ret = 0;
695 goto out_unlock;
696
David Herrmann05b701f2014-01-29 12:43:56 +0100697err_minors:
David Herrmannafcdbc82014-01-29 12:57:05 +0100698 drm_minor_unregister(dev, DRM_MINOR_LEGACY);
699 drm_minor_unregister(dev, DRM_MINOR_RENDER);
700 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
David Herrmannc22f0ac2013-10-02 11:23:35 +0200701out_unlock:
702 mutex_unlock(&drm_global_mutex);
703 return ret;
704}
705EXPORT_SYMBOL(drm_dev_register);
David Herrmannc3a49732013-10-02 11:23:38 +0200706
707/**
708 * drm_dev_unregister - Unregister DRM device
709 * @dev: Device to unregister
710 *
711 * Unregister the DRM device from the system. This does the reverse of
712 * drm_dev_register() but does not deallocate the device. The caller must call
David Herrmann099d1c22014-01-29 10:21:36 +0100713 * drm_dev_unref() to drop their final reference.
Daniel Vetter6e3f7972015-09-28 21:46:35 +0200714 *
715 * This should be called first in the device teardown code to make sure
716 * userspace can't access the device instance any more.
David Herrmannc3a49732013-10-02 11:23:38 +0200717 */
718void drm_dev_unregister(struct drm_device *dev)
719{
720 struct drm_map_list *r_list, *list_temp;
721
722 drm_lastclose(dev);
723
724 if (dev->driver->unload)
725 dev->driver->unload(dev);
726
Daniel Vetter4efafeb2013-12-11 11:34:38 +0100727 if (dev->agp)
728 drm_pci_agp_destroy(dev);
David Herrmannc3a49732013-10-02 11:23:38 +0200729
730 drm_vblank_cleanup(dev);
731
732 list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head)
David Herrmann9fc5cde2014-08-29 12:12:28 +0200733 drm_legacy_rmmap(dev, r_list->map);
David Herrmannc3a49732013-10-02 11:23:38 +0200734
David Herrmannafcdbc82014-01-29 12:57:05 +0100735 drm_minor_unregister(dev, DRM_MINOR_LEGACY);
736 drm_minor_unregister(dev, DRM_MINOR_RENDER);
737 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
David Herrmannc3a49732013-10-02 11:23:38 +0200738}
739EXPORT_SYMBOL(drm_dev_unregister);
Thierry Redingca8e2ad2014-04-11 15:23:00 +0200740
741/**
742 * drm_dev_set_unique - Set the unique name of a DRM device
743 * @dev: device of which to set the unique name
Nicolas Iooss399368aa2015-12-11 11:20:27 +0100744 * @name: unique name
Thierry Redingca8e2ad2014-04-11 15:23:00 +0200745 *
Nicolas Iooss399368aa2015-12-11 11:20:27 +0100746 * Sets the unique name of a DRM device using the specified string. Drivers
747 * can use this at driver probe time if the unique name of the devices they
748 * drive is static.
Thierry Redingca8e2ad2014-04-11 15:23:00 +0200749 *
750 * Return: 0 on success or a negative error code on failure.
751 */
Nicolas Iooss399368aa2015-12-11 11:20:27 +0100752int drm_dev_set_unique(struct drm_device *dev, const char *name)
Thierry Redingca8e2ad2014-04-11 15:23:00 +0200753{
Thierry Redingca8e2ad2014-04-11 15:23:00 +0200754 kfree(dev->unique);
Nicolas Iooss399368aa2015-12-11 11:20:27 +0100755 dev->unique = kstrdup(name, GFP_KERNEL);
Thierry Redingca8e2ad2014-04-11 15:23:00 +0200756
757 return dev->unique ? 0 : -ENOMEM;
758}
759EXPORT_SYMBOL(drm_dev_set_unique);
David Herrmann1b7199f2014-07-23 12:29:56 +0200760
761/*
762 * DRM Core
763 * The DRM core module initializes all global DRM objects and makes them
764 * available to drivers. Once setup, drivers can probe their respective
765 * devices.
766 * Currently, core management includes:
767 * - The "DRM-Global" key/value database
768 * - Global ID management for connectors
769 * - DRM major number allocation
770 * - DRM minor management
771 * - DRM sysfs class
772 * - DRM debugfs root
773 *
774 * Furthermore, the DRM core provides dynamic char-dev lookups. For each
775 * interface registered on a DRM device, you can request minor numbers from DRM
776 * core. DRM core takes care of major-number management and char-dev
777 * registration. A stub ->open() callback forwards any open() requests to the
778 * registered minor.
779 */
780
781static int drm_stub_open(struct inode *inode, struct file *filp)
782{
783 const struct file_operations *new_fops;
784 struct drm_minor *minor;
785 int err;
786
787 DRM_DEBUG("\n");
788
789 mutex_lock(&drm_global_mutex);
790 minor = drm_minor_acquire(iminor(inode));
791 if (IS_ERR(minor)) {
792 err = PTR_ERR(minor);
793 goto out_unlock;
794 }
795
796 new_fops = fops_get(minor->dev->driver->fops);
797 if (!new_fops) {
798 err = -ENODEV;
799 goto out_release;
800 }
801
802 replace_fops(filp, new_fops);
803 if (filp->f_op->open)
804 err = filp->f_op->open(inode, filp);
805 else
806 err = 0;
807
808out_release:
809 drm_minor_release(minor);
810out_unlock:
811 mutex_unlock(&drm_global_mutex);
812 return err;
813}
814
815static const struct file_operations drm_stub_fops = {
816 .owner = THIS_MODULE,
817 .open = drm_stub_open,
818 .llseek = noop_llseek,
819};
820
821static int __init drm_core_init(void)
822{
823 int ret = -ENOMEM;
824
825 drm_global_init();
826 drm_connector_ida_init();
827 idr_init(&drm_minors_idr);
828
829 if (register_chrdev(DRM_MAJOR, "drm", &drm_stub_fops))
830 goto err_p1;
831
David Herrmannfcc90212015-09-09 14:21:30 +0200832 ret = drm_sysfs_init();
833 if (ret < 0) {
David Herrmann1b7199f2014-07-23 12:29:56 +0200834 printk(KERN_ERR "DRM: Error creating drm class.\n");
David Herrmann1b7199f2014-07-23 12:29:56 +0200835 goto err_p2;
836 }
837
838 drm_debugfs_root = debugfs_create_dir("dri", NULL);
839 if (!drm_debugfs_root) {
840 DRM_ERROR("Cannot create /sys/kernel/debug/dri\n");
841 ret = -1;
842 goto err_p3;
843 }
844
845 DRM_INFO("Initialized %s %d.%d.%d %s\n",
846 CORE_NAME, CORE_MAJOR, CORE_MINOR, CORE_PATCHLEVEL, CORE_DATE);
847 return 0;
848err_p3:
849 drm_sysfs_destroy();
850err_p2:
851 unregister_chrdev(DRM_MAJOR, "drm");
852
853 idr_destroy(&drm_minors_idr);
854err_p1:
855 return ret;
856}
857
858static void __exit drm_core_exit(void)
859{
860 debugfs_remove(drm_debugfs_root);
861 drm_sysfs_destroy();
862
863 unregister_chrdev(DRM_MAJOR, "drm");
864
865 drm_connector_ida_destroy();
866 idr_destroy(&drm_minors_idr);
867}
868
869module_init(drm_core_init);
870module_exit(drm_core_exit);