path: root/Documentation/devicetree/bindings/display/rockchip/rockchip-vop2.yaml

# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
%YAML 1.2
---
$id: http://devicetree.org/schemas/display/rockchip/rockchip-vop2.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Rockchip SoC display controller (VOP2)

description:
  VOP2 (Video Output Processor v2) is the display controller for the Rockchip
  series of SoCs which transfers the image data from a video memory buffer to
  an external LCD interface.

maintainers:
  - Sandy Huang <hjc@rock-chips.com>
  - Heiko Stuebner <heiko@sntech.de>
  - Andy Yan <andyshrk@163.com>

properties:
  compatible:
    enum:
      - rockchip,rk3566-vop
      - rockchip,rk3568-vop
      - rockchip,rk3576-vop
      - rockchip,rk3588-vop

  reg:
    items:
      - description:
          Must contain one entry corresponding to the base address and length
          of the register space.
      - description:
          Can optionally contain a second entry corresponding to the CRTC gamma
          LUT address.

  reg-names:
    items:
      - const: vop
      - const: gamma-lut

  interrupts:
    minItems: 1
    maxItems: 4
    description:
      For VOP version under rk3576, the interrupt is shared by several interrupt
      sources, such as frame start (VSYNC), line flag and other interrupt status.
      For VOP version from rk3576 there is a system interrupt for bus error, and
      every video port has it's independent interrupts for vsync and other video
      port related error interrupts.

  interrupt-names:
    items:
      - const: sys
      - const: vp0
      - const: vp1
      - const: vp2

  # See compatible-specific constraints below.
  clocks:
    minItems: 5
    items:
      - description: Clock for ddr buffer transfer via axi.
      - description: Clock for the ahb bus to R/W the regs.
      - description: Pixel clock for video port 0.
      - description: Pixel clock for video port 1.
      - description: Pixel clock for video port 2.
      - {}
      - {}
      - {}
      - {}

  clock-names:
    minItems: 5
    items:
      - const: aclk
      - const: hclk
      - const: dclk_vp0
      - const: dclk_vp1
      - const: dclk_vp2
      - {}
      - {}
      - {}
      - {}

  rockchip,grf:
    $ref: /schemas/types.yaml#/definitions/phandle
    description:
      Phandle to GRF regs used for control the polarity of dclk/hsync/vsync of DPI,
      also used for query vop memory bisr enable status, etc.

  rockchip,vo1-grf:
    $ref: /schemas/types.yaml#/definitions/phandle
    description:
      Phandle to VO GRF regs used for control the polarity of dclk/hsync/vsync of hdmi
      on rk3588.

  rockchip,vop-grf:
    $ref: /schemas/types.yaml#/definitions/phandle
    description:
      Phandle to VOP GRF regs used for control data path between vopr and hdmi/edp.

  rockchip,pmu:
    $ref: /schemas/types.yaml#/definitions/phandle
    description:
      Phandle to PMU GRF used for query vop memory bisr status on rk3588.

  ports:
    $ref: /schemas/graph.yaml#/properties/ports

    patternProperties:
      "^port@[0-3]$":
        $ref: /schemas/graph.yaml#/properties/port
        description: Output endpoint of VP0/1/2/3.

    required:
      - port@0

    unevaluatedProperties: false

  iommus:
    maxItems: 1

  power-domains:
    maxItems: 1

required:
  - compatible
  - reg
  - reg-names
  - interrupts
  - clocks
  - clock-names
  - ports

allOf:
  - if:
      properties:
        compatible:
          contains:
            enum:
              - rockchip,rk3566-vop
              - rockchip,rk3568-vop
    then:
      properties:
        clocks:
          maxItems: 5

        clock-names:
          maxItems: 5

        interrupts:
          maxItems: 1

        interrupt-names: false

        ports:
          required:
            - port@0
            - port@1
            - port@2

        rockchip,vo1-grf: false
        rockchip,vop-grf: false
        rockchip,pmu: false

      required:
        - rockchip,grf

  - if:
      properties:
        compatible:
          contains:
            enum:
              - rockchip,rk3576-vop
    then:
      properties:
        clocks:
          minItems: 5
          items:
            - {}
            - {}
            - {}
            - {}
            - {}
            - description: Alternative pixel clock provided by HDMI PHY PLL.

        clock-names:
          minItems: 5
          items:
            - {}
            - {}
            - {}
            - {}
            - {}
            - const: pll_hdmiphy0

        interrupts:
          minItems: 4

        interrupt-names:
          minItems: 4

        ports:
          required:
            - port@0
            - port@1
            - port@2

        rockchip,vo1-grf: false
        rockchip,vop-grf: false

      required:
        - rockchip,grf
        - rockchip,pmu

  - if:
      properties:
        compatible:
          contains:
            const: rockchip,rk3588-vop
    then:
      properties:
        clocks:
          minItems: 7
          items:
            - {}
            - {}
            - {}
            - {}
            - {}
            - description: Pixel clock for video port 3.
            - description: Peripheral(vop grf/dsi) clock.
            - description: Alternative pixel clock provided by HDMI0 PHY PLL.
            - description: Alternative pixel clock provided by HDMI1 PHY PLL.

        clock-names:
          minItems: 7
          items:
            - {}
            - {}
            - {}
            - {}
            - {}
            - const: dclk_vp3
            - const: pclk_vop
            - const: pll_hdmiphy0
            - const: pll_hdmiphy1

        interrupts:
          maxItems: 1

        interrupt-names: false

        ports:
          required:
            - port@0
            - port@1
            - port@2
            - port@3

      required:
        - rockchip,grf
        - rockchip,vo1-grf
        - rockchip,vop-grf
        - rockchip,pmu

additionalProperties: false

examples:
  - |
        #include <dt-bindings/clock/rk3568-cru.h>
        #include <dt-bindings/interrupt-controller/arm-gic.h>
        #include <dt-bindings/power/rk3568-power.h>
        bus {
            #address-cells = <2>;
            #size-cells = <2>;
            vop: vop@fe040000 {
                compatible = "rockchip,rk3568-vop";
                reg = <0x0 0xfe040000 0x0 0x3000>, <0x0 0xfe044000 0x0 0x1000>;
                reg-names = "vop", "gamma-lut";
                interrupts = <GIC_SPI 148 IRQ_TYPE_LEVEL_HIGH>;
                clocks = <&cru ACLK_VOP>,
                         <&cru HCLK_VOP>,
                         <&cru DCLK_VOP0>,
                         <&cru DCLK_VOP1>,
                         <&cru DCLK_VOP2>;
                clock-names = "aclk",
                              "hclk",
                              "dclk_vp0",
                              "dclk_vp1",
                              "dclk_vp2";
                power-domains = <&power RK3568_PD_VO>;
                rockchip,grf = <&grf>;
                iommus = <&vop_mmu>;
                vop_out: ports {
                    #address-cells = <1>;
                    #size-cells = <0>;
                    vp0: port@0 {
                        reg = <0>;
                        #address-cells = <1>;
                        #size-cells = <0>;
                    };
                    vp1: port@1 {
                        reg = <1>;
                        #address-cells = <1>;
                        #size-cells = <0>;
                    };
                    vp2: port@2 {
                        reg = <2>;
                        #address-cells = <1>;
                        #size-cells = <0>;
                    };
                };
            };
        };