You need to sign in or sign up before continuing.
drm_irq.c 44.2 KB
Newer Older
D
Daniel Vetter 已提交
1 2
/*
 * drm_irq.c IRQ and vblank support
L
Linus Torvalds 已提交
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
 *
 * \author Rickard E. (Rik) Faith <faith@valinux.com>
 * \author Gareth Hughes <gareth@valinux.com>
 */

/*
 * Created: Fri Mar 19 14:30:16 1999 by faith@valinux.com
 *
 * Copyright 1999, 2000 Precision Insight, Inc., Cedar Park, Texas.
 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
 * All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */

35
#include <drm/drmP.h>
J
Jesse Barnes 已提交
36
#include "drm_trace.h"
L
Linus Torvalds 已提交
37 38

#include <linux/interrupt.h>	/* For task queue support */
39
#include <linux/slab.h>
L
Linus Torvalds 已提交
40

41
#include <linux/vgaarb.h>
42
#include <linux/export.h>
43 44

/* Access macro for slots in vblank timestamp ringbuffer. */
45 46
#define vblanktimestamp(dev, crtc, count) \
	((dev)->vblank[crtc].time[(count) % DRM_VBLANKTIME_RBSIZE])
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70

/* Retry timestamp calculation up to 3 times to satisfy
 * drm_timestamp_precision before giving up.
 */
#define DRM_TIMESTAMP_MAXRETRIES 3

/* Threshold in nanoseconds for detection of redundant
 * vblank irq in drm_handle_vblank(). 1 msec should be ok.
 */
#define DRM_REDUNDANT_VBLIRQ_THRESH_NS 1000000

/*
 * Disable vblank irq's on crtc, make sure that last vblank count
 * of hardware and corresponding consistent software vblank counter
 * are preserved, even if there are any spurious vblank irq's after
 * disable.
 */
static void vblank_disable_and_save(struct drm_device *dev, int crtc)
{
	unsigned long irqflags;
	u32 vblcount;
	s64 diff_ns;
	int vblrc;
	struct timeval tvblank;
71
	int count = DRM_TIMESTAMP_MAXRETRIES;
72 73 74 75 76 77 78 79

	/* Prevent vblank irq processing while disabling vblank irqs,
	 * so no updates of timestamps or count can happen after we've
	 * disabled. Needed to prevent races in case of delayed irq's.
	 */
	spin_lock_irqsave(&dev->vblank_time_lock, irqflags);

	dev->driver->disable_vblank(dev, crtc);
80
	dev->vblank[crtc].enabled = false;
81 82 83 84 85 86 87 88 89 90 91 92 93 94

	/* No further vblank irq's will be processed after
	 * this point. Get current hardware vblank count and
	 * vblank timestamp, repeat until they are consistent.
	 *
	 * FIXME: There is still a race condition here and in
	 * drm_update_vblank_count() which can cause off-by-one
	 * reinitialization of software vblank counter. If gpu
	 * vblank counter doesn't increment exactly at the leading
	 * edge of a vblank interval, then we can lose 1 count if
	 * we happen to execute between start of vblank and the
	 * delayed gpu counter increment.
	 */
	do {
95
		dev->vblank[crtc].last = dev->driver->get_vblank_counter(dev, crtc);
96
		vblrc = drm_get_last_vbltimestamp(dev, crtc, &tvblank, 0);
97
	} while (dev->vblank[crtc].last != dev->driver->get_vblank_counter(dev, crtc) && (--count) && vblrc);
98 99 100

	if (!count)
		vblrc = 0;
101 102 103 104

	/* Compute time difference to stored timestamp of last vblank
	 * as updated by last invocation of drm_handle_vblank() in vblank irq.
	 */
105
	vblcount = atomic_read(&dev->vblank[crtc].count);
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
	diff_ns = timeval_to_ns(&tvblank) -
		  timeval_to_ns(&vblanktimestamp(dev, crtc, vblcount));

	/* If there is at least 1 msec difference between the last stored
	 * timestamp and tvblank, then we are currently executing our
	 * disable inside a new vblank interval, the tvblank timestamp
	 * corresponds to this new vblank interval and the irq handler
	 * for this vblank didn't run yet and won't run due to our disable.
	 * Therefore we need to do the job of drm_handle_vblank() and
	 * increment the vblank counter by one to account for this vblank.
	 *
	 * Skip this step if there isn't any high precision timestamp
	 * available. In that case we can't account for this and just
	 * hope for the best.
	 */
121
	if ((vblrc > 0) && (abs64(diff_ns) > 1000000)) {
122
		atomic_inc(&dev->vblank[crtc].count);
123
		smp_mb__after_atomic();
124
	}
125 126 127 128

	spin_unlock_irqrestore(&dev->vblank_time_lock, irqflags);
}

129 130
static void vblank_disable_fn(unsigned long arg)
{
131 132
	struct drm_vblank_crtc *vblank = (void *)arg;
	struct drm_device *dev = vblank->dev;
133
	unsigned long irqflags;
134
	int crtc = vblank->crtc;
135 136 137 138

	if (!dev->vblank_disable_allowed)
		return;

139 140 141 142
	spin_lock_irqsave(&dev->vbl_lock, irqflags);
	if (atomic_read(&vblank->refcount) == 0 && vblank->enabled) {
		DRM_DEBUG("disabling vblank on crtc %d\n", crtc);
		vblank_disable_and_save(dev, crtc);
143
	}
144
	spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
145 146
}

D
Daniel Vetter 已提交
147 148 149 150 151 152
/**
 * drm_vblank_cleanup - cleanup vblank support
 * @dev: DRM device
 *
 * This function cleans up any resources allocated in drm_vblank_init.
 */
153
void drm_vblank_cleanup(struct drm_device *dev)
154
{
155 156
	int crtc;

157 158 159 160
	/* Bail if the driver didn't call drm_vblank_init() */
	if (dev->num_crtcs == 0)
		return;

161 162 163 164
	for (crtc = 0; crtc < dev->num_crtcs; crtc++) {
		del_timer_sync(&dev->vblank[crtc].disable_timer);
		vblank_disable_fn((unsigned long)&dev->vblank[crtc]);
	}
165

166
	kfree(dev->vblank);
167 168 169

	dev->num_crtcs = 0;
}
170
EXPORT_SYMBOL(drm_vblank_cleanup);
171

D
Daniel Vetter 已提交
172 173 174 175 176 177 178 179 180 181
/**
 * drm_vblank_init - initialize vblank support
 * @dev: drm_device
 * @num_crtcs: number of crtcs supported by @dev
 *
 * This function initializes vblank support for @num_crtcs display pipelines.
 *
 * Returns:
 * Zero on success or a negative error code on failure.
 */
182 183 184 185 186
int drm_vblank_init(struct drm_device *dev, int num_crtcs)
{
	int i, ret = -ENOMEM;

	spin_lock_init(&dev->vbl_lock);
187 188
	spin_lock_init(&dev->vblank_time_lock);

189 190
	dev->num_crtcs = num_crtcs;

191 192
	dev->vblank = kcalloc(num_crtcs, sizeof(*dev->vblank), GFP_KERNEL);
	if (!dev->vblank)
193 194
		goto err;

195 196 197
	for (i = 0; i < num_crtcs; i++) {
		dev->vblank[i].dev = dev;
		dev->vblank[i].crtc = i;
198
		init_waitqueue_head(&dev->vblank[i].queue);
199 200 201
		setup_timer(&dev->vblank[i].disable_timer, vblank_disable_fn,
			    (unsigned long)&dev->vblank[i]);
	}
202

203
	DRM_INFO("Supports vblank timestamp caching Rev 2 (21.10.2013).\n");
204 205 206 207 208 209 210

	/* Driver specific high-precision vblank timestamping supported? */
	if (dev->driver->get_vblank_timestamp)
		DRM_INFO("Driver supports precise vblank timestamp query.\n");
	else
		DRM_INFO("No driver support for vblank timestamp query.\n");

211 212
	dev->vblank_disable_allowed = false;

213 214 215 216 217 218 219 220
	return 0;

err:
	drm_vblank_cleanup(dev);
	return ret;
}
EXPORT_SYMBOL(drm_vblank_init);

