drm_irq.c 46.0 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

/* 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

58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
/**
 * 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)
{
76
	struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
	u32 cur_vblank, diff, tslot, rc;
	struct timeval t_vblank;

	/*
	 * 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.
	 *
	 * 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.
	 */
	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 */
98 99
	diff = cur_vblank - vblank->last;
	if (cur_vblank < vblank->last) {
100 101 102
		diff += dev->max_vblank_count;

		DRM_DEBUG("last_vblank[%d]=0x%x, cur_vblank=0x%x => diff=0x%x\n",
103
			  crtc, vblank->last, cur_vblank, diff);
104 105
	}

106
	DRM_DEBUG("updating vblank count on crtc %d, missed %d\n",
107 108 109 110 111 112 113
		  crtc, diff);

	/* 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) {
114
		tslot = atomic_read(&vblank->count) + diff;
115 116 117 118
		vblanktimestamp(dev, crtc, tslot) = t_vblank;
	}

	smp_mb__before_atomic();
119
	atomic_add(diff, &vblank->count);
120 121 122
	smp_mb__after_atomic();
}

123 124 125 126 127 128 129 130
/*
 * 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)
{
131
	struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
132 133 134 135 136
	unsigned long irqflags;
	u32 vblcount;
	s64 diff_ns;
	int vblrc;
	struct timeval tvblank;
137
	int count = DRM_TIMESTAMP_MAXRETRIES;
138 139 140 141 142 143 144

	/* 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);

145 146 147 148 149 150 151
	/*
	 * If the vblank interrupt was already disbled update the count
	 * and timestamp to maintain the appearance that the counter
	 * has been ticking all along until this time. This makes the
	 * count account for the entire time between drm_vblank_on() and
	 * drm_vblank_off().
	 */
152
	if (!vblank->enabled) {
153 154 155 156 157
		drm_update_vblank_count(dev, crtc);
		spin_unlock_irqrestore(&dev->vblank_time_lock, irqflags);
		return;
	}

158
	dev->driver->disable_vblank(dev, crtc);
159
	vblank->enabled = false;
160 161 162 163 164 165 166 167 168 169 170 171 172 173

	/* 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 {
174
		vblank->last = dev->driver->get_vblank_counter(dev, crtc);
175
		vblrc = drm_get_last_vbltimestamp(dev, crtc, &tvblank, 0);
176
	} while (vblank->last != dev->driver->get_vblank_counter(dev, crtc) && (--count) && vblrc);
177 178 179

	if (!count)
		vblrc = 0;
180 181 182 183

	/* Compute time difference to stored timestamp of last vblank
	 * as updated by last invocation of drm_handle_vblank() in vblank irq.
	 */
184
	vblcount = atomic_read(&vblank->count);
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
	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.
	 */
200
	if ((vblrc > 0) && (abs64(diff_ns) > 1000000)) {
201
		atomic_inc(&vblank->count);
202
		smp_mb__after_atomic();
203
	}
204 205 206 207

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

208 209
static void vblank_disable_fn(unsigned long arg)
{
210 211
	struct drm_vblank_crtc *vblank = (void *)arg;
	struct drm_device *dev = vblank->dev;
212
	unsigned long irqflags;
213
	int crtc = vblank->crtc;
214 215 216 217

	if (!dev->vblank_disable_allowed)
		return;

218 219 220 221
	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);
222
	}
223
	spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
224 225
}

D
Daniel Vetter 已提交
226 227 228 229 230 231
/**
 * drm_vblank_cleanup - cleanup vblank support
 * @dev: DRM device
 *
 * This function cleans up any resources allocated in drm_vblank_init.
 */
232
void drm_vblank_cleanup(struct drm_device *dev)
233
{
234 235
	int crtc;

236 237 238 239
	/* Bail if the driver didn't call drm_vblank_init() */
	if (dev->num_crtcs == 0)
		return;

240
	for (crtc = 0; crtc < dev->num_crtcs; crtc++) {
241 242 243 244
		struct drm_vblank_crtc *vblank = &dev->vblank[crtc];

		del_timer_sync(&vblank->disable_timer);
		vblank_disable_fn((unsigned long)vblank);
245
	}
246

247
	kfree(dev->vblank);
248 249 250

	dev->num_crtcs = 0;
}
251
EXPORT_SYMBOL(drm_vblank_cleanup);
252

D
Daniel Vetter 已提交
253 254 255 256 257 258 259 260 261 262
/**
 * 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.
 */
