Commit 4541d31e authored by Daniel Vetter's avatar Daniel Vetter
Browse files

drm/bridge: Use recommened kerneldoc for struct member refs 



I just learned that &struct_name.member_name works and looks pretty
even. It doesn't (yet) link to the member directly though, which would
be really good for big structures or vfunc tables (where the
per-member kerneldoc tends to be long).

Also some minor drive-by polish where it makes sense, I read a lot
of docs ...

Cc: Archit Taneja <architt@codeaurora.org>
Cc: Jani Nikula <jani.nikula@linux.intel.com>
Cc: Chris Wilson <chris@chris-wilson.co.uk>
Reviewed-by: default avatarArchit Taneja <architt@codeaurora.org>
[danvet: Remove spurious hunk that Archit spotted.]
Signed-off-by: default avatarDaniel Vetter <daniel.vetter@intel.com>
Link: http://patchwork.freedesktop.org/patch/msgid/1483044517-5770-13-git-send-email-daniel.vetter@ffwll.ch
parent 421242aa

drivers/gpu/drm/drm_bridge.c

+12 −15
Original line number Diff line number Diff line
@@ -55,7 +55,7 @@ 
 * just provide additional hooks to get the desired output at the end of the

 * encoder chain.

 *

 * Bridges can also be chained up using the next pointer in &struct drm_bridge.

 * Bridges can also be chained up using the &drm_bridge.next pointer.

 *

 * Both legacy CRTC helpers and the new atomic modeset helpers support bridges.

 */
@@ -179,7 +179,7 @@ void drm_bridge_detach(struct drm_bridge *bridge) 
 * @mode: desired mode to be set for the bridge

 * @adjusted_mode: updated mode that works for this bridge

 *

 * Calls ->mode_fixup() &drm_bridge_funcs op for all the bridges in the

 * Calls &drm_bridge_funcs.mode_fixup for all the bridges in the

 * encoder chain, starting from the first bridge to the last.

 *

 * Note: the bridge passed should be the one closest to the encoder
