Commit f15e6bb0 authored by Dhinakaran Pandiyan's avatar Dhinakaran Pandiyan Committed by Daniel Vetter

drm: Fix typo in encoder docs

Corrected typo in bridge and encoder comparison. Also, added a one-line
encoder description from the previous documentation.

Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
Cc: Archit Taneja <architt@codeaurora.org>
Signed-off-by: default avatarDhinakaran Pandiyan <dhinakaran.pandiyan@intel.com>
Signed-off-by: default avatarDaniel Vetter <daniel.vetter@ffwll.ch>
Link: http://patchwork.freedesktop.org/patch/msgid/1474324848-6446-1-git-send-email-dhinakaran.pandiyan@intel.com
parent b5a2ecd8
...@@ -31,20 +31,21 @@ ...@@ -31,20 +31,21 @@
* *
* Encoders represent the connecting element between the CRTC (as the overall * Encoders represent the connecting element between the CRTC (as the overall
* pixel pipeline, represented by struct &drm_crtc) and the connectors (as the * pixel pipeline, represented by struct &drm_crtc) and the connectors (as the
* generic sink entity, represented by struct &drm_connector). Encoders are * generic sink entity, represented by struct &drm_connector). An encoder takes
* objects exposed to userspace, originally to allow userspace to infer cloning * pixel data from a CRTC and converts it to a format suitable for any attached
* and connector/CRTC restrictions. Unfortunately almost all drivers get this * connector. Encoders are objects exposed to userspace, originally to allow
* wrong, making the uabi pretty much useless. On top of that the exposed * userspace to infer cloning and connector/CRTC restrictions. Unfortunately
* restrictions are too simple for todays hardware, and the recommend way to * almost all drivers get this wrong, making the uabi pretty much useless. On
* infer restrictions is by using the DRM_MODE_ATOMIC_TEST_ONLY flag for the * top of that the exposed restrictions are too simple for today's hardware, and
* atomic IOCTL. * the recommended way to infer restrictions is by using the
* DRM_MODE_ATOMIC_TEST_ONLY flag for the atomic IOCTL.
* *
* Otherwise encoders aren't used in the uapi at all (any modeset request from * Otherwise encoders aren't used in the uapi at all (any modeset request from
* userspace directly connects a connector with a CRTC), drivers are therefore * userspace directly connects a connector with a CRTC), drivers are therefore
* free to use them however they wish. Modeset helper libraries make strong use * free to use them however they wish. Modeset helper libraries make strong use
* of encoders to facilitate code sharing. But for more complex settings it is * of encoders to facilitate code sharing. But for more complex settings it is
* usually better to move shared code into a separate &drm_bridge. Compared to * usually better to move shared code into a separate &drm_bridge. Compared to
* encoders bridges also have the benefit of not being purely an internal * encoders, bridges also have the benefit of being purely an internal
* abstraction since they are not exposed to userspace at all. * abstraction since they are not exposed to userspace at all.
* *
* Encoders are initialized with drm_encoder_init() and cleaned up using * Encoders are initialized with drm_encoder_init() and cleaned up using
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment