Commit ec9b0a9e authored by Daniel Vetter's avatar Daniel Vetter
Browse files

drm/atomic: Improve docs for drm_atomic_state->allow_modeset



Motivated by vmwgfx digging around in core uapi bits it shouldn't dig
around in.

Reviewed-by: default avatarVille Syrjälä <ville.syrjala@linux.intel.com>
Signed-off-by: default avatarDaniel Vetter <daniel.vetter@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20181004202446.22905-7-daniel.vetter@ffwll.ch
parent 9ef8a9dc
Loading
Loading
Loading
Loading
+9 −1
Original line number Diff line number Diff line
@@ -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;