Loading...
1/*
2 * drm_irq.c IRQ and vblank support
3 *
4 * \author Rickard E. (Rik) Faith <faith@valinux.com>
5 * \author Gareth Hughes <gareth@valinux.com>
6 */
7
8/*
9 * Created: Fri Mar 19 14:30:16 1999 by faith@valinux.com
10 *
11 * Copyright 1999, 2000 Precision Insight, Inc., Cedar Park, Texas.
12 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
13 * All Rights Reserved.
14 *
15 * Permission is hereby granted, free of charge, to any person obtaining a
16 * copy of this software and associated documentation files (the "Software"),
17 * to deal in the Software without restriction, including without limitation
18 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
19 * and/or sell copies of the Software, and to permit persons to whom the
20 * Software is furnished to do so, subject to the following conditions:
21 *
22 * The above copyright notice and this permission notice (including the next
23 * paragraph) shall be included in all copies or substantial portions of the
24 * Software.
25 *
26 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
27 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
28 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
29 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
30 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
31 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
32 * OTHER DEALINGS IN THE SOFTWARE.
33 */
34
35#include <drm/drmP.h>
36#include "drm_trace.h"
37#include "drm_internal.h"
38
39#include <linux/interrupt.h> /* For task queue support */
40#include <linux/slab.h>
41
42#include <linux/vgaarb.h>
43#include <linux/export.h>
44
45/* Retry timestamp calculation up to 3 times to satisfy
46 * drm_timestamp_precision before giving up.
47 */
48#define DRM_TIMESTAMP_MAXRETRIES 3
49
50/* Threshold in nanoseconds for detection of redundant
51 * vblank irq in drm_handle_vblank(). 1 msec should be ok.
52 */
53#define DRM_REDUNDANT_VBLIRQ_THRESH_NS 1000000
54
55static bool
56drm_get_last_vbltimestamp(struct drm_device *dev, unsigned int pipe,
57 struct timeval *tvblank, unsigned flags);
58
59static unsigned int drm_timestamp_precision = 20; /* Default to 20 usecs. */
60
61/*
62 * Default to use monotonic timestamps for wait-for-vblank and page-flip
63 * complete events.
64 */
65unsigned int drm_timestamp_monotonic = 1;
66
67static int drm_vblank_offdelay = 5000; /* Default to 5000 msecs. */
68
69module_param_named(vblankoffdelay, drm_vblank_offdelay, int, 0600);
70module_param_named(timestamp_precision_usec, drm_timestamp_precision, int, 0600);
71module_param_named(timestamp_monotonic, drm_timestamp_monotonic, int, 0600);
72MODULE_PARM_DESC(vblankoffdelay, "Delay until vblank irq auto-disable [msecs] (0: never disable, <0: disable immediately)");
73MODULE_PARM_DESC(timestamp_precision_usec, "Max. error on timestamps [usecs]");
74MODULE_PARM_DESC(timestamp_monotonic, "Use monotonic timestamps");
75
76static void store_vblank(struct drm_device *dev, unsigned int pipe,
77 u32 vblank_count_inc,
78 struct timeval *t_vblank, u32 last)
79{
80 struct drm_vblank_crtc *vblank = &dev->vblank[pipe];
81
82 assert_spin_locked(&dev->vblank_time_lock);
83
84 vblank->last = last;
85
86 write_seqlock(&vblank->seqlock);
87 vblank->time = *t_vblank;
88 vblank->count += vblank_count_inc;
89 write_sequnlock(&vblank->seqlock);
90}
91
92/*
93 * Reset the stored timestamp for the current vblank count to correspond
94 * to the last vblank occurred.
95 *
96 * Only to be called from drm_crtc_vblank_on().
97 *
98 * Note: caller must hold dev->vbl_lock since this reads & writes
99 * device vblank fields.
100 */
101static void drm_reset_vblank_timestamp(struct drm_device *dev, unsigned int pipe)
102{
103 u32 cur_vblank;
104 bool rc;
105 struct timeval t_vblank;
106 int count = DRM_TIMESTAMP_MAXRETRIES;
107
108 spin_lock(&dev->vblank_time_lock);
109
110 /*
111 * sample the current counter to avoid random jumps
112 * when drm_vblank_enable() applies the diff
113 */
114 do {
115 cur_vblank = dev->driver->get_vblank_counter(dev, pipe);
116 rc = drm_get_last_vbltimestamp(dev, pipe, &t_vblank, 0);
117 } while (cur_vblank != dev->driver->get_vblank_counter(dev, pipe) && --count > 0);
118
119 /*
120 * Only reinitialize corresponding vblank timestamp if high-precision query
121 * available and didn't fail. Otherwise reinitialize delayed at next vblank
122 * interrupt and assign 0 for now, to mark the vblanktimestamp as invalid.
123 */
124 if (!rc)
125 t_vblank = (struct timeval) {0, 0};
126
127 /*
128 * +1 to make sure user will never see the same
129 * vblank counter value before and after a modeset
130 */
131 store_vblank(dev, pipe, 1, &t_vblank, cur_vblank);
132
133 spin_unlock(&dev->vblank_time_lock);
134}
135
136/*
137 * Call back into the driver to update the appropriate vblank counter
138 * (specified by @pipe). Deal with wraparound, if it occurred, and
139 * update the last read value so we can deal with wraparound on the next
140 * call if necessary.
141 *
142 * Only necessary when going from off->on, to account for frames we
143 * didn't get an interrupt for.
144 *
145 * Note: caller must hold dev->vbl_lock since this reads & writes
146 * device vblank fields.
147 */
148static void drm_update_vblank_count(struct drm_device *dev, unsigned int pipe,
149 unsigned long flags)
150{
151 struct drm_vblank_crtc *vblank = &dev->vblank[pipe];
152 u32 cur_vblank, diff;
153 bool rc;
154 struct timeval t_vblank;
155 int count = DRM_TIMESTAMP_MAXRETRIES;
156 int framedur_ns = vblank->framedur_ns;
157
158 /*
159 * Interrupts were disabled prior to this call, so deal with counter
160 * wrap if needed.
161 * NOTE! It's possible we lost a full dev->max_vblank_count + 1 events
162 * here if the register is small or we had vblank interrupts off for
163 * a long time.
164 *
165 * We repeat the hardware vblank counter & timestamp query until
166 * we get consistent results. This to prevent races between gpu
167 * updating its hardware counter while we are retrieving the
168 * corresponding vblank timestamp.
169 */
170 do {
171 cur_vblank = dev->driver->get_vblank_counter(dev, pipe);
172 rc = drm_get_last_vbltimestamp(dev, pipe, &t_vblank, flags);
173 } while (cur_vblank != dev->driver->get_vblank_counter(dev, pipe) && --count > 0);
174
175 if (dev->max_vblank_count != 0) {
176 /* trust the hw counter when it's around */
177 diff = (cur_vblank - vblank->last) & dev->max_vblank_count;
178 } else if (rc && framedur_ns) {
179 const struct timeval *t_old;
180 u64 diff_ns;
181
182 t_old = &vblank->time;
183 diff_ns = timeval_to_ns(&t_vblank) - timeval_to_ns(t_old);
184
185 /*
186 * Figure out how many vblanks we've missed based
187 * on the difference in the timestamps and the
188 * frame/field duration.
189 */
190 diff = DIV_ROUND_CLOSEST_ULL(diff_ns, framedur_ns);
191
192 if (diff == 0 && flags & DRM_CALLED_FROM_VBLIRQ)
193 DRM_DEBUG_VBL("crtc %u: Redundant vblirq ignored."
194 " diff_ns = %lld, framedur_ns = %d)\n",
195 pipe, (long long) diff_ns, framedur_ns);
196 } else {
197 /* some kind of default for drivers w/o accurate vbl timestamping */
198 diff = (flags & DRM_CALLED_FROM_VBLIRQ) != 0;
199 }
200
201 /*
202 * Within a drm_vblank_pre_modeset - drm_vblank_post_modeset
203 * interval? If so then vblank irqs keep running and it will likely
204 * happen that the hardware vblank counter is not trustworthy as it
205 * might reset at some point in that interval and vblank timestamps
206 * are not trustworthy either in that interval. Iow. this can result
207 * in a bogus diff >> 1 which must be avoided as it would cause
208 * random large forward jumps of the software vblank counter.
209 */
210 if (diff > 1 && (vblank->inmodeset & 0x2)) {
211 DRM_DEBUG_VBL("clamping vblank bump to 1 on crtc %u: diffr=%u"
212 " due to pre-modeset.\n", pipe, diff);
213 diff = 1;
214 }
215
216 DRM_DEBUG_VBL("updating vblank count on crtc %u:"
217 " current=%u, diff=%u, hw=%u hw_last=%u\n",
218 pipe, vblank->count, diff, cur_vblank, vblank->last);
219
220 if (diff == 0) {
221 WARN_ON_ONCE(cur_vblank != vblank->last);
222 return;
223 }
224
225 /*
226 * Only reinitialize corresponding vblank timestamp if high-precision query
227 * available and didn't fail, or we were called from the vblank interrupt.
228 * Otherwise reinitialize delayed at next vblank interrupt and assign 0
229 * for now, to mark the vblanktimestamp as invalid.
230 */
231 if (!rc && (flags & DRM_CALLED_FROM_VBLIRQ) == 0)
232 t_vblank = (struct timeval) {0, 0};
233
234 store_vblank(dev, pipe, diff, &t_vblank, cur_vblank);
235}
236
237static u32 drm_vblank_count(struct drm_device *dev, unsigned int pipe)
238{
239 struct drm_vblank_crtc *vblank = &dev->vblank[pipe];
240
241 if (WARN_ON(pipe >= dev->num_crtcs))
242 return 0;
243
244 return vblank->count;
245}
246
247/**
248 * drm_accurate_vblank_count - retrieve the master vblank counter
249 * @crtc: which counter to retrieve
250 *
251 * This function is similar to @drm_crtc_vblank_count but this
252 * function interpolates to handle a race with vblank irq's.
253 *
254 * This is mostly useful for hardware that can obtain the scanout
255 * position, but doesn't have a frame counter.
256 */
257u32 drm_accurate_vblank_count(struct drm_crtc *crtc)
258{
259 struct drm_device *dev = crtc->dev;
260 unsigned int pipe = drm_crtc_index(crtc);
261 u32 vblank;
262 unsigned long flags;
263
264 WARN(!dev->driver->get_vblank_timestamp,
265 "This function requires support for accurate vblank timestamps.");
266
267 spin_lock_irqsave(&dev->vblank_time_lock, flags);
268
269 drm_update_vblank_count(dev, pipe, 0);
270 vblank = drm_vblank_count(dev, pipe);
271
272 spin_unlock_irqrestore(&dev->vblank_time_lock, flags);
273
274 return vblank;
275}
276EXPORT_SYMBOL(drm_accurate_vblank_count);
277
278/*
279 * Disable vblank irq's on crtc, make sure that last vblank count
280 * of hardware and corresponding consistent software vblank counter
281 * are preserved, even if there are any spurious vblank irq's after
282 * disable.
283 */
284static void vblank_disable_and_save(struct drm_device *dev, unsigned int pipe)
285{
286 struct drm_vblank_crtc *vblank = &dev->vblank[pipe];
287 unsigned long irqflags;
288
289 /* Prevent vblank irq processing while disabling vblank irqs,
290 * so no updates of timestamps or count can happen after we've
291 * disabled. Needed to prevent races in case of delayed irq's.
292 */
293 spin_lock_irqsave(&dev->vblank_time_lock, irqflags);
294
295 /*
296 * Only disable vblank interrupts if they're enabled. This avoids
297 * calling the ->disable_vblank() operation in atomic context with the
298 * hardware potentially runtime suspended.
299 */
300 if (vblank->enabled) {
301 dev->driver->disable_vblank(dev, pipe);
302 vblank->enabled = false;
303 }
304
305 /*
306 * Always update the count and timestamp to maintain the
307 * appearance that the counter has been ticking all along until
308 * this time. This makes the count account for the entire time
309 * between drm_crtc_vblank_on() and drm_crtc_vblank_off().
310 */
311 drm_update_vblank_count(dev, pipe, 0);
312
313 spin_unlock_irqrestore(&dev->vblank_time_lock, irqflags);
314}
315
316static void vblank_disable_fn(unsigned long arg)
317{
318 struct drm_vblank_crtc *vblank = (void *)arg;
319 struct drm_device *dev = vblank->dev;
320 unsigned int pipe = vblank->pipe;
321 unsigned long irqflags;
322
323 spin_lock_irqsave(&dev->vbl_lock, irqflags);
324 if (atomic_read(&vblank->refcount) == 0 && vblank->enabled) {
325 DRM_DEBUG("disabling vblank on crtc %u\n", pipe);
326 vblank_disable_and_save(dev, pipe);
327 }
328 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
329}
330
331/**
332 * drm_vblank_cleanup - cleanup vblank support
333 * @dev: DRM device
334 *
335 * This function cleans up any resources allocated in drm_vblank_init.
336 */
337void drm_vblank_cleanup(struct drm_device *dev)
338{
339 unsigned int pipe;
340
341 /* Bail if the driver didn't call drm_vblank_init() */
342 if (dev->num_crtcs == 0)
343 return;
344
345 for (pipe = 0; pipe < dev->num_crtcs; pipe++) {
346 struct drm_vblank_crtc *vblank = &dev->vblank[pipe];
347
348 WARN_ON(vblank->enabled &&
349 drm_core_check_feature(dev, DRIVER_MODESET));
350
351 del_timer_sync(&vblank->disable_timer);
352 }
353
354 kfree(dev->vblank);
355
356 dev->num_crtcs = 0;
357}
358EXPORT_SYMBOL(drm_vblank_cleanup);
359
360/**
361 * drm_vblank_init - initialize vblank support
362 * @dev: DRM device
363 * @num_crtcs: number of CRTCs supported by @dev
364 *
365 * This function initializes vblank support for @num_crtcs display pipelines.
366 *
367 * Returns:
368 * Zero on success or a negative error code on failure.
369 */
370int drm_vblank_init(struct drm_device *dev, unsigned int num_crtcs)
371{
372 int ret = -ENOMEM;
373 unsigned int i;
374
375 spin_lock_init(&dev->vbl_lock);
376 spin_lock_init(&dev->vblank_time_lock);
377
378 dev->num_crtcs = num_crtcs;
379
380 dev->vblank = kcalloc(num_crtcs, sizeof(*dev->vblank), GFP_KERNEL);
381 if (!dev->vblank)
382 goto err;
383
384 for (i = 0; i < num_crtcs; i++) {
385 struct drm_vblank_crtc *vblank = &dev->vblank[i];
386
387 vblank->dev = dev;
388 vblank->pipe = i;
389 init_waitqueue_head(&vblank->queue);
390 setup_timer(&vblank->disable_timer, vblank_disable_fn,
391 (unsigned long)vblank);
392 seqlock_init(&vblank->seqlock);
393 }
394
395 DRM_INFO("Supports vblank timestamp caching Rev 2 (21.10.2013).\n");
396
397 /* Driver specific high-precision vblank timestamping supported? */
398 if (dev->driver->get_vblank_timestamp)
399 DRM_INFO("Driver supports precise vblank timestamp query.\n");
400 else
401 DRM_INFO("No driver support for vblank timestamp query.\n");
402
403 /* Must have precise timestamping for reliable vblank instant disable */
404 if (dev->vblank_disable_immediate && !dev->driver->get_vblank_timestamp) {
405 dev->vblank_disable_immediate = false;
406 DRM_INFO("Setting vblank_disable_immediate to false because "
407 "get_vblank_timestamp == NULL\n");
408 }
409
410 return 0;
411
412err:
413 dev->num_crtcs = 0;
414 return ret;
415}
416EXPORT_SYMBOL(drm_vblank_init);
417
418static void drm_irq_vgaarb_nokms(void *cookie, bool state)
419{
420 struct drm_device *dev = cookie;
421
422 if (dev->driver->vgaarb_irq) {
423 dev->driver->vgaarb_irq(dev, state);
424 return;
425 }
426
427 if (!dev->irq_enabled)
428 return;
429
430 if (state) {
431 if (dev->driver->irq_uninstall)
432 dev->driver->irq_uninstall(dev);
433 } else {
434 if (dev->driver->irq_preinstall)
435 dev->driver->irq_preinstall(dev);
436 if (dev->driver->irq_postinstall)
437 dev->driver->irq_postinstall(dev);
438 }
439}
440
441/**
442 * drm_irq_install - install IRQ handler
443 * @dev: DRM device
444 * @irq: IRQ number to install the handler for
445 *
446 * Initializes the IRQ related data. Installs the handler, calling the driver
447 * irq_preinstall() and irq_postinstall() functions before and after the
448 * installation.
449 *
450 * This is the simplified helper interface provided for drivers with no special
451 * needs. Drivers which need to install interrupt handlers for multiple
452 * interrupts must instead set drm_device->irq_enabled to signal the DRM core
453 * that vblank interrupts are available.
454 *
455 * Returns:
456 * Zero on success or a negative error code on failure.
457 */
458int drm_irq_install(struct drm_device *dev, int irq)
459{
460 int ret;
461 unsigned long sh_flags = 0;
462
463 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
464 return -EINVAL;
465
466 if (irq == 0)
467 return -EINVAL;
468
469 /* Driver must have been initialized */
470 if (!dev->dev_private)
471 return -EINVAL;
472
473 if (dev->irq_enabled)
474 return -EBUSY;
475 dev->irq_enabled = true;
476
477 DRM_DEBUG("irq=%d\n", irq);
478
479 /* Before installing handler */
480 if (dev->driver->irq_preinstall)
481 dev->driver->irq_preinstall(dev);
482
483 /* Install handler */
484 if (drm_core_check_feature(dev, DRIVER_IRQ_SHARED))
485 sh_flags = IRQF_SHARED;
486
487 ret = request_irq(irq, dev->driver->irq_handler,
488 sh_flags, dev->driver->name, dev);
489
490 if (ret < 0) {
491 dev->irq_enabled = false;
492 return ret;
493 }
494
495 if (drm_core_check_feature(dev, DRIVER_LEGACY))
496 vga_client_register(dev->pdev, (void *)dev, drm_irq_vgaarb_nokms, NULL);
497
498 /* After installing handler */
499 if (dev->driver->irq_postinstall)
500 ret = dev->driver->irq_postinstall(dev);
501
502 if (ret < 0) {
503 dev->irq_enabled = false;
504 if (drm_core_check_feature(dev, DRIVER_LEGACY))
505 vga_client_register(dev->pdev, NULL, NULL, NULL);
506 free_irq(irq, dev);
507 } else {
508 dev->irq = irq;
509 }
510
511 return ret;
512}
513EXPORT_SYMBOL(drm_irq_install);
514
515/**
516 * drm_irq_uninstall - uninstall the IRQ handler
517 * @dev: DRM device
518 *
519 * Calls the driver's irq_uninstall() function and unregisters the IRQ handler.
520 * This should only be called by drivers which used drm_irq_install() to set up
521 * their interrupt handler. Other drivers must only reset
522 * drm_device->irq_enabled to false.
523 *
524 * Note that for kernel modesetting drivers it is a bug if this function fails.
525 * The sanity checks are only to catch buggy user modesetting drivers which call
526 * the same function through an ioctl.
527 *
528 * Returns:
529 * Zero on success or a negative error code on failure.
530 */
531int drm_irq_uninstall(struct drm_device *dev)
532{
533 unsigned long irqflags;
534 bool irq_enabled;
535 int i;
536
537 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
538 return -EINVAL;
539
540 irq_enabled = dev->irq_enabled;
541 dev->irq_enabled = false;
542
543 /*
544 * Wake up any waiters so they don't hang. This is just to paper over
545 * issues for UMS drivers which aren't in full control of their
546 * vblank/irq handling. KMS drivers must ensure that vblanks are all
547 * disabled when uninstalling the irq handler.
548 */
549 if (dev->num_crtcs) {
550 spin_lock_irqsave(&dev->vbl_lock, irqflags);
551 for (i = 0; i < dev->num_crtcs; i++) {
552 struct drm_vblank_crtc *vblank = &dev->vblank[i];
553
554 if (!vblank->enabled)
555 continue;
556
557 WARN_ON(drm_core_check_feature(dev, DRIVER_MODESET));
558
559 vblank_disable_and_save(dev, i);
560 wake_up(&vblank->queue);
561 }
562 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
563 }
564
565 if (!irq_enabled)
566 return -EINVAL;
567
568 DRM_DEBUG("irq=%d\n", dev->irq);
569
570 if (drm_core_check_feature(dev, DRIVER_LEGACY))
571 vga_client_register(dev->pdev, NULL, NULL, NULL);
572
573 if (dev->driver->irq_uninstall)
574 dev->driver->irq_uninstall(dev);
575
576 free_irq(dev->irq, dev);
577
578 return 0;
579}
580EXPORT_SYMBOL(drm_irq_uninstall);
581
582/*
583 * IRQ control ioctl.
584 *
585 * \param inode device inode.
586 * \param file_priv DRM file private.
587 * \param cmd command.
588 * \param arg user argument, pointing to a drm_control structure.
589 * \return zero on success or a negative number on failure.
590 *
591 * Calls irq_install() or irq_uninstall() according to \p arg.
592 */
593int drm_control(struct drm_device *dev, void *data,
594 struct drm_file *file_priv)
595{
596 struct drm_control *ctl = data;
597 int ret = 0, irq;
598
599 /* if we haven't irq we fallback for compatibility reasons -
600 * this used to be a separate function in drm_dma.h
601 */
602
603 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
604 return 0;
605 if (!drm_core_check_feature(dev, DRIVER_LEGACY))
606 return 0;
607 /* UMS was only ever supported on pci devices. */
608 if (WARN_ON(!dev->pdev))
609 return -EINVAL;
610
611 switch (ctl->func) {
612 case DRM_INST_HANDLER:
613 irq = dev->pdev->irq;
614
615 if (dev->if_version < DRM_IF_VERSION(1, 2) &&
616 ctl->irq != irq)
617 return -EINVAL;
618 mutex_lock(&dev->struct_mutex);
619 ret = drm_irq_install(dev, irq);
620 mutex_unlock(&dev->struct_mutex);
621
622 return ret;
623 case DRM_UNINST_HANDLER:
624 mutex_lock(&dev->struct_mutex);
625 ret = drm_irq_uninstall(dev);
626 mutex_unlock(&dev->struct_mutex);
627
628 return ret;
629 default:
630 return -EINVAL;
631 }
632}
633
634/**
635 * drm_calc_timestamping_constants - calculate vblank timestamp constants
636 * @crtc: drm_crtc whose timestamp constants should be updated.
637 * @mode: display mode containing the scanout timings
638 *
639 * Calculate and store various constants which are later
640 * needed by vblank and swap-completion timestamping, e.g,
641 * by drm_calc_vbltimestamp_from_scanoutpos(). They are
642 * derived from CRTC's true scanout timing, so they take
643 * things like panel scaling or other adjustments into account.
644 */
645void drm_calc_timestamping_constants(struct drm_crtc *crtc,
646 const struct drm_display_mode *mode)
647{
648 struct drm_device *dev = crtc->dev;
649 unsigned int pipe = drm_crtc_index(crtc);
650 struct drm_vblank_crtc *vblank = &dev->vblank[pipe];
651 int linedur_ns = 0, framedur_ns = 0;
652 int dotclock = mode->crtc_clock;
653
654 if (!dev->num_crtcs)
655 return;
656
657 if (WARN_ON(pipe >= dev->num_crtcs))
658 return;
659
660 /* Valid dotclock? */
661 if (dotclock > 0) {
662 int frame_size = mode->crtc_htotal * mode->crtc_vtotal;
663
664 /*
665 * Convert scanline length in pixels and video
666 * dot clock to line duration and frame duration
667 * in nanoseconds:
668 */
669 linedur_ns = div_u64((u64) mode->crtc_htotal * 1000000, dotclock);
670 framedur_ns = div_u64((u64) frame_size * 1000000, dotclock);
671
672 /*
673 * Fields of interlaced scanout modes are only half a frame duration.
674 */
675 if (mode->flags & DRM_MODE_FLAG_INTERLACE)
676 framedur_ns /= 2;
677 } else
678 DRM_ERROR("crtc %u: Can't calculate constants, dotclock = 0!\n",
679 crtc->base.id);
680
681 vblank->linedur_ns = linedur_ns;
682 vblank->framedur_ns = framedur_ns;
683
684 DRM_DEBUG("crtc %u: hwmode: htotal %d, vtotal %d, vdisplay %d\n",
685 crtc->base.id, mode->crtc_htotal,
686 mode->crtc_vtotal, mode->crtc_vdisplay);
687 DRM_DEBUG("crtc %u: clock %d kHz framedur %d linedur %d\n",
688 crtc->base.id, dotclock, framedur_ns, linedur_ns);
689}
690EXPORT_SYMBOL(drm_calc_timestamping_constants);
691
692/**
693 * drm_calc_vbltimestamp_from_scanoutpos - precise vblank timestamp helper
694 * @dev: DRM device
695 * @pipe: index of CRTC whose vblank timestamp to retrieve
696 * @max_error: Desired maximum allowable error in timestamps (nanosecs)
697 * On return contains true maximum error of timestamp
698 * @vblank_time: Pointer to struct timeval which should receive the timestamp
699 * @flags: Flags to pass to driver:
700 * 0 = Default,
701 * DRM_CALLED_FROM_VBLIRQ = If function is called from vbl IRQ handler
702 * @mode: mode which defines the scanout timings
703 *
704 * Implements calculation of exact vblank timestamps from given drm_display_mode
705 * timings and current video scanout position of a CRTC. This can be called from
706 * within get_vblank_timestamp() implementation of a kms driver to implement the
707 * actual timestamping.
708 *
709 * Should return timestamps conforming to the OML_sync_control OpenML
710 * extension specification. The timestamp corresponds to the end of
711 * the vblank interval, aka start of scanout of topmost-leftmost display
712 * pixel in the following video frame.
713 *
714 * Requires support for optional dev->driver->get_scanout_position()
715 * in kms driver, plus a bit of setup code to provide a drm_display_mode
716 * that corresponds to the true scanout timing.
717 *
718 * The current implementation only handles standard video modes. It
719 * returns as no operation if a doublescan or interlaced video mode is
720 * active. Higher level code is expected to handle this.
721 *
722 * Returns:
723 * Negative value on error, failure or if not supported in current
724 * video mode:
725 *
726 * -EINVAL Invalid CRTC.
727 * -EAGAIN Temporary unavailable, e.g., called before initial modeset.
728 * -ENOTSUPP Function not supported in current display mode.
729 * -EIO Failed, e.g., due to failed scanout position query.
730 *
731 * Returns or'ed positive status flags on success:
732 *
733 * DRM_VBLANKTIME_SCANOUTPOS_METHOD - Signal this method used for timestamping.
734 * DRM_VBLANKTIME_INVBL - Timestamp taken while scanout was in vblank interval.
735 *
736 */
737int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
738 unsigned int pipe,
739 int *max_error,
740 struct timeval *vblank_time,
741 unsigned flags,
742 const struct drm_display_mode *mode)
743{
744 struct timeval tv_etime;
745 ktime_t stime, etime;
746 unsigned int vbl_status;
747 int ret = DRM_VBLANKTIME_SCANOUTPOS_METHOD;
748 int vpos, hpos, i;
749 int delta_ns, duration_ns;
750
751 if (pipe >= dev->num_crtcs) {
752 DRM_ERROR("Invalid crtc %u\n", pipe);
753 return -EINVAL;
754 }
755
756 /* Scanout position query not supported? Should not happen. */
757 if (!dev->driver->get_scanout_position) {
758 DRM_ERROR("Called from driver w/o get_scanout_position()!?\n");
759 return -EIO;
760 }
761
762 /* If mode timing undefined, just return as no-op:
763 * Happens during initial modesetting of a crtc.
764 */
765 if (mode->crtc_clock == 0) {
766 DRM_DEBUG("crtc %u: Noop due to uninitialized mode.\n", pipe);
767 return -EAGAIN;
768 }
769
770 /* Get current scanout position with system timestamp.
771 * Repeat query up to DRM_TIMESTAMP_MAXRETRIES times
772 * if single query takes longer than max_error nanoseconds.
773 *
774 * This guarantees a tight bound on maximum error if
775 * code gets preempted or delayed for some reason.
776 */
777 for (i = 0; i < DRM_TIMESTAMP_MAXRETRIES; i++) {
778 /*
779 * Get vertical and horizontal scanout position vpos, hpos,
780 * and bounding timestamps stime, etime, pre/post query.
781 */
782 vbl_status = dev->driver->get_scanout_position(dev, pipe, flags,
783 &vpos, &hpos,
784 &stime, &etime,
785 mode);
786
787 /* Return as no-op if scanout query unsupported or failed. */
788 if (!(vbl_status & DRM_SCANOUTPOS_VALID)) {
789 DRM_DEBUG("crtc %u : scanoutpos query failed [0x%x].\n",
790 pipe, vbl_status);
791 return -EIO;
792 }
793
794 /* Compute uncertainty in timestamp of scanout position query. */
795 duration_ns = ktime_to_ns(etime) - ktime_to_ns(stime);
796
797 /* Accept result with < max_error nsecs timing uncertainty. */
798 if (duration_ns <= *max_error)
799 break;
800 }
801
802 /* Noisy system timing? */
803 if (i == DRM_TIMESTAMP_MAXRETRIES) {
804 DRM_DEBUG("crtc %u: Noisy timestamp %d us > %d us [%d reps].\n",
805 pipe, duration_ns/1000, *max_error/1000, i);
806 }
807
808 /* Return upper bound of timestamp precision error. */
809 *max_error = duration_ns;
810
811 /* Check if in vblank area:
812 * vpos is >=0 in video scanout area, but negative
813 * within vblank area, counting down the number of lines until
814 * start of scanout.
815 */
816 if (vbl_status & DRM_SCANOUTPOS_IN_VBLANK)
817 ret |= DRM_VBLANKTIME_IN_VBLANK;
818
819 /* Convert scanout position into elapsed time at raw_time query
820 * since start of scanout at first display scanline. delta_ns
821 * can be negative if start of scanout hasn't happened yet.
822 */
823 delta_ns = div_s64(1000000LL * (vpos * mode->crtc_htotal + hpos),
824 mode->crtc_clock);
825
826 if (!drm_timestamp_monotonic)
827 etime = ktime_mono_to_real(etime);
828
829 /* save this only for debugging purposes */
830 tv_etime = ktime_to_timeval(etime);
831 /* Subtract time delta from raw timestamp to get final
832 * vblank_time timestamp for end of vblank.
833 */
834 etime = ktime_sub_ns(etime, delta_ns);
835 *vblank_time = ktime_to_timeval(etime);
836
837 DRM_DEBUG_VBL("crtc %u : v 0x%x p(%d,%d)@ %ld.%ld -> %ld.%ld [e %d us, %d rep]\n",
838 pipe, vbl_status, hpos, vpos,
839 (long)tv_etime.tv_sec, (long)tv_etime.tv_usec,
840 (long)vblank_time->tv_sec, (long)vblank_time->tv_usec,
841 duration_ns/1000, i);
842
843 return ret;
844}
845EXPORT_SYMBOL(drm_calc_vbltimestamp_from_scanoutpos);
846
847static struct timeval get_drm_timestamp(void)
848{
849 ktime_t now;
850
851 now = drm_timestamp_monotonic ? ktime_get() : ktime_get_real();
852 return ktime_to_timeval(now);
853}
854
855/**
856 * drm_get_last_vbltimestamp - retrieve raw timestamp for the most recent
857 * vblank interval
858 * @dev: DRM device
859 * @pipe: index of CRTC whose vblank timestamp to retrieve
860 * @tvblank: Pointer to target struct timeval which should receive the timestamp
861 * @flags: Flags to pass to driver:
862 * 0 = Default,
863 * DRM_CALLED_FROM_VBLIRQ = If function is called from vbl IRQ handler
864 *
865 * Fetches the system timestamp corresponding to the time of the most recent
866 * vblank interval on specified CRTC. May call into kms-driver to
867 * compute the timestamp with a high-precision GPU specific method.
868 *
869 * Returns zero if timestamp originates from uncorrected do_gettimeofday()
870 * call, i.e., it isn't very precisely locked to the true vblank.
871 *
872 * Returns:
873 * True if timestamp is considered to be very precise, false otherwise.
874 */
875static bool
876drm_get_last_vbltimestamp(struct drm_device *dev, unsigned int pipe,
877 struct timeval *tvblank, unsigned flags)
878{
879 int ret;
880
881 /* Define requested maximum error on timestamps (nanoseconds). */
882 int max_error = (int) drm_timestamp_precision * 1000;
883
884 /* Query driver if possible and precision timestamping enabled. */
885 if (dev->driver->get_vblank_timestamp && (max_error > 0)) {
886 ret = dev->driver->get_vblank_timestamp(dev, pipe, &max_error,
887 tvblank, flags);
888 if (ret > 0)
889 return true;
890 }
891
892 /* GPU high precision timestamp query unsupported or failed.
893 * Return current monotonic/gettimeofday timestamp as best estimate.
894 */
895 *tvblank = get_drm_timestamp();
896
897 return false;
898}
899
900/**
901 * drm_crtc_vblank_count - retrieve "cooked" vblank counter value
902 * @crtc: which counter to retrieve
903 *
904 * Fetches the "cooked" vblank count value that represents the number of
905 * vblank events since the system was booted, including lost events due to
906 * modesetting activity.
907 *
908 * Returns:
909 * The software vblank counter.
910 */
911u32 drm_crtc_vblank_count(struct drm_crtc *crtc)
912{
913 return drm_vblank_count(crtc->dev, drm_crtc_index(crtc));
914}
915EXPORT_SYMBOL(drm_crtc_vblank_count);
916
917/**
918 * drm_vblank_count_and_time - retrieve "cooked" vblank counter value and the
919 * system timestamp corresponding to that vblank counter value.
920 * @dev: DRM device
921 * @pipe: index of CRTC whose counter to retrieve
922 * @vblanktime: Pointer to struct timeval to receive the vblank timestamp.
923 *
924 * Fetches the "cooked" vblank count value that represents the number of
925 * vblank events since the system was booted, including lost events due to
926 * modesetting activity. Returns corresponding system timestamp of the time
927 * of the vblank interval that corresponds to the current vblank counter value.
928 *
929 * This is the legacy version of drm_crtc_vblank_count_and_time().
930 */
931static u32 drm_vblank_count_and_time(struct drm_device *dev, unsigned int pipe,
932 struct timeval *vblanktime)
933{
934 struct drm_vblank_crtc *vblank = &dev->vblank[pipe];
935 u32 vblank_count;
936 unsigned int seq;
937
938 if (WARN_ON(pipe >= dev->num_crtcs)) {
939 *vblanktime = (struct timeval) { 0 };
940 return 0;
941 }
942
943 do {
944 seq = read_seqbegin(&vblank->seqlock);
945 vblank_count = vblank->count;
946 *vblanktime = vblank->time;
947 } while (read_seqretry(&vblank->seqlock, seq));
948
949 return vblank_count;
950}
951
952/**
953 * drm_crtc_vblank_count_and_time - retrieve "cooked" vblank counter value
954 * and the system timestamp corresponding to that vblank counter value
955 * @crtc: which counter to retrieve
956 * @vblanktime: Pointer to struct timeval to receive the vblank timestamp.
957 *
958 * Fetches the "cooked" vblank count value that represents the number of
959 * vblank events since the system was booted, including lost events due to
960 * modesetting activity. Returns corresponding system timestamp of the time
961 * of the vblank interval that corresponds to the current vblank counter value.
962 */
963u32 drm_crtc_vblank_count_and_time(struct drm_crtc *crtc,
964 struct timeval *vblanktime)
965{
966 return drm_vblank_count_and_time(crtc->dev, drm_crtc_index(crtc),
967 vblanktime);
968}
969EXPORT_SYMBOL(drm_crtc_vblank_count_and_time);
970
971static void send_vblank_event(struct drm_device *dev,
972 struct drm_pending_vblank_event *e,
973 unsigned long seq, struct timeval *now)
974{
975 e->event.sequence = seq;
976 e->event.tv_sec = now->tv_sec;
977 e->event.tv_usec = now->tv_usec;
978
979 trace_drm_vblank_event_delivered(e->base.pid, e->pipe,
980 e->event.sequence);
981
982 drm_send_event_locked(dev, &e->base);
983}
984
985/**
986 * drm_crtc_arm_vblank_event - arm vblank event after pageflip
987 * @crtc: the source CRTC of the vblank event
988 * @e: the event to send
989 *
990 * A lot of drivers need to generate vblank events for the very next vblank
991 * interrupt. For example when the page flip interrupt happens when the page
992 * flip gets armed, but not when it actually executes within the next vblank
993 * period. This helper function implements exactly the required vblank arming
994 * behaviour.
995 *
996 * NOTE: Drivers using this to send out the event in struct &drm_crtc_state
997 * as part of an atomic commit must ensure that the next vblank happens at
998 * exactly the same time as the atomic commit is committed to the hardware. This
999 * function itself does **not** protect again the next vblank interrupt racing
1000 * with either this function call or the atomic commit operation. A possible
1001 * sequence could be:
1002 *
1003 * 1. Driver commits new hardware state into vblank-synchronized registers.
1004 * 2. A vblank happens, committing the hardware state. Also the corresponding
1005 * vblank interrupt is fired off and fully processed by the interrupt
1006 * handler.
1007 * 3. The atomic commit operation proceeds to call drm_crtc_arm_vblank_event().
1008 * 4. The event is only send out for the next vblank, which is wrong.
1009 *
1010 * An equivalent race can happen when the driver calls
1011 * drm_crtc_arm_vblank_event() before writing out the new hardware state.
1012 *
1013 * The only way to make this work safely is to prevent the vblank from firing
1014 * (and the hardware from committing anything else) until the entire atomic
1015 * commit sequence has run to completion. If the hardware does not have such a
1016 * feature (e.g. using a "go" bit), then it is unsafe to use this functions.
1017 * Instead drivers need to manually send out the event from their interrupt
1018 * handler by calling drm_crtc_send_vblank_event() and make sure that there's no
1019 * possible race with the hardware committing the atomic update.
1020 *
1021 * Caller must hold event lock. Caller must also hold a vblank reference for
1022 * the event @e, which will be dropped when the next vblank arrives.
1023 */
1024void drm_crtc_arm_vblank_event(struct drm_crtc *crtc,
1025 struct drm_pending_vblank_event *e)
1026{
1027 struct drm_device *dev = crtc->dev;
1028 unsigned int pipe = drm_crtc_index(crtc);
1029
1030 assert_spin_locked(&dev->event_lock);
1031
1032 e->pipe = pipe;
1033 e->event.sequence = drm_vblank_count(dev, pipe);
1034 list_add_tail(&e->base.link, &dev->vblank_event_list);
1035}
1036EXPORT_SYMBOL(drm_crtc_arm_vblank_event);
1037
1038/**
1039 * drm_crtc_send_vblank_event - helper to send vblank event after pageflip
1040 * @crtc: the source CRTC of the vblank event
1041 * @e: the event to send
1042 *
1043 * Updates sequence # and timestamp on event for the most recently processed
1044 * vblank, and sends it to userspace. Caller must hold event lock.
1045 *
1046 * See drm_crtc_arm_vblank_event() for a helper which can be used in certain
1047 * situation, especially to send out events for atomic commit operations.
1048 */
1049void drm_crtc_send_vblank_event(struct drm_crtc *crtc,
1050 struct drm_pending_vblank_event *e)
1051{
1052 struct drm_device *dev = crtc->dev;
1053 unsigned int seq, pipe = drm_crtc_index(crtc);
1054 struct timeval now;
1055
1056 if (dev->num_crtcs > 0) {
1057 seq = drm_vblank_count_and_time(dev, pipe, &now);
1058 } else {
1059 seq = 0;
1060
1061 now = get_drm_timestamp();
1062 }
1063 e->pipe = pipe;
1064 send_vblank_event(dev, e, seq, &now);
1065}
1066EXPORT_SYMBOL(drm_crtc_send_vblank_event);
1067
1068/**
1069 * drm_vblank_enable - enable the vblank interrupt on a CRTC
1070 * @dev: DRM device
1071 * @pipe: CRTC index
1072 *
1073 * Returns:
1074 * Zero on success or a negative error code on failure.
1075 */
1076static int drm_vblank_enable(struct drm_device *dev, unsigned int pipe)
1077{
1078 struct drm_vblank_crtc *vblank = &dev->vblank[pipe];
1079 int ret = 0;
1080
1081 assert_spin_locked(&dev->vbl_lock);
1082
1083 spin_lock(&dev->vblank_time_lock);
1084
1085 if (!vblank->enabled) {
1086 /*
1087 * Enable vblank irqs under vblank_time_lock protection.
1088 * All vblank count & timestamp updates are held off
1089 * until we are done reinitializing master counter and
1090 * timestamps. Filtercode in drm_handle_vblank() will
1091 * prevent double-accounting of same vblank interval.
1092 */
1093 ret = dev->driver->enable_vblank(dev, pipe);
1094 DRM_DEBUG("enabling vblank on crtc %u, ret: %d\n", pipe, ret);
1095 if (ret)
1096 atomic_dec(&vblank->refcount);
1097 else {
1098 vblank->enabled = true;
1099 drm_update_vblank_count(dev, pipe, 0);
1100 }
1101 }
1102
1103 spin_unlock(&dev->vblank_time_lock);
1104
1105 return ret;
1106}
1107
1108/**
1109 * drm_vblank_get - get a reference count on vblank events
1110 * @dev: DRM device
1111 * @pipe: index of CRTC to own
1112 *
1113 * Acquire a reference count on vblank events to avoid having them disabled
1114 * while in use.
1115 *
1116 * This is the legacy version of drm_crtc_vblank_get().
1117 *
1118 * Returns:
1119 * Zero on success or a negative error code on failure.
1120 */
1121static int drm_vblank_get(struct drm_device *dev, unsigned int pipe)
1122{
1123 struct drm_vblank_crtc *vblank = &dev->vblank[pipe];
1124 unsigned long irqflags;
1125 int ret = 0;
1126
1127 if (!dev->num_crtcs)
1128 return -EINVAL;
1129
1130 if (WARN_ON(pipe >= dev->num_crtcs))
1131 return -EINVAL;
1132
1133 spin_lock_irqsave(&dev->vbl_lock, irqflags);
1134 /* Going from 0->1 means we have to enable interrupts again */
1135 if (atomic_add_return(1, &vblank->refcount) == 1) {
1136 ret = drm_vblank_enable(dev, pipe);
1137 } else {
1138 if (!vblank->enabled) {
1139 atomic_dec(&vblank->refcount);
1140 ret = -EINVAL;
1141 }
1142 }
1143 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
1144
1145 return ret;
1146}
1147
1148/**
1149 * drm_crtc_vblank_get - get a reference count on vblank events
1150 * @crtc: which CRTC to own
1151 *
1152 * Acquire a reference count on vblank events to avoid having them disabled
1153 * while in use.
1154 *
1155 * Returns:
1156 * Zero on success or a negative error code on failure.
1157 */
1158int drm_crtc_vblank_get(struct drm_crtc *crtc)
1159{
1160 return drm_vblank_get(crtc->dev, drm_crtc_index(crtc));
1161}
1162EXPORT_SYMBOL(drm_crtc_vblank_get);
1163
1164/**
1165 * drm_vblank_put - release ownership of vblank events
1166 * @dev: DRM device
1167 * @pipe: index of CRTC to release
1168 *
1169 * Release ownership of a given vblank counter, turning off interrupts
1170 * if possible. Disable interrupts after drm_vblank_offdelay milliseconds.
1171 *
1172 * This is the legacy version of drm_crtc_vblank_put().
1173 */
1174static void drm_vblank_put(struct drm_device *dev, unsigned int pipe)
1175{
1176 struct drm_vblank_crtc *vblank = &dev->vblank[pipe];
1177
1178 if (WARN_ON(pipe >= dev->num_crtcs))
1179 return;
1180
1181 if (WARN_ON(atomic_read(&vblank->refcount) == 0))
1182 return;
1183
1184 /* Last user schedules interrupt disable */
1185 if (atomic_dec_and_test(&vblank->refcount)) {
1186 if (drm_vblank_offdelay == 0)
1187 return;
1188 else if (dev->vblank_disable_immediate || drm_vblank_offdelay < 0)
1189 vblank_disable_fn((unsigned long)vblank);
1190 else
1191 mod_timer(&vblank->disable_timer,
1192 jiffies + ((drm_vblank_offdelay * HZ)/1000));
1193 }
1194}
1195
1196/**
1197 * drm_crtc_vblank_put - give up ownership of vblank events
1198 * @crtc: which counter to give up
1199 *
1200 * Release ownership of a given vblank counter, turning off interrupts
1201 * if possible. Disable interrupts after drm_vblank_offdelay milliseconds.
1202 */
1203void drm_crtc_vblank_put(struct drm_crtc *crtc)
1204{
1205 drm_vblank_put(crtc->dev, drm_crtc_index(crtc));
1206}
1207EXPORT_SYMBOL(drm_crtc_vblank_put);
1208
1209/**
1210 * drm_wait_one_vblank - wait for one vblank
1211 * @dev: DRM device
1212 * @pipe: CRTC index
1213 *
1214 * This waits for one vblank to pass on @pipe, using the irq driver interfaces.
1215 * It is a failure to call this when the vblank irq for @pipe is disabled, e.g.
1216 * due to lack of driver support or because the crtc is off.
1217 */
1218void drm_wait_one_vblank(struct drm_device *dev, unsigned int pipe)
1219{
1220 struct drm_vblank_crtc *vblank = &dev->vblank[pipe];
1221 int ret;
1222 u32 last;
1223
1224 if (WARN_ON(pipe >= dev->num_crtcs))
1225 return;
1226
1227 ret = drm_vblank_get(dev, pipe);
1228 if (WARN(ret, "vblank not available on crtc %i, ret=%i\n", pipe, ret))
1229 return;
1230
1231 last = drm_vblank_count(dev, pipe);
1232
1233 ret = wait_event_timeout(vblank->queue,
1234 last != drm_vblank_count(dev, pipe),
1235 msecs_to_jiffies(100));
1236
1237 WARN(ret == 0, "vblank wait timed out on crtc %i\n", pipe);
1238
1239 drm_vblank_put(dev, pipe);
1240}
1241EXPORT_SYMBOL(drm_wait_one_vblank);
1242
1243/**
1244 * drm_crtc_wait_one_vblank - wait for one vblank
1245 * @crtc: DRM crtc
1246 *
1247 * This waits for one vblank to pass on @crtc, using the irq driver interfaces.
1248 * It is a failure to call this when the vblank irq for @crtc is disabled, e.g.
1249 * due to lack of driver support or because the crtc is off.
1250 */
1251void drm_crtc_wait_one_vblank(struct drm_crtc *crtc)
1252{
1253 drm_wait_one_vblank(crtc->dev, drm_crtc_index(crtc));
1254}
1255EXPORT_SYMBOL(drm_crtc_wait_one_vblank);
1256
1257/**
1258 * drm_crtc_vblank_off - disable vblank events on a CRTC
1259 * @crtc: CRTC in question
1260 *
1261 * Drivers can use this function to shut down the vblank interrupt handling when
1262 * disabling a crtc. This function ensures that the latest vblank frame count is
1263 * stored so that drm_vblank_on can restore it again.
1264 *
1265 * Drivers must use this function when the hardware vblank counter can get
1266 * reset, e.g. when suspending.
1267 */
1268void drm_crtc_vblank_off(struct drm_crtc *crtc)
1269{
1270 struct drm_device *dev = crtc->dev;
1271 unsigned int pipe = drm_crtc_index(crtc);
1272 struct drm_vblank_crtc *vblank = &dev->vblank[pipe];
1273 struct drm_pending_vblank_event *e, *t;
1274 struct timeval now;
1275 unsigned long irqflags;
1276 unsigned int seq;
1277
1278 if (WARN_ON(pipe >= dev->num_crtcs))
1279 return;
1280
1281 spin_lock_irqsave(&dev->event_lock, irqflags);
1282
1283 spin_lock(&dev->vbl_lock);
1284 DRM_DEBUG_VBL("crtc %d, vblank enabled %d, inmodeset %d\n",
1285 pipe, vblank->enabled, vblank->inmodeset);
1286
1287 /* Avoid redundant vblank disables without previous
1288 * drm_crtc_vblank_on(). */
1289 if (drm_core_check_feature(dev, DRIVER_ATOMIC) || !vblank->inmodeset)
1290 vblank_disable_and_save(dev, pipe);
1291
1292 wake_up(&vblank->queue);
1293
1294 /*
1295 * Prevent subsequent drm_vblank_get() from re-enabling
1296 * the vblank interrupt by bumping the refcount.
1297 */
1298 if (!vblank->inmodeset) {
1299 atomic_inc(&vblank->refcount);
1300 vblank->inmodeset = 1;
1301 }
1302 spin_unlock(&dev->vbl_lock);
1303
1304 /* Send any queued vblank events, lest the natives grow disquiet */
1305 seq = drm_vblank_count_and_time(dev, pipe, &now);
1306
1307 list_for_each_entry_safe(e, t, &dev->vblank_event_list, base.link) {
1308 if (e->pipe != pipe)
1309 continue;
1310 DRM_DEBUG("Sending premature vblank event on disable: "
1311 "wanted %u, current %u\n",
1312 e->event.sequence, seq);
1313 list_del(&e->base.link);
1314 drm_vblank_put(dev, pipe);
1315 send_vblank_event(dev, e, seq, &now);
1316 }
1317 spin_unlock_irqrestore(&dev->event_lock, irqflags);
1318}
1319EXPORT_SYMBOL(drm_crtc_vblank_off);
1320
1321/**
1322 * drm_crtc_vblank_reset - reset vblank state to off on a CRTC
1323 * @crtc: CRTC in question
1324 *
1325 * Drivers can use this function to reset the vblank state to off at load time.
1326 * Drivers should use this together with the drm_crtc_vblank_off() and
1327 * drm_crtc_vblank_on() functions. The difference compared to
1328 * drm_crtc_vblank_off() is that this function doesn't save the vblank counter
1329 * and hence doesn't need to call any driver hooks.
1330 */
1331void drm_crtc_vblank_reset(struct drm_crtc *crtc)
1332{
1333 struct drm_device *dev = crtc->dev;
1334 unsigned long irqflags;
1335 unsigned int pipe = drm_crtc_index(crtc);
1336 struct drm_vblank_crtc *vblank = &dev->vblank[pipe];
1337
1338 spin_lock_irqsave(&dev->vbl_lock, irqflags);
1339 /*
1340 * Prevent subsequent drm_vblank_get() from enabling the vblank
1341 * interrupt by bumping the refcount.
1342 */
1343 if (!vblank->inmodeset) {
1344 atomic_inc(&vblank->refcount);
1345 vblank->inmodeset = 1;
1346 }
1347 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
1348
1349 WARN_ON(!list_empty(&dev->vblank_event_list));
1350}
1351EXPORT_SYMBOL(drm_crtc_vblank_reset);
1352
1353/**
1354 * drm_crtc_vblank_on - enable vblank events on a CRTC
1355 * @crtc: CRTC in question
1356 *
1357 * This functions restores the vblank interrupt state captured with
1358 * drm_crtc_vblank_off() again. Note that calls to drm_crtc_vblank_on() and
1359 * drm_crtc_vblank_off() can be unbalanced and so can also be unconditionally called
1360 * in driver load code to reflect the current hardware state of the crtc.
1361 */
1362void drm_crtc_vblank_on(struct drm_crtc *crtc)
1363{
1364 struct drm_device *dev = crtc->dev;
1365 unsigned int pipe = drm_crtc_index(crtc);
1366 struct drm_vblank_crtc *vblank = &dev->vblank[pipe];
1367 unsigned long irqflags;
1368
1369 if (WARN_ON(pipe >= dev->num_crtcs))
1370 return;
1371
1372 spin_lock_irqsave(&dev->vbl_lock, irqflags);
1373 DRM_DEBUG_VBL("crtc %d, vblank enabled %d, inmodeset %d\n",
1374 pipe, vblank->enabled, vblank->inmodeset);
1375
1376 /* Drop our private "prevent drm_vblank_get" refcount */
1377 if (vblank->inmodeset) {
1378 atomic_dec(&vblank->refcount);
1379 vblank->inmodeset = 0;
1380 }
1381
1382 drm_reset_vblank_timestamp(dev, pipe);
1383
1384 /*
1385 * re-enable interrupts if there are users left, or the
1386 * user wishes vblank interrupts to be enabled all the time.
1387 */
1388 if (atomic_read(&vblank->refcount) != 0 || drm_vblank_offdelay == 0)
1389 WARN_ON(drm_vblank_enable(dev, pipe));
1390 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
1391}
1392EXPORT_SYMBOL(drm_crtc_vblank_on);
1393
1394static void drm_legacy_vblank_pre_modeset(struct drm_device *dev,
1395 unsigned int pipe)
1396{
1397 struct drm_vblank_crtc *vblank = &dev->vblank[pipe];
1398
1399 /* vblank is not initialized (IRQ not installed ?), or has been freed */
1400 if (!dev->num_crtcs)
1401 return;
1402
1403 if (WARN_ON(pipe >= dev->num_crtcs))
1404 return;
1405
1406 /*
1407 * To avoid all the problems that might happen if interrupts
1408 * were enabled/disabled around or between these calls, we just
1409 * have the kernel take a reference on the CRTC (just once though
1410 * to avoid corrupting the count if multiple, mismatch calls occur),
1411 * so that interrupts remain enabled in the interim.
1412 */
1413 if (!vblank->inmodeset) {
1414 vblank->inmodeset = 0x1;
1415 if (drm_vblank_get(dev, pipe) == 0)
1416 vblank->inmodeset |= 0x2;
1417 }
1418}
1419
1420static void drm_legacy_vblank_post_modeset(struct drm_device *dev,
1421 unsigned int pipe)
1422{
1423 struct drm_vblank_crtc *vblank = &dev->vblank[pipe];
1424 unsigned long irqflags;
1425
1426 /* vblank is not initialized (IRQ not installed ?), or has been freed */
1427 if (!dev->num_crtcs)
1428 return;
1429
1430 if (WARN_ON(pipe >= dev->num_crtcs))
1431 return;
1432
1433 if (vblank->inmodeset) {
1434 spin_lock_irqsave(&dev->vbl_lock, irqflags);
1435 drm_reset_vblank_timestamp(dev, pipe);
1436 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
1437
1438 if (vblank->inmodeset & 0x2)
1439 drm_vblank_put(dev, pipe);
1440
1441 vblank->inmodeset = 0;
1442 }
1443}
1444
1445/*
1446 * drm_modeset_ctl - handle vblank event counter changes across mode switch
1447 * @DRM_IOCTL_ARGS: standard ioctl arguments
1448 *
1449 * Applications should call the %_DRM_PRE_MODESET and %_DRM_POST_MODESET
1450 * ioctls around modesetting so that any lost vblank events are accounted for.
1451 *
1452 * Generally the counter will reset across mode sets. If interrupts are
1453 * enabled around this call, we don't have to do anything since the counter
1454 * will have already been incremented.
1455 */
1456int drm_modeset_ctl(struct drm_device *dev, void *data,
1457 struct drm_file *file_priv)
1458{
1459 struct drm_modeset_ctl *modeset = data;
1460 unsigned int pipe;
1461
1462 /* If drm_vblank_init() hasn't been called yet, just no-op */
1463 if (!dev->num_crtcs)
1464 return 0;
1465
1466 /* KMS drivers handle this internally */
1467 if (!drm_core_check_feature(dev, DRIVER_LEGACY))
1468 return 0;
1469
1470 pipe = modeset->crtc;
1471 if (pipe >= dev->num_crtcs)
1472 return -EINVAL;
1473
1474 switch (modeset->cmd) {
1475 case _DRM_PRE_MODESET:
1476 drm_legacy_vblank_pre_modeset(dev, pipe);
1477 break;
1478 case _DRM_POST_MODESET:
1479 drm_legacy_vblank_post_modeset(dev, pipe);
1480 break;
1481 default:
1482 return -EINVAL;
1483 }
1484
1485 return 0;
1486}
1487
1488static int drm_queue_vblank_event(struct drm_device *dev, unsigned int pipe,
1489 union drm_wait_vblank *vblwait,
1490 struct drm_file *file_priv)
1491{
1492 struct drm_vblank_crtc *vblank = &dev->vblank[pipe];
1493 struct drm_pending_vblank_event *e;
1494 struct timeval now;
1495 unsigned long flags;
1496 unsigned int seq;
1497 int ret;
1498
1499 e = kzalloc(sizeof(*e), GFP_KERNEL);
1500 if (e == NULL) {
1501 ret = -ENOMEM;
1502 goto err_put;
1503 }
1504
1505 e->pipe = pipe;
1506 e->base.pid = current->pid;
1507 e->event.base.type = DRM_EVENT_VBLANK;
1508 e->event.base.length = sizeof(e->event);
1509 e->event.user_data = vblwait->request.signal;
1510
1511 spin_lock_irqsave(&dev->event_lock, flags);
1512
1513 /*
1514 * drm_crtc_vblank_off() might have been called after we called
1515 * drm_vblank_get(). drm_crtc_vblank_off() holds event_lock around the
1516 * vblank disable, so no need for further locking. The reference from
1517 * drm_vblank_get() protects against vblank disable from another source.
1518 */
1519 if (!vblank->enabled) {
1520 ret = -EINVAL;
1521 goto err_unlock;
1522 }
1523
1524 ret = drm_event_reserve_init_locked(dev, file_priv, &e->base,
1525 &e->event.base);
1526
1527 if (ret)
1528 goto err_unlock;
1529
1530 seq = drm_vblank_count_and_time(dev, pipe, &now);
1531
1532 DRM_DEBUG("event on vblank count %u, current %u, crtc %u\n",
1533 vblwait->request.sequence, seq, pipe);
1534
1535 trace_drm_vblank_event_queued(current->pid, pipe,
1536 vblwait->request.sequence);
1537
1538 e->event.sequence = vblwait->request.sequence;
1539 if ((seq - vblwait->request.sequence) <= (1 << 23)) {
1540 drm_vblank_put(dev, pipe);
1541 send_vblank_event(dev, e, seq, &now);
1542 vblwait->reply.sequence = seq;
1543 } else {
1544 /* drm_handle_vblank_events will call drm_vblank_put */
1545 list_add_tail(&e->base.link, &dev->vblank_event_list);
1546 vblwait->reply.sequence = vblwait->request.sequence;
1547 }
1548
1549 spin_unlock_irqrestore(&dev->event_lock, flags);
1550
1551 return 0;
1552
1553err_unlock:
1554 spin_unlock_irqrestore(&dev->event_lock, flags);
1555 kfree(e);
1556err_put:
1557 drm_vblank_put(dev, pipe);
1558 return ret;
1559}
1560
1561/*
1562 * Wait for VBLANK.
1563 *
1564 * \param inode device inode.
1565 * \param file_priv DRM file private.
1566 * \param cmd command.
1567 * \param data user argument, pointing to a drm_wait_vblank structure.
1568 * \return zero on success or a negative number on failure.
1569 *
1570 * This function enables the vblank interrupt on the pipe requested, then
1571 * sleeps waiting for the requested sequence number to occur, and drops
1572 * the vblank interrupt refcount afterwards. (vblank IRQ disable follows that
1573 * after a timeout with no further vblank waits scheduled).
1574 */
1575int drm_wait_vblank(struct drm_device *dev, void *data,
1576 struct drm_file *file_priv)
1577{
1578 struct drm_vblank_crtc *vblank;
1579 union drm_wait_vblank *vblwait = data;
1580 int ret;
1581 unsigned int flags, seq, pipe, high_pipe;
1582
1583 if (!dev->irq_enabled)
1584 return -EINVAL;
1585
1586 if (vblwait->request.type & _DRM_VBLANK_SIGNAL)
1587 return -EINVAL;
1588
1589 if (vblwait->request.type &
1590 ~(_DRM_VBLANK_TYPES_MASK | _DRM_VBLANK_FLAGS_MASK |
1591 _DRM_VBLANK_HIGH_CRTC_MASK)) {
1592 DRM_ERROR("Unsupported type value 0x%x, supported mask 0x%x\n",
1593 vblwait->request.type,
1594 (_DRM_VBLANK_TYPES_MASK | _DRM_VBLANK_FLAGS_MASK |
1595 _DRM_VBLANK_HIGH_CRTC_MASK));
1596 return -EINVAL;
1597 }
1598
1599 flags = vblwait->request.type & _DRM_VBLANK_FLAGS_MASK;
1600 high_pipe = (vblwait->request.type & _DRM_VBLANK_HIGH_CRTC_MASK);
1601 if (high_pipe)
1602 pipe = high_pipe >> _DRM_VBLANK_HIGH_CRTC_SHIFT;
1603 else
1604 pipe = flags & _DRM_VBLANK_SECONDARY ? 1 : 0;
1605 if (pipe >= dev->num_crtcs)
1606 return -EINVAL;
1607
1608 vblank = &dev->vblank[pipe];
1609
1610 ret = drm_vblank_get(dev, pipe);
1611 if (ret) {
1612 DRM_DEBUG("failed to acquire vblank counter, %d\n", ret);
1613 return ret;
1614 }
1615 seq = drm_vblank_count(dev, pipe);
1616
1617 switch (vblwait->request.type & _DRM_VBLANK_TYPES_MASK) {
1618 case _DRM_VBLANK_RELATIVE:
1619 vblwait->request.sequence += seq;
1620 vblwait->request.type &= ~_DRM_VBLANK_RELATIVE;
1621 case _DRM_VBLANK_ABSOLUTE:
1622 break;
1623 default:
1624 ret = -EINVAL;
1625 goto done;
1626 }
1627
1628 if ((flags & _DRM_VBLANK_NEXTONMISS) &&
1629 (seq - vblwait->request.sequence) <= (1 << 23)) {
1630 vblwait->request.sequence = seq + 1;
1631 }
1632
1633 if (flags & _DRM_VBLANK_EVENT) {
1634 /* must hold on to the vblank ref until the event fires
1635 * drm_vblank_put will be called asynchronously
1636 */
1637 return drm_queue_vblank_event(dev, pipe, vblwait, file_priv);
1638 }
1639
1640 DRM_DEBUG("waiting on vblank count %u, crtc %u\n",
1641 vblwait->request.sequence, pipe);
1642 DRM_WAIT_ON(ret, vblank->queue, 3 * HZ,
1643 (((drm_vblank_count(dev, pipe) -
1644 vblwait->request.sequence) <= (1 << 23)) ||
1645 !vblank->enabled ||
1646 !dev->irq_enabled));
1647
1648 if (ret != -EINTR) {
1649 struct timeval now;
1650
1651 vblwait->reply.sequence = drm_vblank_count_and_time(dev, pipe, &now);
1652 vblwait->reply.tval_sec = now.tv_sec;
1653 vblwait->reply.tval_usec = now.tv_usec;
1654
1655 DRM_DEBUG("returning %u to client\n",
1656 vblwait->reply.sequence);
1657 } else {
1658 DRM_DEBUG("vblank wait interrupted by signal\n");
1659 }
1660
1661done:
1662 drm_vblank_put(dev, pipe);
1663 return ret;
1664}
1665
1666static void drm_handle_vblank_events(struct drm_device *dev, unsigned int pipe)
1667{
1668 struct drm_pending_vblank_event *e, *t;
1669 struct timeval now;
1670 unsigned int seq;
1671
1672 assert_spin_locked(&dev->event_lock);
1673
1674 seq = drm_vblank_count_and_time(dev, pipe, &now);
1675
1676 list_for_each_entry_safe(e, t, &dev->vblank_event_list, base.link) {
1677 if (e->pipe != pipe)
1678 continue;
1679 if ((seq - e->event.sequence) > (1<<23))
1680 continue;
1681
1682 DRM_DEBUG("vblank event on %u, current %u\n",
1683 e->event.sequence, seq);
1684
1685 list_del(&e->base.link);
1686 drm_vblank_put(dev, pipe);
1687 send_vblank_event(dev, e, seq, &now);
1688 }
1689
1690 trace_drm_vblank_event(pipe, seq);
1691}
1692
1693/**
1694 * drm_handle_vblank - handle a vblank event
1695 * @dev: DRM device
1696 * @pipe: index of CRTC where this event occurred
1697 *
1698 * Drivers should call this routine in their vblank interrupt handlers to
1699 * update the vblank counter and send any signals that may be pending.
1700 *
1701 * This is the legacy version of drm_crtc_handle_vblank().
1702 */
1703bool drm_handle_vblank(struct drm_device *dev, unsigned int pipe)
1704{
1705 struct drm_vblank_crtc *vblank = &dev->vblank[pipe];
1706 unsigned long irqflags;
1707
1708 if (WARN_ON_ONCE(!dev->num_crtcs))
1709 return false;
1710
1711 if (WARN_ON(pipe >= dev->num_crtcs))
1712 return false;
1713
1714 spin_lock_irqsave(&dev->event_lock, irqflags);
1715
1716 /* Need timestamp lock to prevent concurrent execution with
1717 * vblank enable/disable, as this would cause inconsistent
1718 * or corrupted timestamps and vblank counts.
1719 */
1720 spin_lock(&dev->vblank_time_lock);
1721
1722 /* Vblank irq handling disabled. Nothing to do. */
1723 if (!vblank->enabled) {
1724 spin_unlock(&dev->vblank_time_lock);
1725 spin_unlock_irqrestore(&dev->event_lock, irqflags);
1726 return false;
1727 }
1728
1729 drm_update_vblank_count(dev, pipe, DRM_CALLED_FROM_VBLIRQ);
1730
1731 spin_unlock(&dev->vblank_time_lock);
1732
1733 wake_up(&vblank->queue);
1734 drm_handle_vblank_events(dev, pipe);
1735
1736 spin_unlock_irqrestore(&dev->event_lock, irqflags);
1737
1738 return true;
1739}
1740EXPORT_SYMBOL(drm_handle_vblank);
1741
1742/**
1743 * drm_crtc_handle_vblank - handle a vblank event
1744 * @crtc: where this event occurred
1745 *
1746 * Drivers should call this routine in their vblank interrupt handlers to
1747 * update the vblank counter and send any signals that may be pending.
1748 *
1749 * This is the native KMS version of drm_handle_vblank().
1750 *
1751 * Returns:
1752 * True if the event was successfully handled, false on failure.
1753 */
1754bool drm_crtc_handle_vblank(struct drm_crtc *crtc)
1755{
1756 return drm_handle_vblank(crtc->dev, drm_crtc_index(crtc));
1757}
1758EXPORT_SYMBOL(drm_crtc_handle_vblank);
1759
1760/**
1761 * drm_vblank_no_hw_counter - "No hw counter" implementation of .get_vblank_counter()
1762 * @dev: DRM device
1763 * @pipe: CRTC for which to read the counter
1764 *
1765 * Drivers can plug this into the .get_vblank_counter() function if
1766 * there is no useable hardware frame counter available.
1767 *
1768 * Returns:
1769 * 0
1770 */
1771u32 drm_vblank_no_hw_counter(struct drm_device *dev, unsigned int pipe)
1772{
1773 WARN_ON_ONCE(dev->max_vblank_count != 0);
1774 return 0;
1775}
1776EXPORT_SYMBOL(drm_vblank_no_hw_counter);
1/**
2 * \file drm_irq.c
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
36#include "drmP.h"
37#include "drm_trace.h"
38
39#include <linux/interrupt.h> /* For task queue support */
40#include <linux/slab.h>
41
42#include <linux/vgaarb.h>
43#include <linux/export.h>
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
60/**
61 * Get interrupt from bus id.
62 *
63 * \param inode device inode.
64 * \param file_priv DRM file private.
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.
68 *
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 */
73int drm_irq_by_busid(struct drm_device *dev, void *data,
74 struct drm_file *file_priv)
75{
76 struct drm_irq_busid *p = data;
77
78 if (!dev->driver->bus->irq_by_busid)
79 return -EINVAL;
80
81 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
82 return -EINVAL;
83
84 return dev->driver->bus->irq_by_busid(dev, p);
85}
86
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.
113 */
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 */
155 if ((vblrc > 0) && (abs64(diff_ns) > 1000000)) {
156 atomic_inc(&dev->_vblank_count[crtc]);
157 smp_mb__after_atomic_inc();
158 }
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);
164}
165
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);
180 vblank_disable_and_save(dev, i);
181 }
182 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
183 }
184}
185
186void drm_vblank_cleanup(struct drm_device *dev)
187{
188 /* Bail if the driver didn't call drm_vblank_init() */
189 if (dev->num_crtcs == 0)
190 return;
191
192 del_timer_sync(&dev->vblank_disable_timer);
193
194 vblank_disable_fn((unsigned long)dev);
195
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);
203 kfree(dev->_vblank_time);
204
205 dev->num_crtcs = 0;
206}
207EXPORT_SYMBOL(drm_vblank_cleanup);
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);
216 spin_lock_init(&dev->vblank_time_lock);
217
218 dev->num_crtcs = num_crtcs;
219
220 dev->vbl_queue = kmalloc(sizeof(wait_queue_head_t) * num_crtcs,
221 GFP_KERNEL);
222 if (!dev->vbl_queue)
223 goto err;
224
225 dev->_vblank_count = kmalloc(sizeof(atomic_t) * num_crtcs, GFP_KERNEL);
226 if (!dev->_vblank_count)
227 goto err;
228
229 dev->vblank_refcount = kmalloc(sizeof(atomic_t) * num_crtcs,
230 GFP_KERNEL);
231 if (!dev->vblank_refcount)
232 goto err;
233
234 dev->vblank_enabled = kcalloc(num_crtcs, sizeof(int), GFP_KERNEL);
235 if (!dev->vblank_enabled)
236 goto err;
237
238 dev->last_vblank = kcalloc(num_crtcs, sizeof(u32), GFP_KERNEL);
239 if (!dev->last_vblank)
240 goto err;
241
242 dev->last_vblank_wait = kcalloc(num_crtcs, sizeof(u32), GFP_KERNEL);
243 if (!dev->last_vblank_wait)
244 goto err;
245
246 dev->vblank_inmodeset = kcalloc(num_crtcs, sizeof(int), GFP_KERNEL);
247 if (!dev->vblank_inmodeset)
248 goto err;
249
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
263 /* Zero per-crtc vblank stuff */
264 for (i = 0; i < num_crtcs; i++) {
265 init_waitqueue_head(&dev->vbl_queue[i]);
266 atomic_set(&dev->_vblank_count[i], 0);
267 atomic_set(&dev->vblank_refcount[i], 0);
268 }
269
270 dev->vblank_disable_allowed = 0;
271 return 0;
272
273err:
274 drm_vblank_cleanup(dev);
275 return ret;
276}
277EXPORT_SYMBOL(drm_vblank_init);
278
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
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);
299 }
300}
301
302/**
303 * Install IRQ handler.
304 *
305 * \param dev DRM device.
306 *
307 * Initializes the IRQ related data. Installs the handler, calling the driver
308 * \c irq_preinstall() and \c irq_postinstall() functions
309 * before and after the installation.
310 */
311int drm_irq_install(struct drm_device *dev)
312{
313 int ret;
314 unsigned long sh_flags = 0;
315 char *irqname;
316
317 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
318 return -EINVAL;
319
320 if (drm_dev_to_irq(dev) == 0)
321 return -EINVAL;
322
323 mutex_lock(&dev->struct_mutex);
324
325 /* Driver must have been initialized */
326 if (!dev->dev_private) {
327 mutex_unlock(&dev->struct_mutex);
328 return -EINVAL;
329 }
330
331 if (dev->irq_enabled) {
332 mutex_unlock(&dev->struct_mutex);
333 return -EBUSY;
334 }
335 dev->irq_enabled = 1;
336 mutex_unlock(&dev->struct_mutex);
337
338 DRM_DEBUG("irq=%d\n", drm_dev_to_irq(dev));
339
340 /* Before installing handler */
341 if (dev->driver->irq_preinstall)
342 dev->driver->irq_preinstall(dev);
343
344 /* Install handler */
345 if (drm_core_check_feature(dev, DRIVER_IRQ_SHARED))
346 sh_flags = IRQF_SHARED;
347
348 if (dev->devname)
349 irqname = dev->devname;
350 else
351 irqname = dev->driver->name;
352
353 ret = request_irq(drm_dev_to_irq(dev), dev->driver->irq_handler,
354 sh_flags, irqname, dev);
355
356 if (ret < 0) {
357 mutex_lock(&dev->struct_mutex);
358 dev->irq_enabled = 0;
359 mutex_unlock(&dev->struct_mutex);
360 return ret;
361 }
362
363 if (!drm_core_check_feature(dev, DRIVER_MODESET))
364 vga_client_register(dev->pdev, (void *)dev, drm_irq_vgaarb_nokms, NULL);
365
366 /* After installing handler */
367 if (dev->driver->irq_postinstall)
368 ret = dev->driver->irq_postinstall(dev);
369
370 if (ret < 0) {
371 mutex_lock(&dev->struct_mutex);
372 dev->irq_enabled = 0;
373 mutex_unlock(&dev->struct_mutex);
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);
377 }
378
379 return ret;
380}
381EXPORT_SYMBOL(drm_irq_install);
382
383/**
384 * Uninstall the IRQ handler.
385 *
386 * \param dev DRM device.
387 *
388 * Calls the driver's \c irq_uninstall() function, and stops the irq.
389 */
390int drm_irq_uninstall(struct drm_device *dev)
391{
392 unsigned long irqflags;
393 int irq_enabled, i;
394
395 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
396 return -EINVAL;
397
398 mutex_lock(&dev->struct_mutex);
399 irq_enabled = dev->irq_enabled;
400 dev->irq_enabled = 0;
401 mutex_unlock(&dev->struct_mutex);
402
403 /*
404 * Wake up any waiters so they don't hang.
405 */
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);
415 }
416
417 if (!irq_enabled)
418 return -EINVAL;
419
420 DRM_DEBUG("irq=%d\n", drm_dev_to_irq(dev));
421
422 if (!drm_core_check_feature(dev, DRIVER_MODESET))
423 vga_client_register(dev->pdev, NULL, NULL, NULL);
424
425 if (dev->driver->irq_uninstall)
426 dev->driver->irq_uninstall(dev);
427
428 free_irq(drm_dev_to_irq(dev), dev);
429
430 return 0;
431}
432EXPORT_SYMBOL(drm_irq_uninstall);
433
434/**
435 * IRQ control ioctl.
436 *
437 * \param inode device inode.
438 * \param file_priv DRM file private.
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 */
445int drm_control(struct drm_device *dev, void *data,
446 struct drm_file *file_priv)
447{
448 struct drm_control *ctl = data;
449
450 /* if we haven't irq we fallback for compatibility reasons -
451 * this used to be a separate function in drm_dma.h
452 */
453
454
455 switch (ctl->func) {
456 case DRM_INST_HANDLER:
457 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
458 return 0;
459 if (drm_core_check_feature(dev, DRIVER_MODESET))
460 return 0;
461 if (dev->if_version < DRM_IF_VERSION(1, 2) &&
462 ctl->irq != drm_dev_to_irq(dev))
463 return -EINVAL;
464 return drm_irq_install(dev);
465 case DRM_UNINST_HANDLER:
466 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
467 return 0;
468 if (drm_core_check_feature(dev, DRIVER_MODESET))
469 return 0;
470 return drm_irq_uninstall(dev);
471 default:
472 return -EINVAL;
473 }
474}
475
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
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
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{
579 struct timeval stime, raw_time;
580 struct drm_display_mode *mode;
581 int vbl_status, vtotal, vdisplay;
582 int vpos, hpos, i;
583 s64 framedur_ns, linedur_ns, pixeldur_ns, delta_ns, duration_ns;
584 bool invbl;
585
586 if (crtc < 0 || crtc >= dev->num_crtcs) {
587 DRM_ERROR("Invalid crtc %d\n", crtc);
588 return -EINVAL;
589 }
590
591 /* Scanout position query not supported? Should not happen. */
592 if (!dev->driver->get_scanout_position) {
593 DRM_ERROR("Called from driver w/o get_scanout_position()!?\n");
594 return -EIO;
595 }
596
597 mode = &refcrtc->hwmode;
598 vtotal = mode->crtc_vtotal;
599 vdisplay = mode->crtc_vdisplay;
600
601 /* Durations of frames, lines, pixels in nanoseconds. */
602 framedur_ns = refcrtc->framedur_ns;
603 linedur_ns = refcrtc->linedur_ns;
604 pixeldur_ns = refcrtc->pixeldur_ns;
605
606 /* If mode timing undefined, just return as no-op:
607 * Happens during initial modesetting of a crtc.
608 */
609 if (vtotal <= 0 || vdisplay <= 0 || framedur_ns == 0) {
610 DRM_DEBUG("crtc %d: Noop due to uninitialized mode.\n", crtc);
611 return -EAGAIN;
612 }
613
614 /* Get current scanout position with system timestamp.
615 * Repeat query up to DRM_TIMESTAMP_MAXRETRIES times
616 * if single query takes longer than max_error nanoseconds.
617 *
618 * This guarantees a tight bound on maximum error if
619 * code gets preempted or delayed for some reason.
620 */
621 for (i = 0; i < DRM_TIMESTAMP_MAXRETRIES; i++) {
622 /* Disable preemption to make it very likely to
623 * succeed in the first iteration even on PREEMPT_RT kernel.
624 */
625 preempt_disable();
626
627 /* Get system timestamp before query. */
628 do_gettimeofday(&stime);
629
630 /* Get vertical and horizontal scanout pos. vpos, hpos. */
631 vbl_status = dev->driver->get_scanout_position(dev, crtc, &vpos, &hpos);
632
633 /* Get system timestamp after query. */
634 do_gettimeofday(&raw_time);
635
636 preempt_enable();
637
638 /* Return as no-op if scanout query unsupported or failed. */
639 if (!(vbl_status & DRM_SCANOUTPOS_VALID)) {
640 DRM_DEBUG("crtc %d : scanoutpos query failed [%d].\n",
641 crtc, vbl_status);
642 return -EIO;
643 }
644
645 duration_ns = timeval_to_ns(&raw_time) - timeval_to_ns(&stime);
646
647 /* Accept result with < max_error nsecs timing uncertainty. */
648 if (duration_ns <= (s64) *max_error)
649 break;
650 }
651
652 /* Noisy system timing? */
653 if (i == DRM_TIMESTAMP_MAXRETRIES) {
654 DRM_DEBUG("crtc %d: Noisy timestamp %d us > %d us [%d reps].\n",
655 crtc, (int) duration_ns/1000, *max_error/1000, i);
656 }
657
658 /* Return upper bound of timestamp precision error. */
659 *max_error = (int) duration_ns;
660
661 /* Check if in vblank area:
662 * vpos is >=0 in video scanout area, but negative
663 * within vblank area, counting down the number of lines until
664 * start of scanout.
665 */
666 invbl = vbl_status & DRM_SCANOUTPOS_INVBL;
667
668 /* Convert scanout position into elapsed time at raw_time query
669 * since start of scanout at first display scanline. delta_ns
670 * can be negative if start of scanout hasn't happened yet.
671 */
672 delta_ns = (s64) vpos * linedur_ns + (s64) hpos * pixeldur_ns;
673
674 /* Is vpos outside nominal vblank area, but less than
675 * 1/100 of a frame height away from start of vblank?
676 * If so, assume this isn't a massively delayed vblank
677 * interrupt, but a vblank interrupt that fired a few
678 * microseconds before true start of vblank. Compensate
679 * by adding a full frame duration to the final timestamp.
680 * Happens, e.g., on ATI R500, R600.
681 *
682 * We only do this if DRM_CALLED_FROM_VBLIRQ.
683 */
684 if ((flags & DRM_CALLED_FROM_VBLIRQ) && !invbl &&
685 ((vdisplay - vpos) < vtotal / 100)) {
686 delta_ns = delta_ns - framedur_ns;
687
688 /* Signal this correction as "applied". */
689 vbl_status |= 0x8;
690 }
691
692 /* Subtract time delta from raw timestamp to get final
693 * vblank_time timestamp for end of vblank.
694 */
695 *vblank_time = ns_to_timeval(timeval_to_ns(&raw_time) - delta_ns);
696
697 DRM_DEBUG("crtc %d : v %d p(%d,%d)@ %ld.%ld -> %ld.%ld [e %d us, %d rep]\n",
698 crtc, (int)vbl_status, hpos, vpos,
699 (long)raw_time.tv_sec, (long)raw_time.tv_usec,
700 (long)vblank_time->tv_sec, (long)vblank_time->tv_usec,
701 (int)duration_ns/1000, i);
702
703 vbl_status = DRM_VBLANKTIME_SCANOUTPOS_METHOD;
704 if (invbl)
705 vbl_status |= DRM_VBLANKTIME_INVBL;
706
707 return vbl_status;
708}
709EXPORT_SYMBOL(drm_calc_vbltimestamp_from_scanoutpos);
710
711/**
712 * drm_get_last_vbltimestamp - retrieve raw timestamp for the most recent
713 * vblank interval.
714 *
715 * @dev: DRM device
716 * @crtc: which crtc's vblank timestamp to retrieve
717 * @tvblank: Pointer to target struct timeval which should receive the timestamp
718 * @flags: Flags to pass to driver:
719 * 0 = Default.
720 * DRM_CALLED_FROM_VBLIRQ = If function is called from vbl irq handler.
721 *
722 * Fetches the system timestamp corresponding to the time of the most recent
723 * vblank interval on specified crtc. May call into kms-driver to
724 * compute the timestamp with a high-precision GPU specific method.
725 *
726 * Returns zero if timestamp originates from uncorrected do_gettimeofday()
727 * call, i.e., it isn't very precisely locked to the true vblank.
728 *
729 * Returns non-zero if timestamp is considered to be very precise.
730 */
731u32 drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
732 struct timeval *tvblank, unsigned flags)
733{
734 int ret;
735
736 /* Define requested maximum error on timestamps (nanoseconds). */
737 int max_error = (int) drm_timestamp_precision * 1000;
738
739 /* Query driver if possible and precision timestamping enabled. */
740 if (dev->driver->get_vblank_timestamp && (max_error > 0)) {
741 ret = dev->driver->get_vblank_timestamp(dev, crtc, &max_error,
742 tvblank, flags);
743 if (ret > 0)
744 return (u32) ret;
745 }
746
747 /* GPU high precision timestamp query unsupported or failed.
748 * Return gettimeofday timestamp as best estimate.
749 */
750 do_gettimeofday(tvblank);
751
752 return 0;
753}
754EXPORT_SYMBOL(drm_get_last_vbltimestamp);
755
756/**
757 * drm_vblank_count - retrieve "cooked" vblank counter value
758 * @dev: DRM device
759 * @crtc: which counter to retrieve
760 *
761 * Fetches the "cooked" vblank count value that represents the number of
762 * vblank events since the system was booted, including lost events due to
763 * modesetting activity.
764 */
765u32 drm_vblank_count(struct drm_device *dev, int crtc)
766{
767 return atomic_read(&dev->_vblank_count[crtc]);
768}
769EXPORT_SYMBOL(drm_vblank_count);
770
771/**
772 * drm_vblank_count_and_time - retrieve "cooked" vblank counter value
773 * and the system timestamp corresponding to that vblank counter value.
774 *
775 * @dev: DRM device
776 * @crtc: which counter to retrieve
777 * @vblanktime: Pointer to struct timeval to receive the vblank timestamp.
778 *
779 * Fetches the "cooked" vblank count value that represents the number of
780 * vblank events since the system was booted, including lost events due to
781 * modesetting activity. Returns corresponding system timestamp of the time
782 * of the vblank interval that corresponds to the current value vblank counter
783 * value.
784 */
785u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
786 struct timeval *vblanktime)
787{
788 u32 cur_vblank;
789
790 /* Read timestamp from slot of _vblank_time ringbuffer
791 * that corresponds to current vblank count. Retry if
792 * count has incremented during readout. This works like
793 * a seqlock.
794 */
795 do {
796 cur_vblank = atomic_read(&dev->_vblank_count[crtc]);
797 *vblanktime = vblanktimestamp(dev, crtc, cur_vblank);
798 smp_rmb();
799 } while (cur_vblank != atomic_read(&dev->_vblank_count[crtc]));
800
801 return cur_vblank;
802}
803EXPORT_SYMBOL(drm_vblank_count_and_time);
804
805/**
806 * drm_update_vblank_count - update the master vblank counter
807 * @dev: DRM device
808 * @crtc: counter to update
809 *
810 * Call back into the driver to update the appropriate vblank counter
811 * (specified by @crtc). Deal with wraparound, if it occurred, and
812 * update the last read value so we can deal with wraparound on the next
813 * call if necessary.
814 *
815 * Only necessary when going from off->on, to account for frames we
816 * didn't get an interrupt for.
817 *
818 * Note: caller must hold dev->vbl_lock since this reads & writes
819 * device vblank fields.
820 */
821static void drm_update_vblank_count(struct drm_device *dev, int crtc)
822{
823 u32 cur_vblank, diff, tslot, rc;
824 struct timeval t_vblank;
825
826 /*
827 * Interrupts were disabled prior to this call, so deal with counter
828 * wrap if needed.
829 * NOTE! It's possible we lost a full dev->max_vblank_count events
830 * here if the register is small or we had vblank interrupts off for
831 * a long time.
832 *
833 * We repeat the hardware vblank counter & timestamp query until
834 * we get consistent results. This to prevent races between gpu
835 * updating its hardware counter while we are retrieving the
836 * corresponding vblank timestamp.
837 */
838 do {
839 cur_vblank = dev->driver->get_vblank_counter(dev, crtc);
840 rc = drm_get_last_vbltimestamp(dev, crtc, &t_vblank, 0);
841 } while (cur_vblank != dev->driver->get_vblank_counter(dev, crtc));
842
843 /* Deal with counter wrap */
844 diff = cur_vblank - dev->last_vblank[crtc];
845 if (cur_vblank < dev->last_vblank[crtc]) {
846 diff += dev->max_vblank_count;
847
848 DRM_DEBUG("last_vblank[%d]=0x%x, cur_vblank=0x%x => diff=0x%x\n",
849 crtc, dev->last_vblank[crtc], cur_vblank, diff);
850 }
851
852 DRM_DEBUG("enabling vblank interrupts on crtc %d, missed %d\n",
853 crtc, diff);
854
855 /* Reinitialize corresponding vblank timestamp if high-precision query
856 * available. Skip this step if query unsupported or failed. Will
857 * reinitialize delayed at next vblank interrupt in that case.
858 */
859 if (rc) {
860 tslot = atomic_read(&dev->_vblank_count[crtc]) + diff;
861 vblanktimestamp(dev, crtc, tslot) = t_vblank;
862 }
863
864 smp_mb__before_atomic_inc();
865 atomic_add(diff, &dev->_vblank_count[crtc]);
866 smp_mb__after_atomic_inc();
867}
868
869/**
870 * drm_vblank_get - get a reference count on vblank events
871 * @dev: DRM device
872 * @crtc: which CRTC to own
873 *
874 * Acquire a reference count on vblank events to avoid having them disabled
875 * while in use.
876 *
877 * RETURNS
878 * Zero on success, nonzero on failure.
879 */
880int drm_vblank_get(struct drm_device *dev, int crtc)
881{
882 unsigned long irqflags, irqflags2;
883 int ret = 0;
884
885 spin_lock_irqsave(&dev->vbl_lock, irqflags);
886 /* Going from 0->1 means we have to enable interrupts again */
887 if (atomic_add_return(1, &dev->vblank_refcount[crtc]) == 1) {
888 spin_lock_irqsave(&dev->vblank_time_lock, irqflags2);
889 if (!dev->vblank_enabled[crtc]) {
890 /* Enable vblank irqs under vblank_time_lock protection.
891 * All vblank count & timestamp updates are held off
892 * until we are done reinitializing master counter and
893 * timestamps. Filtercode in drm_handle_vblank() will
894 * prevent double-accounting of same vblank interval.
895 */
896 ret = dev->driver->enable_vblank(dev, crtc);
897 DRM_DEBUG("enabling vblank on crtc %d, ret: %d\n",
898 crtc, ret);
899 if (ret)
900 atomic_dec(&dev->vblank_refcount[crtc]);
901 else {
902 dev->vblank_enabled[crtc] = 1;
903 drm_update_vblank_count(dev, crtc);
904 }
905 }
906 spin_unlock_irqrestore(&dev->vblank_time_lock, irqflags2);
907 } else {
908 if (!dev->vblank_enabled[crtc]) {
909 atomic_dec(&dev->vblank_refcount[crtc]);
910 ret = -EINVAL;
911 }
912 }
913 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
914
915 return ret;
916}
917EXPORT_SYMBOL(drm_vblank_get);
918
919/**
920 * drm_vblank_put - give up ownership of vblank events
921 * @dev: DRM device
922 * @crtc: which counter to give up
923 *
924 * Release ownership of a given vblank counter, turning off interrupts
925 * if possible. Disable interrupts after drm_vblank_offdelay milliseconds.
926 */
927void drm_vblank_put(struct drm_device *dev, int crtc)
928{
929 BUG_ON(atomic_read(&dev->vblank_refcount[crtc]) == 0);
930
931 /* Last user schedules interrupt disable */
932 if (atomic_dec_and_test(&dev->vblank_refcount[crtc]) &&
933 (drm_vblank_offdelay > 0))
934 mod_timer(&dev->vblank_disable_timer,
935 jiffies + ((drm_vblank_offdelay * DRM_HZ)/1000));
936}
937EXPORT_SYMBOL(drm_vblank_put);
938
939void drm_vblank_off(struct drm_device *dev, int crtc)
940{
941 struct drm_pending_vblank_event *e, *t;
942 struct timeval now;
943 unsigned long irqflags;
944 unsigned int seq;
945
946 spin_lock_irqsave(&dev->vbl_lock, irqflags);
947 vblank_disable_and_save(dev, crtc);
948 DRM_WAKEUP(&dev->vbl_queue[crtc]);
949
950 /* Send any queued vblank events, lest the natives grow disquiet */
951 seq = drm_vblank_count_and_time(dev, crtc, &now);
952 list_for_each_entry_safe(e, t, &dev->vblank_event_list, base.link) {
953 if (e->pipe != crtc)
954 continue;
955 DRM_DEBUG("Sending premature vblank event on disable: \
956 wanted %d, current %d\n",
957 e->event.sequence, seq);
958
959 e->event.sequence = seq;
960 e->event.tv_sec = now.tv_sec;
961 e->event.tv_usec = now.tv_usec;
962 drm_vblank_put(dev, e->pipe);
963 list_move_tail(&e->base.link, &e->base.file_priv->event_list);
964 wake_up_interruptible(&e->base.file_priv->event_wait);
965 trace_drm_vblank_event_delivered(e->base.pid, e->pipe,
966 e->event.sequence);
967 }
968
969 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
970}
971EXPORT_SYMBOL(drm_vblank_off);
972
973/**
974 * drm_vblank_pre_modeset - account for vblanks across mode sets
975 * @dev: DRM device
976 * @crtc: CRTC in question
977 * @post: post or pre mode set?
978 *
979 * Account for vblank events across mode setting events, which will likely
980 * reset the hardware frame counter.
981 */
982void drm_vblank_pre_modeset(struct drm_device *dev, int crtc)
983{
984 /* vblank is not initialized (IRQ not installed ?) */
985 if (!dev->num_crtcs)
986 return;
987 /*
988 * To avoid all the problems that might happen if interrupts
989 * were enabled/disabled around or between these calls, we just
990 * have the kernel take a reference on the CRTC (just once though
991 * to avoid corrupting the count if multiple, mismatch calls occur),
992 * so that interrupts remain enabled in the interim.
993 */
994 if (!dev->vblank_inmodeset[crtc]) {
995 dev->vblank_inmodeset[crtc] = 0x1;
996 if (drm_vblank_get(dev, crtc) == 0)
997 dev->vblank_inmodeset[crtc] |= 0x2;
998 }
999}
1000EXPORT_SYMBOL(drm_vblank_pre_modeset);
1001
1002void drm_vblank_post_modeset(struct drm_device *dev, int crtc)
1003{
1004 unsigned long irqflags;
1005
1006 if (dev->vblank_inmodeset[crtc]) {
1007 spin_lock_irqsave(&dev->vbl_lock, irqflags);
1008 dev->vblank_disable_allowed = 1;
1009 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
1010
1011 if (dev->vblank_inmodeset[crtc] & 0x2)
1012 drm_vblank_put(dev, crtc);
1013
1014 dev->vblank_inmodeset[crtc] = 0;
1015 }
1016}
1017EXPORT_SYMBOL(drm_vblank_post_modeset);
1018
1019/**
1020 * drm_modeset_ctl - handle vblank event counter changes across mode switch
1021 * @DRM_IOCTL_ARGS: standard ioctl arguments
1022 *
1023 * Applications should call the %_DRM_PRE_MODESET and %_DRM_POST_MODESET
1024 * ioctls around modesetting so that any lost vblank events are accounted for.
1025 *
1026 * Generally the counter will reset across mode sets. If interrupts are
1027 * enabled around this call, we don't have to do anything since the counter
1028 * will have already been incremented.
1029 */
1030int drm_modeset_ctl(struct drm_device *dev, void *data,
1031 struct drm_file *file_priv)
1032{
1033 struct drm_modeset_ctl *modeset = data;
1034 unsigned int crtc;
1035
1036 /* If drm_vblank_init() hasn't been called yet, just no-op */
1037 if (!dev->num_crtcs)
1038 return 0;
1039
1040 crtc = modeset->crtc;
1041 if (crtc >= dev->num_crtcs)
1042 return -EINVAL;
1043
1044 switch (modeset->cmd) {
1045 case _DRM_PRE_MODESET:
1046 drm_vblank_pre_modeset(dev, crtc);
1047 break;
1048 case _DRM_POST_MODESET:
1049 drm_vblank_post_modeset(dev, crtc);
1050 break;
1051 default:
1052 return -EINVAL;
1053 }
1054
1055 return 0;
1056}
1057
1058static int drm_queue_vblank_event(struct drm_device *dev, int pipe,
1059 union drm_wait_vblank *vblwait,
1060 struct drm_file *file_priv)
1061{
1062 struct drm_pending_vblank_event *e;
1063 struct timeval now;
1064 unsigned long flags;
1065 unsigned int seq;
1066 int ret;
1067
1068 e = kzalloc(sizeof *e, GFP_KERNEL);
1069 if (e == NULL) {
1070 ret = -ENOMEM;
1071 goto err_put;
1072 }
1073
1074 e->pipe = pipe;
1075 e->base.pid = current->pid;
1076 e->event.base.type = DRM_EVENT_VBLANK;
1077 e->event.base.length = sizeof e->event;
1078 e->event.user_data = vblwait->request.signal;
1079 e->base.event = &e->event.base;
1080 e->base.file_priv = file_priv;
1081 e->base.destroy = (void (*) (struct drm_pending_event *)) kfree;
1082
1083 spin_lock_irqsave(&dev->event_lock, flags);
1084
1085 if (file_priv->event_space < sizeof e->event) {
1086 ret = -EBUSY;
1087 goto err_unlock;
1088 }
1089
1090 file_priv->event_space -= sizeof e->event;
1091 seq = drm_vblank_count_and_time(dev, pipe, &now);
1092
1093 if ((vblwait->request.type & _DRM_VBLANK_NEXTONMISS) &&
1094 (seq - vblwait->request.sequence) <= (1 << 23)) {
1095 vblwait->request.sequence = seq + 1;
1096 vblwait->reply.sequence = vblwait->request.sequence;
1097 }
1098
1099 DRM_DEBUG("event on vblank count %d, current %d, crtc %d\n",
1100 vblwait->request.sequence, seq, pipe);
1101
1102 trace_drm_vblank_event_queued(current->pid, pipe,
1103 vblwait->request.sequence);
1104
1105 e->event.sequence = vblwait->request.sequence;
1106 if ((seq - vblwait->request.sequence) <= (1 << 23)) {
1107 e->event.sequence = seq;
1108 e->event.tv_sec = now.tv_sec;
1109 e->event.tv_usec = now.tv_usec;
1110 drm_vblank_put(dev, pipe);
1111 list_add_tail(&e->base.link, &e->base.file_priv->event_list);
1112 wake_up_interruptible(&e->base.file_priv->event_wait);
1113 vblwait->reply.sequence = seq;
1114 trace_drm_vblank_event_delivered(current->pid, pipe,
1115 vblwait->request.sequence);
1116 } else {
1117 /* drm_handle_vblank_events will call drm_vblank_put */
1118 list_add_tail(&e->base.link, &dev->vblank_event_list);
1119 vblwait->reply.sequence = vblwait->request.sequence;
1120 }
1121
1122 spin_unlock_irqrestore(&dev->event_lock, flags);
1123
1124 return 0;
1125
1126err_unlock:
1127 spin_unlock_irqrestore(&dev->event_lock, flags);
1128 kfree(e);
1129err_put:
1130 drm_vblank_put(dev, pipe);
1131 return ret;
1132}
1133
1134/**
1135 * Wait for VBLANK.
1136 *
1137 * \param inode device inode.
1138 * \param file_priv DRM file private.
1139 * \param cmd command.
1140 * \param data user argument, pointing to a drm_wait_vblank structure.
1141 * \return zero on success or a negative number on failure.
1142 *
1143 * This function enables the vblank interrupt on the pipe requested, then
1144 * sleeps waiting for the requested sequence number to occur, and drops
1145 * the vblank interrupt refcount afterwards. (vblank irq disable follows that
1146 * after a timeout with no further vblank waits scheduled).
1147 */
1148int drm_wait_vblank(struct drm_device *dev, void *data,
1149 struct drm_file *file_priv)
1150{
1151 union drm_wait_vblank *vblwait = data;
1152 int ret;
1153 unsigned int flags, seq, crtc, high_crtc;
1154
1155 if ((!drm_dev_to_irq(dev)) || (!dev->irq_enabled))
1156 return -EINVAL;
1157
1158 if (vblwait->request.type & _DRM_VBLANK_SIGNAL)
1159 return -EINVAL;
1160
1161 if (vblwait->request.type &
1162 ~(_DRM_VBLANK_TYPES_MASK | _DRM_VBLANK_FLAGS_MASK |
1163 _DRM_VBLANK_HIGH_CRTC_MASK)) {
1164 DRM_ERROR("Unsupported type value 0x%x, supported mask 0x%x\n",
1165 vblwait->request.type,
1166 (_DRM_VBLANK_TYPES_MASK | _DRM_VBLANK_FLAGS_MASK |
1167 _DRM_VBLANK_HIGH_CRTC_MASK));
1168 return -EINVAL;
1169 }
1170
1171 flags = vblwait->request.type & _DRM_VBLANK_FLAGS_MASK;
1172 high_crtc = (vblwait->request.type & _DRM_VBLANK_HIGH_CRTC_MASK);
1173 if (high_crtc)
1174 crtc = high_crtc >> _DRM_VBLANK_HIGH_CRTC_SHIFT;
1175 else
1176 crtc = flags & _DRM_VBLANK_SECONDARY ? 1 : 0;
1177 if (crtc >= dev->num_crtcs)
1178 return -EINVAL;
1179
1180 ret = drm_vblank_get(dev, crtc);
1181 if (ret) {
1182 DRM_DEBUG("failed to acquire vblank counter, %d\n", ret);
1183 return ret;
1184 }
1185 seq = drm_vblank_count(dev, crtc);
1186
1187 switch (vblwait->request.type & _DRM_VBLANK_TYPES_MASK) {
1188 case _DRM_VBLANK_RELATIVE:
1189 vblwait->request.sequence += seq;
1190 vblwait->request.type &= ~_DRM_VBLANK_RELATIVE;
1191 case _DRM_VBLANK_ABSOLUTE:
1192 break;
1193 default:
1194 ret = -EINVAL;
1195 goto done;
1196 }
1197
1198 if (flags & _DRM_VBLANK_EVENT) {
1199 /* must hold on to the vblank ref until the event fires
1200 * drm_vblank_put will be called asynchronously
1201 */
1202 return drm_queue_vblank_event(dev, crtc, vblwait, file_priv);
1203 }
1204
1205 if ((flags & _DRM_VBLANK_NEXTONMISS) &&
1206 (seq - vblwait->request.sequence) <= (1<<23)) {
1207 vblwait->request.sequence = seq + 1;
1208 }
1209
1210 DRM_DEBUG("waiting on vblank count %d, crtc %d\n",
1211 vblwait->request.sequence, crtc);
1212 dev->last_vblank_wait[crtc] = vblwait->request.sequence;
1213 DRM_WAIT_ON(ret, dev->vbl_queue[crtc], 3 * DRM_HZ,
1214 (((drm_vblank_count(dev, crtc) -
1215 vblwait->request.sequence) <= (1 << 23)) ||
1216 !dev->irq_enabled));
1217
1218 if (ret != -EINTR) {
1219 struct timeval now;
1220
1221 vblwait->reply.sequence = drm_vblank_count_and_time(dev, crtc, &now);
1222 vblwait->reply.tval_sec = now.tv_sec;
1223 vblwait->reply.tval_usec = now.tv_usec;
1224
1225 DRM_DEBUG("returning %d to client\n",
1226 vblwait->reply.sequence);
1227 } else {
1228 DRM_DEBUG("vblank wait interrupted by signal\n");
1229 }
1230
1231done:
1232 drm_vblank_put(dev, crtc);
1233 return ret;
1234}
1235
1236void drm_handle_vblank_events(struct drm_device *dev, int crtc)
1237{
1238 struct drm_pending_vblank_event *e, *t;
1239 struct timeval now;
1240 unsigned long flags;
1241 unsigned int seq;
1242
1243 seq = drm_vblank_count_and_time(dev, crtc, &now);
1244
1245 spin_lock_irqsave(&dev->event_lock, flags);
1246
1247 list_for_each_entry_safe(e, t, &dev->vblank_event_list, base.link) {
1248 if (e->pipe != crtc)
1249 continue;
1250 if ((seq - e->event.sequence) > (1<<23))
1251 continue;
1252
1253 DRM_DEBUG("vblank event on %d, current %d\n",
1254 e->event.sequence, seq);
1255
1256 e->event.sequence = seq;
1257 e->event.tv_sec = now.tv_sec;
1258 e->event.tv_usec = now.tv_usec;
1259 drm_vblank_put(dev, e->pipe);
1260 list_move_tail(&e->base.link, &e->base.file_priv->event_list);
1261 wake_up_interruptible(&e->base.file_priv->event_wait);
1262 trace_drm_vblank_event_delivered(e->base.pid, e->pipe,
1263 e->event.sequence);
1264 }
1265
1266 spin_unlock_irqrestore(&dev->event_lock, flags);
1267
1268 trace_drm_vblank_event(crtc, seq);
1269}
1270
1271/**
1272 * drm_handle_vblank - handle a vblank event
1273 * @dev: DRM device
1274 * @crtc: where this event occurred
1275 *
1276 * Drivers should call this routine in their vblank interrupt handlers to
1277 * update the vblank counter and send any signals that may be pending.
1278 */
1279bool drm_handle_vblank(struct drm_device *dev, int crtc)
1280{
1281 u32 vblcount;
1282 s64 diff_ns;
1283 struct timeval tvblank;
1284 unsigned long irqflags;
1285
1286 if (!dev->num_crtcs)
1287 return false;
1288
1289 /* Need timestamp lock to prevent concurrent execution with
1290 * vblank enable/disable, as this would cause inconsistent
1291 * or corrupted timestamps and vblank counts.
1292 */
1293 spin_lock_irqsave(&dev->vblank_time_lock, irqflags);
1294
1295 /* Vblank irq handling disabled. Nothing to do. */
1296 if (!dev->vblank_enabled[crtc]) {
1297 spin_unlock_irqrestore(&dev->vblank_time_lock, irqflags);
1298 return false;
1299 }
1300
1301 /* Fetch corresponding timestamp for this vblank interval from
1302 * driver and store it in proper slot of timestamp ringbuffer.
1303 */
1304
1305 /* Get current timestamp and count. */
1306 vblcount = atomic_read(&dev->_vblank_count[crtc]);
1307 drm_get_last_vbltimestamp(dev, crtc, &tvblank, DRM_CALLED_FROM_VBLIRQ);
1308
1309 /* Compute time difference to timestamp of last vblank */
1310 diff_ns = timeval_to_ns(&tvblank) -
1311 timeval_to_ns(&vblanktimestamp(dev, crtc, vblcount));
1312
1313 /* Update vblank timestamp and count if at least
1314 * DRM_REDUNDANT_VBLIRQ_THRESH_NS nanoseconds
1315 * difference between last stored timestamp and current
1316 * timestamp. A smaller difference means basically
1317 * identical timestamps. Happens if this vblank has
1318 * been already processed and this is a redundant call,
1319 * e.g., due to spurious vblank interrupts. We need to
1320 * ignore those for accounting.
1321 */
1322 if (abs64(diff_ns) > DRM_REDUNDANT_VBLIRQ_THRESH_NS) {
1323 /* Store new timestamp in ringbuffer. */
1324 vblanktimestamp(dev, crtc, vblcount + 1) = tvblank;
1325
1326 /* Increment cooked vblank count. This also atomically commits
1327 * the timestamp computed above.
1328 */
1329 smp_mb__before_atomic_inc();
1330 atomic_inc(&dev->_vblank_count[crtc]);
1331 smp_mb__after_atomic_inc();
1332 } else {
1333 DRM_DEBUG("crtc %d: Redundant vblirq ignored. diff_ns = %d\n",
1334 crtc, (int) diff_ns);
1335 }
1336
1337 DRM_WAKEUP(&dev->vbl_queue[crtc]);
1338 drm_handle_vblank_events(dev, crtc);
1339
1340 spin_unlock_irqrestore(&dev->vblank_time_lock, irqflags);
1341 return true;
1342}
1343EXPORT_SYMBOL(drm_handle_vblank);