[Intel-gfx] [PATCH 06/18] drm/atomic: Improve docs for drm_atomic_state->allow_modeset

[Ville Syrjälä]

On Tue, Oct 02, 2018 at 03:35:14PM +0200, Daniel Vetter wrote:
> Motivated by vmwgfx digging around in core uapi bits it shouldn't dig
> around in.
> 
> Signed-off-by: Daniel Vetter <daniel.vetter at intel.com>

Reviewed-by: Ville Syrjälä <ville.syrjala at linux.intel.com>

> ---
>  include/drm/drm_atomic.h | 10 +++++++++-
>  1 file changed, 9 insertions(+), 1 deletion(-)
> 
> diff --git a/include/drm/drm_atomic.h b/include/drm/drm_atomic.h
> index d6adebcd6ea4..c09ecaf43825 100644
> --- a/include/drm/drm_atomic.h
> +++ b/include/drm/drm_atomic.h
> @@ -254,7 +254,6 @@ struct __drm_private_objs_state {
>   * struct drm_atomic_state - the global state object for atomic updates
>   * @ref: count of all references to this state (will not be freed until zero)
>   * @dev: parent DRM device
> - * @allow_modeset: allow full modeset
>   * @legacy_cursor_update: hint to enforce legacy cursor IOCTL semantics
>   * @async_update: hint for asynchronous plane update
>   * @planes: pointer to array of structures with per-plane data
> @@ -273,6 +272,15 @@ struct drm_atomic_state {
>  	struct kref ref;
>  
>  	struct drm_device *dev;
> +
> +	/**
> +	 * @allow_modeset:
> +	 *
> +	 * Allow full modeset. This is used by the ATOMIC IOCTL handler to
> +	 * implement the DRM_MODE_ATOMIC_ALLOW_MODESET flag. Drivers should
> +	 * never consult this flag, instead looking at the output of
> +	 * drm_atomic_crtc_needs_modeset().
> +	 */
>  	bool allow_modeset : 1;
>  	bool legacy_cursor_update : 1;
>  	bool async_update : 1;
> -- 
> 2.19.0.rc2
> 
> _______________________________________________
> Intel-gfx mailing list
> Intel-gfx at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/intel-gfx

-- 
Ville Syrjälä
Intel