Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 21b21560 authored by Ville Syrjälä's avatar Ville Syrjälä
Browse files

drm: Improve drm_calc_timestamping_constants() documentation



Move the long blurp to into the body of the comment, leaving only
a short summary line at the top.

Reviewed-by: default avatar <mario.kleiner.de@gmail.com>
Signed-off-by: default avatarVille Syrjälä <ville.syrjala@linux.intel.com>
parent c326c0a9
Loading
Loading
Loading
Loading
+6 −7
Original line number Diff line number Diff line
@@ -436,17 +436,16 @@ int drm_control(struct drm_device *dev, void *data,
}

/**
 * drm_calc_timestamping_constants - 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 derived from crtc's true scanout timing,
 * so they take things like panel scaling or other
 * adjustments into account.
 * drm_calc_timestamping_constants - Calculate vblank timestamp constants
 *
 * @crtc drm_crtc whose timestamp constants should be updated.
 * @mode display mode containing the scanout timings
 *
 * 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
 * derived from crtc's true scanout timing, so they take
 * things like panel scaling or other adjustments into account.
 */
void drm_calc_timestamping_constants(struct drm_crtc *crtc,
				     const struct drm_display_mode *mode)