drm: Miscellaneous typo fixes and documentation updates

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Alex Deucher <alexander.deucher@amd.com> Signed-off-by: Dave Airlie <airlied@redhat.com>

drm: Miscellaneous typo fixes and documentation updates
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Alex Deucher <alexander.deucher@amd.com> Signed-off-by: Dave Airlie <airlied@redhat.com>
Laurent Pinchart · Dave Airlie
1 parent 4a1b071427
Showing 5 changed files with 38 additions and 24 deletions Side-by-side Diff
drivers/gpu/drm/drm_crtc.c
drivers/gpu/drm/drm_sysfs.c
include/drm/drmP.h
include/drm/drm_crtc.h
include/drm/drm_crtc_helper.h
@@ -363,7 +363,7 @@
  * @funcs: callbacks for the new CRTC
  *
  * LOCKING:
- * Caller must hold mode config lock.
+ * Takes mode_config lock.
  *
  * Inits a new object created as base part of an driver crtc object.
  *
@@ -347,17 +347,17 @@
 };
  
 /**
- * drm_sysfs_connector_add - add an connector to sysfs
+ * drm_sysfs_connector_add - add a connector to sysfs
  * @connector: connector to add
  *
- * Create an connector device in sysfs, along with its associated connector
+ * Create a connector device in sysfs, along with its associated connector
  * properties (so far, connection status, dpms, mode list & edid) and
  * generate a hotplug event so userspace knows there's a new connector
  * available.
  *
  * Note:
- * This routine should only be called *once* for each DRM minor registered.
- * A second call for an already registered device will trigger the BUG_ON
+ * This routine should only be called *once* for each registered connector.
+ * A second call for an already registered connector will trigger the BUG_ON
  * below.
  */
 int drm_sysfs_connector_add(struct drm_connector *connector)
@@ -755,11 +755,11 @@
 	 * @dev: DRM device
 	 * @crtc: counter to fetch
 	 *
-	 * Driver callback for fetching a raw hardware vblank counter
-	 * for @crtc.  If a device doesn't have a hardware counter, the
-	 * driver can simply return the value of drm_vblank_count and
-	 * make the enable_vblank() and disable_vblank() hooks into no-ops,
-	 * leaving interrupts enabled at all times.
+	 * Driver callback for fetching a raw hardware vblank counter for @crtc.
+	 * If a device doesn't have a hardware counter, the driver can simply
+	 * return the value of drm_vblank_count. The DRM core will account for
+	 * missed vblank events while interrupts where disabled based on system
+	 * timestamps.
 	 *
 	 * Wraparound handling and loss of events due to modesetting is dealt
 	 * with in the DRM core code.
