• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 
59 static bool
60 drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
61 			  struct timeval *tvblank, unsigned flags);
62 
63 static 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  */
69 unsigned int drm_timestamp_monotonic = 1;
70 
71 static int drm_vblank_offdelay = 5000;    /* Default to 5000 msecs. */
72 
73 module_param_named(vblankoffdelay, drm_vblank_offdelay, int, 0600);
74 module_param_named(timestamp_precision_usec, drm_timestamp_precision, int, 0600);
75 module_param_named(timestamp_monotonic, drm_timestamp_monotonic, int, 0600);
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  */
drm_update_vblank_count(struct drm_device * dev,int crtc)93 static 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 and
135 	 * assign 0 for now, to mark the vblanktimestamp as invalid.
136 	 */
137 	tslot = atomic_read(&vblank->count) + diff;
138 	vblanktimestamp(dev, crtc, tslot) = rc ? t_vblank : (struct timeval) {0, 0};
139 
140 	smp_mb__before_atomic();
141 	atomic_add(diff, &vblank->count);
142 	smp_mb__after_atomic();
143 }
144 
145 /*
146  * Disable vblank irq's on crtc, make sure that last vblank count
147  * of hardware and corresponding consistent software vblank counter
148  * are preserved, even if there are any spurious vblank irq's after
149  * disable.
150  */
vblank_disable_and_save(struct drm_device * dev,int crtc)151 static void vblank_disable_and_save(struct drm_device *dev, int crtc)
152 {
153 	struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
154 	unsigned long irqflags;
155 	u32 vblcount;
156 	s64 diff_ns;
157 	bool vblrc;
158 	struct timeval tvblank;
159 	int count = DRM_TIMESTAMP_MAXRETRIES;
160 
161 	/* Prevent vblank irq processing while disabling vblank irqs,
162 	 * so no updates of timestamps or count can happen after we've
163 	 * disabled. Needed to prevent races in case of delayed irq's.
164 	 */
165 	spin_lock_irqsave(&dev->vblank_time_lock, irqflags);
166 
167 	/*
168 	 * If the vblank interrupt was already disbled update the count
169 	 * and timestamp to maintain the appearance that the counter
170 	 * has been ticking all along until this time. This makes the
171 	 * count account for the entire time between drm_vblank_on() and
172 	 * drm_vblank_off().
173 	 *
174 	 * But only do this if precise vblank timestamps are available.
175 	 * Otherwise we might read a totally bogus timestamp since drivers
176 	 * lacking precise timestamp support rely upon sampling the system clock
177 	 * at vblank interrupt time. Which obviously won't work out well if the
178 	 * vblank interrupt is disabled.
179 	 */
180 	if (!vblank->enabled &&
181 	    drm_get_last_vbltimestamp(dev, crtc, &tvblank, 0)) {
182 		drm_update_vblank_count(dev, crtc);
183 		spin_unlock_irqrestore(&dev->vblank_time_lock, irqflags);
184 		return;
185 	}
186 
187 	dev->driver->disable_vblank(dev, crtc);
188 	vblank->enabled = false;
189 
190 	/* No further vblank irq's will be processed after
191 	 * this point. Get current hardware vblank count and
192 	 * vblank timestamp, repeat until they are consistent.
193 	 *
194 	 * FIXME: There is still a race condition here and in
195 	 * drm_update_vblank_count() which can cause off-by-one
196 	 * reinitialization of software vblank counter. If gpu
197 	 * vblank counter doesn't increment exactly at the leading
198 	 * edge of a vblank interval, then we can lose 1 count if
199 	 * we happen to execute between start of vblank and the
200 	 * delayed gpu counter increment.
201 	 */
202 	do {
203 		vblank->last = dev->driver->get_vblank_counter(dev, crtc);
204 		vblrc = drm_get_last_vbltimestamp(dev, crtc, &tvblank, 0);
205 	} while (vblank->last != dev->driver->get_vblank_counter(dev, crtc) && (--count) && vblrc);
206 
207 	if (!count)
208 		vblrc = 0;
209 
210 	/* Compute time difference to stored timestamp of last vblank
211 	 * as updated by last invocation of drm_handle_vblank() in vblank irq.
212 	 */
213 	vblcount = atomic_read(&vblank->count);
214 	diff_ns = timeval_to_ns(&tvblank) -
215 		  timeval_to_ns(&vblanktimestamp(dev, crtc, vblcount));
216 
217 	/* If there is at least 1 msec difference between the last stored
218 	 * timestamp and tvblank, then we are currently executing our
219 	 * disable inside a new vblank interval, the tvblank timestamp
220 	 * corresponds to this new vblank interval and the irq handler
221 	 * for this vblank didn't run yet and won't run due to our disable.
222 	 * Therefore we need to do the job of drm_handle_vblank() and
223 	 * increment the vblank counter by one to account for this vblank.
224 	 *
225 	 * Skip this step if there isn't any high precision timestamp
226 	 * available. In that case we can't account for this and just
227 	 * hope for the best.
228 	 */
229 	if (vblrc && (abs64(diff_ns) > 1000000)) {
230 		/* Store new timestamp in ringbuffer. */
231 		vblanktimestamp(dev, crtc, vblcount + 1) = tvblank;
232 
233 		/* Increment cooked vblank count. This also atomically commits
234 		 * the timestamp computed above.
235 		 */
236 		smp_mb__before_atomic();
237 		atomic_inc(&vblank->count);
238 		smp_mb__after_atomic();
239 	}
240 
241 	spin_unlock_irqrestore(&dev->vblank_time_lock, irqflags);
242 }
243 
vblank_disable_fn(unsigned long arg)244 static void vblank_disable_fn(unsigned long arg)
245 {
246 	struct drm_vblank_crtc *vblank = (void *)arg;
247 	struct drm_device *dev = vblank->dev;
248 	unsigned long irqflags;
249 	int crtc = vblank->crtc;
250 
251 	if (!dev->vblank_disable_allowed)
252 		return;
253 
254 	spin_lock_irqsave(&dev->vbl_lock, irqflags);
255 	if (atomic_read(&vblank->refcount) == 0 && vblank->enabled) {
256 		DRM_DEBUG("disabling vblank on crtc %d\n", crtc);
257 		vblank_disable_and_save(dev, crtc);
258 	}
259 	spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
260 }
261 
262 /**
263  * drm_vblank_cleanup - cleanup vblank support
264  * @dev: DRM device
265  *
266  * This function cleans up any resources allocated in drm_vblank_init.
267  */
drm_vblank_cleanup(struct drm_device * dev)268 void drm_vblank_cleanup(struct drm_device *dev)
269 {
270 	int crtc;
271 	unsigned long irqflags;
272 
273 	/* Bail if the driver didn't call drm_vblank_init() */
274 	if (dev->num_crtcs == 0)
275 		return;
276 
277 	for (crtc = 0; crtc < dev->num_crtcs; crtc++) {
278 		struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
279 
280 		del_timer_sync(&vblank->disable_timer);
281 
282 		spin_lock_irqsave(&dev->vbl_lock, irqflags);
283 		vblank_disable_and_save(dev, crtc);
284 		spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
285 	}
286 
287 	kfree(dev->vblank);
288 
289 	dev->num_crtcs = 0;
290 }
291 EXPORT_SYMBOL(drm_vblank_cleanup);
292 
293 /**
294  * drm_vblank_init - initialize vblank support
295  * @dev: drm_device
296  * @num_crtcs: number of crtcs supported by @dev
297  *
298  * This function initializes vblank support for @num_crtcs display pipelines.
299  *
300  * Returns:
301  * Zero on success or a negative error code on failure.
302  */
drm_vblank_init(struct drm_device * dev,int num_crtcs)303 int drm_vblank_init(struct drm_device *dev, int num_crtcs)
304 {
305 	int i, ret = -ENOMEM;
306 
307 	spin_lock_init(&dev->vbl_lock);
308 	spin_lock_init(&dev->vblank_time_lock);
309 
310 	dev->num_crtcs = num_crtcs;
311 
312 	dev->vblank = kcalloc(num_crtcs, sizeof(*dev->vblank), GFP_KERNEL);
313 	if (!dev->vblank)
314 		goto err;
315 
316 	for (i = 0; i < num_crtcs; i++) {
317 		struct drm_vblank_crtc *vblank = &dev->vblank[i];
318 
319 		vblank->dev = dev;
320 		vblank->crtc = i;
321 		init_waitqueue_head(&vblank->queue);
322 		setup_timer(&vblank->disable_timer, vblank_disable_fn,
323 			    (unsigned long)vblank);
324 	}
325 
326 	DRM_INFO("Supports vblank timestamp caching Rev 2 (21.10.2013).\n");
327 
328 	/* Driver specific high-precision vblank timestamping supported? */
329 	if (dev->driver->get_vblank_timestamp)
330 		DRM_INFO("Driver supports precise vblank timestamp query.\n");
331 	else
332 		DRM_INFO("No driver support for vblank timestamp query.\n");
333 
334 	dev->vblank_disable_allowed = false;
335 
336 	return 0;
337 
338 err:
339 	dev->num_crtcs = 0;
340 	return ret;
341 }
342 EXPORT_SYMBOL(drm_vblank_init);
343 
drm_irq_vgaarb_nokms(void * cookie,bool state)344 static void drm_irq_vgaarb_nokms(void *cookie, bool state)
345 {
346 	struct drm_device *dev = cookie;
347 
348 	if (dev->driver->vgaarb_irq) {
349 		dev->driver->vgaarb_irq(dev, state);
350 		return;
351 	}
352 
353 	if (!dev->irq_enabled)
354 		return;
355 
356 	if (state) {
357 		if (dev->driver->irq_uninstall)
358 			dev->driver->irq_uninstall(dev);
359 	} else {
360 		if (dev->driver->irq_preinstall)
361 			dev->driver->irq_preinstall(dev);
362 		if (dev->driver->irq_postinstall)
363 			dev->driver->irq_postinstall(dev);
364 	}
365 }
366 
367 /**
368  * drm_irq_install - install IRQ handler
369  * @dev: DRM device
370  * @irq: IRQ number to install the handler for
371  *
372  * Initializes the IRQ related data. Installs the handler, calling the driver
373  * irq_preinstall() and irq_postinstall() functions before and after the
374  * installation.
375  *
376  * This is the simplified helper interface provided for drivers with no special
377  * needs. Drivers which need to install interrupt handlers for multiple
378  * interrupts must instead set drm_device->irq_enabled to signal the DRM core
379  * that vblank interrupts are available.
380  *
381  * Returns:
382  * Zero on success or a negative error code on failure.
383  */
drm_irq_install(struct drm_device * dev,int irq)384 int drm_irq_install(struct drm_device *dev, int irq)
385 {
386 	int ret;
387 	unsigned long sh_flags = 0;
388 
389 	if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
390 		return -EINVAL;
391 
392 	if (irq == 0)
393 		return -EINVAL;
394 
395 	/* Driver must have been initialized */
396 	if (!dev->dev_private)
397 		return -EINVAL;
398 
399 	if (dev->irq_enabled)
400 		return -EBUSY;
401 	dev->irq_enabled = true;
402 
403 	DRM_DEBUG("irq=%d\n", irq);
404 
405 	/* Before installing handler */
406 	if (dev->driver->irq_preinstall)
407 		dev->driver->irq_preinstall(dev);
408 
409 	/* Install handler */
410 	if (drm_core_check_feature(dev, DRIVER_IRQ_SHARED))
411 		sh_flags = IRQF_SHARED;
412 
413 	ret = request_irq(irq, dev->driver->irq_handler,
414 			  sh_flags, dev->driver->name, dev);
415 
416 	if (ret < 0) {
417 		dev->irq_enabled = false;
418 		return ret;
419 	}
420 
421 	if (!drm_core_check_feature(dev, DRIVER_MODESET))
422 		vga_client_register(dev->pdev, (void *)dev, drm_irq_vgaarb_nokms, NULL);
423 
424 	/* After installing handler */
425 	if (dev->driver->irq_postinstall)
426 		ret = dev->driver->irq_postinstall(dev);
427 
428 	if (ret < 0) {
429 		dev->irq_enabled = false;
430 		if (!drm_core_check_feature(dev, DRIVER_MODESET))
431 			vga_client_register(dev->pdev, NULL, NULL, NULL);
432 		free_irq(irq, dev);
433 	} else {
434 		dev->irq = irq;
435 	}
436 
437 	return ret;
438 }
439 EXPORT_SYMBOL(drm_irq_install);
440 
441 /**
442  * drm_irq_uninstall - uninstall the IRQ handler
443  * @dev: DRM device
444  *
445  * Calls the driver's irq_uninstall() function and unregisters the IRQ handler.
446  * This should only be called by drivers which used drm_irq_install() to set up
447  * their interrupt handler. Other drivers must only reset
448  * drm_device->irq_enabled to false.
449  *
450  * Note that for kernel modesetting drivers it is a bug if this function fails.
451  * The sanity checks are only to catch buggy user modesetting drivers which call
452  * the same function through an ioctl.
453  *
454  * Returns:
455  * Zero on success or a negative error code on failure.
456  */
drm_irq_uninstall(struct drm_device * dev)457 int drm_irq_uninstall(struct drm_device *dev)
458 {
459 	unsigned long irqflags;
460 	bool irq_enabled;
461 	int i;
462 
463 	if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
464 		return -EINVAL;
465 
466 	irq_enabled = dev->irq_enabled;
467 	dev->irq_enabled = false;
468 
469 	/*
470 	 * Wake up any waiters so they don't hang.
471 	 */
472 	if (dev->num_crtcs) {
473 		spin_lock_irqsave(&dev->vbl_lock, irqflags);
474 		for (i = 0; i < dev->num_crtcs; i++) {
475 			struct drm_vblank_crtc *vblank = &dev->vblank[i];
476 
477 			wake_up(&vblank->queue);
478 			vblank->enabled = false;
479 			vblank->last =
480 				dev->driver->get_vblank_counter(dev, i);
481 		}
482 		spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
483 	}
484 
485 	if (!irq_enabled)
486 		return -EINVAL;
487 
488 	DRM_DEBUG("irq=%d\n", dev->irq);
489 
490 	if (!drm_core_check_feature(dev, DRIVER_MODESET))
491 		vga_client_register(dev->pdev, NULL, NULL, NULL);
492 
493 	if (dev->driver->irq_uninstall)
494 		dev->driver->irq_uninstall(dev);
495 
496 	free_irq(dev->irq, dev);
497 
498 	return 0;
499 }
500 EXPORT_SYMBOL(drm_irq_uninstall);
501 
502 /*
503  * IRQ control ioctl.
504  *
505  * \param inode device inode.
506  * \param file_priv DRM file private.
507  * \param cmd command.
508  * \param arg user argument, pointing to a drm_control structure.
509  * \return zero on success or a negative number on failure.
510  *
511  * Calls irq_install() or irq_uninstall() according to \p arg.
512  */
drm_control(struct drm_device * dev,void * data,struct drm_file * file_priv)513 int drm_control(struct drm_device *dev, void *data,
514 		struct drm_file *file_priv)
515 {
516 	struct drm_control *ctl = data;
517 	int ret = 0, irq;
518 
519 	/* if we haven't irq we fallback for compatibility reasons -
520 	 * this used to be a separate function in drm_dma.h
521 	 */
522 
523 	if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
524 		return 0;
525 	if (drm_core_check_feature(dev, DRIVER_MODESET))
526 		return 0;
527 	/* UMS was only ever support on pci devices. */
528 	if (WARN_ON(!dev->pdev))
529 		return -EINVAL;
530 
531 	switch (ctl->func) {
532 	case DRM_INST_HANDLER:
533 		irq = dev->pdev->irq;
534 
535 		if (dev->if_version < DRM_IF_VERSION(1, 2) &&
536 		    ctl->irq != irq)
537 			return -EINVAL;
538 		mutex_lock(&dev->struct_mutex);
539 		ret = drm_irq_install(dev, irq);
540 		mutex_unlock(&dev->struct_mutex);
541 
542 		return ret;
543 	case DRM_UNINST_HANDLER:
544 		mutex_lock(&dev->struct_mutex);
545 		ret = drm_irq_uninstall(dev);
546 		mutex_unlock(&dev->struct_mutex);
547 
548 		return ret;
549 	default:
550 		return -EINVAL;
551 	}
552 }
553 
554 /**
555  * drm_calc_timestamping_constants - calculate vblank timestamp constants
556  * @crtc: drm_crtc whose timestamp constants should be updated.
557  * @mode: display mode containing the scanout timings
558  *
559  * Calculate and store various constants which are later
560  * needed by vblank and swap-completion timestamping, e.g,
561  * by drm_calc_vbltimestamp_from_scanoutpos(). They are
562  * derived from CRTC's true scanout timing, so they take
563  * things like panel scaling or other adjustments into account.
564  */
drm_calc_timestamping_constants(struct drm_crtc * crtc,const struct drm_display_mode * mode)565 void drm_calc_timestamping_constants(struct drm_crtc *crtc,
566 				     const struct drm_display_mode *mode)
567 {
568 	int linedur_ns = 0, pixeldur_ns = 0, framedur_ns = 0;
569 	int dotclock = mode->crtc_clock;
570 
571 	/* Valid dotclock? */
572 	if (dotclock > 0) {
573 		int frame_size = mode->crtc_htotal * mode->crtc_vtotal;
574 
575 		/*
576 		 * Convert scanline length in pixels and video
577 		 * dot clock to line duration, frame duration
578 		 * and pixel duration in nanoseconds:
579 		 */
580 		pixeldur_ns = 1000000 / dotclock;
581 		linedur_ns  = div_u64((u64) mode->crtc_htotal * 1000000, dotclock);
582 		framedur_ns = div_u64((u64) frame_size * 1000000, dotclock);
583 
584 		/*
585 		 * Fields of interlaced scanout modes are only half a frame duration.
586 		 */
587 		if (mode->flags & DRM_MODE_FLAG_INTERLACE)
588 			framedur_ns /= 2;
589 	} else
590 		DRM_ERROR("crtc %d: Can't calculate constants, dotclock = 0!\n",
591 			  crtc->base.id);
592 
593 	crtc->pixeldur_ns = pixeldur_ns;
594 	crtc->linedur_ns  = linedur_ns;
595 	crtc->framedur_ns = framedur_ns;
596 
597 	DRM_DEBUG("crtc %d: hwmode: htotal %d, vtotal %d, vdisplay %d\n",
598 		  crtc->base.id, mode->crtc_htotal,
599 		  mode->crtc_vtotal, mode->crtc_vdisplay);
600 	DRM_DEBUG("crtc %d: clock %d kHz framedur %d linedur %d, pixeldur %d\n",
601 		  crtc->base.id, dotclock, framedur_ns,
602 		  linedur_ns, pixeldur_ns);
603 }
604 EXPORT_SYMBOL(drm_calc_timestamping_constants);
605 
606 /**
607  * drm_calc_vbltimestamp_from_scanoutpos - precise vblank timestamp helper
608  * @dev: DRM device
609  * @crtc: Which CRTC's vblank timestamp to retrieve
610  * @max_error: Desired maximum allowable error in timestamps (nanosecs)
611  *             On return contains true maximum error of timestamp
612  * @vblank_time: Pointer to struct timeval which should receive the timestamp
613  * @flags: Flags to pass to driver:
614  *         0 = Default,
615  *         DRM_CALLED_FROM_VBLIRQ = If function is called from vbl IRQ handler
616  * @refcrtc: CRTC which defines scanout timing
617  * @mode: mode which defines the scanout timings
618  *
619  * Implements calculation of exact vblank timestamps from given drm_display_mode
620  * timings and current video scanout position of a CRTC. This can be called from
621  * within get_vblank_timestamp() implementation of a kms driver to implement the
622  * actual timestamping.
623  *
624  * Should return timestamps conforming to the OML_sync_control OpenML
625  * extension specification. The timestamp corresponds to the end of
626  * the vblank interval, aka start of scanout of topmost-leftmost display
627  * pixel in the following video frame.
628  *
629  * Requires support for optional dev->driver->get_scanout_position()
630  * in kms driver, plus a bit of setup code to provide a drm_display_mode
631  * that corresponds to the true scanout timing.
632  *
633  * The current implementation only handles standard video modes. It
634  * returns as no operation if a doublescan or interlaced video mode is
635  * active. Higher level code is expected to handle this.
636  *
637  * Returns:
638  * Negative value on error, failure or if not supported in current
639  * video mode:
640  *
641  * -EINVAL   - Invalid CRTC.
642  * -EAGAIN   - Temporary unavailable, e.g., called before initial modeset.
643  * -ENOTSUPP - Function not supported in current display mode.
644  * -EIO      - Failed, e.g., due to failed scanout position query.
645  *
646  * Returns or'ed positive status flags on success:
647  *
648  * DRM_VBLANKTIME_SCANOUTPOS_METHOD - Signal this method used for timestamping.
649  * DRM_VBLANKTIME_INVBL - Timestamp taken while scanout was in vblank interval.
650  *
651  */
drm_calc_vbltimestamp_from_scanoutpos(struct drm_device * dev,int crtc,int * max_error,struct timeval * vblank_time,unsigned flags,const struct drm_crtc * refcrtc,const struct drm_display_mode * mode)652 int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev, int crtc,
653 					  int *max_error,
654 					  struct timeval *vblank_time,
655 					  unsigned flags,
656 					  const struct drm_crtc *refcrtc,
657 					  const struct drm_display_mode *mode)
658 {
659 	struct timeval tv_etime;
660 	ktime_t stime, etime;
661 	int vbl_status;
662 	int vpos, hpos, i;
663 	int framedur_ns, linedur_ns, pixeldur_ns, delta_ns, duration_ns;
664 	bool invbl;
665 
666 	if (crtc < 0 || crtc >= dev->num_crtcs) {
667 		DRM_ERROR("Invalid crtc %d\n", crtc);
668 		return -EINVAL;
669 	}
670 
671 	/* Scanout position query not supported? Should not happen. */
672 	if (!dev->driver->get_scanout_position) {
673 		DRM_ERROR("Called from driver w/o get_scanout_position()!?\n");
674 		return -EIO;
675 	}
676 
677 	/* Durations of frames, lines, pixels in nanoseconds. */
678 	framedur_ns = refcrtc->framedur_ns;
679 	linedur_ns  = refcrtc->linedur_ns;
680 	pixeldur_ns = refcrtc->pixeldur_ns;
681 
682 	/* If mode timing undefined, just return as no-op:
683 	 * Happens during initial modesetting of a crtc.
684 	 */
685 	if (framedur_ns == 0) {
686 		DRM_DEBUG("crtc %d: Noop due to uninitialized mode.\n", crtc);
687 		return -EAGAIN;
688 	}
689 
690 	/* Get current scanout position with system timestamp.
691 	 * Repeat query up to DRM_TIMESTAMP_MAXRETRIES times
692 	 * if single query takes longer than max_error nanoseconds.
693 	 *
694 	 * This guarantees a tight bound on maximum error if
695 	 * code gets preempted or delayed for some reason.
696 	 */
697 	for (i = 0; i < DRM_TIMESTAMP_MAXRETRIES; i++) {
698 		/*
699 		 * Get vertical and horizontal scanout position vpos, hpos,
700 		 * and bounding timestamps stime, etime, pre/post query.
701 		 */
702 		vbl_status = dev->driver->get_scanout_position(dev, crtc, flags, &vpos,
703 							       &hpos, &stime, &etime);
704 
705 		/* Return as no-op if scanout query unsupported or failed. */
706 		if (!(vbl_status & DRM_SCANOUTPOS_VALID)) {
707 			DRM_DEBUG("crtc %d : scanoutpos query failed [%d].\n",
708 				  crtc, vbl_status);
709 			return -EIO;
710 		}
711 
712 		/* Compute uncertainty in timestamp of scanout position query. */
713 		duration_ns = ktime_to_ns(etime) - ktime_to_ns(stime);
714 
715 		/* Accept result with <  max_error nsecs timing uncertainty. */
716 		if (duration_ns <= *max_error)
717 			break;
718 	}
719 
720 	/* Noisy system timing? */
721 	if (i == DRM_TIMESTAMP_MAXRETRIES) {
722 		DRM_DEBUG("crtc %d: Noisy timestamp %d us > %d us [%d reps].\n",
723 			  crtc, duration_ns/1000, *max_error/1000, i);
724 	}
725 
726 	/* Return upper bound of timestamp precision error. */
727 	*max_error = duration_ns;
728 
729 	/* Check if in vblank area:
730 	 * vpos is >=0 in video scanout area, but negative
731 	 * within vblank area, counting down the number of lines until
732 	 * start of scanout.
733 	 */
734 	invbl = vbl_status & DRM_SCANOUTPOS_IN_VBLANK;
735 
736 	/* Convert scanout position into elapsed time at raw_time query
737 	 * since start of scanout at first display scanline. delta_ns
738 	 * can be negative if start of scanout hasn't happened yet.
739 	 */
740 	delta_ns = vpos * linedur_ns + hpos * pixeldur_ns;
741 
742 	if (!drm_timestamp_monotonic)
743 		etime = ktime_mono_to_real(etime);
744 
745 	/* save this only for debugging purposes */
746 	tv_etime = ktime_to_timeval(etime);
747 	/* Subtract time delta from raw timestamp to get final
748 	 * vblank_time timestamp for end of vblank.
749 	 */
750 	if (delta_ns < 0)
751 		etime = ktime_add_ns(etime, -delta_ns);
752 	else
753 		etime = ktime_sub_ns(etime, delta_ns);
754 	*vblank_time = ktime_to_timeval(etime);
755 
756 	DRM_DEBUG("crtc %d : v %d p(%d,%d)@ %ld.%ld -> %ld.%ld [e %d us, %d rep]\n",
757 		  crtc, (int)vbl_status, hpos, vpos,
758 		  (long)tv_etime.tv_sec, (long)tv_etime.tv_usec,
759 		  (long)vblank_time->tv_sec, (long)vblank_time->tv_usec,
760 		  duration_ns/1000, i);
761 
762 	vbl_status = DRM_VBLANKTIME_SCANOUTPOS_METHOD;
763 	if (invbl)
764 		vbl_status |= DRM_VBLANKTIME_IN_VBLANK;
765 
766 	return vbl_status;
767 }
768 EXPORT_SYMBOL(drm_calc_vbltimestamp_from_scanoutpos);
769 
get_drm_timestamp(void)770 static struct timeval get_drm_timestamp(void)
771 {
772 	ktime_t now;
773 
774 	now = drm_timestamp_monotonic ? ktime_get() : ktime_get_real();
775 	return ktime_to_timeval(now);
776 }
777 
778 /**
779  * drm_get_last_vbltimestamp - retrieve raw timestamp for the most recent
780  * 			       vblank interval
781  * @dev: DRM device
782  * @crtc: which CRTC's vblank timestamp to retrieve
783  * @tvblank: Pointer to target struct timeval which should receive the timestamp
784  * @flags: Flags to pass to driver:
785  *         0 = Default,
786  *         DRM_CALLED_FROM_VBLIRQ = If function is called from vbl IRQ handler
787  *
788  * Fetches the system timestamp corresponding to the time of the most recent
789  * vblank interval on specified CRTC. May call into kms-driver to
790  * compute the timestamp with a high-precision GPU specific method.
791  *
792  * Returns zero if timestamp originates from uncorrected do_gettimeofday()
793  * call, i.e., it isn't very precisely locked to the true vblank.
794  *
795  * Returns:
796  * True if timestamp is considered to be very precise, false otherwise.
797  */
798 static bool
drm_get_last_vbltimestamp(struct drm_device * dev,int crtc,struct timeval * tvblank,unsigned flags)799 drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
800 			  struct timeval *tvblank, unsigned flags)
801 {
802 	int ret;
803 
804 	/* Define requested maximum error on timestamps (nanoseconds). */
805 	int max_error = (int) drm_timestamp_precision * 1000;
806 
807 	/* Query driver if possible and precision timestamping enabled. */
808 	if (dev->driver->get_vblank_timestamp && (max_error > 0)) {
809 		ret = dev->driver->get_vblank_timestamp(dev, crtc, &max_error,
810 							tvblank, flags);
811 		if (ret > 0)
812 			return true;
813 	}
814 
815 	/* GPU high precision timestamp query unsupported or failed.
816 	 * Return current monotonic/gettimeofday timestamp as best estimate.
817 	 */
818 	*tvblank = get_drm_timestamp();
819 
820 	return false;
821 }
822 
823 /**
824  * drm_vblank_count - retrieve "cooked" vblank counter value
825  * @dev: DRM device
826  * @crtc: which counter to retrieve
827  *
828  * Fetches the "cooked" vblank count value that represents the number of
829  * vblank events since the system was booted, including lost events due to
830  * modesetting activity.
831  *
832  * Returns:
833  * The software vblank counter.
834  */
drm_vblank_count(struct drm_device * dev,int crtc)835 u32 drm_vblank_count(struct drm_device *dev, int crtc)
836 {
837 	struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
838 
839 	if (WARN_ON(crtc >= dev->num_crtcs))
840 		return 0;
841 	return atomic_read(&vblank->count);
842 }
843 EXPORT_SYMBOL(drm_vblank_count);
844 
845 /**
846  * drm_vblank_count_and_time - retrieve "cooked" vblank counter value
847  * and the system timestamp corresponding to that vblank counter value.
848  *
849  * @dev: DRM device
850  * @crtc: which counter to retrieve
851  * @vblanktime: Pointer to struct timeval to receive the vblank timestamp.
852  *
853  * Fetches the "cooked" vblank count value that represents the number of
854  * vblank events since the system was booted, including lost events due to
855  * modesetting activity. Returns corresponding system timestamp of the time
856  * of the vblank interval that corresponds to the current vblank counter value.
857  */
drm_vblank_count_and_time(struct drm_device * dev,int crtc,struct timeval * vblanktime)858 u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
859 			      struct timeval *vblanktime)
860 {
861 	struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
862 	u32 cur_vblank;
863 
864 	if (WARN_ON(crtc >= dev->num_crtcs))
865 		return 0;
866 
867 	/* Read timestamp from slot of _vblank_time ringbuffer
868 	 * that corresponds to current vblank count. Retry if
869 	 * count has incremented during readout. This works like
870 	 * a seqlock.
871 	 */
872 	do {
873 		cur_vblank = atomic_read(&vblank->count);
874 		*vblanktime = vblanktimestamp(dev, crtc, cur_vblank);
875 		smp_rmb();
876 	} while (cur_vblank != atomic_read(&vblank->count));
877 
878 	return cur_vblank;
879 }
880 EXPORT_SYMBOL(drm_vblank_count_and_time);
881 
send_vblank_event(struct drm_device * dev,struct drm_pending_vblank_event * e,unsigned long seq,struct timeval * now)882 static void send_vblank_event(struct drm_device *dev,
883 		struct drm_pending_vblank_event *e,
884 		unsigned long seq, struct timeval *now)
885 {
886 	WARN_ON_SMP(!spin_is_locked(&dev->event_lock));
887 	e->event.sequence = seq;
888 	e->event.tv_sec = now->tv_sec;
889 	e->event.tv_usec = now->tv_usec;
890 
891 	list_add_tail(&e->base.link,
892 		      &e->base.file_priv->event_list);
893 	wake_up_interruptible(&e->base.file_priv->event_wait);
894 	trace_drm_vblank_event_delivered(e->base.pid, e->pipe,
895 					 e->event.sequence);
896 }
897 
898 /**
899  * drm_send_vblank_event - helper to send vblank event after pageflip
900  * @dev: DRM device
901  * @crtc: CRTC in question
902  * @e: the event to send
903  *
904  * Updates sequence # and timestamp on event, and sends it to userspace.
905  * Caller must hold event lock.
906  */
drm_send_vblank_event(struct drm_device * dev,int crtc,struct drm_pending_vblank_event * e)907 void drm_send_vblank_event(struct drm_device *dev, int crtc,
908 		struct drm_pending_vblank_event *e)
909 {
910 	struct timeval now;
911 	unsigned int seq;
912 	if (crtc >= 0) {
913 		seq = drm_vblank_count_and_time(dev, crtc, &now);
914 	} else {
915 		seq = 0;
916 
917 		now = get_drm_timestamp();
918 	}
919 	e->pipe = crtc;
920 	send_vblank_event(dev, e, seq, &now);
921 }
922 EXPORT_SYMBOL(drm_send_vblank_event);
923 
924 /**
925  * drm_vblank_enable - enable the vblank interrupt on a CRTC
926  * @dev: DRM device
927  * @crtc: CRTC in question
928  */
drm_vblank_enable(struct drm_device * dev,int crtc)929 static int drm_vblank_enable(struct drm_device *dev, int crtc)
930 {
931 	struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
932 	int ret = 0;
933 
934 	assert_spin_locked(&dev->vbl_lock);
935 
936 	spin_lock(&dev->vblank_time_lock);
937 
938 	if (!vblank->enabled) {
939 		/*
940 		 * Enable vblank irqs under vblank_time_lock protection.
941 		 * All vblank count & timestamp updates are held off
942 		 * until we are done reinitializing master counter and
943 		 * timestamps. Filtercode in drm_handle_vblank() will
944 		 * prevent double-accounting of same vblank interval.
945 		 */
946 		ret = dev->driver->enable_vblank(dev, crtc);
947 		DRM_DEBUG("enabling vblank on crtc %d, ret: %d\n", crtc, ret);
948 		if (ret)
949 			atomic_dec(&vblank->refcount);
950 		else {
951 			vblank->enabled = true;
952 			drm_update_vblank_count(dev, crtc);
953 		}
954 	}
955 
956 	spin_unlock(&dev->vblank_time_lock);
957 
958 	return ret;
959 }
960 
961 /**
962  * drm_vblank_get - get a reference count on vblank events
963  * @dev: DRM device
964  * @crtc: which CRTC to own
965  *
966  * Acquire a reference count on vblank events to avoid having them disabled
967  * while in use.
968  *
969  * This is the legacy version of drm_crtc_vblank_get().
970  *
971  * Returns:
972  * Zero on success, nonzero on failure.
973  */
drm_vblank_get(struct drm_device * dev,int crtc)974 int drm_vblank_get(struct drm_device *dev, int crtc)
975 {
976 	struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
977 	unsigned long irqflags;
978 	int ret = 0;
979 
980 	if (WARN_ON(crtc >= dev->num_crtcs))
981 		return -EINVAL;
982 
983 	spin_lock_irqsave(&dev->vbl_lock, irqflags);
984 	/* Going from 0->1 means we have to enable interrupts again */
985 	if (atomic_add_return(1, &vblank->refcount) == 1) {
986 		ret = drm_vblank_enable(dev, crtc);
987 	} else {
988 		if (!vblank->enabled) {
989 			atomic_dec(&vblank->refcount);
990 			ret = -EINVAL;
991 		}
992 	}
993 	spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
994 
995 	return ret;
996 }
997 EXPORT_SYMBOL(drm_vblank_get);
998 
999 /**
1000  * drm_crtc_vblank_get - get a reference count on vblank events
1001  * @crtc: which CRTC to own
1002  *
1003  * Acquire a reference count on vblank events to avoid having them disabled
1004  * while in use.
1005  *
1006  * This is the native kms version of drm_vblank_off().
1007  *
1008  * Returns:
1009  * Zero on success, nonzero on failure.
1010  */
drm_crtc_vblank_get(struct drm_crtc * crtc)1011 int drm_crtc_vblank_get(struct drm_crtc *crtc)
1012 {
1013 	return drm_vblank_get(crtc->dev, drm_crtc_index(crtc));
1014 }
1015 EXPORT_SYMBOL(drm_crtc_vblank_get);
1016 
1017 /**
1018  * drm_vblank_put - give up ownership of vblank events
1019  * @dev: DRM device
1020  * @crtc: which counter to give up
1021  *
1022  * Release ownership of a given vblank counter, turning off interrupts
1023  * if possible. Disable interrupts after drm_vblank_offdelay milliseconds.
1024  *
1025  * This is the legacy version of drm_crtc_vblank_put().
1026  */
drm_vblank_put(struct drm_device * dev,int crtc)1027 void drm_vblank_put(struct drm_device *dev, int crtc)
1028 {
1029 	struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
1030 
1031 	if (WARN_ON(atomic_read(&vblank->refcount) == 0))
1032 		return;
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 }
1048 EXPORT_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  */
drm_crtc_vblank_put(struct drm_crtc * crtc)1059 void drm_crtc_vblank_put(struct drm_crtc *crtc)
1060 {
1061 	drm_vblank_put(crtc->dev, drm_crtc_index(crtc));
1062 }
1063 EXPORT_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  */
drm_wait_one_vblank(struct drm_device * dev,int crtc)1074 void 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 }
1093 EXPORT_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  */
drm_crtc_wait_one_vblank(struct drm_crtc * crtc)1103 void drm_crtc_wait_one_vblank(struct drm_crtc *crtc)
1104 {
1105 	drm_wait_one_vblank(crtc->dev, drm_crtc_index(crtc));
1106 }
1107 EXPORT_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  */
drm_vblank_off(struct drm_device * dev,int crtc)1123 void 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 }
1165 EXPORT_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  */
drm_crtc_vblank_off(struct drm_crtc * crtc)1180 void drm_crtc_vblank_off(struct drm_crtc *crtc)
1181 {
1182 	drm_vblank_off(crtc->dev, drm_crtc_index(crtc));
1183 }
1184 EXPORT_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  */
drm_vblank_on(struct drm_device * dev,int crtc)1198 void 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 }
1232 EXPORT_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  */
drm_crtc_vblank_on(struct drm_crtc * crtc)1245 void drm_crtc_vblank_on(struct drm_crtc *crtc)
1246 {
1247 	drm_vblank_on(crtc->dev, drm_crtc_index(crtc));
1248 }
1249 EXPORT_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  */
drm_vblank_pre_modeset(struct drm_device * dev,int crtc)1274 void 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 }
1298 EXPORT_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  */
drm_vblank_post_modeset(struct drm_device * dev,int crtc)1308 void 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 }
1328 EXPORT_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  */
drm_modeset_ctl(struct drm_device * dev,void * data,struct drm_file * file_priv)1341 int 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 
drm_queue_vblank_event(struct drm_device * dev,int pipe,union drm_wait_vblank * vblwait,struct drm_file * file_priv)1373 static 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 
1448 err_unlock:
1449 	spin_unlock_irqrestore(&dev->event_lock, flags);
1450 	kfree(e);
1451 err_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  */
drm_wait_vblank(struct drm_device * dev,void * data,struct drm_file * file_priv)1470 int 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 
1557 done:
1558 	drm_vblank_put(dev, crtc);
1559 	return ret;
1560 }
1561 
drm_handle_vblank_events(struct drm_device * dev,int crtc)1562 static 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  */
drm_handle_vblank(struct drm_device * dev,int crtc)1597 bool 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 }
1671 EXPORT_SYMBOL(drm_handle_vblank);
1672