[Intel-gfx] [PATCH] drm/i915: Fix documentation for intel_dpll_get_freq()

[Imre Deak]

On Thu, Mar 05, 2020 at 01:44:20AM +0200, Souza, Jose wrote:
> On Wed, 2020-03-04 at 17:09 +0200, Imre Deak wrote:
> > Fix the following kerneldoc warning and while at it also the doc for
> > the
> > corresponding vfunc hook.
> > 
> > $ make htmldocs 2>&1 > /dev/null | grep i915
> > ./drivers/gpu/drm/i915/display/intel_dpll_mgr.h:285: warning:
> > Function parameter or member 'get_freq' not described in
> > 'intel_shared_dpll_funcs'
> 
> Reviewed-by: José Roberto de Souza <jose.souza at intel.com>

Thanks for the review, pushed to -dinq.

> 
> > 
> > Signed-off-by: Imre Deak <imre.deak at intel.com>
> > ---
> >  drivers/gpu/drm/i915/display/intel_dpll_mgr.c | 7 +++++++
> >  drivers/gpu/drm/i915/display/intel_dpll_mgr.h | 6 ++++++
> >  2 files changed, 13 insertions(+)
> > 
> > diff --git a/drivers/gpu/drm/i915/display/intel_dpll_mgr.c
> > b/drivers/gpu/drm/i915/display/intel_dpll_mgr.c
> > index 76d14486b3a5..2d47f1f756a2 100644
> > --- a/drivers/gpu/drm/i915/display/intel_dpll_mgr.c
> > +++ b/drivers/gpu/drm/i915/display/intel_dpll_mgr.c
> > @@ -4408,6 +4408,13 @@ void intel_update_active_dpll(struct
> > intel_atomic_state *state,
> >  	dpll_mgr->update_active_dpll(state, crtc, encoder);
> >  }
> >  
> > +/**
> > + * intel_dpll_get_freq - calculate the DPLL's output frequency
> > + * @i915: i915 device
> > + * @pll: DPLL for which to calculate the output frequency
> > + *
> > + * Return the output frequency corresponding to @pll's current
> > state.
> > + */
> >  int intel_dpll_get_freq(struct drm_i915_private *i915,
> >  			const struct intel_shared_dpll *pll)
> >  {
> > diff --git a/drivers/gpu/drm/i915/display/intel_dpll_mgr.h
> > b/drivers/gpu/drm/i915/display/intel_dpll_mgr.h
> > index 5c847627580a..5d9a2bc371e7 100644
> > --- a/drivers/gpu/drm/i915/display/intel_dpll_mgr.h
> > +++ b/drivers/gpu/drm/i915/display/intel_dpll_mgr.h
> > @@ -279,6 +279,12 @@ struct intel_shared_dpll_funcs {
> >  			     struct intel_shared_dpll *pll,
> >  			     struct intel_dpll_hw_state *hw_state);
> >  
> > +	/**
> > +	 * @get_freq:
> > +	 *
> > +	 * Hook for calculating the pll's output frequency based on its
> > +	 * current state.
> > +	 */
> >  	int (*get_freq)(struct drm_i915_private *i915,
> >  			const struct intel_shared_dpll *pll);
> >  };