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

Commit f4808ab8 authored by Ville Syrjälä's avatar Ville Syrjälä Committed by Daniel Vetter
Browse files

drm/i915: Document the find_pll() function 



The proper use of find_pll() isn't always so easy to determine from the
code itself. Some documentation should help.

Signed-off-by: default avatarVille Syrjälä <ville.syrjala@linux.intel.com>
Reviewed-by: default avatarChris Wilson <chris@chris-wilson.co.uk>
Signed-off-by: default avatarDaniel Vetter <daniel.vetter@ffwll.ch>
parent 2bb4629a

drivers/gpu/drm/i915/intel_display.c

+18 −2
Original line number Diff line number Diff line
@@ -71,8 +71,24 @@ typedef struct intel_limit intel_limit_t; 
struct intel_limit {

	intel_range_t   dot, vco, n, m, m1, m2, p, p1;

	intel_p2_t	    p2;

	bool (* find_pll)(const intel_limit_t *, struct drm_crtc *,

			int, int, intel_clock_t *, intel_clock_t *);

	/**

	 * find_pll() - Find the best values for the PLL

	 * @limit: limits for the PLL

	 * @crtc: current CRTC

	 * @target: target frequency in kHz

	 * @refclk: reference clock frequency in kHz

	 * @match_clock: if provided, @best_clock P divider must

	 *               match the P divider from @match_clock

	 *               used for LVDS downclocking

	 * @best_clock: best PLL values found

	 *

	 * Returns true on success, false on failure.

	 */

	bool (*find_pll)(const intel_limit_t *limit,

			 struct drm_crtc *crtc,

			 int target, int refclk,

			 intel_clock_t *match_clock,

			 intel_clock_t *best_clock);

};



/* FDI */