drm: Simplify return value of drm_get_last_vbltimestamp
[deliverable/linux.git] / drivers / gpu / drm / drm_irq.c
CommitLineData
f5752b38
DV
1/*
2 * drm_irq.c IRQ and vblank support
1da177e4
LT
3 *
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
760285e7 35#include <drm/drmP.h>
ac2874b9 36#include "drm_trace.h"
1da177e4
LT
37
38#include <linux/interrupt.h> /* For task queue support */
5a0e3ad6 39#include <linux/slab.h>
1da177e4 40
28d52043 41#include <linux/vgaarb.h>
2d1a8a48 42#include <linux/export.h>
27641c3f
MK
43
44/* Access macro for slots in vblank timestamp ringbuffer. */
5380e929
VS
45#define vblanktimestamp(dev, crtc, count) \
46 ((dev)->vblank[crtc].time[(count) % DRM_VBLANKTIME_RBSIZE])
27641c3f
MK
47
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
fb446a1a
DV
58static bool
59drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
60 struct timeval *tvblank, unsigned flags);
61
13b030af
VS
62/**
63 * drm_update_vblank_count - update the master vblank counter
64 * @dev: DRM device
65 * @crtc: counter to update
66 *
67 * Call back into the driver to update the appropriate vblank counter
68 * (specified by @crtc). Deal with wraparound, if it occurred, and
69 * update the last read value so we can deal with wraparound on the next
70 * call if necessary.
71 *
72 * Only necessary when going from off->on, to account for frames we
73 * didn't get an interrupt for.
74 *
75 * Note: caller must hold dev->vbl_lock since this reads & writes
76 * device vblank fields.
77 */
78static void drm_update_vblank_count(struct drm_device *dev, int crtc)
79{
8a51d5be 80 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
fb446a1a
DV
81 u32 cur_vblank, diff, tslot;
82 bool rc;
13b030af
VS
83 struct timeval t_vblank;
84
85 /*
86 * Interrupts were disabled prior to this call, so deal with counter
87 * wrap if needed.
88 * NOTE! It's possible we lost a full dev->max_vblank_count events
89 * here if the register is small or we had vblank interrupts off for
90 * a long time.
91 *
92 * We repeat the hardware vblank counter & timestamp query until
93 * we get consistent results. This to prevent races between gpu
94 * updating its hardware counter while we are retrieving the
95 * corresponding vblank timestamp.
96 */
97 do {
98 cur_vblank = dev->driver->get_vblank_counter(dev, crtc);
99 rc = drm_get_last_vbltimestamp(dev, crtc, &t_vblank, 0);
100 } while (cur_vblank != dev->driver->get_vblank_counter(dev, crtc));
101
102 /* Deal with counter wrap */
8a51d5be
VS
103 diff = cur_vblank - vblank->last;
104 if (cur_vblank < vblank->last) {
13b030af
VS
105 diff += dev->max_vblank_count;
106
107 DRM_DEBUG("last_vblank[%d]=0x%x, cur_vblank=0x%x => diff=0x%x\n",
8a51d5be 108 crtc, vblank->last, cur_vblank, diff);
13b030af
VS
109 }
110
96a9fdd7 111 DRM_DEBUG("updating vblank count on crtc %d, missed %d\n",
13b030af
VS
112 crtc, diff);
113
114 /* Reinitialize corresponding vblank timestamp if high-precision query
115 * available. Skip this step if query unsupported or failed. Will
116 * reinitialize delayed at next vblank interrupt in that case.
117 */
118 if (rc) {
8a51d5be 119 tslot = atomic_read(&vblank->count) + diff;
13b030af
VS
120 vblanktimestamp(dev, crtc, tslot) = t_vblank;
121 }
122
123 smp_mb__before_atomic();
8a51d5be 124 atomic_add(diff, &vblank->count);
13b030af
VS
125 smp_mb__after_atomic();
126}
127
27641c3f
MK
128/*
129 * Disable vblank irq's on crtc, make sure that last vblank count
130 * of hardware and corresponding consistent software vblank counter
131 * are preserved, even if there are any spurious vblank irq's after
132 * disable.
133 */
134static void vblank_disable_and_save(struct drm_device *dev, int crtc)
135{
8a51d5be 136 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
27641c3f
MK
137 unsigned long irqflags;
138 u32 vblcount;
139 s64 diff_ns;
fb446a1a 140 bool vblrc;
27641c3f 141 struct timeval tvblank;
0355cf3a 142 int count = DRM_TIMESTAMP_MAXRETRIES;
27641c3f
MK
143
144 /* Prevent vblank irq processing while disabling vblank irqs,
145 * so no updates of timestamps or count can happen after we've
146 * disabled. Needed to prevent races in case of delayed irq's.
27641c3f 147 */
27641c3f
MK
148 spin_lock_irqsave(&dev->vblank_time_lock, irqflags);
149
812e7465
VS
150 /*
151 * If the vblank interrupt was already disbled update the count
152 * and timestamp to maintain the appearance that the counter
153 * has been ticking all along until this time. This makes the
154 * count account for the entire time between drm_vblank_on() and
155 * drm_vblank_off().
855d30b4
DV
156 *
157 * But only do this if precise vblank timestamps are available.
158 * Otherwise we might read a totally bogus timestamp since drivers
159 * lacking precise timestamp support rely upon sampling the system clock
160 * at vblank interrupt time. Which obviously won't work out well if the
161 * vblank interrupt is disabled.
812e7465 162 */
855d30b4 163 if (!vblank->enabled &&
fb446a1a 164 drm_get_last_vbltimestamp(dev, crtc, &tvblank, 0)) {
812e7465
VS
165 drm_update_vblank_count(dev, crtc);
166 spin_unlock_irqrestore(&dev->vblank_time_lock, irqflags);
167 return;
168 }
169
27641c3f 170 dev->driver->disable_vblank(dev, crtc);
8a51d5be 171 vblank->enabled = false;
27641c3f
MK
172
173 /* No further vblank irq's will be processed after
174 * this point. Get current hardware vblank count and
175 * vblank timestamp, repeat until they are consistent.
176 *
177 * FIXME: There is still a race condition here and in
178 * drm_update_vblank_count() which can cause off-by-one
179 * reinitialization of software vblank counter. If gpu
180 * vblank counter doesn't increment exactly at the leading
181 * edge of a vblank interval, then we can lose 1 count if
182 * we happen to execute between start of vblank and the
183 * delayed gpu counter increment.
184 */
185 do {
8a51d5be 186 vblank->last = dev->driver->get_vblank_counter(dev, crtc);
27641c3f 187 vblrc = drm_get_last_vbltimestamp(dev, crtc, &tvblank, 0);
8a51d5be 188 } while (vblank->last != dev->driver->get_vblank_counter(dev, crtc) && (--count) && vblrc);
0355cf3a
EE
189
190 if (!count)
191 vblrc = 0;
27641c3f
MK
192
193 /* Compute time difference to stored timestamp of last vblank
194 * as updated by last invocation of drm_handle_vblank() in vblank irq.
195 */
8a51d5be 196 vblcount = atomic_read(&vblank->count);
27641c3f
MK
197 diff_ns = timeval_to_ns(&tvblank) -
198 timeval_to_ns(&vblanktimestamp(dev, crtc, vblcount));
199
200 /* If there is at least 1 msec difference between the last stored
201 * timestamp and tvblank, then we are currently executing our
202 * disable inside a new vblank interval, the tvblank timestamp
203 * corresponds to this new vblank interval and the irq handler
204 * for this vblank didn't run yet and won't run due to our disable.
205 * Therefore we need to do the job of drm_handle_vblank() and
206 * increment the vblank counter by one to account for this vblank.
207 *
208 * Skip this step if there isn't any high precision timestamp
209 * available. In that case we can't account for this and just
210 * hope for the best.
211 */
fb446a1a 212 if (vblrc && (abs64(diff_ns) > 1000000)) {
c50d7521
VS
213 /* Store new timestamp in ringbuffer. */
214 vblanktimestamp(dev, crtc, vblcount + 1) = tvblank;
215
216 /* Increment cooked vblank count. This also atomically commits
217 * the timestamp computed above.
218 */
219 smp_mb__before_atomic();
8a51d5be 220 atomic_inc(&vblank->count);
4e857c58 221 smp_mb__after_atomic();
bc215128 222 }
27641c3f 223
27641c3f 224 spin_unlock_irqrestore(&dev->vblank_time_lock, irqflags);
27641c3f
MK
225}
226
0a3e67a4
JB
227static void vblank_disable_fn(unsigned long arg)
228{
e69595c2
VS
229 struct drm_vblank_crtc *vblank = (void *)arg;
230 struct drm_device *dev = vblank->dev;
0a3e67a4 231 unsigned long irqflags;
e69595c2 232 int crtc = vblank->crtc;
0a3e67a4
JB
233
234 if (!dev->vblank_disable_allowed)
235 return;
236
e69595c2
VS
237 spin_lock_irqsave(&dev->vbl_lock, irqflags);
238 if (atomic_read(&vblank->refcount) == 0 && vblank->enabled) {
239 DRM_DEBUG("disabling vblank on crtc %d\n", crtc);
240 vblank_disable_and_save(dev, crtc);
0a3e67a4 241 }
e69595c2 242 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
0a3e67a4
JB
243}
244
f5752b38
DV
245/**
246 * drm_vblank_cleanup - cleanup vblank support
247 * @dev: DRM device
248 *
249 * This function cleans up any resources allocated in drm_vblank_init.
250 */
52440211 251void drm_vblank_cleanup(struct drm_device *dev)
0a3e67a4 252{
e69595c2 253 int crtc;
2368ffb1 254 unsigned long irqflags;
e69595c2 255
0a3e67a4
JB
256 /* Bail if the driver didn't call drm_vblank_init() */
257 if (dev->num_crtcs == 0)
258 return;
259
e69595c2 260 for (crtc = 0; crtc < dev->num_crtcs; crtc++) {
8a51d5be
VS
261 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
262
263 del_timer_sync(&vblank->disable_timer);
2368ffb1
MK
264
265 spin_lock_irqsave(&dev->vbl_lock, irqflags);
266 vblank_disable_and_save(dev, crtc);
267 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
e69595c2 268 }
0a3e67a4 269
5380e929 270 kfree(dev->vblank);
0a3e67a4
JB
271
272 dev->num_crtcs = 0;
273}
e77cef9c 274EXPORT_SYMBOL(drm_vblank_cleanup);
0a3e67a4 275
f5752b38
DV
276/**
277 * drm_vblank_init - initialize vblank support
278 * @dev: drm_device
279 * @num_crtcs: number of crtcs supported by @dev
280 *
281 * This function initializes vblank support for @num_crtcs display pipelines.
282 *
283 * Returns:
284 * Zero on success or a negative error code on failure.
285 */
0a3e67a4
JB
286int drm_vblank_init(struct drm_device *dev, int num_crtcs)
287{
288 int i, ret = -ENOMEM;
289
0a3e67a4 290 spin_lock_init(&dev->vbl_lock);
27641c3f
MK
291 spin_lock_init(&dev->vblank_time_lock);
292
0a3e67a4
JB
293 dev->num_crtcs = num_crtcs;
294
5380e929
VS
295 dev->vblank = kcalloc(num_crtcs, sizeof(*dev->vblank), GFP_KERNEL);
296 if (!dev->vblank)
0a3e67a4
JB
297 goto err;
298
e69595c2 299 for (i = 0; i < num_crtcs; i++) {
8a51d5be
VS
300 struct drm_vblank_crtc *vblank = &dev->vblank[i];
301
302 vblank->dev = dev;
303 vblank->crtc = i;
304 init_waitqueue_head(&vblank->queue);
305 setup_timer(&vblank->disable_timer, vblank_disable_fn,
306 (unsigned long)vblank);
e69595c2 307 }
27641c3f 308
8f6fce03 309 DRM_INFO("Supports vblank timestamp caching Rev 2 (21.10.2013).\n");
27641c3f
MK
310
311 /* Driver specific high-precision vblank timestamping supported? */
312 if (dev->driver->get_vblank_timestamp)
313 DRM_INFO("Driver supports precise vblank timestamp query.\n");
314 else
315 DRM_INFO("No driver support for vblank timestamp query.\n");
316
ba0bf120
VS
317 dev->vblank_disable_allowed = false;
318
0a3e67a4
JB
319 return 0;
320
321err:
79a093ae 322 dev->num_crtcs = 0;
0a3e67a4
JB
323 return ret;
324}
325EXPORT_SYMBOL(drm_vblank_init);
326
28d52043
DA
327static void drm_irq_vgaarb_nokms(void *cookie, bool state)
328{
329 struct drm_device *dev = cookie;
330
331 if (dev->driver->vgaarb_irq) {
332 dev->driver->vgaarb_irq(dev, state);
333 return;
334 }
335
336 if (!dev->irq_enabled)
337 return;
338
5037f8ac
JS
339 if (state) {
340 if (dev->driver->irq_uninstall)
341 dev->driver->irq_uninstall(dev);
342 } else {
343 if (dev->driver->irq_preinstall)
344 dev->driver->irq_preinstall(dev);
345 if (dev->driver->irq_postinstall)
346 dev->driver->irq_postinstall(dev);
28d52043
DA
347 }
348}
349
1da177e4 350/**
f5752b38
DV
351 * drm_irq_install - install IRQ handler
352 * @dev: DRM device
353 * @irq: IRQ number to install the handler for
1da177e4 354 *
0a3e67a4 355 * Initializes the IRQ related data. Installs the handler, calling the driver
f5752b38
DV
356 * irq_preinstall() and irq_postinstall() functions before and after the
357 * installation.
358 *
359 * This is the simplified helper interface provided for drivers with no special
360 * needs. Drivers which need to install interrupt handlers for multiple
361 * interrupts must instead set drm_device->irq_enabled to signal the DRM core
362 * that vblank interrupts are available.
363 *
364 * Returns:
365 * Zero on success or a negative error code on failure.
1da177e4 366 */
bb0f1b5c 367int drm_irq_install(struct drm_device *dev, int irq)
1da177e4 368{
4a1b0714 369 int ret;
b5e89ed5 370 unsigned long sh_flags = 0;
1da177e4
LT
371
372 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
373 return -EINVAL;
374
7c1a38e3 375 if (irq == 0)
1da177e4
LT
376 return -EINVAL;
377
1da177e4 378 /* Driver must have been initialized */
e090c53b 379 if (!dev->dev_private)
1da177e4 380 return -EINVAL;
1da177e4 381
e090c53b 382 if (dev->irq_enabled)
1da177e4 383 return -EBUSY;
4423843c 384 dev->irq_enabled = true;
1da177e4 385
7c1a38e3 386 DRM_DEBUG("irq=%d\n", irq);
1da177e4 387
b5e89ed5 388 /* Before installing handler */
5037f8ac
JS
389 if (dev->driver->irq_preinstall)
390 dev->driver->irq_preinstall(dev);
1da177e4 391
b5e89ed5 392 /* Install handler */
1da177e4 393 if (drm_core_check_feature(dev, DRIVER_IRQ_SHARED))
935f6e3a 394 sh_flags = IRQF_SHARED;
b5e89ed5 395
7c1a38e3 396 ret = request_irq(irq, dev->driver->irq_handler,
5829d183 397 sh_flags, dev->driver->name, dev);
9bfbd5cb 398
b5e89ed5 399 if (ret < 0) {
4423843c 400 dev->irq_enabled = false;
1da177e4
LT
401 return ret;
402 }
403
28d52043
DA
404 if (!drm_core_check_feature(dev, DRIVER_MODESET))
405 vga_client_register(dev->pdev, (void *)dev, drm_irq_vgaarb_nokms, NULL);
406
b5e89ed5 407 /* After installing handler */
5037f8ac
JS
408 if (dev->driver->irq_postinstall)
409 ret = dev->driver->irq_postinstall(dev);
410
0a3e67a4 411 if (ret < 0) {
4423843c 412 dev->irq_enabled = false;
e1c44acc
JS
413 if (!drm_core_check_feature(dev, DRIVER_MODESET))
414 vga_client_register(dev->pdev, NULL, NULL, NULL);
7c1a38e3
DV
415 free_irq(irq, dev);
416 } else {
417 dev->irq = irq;
0a3e67a4 418 }
1da177e4 419
0a3e67a4 420 return ret;
1da177e4 421}
0a3e67a4 422EXPORT_SYMBOL(drm_irq_install);
1da177e4
LT
423
424/**
f5752b38
DV
425 * drm_irq_uninstall - uninstall the IRQ handler
426 * @dev: DRM device
427 *
428 * Calls the driver's irq_uninstall() function and unregisters the IRQ handler.
429 * This should only be called by drivers which used drm_irq_install() to set up
430 * their interrupt handler. Other drivers must only reset
431 * drm_device->irq_enabled to false.
1da177e4 432 *
f5752b38
DV
433 * Note that for kernel modesetting drivers it is a bug if this function fails.
434 * The sanity checks are only to catch buggy user modesetting drivers which call
435 * the same function through an ioctl.
1da177e4 436 *
f5752b38
DV
437 * Returns:
438 * Zero on success or a negative error code on failure.
1da177e4 439 */
27641c3f 440int drm_irq_uninstall(struct drm_device *dev)
1da177e4 441{
dc1336ff 442 unsigned long irqflags;
4423843c
VS
443 bool irq_enabled;
444 int i;
1da177e4
LT
445
446 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
447 return -EINVAL;
448
1da177e4 449 irq_enabled = dev->irq_enabled;
4423843c 450 dev->irq_enabled = false;
1da177e4 451
dc1336ff
JB
452 /*
453 * Wake up any waiters so they don't hang.
454 */
bde4889a
BS
455 if (dev->num_crtcs) {
456 spin_lock_irqsave(&dev->vbl_lock, irqflags);
457 for (i = 0; i < dev->num_crtcs; i++) {
8a51d5be
VS
458 struct drm_vblank_crtc *vblank = &dev->vblank[i];
459
460 wake_up(&vblank->queue);
461 vblank->enabled = false;
462 vblank->last =
bde4889a
BS
463 dev->driver->get_vblank_counter(dev, i);
464 }
465 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
dc1336ff 466 }
dc1336ff 467
b5e89ed5 468 if (!irq_enabled)
1da177e4
LT
469 return -EINVAL;
470
7c1a38e3 471 DRM_DEBUG("irq=%d\n", dev->irq);
1da177e4 472
28d52043
DA
473 if (!drm_core_check_feature(dev, DRIVER_MODESET))
474 vga_client_register(dev->pdev, NULL, NULL, NULL);
475
5037f8ac
JS
476 if (dev->driver->irq_uninstall)
477 dev->driver->irq_uninstall(dev);
1da177e4 478
7c1a38e3 479 free_irq(dev->irq, dev);
1da177e4
LT
480
481 return 0;
482}
483EXPORT_SYMBOL(drm_irq_uninstall);
484
f5752b38 485/*
1da177e4
LT
486 * IRQ control ioctl.
487 *
488 * \param inode device inode.
6c340eac 489 * \param file_priv DRM file private.
1da177e4
LT
490 * \param cmd command.
491 * \param arg user argument, pointing to a drm_control structure.
492 * \return zero on success or a negative number on failure.
493 *
494 * Calls irq_install() or irq_uninstall() according to \p arg.
495 */
c153f45f
EA
496int drm_control(struct drm_device *dev, void *data,
497 struct drm_file *file_priv)
1da177e4 498{
c153f45f 499 struct drm_control *ctl = data;
a319c1a4 500 int ret = 0, irq;
b5e89ed5 501
27641c3f
MK
502 /* if we haven't irq we fallback for compatibility reasons -
503 * this used to be a separate function in drm_dma.h
504 */
1da177e4 505
22471cf6
DV
506 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
507 return 0;
508 if (drm_core_check_feature(dev, DRIVER_MODESET))
509 return 0;
510 /* UMS was only ever support on pci devices. */
511 if (WARN_ON(!dev->pdev))
512 return -EINVAL;
1da177e4 513
c153f45f 514 switch (ctl->func) {
1da177e4 515 case DRM_INST_HANDLER:
a319c1a4
DV
516 irq = dev->pdev->irq;
517
1da177e4 518 if (dev->if_version < DRM_IF_VERSION(1, 2) &&
a319c1a4 519 ctl->irq != irq)
1da177e4 520 return -EINVAL;
e090c53b 521 mutex_lock(&dev->struct_mutex);
bb0f1b5c 522 ret = drm_irq_install(dev, irq);
e090c53b
DV
523 mutex_unlock(&dev->struct_mutex);
524
525 return ret;
1da177e4 526 case DRM_UNINST_HANDLER:
e090c53b
DV
527 mutex_lock(&dev->struct_mutex);
528 ret = drm_irq_uninstall(dev);
529 mutex_unlock(&dev->struct_mutex);
530
531 return ret;
1da177e4
LT
532 default:
533 return -EINVAL;
534 }
535}
536
27641c3f 537/**
f5752b38
DV
538 * drm_calc_timestamping_constants - calculate vblank timestamp constants
539 * @crtc: drm_crtc whose timestamp constants should be updated.
540 * @mode: display mode containing the scanout timings
27641c3f 541 *
21b21560
VS
542 * Calculate and store various constants which are later
543 * needed by vblank and swap-completion timestamping, e.g,
544 * by drm_calc_vbltimestamp_from_scanoutpos(). They are
f5752b38 545 * derived from CRTC's true scanout timing, so they take
21b21560 546 * things like panel scaling or other adjustments into account.
27641c3f 547 */
545cdd55
VS
548void drm_calc_timestamping_constants(struct drm_crtc *crtc,
549 const struct drm_display_mode *mode)
27641c3f 550{
3c184f69 551 int linedur_ns = 0, pixeldur_ns = 0, framedur_ns = 0;
77666b72 552 int dotclock = mode->crtc_clock;
27641c3f
MK
553
554 /* Valid dotclock? */
555 if (dotclock > 0) {
0dae35a3
VS
556 int frame_size = mode->crtc_htotal * mode->crtc_vtotal;
557
558 /*
559 * Convert scanline length in pixels and video
560 * dot clock to line duration, frame duration
561 * and pixel duration in nanoseconds:
27641c3f 562 */
0dae35a3
VS
563 pixeldur_ns = 1000000 / dotclock;
564 linedur_ns = div_u64((u64) mode->crtc_htotal * 1000000, dotclock);
565 framedur_ns = div_u64((u64) frame_size * 1000000, dotclock);
c0ae24c1
VS
566
567 /*
568 * Fields of interlaced scanout modes are only half a frame duration.
569 */
570 if (mode->flags & DRM_MODE_FLAG_INTERLACE)
571 framedur_ns /= 2;
27641c3f
MK
572 } else
573 DRM_ERROR("crtc %d: Can't calculate constants, dotclock = 0!\n",
574 crtc->base.id);
575
576 crtc->pixeldur_ns = pixeldur_ns;
577 crtc->linedur_ns = linedur_ns;
578 crtc->framedur_ns = framedur_ns;
579
580 DRM_DEBUG("crtc %d: hwmode: htotal %d, vtotal %d, vdisplay %d\n",
545cdd55
VS
581 crtc->base.id, mode->crtc_htotal,
582 mode->crtc_vtotal, mode->crtc_vdisplay);
27641c3f 583 DRM_DEBUG("crtc %d: clock %d kHz framedur %d linedur %d, pixeldur %d\n",
3c184f69
VS
584 crtc->base.id, dotclock, framedur_ns,
585 linedur_ns, pixeldur_ns);
27641c3f
MK
586}
587EXPORT_SYMBOL(drm_calc_timestamping_constants);
588
589/**
f5752b38
DV
590 * drm_calc_vbltimestamp_from_scanoutpos - precise vblank timestamp helper
591 * @dev: DRM device
592 * @crtc: Which CRTC's vblank timestamp to retrieve
593 * @max_error: Desired maximum allowable error in timestamps (nanosecs)
594 * On return contains true maximum error of timestamp
595 * @vblank_time: Pointer to struct timeval which should receive the timestamp
596 * @flags: Flags to pass to driver:
597 * 0 = Default,
598 * DRM_CALLED_FROM_VBLIRQ = If function is called from vbl IRQ handler
599 * @refcrtc: CRTC which defines scanout timing
600 * @mode: mode which defines the scanout timings
601 *
602 * Implements calculation of exact vblank timestamps from given drm_display_mode
603 * timings and current video scanout position of a CRTC. This can be called from
604 * within get_vblank_timestamp() implementation of a kms driver to implement the
605 * actual timestamping.
27641c3f
MK
606 *
607 * Should return timestamps conforming to the OML_sync_control OpenML
608 * extension specification. The timestamp corresponds to the end of
609 * the vblank interval, aka start of scanout of topmost-leftmost display
610 * pixel in the following video frame.
611 *
612 * Requires support for optional dev->driver->get_scanout_position()
613 * in kms driver, plus a bit of setup code to provide a drm_display_mode
614 * that corresponds to the true scanout timing.
615 *
616 * The current implementation only handles standard video modes. It
617 * returns as no operation if a doublescan or interlaced video mode is
618 * active. Higher level code is expected to handle this.
619 *
f5752b38
DV
620 * Returns:
621 * Negative value on error, failure or if not supported in current
27641c3f
MK
622 * video mode:
623 *
f5752b38 624 * -EINVAL - Invalid CRTC.
27641c3f
MK
625 * -EAGAIN - Temporary unavailable, e.g., called before initial modeset.
626 * -ENOTSUPP - Function not supported in current display mode.
627 * -EIO - Failed, e.g., due to failed scanout position query.
628 *
629 * Returns or'ed positive status flags on success:
630 *
631 * DRM_VBLANKTIME_SCANOUTPOS_METHOD - Signal this method used for timestamping.
632 * DRM_VBLANKTIME_INVBL - Timestamp taken while scanout was in vblank interval.
633 *
634 */
635int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev, int crtc,
636 int *max_error,
637 struct timeval *vblank_time,
638 unsigned flags,
7da903ef
VS
639 const struct drm_crtc *refcrtc,
640 const struct drm_display_mode *mode)
27641c3f 641{
e62f2f5a
ID
642 ktime_t stime, etime, mono_time_offset;
643 struct timeval tv_etime;
8072bfa6 644 int vbl_status;
27641c3f 645 int vpos, hpos, i;
3c184f69 646 int framedur_ns, linedur_ns, pixeldur_ns, delta_ns, duration_ns;
27641c3f
MK
647 bool invbl;
648
649 if (crtc < 0 || crtc >= dev->num_crtcs) {
650 DRM_ERROR("Invalid crtc %d\n", crtc);
651 return -EINVAL;
652 }
653
654 /* Scanout position query not supported? Should not happen. */
655 if (!dev->driver->get_scanout_position) {
656 DRM_ERROR("Called from driver w/o get_scanout_position()!?\n");
657 return -EIO;
658 }
659
27641c3f
MK
660 /* Durations of frames, lines, pixels in nanoseconds. */
661 framedur_ns = refcrtc->framedur_ns;
662 linedur_ns = refcrtc->linedur_ns;
663 pixeldur_ns = refcrtc->pixeldur_ns;
664
665 /* If mode timing undefined, just return as no-op:
666 * Happens during initial modesetting of a crtc.
667 */
8072bfa6 668 if (framedur_ns == 0) {
27641c3f
MK
669 DRM_DEBUG("crtc %d: Noop due to uninitialized mode.\n", crtc);
670 return -EAGAIN;
671 }
672
27641c3f
MK
673 /* Get current scanout position with system timestamp.
674 * Repeat query up to DRM_TIMESTAMP_MAXRETRIES times
675 * if single query takes longer than max_error nanoseconds.
676 *
677 * This guarantees a tight bound on maximum error if
678 * code gets preempted or delayed for some reason.
679 */
680 for (i = 0; i < DRM_TIMESTAMP_MAXRETRIES; i++) {
8f6fce03
MK
681 /*
682 * Get vertical and horizontal scanout position vpos, hpos,
683 * and bounding timestamps stime, etime, pre/post query.
684 */
abca9e45 685 vbl_status = dev->driver->get_scanout_position(dev, crtc, flags, &vpos,
8f6fce03 686 &hpos, &stime, &etime);
27641c3f 687
8f6fce03
MK
688 /*
689 * Get correction for CLOCK_MONOTONIC -> CLOCK_REALTIME if
690 * CLOCK_REALTIME is requested.
691 */
c61eef72
ID
692 if (!drm_timestamp_monotonic)
693 mono_time_offset = ktime_get_monotonic_offset();
27641c3f 694
27641c3f
MK
695 /* Return as no-op if scanout query unsupported or failed. */
696 if (!(vbl_status & DRM_SCANOUTPOS_VALID)) {
697 DRM_DEBUG("crtc %d : scanoutpos query failed [%d].\n",
698 crtc, vbl_status);
699 return -EIO;
700 }
701
8f6fce03 702 /* Compute uncertainty in timestamp of scanout position query. */
e62f2f5a 703 duration_ns = ktime_to_ns(etime) - ktime_to_ns(stime);
27641c3f
MK
704
705 /* Accept result with < max_error nsecs timing uncertainty. */
3c184f69 706 if (duration_ns <= *max_error)
27641c3f
MK
707 break;
708 }
709
710 /* Noisy system timing? */
711 if (i == DRM_TIMESTAMP_MAXRETRIES) {
712 DRM_DEBUG("crtc %d: Noisy timestamp %d us > %d us [%d reps].\n",
3c184f69 713 crtc, duration_ns/1000, *max_error/1000, i);
27641c3f
MK
714 }
715
716 /* Return upper bound of timestamp precision error. */
3c184f69 717 *max_error = duration_ns;
27641c3f
MK
718
719 /* Check if in vblank area:
720 * vpos is >=0 in video scanout area, but negative
721 * within vblank area, counting down the number of lines until
722 * start of scanout.
723 */
724 invbl = vbl_status & DRM_SCANOUTPOS_INVBL;
725
726 /* Convert scanout position into elapsed time at raw_time query
727 * since start of scanout at first display scanline. delta_ns
728 * can be negative if start of scanout hasn't happened yet.
729 */
3c184f69 730 delta_ns = vpos * linedur_ns + hpos * pixeldur_ns;
27641c3f 731
c61eef72
ID
732 if (!drm_timestamp_monotonic)
733 etime = ktime_sub(etime, mono_time_offset);
734
e62f2f5a
ID
735 /* save this only for debugging purposes */
736 tv_etime = ktime_to_timeval(etime);
27641c3f
MK
737 /* Subtract time delta from raw timestamp to get final
738 * vblank_time timestamp for end of vblank.
739 */
e91abf80
MD
740 if (delta_ns < 0)
741 etime = ktime_add_ns(etime, -delta_ns);
742 else
743 etime = ktime_sub_ns(etime, delta_ns);
e62f2f5a 744 *vblank_time = ktime_to_timeval(etime);
27641c3f 745
bbb0aef5
JP
746 DRM_DEBUG("crtc %d : v %d p(%d,%d)@ %ld.%ld -> %ld.%ld [e %d us, %d rep]\n",
747 crtc, (int)vbl_status, hpos, vpos,
e62f2f5a 748 (long)tv_etime.tv_sec, (long)tv_etime.tv_usec,
bbb0aef5 749 (long)vblank_time->tv_sec, (long)vblank_time->tv_usec,
3c184f69 750 duration_ns/1000, i);
27641c3f
MK
751
752 vbl_status = DRM_VBLANKTIME_SCANOUTPOS_METHOD;
753 if (invbl)
754 vbl_status |= DRM_VBLANKTIME_INVBL;
755
756 return vbl_status;
757}
758EXPORT_SYMBOL(drm_calc_vbltimestamp_from_scanoutpos);
759
c61eef72
ID
760static struct timeval get_drm_timestamp(void)
761{
762 ktime_t now;
763
764 now = ktime_get();
765 if (!drm_timestamp_monotonic)
766 now = ktime_sub(now, ktime_get_monotonic_offset());
767
768 return ktime_to_timeval(now);
769}
770
27641c3f
MK
771/**
772 * drm_get_last_vbltimestamp - retrieve raw timestamp for the most recent
f5752b38 773 * vblank interval
27641c3f 774 * @dev: DRM device
f5752b38 775 * @crtc: which CRTC's vblank timestamp to retrieve
27641c3f
MK
776 * @tvblank: Pointer to target struct timeval which should receive the timestamp
777 * @flags: Flags to pass to driver:
f5752b38
DV
778 * 0 = Default,
779 * DRM_CALLED_FROM_VBLIRQ = If function is called from vbl IRQ handler
27641c3f
MK
780 *
781 * Fetches the system timestamp corresponding to the time of the most recent
f5752b38 782 * vblank interval on specified CRTC. May call into kms-driver to
27641c3f
MK
783 * compute the timestamp with a high-precision GPU specific method.
784 *
785 * Returns zero if timestamp originates from uncorrected do_gettimeofday()
786 * call, i.e., it isn't very precisely locked to the true vblank.
787 *
f5752b38 788 * Returns:
fb446a1a 789 * True if timestamp is considered to be very precise, false otherwise.
27641c3f 790 */
fb446a1a
DV
791static bool
792drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
793 struct timeval *tvblank, unsigned flags)
27641c3f 794{
4a1b0714 795 int ret;
27641c3f
MK
796
797 /* Define requested maximum error on timestamps (nanoseconds). */
798 int max_error = (int) drm_timestamp_precision * 1000;
799
800 /* Query driver if possible and precision timestamping enabled. */
801 if (dev->driver->get_vblank_timestamp && (max_error > 0)) {
802 ret = dev->driver->get_vblank_timestamp(dev, crtc, &max_error,
803 tvblank, flags);
804 if (ret > 0)
fb446a1a 805 return true;
27641c3f
MK
806 }
807
808 /* GPU high precision timestamp query unsupported or failed.
c61eef72 809 * Return current monotonic/gettimeofday timestamp as best estimate.
27641c3f 810 */
c61eef72 811 *tvblank = get_drm_timestamp();
27641c3f 812
fb446a1a 813 return false;
27641c3f 814}
27641c3f 815
0a3e67a4
JB
816/**
817 * drm_vblank_count - retrieve "cooked" vblank counter value
818 * @dev: DRM device
819 * @crtc: which counter to retrieve
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.
f5752b38
DV
824 *
825 * Returns:
826 * The software vblank counter.
0a3e67a4
JB
827 */
828u32 drm_vblank_count(struct drm_device *dev, int crtc)
829{
8a51d5be
VS
830 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
831
832 return atomic_read(&vblank->count);
0a3e67a4
JB
833}
834EXPORT_SYMBOL(drm_vblank_count);
835
27641c3f
MK
836/**
837 * drm_vblank_count_and_time - retrieve "cooked" vblank counter value
838 * and the system timestamp corresponding to that vblank counter value.
839 *
840 * @dev: DRM device
841 * @crtc: which counter to retrieve
842 * @vblanktime: Pointer to struct timeval to receive the vblank timestamp.
843 *
844 * Fetches the "cooked" vblank count value that represents the number of
845 * vblank events since the system was booted, including lost events due to
846 * modesetting activity. Returns corresponding system timestamp of the time
f5752b38 847 * of the vblank interval that corresponds to the current vblank counter value.
27641c3f
MK
848 */
849u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
850 struct timeval *vblanktime)
851{
8a51d5be 852 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
27641c3f
MK
853 u32 cur_vblank;
854
855 /* Read timestamp from slot of _vblank_time ringbuffer
856 * that corresponds to current vblank count. Retry if
857 * count has incremented during readout. This works like
858 * a seqlock.
859 */
860 do {
8a51d5be 861 cur_vblank = atomic_read(&vblank->count);
27641c3f
MK
862 *vblanktime = vblanktimestamp(dev, crtc, cur_vblank);
863 smp_rmb();
8a51d5be 864 } while (cur_vblank != atomic_read(&vblank->count));
27641c3f
MK
865
866 return cur_vblank;
867}
868EXPORT_SYMBOL(drm_vblank_count_and_time);
869
c6eefa17
RC
870static void send_vblank_event(struct drm_device *dev,
871 struct drm_pending_vblank_event *e,
872 unsigned long seq, struct timeval *now)
873{
874 WARN_ON_SMP(!spin_is_locked(&dev->event_lock));
875 e->event.sequence = seq;
876 e->event.tv_sec = now->tv_sec;
877 e->event.tv_usec = now->tv_usec;
878
879 list_add_tail(&e->base.link,
880 &e->base.file_priv->event_list);
881 wake_up_interruptible(&e->base.file_priv->event_wait);
882 trace_drm_vblank_event_delivered(e->base.pid, e->pipe,
883 e->event.sequence);
884}
885
886/**
887 * drm_send_vblank_event - helper to send vblank event after pageflip
888 * @dev: DRM device
889 * @crtc: CRTC in question
890 * @e: the event to send
891 *
892 * Updates sequence # and timestamp on event, and sends it to userspace.
893 * Caller must hold event lock.
894 */
895void drm_send_vblank_event(struct drm_device *dev, int crtc,
896 struct drm_pending_vblank_event *e)
897{
898 struct timeval now;
899 unsigned int seq;
900 if (crtc >= 0) {
901 seq = drm_vblank_count_and_time(dev, crtc, &now);
902 } else {
903 seq = 0;
c61eef72
ID
904
905 now = get_drm_timestamp();
c6eefa17 906 }
21a245d2 907 e->pipe = crtc;
c6eefa17
RC
908 send_vblank_event(dev, e, seq, &now);
909}
910EXPORT_SYMBOL(drm_send_vblank_event);
911
f2752282
VS
912/**
913 * drm_vblank_enable - enable the vblank interrupt on a CRTC
914 * @dev: DRM device
915 * @crtc: CRTC in question
916 */
917static int drm_vblank_enable(struct drm_device *dev, int crtc)
918{
8a51d5be 919 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
f2752282
VS
920 int ret = 0;
921
922 assert_spin_locked(&dev->vbl_lock);
923
924 spin_lock(&dev->vblank_time_lock);
925
8a51d5be 926 if (!vblank->enabled) {
1cfb80b1
DV
927 /*
928 * Enable vblank irqs under vblank_time_lock protection.
f2752282
VS
929 * All vblank count & timestamp updates are held off
930 * until we are done reinitializing master counter and
931 * timestamps. Filtercode in drm_handle_vblank() will
932 * prevent double-accounting of same vblank interval.
933 */
934 ret = dev->driver->enable_vblank(dev, crtc);
935 DRM_DEBUG("enabling vblank on crtc %d, ret: %d\n", crtc, ret);
936 if (ret)
8a51d5be 937 atomic_dec(&vblank->refcount);
f2752282 938 else {
8a51d5be 939 vblank->enabled = true;
f2752282
VS
940 drm_update_vblank_count(dev, crtc);
941 }
942 }
943
944 spin_unlock(&dev->vblank_time_lock);
945
946 return ret;
947}
948
0a3e67a4
JB
949/**
950 * drm_vblank_get - get a reference count on vblank events
951 * @dev: DRM device
952 * @crtc: which CRTC to own
953 *
954 * Acquire a reference count on vblank events to avoid having them disabled
955 * while in use.
956 *
89dd6a4b
DV
957 * This is the legacy version of drm_crtc_vblank_get().
958 *
f5752b38 959 * Returns:
0a3e67a4
JB
960 * Zero on success, nonzero on failure.
961 */
962int drm_vblank_get(struct drm_device *dev, int crtc)
963{
8a51d5be 964 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
97cbc883 965 unsigned long irqflags;
0a3e67a4
JB
966 int ret = 0;
967
968 spin_lock_irqsave(&dev->vbl_lock, irqflags);
969 /* Going from 0->1 means we have to enable interrupts again */
8a51d5be 970 if (atomic_add_return(1, &vblank->refcount) == 1) {
f2752282 971 ret = drm_vblank_enable(dev, crtc);
778c9026 972 } else {
8a51d5be
VS
973 if (!vblank->enabled) {
974 atomic_dec(&vblank->refcount);
778c9026 975 ret = -EINVAL;
0a3e67a4
JB
976 }
977 }
978 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
979
980 return ret;
981}
982EXPORT_SYMBOL(drm_vblank_get);
983
89dd6a4b
DV
984/**
985 * drm_crtc_vblank_get - get a reference count on vblank events
986 * @crtc: which CRTC to own
987 *
988 * Acquire a reference count on vblank events to avoid having them disabled
989 * while in use.
990 *
991 * This is the native kms version of drm_vblank_off().
992 *
993 * Returns:
994 * Zero on success, nonzero on failure.
995 */
996int drm_crtc_vblank_get(struct drm_crtc *crtc)
997{
998 return drm_vblank_get(crtc->dev, drm_crtc_index(crtc));
999}
1000EXPORT_SYMBOL(drm_crtc_vblank_get);
1001
0a3e67a4
JB
1002/**
1003 * drm_vblank_put - give up ownership of vblank events
1004 * @dev: DRM device
1005 * @crtc: which counter to give up
1006 *
1007 * Release ownership of a given vblank counter, turning off interrupts
27641c3f 1008 * if possible. Disable interrupts after drm_vblank_offdelay milliseconds.
89dd6a4b
DV
1009 *
1010 * This is the legacy version of drm_crtc_vblank_put().
0a3e67a4
JB
1011 */
1012void drm_vblank_put(struct drm_device *dev, int crtc)
1013{
8a51d5be
VS
1014 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
1015
1016 BUG_ON(atomic_read(&vblank->refcount) == 0);
b3f5e732 1017
0a3e67a4 1018 /* Last user schedules interrupt disable */
4ed0ce3d 1019 if (atomic_dec_and_test(&vblank->refcount)) {
ab8905f1
DV
1020 if (drm_vblank_offdelay == 0)
1021 return;
1022 else if (dev->vblank_disable_immediate || drm_vblank_offdelay < 0)
4ed0ce3d 1023 vblank_disable_fn((unsigned long)vblank);
ab8905f1 1024 else
4ed0ce3d
VS
1025 mod_timer(&vblank->disable_timer,
1026 jiffies + ((drm_vblank_offdelay * HZ)/1000));
1027 }
0a3e67a4
JB
1028}
1029EXPORT_SYMBOL(drm_vblank_put);
1030
89dd6a4b
DV
1031/**
1032 * drm_crtc_vblank_put - give up ownership of vblank events
1033 * @crtc: which counter to give up
1034 *
1035 * Release ownership of a given vblank counter, turning off interrupts
1036 * if possible. Disable interrupts after drm_vblank_offdelay milliseconds.
1037 *
1038 * This is the native kms version of drm_vblank_put().
1039 */
1040void drm_crtc_vblank_put(struct drm_crtc *crtc)
1041{
1042 drm_vblank_put(crtc->dev, drm_crtc_index(crtc));
1043}
1044EXPORT_SYMBOL(drm_crtc_vblank_put);
1045
c6eefa17
RC
1046/**
1047 * drm_vblank_off - disable vblank events on a CRTC
1048 * @dev: DRM device
1049 * @crtc: CRTC in question
1050 *
f5752b38
DV
1051 * Drivers can use this function to shut down the vblank interrupt handling when
1052 * disabling a crtc. This function ensures that the latest vblank frame count is
1053 * stored so that drm_vblank_on() can restore it again.
1054 *
1055 * Drivers must use this function when the hardware vblank counter can get
1056 * reset, e.g. when suspending.
89dd6a4b
DV
1057 *
1058 * This is the legacy version of drm_crtc_vblank_off().
c6eefa17 1059 */
778c9026
LP
1060void drm_vblank_off(struct drm_device *dev, int crtc)
1061{
8a51d5be 1062 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
498548ec
CJHR
1063 struct drm_pending_vblank_event *e, *t;
1064 struct timeval now;
778c9026 1065 unsigned long irqflags;
498548ec 1066 unsigned int seq;
778c9026 1067
56cc279b
VS
1068 spin_lock_irqsave(&dev->event_lock, irqflags);
1069
1070 spin_lock(&dev->vbl_lock);
27641c3f 1071 vblank_disable_and_save(dev, crtc);
8a51d5be 1072 wake_up(&vblank->queue);
498548ec 1073
56cc279b
VS
1074 /*
1075 * Prevent subsequent drm_vblank_get() from re-enabling
1076 * the vblank interrupt by bumping the refcount.
1077 */
1078 if (!vblank->inmodeset) {
1079 atomic_inc(&vblank->refcount);
1080 vblank->inmodeset = 1;
1081 }
1082 spin_unlock(&dev->vbl_lock);
1083
498548ec
CJHR
1084 /* Send any queued vblank events, lest the natives grow disquiet */
1085 seq = drm_vblank_count_and_time(dev, crtc, &now);
e7783ba3 1086
498548ec
CJHR
1087 list_for_each_entry_safe(e, t, &dev->vblank_event_list, base.link) {
1088 if (e->pipe != crtc)
1089 continue;
1090 DRM_DEBUG("Sending premature vblank event on disable: \
1091 wanted %d, current %d\n",
1092 e->event.sequence, seq);
c6eefa17 1093 list_del(&e->base.link);
498548ec 1094 drm_vblank_put(dev, e->pipe);
c6eefa17 1095 send_vblank_event(dev, e, seq, &now);
498548ec 1096 }
56cc279b 1097 spin_unlock_irqrestore(&dev->event_lock, irqflags);
778c9026
LP
1098}
1099EXPORT_SYMBOL(drm_vblank_off);
1100
89dd6a4b
DV
1101/**
1102 * drm_crtc_vblank_off - disable vblank events on a CRTC
1103 * @crtc: CRTC in question
1104 *
1105 * Drivers can use this function to shut down the vblank interrupt handling when
1106 * disabling a crtc. This function ensures that the latest vblank frame count is
1107 * stored so that drm_vblank_on can restore it again.
1108 *
1109 * Drivers must use this function when the hardware vblank counter can get
1110 * reset, e.g. when suspending.
1111 *
1112 * This is the native kms version of drm_vblank_off().
1113 */
1114void drm_crtc_vblank_off(struct drm_crtc *crtc)
1115{
1116 drm_vblank_off(crtc->dev, drm_crtc_index(crtc));
1117}
1118EXPORT_SYMBOL(drm_crtc_vblank_off);
1119
f2752282
VS
1120/**
1121 * drm_vblank_on - enable vblank events on a CRTC
1122 * @dev: DRM device
1123 * @crtc: CRTC in question
f5752b38
DV
1124 *
1125 * This functions restores the vblank interrupt state captured with
1126 * drm_vblank_off() again. Note that calls to drm_vblank_on() and
1127 * drm_vblank_off() can be unbalanced and so can also be unconditionaly called
1128 * in driver load code to reflect the current hardware state of the crtc.
89dd6a4b
DV
1129 *
1130 * This is the legacy version of drm_crtc_vblank_on().
f2752282
VS
1131 */
1132void drm_vblank_on(struct drm_device *dev, int crtc)
1133{
8a51d5be 1134 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
f2752282
VS
1135 unsigned long irqflags;
1136
1137 spin_lock_irqsave(&dev->vbl_lock, irqflags);
7ffd7a68 1138 /* Drop our private "prevent drm_vblank_get" refcount */
8a51d5be
VS
1139 if (vblank->inmodeset) {
1140 atomic_dec(&vblank->refcount);
1141 vblank->inmodeset = 0;
7ffd7a68 1142 }
f8ad028c
VS
1143
1144 /*
1145 * sample the current counter to avoid random jumps
1146 * when drm_vblank_enable() applies the diff
1147 *
1148 * -1 to make sure user will never see the same
1149 * vblank counter value before and after a modeset
1150 */
8a51d5be 1151 vblank->last =
f8ad028c
VS
1152 (dev->driver->get_vblank_counter(dev, crtc) - 1) &
1153 dev->max_vblank_count;
cd19e52a
VS
1154 /*
1155 * re-enable interrupts if there are users left, or the
1156 * user wishes vblank interrupts to be enabled all the time.
1157 */
1158 if (atomic_read(&vblank->refcount) != 0 ||
1159 (!dev->vblank_disable_immediate && drm_vblank_offdelay == 0))
f2752282
VS
1160 WARN_ON(drm_vblank_enable(dev, crtc));
1161 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
1162}
1163EXPORT_SYMBOL(drm_vblank_on);
1164
89dd6a4b
DV
1165/**
1166 * drm_crtc_vblank_on - enable vblank events on a CRTC
1167 * @crtc: CRTC in question
1168 *
1169 * This functions restores the vblank interrupt state captured with
1170 * drm_vblank_off() again. Note that calls to drm_vblank_on() and
1171 * drm_vblank_off() can be unbalanced and so can also be unconditionaly called
1172 * in driver load code to reflect the current hardware state of the crtc.
1173 *
1174 * This is the native kms version of drm_vblank_on().
1175 */
1176void drm_crtc_vblank_on(struct drm_crtc *crtc)
1177{
1178 drm_vblank_on(crtc->dev, drm_crtc_index(crtc));
1179}
1180EXPORT_SYMBOL(drm_crtc_vblank_on);
1181
f453ba04
DA
1182/**
1183 * drm_vblank_pre_modeset - account for vblanks across mode sets
1184 * @dev: DRM device
1185 * @crtc: CRTC in question
f453ba04
DA
1186 *
1187 * Account for vblank events across mode setting events, which will likely
1188 * reset the hardware frame counter.
f5752b38
DV
1189 *
1190 * This is done by grabbing a temporary vblank reference to ensure that the
1191 * vblank interrupt keeps running across the modeset sequence. With this the
1192 * software-side vblank frame counting will ensure that there are no jumps or
1193 * discontinuities.
1194 *
1195 * Unfortunately this approach is racy and also doesn't work when the vblank
1196 * interrupt stops running, e.g. across system suspend resume. It is therefore
1197 * highly recommended that drivers use the newer drm_vblank_off() and
1198 * drm_vblank_on() instead. drm_vblank_pre_modeset() only works correctly when
1199 * using "cooked" software vblank frame counters and not relying on any hardware
1200 * counters.
1201 *
1202 * Drivers must call drm_vblank_post_modeset() when re-enabling the same crtc
1203 * again.
f453ba04
DA
1204 */
1205void drm_vblank_pre_modeset(struct drm_device *dev, int crtc)
1206{
8a51d5be
VS
1207 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
1208
b7ea85a4 1209 /* vblank is not initialized (IRQ not installed ?), or has been freed */
e77cef9c
JG
1210 if (!dev->num_crtcs)
1211 return;
f453ba04
DA
1212 /*
1213 * To avoid all the problems that might happen if interrupts
1214 * were enabled/disabled around or between these calls, we just
1215 * have the kernel take a reference on the CRTC (just once though
1216 * to avoid corrupting the count if multiple, mismatch calls occur),
1217 * so that interrupts remain enabled in the interim.
1218 */
8a51d5be
VS
1219 if (!vblank->inmodeset) {
1220 vblank->inmodeset = 0x1;
b3f5e732 1221 if (drm_vblank_get(dev, crtc) == 0)
8a51d5be 1222 vblank->inmodeset |= 0x2;
f453ba04
DA
1223 }
1224}
1225EXPORT_SYMBOL(drm_vblank_pre_modeset);
1226
f5752b38
DV
1227/**
1228 * drm_vblank_post_modeset - undo drm_vblank_pre_modeset changes
1229 * @dev: DRM device
1230 * @crtc: CRTC in question
1231 *
1232 * This function again drops the temporary vblank reference acquired in
1233 * drm_vblank_pre_modeset.
1234 */
f453ba04
DA
1235void drm_vblank_post_modeset(struct drm_device *dev, int crtc)
1236{
8a51d5be 1237 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
f453ba04
DA
1238 unsigned long irqflags;
1239
b7ea85a4
HC
1240 /* vblank is not initialized (IRQ not installed ?), or has been freed */
1241 if (!dev->num_crtcs)
1242 return;
1243
8a51d5be 1244 if (vblank->inmodeset) {
f453ba04 1245 spin_lock_irqsave(&dev->vbl_lock, irqflags);
ba0bf120 1246 dev->vblank_disable_allowed = true;
f453ba04 1247 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
b3f5e732 1248
8a51d5be 1249 if (vblank->inmodeset & 0x2)
b3f5e732
CW
1250 drm_vblank_put(dev, crtc);
1251
8a51d5be 1252 vblank->inmodeset = 0;
f453ba04
DA
1253 }
1254}
1255EXPORT_SYMBOL(drm_vblank_post_modeset);
1256
f5752b38 1257/*
0a3e67a4
JB
1258 * drm_modeset_ctl - handle vblank event counter changes across mode switch
1259 * @DRM_IOCTL_ARGS: standard ioctl arguments
1260 *
1261 * Applications should call the %_DRM_PRE_MODESET and %_DRM_POST_MODESET
1262 * ioctls around modesetting so that any lost vblank events are accounted for.
1263 *
1264 * Generally the counter will reset across mode sets. If interrupts are
1265 * enabled around this call, we don't have to do anything since the counter
1266 * will have already been incremented.
1267 */
1268int drm_modeset_ctl(struct drm_device *dev, void *data,
1269 struct drm_file *file_priv)
1270{
1271 struct drm_modeset_ctl *modeset = data;
19227561 1272 unsigned int crtc;
0a3e67a4
JB
1273
1274 /* If drm_vblank_init() hasn't been called yet, just no-op */
1275 if (!dev->num_crtcs)
4a1b0714 1276 return 0;
0a3e67a4 1277
29935554
LP
1278 /* KMS drivers handle this internally */
1279 if (drm_core_check_feature(dev, DRIVER_MODESET))
1280 return 0;
1281
0a3e67a4 1282 crtc = modeset->crtc;
4a1b0714
LP
1283 if (crtc >= dev->num_crtcs)
1284 return -EINVAL;
0a3e67a4 1285
0a3e67a4
JB
1286 switch (modeset->cmd) {
1287 case _DRM_PRE_MODESET:
f453ba04 1288 drm_vblank_pre_modeset(dev, crtc);
0a3e67a4
JB
1289 break;
1290 case _DRM_POST_MODESET:
f453ba04 1291 drm_vblank_post_modeset(dev, crtc);
0a3e67a4
JB
1292 break;
1293 default:
4a1b0714 1294 return -EINVAL;
0a3e67a4
JB
1295 }
1296
4a1b0714 1297 return 0;
0a3e67a4
JB
1298}
1299
c9a9c5e0
KH
1300static int drm_queue_vblank_event(struct drm_device *dev, int pipe,
1301 union drm_wait_vblank *vblwait,
1302 struct drm_file *file_priv)
1303{
ffe7c73a 1304 struct drm_vblank_crtc *vblank = &dev->vblank[pipe];
c9a9c5e0
KH
1305 struct drm_pending_vblank_event *e;
1306 struct timeval now;
1307 unsigned long flags;
1308 unsigned int seq;
ea5d552c 1309 int ret;
c9a9c5e0
KH
1310
1311 e = kzalloc(sizeof *e, GFP_KERNEL);
ea5d552c
CW
1312 if (e == NULL) {
1313 ret = -ENOMEM;
1314 goto err_put;
1315 }
c9a9c5e0
KH
1316
1317 e->pipe = pipe;
b9c2c9ae 1318 e->base.pid = current->pid;
c9a9c5e0
KH
1319 e->event.base.type = DRM_EVENT_VBLANK;
1320 e->event.base.length = sizeof e->event;
1321 e->event.user_data = vblwait->request.signal;
1322 e->base.event = &e->event.base;
1323 e->base.file_priv = file_priv;
1324 e->base.destroy = (void (*) (struct drm_pending_event *)) kfree;
1325
c9a9c5e0
KH
1326 spin_lock_irqsave(&dev->event_lock, flags);
1327
ffe7c73a
VS
1328 /*
1329 * drm_vblank_off() might have been called after we called
1330 * drm_vblank_get(). drm_vblank_off() holds event_lock
1331 * around the vblank disable, so no need for further locking.
1332 * The reference from drm_vblank_get() protects against
1333 * vblank disable from another source.
1334 */
1335 if (!vblank->enabled) {
1336 ret = -EINVAL;
1337 goto err_unlock;
1338 }
1339
c9a9c5e0 1340 if (file_priv->event_space < sizeof e->event) {
ea5d552c
CW
1341 ret = -EBUSY;
1342 goto err_unlock;
c9a9c5e0
KH
1343 }
1344
1345 file_priv->event_space -= sizeof e->event;
27641c3f
MK
1346 seq = drm_vblank_count_and_time(dev, pipe, &now);
1347
c9a9c5e0
KH
1348 if ((vblwait->request.type & _DRM_VBLANK_NEXTONMISS) &&
1349 (seq - vblwait->request.sequence) <= (1 << 23)) {
1350 vblwait->request.sequence = seq + 1;
4a921645 1351 vblwait->reply.sequence = vblwait->request.sequence;
c9a9c5e0
KH
1352 }
1353
1354 DRM_DEBUG("event on vblank count %d, current %d, crtc %d\n",
1355 vblwait->request.sequence, seq, pipe);
1356
b9c2c9ae
JB
1357 trace_drm_vblank_event_queued(current->pid, pipe,
1358 vblwait->request.sequence);
1359
c9a9c5e0
KH
1360 e->event.sequence = vblwait->request.sequence;
1361 if ((seq - vblwait->request.sequence) <= (1 << 23)) {
6f331623 1362 drm_vblank_put(dev, pipe);
c6eefa17 1363 send_vblank_event(dev, e, seq, &now);
000fa7cf 1364 vblwait->reply.sequence = seq;
c9a9c5e0 1365 } else {
a6778e9e 1366 /* drm_handle_vblank_events will call drm_vblank_put */
c9a9c5e0 1367 list_add_tail(&e->base.link, &dev->vblank_event_list);
000fa7cf 1368 vblwait->reply.sequence = vblwait->request.sequence;
c9a9c5e0
KH
1369 }
1370
1371 spin_unlock_irqrestore(&dev->event_lock, flags);
1372
1373 return 0;
ea5d552c
CW
1374
1375err_unlock:
1376 spin_unlock_irqrestore(&dev->event_lock, flags);
1377 kfree(e);
1378err_put:
6f331623 1379 drm_vblank_put(dev, pipe);
ea5d552c 1380 return ret;
c9a9c5e0
KH
1381}
1382
f5752b38 1383/*
1da177e4
LT
1384 * Wait for VBLANK.
1385 *
1386 * \param inode device inode.
6c340eac 1387 * \param file_priv DRM file private.
1da177e4
LT
1388 * \param cmd command.
1389 * \param data user argument, pointing to a drm_wait_vblank structure.
1390 * \return zero on success or a negative number on failure.
1391 *
30b23634
EA
1392 * This function enables the vblank interrupt on the pipe requested, then
1393 * sleeps waiting for the requested sequence number to occur, and drops
f5752b38 1394 * the vblank interrupt refcount afterwards. (vblank IRQ disable follows that
30b23634 1395 * after a timeout with no further vblank waits scheduled).
1da177e4 1396 */
0a3e67a4
JB
1397int drm_wait_vblank(struct drm_device *dev, void *data,
1398 struct drm_file *file_priv)
1da177e4 1399{
8a51d5be 1400 struct drm_vblank_crtc *vblank;
c153f45f 1401 union drm_wait_vblank *vblwait = data;
4a1b0714 1402 int ret;
19b01b5f 1403 unsigned int flags, seq, crtc, high_crtc;
1da177e4 1404
4984979b
DV
1405 if (!dev->irq_enabled)
1406 return -EINVAL;
1da177e4 1407
30b23634
EA
1408 if (vblwait->request.type & _DRM_VBLANK_SIGNAL)
1409 return -EINVAL;
1410
c153f45f 1411 if (vblwait->request.type &
19b01b5f
IH
1412 ~(_DRM_VBLANK_TYPES_MASK | _DRM_VBLANK_FLAGS_MASK |
1413 _DRM_VBLANK_HIGH_CRTC_MASK)) {
776c9443 1414 DRM_ERROR("Unsupported type value 0x%x, supported mask 0x%x\n",
c153f45f 1415 vblwait->request.type,
19b01b5f
IH
1416 (_DRM_VBLANK_TYPES_MASK | _DRM_VBLANK_FLAGS_MASK |
1417 _DRM_VBLANK_HIGH_CRTC_MASK));
776c9443
MCA
1418 return -EINVAL;
1419 }
1420
c153f45f 1421 flags = vblwait->request.type & _DRM_VBLANK_FLAGS_MASK;
19b01b5f
IH
1422 high_crtc = (vblwait->request.type & _DRM_VBLANK_HIGH_CRTC_MASK);
1423 if (high_crtc)
1424 crtc = high_crtc >> _DRM_VBLANK_HIGH_CRTC_SHIFT;
1425 else
1426 crtc = flags & _DRM_VBLANK_SECONDARY ? 1 : 0;
0a3e67a4 1427 if (crtc >= dev->num_crtcs)
776c9443
MCA
1428 return -EINVAL;
1429
8a51d5be
VS
1430 vblank = &dev->vblank[crtc];
1431
0a3e67a4
JB
1432 ret = drm_vblank_get(dev, crtc);
1433 if (ret) {
8d3457ec 1434 DRM_DEBUG("failed to acquire vblank counter, %d\n", ret);
0a3e67a4
JB
1435 return ret;
1436 }
1437 seq = drm_vblank_count(dev, crtc);
776c9443 1438
c153f45f 1439 switch (vblwait->request.type & _DRM_VBLANK_TYPES_MASK) {
1da177e4 1440 case _DRM_VBLANK_RELATIVE:
c153f45f
EA
1441 vblwait->request.sequence += seq;
1442 vblwait->request.type &= ~_DRM_VBLANK_RELATIVE;
1da177e4
LT
1443 case _DRM_VBLANK_ABSOLUTE:
1444 break;
1445 default:
0a3e67a4
JB
1446 ret = -EINVAL;
1447 goto done;
1da177e4
LT
1448 }
1449
a6778e9e
IH
1450 if (flags & _DRM_VBLANK_EVENT) {
1451 /* must hold on to the vblank ref until the event fires
1452 * drm_vblank_put will be called asynchronously
1453 */
c9a9c5e0 1454 return drm_queue_vblank_event(dev, crtc, vblwait, file_priv);
a6778e9e 1455 }
c9a9c5e0 1456
ab285d74 1457 if ((flags & _DRM_VBLANK_NEXTONMISS) &&
c153f45f
EA
1458 (seq - vblwait->request.sequence) <= (1<<23)) {
1459 vblwait->request.sequence = seq + 1;
ab285d74
MCA
1460 }
1461
30b23634
EA
1462 DRM_DEBUG("waiting on vblank count %d, crtc %d\n",
1463 vblwait->request.sequence, crtc);
8a51d5be
VS
1464 vblank->last_wait = vblwait->request.sequence;
1465 DRM_WAIT_ON(ret, vblank->queue, 3 * HZ,
30b23634
EA
1466 (((drm_vblank_count(dev, crtc) -
1467 vblwait->request.sequence) <= (1 << 23)) ||
8a51d5be 1468 !vblank->enabled ||
30b23634 1469 !dev->irq_enabled));
1da177e4 1470
30b23634
EA
1471 if (ret != -EINTR) {
1472 struct timeval now;
1da177e4 1473
27641c3f 1474 vblwait->reply.sequence = drm_vblank_count_and_time(dev, crtc, &now);
30b23634
EA
1475 vblwait->reply.tval_sec = now.tv_sec;
1476 vblwait->reply.tval_usec = now.tv_usec;
27641c3f 1477
30b23634
EA
1478 DRM_DEBUG("returning %d to client\n",
1479 vblwait->reply.sequence);
1da177e4 1480 } else {
30b23634 1481 DRM_DEBUG("vblank wait interrupted by signal\n");
1da177e4
LT
1482 }
1483
0a3e67a4
JB
1484done:
1485 drm_vblank_put(dev, crtc);
1da177e4
LT
1486 return ret;
1487}
1488
ea7f7abc 1489static void drm_handle_vblank_events(struct drm_device *dev, int crtc)
c9a9c5e0
KH
1490{
1491 struct drm_pending_vblank_event *e, *t;
1492 struct timeval now;
c9a9c5e0
KH
1493 unsigned int seq;
1494
56cc279b 1495 assert_spin_locked(&dev->event_lock);
c9a9c5e0 1496
56cc279b 1497 seq = drm_vblank_count_and_time(dev, crtc, &now);
c9a9c5e0
KH
1498
1499 list_for_each_entry_safe(e, t, &dev->vblank_event_list, base.link) {
1500 if (e->pipe != crtc)
1501 continue;
1502 if ((seq - e->event.sequence) > (1<<23))
1503 continue;
1504
1505 DRM_DEBUG("vblank event on %d, current %d\n",
1506 e->event.sequence, seq);
1507
c6eefa17 1508 list_del(&e->base.link);
c9a9c5e0 1509 drm_vblank_put(dev, e->pipe);
c6eefa17 1510 send_vblank_event(dev, e, seq, &now);
c9a9c5e0
KH
1511 }
1512
ac2874b9 1513 trace_drm_vblank_event(crtc, seq);
c9a9c5e0
KH
1514}
1515
0a3e67a4
JB
1516/**
1517 * drm_handle_vblank - handle a vblank event
1518 * @dev: DRM device
1519 * @crtc: where this event occurred
1520 *
1521 * Drivers should call this routine in their vblank interrupt handlers to
1522 * update the vblank counter and send any signals that may be pending.
1523 */
78c6e170 1524bool drm_handle_vblank(struct drm_device *dev, int crtc)
0a3e67a4 1525{
8a51d5be 1526 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
27641c3f
MK
1527 u32 vblcount;
1528 s64 diff_ns;
1529 struct timeval tvblank;
1530 unsigned long irqflags;
1531
c9a9c5e0 1532 if (!dev->num_crtcs)
78c6e170 1533 return false;
c9a9c5e0 1534
56cc279b
VS
1535 spin_lock_irqsave(&dev->event_lock, irqflags);
1536
27641c3f
MK
1537 /* Need timestamp lock to prevent concurrent execution with
1538 * vblank enable/disable, as this would cause inconsistent
1539 * or corrupted timestamps and vblank counts.
1540 */
56cc279b 1541 spin_lock(&dev->vblank_time_lock);
27641c3f
MK
1542
1543 /* Vblank irq handling disabled. Nothing to do. */
8a51d5be 1544 if (!vblank->enabled) {
56cc279b
VS
1545 spin_unlock(&dev->vblank_time_lock);
1546 spin_unlock_irqrestore(&dev->event_lock, irqflags);
78c6e170 1547 return false;
27641c3f
MK
1548 }
1549
1550 /* Fetch corresponding timestamp for this vblank interval from
1551 * driver and store it in proper slot of timestamp ringbuffer.
1552 */
1553
1554 /* Get current timestamp and count. */
8a51d5be 1555 vblcount = atomic_read(&vblank->count);
27641c3f
MK
1556 drm_get_last_vbltimestamp(dev, crtc, &tvblank, DRM_CALLED_FROM_VBLIRQ);
1557
1558 /* Compute time difference to timestamp of last vblank */
1559 diff_ns = timeval_to_ns(&tvblank) -
1560 timeval_to_ns(&vblanktimestamp(dev, crtc, vblcount));
1561
1562 /* Update vblank timestamp and count if at least
1563 * DRM_REDUNDANT_VBLIRQ_THRESH_NS nanoseconds
1564 * difference between last stored timestamp and current
1565 * timestamp. A smaller difference means basically
1566 * identical timestamps. Happens if this vblank has
1567 * been already processed and this is a redundant call,
1568 * e.g., due to spurious vblank interrupts. We need to
1569 * ignore those for accounting.
1570 */
c4cc3839 1571 if (abs64(diff_ns) > DRM_REDUNDANT_VBLIRQ_THRESH_NS) {
27641c3f
MK
1572 /* Store new timestamp in ringbuffer. */
1573 vblanktimestamp(dev, crtc, vblcount + 1) = tvblank;
27641c3f
MK
1574
1575 /* Increment cooked vblank count. This also atomically commits
1576 * the timestamp computed above.
1577 */
4e857c58 1578 smp_mb__before_atomic();
8a51d5be 1579 atomic_inc(&vblank->count);
4e857c58 1580 smp_mb__after_atomic();
27641c3f
MK
1581 } else {
1582 DRM_DEBUG("crtc %d: Redundant vblirq ignored. diff_ns = %d\n",
1583 crtc, (int) diff_ns);
1584 }
1585
56cc279b
VS
1586 spin_unlock(&dev->vblank_time_lock);
1587
8a51d5be 1588 wake_up(&vblank->queue);
c9a9c5e0 1589 drm_handle_vblank_events(dev, crtc);
27641c3f 1590
56cc279b
VS
1591 spin_unlock_irqrestore(&dev->event_lock, irqflags);
1592
78c6e170 1593 return true;
0a3e67a4
JB
1594}
1595EXPORT_SYMBOL(drm_handle_vblank);
This page took 0.818045 seconds and 5 git commands to generate.