Documentation/devicetree/bindings/display/ti/ti,am65x-dss.yaml

   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
   8 title: Texas Instruments AM65x Display Subsystem
   9
  10 maintainers:
  11   - Jyri Sarha <jsarha@ti.com>
  12   - Tomi Valkeinen <tomi.valkeinen@ti.com>
  13
  14 description: |
  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
  20 properties:
  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   assigned-clocks:
  59     minItems: 1
  60     maxItems: 3
  61
  62   assigned-clock-parents:
  63     minItems: 1
  64     maxItems: 3
  65
  66   interrupts:
  67     maxItems: 1
  68
  69   power-domains:
  70     maxItems: 1
  71     description: phandle to the associated power domain
  72
  73   dma-coherent:
  74     type: boolean
  75
  76   ports:
  77     type: object
  78     description:
  79       Ports as described in Documentation/devicetree/bindings/graph.txt
  80     properties:
  81       "#address-cells":
  82         const: 1
  83
  84       "#size-cells":
  85         const: 0
  86
  87       port@0:
  88         type: object
  89         description:
  90           The DSS OLDI output port node form video port 1
  91
  92       port@1:
  93         type: object
  94         description:
  95           The DSS DPI output port node from video port 2
  96
  97     required:
  98       - "#address-cells"
  99       - "#size-cells"
 100
 101   ti,am65x-oldi-io-ctrl:
 102     $ref: "/schemas/types.yaml#/definitions/phandle-array"
 103     maxItems: 1
 104     description:
 105       phandle to syscon device node mapping OLDI IO_CTRL registers.
 106       The mapped range should point to OLDI_DAT0_IO_CTRL, map it and
 107       following OLDI_DAT1_IO_CTRL, OLDI_DAT2_IO_CTRL, OLDI_DAT3_IO_CTRL,
 108       and OLDI_CLK_IO_CTRL registers. This property is needed for OLDI
 109       interface to work.
 110
 111   max-memory-bandwidth:
 112     $ref: /schemas/types.yaml#/definitions/uint32
 113     description:
 114       Input memory (from main memory to dispc) bandwidth limit in
 115       bytes per second
 116
 117 required:
 118   - compatible
 119   - reg
 120   - reg-names
 121   - clocks
 122   - clock-names
 123   - interrupts
 124   - ports
 125
 126 additionalProperties: false
 127
 128 examples:
 129   - |
 130     #include <dt-bindings/interrupt-controller/arm-gic.h>
 131     #include <dt-bindings/interrupt-controller/irq.h>
 132     #include <dt-bindings/soc/ti,sci_pm_domain.h>
 133
 134     dss: dss@4a00000 {
 135             compatible = "ti,am65x-dss";
 136             reg =   <0x04a00000 0x1000>, /* common */
 137                     <0x04a02000 0x1000>, /* vidl1 */
 138                     <0x04a06000 0x1000>, /* vid */
 139                     <0x04a07000 0x1000>, /* ovr1 */
 140                     <0x04a08000 0x1000>, /* ovr2 */
 141                     <0x04a0a000 0x1000>, /* vp1 */
 142                     <0x04a0b000 0x1000>; /* vp2 */
 143             reg-names = "common", "vidl1", "vid",
 144                     "ovr1", "ovr2", "vp1", "vp2";
 145             ti,am65x-oldi-io-ctrl = <&dss_oldi_io_ctrl>;
 146             power-domains = <&k3_pds 67 TI_SCI_PD_EXCLUSIVE>;
 147             clocks =        <&k3_clks 67 1>,
 148                             <&k3_clks 216 1>,
 149                             <&k3_clks 67 2>;
 150             clock-names = "fck", "vp1", "vp2";
 151             interrupts = <GIC_SPI 166 IRQ_TYPE_EDGE_RISING>;
 152             ports {
 153                     #address-cells = <1>;
 154                     #size-cells = <0>;
 155                     port@0 {
 156                             reg = <0>;
 157                             oldi_out0: endpoint {
 158                                     remote-endpoint = <&lcd_in0>;
 159                             };
 160                     };
 161             };
 162     };