Commit 6e762f7b authored by Bjorn Andersson's avatar Bjorn Andersson Committed by Greg Kroah-Hartman
Browse files

dt-bindings: usb: Introduce qcom,snps-dwc3 



The Qualcomm USB glue is not separate of the Synopsys DWC3 core and
several of the snps,dwc3 properties (such as clocks and reset) conflicts
in expectation with the Qualcomm integration.

Using the newly split out Synopsys DWC3 core properties, describe the
Qualcomm USB block in a single block. The new binding is a copy of
qcom,dwc3 with the needed modifications.

It would have been convenient to retain the two structures with the same
compatibles, but as there exist no way to select a binding based on the
absence of a subnode/patternProperty, a new generic compatible is
introduced to describe this binding.

To avoid redefining all the platform-specific compatibles, "select" is
used to tell the DeviceTree validator which binding to use solely on the
generic compatible. (Otherwise if the specific compatible matches during
validation, the generic one must match as well)

Mark qcom,dwc3 deprecated, to favor expressing future platforms using
the new combined binding.

Reviewed-by: default avatarRob Herring (Arm) <robh@kernel.org>
Tested-by: Neil Armstrong <neil.armstrong@linaro.org> # on SM8650-QRD
Signed-off-by: default avatarBjorn Andersson <bjorn.andersson@oss.qualcomm.com>
Link: https://lore.kernel.org/r/20250414-dwc3-refactor-v7-2-f015b358722d@oss.qualcomm.com


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent b958b03c

Documentation/devicetree/bindings/usb/qcom,dwc3.yaml

+12 −1
Original line number Diff line number Diff line
@@ -4,11 +4,22 @@ 
$id: http://devicetree.org/schemas/usb/qcom,dwc3.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Qualcomm SuperSpeed DWC3 USB SoC controller

title: Legacy Qualcomm SuperSpeed DWC3 USB SoC controller



maintainers:

  - Wesley Cheng <quic_wcheng@quicinc.com>



# Use the combined qcom,snps-dwc3 instead

deprecated: true



select:

  properties:

    compatible:

      contains:

        const: qcom,dwc3

  required:

    - compatible



properties:

  compatible:

    items:

Documentation/devicetree/bindings/usb/qcom,snps-dwc3.yaml

0 → 100644
+622 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)

%YAML 1.2

---

$id: http://devicetree.org/schemas/usb/qcom,snps-dwc3.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Qualcomm SuperSpeed DWC3 USB SoC controller



maintainers:

  - Wesley Cheng <quic_wcheng@quicinc.com>



description:

  Describes the Qualcomm USB block, based on Synopsys DWC3.



select:

  properties:

    compatible:

      contains:

        const: qcom,snps-dwc3

  required:

    - compatible



