summaryrefslogtreecommitdiffstats
path: root/include/drm
diff options
context:
space:
mode:
authorJesse Barnes <jbarnes@virtuousgeek.org>2011-11-07 12:03:17 -0800
committerDave Airlie <airlied@redhat.com>2011-12-06 10:23:30 +0000
commitdb3e44996f23a2a7e826ede2dd9cb1571687a60f (patch)
treec354d0b65938b1a197c271e80bd632b37b76d17e /include/drm
parent6c3db9200b75f0fd736c9d766b754b971ad07eb1 (diff)
downloadlinux-db3e44996f23a2a7e826ede2dd9cb1571687a60f.tar.bz2
drm: add drm_encoder comments
Just some basic comments about the place and function of the structure and fields. Signed-off-by: Jesse Barnes <jbarnes@virtuousgeek.org> Reviewed-by: Alex Deucher <alexdeucher@gmail.com> Signed-off-by: Dave Airlie <airlied@redhat.com>
Diffstat (limited to 'include/drm')
-rw-r--r--include/drm/drm_crtc.h12
1 files changed, 12 insertions, 0 deletions
diff --git a/include/drm/drm_crtc.h b/include/drm/drm_crtc.h
index 7db2ce52c5a4..1cdef2e4dfd2 100644
--- a/include/drm/drm_crtc.h
+++ b/include/drm/drm_crtc.h
@@ -456,6 +456,18 @@ struct drm_encoder_funcs {
/**
* drm_encoder - central DRM encoder structure
+ * @dev: parent DRM device
+ * @head: list management
+ * @base: base KMS object
+ * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h
+ * @possible_crtcs: bitmask of potential CRTC bindings
+ * @possible_clones: bitmask of potential sibling encoders for cloning
+ * @crtc: currently bound CRTC
+ * @funcs: control functions
+ * @helper_private: mid-layer private data
+ *
+ * CRTCs drive pixels to encoders, which convert them into signals
+ * appropriate for a given connector or set of connectors.
*/
struct drm_encoder {
struct drm_device *dev;