[PATCH v3 3/5] dt-bindings: display: armada: Improve the LCDC documentation

Lubomir Rintel
2019-03-20T08:21:31Z

The port is a child, not a property. And should be accompanied by an
example. Plus a pair of cosmetic changes that don't seem to deserve a
separate commit.

Signed-off-by: Lubomir Rintel <lkundrak@v3.sk>

---
Changes since v2:
- Collected the Reviewed-by tag

Changes since v1:
- Minor adjustments to the commit message wording.

.../bindings/display/marvell,armada-lcdc.txt | 16 ++++++++++++++--
1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/Documentation/devicetree/bindings/display/marvell,armada-lcdc.txt b/Documentation/devicetree/bindings/display/marvell,armada-lcdc.txt
index 46525ea3e646..2606a8efc956 100644
--- a/Documentation/devicetree/bindings/display/marvell,armada-lcdc.txt
+++ b/Documentation/devicetree/bindings/display/marvell,armada-lcdc.txt
@@ -1,10 +1,11 @@
-Device Tree bindings for Armada DRM CRTC driver
+Marvell Armada LCD controller
+=============================

Required properties:
+
- compatible: value should be "marvell,dove-lcd".
- reg: base address and size of the LCD controller
- interrupts: single interrupt number for the LCD controller
- - port: video output port with endpoints, as described by graph.txt

Optional properties:

@@ -19,6 +20,11 @@ Note: all clocks are optional but at least one must be specified.
Further clocks may be added in the future according to requirements of
different SoCs.

+Required child nodes:
+
+- port: video output port with endpoints, as described by
+ Documentation/devicetree/bindings/graph.txt
+
Example:

lcd0: lcd-controller@820000 {
@@ -27,4 +33,10 @@ Example:
interrupts = <47>;
clocks = <&si5351 0>;
clock-names = "ext_ref_clk_1";
+
+ lcd0_port: port {
+ lcd0_rgb_out: endpoint {
+ remote-endpoint = <&encoder_rgb_in>;
+ };
+ };
};
--
2.20.1