R: [PATCH 2/2] devicetree: bindings: phy: Document dwc3 qcom phy

[ansuelsmth]

> On Fri, Apr 03, 2020 at 02:26:05AM +0200, Ansuel Smith wrote:
> > Document dwc3 qcom phy hs and ss phy bindings needed to correctly
> > inizialize and use usb on ipq806x SoC
> >
> > Signed-off-by: Ansuel Smith <ansuelsmth@xxxxxxxxx>
> > ---
> >  .../bindings/phy/qcom,dwc3-hs-usb-phy.yaml    | 65
> +++++++++++++++++++
> >  .../bindings/phy/qcom,dwc3-ss-usb-phy.yaml    | 65
> +++++++++++++++++++
> >  2 files changed, 130 insertions(+)
> >  create mode 100644
> Documentation/devicetree/bindings/phy/qcom,dwc3-hs-usb-phy.yaml
> >  create mode 100644
> Documentation/devicetree/bindings/phy/qcom,dwc3-ss-usb-phy.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/phy/qcom,dwc3-hs-usb-
> phy.yaml b/Documentation/devicetree/bindings/phy/qcom,dwc3-hs-usb-
> phy.yaml
> > new file mode 100644
> > index 000000000000..0bb59e3c2ab8
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/phy/qcom,dwc3-hs-usb-
> phy.yaml
> > @@ -0,0 +1,65 @@
> > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/phy/qcom,dwc3-hs-usb-phy.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Qualcomm DWC3 HS PHY CONTROLLER
> > +
> > +maintainers:
> > +  - Ansuel Smith <ansuelsmth@xxxxxxxxx>
> > +
> > +description:
> > +  DWC3 PHY nodes are defined to describe on-chip Synopsis Physical
> layer
> > +  controllers. Each DWC3 PHY controller should have its own node.
> > +
> > +properties:
> > +  compatible:
> > +    const: qcom,dwc3-hs-usb-phy
> > +
> > +  "#phy-cells":
> > +    const: 0
> > +
> > +  regmap:
> > +    maxItems: 1
> > +    description: phandle to usb3 dts definition
> > +
> > +  clocks:
> > +    minItems: 1
> > +    maxItems: 2
> > +
> > +  clock-names:
> > +    minItems: 1
> > +    maxItems: 2
> > +    description: |
> > +      - "ref" Is required
> > +      - "xo"	Optional external reference clock
> > +    items:
> > +      - const: ref
> > +      - const: xo
> > +
> > +required:
> > +  - compatible
> > +  - "#phy-cells"
> > +  - regmap
> > +  - clocks
> > +  - clock-names
> > +
> > +examples:
> > +  - |
> > +    #include <dt-bindings/clock/qcom,gcc-ipq806x.h>
> > +
> > +    hs_phy_0: hs_phy_0 {
> > +      compatible = "qcom,dwc3-hs-usb-phy";
> > +      regmap = <&usb3_0>;
> 
> If the registers for the phy are part of 'qcom,dwc3' then make this node
> a child of it.
> 

Making this node a child of qcom,dwc3 cause malfunction of the driver.

> > +      clocks = <&gcc USB30_0_UTMI_CLK>;
> > +      clock-names = "ref";
> > +      #phy-cells = <0>;
> > +    };
> > +
> > +    usb3_0: usb3@110f8800 {
> > +      compatible = "qcom,dwc3", "syscon";
> > +      reg = <0x110f8800 0x8000>;
> > +
> > +      /* ... */
> 
> Incomplete examples should or will fail validation.
> 
> > +    };