1 // SPDX-License-Identifier: MIT
3 * Copyright © 2022-2023 Intel Corporation
6 #include <drm/drm_vblank.h>
10 #include "intel_color.h"
11 #include "intel_crtc.h"
13 #include "intel_display_types.h"
14 #include "intel_vblank.h"
15 #include "intel_vrr.h"
18 * This timing diagram depicts the video signal in and
19 * around the vertical blanking period.
21 * Assumptions about the fictitious mode used in this example:
23 * vsync_start = vblank_start + 1
24 * vsync_end = vblank_start + 2
25 * vtotal = vblank_start + 3
28 * latch double buffered registers
29 * increment frame counter (ctg+)
30 * generate start of vblank interrupt (gen4+)
33 * | generate frame start interrupt (aka. vblank interrupt) (gmch)
34 * | may be shifted forward 1-3 extra lines via TRANSCONF
37 * | | generate vsync interrupt
39 * ___xxxx___ ___xxxx___ ___xxxx___ ___xxxx___ ___xxxx___ ___xxxx
40 * . \hs/ . \hs/ \hs/ \hs/ . \hs/
41 * ----va---> <-----------------vb--------------------> <--------va-------------
43 * -vbs-----> <---vbs+1---> <---vbs+2---> <-----0-----> <-----1-----> <-----2--- (scanline counter gen2)
44 * -vbs-2---> <---vbs-1---> <---vbs-----> <---vbs+1---> <---vbs+2---> <-----0--- (scanline counter gen3+)
45 * -vbs-2---> <---vbs-2---> <---vbs-1---> <---vbs-----> <---vbs+1---> <---vbs+2- (scanline counter hsw+ hdmi)
47 * last visible pixel first visible pixel
48 * | increment frame counter (gen3/4)
49 * pixel counter = vblank_start * htotal pixel counter = 0 (gen3/4)
51 * x = horizontal active
52 * _ = horizontal blanking
53 * hs = horizontal sync
54 * va = vertical active
55 * vb = vertical blanking
57 * vbs = vblank_start (number)
60 * - most events happen at the start of horizontal sync
61 * - frame start happens at the start of horizontal blank, 1-4 lines
62 * (depending on TRANSCONF settings) after the start of vblank
63 * - gen3/4 pixel and frame counter are synchronized with the start
64 * of horizontal active on the first line of vertical active
68 * Called from drm generic code, passed a 'crtc', which we use as a pipe index.
70 u32 i915_get_vblank_counter(struct drm_crtc *crtc)
72 struct intel_display *display = to_intel_display(crtc->dev);
73 struct drm_vblank_crtc *vblank = drm_crtc_vblank_crtc(crtc);
74 const struct drm_display_mode *mode = &vblank->hwmode;
75 enum pipe pipe = to_intel_crtc(crtc)->pipe;
76 u32 pixel, vbl_start, hsync_start, htotal;
80 * On i965gm TV output the frame counter only works up to
81 * the point when we enable the TV encoder. After that the
82 * frame counter ceases to work and reads zero. We need a
83 * vblank wait before enabling the TV encoder and so we
84 * have to enable vblank interrupts while the frame counter
85 * is still in a working state. However the core vblank code
86 * does not like us returning non-zero frame counter values
87 * when we've told it that we don't have a working frame
88 * counter. Thus we must stop non-zero values leaking out.
90 if (!vblank->max_vblank_count)
93 htotal = mode->crtc_htotal;
94 hsync_start = mode->crtc_hsync_start;
95 vbl_start = intel_mode_vblank_start(mode);
97 /* Convert to pixel count */
100 /* Start of vblank event occurs at start of hsync */
101 vbl_start -= htotal - hsync_start;
104 * High & low register fields aren't synchronized, so make sure
105 * we get a low value that's stable across two reads of the high
108 frame = intel_de_read64_2x32(display, PIPEFRAMEPIXEL(display, pipe),
109 PIPEFRAME(display, pipe));
111 pixel = frame & PIPE_PIXEL_MASK;
112 frame = (frame >> PIPE_FRAME_LOW_SHIFT) & 0xffffff;
115 * The frame counter increments at beginning of active.
116 * Cook up a vblank counter by also checking the pixel
117 * counter against vblank start.
119 return (frame + (pixel >= vbl_start)) & 0xffffff;
122 u32 g4x_get_vblank_counter(struct drm_crtc *crtc)
124 struct intel_display *display = to_intel_display(crtc->dev);
125 struct drm_vblank_crtc *vblank = drm_crtc_vblank_crtc(crtc);
126 enum pipe pipe = to_intel_crtc(crtc)->pipe;
128 if (!vblank->max_vblank_count)
131 return intel_de_read(display, PIPE_FRMCOUNT_G4X(display, pipe));
134 static u32 intel_crtc_scanlines_since_frame_timestamp(struct intel_crtc *crtc)
136 struct intel_display *display = to_intel_display(crtc);
137 struct drm_vblank_crtc *vblank = drm_crtc_vblank_crtc(&crtc->base);
138 const struct drm_display_mode *mode = &vblank->hwmode;
139 u32 htotal = mode->crtc_htotal;
140 u32 clock = mode->crtc_clock;
141 u32 scan_prev_time, scan_curr_time, scan_post_time;
144 * To avoid the race condition where we might cross into the
145 * next vblank just between the PIPE_FRMTMSTMP and TIMESTAMP_CTR
146 * reads. We make sure we read PIPE_FRMTMSTMP and TIMESTAMP_CTR
147 * during the same frame.
151 * This field provides read back of the display
152 * pipe frame time stamp. The time stamp value
153 * is sampled at every start of vertical blank.
155 scan_prev_time = intel_de_read_fw(display,
156 PIPE_FRMTMSTMP(crtc->pipe));
159 * The TIMESTAMP_CTR register has the current
162 scan_curr_time = intel_de_read_fw(display, IVB_TIMESTAMP_CTR);
164 scan_post_time = intel_de_read_fw(display,
165 PIPE_FRMTMSTMP(crtc->pipe));
166 } while (scan_post_time != scan_prev_time);
168 return div_u64(mul_u32_u32(scan_curr_time - scan_prev_time,
169 clock), 1000 * htotal);
173 * On certain encoders on certain platforms, pipe
174 * scanline register will not work to get the scanline,
175 * since the timings are driven from the PORT or issues
176 * with scanline register updates.
177 * This function will use Framestamp and current
178 * timestamp registers to calculate the scanline.
180 static u32 __intel_get_crtc_scanline_from_timestamp(struct intel_crtc *crtc)
182 struct drm_vblank_crtc *vblank = drm_crtc_vblank_crtc(&crtc->base);
183 const struct drm_display_mode *mode = &vblank->hwmode;
184 u32 vblank_start = mode->crtc_vblank_start;
185 u32 vtotal = mode->crtc_vtotal;
188 scanline = intel_crtc_scanlines_since_frame_timestamp(crtc);
189 scanline = min(scanline, vtotal - 1);
190 scanline = (scanline + vblank_start) % vtotal;
195 int intel_crtc_scanline_offset(const struct intel_crtc_state *crtc_state)
197 struct intel_display *display = to_intel_display(crtc_state);
200 * The scanline counter increments at the leading edge of hsync.
202 * On most platforms it starts counting from vtotal-1 on the
203 * first active line. That means the scanline counter value is
204 * always one less than what we would expect. Ie. just after
205 * start of vblank, which also occurs at start of hsync (on the
206 * last active line), the scanline counter will read vblank_start-1.
208 * On gen2 the scanline counter starts counting from 1 instead
209 * of vtotal-1, so we have to subtract one.
211 * On HSW+ the behaviour of the scanline counter depends on the output
212 * type. For DP ports it behaves like most other platforms, but on HDMI
213 * there's an extra 1 line difference. So we need to add two instead of
216 * On VLV/CHV DSI the scanline counter would appear to increment
217 * approx. 1/3 of a scanline before start of vblank. Unfortunately
218 * that means we can't tell whether we're in vblank or not while
219 * we're on that particular line. We must still set scanline_offset
220 * to 1 so that the vblank timestamps come out correct when we query
221 * the scanline counter from within the vblank interrupt handler.
222 * However if queried just before the start of vblank we'll get an
223 * answer that's slightly in the future.
225 if (DISPLAY_VER(display) == 2)
227 else if (HAS_DDI(display) && intel_crtc_has_type(crtc_state, INTEL_OUTPUT_HDMI))
234 * intel_de_read_fw(), only for fast reads of display block, no need for
237 static int __intel_get_crtc_scanline(struct intel_crtc *crtc)
239 struct intel_display *display = to_intel_display(crtc);
240 struct drm_vblank_crtc *vblank = drm_crtc_vblank_crtc(&crtc->base);
241 const struct drm_display_mode *mode = &vblank->hwmode;
242 enum pipe pipe = crtc->pipe;
243 int position, vtotal;
248 if (crtc->mode_flags & I915_MODE_FLAG_GET_SCANLINE_FROM_TIMESTAMP)
249 return __intel_get_crtc_scanline_from_timestamp(crtc);
251 vtotal = intel_mode_vtotal(mode);
253 position = intel_de_read_fw(display, PIPEDSL(display, pipe)) & PIPEDSL_LINE_MASK;
256 * On HSW, the DSL reg (0x70000) appears to return 0 if we
257 * read it just before the start of vblank. So try it again
258 * so we don't accidentally end up spanning a vblank frame
259 * increment, causing the pipe_update_end() code to squak at us.
261 * The nature of this problem means we can't simply check the ISR
262 * bit and return the vblank start value; nor can we use the scanline
263 * debug register in the transcoder as it appears to have the same
264 * problem. We may need to extend this to include other platforms,
265 * but so far testing only shows the problem on HSW.
267 if (HAS_DDI(display) && !position) {
270 for (i = 0; i < 100; i++) {
272 temp = intel_de_read_fw(display,
273 PIPEDSL(display, pipe)) & PIPEDSL_LINE_MASK;
274 if (temp != position) {
282 * See update_scanline_offset() for the details on the
283 * scanline_offset adjustment.
285 return (position + vtotal + crtc->scanline_offset) % vtotal;
289 * The uncore version of the spin lock functions is used to decide
290 * whether we need to lock the uncore lock or not. This is only
291 * needed in i915, not in Xe.
293 * This lock in i915 is needed because some old platforms (at least
294 * IVB and possibly HSW as well), which are not supported in Xe, need
295 * all register accesses to the same cacheline to be serialized,
296 * otherwise they may hang.
299 static void intel_vblank_section_enter(struct intel_display *display)
300 __acquires(i915->uncore.lock)
302 struct drm_i915_private *i915 = to_i915(display->drm);
303 spin_lock(&i915->uncore.lock);
306 static void intel_vblank_section_exit(struct intel_display *display)
307 __releases(i915->uncore.lock)
309 struct drm_i915_private *i915 = to_i915(display->drm);
310 spin_unlock(&i915->uncore.lock);
313 static void intel_vblank_section_enter(struct intel_display *display)
317 static void intel_vblank_section_exit(struct intel_display *display)
322 static bool i915_get_crtc_scanoutpos(struct drm_crtc *_crtc,
324 int *vpos, int *hpos,
325 ktime_t *stime, ktime_t *etime,
326 const struct drm_display_mode *mode)
328 struct intel_display *display = to_intel_display(_crtc->dev);
329 struct intel_crtc *crtc = to_intel_crtc(_crtc);
330 enum pipe pipe = crtc->pipe;
332 int vbl_start, vbl_end, hsync_start, htotal, vtotal;
333 unsigned long irqflags;
334 bool use_scanline_counter = DISPLAY_VER(display) >= 5 ||
335 display->platform.g4x || DISPLAY_VER(display) == 2 ||
336 crtc->mode_flags & I915_MODE_FLAG_USE_SCANLINE_COUNTER;
338 if (drm_WARN_ON(display->drm, !mode->crtc_clock)) {
339 drm_dbg(display->drm,
340 "trying to get scanoutpos for disabled pipe %c\n",
345 htotal = mode->crtc_htotal;
346 hsync_start = mode->crtc_hsync_start;
347 vtotal = intel_mode_vtotal(mode);
348 vbl_start = intel_mode_vblank_start(mode);
349 vbl_end = intel_mode_vblank_end(mode);
352 * Enter vblank critical section, as we will do multiple
353 * timing critical raw register reads, potentially with
354 * preemption disabled, so the following code must not block.
356 local_irq_save(irqflags);
357 intel_vblank_section_enter(display);
359 /* preempt_disable_rt() should go right here in PREEMPT_RT patchset. */
361 /* Get optional system timestamp before query. */
363 *stime = ktime_get();
365 if (crtc->mode_flags & I915_MODE_FLAG_VRR) {
366 int scanlines = intel_crtc_scanlines_since_frame_timestamp(crtc);
368 position = __intel_get_crtc_scanline(crtc);
371 * Already exiting vblank? If so, shift our position
372 * so it looks like we're already apporaching the full
373 * vblank end. This should make the generated timestamp
374 * more or less match when the active portion will start.
376 if (position >= vbl_start && scanlines < position)
377 position = min(crtc->vmax_vblank_start + scanlines, vtotal - 1);
378 } else if (use_scanline_counter) {
379 /* No obvious pixelcount register. Only query vertical
380 * scanout position from Display scan line register.
382 position = __intel_get_crtc_scanline(crtc);
385 * Have access to pixelcount since start of frame.
386 * We can split this into vertical and horizontal
389 position = (intel_de_read_fw(display, PIPEFRAMEPIXEL(display, pipe)) & PIPE_PIXEL_MASK) >> PIPE_PIXEL_SHIFT;
391 /* convert to pixel counts */
397 * In interlaced modes, the pixel counter counts all pixels,
398 * so one field will have htotal more pixels. In order to avoid
399 * the reported position from jumping backwards when the pixel
400 * counter is beyond the length of the shorter field, just
401 * clamp the position the length of the shorter field. This
402 * matches how the scanline counter based position works since
403 * the scanline counter doesn't count the two half lines.
405 position = min(position, vtotal - 1);
408 * Start of vblank interrupt is triggered at start of hsync,
409 * just prior to the first active line of vblank. However we
410 * consider lines to start at the leading edge of horizontal
411 * active. So, should we get here before we've crossed into
412 * the horizontal active of the first line in vblank, we would
413 * not set the DRM_SCANOUTPOS_INVBL flag. In order to fix that,
414 * always add htotal-hsync_start to the current pixel position.
416 position = (position + htotal - hsync_start) % vtotal;
419 /* Get optional system timestamp after query. */
421 *etime = ktime_get();
423 /* preempt_enable_rt() should go right here in PREEMPT_RT patchset. */
425 intel_vblank_section_exit(display);
426 local_irq_restore(irqflags);
429 * While in vblank, position will be negative
430 * counting up towards 0 at vbl_end. And outside
431 * vblank, position will be positive counting
434 if (position >= vbl_start)
437 position += vtotal - vbl_end;
439 if (use_scanline_counter) {
443 *vpos = position / htotal;
444 *hpos = position - (*vpos * htotal);
450 bool intel_crtc_get_vblank_timestamp(struct drm_crtc *crtc, int *max_error,
451 ktime_t *vblank_time, bool in_vblank_irq)
453 return drm_crtc_vblank_helper_get_vblank_timestamp_internal(
454 crtc, max_error, vblank_time, in_vblank_irq,
455 i915_get_crtc_scanoutpos);
458 int intel_get_crtc_scanline(struct intel_crtc *crtc)
460 struct intel_display *display = to_intel_display(crtc);
461 unsigned long irqflags;
464 local_irq_save(irqflags);
465 intel_vblank_section_enter(display);
467 position = __intel_get_crtc_scanline(crtc);
469 intel_vblank_section_exit(display);
470 local_irq_restore(irqflags);
475 static bool pipe_scanline_is_moving(struct intel_display *display,
478 i915_reg_t reg = PIPEDSL(display, pipe);
481 line1 = intel_de_read(display, reg) & PIPEDSL_LINE_MASK;
483 line2 = intel_de_read(display, reg) & PIPEDSL_LINE_MASK;
485 return line1 != line2;
488 static void wait_for_pipe_scanline_moving(struct intel_crtc *crtc, bool state)
490 struct intel_display *display = to_intel_display(crtc);
491 enum pipe pipe = crtc->pipe;
493 /* Wait for the display line to settle/start moving */
494 if (wait_for(pipe_scanline_is_moving(display, pipe) == state, 100))
495 drm_err(display->drm,
496 "pipe %c scanline %s wait timed out\n",
497 pipe_name(pipe), str_on_off(state));
500 void intel_wait_for_pipe_scanline_stopped(struct intel_crtc *crtc)
502 wait_for_pipe_scanline_moving(crtc, false);
505 void intel_wait_for_pipe_scanline_moving(struct intel_crtc *crtc)
507 wait_for_pipe_scanline_moving(crtc, true);
510 void intel_crtc_update_active_timings(const struct intel_crtc_state *crtc_state,
513 struct intel_display *display = to_intel_display(crtc_state);
514 struct intel_crtc *crtc = to_intel_crtc(crtc_state->uapi.crtc);
515 u8 mode_flags = crtc_state->mode_flags;
516 struct drm_display_mode adjusted_mode;
517 int vmax_vblank_start = 0;
518 unsigned long irqflags;
520 drm_mode_init(&adjusted_mode, &crtc_state->hw.adjusted_mode);
523 drm_WARN_ON(display->drm,
524 (mode_flags & I915_MODE_FLAG_VRR) == 0);
526 adjusted_mode.crtc_vtotal = crtc_state->vrr.vmax;
527 adjusted_mode.crtc_vblank_end = crtc_state->vrr.vmax;
528 adjusted_mode.crtc_vblank_start = intel_vrr_vmin_vblank_start(crtc_state);
529 vmax_vblank_start = intel_vrr_vmax_vblank_start(crtc_state);
531 mode_flags &= ~I915_MODE_FLAG_VRR;
535 * Belts and suspenders locking to guarantee everyone sees 100%
536 * consistent state during fastset seamless refresh rate changes.
538 * vblank_time_lock takes care of all drm_vblank.c stuff, and
539 * uncore.lock takes care of __intel_get_crtc_scanline() which
540 * may get called elsewhere as well.
542 * TODO maybe just protect everything (including
543 * __intel_get_crtc_scanline()) with vblank_time_lock?
544 * Need to audit everything to make sure it's safe.
546 spin_lock_irqsave(&display->drm->vblank_time_lock, irqflags);
547 intel_vblank_section_enter(display);
549 drm_calc_timestamping_constants(&crtc->base, &adjusted_mode);
551 crtc->vmax_vblank_start = vmax_vblank_start;
553 crtc->mode_flags = mode_flags;
555 crtc->scanline_offset = intel_crtc_scanline_offset(crtc_state);
556 intel_vblank_section_exit(display);
557 spin_unlock_irqrestore(&display->drm->vblank_time_lock, irqflags);
560 int intel_mode_vdisplay(const struct drm_display_mode *mode)
562 int vdisplay = mode->crtc_vdisplay;
564 if (mode->flags & DRM_MODE_FLAG_INTERLACE)
565 vdisplay = DIV_ROUND_UP(vdisplay, 2);
570 int intel_mode_vblank_start(const struct drm_display_mode *mode)
572 int vblank_start = mode->crtc_vblank_start;
574 if (mode->flags & DRM_MODE_FLAG_INTERLACE)
575 vblank_start = DIV_ROUND_UP(vblank_start, 2);
580 int intel_mode_vblank_end(const struct drm_display_mode *mode)
582 int vblank_end = mode->crtc_vblank_end;
584 if (mode->flags & DRM_MODE_FLAG_INTERLACE)
590 int intel_mode_vtotal(const struct drm_display_mode *mode)
592 int vtotal = mode->crtc_vtotal;
594 if (mode->flags & DRM_MODE_FLAG_INTERLACE)
600 void intel_vblank_evade_init(const struct intel_crtc_state *old_crtc_state,
601 const struct intel_crtc_state *new_crtc_state,
602 struct intel_vblank_evade_ctx *evade)
604 struct intel_display *display = to_intel_display(new_crtc_state);
605 struct intel_crtc *crtc = to_intel_crtc(new_crtc_state->uapi.crtc);
606 const struct intel_crtc_state *crtc_state;
607 const struct drm_display_mode *adjusted_mode;
611 evade->need_vlv_dsi_wa = (display->platform.valleyview ||
612 display->platform.cherryview) &&
613 intel_crtc_has_type(new_crtc_state, INTEL_OUTPUT_DSI);
616 * During fastsets/etc. the transcoder is still
617 * running with the old timings at this point.
619 * TODO: maybe just use the active timings here?
621 if (intel_crtc_needs_modeset(new_crtc_state))
622 crtc_state = new_crtc_state;
624 crtc_state = old_crtc_state;
626 adjusted_mode = &crtc_state->hw.adjusted_mode;
628 if (crtc->mode_flags & I915_MODE_FLAG_VRR) {
629 /* timing changes should happen with VRR disabled */
630 drm_WARN_ON(crtc->base.dev, intel_crtc_needs_modeset(new_crtc_state) ||
631 new_crtc_state->update_m_n || new_crtc_state->update_lrr);
633 if (intel_vrr_is_push_sent(crtc_state))
634 evade->vblank_start = intel_vrr_vmin_vblank_start(crtc_state);
636 evade->vblank_start = intel_vrr_vmax_vblank_start(crtc_state);
638 evade->vblank_start = intel_mode_vblank_start(adjusted_mode);
641 /* FIXME needs to be calibrated sensibly */
642 evade->min = evade->vblank_start - intel_usecs_to_scanlines(adjusted_mode,
643 VBLANK_EVASION_TIME_US);
644 evade->max = evade->vblank_start - 1;
647 * M/N and TRANS_VTOTAL are double buffered on the transcoder's
648 * undelayed vblank, so with seamless M/N and LRR we must evade
651 * DSB execution waits for the transcoder's undelayed vblank,
652 * hence we must kick off the commit before that.
654 if (intel_color_uses_dsb(new_crtc_state) ||
655 new_crtc_state->update_m_n || new_crtc_state->update_lrr)
656 evade->min -= intel_mode_vblank_start(adjusted_mode) -
657 intel_mode_vdisplay(adjusted_mode);
660 /* must be called with vblank interrupt already enabled! */
661 int intel_vblank_evade(struct intel_vblank_evade_ctx *evade)
663 struct intel_crtc *crtc = evade->crtc;
664 struct intel_display *display = to_intel_display(crtc);
665 long timeout = msecs_to_jiffies_timeout(1);
666 wait_queue_head_t *wq = drm_crtc_vblank_waitqueue(&crtc->base);
670 if (evade->min <= 0 || evade->max <= 0)
675 * prepare_to_wait() has a memory barrier, which guarantees
676 * other CPUs can see the task state update by the time we
679 prepare_to_wait(wq, &wait, TASK_UNINTERRUPTIBLE);
681 scanline = intel_get_crtc_scanline(crtc);
682 if (scanline < evade->min || scanline > evade->max)
686 drm_err(display->drm,
687 "Potential atomic update failure on pipe %c\n",
688 pipe_name(crtc->pipe));
694 timeout = schedule_timeout(timeout);
699 finish_wait(wq, &wait);
702 * On VLV/CHV DSI the scanline counter would appear to
703 * increment approx. 1/3 of a scanline before start of vblank.
704 * The registers still get latched at start of vblank however.
705 * This means we must not write any registers on the first
706 * line of vblank (since not the whole line is actually in
707 * vblank). And unfortunately we can't use the interrupt to
708 * wait here since it will fire too soon. We could use the
709 * frame start interrupt instead since it will fire after the
710 * critical scanline, but that would require more changes
711 * in the interrupt code. So for now we'll just do the nasty
712 * thing and poll for the bad scanline to pass us by.
714 * FIXME figure out if BXT+ DSI suffers from this as well
716 while (evade->need_vlv_dsi_wa && scanline == evade->vblank_start)
717 scanline = intel_get_crtc_scanline(crtc);