[RESEND PATCH] drm/doc: Document drm_add_modes_noedid() usage

[Daniel Vetter]

On Wed, Dec 10, 2014 at 04:11:46PM -0500, Alex Deucher wrote:
> On Wed, Dec 10, 2014 at 2:11 PM, Laurent Pinchart
> <laurent.pinchart+renesas at ideasonboard.com> wrote:
> > From: Laurent Pinchart <laurent.pinchart at ideasonboard.com>
> >
> > And fix a spelling mistake.
> >
> > Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>
> 
> Reviewed-by: Alex Deucher <alexander.deucher at amd.com>

Merged to drm-misc, thanks.
-Daniel

> 
> > ---
> >  Documentation/DocBook/drm.tmpl | 24 +++++++++++++++++++-----
> >  1 file changed, 19 insertions(+), 5 deletions(-)
> >
> > I've had this patch in my tree for way too long, it's time to get it to
> > mainline or drop it. I of course vote for the former as I wouldn't submit it
> > otherwise.
> >
> > diff --git a/Documentation/DocBook/drm.tmpl b/Documentation/DocBook/drm.tmpl
> > index 60c1063d4178..a5024f6aaf53 100644
> > --- a/Documentation/DocBook/drm.tmpl
> > +++ b/Documentation/DocBook/drm.tmpl
> > @@ -1947,10 +1947,16 @@ void intel_crt_init(struct drm_device *dev)
> >              and then retrieves a list of modes by calling the connector
> >              <methodname>get_modes</methodname> helper operation.
> >            </para>
> > +         <para>
> > +            If the helper operation returns no mode, and if the connector status
> > +            is connector_status_connected, standard VESA DMT modes up to
> > +            1024x768 are automatically added to the modes list by a call to
> > +            <function>drm_add_modes_noedid</function>.
> > +          </para>
> >            <para>
> > -            The function filters out modes larger than
> > +            The function then filters out modes larger than
> >              <parameter>max_width</parameter> and <parameter>max_height</parameter>
> > -            if specified. It then calls the optional connector
> > +            if specified. It finally calls the optional connector
> >              <methodname>mode_valid</methodname> helper operation for each mode in
> >              the probed list to check whether the mode is valid for the connector.
> >            </para>
> > @@ -2090,12 +2096,20 @@ void intel_crt_init(struct drm_device *dev)
> >            <synopsis>int (*get_modes)(struct drm_connector *connector);</synopsis>
> >            <para>
> >              Fill the connector's <structfield>probed_modes</structfield> list
> > -            by parsing EDID data with <function>drm_add_edid_modes</function> or
> > -            calling <function>drm_mode_probed_add</function> directly for every
> > +            by parsing EDID data with <function>drm_add_edid_modes</function>,
> > +            adding standard VESA DMT modes with <function>drm_add_modes_noedid</function>,
> > +            or calling <function>drm_mode_probed_add</function> directly for every
> >              supported mode and return the number of modes it has detected. This
> >              operation is mandatory.
> >            </para>
> >            <para>
> > +            Note that the caller function will automatically add standard VESA
> > +            DMT modes up to 1024x768 if the <methodname>get_modes</methodname>
> > +            helper operation returns no mode and if the connector status is
> > +            connector_status_connected. There is no need to call
> > +            <function>drm_add_edid_modes</function> manually in that case.
> > +          </para>
> > +          <para>
> >              When adding modes manually the driver creates each mode with a call to
> >              <function>drm_mode_create</function> and must fill the following fields.
> >              <itemizedlist>
> > @@ -2292,7 +2306,7 @@ void intel_crt_init(struct drm_device *dev)
> >              <function>drm_helper_probe_single_connector_modes</function>.
> >            </para>
> >            <para>
> > -            When parsing EDID data, <function>drm_add_edid_modes</function> fill the
> > +            When parsing EDID data, <function>drm_add_edid_modes</function> fills the
> >              connector <structfield>display_info</structfield>
> >              <structfield>width_mm</structfield> and
> >              <structfield>height_mm</structfield> fields. When creating modes
> > --
> > Regards,
> >
> > Laurent Pinchart
> >
> > _______________________________________________
> > dri-devel mailing list
> > dri-devel at lists.freedesktop.org
> > http://lists.freedesktop.org/mailman/listinfo/dri-devel
> _______________________________________________
> dri-devel mailing list
> dri-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/dri-devel

-- 
Daniel Vetter
Software Engineer, Intel Corporation
+41 (0) 79 365 57 48 - http://blog.ffwll.ch