blob: 3b04c25100aebd19ed38dbb486d30fa8929b7a1f [file] [log] [blame]
Daniel Vetterf5752b32014-05-08 16:41:51 +02001/*
2 * drm_irq.c IRQ and vblank support
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
4 * \author Rickard E. (Rik) Faith <faith@valinux.com>
5 * \author Gareth Hughes <gareth@valinux.com>
Daniel Vetter3ed43512017-05-31 11:21:46 +02006 *
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice (including the next
15 * paragraph) shall be included in all copies or substantial portions of the
16 * Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
22 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
23 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
24 * OTHER DEALINGS IN THE SOFTWARE.
Linus Torvalds1da177e2005-04-16 15:20:36 -070025 */
26
27/*
28 * Created: Fri Mar 19 14:30:16 1999 by faith@valinux.com
29 *
30 * Copyright 1999, 2000 Precision Insight, Inc., Cedar Park, Texas.
31 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
32 * All Rights Reserved.
33 *
34 * Permission is hereby granted, free of charge, to any person obtaining a
35 * copy of this software and associated documentation files (the "Software"),
36 * to deal in the Software without restriction, including without limitation
37 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
38 * and/or sell copies of the Software, and to permit persons to whom the
39 * Software is furnished to do so, subject to the following conditions:
40 *
41 * The above copyright notice and this permission notice (including the next
42 * paragraph) shall be included in all copies or substantial portions of the
43 * Software.
44 *
45 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
46 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
47 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
48 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
49 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
50 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
51 * OTHER DEALINGS IN THE SOFTWARE.
52 */
53
Daniel Vetter3ed43512017-05-31 11:21:46 +020054#include <drm/drm_irq.h>
David Howells760285e2012-10-02 18:01:07 +010055#include <drm/drmP.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
57#include <linux/interrupt.h> /* For task queue support */
58
Dave Airlie28d52042009-09-21 14:33:58 +100059#include <linux/vgaarb.h>
Paul Gortmaker2d1a8a42011-08-30 18:16:33 -040060#include <linux/export.h>
Mario Kleiner27641c32010-10-23 04:20:23 +020061
Daniel Vetter3ed43512017-05-31 11:21:46 +020062#include "drm_internal.h"
Jesse Barnes0a3e67a2008-09-30 12:14:26 -070063
Linus Torvalds1da177e2005-04-16 15:20:36 -070064/**
Daniel Vetter16584b22017-05-31 11:22:53 +020065 * DOC: irq helpers
66 *
67 * The DRM core provides very simple support helpers to enable IRQ handling on a
68 * device through the drm_irq_install() and drm_irq_uninstall() functions. This
69 * only supports devices with a single interrupt on the main device stored in
70 * &drm_device.dev and set as the device paramter in drm_dev_alloc().
71 *
72 * These IRQ helpers are strictly optional. Drivers which roll their own only
73 * need to set &drm_device.irq_enabled to signal the DRM core that vblank
74 * interrupts are working. Since these helpers don't automatically clean up the
75 * requested interrupt like e.g. devm_request_irq() they're not really
76 * recommended.
77 */
78
79/**
Daniel Vetterf5752b32014-05-08 16:41:51 +020080 * drm_irq_install - install IRQ handler
81 * @dev: DRM device
82 * @irq: IRQ number to install the handler for
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 *
Jesse Barnes0a3e67a2008-09-30 12:14:26 -070084 * Initializes the IRQ related data. Installs the handler, calling the driver
Daniel Vetter16584b22017-05-31 11:22:53 +020085 * &drm_driver.irq_preinstall and &drm_driver.irq_postinstall functions before
86 * and after the installation.
Daniel Vetterf5752b32014-05-08 16:41:51 +020087 *
88 * This is the simplified helper interface provided for drivers with no special
89 * needs. Drivers which need to install interrupt handlers for multiple
Daniel Vetteref40cbf92017-01-25 07:26:47 +010090 * interrupts must instead set &drm_device.irq_enabled to signal the DRM core
Daniel Vetterf5752b32014-05-08 16:41:51 +020091 * that vblank interrupts are available.
92 *
Daniel Vetter16584b22017-05-31 11:22:53 +020093 * @irq must match the interrupt number that would be passed to request_irq(),
94 * if called directly instead of using this helper function.
95 *
96 * &drm_driver.irq_handler is called to handle the registered interrupt.
97 *
Daniel Vetterf5752b32014-05-08 16:41:51 +020098 * Returns:
99 * Zero on success or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 */
Daniel Vetterbb0f1b52013-11-03 21:09:27 +0100101int drm_irq_install(struct drm_device *dev, int irq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102{
Laurent Pinchart4a1b0712012-05-17 13:27:21 +0200103 int ret;
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000104 unsigned long sh_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
106 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
107 return -EINVAL;
108
Daniel Vetter7c1a38e2013-12-16 11:21:15 +0100109 if (irq == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 return -EINVAL;
111
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 /* Driver must have been initialized */
Daniel Vettere090c532013-11-03 20:27:05 +0100113 if (!dev->dev_private)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115
Daniel Vettere090c532013-11-03 20:27:05 +0100116 if (dev->irq_enabled)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 return -EBUSY;
Ville Syrjälä44238432013-10-04 14:53:37 +0300118 dev->irq_enabled = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
Daniel Vetter7c1a38e2013-12-16 11:21:15 +0100120 DRM_DEBUG("irq=%d\n", irq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000122 /* Before installing handler */
Joonyoung Shim5037f8a2011-08-04 05:41:01 +0000123 if (dev->driver->irq_preinstall)
124 dev->driver->irq_preinstall(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000126 /* Install handler */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 if (drm_core_check_feature(dev, DRIVER_IRQ_SHARED))
Thomas Gleixner935f6e32006-07-01 19:29:34 -0700128 sh_flags = IRQF_SHARED;
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000129
Daniel Vetter7c1a38e2013-12-16 11:21:15 +0100130 ret = request_irq(irq, dev->driver->irq_handler,
Daniel Vetter5829d182013-11-03 21:48:48 +0100131 sh_flags, dev->driver->name, dev);
Jesse Barnes9bfbd5c2008-09-15 15:00:33 -0700132
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000133 if (ret < 0) {
Ville Syrjälä44238432013-10-04 14:53:37 +0300134 dev->irq_enabled = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 return ret;
136 }
137
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000138 /* After installing handler */
Joonyoung Shim5037f8a2011-08-04 05:41:01 +0000139 if (dev->driver->irq_postinstall)
140 ret = dev->driver->irq_postinstall(dev);
141
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700142 if (ret < 0) {
Ville Syrjälä44238432013-10-04 14:53:37 +0300143 dev->irq_enabled = false;
Daniel Vetterfa538642016-08-03 21:11:10 +0200144 if (drm_core_check_feature(dev, DRIVER_LEGACY))
Joonyoung Shime1c44ac2011-08-04 05:41:00 +0000145 vga_client_register(dev->pdev, NULL, NULL, NULL);
Daniel Vetter7c1a38e2013-12-16 11:21:15 +0100146 free_irq(irq, dev);
147 } else {
148 dev->irq = irq;
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700149 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700151 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152}
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700153EXPORT_SYMBOL(drm_irq_install);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
155/**
Daniel Vetterf5752b32014-05-08 16:41:51 +0200156 * drm_irq_uninstall - uninstall the IRQ handler
157 * @dev: DRM device
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 *
Daniel Vetter16584b22017-05-31 11:22:53 +0200159 * Calls the driver's &drm_driver.irq_uninstall function and unregisters the IRQ
160 * handler. This should only be called by drivers which used drm_irq_install()
161 * to set up their interrupt handler. Other drivers must only reset
Daniel Vetteref40cbf92017-01-25 07:26:47 +0100162 * &drm_device.irq_enabled to false.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 *
Daniel Vetterf5752b32014-05-08 16:41:51 +0200164 * Note that for kernel modesetting drivers it is a bug if this function fails.
165 * The sanity checks are only to catch buggy user modesetting drivers which call
166 * the same function through an ioctl.
167 *
168 * Returns:
169 * Zero on success or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 */
Mario Kleiner27641c32010-10-23 04:20:23 +0200171int drm_irq_uninstall(struct drm_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172{
Jesse Barnesdc1336f2009-01-06 10:21:24 -0800173 unsigned long irqflags;
Ville Syrjälä44238432013-10-04 14:53:37 +0300174 bool irq_enabled;
175 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
177 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
178 return -EINVAL;
179
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 irq_enabled = dev->irq_enabled;
Ville Syrjälä44238432013-10-04 14:53:37 +0300181 dev->irq_enabled = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
Jesse Barnesdc1336f2009-01-06 10:21:24 -0800183 /*
Daniel Vetter3bff93d2015-02-22 15:11:19 +0100184 * Wake up any waiters so they don't hang. This is just to paper over
Frank Binnsc78d1ca2016-06-24 11:15:37 +0100185 * issues for UMS drivers which aren't in full control of their
Daniel Vetter3bff93d2015-02-22 15:11:19 +0100186 * vblank/irq handling. KMS drivers must ensure that vblanks are all
187 * disabled when uninstalling the irq handler.
Jesse Barnesdc1336f2009-01-06 10:21:24 -0800188 */
Ben Skeggsbde48892011-07-04 12:52:27 +1000189 if (dev->num_crtcs) {
190 spin_lock_irqsave(&dev->vbl_lock, irqflags);
191 for (i = 0; i < dev->num_crtcs; i++) {
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300192 struct drm_vblank_crtc *vblank = &dev->vblank[i];
193
Daniel Vetter3bff93d2015-02-22 15:11:19 +0100194 if (!vblank->enabled)
195 continue;
196
197 WARN_ON(drm_core_check_feature(dev, DRIVER_MODESET));
198
Daniel Vetter3ed43512017-05-31 11:21:46 +0200199 drm_vblank_disable_and_save(dev, i);
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300200 wake_up(&vblank->queue);
Ben Skeggsbde48892011-07-04 12:52:27 +1000201 }
202 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
Jesse Barnesdc1336f2009-01-06 10:21:24 -0800203 }
Jesse Barnesdc1336f2009-01-06 10:21:24 -0800204
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000205 if (!irq_enabled)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 return -EINVAL;
207
Daniel Vetter7c1a38e2013-12-16 11:21:15 +0100208 DRM_DEBUG("irq=%d\n", dev->irq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209
Daniel Vetterfa538642016-08-03 21:11:10 +0200210 if (drm_core_check_feature(dev, DRIVER_LEGACY))
Dave Airlie28d52042009-09-21 14:33:58 +1000211 vga_client_register(dev->pdev, NULL, NULL, NULL);
212
Joonyoung Shim5037f8a2011-08-04 05:41:01 +0000213 if (dev->driver->irq_uninstall)
214 dev->driver->irq_uninstall(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215
Daniel Vetter7c1a38e2013-12-16 11:21:15 +0100216 free_irq(dev->irq, dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
218 return 0;
219}
220EXPORT_SYMBOL(drm_irq_uninstall);
221
Daniel Vetter25a99392016-12-14 00:08:02 +0100222int drm_legacy_irq_control(struct drm_device *dev, void *data,
223 struct drm_file *file_priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224{
Eric Anholtc153f452007-09-03 12:06:45 +1000225 struct drm_control *ctl = data;
Daniel Vettera319c1a2013-11-03 21:09:15 +0100226 int ret = 0, irq;
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000227
Mario Kleiner27641c32010-10-23 04:20:23 +0200228 /* if we haven't irq we fallback for compatibility reasons -
229 * this used to be a separate function in drm_dma.h
230 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
Daniel Vetter22471cf2013-11-03 20:02:50 +0100232 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
233 return 0;
Daniel Vetterfa538642016-08-03 21:11:10 +0200234 if (!drm_core_check_feature(dev, DRIVER_LEGACY))
Daniel Vetter22471cf2013-11-03 20:02:50 +0100235 return 0;
Frank Binnsc78d1ca2016-06-24 11:15:37 +0100236 /* UMS was only ever supported on pci devices. */
Daniel Vetter22471cf2013-11-03 20:02:50 +0100237 if (WARN_ON(!dev->pdev))
238 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239
Eric Anholtc153f452007-09-03 12:06:45 +1000240 switch (ctl->func) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 case DRM_INST_HANDLER:
Daniel Vettera319c1a2013-11-03 21:09:15 +0100242 irq = dev->pdev->irq;
243
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 if (dev->if_version < DRM_IF_VERSION(1, 2) &&
Daniel Vettera319c1a2013-11-03 21:09:15 +0100245 ctl->irq != irq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 return -EINVAL;
Daniel Vettere090c532013-11-03 20:27:05 +0100247 mutex_lock(&dev->struct_mutex);
Daniel Vetterbb0f1b52013-11-03 21:09:27 +0100248 ret = drm_irq_install(dev, irq);
Daniel Vettere090c532013-11-03 20:27:05 +0100249 mutex_unlock(&dev->struct_mutex);
250
251 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 case DRM_UNINST_HANDLER:
Daniel Vettere090c532013-11-03 20:27:05 +0100253 mutex_lock(&dev->struct_mutex);
254 ret = drm_irq_uninstall(dev);
255 mutex_unlock(&dev->struct_mutex);
256
257 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 default:
259 return -EINVAL;
260 }
261}