[PATCH 13/37] drm: better document how to send out the crtc disable event

[Boris Brezillon]

On Wed, 24 May 2017 16:51:48 +0200
Daniel Vetter <daniel.vetter at ffwll.ch> wrote:

> The kernel doc explained what needs to happen, but not how to most
> easily accomplish that using the functions. Fix that.
> 
> Cc: Boris Brezillon <boris.brezillon at free-electrons.com>
> Signed-off-by: Daniel Vetter <daniel.vetter at intel.com>

Reviewed-by: Boris Brezillon <boris.brezillon at free-electrons.com>

> ---
>  include/drm/drm_crtc.h | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/include/drm/drm_crtc.h b/include/drm/drm_crtc.h
> index 5f5d53973ca5..3a911a64c257 100644
> --- a/include/drm/drm_crtc.h
> +++ b/include/drm/drm_crtc.h
> @@ -214,7 +214,9 @@ struct drm_crtc_state {
>  	 *    atomic commit. In that case the event can be send out any time
>  	 *    after the hardware has stopped scanning out the current
>  	 *    framebuffers. It should contain the timestamp and counter for the
> -	 *    last vblank before the display pipeline was shut off.
> +	 *    last vblank before the display pipeline was shut off. The simplest
> +	 *    way to achieve that is calling drm_crtc_send_vblank_event()
> +	 *    somewhen after drm_crtc_vblank_off() has been called.
>  	 *
>  	 *  - For a CRTC which is enabled at the end of the commit (even when it
>  	 *    undergoes an full modeset) the vblank timestamp and counter must