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