properties:

  compatible:

    items:

      - enum:

          - qcom,ipq4019-dwc3

          - qcom,ipq5018-dwc3

          - qcom,ipq5332-dwc3

          - qcom,ipq5424-dwc3

          - qcom,ipq6018-dwc3

          - qcom,ipq8064-dwc3

          - qcom,ipq8074-dwc3

          - qcom,ipq9574-dwc3

          - qcom,msm8953-dwc3

          - qcom,msm8994-dwc3

          - qcom,msm8996-dwc3

          - qcom,msm8998-dwc3

          - qcom,qcm2290-dwc3

          - qcom,qcs404-dwc3

          - qcom,qcs615-dwc3

          - qcom,qcs8300-dwc3

          - qcom,qdu1000-dwc3

          - qcom,sa8775p-dwc3

          - qcom,sar2130p-dwc3

          - qcom,sc7180-dwc3

          - qcom,sc7280-dwc3

          - qcom,sc8180x-dwc3

          - qcom,sc8180x-dwc3-mp

          - qcom,sc8280xp-dwc3

          - qcom,sc8280xp-dwc3-mp

          - qcom,sdm660-dwc3

          - qcom,sdm670-dwc3

          - qcom,sdm845-dwc3

          - qcom,sdx55-dwc3

          - qcom,sdx65-dwc3

          - qcom,sdx75-dwc3

          - qcom,sm4250-dwc3

          - qcom,sm6115-dwc3

          - qcom,sm6125-dwc3

          - qcom,sm6350-dwc3

          - qcom,sm6375-dwc3

          - qcom,sm8150-dwc3

          - qcom,sm8250-dwc3

          - qcom,sm8350-dwc3

          - qcom,sm8450-dwc3

          - qcom,sm8550-dwc3

          - qcom,sm8650-dwc3

          - qcom,x1e80100-dwc3

      - const: qcom,snps-dwc3



  reg:

    maxItems: 1



  power-domains:

    maxItems: 1



  required-opps:

    maxItems: 1



  clocks:

    description: |

      Several clocks are used, depending on the variant. Typical ones are::

       - cfg_noc:: System Config NOC clock.

       - core:: Master/Core clock, has to be >= 125 MHz for SS operation and >=

                60MHz for HS operation.

       - iface:: System bus AXI clock.

       - sleep:: Sleep clock, used for wakeup when USB3 core goes into low

                 power mode (U3).

       - mock_utmi:: Mock utmi clock needed for ITP/SOF generation in host

                     mode. Its frequency should be 19.2MHz.

    minItems: 1

    maxItems: 9



  clock-names:

    minItems: 1

    maxItems: 9



  dma-coherent: true



  iommus:

    maxItems: 1



  resets:

    maxItems: 1



  interconnects:

    maxItems: 2



  interconnect-names:

    items:

      - const: usb-ddr

      - const: apps-usb



  interrupts:

    description: |

      Different types of interrupts are used based on HS PHY used on target:

        - dwc_usb3: Core DWC3 interrupt

        - pwr_event: Used for wakeup based on other power events.

        - hs_phy_irq: Apart from DP/DM/QUSB2 PHY interrupts, there is

                       hs_phy_irq which is not triggered by default and its

                       functionality is mutually exclusive to that of

                       {dp/dm}_hs_phy_irq and qusb2_phy_irq.

        - qusb2_phy: SoCs with QUSB2 PHY do not have separate DP/DM IRQs and

                      expose only a single IRQ whose behavior can be modified

                      by the QUSB2PHY_INTR_CTRL register. The required DPSE/

                      DMSE configuration is done in QUSB2PHY_INTR_CTRL register

                      of PHY address space.

        - {dp/dm}_hs_phy_irq: These IRQ's directly reflect changes on the DP/

                               DM pads of the SoC. These are used for wakeup

                               only on SoCs with non-QUSB2 targets with

                               exception of SDM670/SDM845/SM6350.

        - ss_phy_irq: Used for remote wakeup in Super Speed mode of operation.

    minItems: 3

    maxItems: 19



  interrupt-names:

    minItems: 3

    maxItems: 19



  qcom,select-utmi-as-pipe-clk:

    description:

      If present, disable USB3 pipe_clk requirement.

      Used when dwc3 operates without SSPHY and only

      HS/FS/LS modes are supported.

    type: boolean



  wakeup-source: true



# Required child node:



required:

  - compatible

  - reg

  - clocks

  - clock-names

  - interrupts

  - interrupt-names