@@ -206,11 +206,10 @@ bool drm_bridge_mode_fixup(struct drm_bridge *bridge, 
EXPORT_SYMBOL(drm_bridge_mode_fixup);



/**

 * drm_bridge_disable - calls ->disable() &drm_bridge_funcs op for all

 *			bridges in the encoder chain.

 * drm_bridge_disable - disables all bridges in the encoder chain

 * @bridge: bridge control structure

 *

 * Calls ->disable() &drm_bridge_funcs op for all the bridges in the encoder

 * Calls &drm_bridge_funcs.disable op for all the bridges in the encoder

 * chain, starting from the last bridge to the first. These are called before

 * calling the encoder's prepare op.

 *
@@ -229,11 +228,10 @@ void drm_bridge_disable(struct drm_bridge *bridge) 
EXPORT_SYMBOL(drm_bridge_disable);



/**

 * drm_bridge_post_disable - calls ->post_disable() &drm_bridge_funcs op for

 *			     all bridges in the encoder chain.

 * drm_bridge_post_disable - cleans up after disabling all bridges in the encoder chain

 * @bridge: bridge control structure

 *

 * Calls ->post_disable() &drm_bridge_funcs op for all the bridges in the

 * Calls &drm_bridge_funcs.post_disable op for all the bridges in the

 * encoder chain, starting from the first bridge to the last. These are called

 * after completing the encoder's prepare op.

 *
@@ -258,7 +256,7 @@ EXPORT_SYMBOL(drm_bridge_post_disable); 
 * @mode: desired mode to be set for the bridge

 * @adjusted_mode: updated mode that works for this bridge

 *

 * Calls ->mode_set() &drm_bridge_funcs op for all the bridges in the

 * Calls &drm_bridge_funcs.mode_set op for all the bridges in the

 * encoder chain, starting from the first bridge to the last.

 *

 * Note: the bridge passed should be the one closest to the encoder
@@ -278,11 +276,11 @@ void drm_bridge_mode_set(struct drm_bridge *bridge, 
EXPORT_SYMBOL(drm_bridge_mode_set);



/**

 * drm_bridge_pre_enable - calls ->pre_enable() &drm_bridge_funcs op for all

 *			   bridges in the encoder chain.

 * drm_bridge_pre_enable - prepares for enabling all

 *			   bridges in the encoder chain

 * @bridge: bridge control structure

 *

 * Calls ->pre_enable() &drm_bridge_funcs op for all the bridges in the encoder

 * Calls &drm_bridge_funcs.pre_enable op for all the bridges in the encoder

 * chain, starting from the last bridge to the first. These are called

 * before calling the encoder's commit op.

 *
@@ -301,11 +299,10 @@ void drm_bridge_pre_enable(struct drm_bridge *bridge) 
EXPORT_SYMBOL(drm_bridge_pre_enable);



/**

 * drm_bridge_enable - calls ->enable() &drm_bridge_funcs op for all bridges

 *		       in the encoder chain.

 * drm_bridge_enable - enables all bridges in the encoder chain

 * @bridge: bridge control structure

 *

 * Calls ->enable() &drm_bridge_funcs op for all the bridges in the encoder

 * Calls &drm_bridge_funcs.enable op for all the bridges in the encoder

 * chain, starting from the first bridge to the last. These are called

 * after completing the encoder's commit op.

 *

include/drm/drm_bridge.h

+24 −18
Original line number Diff line number Diff line
@@ -96,9 +96,10 @@ struct drm_bridge_funcs { 
	 * This callback should disable the bridge. It is called right before

	 * the preceding element in the display pipe is disabled. If the

	 * preceding element is a bridge this means it's called before that

	 * bridge's ->disable() function. If the preceding element is a

	 * &drm_encoder it's called right before the encoder's ->disable(),

	 * ->prepare() or ->dpms() hook from &struct drm_encoder_helper_funcs.

	 * bridge's @disable vfunc. If the preceding element is a &drm_encoder

	 * it's called right before the &drm_encoder_helper_funcs.disable,

	 * &drm_encoder_helper_funcs.prepare or &drm_encoder_helper_funcs.dpms

	 * hook.

	 *

	 * The bridge can assume that the display pipe (i.e. clocks and timing

	 * signals) feeding it is still running when this callback is called.
@@ -110,12 +111,13 @@ struct drm_bridge_funcs { 
	/**

	 * @post_disable:

	 *

	 * This callback should disable the bridge. It is called right after

	 * the preceding element in the display pipe is disabled. If the

	 * preceding element is a bridge this means it's called after that

	 * bridge's ->post_disable() function. If the preceding element is a

	 * &drm_encoder it's called right after the encoder's ->disable(),

	 * ->prepare() or ->dpms() hook from &struct drm_encoder_helper_funcs.

	 * This callback should disable the bridge. It is called right after the

	 * preceding element in the display pipe is disabled. If the preceding

	 * element is a bridge this means it's called after that bridge's

	 * @post_disable function. If the preceding element is a &drm_encoder

	 * it's called right after the encoder's

	 * &drm_encoder_helper_funcs.disable, &drm_encoder_helper_funcs.prepare

	 * or &drm_encoder_helper_funcs.dpms hook.

	 *

	 * The bridge must assume that the display pipe (i.e. clocks and timing

	 * singals) feeding it is no longer running when this callback is
@@ -129,9 +131,11 @@ struct drm_bridge_funcs { 
	 * @mode_set:

	 *

	 * This callback should set the given mode on the bridge. It is called

	 * after the ->mode_set() callback for the preceding element in the

	 * display pipeline has been called already. The display pipe (i.e.

	 * clocks and timing signals) is off when this function is called.

	 * after the @mode_set callback for the preceding element in the display

	 * pipeline has been called already. If the bridge is the first element

	 * then this would be &drm_encoder_helper_funcs.mode_set. The display

	 * pipe (i.e.  clocks and timing signals) is off when this function is

	 * called.

	 */

	void (*mode_set)(struct drm_bridge *bridge,

			 struct drm_display_mode *mode,
@@ -142,9 +146,10 @@ struct drm_bridge_funcs { 
	 * This callback should enable the bridge. It is called right before

	 * the preceding element in the display pipe is enabled. If the

	 * preceding element is a bridge this means it's called before that

	 * bridge's ->pre_enable() function. If the preceding element is a

	 * &drm_encoder it's called right before the encoder's ->enable(),

	 * ->commit() or ->dpms() hook from &struct drm_encoder_helper_funcs.

	 * bridge's @pre_enable function. If the preceding element is a

	 * &drm_encoder it's called right before the encoder's

	 * &drm_encoder_helper_funcs.enable, &drm_encoder_helper_funcs.commit or

	 * &drm_encoder_helper_funcs.dpms hook.

	 *

	 * The display pipe (i.e. clocks and timing signals) feeding this bridge

	 * will not yet be running when this callback is called. The bridge must
@@ -161,9 +166,10 @@ struct drm_bridge_funcs { 
	 * This callback should enable the bridge. It is called right after

	 * the preceding element in the display pipe is enabled. If the

	 * preceding element is a bridge this means it's called after that

	 * bridge's ->enable() function. If the preceding element is a

	 * &drm_encoder it's called right after the encoder's ->enable(),

	 * ->commit() or ->dpms() hook from &struct drm_encoder_helper_funcs.

	 * bridge's @enable function. If the preceding element is a

	 * &drm_encoder it's called right after the encoder's

	 * &drm_encoder_helper_funcs.enable, &drm_encoder_helper_funcs.commit or

	 * &drm_encoder_helper_funcs.dpms hook.

	 *

	 * The bridge can assume that the display pipe (i.e. clocks and timing

	 * signals) feeding it is running when this callback is called. This

CRA Git | Maintained and supported by SUSTech CRA and CCSE