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