221 222 223 224 225 226 227 228 229 230 231 232
static void drm_irq_vgaarb_nokms(void *cookie, bool state)
{
	struct drm_device *dev = cookie;

	if (dev->driver->vgaarb_irq) {
		dev->driver->vgaarb_irq(dev, state);
		return;
	}

	if (!dev->irq_enabled)
		return;

233 234 235 236 237 238 239 240
	if (state) {
		if (dev->driver->irq_uninstall)
			dev->driver->irq_uninstall(dev);
	} else {
		if (dev->driver->irq_preinstall)
			dev->driver->irq_preinstall(dev);
		if (dev->driver->irq_postinstall)
			dev->driver->irq_postinstall(dev);
241 242 243
	}
}

L
Linus Torvalds 已提交
244
/**
D
Daniel Vetter 已提交
245 246 247
 * drm_irq_install - install IRQ handler
 * @dev: DRM device
 * @irq: IRQ number to install the handler for
L
Linus Torvalds 已提交
248
 *
249
 * Initializes the IRQ related data. Installs the handler, calling the driver
D
Daniel Vetter 已提交
250 251 252 253 254 255 256 257 258 259
 * irq_preinstall() and irq_postinstall() functions before and after the
 * installation.
 *
 * This is the simplified helper interface provided for drivers with no special
 * needs. Drivers which need to install interrupt handlers for multiple
 * interrupts must instead set drm_device->irq_enabled to signal the DRM core
 * that vblank interrupts are available.
 *
 * Returns:
 * Zero on success or a negative error code on failure.
L
Linus Torvalds 已提交
260
 */
261
int drm_irq_install(struct drm_device *dev, int irq)
L
Linus Torvalds 已提交
262
{
263
	int ret;
D
Dave Airlie 已提交
264
	unsigned long sh_flags = 0;
L
Linus Torvalds 已提交
265 266 267 268

	if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
		return -EINVAL;

269
	if (irq == 0)
L
Linus Torvalds 已提交
270 271 272
		return -EINVAL;

	/* Driver must have been initialized */
273
	if (!dev->dev_private)
L
Linus Torvalds 已提交
274 275
		return -EINVAL;

276
	if (dev->irq_enabled)
L
Linus Torvalds 已提交
277
		return -EBUSY;
V
Ville Syrjälä 已提交
278
	dev->irq_enabled = true;
L
Linus Torvalds 已提交
279

280
	DRM_DEBUG("irq=%d\n", irq);
L
Linus Torvalds 已提交
281

D
Dave Airlie 已提交
282
	/* Before installing handler */
283 284
	if (dev->driver->irq_preinstall)
		dev->driver->irq_preinstall(dev);
L
Linus Torvalds 已提交
285

D
Dave Airlie 已提交
286
	/* Install handler */
L
Linus Torvalds 已提交
287
	if (drm_core_check_feature(dev, DRIVER_IRQ_SHARED))
288
		sh_flags = IRQF_SHARED;
D
Dave Airlie 已提交
289

290
	ret = request_irq(irq, dev->driver->irq_handler,
D
Daniel Vetter 已提交
291
			  sh_flags, dev->driver->name, dev);
J
Jesse Barnes 已提交
292

D
Dave Airlie 已提交
293
	if (ret < 0) {
V
Ville Syrjälä 已提交
294
		dev->irq_enabled = false;
L
Linus Torvalds 已提交
295 296 297
		return ret;
	}

298 299 300
	if (!drm_core_check_feature(dev, DRIVER_MODESET))
		vga_client_register(dev->pdev, (void *)dev, drm_irq_vgaarb_nokms, NULL);

D
Dave Airlie 已提交
301
	/* After installing handler */
302 303 304
	if (dev->driver->irq_postinstall)
		ret = dev->driver->irq_postinstall(dev);

305
	if (ret < 0) {
V
Ville Syrjälä 已提交
306
		dev->irq_enabled = false;
307 308
		if (!drm_core_check_feature(dev, DRIVER_MODESET))
			vga_client_register(dev->pdev, NULL, NULL, NULL);
309 310 311
		free_irq(irq, dev);
	} else {
		dev->irq = irq;
312
	}
L
Linus Torvalds 已提交
313

314
	return ret;
L
Linus Torvalds 已提交
315
}
316
EXPORT_SYMBOL(drm_irq_install);
L
Linus Torvalds 已提交
317 318

/**
D
Daniel Vetter 已提交
319 320 321 322 323 324 325
 * drm_irq_uninstall - uninstall the IRQ handler
 * @dev: DRM device
 *
 * Calls the driver's irq_uninstall() function and unregisters the IRQ handler.
 * This should only be called by drivers which used drm_irq_install() to set up
 * their interrupt handler. Other drivers must only reset
 * drm_device->irq_enabled to false.
L
Linus Torvalds 已提交
326
 *
D
Daniel Vetter 已提交
327 328 329
 * Note that for kernel modesetting drivers it is a bug if this function fails.
 * The sanity checks are only to catch buggy user modesetting drivers which call
 * the same function through an ioctl.
L
Linus Torvalds 已提交
330
 *
D
Daniel Vetter 已提交
331 332
 * Returns:
 * Zero on success or a negative error code on failure.
L
Linus Torvalds 已提交
333
 */
334
int drm_irq_uninstall(struct drm_device *dev)
L
Linus Torvalds 已提交
335
{
336
	unsigned long irqflags;
V
Ville Syrjälä 已提交
337 338
	bool irq_enabled;
	int i;
L
Linus Torvalds 已提交
339 340 341 342 343

	if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
		return -EINVAL;

	irq_enabled = dev->irq_enabled;
V
Ville Syrjälä 已提交
344
	dev->irq_enabled = false;
L
Linus Torvalds 已提交
345

346 347 348
	/*
	 * Wake up any waiters so they don't hang.
	 */
349 350 351
	if (dev->num_crtcs) {
		spin_lock_irqsave(&dev->vbl_lock, irqflags);
		for (i = 0; i < dev->num_crtcs; i++) {
352
			wake_up(&dev->vblank[i].queue);
353 354
			dev->vblank[i].enabled = false;
			dev->vblank[i].last =
355 356 357
				dev->driver->get_vblank_counter(dev, i);
		}
		spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
358 359
	}

D
Dave Airlie 已提交
360
	if (!irq_enabled)
L
Linus Torvalds 已提交
361 362
		return -EINVAL;

363
	DRM_DEBUG("irq=%d\n", dev->irq);
L
Linus Torvalds 已提交
364

365 366 367
	if (!drm_core_check_feature(dev, DRIVER_MODESET))
		vga_client_register(dev->pdev, NULL, NULL, NULL);

368 369
	if (dev->driver->irq_uninstall)
		dev->driver->irq_uninstall(dev);
L
Linus Torvalds 已提交
370

371
	free_irq(dev->irq, dev);
L
Linus Torvalds 已提交
372 373 374 375 376

	return 0;
}
EXPORT_SYMBOL(drm_irq_uninstall);

D
Daniel Vetter 已提交
377
/*
L
Linus Torvalds 已提交
378 379 380
 * IRQ control ioctl.
 *
 * \param inode device inode.
381
 * \param file_priv DRM file private.
L
Linus Torvalds 已提交
382 383 384 385 386 387
 * \param cmd command.
 * \param arg user argument, pointing to a drm_control structure.
 * \return zero on success or a negative number on failure.
 *
 * Calls irq_install() or irq_uninstall() according to \p arg.
 */
388 389
int drm_control(struct drm_device *dev, void *data,
		struct drm_file *file_priv)
