xref: /freebsd/sys/contrib/device-tree/Bindings/usb/rockchip,rk3399-dwc3.yaml (revision cb7aa33a)

# SPDX-License-Identifier: GPL-2.0
%YAML 1.2
---
$id: http://devicetree.org/schemas/usb/rockchip,rk3399-dwc3.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Rockchip RK3399 SuperSpeed DWC3 USB SoC controller

maintainers:
  - Heiko Stuebner <heiko@sntech.de>

properties:
  compatible:
    const: rockchip,rk3399-dwc3

  '#address-cells':
    const: 2

  '#size-cells':
    const: 2

  ranges: true

  clocks:
    items:
      - description:
          Controller reference clock, must to be 24 MHz
      - description:
          Controller suspend clock, must to be 24 MHz or 32 KHz
      - description:
          Master/Core clock, must to be >= 62.5 MHz for SS
          operation and >= 30MHz for HS operation
      - description:
          USB3 aclk peri
      - description:
          USB3 aclk
      - description:
          Controller grf clock

  clock-names:
    items:
      - const: ref_clk
      - const: suspend_clk
      - const: bus_clk
      - const: aclk_usb3_rksoc_axi_perf
      - const: aclk_usb3
      - const: grf_clk

  resets:
    maxItems: 1

  reset-names:
    const: usb3-otg

patternProperties:
  '^usb@':
    $ref: snps,dwc3.yaml#

additionalProperties: false

required:
  - compatible
  - '#address-cells'
  - '#size-cells'
  - ranges
  - clocks
  - clock-names
  - resets
  - reset-names

examples:
  - |
    #include <dt-bindings/clock/rk3399-cru.h>
    #include <dt-bindings/power/rk3399-power.h>
    #include <dt-bindings/interrupt-controller/arm-gic.h>

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

        usb {
            compatible = "rockchip,rk3399-dwc3";
            #address-cells = <2>;
            #size-cells = <2>;
            ranges;
            clocks = <&cru SCLK_USB3OTG0_REF>, <&cru SCLK_USB3OTG0_SUSPEND>,
                     <&cru ACLK_USB3OTG0>, <&cru ACLK_USB3_RKSOC_AXI_PERF>,
                     <&cru ACLK_USB3>, <&cru ACLK_USB3_GRF>;
            clock-names = "ref_clk", "suspend_clk",
                          "bus_clk", "aclk_usb3_rksoc_axi_perf",
                          "aclk_usb3", "grf_clk";
            resets = <&cru SRST_A_USB3_OTG0>;
            reset-names = "usb3-otg";

            usb@fe800000 {
                compatible = "snps,dwc3";
                reg = <0x0 0xfe800000 0x0 0x100000>;
                interrupts = <GIC_SPI 105 IRQ_TYPE_LEVEL_HIGH 0>;
                clocks = <&cru SCLK_USB3OTG0_REF>, <&cru ACLK_USB3OTG0>,
                         <&cru SCLK_USB3OTG0_SUSPEND>;
                clock-names = "ref", "bus_early", "suspend";
                dr_mode = "otg";
                phys = <&u2phy0_otg>, <&tcphy0_usb3>;
                phy-names = "usb2-phy", "usb3-phy";
                phy_type = "utmi_wide";
                snps,dis_enblslpm_quirk;
                snps,dis-u2-freeclk-exists-quirk;
                snps,dis_u2_susphy_quirk;
                snps,dis-del-phy-power-chg-quirk;
                snps,dis-tx-ipgap-linecheck-quirk;
                power-domains = <&power RK3399_PD_USB3>;
            };
        };
    };
...