2 * drm_irq.c IRQ and vblank support
11 * Copyright 1999, 2000 Precision Insight, Inc., Cedar Park, Texas.
12 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
13 * All Rights Reserved.
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:
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
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.
36 #include "drm_trace.h"
37 #include "drm_internal.h"
39 #include <linux/interrupt.h> /* For task queue support */
40 #include <linux/slab.h>
42 #include <linux/vgaarb.h>
43 #include <linux/export.h>
45 /* Access macro for slots in vblank timestamp ringbuffer. */
46 #define vblanktimestamp(dev, crtc, count) \
47 ((dev)->vblank[crtc].time[(count) % DRM_VBLANKTIME_RBSIZE])
49 /* Retry timestamp calculation up to 3 times to satisfy
50 * drm_timestamp_precision before giving up.
52 #define DRM_TIMESTAMP_MAXRETRIES 3
54 /* Threshold in nanoseconds for detection of redundant
55 * vblank irq in drm_handle_vblank(). 1 msec should be ok.
57 #define DRM_REDUNDANT_VBLIRQ_THRESH_NS 1000000
60 drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
61 struct timeval *tvblank, unsigned flags);
63 static unsigned int drm_timestamp_precision = 20; /* Default to 20 usecs. */
66 * Default to use monotonic timestamps for wait-for-vblank and page-flip
69 unsigned int drm_timestamp_monotonic = 1;
71 static int drm_vblank_offdelay = 5000; /* Default to 5000 msecs. */
73 module_param_named(vblankoffdelay, drm_vblank_offdelay, int, 0600);
74 module_param_named(timestamp_precision_usec, drm_timestamp_precision, int, 0600);
75 module_param_named(timestamp_monotonic, drm_timestamp_monotonic, int, 0600);
78 * drm_update_vblank_count - update the master vblank counter
80 * @crtc: counter to update
82 * Call back into the driver to update the appropriate vblank counter
83 * (specified by @crtc). Deal with wraparound, if it occurred, and
84 * update the last read value so we can deal with wraparound on the next
87 * Only necessary when going from off->on, to account for frames we
88 * didn't get an interrupt for.
90 * Note: caller must hold dev->vbl_lock since this reads & writes
91 * device vblank fields.
93 static void drm_update_vblank_count(struct drm_device *dev, int crtc)
95 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
96 u32 cur_vblank, diff, tslot;
98 struct timeval t_vblank;
101 * Interrupts were disabled prior to this call, so deal with counter
103 * NOTE! It's possible we lost a full dev->max_vblank_count events
104 * here if the register is small or we had vblank interrupts off for
107 * We repeat the hardware vblank counter & timestamp query until
108 * we get consistent results. This to prevent races between gpu
109 * updating its hardware counter while we are retrieving the
110 * corresponding vblank timestamp.
113 cur_vblank = dev->driver->get_vblank_counter(dev, crtc);
114 rc = drm_get_last_vbltimestamp(dev, crtc, &t_vblank, 0);
115 } while (cur_vblank != dev->driver->get_vblank_counter(dev, crtc));
117 /* Deal with counter wrap */
118 diff = cur_vblank - vblank->last;
119 if (cur_vblank < vblank->last) {
120 diff += dev->max_vblank_count;
122 DRM_DEBUG("last_vblank[%d]=0x%x, cur_vblank=0x%x => diff=0x%x\n",
123 crtc, vblank->last, cur_vblank, diff);
126 DRM_DEBUG("updating vblank count on crtc %d, missed %d\n",
132 /* Reinitialize corresponding vblank timestamp if high-precision query
133 * available. Skip this step if query unsupported or failed. Will
134 * reinitialize delayed at next vblank interrupt in that case.
137 tslot = atomic_read(&vblank->count) + diff;
138 vblanktimestamp(dev, crtc, tslot) = t_vblank;
141 smp_mb__before_atomic();
142 atomic_add(diff, &vblank->count);
143 smp_mb__after_atomic();
147 * Disable vblank irq's on crtc, make sure that last vblank count
148 * of hardware and corresponding consistent software vblank counter
149 * are preserved, even if there are any spurious vblank irq's after
152 static void vblank_disable_and_save(struct drm_device *dev, int crtc)
154 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
155 unsigned long irqflags;
159 struct timeval tvblank;
160 int count = DRM_TIMESTAMP_MAXRETRIES;
162 /* Prevent vblank irq processing while disabling vblank irqs,
163 * so no updates of timestamps or count can happen after we've
164 * disabled. Needed to prevent races in case of delayed irq's.
166 spin_lock_irqsave(&dev->vblank_time_lock, irqflags);
169 * If the vblank interrupt was already disabled update the count
170 * and timestamp to maintain the appearance that the counter
171 * has been ticking all along until this time. This makes the
172 * count account for the entire time between drm_vblank_on() and
175 * But only do this if precise vblank timestamps are available.
176 * Otherwise we might read a totally bogus timestamp since drivers
177 * lacking precise timestamp support rely upon sampling the system clock
178 * at vblank interrupt time. Which obviously won't work out well if the
179 * vblank interrupt is disabled.
181 if (!vblank->enabled &&
182 drm_get_last_vbltimestamp(dev, crtc, &tvblank, 0)) {
183 drm_update_vblank_count(dev, crtc);
184 spin_unlock_irqrestore(&dev->vblank_time_lock, irqflags);
189 * Only disable vblank interrupts if they're enabled. This avoids
190 * calling the ->disable_vblank() operation in atomic context with the
191 * hardware potentially runtime suspended.
193 if (vblank->enabled) {
194 dev->driver->disable_vblank(dev, crtc);
195 vblank->enabled = false;
198 /* No further vblank irq's will be processed after
199 * this point. Get current hardware vblank count and
200 * vblank timestamp, repeat until they are consistent.
202 * FIXME: There is still a race condition here and in
203 * drm_update_vblank_count() which can cause off-by-one
204 * reinitialization of software vblank counter. If gpu
205 * vblank counter doesn't increment exactly at the leading
206 * edge of a vblank interval, then we can lose 1 count if
207 * we happen to execute between start of vblank and the
208 * delayed gpu counter increment.
211 vblank->last = dev->driver->get_vblank_counter(dev, crtc);
212 vblrc = drm_get_last_vbltimestamp(dev, crtc, &tvblank, 0);
213 } while (vblank->last != dev->driver->get_vblank_counter(dev, crtc) && (--count) && vblrc);
218 /* Compute time difference to stored timestamp of last vblank
219 * as updated by last invocation of drm_handle_vblank() in vblank irq.
221 vblcount = atomic_read(&vblank->count);
222 diff_ns = timeval_to_ns(&tvblank) -
223 timeval_to_ns(&vblanktimestamp(dev, crtc, vblcount));
225 /* If there is at least 1 msec difference between the last stored
226 * timestamp and tvblank, then we are currently executing our
227 * disable inside a new vblank interval, the tvblank timestamp
228 * corresponds to this new vblank interval and the irq handler
229 * for this vblank didn't run yet and won't run due to our disable.
230 * Therefore we need to do the job of drm_handle_vblank() and
231 * increment the vblank counter by one to account for this vblank.
233 * Skip this step if there isn't any high precision timestamp
234 * available. In that case we can't account for this and just
237 if (vblrc && (abs64(diff_ns) > 1000000)) {
238 /* Store new timestamp in ringbuffer. */
239 vblanktimestamp(dev, crtc, vblcount + 1) = tvblank;
241 /* Increment cooked vblank count. This also atomically commits
242 * the timestamp computed above.
244 smp_mb__before_atomic();
245 atomic_inc(&vblank->count);
246 smp_mb__after_atomic();
249 spin_unlock_irqrestore(&dev->vblank_time_lock, irqflags);
252 static void vblank_disable_fn(unsigned long arg)
254 struct drm_vblank_crtc *vblank = (void *)arg;
255 struct drm_device *dev = vblank->dev;
256 unsigned long irqflags;
257 int crtc = vblank->crtc;
259 if (!dev->vblank_disable_allowed)
262 spin_lock_irqsave(&dev->vbl_lock, irqflags);
263 if (atomic_read(&vblank->refcount) == 0 && vblank->enabled) {
264 DRM_DEBUG("disabling vblank on crtc %d\n", crtc);
265 vblank_disable_and_save(dev, crtc);
267 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
271 * drm_vblank_cleanup - cleanup vblank support
274 * This function cleans up any resources allocated in drm_vblank_init.
276 void drm_vblank_cleanup(struct drm_device *dev)
280 /* Bail if the driver didn't call drm_vblank_init() */
281 if (dev->num_crtcs == 0)
284 for (crtc = 0; crtc < dev->num_crtcs; crtc++) {
285 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
287 WARN_ON(vblank->enabled &&
288 drm_core_check_feature(dev, DRIVER_MODESET));
290 del_timer_sync(&vblank->disable_timer);
297 EXPORT_SYMBOL(drm_vblank_cleanup);
300 * drm_vblank_init - initialize vblank support
302 * @num_crtcs: number of crtcs supported by @dev
304 * This function initializes vblank support for @num_crtcs display pipelines.
307 * Zero on success or a negative error code on failure.
309 int drm_vblank_init(struct drm_device *dev, int num_crtcs)
311 int i, ret = -ENOMEM;
313 spin_lock_init(&dev->vbl_lock);
314 spin_lock_init(&dev->vblank_time_lock);
316 dev->num_crtcs = num_crtcs;
318 dev->vblank = kcalloc(num_crtcs, sizeof(*dev->vblank), GFP_KERNEL);
322 for (i = 0; i < num_crtcs; i++) {
323 struct drm_vblank_crtc *vblank = &dev->vblank[i];
327 init_waitqueue_head(&vblank->queue);
328 setup_timer(&vblank->disable_timer, vblank_disable_fn,
329 (unsigned long)vblank);
332 DRM_INFO("Supports vblank timestamp caching Rev 2 (21.10.2013).\n");
334 /* Driver specific high-precision vblank timestamping supported? */
335 if (dev->driver->get_vblank_timestamp)
336 DRM_INFO("Driver supports precise vblank timestamp query.\n");
338 DRM_INFO("No driver support for vblank timestamp query.\n");
340 dev->vblank_disable_allowed = false;
348 EXPORT_SYMBOL(drm_vblank_init);
350 static void drm_irq_vgaarb_nokms(void *cookie, bool state)
352 struct drm_device *dev = cookie;
354 if (dev->driver->vgaarb_irq) {
355 dev->driver->vgaarb_irq(dev, state);
359 if (!dev->irq_enabled)
363 if (dev->driver->irq_uninstall)
364 dev->driver->irq_uninstall(dev);
366 if (dev->driver->irq_preinstall)
367 dev->driver->irq_preinstall(dev);
368 if (dev->driver->irq_postinstall)
369 dev->driver->irq_postinstall(dev);
374 * drm_irq_install - install IRQ handler
376 * @irq: IRQ number to install the handler for
378 * Initializes the IRQ related data. Installs the handler, calling the driver
379 * irq_preinstall() and irq_postinstall() functions before and after the
382 * This is the simplified helper interface provided for drivers with no special
383 * needs. Drivers which need to install interrupt handlers for multiple
384 * interrupts must instead set drm_device->irq_enabled to signal the DRM core
385 * that vblank interrupts are available.
388 * Zero on success or a negative error code on failure.
390 int drm_irq_install(struct drm_device *dev, int irq)
393 unsigned long sh_flags = 0;
395 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
401 /* Driver must have been initialized */
402 if (!dev->dev_private)
405 if (dev->irq_enabled)
407 dev->irq_enabled = true;
409 DRM_DEBUG("irq=%d\n", irq);
411 /* Before installing handler */
412 if (dev->driver->irq_preinstall)
413 dev->driver->irq_preinstall(dev);
415 /* Install handler */
416 if (drm_core_check_feature(dev, DRIVER_IRQ_SHARED))
417 sh_flags = IRQF_SHARED;
419 ret = request_irq(irq, dev->driver->irq_handler,
420 sh_flags, dev->driver->name, dev);
423 dev->irq_enabled = false;
427 if (!drm_core_check_feature(dev, DRIVER_MODESET))
428 vga_client_register(dev->pdev, (void *)dev, drm_irq_vgaarb_nokms, NULL);
430 /* After installing handler */
431 if (dev->driver->irq_postinstall)
432 ret = dev->driver->irq_postinstall(dev);
435 dev->irq_enabled = false;
436 if (!drm_core_check_feature(dev, DRIVER_MODESET))
437 vga_client_register(dev->pdev, NULL, NULL, NULL);
445 EXPORT_SYMBOL(drm_irq_install);
448 * drm_irq_uninstall - uninstall the IRQ handler
451 * Calls the driver's irq_uninstall() function and unregisters the IRQ handler.
452 * This should only be called by drivers which used drm_irq_install() to set up
453 * their interrupt handler. Other drivers must only reset
454 * drm_device->irq_enabled to false.
456 * Note that for kernel modesetting drivers it is a bug if this function fails.
457 * The sanity checks are only to catch buggy user modesetting drivers which call
458 * the same function through an ioctl.
461 * Zero on success or a negative error code on failure.
463 int drm_irq_uninstall(struct drm_device *dev)
465 unsigned long irqflags;
469 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
472 irq_enabled = dev->irq_enabled;
473 dev->irq_enabled = false;
476 * Wake up any waiters so they don't hang. This is just to paper over
477 * isssues for UMS drivers which aren't in full control of their
478 * vblank/irq handling. KMS drivers must ensure that vblanks are all
479 * disabled when uninstalling the irq handler.
481 if (dev->num_crtcs) {
482 spin_lock_irqsave(&dev->vbl_lock, irqflags);
483 for (i = 0; i < dev->num_crtcs; i++) {
484 struct drm_vblank_crtc *vblank = &dev->vblank[i];
486 if (!vblank->enabled)
489 WARN_ON(drm_core_check_feature(dev, DRIVER_MODESET));
491 vblank_disable_and_save(dev, i);
492 wake_up(&vblank->queue);
494 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
500 DRM_DEBUG("irq=%d\n", dev->irq);
502 if (!drm_core_check_feature(dev, DRIVER_MODESET))
503 vga_client_register(dev->pdev, NULL, NULL, NULL);
505 if (dev->driver->irq_uninstall)
506 dev->driver->irq_uninstall(dev);
508 free_irq(dev->irq, dev);
512 EXPORT_SYMBOL(drm_irq_uninstall);
517 * \param inode device inode.
518 * \param file_priv DRM file private.
519 * \param cmd command.
520 * \param arg user argument, pointing to a drm_control structure.
521 * \return zero on success or a negative number on failure.
523 * Calls irq_install() or irq_uninstall() according to \p arg.
525 int drm_control(struct drm_device *dev, void *data,
526 struct drm_file *file_priv)
528 struct drm_control *ctl = data;
531 /* if we haven't irq we fallback for compatibility reasons -
532 * this used to be a separate function in drm_dma.h
535 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
537 if (drm_core_check_feature(dev, DRIVER_MODESET))
539 /* UMS was only ever support on pci devices. */
540 if (WARN_ON(!dev->pdev))
544 case DRM_INST_HANDLER:
545 irq = dev->pdev->irq;
547 if (dev->if_version < DRM_IF_VERSION(1, 2) &&
550 mutex_lock(&dev->struct_mutex);
551 ret = drm_irq_install(dev, irq);
552 mutex_unlock(&dev->struct_mutex);
555 case DRM_UNINST_HANDLER:
556 mutex_lock(&dev->struct_mutex);
557 ret = drm_irq_uninstall(dev);
558 mutex_unlock(&dev->struct_mutex);
567 * drm_calc_timestamping_constants - calculate vblank timestamp constants
568 * @crtc: drm_crtc whose timestamp constants should be updated.
569 * @mode: display mode containing the scanout timings
571 * Calculate and store various constants which are later
572 * needed by vblank and swap-completion timestamping, e.g,
573 * by drm_calc_vbltimestamp_from_scanoutpos(). They are
574 * derived from CRTC's true scanout timing, so they take
575 * things like panel scaling or other adjustments into account.
577 void drm_calc_timestamping_constants(struct drm_crtc *crtc,
578 const struct drm_display_mode *mode)
580 int linedur_ns = 0, pixeldur_ns = 0, framedur_ns = 0;
581 int dotclock = mode->crtc_clock;
583 /* Valid dotclock? */
585 int frame_size = mode->crtc_htotal * mode->crtc_vtotal;
588 * Convert scanline length in pixels and video
589 * dot clock to line duration, frame duration
590 * and pixel duration in nanoseconds:
592 pixeldur_ns = 1000000 / dotclock;
593 linedur_ns = div_u64((u64) mode->crtc_htotal * 1000000, dotclock);
594 framedur_ns = div_u64((u64) frame_size * 1000000, dotclock);
597 * Fields of interlaced scanout modes are only half a frame duration.
599 if (mode->flags & DRM_MODE_FLAG_INTERLACE)
602 DRM_ERROR("crtc %d: Can't calculate constants, dotclock = 0!\n",
605 crtc->pixeldur_ns = pixeldur_ns;
606 crtc->linedur_ns = linedur_ns;
607 crtc->framedur_ns = framedur_ns;
609 DRM_DEBUG("crtc %d: hwmode: htotal %d, vtotal %d, vdisplay %d\n",
610 crtc->base.id, mode->crtc_htotal,
611 mode->crtc_vtotal, mode->crtc_vdisplay);
612 DRM_DEBUG("crtc %d: clock %d kHz framedur %d linedur %d, pixeldur %d\n",
613 crtc->base.id, dotclock, framedur_ns,
614 linedur_ns, pixeldur_ns);
616 EXPORT_SYMBOL(drm_calc_timestamping_constants);
619 * drm_calc_vbltimestamp_from_scanoutpos - precise vblank timestamp helper
621 * @crtc: Which CRTC's vblank timestamp to retrieve
622 * @max_error: Desired maximum allowable error in timestamps (nanosecs)
623 * On return contains true maximum error of timestamp
624 * @vblank_time: Pointer to struct timeval which should receive the timestamp
625 * @flags: Flags to pass to driver:
627 * DRM_CALLED_FROM_VBLIRQ = If function is called from vbl IRQ handler
628 * @refcrtc: CRTC which defines scanout timing
629 * @mode: mode which defines the scanout timings
631 * Implements calculation of exact vblank timestamps from given drm_display_mode
632 * timings and current video scanout position of a CRTC. This can be called from
633 * within get_vblank_timestamp() implementation of a kms driver to implement the
634 * actual timestamping.
636 * Should return timestamps conforming to the OML_sync_control OpenML
637 * extension specification. The timestamp corresponds to the end of
638 * the vblank interval, aka start of scanout of topmost-leftmost display
639 * pixel in the following video frame.
641 * Requires support for optional dev->driver->get_scanout_position()
642 * in kms driver, plus a bit of setup code to provide a drm_display_mode
643 * that corresponds to the true scanout timing.
645 * The current implementation only handles standard video modes. It
646 * returns as no operation if a doublescan or interlaced video mode is
647 * active. Higher level code is expected to handle this.
650 * Negative value on error, failure or if not supported in current
653 * -EINVAL - Invalid CRTC.
654 * -EAGAIN - Temporary unavailable, e.g., called before initial modeset.
655 * -ENOTSUPP - Function not supported in current display mode.
656 * -EIO - Failed, e.g., due to failed scanout position query.
658 * Returns or'ed positive status flags on success:
660 * DRM_VBLANKTIME_SCANOUTPOS_METHOD - Signal this method used for timestamping.
661 * DRM_VBLANKTIME_INVBL - Timestamp taken while scanout was in vblank interval.
664 int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev, int crtc,
666 struct timeval *vblank_time,
668 const struct drm_crtc *refcrtc,
669 const struct drm_display_mode *mode)
671 struct timeval tv_etime;
672 ktime_t stime, etime;
675 int framedur_ns, linedur_ns, pixeldur_ns, delta_ns, duration_ns;
678 if (crtc < 0 || crtc >= dev->num_crtcs) {
679 DRM_ERROR("Invalid crtc %d\n", crtc);
683 /* Scanout position query not supported? Should not happen. */
684 if (!dev->driver->get_scanout_position) {
685 DRM_ERROR("Called from driver w/o get_scanout_position()!?\n");
689 /* Durations of frames, lines, pixels in nanoseconds. */
690 framedur_ns = refcrtc->framedur_ns;
691 linedur_ns = refcrtc->linedur_ns;
692 pixeldur_ns = refcrtc->pixeldur_ns;
694 /* If mode timing undefined, just return as no-op:
695 * Happens during initial modesetting of a crtc.
697 if (framedur_ns == 0) {
698 DRM_DEBUG("crtc %d: Noop due to uninitialized mode.\n", crtc);
702 /* Get current scanout position with system timestamp.
703 * Repeat query up to DRM_TIMESTAMP_MAXRETRIES times
704 * if single query takes longer than max_error nanoseconds.
706 * This guarantees a tight bound on maximum error if
707 * code gets preempted or delayed for some reason.
709 for (i = 0; i < DRM_TIMESTAMP_MAXRETRIES; i++) {
711 * Get vertical and horizontal scanout position vpos, hpos,
712 * and bounding timestamps stime, etime, pre/post query.
714 vbl_status = dev->driver->get_scanout_position(dev, crtc, flags, &vpos,
715 &hpos, &stime, &etime);
717 /* Return as no-op if scanout query unsupported or failed. */
718 if (!(vbl_status & DRM_SCANOUTPOS_VALID)) {
719 DRM_DEBUG("crtc %d : scanoutpos query failed [%d].\n",
724 /* Compute uncertainty in timestamp of scanout position query. */
725 duration_ns = ktime_to_ns(etime) - ktime_to_ns(stime);
727 /* Accept result with < max_error nsecs timing uncertainty. */
728 if (duration_ns <= *max_error)
732 /* Noisy system timing? */
733 if (i == DRM_TIMESTAMP_MAXRETRIES) {
734 DRM_DEBUG("crtc %d: Noisy timestamp %d us > %d us [%d reps].\n",
735 crtc, duration_ns/1000, *max_error/1000, i);
738 /* Return upper bound of timestamp precision error. */
739 *max_error = duration_ns;
741 /* Check if in vblank area:
742 * vpos is >=0 in video scanout area, but negative
743 * within vblank area, counting down the number of lines until
746 invbl = vbl_status & DRM_SCANOUTPOS_IN_VBLANK;
748 /* Convert scanout position into elapsed time at raw_time query
749 * since start of scanout at first display scanline. delta_ns
750 * can be negative if start of scanout hasn't happened yet.
752 delta_ns = vpos * linedur_ns + hpos * pixeldur_ns;
754 if (!drm_timestamp_monotonic)
755 etime = ktime_mono_to_real(etime);
757 /* save this only for debugging purposes */
758 tv_etime = ktime_to_timeval(etime);
759 /* Subtract time delta from raw timestamp to get final
760 * vblank_time timestamp for end of vblank.
763 etime = ktime_add_ns(etime, -delta_ns);
765 etime = ktime_sub_ns(etime, delta_ns);
766 *vblank_time = ktime_to_timeval(etime);
768 DRM_DEBUG("crtc %d : v %d p(%d,%d)@ %ld.%ld -> %ld.%ld [e %d us, %d rep]\n",
769 crtc, (int)vbl_status, hpos, vpos,
770 (long)tv_etime.tv_sec, (long)tv_etime.tv_usec,
771 (long)vblank_time->tv_sec, (long)vblank_time->tv_usec,
772 duration_ns/1000, i);
774 vbl_status = DRM_VBLANKTIME_SCANOUTPOS_METHOD;
776 vbl_status |= DRM_VBLANKTIME_IN_VBLANK;
780 EXPORT_SYMBOL(drm_calc_vbltimestamp_from_scanoutpos);
782 static struct timeval get_drm_timestamp(void)
786 now = drm_timestamp_monotonic ? ktime_get() : ktime_get_real();
787 return ktime_to_timeval(now);
791 * drm_get_last_vbltimestamp - retrieve raw timestamp for the most recent
794 * @crtc: which CRTC's vblank timestamp to retrieve
795 * @tvblank: Pointer to target struct timeval which should receive the timestamp
796 * @flags: Flags to pass to driver:
798 * DRM_CALLED_FROM_VBLIRQ = If function is called from vbl IRQ handler
800 * Fetches the system timestamp corresponding to the time of the most recent
801 * vblank interval on specified CRTC. May call into kms-driver to
802 * compute the timestamp with a high-precision GPU specific method.
804 * Returns zero if timestamp originates from uncorrected do_gettimeofday()
805 * call, i.e., it isn't very precisely locked to the true vblank.
808 * True if timestamp is considered to be very precise, false otherwise.
811 drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
812 struct timeval *tvblank, unsigned flags)
816 /* Define requested maximum error on timestamps (nanoseconds). */
817 int max_error = (int) drm_timestamp_precision * 1000;
819 /* Query driver if possible and precision timestamping enabled. */
820 if (dev->driver->get_vblank_timestamp && (max_error > 0)) {
821 ret = dev->driver->get_vblank_timestamp(dev, crtc, &max_error,
827 /* GPU high precision timestamp query unsupported or failed.
828 * Return current monotonic/gettimeofday timestamp as best estimate.
830 *tvblank = get_drm_timestamp();
836 * drm_vblank_count - retrieve "cooked" vblank counter value
838 * @crtc: which counter to retrieve
840 * Fetches the "cooked" vblank count value that represents the number of
841 * vblank events since the system was booted, including lost events due to
842 * modesetting activity.
844 * This is the legacy version of drm_crtc_vblank_count().
847 * The software vblank counter.
849 u32 drm_vblank_count(struct drm_device *dev, int crtc)
851 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
853 if (WARN_ON(crtc >= dev->num_crtcs))
855 return atomic_read(&vblank->count);
857 EXPORT_SYMBOL(drm_vblank_count);
860 * drm_crtc_vblank_count - retrieve "cooked" vblank counter value
861 * @crtc: which counter to retrieve
863 * Fetches the "cooked" vblank count value that represents the number of
864 * vblank events since the system was booted, including lost events due to
865 * modesetting activity.
867 * This is the native KMS version of drm_vblank_count().
870 * The software vblank counter.
872 u32 drm_crtc_vblank_count(struct drm_crtc *crtc)
874 return drm_vblank_count(crtc->dev, drm_crtc_index(crtc));
876 EXPORT_SYMBOL(drm_crtc_vblank_count);
879 * drm_vblank_count_and_time - retrieve "cooked" vblank counter value
880 * and the system timestamp corresponding to that vblank counter value.
883 * @crtc: which counter to retrieve
884 * @vblanktime: Pointer to struct timeval to receive the vblank timestamp.
886 * Fetches the "cooked" vblank count value that represents the number of
887 * vblank events since the system was booted, including lost events due to
888 * modesetting activity. Returns corresponding system timestamp of the time
889 * of the vblank interval that corresponds to the current vblank counter value.
891 u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
892 struct timeval *vblanktime)
894 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
897 if (WARN_ON(crtc >= dev->num_crtcs))
900 /* Read timestamp from slot of _vblank_time ringbuffer
901 * that corresponds to current vblank count. Retry if
902 * count has incremented during readout. This works like
906 cur_vblank = atomic_read(&vblank->count);
907 *vblanktime = vblanktimestamp(dev, crtc, cur_vblank);
909 } while (cur_vblank != atomic_read(&vblank->count));
913 EXPORT_SYMBOL(drm_vblank_count_and_time);
915 static void send_vblank_event(struct drm_device *dev,
916 struct drm_pending_vblank_event *e,
917 unsigned long seq, struct timeval *now)
919 WARN_ON_SMP(!spin_is_locked(&dev->event_lock));
920 e->event.sequence = seq;
921 e->event.tv_sec = now->tv_sec;
922 e->event.tv_usec = now->tv_usec;
924 list_add_tail(&e->base.link,
925 &e->base.file_priv->event_list);
926 wake_up_interruptible(&e->base.file_priv->event_wait);
927 trace_drm_vblank_event_delivered(e->base.pid, e->pipe,
932 * drm_send_vblank_event - helper to send vblank event after pageflip
934 * @crtc: CRTC in question
935 * @e: the event to send
937 * Updates sequence # and timestamp on event, and sends it to userspace.
938 * Caller must hold event lock.
940 * This is the legacy version of drm_crtc_send_vblank_event().
942 void drm_send_vblank_event(struct drm_device *dev, int crtc,
943 struct drm_pending_vblank_event *e)
949 seq = drm_vblank_count_and_time(dev, crtc, &now);
953 now = get_drm_timestamp();
956 send_vblank_event(dev, e, seq, &now);
958 EXPORT_SYMBOL(drm_send_vblank_event);
961 * drm_crtc_send_vblank_event - helper to send vblank event after pageflip
962 * @crtc: the source CRTC of the vblank event
963 * @e: the event to send
965 * Updates sequence # and timestamp on event, and sends it to userspace.
966 * Caller must hold event lock.
968 * This is the native KMS version of drm_send_vblank_event().
970 void drm_crtc_send_vblank_event(struct drm_crtc *crtc,
971 struct drm_pending_vblank_event *e)
973 drm_send_vblank_event(crtc->dev, drm_crtc_index(crtc), e);
975 EXPORT_SYMBOL(drm_crtc_send_vblank_event);
978 * drm_vblank_enable - enable the vblank interrupt on a CRTC
980 * @crtc: CRTC in question
982 static int drm_vblank_enable(struct drm_device *dev, int crtc)
984 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
987 assert_spin_locked(&dev->vbl_lock);
989 spin_lock(&dev->vblank_time_lock);
991 if (!vblank->enabled) {
993 * Enable vblank irqs under vblank_time_lock protection.
994 * All vblank count & timestamp updates are held off
995 * until we are done reinitializing master counter and
996 * timestamps. Filtercode in drm_handle_vblank() will
997 * prevent double-accounting of same vblank interval.
999 ret = dev->driver->enable_vblank(dev, crtc);
1000 DRM_DEBUG("enabling vblank on crtc %d, ret: %d\n", crtc, ret);
1002 atomic_dec(&vblank->refcount);
1004 vblank->enabled = true;
1005 drm_update_vblank_count(dev, crtc);
1009 spin_unlock(&dev->vblank_time_lock);
1015 * drm_vblank_get - get a reference count on vblank events
1017 * @crtc: which CRTC to own
1019 * Acquire a reference count on vblank events to avoid having them disabled
1022 * This is the legacy version of drm_crtc_vblank_get().
1025 * Zero on success, nonzero on failure.
1027 int drm_vblank_get(struct drm_device *dev, int crtc)
1029 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
1030 unsigned long irqflags;
1033 if (WARN_ON(crtc >= dev->num_crtcs))
1036 spin_lock_irqsave(&dev->vbl_lock, irqflags);
1037 /* Going from 0->1 means we have to enable interrupts again */
1038 if (atomic_add_return(1, &vblank->refcount) == 1) {
1039 ret = drm_vblank_enable(dev, crtc);
1041 if (!vblank->enabled) {
1042 atomic_dec(&vblank->refcount);
1046 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
1050 EXPORT_SYMBOL(drm_vblank_get);
1053 * drm_crtc_vblank_get - get a reference count on vblank events
1054 * @crtc: which CRTC to own
1056 * Acquire a reference count on vblank events to avoid having them disabled
1059 * This is the native kms version of drm_vblank_get().
1062 * Zero on success, nonzero on failure.
1064 int drm_crtc_vblank_get(struct drm_crtc *crtc)
1066 return drm_vblank_get(crtc->dev, drm_crtc_index(crtc));
1068 EXPORT_SYMBOL(drm_crtc_vblank_get);
1071 * drm_vblank_put - give up ownership of vblank events
1073 * @crtc: which counter to give up
1075 * Release ownership of a given vblank counter, turning off interrupts
1076 * if possible. Disable interrupts after drm_vblank_offdelay milliseconds.
1078 * This is the legacy version of drm_crtc_vblank_put().
1080 void drm_vblank_put(struct drm_device *dev, int crtc)
1082 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
1084 if (WARN_ON(atomic_read(&vblank->refcount) == 0))
1087 if (WARN_ON(crtc >= dev->num_crtcs))
1090 /* Last user schedules interrupt disable */
1091 if (atomic_dec_and_test(&vblank->refcount)) {
1092 if (drm_vblank_offdelay == 0)
1094 else if (dev->vblank_disable_immediate || drm_vblank_offdelay < 0)
1095 vblank_disable_fn((unsigned long)vblank);
1097 mod_timer(&vblank->disable_timer,
1098 jiffies + ((drm_vblank_offdelay * HZ)/1000));
1101 EXPORT_SYMBOL(drm_vblank_put);
1104 * drm_crtc_vblank_put - give up ownership of vblank events
1105 * @crtc: which counter to give up
1107 * Release ownership of a given vblank counter, turning off interrupts
1108 * if possible. Disable interrupts after drm_vblank_offdelay milliseconds.
1110 * This is the native kms version of drm_vblank_put().
1112 void drm_crtc_vblank_put(struct drm_crtc *crtc)
1114 drm_vblank_put(crtc->dev, drm_crtc_index(crtc));
1116 EXPORT_SYMBOL(drm_crtc_vblank_put);
1119 * drm_wait_one_vblank - wait for one vblank
1123 * This waits for one vblank to pass on @crtc, using the irq driver interfaces.
1124 * It is a failure to call this when the vblank irq for @crtc is disabled, e.g.
1125 * due to lack of driver support or because the crtc is off.
1127 void drm_wait_one_vblank(struct drm_device *dev, int crtc)
1132 ret = drm_vblank_get(dev, crtc);
1133 if (WARN(ret, "vblank not available on crtc %i, ret=%i\n", crtc, ret))
1136 last = drm_vblank_count(dev, crtc);
1138 ret = wait_event_timeout(dev->vblank[crtc].queue,
1139 last != drm_vblank_count(dev, crtc),
1140 msecs_to_jiffies(100));
1142 WARN(ret == 0, "vblank wait timed out on crtc %i\n", crtc);
1144 drm_vblank_put(dev, crtc);
1146 EXPORT_SYMBOL(drm_wait_one_vblank);
1149 * drm_crtc_wait_one_vblank - wait for one vblank
1152 * This waits for one vblank to pass on @crtc, using the irq driver interfaces.
1153 * It is a failure to call this when the vblank irq for @crtc is disabled, e.g.
1154 * due to lack of driver support or because the crtc is off.
1156 void drm_crtc_wait_one_vblank(struct drm_crtc *crtc)
1158 drm_wait_one_vblank(crtc->dev, drm_crtc_index(crtc));
1160 EXPORT_SYMBOL(drm_crtc_wait_one_vblank);
1163 * drm_vblank_off - disable vblank events on a CRTC
1165 * @crtc: CRTC in question
1167 * Drivers can use this function to shut down the vblank interrupt handling when
1168 * disabling a crtc. This function ensures that the latest vblank frame count is
1169 * stored so that drm_vblank_on() can restore it again.
1171 * Drivers must use this function when the hardware vblank counter can get
1172 * reset, e.g. when suspending.
1174 * This is the legacy version of drm_crtc_vblank_off().
1176 void drm_vblank_off(struct drm_device *dev, int crtc)
1178 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
1179 struct drm_pending_vblank_event *e, *t;
1181 unsigned long irqflags;
1184 if (WARN_ON(crtc >= dev->num_crtcs))
1187 spin_lock_irqsave(&dev->event_lock, irqflags);
1189 spin_lock(&dev->vbl_lock);
1190 vblank_disable_and_save(dev, crtc);
1191 wake_up(&vblank->queue);
1194 * Prevent subsequent drm_vblank_get() from re-enabling
1195 * the vblank interrupt by bumping the refcount.
1197 if (!vblank->inmodeset) {
1198 atomic_inc(&vblank->refcount);
1199 vblank->inmodeset = 1;
1201 spin_unlock(&dev->vbl_lock);
1203 /* Send any queued vblank events, lest the natives grow disquiet */
1204 seq = drm_vblank_count_and_time(dev, crtc, &now);
1206 list_for_each_entry_safe(e, t, &dev->vblank_event_list, base.link) {
1207 if (e->pipe != crtc)
1209 DRM_DEBUG("Sending premature vblank event on disable: \
1210 wanted %d, current %d\n",
1211 e->event.sequence, seq);
1212 list_del(&e->base.link);
1213 drm_vblank_put(dev, e->pipe);
1214 send_vblank_event(dev, e, seq, &now);
1216 spin_unlock_irqrestore(&dev->event_lock, irqflags);
1218 EXPORT_SYMBOL(drm_vblank_off);
1221 * drm_crtc_vblank_off - disable vblank events on a CRTC
1222 * @crtc: CRTC in question
1224 * Drivers can use this function to shut down the vblank interrupt handling when
1225 * disabling a crtc. This function ensures that the latest vblank frame count is
1226 * stored so that drm_vblank_on can restore it again.
1228 * Drivers must use this function when the hardware vblank counter can get
1229 * reset, e.g. when suspending.
1231 * This is the native kms version of drm_vblank_off().
1233 void drm_crtc_vblank_off(struct drm_crtc *crtc)
1235 drm_vblank_off(crtc->dev, drm_crtc_index(crtc));
1237 EXPORT_SYMBOL(drm_crtc_vblank_off);
1240 * drm_crtc_vblank_reset - reset vblank state to off on a CRTC
1241 * @crtc: CRTC in question
1243 * Drivers can use this function to reset the vblank state to off at load time.
1244 * Drivers should use this together with the drm_crtc_vblank_off() and
1245 * drm_crtc_vblank_on() functions. The difference compared to
1246 * drm_crtc_vblank_off() is that this function doesn't save the vblank counter
1247 * and hence doesn't need to call any driver hooks.
1249 void drm_crtc_vblank_reset(struct drm_crtc *drm_crtc)
1251 struct drm_device *dev = drm_crtc->dev;
1252 unsigned long irqflags;
1253 int crtc = drm_crtc_index(drm_crtc);
1254 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
1256 spin_lock_irqsave(&dev->vbl_lock, irqflags);
1258 * Prevent subsequent drm_vblank_get() from enabling the vblank
1259 * interrupt by bumping the refcount.
1261 if (!vblank->inmodeset) {
1262 atomic_inc(&vblank->refcount);
1263 vblank->inmodeset = 1;
1265 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
1267 WARN_ON(!list_empty(&dev->vblank_event_list));
1269 EXPORT_SYMBOL(drm_crtc_vblank_reset);
1272 * drm_vblank_on - enable vblank events on a CRTC
1274 * @crtc: CRTC in question
1276 * This functions restores the vblank interrupt state captured with
1277 * drm_vblank_off() again. Note that calls to drm_vblank_on() and
1278 * drm_vblank_off() can be unbalanced and so can also be unconditionally called
1279 * in driver load code to reflect the current hardware state of the crtc.
1281 * This is the legacy version of drm_crtc_vblank_on().
1283 void drm_vblank_on(struct drm_device *dev, int crtc)
1285 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
1286 unsigned long irqflags;
1288 if (WARN_ON(crtc >= dev->num_crtcs))
1291 spin_lock_irqsave(&dev->vbl_lock, irqflags);
1292 /* Drop our private "prevent drm_vblank_get" refcount */
1293 if (vblank->inmodeset) {
1294 atomic_dec(&vblank->refcount);
1295 vblank->inmodeset = 0;
1299 * sample the current counter to avoid random jumps
1300 * when drm_vblank_enable() applies the diff
1302 * -1 to make sure user will never see the same
1303 * vblank counter value before and after a modeset
1306 (dev->driver->get_vblank_counter(dev, crtc) - 1) &
1307 dev->max_vblank_count;
1309 * re-enable interrupts if there are users left, or the
1310 * user wishes vblank interrupts to be enabled all the time.
1312 if (atomic_read(&vblank->refcount) != 0 ||
1313 (!dev->vblank_disable_immediate && drm_vblank_offdelay == 0))
1314 WARN_ON(drm_vblank_enable(dev, crtc));
1315 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
1317 EXPORT_SYMBOL(drm_vblank_on);
1320 * drm_crtc_vblank_on - enable vblank events on a CRTC
1321 * @crtc: CRTC in question
1323 * This functions restores the vblank interrupt state captured with
1324 * drm_vblank_off() again. Note that calls to drm_vblank_on() and
1325 * drm_vblank_off() can be unbalanced and so can also be unconditionally called
1326 * in driver load code to reflect the current hardware state of the crtc.
1328 * This is the native kms version of drm_vblank_on().
1330 void drm_crtc_vblank_on(struct drm_crtc *crtc)
1332 drm_vblank_on(crtc->dev, drm_crtc_index(crtc));
1334 EXPORT_SYMBOL(drm_crtc_vblank_on);
1337 * drm_vblank_pre_modeset - account for vblanks across mode sets
1339 * @crtc: CRTC in question
1341 * Account for vblank events across mode setting events, which will likely
1342 * reset the hardware frame counter.
1344 * This is done by grabbing a temporary vblank reference to ensure that the
1345 * vblank interrupt keeps running across the modeset sequence. With this the
1346 * software-side vblank frame counting will ensure that there are no jumps or
1349 * Unfortunately this approach is racy and also doesn't work when the vblank
1350 * interrupt stops running, e.g. across system suspend resume. It is therefore
1351 * highly recommended that drivers use the newer drm_vblank_off() and
1352 * drm_vblank_on() instead. drm_vblank_pre_modeset() only works correctly when
1353 * using "cooked" software vblank frame counters and not relying on any hardware
1356 * Drivers must call drm_vblank_post_modeset() when re-enabling the same crtc
1359 void drm_vblank_pre_modeset(struct drm_device *dev, int crtc)
1361 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
1363 /* vblank is not initialized (IRQ not installed ?), or has been freed */
1364 if (!dev->num_crtcs)
1367 if (WARN_ON(crtc >= dev->num_crtcs))
1371 * To avoid all the problems that might happen if interrupts
1372 * were enabled/disabled around or between these calls, we just
1373 * have the kernel take a reference on the CRTC (just once though
1374 * to avoid corrupting the count if multiple, mismatch calls occur),
1375 * so that interrupts remain enabled in the interim.
1377 if (!vblank->inmodeset) {
1378 vblank->inmodeset = 0x1;
1379 if (drm_vblank_get(dev, crtc) == 0)
1380 vblank->inmodeset |= 0x2;
1383 EXPORT_SYMBOL(drm_vblank_pre_modeset);
1386 * drm_vblank_post_modeset - undo drm_vblank_pre_modeset changes
1388 * @crtc: CRTC in question
1390 * This function again drops the temporary vblank reference acquired in
1391 * drm_vblank_pre_modeset.
1393 void drm_vblank_post_modeset(struct drm_device *dev, int crtc)
1395 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
1396 unsigned long irqflags;
1398 /* vblank is not initialized (IRQ not installed ?), or has been freed */
1399 if (!dev->num_crtcs)
1402 if (vblank->inmodeset) {
1403 spin_lock_irqsave(&dev->vbl_lock, irqflags);
1404 dev->vblank_disable_allowed = true;
1405 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
1407 if (vblank->inmodeset & 0x2)
1408 drm_vblank_put(dev, crtc);
1410 vblank->inmodeset = 0;
1413 EXPORT_SYMBOL(drm_vblank_post_modeset);
1416 * drm_modeset_ctl - handle vblank event counter changes across mode switch
1417 * @DRM_IOCTL_ARGS: standard ioctl arguments
1419 * Applications should call the %_DRM_PRE_MODESET and %_DRM_POST_MODESET
1420 * ioctls around modesetting so that any lost vblank events are accounted for.
1422 * Generally the counter will reset across mode sets. If interrupts are
1423 * enabled around this call, we don't have to do anything since the counter
1424 * will have already been incremented.
1426 int drm_modeset_ctl(struct drm_device *dev, void *data,
1427 struct drm_file *file_priv)
1429 struct drm_modeset_ctl *modeset = data;
1432 /* If drm_vblank_init() hasn't been called yet, just no-op */
1433 if (!dev->num_crtcs)
1436 /* KMS drivers handle this internally */
1437 if (drm_core_check_feature(dev, DRIVER_MODESET))
1440 crtc = modeset->crtc;
1441 if (crtc >= dev->num_crtcs)
1444 switch (modeset->cmd) {
1445 case _DRM_PRE_MODESET:
1446 drm_vblank_pre_modeset(dev, crtc);
1448 case _DRM_POST_MODESET:
1449 drm_vblank_post_modeset(dev, crtc);
1458 static int drm_queue_vblank_event(struct drm_device *dev, int pipe,
1459 union drm_wait_vblank *vblwait,
1460 struct drm_file *file_priv)
1462 struct drm_vblank_crtc *vblank = &dev->vblank[pipe];
1463 struct drm_pending_vblank_event *e;
1465 unsigned long flags;
1469 e = kzalloc(sizeof(*e), GFP_KERNEL);
1476 e->base.pid = current->pid;
1477 e->event.base.type = DRM_EVENT_VBLANK;
1478 e->event.base.length = sizeof(e->event);
1479 e->event.user_data = vblwait->request.signal;
1480 e->base.event = &e->event.base;
1481 e->base.file_priv = file_priv;
1482 e->base.destroy = (void (*) (struct drm_pending_event *)) kfree;
1484 spin_lock_irqsave(&dev->event_lock, flags);
1487 * drm_vblank_off() might have been called after we called
1488 * drm_vblank_get(). drm_vblank_off() holds event_lock
1489 * around the vblank disable, so no need for further locking.
1490 * The reference from drm_vblank_get() protects against
1491 * vblank disable from another source.
1493 if (!vblank->enabled) {
1498 if (file_priv->event_space < sizeof(e->event)) {
1503 file_priv->event_space -= sizeof(e->event);
1504 seq = drm_vblank_count_and_time(dev, pipe, &now);
1506 if ((vblwait->request.type & _DRM_VBLANK_NEXTONMISS) &&
1507 (seq - vblwait->request.sequence) <= (1 << 23)) {
1508 vblwait->request.sequence = seq + 1;
1509 vblwait->reply.sequence = vblwait->request.sequence;
1512 DRM_DEBUG("event on vblank count %d, current %d, crtc %d\n",
1513 vblwait->request.sequence, seq, pipe);
1515 trace_drm_vblank_event_queued(current->pid, pipe,
1516 vblwait->request.sequence);
1518 e->event.sequence = vblwait->request.sequence;
1519 if ((seq - vblwait->request.sequence) <= (1 << 23)) {
1520 drm_vblank_put(dev, pipe);
1521 send_vblank_event(dev, e, seq, &now);
1522 vblwait->reply.sequence = seq;
1524 /* drm_handle_vblank_events will call drm_vblank_put */
1525 list_add_tail(&e->base.link, &dev->vblank_event_list);
1526 vblwait->reply.sequence = vblwait->request.sequence;
1529 spin_unlock_irqrestore(&dev->event_lock, flags);
1534 spin_unlock_irqrestore(&dev->event_lock, flags);
1537 drm_vblank_put(dev, pipe);
1544 * \param inode device inode.
1545 * \param file_priv DRM file private.
1546 * \param cmd command.
1547 * \param data user argument, pointing to a drm_wait_vblank structure.
1548 * \return zero on success or a negative number on failure.
1550 * This function enables the vblank interrupt on the pipe requested, then
1551 * sleeps waiting for the requested sequence number to occur, and drops
1552 * the vblank interrupt refcount afterwards. (vblank IRQ disable follows that
1553 * after a timeout with no further vblank waits scheduled).
1555 int drm_wait_vblank(struct drm_device *dev, void *data,
1556 struct drm_file *file_priv)
1558 struct drm_vblank_crtc *vblank;
1559 union drm_wait_vblank *vblwait = data;
1561 unsigned int flags, seq, crtc, high_crtc;
1563 if (!dev->irq_enabled)
1566 if (vblwait->request.type & _DRM_VBLANK_SIGNAL)
1569 if (vblwait->request.type &
1570 ~(_DRM_VBLANK_TYPES_MASK | _DRM_VBLANK_FLAGS_MASK |
1571 _DRM_VBLANK_HIGH_CRTC_MASK)) {
1572 DRM_ERROR("Unsupported type value 0x%x, supported mask 0x%x\n",
1573 vblwait->request.type,
1574 (_DRM_VBLANK_TYPES_MASK | _DRM_VBLANK_FLAGS_MASK |
1575 _DRM_VBLANK_HIGH_CRTC_MASK));
1579 flags = vblwait->request.type & _DRM_VBLANK_FLAGS_MASK;
1580 high_crtc = (vblwait->request.type & _DRM_VBLANK_HIGH_CRTC_MASK);
1582 crtc = high_crtc >> _DRM_VBLANK_HIGH_CRTC_SHIFT;
1584 crtc = flags & _DRM_VBLANK_SECONDARY ? 1 : 0;
1585 if (crtc >= dev->num_crtcs)
1588 vblank = &dev->vblank[crtc];
1590 ret = drm_vblank_get(dev, crtc);
1592 DRM_DEBUG("failed to acquire vblank counter, %d\n", ret);
1595 seq = drm_vblank_count(dev, crtc);
1597 switch (vblwait->request.type & _DRM_VBLANK_TYPES_MASK) {
1598 case _DRM_VBLANK_RELATIVE:
1599 vblwait->request.sequence += seq;
1600 vblwait->request.type &= ~_DRM_VBLANK_RELATIVE;
1601 case _DRM_VBLANK_ABSOLUTE:
1608 if (flags & _DRM_VBLANK_EVENT) {
1609 /* must hold on to the vblank ref until the event fires
1610 * drm_vblank_put will be called asynchronously
1612 return drm_queue_vblank_event(dev, crtc, vblwait, file_priv);
1615 if ((flags & _DRM_VBLANK_NEXTONMISS) &&
1616 (seq - vblwait->request.sequence) <= (1<<23)) {
1617 vblwait->request.sequence = seq + 1;
1620 DRM_DEBUG("waiting on vblank count %d, crtc %d\n",
1621 vblwait->request.sequence, crtc);
1622 vblank->last_wait = vblwait->request.sequence;
1623 DRM_WAIT_ON(ret, vblank->queue, 3 * HZ,
1624 (((drm_vblank_count(dev, crtc) -
1625 vblwait->request.sequence) <= (1 << 23)) ||
1627 !dev->irq_enabled));
1629 if (ret != -EINTR) {
1632 vblwait->reply.sequence = drm_vblank_count_and_time(dev, crtc, &now);
1633 vblwait->reply.tval_sec = now.tv_sec;
1634 vblwait->reply.tval_usec = now.tv_usec;
1636 DRM_DEBUG("returning %d to client\n",
1637 vblwait->reply.sequence);
1639 DRM_DEBUG("vblank wait interrupted by signal\n");
1643 drm_vblank_put(dev, crtc);
1647 static void drm_handle_vblank_events(struct drm_device *dev, int crtc)
1649 struct drm_pending_vblank_event *e, *t;
1653 assert_spin_locked(&dev->event_lock);
1655 seq = drm_vblank_count_and_time(dev, crtc, &now);
1657 list_for_each_entry_safe(e, t, &dev->vblank_event_list, base.link) {
1658 if (e->pipe != crtc)
1660 if ((seq - e->event.sequence) > (1<<23))
1663 DRM_DEBUG("vblank event on %d, current %d\n",
1664 e->event.sequence, seq);
1666 list_del(&e->base.link);
1667 drm_vblank_put(dev, e->pipe);
1668 send_vblank_event(dev, e, seq, &now);
1671 trace_drm_vblank_event(crtc, seq);
1675 * drm_handle_vblank - handle a vblank event
1677 * @crtc: where this event occurred
1679 * Drivers should call this routine in their vblank interrupt handlers to
1680 * update the vblank counter and send any signals that may be pending.
1682 * This is the legacy version of drm_crtc_handle_vblank().
1684 bool drm_handle_vblank(struct drm_device *dev, int crtc)
1686 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
1689 struct timeval tvblank;
1690 unsigned long irqflags;
1692 if (WARN_ON_ONCE(!dev->num_crtcs))
1695 if (WARN_ON(crtc >= dev->num_crtcs))
1698 spin_lock_irqsave(&dev->event_lock, irqflags);
1700 /* Need timestamp lock to prevent concurrent execution with
1701 * vblank enable/disable, as this would cause inconsistent
1702 * or corrupted timestamps and vblank counts.
1704 spin_lock(&dev->vblank_time_lock);
1706 /* Vblank irq handling disabled. Nothing to do. */
1707 if (!vblank->enabled) {
1708 spin_unlock(&dev->vblank_time_lock);
1709 spin_unlock_irqrestore(&dev->event_lock, irqflags);
1713 /* Fetch corresponding timestamp for this vblank interval from
1714 * driver and store it in proper slot of timestamp ringbuffer.
1717 /* Get current timestamp and count. */
1718 vblcount = atomic_read(&vblank->count);
1719 drm_get_last_vbltimestamp(dev, crtc, &tvblank, DRM_CALLED_FROM_VBLIRQ);
1721 /* Compute time difference to timestamp of last vblank */
1722 diff_ns = timeval_to_ns(&tvblank) -
1723 timeval_to_ns(&vblanktimestamp(dev, crtc, vblcount));
1725 /* Update vblank timestamp and count if at least
1726 * DRM_REDUNDANT_VBLIRQ_THRESH_NS nanoseconds
1727 * difference between last stored timestamp and current
1728 * timestamp. A smaller difference means basically
1729 * identical timestamps. Happens if this vblank has
1730 * been already processed and this is a redundant call,
1731 * e.g., due to spurious vblank interrupts. We need to
1732 * ignore those for accounting.
1734 if (abs64(diff_ns) > DRM_REDUNDANT_VBLIRQ_THRESH_NS) {
1735 /* Store new timestamp in ringbuffer. */
1736 vblanktimestamp(dev, crtc, vblcount + 1) = tvblank;
1738 /* Increment cooked vblank count. This also atomically commits
1739 * the timestamp computed above.
1741 smp_mb__before_atomic();
1742 atomic_inc(&vblank->count);
1743 smp_mb__after_atomic();
1745 DRM_DEBUG("crtc %d: Redundant vblirq ignored. diff_ns = %d\n",
1746 crtc, (int) diff_ns);
1749 spin_unlock(&dev->vblank_time_lock);
1751 wake_up(&vblank->queue);
1752 drm_handle_vblank_events(dev, crtc);
1754 spin_unlock_irqrestore(&dev->event_lock, irqflags);
1758 EXPORT_SYMBOL(drm_handle_vblank);
1761 * drm_crtc_handle_vblank - handle a vblank event
1762 * @crtc: where this event occurred
1764 * Drivers should call this routine in their vblank interrupt handlers to
1765 * update the vblank counter and send any signals that may be pending.
1767 * This is the native KMS version of drm_handle_vblank().
1770 * True if the event was successfully handled, false on failure.
1772 bool drm_crtc_handle_vblank(struct drm_crtc *crtc)
1774 return drm_handle_vblank(crtc->dev, drm_crtc_index(crtc));
1776 EXPORT_SYMBOL(drm_crtc_handle_vblank);