L
Linus Torvalds 已提交
390
{
391
	struct drm_control *ctl = data;
392
	int ret = 0, irq;
D
Dave Airlie 已提交
393

394 395 396
	/* if we haven't irq we fallback for compatibility reasons -
	 * this used to be a separate function in drm_dma.h
	 */
L
Linus Torvalds 已提交
397

398 399 400 401 402 403 404
	if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
		return 0;
	if (drm_core_check_feature(dev, DRIVER_MODESET))
		return 0;
	/* UMS was only ever support on pci devices. */
	if (WARN_ON(!dev->pdev))
		return -EINVAL;
L
Linus Torvalds 已提交
405

406
	switch (ctl->func) {
L
Linus Torvalds 已提交
407
	case DRM_INST_HANDLER:
408 409
		irq = dev->pdev->irq;

L
Linus Torvalds 已提交
410
		if (dev->if_version < DRM_IF_VERSION(1, 2) &&
411
		    ctl->irq != irq)
L
Linus Torvalds 已提交
412
			return -EINVAL;
413
		mutex_lock(&dev->struct_mutex);
414
		ret = drm_irq_install(dev, irq);
415 416 417
		mutex_unlock(&dev->struct_mutex);

		return ret;
L
Linus Torvalds 已提交
418
	case DRM_UNINST_HANDLER:
419 420 421 422 423
		mutex_lock(&dev->struct_mutex);
		ret = drm_irq_uninstall(dev);
		mutex_unlock(&dev->struct_mutex);

		return ret;
L
Linus Torvalds 已提交
424 425 426 427 428
	default:
		return -EINVAL;
	}
}

429
/**
D
Daniel Vetter 已提交
430 431 432
 * drm_calc_timestamping_constants - calculate vblank timestamp constants
 * @crtc: drm_crtc whose timestamp constants should be updated.
 * @mode: display mode containing the scanout timings
433
 *
434 435 436
 * Calculate and store various constants which are later
 * needed by vblank and swap-completion timestamping, e.g,
 * by drm_calc_vbltimestamp_from_scanoutpos(). They are
D
Daniel Vetter 已提交
437
 * derived from CRTC's true scanout timing, so they take
438
 * things like panel scaling or other adjustments into account.
439
 */
440 441
void drm_calc_timestamping_constants(struct drm_crtc *crtc,
				     const struct drm_display_mode *mode)
442
{
443
	int linedur_ns = 0, pixeldur_ns = 0, framedur_ns = 0;
444
	int dotclock = mode->crtc_clock;
445 446 447

	/* Valid dotclock? */
	if (dotclock > 0) {
448 449 450 451 452 453
		int frame_size = mode->crtc_htotal * mode->crtc_vtotal;

		/*
		 * Convert scanline length in pixels and video
		 * dot clock to line duration, frame duration
		 * and pixel duration in nanoseconds:
454
		 */
455 456 457
		pixeldur_ns = 1000000 / dotclock;
		linedur_ns  = div_u64((u64) mode->crtc_htotal * 1000000, dotclock);
		framedur_ns = div_u64((u64) frame_size * 1000000, dotclock);
458 459 460 461 462 463

		/*
		 * Fields of interlaced scanout modes are only half a frame duration.
		 */
		if (mode->flags & DRM_MODE_FLAG_INTERLACE)
			framedur_ns /= 2;
464 465 466 467 468 469 470 471 472
	} else
		DRM_ERROR("crtc %d: Can't calculate constants, dotclock = 0!\n",
			  crtc->base.id);

	crtc->pixeldur_ns = pixeldur_ns;
	crtc->linedur_ns  = linedur_ns;
	crtc->framedur_ns = framedur_ns;

	DRM_DEBUG("crtc %d: hwmode: htotal %d, vtotal %d, vdisplay %d\n",
473 474
		  crtc->base.id, mode->crtc_htotal,
		  mode->crtc_vtotal, mode->crtc_vdisplay);
475
	DRM_DEBUG("crtc %d: clock %d kHz framedur %d linedur %d, pixeldur %d\n",
476 477
		  crtc->base.id, dotclock, framedur_ns,
		  linedur_ns, pixeldur_ns);
478 479 480 481
}
EXPORT_SYMBOL(drm_calc_timestamping_constants);

/**
D
Daniel Vetter 已提交
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
 * drm_calc_vbltimestamp_from_scanoutpos - precise vblank timestamp helper
 * @dev: DRM device
 * @crtc: Which CRTC's vblank timestamp to retrieve
 * @max_error: Desired maximum allowable error in timestamps (nanosecs)
 *             On return contains true maximum error of timestamp
 * @vblank_time: Pointer to struct timeval which should receive the timestamp
 * @flags: Flags to pass to driver:
 *         0 = Default,
 *         DRM_CALLED_FROM_VBLIRQ = If function is called from vbl IRQ handler
 * @refcrtc: CRTC which defines scanout timing
 * @mode: mode which defines the scanout timings
 *
 * Implements calculation of exact vblank timestamps from given drm_display_mode
 * timings and current video scanout position of a CRTC. This can be called from
 * within get_vblank_timestamp() implementation of a kms driver to implement the
 * actual timestamping.
498 499 500 501 502 503 504 505 506 507 508 509 510 511
 *
 * Should return timestamps conforming to the OML_sync_control OpenML
 * extension specification. The timestamp corresponds to the end of
 * the vblank interval, aka start of scanout of topmost-leftmost display
 * pixel in the following video frame.
 *
 * Requires support for optional dev->driver->get_scanout_position()
 * in kms driver, plus a bit of setup code to provide a drm_display_mode
 * that corresponds to the true scanout timing.
 *
 * The current implementation only handles standard video modes. It
 * returns as no operation if a doublescan or interlaced video mode is
 * active. Higher level code is expected to handle this.
 *
D
Daniel Vetter 已提交
512 513
 * Returns:
 * Negative value on error, failure or if not supported in current
514 515
 * video mode:
 *
D
Daniel Vetter 已提交
516
 * -EINVAL   - Invalid CRTC.
517 518 519 520 521 522 523 524 525 526 527 528 529 530
 * -EAGAIN   - Temporary unavailable, e.g., called before initial modeset.
 * -ENOTSUPP - Function not supported in current display mode.
 * -EIO      - Failed, e.g., due to failed scanout position query.
 *
 * Returns or'ed positive status flags on success:
 *
 * DRM_VBLANKTIME_SCANOUTPOS_METHOD - Signal this method used for timestamping.
 * DRM_VBLANKTIME_INVBL - Timestamp taken while scanout was in vblank interval.
 *
 */
int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev, int crtc,
					  int *max_error,
					  struct timeval *vblank_time,
					  unsigned flags,
531 532
					  const struct drm_crtc *refcrtc,
					  const struct drm_display_mode *mode)
