summaryrefslogtreecommitdiffstats
path: root/include/drm/drm_crtc.h
diff options
context:
space:
mode:
authorBrian Starkey <brian.starkey@arm.com>2016-10-13 10:47:08 +0100
committerDaniel Vetter <daniel.vetter@ffwll.ch>2016-10-17 08:07:11 +0200
commitd807ed1c55fb1b2dcfb2bc49385e227f6bee7669 (patch)
treed6422d386983b3e6bd1da80b536ba64751ba30c0 /include/drm/drm_crtc.h
parentf7741aa75e76440f4e9ecfe512feebe9bce33ca8 (diff)
downloadlinux-stable-d807ed1c55fb1b2dcfb2bc49385e227f6bee7669.tar.gz
linux-stable-d807ed1c55fb1b2dcfb2bc49385e227f6bee7669.tar.bz2
linux-stable-d807ed1c55fb1b2dcfb2bc49385e227f6bee7669.zip
drm: atomic: Clarify documentation around drm_atomic_crtc_needs_modeset
Add some additional comments to more explicitly describe the meaning and usage of the three CRTC modeset detection booleans: mode_changed, connectors_changed and active_changed. Suggested-by: Daniel Vetter <daniel.vetter@ffwll.ch> Signed-off-by: Brian Starkey <brian.starkey@arm.com> Acked-by: Alex Deucher <alexander.deucher@amd.com> Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch> Link: http://patchwork.freedesktop.org/patch/msgid/1476352028-16701-1-git-send-email-brian.starkey@arm.com
Diffstat (limited to 'include/drm/drm_crtc.h')
-rw-r--r--include/drm/drm_crtc.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/include/drm/drm_crtc.h b/include/drm/drm_crtc.h
index 0aa292526567..92246619947c 100644
--- a/include/drm/drm_crtc.h
+++ b/include/drm/drm_crtc.h
@@ -116,6 +116,11 @@ struct drm_plane_helper_funcs;
* never return in a failure from the ->atomic_check callback. Userspace assumes
* that a DPMS On will always succeed. In other words: @enable controls resource
* assignment, @active controls the actual hardware state.
+ *
+ * The three booleans active_changed, connectors_changed and mode_changed are
+ * intended to indicate whether a full modeset is needed, rather than strictly
+ * describing what has changed in a commit.
+ * See also: drm_atomic_crtc_needs_modeset()
*/
struct drm_crtc_state {
struct drm_crtc *crtc;