xref: /freebsd/sys/contrib/device-tree/Bindings/display/ti/ti,am65x-dss.yaml (revision c66ec88fed842fbaad62c30d510644ceb7bd2d71)
1# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2# Copyright 2019 Texas Instruments Incorporated
3%YAML 1.2
4---
5$id: "http://devicetree.org/schemas/display/ti/ti,am65x-dss.yaml#"
6$schema: "http://devicetree.org/meta-schemas/core.yaml#"
7
8title: Texas Instruments AM65x Display Subsystem
9
10maintainers:
11  - Jyri Sarha <jsarha@ti.com>
12  - Tomi Valkeinen <tomi.valkeinen@ti.com>
13
14description: |
15  The AM65x TI Keystone Display SubSystem with two output ports and
16  two video planes. The first video port supports OLDI and the second
17  supports DPI format. The fist plane is full video plane with all
18  features and the second is a "lite plane" without scaling support.
19
20properties:
21  compatible:
22    const: ti,am65x-dss
23
24  reg:
25    description:
26      Addresses to each DSS memory region described in the SoC's TRM.
27    items:
28      - description: common DSS register area
29      - description: VIDL1 light video plane
30      - description: VID video plane
31      - description: OVR1 overlay manager for vp1
32      - description: OVR2 overlay manager for vp2
33      - description: VP1 video port 1
34      - description: VP2 video port 2
35
36  reg-names:
37    items:
38      - const: common
39      - const: vidl1
40      - const: vid
41      - const: ovr1
42      - const: ovr2
43      - const: vp1
44      - const: vp2
45
46  clocks:
47    items:
48      - description: fck DSS functional clock
49      - description: vp1 Video Port 1 pixel clock
50      - description: vp2 Video Port 2 pixel clock
51
52  clock-names:
53    items:
54      - const: fck
55      - const: vp1
56      - const: vp2
57
58  interrupts:
59    maxItems: 1
60
61  power-domains:
62    maxItems: 1
63    description: phandle to the associated power domain
64
65  ports:
66    type: object
67    description:
68      Ports as described in Documentation/devicetree/bindings/graph.txt
69    properties:
70      "#address-cells":
71        const: 1
72
73      "#size-cells":
74        const: 0
75
76      port@0:
77        type: object
78        description:
79          The DSS OLDI output port node form video port 1
80
81      port@1:
82        type: object
83        description:
84          The DSS DPI output port node from video port 2
85
86    required:
87      - "#address-cells"
88      - "#size-cells"
89
90  ti,am65x-oldi-io-ctrl:
91    $ref: "/schemas/types.yaml#/definitions/phandle-array"
92    maxItems: 1
93    description:
94      phandle to syscon device node mapping OLDI IO_CTRL registers.
95      The mapped range should point to OLDI_DAT0_IO_CTRL, map it and
96      following OLDI_DAT1_IO_CTRL, OLDI_DAT2_IO_CTRL, OLDI_DAT3_IO_CTRL,
97      and OLDI_CLK_IO_CTRL registers. This property is needed for OLDI
98      interface to work.
99
100  max-memory-bandwidth:
101    $ref: /schemas/types.yaml#/definitions/uint32
102    description:
103      Input memory (from main memory to dispc) bandwidth limit in
104      bytes per second
105
106required:
107  - compatible
108  - reg
109  - reg-names
110  - clocks
111  - clock-names
112  - interrupts
113  - ports
114
115additionalProperties: false
116
117examples:
118  - |
119    #include <dt-bindings/interrupt-controller/arm-gic.h>
120    #include <dt-bindings/interrupt-controller/irq.h>
121    #include <dt-bindings/soc/ti,sci_pm_domain.h>
122
123    dss: dss@4a00000 {
124            compatible = "ti,am65x-dss";
125            reg =   <0x04a00000 0x1000>, /* common */
126                    <0x04a02000 0x1000>, /* vidl1 */
127                    <0x04a06000 0x1000>, /* vid */
128                    <0x04a07000 0x1000>, /* ovr1 */
129                    <0x04a08000 0x1000>, /* ovr2 */
130                    <0x04a0a000 0x1000>, /* vp1 */
131                    <0x04a0b000 0x1000>; /* vp2 */
132            reg-names = "common", "vidl1", "vid",
133                    "ovr1", "ovr2", "vp1", "vp2";
134            ti,am65x-oldi-io-ctrl = <&dss_oldi_io_ctrl>;
135            power-domains = <&k3_pds 67 TI_SCI_PD_EXCLUSIVE>;
136            clocks =        <&k3_clks 67 1>,
137                            <&k3_clks 216 1>,
138                            <&k3_clks 67 2>;
139            clock-names = "fck", "vp1", "vp2";
140            interrupts = <GIC_SPI 166 IRQ_TYPE_EDGE_RISING>;
141            ports {
142                    #address-cells = <1>;
143                    #size-cells = <0>;
144                    port@0 {
145                            reg = <0>;
146                            oldi_out0: endpoint {
147                                    remote-endpoint = <&lcd_in0>;
148                            };
149                    };
150            };
151    };
152