Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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: Archit Taneja <architt@codeaurora.org>
[danvet: Remove spurious hunk that Archit spotted.]
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
Link: http://patchwork.freedesktop.org/patch/msgid/1483044517-5770-13-git-send-email-daniel.vetter@ffwll.ch

+36 -33
+12 -15
drivers/gpu/drm/drm_bridge.c
··· 55 55 * just provide additional hooks to get the desired output at the end of the 56 56 * encoder chain. 57 57 * 58 - * Bridges can also be chained up using the next pointer in &struct drm_bridge. 58 + * Bridges can also be chained up using the &drm_bridge.next pointer. 59 59 * 60 60 * Both legacy CRTC helpers and the new atomic modeset helpers support bridges. 61 61 */ ··· 179 179 * @mode: desired mode to be set for the bridge 180 180 * @adjusted_mode: updated mode that works for this bridge 181 181 * 182 - * Calls ->mode_fixup() &drm_bridge_funcs op for all the bridges in the 182 + * Calls &drm_bridge_funcs.mode_fixup for all the bridges in the 183 183 * encoder chain, starting from the first bridge to the last. 184 184 * 185 185 * Note: the bridge passed should be the one closest to the encoder ··· 206 206 EXPORT_SYMBOL(drm_bridge_mode_fixup); 207 207 208 208 /** 209 - * drm_bridge_disable - calls ->disable() &drm_bridge_funcs op for all 210 - * bridges in the encoder chain. 209 + * drm_bridge_disable - disables all bridges in the encoder chain 211 210 * @bridge: bridge control structure 212 211 * 213 - * Calls ->disable() &drm_bridge_funcs op for all the bridges in the encoder 212 + * Calls &drm_bridge_funcs.disable op for all the bridges in the encoder 214 213 * chain, starting from the last bridge to the first. These are called before 215 214 * calling the encoder's prepare op. 216 215 * ··· 228 229 EXPORT_SYMBOL(drm_bridge_disable); 229 230 230 231 /** 231 - * drm_bridge_post_disable - calls ->post_disable() &drm_bridge_funcs op for 232 - * all bridges in the encoder chain. 232 + * drm_bridge_post_disable - cleans up after disabling all bridges in the encoder chain 233 233 * @bridge: bridge control structure 234 234 * 235 - * Calls ->post_disable() &drm_bridge_funcs op for all the bridges in the 235 + * Calls &drm_bridge_funcs.post_disable op for all the bridges in the 236 236 * encoder chain, starting from the first bridge to the last. These are called 237 237 * after completing the encoder's prepare op. 238 238 * ··· 256 258 * @mode: desired mode to be set for the bridge 257 259 * @adjusted_mode: updated mode that works for this bridge 258 260 * 259 - * Calls ->mode_set() &drm_bridge_funcs op for all the bridges in the 261 + * Calls &drm_bridge_funcs.mode_set op for all the bridges in the 260 262 * encoder chain, starting from the first bridge to the last. 261 263 * 262 264 * Note: the bridge passed should be the one closest to the encoder ··· 276 278 EXPORT_SYMBOL(drm_bridge_mode_set); 277 279 278 280 /** 279 - * drm_bridge_pre_enable - calls ->pre_enable() &drm_bridge_funcs op for all 280 - * bridges in the encoder chain. 281 + * drm_bridge_pre_enable - prepares for enabling all 282 + * bridges in the encoder chain 281 283 * @bridge: bridge control structure 282 284 * 283 - * Calls ->pre_enable() &drm_bridge_funcs op for all the bridges in the encoder 285 + * Calls &drm_bridge_funcs.pre_enable op for all the bridges in the encoder 284 286 * chain, starting from the last bridge to the first. These are called 285 287 * before calling the encoder's commit op. 286 288 * ··· 299 301 EXPORT_SYMBOL(drm_bridge_pre_enable); 300 302 301 303 /** 302 - * drm_bridge_enable - calls ->enable() &drm_bridge_funcs op for all bridges 303 - * in the encoder chain. 304 + * drm_bridge_enable - enables all bridges in the encoder chain 304 305 * @bridge: bridge control structure 305 306 * 306 - * Calls ->enable() &drm_bridge_funcs op for all the bridges in the encoder 307 + * Calls &drm_bridge_funcs.enable op for all the bridges in the encoder 307 308 * chain, starting from the first bridge to the last. These are called 308 309 * after completing the encoder's commit op. 309 310 *
+24 -18
include/drm/drm_bridge.h
··· 96 96 * This callback should disable the bridge. It is called right before 97 97 * the preceding element in the display pipe is disabled. If the 98 98 * preceding element is a bridge this means it's called before that 99 - * bridge's ->disable() function. If the preceding element is a 100 - * &drm_encoder it's called right before the encoder's ->disable(), 101 - * ->prepare() or ->dpms() hook from &struct drm_encoder_helper_funcs. 99 + * bridge's @disable vfunc. If the preceding element is a &drm_encoder 100 + * it's called right before the &drm_encoder_helper_funcs.disable, 101 + * &drm_encoder_helper_funcs.prepare or &drm_encoder_helper_funcs.dpms 102 + * hook. 102 103 * 103 104 * The bridge can assume that the display pipe (i.e. clocks and timing 104 105 * signals) feeding it is still running when this callback is called. ··· 111 110 /** 112 111 * @post_disable: 113 112 * 114 - * This callback should disable the bridge. It is called right after 115 - * the preceding element in the display pipe is disabled. If the 116 - * preceding element is a bridge this means it's called after that 117 - * bridge's ->post_disable() function. If the preceding element is a 118 - * &drm_encoder it's called right after the encoder's ->disable(), 119 - * ->prepare() or ->dpms() hook from &struct drm_encoder_helper_funcs. 113 + * This callback should disable the bridge. It is called right after the 114 + * preceding element in the display pipe is disabled. If the preceding 115 + * element is a bridge this means it's called after that bridge's 116 + * @post_disable function. If the preceding element is a &drm_encoder 117 + * it's called right after the encoder's 118 + * &drm_encoder_helper_funcs.disable, &drm_encoder_helper_funcs.prepare 119 + * or &drm_encoder_helper_funcs.dpms hook. 120 120 * 121 121 * The bridge must assume that the display pipe (i.e. clocks and timing 122 122 * singals) feeding it is no longer running when this callback is ··· 131 129 * @mode_set: 132 130 * 133 131 * This callback should set the given mode on the bridge. It is called 134 - * after the ->mode_set() callback for the preceding element in the 135 - * display pipeline has been called already. The display pipe (i.e. 136 - * clocks and timing signals) is off when this function is called. 132 + * after the @mode_set callback for the preceding element in the display 133 + * pipeline has been called already. If the bridge is the first element 134 + * then this would be &drm_encoder_helper_funcs.mode_set. The display 135 + * pipe (i.e. clocks and timing signals) is off when this function is 136 + * called. 137 137 */ 138 138 void (*mode_set)(struct drm_bridge *bridge, 139 139 struct drm_display_mode *mode, ··· 146 142 * This callback should enable the bridge. It is called right before 147 143 * the preceding element in the display pipe is enabled. If the 148 144 * preceding element is a bridge this means it's called before that 149 - * bridge's ->pre_enable() function. If the preceding element is a 150 - * &drm_encoder it's called right before the encoder's ->enable(), 151 - * ->commit() or ->dpms() hook from &struct drm_encoder_helper_funcs. 145 + * bridge's @pre_enable function. If the preceding element is a 146 + * &drm_encoder it's called right before the encoder's 147 + * &drm_encoder_helper_funcs.enable, &drm_encoder_helper_funcs.commit or 148 + * &drm_encoder_helper_funcs.dpms hook. 152 149 * 153 150 * The display pipe (i.e. clocks and timing signals) feeding this bridge 154 151 * will not yet be running when this callback is called. The bridge must ··· 166 161 * This callback should enable the bridge. It is called right after 167 162 * the preceding element in the display pipe is enabled. If the 168 163 * preceding element is a bridge this means it's called after that 169 - * bridge's ->enable() function. If the preceding element is a 170 - * &drm_encoder it's called right after the encoder's ->enable(), 171 - * ->commit() or ->dpms() hook from &struct drm_encoder_helper_funcs. 164 + * bridge's @enable function. If the preceding element is a 165 + * &drm_encoder it's called right after the encoder's 166 + * &drm_encoder_helper_funcs.enable, &drm_encoder_helper_funcs.commit or 167 + * &drm_encoder_helper_funcs.dpms hook. 172 168 * 173 169 * The bridge can assume that the display pipe (i.e. clocks and timing 174 170 * signals) feeding it is running when this callback is called. This