allOf:

  - $ref: snps,dwc3-common.yaml#

  - if:

      properties:

        compatible:

          contains:

            enum:

              - qcom,ipq4019-dwc3

              - qcom,ipq5332-dwc3

    then:

      properties:

        clocks:

          maxItems: 3

        clock-names:

          items:

            - const: core

            - const: sleep

            - const: mock_utmi



  - if:

      properties:

        compatible:

          contains:

            enum:

              - qcom,ipq8064-dwc3

    then:

      properties:

        clocks:

          items:

            - description: Master/Core clock, has to be >= 125 MHz

                for SS operation and >= 60MHz for HS operation.

        clock-names:

          items:

            - const: core



  - if:

      properties:

        compatible:

          contains:

            enum:

              - qcom,ipq9574-dwc3

              - qcom,msm8953-dwc3

              - qcom,msm8996-dwc3

              - qcom,msm8998-dwc3

              - qcom,qcs8300-dwc3

              - qcom,sa8775p-dwc3

              - qcom,sc7180-dwc3

              - qcom,sc7280-dwc3

              - qcom,sdm670-dwc3

              - qcom,sdm845-dwc3

              - qcom,sdx55-dwc3

              - qcom,sdx65-dwc3

              - qcom,sdx75-dwc3

              - qcom,sm6350-dwc3

    then:

      properties:

        clocks:

          maxItems: 5

        clock-names:

          items:

            - const: cfg_noc

            - const: core

            - const: iface

            - const: sleep

            - const: mock_utmi



  - if:

      properties:

        compatible:

          contains:

            enum:

              - qcom,ipq6018-dwc3

    then:

      properties:

        clocks:

          minItems: 3

          maxItems: 4

        clock-names:

          oneOf:

            - items:

                - const: core

                - const: sleep

                - const: mock_utmi

            - items:

                - const: cfg_noc

                - const: core

                - const: sleep

                - const: mock_utmi



  - if:

      properties:

        compatible:

          contains:

            enum:

              - qcom,ipq8074-dwc3

              - qcom,qdu1000-dwc3

    then:

      properties:

        clocks:

          maxItems: 4

        clock-names:

          items:

            - const: cfg_noc

            - const: core

            - const: sleep

            - const: mock_utmi



  - if:

      properties:

        compatible:

          contains:

            enum:

              - qcom,ipq5018-dwc3

              - qcom,msm8994-dwc3

              - qcom,qcs404-dwc3

    then:

      properties:

        clocks:

          maxItems: 4

        clock-names:

          items:

            - const: core

            - const: iface

            - const: sleep

            - const: mock_utmi



  - if:

      properties:

        compatible:

          contains:

            enum:

              - qcom,sc8280xp-dwc3

              - qcom,sc8280xp-dwc3-mp

              - qcom,x1e80100-dwc3

              - qcom,x1e80100-dwc3-mp

    then:

      properties:

        clocks:

          maxItems: 9

        clock-names:

          items:

            - const: cfg_noc

            - const: core

            - const: iface

            - const: sleep

            - const: mock_utmi

            - const: noc_aggr

            - const: noc_aggr_north

            - const: noc_aggr_south

            - const: noc_sys



  - if:

      properties:

        compatible:

          contains:

            enum:

              - qcom,sdm660-dwc3

    then:

      properties:

        clocks:

          minItems: 4

          maxItems: 5

        clock-names:

          oneOf:

            - items:

                - const: cfg_noc

                - const: core

                - const: iface

                - const: sleep

                - const: mock_utmi

            - items:

                - const: cfg_noc

                - const: core

                - const: sleep

                - const: mock_utmi



  - if:

      properties:

        compatible:

          contains:

            enum:

              - qcom,qcm2290-dwc3

              - qcom,qcs615-dwc3

              - qcom,sar2130p-dwc3

              - qcom,sc8180x-dwc3

              - qcom,sc8180x-dwc3-mp

              - qcom,sm6115-dwc3

              - qcom,sm6125-dwc3

              - qcom,sm8150-dwc3

              - qcom,sm8250-dwc3

              - qcom,sm8450-dwc3

              - qcom,sm8550-dwc3

              - qcom,sm8650-dwc3

    then:

      properties:

        clocks:

          minItems: 6

        clock-names:

          items:

            - const: cfg_noc

            - const: core

            - const: iface

            - const: sleep

            - const: mock_utmi

            - const: xo



  - if:

      properties:

        compatible:

          contains:

            enum:

              - qcom,sm8350-dwc3

    then:

      properties:

        clocks:

          minItems: 5

          maxItems: 6

        clock-names:

          minItems: 5

          items:

            - const: cfg_noc

            - const: core

            - const: iface

            - const: sleep

            - const: mock_utmi

            - const: xo



  - if:

      properties:

        compatible:

          contains:

            enum:

              - qcom,ipq5018-dwc3

              - qcom,ipq6018-dwc3

              - qcom,ipq8074-dwc3

              - qcom,msm8953-dwc3

              - qcom,msm8998-dwc3

    then:

      properties:

        interrupts:

          minItems: 3

          maxItems: 4

        interrupt-names:

          minItems: 3

          items:

            - const: dwc_usb3

            - const: pwr_event

            - const: qusb2_phy

            - const: ss_phy_irq



  - if:

      properties:

        compatible:

          contains:

            enum:

              - qcom,msm8996-dwc3

              - qcom,qcs404-dwc3

              - qcom,sdm660-dwc3

              - qcom,sm6115-dwc3

              - qcom,sm6125-dwc3

    then:

      properties:

        interrupts:

          minItems: 4

          maxItems: 5

        interrupt-names:

          minItems: 4

          items:

            - const: dwc_usb3

            - const: pwr_event

            - const: qusb2_phy

            - const: hs_phy_irq

            - const: ss_phy_irq



  - if:

      properties:

        compatible:

          contains:

            enum:

              - qcom,ipq5332-dwc3

    then:

      properties:

        interrupts:

          maxItems: 4

        interrupt-names:

          items:

            - const: dwc_usb3

            - const: pwr_event

            - const: dp_hs_phy_irq

            - const: dm_hs_phy_irq



  - if:

      properties:

        compatible:

          contains:

            enum:

              - qcom,x1e80100-dwc3

    then:

      properties:

        interrupts:

          maxItems: 5

        interrupt-names:

          items:

            - const: dwc_usb3

            - const: pwr_event

            - const: dp_hs_phy_irq

            - const: dm_hs_phy_irq

            - const: ss_phy_irq



  - if:

      properties:

        compatible:

          contains:

            enum:

              - qcom,ipq4019-dwc3

              - qcom,ipq8064-dwc3

              - qcom,msm8994-dwc3

              - qcom,qcs615-dwc3

              - qcom,qcs8300-dwc3

              - qcom,qdu1000-dwc3

              - qcom,sa8775p-dwc3

              - qcom,sc7180-dwc3

              - qcom,sc7280-dwc3

              - qcom,sc8180x-dwc3

              - qcom,sc8280xp-dwc3

              - qcom,sdm670-dwc3

              - qcom,sdm845-dwc3

              - qcom,sdx55-dwc3

              - qcom,sdx65-dwc3

              - qcom,sdx75-dwc3

              - qcom,sm4250-dwc3

              - qcom,sm6350-dwc3

              - qcom,sm8150-dwc3

              - qcom,sm8250-dwc3

              - qcom,sm8350-dwc3

              - qcom,sm8450-dwc3

              - qcom,sm8550-dwc3

              - qcom,sm8650-dwc3

    then:

      properties:

        interrupts:

          minItems: 5

          maxItems: 6

        interrupt-names:

          minItems: 5

          items:

            - const: dwc_usb3

            - const: pwr_event

            - const: hs_phy_irq

            - const: dp_hs_phy_irq

            - const: dm_hs_phy_irq

            - const: ss_phy_irq



  - if:

      properties:

        compatible:

          contains:

            enum:

              - qcom,sc8180x-dwc3-mp

              - qcom,x1e80100-dwc3-mp

    then:

      properties:

        interrupts:

          minItems: 11

          maxItems: 11

        interrupt-names:

          items:

            - const: dwc_usb3

            - const: pwr_event_1

            - const: pwr_event_2

            - const: hs_phy_1

            - const: hs_phy_2

            - const: dp_hs_phy_1

            - const: dm_hs_phy_1

            - const: dp_hs_phy_2

            - const: dm_hs_phy_2

            - const: ss_phy_1

            - const: ss_phy_2



  - if:

      properties:

        compatible:

          contains:

            enum:

              - qcom,sc8280xp-dwc3-mp

    then:

      properties:

        interrupts:

          minItems: 19

          maxItems: 19

        interrupt-names:

          items:

            - const: dwc_usb3

            - const: pwr_event_1

            - const: pwr_event_2

            - const: pwr_event_3

            - const: pwr_event_4

            - const: hs_phy_1

            - const: hs_phy_2

            - const: hs_phy_3

            - const: hs_phy_4

            - const: dp_hs_phy_1

            - const: dm_hs_phy_1

            - const: dp_hs_phy_2

            - const: dm_hs_phy_2

            - const: dp_hs_phy_3

            - const: dm_hs_phy_3

            - const: dp_hs_phy_4

            - const: dm_hs_phy_4

            - const: ss_phy_1

            - const: ss_phy_2



