b595b64291a2a8b38212aa4401457592e2307c4e
[cascardo/linux.git] / drivers / gpu / drm / drm_stub.c
1 /**
2  * \file drm_stub.h
3  * Stub support
4  *
5  * \author Rickard E. (Rik) Faith <faith@valinux.com>
6  */
7
8 /*
9  * Created: Fri Jan 19 10:48:35 2001 by faith@acm.org
10  *
11  * Copyright 2001 VA Linux Systems, Inc., Sunnyvale, California.
12  * All Rights Reserved.
13  *
14  * Permission is hereby granted, free of charge, to any person obtaining a
15  * copy of this software and associated documentation files (the "Software"),
16  * to deal in the Software without restriction, including without limitation
17  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
18  * and/or sell copies of the Software, and to permit persons to whom the
19  * Software is furnished to do so, subject to the following conditions:
20  *
21  * The above copyright notice and this permission notice (including the next
22  * paragraph) shall be included in all copies or substantial portions of the
23  * Software.
24  *
25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
26  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
27  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
28  * PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
29  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
30  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
31  * DEALINGS IN THE SOFTWARE.
32  */
33
34 #include <linux/module.h>
35 #include <linux/moduleparam.h>
36 #include <linux/slab.h>
37 #include <drm/drmP.h>
38 #include <drm/drm_core.h>
39
40 unsigned int drm_debug = 0;     /* 1 to enable debug output */
41 EXPORT_SYMBOL(drm_debug);
42
43 unsigned int drm_rnodes = 0;    /* 1 to enable experimental render nodes API */
44 EXPORT_SYMBOL(drm_rnodes);
45
46 unsigned int drm_vblank_offdelay = 5000;    /* Default to 5000 msecs. */
47 EXPORT_SYMBOL(drm_vblank_offdelay);
48
49 unsigned int drm_timestamp_precision = 20;  /* Default to 20 usecs. */
50 EXPORT_SYMBOL(drm_timestamp_precision);
51
52 /*
53  * Default to use monotonic timestamps for wait-for-vblank and page-flip
54  * complete events.
55  */
56 unsigned int drm_timestamp_monotonic = 1;
57
58 MODULE_AUTHOR(CORE_AUTHOR);
59 MODULE_DESCRIPTION(CORE_DESC);
60 MODULE_LICENSE("GPL and additional rights");
61 MODULE_PARM_DESC(debug, "Enable debug output");
62 MODULE_PARM_DESC(rnodes, "Enable experimental render nodes API");
63 MODULE_PARM_DESC(vblankoffdelay, "Delay until vblank irq auto-disable [msecs]");
64 MODULE_PARM_DESC(timestamp_precision_usec, "Max. error on timestamps [usecs]");
65 MODULE_PARM_DESC(timestamp_monotonic, "Use monotonic timestamps");
66
67 module_param_named(debug, drm_debug, int, 0600);
68 module_param_named(rnodes, drm_rnodes, int, 0600);
69 module_param_named(vblankoffdelay, drm_vblank_offdelay, int, 0600);
70 module_param_named(timestamp_precision_usec, drm_timestamp_precision, int, 0600);
71 module_param_named(timestamp_monotonic, drm_timestamp_monotonic, int, 0600);
72
73 struct idr drm_minors_idr;
74
75 struct class *drm_class;
76 struct dentry *drm_debugfs_root;
77
78 int drm_err(const char *func, const char *format, ...)
79 {
80         struct va_format vaf;
81         va_list args;
82         int r;
83
84         va_start(args, format);
85
86         vaf.fmt = format;
87         vaf.va = &args;
88
89         r = printk(KERN_ERR "[" DRM_NAME ":%s] *ERROR* %pV", func, &vaf);
90
91         va_end(args);
92
93         return r;
94 }
95 EXPORT_SYMBOL(drm_err);
96
97 void drm_ut_debug_printk(unsigned int request_level,
98                          const char *prefix,
99                          const char *function_name,
100                          const char *format, ...)
101 {
102         struct va_format vaf;
103         va_list args;
104
105         if (drm_debug & request_level) {
106                 va_start(args, format);
107                 vaf.fmt = format;
108                 vaf.va = &args;
109
110                 if (function_name)
111                         printk(KERN_DEBUG "[%s:%s], %pV", prefix,
112                                function_name, &vaf);
113                 else
114                         printk(KERN_DEBUG "%pV", &vaf);
115                 va_end(args);
116         }
117 }
118 EXPORT_SYMBOL(drm_ut_debug_printk);
119
120 static int drm_minor_get_id(struct drm_device *dev, int type)
121 {
122         int ret;
123         int base = 0, limit = 63;
124
125         if (type == DRM_MINOR_CONTROL) {
126                 base += 64;
127                 limit = base + 63;
128         } else if (type == DRM_MINOR_RENDER) {
129                 base += 128;
130                 limit = base + 63;
131         }
132
133         mutex_lock(&dev->struct_mutex);
134         ret = idr_alloc(&drm_minors_idr, NULL, base, limit, GFP_KERNEL);
135         mutex_unlock(&dev->struct_mutex);
136
137         return ret == -ENOSPC ? -EINVAL : ret;
138 }
139
140 struct drm_master *drm_master_create(struct drm_minor *minor)
141 {
142         struct drm_master *master;
143
144         master = kzalloc(sizeof(*master), GFP_KERNEL);
145         if (!master)
146                 return NULL;
147
148         kref_init(&master->refcount);
149         spin_lock_init(&master->lock.spinlock);
150         init_waitqueue_head(&master->lock.lock_queue);
151         drm_ht_create(&master->magiclist, DRM_MAGIC_HASH_ORDER);
152         INIT_LIST_HEAD(&master->magicfree);
153         master->minor = minor;
154
155         list_add_tail(&master->head, &minor->master_list);
156
157         return master;
158 }
159
160 struct drm_master *drm_master_get(struct drm_master *master)
161 {
162         kref_get(&master->refcount);
163         return master;
164 }
165 EXPORT_SYMBOL(drm_master_get);
166
167 static void drm_master_destroy(struct kref *kref)
168 {
169         struct drm_master *master = container_of(kref, struct drm_master, refcount);
170         struct drm_magic_entry *pt, *next;
171         struct drm_device *dev = master->minor->dev;
172         struct drm_map_list *r_list, *list_temp;
173
174         list_del(&master->head);
175
176         if (dev->driver->master_destroy)
177                 dev->driver->master_destroy(dev, master);
178
179         list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head) {
180                 if (r_list->master == master) {
181                         drm_rmmap_locked(dev, r_list->map);
182                         r_list = NULL;
183                 }
184         }
185
186         if (master->unique) {
187                 kfree(master->unique);
188                 master->unique = NULL;
189                 master->unique_len = 0;
190         }
191
192         kfree(dev->devname);
193         dev->devname = NULL;
194
195         list_for_each_entry_safe(pt, next, &master->magicfree, head) {
196                 list_del(&pt->head);
197                 drm_ht_remove_item(&master->magiclist, &pt->hash_item);
198                 kfree(pt);
199         }
200
201         drm_ht_remove(&master->magiclist);
202
203         kfree(master);
204 }
205
206 void drm_master_put(struct drm_master **master)
207 {
208         kref_put(&(*master)->refcount, drm_master_destroy);
209         *master = NULL;
210 }
211 EXPORT_SYMBOL(drm_master_put);
212
213 int drm_setmaster_ioctl(struct drm_device *dev, void *data,
214                         struct drm_file *file_priv)
215 {
216         int ret = 0;
217
218         if (file_priv->is_master)
219                 return 0;
220
221         if (file_priv->minor->master && file_priv->minor->master != file_priv->master)
222                 return -EINVAL;
223
224         if (!file_priv->master)
225                 return -EINVAL;
226
227         if (file_priv->minor->master)
228                 return -EINVAL;
229
230         mutex_lock(&dev->struct_mutex);
231         file_priv->minor->master = drm_master_get(file_priv->master);
232         file_priv->is_master = 1;
233         if (dev->driver->master_set) {
234                 ret = dev->driver->master_set(dev, file_priv, false);
235                 if (unlikely(ret != 0)) {
236                         file_priv->is_master = 0;
237                         drm_master_put(&file_priv->minor->master);
238                 }
239         }
240         mutex_unlock(&dev->struct_mutex);
241
242         return ret;
243 }
244
245 int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
246                          struct drm_file *file_priv)
247 {
248         if (!file_priv->is_master)
249                 return -EINVAL;
250
251         if (!file_priv->minor->master)
252                 return -EINVAL;
253
254         mutex_lock(&dev->struct_mutex);
255         if (dev->driver->master_drop)
256                 dev->driver->master_drop(dev, file_priv, false);
257         drm_master_put(&file_priv->minor->master);
258         file_priv->is_master = 0;
259         mutex_unlock(&dev->struct_mutex);
260         return 0;
261 }
262
263 static struct drm_minor **drm_minor_get_slot(struct drm_device *dev,
264                                              unsigned int type)
265 {
266         switch (type) {
267         case DRM_MINOR_LEGACY:
268                 return &dev->primary;
269         case DRM_MINOR_RENDER:
270                 return &dev->render;
271         case DRM_MINOR_CONTROL:
272                 return &dev->control;
273         default:
274                 return NULL;
275         }
276 }
277
278 static int drm_minor_alloc(struct drm_device *dev, unsigned int type)
279 {
280         struct drm_minor *minor;
281
282         minor = kzalloc(sizeof(*minor), GFP_KERNEL);
283         if (!minor)
284                 return -ENOMEM;
285
286         minor->type = type;
287         minor->dev = dev;
288         INIT_LIST_HEAD(&minor->master_list);
289
290         *drm_minor_get_slot(dev, type) = minor;
291         return 0;
292 }
293
294 /**
295  * drm_get_minor - Register DRM minor
296  * @dev: DRM device
297  * @type: Type of minor
298  *
299  * Register minor of given type.
300  * Caller must hold the global DRM mutex.
301  *
302  * RETURNS:
303  * 0 on success, negative error code on failure.
304  */
305 static int drm_get_minor(struct drm_device *dev, unsigned int type)
306 {
307         struct drm_minor *new_minor;
308         int ret;
309         int minor_id;
310
311         DRM_DEBUG("\n");
312
313         new_minor = *drm_minor_get_slot(dev, type);
314         if (!new_minor)
315                 return 0;
316
317         minor_id = drm_minor_get_id(dev, type);
318         if (minor_id < 0)
319                 return minor_id;
320
321         new_minor->device = MKDEV(DRM_MAJOR, minor_id);
322         new_minor->index = minor_id;
323
324         idr_replace(&drm_minors_idr, new_minor, minor_id);
325
326 #if defined(CONFIG_DEBUG_FS)
327         ret = drm_debugfs_init(new_minor, minor_id, drm_debugfs_root);
328         if (ret) {
329                 DRM_ERROR("DRM: Failed to initialize /sys/kernel/debug/dri.\n");
330                 goto err_mem;
331         }
332 #endif
333
334         ret = drm_sysfs_device_add(new_minor);
335         if (ret) {
336                 printk(KERN_ERR
337                        "DRM: Error sysfs_device_add.\n");
338                 goto err_debugfs;
339         }
340
341         DRM_DEBUG("new minor assigned %d\n", minor_id);
342         return 0;
343
344
345 err_debugfs:
346 #if defined(CONFIG_DEBUG_FS)
347         drm_debugfs_cleanup(new_minor);
348 err_mem:
349 #endif
350         idr_remove(&drm_minors_idr, minor_id);
351         return ret;
352 }
353
354 /**
355  * drm_unplug_minor - Unplug DRM minor
356  * @minor: Minor to unplug
357  *
358  * Unplugs the given DRM minor but keeps the object. So after this returns,
359  * minor->dev is still valid so existing open-files can still access it to get
360  * device information from their drm_file ojects.
361  * If the minor is already unplugged or if @minor is NULL, nothing is done.
362  * The global DRM mutex must be held by the caller.
363  */
364 static void drm_unplug_minor(struct drm_minor *minor)
365 {
366         if (!minor || !minor->kdev)
367                 return;
368
369 #if defined(CONFIG_DEBUG_FS)
370         drm_debugfs_cleanup(minor);
371 #endif
372
373         drm_sysfs_device_remove(minor);
374         idr_remove(&drm_minors_idr, minor->index);
375 }
376
377 /**
378  * drm_minor_acquire - Acquire a DRM minor
379  * @minor_id: Minor ID of the DRM-minor
380  *
381  * Looks up the given minor-ID and returns the respective DRM-minor object. The
382  * refence-count of the underlying device is increased so you must release this
383  * object with drm_minor_release().
384  *
385  * As long as you hold this minor, it is guaranteed that the object and the
386  * minor->dev pointer will stay valid! However, the device may get unplugged and
387  * unregistered while you hold the minor.
388  *
389  * Returns:
390  * Pointer to minor-object with increased device-refcount, or PTR_ERR on
391  * failure.
392  */
393 struct drm_minor *drm_minor_acquire(unsigned int minor_id)
394 {
395         struct drm_minor *minor;
396
397         minor = idr_find(&drm_minors_idr, minor_id);
398         if (!minor)
399                 return ERR_PTR(-ENODEV);
400
401         drm_dev_ref(minor->dev);
402         return minor;
403 }
404
405 /**
406  * drm_minor_release - Release DRM minor
407  * @minor: Pointer to DRM minor object
408  *
409  * Release a minor that was previously acquired via drm_minor_acquire().
410  */
411 void drm_minor_release(struct drm_minor *minor)
412 {
413         drm_dev_unref(minor->dev);
414 }
415
416 /**
417  * drm_put_minor - Destroy DRM minor
418  * @minor: Minor to destroy
419  *
420  * This calls drm_unplug_minor() on the given minor and then frees it. Nothing
421  * is done if @minor is NULL. It is fine to call this on already unplugged
422  * minors.
423  * The global DRM mutex must be held by the caller.
424  */
425 static void drm_put_minor(struct drm_minor *minor)
426 {
427         if (!minor)
428                 return;
429
430         DRM_DEBUG("release secondary minor %d\n", minor->index);
431
432         drm_unplug_minor(minor);
433         kfree(minor);
434 }
435
436 /**
437  * Called via drm_exit() at module unload time or when pci device is
438  * unplugged.
439  *
440  * Cleans up all DRM device, calling drm_lastclose().
441  *
442  */
443 void drm_put_dev(struct drm_device *dev)
444 {
445         DRM_DEBUG("\n");
446
447         if (!dev) {
448                 DRM_ERROR("cleanup called no dev\n");
449                 return;
450         }
451
452         drm_dev_unregister(dev);
453         drm_dev_unref(dev);
454 }
455 EXPORT_SYMBOL(drm_put_dev);
456
457 void drm_unplug_dev(struct drm_device *dev)
458 {
459         /* for a USB device */
460         if (drm_core_check_feature(dev, DRIVER_MODESET))
461                 drm_unplug_minor(dev->control);
462         if (dev->render)
463                 drm_unplug_minor(dev->render);
464         drm_unplug_minor(dev->primary);
465
466         mutex_lock(&drm_global_mutex);
467
468         drm_device_set_unplugged(dev);
469
470         if (dev->open_count == 0) {
471                 drm_put_dev(dev);
472         }
473         mutex_unlock(&drm_global_mutex);
474 }
475 EXPORT_SYMBOL(drm_unplug_dev);
476
477 /**
478  * drm_dev_alloc - Allocate new drm device
479  * @driver: DRM driver to allocate device for
480  * @parent: Parent device object
481  *
482  * Allocate and initialize a new DRM device. No device registration is done.
483  * Call drm_dev_register() to advertice the device to user space and register it
484  * with other core subsystems.
485  *
486  * The initial ref-count of the object is 1. Use drm_dev_ref() and
487  * drm_dev_unref() to take and drop further ref-counts.
488  *
489  * RETURNS:
490  * Pointer to new DRM device, or NULL if out of memory.
491  */
492 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
493                                  struct device *parent)
494 {
495         struct drm_device *dev;
496         int ret;
497
498         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
499         if (!dev)
500                 return NULL;
501
502         kref_init(&dev->ref);
503         dev->dev = parent;
504         dev->driver = driver;
505
506         INIT_LIST_HEAD(&dev->filelist);
507         INIT_LIST_HEAD(&dev->ctxlist);
508         INIT_LIST_HEAD(&dev->vmalist);
509         INIT_LIST_HEAD(&dev->maplist);
510         INIT_LIST_HEAD(&dev->vblank_event_list);
511
512         spin_lock_init(&dev->count_lock);
513         spin_lock_init(&dev->event_lock);
514         mutex_init(&dev->struct_mutex);
515         mutex_init(&dev->ctxlist_mutex);
516
517         if (drm_core_check_feature(dev, DRIVER_MODESET)) {
518                 ret = drm_minor_alloc(dev, DRM_MINOR_CONTROL);
519                 if (ret)
520                         goto err_minors;
521         }
522
523         if (drm_core_check_feature(dev, DRIVER_RENDER) && drm_rnodes) {
524                 ret = drm_minor_alloc(dev, DRM_MINOR_RENDER);
525                 if (ret)
526                         goto err_minors;
527         }
528
529         ret = drm_minor_alloc(dev, DRM_MINOR_LEGACY);
530         if (ret)
531                 goto err_minors;
532
533         if (drm_ht_create(&dev->map_hash, 12))
534                 goto err_minors;
535
536         ret = drm_ctxbitmap_init(dev);
537         if (ret) {
538                 DRM_ERROR("Cannot allocate memory for context bitmap.\n");
539                 goto err_ht;
540         }
541
542         if (driver->driver_features & DRIVER_GEM) {
543                 ret = drm_gem_init(dev);
544                 if (ret) {
545                         DRM_ERROR("Cannot initialize graphics execution manager (GEM)\n");
546                         goto err_ctxbitmap;
547                 }
548         }
549
550         return dev;
551
552 err_ctxbitmap:
553         drm_ctxbitmap_cleanup(dev);
554 err_ht:
555         drm_ht_remove(&dev->map_hash);
556 err_minors:
557         drm_put_minor(dev->control);
558         drm_put_minor(dev->render);
559         drm_put_minor(dev->primary);
560         kfree(dev);
561         return NULL;
562 }
563 EXPORT_SYMBOL(drm_dev_alloc);
564
565 static void drm_dev_release(struct kref *ref)
566 {
567         struct drm_device *dev = container_of(ref, struct drm_device, ref);
568
569         drm_put_minor(dev->control);
570         drm_put_minor(dev->render);
571         drm_put_minor(dev->primary);
572
573         if (dev->driver->driver_features & DRIVER_GEM)
574                 drm_gem_destroy(dev);
575
576         drm_ctxbitmap_cleanup(dev);
577         drm_ht_remove(&dev->map_hash);
578
579         kfree(dev->devname);
580         kfree(dev);
581 }
582
583 /**
584  * drm_dev_ref - Take reference of a DRM device
585  * @dev: device to take reference of or NULL
586  *
587  * This increases the ref-count of @dev by one. You *must* already own a
588  * reference when calling this. Use drm_dev_unref() to drop this reference
589  * again.
590  *
591  * This function never fails. However, this function does not provide *any*
592  * guarantee whether the device is alive or running. It only provides a
593  * reference to the object and the memory associated with it.
594  */
595 void drm_dev_ref(struct drm_device *dev)
596 {
597         if (dev)
598                 kref_get(&dev->ref);
599 }
600 EXPORT_SYMBOL(drm_dev_ref);
601
602 /**
603  * drm_dev_unref - Drop reference of a DRM device
604  * @dev: device to drop reference of or NULL
605  *
606  * This decreases the ref-count of @dev by one. The device is destroyed if the
607  * ref-count drops to zero.
608  */
609 void drm_dev_unref(struct drm_device *dev)
610 {
611         if (dev)
612                 kref_put(&dev->ref, drm_dev_release);
613 }
614 EXPORT_SYMBOL(drm_dev_unref);
615
616 /**
617  * drm_dev_register - Register DRM device
618  * @dev: Device to register
619  *
620  * Register the DRM device @dev with the system, advertise device to user-space
621  * and start normal device operation. @dev must be allocated via drm_dev_alloc()
622  * previously.
623  *
624  * Never call this twice on any device!
625  *
626  * RETURNS:
627  * 0 on success, negative error code on failure.
628  */
629 int drm_dev_register(struct drm_device *dev, unsigned long flags)
630 {
631         int ret;
632
633         mutex_lock(&drm_global_mutex);
634
635         ret = drm_get_minor(dev, DRM_MINOR_CONTROL);
636         if (ret)
637                 goto err_minors;
638
639         ret = drm_get_minor(dev, DRM_MINOR_RENDER);
640         if (ret)
641                 goto err_minors;
642
643         ret = drm_get_minor(dev, DRM_MINOR_LEGACY);
644         if (ret)
645                 goto err_minors;
646
647         if (dev->driver->load) {
648                 ret = dev->driver->load(dev, flags);
649                 if (ret)
650                         goto err_minors;
651         }
652
653         /* setup grouping for legacy outputs */
654         if (drm_core_check_feature(dev, DRIVER_MODESET)) {
655                 ret = drm_mode_group_init_legacy_group(dev,
656                                 &dev->primary->mode_group);
657                 if (ret)
658                         goto err_unload;
659         }
660
661         ret = 0;
662         goto out_unlock;
663
664 err_unload:
665         if (dev->driver->unload)
666                 dev->driver->unload(dev);
667 err_minors:
668         drm_unplug_minor(dev->control);
669         drm_unplug_minor(dev->render);
670         drm_unplug_minor(dev->primary);
671 out_unlock:
672         mutex_unlock(&drm_global_mutex);
673         return ret;
674 }
675 EXPORT_SYMBOL(drm_dev_register);
676
677 /**
678  * drm_dev_unregister - Unregister DRM device
679  * @dev: Device to unregister
680  *
681  * Unregister the DRM device from the system. This does the reverse of
682  * drm_dev_register() but does not deallocate the device. The caller must call
683  * drm_dev_unref() to drop their final reference.
684  */
685 void drm_dev_unregister(struct drm_device *dev)
686 {
687         struct drm_map_list *r_list, *list_temp;
688
689         drm_lastclose(dev);
690
691         if (dev->driver->unload)
692                 dev->driver->unload(dev);
693
694         if (dev->agp)
695                 drm_pci_agp_destroy(dev);
696
697         drm_vblank_cleanup(dev);
698
699         list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head)
700                 drm_rmmap(dev, r_list->map);
701
702         drm_unplug_minor(dev->control);
703         drm_unplug_minor(dev->render);
704         drm_unplug_minor(dev->primary);
705 }
706 EXPORT_SYMBOL(drm_dev_unregister);