]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/gpu/drm/drm_irq.c
drm: add support for monotonic vblank timestamps
[mirror_ubuntu-bionic-kernel.git] / drivers / gpu / drm / drm_irq.c
CommitLineData
1da177e4 1/**
b5e89ed5 2 * \file drm_irq.c
1da177e4
LT
3 * IRQ support
4 *
5 * \author Rickard E. (Rik) Faith <faith@valinux.com>
6 * \author Gareth Hughes <gareth@valinux.com>
7 */
8
9/*
10 * Created: Fri Mar 19 14:30:16 1999 by faith@valinux.com
11 *
12 * Copyright 1999, 2000 Precision Insight, Inc., Cedar Park, Texas.
13 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
14 * All Rights Reserved.
15 *
16 * Permission is hereby granted, free of charge, to any person obtaining a
17 * copy of this software and associated documentation files (the "Software"),
18 * to deal in the Software without restriction, including without limitation
19 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
20 * and/or sell copies of the Software, and to permit persons to whom the
21 * Software is furnished to do so, subject to the following conditions:
22 *
23 * The above copyright notice and this permission notice (including the next
24 * paragraph) shall be included in all copies or substantial portions of the
25 * Software.
26 *
27 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
28 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
29 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
30 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
31 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
32 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
33 * OTHER DEALINGS IN THE SOFTWARE.
34 */
35
760285e7 36#include <drm/drmP.h>
ac2874b9 37#include "drm_trace.h"
1da177e4
LT
38
39#include <linux/interrupt.h> /* For task queue support */
5a0e3ad6 40#include <linux/slab.h>
1da177e4 41
28d52043 42#include <linux/vgaarb.h>
2d1a8a48 43#include <linux/export.h>
27641c3f
MK
44
45/* Access macro for slots in vblank timestamp ringbuffer. */
46#define vblanktimestamp(dev, crtc, count) ( \
47 (dev)->_vblank_time[(crtc) * DRM_VBLANKTIME_RBSIZE + \
48 ((count) % DRM_VBLANKTIME_RBSIZE)])
49
50/* Retry timestamp calculation up to 3 times to satisfy
51 * drm_timestamp_precision before giving up.
52 */
53#define DRM_TIMESTAMP_MAXRETRIES 3
54
55/* Threshold in nanoseconds for detection of redundant
56 * vblank irq in drm_handle_vblank(). 1 msec should be ok.
57 */
58#define DRM_REDUNDANT_VBLIRQ_THRESH_NS 1000000
59
1da177e4
LT
60/**
61 * Get interrupt from bus id.
b5e89ed5 62 *
1da177e4 63 * \param inode device inode.
6c340eac 64 * \param file_priv DRM file private.
1da177e4
LT
65 * \param cmd command.
66 * \param arg user argument, pointing to a drm_irq_busid structure.
67 * \return zero on success or a negative number on failure.
b5e89ed5 68 *
1da177e4
LT
69 * Finds the PCI device with the specified bus id and gets its IRQ number.
70 * This IOCTL is deprecated, and will now return EINVAL for any busid not equal
71 * to that of the device that this DRM instance attached to.
72 */
c153f45f
EA
73int drm_irq_by_busid(struct drm_device *dev, void *data,
74 struct drm_file *file_priv)
1da177e4 75{
c153f45f 76 struct drm_irq_busid *p = data;
1da177e4 77
8410ea3b 78 if (!dev->driver->bus->irq_by_busid)
dcdb1674
JC
79 return -EINVAL;
80
1da177e4
LT
81 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
82 return -EINVAL;
83
8410ea3b 84 return dev->driver->bus->irq_by_busid(dev, p);
1da177e4
LT
85}
86
27641c3f
MK
87/*
88 * Clear vblank timestamp buffer for a crtc.
89 */
90static void clear_vblank_timestamps(struct drm_device *dev, int crtc)
91{
92 memset(&dev->_vblank_time[crtc * DRM_VBLANKTIME_RBSIZE], 0,
93 DRM_VBLANKTIME_RBSIZE * sizeof(struct timeval));
94}
95
96/*
97 * Disable vblank irq's on crtc, make sure that last vblank count
98 * of hardware and corresponding consistent software vblank counter
99 * are preserved, even if there are any spurious vblank irq's after
100 * disable.
101 */
102static void vblank_disable_and_save(struct drm_device *dev, int crtc)
103{
104 unsigned long irqflags;
105 u32 vblcount;
106 s64 diff_ns;
107 int vblrc;
108 struct timeval tvblank;
109
110 /* Prevent vblank irq processing while disabling vblank irqs,
111 * so no updates of timestamps or count can happen after we've
112 * disabled. Needed to prevent races in case of delayed irq's.
27641c3f 113 */
27641c3f
MK
114 spin_lock_irqsave(&dev->vblank_time_lock, irqflags);
115
116 dev->driver->disable_vblank(dev, crtc);
117 dev->vblank_enabled[crtc] = 0;
118
119 /* No further vblank irq's will be processed after
120 * this point. Get current hardware vblank count and
121 * vblank timestamp, repeat until they are consistent.
122 *
123 * FIXME: There is still a race condition here and in
124 * drm_update_vblank_count() which can cause off-by-one
125 * reinitialization of software vblank counter. If gpu
126 * vblank counter doesn't increment exactly at the leading
127 * edge of a vblank interval, then we can lose 1 count if
128 * we happen to execute between start of vblank and the
129 * delayed gpu counter increment.
130 */
131 do {
132 dev->last_vblank[crtc] = dev->driver->get_vblank_counter(dev, crtc);
133 vblrc = drm_get_last_vbltimestamp(dev, crtc, &tvblank, 0);
134 } while (dev->last_vblank[crtc] != dev->driver->get_vblank_counter(dev, crtc));
135
136 /* Compute time difference to stored timestamp of last vblank
137 * as updated by last invocation of drm_handle_vblank() in vblank irq.
138 */
139 vblcount = atomic_read(&dev->_vblank_count[crtc]);
140 diff_ns = timeval_to_ns(&tvblank) -
141 timeval_to_ns(&vblanktimestamp(dev, crtc, vblcount));
142
143 /* If there is at least 1 msec difference between the last stored
144 * timestamp and tvblank, then we are currently executing our
145 * disable inside a new vblank interval, the tvblank timestamp
146 * corresponds to this new vblank interval and the irq handler
147 * for this vblank didn't run yet and won't run due to our disable.
148 * Therefore we need to do the job of drm_handle_vblank() and
149 * increment the vblank counter by one to account for this vblank.
150 *
151 * Skip this step if there isn't any high precision timestamp
152 * available. In that case we can't account for this and just
153 * hope for the best.
154 */
bc215128 155 if ((vblrc > 0) && (abs64(diff_ns) > 1000000)) {
27641c3f 156 atomic_inc(&dev->_vblank_count[crtc]);
bc215128
MK
157 smp_mb__after_atomic_inc();
158 }
27641c3f
MK
159
160 /* Invalidate all timestamps while vblank irq's are off. */
161 clear_vblank_timestamps(dev, crtc);
162
163 spin_unlock_irqrestore(&dev->vblank_time_lock, irqflags);
27641c3f
MK
164}
165
0a3e67a4
JB
166static void vblank_disable_fn(unsigned long arg)
167{
168 struct drm_device *dev = (struct drm_device *)arg;
169 unsigned long irqflags;
170 int i;
171
172 if (!dev->vblank_disable_allowed)
173 return;
174
175 for (i = 0; i < dev->num_crtcs; i++) {
176 spin_lock_irqsave(&dev->vbl_lock, irqflags);
177 if (atomic_read(&dev->vblank_refcount[i]) == 0 &&
178 dev->vblank_enabled[i]) {
179 DRM_DEBUG("disabling vblank on crtc %d\n", i);
27641c3f 180 vblank_disable_and_save(dev, i);
0a3e67a4
JB
181 }
182 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
183 }
184}
185
52440211 186void drm_vblank_cleanup(struct drm_device *dev)
0a3e67a4
JB
187{
188 /* Bail if the driver didn't call drm_vblank_init() */
189 if (dev->num_crtcs == 0)
190 return;
191
7eb3b2c8 192 del_timer_sync(&dev->vblank_disable_timer);
0a3e67a4
JB
193
194 vblank_disable_fn((unsigned long)dev);
195
9a298b2a
EA
196 kfree(dev->vbl_queue);
197 kfree(dev->_vblank_count);
198 kfree(dev->vblank_refcount);
199 kfree(dev->vblank_enabled);
200 kfree(dev->last_vblank);
201 kfree(dev->last_vblank_wait);
202 kfree(dev->vblank_inmodeset);
27641c3f 203 kfree(dev->_vblank_time);
0a3e67a4
JB
204
205 dev->num_crtcs = 0;
206}
e77cef9c 207EXPORT_SYMBOL(drm_vblank_cleanup);
0a3e67a4
JB
208
209int drm_vblank_init(struct drm_device *dev, int num_crtcs)
210{
211 int i, ret = -ENOMEM;
212
213 setup_timer(&dev->vblank_disable_timer, vblank_disable_fn,
214 (unsigned long)dev);
215 spin_lock_init(&dev->vbl_lock);
27641c3f
MK
216 spin_lock_init(&dev->vblank_time_lock);
217
0a3e67a4
JB
218 dev->num_crtcs = num_crtcs;
219
9a298b2a
EA
220 dev->vbl_queue = kmalloc(sizeof(wait_queue_head_t) * num_crtcs,
221 GFP_KERNEL);
0a3e67a4
JB
222 if (!dev->vbl_queue)
223 goto err;
224
9a298b2a 225 dev->_vblank_count = kmalloc(sizeof(atomic_t) * num_crtcs, GFP_KERNEL);
0a3e67a4
JB
226 if (!dev->_vblank_count)
227 goto err;
228
9a298b2a
EA
229 dev->vblank_refcount = kmalloc(sizeof(atomic_t) * num_crtcs,
230 GFP_KERNEL);
0a3e67a4
JB
231 if (!dev->vblank_refcount)
232 goto err;
233
9a298b2a 234 dev->vblank_enabled = kcalloc(num_crtcs, sizeof(int), GFP_KERNEL);
0a3e67a4
JB
235 if (!dev->vblank_enabled)
236 goto err;
237
9a298b2a 238 dev->last_vblank = kcalloc(num_crtcs, sizeof(u32), GFP_KERNEL);
0a3e67a4
JB
239 if (!dev->last_vblank)
240 goto err;
241
9a298b2a 242 dev->last_vblank_wait = kcalloc(num_crtcs, sizeof(u32), GFP_KERNEL);
fede5c91
EA
243 if (!dev->last_vblank_wait)
244 goto err;
245
9a298b2a 246 dev->vblank_inmodeset = kcalloc(num_crtcs, sizeof(int), GFP_KERNEL);
0a3e67a4
JB
247 if (!dev->vblank_inmodeset)
248 goto err;
249
27641c3f
MK
250 dev->_vblank_time = kcalloc(num_crtcs * DRM_VBLANKTIME_RBSIZE,
251 sizeof(struct timeval), GFP_KERNEL);
252 if (!dev->_vblank_time)
253 goto err;
254
255 DRM_INFO("Supports vblank timestamp caching Rev 1 (10.10.2010).\n");
256
257 /* Driver specific high-precision vblank timestamping supported? */
258 if (dev->driver->get_vblank_timestamp)
259 DRM_INFO("Driver supports precise vblank timestamp query.\n");
260 else
261 DRM_INFO("No driver support for vblank timestamp query.\n");
262
0a3e67a4
JB
263 /* Zero per-crtc vblank stuff */
264 for (i = 0; i < num_crtcs; i++) {
265 init_waitqueue_head(&dev->vbl_queue[i]);
0a3e67a4
JB
266 atomic_set(&dev->_vblank_count[i], 0);
267 atomic_set(&dev->vblank_refcount[i], 0);
268 }
269
270 dev->vblank_disable_allowed = 0;
0a3e67a4
JB
271 return 0;
272
273err:
274 drm_vblank_cleanup(dev);
275 return ret;
276}
277EXPORT_SYMBOL(drm_vblank_init);
278
28d52043
DA
279static void drm_irq_vgaarb_nokms(void *cookie, bool state)
280{
281 struct drm_device *dev = cookie;
282
283 if (dev->driver->vgaarb_irq) {
284 dev->driver->vgaarb_irq(dev, state);
285 return;
286 }
287
288 if (!dev->irq_enabled)
289 return;
290
5037f8ac
JS
291 if (state) {
292 if (dev->driver->irq_uninstall)
293 dev->driver->irq_uninstall(dev);
294 } else {
295 if (dev->driver->irq_preinstall)
296 dev->driver->irq_preinstall(dev);
297 if (dev->driver->irq_postinstall)
298 dev->driver->irq_postinstall(dev);
28d52043
DA
299 }
300}
301
1da177e4
LT
302/**
303 * Install IRQ handler.
304 *
305 * \param dev DRM device.
1da177e4 306 *
0a3e67a4 307 * Initializes the IRQ related data. Installs the handler, calling the driver
884a53ef 308 * \c irq_preinstall() and \c irq_postinstall() functions
1da177e4
LT
309 * before and after the installation.
310 */
0a3e67a4 311int drm_irq_install(struct drm_device *dev)
1da177e4 312{
4a1b0714 313 int ret;
b5e89ed5 314 unsigned long sh_flags = 0;
b8da7de5 315 char *irqname;
1da177e4
LT
316
317 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
318 return -EINVAL;
319
dcdb1674 320 if (drm_dev_to_irq(dev) == 0)
1da177e4
LT
321 return -EINVAL;
322
30e2fb18 323 mutex_lock(&dev->struct_mutex);
1da177e4
LT
324
325 /* Driver must have been initialized */
b5e89ed5 326 if (!dev->dev_private) {
30e2fb18 327 mutex_unlock(&dev->struct_mutex);
1da177e4
LT
328 return -EINVAL;
329 }
330
b5e89ed5 331 if (dev->irq_enabled) {
30e2fb18 332 mutex_unlock(&dev->struct_mutex);
1da177e4
LT
333 return -EBUSY;
334 }
335 dev->irq_enabled = 1;
30e2fb18 336 mutex_unlock(&dev->struct_mutex);
1da177e4 337
dcdb1674 338 DRM_DEBUG("irq=%d\n", drm_dev_to_irq(dev));
1da177e4 339
b5e89ed5 340 /* Before installing handler */
5037f8ac
JS
341 if (dev->driver->irq_preinstall)
342 dev->driver->irq_preinstall(dev);
1da177e4 343
b5e89ed5 344 /* Install handler */
1da177e4 345 if (drm_core_check_feature(dev, DRIVER_IRQ_SHARED))
935f6e3a 346 sh_flags = IRQF_SHARED;
b5e89ed5 347
b8da7de5
DA
348 if (dev->devname)
349 irqname = dev->devname;
350 else
351 irqname = dev->driver->name;
352
9bfbd5cb 353 ret = request_irq(drm_dev_to_irq(dev), dev->driver->irq_handler,
b8da7de5 354 sh_flags, irqname, dev);
9bfbd5cb 355
b5e89ed5 356 if (ret < 0) {
30e2fb18 357 mutex_lock(&dev->struct_mutex);
1da177e4 358 dev->irq_enabled = 0;
30e2fb18 359 mutex_unlock(&dev->struct_mutex);
1da177e4
LT
360 return ret;
361 }
362
28d52043
DA
363 if (!drm_core_check_feature(dev, DRIVER_MODESET))
364 vga_client_register(dev->pdev, (void *)dev, drm_irq_vgaarb_nokms, NULL);
365
b5e89ed5 366 /* After installing handler */
5037f8ac
JS
367 if (dev->driver->irq_postinstall)
368 ret = dev->driver->irq_postinstall(dev);
369
0a3e67a4
JB
370 if (ret < 0) {
371 mutex_lock(&dev->struct_mutex);
372 dev->irq_enabled = 0;
373 mutex_unlock(&dev->struct_mutex);
e1c44acc
JS
374 if (!drm_core_check_feature(dev, DRIVER_MODESET))
375 vga_client_register(dev->pdev, NULL, NULL, NULL);
376 free_irq(drm_dev_to_irq(dev), dev);
0a3e67a4 377 }
1da177e4 378
0a3e67a4 379 return ret;
1da177e4 380}
0a3e67a4 381EXPORT_SYMBOL(drm_irq_install);
1da177e4
LT
382
383/**
384 * Uninstall the IRQ handler.
385 *
386 * \param dev DRM device.
387 *
884a53ef 388 * Calls the driver's \c irq_uninstall() function, and stops the irq.
1da177e4 389 */
27641c3f 390int drm_irq_uninstall(struct drm_device *dev)
1da177e4 391{
dc1336ff
JB
392 unsigned long irqflags;
393 int irq_enabled, i;
1da177e4
LT
394
395 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
396 return -EINVAL;
397
30e2fb18 398 mutex_lock(&dev->struct_mutex);
1da177e4
LT
399 irq_enabled = dev->irq_enabled;
400 dev->irq_enabled = 0;
30e2fb18 401 mutex_unlock(&dev->struct_mutex);
1da177e4 402
dc1336ff
JB
403 /*
404 * Wake up any waiters so they don't hang.
405 */
bde4889a
BS
406 if (dev->num_crtcs) {
407 spin_lock_irqsave(&dev->vbl_lock, irqflags);
408 for (i = 0; i < dev->num_crtcs; i++) {
409 DRM_WAKEUP(&dev->vbl_queue[i]);
410 dev->vblank_enabled[i] = 0;
411 dev->last_vblank[i] =
412 dev->driver->get_vblank_counter(dev, i);
413 }
414 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
dc1336ff 415 }
dc1336ff 416
b5e89ed5 417 if (!irq_enabled)
1da177e4
LT
418 return -EINVAL;
419
dcdb1674 420 DRM_DEBUG("irq=%d\n", drm_dev_to_irq(dev));
1da177e4 421
28d52043
DA
422 if (!drm_core_check_feature(dev, DRIVER_MODESET))
423 vga_client_register(dev->pdev, NULL, NULL, NULL);
424
5037f8ac
JS
425 if (dev->driver->irq_uninstall)
426 dev->driver->irq_uninstall(dev);
1da177e4 427
dcdb1674 428 free_irq(drm_dev_to_irq(dev), dev);
1da177e4
LT
429
430 return 0;
431}
432EXPORT_SYMBOL(drm_irq_uninstall);
433
434/**
435 * IRQ control ioctl.
436 *
437 * \param inode device inode.
6c340eac 438 * \param file_priv DRM file private.
1da177e4
LT
439 * \param cmd command.
440 * \param arg user argument, pointing to a drm_control structure.
441 * \return zero on success or a negative number on failure.
442 *
443 * Calls irq_install() or irq_uninstall() according to \p arg.
444 */
c153f45f
EA
445int drm_control(struct drm_device *dev, void *data,
446 struct drm_file *file_priv)
1da177e4 447{
c153f45f 448 struct drm_control *ctl = data;
b5e89ed5 449
27641c3f
MK
450 /* if we haven't irq we fallback for compatibility reasons -
451 * this used to be a separate function in drm_dma.h
452 */
1da177e4 453
1da177e4 454
c153f45f 455 switch (ctl->func) {
1da177e4
LT
456 case DRM_INST_HANDLER:
457 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
458 return 0;
f453ba04
DA
459 if (drm_core_check_feature(dev, DRIVER_MODESET))
460 return 0;
1da177e4 461 if (dev->if_version < DRM_IF_VERSION(1, 2) &&
dcdb1674 462 ctl->irq != drm_dev_to_irq(dev))
1da177e4 463 return -EINVAL;
b5e89ed5 464 return drm_irq_install(dev);
1da177e4
LT
465 case DRM_UNINST_HANDLER:
466 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
467 return 0;
f453ba04
DA
468 if (drm_core_check_feature(dev, DRIVER_MODESET))
469 return 0;
b5e89ed5 470 return drm_irq_uninstall(dev);
1da177e4
LT
471 default:
472 return -EINVAL;
473 }
474}
475
27641c3f
MK
476/**
477 * drm_calc_timestamping_constants - Calculate and
478 * store various constants which are later needed by
479 * vblank and swap-completion timestamping, e.g, by
480 * drm_calc_vbltimestamp_from_scanoutpos().
481 * They are derived from crtc's true scanout timing,
482 * so they take things like panel scaling or other
483 * adjustments into account.
484 *
485 * @crtc drm_crtc whose timestamp constants should be updated.
486 *
487 */
488void drm_calc_timestamping_constants(struct drm_crtc *crtc)
489{
490 s64 linedur_ns = 0, pixeldur_ns = 0, framedur_ns = 0;
491 u64 dotclock;
492
493 /* Dot clock in Hz: */
494 dotclock = (u64) crtc->hwmode.clock * 1000;
495
9be6f8a9
MK
496 /* Fields of interlaced scanout modes are only halve a frame duration.
497 * Double the dotclock to get halve the frame-/line-/pixelduration.
498 */
499 if (crtc->hwmode.flags & DRM_MODE_FLAG_INTERLACE)
500 dotclock *= 2;
501
27641c3f
MK
502 /* Valid dotclock? */
503 if (dotclock > 0) {
504 /* Convert scanline length in pixels and video dot clock to
505 * line duration, frame duration and pixel duration in
506 * nanoseconds:
507 */
508 pixeldur_ns = (s64) div64_u64(1000000000, dotclock);
509 linedur_ns = (s64) div64_u64(((u64) crtc->hwmode.crtc_htotal *
510 1000000000), dotclock);
511 framedur_ns = (s64) crtc->hwmode.crtc_vtotal * linedur_ns;
512 } else
513 DRM_ERROR("crtc %d: Can't calculate constants, dotclock = 0!\n",
514 crtc->base.id);
515
516 crtc->pixeldur_ns = pixeldur_ns;
517 crtc->linedur_ns = linedur_ns;
518 crtc->framedur_ns = framedur_ns;
519
520 DRM_DEBUG("crtc %d: hwmode: htotal %d, vtotal %d, vdisplay %d\n",
521 crtc->base.id, crtc->hwmode.crtc_htotal,
522 crtc->hwmode.crtc_vtotal, crtc->hwmode.crtc_vdisplay);
523 DRM_DEBUG("crtc %d: clock %d kHz framedur %d linedur %d, pixeldur %d\n",
524 crtc->base.id, (int) dotclock/1000, (int) framedur_ns,
525 (int) linedur_ns, (int) pixeldur_ns);
526}
527EXPORT_SYMBOL(drm_calc_timestamping_constants);
528
529/**
530 * drm_calc_vbltimestamp_from_scanoutpos - helper routine for kms
531 * drivers. Implements calculation of exact vblank timestamps from
532 * given drm_display_mode timings and current video scanout position
533 * of a crtc. This can be called from within get_vblank_timestamp()
534 * implementation of a kms driver to implement the actual timestamping.
535 *
536 * Should return timestamps conforming to the OML_sync_control OpenML
537 * extension specification. The timestamp corresponds to the end of
538 * the vblank interval, aka start of scanout of topmost-leftmost display
539 * pixel in the following video frame.
540 *
541 * Requires support for optional dev->driver->get_scanout_position()
542 * in kms driver, plus a bit of setup code to provide a drm_display_mode
543 * that corresponds to the true scanout timing.
544 *
545 * The current implementation only handles standard video modes. It
546 * returns as no operation if a doublescan or interlaced video mode is
547 * active. Higher level code is expected to handle this.
548 *
549 * @dev: DRM device.
550 * @crtc: Which crtc's vblank timestamp to retrieve.
551 * @max_error: Desired maximum allowable error in timestamps (nanosecs).
552 * On return contains true maximum error of timestamp.
553 * @vblank_time: Pointer to struct timeval which should receive the timestamp.
554 * @flags: Flags to pass to driver:
555 * 0 = Default.
556 * DRM_CALLED_FROM_VBLIRQ = If function is called from vbl irq handler.
557 * @refcrtc: drm_crtc* of crtc which defines scanout timing.
558 *
559 * Returns negative value on error, failure or if not supported in current
560 * video mode:
561 *
562 * -EINVAL - Invalid crtc.
563 * -EAGAIN - Temporary unavailable, e.g., called before initial modeset.
564 * -ENOTSUPP - Function not supported in current display mode.
565 * -EIO - Failed, e.g., due to failed scanout position query.
566 *
567 * Returns or'ed positive status flags on success:
568 *
569 * DRM_VBLANKTIME_SCANOUTPOS_METHOD - Signal this method used for timestamping.
570 * DRM_VBLANKTIME_INVBL - Timestamp taken while scanout was in vblank interval.
571 *
572 */
573int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev, int crtc,
574 int *max_error,
575 struct timeval *vblank_time,
576 unsigned flags,
577 struct drm_crtc *refcrtc)
578{
e62f2f5a
ID
579 ktime_t stime, etime, mono_time_offset;
580 struct timeval tv_etime;
27641c3f
MK
581 struct drm_display_mode *mode;
582 int vbl_status, vtotal, vdisplay;
583 int vpos, hpos, i;
584 s64 framedur_ns, linedur_ns, pixeldur_ns, delta_ns, duration_ns;
585 bool invbl;
586
587 if (crtc < 0 || crtc >= dev->num_crtcs) {
588 DRM_ERROR("Invalid crtc %d\n", crtc);
589 return -EINVAL;
590 }
591
592 /* Scanout position query not supported? Should not happen. */
593 if (!dev->driver->get_scanout_position) {
594 DRM_ERROR("Called from driver w/o get_scanout_position()!?\n");
595 return -EIO;
596 }
597
598 mode = &refcrtc->hwmode;
599 vtotal = mode->crtc_vtotal;
600 vdisplay = mode->crtc_vdisplay;
601
602 /* Durations of frames, lines, pixels in nanoseconds. */
603 framedur_ns = refcrtc->framedur_ns;
604 linedur_ns = refcrtc->linedur_ns;
605 pixeldur_ns = refcrtc->pixeldur_ns;
606
607 /* If mode timing undefined, just return as no-op:
608 * Happens during initial modesetting of a crtc.
609 */
610 if (vtotal <= 0 || vdisplay <= 0 || framedur_ns == 0) {
611 DRM_DEBUG("crtc %d: Noop due to uninitialized mode.\n", crtc);
612 return -EAGAIN;
613 }
614
27641c3f
MK
615 /* Get current scanout position with system timestamp.
616 * Repeat query up to DRM_TIMESTAMP_MAXRETRIES times
617 * if single query takes longer than max_error nanoseconds.
618 *
619 * This guarantees a tight bound on maximum error if
620 * code gets preempted or delayed for some reason.
621 */
622 for (i = 0; i < DRM_TIMESTAMP_MAXRETRIES; i++) {
623 /* Disable preemption to make it very likely to
624 * succeed in the first iteration even on PREEMPT_RT kernel.
625 */
626 preempt_disable();
627
628 /* Get system timestamp before query. */
e62f2f5a 629 stime = ktime_get();
27641c3f
MK
630
631 /* Get vertical and horizontal scanout pos. vpos, hpos. */
632 vbl_status = dev->driver->get_scanout_position(dev, crtc, &vpos, &hpos);
633
634 /* Get system timestamp after query. */
e62f2f5a 635 etime = ktime_get();
c61eef72
ID
636 if (!drm_timestamp_monotonic)
637 mono_time_offset = ktime_get_monotonic_offset();
27641c3f
MK
638
639 preempt_enable();
640
641 /* Return as no-op if scanout query unsupported or failed. */
642 if (!(vbl_status & DRM_SCANOUTPOS_VALID)) {
643 DRM_DEBUG("crtc %d : scanoutpos query failed [%d].\n",
644 crtc, vbl_status);
645 return -EIO;
646 }
647
e62f2f5a 648 duration_ns = ktime_to_ns(etime) - ktime_to_ns(stime);
27641c3f
MK
649
650 /* Accept result with < max_error nsecs timing uncertainty. */
651 if (duration_ns <= (s64) *max_error)
652 break;
653 }
654
655 /* Noisy system timing? */
656 if (i == DRM_TIMESTAMP_MAXRETRIES) {
657 DRM_DEBUG("crtc %d: Noisy timestamp %d us > %d us [%d reps].\n",
658 crtc, (int) duration_ns/1000, *max_error/1000, i);
659 }
660
661 /* Return upper bound of timestamp precision error. */
662 *max_error = (int) duration_ns;
663
664 /* Check if in vblank area:
665 * vpos is >=0 in video scanout area, but negative
666 * within vblank area, counting down the number of lines until
667 * start of scanout.
668 */
669 invbl = vbl_status & DRM_SCANOUTPOS_INVBL;
670
671 /* Convert scanout position into elapsed time at raw_time query
672 * since start of scanout at first display scanline. delta_ns
673 * can be negative if start of scanout hasn't happened yet.
674 */
675 delta_ns = (s64) vpos * linedur_ns + (s64) hpos * pixeldur_ns;
676
677 /* Is vpos outside nominal vblank area, but less than
678 * 1/100 of a frame height away from start of vblank?
679 * If so, assume this isn't a massively delayed vblank
680 * interrupt, but a vblank interrupt that fired a few
681 * microseconds before true start of vblank. Compensate
682 * by adding a full frame duration to the final timestamp.
683 * Happens, e.g., on ATI R500, R600.
684 *
685 * We only do this if DRM_CALLED_FROM_VBLIRQ.
686 */
687 if ((flags & DRM_CALLED_FROM_VBLIRQ) && !invbl &&
688 ((vdisplay - vpos) < vtotal / 100)) {
689 delta_ns = delta_ns - framedur_ns;
690
691 /* Signal this correction as "applied". */
692 vbl_status |= 0x8;
693 }
694
c61eef72
ID
695 if (!drm_timestamp_monotonic)
696 etime = ktime_sub(etime, mono_time_offset);
697
e62f2f5a
ID
698 /* save this only for debugging purposes */
699 tv_etime = ktime_to_timeval(etime);
27641c3f
MK
700 /* Subtract time delta from raw timestamp to get final
701 * vblank_time timestamp for end of vblank.
702 */
e62f2f5a
ID
703 etime = ktime_sub_ns(etime, delta_ns);
704 *vblank_time = ktime_to_timeval(etime);
27641c3f 705
bbb0aef5
JP
706 DRM_DEBUG("crtc %d : v %d p(%d,%d)@ %ld.%ld -> %ld.%ld [e %d us, %d rep]\n",
707 crtc, (int)vbl_status, hpos, vpos,
e62f2f5a 708 (long)tv_etime.tv_sec, (long)tv_etime.tv_usec,
bbb0aef5
JP
709 (long)vblank_time->tv_sec, (long)vblank_time->tv_usec,
710 (int)duration_ns/1000, i);
27641c3f
MK
711
712 vbl_status = DRM_VBLANKTIME_SCANOUTPOS_METHOD;
713 if (invbl)
714 vbl_status |= DRM_VBLANKTIME_INVBL;
715
716 return vbl_status;
717}
718EXPORT_SYMBOL(drm_calc_vbltimestamp_from_scanoutpos);
719
c61eef72
ID
720static struct timeval get_drm_timestamp(void)
721{
722 ktime_t now;
723
724 now = ktime_get();
725 if (!drm_timestamp_monotonic)
726 now = ktime_sub(now, ktime_get_monotonic_offset());
727
728 return ktime_to_timeval(now);
729}
730
27641c3f
MK
731/**
732 * drm_get_last_vbltimestamp - retrieve raw timestamp for the most recent
733 * vblank interval.
734 *
735 * @dev: DRM device
736 * @crtc: which crtc's vblank timestamp to retrieve
737 * @tvblank: Pointer to target struct timeval which should receive the timestamp
738 * @flags: Flags to pass to driver:
739 * 0 = Default.
740 * DRM_CALLED_FROM_VBLIRQ = If function is called from vbl irq handler.
741 *
742 * Fetches the system timestamp corresponding to the time of the most recent
743 * vblank interval on specified crtc. May call into kms-driver to
744 * compute the timestamp with a high-precision GPU specific method.
745 *
746 * Returns zero if timestamp originates from uncorrected do_gettimeofday()
747 * call, i.e., it isn't very precisely locked to the true vblank.
748 *
749 * Returns non-zero if timestamp is considered to be very precise.
750 */
751u32 drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
752 struct timeval *tvblank, unsigned flags)
753{
4a1b0714 754 int ret;
27641c3f
MK
755
756 /* Define requested maximum error on timestamps (nanoseconds). */
757 int max_error = (int) drm_timestamp_precision * 1000;
758
759 /* Query driver if possible and precision timestamping enabled. */
760 if (dev->driver->get_vblank_timestamp && (max_error > 0)) {
761 ret = dev->driver->get_vblank_timestamp(dev, crtc, &max_error,
762 tvblank, flags);
763 if (ret > 0)
764 return (u32) ret;
765 }
766
767 /* GPU high precision timestamp query unsupported or failed.
c61eef72 768 * Return current monotonic/gettimeofday timestamp as best estimate.
27641c3f 769 */
c61eef72 770 *tvblank = get_drm_timestamp();
27641c3f
MK
771
772 return 0;
773}
774EXPORT_SYMBOL(drm_get_last_vbltimestamp);
775
0a3e67a4
JB
776/**
777 * drm_vblank_count - retrieve "cooked" vblank counter value
778 * @dev: DRM device
779 * @crtc: which counter to retrieve
780 *
781 * Fetches the "cooked" vblank count value that represents the number of
782 * vblank events since the system was booted, including lost events due to
783 * modesetting activity.
784 */
785u32 drm_vblank_count(struct drm_device *dev, int crtc)
786{
787 return atomic_read(&dev->_vblank_count[crtc]);
788}
789EXPORT_SYMBOL(drm_vblank_count);
790
27641c3f
MK
791/**
792 * drm_vblank_count_and_time - retrieve "cooked" vblank counter value
793 * and the system timestamp corresponding to that vblank counter value.
794 *
795 * @dev: DRM device
796 * @crtc: which counter to retrieve
797 * @vblanktime: Pointer to struct timeval to receive the vblank timestamp.
798 *
799 * Fetches the "cooked" vblank count value that represents the number of
800 * vblank events since the system was booted, including lost events due to
801 * modesetting activity. Returns corresponding system timestamp of the time
802 * of the vblank interval that corresponds to the current value vblank counter
803 * value.
804 */
805u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
806 struct timeval *vblanktime)
807{
808 u32 cur_vblank;
809
810 /* Read timestamp from slot of _vblank_time ringbuffer
811 * that corresponds to current vblank count. Retry if
812 * count has incremented during readout. This works like
813 * a seqlock.
814 */
815 do {
816 cur_vblank = atomic_read(&dev->_vblank_count[crtc]);
817 *vblanktime = vblanktimestamp(dev, crtc, cur_vblank);
818 smp_rmb();
819 } while (cur_vblank != atomic_read(&dev->_vblank_count[crtc]));
820
821 return cur_vblank;
822}
823EXPORT_SYMBOL(drm_vblank_count_and_time);
824
c6eefa17
RC
825static void send_vblank_event(struct drm_device *dev,
826 struct drm_pending_vblank_event *e,
827 unsigned long seq, struct timeval *now)
828{
829 WARN_ON_SMP(!spin_is_locked(&dev->event_lock));
830 e->event.sequence = seq;
831 e->event.tv_sec = now->tv_sec;
832 e->event.tv_usec = now->tv_usec;
833
834 list_add_tail(&e->base.link,
835 &e->base.file_priv->event_list);
836 wake_up_interruptible(&e->base.file_priv->event_wait);
837 trace_drm_vblank_event_delivered(e->base.pid, e->pipe,
838 e->event.sequence);
839}
840
841/**
842 * drm_send_vblank_event - helper to send vblank event after pageflip
843 * @dev: DRM device
844 * @crtc: CRTC in question
845 * @e: the event to send
846 *
847 * Updates sequence # and timestamp on event, and sends it to userspace.
848 * Caller must hold event lock.
849 */
850void drm_send_vblank_event(struct drm_device *dev, int crtc,
851 struct drm_pending_vblank_event *e)
852{
853 struct timeval now;
854 unsigned int seq;
855 if (crtc >= 0) {
856 seq = drm_vblank_count_and_time(dev, crtc, &now);
857 } else {
858 seq = 0;
c61eef72
ID
859
860 now = get_drm_timestamp();
c6eefa17
RC
861 }
862 send_vblank_event(dev, e, seq, &now);
863}
864EXPORT_SYMBOL(drm_send_vblank_event);
865
0a3e67a4
JB
866/**
867 * drm_update_vblank_count - update the master vblank counter
868 * @dev: DRM device
869 * @crtc: counter to update
870 *
871 * Call back into the driver to update the appropriate vblank counter
872 * (specified by @crtc). Deal with wraparound, if it occurred, and
873 * update the last read value so we can deal with wraparound on the next
874 * call if necessary.
875 *
876 * Only necessary when going from off->on, to account for frames we
877 * didn't get an interrupt for.
878 *
879 * Note: caller must hold dev->vbl_lock since this reads & writes
880 * device vblank fields.
881 */
882static void drm_update_vblank_count(struct drm_device *dev, int crtc)
883{
27641c3f
MK
884 u32 cur_vblank, diff, tslot, rc;
885 struct timeval t_vblank;
0a3e67a4
JB
886
887 /*
888 * Interrupts were disabled prior to this call, so deal with counter
889 * wrap if needed.
890 * NOTE! It's possible we lost a full dev->max_vblank_count events
891 * here if the register is small or we had vblank interrupts off for
892 * a long time.
27641c3f
MK
893 *
894 * We repeat the hardware vblank counter & timestamp query until
895 * we get consistent results. This to prevent races between gpu
896 * updating its hardware counter while we are retrieving the
897 * corresponding vblank timestamp.
0a3e67a4 898 */
27641c3f
MK
899 do {
900 cur_vblank = dev->driver->get_vblank_counter(dev, crtc);
901 rc = drm_get_last_vbltimestamp(dev, crtc, &t_vblank, 0);
902 } while (cur_vblank != dev->driver->get_vblank_counter(dev, crtc));
903
904 /* Deal with counter wrap */
0a3e67a4
JB
905 diff = cur_vblank - dev->last_vblank[crtc];
906 if (cur_vblank < dev->last_vblank[crtc]) {
907 diff += dev->max_vblank_count;
908
909 DRM_DEBUG("last_vblank[%d]=0x%x, cur_vblank=0x%x => diff=0x%x\n",
910 crtc, dev->last_vblank[crtc], cur_vblank, diff);
911 }
912
913 DRM_DEBUG("enabling vblank interrupts on crtc %d, missed %d\n",
914 crtc, diff);
915
27641c3f
MK
916 /* Reinitialize corresponding vblank timestamp if high-precision query
917 * available. Skip this step if query unsupported or failed. Will
918 * reinitialize delayed at next vblank interrupt in that case.
919 */
920 if (rc) {
921 tslot = atomic_read(&dev->_vblank_count[crtc]) + diff;
922 vblanktimestamp(dev, crtc, tslot) = t_vblank;
27641c3f
MK
923 }
924
bc215128 925 smp_mb__before_atomic_inc();
0a3e67a4 926 atomic_add(diff, &dev->_vblank_count[crtc]);
bc215128 927 smp_mb__after_atomic_inc();
0a3e67a4
JB
928}
929
930/**
931 * drm_vblank_get - get a reference count on vblank events
932 * @dev: DRM device
933 * @crtc: which CRTC to own
934 *
935 * Acquire a reference count on vblank events to avoid having them disabled
936 * while in use.
937 *
938 * RETURNS
939 * Zero on success, nonzero on failure.
940 */
941int drm_vblank_get(struct drm_device *dev, int crtc)
942{
27641c3f 943 unsigned long irqflags, irqflags2;
0a3e67a4
JB
944 int ret = 0;
945
946 spin_lock_irqsave(&dev->vbl_lock, irqflags);
947 /* Going from 0->1 means we have to enable interrupts again */
778c9026 948 if (atomic_add_return(1, &dev->vblank_refcount[crtc]) == 1) {
27641c3f 949 spin_lock_irqsave(&dev->vblank_time_lock, irqflags2);
778c9026 950 if (!dev->vblank_enabled[crtc]) {
27641c3f
MK
951 /* Enable vblank irqs under vblank_time_lock protection.
952 * All vblank count & timestamp updates are held off
953 * until we are done reinitializing master counter and
954 * timestamps. Filtercode in drm_handle_vblank() will
955 * prevent double-accounting of same vblank interval.
956 */
778c9026 957 ret = dev->driver->enable_vblank(dev, crtc);
27641c3f
MK
958 DRM_DEBUG("enabling vblank on crtc %d, ret: %d\n",
959 crtc, ret);
778c9026
LP
960 if (ret)
961 atomic_dec(&dev->vblank_refcount[crtc]);
962 else {
963 dev->vblank_enabled[crtc] = 1;
964 drm_update_vblank_count(dev, crtc);
965 }
966 }
27641c3f 967 spin_unlock_irqrestore(&dev->vblank_time_lock, irqflags2);
778c9026
LP
968 } else {
969 if (!dev->vblank_enabled[crtc]) {
0a3e67a4 970 atomic_dec(&dev->vblank_refcount[crtc]);
778c9026 971 ret = -EINVAL;
0a3e67a4
JB
972 }
973 }
974 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
975
976 return ret;
977}
978EXPORT_SYMBOL(drm_vblank_get);
979
980/**
981 * drm_vblank_put - give up ownership of vblank events
982 * @dev: DRM device
983 * @crtc: which counter to give up
984 *
985 * Release ownership of a given vblank counter, turning off interrupts
27641c3f 986 * if possible. Disable interrupts after drm_vblank_offdelay milliseconds.
0a3e67a4
JB
987 */
988void drm_vblank_put(struct drm_device *dev, int crtc)
989{
27641c3f 990 BUG_ON(atomic_read(&dev->vblank_refcount[crtc]) == 0);
b3f5e732 991
0a3e67a4 992 /* Last user schedules interrupt disable */
27641c3f
MK
993 if (atomic_dec_and_test(&dev->vblank_refcount[crtc]) &&
994 (drm_vblank_offdelay > 0))
995 mod_timer(&dev->vblank_disable_timer,
996 jiffies + ((drm_vblank_offdelay * DRM_HZ)/1000));
0a3e67a4
JB
997}
998EXPORT_SYMBOL(drm_vblank_put);
999
c6eefa17
RC
1000/**
1001 * drm_vblank_off - disable vblank events on a CRTC
1002 * @dev: DRM device
1003 * @crtc: CRTC in question
1004 *
1005 * Caller must hold event lock.
1006 */
778c9026
LP
1007void drm_vblank_off(struct drm_device *dev, int crtc)
1008{
498548ec
CJHR
1009 struct drm_pending_vblank_event *e, *t;
1010 struct timeval now;
778c9026 1011 unsigned long irqflags;
498548ec 1012 unsigned int seq;
778c9026
LP
1013
1014 spin_lock_irqsave(&dev->vbl_lock, irqflags);
27641c3f 1015 vblank_disable_and_save(dev, crtc);
778c9026 1016 DRM_WAKEUP(&dev->vbl_queue[crtc]);
498548ec
CJHR
1017
1018 /* Send any queued vblank events, lest the natives grow disquiet */
1019 seq = drm_vblank_count_and_time(dev, crtc, &now);
1020 list_for_each_entry_safe(e, t, &dev->vblank_event_list, base.link) {
1021 if (e->pipe != crtc)
1022 continue;
1023 DRM_DEBUG("Sending premature vblank event on disable: \
1024 wanted %d, current %d\n",
1025 e->event.sequence, seq);
c6eefa17 1026 list_del(&e->base.link);
498548ec 1027 drm_vblank_put(dev, e->pipe);
c6eefa17 1028 send_vblank_event(dev, e, seq, &now);
498548ec
CJHR
1029 }
1030
778c9026
LP
1031 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
1032}
1033EXPORT_SYMBOL(drm_vblank_off);
1034
f453ba04
DA
1035/**
1036 * drm_vblank_pre_modeset - account for vblanks across mode sets
1037 * @dev: DRM device
1038 * @crtc: CRTC in question
f453ba04
DA
1039 *
1040 * Account for vblank events across mode setting events, which will likely
1041 * reset the hardware frame counter.
1042 */
1043void drm_vblank_pre_modeset(struct drm_device *dev, int crtc)
1044{
e77cef9c
JG
1045 /* vblank is not initialized (IRQ not installed ?) */
1046 if (!dev->num_crtcs)
1047 return;
f453ba04
DA
1048 /*
1049 * To avoid all the problems that might happen if interrupts
1050 * were enabled/disabled around or between these calls, we just
1051 * have the kernel take a reference on the CRTC (just once though
1052 * to avoid corrupting the count if multiple, mismatch calls occur),
1053 * so that interrupts remain enabled in the interim.
1054 */
1055 if (!dev->vblank_inmodeset[crtc]) {
b3f5e732
CW
1056 dev->vblank_inmodeset[crtc] = 0x1;
1057 if (drm_vblank_get(dev, crtc) == 0)
1058 dev->vblank_inmodeset[crtc] |= 0x2;
f453ba04
DA
1059 }
1060}
1061EXPORT_SYMBOL(drm_vblank_pre_modeset);
1062
1063void drm_vblank_post_modeset(struct drm_device *dev, int crtc)
1064{
1065 unsigned long irqflags;
1066
1067 if (dev->vblank_inmodeset[crtc]) {
1068 spin_lock_irqsave(&dev->vbl_lock, irqflags);
1069 dev->vblank_disable_allowed = 1;
f453ba04 1070 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
b3f5e732
CW
1071
1072 if (dev->vblank_inmodeset[crtc] & 0x2)
1073 drm_vblank_put(dev, crtc);
1074
1075 dev->vblank_inmodeset[crtc] = 0;
f453ba04
DA
1076 }
1077}
1078EXPORT_SYMBOL(drm_vblank_post_modeset);
1079
0a3e67a4
JB
1080/**
1081 * drm_modeset_ctl - handle vblank event counter changes across mode switch
1082 * @DRM_IOCTL_ARGS: standard ioctl arguments
1083 *
1084 * Applications should call the %_DRM_PRE_MODESET and %_DRM_POST_MODESET
1085 * ioctls around modesetting so that any lost vblank events are accounted for.
1086 *
1087 * Generally the counter will reset across mode sets. If interrupts are
1088 * enabled around this call, we don't have to do anything since the counter
1089 * will have already been incremented.
1090 */
1091int drm_modeset_ctl(struct drm_device *dev, void *data,
1092 struct drm_file *file_priv)
1093{
1094 struct drm_modeset_ctl *modeset = data;
19227561 1095 unsigned int crtc;
0a3e67a4
JB
1096
1097 /* If drm_vblank_init() hasn't been called yet, just no-op */
1098 if (!dev->num_crtcs)
4a1b0714 1099 return 0;
0a3e67a4 1100
29935554
LP
1101 /* KMS drivers handle this internally */
1102 if (drm_core_check_feature(dev, DRIVER_MODESET))
1103 return 0;
1104
0a3e67a4 1105 crtc = modeset->crtc;
4a1b0714
LP
1106 if (crtc >= dev->num_crtcs)
1107 return -EINVAL;
0a3e67a4 1108
0a3e67a4
JB
1109 switch (modeset->cmd) {
1110 case _DRM_PRE_MODESET:
f453ba04 1111 drm_vblank_pre_modeset(dev, crtc);
0a3e67a4
JB
1112 break;
1113 case _DRM_POST_MODESET:
f453ba04 1114 drm_vblank_post_modeset(dev, crtc);
0a3e67a4
JB
1115 break;
1116 default:
4a1b0714 1117 return -EINVAL;
0a3e67a4
JB
1118 }
1119
4a1b0714 1120 return 0;
0a3e67a4
JB
1121}
1122
c9a9c5e0
KH
1123static int drm_queue_vblank_event(struct drm_device *dev, int pipe,
1124 union drm_wait_vblank *vblwait,
1125 struct drm_file *file_priv)
1126{
1127 struct drm_pending_vblank_event *e;
1128 struct timeval now;
1129 unsigned long flags;
1130 unsigned int seq;
ea5d552c 1131 int ret;
c9a9c5e0
KH
1132
1133 e = kzalloc(sizeof *e, GFP_KERNEL);
ea5d552c
CW
1134 if (e == NULL) {
1135 ret = -ENOMEM;
1136 goto err_put;
1137 }
c9a9c5e0
KH
1138
1139 e->pipe = pipe;
b9c2c9ae 1140 e->base.pid = current->pid;
c9a9c5e0
KH
1141 e->event.base.type = DRM_EVENT_VBLANK;
1142 e->event.base.length = sizeof e->event;
1143 e->event.user_data = vblwait->request.signal;
1144 e->base.event = &e->event.base;
1145 e->base.file_priv = file_priv;
1146 e->base.destroy = (void (*) (struct drm_pending_event *)) kfree;
1147
c9a9c5e0
KH
1148 spin_lock_irqsave(&dev->event_lock, flags);
1149
1150 if (file_priv->event_space < sizeof e->event) {
ea5d552c
CW
1151 ret = -EBUSY;
1152 goto err_unlock;
c9a9c5e0
KH
1153 }
1154
1155 file_priv->event_space -= sizeof e->event;
27641c3f
MK
1156 seq = drm_vblank_count_and_time(dev, pipe, &now);
1157
c9a9c5e0
KH
1158 if ((vblwait->request.type & _DRM_VBLANK_NEXTONMISS) &&
1159 (seq - vblwait->request.sequence) <= (1 << 23)) {
1160 vblwait->request.sequence = seq + 1;
4a921645 1161 vblwait->reply.sequence = vblwait->request.sequence;
c9a9c5e0
KH
1162 }
1163
1164 DRM_DEBUG("event on vblank count %d, current %d, crtc %d\n",
1165 vblwait->request.sequence, seq, pipe);
1166
b9c2c9ae
JB
1167 trace_drm_vblank_event_queued(current->pid, pipe,
1168 vblwait->request.sequence);
1169
c9a9c5e0
KH
1170 e->event.sequence = vblwait->request.sequence;
1171 if ((seq - vblwait->request.sequence) <= (1 << 23)) {
6f331623 1172 drm_vblank_put(dev, pipe);
c6eefa17 1173 send_vblank_event(dev, e, seq, &now);
000fa7cf 1174 vblwait->reply.sequence = seq;
c9a9c5e0 1175 } else {
a6778e9e 1176 /* drm_handle_vblank_events will call drm_vblank_put */
c9a9c5e0 1177 list_add_tail(&e->base.link, &dev->vblank_event_list);
000fa7cf 1178 vblwait->reply.sequence = vblwait->request.sequence;
c9a9c5e0
KH
1179 }
1180
1181 spin_unlock_irqrestore(&dev->event_lock, flags);
1182
1183 return 0;
ea5d552c
CW
1184
1185err_unlock:
1186 spin_unlock_irqrestore(&dev->event_lock, flags);
1187 kfree(e);
1188err_put:
6f331623 1189 drm_vblank_put(dev, pipe);
ea5d552c 1190 return ret;
c9a9c5e0
KH
1191}
1192
1da177e4
LT
1193/**
1194 * Wait for VBLANK.
1195 *
1196 * \param inode device inode.
6c340eac 1197 * \param file_priv DRM file private.
1da177e4
LT
1198 * \param cmd command.
1199 * \param data user argument, pointing to a drm_wait_vblank structure.
1200 * \return zero on success or a negative number on failure.
1201 *
30b23634
EA
1202 * This function enables the vblank interrupt on the pipe requested, then
1203 * sleeps waiting for the requested sequence number to occur, and drops
1204 * the vblank interrupt refcount afterwards. (vblank irq disable follows that
1205 * after a timeout with no further vblank waits scheduled).
1da177e4 1206 */
0a3e67a4
JB
1207int drm_wait_vblank(struct drm_device *dev, void *data,
1208 struct drm_file *file_priv)
1da177e4 1209{
c153f45f 1210 union drm_wait_vblank *vblwait = data;
4a1b0714 1211 int ret;
19b01b5f 1212 unsigned int flags, seq, crtc, high_crtc;
1da177e4 1213
dcdb1674 1214 if ((!drm_dev_to_irq(dev)) || (!dev->irq_enabled))
1da177e4
LT
1215 return -EINVAL;
1216
30b23634
EA
1217 if (vblwait->request.type & _DRM_VBLANK_SIGNAL)
1218 return -EINVAL;
1219
c153f45f 1220 if (vblwait->request.type &
19b01b5f
IH
1221 ~(_DRM_VBLANK_TYPES_MASK | _DRM_VBLANK_FLAGS_MASK |
1222 _DRM_VBLANK_HIGH_CRTC_MASK)) {
776c9443 1223 DRM_ERROR("Unsupported type value 0x%x, supported mask 0x%x\n",
c153f45f 1224 vblwait->request.type,
19b01b5f
IH
1225 (_DRM_VBLANK_TYPES_MASK | _DRM_VBLANK_FLAGS_MASK |
1226 _DRM_VBLANK_HIGH_CRTC_MASK));
776c9443
MD
1227 return -EINVAL;
1228 }
1229
c153f45f 1230 flags = vblwait->request.type & _DRM_VBLANK_FLAGS_MASK;
19b01b5f
IH
1231 high_crtc = (vblwait->request.type & _DRM_VBLANK_HIGH_CRTC_MASK);
1232 if (high_crtc)
1233 crtc = high_crtc >> _DRM_VBLANK_HIGH_CRTC_SHIFT;
1234 else
1235 crtc = flags & _DRM_VBLANK_SECONDARY ? 1 : 0;
0a3e67a4 1236 if (crtc >= dev->num_crtcs)
776c9443
MD
1237 return -EINVAL;
1238
0a3e67a4
JB
1239 ret = drm_vblank_get(dev, crtc);
1240 if (ret) {
8d3457ec 1241 DRM_DEBUG("failed to acquire vblank counter, %d\n", ret);
0a3e67a4
JB
1242 return ret;
1243 }
1244 seq = drm_vblank_count(dev, crtc);
776c9443 1245
c153f45f 1246 switch (vblwait->request.type & _DRM_VBLANK_TYPES_MASK) {
1da177e4 1247 case _DRM_VBLANK_RELATIVE:
c153f45f
EA
1248 vblwait->request.sequence += seq;
1249 vblwait->request.type &= ~_DRM_VBLANK_RELATIVE;
1da177e4
LT
1250 case _DRM_VBLANK_ABSOLUTE:
1251 break;
1252 default:
0a3e67a4
JB
1253 ret = -EINVAL;
1254 goto done;
1da177e4
LT
1255 }
1256
a6778e9e
IH
1257 if (flags & _DRM_VBLANK_EVENT) {
1258 /* must hold on to the vblank ref until the event fires
1259 * drm_vblank_put will be called asynchronously
1260 */
c9a9c5e0 1261 return drm_queue_vblank_event(dev, crtc, vblwait, file_priv);
a6778e9e 1262 }
c9a9c5e0 1263
ab285d74 1264 if ((flags & _DRM_VBLANK_NEXTONMISS) &&
c153f45f
EA
1265 (seq - vblwait->request.sequence) <= (1<<23)) {
1266 vblwait->request.sequence = seq + 1;
ab285d74
MD
1267 }
1268
30b23634
EA
1269 DRM_DEBUG("waiting on vblank count %d, crtc %d\n",
1270 vblwait->request.sequence, crtc);
1271 dev->last_vblank_wait[crtc] = vblwait->request.sequence;
1272 DRM_WAIT_ON(ret, dev->vbl_queue[crtc], 3 * DRM_HZ,
1273 (((drm_vblank_count(dev, crtc) -
1274 vblwait->request.sequence) <= (1 << 23)) ||
1275 !dev->irq_enabled));
1da177e4 1276
30b23634
EA
1277 if (ret != -EINTR) {
1278 struct timeval now;
1da177e4 1279
27641c3f 1280 vblwait->reply.sequence = drm_vblank_count_and_time(dev, crtc, &now);
30b23634
EA
1281 vblwait->reply.tval_sec = now.tv_sec;
1282 vblwait->reply.tval_usec = now.tv_usec;
27641c3f 1283
30b23634
EA
1284 DRM_DEBUG("returning %d to client\n",
1285 vblwait->reply.sequence);
1da177e4 1286 } else {
30b23634 1287 DRM_DEBUG("vblank wait interrupted by signal\n");
1da177e4
LT
1288 }
1289
0a3e67a4
JB
1290done:
1291 drm_vblank_put(dev, crtc);
1da177e4
LT
1292 return ret;
1293}
1294
ea7f7abc 1295static void drm_handle_vblank_events(struct drm_device *dev, int crtc)
c9a9c5e0
KH
1296{
1297 struct drm_pending_vblank_event *e, *t;
1298 struct timeval now;
1299 unsigned long flags;
1300 unsigned int seq;
1301
27641c3f 1302 seq = drm_vblank_count_and_time(dev, crtc, &now);
c9a9c5e0
KH
1303
1304 spin_lock_irqsave(&dev->event_lock, flags);
1305
1306 list_for_each_entry_safe(e, t, &dev->vblank_event_list, base.link) {
1307 if (e->pipe != crtc)
1308 continue;
1309 if ((seq - e->event.sequence) > (1<<23))
1310 continue;
1311
1312 DRM_DEBUG("vblank event on %d, current %d\n",
1313 e->event.sequence, seq);
1314
c6eefa17 1315 list_del(&e->base.link);
c9a9c5e0 1316 drm_vblank_put(dev, e->pipe);
c6eefa17 1317 send_vblank_event(dev, e, seq, &now);
c9a9c5e0
KH
1318 }
1319
1320 spin_unlock_irqrestore(&dev->event_lock, flags);
ac2874b9
JB
1321
1322 trace_drm_vblank_event(crtc, seq);
c9a9c5e0
KH
1323}
1324
0a3e67a4
JB
1325/**
1326 * drm_handle_vblank - handle a vblank event
1327 * @dev: DRM device
1328 * @crtc: where this event occurred
1329 *
1330 * Drivers should call this routine in their vblank interrupt handlers to
1331 * update the vblank counter and send any signals that may be pending.
1332 */
78c6e170 1333bool drm_handle_vblank(struct drm_device *dev, int crtc)
0a3e67a4 1334{
27641c3f
MK
1335 u32 vblcount;
1336 s64 diff_ns;
1337 struct timeval tvblank;
1338 unsigned long irqflags;
1339
c9a9c5e0 1340 if (!dev->num_crtcs)
78c6e170 1341 return false;
c9a9c5e0 1342
27641c3f
MK
1343 /* Need timestamp lock to prevent concurrent execution with
1344 * vblank enable/disable, as this would cause inconsistent
1345 * or corrupted timestamps and vblank counts.
1346 */
1347 spin_lock_irqsave(&dev->vblank_time_lock, irqflags);
1348
1349 /* Vblank irq handling disabled. Nothing to do. */
1350 if (!dev->vblank_enabled[crtc]) {
1351 spin_unlock_irqrestore(&dev->vblank_time_lock, irqflags);
78c6e170 1352 return false;
27641c3f
MK
1353 }
1354
1355 /* Fetch corresponding timestamp for this vblank interval from
1356 * driver and store it in proper slot of timestamp ringbuffer.
1357 */
1358
1359 /* Get current timestamp and count. */
1360 vblcount = atomic_read(&dev->_vblank_count[crtc]);
1361 drm_get_last_vbltimestamp(dev, crtc, &tvblank, DRM_CALLED_FROM_VBLIRQ);
1362
1363 /* Compute time difference to timestamp of last vblank */
1364 diff_ns = timeval_to_ns(&tvblank) -
1365 timeval_to_ns(&vblanktimestamp(dev, crtc, vblcount));
1366
1367 /* Update vblank timestamp and count if at least
1368 * DRM_REDUNDANT_VBLIRQ_THRESH_NS nanoseconds
1369 * difference between last stored timestamp and current
1370 * timestamp. A smaller difference means basically
1371 * identical timestamps. Happens if this vblank has
1372 * been already processed and this is a redundant call,
1373 * e.g., due to spurious vblank interrupts. We need to
1374 * ignore those for accounting.
1375 */
c4cc3839 1376 if (abs64(diff_ns) > DRM_REDUNDANT_VBLIRQ_THRESH_NS) {
27641c3f
MK
1377 /* Store new timestamp in ringbuffer. */
1378 vblanktimestamp(dev, crtc, vblcount + 1) = tvblank;
27641c3f
MK
1379
1380 /* Increment cooked vblank count. This also atomically commits
1381 * the timestamp computed above.
1382 */
bc215128 1383 smp_mb__before_atomic_inc();
27641c3f 1384 atomic_inc(&dev->_vblank_count[crtc]);
bc215128 1385 smp_mb__after_atomic_inc();
27641c3f
MK
1386 } else {
1387 DRM_DEBUG("crtc %d: Redundant vblirq ignored. diff_ns = %d\n",
1388 crtc, (int) diff_ns);
1389 }
1390
0a3e67a4 1391 DRM_WAKEUP(&dev->vbl_queue[crtc]);
c9a9c5e0 1392 drm_handle_vblank_events(dev, crtc);
27641c3f
MK
1393
1394 spin_unlock_irqrestore(&dev->vblank_time_lock, irqflags);
78c6e170 1395 return true;
0a3e67a4
JB
1396}
1397EXPORT_SYMBOL(drm_handle_vblank);