533
{
534 535
	ktime_t stime, etime, mono_time_offset;
	struct timeval tv_etime;
536
	int vbl_status;
537
	int vpos, hpos, i;
538
	int framedur_ns, linedur_ns, pixeldur_ns, delta_ns, duration_ns;
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559
	bool invbl;

	if (crtc < 0 || crtc >= dev->num_crtcs) {
		DRM_ERROR("Invalid crtc %d\n", crtc);
		return -EINVAL;
	}

	/* Scanout position query not supported? Should not happen. */
	if (!dev->driver->get_scanout_position) {
		DRM_ERROR("Called from driver w/o get_scanout_position()!?\n");
		return -EIO;
	}

	/* Durations of frames, lines, pixels in nanoseconds. */
	framedur_ns = refcrtc->framedur_ns;
	linedur_ns  = refcrtc->linedur_ns;
	pixeldur_ns = refcrtc->pixeldur_ns;

	/* If mode timing undefined, just return as no-op:
	 * Happens during initial modesetting of a crtc.
	 */
560
	if (framedur_ns == 0) {
561 562 563 564 565 566 567 568 569 570 571 572
		DRM_DEBUG("crtc %d: Noop due to uninitialized mode.\n", crtc);
		return -EAGAIN;
	}

	/* Get current scanout position with system timestamp.
	 * Repeat query up to DRM_TIMESTAMP_MAXRETRIES times
	 * if single query takes longer than max_error nanoseconds.
	 *
	 * This guarantees a tight bound on maximum error if
	 * code gets preempted or delayed for some reason.
	 */
	for (i = 0; i < DRM_TIMESTAMP_MAXRETRIES; i++) {
573 574 575 576
		/*
		 * Get vertical and horizontal scanout position vpos, hpos,
		 * and bounding timestamps stime, etime, pre/post query.
		 */
577
		vbl_status = dev->driver->get_scanout_position(dev, crtc, flags, &vpos,
578
							       &hpos, &stime, &etime);
579

580 581 582 583
		/*
		 * Get correction for CLOCK_MONOTONIC -> CLOCK_REALTIME if
		 * CLOCK_REALTIME is requested.
		 */
584 585
		if (!drm_timestamp_monotonic)
			mono_time_offset = ktime_get_monotonic_offset();
586 587 588 589 590 591 592 593

		/* Return as no-op if scanout query unsupported or failed. */
		if (!(vbl_status & DRM_SCANOUTPOS_VALID)) {
			DRM_DEBUG("crtc %d : scanoutpos query failed [%d].\n",
				  crtc, vbl_status);
			return -EIO;
		}

594
		/* Compute uncertainty in timestamp of scanout position query. */
595
		duration_ns = ktime_to_ns(etime) - ktime_to_ns(stime);
596 597

		/* Accept result with <  max_error nsecs timing uncertainty. */
598
		if (duration_ns <= *max_error)
599 600 601 602 603 604
			break;
	}

	/* Noisy system timing? */
	if (i == DRM_TIMESTAMP_MAXRETRIES) {
		DRM_DEBUG("crtc %d: Noisy timestamp %d us > %d us [%d reps].\n",
605
			  crtc, duration_ns/1000, *max_error/1000, i);
606 607 608
	}

	/* Return upper bound of timestamp precision error. */
609
	*max_error = duration_ns;
610 611 612 613 614 615 616 617 618 619 620 621

	/* Check if in vblank area:
	 * vpos is >=0 in video scanout area, but negative
	 * within vblank area, counting down the number of lines until
	 * start of scanout.
	 */
	invbl = vbl_status & DRM_SCANOUTPOS_INVBL;

	/* Convert scanout position into elapsed time at raw_time query
	 * since start of scanout at first display scanline. delta_ns
	 * can be negative if start of scanout hasn't happened yet.
	 */
622
	delta_ns = vpos * linedur_ns + hpos * pixeldur_ns;
623

624 625 626
	if (!drm_timestamp_monotonic)
		etime = ktime_sub(etime, mono_time_offset);

627 628
	/* save this only for debugging purposes */
	tv_etime = ktime_to_timeval(etime);
629 630 631
	/* Subtract time delta from raw timestamp to get final
	 * vblank_time timestamp for end of vblank.
	 */
632 633 634 635
	if (delta_ns < 0)
		etime = ktime_add_ns(etime, -delta_ns);
	else
		etime = ktime_sub_ns(etime, delta_ns);
636
	*vblank_time = ktime_to_timeval(etime);
637

638 639
	DRM_DEBUG("crtc %d : v %d p(%d,%d)@ %ld.%ld -> %ld.%ld [e %d us, %d rep]\n",
		  crtc, (int)vbl_status, hpos, vpos,
640
		  (long)tv_etime.tv_sec, (long)tv_etime.tv_usec,
641
		  (long)vblank_time->tv_sec, (long)vblank_time->tv_usec,
642
		  duration_ns/1000, i);
643 644 645 646 647 648 649 650 651

	vbl_status = DRM_VBLANKTIME_SCANOUTPOS_METHOD;
	if (invbl)
		vbl_status |= DRM_VBLANKTIME_INVBL;

	return vbl_status;
}
EXPORT_SYMBOL(drm_calc_vbltimestamp_from_scanoutpos);

652 653 654 655 656 657 658 659 660 661 662
static struct timeval get_drm_timestamp(void)
{
	ktime_t now;

	now = ktime_get();
	if (!drm_timestamp_monotonic)
		now = ktime_sub(now, ktime_get_monotonic_offset());

	return ktime_to_timeval(now);
}

663 664
/**
 * drm_get_last_vbltimestamp - retrieve raw timestamp for the most recent
D
Daniel Vetter 已提交
665
 * 			       vblank interval
666
 * @dev: DRM device
D
Daniel Vetter 已提交
667
 * @crtc: which CRTC's vblank timestamp to retrieve
668 669
 * @tvblank: Pointer to target struct timeval which should receive the timestamp
 * @flags: Flags to pass to driver:
D
Daniel Vetter 已提交
670 671
 *         0 = Default,
 *         DRM_CALLED_FROM_VBLIRQ = If function is called from vbl IRQ handler
672 673
 *
 * Fetches the system timestamp corresponding to the time of the most recent
D
Daniel Vetter 已提交
674
 * vblank interval on specified CRTC. May call into kms-driver to
675 676 677 678 679
 * compute the timestamp with a high-precision GPU specific method.
 *
 * Returns zero if timestamp originates from uncorrected do_gettimeofday()
 * call, i.e., it isn't very precisely locked to the true vblank.
 *
D
Daniel Vetter 已提交
680 681
 * Returns:
 * Non-zero if timestamp is considered to be very precise, zero otherwise.
682 683 684 685
 */
u32 drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
			      struct timeval *tvblank, unsigned flags)
{
686
	int ret;
687 688 689 690 691 692 693 694 695 696 697 698 699

	/* Define requested maximum error on timestamps (nanoseconds). */
	int max_error = (int) drm_timestamp_precision * 1000;

	/* Query driver if possible and precision timestamping enabled. */
	if (dev->driver->get_vblank_timestamp && (max_error > 0)) {
		ret = dev->driver->get_vblank_timestamp(dev, crtc, &max_error,
							tvblank, flags);
		if (ret > 0)
			return (u32) ret;
	}

	/* GPU high precision timestamp query unsupported or failed.
700
	 * Return current monotonic/gettimeofday timestamp as best estimate.
701
	 */
702
	*tvblank = get_drm_timestamp();
703 704 705 706 707

	return 0;
}
EXPORT_SYMBOL(drm_get_last_vbltimestamp);

708 709 710 711 712 713 714 715
/**
 * drm_vblank_count - retrieve "cooked" vblank counter value
 * @dev: DRM device
 * @crtc: which counter to retrieve
 *
 * Fetches the "cooked" vblank count value that represents the number of
 * vblank events since the system was booted, including lost events due to
 * modesetting activity.
D
Daniel Vetter 已提交
716 717 718
 *
 * Returns:
 * The software vblank counter.
719 720 721
 */
u32 drm_vblank_count(struct drm_device *dev, int crtc)
{
722
	return atomic_read(&dev->vblank[crtc].count);
723 724 725
}
EXPORT_SYMBOL(drm_vblank_count);

726 727 728 729 730 731 732 733 734 735 736
/**
 * drm_vblank_count_and_time - retrieve "cooked" vblank counter value
 * and the system timestamp corresponding to that vblank counter value.
 *
 * @dev: DRM device
 * @crtc: which counter to retrieve
 * @vblanktime: Pointer to struct timeval to receive the vblank timestamp.
 *
 * Fetches the "cooked" vblank count value that represents the number of
 * vblank events since the system was booted, including lost events due to
 * modesetting activity. Returns corresponding system timestamp of the time
D
Daniel Vetter 已提交
737
 * of the vblank interval that corresponds to the current vblank counter value.
738 739 740 741 742 743 744 745 746 747 748 749
 */
u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
			      struct timeval *vblanktime)
{
	u32 cur_vblank;

	/* Read timestamp from slot of _vblank_time ringbuffer
	 * that corresponds to current vblank count. Retry if
	 * count has incremented during readout. This works like
	 * a seqlock.
	 */
	do {
750
		cur_vblank = atomic_read(&dev->vblank[crtc].count);
751 752
		*vblanktime = vblanktimestamp(dev, crtc, cur_vblank);
		smp_rmb();
753
	} while (cur_vblank != atomic_read(&dev->vblank[crtc].count));
754 755 756 757 758

