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