263 264 265 266 267
int drm_vblank_init(struct drm_device *dev, int num_crtcs)
{
	int i, ret = -ENOMEM;

	spin_lock_init(&dev->vbl_lock);
268 269
	spin_lock_init(&dev->vblank_time_lock);

270 271
	dev->num_crtcs = num_crtcs;

272 273
	dev->vblank = kcalloc(num_crtcs, sizeof(*dev->vblank), GFP_KERNEL);
	if (!dev->vblank)
274 275
		goto err;

276
	for (i = 0; i < num_crtcs; i++) {
277 278 279 280 281 282 283
		struct drm_vblank_crtc *vblank = &dev->vblank[i];

		vblank->dev = dev;
		vblank->crtc = i;
		init_waitqueue_head(&vblank->queue);
		setup_timer(&vblank->disable_timer, vblank_disable_fn,
			    (unsigned long)vblank);
284
	}
285

286
	DRM_INFO("Supports vblank timestamp caching Rev 2 (21.10.2013).\n");
287 288 289 290 291 292 293

	/* 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");

294 295
	dev->vblank_disable_allowed = false;

296 297 298 299 300 301 302 303
	return 0;

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

304 305 306 307 308 309 310 311 312 313 314 315
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;

316 317 318 319 320 321 322 323
	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);
324 325 326
	}
}

L
Linus Torvalds 已提交
327
/**
D
Daniel Vetter 已提交
328 329 330
 * drm_irq_install - install IRQ handler
 * @dev: DRM device
 * @irq: IRQ number to install the handler for
L
Linus Torvalds 已提交
331
 *
332
 * Initializes the IRQ related data. Installs the handler, calling the driver
D
Daniel Vetter 已提交
333 334 335 336 337 338 339 340 341 342
 * 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 已提交
343
 */
344
int drm_irq_install(struct drm_device *dev, int irq)
L
Linus Torvalds 已提交
345
{
346
	int ret;
D
Dave Airlie 已提交
347
	unsigned long sh_flags = 0;
L
Linus Torvalds 已提交
348 349 350 351

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

352
	if (irq == 0)
L
Linus Torvalds 已提交
353 354 355
		return -EINVAL;

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

359
	if (dev->irq_enabled)
L
Linus Torvalds 已提交
360
		return -EBUSY;
V
Ville Syrjälä 已提交
361
	dev->irq_enabled = true;
L
Linus Torvalds 已提交
362

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

D
Dave Airlie 已提交
365
	/* Before installing handler */
366 367
	if (dev->driver->irq_preinstall)
		dev->driver->irq_preinstall(dev);
L
Linus Torvalds 已提交
368

D
Dave Airlie 已提交
369
	/* Install handler */
L
Linus Torvalds 已提交
370
	if (drm_core_check_feature(dev, DRIVER_IRQ_SHARED))
371
		sh_flags = IRQF_SHARED;
D
Dave Airlie 已提交
372

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

D
Dave Airlie 已提交
376
	if (ret < 0) {
V
Ville Syrjälä 已提交
377
		dev->irq_enabled = false;
L
Linus Torvalds 已提交
378 379 380
		return ret;
	}

381 382 383
	if (!drm_core_check_feature(dev, DRIVER_MODESET))
		vga_client_register(dev->pdev, (void *)dev, drm_irq_vgaarb_nokms, NULL);

D
Dave Airlie 已提交
384
	/* After installing handler */
385 386 387
	if (dev->driver->irq_postinstall)
		ret = dev->driver->irq_postinstall(dev);

388
	if (ret < 0) {
V
Ville Syrjälä 已提交
389
		dev->irq_enabled = false;
390 391
		if (!drm_core_check_feature(dev, DRIVER_MODESET))
			vga_client_register(dev->pdev, NULL, NULL, NULL);
392 393 394
		free_irq(irq, dev);
	} else {
		dev->irq = irq;
395
	}
L
Linus Torvalds 已提交
396

397
	return ret;
L
Linus Torvalds 已提交
398
}
399
EXPORT_SYMBOL(drm_irq_install);
L
Linus Torvalds 已提交
400 401

/**
D
Daniel Vetter 已提交
402 403 404 405 406 407 408
 * 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 已提交
409
 *
D
Daniel Vetter 已提交
410 411 412
 * 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 已提交
413
 *
D
Daniel Vetter 已提交
414 415
 * Returns:
 * Zero on success or a negative error code on failure.
L
Linus Torvalds 已提交
416
 */
417
int drm_irq_uninstall(struct drm_device *dev)
L
Linus Torvalds 已提交
418
{
419
	unsigned long irqflags;
V
Ville Syrjälä 已提交
420 421
	bool irq_enabled;
	int i;
L
Linus Torvalds 已提交
422 423 424 425 426

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

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

429 430 431
	/*
	 * Wake up any waiters so they don't hang.
	 */
432 433 434
	if (dev->num_crtcs) {
		spin_lock_irqsave(&dev->vbl_lock, irqflags);
		for (i = 0; i < dev->num_crtcs; i++) {
435 436 437 438 439
			struct drm_vblank_crtc *vblank = &dev->vblank[i];

			wake_up(&vblank->queue);
			vblank->enabled = false;
			vblank->last =
440 441 442
				dev->driver->get_vblank_counter(dev, i);
		}
		spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
443 444
	}

D
Dave Airlie 已提交
445
	if (!irq_enabled)
L
Linus Torvalds 已提交
446 447
		return -EINVAL;

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

450 451 452
	if (!drm_core_check_feature(dev, DRIVER_MODESET))
		vga_client_register(dev->pdev, NULL, NULL, NULL);

453 454
	if (dev->driver->irq_uninstall)
		dev->driver->irq_uninstall(dev);
L
Linus Torvalds 已提交
455

456
	free_irq(dev->irq, dev);
L
Linus Torvalds 已提交
457 458 459 460 461

	return 0;
}
EXPORT_SYMBOL(drm_irq_uninstall);

D
Daniel Vetter 已提交
462
/*
L
Linus Torvalds 已提交
463 464 465
 * IRQ control ioctl.
 *
 * \param inode device inode.
466
 * \param file_priv DRM file private.
L
Linus Torvalds 已提交
467 468 469 470 471 472
 * \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.
 */
473 474
int drm_control(struct drm_device *dev, void *data,
		struct drm_file *file_priv)
L
Linus Torvalds 已提交
475
{
476
	struct drm_control *ctl = data;
477
	int ret = 0, irq;
D
Dave Airlie 已提交
478

479 480 481
	/* if we haven't irq we fallback for compatibility reasons -
	 * this used to be a separate function in drm_dma.h
	 */
L
Linus Torvalds 已提交
482

483 484 485 486 487 488 489
	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 已提交
490

491
	switch (ctl->func) {
L
Linus Torvalds 已提交
492
	case DRM_INST_HANDLER:
493 494
		irq = dev->pdev->irq;

L
Linus Torvalds 已提交
495
		if (dev->if_version < DRM_IF_VERSION(1, 2) &&
496
		    ctl->irq != irq)
L
Linus Torvalds 已提交
497
			return -EINVAL;
498
		mutex_lock(&dev->struct_mutex);
499
		ret = drm_irq_install(dev, irq);
500 501 502
		mutex_unlock(&dev->struct_mutex);

		return ret;
L
Linus Torvalds 已提交
503
	case DRM_UNINST_HANDLER:
504 505 506 507 508
		mutex_lock(&dev->struct_mutex);
		ret = drm_irq_uninstall(dev);
		mutex_unlock(&dev->struct_mutex);

		return ret;
L
Linus Torvalds 已提交
509 510 511 512 513
	default:
		return -EINVAL;
	}
}

514
/**
D
Daniel Vetter 已提交
515 516 517
 * drm_calc_timestamping_constants - calculate vblank timestamp constants
 * @crtc: drm_crtc whose timestamp constants should be updated.
 * @mode: display mode containing the scanout timings
518
 *
519 520 521
 * 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 已提交
522
 * derived from CRTC's true scanout timing, so they take
523
 * things like panel scaling or other adjustments into account.
524
 */
525 526
void drm_calc_timestamping_constants(struct drm_crtc *crtc,
				     const struct drm_display_mode *mode)
527
{
528
	int linedur_ns = 0, pixeldur_ns = 0, framedur_ns = 0;
529
	int dotclock = mode->crtc_clock;
530 531 532

	/* Valid dotclock? */
	if (dotclock > 0) {
533 534 535 536 537 538
		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:
539
		 */
540 541 542
		pixeldur_ns = 1000000 / dotclock;
		linedur_ns  = div_u64((u64) mode->crtc_htotal * 1000000, dotclock);
		framedur_ns = div_u64((u64) frame_size * 1000000, dotclock);
543 544 545 546 547 548

		/*
		 * Fields of interlaced scanout modes are only half a frame duration.
		 */
		if (mode->flags & DRM_MODE_FLAG_INTERLACE)
			framedur_ns /= 2;
549 550 551 552 553 554 555 556 557
	} 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",
558 559
		  crtc->base.id, mode->crtc_htotal,
		  mode->crtc_vtotal, mode->crtc_vdisplay);
560
	DRM_DEBUG("crtc %d: clock %d kHz framedur %d linedur %d, pixeldur %d\n",
561 562
		  crtc->base.id, dotclock, framedur_ns,
		  linedur_ns, pixeldur_ns);
563 564 565 566
}
EXPORT_SYMBOL(drm_calc_timestamping_constants);

