[Intel-gfx] [PATCH 24/28] drm: Document drm_connector_helper_funcs

[Daniel Vetter]

On Mon, Dec 07, 2015 at 03:42:22PM +0100, Thierry Reding wrote:
> On Fri, Dec 04, 2015 at 09:46:05AM +0100, Daniel Vetter wrote:
> > Nothing special, except the somewhat awkard split in probe helper
> 
> "awkward"
> 
> > callbacks between here and drm_crtc_funcs.
> > 
> > Signed-off-by: Daniel Vetter <daniel.vetter at ffwll.ch>
> > ---
> >  include/drm/drm_modeset_helper_vtables.h | 106 +++++++++++++++++++++++++++++--
> >  1 file changed, 101 insertions(+), 5 deletions(-)
> > 
> > diff --git a/include/drm/drm_modeset_helper_vtables.h b/include/drm/drm_modeset_helper_vtables.h
> > index 66b78c14154e..22cc51b278fb 100644
> > --- a/include/drm/drm_modeset_helper_vtables.h
> > +++ b/include/drm/drm_modeset_helper_vtables.h
> > @@ -264,18 +264,114 @@ static inline void drm_encoder_helper_add(struct drm_encoder *encoder,
> >  
> >  /**
> >   * struct drm_connector_helper_funcs - helper operations for connectors
> > - * @get_modes: get mode list for this connector
> > - * @mode_valid: is this mode valid on the given connector? (optional)
> > - * @best_encoder: return the preferred encoder for this connector
> > - * @atomic_best_encoder: atomic version of @best_encoder
> >   *
> > - * The helper operations are called by the mid-layer CRTC helper.
> > + * These functions are used by the atomic and legacy modeset helpers and by the
> > + * probe helpers.
> >   */
> >  struct drm_connector_helper_funcs {
> > +	/**
> > +	 * @get_modes:
> > +	 *
> > +	 * This function should fill in all modes currently valid for the sink
> > +	 * into the connector->probe_modes function. It should also update the
> 
> What's probe_modes? I've never heard of it. Did you mean ->fill_modes()?
> Also it's strange to say "fill into the ... function". Perhaps "pass
> into the ... function" instead?

connector->probe*d*_modes *list* is what it should read. Fixed.
-Daniel
-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch