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