/**
D
Daniel Vetter 已提交
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
 * 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.
583 584 585 586 587 588 589 590 591 592 593 594 595 596
 *
 * 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 已提交
597 598
 * Returns:
 * Negative value on error, failure or if not supported in current
599 600
 * video mode:
 *
D
Daniel Vetter 已提交
601
 * -EINVAL   - Invalid CRTC.
602 603 604 605 606 607 608 609 610 611 612 613 614 615
 * -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,
616 617
					  const struct drm_crtc *refcrtc,
					  const struct drm_display_mode *mode)
618
{
619 620
	ktime_t stime, etime, mono_time_offset;
	struct timeval tv_etime;
621
	int vbl_status;
622
	int vpos, hpos, i;
623
	int framedur_ns, linedur_ns, pixeldur_ns, delta_ns, duration_ns;
624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
	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.
	 */
645
	if (framedur_ns == 0) {
646 647 648 649 650 651 652 653 654 655 656 657
		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++) {
658 659 660 661
		/*
		 * Get vertical and horizontal scanout position vpos, hpos,
		 * and bounding timestamps stime, etime, pre/post query.
		 */
662
		vbl_status = dev->driver->get_scanout_position(dev, crtc, flags, &vpos,
663
							       &hpos, &stime, &etime);
664

665 666 667 668
		/*
		 * Get correction for CLOCK_MONOTONIC -> CLOCK_REALTIME if
		 * CLOCK_REALTIME is requested.
		 */
669 670
		if (!drm_timestamp_monotonic)
			mono_time_offset = ktime_get_monotonic_offset();
671 672 673 674 675 676 677 678

		/* 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;
		}

679
		/* Compute uncertainty in timestamp of scanout position query. */
680
		duration_ns = ktime_to_ns(etime) - ktime_to_ns(stime);
681 682

		/* Accept result with <  max_error nsecs timing uncertainty. */
683
		if (duration_ns <= *max_error)
684 685 686 687 688 689
			break;
	}

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

	/* Return upper bound of timestamp precision error. */
