[PATCH 4/4] drm: Include drm_crtc_helper.h in DocBook

[Alex Deucher]

On Wed, Dec 17, 2014 at 10:41 AM, Thierry Reding
<thierry.reding at gmail.com> wrote:
> From: Thierry Reding <treding at nvidia.com>
>
> There is already a section that describes the helpers implemented by
> this module. Add the kerneldoc-generated structure descriptions to this
> section.
>
> While at it, add missing kerneldoc for the structures to avoid warnings
> when generating the documentation.
>
> Signed-off-by: Thierry Reding <treding at nvidia.com>

Reviewed-by: Alex Deucher <alexander.deucher at amd.com>

> ---
>  Documentation/DocBook/drm.tmpl |  1 +
>  include/drm/drm_crtc_helper.h  | 30 +++++++++++++++++++++++++-----
>  2 files changed, 26 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/DocBook/drm.tmpl b/Documentation/DocBook/drm.tmpl
> index 4b592ffbafee..8b6fe229dc9a 100644
> --- a/Documentation/DocBook/drm.tmpl
> +++ b/Documentation/DocBook/drm.tmpl
> @@ -2362,6 +2362,7 @@ void intel_crt_init(struct drm_device *dev)
>      </sect2>
>      <sect2>
>        <title>Modeset Helper Functions Reference</title>
> +!Iinclude/drm/drm_crtc_helper.h
>  !Edrivers/gpu/drm/drm_crtc_helper.c
>  !Pdrivers/gpu/drm/drm_crtc_helper.c overview
>      </sect2>
> diff --git a/include/drm/drm_crtc_helper.h b/include/drm/drm_crtc_helper.h
> index 8608897ace10..e76828d81a8b 100644
> --- a/include/drm/drm_crtc_helper.h
> +++ b/include/drm/drm_crtc_helper.h
> @@ -47,9 +47,20 @@ enum mode_set_atomic {
>  };
>
>  /**
> - * drm_crtc_helper_funcs - helper operations for CRTCs
> - * @mode_fixup: try to fixup proposed mode for this connector
> + * struct drm_crtc_helper_funcs - helper operations for CRTCs
> + * @dpms: set power state
> + * @prepare: prepare the CRTC, called before @mode_set
> + * @commit: commit changes to CRTC, called after @mode_set
> + * @mode_fixup: try to fixup proposed mode for this CRTC
>   * @mode_set: set this mode
> + * @mode_set_nofb: set mode only (no scanout buffer attached)
> + * @mode_set_base: update the scanout buffer
> + * @mode_set_base_atomic: non-blocking mode set (used for kgdb support)
> + * @load_lut: load color palette
> + * @disable: disable CRTC when no longer in use
> + * @atomic_check: check for validity of an atomic state
> + * @atomic_begin: begin atomic update
> + * @atomic_flush: flush atomic update
>   *
>   * The helper operations are called by the mid-layer CRTC helper.
>   */
> @@ -93,9 +104,17 @@ struct drm_crtc_helper_funcs {
>  };
>
>  /**
> - * drm_encoder_helper_funcs - helper operations for encoders
> + * struct drm_encoder_helper_funcs - helper operations for encoders
> + * @dpms: set power state
> + * @save: save connector state
> + * @restore: restore connector state
>   * @mode_fixup: try to fixup proposed mode for this connector
> + * @prepare: part of the disable sequence, called before the CRTC modeset
> + * @commit: called after the CRTC modeset
>   * @mode_set: set this mode
> + * @get_crtc: return CRTC that the encoder is currently attached to
> + * @detect: connection status detection
> + * @disable: disable encoder when not in use (overrides DPMS off)
>   *
>   * The helper operations are called by the mid-layer CRTC helper.
>   */
> @@ -121,9 +140,10 @@ struct drm_encoder_helper_funcs {
>  };
>
>  /**
> - * drm_connector_helper_funcs - helper operations for connectors
> + * struct drm_connector_helper_funcs - helper operations for connectors
>   * @get_modes: get mode list for this connector
> - * @mode_valid (optional): is this mode valid on the given connector?
> + * @mode_valid: is this mode valid on the given connector? (optional)
> + * @best_encoder: return the preferred encoder for this connector
>   *
>   * The helper operations are called by the mid-layer CRTC helper.
>   */
> --
> 2.1.3
>
> _______________________________________________
> dri-devel mailing list
> dri-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/dri-devel