blob: b2428cb0c64d1895f406404a1fdedba3f9842a7d [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>
6 */
7
8/*
9 * Created: Fri Mar 19 14:30:16 1999 by faith@valinux.com
10 *
11 * Copyright 1999, 2000 Precision Insight, Inc., Cedar Park, Texas.
12 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
13 * All Rights Reserved.
14 *
15 * Permission is hereby granted, free of charge, to any person obtaining a
16 * copy of this software and associated documentation files (the "Software"),
17 * to deal in the Software without restriction, including without limitation
18 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
19 * and/or sell copies of the Software, and to permit persons to whom the
20 * Software is furnished to do so, subject to the following conditions:
21 *
22 * The above copyright notice and this permission notice (including the next
23 * paragraph) shall be included in all copies or substantial portions of the
24 * Software.
25 *
26 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
27 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
28 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
29 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
30 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
31 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
32 * OTHER DEALINGS IN THE SOFTWARE.
33 */
34
David Howells760285e2012-10-02 18:01:07 +010035#include <drm/drmP.h>
Jesse Barnesac2874b2010-07-01 16:47:31 -070036#include "drm_trace.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
38#include <linux/interrupt.h> /* For task queue support */
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090039#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
Dave Airlie28d52042009-09-21 14:33:58 +100041#include <linux/vgaarb.h>
Paul Gortmaker2d1a8a42011-08-30 18:16:33 -040042#include <linux/export.h>
Mario Kleiner27641c32010-10-23 04:20:23 +020043
44/* Access macro for slots in vblank timestamp ringbuffer. */
Ville Syrjälä5380e922013-10-04 14:53:36 +030045#define vblanktimestamp(dev, crtc, count) \
46 ((dev)->vblank[crtc].time[(count) % DRM_VBLANKTIME_RBSIZE])
Mario Kleiner27641c32010-10-23 04:20:23 +020047
48/* Retry timestamp calculation up to 3 times to satisfy
49 * drm_timestamp_precision before giving up.
50 */
51#define DRM_TIMESTAMP_MAXRETRIES 3
52
53/* Threshold in nanoseconds for detection of redundant
54 * vblank irq in drm_handle_vblank(). 1 msec should be ok.
55 */
56#define DRM_REDUNDANT_VBLIRQ_THRESH_NS 1000000
57
Ville Syrjälä13b030a2014-08-06 14:49:47 +030058/**
59 * drm_update_vblank_count - update the master vblank counter
60 * @dev: DRM device
61 * @crtc: counter to update
62 *
63 * Call back into the driver to update the appropriate vblank counter
64 * (specified by @crtc). Deal with wraparound, if it occurred, and
65 * update the last read value so we can deal with wraparound on the next
66 * call if necessary.
67 *
68 * Only necessary when going from off->on, to account for frames we
69 * didn't get an interrupt for.
70 *
71 * Note: caller must hold dev->vbl_lock since this reads & writes
72 * device vblank fields.
73 */
74static void drm_update_vblank_count(struct drm_device *dev, int crtc)
75{
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +030076 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
Ville Syrjälä13b030a2014-08-06 14:49:47 +030077 u32 cur_vblank, diff, tslot, rc;
78 struct timeval t_vblank;
79
80 /*
81 * Interrupts were disabled prior to this call, so deal with counter
82 * wrap if needed.
83 * NOTE! It's possible we lost a full dev->max_vblank_count events
84 * here if the register is small or we had vblank interrupts off for
85 * a long time.
86 *
87 * We repeat the hardware vblank counter & timestamp query until
88 * we get consistent results. This to prevent races between gpu
89 * updating its hardware counter while we are retrieving the
90 * corresponding vblank timestamp.
91 */
92 do {
93 cur_vblank = dev->driver->get_vblank_counter(dev, crtc);
94 rc = drm_get_last_vbltimestamp(dev, crtc, &t_vblank, 0);
95 } while (cur_vblank != dev->driver->get_vblank_counter(dev, crtc));
96
97 /* Deal with counter wrap */
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +030098 diff = cur_vblank - vblank->last;
99 if (cur_vblank < vblank->last) {
Ville Syrjälä13b030a2014-08-06 14:49:47 +0300100 diff += dev->max_vblank_count;
101
102 DRM_DEBUG("last_vblank[%d]=0x%x, cur_vblank=0x%x => diff=0x%x\n",
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300103 crtc, vblank->last, cur_vblank, diff);
Ville Syrjälä13b030a2014-08-06 14:49:47 +0300104 }
105
106 DRM_DEBUG("enabling vblank interrupts on crtc %d, missed %d\n",
107 crtc, diff);
108
109 /* Reinitialize corresponding vblank timestamp if high-precision query
110 * available. Skip this step if query unsupported or failed. Will
111 * reinitialize delayed at next vblank interrupt in that case.
112 */
113 if (rc) {
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300114 tslot = atomic_read(&vblank->count) + diff;
Ville Syrjälä13b030a2014-08-06 14:49:47 +0300115 vblanktimestamp(dev, crtc, tslot) = t_vblank;
116 }
117
118 smp_mb__before_atomic();
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300119 atomic_add(diff, &vblank->count);
Ville Syrjälä13b030a2014-08-06 14:49:47 +0300120 smp_mb__after_atomic();
121}
122
Mario Kleiner27641c32010-10-23 04:20:23 +0200123/*
Mario Kleiner27641c32010-10-23 04:20:23 +0200124 * Disable vblank irq's on crtc, make sure that last vblank count
125 * of hardware and corresponding consistent software vblank counter
126 * are preserved, even if there are any spurious vblank irq's after
127 * disable.
128 */
129static void vblank_disable_and_save(struct drm_device *dev, int crtc)
130{
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300131 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
Mario Kleiner27641c32010-10-23 04:20:23 +0200132 unsigned long irqflags;
133 u32 vblcount;
134 s64 diff_ns;
135 int vblrc;
136 struct timeval tvblank;
Egbert Eich0355cf32012-10-13 11:36:14 +0000137 int count = DRM_TIMESTAMP_MAXRETRIES;
Mario Kleiner27641c32010-10-23 04:20:23 +0200138
139 /* Prevent vblank irq processing while disabling vblank irqs,
140 * so no updates of timestamps or count can happen after we've
141 * disabled. Needed to prevent races in case of delayed irq's.
Mario Kleiner27641c32010-10-23 04:20:23 +0200142 */
Mario Kleiner27641c32010-10-23 04:20:23 +0200143 spin_lock_irqsave(&dev->vblank_time_lock, irqflags);
144
Ville Syrjälä812e7462014-08-06 14:49:48 +0300145 /*
146 * If the vblank interrupt was already disbled update the count
147 * and timestamp to maintain the appearance that the counter
148 * has been ticking all along until this time. This makes the
149 * count account for the entire time between drm_vblank_on() and
150 * drm_vblank_off().
151 */
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300152 if (!vblank->enabled) {
Ville Syrjälä812e7462014-08-06 14:49:48 +0300153 drm_update_vblank_count(dev, crtc);
154 spin_unlock_irqrestore(&dev->vblank_time_lock, irqflags);
155 return;
156 }
157
Mario Kleiner27641c32010-10-23 04:20:23 +0200158 dev->driver->disable_vblank(dev, crtc);
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300159 vblank->enabled = false;
Mario Kleiner27641c32010-10-23 04:20:23 +0200160
161 /* No further vblank irq's will be processed after
162 * this point. Get current hardware vblank count and
163 * vblank timestamp, repeat until they are consistent.
164 *
165 * FIXME: There is still a race condition here and in
166 * drm_update_vblank_count() which can cause off-by-one
167 * reinitialization of software vblank counter. If gpu
168 * vblank counter doesn't increment exactly at the leading
169 * edge of a vblank interval, then we can lose 1 count if
170 * we happen to execute between start of vblank and the
171 * delayed gpu counter increment.
172 */
173 do {
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300174 vblank->last = dev->driver->get_vblank_counter(dev, crtc);
Mario Kleiner27641c32010-10-23 04:20:23 +0200175 vblrc = drm_get_last_vbltimestamp(dev, crtc, &tvblank, 0);
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300176 } while (vblank->last != dev->driver->get_vblank_counter(dev, crtc) && (--count) && vblrc);
Egbert Eich0355cf32012-10-13 11:36:14 +0000177
178 if (!count)
179 vblrc = 0;
Mario Kleiner27641c32010-10-23 04:20:23 +0200180
181 /* Compute time difference to stored timestamp of last vblank
182 * as updated by last invocation of drm_handle_vblank() in vblank irq.
183 */
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300184 vblcount = atomic_read(&vblank->count);
Mario Kleiner27641c32010-10-23 04:20:23 +0200185 diff_ns = timeval_to_ns(&tvblank) -
186 timeval_to_ns(&vblanktimestamp(dev, crtc, vblcount));
187
188 /* If there is at least 1 msec difference between the last stored
189 * timestamp and tvblank, then we are currently executing our
190 * disable inside a new vblank interval, the tvblank timestamp
191 * corresponds to this new vblank interval and the irq handler
192 * for this vblank didn't run yet and won't run due to our disable.
193 * Therefore we need to do the job of drm_handle_vblank() and
194 * increment the vblank counter by one to account for this vblank.
195 *
196 * Skip this step if there isn't any high precision timestamp
197 * available. In that case we can't account for this and just
198 * hope for the best.
199 */
Mario Kleinerbc215122011-02-21 05:42:01 +0100200 if ((vblrc > 0) && (abs64(diff_ns) > 1000000)) {
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300201 atomic_inc(&vblank->count);
Peter Zijlstra4e857c52014-03-17 18:06:10 +0100202 smp_mb__after_atomic();
Mario Kleinerbc215122011-02-21 05:42:01 +0100203 }
Mario Kleiner27641c32010-10-23 04:20:23 +0200204
Mario Kleiner27641c32010-10-23 04:20:23 +0200205 spin_unlock_irqrestore(&dev->vblank_time_lock, irqflags);
Mario Kleiner27641c32010-10-23 04:20:23 +0200206}
207
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700208static void vblank_disable_fn(unsigned long arg)
209{
Ville Syrjäläe69595c2014-02-19 19:36:08 +0200210 struct drm_vblank_crtc *vblank = (void *)arg;
211 struct drm_device *dev = vblank->dev;
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700212 unsigned long irqflags;
Ville Syrjäläe69595c2014-02-19 19:36:08 +0200213 int crtc = vblank->crtc;
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700214
215 if (!dev->vblank_disable_allowed)
216 return;
217
Ville Syrjäläe69595c2014-02-19 19:36:08 +0200218 spin_lock_irqsave(&dev->vbl_lock, irqflags);
219 if (atomic_read(&vblank->refcount) == 0 && vblank->enabled) {
220 DRM_DEBUG("disabling vblank on crtc %d\n", crtc);
221 vblank_disable_and_save(dev, crtc);
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700222 }
Ville Syrjäläe69595c2014-02-19 19:36:08 +0200223 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700224}
225
Daniel Vetterf5752b32014-05-08 16:41:51 +0200226/**
227 * drm_vblank_cleanup - cleanup vblank support
228 * @dev: DRM device
229 *
230 * This function cleans up any resources allocated in drm_vblank_init.
231 */
Keith Packard52440212008-11-18 09:30:25 -0800232void drm_vblank_cleanup(struct drm_device *dev)
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700233{
Ville Syrjäläe69595c2014-02-19 19:36:08 +0200234 int crtc;
235
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700236 /* Bail if the driver didn't call drm_vblank_init() */
237 if (dev->num_crtcs == 0)
238 return;
239
Ville Syrjäläe69595c2014-02-19 19:36:08 +0200240 for (crtc = 0; crtc < dev->num_crtcs; crtc++) {
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300241 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
242
243 del_timer_sync(&vblank->disable_timer);
244 vblank_disable_fn((unsigned long)vblank);
Ville Syrjäläe69595c2014-02-19 19:36:08 +0200245 }
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700246
Ville Syrjälä5380e922013-10-04 14:53:36 +0300247 kfree(dev->vblank);
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700248
249 dev->num_crtcs = 0;
250}
Jerome Glissee77cef92010-01-07 15:39:13 +0100251EXPORT_SYMBOL(drm_vblank_cleanup);
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700252
Daniel Vetterf5752b32014-05-08 16:41:51 +0200253/**
254 * drm_vblank_init - initialize vblank support
255 * @dev: drm_device
256 * @num_crtcs: number of crtcs supported by @dev
257 *
258 * This function initializes vblank support for @num_crtcs display pipelines.
259 *
260 * Returns:
261 * Zero on success or a negative error code on failure.
262 */
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700263int drm_vblank_init(struct drm_device *dev, int num_crtcs)
264{
265 int i, ret = -ENOMEM;
266
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700267 spin_lock_init(&dev->vbl_lock);
Mario Kleiner27641c32010-10-23 04:20:23 +0200268 spin_lock_init(&dev->vblank_time_lock);
269
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700270 dev->num_crtcs = num_crtcs;
271
Ville Syrjälä5380e922013-10-04 14:53:36 +0300272 dev->vblank = kcalloc(num_crtcs, sizeof(*dev->vblank), GFP_KERNEL);
273 if (!dev->vblank)
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700274 goto err;
275
Ville Syrjäläe69595c2014-02-19 19:36:08 +0200276 for (i = 0; i < num_crtcs; i++) {
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300277 struct drm_vblank_crtc *vblank = &dev->vblank[i];
278
279 vblank->dev = dev;
280 vblank->crtc = i;
281 init_waitqueue_head(&vblank->queue);
282 setup_timer(&vblank->disable_timer, vblank_disable_fn,
283 (unsigned long)vblank);
Ville Syrjäläe69595c2014-02-19 19:36:08 +0200284 }
Mario Kleiner27641c32010-10-23 04:20:23 +0200285
Mario Kleiner8f6fce02013-10-30 05:13:06 +0100286 DRM_INFO("Supports vblank timestamp caching Rev 2 (21.10.2013).\n");
Mario Kleiner27641c32010-10-23 04:20:23 +0200287
288 /* Driver specific high-precision vblank timestamping supported? */
289 if (dev->driver->get_vblank_timestamp)
290 DRM_INFO("Driver supports precise vblank timestamp query.\n");
291 else
292 DRM_INFO("No driver support for vblank timestamp query.\n");
293
Ville Syrjäläba0bf122013-10-04 14:53:33 +0300294 dev->vblank_disable_allowed = false;
295
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700296 return 0;
297
298err:
299 drm_vblank_cleanup(dev);
300 return ret;
301}
302EXPORT_SYMBOL(drm_vblank_init);
303
Dave Airlie28d52042009-09-21 14:33:58 +1000304static void drm_irq_vgaarb_nokms(void *cookie, bool state)
305{
306 struct drm_device *dev = cookie;
307
308 if (dev->driver->vgaarb_irq) {
309 dev->driver->vgaarb_irq(dev, state);
310 return;
311 }
312
313 if (!dev->irq_enabled)
314 return;
315
Joonyoung Shim5037f8a2011-08-04 05:41:01 +0000316 if (state) {
317 if (dev->driver->irq_uninstall)
318 dev->driver->irq_uninstall(dev);
319 } else {
320 if (dev->driver->irq_preinstall)
321 dev->driver->irq_preinstall(dev);
322 if (dev->driver->irq_postinstall)
323 dev->driver->irq_postinstall(dev);
Dave Airlie28d52042009-09-21 14:33:58 +1000324 }
325}
326
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327/**
Daniel Vetterf5752b32014-05-08 16:41:51 +0200328 * drm_irq_install - install IRQ handler
329 * @dev: DRM device
330 * @irq: IRQ number to install the handler for
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 *
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700332 * Initializes the IRQ related data. Installs the handler, calling the driver
Daniel Vetterf5752b32014-05-08 16:41:51 +0200333 * irq_preinstall() and irq_postinstall() functions before and after the
334 * installation.
335 *
336 * This is the simplified helper interface provided for drivers with no special
337 * needs. Drivers which need to install interrupt handlers for multiple
338 * interrupts must instead set drm_device->irq_enabled to signal the DRM core
339 * that vblank interrupts are available.
340 *
341 * Returns:
342 * Zero on success or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 */
Daniel Vetterbb0f1b52013-11-03 21:09:27 +0100344int drm_irq_install(struct drm_device *dev, int irq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345{
Laurent Pinchart4a1b0712012-05-17 13:27:21 +0200346 int ret;
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000347 unsigned long sh_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
349 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
350 return -EINVAL;
351
Daniel Vetter7c1a38e2013-12-16 11:21:15 +0100352 if (irq == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 return -EINVAL;
354
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 /* Driver must have been initialized */
Daniel Vettere090c532013-11-03 20:27:05 +0100356 if (!dev->dev_private)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
Daniel Vettere090c532013-11-03 20:27:05 +0100359 if (dev->irq_enabled)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 return -EBUSY;
Ville Syrjälä44238432013-10-04 14:53:37 +0300361 dev->irq_enabled = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362
Daniel Vetter7c1a38e2013-12-16 11:21:15 +0100363 DRM_DEBUG("irq=%d\n", irq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000365 /* Before installing handler */
Joonyoung Shim5037f8a2011-08-04 05:41:01 +0000366 if (dev->driver->irq_preinstall)
367 dev->driver->irq_preinstall(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000369 /* Install handler */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 if (drm_core_check_feature(dev, DRIVER_IRQ_SHARED))
Thomas Gleixner935f6e32006-07-01 19:29:34 -0700371 sh_flags = IRQF_SHARED;
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000372
Daniel Vetter7c1a38e2013-12-16 11:21:15 +0100373 ret = request_irq(irq, dev->driver->irq_handler,
Daniel Vetter5829d182013-11-03 21:48:48 +0100374 sh_flags, dev->driver->name, dev);
Jesse Barnes9bfbd5c2008-09-15 15:00:33 -0700375
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000376 if (ret < 0) {
Ville Syrjälä44238432013-10-04 14:53:37 +0300377 dev->irq_enabled = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 return ret;
379 }
380
Dave Airlie28d52042009-09-21 14:33:58 +1000381 if (!drm_core_check_feature(dev, DRIVER_MODESET))
382 vga_client_register(dev->pdev, (void *)dev, drm_irq_vgaarb_nokms, NULL);
383
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000384 /* After installing handler */
Joonyoung Shim5037f8a2011-08-04 05:41:01 +0000385 if (dev->driver->irq_postinstall)
386 ret = dev->driver->irq_postinstall(dev);
387
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700388 if (ret < 0) {
Ville Syrjälä44238432013-10-04 14:53:37 +0300389 dev->irq_enabled = false;
Joonyoung Shime1c44ac2011-08-04 05:41:00 +0000390 if (!drm_core_check_feature(dev, DRIVER_MODESET))
391 vga_client_register(dev->pdev, NULL, NULL, NULL);
Daniel Vetter7c1a38e2013-12-16 11:21:15 +0100392 free_irq(irq, dev);
393 } else {
394 dev->irq = irq;
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700395 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700397 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398}
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700399EXPORT_SYMBOL(drm_irq_install);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400
401/**
Daniel Vetterf5752b32014-05-08 16:41:51 +0200402 * drm_irq_uninstall - uninstall the IRQ handler
403 * @dev: DRM device
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 *
Daniel Vetterf5752b32014-05-08 16:41:51 +0200405 * Calls the driver's irq_uninstall() function and unregisters the IRQ handler.
406 * This should only be called by drivers which used drm_irq_install() to set up
407 * their interrupt handler. Other drivers must only reset
408 * drm_device->irq_enabled to false.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 *
Daniel Vetterf5752b32014-05-08 16:41:51 +0200410 * Note that for kernel modesetting drivers it is a bug if this function fails.
411 * The sanity checks are only to catch buggy user modesetting drivers which call
412 * the same function through an ioctl.
413 *
414 * Returns:
415 * Zero on success or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 */
Mario Kleiner27641c32010-10-23 04:20:23 +0200417int drm_irq_uninstall(struct drm_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418{
Jesse Barnesdc1336f2009-01-06 10:21:24 -0800419 unsigned long irqflags;
Ville Syrjälä44238432013-10-04 14:53:37 +0300420 bool irq_enabled;
421 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
423 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
424 return -EINVAL;
425
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 irq_enabled = dev->irq_enabled;
Ville Syrjälä44238432013-10-04 14:53:37 +0300427 dev->irq_enabled = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428
Jesse Barnesdc1336f2009-01-06 10:21:24 -0800429 /*
430 * Wake up any waiters so they don't hang.
431 */
Ben Skeggsbde48892011-07-04 12:52:27 +1000432 if (dev->num_crtcs) {
433 spin_lock_irqsave(&dev->vbl_lock, irqflags);
434 for (i = 0; i < dev->num_crtcs; i++) {
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300435 struct drm_vblank_crtc *vblank = &dev->vblank[i];
436
437 wake_up(&vblank->queue);
438 vblank->enabled = false;
439 vblank->last =
Ben Skeggsbde48892011-07-04 12:52:27 +1000440 dev->driver->get_vblank_counter(dev, i);
441 }
442 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
Jesse Barnesdc1336f2009-01-06 10:21:24 -0800443 }
Jesse Barnesdc1336f2009-01-06 10:21:24 -0800444
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000445 if (!irq_enabled)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 return -EINVAL;
447
Daniel Vetter7c1a38e2013-12-16 11:21:15 +0100448 DRM_DEBUG("irq=%d\n", dev->irq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449
Dave Airlie28d52042009-09-21 14:33:58 +1000450 if (!drm_core_check_feature(dev, DRIVER_MODESET))
451 vga_client_register(dev->pdev, NULL, NULL, NULL);
452
Joonyoung Shim5037f8a2011-08-04 05:41:01 +0000453 if (dev->driver->irq_uninstall)
454 dev->driver->irq_uninstall(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455
Daniel Vetter7c1a38e2013-12-16 11:21:15 +0100456 free_irq(dev->irq, dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457
458 return 0;
459}
460EXPORT_SYMBOL(drm_irq_uninstall);
461
Daniel Vetterf5752b32014-05-08 16:41:51 +0200462/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 * IRQ control ioctl.
464 *
465 * \param inode device inode.
Eric Anholt6c340ea2007-08-25 20:23:09 +1000466 * \param file_priv DRM file private.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 * \param cmd command.
468 * \param arg user argument, pointing to a drm_control structure.
469 * \return zero on success or a negative number on failure.
470 *
471 * Calls irq_install() or irq_uninstall() according to \p arg.
472 */
Eric Anholtc153f452007-09-03 12:06:45 +1000473int drm_control(struct drm_device *dev, void *data,
474 struct drm_file *file_priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475{
Eric Anholtc153f452007-09-03 12:06:45 +1000476 struct drm_control *ctl = data;
Daniel Vettera319c1a2013-11-03 21:09:15 +0100477 int ret = 0, irq;
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000478
Mario Kleiner27641c32010-10-23 04:20:23 +0200479 /* if we haven't irq we fallback for compatibility reasons -
480 * this used to be a separate function in drm_dma.h
481 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482
Daniel Vetter22471cf2013-11-03 20:02:50 +0100483 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
484 return 0;
485 if (drm_core_check_feature(dev, DRIVER_MODESET))
486 return 0;
487 /* UMS was only ever support on pci devices. */
488 if (WARN_ON(!dev->pdev))
489 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490
Eric Anholtc153f452007-09-03 12:06:45 +1000491 switch (ctl->func) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 case DRM_INST_HANDLER:
Daniel Vettera319c1a2013-11-03 21:09:15 +0100493 irq = dev->pdev->irq;
494
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 if (dev->if_version < DRM_IF_VERSION(1, 2) &&
Daniel Vettera319c1a2013-11-03 21:09:15 +0100496 ctl->irq != irq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 return -EINVAL;
Daniel Vettere090c532013-11-03 20:27:05 +0100498 mutex_lock(&dev->struct_mutex);
Daniel Vetterbb0f1b52013-11-03 21:09:27 +0100499 ret = drm_irq_install(dev, irq);
Daniel Vettere090c532013-11-03 20:27:05 +0100500 mutex_unlock(&dev->struct_mutex);
501
502 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 case DRM_UNINST_HANDLER:
Daniel Vettere090c532013-11-03 20:27:05 +0100504 mutex_lock(&dev->struct_mutex);
505 ret = drm_irq_uninstall(dev);
506 mutex_unlock(&dev->struct_mutex);
507
508 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 default:
510 return -EINVAL;
511 }
512}
513
514/**
Daniel Vetterf5752b32014-05-08 16:41:51 +0200515 * drm_calc_timestamping_constants - calculate vblank timestamp constants
516 * @crtc: drm_crtc whose timestamp constants should be updated.
517 * @mode: display mode containing the scanout timings
Mario Kleiner27641c32010-10-23 04:20:23 +0200518 *
Ville Syrjälä21b21562013-10-26 17:22:52 +0300519 * Calculate and store various constants which are later
520 * needed by vblank and swap-completion timestamping, e.g,
521 * by drm_calc_vbltimestamp_from_scanoutpos(). They are
Daniel Vetterf5752b32014-05-08 16:41:51 +0200522 * derived from CRTC's true scanout timing, so they take
Ville Syrjälä21b21562013-10-26 17:22:52 +0300523 * things like panel scaling or other adjustments into account.
Mario Kleiner27641c32010-10-23 04:20:23 +0200524 */
Ville Syrjälä545cdd52013-10-26 17:16:30 +0300525void drm_calc_timestamping_constants(struct drm_crtc *crtc,
526 const struct drm_display_mode *mode)
Mario Kleiner27641c32010-10-23 04:20:23 +0200527{
Ville Syrjälä3c184f62013-10-26 17:38:52 +0300528 int linedur_ns = 0, pixeldur_ns = 0, framedur_ns = 0;
Ville Syrjälä77666b72013-10-27 21:22:58 +0200529 int dotclock = mode->crtc_clock;
Mario Kleiner27641c32010-10-23 04:20:23 +0200530
531 /* Valid dotclock? */
532 if (dotclock > 0) {
Ville Syrjälä0dae35a2013-10-26 17:11:01 +0300533 int frame_size = mode->crtc_htotal * mode->crtc_vtotal;
534
535 /*
536 * Convert scanline length in pixels and video
537 * dot clock to line duration, frame duration
538 * and pixel duration in nanoseconds:
Mario Kleiner27641c32010-10-23 04:20:23 +0200539 */
Ville Syrjälä0dae35a2013-10-26 17:11:01 +0300540 pixeldur_ns = 1000000 / dotclock;
541 linedur_ns = div_u64((u64) mode->crtc_htotal * 1000000, dotclock);
542 framedur_ns = div_u64((u64) frame_size * 1000000, dotclock);
Ville Syrjäläc0ae24c2013-10-28 19:53:25 +0200543
544 /*
545 * Fields of interlaced scanout modes are only half a frame duration.
546 */
547 if (mode->flags & DRM_MODE_FLAG_INTERLACE)
548 framedur_ns /= 2;
Mario Kleiner27641c32010-10-23 04:20:23 +0200549 } else
550 DRM_ERROR("crtc %d: Can't calculate constants, dotclock = 0!\n",
551 crtc->base.id);
552
553 crtc->pixeldur_ns = pixeldur_ns;
554 crtc->linedur_ns = linedur_ns;
555 crtc->framedur_ns = framedur_ns;
556
557 DRM_DEBUG("crtc %d: hwmode: htotal %d, vtotal %d, vdisplay %d\n",
Ville Syrjälä545cdd52013-10-26 17:16:30 +0300558 crtc->base.id, mode->crtc_htotal,
559 mode->crtc_vtotal, mode->crtc_vdisplay);
Mario Kleiner27641c32010-10-23 04:20:23 +0200560 DRM_DEBUG("crtc %d: clock %d kHz framedur %d linedur %d, pixeldur %d\n",
Ville Syrjälä3c184f62013-10-26 17:38:52 +0300561 crtc->base.id, dotclock, framedur_ns,
562 linedur_ns, pixeldur_ns);
Mario Kleiner27641c32010-10-23 04:20:23 +0200563}
564EXPORT_SYMBOL(drm_calc_timestamping_constants);
565
566/**
Daniel Vetterf5752b32014-05-08 16:41:51 +0200567 * drm_calc_vbltimestamp_from_scanoutpos - precise vblank timestamp helper
568 * @dev: DRM device
569 * @crtc: Which CRTC's vblank timestamp to retrieve
570 * @max_error: Desired maximum allowable error in timestamps (nanosecs)
571 * On return contains true maximum error of timestamp
572 * @vblank_time: Pointer to struct timeval which should receive the timestamp
573 * @flags: Flags to pass to driver:
574 * 0 = Default,
575 * DRM_CALLED_FROM_VBLIRQ = If function is called from vbl IRQ handler
576 * @refcrtc: CRTC which defines scanout timing
577 * @mode: mode which defines the scanout timings
578 *
579 * Implements calculation of exact vblank timestamps from given drm_display_mode
580 * timings and current video scanout position of a CRTC. This can be called from
581 * within get_vblank_timestamp() implementation of a kms driver to implement the
582 * actual timestamping.
Mario Kleiner27641c32010-10-23 04:20:23 +0200583 *
584 * Should return timestamps conforming to the OML_sync_control OpenML
585 * extension specification. The timestamp corresponds to the end of
586 * the vblank interval, aka start of scanout of topmost-leftmost display
587 * pixel in the following video frame.
588 *
589 * Requires support for optional dev->driver->get_scanout_position()
590 * in kms driver, plus a bit of setup code to provide a drm_display_mode
591 * that corresponds to the true scanout timing.
592 *
593 * The current implementation only handles standard video modes. It
594 * returns as no operation if a doublescan or interlaced video mode is
595 * active. Higher level code is expected to handle this.
596 *
Daniel Vetterf5752b32014-05-08 16:41:51 +0200597 * Returns:
598 * Negative value on error, failure or if not supported in current
Mario Kleiner27641c32010-10-23 04:20:23 +0200599 * video mode:
600 *
Daniel Vetterf5752b32014-05-08 16:41:51 +0200601 * -EINVAL - Invalid CRTC.
Mario Kleiner27641c32010-10-23 04:20:23 +0200602 * -EAGAIN - Temporary unavailable, e.g., called before initial modeset.
603 * -ENOTSUPP - Function not supported in current display mode.
604 * -EIO - Failed, e.g., due to failed scanout position query.
605 *
606 * Returns or'ed positive status flags on success:
607 *
608 * DRM_VBLANKTIME_SCANOUTPOS_METHOD - Signal this method used for timestamping.
609 * DRM_VBLANKTIME_INVBL - Timestamp taken while scanout was in vblank interval.
610 *
611 */
612int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev, int crtc,
613 int *max_error,
614 struct timeval *vblank_time,
615 unsigned flags,
Ville Syrjälä7da903e2013-10-26 17:57:31 +0300616 const struct drm_crtc *refcrtc,
617 const struct drm_display_mode *mode)
Mario Kleiner27641c32010-10-23 04:20:23 +0200618{
Imre Deake62f2f52012-10-23 18:53:25 +0000619 ktime_t stime, etime, mono_time_offset;
620 struct timeval tv_etime;
Ville Syrjälä8072bfa2013-10-28 21:22:52 +0200621 int vbl_status;
Mario Kleiner27641c32010-10-23 04:20:23 +0200622 int vpos, hpos, i;
Ville Syrjälä3c184f62013-10-26 17:38:52 +0300623 int framedur_ns, linedur_ns, pixeldur_ns, delta_ns, duration_ns;
Mario Kleiner27641c32010-10-23 04:20:23 +0200624 bool invbl;
625
626 if (crtc < 0 || crtc >= dev->num_crtcs) {
627 DRM_ERROR("Invalid crtc %d\n", crtc);
628 return -EINVAL;
629 }
630
631 /* Scanout position query not supported? Should not happen. */
632 if (!dev->driver->get_scanout_position) {
633 DRM_ERROR("Called from driver w/o get_scanout_position()!?\n");
634 return -EIO;
635 }
636
Mario Kleiner27641c32010-10-23 04:20:23 +0200637 /* Durations of frames, lines, pixels in nanoseconds. */
638 framedur_ns = refcrtc->framedur_ns;
639 linedur_ns = refcrtc->linedur_ns;
640 pixeldur_ns = refcrtc->pixeldur_ns;
641
642 /* If mode timing undefined, just return as no-op:
643 * Happens during initial modesetting of a crtc.
644 */
Ville Syrjälä8072bfa2013-10-28 21:22:52 +0200645 if (framedur_ns == 0) {
Mario Kleiner27641c32010-10-23 04:20:23 +0200646 DRM_DEBUG("crtc %d: Noop due to uninitialized mode.\n", crtc);
647 return -EAGAIN;
648 }
649
Mario Kleiner27641c32010-10-23 04:20:23 +0200650 /* Get current scanout position with system timestamp.
651 * Repeat query up to DRM_TIMESTAMP_MAXRETRIES times
652 * if single query takes longer than max_error nanoseconds.
653 *
654 * This guarantees a tight bound on maximum error if
655 * code gets preempted or delayed for some reason.
656 */
657 for (i = 0; i < DRM_TIMESTAMP_MAXRETRIES; i++) {
Mario Kleiner8f6fce02013-10-30 05:13:06 +0100658 /*
659 * Get vertical and horizontal scanout position vpos, hpos,
660 * and bounding timestamps stime, etime, pre/post query.
661 */
Ville Syrjäläabca9e42013-10-28 20:50:48 +0200662 vbl_status = dev->driver->get_scanout_position(dev, crtc, flags, &vpos,
Mario Kleiner8f6fce02013-10-30 05:13:06 +0100663 &hpos, &stime, &etime);
Mario Kleiner27641c32010-10-23 04:20:23 +0200664
Mario Kleiner8f6fce02013-10-30 05:13:06 +0100665 /*
666 * Get correction for CLOCK_MONOTONIC -> CLOCK_REALTIME if
667 * CLOCK_REALTIME is requested.
668 */
Imre Deakc61eef72012-10-23 18:53:26 +0000669 if (!drm_timestamp_monotonic)
670 mono_time_offset = ktime_get_monotonic_offset();
Mario Kleiner27641c32010-10-23 04:20:23 +0200671
Mario Kleiner27641c32010-10-23 04:20:23 +0200672 /* Return as no-op if scanout query unsupported or failed. */
673 if (!(vbl_status & DRM_SCANOUTPOS_VALID)) {
674 DRM_DEBUG("crtc %d : scanoutpos query failed [%d].\n",
675 crtc, vbl_status);
676 return -EIO;
677 }
678
Mario Kleiner8f6fce02013-10-30 05:13:06 +0100679 /* Compute uncertainty in timestamp of scanout position query. */
Imre Deake62f2f52012-10-23 18:53:25 +0000680 duration_ns = ktime_to_ns(etime) - ktime_to_ns(stime);
Mario Kleiner27641c32010-10-23 04:20:23 +0200681
682 /* Accept result with < max_error nsecs timing uncertainty. */
Ville Syrjälä3c184f62013-10-26 17:38:52 +0300683 if (duration_ns <= *max_error)
Mario Kleiner27641c32010-10-23 04:20:23 +0200684 break;
685 }
686
687 /* Noisy system timing? */
688 if (i == DRM_TIMESTAMP_MAXRETRIES) {
689 DRM_DEBUG("crtc %d: Noisy timestamp %d us > %d us [%d reps].\n",
Ville Syrjälä3c184f62013-10-26 17:38:52 +0300690 crtc, duration_ns/1000, *max_error/1000, i);
Mario Kleiner27641c32010-10-23 04:20:23 +0200691 }
692
693 /* Return upper bound of timestamp precision error. */
Ville Syrjälä3c184f62013-10-26 17:38:52 +0300694 *max_error = duration_ns;
Mario Kleiner27641c32010-10-23 04:20:23 +0200695
696 /* Check if in vblank area:
697 * vpos is >=0 in video scanout area, but negative
698 * within vblank area, counting down the number of lines until
699 * start of scanout.
700 */
701 invbl = vbl_status & DRM_SCANOUTPOS_INVBL;
702
703 /* Convert scanout position into elapsed time at raw_time query
704 * since start of scanout at first display scanline. delta_ns
705 * can be negative if start of scanout hasn't happened yet.
706 */
Ville Syrjälä3c184f62013-10-26 17:38:52 +0300707 delta_ns = vpos * linedur_ns + hpos * pixeldur_ns;
Mario Kleiner27641c32010-10-23 04:20:23 +0200708
Imre Deakc61eef72012-10-23 18:53:26 +0000709 if (!drm_timestamp_monotonic)
710 etime = ktime_sub(etime, mono_time_offset);
711
Imre Deake62f2f52012-10-23 18:53:25 +0000712 /* save this only for debugging purposes */
713 tv_etime = ktime_to_timeval(etime);
Mario Kleiner27641c32010-10-23 04:20:23 +0200714 /* Subtract time delta from raw timestamp to get final
715 * vblank_time timestamp for end of vblank.
716 */
Michel Dänzere91abf82013-06-12 11:58:44 +0200717 if (delta_ns < 0)
718 etime = ktime_add_ns(etime, -delta_ns);
719 else
720 etime = ktime_sub_ns(etime, delta_ns);
Imre Deake62f2f52012-10-23 18:53:25 +0000721 *vblank_time = ktime_to_timeval(etime);
Mario Kleiner27641c32010-10-23 04:20:23 +0200722
Joe Perchesbbb0aef2011-04-17 20:35:52 -0700723 DRM_DEBUG("crtc %d : v %d p(%d,%d)@ %ld.%ld -> %ld.%ld [e %d us, %d rep]\n",
724 crtc, (int)vbl_status, hpos, vpos,
Imre Deake62f2f52012-10-23 18:53:25 +0000725 (long)tv_etime.tv_sec, (long)tv_etime.tv_usec,
Joe Perchesbbb0aef2011-04-17 20:35:52 -0700726 (long)vblank_time->tv_sec, (long)vblank_time->tv_usec,
Ville Syrjälä3c184f62013-10-26 17:38:52 +0300727 duration_ns/1000, i);
Mario Kleiner27641c32010-10-23 04:20:23 +0200728
729 vbl_status = DRM_VBLANKTIME_SCANOUTPOS_METHOD;
730 if (invbl)
731 vbl_status |= DRM_VBLANKTIME_INVBL;
732
733 return vbl_status;
734}
735EXPORT_SYMBOL(drm_calc_vbltimestamp_from_scanoutpos);
736
Imre Deakc61eef72012-10-23 18:53:26 +0000737static struct timeval get_drm_timestamp(void)
738{
739 ktime_t now;
740
741 now = ktime_get();
742 if (!drm_timestamp_monotonic)
743 now = ktime_sub(now, ktime_get_monotonic_offset());
744
745 return ktime_to_timeval(now);
746}
747
Mario Kleiner27641c32010-10-23 04:20:23 +0200748/**
749 * drm_get_last_vbltimestamp - retrieve raw timestamp for the most recent
Daniel Vetterf5752b32014-05-08 16:41:51 +0200750 * vblank interval
Mario Kleiner27641c32010-10-23 04:20:23 +0200751 * @dev: DRM device
Daniel Vetterf5752b32014-05-08 16:41:51 +0200752 * @crtc: which CRTC's vblank timestamp to retrieve
Mario Kleiner27641c32010-10-23 04:20:23 +0200753 * @tvblank: Pointer to target struct timeval which should receive the timestamp
754 * @flags: Flags to pass to driver:
Daniel Vetterf5752b32014-05-08 16:41:51 +0200755 * 0 = Default,
756 * DRM_CALLED_FROM_VBLIRQ = If function is called from vbl IRQ handler
Mario Kleiner27641c32010-10-23 04:20:23 +0200757 *
758 * Fetches the system timestamp corresponding to the time of the most recent
Daniel Vetterf5752b32014-05-08 16:41:51 +0200759 * vblank interval on specified CRTC. May call into kms-driver to
Mario Kleiner27641c32010-10-23 04:20:23 +0200760 * compute the timestamp with a high-precision GPU specific method.
761 *
762 * Returns zero if timestamp originates from uncorrected do_gettimeofday()
763 * call, i.e., it isn't very precisely locked to the true vblank.
764 *
Daniel Vetterf5752b32014-05-08 16:41:51 +0200765 * Returns:
766 * Non-zero if timestamp is considered to be very precise, zero otherwise.
Mario Kleiner27641c32010-10-23 04:20:23 +0200767 */
768u32 drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
769 struct timeval *tvblank, unsigned flags)
770{
Laurent Pinchart4a1b0712012-05-17 13:27:21 +0200771 int ret;
Mario Kleiner27641c32010-10-23 04:20:23 +0200772
773 /* Define requested maximum error on timestamps (nanoseconds). */
774 int max_error = (int) drm_timestamp_precision * 1000;
775
776 /* Query driver if possible and precision timestamping enabled. */
777 if (dev->driver->get_vblank_timestamp && (max_error > 0)) {
778 ret = dev->driver->get_vblank_timestamp(dev, crtc, &max_error,
779 tvblank, flags);
780 if (ret > 0)
781 return (u32) ret;
782 }
783
784 /* GPU high precision timestamp query unsupported or failed.
Imre Deakc61eef72012-10-23 18:53:26 +0000785 * Return current monotonic/gettimeofday timestamp as best estimate.
Mario Kleiner27641c32010-10-23 04:20:23 +0200786 */
Imre Deakc61eef72012-10-23 18:53:26 +0000787 *tvblank = get_drm_timestamp();
Mario Kleiner27641c32010-10-23 04:20:23 +0200788
789 return 0;
790}
791EXPORT_SYMBOL(drm_get_last_vbltimestamp);
792
793/**
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700794 * drm_vblank_count - retrieve "cooked" vblank counter value
795 * @dev: DRM device
796 * @crtc: which counter to retrieve
797 *
798 * Fetches the "cooked" vblank count value that represents the number of
799 * vblank events since the system was booted, including lost events due to
800 * modesetting activity.
Daniel Vetterf5752b32014-05-08 16:41:51 +0200801 *
802 * Returns:
803 * The software vblank counter.
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700804 */
805u32 drm_vblank_count(struct drm_device *dev, int crtc)
806{
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300807 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
808
809 return atomic_read(&vblank->count);
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700810}
811EXPORT_SYMBOL(drm_vblank_count);
812
813/**
Mario Kleiner27641c32010-10-23 04:20:23 +0200814 * drm_vblank_count_and_time - retrieve "cooked" vblank counter value
815 * and the system timestamp corresponding to that vblank counter value.
816 *
817 * @dev: DRM device
818 * @crtc: which counter to retrieve
819 * @vblanktime: Pointer to struct timeval to receive the vblank timestamp.
820 *
821 * Fetches the "cooked" vblank count value that represents the number of
822 * vblank events since the system was booted, including lost events due to
823 * modesetting activity. Returns corresponding system timestamp of the time
Daniel Vetterf5752b32014-05-08 16:41:51 +0200824 * of the vblank interval that corresponds to the current vblank counter value.
Mario Kleiner27641c32010-10-23 04:20:23 +0200825 */
826u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
827 struct timeval *vblanktime)
828{
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300829 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
Mario Kleiner27641c32010-10-23 04:20:23 +0200830 u32 cur_vblank;
831
832 /* Read timestamp from slot of _vblank_time ringbuffer
833 * that corresponds to current vblank count. Retry if
834 * count has incremented during readout. This works like
835 * a seqlock.
836 */
837 do {
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300838 cur_vblank = atomic_read(&vblank->count);
Mario Kleiner27641c32010-10-23 04:20:23 +0200839 *vblanktime = vblanktimestamp(dev, crtc, cur_vblank);
840 smp_rmb();
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300841 } while (cur_vblank != atomic_read(&vblank->count));
Mario Kleiner27641c32010-10-23 04:20:23 +0200842
843 return cur_vblank;
844}
845EXPORT_SYMBOL(drm_vblank_count_and_time);
846
Rob Clarkc6eefa12012-10-16 22:48:40 +0000847static void send_vblank_event(struct drm_device *dev,
848 struct drm_pending_vblank_event *e,
849 unsigned long seq, struct timeval *now)
850{
851 WARN_ON_SMP(!spin_is_locked(&dev->event_lock));
852 e->event.sequence = seq;
853 e->event.tv_sec = now->tv_sec;
854 e->event.tv_usec = now->tv_usec;
855
856 list_add_tail(&e->base.link,
857 &e->base.file_priv->event_list);
858 wake_up_interruptible(&e->base.file_priv->event_wait);
859 trace_drm_vblank_event_delivered(e->base.pid, e->pipe,
860 e->event.sequence);
861}
862
863/**
864 * drm_send_vblank_event - helper to send vblank event after pageflip
865 * @dev: DRM device
866 * @crtc: CRTC in question
867 * @e: the event to send
868 *
869 * Updates sequence # and timestamp on event, and sends it to userspace.
870 * Caller must hold event lock.
871 */
872void drm_send_vblank_event(struct drm_device *dev, int crtc,
873 struct drm_pending_vblank_event *e)
874{
875 struct timeval now;
876 unsigned int seq;
877 if (crtc >= 0) {
878 seq = drm_vblank_count_and_time(dev, crtc, &now);
879 } else {
880 seq = 0;
Imre Deakc61eef72012-10-23 18:53:26 +0000881
882 now = get_drm_timestamp();
Rob Clarkc6eefa12012-10-16 22:48:40 +0000883 }
Rob Clark21a245d2012-12-10 10:49:46 -0600884 e->pipe = crtc;
Rob Clarkc6eefa12012-10-16 22:48:40 +0000885 send_vblank_event(dev, e, seq, &now);
886}
887EXPORT_SYMBOL(drm_send_vblank_event);
888
Mario Kleiner27641c32010-10-23 04:20:23 +0200889/**
Ville Syrjäläf2752282014-02-19 21:29:49 +0200890 * drm_vblank_enable - enable the vblank interrupt on a CRTC
891 * @dev: DRM device
892 * @crtc: CRTC in question
893 */
894static int drm_vblank_enable(struct drm_device *dev, int crtc)
895{
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300896 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
Ville Syrjäläf2752282014-02-19 21:29:49 +0200897 int ret = 0;
898
899 assert_spin_locked(&dev->vbl_lock);
900
901 spin_lock(&dev->vblank_time_lock);
902
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300903 if (!vblank->enabled) {
Daniel Vetter1cfb80b2014-05-21 15:11:33 +0200904 /*
905 * Enable vblank irqs under vblank_time_lock protection.
Ville Syrjäläf2752282014-02-19 21:29:49 +0200906 * All vblank count & timestamp updates are held off
907 * until we are done reinitializing master counter and
908 * timestamps. Filtercode in drm_handle_vblank() will
909 * prevent double-accounting of same vblank interval.
910 */
911 ret = dev->driver->enable_vblank(dev, crtc);
912 DRM_DEBUG("enabling vblank on crtc %d, ret: %d\n", crtc, ret);
913 if (ret)
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300914 atomic_dec(&vblank->refcount);
Ville Syrjäläf2752282014-02-19 21:29:49 +0200915 else {
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300916 vblank->enabled = true;
Ville Syrjäläf2752282014-02-19 21:29:49 +0200917 drm_update_vblank_count(dev, crtc);
918 }
919 }
920
921 spin_unlock(&dev->vblank_time_lock);
922
923 return ret;
924}
925
926/**
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700927 * drm_vblank_get - get a reference count on vblank events
928 * @dev: DRM device
929 * @crtc: which CRTC to own
930 *
931 * Acquire a reference count on vblank events to avoid having them disabled
932 * while in use.
933 *
Daniel Vetter89dd6a42014-05-15 15:32:12 +0200934 * This is the legacy version of drm_crtc_vblank_get().
935 *
Daniel Vetterf5752b32014-05-08 16:41:51 +0200936 * Returns:
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700937 * Zero on success, nonzero on failure.
938 */
939int drm_vblank_get(struct drm_device *dev, int crtc)
940{
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300941 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
Peter Hurley97cbc882013-08-20 21:51:12 -0400942 unsigned long irqflags;
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700943 int ret = 0;
944
945 spin_lock_irqsave(&dev->vbl_lock, irqflags);
946 /* Going from 0->1 means we have to enable interrupts again */
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300947 if (atomic_add_return(1, &vblank->refcount) == 1) {
Ville Syrjäläf2752282014-02-19 21:29:49 +0200948 ret = drm_vblank_enable(dev, crtc);
Li Peng778c9022009-11-09 12:51:22 +0800949 } else {
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300950 if (!vblank->enabled) {
951 atomic_dec(&vblank->refcount);
Li Peng778c9022009-11-09 12:51:22 +0800952 ret = -EINVAL;
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700953 }
954 }
955 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
956
957 return ret;
958}
959EXPORT_SYMBOL(drm_vblank_get);
960
961/**
Daniel Vetter89dd6a42014-05-15 15:32:12 +0200962 * drm_crtc_vblank_get - get a reference count on vblank events
963 * @crtc: which CRTC to own
964 *
965 * Acquire a reference count on vblank events to avoid having them disabled
966 * while in use.
967 *
968 * This is the native kms version of drm_vblank_off().
969 *
970 * Returns:
971 * Zero on success, nonzero on failure.
972 */
973int drm_crtc_vblank_get(struct drm_crtc *crtc)
974{
975 return drm_vblank_get(crtc->dev, drm_crtc_index(crtc));
976}
977EXPORT_SYMBOL(drm_crtc_vblank_get);
978
979/**
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700980 * drm_vblank_put - give up ownership of vblank events
981 * @dev: DRM device
982 * @crtc: which counter to give up
983 *
984 * Release ownership of a given vblank counter, turning off interrupts
Mario Kleiner27641c32010-10-23 04:20:23 +0200985 * if possible. Disable interrupts after drm_vblank_offdelay milliseconds.
Daniel Vetter89dd6a42014-05-15 15:32:12 +0200986 *
987 * This is the legacy version of drm_crtc_vblank_put().
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700988 */
989void drm_vblank_put(struct drm_device *dev, int crtc)
990{
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300991 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
992
993 BUG_ON(atomic_read(&vblank->refcount) == 0);
Chris Wilsonb3f5e732009-02-19 14:48:22 +0000994
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700995 /* Last user schedules interrupt disable */
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300996 if (atomic_dec_and_test(&vblank->refcount) &&
Mario Kleiner27641c32010-10-23 04:20:23 +0200997 (drm_vblank_offdelay > 0))
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +0300998 mod_timer(&vblank->disable_timer,
Daniel Vetterbfd83032013-12-11 11:34:41 +0100999 jiffies + ((drm_vblank_offdelay * HZ)/1000));
Jesse Barnes0a3e67a2008-09-30 12:14:26 -07001000}
1001EXPORT_SYMBOL(drm_vblank_put);
1002
Rob Clarkc6eefa12012-10-16 22:48:40 +00001003/**
Daniel Vetter89dd6a42014-05-15 15:32:12 +02001004 * drm_crtc_vblank_put - give up ownership of vblank events
1005 * @crtc: which counter to give up
1006 *
1007 * Release ownership of a given vblank counter, turning off interrupts
1008 * if possible. Disable interrupts after drm_vblank_offdelay milliseconds.
1009 *
1010 * This is the native kms version of drm_vblank_put().
1011 */
1012void drm_crtc_vblank_put(struct drm_crtc *crtc)
1013{
1014 drm_vblank_put(crtc->dev, drm_crtc_index(crtc));
1015}
1016EXPORT_SYMBOL(drm_crtc_vblank_put);
1017
1018/**
Rob Clarkc6eefa12012-10-16 22:48:40 +00001019 * drm_vblank_off - disable vblank events on a CRTC
1020 * @dev: DRM device
1021 * @crtc: CRTC in question
1022 *
Daniel Vetterf5752b32014-05-08 16:41:51 +02001023 * Drivers can use this function to shut down the vblank interrupt handling when
1024 * disabling a crtc. This function ensures that the latest vblank frame count is
1025 * stored so that drm_vblank_on() can restore it again.
1026 *
1027 * Drivers must use this function when the hardware vblank counter can get
1028 * reset, e.g. when suspending.
Daniel Vetter89dd6a42014-05-15 15:32:12 +02001029 *
1030 * This is the legacy version of drm_crtc_vblank_off().
Rob Clarkc6eefa12012-10-16 22:48:40 +00001031 */
Li Peng778c9022009-11-09 12:51:22 +08001032void drm_vblank_off(struct drm_device *dev, int crtc)
1033{
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +03001034 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
Christopher James Halse Rogers498548e2011-04-27 16:10:57 +10001035 struct drm_pending_vblank_event *e, *t;
1036 struct timeval now;
Li Peng778c9022009-11-09 12:51:22 +08001037 unsigned long irqflags;
Christopher James Halse Rogers498548e2011-04-27 16:10:57 +10001038 unsigned int seq;
Li Peng778c9022009-11-09 12:51:22 +08001039
Ville Syrjälä56cc2792014-08-06 14:49:51 +03001040 spin_lock_irqsave(&dev->event_lock, irqflags);
1041
1042 spin_lock(&dev->vbl_lock);
Mario Kleiner27641c32010-10-23 04:20:23 +02001043 vblank_disable_and_save(dev, crtc);
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +03001044 wake_up(&vblank->queue);
Christopher James Halse Rogers498548e2011-04-27 16:10:57 +10001045
Ville Syrjälä56cc2792014-08-06 14:49:51 +03001046 /*
1047 * Prevent subsequent drm_vblank_get() from re-enabling
1048 * the vblank interrupt by bumping the refcount.
1049 */
1050 if (!vblank->inmodeset) {
1051 atomic_inc(&vblank->refcount);
1052 vblank->inmodeset = 1;
1053 }
1054 spin_unlock(&dev->vbl_lock);
1055
Christopher James Halse Rogers498548e2011-04-27 16:10:57 +10001056 /* Send any queued vblank events, lest the natives grow disquiet */
1057 seq = drm_vblank_count_and_time(dev, crtc, &now);
Imre Deake7783ba2012-11-02 13:30:50 +02001058
Christopher James Halse Rogers498548e2011-04-27 16:10:57 +10001059 list_for_each_entry_safe(e, t, &dev->vblank_event_list, base.link) {
1060 if (e->pipe != crtc)
1061 continue;
1062 DRM_DEBUG("Sending premature vblank event on disable: \
1063 wanted %d, current %d\n",
1064 e->event.sequence, seq);
Rob Clarkc6eefa12012-10-16 22:48:40 +00001065 list_del(&e->base.link);
Christopher James Halse Rogers498548e2011-04-27 16:10:57 +10001066 drm_vblank_put(dev, e->pipe);
Rob Clarkc6eefa12012-10-16 22:48:40 +00001067 send_vblank_event(dev, e, seq, &now);
Christopher James Halse Rogers498548e2011-04-27 16:10:57 +10001068 }
Ville Syrjälä56cc2792014-08-06 14:49:51 +03001069 spin_unlock_irqrestore(&dev->event_lock, irqflags);
Li Peng778c9022009-11-09 12:51:22 +08001070}
1071EXPORT_SYMBOL(drm_vblank_off);
1072
Jesse Barnes0a3e67a2008-09-30 12:14:26 -07001073/**
Daniel Vetter89dd6a42014-05-15 15:32:12 +02001074 * drm_crtc_vblank_off - disable vblank events on a CRTC
1075 * @crtc: CRTC in question
1076 *
1077 * Drivers can use this function to shut down the vblank interrupt handling when
1078 * disabling a crtc. This function ensures that the latest vblank frame count is
1079 * stored so that drm_vblank_on can restore it again.
1080 *
1081 * Drivers must use this function when the hardware vblank counter can get
1082 * reset, e.g. when suspending.
1083 *
1084 * This is the native kms version of drm_vblank_off().
1085 */
1086void drm_crtc_vblank_off(struct drm_crtc *crtc)
1087{
1088 drm_vblank_off(crtc->dev, drm_crtc_index(crtc));
1089}
1090EXPORT_SYMBOL(drm_crtc_vblank_off);
1091
1092/**
Ville Syrjäläf2752282014-02-19 21:29:49 +02001093 * drm_vblank_on - enable vblank events on a CRTC
1094 * @dev: DRM device
1095 * @crtc: CRTC in question
Daniel Vetterf5752b32014-05-08 16:41:51 +02001096 *
1097 * This functions restores the vblank interrupt state captured with
1098 * drm_vblank_off() again. Note that calls to drm_vblank_on() and
1099 * drm_vblank_off() can be unbalanced and so can also be unconditionaly called
1100 * in driver load code to reflect the current hardware state of the crtc.
Daniel Vetter89dd6a42014-05-15 15:32:12 +02001101 *
1102 * This is the legacy version of drm_crtc_vblank_on().
Ville Syrjäläf2752282014-02-19 21:29:49 +02001103 */
1104void drm_vblank_on(struct drm_device *dev, int crtc)
1105{
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +03001106 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
Ville Syrjäläf2752282014-02-19 21:29:49 +02001107 unsigned long irqflags;
1108
1109 spin_lock_irqsave(&dev->vbl_lock, irqflags);
Ville Syrjälä7ffd7a62014-08-06 14:49:44 +03001110 /* Drop our private "prevent drm_vblank_get" refcount */
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +03001111 if (vblank->inmodeset) {
1112 atomic_dec(&vblank->refcount);
1113 vblank->inmodeset = 0;
Ville Syrjälä7ffd7a62014-08-06 14:49:44 +03001114 }
Ville Syrjäläf8ad0282014-08-06 14:49:49 +03001115
1116 /*
1117 * sample the current counter to avoid random jumps
1118 * when drm_vblank_enable() applies the diff
1119 *
1120 * -1 to make sure user will never see the same
1121 * vblank counter value before and after a modeset
1122 */
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +03001123 vblank->last =
Ville Syrjäläf8ad0282014-08-06 14:49:49 +03001124 (dev->driver->get_vblank_counter(dev, crtc) - 1) &
1125 dev->max_vblank_count;
1126
Ville Syrjäläf2752282014-02-19 21:29:49 +02001127 /* re-enable interrupts if there's are users left */
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +03001128 if (atomic_read(&vblank->refcount) != 0)
Ville Syrjäläf2752282014-02-19 21:29:49 +02001129 WARN_ON(drm_vblank_enable(dev, crtc));
1130 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
1131}
1132EXPORT_SYMBOL(drm_vblank_on);
1133
1134/**
Daniel Vetter89dd6a42014-05-15 15:32:12 +02001135 * drm_crtc_vblank_on - enable vblank events on a CRTC
1136 * @crtc: CRTC in question
1137 *
1138 * This functions restores the vblank interrupt state captured with
1139 * drm_vblank_off() again. Note that calls to drm_vblank_on() and
1140 * drm_vblank_off() can be unbalanced and so can also be unconditionaly called
1141 * in driver load code to reflect the current hardware state of the crtc.
1142 *
1143 * This is the native kms version of drm_vblank_on().
1144 */
1145void drm_crtc_vblank_on(struct drm_crtc *crtc)
1146{
1147 drm_vblank_on(crtc->dev, drm_crtc_index(crtc));
1148}
1149EXPORT_SYMBOL(drm_crtc_vblank_on);
1150
1151/**
Dave Airlief453ba02008-11-07 14:05:41 -08001152 * drm_vblank_pre_modeset - account for vblanks across mode sets
1153 * @dev: DRM device
1154 * @crtc: CRTC in question
Dave Airlief453ba02008-11-07 14:05:41 -08001155 *
1156 * Account for vblank events across mode setting events, which will likely
1157 * reset the hardware frame counter.
Daniel Vetterf5752b32014-05-08 16:41:51 +02001158 *
1159 * This is done by grabbing a temporary vblank reference to ensure that the
1160 * vblank interrupt keeps running across the modeset sequence. With this the
1161 * software-side vblank frame counting will ensure that there are no jumps or
1162 * discontinuities.
1163 *
1164 * Unfortunately this approach is racy and also doesn't work when the vblank
1165 * interrupt stops running, e.g. across system suspend resume. It is therefore
1166 * highly recommended that drivers use the newer drm_vblank_off() and
1167 * drm_vblank_on() instead. drm_vblank_pre_modeset() only works correctly when
1168 * using "cooked" software vblank frame counters and not relying on any hardware
1169 * counters.
1170 *
1171 * Drivers must call drm_vblank_post_modeset() when re-enabling the same crtc
1172 * again.
Dave Airlief453ba02008-11-07 14:05:41 -08001173 */
1174void drm_vblank_pre_modeset(struct drm_device *dev, int crtc)
1175{
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +03001176 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
1177
Huacai Chenb7ea85a42013-05-21 06:23:43 +00001178 /* vblank is not initialized (IRQ not installed ?), or has been freed */
Jerome Glissee77cef92010-01-07 15:39:13 +01001179 if (!dev->num_crtcs)
1180 return;
Dave Airlief453ba02008-11-07 14:05:41 -08001181 /*
1182 * To avoid all the problems that might happen if interrupts
1183 * were enabled/disabled around or between these calls, we just
1184 * have the kernel take a reference on the CRTC (just once though
1185 * to avoid corrupting the count if multiple, mismatch calls occur),
1186 * so that interrupts remain enabled in the interim.
1187 */
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +03001188 if (!vblank->inmodeset) {
1189 vblank->inmodeset = 0x1;
Chris Wilsonb3f5e732009-02-19 14:48:22 +00001190 if (drm_vblank_get(dev, crtc) == 0)
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +03001191 vblank->inmodeset |= 0x2;
Dave Airlief453ba02008-11-07 14:05:41 -08001192 }
1193}
1194EXPORT_SYMBOL(drm_vblank_pre_modeset);
1195
Daniel Vetterf5752b32014-05-08 16:41:51 +02001196/**
1197 * drm_vblank_post_modeset - undo drm_vblank_pre_modeset changes
1198 * @dev: DRM device
1199 * @crtc: CRTC in question
1200 *
1201 * This function again drops the temporary vblank reference acquired in
1202 * drm_vblank_pre_modeset.
1203 */
Dave Airlief453ba02008-11-07 14:05:41 -08001204void drm_vblank_post_modeset(struct drm_device *dev, int crtc)
1205{
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +03001206 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
Dave Airlief453ba02008-11-07 14:05:41 -08001207 unsigned long irqflags;
1208
Huacai Chenb7ea85a42013-05-21 06:23:43 +00001209 /* vblank is not initialized (IRQ not installed ?), or has been freed */
1210 if (!dev->num_crtcs)
1211 return;
1212
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +03001213 if (vblank->inmodeset) {
Dave Airlief453ba02008-11-07 14:05:41 -08001214 spin_lock_irqsave(&dev->vbl_lock, irqflags);
Ville Syrjäläba0bf122013-10-04 14:53:33 +03001215 dev->vblank_disable_allowed = true;
Dave Airlief453ba02008-11-07 14:05:41 -08001216 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
Chris Wilsonb3f5e732009-02-19 14:48:22 +00001217
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +03001218 if (vblank->inmodeset & 0x2)
Chris Wilsonb3f5e732009-02-19 14:48:22 +00001219 drm_vblank_put(dev, crtc);
1220
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +03001221 vblank->inmodeset = 0;
Dave Airlief453ba02008-11-07 14:05:41 -08001222 }
1223}
1224EXPORT_SYMBOL(drm_vblank_post_modeset);
1225
Daniel Vetterf5752b32014-05-08 16:41:51 +02001226/*
Jesse Barnes0a3e67a2008-09-30 12:14:26 -07001227 * drm_modeset_ctl - handle vblank event counter changes across mode switch
1228 * @DRM_IOCTL_ARGS: standard ioctl arguments
1229 *
1230 * Applications should call the %_DRM_PRE_MODESET and %_DRM_POST_MODESET
1231 * ioctls around modesetting so that any lost vblank events are accounted for.
1232 *
1233 * Generally the counter will reset across mode sets. If interrupts are
1234 * enabled around this call, we don't have to do anything since the counter
1235 * will have already been incremented.
1236 */
1237int drm_modeset_ctl(struct drm_device *dev, void *data,
1238 struct drm_file *file_priv)
1239{
1240 struct drm_modeset_ctl *modeset = data;
Dave Airlie19227562011-02-24 08:35:06 +10001241 unsigned int crtc;
Jesse Barnes0a3e67a2008-09-30 12:14:26 -07001242
1243 /* If drm_vblank_init() hasn't been called yet, just no-op */
1244 if (!dev->num_crtcs)
Laurent Pinchart4a1b0712012-05-17 13:27:21 +02001245 return 0;
Jesse Barnes0a3e67a2008-09-30 12:14:26 -07001246
Laurent Pinchart29935552012-05-30 00:58:09 +02001247 /* KMS drivers handle this internally */
1248 if (drm_core_check_feature(dev, DRIVER_MODESET))
1249 return 0;
1250
Jesse Barnes0a3e67a2008-09-30 12:14:26 -07001251 crtc = modeset->crtc;
Laurent Pinchart4a1b0712012-05-17 13:27:21 +02001252 if (crtc >= dev->num_crtcs)
1253 return -EINVAL;
Jesse Barnes0a3e67a2008-09-30 12:14:26 -07001254
Jesse Barnes0a3e67a2008-09-30 12:14:26 -07001255 switch (modeset->cmd) {
1256 case _DRM_PRE_MODESET:
Dave Airlief453ba02008-11-07 14:05:41 -08001257 drm_vblank_pre_modeset(dev, crtc);
Jesse Barnes0a3e67a2008-09-30 12:14:26 -07001258 break;
1259 case _DRM_POST_MODESET:
Dave Airlief453ba02008-11-07 14:05:41 -08001260 drm_vblank_post_modeset(dev, crtc);
Jesse Barnes0a3e67a2008-09-30 12:14:26 -07001261 break;
1262 default:
Laurent Pinchart4a1b0712012-05-17 13:27:21 +02001263 return -EINVAL;
Jesse Barnes0a3e67a2008-09-30 12:14:26 -07001264 }
1265
Laurent Pinchart4a1b0712012-05-17 13:27:21 +02001266 return 0;
Jesse Barnes0a3e67a2008-09-30 12:14:26 -07001267}
1268
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001269static int drm_queue_vblank_event(struct drm_device *dev, int pipe,
1270 union drm_wait_vblank *vblwait,
1271 struct drm_file *file_priv)
1272{
Ville Syrjäläffe7c732014-08-06 14:49:52 +03001273 struct drm_vblank_crtc *vblank = &dev->vblank[pipe];
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001274 struct drm_pending_vblank_event *e;
1275 struct timeval now;
1276 unsigned long flags;
1277 unsigned int seq;
Chris Wilsonea5d5522010-12-01 19:41:31 +00001278 int ret;
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001279
1280 e = kzalloc(sizeof *e, GFP_KERNEL);
Chris Wilsonea5d5522010-12-01 19:41:31 +00001281 if (e == NULL) {
1282 ret = -ENOMEM;
1283 goto err_put;
1284 }
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001285
1286 e->pipe = pipe;
Jesse Barnesb9c2c9a2010-07-01 16:48:09 -07001287 e->base.pid = current->pid;
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001288 e->event.base.type = DRM_EVENT_VBLANK;
1289 e->event.base.length = sizeof e->event;
1290 e->event.user_data = vblwait->request.signal;
1291 e->base.event = &e->event.base;
1292 e->base.file_priv = file_priv;
1293 e->base.destroy = (void (*) (struct drm_pending_event *)) kfree;
1294
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001295 spin_lock_irqsave(&dev->event_lock, flags);
1296
Ville Syrjäläffe7c732014-08-06 14:49:52 +03001297 /*
1298 * drm_vblank_off() might have been called after we called
1299 * drm_vblank_get(). drm_vblank_off() holds event_lock
1300 * around the vblank disable, so no need for further locking.
1301 * The reference from drm_vblank_get() protects against
1302 * vblank disable from another source.
1303 */
1304 if (!vblank->enabled) {
1305 ret = -EINVAL;
1306 goto err_unlock;
1307 }
1308
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001309 if (file_priv->event_space < sizeof e->event) {
Chris Wilsonea5d5522010-12-01 19:41:31 +00001310 ret = -EBUSY;
1311 goto err_unlock;
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001312 }
1313
1314 file_priv->event_space -= sizeof e->event;
Mario Kleiner27641c32010-10-23 04:20:23 +02001315 seq = drm_vblank_count_and_time(dev, pipe, &now);
1316
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001317 if ((vblwait->request.type & _DRM_VBLANK_NEXTONMISS) &&
1318 (seq - vblwait->request.sequence) <= (1 << 23)) {
1319 vblwait->request.sequence = seq + 1;
Jesse Barnes4a921642009-11-10 08:21:25 +00001320 vblwait->reply.sequence = vblwait->request.sequence;
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001321 }
1322
1323 DRM_DEBUG("event on vblank count %d, current %d, crtc %d\n",
1324 vblwait->request.sequence, seq, pipe);
1325
Jesse Barnesb9c2c9a2010-07-01 16:48:09 -07001326 trace_drm_vblank_event_queued(current->pid, pipe,
1327 vblwait->request.sequence);
1328
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001329 e->event.sequence = vblwait->request.sequence;
1330 if ((seq - vblwait->request.sequence) <= (1 << 23)) {
Dan Carpenter6f331622010-12-09 08:35:40 +03001331 drm_vblank_put(dev, pipe);
Rob Clarkc6eefa12012-10-16 22:48:40 +00001332 send_vblank_event(dev, e, seq, &now);
Mario Kleiner000fa7c2010-12-10 16:00:19 +01001333 vblwait->reply.sequence = seq;
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001334 } else {
Ilija Hadzica6778e92011-10-31 13:11:57 -04001335 /* drm_handle_vblank_events will call drm_vblank_put */
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001336 list_add_tail(&e->base.link, &dev->vblank_event_list);
Mario Kleiner000fa7c2010-12-10 16:00:19 +01001337 vblwait->reply.sequence = vblwait->request.sequence;
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001338 }
1339
1340 spin_unlock_irqrestore(&dev->event_lock, flags);
1341
1342 return 0;
Chris Wilsonea5d5522010-12-01 19:41:31 +00001343
1344err_unlock:
1345 spin_unlock_irqrestore(&dev->event_lock, flags);
1346 kfree(e);
1347err_put:
Dan Carpenter6f331622010-12-09 08:35:40 +03001348 drm_vblank_put(dev, pipe);
Chris Wilsonea5d5522010-12-01 19:41:31 +00001349 return ret;
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001350}
1351
Daniel Vetterf5752b32014-05-08 16:41:51 +02001352/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353 * Wait for VBLANK.
1354 *
1355 * \param inode device inode.
Eric Anholt6c340ea2007-08-25 20:23:09 +10001356 * \param file_priv DRM file private.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357 * \param cmd command.
1358 * \param data user argument, pointing to a drm_wait_vblank structure.
1359 * \return zero on success or a negative number on failure.
1360 *
Eric Anholt30b23632009-01-27 21:19:41 -08001361 * This function enables the vblank interrupt on the pipe requested, then
1362 * sleeps waiting for the requested sequence number to occur, and drops
Daniel Vetterf5752b32014-05-08 16:41:51 +02001363 * the vblank interrupt refcount afterwards. (vblank IRQ disable follows that
Eric Anholt30b23632009-01-27 21:19:41 -08001364 * after a timeout with no further vblank waits scheduled).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 */
Jesse Barnes0a3e67a2008-09-30 12:14:26 -07001366int drm_wait_vblank(struct drm_device *dev, void *data,
1367 struct drm_file *file_priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368{
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +03001369 struct drm_vblank_crtc *vblank;
Eric Anholtc153f452007-09-03 12:06:45 +10001370 union drm_wait_vblank *vblwait = data;
Laurent Pinchart4a1b0712012-05-17 13:27:21 +02001371 int ret;
Ilija Hadzic19b01b52011-03-18 16:58:04 -05001372 unsigned int flags, seq, crtc, high_crtc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373
Daniel Vetter49849792013-08-28 15:02:37 +02001374 if (!dev->irq_enabled)
1375 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376
Eric Anholt30b23632009-01-27 21:19:41 -08001377 if (vblwait->request.type & _DRM_VBLANK_SIGNAL)
1378 return -EINVAL;
1379
Eric Anholtc153f452007-09-03 12:06:45 +10001380 if (vblwait->request.type &
Ilija Hadzic19b01b52011-03-18 16:58:04 -05001381 ~(_DRM_VBLANK_TYPES_MASK | _DRM_VBLANK_FLAGS_MASK |
1382 _DRM_VBLANK_HIGH_CRTC_MASK)) {
=?utf-8?q?Michel_D=C3=A4nzer?=776c9442006-10-24 22:24:38 +10001383 DRM_ERROR("Unsupported type value 0x%x, supported mask 0x%x\n",
Eric Anholtc153f452007-09-03 12:06:45 +10001384 vblwait->request.type,
Ilija Hadzic19b01b52011-03-18 16:58:04 -05001385 (_DRM_VBLANK_TYPES_MASK | _DRM_VBLANK_FLAGS_MASK |
1386 _DRM_VBLANK_HIGH_CRTC_MASK));
=?utf-8?q?Michel_D=C3=A4nzer?=776c9442006-10-24 22:24:38 +10001387 return -EINVAL;
1388 }
1389
Eric Anholtc153f452007-09-03 12:06:45 +10001390 flags = vblwait->request.type & _DRM_VBLANK_FLAGS_MASK;
Ilija Hadzic19b01b52011-03-18 16:58:04 -05001391 high_crtc = (vblwait->request.type & _DRM_VBLANK_HIGH_CRTC_MASK);
1392 if (high_crtc)
1393 crtc = high_crtc >> _DRM_VBLANK_HIGH_CRTC_SHIFT;
1394 else
1395 crtc = flags & _DRM_VBLANK_SECONDARY ? 1 : 0;
Jesse Barnes0a3e67a2008-09-30 12:14:26 -07001396 if (crtc >= dev->num_crtcs)
=?utf-8?q?Michel_D=C3=A4nzer?=776c9442006-10-24 22:24:38 +10001397 return -EINVAL;
1398
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +03001399 vblank = &dev->vblank[crtc];
1400
Jesse Barnes0a3e67a2008-09-30 12:14:26 -07001401 ret = drm_vblank_get(dev, crtc);
1402 if (ret) {
Paul Rolland8d3457e2009-08-09 12:24:01 +10001403 DRM_DEBUG("failed to acquire vblank counter, %d\n", ret);
Jesse Barnes0a3e67a2008-09-30 12:14:26 -07001404 return ret;
1405 }
1406 seq = drm_vblank_count(dev, crtc);
=?utf-8?q?Michel_D=C3=A4nzer?=776c9442006-10-24 22:24:38 +10001407
Eric Anholtc153f452007-09-03 12:06:45 +10001408 switch (vblwait->request.type & _DRM_VBLANK_TYPES_MASK) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409 case _DRM_VBLANK_RELATIVE:
Eric Anholtc153f452007-09-03 12:06:45 +10001410 vblwait->request.sequence += seq;
1411 vblwait->request.type &= ~_DRM_VBLANK_RELATIVE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412 case _DRM_VBLANK_ABSOLUTE:
1413 break;
1414 default:
Jesse Barnes0a3e67a2008-09-30 12:14:26 -07001415 ret = -EINVAL;
1416 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 }
1418
Ilija Hadzica6778e92011-10-31 13:11:57 -04001419 if (flags & _DRM_VBLANK_EVENT) {
1420 /* must hold on to the vblank ref until the event fires
1421 * drm_vblank_put will be called asynchronously
1422 */
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001423 return drm_queue_vblank_event(dev, crtc, vblwait, file_priv);
Ilija Hadzica6778e92011-10-31 13:11:57 -04001424 }
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001425
=?utf-8?q?Michel_D=C3=A4nzer?=ab285d72006-10-24 23:34:18 +10001426 if ((flags & _DRM_VBLANK_NEXTONMISS) &&
Eric Anholtc153f452007-09-03 12:06:45 +10001427 (seq - vblwait->request.sequence) <= (1<<23)) {
1428 vblwait->request.sequence = seq + 1;
=?utf-8?q?Michel_D=C3=A4nzer?=ab285d72006-10-24 23:34:18 +10001429 }
1430
Eric Anholt30b23632009-01-27 21:19:41 -08001431 DRM_DEBUG("waiting on vblank count %d, crtc %d\n",
1432 vblwait->request.sequence, crtc);
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +03001433 vblank->last_wait = vblwait->request.sequence;
1434 DRM_WAIT_ON(ret, vblank->queue, 3 * HZ,
Eric Anholt30b23632009-01-27 21:19:41 -08001435 (((drm_vblank_count(dev, crtc) -
1436 vblwait->request.sequence) <= (1 << 23)) ||
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +03001437 !vblank->enabled ||
Eric Anholt30b23632009-01-27 21:19:41 -08001438 !dev->irq_enabled));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439
Eric Anholt30b23632009-01-27 21:19:41 -08001440 if (ret != -EINTR) {
1441 struct timeval now;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442
Mario Kleiner27641c32010-10-23 04:20:23 +02001443 vblwait->reply.sequence = drm_vblank_count_and_time(dev, crtc, &now);
Eric Anholt30b23632009-01-27 21:19:41 -08001444 vblwait->reply.tval_sec = now.tv_sec;
1445 vblwait->reply.tval_usec = now.tv_usec;
Mario Kleiner27641c32010-10-23 04:20:23 +02001446
Eric Anholt30b23632009-01-27 21:19:41 -08001447 DRM_DEBUG("returning %d to client\n",
1448 vblwait->reply.sequence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449 } else {
Eric Anholt30b23632009-01-27 21:19:41 -08001450 DRM_DEBUG("vblank wait interrupted by signal\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 }
1452
Jesse Barnes0a3e67a2008-09-30 12:14:26 -07001453done:
1454 drm_vblank_put(dev, crtc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455 return ret;
1456}
1457
Sachin Kamatea7f7ab2012-08-01 17:15:31 +05301458static void drm_handle_vblank_events(struct drm_device *dev, int crtc)
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001459{
1460 struct drm_pending_vblank_event *e, *t;
1461 struct timeval now;
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001462 unsigned int seq;
1463
Ville Syrjälä56cc2792014-08-06 14:49:51 +03001464 assert_spin_locked(&dev->event_lock);
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001465
Ville Syrjälä56cc2792014-08-06 14:49:51 +03001466 seq = drm_vblank_count_and_time(dev, crtc, &now);
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001467
1468 list_for_each_entry_safe(e, t, &dev->vblank_event_list, base.link) {
1469 if (e->pipe != crtc)
1470 continue;
1471 if ((seq - e->event.sequence) > (1<<23))
1472 continue;
1473
1474 DRM_DEBUG("vblank event on %d, current %d\n",
1475 e->event.sequence, seq);
1476
Rob Clarkc6eefa12012-10-16 22:48:40 +00001477 list_del(&e->base.link);
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001478 drm_vblank_put(dev, e->pipe);
Rob Clarkc6eefa12012-10-16 22:48:40 +00001479 send_vblank_event(dev, e, seq, &now);
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001480 }
1481
Jesse Barnesac2874b2010-07-01 16:47:31 -07001482 trace_drm_vblank_event(crtc, seq);
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001483}
1484
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485/**
Jesse Barnes0a3e67a2008-09-30 12:14:26 -07001486 * drm_handle_vblank - handle a vblank event
1487 * @dev: DRM device
1488 * @crtc: where this event occurred
1489 *
1490 * Drivers should call this routine in their vblank interrupt handlers to
1491 * update the vblank counter and send any signals that may be pending.
1492 */
Chris Wilson78c6e172011-01-31 10:48:04 +00001493bool drm_handle_vblank(struct drm_device *dev, int crtc)
Jesse Barnes0a3e67a2008-09-30 12:14:26 -07001494{
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +03001495 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
Mario Kleiner27641c32010-10-23 04:20:23 +02001496 u32 vblcount;
1497 s64 diff_ns;
1498 struct timeval tvblank;
1499 unsigned long irqflags;
1500
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001501 if (!dev->num_crtcs)
Chris Wilson78c6e172011-01-31 10:48:04 +00001502 return false;
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001503
Ville Syrjälä56cc2792014-08-06 14:49:51 +03001504 spin_lock_irqsave(&dev->event_lock, irqflags);
1505
Mario Kleiner27641c32010-10-23 04:20:23 +02001506 /* Need timestamp lock to prevent concurrent execution with
1507 * vblank enable/disable, as this would cause inconsistent
1508 * or corrupted timestamps and vblank counts.
1509 */
Ville Syrjälä56cc2792014-08-06 14:49:51 +03001510 spin_lock(&dev->vblank_time_lock);
Mario Kleiner27641c32010-10-23 04:20:23 +02001511
1512 /* Vblank irq handling disabled. Nothing to do. */
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +03001513 if (!vblank->enabled) {
Ville Syrjälä56cc2792014-08-06 14:49:51 +03001514 spin_unlock(&dev->vblank_time_lock);
1515 spin_unlock_irqrestore(&dev->event_lock, irqflags);
Chris Wilson78c6e172011-01-31 10:48:04 +00001516 return false;
Mario Kleiner27641c32010-10-23 04:20:23 +02001517 }
1518
1519 /* Fetch corresponding timestamp for this vblank interval from
1520 * driver and store it in proper slot of timestamp ringbuffer.
1521 */
1522
1523 /* Get current timestamp and count. */
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +03001524 vblcount = atomic_read(&vblank->count);
Mario Kleiner27641c32010-10-23 04:20:23 +02001525 drm_get_last_vbltimestamp(dev, crtc, &tvblank, DRM_CALLED_FROM_VBLIRQ);
1526
1527 /* Compute time difference to timestamp of last vblank */
1528 diff_ns = timeval_to_ns(&tvblank) -
1529 timeval_to_ns(&vblanktimestamp(dev, crtc, vblcount));
1530
1531 /* Update vblank timestamp and count if at least
1532 * DRM_REDUNDANT_VBLIRQ_THRESH_NS nanoseconds
1533 * difference between last stored timestamp and current
1534 * timestamp. A smaller difference means basically
1535 * identical timestamps. Happens if this vblank has
1536 * been already processed and this is a redundant call,
1537 * e.g., due to spurious vblank interrupts. We need to
1538 * ignore those for accounting.
1539 */
Mario Kleinerc4cc3832011-02-21 05:42:00 +01001540 if (abs64(diff_ns) > DRM_REDUNDANT_VBLIRQ_THRESH_NS) {
Mario Kleiner27641c32010-10-23 04:20:23 +02001541 /* Store new timestamp in ringbuffer. */
1542 vblanktimestamp(dev, crtc, vblcount + 1) = tvblank;
Mario Kleiner27641c32010-10-23 04:20:23 +02001543
1544 /* Increment cooked vblank count. This also atomically commits
1545 * the timestamp computed above.
1546 */
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001547 smp_mb__before_atomic();
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +03001548 atomic_inc(&vblank->count);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001549 smp_mb__after_atomic();
Mario Kleiner27641c32010-10-23 04:20:23 +02001550 } else {
1551 DRM_DEBUG("crtc %d: Redundant vblirq ignored. diff_ns = %d\n",
1552 crtc, (int) diff_ns);
1553 }
1554
Ville Syrjälä56cc2792014-08-06 14:49:51 +03001555 spin_unlock(&dev->vblank_time_lock);
1556
Ville Syrjälä8a51d5b2014-08-06 14:49:50 +03001557 wake_up(&vblank->queue);
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +10001558 drm_handle_vblank_events(dev, crtc);
Mario Kleiner27641c32010-10-23 04:20:23 +02001559
Ville Syrjälä56cc2792014-08-06 14:49:51 +03001560 spin_unlock_irqrestore(&dev->event_lock, irqflags);
1561
Chris Wilson78c6e172011-01-31 10:48:04 +00001562 return true;
Jesse Barnes0a3e67a2008-09-30 12:14:26 -07001563}
1564EXPORT_SYMBOL(drm_handle_vblank);