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

drm/bridge: Fix references to drm_bridge_funcs in documentation

The documentation for most of the bridge atomic operations incorrectly
reference the non-atomic version when stating the operations are
optional. Fix them, and make sure that all references to bridge
operations are correctly marked with @.

Signed-off-by: Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com>
Signed-off-by: Andrzej Hajda <a.hajda@samsung.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20190821235502.15475-1-laurent.pinchart+renesas@ideasonboard.com

authored by

Laurent Pinchart and committed by
Andrzej Hajda
fe9e557d 3250cdf9

+11 -11
+11 -11
include/drm/drm_bridge.h
··· 42 42 * This callback is invoked whenever our bridge is being attached to a 43 43 * &drm_encoder. 44 44 * 45 - * The attach callback is optional. 45 + * The @attach callback is optional. 46 46 * 47 47 * RETURNS: 48 48 * ··· 56 56 * This callback is invoked whenever our bridge is being detached from a 57 57 * &drm_encoder. 58 58 * 59 - * The detach callback is optional. 59 + * The @detach callback is optional. 60 60 */ 61 61 void (*detach)(struct drm_bridge *bridge); 62 62 ··· 76 76 * atomic helpers to validate modes supplied by userspace in 77 77 * drm_atomic_helper_check_modeset(). 78 78 * 79 - * This function is optional. 79 + * The @mode_valid callback is optional. 80 80 * 81 81 * NOTE: 82 82 * ··· 108 108 * this function passes all other callbacks must succeed for this 109 109 * configuration. 110 110 * 111 - * The mode_fixup callback is optional. 111 + * The @mode_fixup callback is optional. 112 112 * 113 113 * NOTE: 114 114 * ··· 146 146 * The bridge can assume that the display pipe (i.e. clocks and timing 147 147 * signals) feeding it is still running when this callback is called. 148 148 * 149 - * The disable callback is optional. 149 + * The @disable callback is optional. 150 150 */ 151 151 void (*disable)(struct drm_bridge *bridge); 152 152 ··· 165 165 * singals) feeding it is no longer running when this callback is 166 166 * called. 167 167 * 168 - * The post_disable callback is optional. 168 + * The @post_disable callback is optional. 169 169 */ 170 170 void (*post_disable)(struct drm_bridge *bridge); 171 171 ··· 214 214 * not enable the display link feeding the next bridge in the chain (if 215 215 * there is one) when this callback is called. 216 216 * 217 - * The pre_enable callback is optional. 217 + * The @pre_enable callback is optional. 218 218 */ 219 219 void (*pre_enable)(struct drm_bridge *bridge); 220 220 ··· 234 234 * callback must enable the display link feeding the next bridge in the 235 235 * chain if there is one. 236 236 * 237 - * The enable callback is optional. 237 + * The @enable callback is optional. 238 238 */ 239 239 void (*enable)(struct drm_bridge *bridge); 240 240 ··· 283 283 * would be prudent to also provide an implementation of @enable if 284 284 * you are expecting driver calls into &drm_bridge_enable. 285 285 * 286 - * The enable callback is optional. 286 + * The @atomic_enable callback is optional. 287 287 */ 288 288 void (*atomic_enable)(struct drm_bridge *bridge, 289 289 struct drm_atomic_state *state); ··· 305 305 * would be prudent to also provide an implementation of @disable if 306 306 * you are expecting driver calls into &drm_bridge_disable. 307 307 * 308 - * The disable callback is optional. 308 + * The @atomic_disable callback is optional. 309 309 */ 310 310 void (*atomic_disable)(struct drm_bridge *bridge, 311 311 struct drm_atomic_state *state); ··· 330 330 * @post_disable if you are expecting driver calls into 331 331 * &drm_bridge_post_disable. 332 332 * 333 - * The post_disable callback is optional. 333 + * The @atomic_post_disable callback is optional. 334 334 */ 335 335 void (*atomic_post_disable)(struct drm_bridge *bridge, 336 336 struct drm_atomic_state *state);