	return cur_vblank;
}
EXPORT_SYMBOL(drm_vblank_count_and_time);

759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
static void send_vblank_event(struct drm_device *dev,
		struct drm_pending_vblank_event *e,
		unsigned long seq, struct timeval *now)
{
	WARN_ON_SMP(!spin_is_locked(&dev->event_lock));
	e->event.sequence = seq;
	e->event.tv_sec = now->tv_sec;
	e->event.tv_usec = now->tv_usec;

	list_add_tail(&e->base.link,
		      &e->base.file_priv->event_list);
	wake_up_interruptible(&e->base.file_priv->event_wait);
	trace_drm_vblank_event_delivered(e->base.pid, e->pipe,
					 e->event.sequence);
}

/**
 * drm_send_vblank_event - helper to send vblank event after pageflip
 * @dev: DRM device
 * @crtc: CRTC in question
 * @e: the event to send
 *
 * Updates sequence # and timestamp on event, and sends it to userspace.
 * Caller must hold event lock.
 */
void drm_send_vblank_event(struct drm_device *dev, int crtc,
		struct drm_pending_vblank_event *e)
{
	struct timeval now;
	unsigned int seq;
	if (crtc >= 0) {
		seq = drm_vblank_count_and_time(dev, crtc, &now);
	} else {
		seq = 0;
793 794

		now = get_drm_timestamp();
795
	}
796
	e->pipe = crtc;
797 798 799 800
	send_vblank_event(dev, e, seq, &now);
}
EXPORT_SYMBOL(drm_send_vblank_event);

801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818
/**
 * drm_update_vblank_count - update the master vblank counter
 * @dev: DRM device
 * @crtc: counter to update
 *
 * Call back into the driver to update the appropriate vblank counter
 * (specified by @crtc).  Deal with wraparound, if it occurred, and
 * update the last read value so we can deal with wraparound on the next
 * call if necessary.
 *
 * Only necessary when going from off->on, to account for frames we
 * didn't get an interrupt for.
 *
 * Note: caller must hold dev->vbl_lock since this reads & writes
 * device vblank fields.
 */
static void drm_update_vblank_count(struct drm_device *dev, int crtc)
{
819 820
	u32 cur_vblank, diff, tslot, rc;
	struct timeval t_vblank;
821 822 823 824 825 826 827

	/*
	 * Interrupts were disabled prior to this call, so deal with counter
	 * wrap if needed.
	 * NOTE!  It's possible we lost a full dev->max_vblank_count events
	 * here if the register is small or we had vblank interrupts off for
	 * a long time.
828 829 830 831 832
	 *
	 * We repeat the hardware vblank counter & timestamp query until
	 * we get consistent results. This to prevent races between gpu
	 * updating its hardware counter while we are retrieving the
	 * corresponding vblank timestamp.
833
	 */
834 835 836 837 838 839
	do {
		cur_vblank = dev->driver->get_vblank_counter(dev, crtc);
		rc = drm_get_last_vbltimestamp(dev, crtc, &t_vblank, 0);
	} while (cur_vblank != dev->driver->get_vblank_counter(dev, crtc));

	/* Deal with counter wrap */
840 841
	diff = cur_vblank - dev->vblank[crtc].last;
	if (cur_vblank < dev->vblank[crtc].last) {
842 843 844
		diff += dev->max_vblank_count;

		DRM_DEBUG("last_vblank[%d]=0x%x, cur_vblank=0x%x => diff=0x%x\n",
845
			  crtc, dev->vblank[crtc].last, cur_vblank, diff);
846 847 848 849 850
	}

	DRM_DEBUG("enabling vblank interrupts on crtc %d, missed %d\n",
		  crtc, diff);

851 852 853 854 855
	/* Reinitialize corresponding vblank timestamp if high-precision query
	 * available. Skip this step if query unsupported or failed. Will
	 * reinitialize delayed at next vblank interrupt in that case.
	 */
	if (rc) {
856
		tslot = atomic_read(&dev->vblank[crtc].count) + diff;
857 858 859
		vblanktimestamp(dev, crtc, tslot) = t_vblank;
	}

860
	smp_mb__before_atomic();
861
	atomic_add(diff, &dev->vblank[crtc].count);
862
	smp_mb__after_atomic();
863 864
}

V
Ville Syrjälä 已提交
865 866 867 868 869 870 871 872 873 874 875 876 877 878
/**
 * drm_vblank_enable - enable the vblank interrupt on a CRTC
 * @dev: DRM device
 * @crtc: CRTC in question
 */
static int drm_vblank_enable(struct drm_device *dev, int crtc)
{
	int ret = 0;

	assert_spin_locked(&dev->vbl_lock);

	spin_lock(&dev->vblank_time_lock);

	if (!dev->vblank[crtc].enabled) {
D
Daniel Vetter 已提交
879 880
		/*
		 * Enable vblank irqs under vblank_time_lock protection.
V
Ville Syrjälä 已提交
881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
		 * All vblank count & timestamp updates are held off
		 * until we are done reinitializing master counter and
		 * timestamps. Filtercode in drm_handle_vblank() will
		 * prevent double-accounting of same vblank interval.
		 */
		ret = dev->driver->enable_vblank(dev, crtc);
		DRM_DEBUG("enabling vblank on crtc %d, ret: %d\n", crtc, ret);
		if (ret)
			atomic_dec(&dev->vblank[crtc].refcount);
		else {
			dev->vblank[crtc].enabled = true;
			drm_update_vblank_count(dev, crtc);
		}
	}

	spin_unlock(&dev->vblank_time_lock);

	return ret;
}

901 902 903 904 905 906 907 908
/**
 * drm_vblank_get - get a reference count on vblank events
 * @dev: DRM device
 * @crtc: which CRTC to own
 *
 * Acquire a reference count on vblank events to avoid having them disabled
 * while in use.
 *
909 910
 * This is the legacy version of drm_crtc_vblank_get().
 *
D
Daniel Vetter 已提交
911
 * Returns:
912 913 914 915
 * Zero on success, nonzero on failure.
 */
int drm_vblank_get(struct drm_device *dev, int crtc)
{
916
	unsigned long irqflags;
917 918 919 920
	int ret = 0;

	spin_lock_irqsave(&dev->vbl_lock, irqflags);
	/* Going from 0->1 means we have to enable interrupts again */
921
	if (atomic_add_return(1, &dev->vblank[crtc].refcount) == 1) {
V
Ville Syrjälä 已提交
922
		ret = drm_vblank_enable(dev, crtc);
923
	} else {
924 925
		if (!dev->vblank[crtc].enabled) {
			atomic_dec(&dev->vblank[crtc].refcount);
926
			ret = -EINVAL;
927 928 929 930 931 932 933 934
		}
	}
	spin_unlock_irqrestore(&dev->vbl_lock, irqflags);

	return ret;
}
EXPORT_SYMBOL(drm_vblank_get);

935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952
/**
 * drm_crtc_vblank_get - get a reference count on vblank events
 * @crtc: which CRTC to own
 *
 * Acquire a reference count on vblank events to avoid having them disabled
 * while in use.
 *
 * This is the native kms version of drm_vblank_off().
 *
 * Returns:
 * Zero on success, nonzero on failure.
 */
int drm_crtc_vblank_get(struct drm_crtc *crtc)
{
	return drm_vblank_get(crtc->dev, drm_crtc_index(crtc));
}
EXPORT_SYMBOL(drm_crtc_vblank_get);

953 954 955 956 957 958
/**
 * drm_vblank_put - give up ownership of vblank events
 * @dev: DRM device
 * @crtc: which counter to give up
 *
 * Release ownership of a given vblank counter, turning off interrupts
959
 * if possible. Disable interrupts after drm_vblank_offdelay milliseconds.
960 961
 *
 * This is the legacy version of drm_crtc_vblank_put().
962 963 964
 */