694
	*max_error = duration_ns;
695 696 697 698 699 700 701 702 703 704 705 706

	/* 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.
	 */
707
	delta_ns = vpos * linedur_ns + hpos * pixeldur_ns;
708

709 710 711
	if (!drm_timestamp_monotonic)
		etime = ktime_sub(etime, mono_time_offset);

712 713
	/* save this only for debugging purposes */
	tv_etime = ktime_to_timeval(etime);
714 715 716
	/* Subtract time delta from raw timestamp to get final
	 * vblank_time timestamp for end of vblank.
	 */
717 718 719 720
	if (delta_ns < 0)
		etime = ktime_add_ns(etime, -delta_ns);
	else
		etime = ktime_sub_ns(etime, delta_ns);
721
	*vblank_time = ktime_to_timeval(etime);
722

723 724
	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,
725
		  (long)tv_etime.tv_sec, (long)tv_etime.tv_usec,
726
		  (long)vblank_time->tv_sec, (long)vblank_time->tv_usec,
727
		  duration_ns/1000, i);
728 729 730 731 732 733 734 735 736

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

	return vbl_status;
}
EXPORT_SYMBOL(drm_calc_vbltimestamp_from_scanoutpos);

737 738 739 740 741 742 743 744 745 746 747
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);
}

748 749
/**
 * drm_get_last_vbltimestamp - retrieve raw timestamp for the most recent
D
Daniel Vetter 已提交
750
 * 			       vblank interval
751
 * @dev: DRM device
D
Daniel Vetter 已提交
752
 * @crtc: which CRTC's vblank timestamp to retrieve
753 754
 * @tvblank: Pointer to target struct timeval which should receive the timestamp
 * @flags: Flags to pass to driver:
D
Daniel Vetter 已提交
755 756
 *         0 = Default,
 *         DRM_CALLED_FROM_VBLIRQ = If function is called from vbl IRQ handler
757 758
 *
 * Fetches the system timestamp corresponding to the time of the most recent
D
Daniel Vetter 已提交
759
 * vblank interval on specified CRTC. May call into kms-driver to
760 761 762 763 764
 * 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 已提交
765 766
 * Returns:
 * Non-zero if timestamp is considered to be very precise, zero otherwise.
767 768 769 770
 */
u32 drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
			      struct timeval *tvblank, unsigned flags)
{
771
	int ret;
772 773 774 775 776 777 778 779 780 781 782 783 784

	/* 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.
785
	 * Return current monotonic/gettimeofday timestamp as best estimate.
786
	 */
787
	*tvblank = get_drm_timestamp();
788 789 790 791 792

	return 0;
}
EXPORT_SYMBOL(drm_get_last_vbltimestamp);

793 794 795 796 797 798 799 800
/**
 * 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 已提交
801 802 803
 *
 * Returns:
 * The software vblank counter.
804 805 806
 */
u32 drm_vblank_count(struct drm_device *dev, int crtc)
{
807 808 809
	struct drm_vblank_crtc *vblank = &dev->vblank[crtc];

	return atomic_read(&vblank->count);
810 811 812
}
EXPORT_SYMBOL(drm_vblank_count);

813 814 815 816 817 818 819 820 821 822 823
/**
 * 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 已提交
824
 * of the vblank interval that corresponds to the current vblank counter value.
825 826 827 828
 */
u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
			      struct timeval *vblanktime)
{
829
	struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
830 831 832 833 834 835 836 837
	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 {
838
		cur_vblank = atomic_read(&vblank->count);
839 840
		*vblanktime = vblanktimestamp(dev, crtc, cur_vblank);
		smp_rmb();
841
	} while (cur_vblank != atomic_read(&vblank->count));
842 843 844 845 846

	return cur_vblank;
}
EXPORT_SYMBOL(drm_vblank_count_and_time);

847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880
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;
881 882

		now = get_drm_timestamp();
883
	}
884
	e->pipe = crtc;
885 886 887 888
	send_vblank_event(dev, e, seq, &now);
}
EXPORT_SYMBOL(drm_send_vblank_event);