unevaluatedProperties: false



examples:

  - |

    #include <dt-bindings/clock/qcom,gcc-sdm845.h>

    #include <dt-bindings/interrupt-controller/arm-gic.h>

    #include <dt-bindings/interrupt-controller/irq.h>

    soc {

        #address-cells = <2>;

        #size-cells = <2>;



        usb@a600000 {

            compatible = "qcom,sdm845-dwc3", "qcom,snps-dwc3";

            reg = <0 0x0a600000 0 0x100000>;



            clocks = <&gcc GCC_CFG_NOC_USB3_PRIM_AXI_CLK>,

                     <&gcc GCC_USB30_PRIM_MASTER_CLK>,

                     <&gcc GCC_AGGRE_USB3_PRIM_AXI_CLK>,

                     <&gcc GCC_USB30_PRIM_SLEEP_CLK>,

                     <&gcc GCC_USB30_PRIM_MOCK_UTMI_CLK>;

            clock-names = "cfg_noc",

                          "core",

                          "iface",

                          "sleep",

                          "mock_utmi";



            assigned-clocks = <&gcc GCC_USB30_PRIM_MOCK_UTMI_CLK>,

                          <&gcc GCC_USB30_PRIM_MASTER_CLK>;

            assigned-clock-rates = <19200000>, <150000000>;



            interrupts = <GIC_SPI 133 IRQ_TYPE_LEVEL_HIGH>,

                         <GIC_SPI 130 IRQ_TYPE_LEVEL_HIGH>,

                         <GIC_SPI 131 IRQ_TYPE_LEVEL_HIGH>,

                         <GIC_SPI 489 IRQ_TYPE_EDGE_BOTH>,

                         <GIC_SPI 488 IRQ_TYPE_EDGE_BOTH>,

                         <GIC_SPI 486 IRQ_TYPE_LEVEL_HIGH>;

            interrupt-names = "dwc_usb3", "pwr_event", "hs_phy_irq",

                          "dp_hs_phy_irq", "dm_hs_phy_irq", "ss_phy_irq";



            power-domains = <&gcc USB30_PRIM_GDSC>;



            resets = <&gcc GCC_USB30_PRIM_BCR>;



            iommus = <&apps_smmu 0x740 0>;

            snps,dis_u2_susphy_quirk;

            snps,dis_enblslpm_quirk;

            phys = <&usb_1_hsphy>, <&usb_1_ssphy>;

            phy-names = "usb2-phy", "usb3-phy";

        };

    };

...