diff mbox

[v2] dt-bindings: display: sunxi: Improve endpoint ID scheme readability

Message ID 20170718040201.21099-1-wens@csie.org
State Not Applicable, archived
Headers show

Commit Message

Chen-Yu Tsai July 18, 2017, 4:02 a.m. UTC 
The explanation for the endpoint ID numbering scheme is convoluted
and hard to understand.

This patch aims to improve the readability of it by combining the
existing two paragraphs, while also providing a diagram example,
and how endpoints should be numbered based on that example.

Signed-off-by: Chen-Yu Tsai <wens@csie.org>
---
Changes since v1:

  - Added recently discovered mux between backends and TCONs to the
    diagram. This also fixes the numbering on the endpoints between
    backend 1 and TCON 1. Rob's ack is not added because of this
    change.

---
 .../bindings/display/sunxi/sun4i-drm.txt           | 36 ++++++++++++++++------
 1 file changed, 27 insertions(+), 9 deletions(-)

Comments

Maxime Ripard July 18, 2017, 2:53 p.m. UTC | #1 
On Tue, Jul 18, 2017 at 12:02:01PM +0800, Chen-Yu Tsai wrote:
> The explanation for the endpoint ID numbering scheme is convoluted
> and hard to understand.
> 
> This patch aims to improve the readability of it by combining the
> existing two paragraphs, while also providing a diagram example,
> and how endpoints should be numbered based on that example.
> 
> Signed-off-by: Chen-Yu Tsai <wens@csie.org>

Dropped the previous iteration, and applied this one. Thanks!
Maxime
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/display/sunxi/sun4i-drm.txt b/Documentation/devicetree/bindings/display/sunxi/sun4i-drm.txt
index b83e6018041d..2ee6ff0ef98e 100644
--- a/Documentation/devicetree/bindings/display/sunxi/sun4i-drm.txt
+++ b/Documentation/devicetree/bindings/display/sunxi/sun4i-drm.txt
@@ -4,15 +4,33 @@  Allwinner A10 Display Pipeline
 The Allwinner A10 Display pipeline is composed of several components
 that are going to be documented below:
 
-For the input port of all components up to the TCON in the display
-pipeline, if there are multiple components, the local endpoint IDs
-must correspond to the index of the upstream block. For example, if
-the remote endpoint is Frontend 1, then the local endpoint ID must
-be 1.
-
-Conversely, for the output ports of the same group, the remote endpoint
-ID must be the index of the local hardware block. If the local backend
-is backend 1, then the remote endpoint ID must be 1.
+For all connections between components up to the TCONs in the display
+pipeline, when there are multiple components of the same type at the
+same depth, the local endpoint ID must be the same as the remote
+component's index. For example, if the remote endpoint is Frontend 1,
+then the local endpoint ID must be 1.
+
+    Frontend 0  [0] ------- [0]  Backend 0  [0] ------- [0]  TCON 0
+		[1] --   -- [1]             [1] --   -- [1]
+		      \ /                         \ /
+		       X                           X
+		      / \                         / \
+		[0] --   -- [0]             [0] --   -- [0]
+    Frontend 1  [1] ------- [1]  Backend 1  [1] ------- [1]  TCON 1
+
+For a two pipeline system such as the one depicted above, the lines
+represent the connections between the components, while the numbers
+within the square brackets corresponds to the ID of the local endpoint.
+
+The same rule also applies to DE 2.0 mixer-TCON connections:
+
+    Mixer 0  [0] ----------- [0]  TCON 0
+	     [1] ----   ---- [1]
+		     \ /
+		      X
+		     / \
+	     [0] ----   ---- [0]
+    Mixer 1  [1] ----------- [1]  TCON 1
 
 HDMI Encoder
 ------------