V
Ville Syrjälä 已提交
889 890 891 892 893 894 895
/**
 * 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)
{
896
	struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
V
Ville Syrjälä 已提交
897 898 899 900 901 902
	int ret = 0;

	assert_spin_locked(&dev->vbl_lock);

	spin_lock(&dev->vblank_time_lock);

903
	if (!vblank->enabled) {
D
Daniel Vetter 已提交
904 905
		/*
		 * Enable vblank irqs under vblank_time_lock protection.
V
Ville Syrjälä 已提交
906 907 908 909 910 911 912 913
		 * 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)
914
			atomic_dec(&vblank->refcount);
V
Ville Syrjälä 已提交
915
		else {
916
			vblank->enabled = true;
V
Ville Syrjälä 已提交
917 918 919 920 921 922 923 924 925
			drm_update_vblank_count(dev, crtc);
		}
	}

	spin_unlock(&dev->vblank_time_lock);

	return ret;
}

926 927 928 929 930 931 932 933
/**
 * 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.
 *
934 935
 * This is the legacy version of drm_crtc_vblank_get().
 *
D
Daniel Vetter 已提交
936
 * Returns:
937 938 939 940
 * Zero on success, nonzero on failure.
 */
int drm_vblank_get(struct drm_device *dev, int crtc)
{
941
	struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
942
	unsigned long irqflags;
943 944 945 946
	int ret = 0;

	spin_lock_irqsave(&dev->vbl_lock, irqflags);
	/* Going from 0->1 means we have to enable interrupts again */
947
	if (atomic_add_return(1, &vblank->refcount) == 1) {
V
Ville Syrjälä 已提交
948
		ret = drm_vblank_enable(dev, crtc);
949
	} else {
950 951
		if (!vblank->enabled) {
			atomic_dec(&vblank->refcount);
952
			ret = -EINVAL;
953 954 955 956 957 958 959 960
		}
	}
	spin_unlock_irqrestore(&dev->vbl_lock, irqflags);

	return ret;
}
EXPORT_SYMBOL(drm_vblank_get);

961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978
/**
 * 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);

979 980 981 982 983 984
/**
 * 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
985
 * if possible. Disable interrupts after drm_vblank_offdelay milliseconds.
986 987
 *
 * This is the legacy version of drm_crtc_vblank_put().
988 989 990
 */
void drm_vblank_put(struct drm_device *dev, int crtc)
{
991 992 993
	struct drm_vblank_crtc *vblank = &dev->vblank[crtc];

	BUG_ON(atomic_read(&vblank->refcount) == 0);
994

995
	/* Last user schedules interrupt disable */
996
	if (atomic_dec_and_test(&vblank->refcount)) {
997
		if (dev->vblank_disable_immediate || drm_vblank_offdelay < 0)
998 999 1000 1001 1002
			vblank_disable_fn((unsigned long)vblank);
		else if (drm_vblank_offdelay > 0)
			mod_timer(&vblank->disable_timer,
				  jiffies + ((drm_vblank_offdelay * HZ)/1000));
	}
1003 1004 1005
}
EXPORT_SYMBOL(drm_vblank_put);

1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
/**
 * 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);

1021 1022 1023 1024 1025
/**
 * drm_vblank_off - disable vblank events on a CRTC
 * @dev: DRM device
 * @crtc: CRTC in question
 *
D
Daniel Vetter 已提交
1026 1027 1028 1029 1030 1031
 * 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.
1032 1033
 *
 * This is the legacy version of drm_crtc_vblank_off().
1034
 */
1035 1036
void drm_vblank_off(struct drm_device *dev, int crtc)
{
1037
	struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
1038 1039
	struct drm_pending_vblank_event *e, *t;
	struct timeval now;
1040
	unsigned long irqflags;
1041
	unsigned int seq;
1042

1043 1044 1045
	spin_lock_irqsave(&dev->event_lock, irqflags);

	spin_lock(&dev->vbl_lock);
1046
	vblank_disable_and_save(dev, crtc);
1047
	wake_up(&vblank->queue);
1048

1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
	/*
	 * Prevent subsequent drm_vblank_get() from re-enabling
	 * the vblank interrupt by bumping the refcount.
	 */
	if (!vblank->inmodeset) {
		atomic_inc(&vblank->refcount);
		vblank->inmodeset = 1;
	}
	spin_unlock(&dev->vbl_lock);

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

1062 1063 1064 1065 1066 1067
	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);
1068
		list_del(&e->base.link);
1069
		drm_vblank_put(dev, e->pipe);
1070
		send_vblank_event(dev, e, seq, &now);
1071
	}
1072
	spin_unlock_irqrestore(&dev->event_lock, irqflags);
1073 1074 1075
}
EXPORT_SYMBOL(drm_vblank_off);

1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
/**
 * 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ä 已提交
1095 1096 1097 1098
/**
 * drm_vblank_on - enable vblank events on a CRTC
 * @dev: DRM device
 * @crtc: CRTC in question
D
Daniel Vetter 已提交
1099 1100 1101 1102 1103
 *
 * 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.
1104 1105
 *
 * This is the legacy version of drm_crtc_vblank_on().
V
Ville Syrjälä 已提交
1106 1107 1108
 */
