Documentation/devicetree/bindings/media/rockchip,rk3568-vicap.yaml

# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/media/rockchip,rk3568-vicap.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Rockchip RK3568 Video Capture (VICAP)

maintainers:
  - Michael Riesch <michael.riesch@collabora.com>

description:
  The Rockchip RK3568 Video Capture (VICAP) block features a digital video
  port (DVP, a parallel video interface) and a MIPI CSI-2 port. It receives
  the data from camera sensors, video decoders, or other companion ICs and
  transfers it into system main memory by AXI bus.

properties:
  compatible:
    const: rockchip,rk3568-vicap

  reg:
    maxItems: 1

  interrupts:
    maxItems: 1

  clocks:
    items:
      - description: ACLK
      - description: HCLK
      - description: DCLK
      - description: ICLK

  clock-names:
    items:
      - const: aclk
      - const: hclk
      - const: dclk
      - const: iclk

  iommus:
    maxItems: 1

  resets:
    items:
      - description: ARST
      - description: HRST
      - description: DRST
      - description: PRST
      - description: IRST

  reset-names:
    items:
      - const: arst
      - const: hrst
      - const: drst
      - const: prst
      - const: irst

  rockchip,grf:
    $ref: /schemas/types.yaml#/definitions/phandle
    description: Phandle to general register file used for video input block control.

  power-domains:
    maxItems: 1

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

    properties:
      port@0:
        $ref: /schemas/graph.yaml#/$defs/port-base
        unevaluatedProperties: false
        description: The digital video port (DVP, a parallel video interface).

        properties:
          endpoint:
            $ref: video-interfaces.yaml#
            unevaluatedProperties: false

            properties:
              bus-type:
                enum:
                  - 5 # MEDIA_BUS_TYPE_PARALLEL
                  - 6 # MEDIA_BUS_TYPE_BT656

              rockchip,dvp-clk-delay:
                $ref: /schemas/types.yaml#/definitions/uint32
                default: 0
                minimum: 0
                maximum: 127
                description:
                  Delay the DVP path clock input to align the sampling phase,
                  only valid in dual edge sampling mode. Delay is zero by
                  default and can be adjusted optionally.

            required:
              - bus-type

      port@1:
        $ref: /schemas/graph.yaml#/properties/port
        description: Port connected to the MIPI CSI-2 receiver output.

        properties:
          endpoint:
            $ref: video-interfaces.yaml#
            unevaluatedProperties: false

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

additionalProperties: false

examples:
  - |
    #include <dt-bindings/clock/rk3568-cru.h>
    #include <dt-bindings/interrupt-controller/arm-gic.h>
    #include <dt-bindings/interrupt-controller/irq.h>
    #include <dt-bindings/power/rk3568-power.h>
    #include <dt-bindings/media/video-interfaces.h>

    soc {
        #address-cells = <2>;
        #size-cells = <2>;

        vicap: video-capture@fdfe0000 {
            compatible = "rockchip,rk3568-vicap";
            reg = <0x0 0xfdfe0000 0x0 0x200>;
            interrupts = <GIC_SPI 146 IRQ_TYPE_LEVEL_HIGH>;
            assigned-clocks = <&cru DCLK_VICAP>;
            assigned-clock-rates = <300000000>;
            clocks = <&cru ACLK_VICAP>, <&cru HCLK_VICAP>,
                     <&cru DCLK_VICAP>, <&cru ICLK_VICAP_G>;
            clock-names = "aclk", "hclk", "dclk", "iclk";
            iommus = <&vicap_mmu>;
            power-domains = <&power RK3568_PD_VI>;
            resets = <&cru SRST_A_VICAP>, <&cru SRST_H_VICAP>,
                     <&cru SRST_D_VICAP>, <&cru SRST_P_VICAP>,
                     <&cru SRST_I_VICAP>;
            reset-names = "arst", "hrst", "drst", "prst", "irst";
            rockchip,grf = <&grf>;

            ports {
                #address-cells = <1>;
                #size-cells = <0>;

                vicap_dvp: port@0 {
                    reg = <0>;

                    vicap_dvp_input: endpoint {
                        bus-type = <MEDIA_BUS_TYPE_BT656>;
                        bus-width = <16>;
                        pclk-sample = <MEDIA_PCLK_SAMPLE_DUAL_EDGE>;
                        remote-endpoint = <&it6801_output>;
                    };
                };

                vicap_mipi: port@1 {
                    reg = <1>;

                    vicap_mipi_input: endpoint {
                        remote-endpoint = <&csi_output>;
                    };
                };
            };
        };
    };