@@ -294,20 +294,16 @@
  
 /**
  * drm_crtc_funcs - control CRTCs for a given device
- * @reset: reset CRTC after state has been invalidate (e.g. resume)
- * @dpms: control display power levels
  * @save: save CRTC state
- * @resore: restore CRTC state
- * @lock: lock the CRTC
- * @unlock: unlock the CRTC
- * @shadow_allocate: allocate shadow pixmap
- * @shadow_create: create shadow pixmap for rotation support
- * @shadow_destroy: free shadow pixmap
- * @mode_fixup: fixup proposed mode
- * @mode_set: set the desired mode on the CRTC
+ * @restore: restore CRTC state
+ * @reset: reset CRTC after state has been invalidate (e.g. resume)
+ * @cursor_set: setup the cursor
+ * @cursor_move: move the cursor
  * @gamma_set: specify color ramp for CRTC
  * @destroy: deinit and free object
  * @set_property: called when a property is changed
+ * @set_config: apply a new CRTC configuration
+ * @page_flip: initiate a page flip
  *
  * The drm_crtc_funcs structure is the central CRTC management structure
  * in the DRM.  Each CRTC controls one or more connectors (note that the name
  
@@ -420,11 +416,8 @@
  * @save: save connector state
  * @restore: restore connector state
  * @reset: reset connector after state has been invalidate (e.g. resume)
- * @mode_valid: is this mode valid on the given connector?
- * @mode_fixup: try to fixup proposed mode for this connector
- * @mode_set: set this mode
  * @detect: is this connector active?
- * @get_modes: get mode list for this connector
+ * @fill_modes: fill mode list for this connector
  * @set_property: property for this connector may need update
  * @destroy: make object go away
  * @force: notify the driver the connector is forced on
@@ -44,6 +44,13 @@
 	ENTER_ATOMIC_MODE_SET,
 };
  
+/**
+ * drm_crtc_helper_funcs - helper operations for CRTCs
+ * @mode_fixup: try to fixup proposed mode for this connector
+ * @mode_set: set this mode
+ *
+ * The helper operations are called by the mid-layer CRTC helper.
+ */
 struct drm_crtc_helper_funcs {
 	/*
 	 * Control power levels on the CRTC.  If the mode passed in is
@@ -76,6 +83,13 @@
 	void (*disable)(struct drm_crtc *crtc);
 };
  
+/**
+ * drm_encoder_helper_funcs - helper operations for encoders
+ * @mode_fixup: try to fixup proposed mode for this connector
+ * @mode_set: set this mode
+ *
+ * The helper operations are called by the mid-layer CRTC helper.
+ */
 struct drm_encoder_helper_funcs {
 	void (*dpms)(struct drm_encoder *encoder, int mode);
 	void (*save)(struct drm_encoder *encoder);
@@ -97,6 +111,13 @@
 	void (*disable)(struct drm_encoder *encoder);
 };
  
+/**
+ * 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?
+ *
+ * The helper operations are called by the mid-layer CRTC helper.
+ */
 struct drm_connector_helper_funcs {
 	int (*get_modes)(struct drm_connector *connector);
 	int (*mode_valid)(struct drm_connector *connector,
...	...	@@ -363,7 +363,7 @@
363	363	* @funcs: callbacks for the new CRTC
364	364	*
365	365	* LOCKING:
366		- * Caller must hold mode config lock.
	366	+ * Takes mode_config lock.
367	367	*
368	368	* Inits a new object created as base part of an driver crtc object.
369	369	*
...	...	@@ -347,17 +347,17 @@
347	347	};
348	348
349	349	/**
350		- * drm_sysfs_connector_add - add an connector to sysfs
	350	+ * drm_sysfs_connector_add - add a connector to sysfs
351	351	* @connector: connector to add
352	352	*
353		- * Create an connector device in sysfs, along with its associated connector
	353	+ * Create a connector device in sysfs, along with its associated connector
354	354	* properties (so far, connection status, dpms, mode list & edid) and
355	355	* generate a hotplug event so userspace knows there's a new connector
356	356	* available.
357	357	*
358	358	* Note:
359		- * This routine should only be called once for each DRM minor registered.
360		- * A second call for an already registered device will trigger the BUG_ON
	359	+ * This routine should only be called once for each registered connector.
	360	+ * A second call for an already registered connector will trigger the BUG_ON
361	361	* below.
362	362	*/
363	363	int drm_sysfs_connector_add(struct drm_connector *connector)
...	...	@@ -755,11 +755,11 @@
755	755	* @dev: DRM device
756	756	* @crtc: counter to fetch
757	757	*
758		- * Driver callback for fetching a raw hardware vblank counter
759		- * for @crtc. If a device doesn't have a hardware counter, the
760		- * driver can simply return the value of drm_vblank_count and
761		- * make the enable_vblank() and disable_vblank() hooks into no-ops,
762		- * leaving interrupts enabled at all times.
	758	+ * Driver callback for fetching a raw hardware vblank counter for @crtc.
	759	+ * If a device doesn't have a hardware counter, the driver can simply
	760	+ * return the value of drm_vblank_count. The DRM core will account for
	761	+ * missed vblank events while interrupts where disabled based on system
	762	+ * timestamps.
763	763	*
764	764	* Wraparound handling and loss of events due to modesetting is dealt
765	765	* with in the DRM core code.
...	...	@@ -294,20 +294,16 @@
294	294
295	295	/**
296	296	* drm_crtc_funcs - control CRTCs for a given device
297		- * @reset: reset CRTC after state has been invalidate (e.g. resume)
298		- * @dpms: control display power levels
299	297	* @save: save CRTC state
300		- * @resore: restore CRTC state
301		- * @lock: lock the CRTC
302		- * @unlock: unlock the CRTC
303		- * @shadow_allocate: allocate shadow pixmap
304		- * @shadow_create: create shadow pixmap for rotation support
305		- * @shadow_destroy: free shadow pixmap
306		- * @mode_fixup: fixup proposed mode
307		- * @mode_set: set the desired mode on the CRTC
	298	+ * @restore: restore CRTC state
	299	+ * @reset: reset CRTC after state has been invalidate (e.g. resume)
	300	+ * @cursor_set: setup the cursor
	301	+ * @cursor_move: move the cursor
308	302	* @gamma_set: specify color ramp for CRTC
309	303	* @destroy: deinit and free object
310	304	* @set_property: called when a property is changed
	305	+ * @set_config: apply a new CRTC configuration
	306	+ * @page_flip: initiate a page flip
311	307	*
312	308	* The drm_crtc_funcs structure is the central CRTC management structure
313	309	* in the DRM. Each CRTC controls one or more connectors (note that the name
314	310
...	...	@@ -420,11 +416,8 @@
420	416	* @save: save connector state
421	417	* @restore: restore connector state
422	418	* @reset: reset connector after state has been invalidate (e.g. resume)
423		- * @mode_valid: is this mode valid on the given connector?
424		- * @mode_fixup: try to fixup proposed mode for this connector
425		- * @mode_set: set this mode
426	419	* @detect: is this connector active?
427		- * @get_modes: get mode list for this connector
	420	+ * @fill_modes: fill mode list for this connector
428	421	* @set_property: property for this connector may need update
429	422	* @destroy: make object go away
430	423	* @force: notify the driver the connector is forced on
...	...	@@ -44,6 +44,13 @@
44	44	ENTER_ATOMIC_MODE_SET,
45	45	};
46	46
	47	+/**
	48	+ * drm_crtc_helper_funcs - helper operations for CRTCs
	49	+ * @mode_fixup: try to fixup proposed mode for this connector
	50	+ * @mode_set: set this mode
	51	+ *
	52	+ * The helper operations are called by the mid-layer CRTC helper.
	53	+ */
47	54	struct drm_crtc_helper_funcs {
48	55	/*
49	56	* Control power levels on the CRTC. If the mode passed in is
...	...	@@ -76,6 +83,13 @@
76	83	void (disable)(struct drm_crtc crtc);
77	84	};
78	85
	86	+/**
	87	+ * drm_encoder_helper_funcs - helper operations for encoders
	88	+ * @mode_fixup: try to fixup proposed mode for this connector
	89	+ * @mode_set: set this mode
	90	+ *
	91	+ * The helper operations are called by the mid-layer CRTC helper.
	92	+ */
79	93	struct drm_encoder_helper_funcs {
80	94	void (dpms)(struct drm_encoder encoder, int mode);
81	95	void (save)(struct drm_encoder encoder);
...	...	@@ -97,6 +111,13 @@
97	111	void (disable)(struct drm_encoder encoder);
98	112	};
99	113
	114	+/**
	115	+ * drm_connector_helper_funcs - helper operations for connectors
	116	+ * @get_modes: get mode list for this connector
	117	+ * @mode_valid: is this mode valid on the given connector?
	118	+ *
	119	+ * The helper operations are called by the mid-layer CRTC helper.
	120	+ */
100	121	struct drm_connector_helper_funcs {
101	122	int (get_modes)(struct drm_connector connector);
102	123	int (mode_valid)(struct drm_connector connector,