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