void drm_vblank_put(struct drm_device *dev, int crtc)
{
965
	BUG_ON(atomic_read(&dev->vblank[crtc].refcount) == 0);
966

967
	/* Last user schedules interrupt disable */
968
	if (atomic_dec_and_test(&dev->vblank[crtc].refcount) &&
969
	    (drm_vblank_offdelay > 0))
970
		mod_timer(&dev->vblank[crtc].disable_timer,
D
Daniel Vetter 已提交
971
			  jiffies + ((drm_vblank_offdelay * HZ)/1000));
972 973 974
}
EXPORT_SYMBOL(drm_vblank_put);

975 976 977 978 979 980 981 982 983 984 985 986 987 988 989
/**
 * drm_crtc_vblank_put - give up ownership of vblank events
 * @crtc: which counter to give up
 *
 * Release ownership of a given vblank counter, turning off interrupts
 * if possible. Disable interrupts after drm_vblank_offdelay milliseconds.
 *
 * This is the native kms version of drm_vblank_put().
 */
void drm_crtc_vblank_put(struct drm_crtc *crtc)
{
	drm_vblank_put(crtc->dev, drm_crtc_index(crtc));
}
EXPORT_SYMBOL(drm_crtc_vblank_put);

990 991 992 993 994
/**
 * drm_vblank_off - disable vblank events on a CRTC
 * @dev: DRM device
 * @crtc: CRTC in question
 *
D
Daniel Vetter 已提交
995 996 997 998 999 1000
 * Drivers can use this function to shut down the vblank interrupt handling when
 * disabling a crtc. This function ensures that the latest vblank frame count is
 * stored so that drm_vblank_on() can restore it again.
 *
 * Drivers must use this function when the hardware vblank counter can get
 * reset, e.g. when suspending.
1001 1002
 *
 * This is the legacy version of drm_crtc_vblank_off().
1003
 */
1004 1005
void drm_vblank_off(struct drm_device *dev, int crtc)
{
1006 1007
	struct drm_pending_vblank_event *e, *t;
	struct timeval now;
1008
	unsigned long irqflags;
1009
	unsigned int seq;
1010 1011

	spin_lock_irqsave(&dev->vbl_lock, irqflags);
1012
	vblank_disable_and_save(dev, crtc);
1013
	wake_up(&dev->vblank[crtc].queue);
1014 1015 1016

	/* Send any queued vblank events, lest the natives grow disquiet */
	seq = drm_vblank_count_and_time(dev, crtc, &now);
1017 1018

	spin_lock(&dev->event_lock);
1019 1020 1021 1022 1023 1024
	list_for_each_entry_safe(e, t, &dev->vblank_event_list, base.link) {
		if (e->pipe != crtc)
			continue;
		DRM_DEBUG("Sending premature vblank event on disable: \
			  wanted %d, current %d\n",
			  e->event.sequence, seq);
1025
		list_del(&e->base.link);
1026
		drm_vblank_put(dev, e->pipe);
1027
		send_vblank_event(dev, e, seq, &now);
1028
	}
1029
	spin_unlock(&dev->event_lock);
1030

1031 1032 1033 1034 1035 1036 1037 1038 1039
	/*
	 * Prevent subsequent drm_vblank_get() from re-enabling
	 * the vblank interrupt by bumping the refcount.
	 */
	if (!dev->vblank[crtc].inmodeset) {
		atomic_inc(&dev->vblank[crtc].refcount);
		dev->vblank[crtc].inmodeset = 1;
	}

1040 1041 1042 1043
	spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
}
EXPORT_SYMBOL(drm_vblank_off);

1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
/**
 * drm_crtc_vblank_off - disable vblank events on a CRTC
 * @crtc: CRTC in question
 *
 * Drivers can use this function to shut down the vblank interrupt handling when
 * disabling a crtc. This function ensures that the latest vblank frame count is
 * stored so that drm_vblank_on can restore it again.
 *
 * Drivers must use this function when the hardware vblank counter can get
 * reset, e.g. when suspending.
 *
 * This is the native kms version of drm_vblank_off().
 */
void drm_crtc_vblank_off(struct drm_crtc *crtc)
{
	drm_vblank_off(crtc->dev, drm_crtc_index(crtc));
}
EXPORT_SYMBOL(drm_crtc_vblank_off);

V
Ville Syrjälä 已提交
1063 1064 1065 1066
/**
 * drm_vblank_on - enable vblank events on a CRTC
 * @dev: DRM device
 * @crtc: CRTC in question
D
Daniel Vetter 已提交
1067 1068 1069 1070 1071
 *
 * This functions restores the vblank interrupt state captured with
 * drm_vblank_off() again. Note that calls to drm_vblank_on() and
 * drm_vblank_off() can be unbalanced and so can also be unconditionaly called
 * in driver load code to reflect the current hardware state of the crtc.
1072 1073
 *
 * This is the legacy version of drm_crtc_vblank_on().
V
Ville Syrjälä 已提交
1074 1075 1076 1077 1078 1079
 */
void drm_vblank_on(struct drm_device *dev, int crtc)
{
	unsigned long irqflags;

	spin_lock_irqsave(&dev->vbl_lock, irqflags);
1080 1081 1082 1083 1084
	/* Drop our private "prevent drm_vblank_get" refcount */
	if (dev->vblank[crtc].inmodeset) {
		atomic_dec(&dev->vblank[crtc].refcount);
		dev->vblank[crtc].inmodeset = 0;
	}
V
Ville Syrjälä 已提交
1085 1086 1087 1088 1089 1090 1091
	/* re-enable interrupts if there's are users left */
	if (atomic_read(&dev->vblank[crtc].refcount) != 0)
		WARN_ON(drm_vblank_enable(dev, crtc));
	spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
}
EXPORT_SYMBOL(drm_vblank_on);

1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
/**
 * drm_crtc_vblank_on - enable vblank events on a CRTC
 * @crtc: CRTC in question
 *
 * This functions restores the vblank interrupt state captured with
 * drm_vblank_off() again. Note that calls to drm_vblank_on() and
 * drm_vblank_off() can be unbalanced and so can also be unconditionaly called
 * in driver load code to reflect the current hardware state of the crtc.
 *
 * This is the native kms version of drm_vblank_on().
 */
void drm_crtc_vblank_on(struct drm_crtc *crtc)
{
	drm_vblank_on(crtc->dev, drm_crtc_index(crtc));
}
EXPORT_SYMBOL(drm_crtc_vblank_on);

D
Dave Airlie 已提交
1109 1110 1111 1112 1113 1114 1115
/**
 * drm_vblank_pre_modeset - account for vblanks across mode sets
 * @dev: DRM device
 * @crtc: CRTC in question
 *
 * Account for vblank events across mode setting events, which will likely
 * reset the hardware frame counter.
D
Daniel Vetter 已提交
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
 *
 * This is done by grabbing a temporary vblank reference to ensure that the
 * vblank interrupt keeps running across the modeset sequence. With this the
 * software-side vblank frame counting will ensure that there are no jumps or
 * discontinuities.
 *
 * Unfortunately this approach is racy and also doesn't work when the vblank
 * interrupt stops running, e.g. across system suspend resume. It is therefore
 * highly recommended that drivers use the newer drm_vblank_off() and
 * drm_vblank_on() instead. drm_vblank_pre_modeset() only works correctly when
 * using "cooked" software vblank frame counters and not relying on any hardware
 * counters.
 *
 * Drivers must call drm_vblank_post_modeset() when re-enabling the same crtc
 * again.
D
Dave Airlie 已提交
1131 1132 1133
 */
void drm_vblank_pre_modeset(struct drm_device *dev, int crtc)
{
1134
	/* vblank is not initialized (IRQ not installed ?), or has been freed */
1135 1136
	if (!dev->num_crtcs)
		return;
D
Dave Airlie 已提交
1137 1138 1139 1140 1141 1142 1143
	/*
	 * To avoid all the problems that might happen if interrupts
	 * were enabled/disabled around or between these calls, we just
	 * have the kernel take a reference on the CRTC (just once though
	 * to avoid corrupting the count if multiple, mismatch calls occur),
	 * so that interrupts remain enabled in the interim.
	 */
1144 1145
	if (!dev->vblank[crtc].inmodeset) {
		dev->vblank[crtc].inmodeset = 0x1;
1146
		if (drm_vblank_get(dev, crtc) == 0)
1147
			dev->vblank[crtc].inmodeset |= 0x2;
D
Dave Airlie 已提交
1148 1149 1150 1151
	}
}
EXPORT_SYMBOL(drm_vblank_pre_modeset);