void drm_vblank_on(struct drm_device *dev, int crtc)
{
1109
	struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
V
Ville Syrjälä 已提交
1110 1111 1112
	unsigned long irqflags;

	spin_lock_irqsave(&dev->vbl_lock, irqflags);
1113
	/* Drop our private "prevent drm_vblank_get" refcount */
1114 1115 1116
	if (vblank->inmodeset) {
		atomic_dec(&vblank->refcount);
		vblank->inmodeset = 0;
1117
	}
1118 1119 1120 1121 1122 1123 1124 1125

	/*
	 * sample the current counter to avoid random jumps
	 * when drm_vblank_enable() applies the diff
	 *
	 * -1 to make sure user will never see the same
	 * vblank counter value before and after a modeset
	 */
1126
	vblank->last =
1127 1128
		(dev->driver->get_vblank_counter(dev, crtc) - 1) &
		dev->max_vblank_count;
1129 1130 1131 1132 1133 1134
	/*
	 * re-enable interrupts if there are users left, or the
	 * user wishes vblank interrupts to be enabled all the time.
	 */
	if (atomic_read(&vblank->refcount) != 0 ||
	    (!dev->vblank_disable_immediate && drm_vblank_offdelay == 0))
V
Ville Syrjälä 已提交
1135 1136 1137 1138 1139
		WARN_ON(drm_vblank_enable(dev, crtc));
	spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
}
EXPORT_SYMBOL(drm_vblank_on);

1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
/**
 * 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 已提交
1157 1158 1159 1160 1161 1162 1163
/**
 * 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 已提交
1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178
 *
 * 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 已提交
1179 1180 1181
 */
void drm_vblank_pre_modeset(struct drm_device *dev, int crtc)
{
1182 1183
	struct drm_vblank_crtc *vblank = &dev->vblank[crtc];

1184
	/* vblank is not initialized (IRQ not installed ?), or has been freed */
1185 1186
	if (!dev->num_crtcs)
		return;
D
Dave Airlie 已提交
1187 1188 1189 1190 1191 1192 1193
	/*
	 * 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.
	 */
1194 1195
	if (!vblank->inmodeset) {
		vblank->inmodeset = 0x1;
1196
		if (drm_vblank_get(dev, crtc) == 0)
1197
			vblank->inmodeset |= 0x2;
D
Dave Airlie 已提交
1198 1199 1200 1201
	}
}
EXPORT_SYMBOL(drm_vblank_pre_modeset);

D
Daniel Vetter 已提交
1202 1203 1204 1205 1206 1207 1208 1209
/**
 * 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 已提交
1210 1211
void drm_vblank_post_modeset(struct drm_device *dev, int crtc)
{
1212
	struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
D
Dave Airlie 已提交
1213 1214
	unsigned long irqflags;

1215 1216 1217 1218
	/* vblank is not initialized (IRQ not installed ?), or has been freed */
	if (!dev->num_crtcs)
		return;

1219
	if (vblank->inmodeset) {
D
Dave Airlie 已提交
1220
		spin_lock_irqsave(&dev->vbl_lock, irqflags);
1221
		dev->vblank_disable_allowed = true;
D
Dave Airlie 已提交
1222
		spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
1223

1224
		if (vblank->inmodeset & 0x2)
1225 1226
			drm_vblank_put(dev, crtc);

1227
		vblank->inmodeset = 0;
D
Dave Airlie 已提交
1228 1229 1230 1231
	}
}
EXPORT_SYMBOL(drm_vblank_post_modeset);

D
Daniel Vetter 已提交
1232
/*
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
 * 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;
1247
	unsigned int crtc;
1248 1249 1250

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

1253 1254 1255 1256
	/* KMS drivers handle this internally */
	if (drm_core_check_feature(dev, DRIVER_MODESET))
		return 0;

1257
	crtc = modeset->crtc;
1258 1259
	if (crtc >= dev->num_crtcs)
		return -EINVAL;
1260 1261 1262

	switch (modeset->cmd) {
	case _DRM_PRE_MODESET:
D
Dave Airlie 已提交
1263
		drm_vblank_pre_modeset(dev, crtc);
1264 1265
		break;
	case _DRM_POST_MODESET:
D
Dave Airlie 已提交
1266
		drm_vblank_post_modeset(dev, crtc);
1267 1268
		break;
	default:
1269
		return -EINVAL;
1270 1271
	}

1272
	return 0;
1273 1274
}

1275 1276 1277 1278
static int drm_queue_vblank_event(struct drm_device *dev, int pipe,
				  union drm_wait_vblank *vblwait,
				  struct drm_file *file_priv)
{
1279
	struct drm_vblank_crtc *vblank = &dev->vblank[pipe];
1280 1281 1282 1283
	struct drm_pending_vblank_event *e;
	struct timeval now;
	unsigned long flags;
	unsigned int seq;
1284
	int ret;
1285 1286

	e = kzalloc(sizeof *e, GFP_KERNEL);
1287 1288 1289 1290
	if (e == NULL) {
		ret = -ENOMEM;
		goto err_put;
	}
1291 1292

	e->pipe = pipe;
1293
	e->base.pid = current->pid;
1294 1295 1296 1297 1298 1299 1300 1301 1302
	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);

