On 22.08.2019 01:55, Laurent Pinchart wrote:
> 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+rene...@ideasonboard.com>
Queued to drm-misc-next.
Regards
Andrzej
> ---
> include/drm/drm_bridge.h | 22 +++++++++++-----------
> 1 file changed, 11 insertions(+), 11 deletions(-)
>
> diff --git a/include/drm/drm_bridge.h b/include/drm/drm_bridge.h
> index 7616f6562fe4..6d76c67fb819 100644
> --- a/include/drm/drm_bridge.h
> +++ b/include/drm/drm_bridge.h
> @@ -42,7 +42,7 @@ struct drm_bridge_funcs {
> * This callback is invoked whenever our bridge is being attached to a
> * &drm_encoder.
> *
> - * The attach callback is optional.
> + * The @attach callback is optional.
> *
> * RETURNS:
> *
> @@ -56,7 +56,7 @@ struct drm_bridge_funcs {
> * This callback is invoked whenever our bridge is being detached from a
> * &drm_encoder.
> *
> - * The detach callback is optional.
> + * The @detach callback is optional.
> */
> void (*detach)(struct drm_bridge *bridge);
>
> @@ -76,7 +76,7 @@ struct drm_bridge_funcs {
> * atomic helpers to validate modes supplied by userspace in
> * drm_atomic_helper_check_modeset().
> *
> - * This function is optional.
> + * The @mode_valid callback is optional.
> *
> * NOTE:
> *
> @@ -108,7 +108,7 @@ struct drm_bridge_funcs {
> * this function passes all other callbacks must succeed for this
> * configuration.
> *
> - * The mode_fixup callback is optional.
> + * The @mode_fixup callback is optional.
> *
> * NOTE:
> *
> @@ -146,7 +146,7 @@ struct drm_bridge_funcs {
> * The bridge can assume that the display pipe (i.e. clocks and timing
> * signals) feeding it is still running when this callback is called.
> *
> - * The disable callback is optional.
> + * The @disable callback is optional.
> */
> void (*disable)(struct drm_bridge *bridge);
>
> @@ -165,7 +165,7 @@ struct drm_bridge_funcs {
> * singals) feeding it is no longer running when this callback is
> * called.
> *
> - * The post_disable callback is optional.
> + * The @post_disable callback is optional.
> */
> void (*post_disable)(struct drm_bridge *bridge);
>
> @@ -214,7 +214,7 @@ struct drm_bridge_funcs {
> * not enable the display link feeding the next bridge in the chain (if
> * there is one) when this callback is called.
> *
> - * The pre_enable callback is optional.
> + * The @pre_enable callback is optional.
> */
> void (*pre_enable)(struct drm_bridge *bridge);
>
> @@ -234,7 +234,7 @@ struct drm_bridge_funcs {
> * callback must enable the display link feeding the next bridge in the
> * chain if there is one.
> *
> - * The enable callback is optional.
> + * The @enable callback is optional.
> */
> void (*enable)(struct drm_bridge *bridge);
>
> @@ -283,7 +283,7 @@ struct drm_bridge_funcs {
> * would be prudent to also provide an implementation of @enable if
> * you are expecting driver calls into &drm_bridge_enable.
> *
> - * The enable callback is optional.
> + * The @atomic_enable callback is optional.
> */
> void (*atomic_enable)(struct drm_bridge *bridge,
> struct drm_atomic_state *state);
> @@ -305,7 +305,7 @@ struct drm_bridge_funcs {
> * would be prudent to also provide an implementation of @disable if
> * you are expecting driver calls into &drm_bridge_disable.
> *
> - * The disable callback is optional.
> + * The @atomic_disable callback is optional.
> */
> void (*atomic_disable)(struct drm_bridge *bridge,
> struct drm_atomic_state *state);
> @@ -330,7 +330,7 @@ struct drm_bridge_funcs {
> * @post_disable if you are expecting driver calls into
> * &drm_bridge_post_disable.
> *
> - * The post_disable callback is optional.
> + * The @atomic_post_disable callback is optional.
> */
> void (*atomic_post_disable)(struct drm_bridge *bridge,
> struct drm_atomic_state *state);
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