D
Daniel Vetter 已提交
1152 1153 1154 1155 1156 1157 1158 1159
/**
 * drm_vblank_post_modeset - undo drm_vblank_pre_modeset changes
 * @dev: DRM device
 * @crtc: CRTC in question
 *
 * This function again drops the temporary vblank reference acquired in
 * drm_vblank_pre_modeset.
 */
D
Dave Airlie 已提交
1160 1161 1162 1163
void drm_vblank_post_modeset(struct drm_device *dev, int crtc)
{
	unsigned long irqflags;

1164 1165 1166 1167
	/* vblank is not initialized (IRQ not installed ?), or has been freed */
	if (!dev->num_crtcs)
		return;

1168
	if (dev->vblank[crtc].inmodeset) {
D
Dave Airlie 已提交
1169
		spin_lock_irqsave(&dev->vbl_lock, irqflags);
1170
		dev->vblank_disable_allowed = true;
D
Dave Airlie 已提交
1171
		spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
1172

1173
		if (dev->vblank[crtc].inmodeset & 0x2)
1174 1175
			drm_vblank_put(dev, crtc);

1176
		dev->vblank[crtc].inmodeset = 0;
D
Dave Airlie 已提交
1177 1178 1179 1180
	}
}
EXPORT_SYMBOL(drm_vblank_post_modeset);

D
Daniel Vetter 已提交
1181
/*
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195
 * drm_modeset_ctl - handle vblank event counter changes across mode switch
 * @DRM_IOCTL_ARGS: standard ioctl arguments
 *
 * Applications should call the %_DRM_PRE_MODESET and %_DRM_POST_MODESET
 * ioctls around modesetting so that any lost vblank events are accounted for.
 *
 * Generally the counter will reset across mode sets.  If interrupts are
 * enabled around this call, we don't have to do anything since the counter
 * will have already been incremented.
 */
int drm_modeset_ctl(struct drm_device *dev, void *data,
		    struct drm_file *file_priv)
{
	struct drm_modeset_ctl *modeset = data;
1196
	unsigned int crtc;
1197 1198 1199

	/* If drm_vblank_init() hasn't been called yet, just no-op */
	if (!dev->num_crtcs)
1200
		return 0;
1201

1202 1203 1204 1205
	/* KMS drivers handle this internally */
	if (drm_core_check_feature(dev, DRIVER_MODESET))
		return 0;

1206
	crtc = modeset->crtc;
1207 1208
	if (crtc >= dev->num_crtcs)
		return -EINVAL;
1209 1210 1211

	switch (modeset->cmd) {
	case _DRM_PRE_MODESET:
D
Dave Airlie 已提交
1212
		drm_vblank_pre_modeset(dev, crtc);
1213 1214
		break;
	case _DRM_POST_MODESET:
D
Dave Airlie 已提交
1215
		drm_vblank_post_modeset(dev, crtc);
1216 1217
		break;
	default:
1218
		return -EINVAL;
1219 1220
	}

1221
	return 0;
1222 1223
}

1224 1225 1226 1227 1228 1229 1230 1231
static int drm_queue_vblank_event(struct drm_device *dev, int pipe,
				  union drm_wait_vblank *vblwait,
				  struct drm_file *file_priv)
{
	struct drm_pending_vblank_event *e;
	struct timeval now;
	unsigned long flags;
	unsigned int seq;
1232
	int ret;
1233 1234

	e = kzalloc(sizeof *e, GFP_KERNEL);
1235 1236 1237 1238
	if (e == NULL) {
		ret = -ENOMEM;
		goto err_put;
	}
1239 1240

	e->pipe = pipe;
1241
	e->base.pid = current->pid;
1242 1243 1244 1245 1246 1247 1248 1249 1250 1251
	e->event.base.type = DRM_EVENT_VBLANK;
	e->event.base.length = sizeof e->event;
	e->event.user_data = vblwait->request.signal;
	e->base.event = &e->event.base;
	e->base.file_priv = file_priv;
	e->base.destroy = (void (*) (struct drm_pending_event *)) kfree;

	spin_lock_irqsave(&dev->event_lock, flags);

	if (file_priv->event_space < sizeof e->event) {
1252 1253
		ret = -EBUSY;
		goto err_unlock;
1254 1255 1256
	}

	file_priv->event_space -= sizeof e->event;
1257 1258
	seq = drm_vblank_count_and_time(dev, pipe, &now);

1259 1260 1261
	if ((vblwait->request.type & _DRM_VBLANK_NEXTONMISS) &&
	    (seq - vblwait->request.sequence) <= (1 << 23)) {
		vblwait->request.sequence = seq + 1;
1262
		vblwait->reply.sequence = vblwait->request.sequence;
1263 1264 1265 1266 1267
	}

	DRM_DEBUG("event on vblank count %d, current %d, crtc %d\n",
		  vblwait->request.sequence, seq, pipe);

1268 1269 1270
	trace_drm_vblank_event_queued(current->pid, pipe,
				      vblwait->request.sequence);

1271 1272
	e->event.sequence = vblwait->request.sequence;
	if ((seq - vblwait->request.sequence) <= (1 << 23)) {
1273
		drm_vblank_put(dev, pipe);
1274
		send_vblank_event(dev, e, seq, &now);
1275
		vblwait->reply.sequence = seq;
1276
	} else {
1277
		/* drm_handle_vblank_events will call drm_vblank_put */
1278
		list_add_tail(&e->base.link, &dev->vblank_event_list);
1279
		vblwait->reply.sequence = vblwait->request.sequence;
1280 1281 1282 1283 1284
	}

	spin_unlock_irqrestore(&dev->event_lock, flags);

	return 0;
1285 1286 1287 1288 1289

err_unlock:
	spin_unlock_irqrestore(&dev->event_lock, flags);
	kfree(e);
err_put:
1290
	drm_vblank_put(dev, pipe);
1291
	return ret;
1292 1293
}

D
Daniel Vetter 已提交
1294
/*
L
Linus Torvalds 已提交
1295 1296 1297
 * Wait for VBLANK.
 *
 * \param inode device inode.
1298
 * \param file_priv DRM file private.
L
Linus Torvalds 已提交
1299 1300 1301 1302
 * \param cmd command.
 * \param data user argument, pointing to a drm_wait_vblank structure.
 * \return zero on success or a negative number on failure.
 *
1303 1304
 * This function enables the vblank interrupt on the pipe requested, then
 * sleeps waiting for the requested sequence number to occur, and drops
D
Daniel Vetter 已提交
1305
 * the vblank interrupt refcount afterwards. (vblank IRQ disable follows that
1306
 * after a timeout with no further vblank waits scheduled).
L
Linus Torvalds 已提交
1307
 */
1308 1309
int drm_wait_vblank(struct drm_device *dev, void *data,
		    struct drm_file *file_priv)
