[Intel-gfx] [PATCH 12/14] drm/i915: Document the inteded use of requested_mode

[Ville Syrjälä]

On Tue, Sep 10, 2013 at 06:07:18PM +0100, Damien Lespiau wrote:
> On Wed, Sep 04, 2013 at 06:25:29PM +0300, ville.syrjala at linux.intel.com wrote:
> > From: Ville Syrjälä <ville.syrjala at linux.intel.com>
> > 
> > Try to clarify the purpose of requested_mode.
> > 
> > Signed-off-by: Ville Syrjälä <ville.syrjala at linux.intel.com>
> 
> Reviewed-by: Damien Lespiau <damien.lespiau at intel.com>
> 
> > ---
> >  drivers/gpu/drm/i915/intel_drv.h | 5 +++++
> >  1 file changed, 5 insertions(+)
> > 
> > diff --git a/drivers/gpu/drm/i915/intel_drv.h b/drivers/gpu/drm/i915/intel_drv.h
> > index 9d30909..2c9c96b 100644
> > --- a/drivers/gpu/drm/i915/intel_drv.h
> > +++ b/drivers/gpu/drm/i915/intel_drv.h
> > @@ -211,6 +211,11 @@ struct intel_crtc_config {
> >  #define PIPE_CONFIG_QUIRK_MODE_SYNC_FLAGS (1<<0) /* unreliable sync mode.flags */
> >  	unsigned long quirks;
> >  
> > +	/* User requested mode, only valid as a starting point to
> > +	 * compute adjusted_mode, except in the case of (S)DVO where
> > +	 * it's also for the output timings of the (S)DVO chip.
> > +	 * adjusted_mode will then correspond to the S(DVO) chip's
> > +	 * preferred input timings. */
> 
> That looks quite weird, maybe we should introduce another mode for this, and
> only this, case?

I was thinking about it, but then decided that I don't care enough
about it to make another patch. Maybe if I ever manage to get some SDVO
cards I might care, or if we simply decide to kill requested_mode (ie.
we'd just rename it to sdvo_output_mode or something).

> 
> FWIW, I've been recently reminded that:
> 
> 	/*
> 	* This is the preferred style for multi-line
> 	* comments in the Linux kernel source code.
> 	* Please use it consistently.
> 	*
> 	* Description:  A column of asterisks on the left side,
> 	* with beginning and ending almost-blank lines.
> 	*/
> 
> except in net/ and drivers/net/ where the style in this patch is used.

Yeah I tried it. But it looked funny since the other comments there
already used the wrong style. So you can blame Daniel or whoever wrote
the other comments ;)

-- 
Ville Syrjälä
Intel OTC