blob: 362b8cd68a24f4bb4848db89a2e7ccd59caefd04 [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>
Benjamin Gaignard79190ea2016-06-21 16:37:09 +020036#include "drm_crtc_internal.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"
Daniel Vetter81065542016-06-21 10:54:13 +020039#include "drm_crtc_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
Ezequiel Garcia6dc3e222016-04-20 13:45:03 -030041/*
42 * drm_debug: Enable debug output.
43 * Bitmask of DRM_UT_x. See include/drm/drmP.h for details.
44 */
45unsigned int drm_debug = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070046EXPORT_SYMBOL(drm_debug);
47
David Herrmann82d5e732016-09-01 14:48:36 +020048MODULE_AUTHOR("Gareth Hughes, Leif Delgass, José Fonseca, Jon Smirl");
49MODULE_DESCRIPTION("DRM shared core routines");
Linus Torvalds1da177e2005-04-16 15:20:36 -070050MODULE_LICENSE("GPL and additional rights");
Ezequiel Garcia6dc3e222016-04-20 13:45:03 -030051MODULE_PARM_DESC(debug, "Enable debug output, where each bit enables a debug category.\n"
52"\t\tBit 0 (0x01) will enable CORE messages (drm core code)\n"
53"\t\tBit 1 (0x02) will enable DRIVER messages (drm controller code)\n"
54"\t\tBit 2 (0x04) will enable KMS messages (modesetting code)\n"
55"\t\tBit 3 (0x08) will enable PRIME messages (prime code)\n"
56"\t\tBit 4 (0x10) will enable ATOMIC messages (atomic code)\n"
57"\t\tBit 5 (0x20) will enable VBL messages (vblank code)");
Dave Jonesc0758142005-10-03 15:02:20 -040058module_param_named(debug, drm_debug, int, 0600);
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
David Herrmann0d639882014-02-24 15:53:25 +010060static DEFINE_SPINLOCK(drm_minor_lock);
David Herrmann1b7199f2014-07-23 12:29:56 +020061static struct idr drm_minors_idr;
Dave Airlie2c14f282008-04-21 16:47:32 +100062
David Herrmann1b7199f2014-07-23 12:29:56 +020063static struct dentry *drm_debugfs_root;
Joe Perches5ad3d882011-04-17 20:35:51 -070064
Sean Paulc4e68a52016-08-15 16:18:04 -070065#define DRM_PRINTK_FMT "[" DRM_NAME ":%s]%s %pV"
66
67void drm_dev_printk(const struct device *dev, const char *level,
68 unsigned int category, const char *function_name,
69 const char *prefix, const char *format, ...)
Joe Perches5ad3d882011-04-17 20:35:51 -070070{
71 struct va_format vaf;
72 va_list args;
Joe Perches5ad3d882011-04-17 20:35:51 -070073
Sean Paulc4e68a52016-08-15 16:18:04 -070074 if (category != DRM_UT_NONE && !(drm_debug & category))
75 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
Lespiau, Damiena73d4e92014-03-24 15:53:15 +000077 va_start(args, format);
78 vaf.fmt = format;
79 vaf.va = &args;
Daniel Vetterfffb9062013-11-17 22:25:02 +010080
Chris Wilsonb4ba97e2016-08-19 08:37:50 +010081 if (dev)
82 dev_printk(level, dev, DRM_PRINTK_FMT, function_name, prefix,
83 &vaf);
84 else
85 printk("%s" DRM_PRINTK_FMT, level, function_name, prefix, &vaf);
Lespiau, Damiena73d4e92014-03-24 15:53:15 +000086
87 va_end(args);
yakui_zhao4fefcb22009-06-02 14:09:47 +080088}
Sean Paulc4e68a52016-08-15 16:18:04 -070089EXPORT_SYMBOL(drm_dev_printk);
90
91void drm_printk(const char *level, unsigned int category,
Sean Paulc4e68a52016-08-15 16:18:04 -070092 const char *format, ...)
93{
94 struct va_format vaf;
95 va_list args;
96
97 if (category != DRM_UT_NONE && !(drm_debug & category))
98 return;
99
100 va_start(args, format);
101 vaf.fmt = format;
102 vaf.va = &args;
103
Joe Perches6bd488d2016-09-25 19:18:34 -0700104 printk("%s" "[" DRM_NAME ":%ps]%s %pV",
105 level, __builtin_return_address(0),
106 strcmp(level, KERN_ERR) == 0 ? " *ERROR*" : "", &vaf);
Sean Paulc4e68a52016-08-15 16:18:04 -0700107
108 va_end(args);
109}
110EXPORT_SYMBOL(drm_printk);
Joe Perches5ad3d882011-04-17 20:35:51 -0700111
David Herrmann0d639882014-02-24 15:53:25 +0100112/*
113 * DRM Minors
114 * A DRM device can provide several char-dev interfaces on the DRM-Major. Each
115 * of them is represented by a drm_minor object. Depending on the capabilities
116 * of the device-driver, different interfaces are registered.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 *
David Herrmann0d639882014-02-24 15:53:25 +0100118 * Minors can be accessed via dev->$minor_name. This pointer is either
119 * NULL or a valid drm_minor pointer and stays valid as long as the device is
120 * valid. This means, DRM minors have the same life-time as the underlying
121 * device. However, this doesn't mean that the minor is active. Minors are
122 * registered and unregistered dynamically according to device-state.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 */
David Herrmann0d639882014-02-24 15:53:25 +0100124
David Herrmann05b701f2014-01-29 12:43:56 +0100125static struct drm_minor **drm_minor_get_slot(struct drm_device *dev,
126 unsigned int type)
127{
128 switch (type) {
David Herrmanna3ccc462016-08-03 20:04:25 +0200129 case DRM_MINOR_PRIMARY:
David Herrmann05b701f2014-01-29 12:43:56 +0100130 return &dev->primary;
131 case DRM_MINOR_RENDER:
132 return &dev->render;
133 case DRM_MINOR_CONTROL:
134 return &dev->control;
135 default:
136 return NULL;
137 }
138}
139
140static int drm_minor_alloc(struct drm_device *dev, unsigned int type)
141{
142 struct drm_minor *minor;
David Herrmannf1b85962014-07-23 10:34:52 +0200143 unsigned long flags;
144 int r;
David Herrmann05b701f2014-01-29 12:43:56 +0100145
146 minor = kzalloc(sizeof(*minor), GFP_KERNEL);
147 if (!minor)
148 return -ENOMEM;
149
150 minor->type = type;
151 minor->dev = dev;
David Herrmann05b701f2014-01-29 12:43:56 +0100152
David Herrmannf1b85962014-07-23 10:34:52 +0200153 idr_preload(GFP_KERNEL);
154 spin_lock_irqsave(&drm_minor_lock, flags);
155 r = idr_alloc(&drm_minors_idr,
156 NULL,
157 64 * type,
158 64 * (type + 1),
159 GFP_NOWAIT);
160 spin_unlock_irqrestore(&drm_minor_lock, flags);
161 idr_preload_end();
162
163 if (r < 0)
164 goto err_free;
165
166 minor->index = r;
167
David Herrmanne1728072014-07-23 11:38:38 +0200168 minor->kdev = drm_sysfs_minor_alloc(minor);
169 if (IS_ERR(minor->kdev)) {
170 r = PTR_ERR(minor->kdev);
171 goto err_index;
172 }
173
David Herrmann05b701f2014-01-29 12:43:56 +0100174 *drm_minor_get_slot(dev, type) = minor;
175 return 0;
David Herrmannf1b85962014-07-23 10:34:52 +0200176
David Herrmanne1728072014-07-23 11:38:38 +0200177err_index:
178 spin_lock_irqsave(&drm_minor_lock, flags);
179 idr_remove(&drm_minors_idr, minor->index);
180 spin_unlock_irqrestore(&drm_minor_lock, flags);
David Herrmannf1b85962014-07-23 10:34:52 +0200181err_free:
182 kfree(minor);
183 return r;
David Herrmann05b701f2014-01-29 12:43:56 +0100184}
185
David Herrmannbd9dfa92014-01-29 12:55:48 +0100186static void drm_minor_free(struct drm_device *dev, unsigned int type)
187{
David Herrmannf1b85962014-07-23 10:34:52 +0200188 struct drm_minor **slot, *minor;
189 unsigned long flags;
David Herrmannbd9dfa92014-01-29 12:55:48 +0100190
191 slot = drm_minor_get_slot(dev, type);
David Herrmannf1b85962014-07-23 10:34:52 +0200192 minor = *slot;
193 if (!minor)
194 return;
195
David Herrmanne1728072014-07-23 11:38:38 +0200196 put_device(minor->kdev);
David Herrmannf1b85962014-07-23 10:34:52 +0200197
198 spin_lock_irqsave(&drm_minor_lock, flags);
199 idr_remove(&drm_minors_idr, minor->index);
200 spin_unlock_irqrestore(&drm_minor_lock, flags);
201
202 kfree(minor);
203 *slot = NULL;
David Herrmannbd9dfa92014-01-29 12:55:48 +0100204}
205
David Herrmannafcdbc82014-01-29 12:57:05 +0100206static int drm_minor_register(struct drm_device *dev, unsigned int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207{
David Herrmannf1b85962014-07-23 10:34:52 +0200208 struct drm_minor *minor;
David Herrmann0d639882014-02-24 15:53:25 +0100209 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
212 DRM_DEBUG("\n");
213
David Herrmannf1b85962014-07-23 10:34:52 +0200214 minor = *drm_minor_get_slot(dev, type);
215 if (!minor)
David Herrmann05b701f2014-01-29 12:43:56 +0100216 return 0;
217
David Herrmannf1b85962014-07-23 10:34:52 +0200218 ret = drm_debugfs_init(minor, minor->index, drm_debugfs_root);
Ben Gamari955b12d2009-02-17 20:08:49 -0500219 if (ret) {
GeunSik Lim156f5a72009-06-02 15:01:37 +0900220 DRM_ERROR("DRM: Failed to initialize /sys/kernel/debug/dri.\n");
David Herrmannf1b85962014-07-23 10:34:52 +0200221 return ret;
Ben Gamari955b12d2009-02-17 20:08:49 -0500222 }
Dave Airlie2c14f282008-04-21 16:47:32 +1000223
David Herrmanne1728072014-07-23 11:38:38 +0200224 ret = device_add(minor->kdev);
225 if (ret)
Daniel Vettercb6458f2013-08-08 15:41:34 +0200226 goto err_debugfs;
Dave Airlie2c14f282008-04-21 16:47:32 +1000227
David Herrmann0d639882014-02-24 15:53:25 +0100228 /* replace NULL with @minor so lookups will succeed from now on */
229 spin_lock_irqsave(&drm_minor_lock, flags);
David Herrmannf1b85962014-07-23 10:34:52 +0200230 idr_replace(&drm_minors_idr, minor, minor->index);
David Herrmann0d639882014-02-24 15:53:25 +0100231 spin_unlock_irqrestore(&drm_minor_lock, flags);
Dave Airlie2c14f282008-04-21 16:47:32 +1000232
David Herrmannf1b85962014-07-23 10:34:52 +0200233 DRM_DEBUG("new minor registered %d\n", minor->index);
Dave Airlie2c14f282008-04-21 16:47:32 +1000234 return 0;
235
Daniel Vettercb6458f2013-08-08 15:41:34 +0200236err_debugfs:
David Herrmannf1b85962014-07-23 10:34:52 +0200237 drm_debugfs_cleanup(minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 return ret;
239}
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000240
David Herrmannafcdbc82014-01-29 12:57:05 +0100241static void drm_minor_unregister(struct drm_device *dev, unsigned int type)
David Herrmannf73aca52013-10-20 18:55:40 +0200242{
David Herrmannafcdbc82014-01-29 12:57:05 +0100243 struct drm_minor *minor;
David Herrmann0d639882014-02-24 15:53:25 +0100244 unsigned long flags;
David Herrmannafcdbc82014-01-29 12:57:05 +0100245
246 minor = *drm_minor_get_slot(dev, type);
David Herrmanne1728072014-07-23 11:38:38 +0200247 if (!minor || !device_is_registered(minor->kdev))
David Herrmannf73aca52013-10-20 18:55:40 +0200248 return;
249
David Herrmannf1b85962014-07-23 10:34:52 +0200250 /* replace @minor with NULL so lookups will fail from now on */
David Herrmann0d639882014-02-24 15:53:25 +0100251 spin_lock_irqsave(&drm_minor_lock, flags);
David Herrmannf1b85962014-07-23 10:34:52 +0200252 idr_replace(&drm_minors_idr, NULL, minor->index);
David Herrmann0d639882014-02-24 15:53:25 +0100253 spin_unlock_irqrestore(&drm_minor_lock, flags);
David Herrmann0d639882014-02-24 15:53:25 +0100254
David Herrmanne1728072014-07-23 11:38:38 +0200255 device_del(minor->kdev);
256 dev_set_drvdata(minor->kdev, NULL); /* safety belt */
David Herrmann865fb472013-10-20 18:55:43 +0200257 drm_debugfs_cleanup(minor);
David Herrmannf73aca52013-10-20 18:55:40 +0200258}
259
260/**
David Herrmann1616c522014-01-29 10:49:19 +0100261 * drm_minor_acquire - Acquire a DRM minor
262 * @minor_id: Minor ID of the DRM-minor
David Herrmannf73aca52013-10-20 18:55:40 +0200263 *
David Herrmann1616c522014-01-29 10:49:19 +0100264 * 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.
271 *
272 * Returns:
273 * Pointer to minor-object with increased device-refcount, or PTR_ERR on
274 * failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 */
David Herrmann1616c522014-01-29 10:49:19 +0100276struct drm_minor *drm_minor_acquire(unsigned int minor_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277{
David Herrmann1616c522014-01-29 10:49:19 +0100278 struct drm_minor *minor;
David Herrmann0d639882014-02-24 15:53:25 +0100279 unsigned long flags;
Eric Anholt673a3942008-07-30 12:06:12 -0700280
David Herrmann0d639882014-02-24 15:53:25 +0100281 spin_lock_irqsave(&drm_minor_lock, flags);
David Herrmann1616c522014-01-29 10:49:19 +0100282 minor = idr_find(&drm_minors_idr, minor_id);
David Herrmann0d639882014-02-24 15:53:25 +0100283 if (minor)
284 drm_dev_ref(minor->dev);
285 spin_unlock_irqrestore(&drm_minor_lock, flags);
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000286
David Herrmann0d639882014-02-24 15:53:25 +0100287 if (!minor) {
288 return ERR_PTR(-ENODEV);
289 } else if (drm_device_is_unplugged(minor->dev)) {
290 drm_dev_unref(minor->dev);
291 return ERR_PTR(-ENODEV);
292 }
293
David Herrmann1616c522014-01-29 10:49:19 +0100294 return minor;
295}
296
297/**
298 * drm_minor_release - Release DRM minor
299 * @minor: Pointer to DRM minor object
300 *
301 * Release a minor that was previously acquired via drm_minor_acquire().
302 */
303void drm_minor_release(struct drm_minor *minor)
304{
305 drm_dev_unref(minor->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306}
Kristian Høgsberg112b7152009-01-04 16:55:33 -0500307
308/**
Daniel Vetter6e3f7972015-09-28 21:46:35 +0200309 * DOC: driver instance overview
310 *
311 * A device instance for a drm driver is represented by struct &drm_device. This
312 * is allocated with drm_dev_alloc(), usually from bus-specific ->probe()
313 * callbacks implemented by the driver. The driver then needs to initialize all
314 * the various subsystems for the drm device like memory management, vblank
315 * handling, modesetting support and intial output configuration plus obviously
Daniel Vettera7429462016-06-21 10:54:16 +0200316 * initialize all the corresponding hardware bits. Finally when everything is up
317 * and running and ready for userspace the device instance can be published
318 * using drm_dev_register().
Daniel Vetter6e3f7972015-09-28 21:46:35 +0200319 *
320 * There is also deprecated support for initalizing device instances using
321 * bus-specific helpers and the ->load() callback. But due to
322 * backwards-compatibility needs the device instance have to be published too
323 * early, which requires unpretty global locking to make safe and is therefore
324 * only support for existing drivers not yet converted to the new scheme.
325 *
326 * When cleaning up a device instance everything needs to be done in reverse:
327 * First unpublish the device instance with drm_dev_unregister(). Then clean up
328 * any other resources allocated at device initialization and drop the driver's
329 * reference to &drm_device using drm_dev_unref().
330 *
331 * Note that the lifetime rules for &drm_device instance has still a lot of
332 * historical baggage. Hence use the reference counting provided by
333 * drm_dev_ref() and drm_dev_unref() only carefully.
334 *
335 * Also note that embedding of &drm_device is currently not (yet) supported (but
336 * it would be easy to add). Drivers can store driver-private data in the
337 * dev_priv field of &drm_device.
338 */
339
Daniel Vettera7429462016-06-21 10:54:16 +0200340static int drm_dev_set_unique(struct drm_device *dev, const char *name)
341{
Tom Gundersenc6bf8112016-09-21 16:59:18 +0200342 if (!name)
343 return -EINVAL;
344
Daniel Vettera7429462016-06-21 10:54:16 +0200345 kfree(dev->unique);
346 dev->unique = kstrdup(name, GFP_KERNEL);
347
348 return dev->unique ? 0 : -ENOMEM;
349}
350
Daniel Vetter6e3f7972015-09-28 21:46:35 +0200351/**
Thierry Redingc6a1af8a2014-05-19 13:39:07 +0200352 * drm_put_dev - Unregister and release a DRM device
353 * @dev: DRM device
354 *
355 * Called at module unload time or when a PCI device is unplugged.
356 *
Kristian Høgsberg112b7152009-01-04 16:55:33 -0500357 * Cleans up all DRM device, calling drm_lastclose().
Daniel Vetter6e3f7972015-09-28 21:46:35 +0200358 *
359 * Note: Use of this function is deprecated. It will eventually go away
360 * completely. Please use drm_dev_unregister() and drm_dev_unref() explicitly
361 * instead to make sure that the device isn't userspace accessible any more
362 * while teardown is in progress, ensuring that userspace can't access an
363 * inconsistent state.
Kristian Høgsberg112b7152009-01-04 16:55:33 -0500364 */
365void drm_put_dev(struct drm_device *dev)
366{
Kristian Høgsberg112b7152009-01-04 16:55:33 -0500367 DRM_DEBUG("\n");
368
369 if (!dev) {
370 DRM_ERROR("cleanup called no dev\n");
371 return;
372 }
373
David Herrmannc3a49732013-10-02 11:23:38 +0200374 drm_dev_unregister(dev);
David Herrmann099d1c22014-01-29 10:21:36 +0100375 drm_dev_unref(dev);
Kristian Høgsberg112b7152009-01-04 16:55:33 -0500376}
377EXPORT_SYMBOL(drm_put_dev);
Dave Airlie2c07a212012-02-20 14:18:07 +0000378
379void drm_unplug_dev(struct drm_device *dev)
380{
381 /* for a USB device */
Hans de Goede1308eee2017-06-01 13:54:30 +0200382 if (drm_core_check_feature(dev, DRIVER_MODESET))
383 drm_modeset_unregister_all(dev);
384
385 drm_minor_unregister(dev, DRM_MINOR_PRIMARY);
386 drm_minor_unregister(dev, DRM_MINOR_RENDER);
387 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
Dave Airlie2c07a212012-02-20 14:18:07 +0000388
389 mutex_lock(&drm_global_mutex);
390
391 drm_device_set_unplugged(dev);
392
393 if (dev->open_count == 0) {
394 drm_put_dev(dev);
395 }
396 mutex_unlock(&drm_global_mutex);
397}
398EXPORT_SYMBOL(drm_unplug_dev);
David Herrmann1bb72532013-10-02 11:23:34 +0200399
David Herrmann31bbe162014-01-03 14:09:47 +0100400/*
401 * DRM internal mount
402 * We want to be able to allocate our own "struct address_space" to control
403 * memory-mappings in VRAM (or stolen RAM, ...). However, core MM does not allow
404 * stand-alone address_space objects, so we need an underlying inode. As there
405 * is no way to allocate an independent inode easily, we need a fake internal
406 * VFS mount-point.
407 *
408 * The drm_fs_inode_new() function allocates a new inode, drm_fs_inode_free()
409 * frees it again. You are allowed to use iget() and iput() to get references to
410 * the inode. But each drm_fs_inode_new() call must be paired with exactly one
411 * drm_fs_inode_free() call (which does not have to be the last iput()).
412 * We use drm_fs_inode_*() to manage our internal VFS mount-point and share it
413 * between multiple inode-users. You could, technically, call
414 * iget() + drm_fs_inode_free() directly after alloc and sometime later do an
415 * iput(), but this way you'd end up with a new vfsmount for each inode.
416 */
417
418static int drm_fs_cnt;
419static struct vfsmount *drm_fs_mnt;
420
421static const struct dentry_operations drm_fs_dops = {
422 .d_dname = simple_dname,
423};
424
425static const struct super_operations drm_fs_sops = {
426 .statfs = simple_statfs,
427};
428
429static struct dentry *drm_fs_mount(struct file_system_type *fs_type, int flags,
430 const char *dev_name, void *data)
431{
432 return mount_pseudo(fs_type,
433 "drm:",
434 &drm_fs_sops,
435 &drm_fs_dops,
436 0x010203ff);
437}
438
439static struct file_system_type drm_fs_type = {
440 .name = "drm",
441 .owner = THIS_MODULE,
442 .mount = drm_fs_mount,
443 .kill_sb = kill_anon_super,
444};
445
446static struct inode *drm_fs_inode_new(void)
447{
448 struct inode *inode;
449 int r;
450
451 r = simple_pin_fs(&drm_fs_type, &drm_fs_mnt, &drm_fs_cnt);
452 if (r < 0) {
453 DRM_ERROR("Cannot mount pseudo fs: %d\n", r);
454 return ERR_PTR(r);
455 }
456
457 inode = alloc_anon_inode(drm_fs_mnt->mnt_sb);
458 if (IS_ERR(inode))
459 simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
460
461 return inode;
462}
463
464static void drm_fs_inode_free(struct inode *inode)
465{
466 if (inode) {
467 iput(inode);
468 simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
469 }
470}
471
David Herrmann1bb72532013-10-02 11:23:34 +0200472/**
Chris Wilsonb209aca2016-06-15 13:17:46 +0100473 * drm_dev_init - Initialise new DRM device
474 * @dev: DRM device
475 * @driver: DRM driver
David Herrmann1bb72532013-10-02 11:23:34 +0200476 * @parent: Parent device object
477 *
Chris Wilsonb209aca2016-06-15 13:17:46 +0100478 * Initialize a new DRM device. No device registration is done.
David Herrmannc22f0ac2013-10-02 11:23:35 +0200479 * Call drm_dev_register() to advertice the device to user space and register it
Daniel Vetter6e3f7972015-09-28 21:46:35 +0200480 * with other core subsystems. This should be done last in the device
481 * initialization sequence to make sure userspace can't access an inconsistent
482 * state.
David Herrmann1bb72532013-10-02 11:23:34 +0200483 *
David Herrmann099d1c22014-01-29 10:21:36 +0100484 * The initial ref-count of the object is 1. Use drm_dev_ref() and
485 * drm_dev_unref() to take and drop further ref-counts.
486 *
Daniel Vetterb0ff4b92014-11-24 20:01:58 +0100487 * Note that for purely virtual devices @parent can be NULL.
488 *
Chris Wilsonb209aca2016-06-15 13:17:46 +0100489 * Drivers that do not want to allocate their own device struct
490 * embedding struct &drm_device can call drm_dev_alloc() instead.
491 *
David Herrmann1bb72532013-10-02 11:23:34 +0200492 * RETURNS:
Chris Wilsonb209aca2016-06-15 13:17:46 +0100493 * 0 on success, or error code on failure.
David Herrmann1bb72532013-10-02 11:23:34 +0200494 */
Chris Wilsonb209aca2016-06-15 13:17:46 +0100495int drm_dev_init(struct drm_device *dev,
496 struct drm_driver *driver,
497 struct device *parent)
David Herrmann1bb72532013-10-02 11:23:34 +0200498{
David Herrmann1bb72532013-10-02 11:23:34 +0200499 int ret;
500
David Herrmann099d1c22014-01-29 10:21:36 +0100501 kref_init(&dev->ref);
David Herrmann1bb72532013-10-02 11:23:34 +0200502 dev->dev = parent;
503 dev->driver = driver;
504
505 INIT_LIST_HEAD(&dev->filelist);
506 INIT_LIST_HEAD(&dev->ctxlist);
507 INIT_LIST_HEAD(&dev->vmalist);
508 INIT_LIST_HEAD(&dev->maplist);
509 INIT_LIST_HEAD(&dev->vblank_event_list);
510
Daniel Vetter2177a212013-12-16 11:21:06 +0100511 spin_lock_init(&dev->buf_lock);
David Herrmann1bb72532013-10-02 11:23:34 +0200512 spin_lock_init(&dev->event_lock);
513 mutex_init(&dev->struct_mutex);
Daniel Vetter1d2ac402016-04-26 19:29:41 +0200514 mutex_init(&dev->filelist_mutex);
David Herrmann1bb72532013-10-02 11:23:34 +0200515 mutex_init(&dev->ctxlist_mutex);
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100516 mutex_init(&dev->master_mutex);
David Herrmann1bb72532013-10-02 11:23:34 +0200517
David Herrmann6796cb12014-01-03 14:24:19 +0100518 dev->anon_inode = drm_fs_inode_new();
519 if (IS_ERR(dev->anon_inode)) {
520 ret = PTR_ERR(dev->anon_inode);
521 DRM_ERROR("Cannot allocate anonymous inode: %d\n", ret);
David Herrmann1bb72532013-10-02 11:23:34 +0200522 goto err_free;
David Herrmann6796cb12014-01-03 14:24:19 +0100523 }
524
David Herrmann05b701f2014-01-29 12:43:56 +0100525 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
526 ret = drm_minor_alloc(dev, DRM_MINOR_CONTROL);
527 if (ret)
528 goto err_minors;
529 }
530
David Herrmann6d6dfcf2014-03-16 14:38:40 +0100531 if (drm_core_check_feature(dev, DRIVER_RENDER)) {
David Herrmann05b701f2014-01-29 12:43:56 +0100532 ret = drm_minor_alloc(dev, DRM_MINOR_RENDER);
533 if (ret)
534 goto err_minors;
535 }
536
David Herrmanna3ccc462016-08-03 20:04:25 +0200537 ret = drm_minor_alloc(dev, DRM_MINOR_PRIMARY);
David Herrmann05b701f2014-01-29 12:43:56 +0100538 if (ret)
539 goto err_minors;
540
Chris Wilsonb209aca2016-06-15 13:17:46 +0100541 ret = drm_ht_create(&dev->map_hash, 12);
542 if (ret)
David Herrmann05b701f2014-01-29 12:43:56 +0100543 goto err_minors;
David Herrmann1bb72532013-10-02 11:23:34 +0200544
Daniel Vetterba6976c2015-06-23 11:22:36 +0200545 drm_legacy_ctxbitmap_init(dev);
David Herrmann1bb72532013-10-02 11:23:34 +0200546
Andrzej Hajda1bcecfa2014-09-30 16:49:56 +0200547 if (drm_core_check_feature(dev, DRIVER_GEM)) {
David Herrmann1bb72532013-10-02 11:23:34 +0200548 ret = drm_gem_init(dev);
549 if (ret) {
550 DRM_ERROR("Cannot initialize graphics execution manager (GEM)\n");
551 goto err_ctxbitmap;
552 }
553 }
554
Daniel Vetter5079c462016-06-21 10:54:14 +0200555 /* Use the parent device name as DRM device unique identifier, but fall
556 * back to the driver name for virtual devices like vgem. */
557 ret = drm_dev_set_unique(dev, parent ? dev_name(parent) : driver->name);
558 if (ret)
559 goto err_setunique;
Nicolas Ioosse112e592015-12-11 11:20:28 +0100560
Chris Wilsonb209aca2016-06-15 13:17:46 +0100561 return 0;
David Herrmann1bb72532013-10-02 11:23:34 +0200562
Nicolas Ioosse112e592015-12-11 11:20:28 +0100563err_setunique:
564 if (drm_core_check_feature(dev, DRIVER_GEM))
565 drm_gem_destroy(dev);
David Herrmann1bb72532013-10-02 11:23:34 +0200566err_ctxbitmap:
David Herrmanne7b960702014-07-24 12:10:04 +0200567 drm_legacy_ctxbitmap_cleanup(dev);
David Herrmann1bb72532013-10-02 11:23:34 +0200568 drm_ht_remove(&dev->map_hash);
David Herrmann05b701f2014-01-29 12:43:56 +0100569err_minors:
David Herrmanna3ccc462016-08-03 20:04:25 +0200570 drm_minor_free(dev, DRM_MINOR_PRIMARY);
David Herrmannbd9dfa92014-01-29 12:55:48 +0100571 drm_minor_free(dev, DRM_MINOR_RENDER);
572 drm_minor_free(dev, DRM_MINOR_CONTROL);
David Herrmann6796cb12014-01-03 14:24:19 +0100573 drm_fs_inode_free(dev->anon_inode);
David Herrmann1bb72532013-10-02 11:23:34 +0200574err_free:
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100575 mutex_destroy(&dev->master_mutex);
Chris Wilsonb209aca2016-06-15 13:17:46 +0100576 return ret;
577}
578EXPORT_SYMBOL(drm_dev_init);
579
580/**
581 * drm_dev_alloc - Allocate new DRM device
582 * @driver: DRM driver to allocate device for
583 * @parent: Parent device object
584 *
585 * Allocate and initialize a new DRM device. No device registration is done.
586 * Call drm_dev_register() to advertice the device to user space and register it
587 * with other core subsystems. This should be done last in the device
588 * initialization sequence to make sure userspace can't access an inconsistent
589 * state.
590 *
591 * The initial ref-count of the object is 1. Use drm_dev_ref() and
592 * drm_dev_unref() to take and drop further ref-counts.
593 *
594 * Note that for purely virtual devices @parent can be NULL.
595 *
596 * Drivers that wish to subclass or embed struct &drm_device into their
597 * own struct should look at using drm_dev_init() instead.
598 *
599 * RETURNS:
Tom Gundersen0f288602016-09-21 16:59:19 +0200600 * Pointer to new DRM device, or ERR_PTR on failure.
Chris Wilsonb209aca2016-06-15 13:17:46 +0100601 */
602struct drm_device *drm_dev_alloc(struct drm_driver *driver,
603 struct device *parent)
604{
605 struct drm_device *dev;
606 int ret;
607
608 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
609 if (!dev)
Tom Gundersen0f288602016-09-21 16:59:19 +0200610 return ERR_PTR(-ENOMEM);
Chris Wilsonb209aca2016-06-15 13:17:46 +0100611
612 ret = drm_dev_init(dev, driver, parent);
613 if (ret) {
614 kfree(dev);
Tom Gundersen0f288602016-09-21 16:59:19 +0200615 return ERR_PTR(ret);
Chris Wilsonb209aca2016-06-15 13:17:46 +0100616 }
617
618 return dev;
David Herrmann1bb72532013-10-02 11:23:34 +0200619}
620EXPORT_SYMBOL(drm_dev_alloc);
David Herrmannc22f0ac2013-10-02 11:23:35 +0200621
David Herrmann099d1c22014-01-29 10:21:36 +0100622static void drm_dev_release(struct kref *ref)
David Herrmann0dc8fe52013-10-02 11:23:37 +0200623{
David Herrmann099d1c22014-01-29 10:21:36 +0100624 struct drm_device *dev = container_of(ref, struct drm_device, ref);
David Herrmann8f6599d2013-10-20 18:55:45 +0200625
Andrzej Hajda1bcecfa2014-09-30 16:49:56 +0200626 if (drm_core_check_feature(dev, DRIVER_GEM))
David Herrmann0dc8fe52013-10-02 11:23:37 +0200627 drm_gem_destroy(dev);
628
David Herrmanne7b960702014-07-24 12:10:04 +0200629 drm_legacy_ctxbitmap_cleanup(dev);
David Herrmann0dc8fe52013-10-02 11:23:37 +0200630 drm_ht_remove(&dev->map_hash);
David Herrmann6796cb12014-01-03 14:24:19 +0100631 drm_fs_inode_free(dev->anon_inode);
David Herrmann0dc8fe52013-10-02 11:23:37 +0200632
David Herrmanna3ccc462016-08-03 20:04:25 +0200633 drm_minor_free(dev, DRM_MINOR_PRIMARY);
David Herrmannbd9dfa92014-01-29 12:55:48 +0100634 drm_minor_free(dev, DRM_MINOR_RENDER);
635 drm_minor_free(dev, DRM_MINOR_CONTROL);
636
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100637 mutex_destroy(&dev->master_mutex);
Thierry Redingca8e2ad2014-04-11 15:23:00 +0200638 kfree(dev->unique);
David Herrmann0dc8fe52013-10-02 11:23:37 +0200639 kfree(dev);
640}
David Herrmann099d1c22014-01-29 10:21:36 +0100641
642/**
643 * drm_dev_ref - Take reference of a DRM device
644 * @dev: device to take reference of or NULL
645 *
646 * This increases the ref-count of @dev by one. You *must* already own a
647 * reference when calling this. Use drm_dev_unref() to drop this reference
648 * again.
649 *
650 * This function never fails. However, this function does not provide *any*
651 * guarantee whether the device is alive or running. It only provides a
652 * reference to the object and the memory associated with it.
653 */
654void drm_dev_ref(struct drm_device *dev)
655{
656 if (dev)
657 kref_get(&dev->ref);
658}
659EXPORT_SYMBOL(drm_dev_ref);
660
661/**
662 * drm_dev_unref - Drop reference of a DRM device
663 * @dev: device to drop reference of or NULL
664 *
665 * This decreases the ref-count of @dev by one. The device is destroyed if the
666 * ref-count drops to zero.
667 */
668void drm_dev_unref(struct drm_device *dev)
669{
670 if (dev)
671 kref_put(&dev->ref, drm_dev_release);
672}
673EXPORT_SYMBOL(drm_dev_unref);
David Herrmann0dc8fe52013-10-02 11:23:37 +0200674
675/**
David Herrmannc22f0ac2013-10-02 11:23:35 +0200676 * drm_dev_register - Register DRM device
677 * @dev: Device to register
Thierry Redingc6a1af8a2014-05-19 13:39:07 +0200678 * @flags: Flags passed to the driver's .load() function
David Herrmannc22f0ac2013-10-02 11:23:35 +0200679 *
680 * Register the DRM device @dev with the system, advertise device to user-space
681 * and start normal device operation. @dev must be allocated via drm_dev_alloc()
Chris Wilsone28cd4d2016-06-17 09:25:17 +0100682 * previously.
David Herrmannc22f0ac2013-10-02 11:23:35 +0200683 *
684 * Never call this twice on any device!
685 *
Daniel Vetter6e3f7972015-09-28 21:46:35 +0200686 * NOTE: To ensure backward compatibility with existing drivers method this
687 * function calls the ->load() method after registering the device nodes,
688 * creating race conditions. Usage of the ->load() methods is therefore
689 * deprecated, drivers must perform all initialization before calling
690 * drm_dev_register().
691 *
David Herrmannc22f0ac2013-10-02 11:23:35 +0200692 * RETURNS:
693 * 0 on success, negative error code on failure.
694 */
695int drm_dev_register(struct drm_device *dev, unsigned long flags)
696{
697 int ret;
698
699 mutex_lock(&drm_global_mutex);
700
David Herrmannafcdbc82014-01-29 12:57:05 +0100701 ret = drm_minor_register(dev, DRM_MINOR_CONTROL);
David Herrmannc22f0ac2013-10-02 11:23:35 +0200702 if (ret)
David Herrmann05b701f2014-01-29 12:43:56 +0100703 goto err_minors;
704
David Herrmannafcdbc82014-01-29 12:57:05 +0100705 ret = drm_minor_register(dev, DRM_MINOR_RENDER);
David Herrmann05b701f2014-01-29 12:43:56 +0100706 if (ret)
707 goto err_minors;
708
David Herrmanna3ccc462016-08-03 20:04:25 +0200709 ret = drm_minor_register(dev, DRM_MINOR_PRIMARY);
David Herrmann05b701f2014-01-29 12:43:56 +0100710 if (ret)
711 goto err_minors;
David Herrmannc22f0ac2013-10-02 11:23:35 +0200712
Daniel Vetter326fdff2017-01-12 17:15:56 +0100713 dev->registered = true;
714
David Herrmannc22f0ac2013-10-02 11:23:35 +0200715 if (dev->driver->load) {
716 ret = dev->driver->load(dev, flags);
717 if (ret)
David Herrmann05b701f2014-01-29 12:43:56 +0100718 goto err_minors;
David Herrmannc22f0ac2013-10-02 11:23:35 +0200719 }
720
Chris Wilsonbee7fb12016-06-18 14:46:41 +0100721 if (drm_core_check_feature(dev, DRIVER_MODESET))
Benjamin Gaignard79190ea2016-06-21 16:37:09 +0200722 drm_modeset_register_all(dev);
Chris Wilsone28cd4d2016-06-17 09:25:17 +0100723
David Herrmannc22f0ac2013-10-02 11:23:35 +0200724 ret = 0;
725 goto out_unlock;
726
David Herrmann05b701f2014-01-29 12:43:56 +0100727err_minors:
David Herrmanna3ccc462016-08-03 20:04:25 +0200728 drm_minor_unregister(dev, DRM_MINOR_PRIMARY);
David Herrmannafcdbc82014-01-29 12:57:05 +0100729 drm_minor_unregister(dev, DRM_MINOR_RENDER);
730 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
David Herrmannc22f0ac2013-10-02 11:23:35 +0200731out_unlock:
732 mutex_unlock(&drm_global_mutex);
733 return ret;
734}
735EXPORT_SYMBOL(drm_dev_register);
David Herrmannc3a49732013-10-02 11:23:38 +0200736
737/**
738 * drm_dev_unregister - Unregister DRM device
739 * @dev: Device to unregister
740 *
741 * Unregister the DRM device from the system. This does the reverse of
742 * drm_dev_register() but does not deallocate the device. The caller must call
David Herrmann099d1c22014-01-29 10:21:36 +0100743 * drm_dev_unref() to drop their final reference.
Daniel Vetter6e3f7972015-09-28 21:46:35 +0200744 *
745 * This should be called first in the device teardown code to make sure
746 * userspace can't access the device instance any more.
David Herrmannc3a49732013-10-02 11:23:38 +0200747 */
748void drm_dev_unregister(struct drm_device *dev)
749{
750 struct drm_map_list *r_list, *list_temp;
751
752 drm_lastclose(dev);
753
Daniel Vetter326fdff2017-01-12 17:15:56 +0100754 dev->registered = false;
755
Chris Wilsonbee7fb12016-06-18 14:46:41 +0100756 if (drm_core_check_feature(dev, DRIVER_MODESET))
Benjamin Gaignard79190ea2016-06-21 16:37:09 +0200757 drm_modeset_unregister_all(dev);
Chris Wilsone28cd4d2016-06-17 09:25:17 +0100758
David Herrmannc3a49732013-10-02 11:23:38 +0200759 if (dev->driver->unload)
760 dev->driver->unload(dev);
761
Daniel Vetter4efafeb2013-12-11 11:34:38 +0100762 if (dev->agp)
763 drm_pci_agp_destroy(dev);
David Herrmannc3a49732013-10-02 11:23:38 +0200764
765 drm_vblank_cleanup(dev);
766
767 list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head)
David Herrmann9fc5cde2014-08-29 12:12:28 +0200768 drm_legacy_rmmap(dev, r_list->map);
David Herrmannc3a49732013-10-02 11:23:38 +0200769
David Herrmanna3ccc462016-08-03 20:04:25 +0200770 drm_minor_unregister(dev, DRM_MINOR_PRIMARY);
David Herrmannafcdbc82014-01-29 12:57:05 +0100771 drm_minor_unregister(dev, DRM_MINOR_RENDER);
772 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
David Herrmannc3a49732013-10-02 11:23:38 +0200773}
774EXPORT_SYMBOL(drm_dev_unregister);
Thierry Redingca8e2ad2014-04-11 15:23:00 +0200775
David Herrmann1b7199f2014-07-23 12:29:56 +0200776/*
777 * DRM Core
778 * The DRM core module initializes all global DRM objects and makes them
779 * available to drivers. Once setup, drivers can probe their respective
780 * devices.
781 * Currently, core management includes:
782 * - The "DRM-Global" key/value database
783 * - Global ID management for connectors
784 * - DRM major number allocation
785 * - DRM minor management
786 * - DRM sysfs class
787 * - DRM debugfs root
788 *
789 * Furthermore, the DRM core provides dynamic char-dev lookups. For each
790 * interface registered on a DRM device, you can request minor numbers from DRM
791 * core. DRM core takes care of major-number management and char-dev
792 * registration. A stub ->open() callback forwards any open() requests to the
793 * registered minor.
794 */
795
796static int drm_stub_open(struct inode *inode, struct file *filp)
797{
798 const struct file_operations *new_fops;
799 struct drm_minor *minor;
800 int err;
801
802 DRM_DEBUG("\n");
803
804 mutex_lock(&drm_global_mutex);
805 minor = drm_minor_acquire(iminor(inode));
806 if (IS_ERR(minor)) {
807 err = PTR_ERR(minor);
808 goto out_unlock;
809 }
810
811 new_fops = fops_get(minor->dev->driver->fops);
812 if (!new_fops) {
813 err = -ENODEV;
814 goto out_release;
815 }
816
817 replace_fops(filp, new_fops);
818 if (filp->f_op->open)
819 err = filp->f_op->open(inode, filp);
820 else
821 err = 0;
822
823out_release:
824 drm_minor_release(minor);
825out_unlock:
826 mutex_unlock(&drm_global_mutex);
827 return err;
828}
829
830static const struct file_operations drm_stub_fops = {
831 .owner = THIS_MODULE,
832 .open = drm_stub_open,
833 .llseek = noop_llseek,
834};
835
David Herrmann2cc107d2016-09-01 14:48:37 +0200836static void drm_core_exit(void)
837{
838 unregister_chrdev(DRM_MAJOR, "drm");
839 debugfs_remove(drm_debugfs_root);
840 drm_sysfs_destroy();
841 idr_destroy(&drm_minors_idr);
842 drm_connector_ida_destroy();
843 drm_global_release();
844}
845
David Herrmann1b7199f2014-07-23 12:29:56 +0200846static int __init drm_core_init(void)
847{
David Herrmann2cc107d2016-09-01 14:48:37 +0200848 int ret;
David Herrmann1b7199f2014-07-23 12:29:56 +0200849
850 drm_global_init();
851 drm_connector_ida_init();
852 idr_init(&drm_minors_idr);
853
David Herrmannfcc90212015-09-09 14:21:30 +0200854 ret = drm_sysfs_init();
855 if (ret < 0) {
David Herrmann2cc107d2016-09-01 14:48:37 +0200856 DRM_ERROR("Cannot create DRM class: %d\n", ret);
857 goto error;
David Herrmann1b7199f2014-07-23 12:29:56 +0200858 }
859
860 drm_debugfs_root = debugfs_create_dir("dri", NULL);
861 if (!drm_debugfs_root) {
David Herrmann2cc107d2016-09-01 14:48:37 +0200862 ret = -ENOMEM;
863 DRM_ERROR("Cannot create debugfs-root: %d\n", ret);
864 goto error;
David Herrmann1b7199f2014-07-23 12:29:56 +0200865 }
866
David Herrmann2cc107d2016-09-01 14:48:37 +0200867 ret = register_chrdev(DRM_MAJOR, "drm", &drm_stub_fops);
868 if (ret < 0)
869 goto error;
870
David Herrmann82d5e732016-09-01 14:48:36 +0200871 DRM_INFO("Initialized\n");
David Herrmann1b7199f2014-07-23 12:29:56 +0200872 return 0;
David Herrmann1b7199f2014-07-23 12:29:56 +0200873
David Herrmann2cc107d2016-09-01 14:48:37 +0200874error:
875 drm_core_exit();
David Herrmann1b7199f2014-07-23 12:29:56 +0200876 return ret;
877}
878
David Herrmann1b7199f2014-07-23 12:29:56 +0200879module_init(drm_core_init);
880module_exit(drm_core_exit);