1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314
	/*
	 * drm_vblank_off() might have been called after we called
	 * drm_vblank_get(). drm_vblank_off() holds event_lock
	 * around the vblank disable, so no need for further locking.
	 * The reference from drm_vblank_get() protects against
	 * vblank disable from another source.
	 */
	if (!vblank->enabled) {
		ret = -EINVAL;
		goto err_unlock;
	}

1315
	if (file_priv->event_space < sizeof e->event) {
1316 1317
		ret = -EBUSY;
		goto err_unlock;
1318 1319 1320
	}

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

1323 1324 1325
	if ((vblwait->request.type & _DRM_VBLANK_NEXTONMISS) &&
	    (seq - vblwait->request.sequence) <= (1 << 23)) {
		vblwait->request.sequence = seq + 1;
1326
		vblwait->reply.sequence = vblwait->request.sequence;
1327 1328 1329 1330 1331
	}

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

1332 1333 1334
	trace_drm_vblank_event_queued(current->pid, pipe,
				      vblwait->request.sequence);

1335 1336
	e->event.sequence = vblwait->request.sequence;
	if ((seq - vblwait->request.sequence) <= (1 << 23)) {
1337
		drm_vblank_put(dev, pipe);
1338
		send_vblank_event(dev, e, seq, &now);
1339
		vblwait->reply.sequence = seq;
1340
	} else {
1341
		/* drm_handle_vblank_events will call drm_vblank_put */
1342
		list_add_tail(&e->base.link, &dev->vblank_event_list);
1343
		vblwait->reply.sequence = vblwait->request.sequence;
1344 1345 1346 1347 1348
	}

	spin_unlock_irqrestore(&dev->event_lock, flags);

	return 0;
1349 1350 1351 1352 1353

err_unlock:
	spin_unlock_irqrestore(&dev->event_lock, flags);
	kfree(e);
err_put:
1354
	drm_vblank_put(dev, pipe);
1355
	return ret;
1356 1357
}

D
Daniel Vetter 已提交
1358
/*
L
Linus Torvalds 已提交
1359 1360 1361
 * Wait for VBLANK.
 *
 * \param inode device inode.
1362
 * \param file_priv DRM file private.
L
Linus Torvalds 已提交
1363 1364 1365 1366
 * \param cmd command.
 * \param data user argument, pointing to a drm_wait_vblank structure.
 * \return zero on success or a negative number on failure.
 *
1367 1368
 * 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 已提交
1369
 * the vblank interrupt refcount afterwards. (vblank IRQ disable follows that
1370
 * after a timeout with no further vblank waits scheduled).
L
Linus Torvalds 已提交
1371
 */
1372 1373
int drm_wait_vblank(struct drm_device *dev, void *data,
		    struct drm_file *file_priv)
L
Linus Torvalds 已提交
1374
{
1375
	struct drm_vblank_crtc *vblank;
1376
	union drm_wait_vblank *vblwait = data;
1377
	int ret;
1378
	unsigned int flags, seq, crtc, high_crtc;
L
Linus Torvalds 已提交
1379

1380 1381
	if (!dev->irq_enabled)
		return -EINVAL;
L
Linus Torvalds 已提交
1382

1383 1384 1385
	if (vblwait->request.type & _DRM_VBLANK_SIGNAL)
		return -EINVAL;

1386
	if (vblwait->request.type &
1387 1388
	    ~(_DRM_VBLANK_TYPES_MASK | _DRM_VBLANK_FLAGS_MASK |
	      _DRM_VBLANK_HIGH_CRTC_MASK)) {
1389
		DRM_ERROR("Unsupported type value 0x%x, supported mask 0x%x\n",
1390
			  vblwait->request.type,
1391 1392
			  (_DRM_VBLANK_TYPES_MASK | _DRM_VBLANK_FLAGS_MASK |
			   _DRM_VBLANK_HIGH_CRTC_MASK));
1393 1394 1395
		return -EINVAL;
	}

1396
	flags = vblwait->request.type & _DRM_VBLANK_FLAGS_MASK;
1397 1398 1399 1400 1401
	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;
1402
	if (crtc >= dev->num_crtcs)
1403 1404
		return -EINVAL;

1405 1406
	vblank = &dev->vblank[crtc];

1407 1408
	ret = drm_vblank_get(dev, crtc);
	if (ret) {
1409
		DRM_DEBUG("failed to acquire vblank counter, %d\n", ret);
1410 1411 1412
		return ret;
	}
	seq = drm_vblank_count(dev, crtc);
1413

1414
	switch (vblwait->request.type & _DRM_VBLANK_TYPES_MASK) {
L
Linus Torvalds 已提交
1415
	case _DRM_VBLANK_RELATIVE:
1416 1417
		vblwait->request.sequence += seq;
		vblwait->request.type &= ~_DRM_VBLANK_RELATIVE;
L
Linus Torvalds 已提交
1418 1419 1420
	case _DRM_VBLANK_ABSOLUTE:
		break;
	default:
1421 1422
		ret = -EINVAL;
		goto done;
L
Linus Torvalds 已提交
1423 1424
	}

1425 1426 1427 1428
	if (flags & _DRM_VBLANK_EVENT) {
		/* must hold on to the vblank ref until the event fires
		 * drm_vblank_put will be called asynchronously
		 */
1429
		return drm_queue_vblank_event(dev, crtc, vblwait, file_priv);
1430
	}
1431

1432
	if ((flags & _DRM_VBLANK_NEXTONMISS) &&
1433 1434
	    (seq - vblwait->request.sequence) <= (1<<23)) {
		vblwait->request.sequence = seq + 1;
1435 1436
	}

1437 1438
	DRM_DEBUG("waiting on vblank count %d, crtc %d\n",
		  vblwait->request.sequence, crtc);
1439 1440
	vblank->last_wait = vblwait->request.sequence;
	DRM_WAIT_ON(ret, vblank->queue, 3 * HZ,
1441 1442
		    (((drm_vblank_count(dev, crtc) -
		       vblwait->request.sequence) <= (1 << 23)) ||
1443
		     !vblank->enabled ||
1444
		     !dev->irq_enabled));
L
Linus Torvalds 已提交
1445

1446 1447
	if (ret != -EINTR) {
		struct timeval now;
L
Linus Torvalds 已提交
1448

1449
		vblwait->reply.sequence = drm_vblank_count_and_time(dev, crtc, &now);
1450 1451
		vblwait->reply.tval_sec = now.tv_sec;
		vblwait->reply.tval_usec = now.tv_usec;
1452

1453 1454
		DRM_DEBUG("returning %d to client\n",
			  vblwait->reply.sequence);
L
Linus Torvalds 已提交
1455
	} else {
1456
		DRM_DEBUG("vblank wait interrupted by signal\n");
L
Linus Torvalds 已提交
1457 1458
	}

1459 1460
done:
	drm_vblank_put(dev, crtc);
L
Linus Torvalds 已提交
1461 1462 1463
	return ret;
}

