Document the CIX Sky1 DisplayPort transmitter. Each instance sits
between one of the SoC display pipelines and a DisplayPort PHY, and
exposes the DP register block together with the RCSU block used for the
link setup.

The controller is described as a DRM bridge whose video input is linked
through the OF graph, and the DisplayPort PHY is referenced through the
generic PHY framework. The RCSU adapter port, the video stream and the
maximum link rate are described by "cix,adapter-port", "cix,stream-id"
and "cix,dp-max-rate".

Signed-off-by: Luo Liu <[email protected]>
---
 .../bindings/display/cix,sky1-dptx.yaml       | 108 ++++++++++++++++++
 MAINTAINERS                                   |   8 ++
 2 files changed, 116 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/display/cix,sky1-dptx.yaml

diff --git a/Documentation/devicetree/bindings/display/cix,sky1-dptx.yaml 
b/Documentation/devicetree/bindings/display/cix,sky1-dptx.yaml
new file mode 100644
index 000000000000..9087b5edd9f0
--- /dev/null
+++ b/Documentation/devicetree/bindings/display/cix,sky1-dptx.yaml
@@ -0,0 +1,108 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/display/cix,sky1-dptx.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: CIX Sky1 Trilinear DisplayPort Transmitter
+
+maintainers:
+  - Luo Liu <[email protected]>
+
+description:
+  DisplayPort transmitter controller based on the Trilinear DP IP on CIX Sky1.
+
+properties:
+  compatible:
+    const: cix,sky1-dptx
+
+  reg:
+    items:
+      - description: DisplayPort transmitter registers.
+      - description: RCSU video adapter registers used for link setup.
+
+  reg-names:
+    items:
+      - const: dp
+      - const: rcsu
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    items:
+      - description: APB clock of the controller.
+      - description: Video clock of stream 0.
+      - description: Video clock of stream 1.
+
+  clock-names:
+    items:
+      - const: apb
+      - const: vid0
+      - const: vid1
+
+  resets:
+    maxItems: 1
+    description: DisplayPort controller reset.
+
+  phys:
+    maxItems: 1
+    description: DisplayPort PHY the controller transmits through.
+
+  port:
+    $ref: /schemas/graph.yaml#/properties/port
+    description:
+      Video input from the display pipeline that drives this controller.
+
+  cix,adapter-port:
+    description:
+      RCSU video adapter port of this transmitter. Sky1 numbers its five
+      transmitters from 1 to 5. Port 3 is the native DP/eDP output.
+    $ref: /schemas/types.yaml#/definitions/uint32
+    minimum: 1
+    maximum: 5
+
+  cix,dp-max-rate:
+    description:
+      Maximum link rate the board is wired for, in units of 10 kbit/s.
+    $ref: /schemas/types.yaml#/definitions/uint32
+    enum: [162000, 270000, 540000, 810000]
+    default: 810000
+
+  cix,stream-id:
+    description:
+      Index of the video stream this controller uses. Sky1 has two streams,
+      numbered 0 and 1.
+    $ref: /schemas/types.yaml#/definitions/uint32
+    minimum: 0
+    maximum: 1
+    default: 0
+
+required:
+  - compatible
+  - reg
+  - reg-names
+  - interrupts
+  - clocks
+  - clock-names
+  - resets
+  - cix,adapter-port
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+
+    dp0: dp@14064000 {
+        compatible = "cix,sky1-dptx";
+        reg = <0x14064000 0x4000>,
+              <0x14050000 0x400>;
+        reg-names = "dp", "rcsu";
+        interrupts = <GIC_SPI 332 IRQ_TYPE_LEVEL_HIGH>;
+        clocks = <&clk 0>, <&clk 1>, <&clk 2>;
+        clock-names = "apb", "vid0", "vid1";
+        resets = <&rst 0>;
+        cix,adapter-port = <1>;
+    };
diff --git a/MAINTAINERS b/MAINTAINERS
index 93abbb315065..7d5283d83022 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -6522,6 +6522,14 @@ M:       Satish Kharat <[email protected]>
 S:     Supported
 F:     drivers/infiniband/hw/usnic/
 
+CIX SKY1 DISPLAYPORT TRANSMITTER DRIVER
+M:     Luo Liu <[email protected]>
+M:     Wuyi Shen <[email protected]>
+R:     CIX Linux Kernel Upstream Group <[email protected]>
+L:     [email protected]
+S:     Maintained
+F:     Documentation/devicetree/bindings/display/cix,sky1-dptx.yaml
+
 CLANG CONTEXT ANALYSIS
 M:     Marco Elver <[email protected]>
 R:     Bart Van Assche <[email protected]>
-- 
2.25.1

Reply via email to