aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLaurent Pinchart <laurent.pinchart@ideasonboard.com>2014-12-10 14:11:31 -0500
committerDaniel Vetter <daniel.vetter@ffwll.ch>2014-12-11 02:56:15 -0500
commitc631c7156fc6dc50758ad99b5600c1eebd88c6a6 (patch)
tree123be577c89dae7d0a3244c68cbe5b12dfa32148
parentae28290be3871969fc3f64b480d42575a16ae990 (diff)
drm/doc: Document drm_add_modes_noedid() usage
And fix a spelling mistake. Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Alex Deucher <alexander.deucher@amd.com> Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
-rw-r--r--Documentation/DocBook/drm.tmpl24
1 files changed, 19 insertions, 5 deletions
diff --git a/Documentation/DocBook/drm.tmpl b/Documentation/DocBook/drm.tmpl
index b344bc3b0d77..3e212b903510 100644
--- a/Documentation/DocBook/drm.tmpl
+++ b/Documentation/DocBook/drm.tmpl
@@ -1947,10 +1947,16 @@ void intel_crt_init(struct drm_device *dev)
1947 and then retrieves a list of modes by calling the connector 1947 and then retrieves a list of modes by calling the connector
1948 <methodname>get_modes</methodname> helper operation. 1948 <methodname>get_modes</methodname> helper operation.
1949 </para> 1949 </para>
1950 <para>
1951 If the helper operation returns no mode, and if the connector status
1952 is connector_status_connected, standard VESA DMT modes up to
1953 1024x768 are automatically added to the modes list by a call to
1954 <function>drm_add_modes_noedid</function>.
1955 </para>
1950 <para> 1956 <para>
1951 The function filters out modes larger than 1957 The function then filters out modes larger than
1952 <parameter>max_width</parameter> and <parameter>max_height</parameter> 1958 <parameter>max_width</parameter> and <parameter>max_height</parameter>
1953 if specified. It then calls the optional connector 1959 if specified. It finally calls the optional connector
1954 <methodname>mode_valid</methodname> helper operation for each mode in 1960 <methodname>mode_valid</methodname> helper operation for each mode in
1955 the probed list to check whether the mode is valid for the connector. 1961 the probed list to check whether the mode is valid for the connector.
1956 </para> 1962 </para>
@@ -2090,12 +2096,20 @@ void intel_crt_init(struct drm_device *dev)
2090 <synopsis>int (*get_modes)(struct drm_connector *connector);</synopsis> 2096 <synopsis>int (*get_modes)(struct drm_connector *connector);</synopsis>
2091 <para> 2097 <para>
2092 Fill the connector's <structfield>probed_modes</structfield> list 2098 Fill the connector's <structfield>probed_modes</structfield> list
2093 by parsing EDID data with <function>drm_add_edid_modes</function> or 2099 by parsing EDID data with <function>drm_add_edid_modes</function>,
2094 calling <function>drm_mode_probed_add</function> directly for every 2100 adding standard VESA DMT modes with <function>drm_add_modes_noedid</function>,
2101 or calling <function>drm_mode_probed_add</function> directly for every
2095 supported mode and return the number of modes it has detected. This 2102 supported mode and return the number of modes it has detected. This
2096 operation is mandatory. 2103 operation is mandatory.
2097 </para> 2104 </para>
2098 <para> 2105 <para>
2106 Note that the caller function will automatically add standard VESA
2107 DMT modes up to 1024x768 if the <methodname>get_modes</methodname>
2108 helper operation returns no mode and if the connector status is
2109 connector_status_connected. There is no need to call
2110 <function>drm_add_edid_modes</function> manually in that case.
2111 </para>
2112 <para>
2099 When adding modes manually the driver creates each mode with a call to 2113 When adding modes manually the driver creates each mode with a call to
2100 <function>drm_mode_create</function> and must fill the following fields. 2114 <function>drm_mode_create</function> and must fill the following fields.
2101 <itemizedlist> 2115 <itemizedlist>
@@ -2292,7 +2306,7 @@ void intel_crt_init(struct drm_device *dev)
2292 <function>drm_helper_probe_single_connector_modes</function>. 2306 <function>drm_helper_probe_single_connector_modes</function>.
2293 </para> 2307 </para>
2294 <para> 2308 <para>
2295 When parsing EDID data, <function>drm_add_edid_modes</function> fill the 2309 When parsing EDID data, <function>drm_add_edid_modes</function> fills the
2296 connector <structfield>display_info</structfield> 2310 connector <structfield>display_info</structfield>
2297 <structfield>width_mm</structfield> and 2311 <structfield>width_mm</structfield> and
2298 <structfield>height_mm</structfield> fields. When creating modes 2312 <structfield>height_mm</structfield> fields. When creating modes