diff mbox

dt-bindings: display: sunxi: Improve endpoint ID scheme readability

Message ID 20170614063016.22069-1-wens@csie.org (mailing list archive)
State New, archived
Headers show

Commit Message

Chen-Yu Tsai June 14, 2017, 6:30 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>
---

Hope this helps. I'm not sure I can improve this even more without
spelling out all cases.

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

Comments

Rob Herring (Arm) June 18, 2017, 2:05 p.m. UTC | #1
On Wed, Jun 14, 2017 at 02:30:16PM +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>
> ---
> 
> Hope this helps. I'm not sure I can improve this even more without
> spelling out all cases.
> 
> ---
>  .../bindings/display/sunxi/sun4i-drm.txt           | 36 ++++++++++++++++------
>  1 file changed, 27 insertions(+), 9 deletions(-)

Acked-by: Rob Herring <robh@kernel.org>
Chen-Yu Tsai July 10, 2017, 3:48 p.m. UTC | #2
On Sun, Jun 18, 2017 at 10:05 PM, Rob Herring <robh@kernel.org> wrote:
> On Wed, Jun 14, 2017 at 02:30:16PM +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>
>> ---
>>
>> Hope this helps. I'm not sure I can improve this even more without
>> spelling out all cases.
>>
>> ---
>>  .../bindings/display/sunxi/sun4i-drm.txt           | 36 ++++++++++++++++------
>>  1 file changed, 27 insertions(+), 9 deletions(-)
>
> Acked-by: Rob Herring <robh@kernel.org>

Maxime, this patch seems to have fallen through the cracks.

Could you queue it as a fix for 4.13?

Thanks
ChenYu
Maxime Ripard July 11, 2017, 7:31 p.m. UTC | #3
On Mon, Jul 10, 2017 at 11:48:00PM +0800, Chen-Yu Tsai wrote:
> On Sun, Jun 18, 2017 at 10:05 PM, Rob Herring <robh@kernel.org> wrote:
> > On Wed, Jun 14, 2017 at 02:30:16PM +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>
> >> ---
> >>
> >> Hope this helps. I'm not sure I can improve this even more without
> >> spelling out all cases.
> >>
> >> ---
> >>  .../bindings/display/sunxi/sun4i-drm.txt           | 36 ++++++++++++++++------
> >>  1 file changed, 27 insertions(+), 9 deletions(-)
> >
> > Acked-by: Rob Herring <robh@kernel.org>
> 
> Maxime, this patch seems to have fallen through the cracks.
> 
> Could you queue it as a fix for 4.13?

Sorry, I don't know why I overlooked it.

Is it really 4.13 material though? It doesn't look that urgent.

Maxime
Chen-Yu Tsai July 12, 2017, 2:38 a.m. UTC | #4
On Wed, Jul 12, 2017 at 3:31 AM, Maxime Ripard
<maxime.ripard@free-electrons.com> wrote:
> On Mon, Jul 10, 2017 at 11:48:00PM +0800, Chen-Yu Tsai wrote:
>> On Sun, Jun 18, 2017 at 10:05 PM, Rob Herring <robh@kernel.org> wrote:
>> > On Wed, Jun 14, 2017 at 02:30:16PM +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>
>> >> ---
>> >>
>> >> Hope this helps. I'm not sure I can improve this even more without
>> >> spelling out all cases.
>> >>
>> >> ---
>> >>  .../bindings/display/sunxi/sun4i-drm.txt           | 36 ++++++++++++++++------
>> >>  1 file changed, 27 insertions(+), 9 deletions(-)
>> >
>> > Acked-by: Rob Herring <robh@kernel.org>
>>
>> Maxime, this patch seems to have fallen through the cracks.
>>
>> Could you queue it as a fix for 4.13?
>
> Sorry, I don't know why I overlooked it.
>
> Is it really 4.13 material though? It doesn't look that urgent.

Unless I'm mistaken, this clarifies the numbering scheme introduced
in 4.13. I'd say that's enough reason to have it in the same release.

But I should update the diagram first. The backend <-> TCON mux is
missing. And maybe a Fixes tag.

ChenYu
Maxime Ripard July 17, 2017, 6:21 a.m. UTC | #5
Hi,

On Wed, Jul 12, 2017 at 10:38:38AM +0800, Chen-Yu Tsai wrote:
> On Wed, Jul 12, 2017 at 3:31 AM, Maxime Ripard
> <maxime.ripard@free-electrons.com> wrote:
> > On Mon, Jul 10, 2017 at 11:48:00PM +0800, Chen-Yu Tsai wrote:
> >> On Sun, Jun 18, 2017 at 10:05 PM, Rob Herring <robh@kernel.org> wrote:
> >> > On Wed, Jun 14, 2017 at 02:30:16PM +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>
> >> >> ---
> >> >>
> >> >> Hope this helps. I'm not sure I can improve this even more without
> >> >> spelling out all cases.
> >> >>
> >> >> ---
> >> >>  .../bindings/display/sunxi/sun4i-drm.txt           | 36 ++++++++++++++++------
> >> >>  1 file changed, 27 insertions(+), 9 deletions(-)
> >> >
> >> > Acked-by: Rob Herring <robh@kernel.org>
> >>
> >> Maxime, this patch seems to have fallen through the cracks.
> >>
> >> Could you queue it as a fix for 4.13?
> >
> > Sorry, I don't know why I overlooked it.
> >
> > Is it really 4.13 material though? It doesn't look that urgent.
> 
> Unless I'm mistaken, this clarifies the numbering scheme introduced
> in 4.13. I'd say that's enough reason to have it in the same release.
> 
> But I should update the diagram first. The backend <-> TCON mux is
> missing. And maybe a Fixes tag.

If it's just clarification, I don't think we should push it as a fix,
but and it can definitely wait.

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..70885041553a 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]
+			\ /
+			 X
+			/ \
+		[0] ----   ---- [0]
+    Frontend 1  [1] ----------- [1]  Backend 1  [0] ----- [0]  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
 ------------