Loading...
1/*
2 * Created: Fri Jan 19 10:48:35 2001 by faith@acm.org
3 *
4 * Copyright 2001 VA Linux Systems, Inc., Sunnyvale, California.
5 * All Rights Reserved.
6 *
7 * Author Rickard E. (Rik) Faith <faith@valinux.com>
8 *
9 * Permission is hereby granted, free of charge, to any person obtaining a
10 * copy of this software and associated documentation files (the "Software"),
11 * to deal in the Software without restriction, including without limitation
12 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
13 * and/or sell copies of the Software, and to permit persons to whom the
14 * Software is furnished to do so, subject to the following conditions:
15 *
16 * The above copyright notice and this permission notice (including the next
17 * paragraph) shall be included in all copies or substantial portions of the
18 * Software.
19 *
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
23 * PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
24 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
25 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
26 * DEALINGS IN THE SOFTWARE.
27 */
28
29#include <linux/debugfs.h>
30#include <linux/fs.h>
31#include <linux/module.h>
32#include <linux/moduleparam.h>
33#include <linux/mount.h>
34#include <linux/pseudo_fs.h>
35#include <linux/slab.h>
36#include <linux/srcu.h>
37
38#include <drm/drm_accel.h>
39#include <drm/drm_cache.h>
40#include <drm/drm_client.h>
41#include <drm/drm_color_mgmt.h>
42#include <drm/drm_drv.h>
43#include <drm/drm_file.h>
44#include <drm/drm_managed.h>
45#include <drm/drm_mode_object.h>
46#include <drm/drm_print.h>
47#include <drm/drm_privacy_screen_machine.h>
48
49#include "drm_crtc_internal.h"
50#include "drm_internal.h"
51#include "drm_legacy.h"
52
53MODULE_AUTHOR("Gareth Hughes, Leif Delgass, José Fonseca, Jon Smirl");
54MODULE_DESCRIPTION("DRM shared core routines");
55MODULE_LICENSE("GPL and additional rights");
56
57static DEFINE_SPINLOCK(drm_minor_lock);
58static struct idr drm_minors_idr;
59
60/*
61 * If the drm core fails to init for whatever reason,
62 * we should prevent any drivers from registering with it.
63 * It's best to check this at drm_dev_init(), as some drivers
64 * prefer to embed struct drm_device into their own device
65 * structure and call drm_dev_init() themselves.
66 */
67static bool drm_core_init_complete;
68
69static struct dentry *drm_debugfs_root;
70
71DEFINE_STATIC_SRCU(drm_unplug_srcu);
72
73/*
74 * DRM Minors
75 * A DRM device can provide several char-dev interfaces on the DRM-Major. Each
76 * of them is represented by a drm_minor object. Depending on the capabilities
77 * of the device-driver, different interfaces are registered.
78 *
79 * Minors can be accessed via dev->$minor_name. This pointer is either
80 * NULL or a valid drm_minor pointer and stays valid as long as the device is
81 * valid. This means, DRM minors have the same life-time as the underlying
82 * device. However, this doesn't mean that the minor is active. Minors are
83 * registered and unregistered dynamically according to device-state.
84 */
85
86static struct drm_minor **drm_minor_get_slot(struct drm_device *dev,
87 unsigned int type)
88{
89 switch (type) {
90 case DRM_MINOR_PRIMARY:
91 return &dev->primary;
92 case DRM_MINOR_RENDER:
93 return &dev->render;
94 case DRM_MINOR_ACCEL:
95 return &dev->accel;
96 default:
97 BUG();
98 }
99}
100
101static void drm_minor_alloc_release(struct drm_device *dev, void *data)
102{
103 struct drm_minor *minor = data;
104 unsigned long flags;
105
106 WARN_ON(dev != minor->dev);
107
108 put_device(minor->kdev);
109
110 if (minor->type == DRM_MINOR_ACCEL) {
111 accel_minor_remove(minor->index);
112 } else {
113 spin_lock_irqsave(&drm_minor_lock, flags);
114 idr_remove(&drm_minors_idr, minor->index);
115 spin_unlock_irqrestore(&drm_minor_lock, flags);
116 }
117}
118
119static int drm_minor_alloc(struct drm_device *dev, unsigned int type)
120{
121 struct drm_minor *minor;
122 unsigned long flags;
123 int r;
124
125 minor = drmm_kzalloc(dev, sizeof(*minor), GFP_KERNEL);
126 if (!minor)
127 return -ENOMEM;
128
129 minor->type = type;
130 minor->dev = dev;
131
132 idr_preload(GFP_KERNEL);
133 if (type == DRM_MINOR_ACCEL) {
134 r = accel_minor_alloc();
135 } else {
136 spin_lock_irqsave(&drm_minor_lock, flags);
137 r = idr_alloc(&drm_minors_idr,
138 NULL,
139 64 * type,
140 64 * (type + 1),
141 GFP_NOWAIT);
142 spin_unlock_irqrestore(&drm_minor_lock, flags);
143 }
144 idr_preload_end();
145
146 if (r < 0)
147 return r;
148
149 minor->index = r;
150
151 r = drmm_add_action_or_reset(dev, drm_minor_alloc_release, minor);
152 if (r)
153 return r;
154
155 minor->kdev = drm_sysfs_minor_alloc(minor);
156 if (IS_ERR(minor->kdev))
157 return PTR_ERR(minor->kdev);
158
159 *drm_minor_get_slot(dev, type) = minor;
160 return 0;
161}
162
163static int drm_minor_register(struct drm_device *dev, unsigned int type)
164{
165 struct drm_minor *minor;
166 unsigned long flags;
167 int ret;
168
169 DRM_DEBUG("\n");
170
171 minor = *drm_minor_get_slot(dev, type);
172 if (!minor)
173 return 0;
174
175 if (minor->type == DRM_MINOR_ACCEL) {
176 accel_debugfs_init(minor, minor->index);
177 } else {
178 ret = drm_debugfs_init(minor, minor->index, drm_debugfs_root);
179 if (ret) {
180 DRM_ERROR("DRM: Failed to initialize /sys/kernel/debug/dri.\n");
181 goto err_debugfs;
182 }
183 }
184
185 ret = device_add(minor->kdev);
186 if (ret)
187 goto err_debugfs;
188
189 /* replace NULL with @minor so lookups will succeed from now on */
190 if (minor->type == DRM_MINOR_ACCEL) {
191 accel_minor_replace(minor, minor->index);
192 } else {
193 spin_lock_irqsave(&drm_minor_lock, flags);
194 idr_replace(&drm_minors_idr, minor, minor->index);
195 spin_unlock_irqrestore(&drm_minor_lock, flags);
196 }
197
198 DRM_DEBUG("new minor registered %d\n", minor->index);
199 return 0;
200
201err_debugfs:
202 drm_debugfs_cleanup(minor);
203 return ret;
204}
205
206static void drm_minor_unregister(struct drm_device *dev, unsigned int type)
207{
208 struct drm_minor *minor;
209 unsigned long flags;
210
211 minor = *drm_minor_get_slot(dev, type);
212 if (!minor || !device_is_registered(minor->kdev))
213 return;
214
215 /* replace @minor with NULL so lookups will fail from now on */
216 if (minor->type == DRM_MINOR_ACCEL) {
217 accel_minor_replace(NULL, minor->index);
218 } else {
219 spin_lock_irqsave(&drm_minor_lock, flags);
220 idr_replace(&drm_minors_idr, NULL, minor->index);
221 spin_unlock_irqrestore(&drm_minor_lock, flags);
222 }
223
224 device_del(minor->kdev);
225 dev_set_drvdata(minor->kdev, NULL); /* safety belt */
226 drm_debugfs_cleanup(minor);
227}
228
229/*
230 * Looks up the given minor-ID and returns the respective DRM-minor object. The
231 * refence-count of the underlying device is increased so you must release this
232 * object with drm_minor_release().
233 *
234 * As long as you hold this minor, it is guaranteed that the object and the
235 * minor->dev pointer will stay valid! However, the device may get unplugged and
236 * unregistered while you hold the minor.
237 */
238struct drm_minor *drm_minor_acquire(unsigned int minor_id)
239{
240 struct drm_minor *minor;
241 unsigned long flags;
242
243 spin_lock_irqsave(&drm_minor_lock, flags);
244 minor = idr_find(&drm_minors_idr, minor_id);
245 if (minor)
246 drm_dev_get(minor->dev);
247 spin_unlock_irqrestore(&drm_minor_lock, flags);
248
249 if (!minor) {
250 return ERR_PTR(-ENODEV);
251 } else if (drm_dev_is_unplugged(minor->dev)) {
252 drm_dev_put(minor->dev);
253 return ERR_PTR(-ENODEV);
254 }
255
256 return minor;
257}
258
259void drm_minor_release(struct drm_minor *minor)
260{
261 drm_dev_put(minor->dev);
262}
263
264/**
265 * DOC: driver instance overview
266 *
267 * A device instance for a drm driver is represented by &struct drm_device. This
268 * is allocated and initialized with devm_drm_dev_alloc(), usually from
269 * bus-specific ->probe() callbacks implemented by the driver. The driver then
270 * needs to initialize all the various subsystems for the drm device like memory
271 * management, vblank handling, modesetting support and initial output
272 * configuration plus obviously initialize all the corresponding hardware bits.
273 * Finally when everything is up and running and ready for userspace the device
274 * instance can be published using drm_dev_register().
275 *
276 * There is also deprecated support for initializing device instances using
277 * bus-specific helpers and the &drm_driver.load callback. But due to
278 * backwards-compatibility needs the device instance have to be published too
279 * early, which requires unpretty global locking to make safe and is therefore
280 * only support for existing drivers not yet converted to the new scheme.
281 *
282 * When cleaning up a device instance everything needs to be done in reverse:
283 * First unpublish the device instance with drm_dev_unregister(). Then clean up
284 * any other resources allocated at device initialization and drop the driver's
285 * reference to &drm_device using drm_dev_put().
286 *
287 * Note that any allocation or resource which is visible to userspace must be
288 * released only when the final drm_dev_put() is called, and not when the
289 * driver is unbound from the underlying physical struct &device. Best to use
290 * &drm_device managed resources with drmm_add_action(), drmm_kmalloc() and
291 * related functions.
292 *
293 * devres managed resources like devm_kmalloc() can only be used for resources
294 * directly related to the underlying hardware device, and only used in code
295 * paths fully protected by drm_dev_enter() and drm_dev_exit().
296 *
297 * Display driver example
298 * ~~~~~~~~~~~~~~~~~~~~~~
299 *
300 * The following example shows a typical structure of a DRM display driver.
301 * The example focus on the probe() function and the other functions that is
302 * almost always present and serves as a demonstration of devm_drm_dev_alloc().
303 *
304 * .. code-block:: c
305 *
306 * struct driver_device {
307 * struct drm_device drm;
308 * void *userspace_facing;
309 * struct clk *pclk;
310 * };
311 *
312 * static const struct drm_driver driver_drm_driver = {
313 * [...]
314 * };
315 *
316 * static int driver_probe(struct platform_device *pdev)
317 * {
318 * struct driver_device *priv;
319 * struct drm_device *drm;
320 * int ret;
321 *
322 * priv = devm_drm_dev_alloc(&pdev->dev, &driver_drm_driver,
323 * struct driver_device, drm);
324 * if (IS_ERR(priv))
325 * return PTR_ERR(priv);
326 * drm = &priv->drm;
327 *
328 * ret = drmm_mode_config_init(drm);
329 * if (ret)
330 * return ret;
331 *
332 * priv->userspace_facing = drmm_kzalloc(..., GFP_KERNEL);
333 * if (!priv->userspace_facing)
334 * return -ENOMEM;
335 *
336 * priv->pclk = devm_clk_get(dev, "PCLK");
337 * if (IS_ERR(priv->pclk))
338 * return PTR_ERR(priv->pclk);
339 *
340 * // Further setup, display pipeline etc
341 *
342 * platform_set_drvdata(pdev, drm);
343 *
344 * drm_mode_config_reset(drm);
345 *
346 * ret = drm_dev_register(drm);
347 * if (ret)
348 * return ret;
349 *
350 * drm_fbdev_generic_setup(drm, 32);
351 *
352 * return 0;
353 * }
354 *
355 * // This function is called before the devm_ resources are released
356 * static int driver_remove(struct platform_device *pdev)
357 * {
358 * struct drm_device *drm = platform_get_drvdata(pdev);
359 *
360 * drm_dev_unregister(drm);
361 * drm_atomic_helper_shutdown(drm)
362 *
363 * return 0;
364 * }
365 *
366 * // This function is called on kernel restart and shutdown
367 * static void driver_shutdown(struct platform_device *pdev)
368 * {
369 * drm_atomic_helper_shutdown(platform_get_drvdata(pdev));
370 * }
371 *
372 * static int __maybe_unused driver_pm_suspend(struct device *dev)
373 * {
374 * return drm_mode_config_helper_suspend(dev_get_drvdata(dev));
375 * }
376 *
377 * static int __maybe_unused driver_pm_resume(struct device *dev)
378 * {
379 * drm_mode_config_helper_resume(dev_get_drvdata(dev));
380 *
381 * return 0;
382 * }
383 *
384 * static const struct dev_pm_ops driver_pm_ops = {
385 * SET_SYSTEM_SLEEP_PM_OPS(driver_pm_suspend, driver_pm_resume)
386 * };
387 *
388 * static struct platform_driver driver_driver = {
389 * .driver = {
390 * [...]
391 * .pm = &driver_pm_ops,
392 * },
393 * .probe = driver_probe,
394 * .remove = driver_remove,
395 * .shutdown = driver_shutdown,
396 * };
397 * module_platform_driver(driver_driver);
398 *
399 * Drivers that want to support device unplugging (USB, DT overlay unload) should
400 * use drm_dev_unplug() instead of drm_dev_unregister(). The driver must protect
401 * regions that is accessing device resources to prevent use after they're
402 * released. This is done using drm_dev_enter() and drm_dev_exit(). There is one
403 * shortcoming however, drm_dev_unplug() marks the drm_device as unplugged before
404 * drm_atomic_helper_shutdown() is called. This means that if the disable code
405 * paths are protected, they will not run on regular driver module unload,
406 * possibly leaving the hardware enabled.
407 */
408
409/**
410 * drm_put_dev - Unregister and release a DRM device
411 * @dev: DRM device
412 *
413 * Called at module unload time or when a PCI device is unplugged.
414 *
415 * Cleans up all DRM device, calling drm_lastclose().
416 *
417 * Note: Use of this function is deprecated. It will eventually go away
418 * completely. Please use drm_dev_unregister() and drm_dev_put() explicitly
419 * instead to make sure that the device isn't userspace accessible any more
420 * while teardown is in progress, ensuring that userspace can't access an
421 * inconsistent state.
422 */
423void drm_put_dev(struct drm_device *dev)
424{
425 DRM_DEBUG("\n");
426
427 if (!dev) {
428 DRM_ERROR("cleanup called no dev\n");
429 return;
430 }
431
432 drm_dev_unregister(dev);
433 drm_dev_put(dev);
434}
435EXPORT_SYMBOL(drm_put_dev);
436
437/**
438 * drm_dev_enter - Enter device critical section
439 * @dev: DRM device
440 * @idx: Pointer to index that will be passed to the matching drm_dev_exit()
441 *
442 * This function marks and protects the beginning of a section that should not
443 * be entered after the device has been unplugged. The section end is marked
444 * with drm_dev_exit(). Calls to this function can be nested.
445 *
446 * Returns:
447 * True if it is OK to enter the section, false otherwise.
448 */
449bool drm_dev_enter(struct drm_device *dev, int *idx)
450{
451 *idx = srcu_read_lock(&drm_unplug_srcu);
452
453 if (dev->unplugged) {
454 srcu_read_unlock(&drm_unplug_srcu, *idx);
455 return false;
456 }
457
458 return true;
459}
460EXPORT_SYMBOL(drm_dev_enter);
461
462/**
463 * drm_dev_exit - Exit device critical section
464 * @idx: index returned from drm_dev_enter()
465 *
466 * This function marks the end of a section that should not be entered after
467 * the device has been unplugged.
468 */
469void drm_dev_exit(int idx)
470{
471 srcu_read_unlock(&drm_unplug_srcu, idx);
472}
473EXPORT_SYMBOL(drm_dev_exit);
474
475/**
476 * drm_dev_unplug - unplug a DRM device
477 * @dev: DRM device
478 *
479 * This unplugs a hotpluggable DRM device, which makes it inaccessible to
480 * userspace operations. Entry-points can use drm_dev_enter() and
481 * drm_dev_exit() to protect device resources in a race free manner. This
482 * essentially unregisters the device like drm_dev_unregister(), but can be
483 * called while there are still open users of @dev.
484 */
485void drm_dev_unplug(struct drm_device *dev)
486{
487 /*
488 * After synchronizing any critical read section is guaranteed to see
489 * the new value of ->unplugged, and any critical section which might
490 * still have seen the old value of ->unplugged is guaranteed to have
491 * finished.
492 */
493 dev->unplugged = true;
494 synchronize_srcu(&drm_unplug_srcu);
495
496 drm_dev_unregister(dev);
497
498 /* Clear all CPU mappings pointing to this device */
499 unmap_mapping_range(dev->anon_inode->i_mapping, 0, 0, 1);
500}
501EXPORT_SYMBOL(drm_dev_unplug);
502
503/*
504 * DRM internal mount
505 * We want to be able to allocate our own "struct address_space" to control
506 * memory-mappings in VRAM (or stolen RAM, ...). However, core MM does not allow
507 * stand-alone address_space objects, so we need an underlying inode. As there
508 * is no way to allocate an independent inode easily, we need a fake internal
509 * VFS mount-point.
510 *
511 * The drm_fs_inode_new() function allocates a new inode, drm_fs_inode_free()
512 * frees it again. You are allowed to use iget() and iput() to get references to
513 * the inode. But each drm_fs_inode_new() call must be paired with exactly one
514 * drm_fs_inode_free() call (which does not have to be the last iput()).
515 * We use drm_fs_inode_*() to manage our internal VFS mount-point and share it
516 * between multiple inode-users. You could, technically, call
517 * iget() + drm_fs_inode_free() directly after alloc and sometime later do an
518 * iput(), but this way you'd end up with a new vfsmount for each inode.
519 */
520
521static int drm_fs_cnt;
522static struct vfsmount *drm_fs_mnt;
523
524static int drm_fs_init_fs_context(struct fs_context *fc)
525{
526 return init_pseudo(fc, 0x010203ff) ? 0 : -ENOMEM;
527}
528
529static struct file_system_type drm_fs_type = {
530 .name = "drm",
531 .owner = THIS_MODULE,
532 .init_fs_context = drm_fs_init_fs_context,
533 .kill_sb = kill_anon_super,
534};
535
536static struct inode *drm_fs_inode_new(void)
537{
538 struct inode *inode;
539 int r;
540
541 r = simple_pin_fs(&drm_fs_type, &drm_fs_mnt, &drm_fs_cnt);
542 if (r < 0) {
543 DRM_ERROR("Cannot mount pseudo fs: %d\n", r);
544 return ERR_PTR(r);
545 }
546
547 inode = alloc_anon_inode(drm_fs_mnt->mnt_sb);
548 if (IS_ERR(inode))
549 simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
550
551 return inode;
552}
553
554static void drm_fs_inode_free(struct inode *inode)
555{
556 if (inode) {
557 iput(inode);
558 simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
559 }
560}
561
562/**
563 * DOC: component helper usage recommendations
564 *
565 * DRM drivers that drive hardware where a logical device consists of a pile of
566 * independent hardware blocks are recommended to use the :ref:`component helper
567 * library<component>`. For consistency and better options for code reuse the
568 * following guidelines apply:
569 *
570 * - The entire device initialization procedure should be run from the
571 * &component_master_ops.master_bind callback, starting with
572 * devm_drm_dev_alloc(), then binding all components with
573 * component_bind_all() and finishing with drm_dev_register().
574 *
575 * - The opaque pointer passed to all components through component_bind_all()
576 * should point at &struct drm_device of the device instance, not some driver
577 * specific private structure.
578 *
579 * - The component helper fills the niche where further standardization of
580 * interfaces is not practical. When there already is, or will be, a
581 * standardized interface like &drm_bridge or &drm_panel, providing its own
582 * functions to find such components at driver load time, like
583 * drm_of_find_panel_or_bridge(), then the component helper should not be
584 * used.
585 */
586
587static void drm_dev_init_release(struct drm_device *dev, void *res)
588{
589 drm_legacy_ctxbitmap_cleanup(dev);
590 drm_legacy_remove_map_hash(dev);
591 drm_fs_inode_free(dev->anon_inode);
592
593 put_device(dev->dev);
594 /* Prevent use-after-free in drm_managed_release when debugging is
595 * enabled. Slightly awkward, but can't really be helped. */
596 dev->dev = NULL;
597 mutex_destroy(&dev->master_mutex);
598 mutex_destroy(&dev->clientlist_mutex);
599 mutex_destroy(&dev->filelist_mutex);
600 mutex_destroy(&dev->struct_mutex);
601 drm_legacy_destroy_members(dev);
602}
603
604static int drm_dev_init(struct drm_device *dev,
605 const struct drm_driver *driver,
606 struct device *parent)
607{
608 struct inode *inode;
609 int ret;
610
611 if (!drm_core_init_complete) {
612 DRM_ERROR("DRM core is not initialized\n");
613 return -ENODEV;
614 }
615
616 if (WARN_ON(!parent))
617 return -EINVAL;
618
619 kref_init(&dev->ref);
620 dev->dev = get_device(parent);
621 dev->driver = driver;
622
623 INIT_LIST_HEAD(&dev->managed.resources);
624 spin_lock_init(&dev->managed.lock);
625
626 /* no per-device feature limits by default */
627 dev->driver_features = ~0u;
628
629 if (drm_core_check_feature(dev, DRIVER_COMPUTE_ACCEL) &&
630 (drm_core_check_feature(dev, DRIVER_RENDER) ||
631 drm_core_check_feature(dev, DRIVER_MODESET))) {
632 DRM_ERROR("DRM driver can't be both a compute acceleration and graphics driver\n");
633 return -EINVAL;
634 }
635
636 drm_legacy_init_members(dev);
637 INIT_LIST_HEAD(&dev->filelist);
638 INIT_LIST_HEAD(&dev->filelist_internal);
639 INIT_LIST_HEAD(&dev->clientlist);
640 INIT_LIST_HEAD(&dev->vblank_event_list);
641
642 spin_lock_init(&dev->event_lock);
643 mutex_init(&dev->struct_mutex);
644 mutex_init(&dev->filelist_mutex);
645 mutex_init(&dev->clientlist_mutex);
646 mutex_init(&dev->master_mutex);
647
648 ret = drmm_add_action_or_reset(dev, drm_dev_init_release, NULL);
649 if (ret)
650 return ret;
651
652 inode = drm_fs_inode_new();
653 if (IS_ERR(inode)) {
654 ret = PTR_ERR(inode);
655 DRM_ERROR("Cannot allocate anonymous inode: %d\n", ret);
656 goto err;
657 }
658
659 dev->anon_inode = inode;
660
661 if (drm_core_check_feature(dev, DRIVER_COMPUTE_ACCEL)) {
662 ret = drm_minor_alloc(dev, DRM_MINOR_ACCEL);
663 if (ret)
664 goto err;
665 } else {
666 if (drm_core_check_feature(dev, DRIVER_RENDER)) {
667 ret = drm_minor_alloc(dev, DRM_MINOR_RENDER);
668 if (ret)
669 goto err;
670 }
671
672 ret = drm_minor_alloc(dev, DRM_MINOR_PRIMARY);
673 if (ret)
674 goto err;
675 }
676
677 ret = drm_legacy_create_map_hash(dev);
678 if (ret)
679 goto err;
680
681 drm_legacy_ctxbitmap_init(dev);
682
683 if (drm_core_check_feature(dev, DRIVER_GEM)) {
684 ret = drm_gem_init(dev);
685 if (ret) {
686 DRM_ERROR("Cannot initialize graphics execution manager (GEM)\n");
687 goto err;
688 }
689 }
690
691 ret = drm_dev_set_unique(dev, dev_name(parent));
692 if (ret)
693 goto err;
694
695 return 0;
696
697err:
698 drm_managed_release(dev);
699
700 return ret;
701}
702
703static void devm_drm_dev_init_release(void *data)
704{
705 drm_dev_put(data);
706}
707
708static int devm_drm_dev_init(struct device *parent,
709 struct drm_device *dev,
710 const struct drm_driver *driver)
711{
712 int ret;
713
714 ret = drm_dev_init(dev, driver, parent);
715 if (ret)
716 return ret;
717
718 return devm_add_action_or_reset(parent,
719 devm_drm_dev_init_release, dev);
720}
721
722void *__devm_drm_dev_alloc(struct device *parent,
723 const struct drm_driver *driver,
724 size_t size, size_t offset)
725{
726 void *container;
727 struct drm_device *drm;
728 int ret;
729
730 container = kzalloc(size, GFP_KERNEL);
731 if (!container)
732 return ERR_PTR(-ENOMEM);
733
734 drm = container + offset;
735 ret = devm_drm_dev_init(parent, drm, driver);
736 if (ret) {
737 kfree(container);
738 return ERR_PTR(ret);
739 }
740 drmm_add_final_kfree(drm, container);
741
742 return container;
743}
744EXPORT_SYMBOL(__devm_drm_dev_alloc);
745
746/**
747 * drm_dev_alloc - Allocate new DRM device
748 * @driver: DRM driver to allocate device for
749 * @parent: Parent device object
750 *
751 * This is the deprecated version of devm_drm_dev_alloc(), which does not support
752 * subclassing through embedding the struct &drm_device in a driver private
753 * structure, and which does not support automatic cleanup through devres.
754 *
755 * RETURNS:
756 * Pointer to new DRM device, or ERR_PTR on failure.
757 */
758struct drm_device *drm_dev_alloc(const struct drm_driver *driver,
759 struct device *parent)
760{
761 struct drm_device *dev;
762 int ret;
763
764 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
765 if (!dev)
766 return ERR_PTR(-ENOMEM);
767
768 ret = drm_dev_init(dev, driver, parent);
769 if (ret) {
770 kfree(dev);
771 return ERR_PTR(ret);
772 }
773
774 drmm_add_final_kfree(dev, dev);
775
776 return dev;
777}
778EXPORT_SYMBOL(drm_dev_alloc);
779
780static void drm_dev_release(struct kref *ref)
781{
782 struct drm_device *dev = container_of(ref, struct drm_device, ref);
783
784 if (dev->driver->release)
785 dev->driver->release(dev);
786
787 drm_managed_release(dev);
788
789 kfree(dev->managed.final_kfree);
790}
791
792/**
793 * drm_dev_get - Take reference of a DRM device
794 * @dev: device to take reference of or NULL
795 *
796 * This increases the ref-count of @dev by one. You *must* already own a
797 * reference when calling this. Use drm_dev_put() to drop this reference
798 * again.
799 *
800 * This function never fails. However, this function does not provide *any*
801 * guarantee whether the device is alive or running. It only provides a
802 * reference to the object and the memory associated with it.
803 */
804void drm_dev_get(struct drm_device *dev)
805{
806 if (dev)
807 kref_get(&dev->ref);
808}
809EXPORT_SYMBOL(drm_dev_get);
810
811/**
812 * drm_dev_put - Drop reference of a DRM device
813 * @dev: device to drop reference of or NULL
814 *
815 * This decreases the ref-count of @dev by one. The device is destroyed if the
816 * ref-count drops to zero.
817 */
818void drm_dev_put(struct drm_device *dev)
819{
820 if (dev)
821 kref_put(&dev->ref, drm_dev_release);
822}
823EXPORT_SYMBOL(drm_dev_put);
824
825static int create_compat_control_link(struct drm_device *dev)
826{
827 struct drm_minor *minor;
828 char *name;
829 int ret;
830
831 if (!drm_core_check_feature(dev, DRIVER_MODESET))
832 return 0;
833
834 minor = *drm_minor_get_slot(dev, DRM_MINOR_PRIMARY);
835 if (!minor)
836 return 0;
837
838 /*
839 * Some existing userspace out there uses the existing of the controlD*
840 * sysfs files to figure out whether it's a modeset driver. It only does
841 * readdir, hence a symlink is sufficient (and the least confusing
842 * option). Otherwise controlD* is entirely unused.
843 *
844 * Old controlD chardev have been allocated in the range
845 * 64-127.
846 */
847 name = kasprintf(GFP_KERNEL, "controlD%d", minor->index + 64);
848 if (!name)
849 return -ENOMEM;
850
851 ret = sysfs_create_link(minor->kdev->kobj.parent,
852 &minor->kdev->kobj,
853 name);
854
855 kfree(name);
856
857 return ret;
858}
859
860static void remove_compat_control_link(struct drm_device *dev)
861{
862 struct drm_minor *minor;
863 char *name;
864
865 if (!drm_core_check_feature(dev, DRIVER_MODESET))
866 return;
867
868 minor = *drm_minor_get_slot(dev, DRM_MINOR_PRIMARY);
869 if (!minor)
870 return;
871
872 name = kasprintf(GFP_KERNEL, "controlD%d", minor->index + 64);
873 if (!name)
874 return;
875
876 sysfs_remove_link(minor->kdev->kobj.parent, name);
877
878 kfree(name);
879}
880
881/**
882 * drm_dev_register - Register DRM device
883 * @dev: Device to register
884 * @flags: Flags passed to the driver's .load() function
885 *
886 * Register the DRM device @dev with the system, advertise device to user-space
887 * and start normal device operation. @dev must be initialized via drm_dev_init()
888 * previously.
889 *
890 * Never call this twice on any device!
891 *
892 * NOTE: To ensure backward compatibility with existing drivers method this
893 * function calls the &drm_driver.load method after registering the device
894 * nodes, creating race conditions. Usage of the &drm_driver.load methods is
895 * therefore deprecated, drivers must perform all initialization before calling
896 * drm_dev_register().
897 *
898 * RETURNS:
899 * 0 on success, negative error code on failure.
900 */
901int drm_dev_register(struct drm_device *dev, unsigned long flags)
902{
903 const struct drm_driver *driver = dev->driver;
904 int ret;
905
906 if (!driver->load)
907 drm_mode_config_validate(dev);
908
909 WARN_ON(!dev->managed.final_kfree);
910
911 if (drm_dev_needs_global_mutex(dev))
912 mutex_lock(&drm_global_mutex);
913
914 ret = drm_minor_register(dev, DRM_MINOR_RENDER);
915 if (ret)
916 goto err_minors;
917
918 ret = drm_minor_register(dev, DRM_MINOR_PRIMARY);
919 if (ret)
920 goto err_minors;
921
922 ret = drm_minor_register(dev, DRM_MINOR_ACCEL);
923 if (ret)
924 goto err_minors;
925
926 ret = create_compat_control_link(dev);
927 if (ret)
928 goto err_minors;
929
930 dev->registered = true;
931
932 if (dev->driver->load) {
933 ret = dev->driver->load(dev, flags);
934 if (ret)
935 goto err_minors;
936 }
937
938 if (drm_core_check_feature(dev, DRIVER_MODESET))
939 drm_modeset_register_all(dev);
940
941 DRM_INFO("Initialized %s %d.%d.%d %s for %s on minor %d\n",
942 driver->name, driver->major, driver->minor,
943 driver->patchlevel, driver->date,
944 dev->dev ? dev_name(dev->dev) : "virtual device",
945 dev->primary ? dev->primary->index : dev->accel->index);
946
947 goto out_unlock;
948
949err_minors:
950 remove_compat_control_link(dev);
951 drm_minor_unregister(dev, DRM_MINOR_ACCEL);
952 drm_minor_unregister(dev, DRM_MINOR_PRIMARY);
953 drm_minor_unregister(dev, DRM_MINOR_RENDER);
954out_unlock:
955 if (drm_dev_needs_global_mutex(dev))
956 mutex_unlock(&drm_global_mutex);
957 return ret;
958}
959EXPORT_SYMBOL(drm_dev_register);
960
961/**
962 * drm_dev_unregister - Unregister DRM device
963 * @dev: Device to unregister
964 *
965 * Unregister the DRM device from the system. This does the reverse of
966 * drm_dev_register() but does not deallocate the device. The caller must call
967 * drm_dev_put() to drop their final reference.
968 *
969 * A special form of unregistering for hotpluggable devices is drm_dev_unplug(),
970 * which can be called while there are still open users of @dev.
971 *
972 * This should be called first in the device teardown code to make sure
973 * userspace can't access the device instance any more.
974 */
975void drm_dev_unregister(struct drm_device *dev)
976{
977 if (drm_core_check_feature(dev, DRIVER_LEGACY))
978 drm_lastclose(dev);
979
980 dev->registered = false;
981
982 drm_client_dev_unregister(dev);
983
984 if (drm_core_check_feature(dev, DRIVER_MODESET))
985 drm_modeset_unregister_all(dev);
986
987 if (dev->driver->unload)
988 dev->driver->unload(dev);
989
990 drm_legacy_pci_agp_destroy(dev);
991 drm_legacy_rmmaps(dev);
992
993 remove_compat_control_link(dev);
994 drm_minor_unregister(dev, DRM_MINOR_ACCEL);
995 drm_minor_unregister(dev, DRM_MINOR_PRIMARY);
996 drm_minor_unregister(dev, DRM_MINOR_RENDER);
997}
998EXPORT_SYMBOL(drm_dev_unregister);
999
1000/**
1001 * drm_dev_set_unique - Set the unique name of a DRM device
1002 * @dev: device of which to set the unique name
1003 * @name: unique name
1004 *
1005 * Sets the unique name of a DRM device using the specified string. This is
1006 * already done by drm_dev_init(), drivers should only override the default
1007 * unique name for backwards compatibility reasons.
1008 *
1009 * Return: 0 on success or a negative error code on failure.
1010 */
1011int drm_dev_set_unique(struct drm_device *dev, const char *name)
1012{
1013 drmm_kfree(dev, dev->unique);
1014 dev->unique = drmm_kstrdup(dev, name, GFP_KERNEL);
1015
1016 return dev->unique ? 0 : -ENOMEM;
1017}
1018EXPORT_SYMBOL(drm_dev_set_unique);
1019
1020/*
1021 * DRM Core
1022 * The DRM core module initializes all global DRM objects and makes them
1023 * available to drivers. Once setup, drivers can probe their respective
1024 * devices.
1025 * Currently, core management includes:
1026 * - The "DRM-Global" key/value database
1027 * - Global ID management for connectors
1028 * - DRM major number allocation
1029 * - DRM minor management
1030 * - DRM sysfs class
1031 * - DRM debugfs root
1032 *
1033 * Furthermore, the DRM core provides dynamic char-dev lookups. For each
1034 * interface registered on a DRM device, you can request minor numbers from DRM
1035 * core. DRM core takes care of major-number management and char-dev
1036 * registration. A stub ->open() callback forwards any open() requests to the
1037 * registered minor.
1038 */
1039
1040static int drm_stub_open(struct inode *inode, struct file *filp)
1041{
1042 const struct file_operations *new_fops;
1043 struct drm_minor *minor;
1044 int err;
1045
1046 DRM_DEBUG("\n");
1047
1048 minor = drm_minor_acquire(iminor(inode));
1049 if (IS_ERR(minor))
1050 return PTR_ERR(minor);
1051
1052 new_fops = fops_get(minor->dev->driver->fops);
1053 if (!new_fops) {
1054 err = -ENODEV;
1055 goto out;
1056 }
1057
1058 replace_fops(filp, new_fops);
1059 if (filp->f_op->open)
1060 err = filp->f_op->open(inode, filp);
1061 else
1062 err = 0;
1063
1064out:
1065 drm_minor_release(minor);
1066
1067 return err;
1068}
1069
1070static const struct file_operations drm_stub_fops = {
1071 .owner = THIS_MODULE,
1072 .open = drm_stub_open,
1073 .llseek = noop_llseek,
1074};
1075
1076static void drm_core_exit(void)
1077{
1078 drm_privacy_screen_lookup_exit();
1079 accel_core_exit();
1080 unregister_chrdev(DRM_MAJOR, "drm");
1081 debugfs_remove(drm_debugfs_root);
1082 drm_sysfs_destroy();
1083 idr_destroy(&drm_minors_idr);
1084 drm_connector_ida_destroy();
1085}
1086
1087static int __init drm_core_init(void)
1088{
1089 int ret;
1090
1091 drm_connector_ida_init();
1092 idr_init(&drm_minors_idr);
1093 drm_memcpy_init_early();
1094
1095 ret = drm_sysfs_init();
1096 if (ret < 0) {
1097 DRM_ERROR("Cannot create DRM class: %d\n", ret);
1098 goto error;
1099 }
1100
1101 drm_debugfs_root = debugfs_create_dir("dri", NULL);
1102
1103 ret = register_chrdev(DRM_MAJOR, "drm", &drm_stub_fops);
1104 if (ret < 0)
1105 goto error;
1106
1107 ret = accel_core_init();
1108 if (ret < 0)
1109 goto error;
1110
1111 drm_privacy_screen_lookup_init();
1112
1113 drm_core_init_complete = true;
1114
1115 DRM_DEBUG("Initialized\n");
1116 return 0;
1117
1118error:
1119 drm_core_exit();
1120 return ret;
1121}
1122
1123module_init(drm_core_init);
1124module_exit(drm_core_exit);
1/*
2 * Created: Fri Jan 19 10:48:35 2001 by faith@acm.org
3 *
4 * Copyright 2001 VA Linux Systems, Inc., Sunnyvale, California.
5 * All Rights Reserved.
6 *
7 * Author Rickard E. (Rik) Faith <faith@valinux.com>
8 *
9 * Permission is hereby granted, free of charge, to any person obtaining a
10 * copy of this software and associated documentation files (the "Software"),
11 * to deal in the Software without restriction, including without limitation
12 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
13 * and/or sell copies of the Software, and to permit persons to whom the
14 * Software is furnished to do so, subject to the following conditions:
15 *
16 * The above copyright notice and this permission notice (including the next
17 * paragraph) shall be included in all copies or substantial portions of the
18 * Software.
19 *
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
23 * PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
24 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
25 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
26 * DEALINGS IN THE SOFTWARE.
27 */
28
29#include <linux/debugfs.h>
30#include <linux/fs.h>
31#include <linux/module.h>
32#include <linux/moduleparam.h>
33#include <linux/mount.h>
34#include <linux/slab.h>
35
36#include <drm/drm_drv.h>
37#include <drm/drmP.h>
38
39#include "drm_crtc_internal.h"
40#include "drm_legacy.h"
41#include "drm_internal.h"
42#include "drm_crtc_internal.h"
43
44/*
45 * drm_debug: Enable debug output.
46 * Bitmask of DRM_UT_x. See include/drm/drmP.h for details.
47 */
48unsigned int drm_debug = 0;
49EXPORT_SYMBOL(drm_debug);
50
51MODULE_AUTHOR("Gareth Hughes, Leif Delgass, José Fonseca, Jon Smirl");
52MODULE_DESCRIPTION("DRM shared core routines");
53MODULE_LICENSE("GPL and additional rights");
54MODULE_PARM_DESC(debug, "Enable debug output, where each bit enables a debug category.\n"
55"\t\tBit 0 (0x01) will enable CORE messages (drm core code)\n"
56"\t\tBit 1 (0x02) will enable DRIVER messages (drm controller code)\n"
57"\t\tBit 2 (0x04) will enable KMS messages (modesetting code)\n"
58"\t\tBit 3 (0x08) will enable PRIME messages (prime code)\n"
59"\t\tBit 4 (0x10) will enable ATOMIC messages (atomic code)\n"
60"\t\tBit 5 (0x20) will enable VBL messages (vblank code)\n"
61"\t\tBit 7 (0x80) will enable LEASE messages (leasing code)");
62module_param_named(debug, drm_debug, int, 0600);
63
64static DEFINE_SPINLOCK(drm_minor_lock);
65static struct idr drm_minors_idr;
66
67/*
68 * If the drm core fails to init for whatever reason,
69 * we should prevent any drivers from registering with it.
70 * It's best to check this at drm_dev_init(), as some drivers
71 * prefer to embed struct drm_device into their own device
72 * structure and call drm_dev_init() themselves.
73 */
74static bool drm_core_init_complete = false;
75
76static struct dentry *drm_debugfs_root;
77
78/*
79 * DRM Minors
80 * A DRM device can provide several char-dev interfaces on the DRM-Major. Each
81 * of them is represented by a drm_minor object. Depending on the capabilities
82 * of the device-driver, different interfaces are registered.
83 *
84 * Minors can be accessed via dev->$minor_name. This pointer is either
85 * NULL or a valid drm_minor pointer and stays valid as long as the device is
86 * valid. This means, DRM minors have the same life-time as the underlying
87 * device. However, this doesn't mean that the minor is active. Minors are
88 * registered and unregistered dynamically according to device-state.
89 */
90
91static struct drm_minor **drm_minor_get_slot(struct drm_device *dev,
92 unsigned int type)
93{
94 switch (type) {
95 case DRM_MINOR_PRIMARY:
96 return &dev->primary;
97 case DRM_MINOR_RENDER:
98 return &dev->render;
99 case DRM_MINOR_CONTROL:
100 return &dev->control;
101 default:
102 BUG();
103 }
104}
105
106static int drm_minor_alloc(struct drm_device *dev, unsigned int type)
107{
108 struct drm_minor *minor;
109 unsigned long flags;
110 int r;
111
112 minor = kzalloc(sizeof(*minor), GFP_KERNEL);
113 if (!minor)
114 return -ENOMEM;
115
116 minor->type = type;
117 minor->dev = dev;
118
119 idr_preload(GFP_KERNEL);
120 spin_lock_irqsave(&drm_minor_lock, flags);
121 r = idr_alloc(&drm_minors_idr,
122 NULL,
123 64 * type,
124 64 * (type + 1),
125 GFP_NOWAIT);
126 spin_unlock_irqrestore(&drm_minor_lock, flags);
127 idr_preload_end();
128
129 if (r < 0)
130 goto err_free;
131
132 minor->index = r;
133
134 minor->kdev = drm_sysfs_minor_alloc(minor);
135 if (IS_ERR(minor->kdev)) {
136 r = PTR_ERR(minor->kdev);
137 goto err_index;
138 }
139
140 *drm_minor_get_slot(dev, type) = minor;
141 return 0;
142
143err_index:
144 spin_lock_irqsave(&drm_minor_lock, flags);
145 idr_remove(&drm_minors_idr, minor->index);
146 spin_unlock_irqrestore(&drm_minor_lock, flags);
147err_free:
148 kfree(minor);
149 return r;
150}
151
152static void drm_minor_free(struct drm_device *dev, unsigned int type)
153{
154 struct drm_minor **slot, *minor;
155 unsigned long flags;
156
157 slot = drm_minor_get_slot(dev, type);
158 minor = *slot;
159 if (!minor)
160 return;
161
162 put_device(minor->kdev);
163
164 spin_lock_irqsave(&drm_minor_lock, flags);
165 idr_remove(&drm_minors_idr, minor->index);
166 spin_unlock_irqrestore(&drm_minor_lock, flags);
167
168 kfree(minor);
169 *slot = NULL;
170}
171
172static int drm_minor_register(struct drm_device *dev, unsigned int type)
173{
174 struct drm_minor *minor;
175 unsigned long flags;
176 int ret;
177
178 DRM_DEBUG("\n");
179
180 minor = *drm_minor_get_slot(dev, type);
181 if (!minor)
182 return 0;
183
184 ret = drm_debugfs_init(minor, minor->index, drm_debugfs_root);
185 if (ret) {
186 DRM_ERROR("DRM: Failed to initialize /sys/kernel/debug/dri.\n");
187 goto err_debugfs;
188 }
189
190 ret = device_add(minor->kdev);
191 if (ret)
192 goto err_debugfs;
193
194 /* replace NULL with @minor so lookups will succeed from now on */
195 spin_lock_irqsave(&drm_minor_lock, flags);
196 idr_replace(&drm_minors_idr, minor, minor->index);
197 spin_unlock_irqrestore(&drm_minor_lock, flags);
198
199 DRM_DEBUG("new minor registered %d\n", minor->index);
200 return 0;
201
202err_debugfs:
203 drm_debugfs_cleanup(minor);
204 return ret;
205}
206
207static void drm_minor_unregister(struct drm_device *dev, unsigned int type)
208{
209 struct drm_minor *minor;
210 unsigned long flags;
211
212 minor = *drm_minor_get_slot(dev, type);
213 if (!minor || !device_is_registered(minor->kdev))
214 return;
215
216 /* replace @minor with NULL so lookups will fail from now on */
217 spin_lock_irqsave(&drm_minor_lock, flags);
218 idr_replace(&drm_minors_idr, NULL, minor->index);
219 spin_unlock_irqrestore(&drm_minor_lock, flags);
220
221 device_del(minor->kdev);
222 dev_set_drvdata(minor->kdev, NULL); /* safety belt */
223 drm_debugfs_cleanup(minor);
224}
225
226/*
227 * Looks up the given minor-ID and returns the respective DRM-minor object. The
228 * refence-count of the underlying device is increased so you must release this
229 * object with drm_minor_release().
230 *
231 * As long as you hold this minor, it is guaranteed that the object and the
232 * minor->dev pointer will stay valid! However, the device may get unplugged and
233 * unregistered while you hold the minor.
234 */
235struct drm_minor *drm_minor_acquire(unsigned int minor_id)
236{
237 struct drm_minor *minor;
238 unsigned long flags;
239
240 spin_lock_irqsave(&drm_minor_lock, flags);
241 minor = idr_find(&drm_minors_idr, minor_id);
242 if (minor)
243 drm_dev_get(minor->dev);
244 spin_unlock_irqrestore(&drm_minor_lock, flags);
245
246 if (!minor) {
247 return ERR_PTR(-ENODEV);
248 } else if (drm_dev_is_unplugged(minor->dev)) {
249 drm_dev_put(minor->dev);
250 return ERR_PTR(-ENODEV);
251 }
252
253 return minor;
254}
255
256void drm_minor_release(struct drm_minor *minor)
257{
258 drm_dev_put(minor->dev);
259}
260
261/**
262 * DOC: driver instance overview
263 *
264 * A device instance for a drm driver is represented by &struct drm_device. This
265 * is allocated with drm_dev_alloc(), usually from bus-specific ->probe()
266 * callbacks implemented by the driver. The driver then needs to initialize all
267 * the various subsystems for the drm device like memory management, vblank
268 * handling, modesetting support and intial output configuration plus obviously
269 * initialize all the corresponding hardware bits. An important part of this is
270 * also calling drm_dev_set_unique() to set the userspace-visible unique name of
271 * this device instance. Finally when everything is up and running and ready for
272 * userspace the device instance can be published using drm_dev_register().
273 *
274 * There is also deprecated support for initalizing device instances using
275 * bus-specific helpers and the &drm_driver.load callback. But due to
276 * backwards-compatibility needs the device instance have to be published too
277 * early, which requires unpretty global locking to make safe and is therefore
278 * only support for existing drivers not yet converted to the new scheme.
279 *
280 * When cleaning up a device instance everything needs to be done in reverse:
281 * First unpublish the device instance with drm_dev_unregister(). Then clean up
282 * any other resources allocated at device initialization and drop the driver's
283 * reference to &drm_device using drm_dev_put().
284 *
285 * Note that the lifetime rules for &drm_device instance has still a lot of
286 * historical baggage. Hence use the reference counting provided by
287 * drm_dev_get() and drm_dev_put() only carefully.
288 *
289 * It is recommended that drivers embed &struct drm_device into their own device
290 * structure, which is supported through drm_dev_init().
291 */
292
293/**
294 * drm_put_dev - Unregister and release a DRM device
295 * @dev: DRM device
296 *
297 * Called at module unload time or when a PCI device is unplugged.
298 *
299 * Cleans up all DRM device, calling drm_lastclose().
300 *
301 * Note: Use of this function is deprecated. It will eventually go away
302 * completely. Please use drm_dev_unregister() and drm_dev_put() explicitly
303 * instead to make sure that the device isn't userspace accessible any more
304 * while teardown is in progress, ensuring that userspace can't access an
305 * inconsistent state.
306 */
307void drm_put_dev(struct drm_device *dev)
308{
309 DRM_DEBUG("\n");
310
311 if (!dev) {
312 DRM_ERROR("cleanup called no dev\n");
313 return;
314 }
315
316 drm_dev_unregister(dev);
317 drm_dev_put(dev);
318}
319EXPORT_SYMBOL(drm_put_dev);
320
321static void drm_device_set_unplugged(struct drm_device *dev)
322{
323 smp_wmb();
324 atomic_set(&dev->unplugged, 1);
325}
326
327/**
328 * drm_dev_unplug - unplug a DRM device
329 * @dev: DRM device
330 *
331 * This unplugs a hotpluggable DRM device, which makes it inaccessible to
332 * userspace operations. Entry-points can use drm_dev_is_unplugged(). This
333 * essentially unregisters the device like drm_dev_unregister(), but can be
334 * called while there are still open users of @dev.
335 */
336void drm_dev_unplug(struct drm_device *dev)
337{
338 drm_dev_unregister(dev);
339
340 mutex_lock(&drm_global_mutex);
341 drm_device_set_unplugged(dev);
342 if (dev->open_count == 0)
343 drm_dev_put(dev);
344 mutex_unlock(&drm_global_mutex);
345}
346EXPORT_SYMBOL(drm_dev_unplug);
347
348/*
349 * DRM internal mount
350 * We want to be able to allocate our own "struct address_space" to control
351 * memory-mappings in VRAM (or stolen RAM, ...). However, core MM does not allow
352 * stand-alone address_space objects, so we need an underlying inode. As there
353 * is no way to allocate an independent inode easily, we need a fake internal
354 * VFS mount-point.
355 *
356 * The drm_fs_inode_new() function allocates a new inode, drm_fs_inode_free()
357 * frees it again. You are allowed to use iget() and iput() to get references to
358 * the inode. But each drm_fs_inode_new() call must be paired with exactly one
359 * drm_fs_inode_free() call (which does not have to be the last iput()).
360 * We use drm_fs_inode_*() to manage our internal VFS mount-point and share it
361 * between multiple inode-users. You could, technically, call
362 * iget() + drm_fs_inode_free() directly after alloc and sometime later do an
363 * iput(), but this way you'd end up with a new vfsmount for each inode.
364 */
365
366static int drm_fs_cnt;
367static struct vfsmount *drm_fs_mnt;
368
369static const struct dentry_operations drm_fs_dops = {
370 .d_dname = simple_dname,
371};
372
373static const struct super_operations drm_fs_sops = {
374 .statfs = simple_statfs,
375};
376
377static struct dentry *drm_fs_mount(struct file_system_type *fs_type, int flags,
378 const char *dev_name, void *data)
379{
380 return mount_pseudo(fs_type,
381 "drm:",
382 &drm_fs_sops,
383 &drm_fs_dops,
384 0x010203ff);
385}
386
387static struct file_system_type drm_fs_type = {
388 .name = "drm",
389 .owner = THIS_MODULE,
390 .mount = drm_fs_mount,
391 .kill_sb = kill_anon_super,
392};
393
394static struct inode *drm_fs_inode_new(void)
395{
396 struct inode *inode;
397 int r;
398
399 r = simple_pin_fs(&drm_fs_type, &drm_fs_mnt, &drm_fs_cnt);
400 if (r < 0) {
401 DRM_ERROR("Cannot mount pseudo fs: %d\n", r);
402 return ERR_PTR(r);
403 }
404
405 inode = alloc_anon_inode(drm_fs_mnt->mnt_sb);
406 if (IS_ERR(inode))
407 simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
408
409 return inode;
410}
411
412static void drm_fs_inode_free(struct inode *inode)
413{
414 if (inode) {
415 iput(inode);
416 simple_release_fs(&drm_fs_mnt, &drm_fs_cnt);
417 }
418}
419
420/**
421 * drm_dev_init - Initialise new DRM device
422 * @dev: DRM device
423 * @driver: DRM driver
424 * @parent: Parent device object
425 *
426 * Initialize a new DRM device. No device registration is done.
427 * Call drm_dev_register() to advertice the device to user space and register it
428 * with other core subsystems. This should be done last in the device
429 * initialization sequence to make sure userspace can't access an inconsistent
430 * state.
431 *
432 * The initial ref-count of the object is 1. Use drm_dev_get() and
433 * drm_dev_put() to take and drop further ref-counts.
434 *
435 * Note that for purely virtual devices @parent can be NULL.
436 *
437 * Drivers that do not want to allocate their own device struct
438 * embedding &struct drm_device can call drm_dev_alloc() instead. For drivers
439 * that do embed &struct drm_device it must be placed first in the overall
440 * structure, and the overall structure must be allocated using kmalloc(): The
441 * drm core's release function unconditionally calls kfree() on the @dev pointer
442 * when the final reference is released. To override this behaviour, and so
443 * allow embedding of the drm_device inside the driver's device struct at an
444 * arbitrary offset, you must supply a &drm_driver.release callback and control
445 * the finalization explicitly.
446 *
447 * RETURNS:
448 * 0 on success, or error code on failure.
449 */
450int drm_dev_init(struct drm_device *dev,
451 struct drm_driver *driver,
452 struct device *parent)
453{
454 int ret;
455
456 if (!drm_core_init_complete) {
457 DRM_ERROR("DRM core is not initialized\n");
458 return -ENODEV;
459 }
460
461 kref_init(&dev->ref);
462 dev->dev = parent;
463 dev->driver = driver;
464
465 INIT_LIST_HEAD(&dev->filelist);
466 INIT_LIST_HEAD(&dev->ctxlist);
467 INIT_LIST_HEAD(&dev->vmalist);
468 INIT_LIST_HEAD(&dev->maplist);
469 INIT_LIST_HEAD(&dev->vblank_event_list);
470
471 spin_lock_init(&dev->buf_lock);
472 spin_lock_init(&dev->event_lock);
473 mutex_init(&dev->struct_mutex);
474 mutex_init(&dev->filelist_mutex);
475 mutex_init(&dev->ctxlist_mutex);
476 mutex_init(&dev->master_mutex);
477
478 dev->anon_inode = drm_fs_inode_new();
479 if (IS_ERR(dev->anon_inode)) {
480 ret = PTR_ERR(dev->anon_inode);
481 DRM_ERROR("Cannot allocate anonymous inode: %d\n", ret);
482 goto err_free;
483 }
484
485 if (drm_core_check_feature(dev, DRIVER_RENDER)) {
486 ret = drm_minor_alloc(dev, DRM_MINOR_RENDER);
487 if (ret)
488 goto err_minors;
489 }
490
491 ret = drm_minor_alloc(dev, DRM_MINOR_PRIMARY);
492 if (ret)
493 goto err_minors;
494
495 ret = drm_ht_create(&dev->map_hash, 12);
496 if (ret)
497 goto err_minors;
498
499 drm_legacy_ctxbitmap_init(dev);
500
501 if (drm_core_check_feature(dev, DRIVER_GEM)) {
502 ret = drm_gem_init(dev);
503 if (ret) {
504 DRM_ERROR("Cannot initialize graphics execution manager (GEM)\n");
505 goto err_ctxbitmap;
506 }
507 }
508
509 /* Use the parent device name as DRM device unique identifier, but fall
510 * back to the driver name for virtual devices like vgem. */
511 ret = drm_dev_set_unique(dev, parent ? dev_name(parent) : driver->name);
512 if (ret)
513 goto err_setunique;
514
515 return 0;
516
517err_setunique:
518 if (drm_core_check_feature(dev, DRIVER_GEM))
519 drm_gem_destroy(dev);
520err_ctxbitmap:
521 drm_legacy_ctxbitmap_cleanup(dev);
522 drm_ht_remove(&dev->map_hash);
523err_minors:
524 drm_minor_free(dev, DRM_MINOR_PRIMARY);
525 drm_minor_free(dev, DRM_MINOR_RENDER);
526 drm_minor_free(dev, DRM_MINOR_CONTROL);
527 drm_fs_inode_free(dev->anon_inode);
528err_free:
529 mutex_destroy(&dev->master_mutex);
530 mutex_destroy(&dev->ctxlist_mutex);
531 mutex_destroy(&dev->filelist_mutex);
532 mutex_destroy(&dev->struct_mutex);
533 return ret;
534}
535EXPORT_SYMBOL(drm_dev_init);
536
537/**
538 * drm_dev_fini - Finalize a dead DRM device
539 * @dev: DRM device
540 *
541 * Finalize a dead DRM device. This is the converse to drm_dev_init() and
542 * frees up all data allocated by it. All driver private data should be
543 * finalized first. Note that this function does not free the @dev, that is
544 * left to the caller.
545 *
546 * The ref-count of @dev must be zero, and drm_dev_fini() should only be called
547 * from a &drm_driver.release callback.
548 */
549void drm_dev_fini(struct drm_device *dev)
550{
551 drm_vblank_cleanup(dev);
552
553 if (drm_core_check_feature(dev, DRIVER_GEM))
554 drm_gem_destroy(dev);
555
556 drm_legacy_ctxbitmap_cleanup(dev);
557 drm_ht_remove(&dev->map_hash);
558 drm_fs_inode_free(dev->anon_inode);
559
560 drm_minor_free(dev, DRM_MINOR_PRIMARY);
561 drm_minor_free(dev, DRM_MINOR_RENDER);
562 drm_minor_free(dev, DRM_MINOR_CONTROL);
563
564 mutex_destroy(&dev->master_mutex);
565 mutex_destroy(&dev->ctxlist_mutex);
566 mutex_destroy(&dev->filelist_mutex);
567 mutex_destroy(&dev->struct_mutex);
568 kfree(dev->unique);
569}
570EXPORT_SYMBOL(drm_dev_fini);
571
572/**
573 * drm_dev_alloc - Allocate new DRM device
574 * @driver: DRM driver to allocate device for
575 * @parent: Parent device object
576 *
577 * Allocate and initialize a new DRM device. No device registration is done.
578 * Call drm_dev_register() to advertice the device to user space and register it
579 * with other core subsystems. This should be done last in the device
580 * initialization sequence to make sure userspace can't access an inconsistent
581 * state.
582 *
583 * The initial ref-count of the object is 1. Use drm_dev_get() and
584 * drm_dev_put() to take and drop further ref-counts.
585 *
586 * Note that for purely virtual devices @parent can be NULL.
587 *
588 * Drivers that wish to subclass or embed &struct drm_device into their
589 * own struct should look at using drm_dev_init() instead.
590 *
591 * RETURNS:
592 * Pointer to new DRM device, or ERR_PTR on failure.
593 */
594struct drm_device *drm_dev_alloc(struct drm_driver *driver,
595 struct device *parent)
596{
597 struct drm_device *dev;
598 int ret;
599
600 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
601 if (!dev)
602 return ERR_PTR(-ENOMEM);
603
604 ret = drm_dev_init(dev, driver, parent);
605 if (ret) {
606 kfree(dev);
607 return ERR_PTR(ret);
608 }
609
610 return dev;
611}
612EXPORT_SYMBOL(drm_dev_alloc);
613
614static void drm_dev_release(struct kref *ref)
615{
616 struct drm_device *dev = container_of(ref, struct drm_device, ref);
617
618 if (dev->driver->release) {
619 dev->driver->release(dev);
620 } else {
621 drm_dev_fini(dev);
622 kfree(dev);
623 }
624}
625
626/**
627 * drm_dev_get - Take reference of a DRM device
628 * @dev: device to take reference of or NULL
629 *
630 * This increases the ref-count of @dev by one. You *must* already own a
631 * reference when calling this. Use drm_dev_put() to drop this reference
632 * again.
633 *
634 * This function never fails. However, this function does not provide *any*
635 * guarantee whether the device is alive or running. It only provides a
636 * reference to the object and the memory associated with it.
637 */
638void drm_dev_get(struct drm_device *dev)
639{
640 if (dev)
641 kref_get(&dev->ref);
642}
643EXPORT_SYMBOL(drm_dev_get);
644
645/**
646 * drm_dev_put - Drop reference of a DRM device
647 * @dev: device to drop reference of or NULL
648 *
649 * This decreases the ref-count of @dev by one. The device is destroyed if the
650 * ref-count drops to zero.
651 */
652void drm_dev_put(struct drm_device *dev)
653{
654 if (dev)
655 kref_put(&dev->ref, drm_dev_release);
656}
657EXPORT_SYMBOL(drm_dev_put);
658
659/**
660 * drm_dev_unref - Drop reference of a DRM device
661 * @dev: device to drop reference of or NULL
662 *
663 * This is a compatibility alias for drm_dev_put() and should not be used by new
664 * code.
665 */
666void drm_dev_unref(struct drm_device *dev)
667{
668 drm_dev_put(dev);
669}
670EXPORT_SYMBOL(drm_dev_unref);
671
672static int create_compat_control_link(struct drm_device *dev)
673{
674 struct drm_minor *minor;
675 char *name;
676 int ret;
677
678 if (!drm_core_check_feature(dev, DRIVER_MODESET))
679 return 0;
680
681 minor = *drm_minor_get_slot(dev, DRM_MINOR_PRIMARY);
682 if (!minor)
683 return 0;
684
685 /*
686 * Some existing userspace out there uses the existing of the controlD*
687 * sysfs files to figure out whether it's a modeset driver. It only does
688 * readdir, hence a symlink is sufficient (and the least confusing
689 * option). Otherwise controlD* is entirely unused.
690 *
691 * Old controlD chardev have been allocated in the range
692 * 64-127.
693 */
694 name = kasprintf(GFP_KERNEL, "controlD%d", minor->index + 64);
695 if (!name)
696 return -ENOMEM;
697
698 ret = sysfs_create_link(minor->kdev->kobj.parent,
699 &minor->kdev->kobj,
700 name);
701
702 kfree(name);
703
704 return ret;
705}
706
707static void remove_compat_control_link(struct drm_device *dev)
708{
709 struct drm_minor *minor;
710 char *name;
711
712 if (!drm_core_check_feature(dev, DRIVER_MODESET))
713 return;
714
715 minor = *drm_minor_get_slot(dev, DRM_MINOR_PRIMARY);
716 if (!minor)
717 return;
718
719 name = kasprintf(GFP_KERNEL, "controlD%d", minor->index + 64);
720 if (!name)
721 return;
722
723 sysfs_remove_link(minor->kdev->kobj.parent, name);
724
725 kfree(name);
726}
727
728/**
729 * drm_dev_register - Register DRM device
730 * @dev: Device to register
731 * @flags: Flags passed to the driver's .load() function
732 *
733 * Register the DRM device @dev with the system, advertise device to user-space
734 * and start normal device operation. @dev must be allocated via drm_dev_alloc()
735 * previously.
736 *
737 * Never call this twice on any device!
738 *
739 * NOTE: To ensure backward compatibility with existing drivers method this
740 * function calls the &drm_driver.load method after registering the device
741 * nodes, creating race conditions. Usage of the &drm_driver.load methods is
742 * therefore deprecated, drivers must perform all initialization before calling
743 * drm_dev_register().
744 *
745 * RETURNS:
746 * 0 on success, negative error code on failure.
747 */
748int drm_dev_register(struct drm_device *dev, unsigned long flags)
749{
750 struct drm_driver *driver = dev->driver;
751 int ret;
752
753 mutex_lock(&drm_global_mutex);
754
755 ret = drm_minor_register(dev, DRM_MINOR_CONTROL);
756 if (ret)
757 goto err_minors;
758
759 ret = drm_minor_register(dev, DRM_MINOR_RENDER);
760 if (ret)
761 goto err_minors;
762
763 ret = drm_minor_register(dev, DRM_MINOR_PRIMARY);
764 if (ret)
765 goto err_minors;
766
767 ret = create_compat_control_link(dev);
768 if (ret)
769 goto err_minors;
770
771 dev->registered = true;
772
773 if (dev->driver->load) {
774 ret = dev->driver->load(dev, flags);
775 if (ret)
776 goto err_minors;
777 }
778
779 if (drm_core_check_feature(dev, DRIVER_MODESET))
780 drm_modeset_register_all(dev);
781
782 ret = 0;
783
784 DRM_INFO("Initialized %s %d.%d.%d %s for %s on minor %d\n",
785 driver->name, driver->major, driver->minor,
786 driver->patchlevel, driver->date,
787 dev->dev ? dev_name(dev->dev) : "virtual device",
788 dev->primary->index);
789
790 goto out_unlock;
791
792err_minors:
793 remove_compat_control_link(dev);
794 drm_minor_unregister(dev, DRM_MINOR_PRIMARY);
795 drm_minor_unregister(dev, DRM_MINOR_RENDER);
796 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
797out_unlock:
798 mutex_unlock(&drm_global_mutex);
799 return ret;
800}
801EXPORT_SYMBOL(drm_dev_register);
802
803/**
804 * drm_dev_unregister - Unregister DRM device
805 * @dev: Device to unregister
806 *
807 * Unregister the DRM device from the system. This does the reverse of
808 * drm_dev_register() but does not deallocate the device. The caller must call
809 * drm_dev_put() to drop their final reference.
810 *
811 * A special form of unregistering for hotpluggable devices is drm_dev_unplug(),
812 * which can be called while there are still open users of @dev.
813 *
814 * This should be called first in the device teardown code to make sure
815 * userspace can't access the device instance any more.
816 */
817void drm_dev_unregister(struct drm_device *dev)
818{
819 struct drm_map_list *r_list, *list_temp;
820
821 if (drm_core_check_feature(dev, DRIVER_LEGACY))
822 drm_lastclose(dev);
823
824 dev->registered = false;
825
826 if (drm_core_check_feature(dev, DRIVER_MODESET))
827 drm_modeset_unregister_all(dev);
828
829 if (dev->driver->unload)
830 dev->driver->unload(dev);
831
832 if (dev->agp)
833 drm_pci_agp_destroy(dev);
834
835 list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head)
836 drm_legacy_rmmap(dev, r_list->map);
837
838 remove_compat_control_link(dev);
839 drm_minor_unregister(dev, DRM_MINOR_PRIMARY);
840 drm_minor_unregister(dev, DRM_MINOR_RENDER);
841 drm_minor_unregister(dev, DRM_MINOR_CONTROL);
842}
843EXPORT_SYMBOL(drm_dev_unregister);
844
845/**
846 * drm_dev_set_unique - Set the unique name of a DRM device
847 * @dev: device of which to set the unique name
848 * @name: unique name
849 *
850 * Sets the unique name of a DRM device using the specified string. Drivers
851 * can use this at driver probe time if the unique name of the devices they
852 * drive is static.
853 *
854 * Return: 0 on success or a negative error code on failure.
855 */
856int drm_dev_set_unique(struct drm_device *dev, const char *name)
857{
858 kfree(dev->unique);
859 dev->unique = kstrdup(name, GFP_KERNEL);
860
861 return dev->unique ? 0 : -ENOMEM;
862}
863EXPORT_SYMBOL(drm_dev_set_unique);
864
865/*
866 * DRM Core
867 * The DRM core module initializes all global DRM objects and makes them
868 * available to drivers. Once setup, drivers can probe their respective
869 * devices.
870 * Currently, core management includes:
871 * - The "DRM-Global" key/value database
872 * - Global ID management for connectors
873 * - DRM major number allocation
874 * - DRM minor management
875 * - DRM sysfs class
876 * - DRM debugfs root
877 *
878 * Furthermore, the DRM core provides dynamic char-dev lookups. For each
879 * interface registered on a DRM device, you can request minor numbers from DRM
880 * core. DRM core takes care of major-number management and char-dev
881 * registration. A stub ->open() callback forwards any open() requests to the
882 * registered minor.
883 */
884
885static int drm_stub_open(struct inode *inode, struct file *filp)
886{
887 const struct file_operations *new_fops;
888 struct drm_minor *minor;
889 int err;
890
891 DRM_DEBUG("\n");
892
893 mutex_lock(&drm_global_mutex);
894 minor = drm_minor_acquire(iminor(inode));
895 if (IS_ERR(minor)) {
896 err = PTR_ERR(minor);
897 goto out_unlock;
898 }
899
900 new_fops = fops_get(minor->dev->driver->fops);
901 if (!new_fops) {
902 err = -ENODEV;
903 goto out_release;
904 }
905
906 replace_fops(filp, new_fops);
907 if (filp->f_op->open)
908 err = filp->f_op->open(inode, filp);
909 else
910 err = 0;
911
912out_release:
913 drm_minor_release(minor);
914out_unlock:
915 mutex_unlock(&drm_global_mutex);
916 return err;
917}
918
919static const struct file_operations drm_stub_fops = {
920 .owner = THIS_MODULE,
921 .open = drm_stub_open,
922 .llseek = noop_llseek,
923};
924
925static void drm_core_exit(void)
926{
927 unregister_chrdev(DRM_MAJOR, "drm");
928 debugfs_remove(drm_debugfs_root);
929 drm_sysfs_destroy();
930 idr_destroy(&drm_minors_idr);
931 drm_connector_ida_destroy();
932 drm_global_release();
933}
934
935static int __init drm_core_init(void)
936{
937 int ret;
938
939 drm_global_init();
940 drm_connector_ida_init();
941 idr_init(&drm_minors_idr);
942
943 ret = drm_sysfs_init();
944 if (ret < 0) {
945 DRM_ERROR("Cannot create DRM class: %d\n", ret);
946 goto error;
947 }
948
949 drm_debugfs_root = debugfs_create_dir("dri", NULL);
950 if (!drm_debugfs_root) {
951 ret = -ENOMEM;
952 DRM_ERROR("Cannot create debugfs-root: %d\n", ret);
953 goto error;
954 }
955
956 ret = register_chrdev(DRM_MAJOR, "drm", &drm_stub_fops);
957 if (ret < 0)
958 goto error;
959
960 drm_core_init_complete = true;
961
962 DRM_DEBUG("Initialized\n");
963 return 0;
964
965error:
966 drm_core_exit();
967 return ret;
968}
969
970module_init(drm_core_init);
971module_exit(drm_core_exit);