1464
static void drm_handle_vblank_events(struct drm_device *dev, int crtc)
1465 1466 1467 1468 1469
{
	struct drm_pending_vblank_event *e, *t;
	struct timeval now;
	unsigned int seq;

1470
	assert_spin_locked(&dev->event_lock);
1471

1472
	seq = drm_vblank_count_and_time(dev, crtc, &now);
1473 1474 1475 1476 1477 1478 1479 1480 1481 1482

	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);

1483
		list_del(&e->base.link);
1484
		drm_vblank_put(dev, e->pipe);
1485
		send_vblank_event(dev, e, seq, &now);
1486 1487
	}

J
Jesse Barnes 已提交
1488
	trace_drm_vblank_event(crtc, seq);
1489 1490
}

1491 1492 1493 1494 1495 1496 1497 1498
/**
 * 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.
 */
1499
bool drm_handle_vblank(struct drm_device *dev, int crtc)
1500
{
1501
	struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
1502 1503 1504 1505 1506
	u32 vblcount;
	s64 diff_ns;
	struct timeval tvblank;
	unsigned long irqflags;

1507
	if (!dev->num_crtcs)
1508
		return false;
1509

1510 1511
	spin_lock_irqsave(&dev->event_lock, irqflags);

1512 1513 1514 1515
	/* Need timestamp lock to prevent concurrent execution with
	 * vblank enable/disable, as this would cause inconsistent
	 * or corrupted timestamps and vblank counts.
	 */
1516
	spin_lock(&dev->vblank_time_lock);
1517 1518

	/* Vblank irq handling disabled. Nothing to do. */
1519
	if (!vblank->enabled) {
1520 1521
		spin_unlock(&dev->vblank_time_lock);
		spin_unlock_irqrestore(&dev->event_lock, irqflags);
1522
		return false;
1523 1524 1525 1526 1527 1528 1529
	}

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

	/* Get current timestamp and count. */
1530
	vblcount = atomic_read(&vblank->count);
1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545
	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.
	 */
1546
	if (abs64(diff_ns) > DRM_REDUNDANT_VBLIRQ_THRESH_NS) {
1547 1548 1549 1550 1551 1552
		/* Store new timestamp in ringbuffer. */
		vblanktimestamp(dev, crtc, vblcount + 1) = tvblank;

		/* Increment cooked vblank count. This also atomically commits
		 * the timestamp computed above.
		 */
1553
		smp_mb__before_atomic();
1554
		atomic_inc(&vblank->count);
1555
		smp_mb__after_atomic();
1556 1557 1558 1559 1560
	} else {
		DRM_DEBUG("crtc %d: Redundant vblirq ignored. diff_ns = %d\n",
			  crtc, (int) diff_ns);
	}

1561 1562
	spin_unlock(&dev->vblank_time_lock);

1563
	wake_up(&vblank->queue);
1564
	drm_handle_vblank_events(dev, crtc);
1565

1566 1567
	spin_unlock_irqrestore(&dev->event_lock, irqflags);

1568
	return true;
1569 1570
}
EXPORT_SYMBOL(drm_handle_vblank);