L
Linus Torvalds 已提交
1310
{
1311
	union drm_wait_vblank *vblwait = data;
1312
	int ret;
1313
	unsigned int flags, seq, crtc, high_crtc;
L
Linus Torvalds 已提交
1314

1315 1316
	if (!dev->irq_enabled)
		return -EINVAL;
L
Linus Torvalds 已提交
1317

1318 1319 1320
	if (vblwait->request.type & _DRM_VBLANK_SIGNAL)
		return -EINVAL;

1321
	if (vblwait->request.type &
1322 1323
	    ~(_DRM_VBLANK_TYPES_MASK | _DRM_VBLANK_FLAGS_MASK |
	      _DRM_VBLANK_HIGH_CRTC_MASK)) {
1324
		DRM_ERROR("Unsupported type value 0x%x, supported mask 0x%x\n",
1325
			  vblwait->request.type,
1326 1327
			  (_DRM_VBLANK_TYPES_MASK | _DRM_VBLANK_FLAGS_MASK |
			   _DRM_VBLANK_HIGH_CRTC_MASK));
1328 1329 1330
		return -EINVAL;
	}

1331
	flags = vblwait->request.type & _DRM_VBLANK_FLAGS_MASK;
1332 1333 1334 1335 1336
	high_crtc = (vblwait->request.type & _DRM_VBLANK_HIGH_CRTC_MASK);
	if (high_crtc)
		crtc = high_crtc >> _DRM_VBLANK_HIGH_CRTC_SHIFT;
	else
		crtc = flags & _DRM_VBLANK_SECONDARY ? 1 : 0;
1337
	if (crtc >= dev->num_crtcs)
1338 1339
		return -EINVAL;

1340 1341
	ret = drm_vblank_get(dev, crtc);
	if (ret) {
1342
		DRM_DEBUG("failed to acquire vblank counter, %d\n", ret);
1343 1344 1345
		return ret;
	}
	seq = drm_vblank_count(dev, crtc);
1346

1347
	switch (vblwait->request.type & _DRM_VBLANK_TYPES_MASK) {
L
Linus Torvalds 已提交
1348
	case _DRM_VBLANK_RELATIVE:
1349 1350
		vblwait->request.sequence += seq;
		vblwait->request.type &= ~_DRM_VBLANK_RELATIVE;
L
Linus Torvalds 已提交
1351 1352 1353
	case _DRM_VBLANK_ABSOLUTE:
		break;
	default:
1354 1355
		ret = -EINVAL;
		goto done;
L
Linus Torvalds 已提交
1356 1357
	}

1358 1359 1360 1361
	if (flags & _DRM_VBLANK_EVENT) {
		/* must hold on to the vblank ref until the event fires
		 * drm_vblank_put will be called asynchronously
		 */
1362
		return drm_queue_vblank_event(dev, crtc, vblwait, file_priv);
1363
	}
1364

1365
	if ((flags & _DRM_VBLANK_NEXTONMISS) &&
1366 1367
	    (seq - vblwait->request.sequence) <= (1<<23)) {
		vblwait->request.sequence = seq + 1;
1368 1369
	}

1370 1371
	DRM_DEBUG("waiting on vblank count %d, crtc %d\n",
		  vblwait->request.sequence, crtc);
1372
	dev->vblank[crtc].last_wait = vblwait->request.sequence;
D
Daniel Vetter 已提交
1373
	DRM_WAIT_ON(ret, dev->vblank[crtc].queue, 3 * HZ,
1374 1375
		    (((drm_vblank_count(dev, crtc) -
		       vblwait->request.sequence) <= (1 << 23)) ||
1376
		     !dev->vblank[crtc].enabled ||
1377
		     !dev->irq_enabled));
L
Linus Torvalds 已提交
1378

1379 1380
	if (ret != -EINTR) {
		struct timeval now;
L
Linus Torvalds 已提交
1381

1382
		vblwait->reply.sequence = drm_vblank_count_and_time(dev, crtc, &now);
1383 1384
		vblwait->reply.tval_sec = now.tv_sec;
		vblwait->reply.tval_usec = now.tv_usec;
1385

1386 1387
		DRM_DEBUG("returning %d to client\n",
			  vblwait->reply.sequence);
L
Linus Torvalds 已提交
1388
	} else {
1389
		DRM_DEBUG("vblank wait interrupted by signal\n");
L
Linus Torvalds 已提交
1390 1391
	}

1392 1393
done:
	drm_vblank_put(dev, crtc);
L
Linus Torvalds 已提交
1394 1395 1396
	return ret;
}

1397
static void drm_handle_vblank_events(struct drm_device *dev, int crtc)
1398 1399 1400 1401 1402 1403
{
	struct drm_pending_vblank_event *e, *t;
	struct timeval now;
	unsigned long flags;
	unsigned int seq;

1404
	seq = drm_vblank_count_and_time(dev, crtc, &now);
1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416

	spin_lock_irqsave(&dev->event_lock, flags);

	list_for_each_entry_safe(e, t, &dev->vblank_event_list, base.link) {
		if (e->pipe != crtc)
			continue;
		if ((seq - e->event.sequence) > (1<<23))
			continue;

		DRM_DEBUG("vblank event on %d, current %d\n",
			  e->event.sequence, seq);

1417
		list_del(&e->base.link);
1418
		drm_vblank_put(dev, e->pipe);
1419
		send_vblank_event(dev, e, seq, &now);
1420 1421 1422
	}

	spin_unlock_irqrestore(&dev->event_lock, flags);
J
Jesse Barnes 已提交
1423 1424

	trace_drm_vblank_event(crtc, seq);
1425 1426
}

1427 1428 1429 1430 1431 1432 1433 1434
/**
 * drm_handle_vblank - handle a vblank event
 * @dev: DRM device
 * @crtc: where this event occurred
 *
 * Drivers should call this routine in their vblank interrupt handlers to
 * update the vblank counter and send any signals that may be pending.
 */
1435
bool drm_handle_vblank(struct drm_device *dev, int crtc)
1436
{
1437 1438 1439 1440 1441
	u32 vblcount;
	s64 diff_ns;
	struct timeval tvblank;
	unsigned long irqflags;

1442
	if (!dev->num_crtcs)
1443
		return false;
1444

1445 1446 1447 1448 1449 1450 1451
	/* Need timestamp lock to prevent concurrent execution with
	 * vblank enable/disable, as this would cause inconsistent
	 * or corrupted timestamps and vblank counts.
	 */
	spin_lock_irqsave(&dev->vblank_time_lock, irqflags);

	/* Vblank irq handling disabled. Nothing to do. */
1452
	if (!dev->vblank[crtc].enabled) {
1453
		spin_unlock_irqrestore(&dev->vblank_time_lock, irqflags);
1454
		return false;
1455 1456 1457 1458 1459 1460 1461
	}

	/* Fetch corresponding timestamp for this vblank interval from
	 * driver and store it in proper slot of timestamp ringbuffer.
	 */

	/* Get current timestamp and count. */
1462
	vblcount = atomic_read(&dev->vblank[crtc].count);
1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477
	drm_get_last_vbltimestamp(dev, crtc, &tvblank, DRM_CALLED_FROM_VBLIRQ);

	/* Compute time difference to timestamp of last vblank */
	diff_ns = timeval_to_ns(&tvblank) -
		  timeval_to_ns(&vblanktimestamp(dev, crtc, vblcount));

	/* Update vblank timestamp and count if at least
	 * DRM_REDUNDANT_VBLIRQ_THRESH_NS nanoseconds
	 * difference between last stored timestamp and current
	 * timestamp. A smaller difference means basically
	 * identical timestamps. Happens if this vblank has
	 * been already processed and this is a redundant call,
	 * e.g., due to spurious vblank interrupts. We need to
	 * ignore those for accounting.
	 */
1478
	if (abs64(diff_ns) > DRM_REDUNDANT_VBLIRQ_THRESH_NS) {
1479 1480 1481 1482 1483 1484
		/* Store new timestamp in ringbuffer. */
		vblanktimestamp(dev, crtc, vblcount + 1) = tvblank;

		/* Increment cooked vblank count. This also atomically commits
		 * the timestamp computed above.
		 */
1485
		smp_mb__before_atomic();
1486
		atomic_inc(&dev->vblank[crtc].count);
1487
		smp_mb__after_atomic();
1488 1489 1490 1491 1492
	} else {
		DRM_DEBUG("crtc %d: Redundant vblirq ignored. diff_ns = %d\n",
			  crtc, (int) diff_ns);
	}

1493
	wake_up(&dev->vblank[crtc].queue);
1494
	drm_handle_vblank_events(dev, crtc);
1495 1496

	spin_unlock_irqrestore(&dev->vblank_time_lock, irqflags);
1497
	return true;
1498 1499
}
EXPORT_SYMBOL(drm_handle_vblank);