| Message ID | 20200103152824.47383-1-maxime@cerno.tech (mailing list archive) |
|---|---|
| State | Mainlined |
| Commit | b66d1ac82918cb5860e684153706058b3330df00 |
| Headers | show |
| Series | [v2] dt-bindings: usb: Convert Allwinner A80 USB PHY controller to a schema | expand |
On Fri, Jan 03, 2020 at 04:28:24PM +0100, Maxime Ripard wrote: > The Allwinner A80 SoCs have a USB PHY controller that is used by Linux, > with a matching Device Tree binding. > > Now that we have the DT validation in place, let's convert the device tree > bindings for that controller over to a YAML schemas. > > Reviewed-by: Chen-Yu Tsai <wens@csie.org> > Signed-off-by: Maxime Ripard <maxime@cerno.tech> > > --- > > Changes from v1: > - Added r-b tag from chen-yu > --- > .../phy/allwinner,sun9i-a80-usb-phy.yaml | 135 ++++++++++++++++++ > .../devicetree/bindings/phy/sun9i-usb-phy.txt | 37 ----- > 2 files changed, 135 insertions(+), 37 deletions(-) > create mode 100644 Documentation/devicetree/bindings/phy/allwinner,sun9i-a80-usb-phy.yaml > delete mode 100644 Documentation/devicetree/bindings/phy/sun9i-usb-phy.txt > > diff --git a/Documentation/devicetree/bindings/phy/allwinner,sun9i-a80-usb-phy.yaml b/Documentation/devicetree/bindings/phy/allwinner,sun9i-a80-usb-phy.yaml > new file mode 100644 > index 000000000000..ded7d6f0a119 > --- /dev/null > +++ b/Documentation/devicetree/bindings/phy/allwinner,sun9i-a80-usb-phy.yaml > @@ -0,0 +1,135 @@ > +# SPDX-License-Identifier: GPL-2.0 > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/phy/allwinner,sun9i-a80-usb-phy.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Allwinner A80 USB PHY Device Tree Bindings > + > +maintainers: > + - Chen-Yu Tsai <wens@csie.org> > + - Maxime Ripard <mripard@kernel.org> > + > +properties: > + "#phy-cells": > + const: 0 > + > + compatible: > + const: allwinner,sun9i-a80-usb-phy > + > + reg: > + maxItems: 1 > + > + clocks: > + anyOf: > + - description: Main PHY Clock > + > + - items: > + - description: Main PHY clock > + - description: HSIC 12MHz clock > + - description: HSIC 480MHz clock Rather than anyOf, just 'minItems: 1' would work here. Though I guess this disallows 2 items. > + > + clock-names: > + oneOf: > + - const: phy > + > + - items: > + - const: phy > + - const: hsic_12M > + - const: hsic_480M > + > + resets: > + anyOf: > + - description: Normal USB PHY reset > + > + - items: > + - description: Normal USB PHY reset > + - description: HSIC Reset > + > + reset-names: > + oneOf: > + - const: phy > + > + - items: > + - const: phy > + - const: hsic > + > + phy_type: > + const: hsic > + description: > + When absent, the PHY type will be assumed to be normal USB. > + > + phy-supply: > + description: > + Regulator that powers VBUS > + > +required: > + - "#phy-cells" > + - compatible > + - reg > + - clocks > + - clock-names > + - resets > + - reset-names > + > +additionalProperties: false > + > +if: > + properties: > + phy_type: > + const: hsic > + > + required: > + - phy_type > + > +then: > + properties: > + clocks: > + maxItems: 3 > + > + clock-names: > + maxItems: 3 > + > + resets: > + maxItems: 2 > + > + reset-names: > + maxItems: 2 Do you intend that only a single item is allowed when not HSIC? If so, that's not what is happening. Rob
Hi Rob, On Sat, Jan 04, 2020 at 03:13:21PM -0700, Rob Herring wrote: > On Fri, Jan 03, 2020 at 04:28:24PM +0100, Maxime Ripard wrote: > > The Allwinner A80 SoCs have a USB PHY controller that is used by Linux, > > with a matching Device Tree binding. > > > > Now that we have the DT validation in place, let's convert the device tree > > bindings for that controller over to a YAML schemas. > > > > Reviewed-by: Chen-Yu Tsai <wens@csie.org> > > Signed-off-by: Maxime Ripard <maxime@cerno.tech> > > > > --- > > > > Changes from v1: > > - Added r-b tag from chen-yu > > --- > > .../phy/allwinner,sun9i-a80-usb-phy.yaml | 135 ++++++++++++++++++ > > .../devicetree/bindings/phy/sun9i-usb-phy.txt | 37 ----- > > 2 files changed, 135 insertions(+), 37 deletions(-) > > create mode 100644 Documentation/devicetree/bindings/phy/allwinner,sun9i-a80-usb-phy.yaml > > delete mode 100644 Documentation/devicetree/bindings/phy/sun9i-usb-phy.txt > > > > diff --git a/Documentation/devicetree/bindings/phy/allwinner,sun9i-a80-usb-phy.yaml b/Documentation/devicetree/bindings/phy/allwinner,sun9i-a80-usb-phy.yaml > > new file mode 100644 > > index 000000000000..ded7d6f0a119 > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/phy/allwinner,sun9i-a80-usb-phy.yaml > > @@ -0,0 +1,135 @@ > > +# SPDX-License-Identifier: GPL-2.0 > > +%YAML 1.2 > > +--- > > +$id: http://devicetree.org/schemas/phy/allwinner,sun9i-a80-usb-phy.yaml# > > +$schema: http://devicetree.org/meta-schemas/core.yaml# > > + > > +title: Allwinner A80 USB PHY Device Tree Bindings > > + > > +maintainers: > > + - Chen-Yu Tsai <wens@csie.org> > > + - Maxime Ripard <mripard@kernel.org> > > + > > +properties: > > + "#phy-cells": > > + const: 0 > > + > > + compatible: > > + const: allwinner,sun9i-a80-usb-phy > > + > > + reg: > > + maxItems: 1 > > + > > + clocks: > > + anyOf: > > + - description: Main PHY Clock > > + > > + - items: > > + - description: Main PHY clock > > + - description: HSIC 12MHz clock > > + - description: HSIC 480MHz clock > > Rather than anyOf, just 'minItems: 1' would work here. Though I guess > this disallows 2 items. Yeah, 2 items is not allowed so I wanted to prevent that. > > + > > + clock-names: > > + oneOf: > > + - const: phy > > + > > + - items: > > + - const: phy > > + - const: hsic_12M > > + - const: hsic_480M > > + > > + resets: > > + anyOf: > > + - description: Normal USB PHY reset > > + > > + - items: > > + - description: Normal USB PHY reset > > + - description: HSIC Reset > > + > > + reset-names: > > + oneOf: > > + - const: phy > > + > > + - items: > > + - const: phy > > + - const: hsic > > + > > + phy_type: > > + const: hsic > > + description: > > + When absent, the PHY type will be assumed to be normal USB. > > + > > + phy-supply: > > + description: > > + Regulator that powers VBUS > > + > > +required: > > + - "#phy-cells" > > + - compatible > > + - reg > > + - clocks > > + - clock-names > > + - resets > > + - reset-names > > + > > +additionalProperties: false > > + > > +if: > > + properties: > > + phy_type: > > + const: hsic > > + > > + required: > > + - phy_type > > + > > +then: > > + properties: > > + clocks: > > + maxItems: 3 > > + > > + clock-names: > > + maxItems: 3 > > + > > + resets: > > + maxItems: 2 > > + > > + reset-names: > > + maxItems: 2 > > Do you intend that only a single item is allowed when not HSIC? If so, > that's not what is happening. That's intentional indeed, the former binding was making the hsic clocks and resets mandatory when the phy was in HSIC mode, but only recommending listing them otherwise. Maybe we can change that in the future, but that seems out of scope for a conversion. Maxime
On Mon, Jan 06, 2020 at 10:27:24AM +0100, Maxime Ripard wrote: > Hi Rob, > > On Sat, Jan 04, 2020 at 03:13:21PM -0700, Rob Herring wrote: > > On Fri, Jan 03, 2020 at 04:28:24PM +0100, Maxime Ripard wrote: > > > The Allwinner A80 SoCs have a USB PHY controller that is used by Linux, > > > with a matching Device Tree binding. > > > > > > Now that we have the DT validation in place, let's convert the device tree > > > bindings for that controller over to a YAML schemas. > > > > > > Reviewed-by: Chen-Yu Tsai <wens@csie.org> > > > Signed-off-by: Maxime Ripard <maxime@cerno.tech> > > > > > > --- > > > > > > Changes from v1: > > > - Added r-b tag from chen-yu > > > --- > > > .../phy/allwinner,sun9i-a80-usb-phy.yaml | 135 ++++++++++++++++++ > > > .../devicetree/bindings/phy/sun9i-usb-phy.txt | 37 ----- > > > 2 files changed, 135 insertions(+), 37 deletions(-) > > > create mode 100644 Documentation/devicetree/bindings/phy/allwinner,sun9i-a80-usb-phy.yaml > > > delete mode 100644 Documentation/devicetree/bindings/phy/sun9i-usb-phy.txt > > > > > > diff --git a/Documentation/devicetree/bindings/phy/allwinner,sun9i-a80-usb-phy.yaml b/Documentation/devicetree/bindings/phy/allwinner,sun9i-a80-usb-phy.yaml > > > new file mode 100644 > > > index 000000000000..ded7d6f0a119 > > > --- /dev/null > > > +++ b/Documentation/devicetree/bindings/phy/allwinner,sun9i-a80-usb-phy.yaml > > > @@ -0,0 +1,135 @@ > > > +# SPDX-License-Identifier: GPL-2.0 > > > +%YAML 1.2 > > > +--- > > > +$id: http://devicetree.org/schemas/phy/allwinner,sun9i-a80-usb-phy.yaml# > > > +$schema: http://devicetree.org/meta-schemas/core.yaml# > > > + > > > +title: Allwinner A80 USB PHY Device Tree Bindings > > > + > > > +maintainers: > > > + - Chen-Yu Tsai <wens@csie.org> > > > + - Maxime Ripard <mripard@kernel.org> > > > + > > > +properties: > > > + "#phy-cells": > > > + const: 0 > > > + > > > + compatible: > > > + const: allwinner,sun9i-a80-usb-phy > > > + > > > + reg: > > > + maxItems: 1 > > > + > > > + clocks: > > > + anyOf: > > > + - description: Main PHY Clock > > > + > > > + - items: > > > + - description: Main PHY clock > > > + - description: HSIC 12MHz clock > > > + - description: HSIC 480MHz clock > > > > Rather than anyOf, just 'minItems: 1' would work here. Though I guess > > this disallows 2 items. > > Yeah, 2 items is not allowed so I wanted to prevent that. > > > > + > > > + clock-names: > > > + oneOf: > > > + - const: phy > > > + > > > + - items: > > > + - const: phy > > > + - const: hsic_12M > > > + - const: hsic_480M > > > + > > > + resets: > > > + anyOf: > > > + - description: Normal USB PHY reset > > > + > > > + - items: > > > + - description: Normal USB PHY reset > > > + - description: HSIC Reset > > > + > > > + reset-names: > > > + oneOf: > > > + - const: phy > > > + > > > + - items: > > > + - const: phy > > > + - const: hsic > > > + > > > + phy_type: > > > + const: hsic > > > + description: > > > + When absent, the PHY type will be assumed to be normal USB. > > > + > > > + phy-supply: > > > + description: > > > + Regulator that powers VBUS > > > + > > > +required: > > > + - "#phy-cells" > > > + - compatible > > > + - reg > > > + - clocks > > > + - clock-names > > > + - resets > > > + - reset-names > > > + > > > +additionalProperties: false > > > + > > > +if: > > > + properties: > > > + phy_type: > > > + const: hsic > > > + > > > + required: > > > + - phy_type > > > + > > > +then: > > > + properties: > > > + clocks: > > > + maxItems: 3 > > > + > > > + clock-names: > > > + maxItems: 3 > > > + > > > + resets: > > > + maxItems: 2 > > > + > > > + reset-names: > > > + maxItems: 2 > > > > Do you intend that only a single item is allowed when not HSIC? If so, > > that's not what is happening. > > That's intentional indeed, the former binding was making the hsic > clocks and resets mandatory when the phy was in HSIC mode, but only > recommending listing them otherwise. Maybe we can change that in the > future, but that seems out of scope for a conversion. Okay. In that case, Reviewed-by: Rob Herring <robh@kernel.org>
On 07/01/20 3:21 AM, Rob Herring wrote: > On Mon, Jan 06, 2020 at 10:27:24AM +0100, Maxime Ripard wrote: >> Hi Rob, >> >> On Sat, Jan 04, 2020 at 03:13:21PM -0700, Rob Herring wrote: >>> On Fri, Jan 03, 2020 at 04:28:24PM +0100, Maxime Ripard wrote: >>>> The Allwinner A80 SoCs have a USB PHY controller that is used by Linux, >>>> with a matching Device Tree binding. >>>> >>>> Now that we have the DT validation in place, let's convert the device tree >>>> bindings for that controller over to a YAML schemas. >>>> >>>> Reviewed-by: Chen-Yu Tsai <wens@csie.org> >>>> Signed-off-by: Maxime Ripard <maxime@cerno.tech> >>>> >>>> --- >>>> >>>> Changes from v1: >>>> - Added r-b tag from chen-yu >>>> --- >>>> .../phy/allwinner,sun9i-a80-usb-phy.yaml | 135 ++++++++++++++++++ >>>> .../devicetree/bindings/phy/sun9i-usb-phy.txt | 37 ----- >>>> 2 files changed, 135 insertions(+), 37 deletions(-) >>>> create mode 100644 Documentation/devicetree/bindings/phy/allwinner,sun9i-a80-usb-phy.yaml >>>> delete mode 100644 Documentation/devicetree/bindings/phy/sun9i-usb-phy.txt >>>> >>>> diff --git a/Documentation/devicetree/bindings/phy/allwinner,sun9i-a80-usb-phy.yaml b/Documentation/devicetree/bindings/phy/allwinner,sun9i-a80-usb-phy.yaml >>>> new file mode 100644 >>>> index 000000000000..ded7d6f0a119 >>>> --- /dev/null >>>> +++ b/Documentation/devicetree/bindings/phy/allwinner,sun9i-a80-usb-phy.yaml >>>> @@ -0,0 +1,135 @@ >>>> +# SPDX-License-Identifier: GPL-2.0 >>>> +%YAML 1.2 >>>> +--- >>>> +$id: http://devicetree.org/schemas/phy/allwinner,sun9i-a80-usb-phy.yaml# >>>> +$schema: http://devicetree.org/meta-schemas/core.yaml# >>>> + >>>> +title: Allwinner A80 USB PHY Device Tree Bindings >>>> + >>>> +maintainers: >>>> + - Chen-Yu Tsai <wens@csie.org> >>>> + - Maxime Ripard <mripard@kernel.org> >>>> + >>>> +properties: >>>> + "#phy-cells": >>>> + const: 0 >>>> + >>>> + compatible: >>>> + const: allwinner,sun9i-a80-usb-phy >>>> + >>>> + reg: >>>> + maxItems: 1 >>>> + >>>> + clocks: >>>> + anyOf: >>>> + - description: Main PHY Clock >>>> + >>>> + - items: >>>> + - description: Main PHY clock >>>> + - description: HSIC 12MHz clock >>>> + - description: HSIC 480MHz clock >>> >>> Rather than anyOf, just 'minItems: 1' would work here. Though I guess >>> this disallows 2 items. >> >> Yeah, 2 items is not allowed so I wanted to prevent that. >> >>>> + >>>> + clock-names: >>>> + oneOf: >>>> + - const: phy >>>> + >>>> + - items: >>>> + - const: phy >>>> + - const: hsic_12M >>>> + - const: hsic_480M >>>> + >>>> + resets: >>>> + anyOf: >>>> + - description: Normal USB PHY reset >>>> + >>>> + - items: >>>> + - description: Normal USB PHY reset >>>> + - description: HSIC Reset >>>> + >>>> + reset-names: >>>> + oneOf: >>>> + - const: phy >>>> + >>>> + - items: >>>> + - const: phy >>>> + - const: hsic >>>> + >>>> + phy_type: >>>> + const: hsic >>>> + description: >>>> + When absent, the PHY type will be assumed to be normal USB. >>>> + >>>> + phy-supply: >>>> + description: >>>> + Regulator that powers VBUS >>>> + >>>> +required: >>>> + - "#phy-cells" >>>> + - compatible >>>> + - reg >>>> + - clocks >>>> + - clock-names >>>> + - resets >>>> + - reset-names >>>> + >>>> +additionalProperties: false >>>> + >>>> +if: >>>> + properties: >>>> + phy_type: >>>> + const: hsic >>>> + >>>> + required: >>>> + - phy_type >>>> + >>>> +then: >>>> + properties: >>>> + clocks: >>>> + maxItems: 3 >>>> + >>>> + clock-names: >>>> + maxItems: 3 >>>> + >>>> + resets: >>>> + maxItems: 2 >>>> + >>>> + reset-names: >>>> + maxItems: 2 >>> >>> Do you intend that only a single item is allowed when not HSIC? If so, >>> that's not what is happening. >> >> That's intentional indeed, the former binding was making the hsic >> clocks and resets mandatory when the phy was in HSIC mode, but only >> recommending listing them otherwise. Maybe we can change that in the >> future, but that seems out of scope for a conversion. > > Okay. In that case, > > Reviewed-by: Rob Herring <robh@kernel.org> merged, thanks! -Kishon
diff --git a/Documentation/devicetree/bindings/phy/allwinner,sun9i-a80-usb-phy.yaml b/Documentation/devicetree/bindings/phy/allwinner,sun9i-a80-usb-phy.yaml new file mode 100644 index 000000000000..ded7d6f0a119 --- /dev/null +++ b/Documentation/devicetree/bindings/phy/allwinner,sun9i-a80-usb-phy.yaml @@ -0,0 +1,135 @@ +# SPDX-License-Identifier: GPL-2.0 +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/phy/allwinner,sun9i-a80-usb-phy.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Allwinner A80 USB PHY Device Tree Bindings + +maintainers: + - Chen-Yu Tsai <wens@csie.org> + - Maxime Ripard <mripard@kernel.org> + +properties: + "#phy-cells": + const: 0 + + compatible: + const: allwinner,sun9i-a80-usb-phy + + reg: + maxItems: 1 + + clocks: + anyOf: + - description: Main PHY Clock + + - items: + - description: Main PHY clock + - description: HSIC 12MHz clock + - description: HSIC 480MHz clock + + clock-names: + oneOf: + - const: phy + + - items: + - const: phy + - const: hsic_12M + - const: hsic_480M + + resets: + anyOf: + - description: Normal USB PHY reset + + - items: + - description: Normal USB PHY reset + - description: HSIC Reset + + reset-names: + oneOf: + - const: phy + + - items: + - const: phy + - const: hsic + + phy_type: + const: hsic + description: + When absent, the PHY type will be assumed to be normal USB. + + phy-supply: + description: + Regulator that powers VBUS + +required: + - "#phy-cells" + - compatible + - reg + - clocks + - clock-names + - resets + - reset-names + +additionalProperties: false + +if: + properties: + phy_type: + const: hsic + + required: + - phy_type + +then: + properties: + clocks: + maxItems: 3 + + clock-names: + maxItems: 3 + + resets: + maxItems: 2 + + reset-names: + maxItems: 2 + +examples: + - | + #include <dt-bindings/clock/sun9i-a80-usb.h> + #include <dt-bindings/reset/sun9i-a80-usb.h> + + usbphy1: phy@a00800 { + compatible = "allwinner,sun9i-a80-usb-phy"; + reg = <0x00a00800 0x4>; + clocks = <&usb_clocks CLK_USB0_PHY>; + clock-names = "phy"; + resets = <&usb_clocks RST_USB0_PHY>; + reset-names = "phy"; + phy-supply = <®_usb1_vbus>; + #phy-cells = <0>; + }; + + - | + #include <dt-bindings/clock/sun9i-a80-usb.h> + #include <dt-bindings/reset/sun9i-a80-usb.h> + + usbphy3: phy@a02800 { + compatible = "allwinner,sun9i-a80-usb-phy"; + reg = <0x00a02800 0x4>; + clocks = <&usb_clocks CLK_USB2_PHY>, + <&usb_clocks CLK_USB_HSIC>, + <&usb_clocks CLK_USB2_HSIC>; + clock-names = "phy", + "hsic_12M", + "hsic_480M"; + resets = <&usb_clocks RST_USB2_PHY>, + <&usb_clocks RST_USB2_HSIC>; + reset-names = "phy", + "hsic"; + phy_type = "hsic"; + phy-supply = <®_usb3_vbus>; + #phy-cells = <0>; + }; diff --git a/Documentation/devicetree/bindings/phy/sun9i-usb-phy.txt b/Documentation/devicetree/bindings/phy/sun9i-usb-phy.txt deleted file mode 100644 index 64f7109aea1f..000000000000 --- a/Documentation/devicetree/bindings/phy/sun9i-usb-phy.txt +++ /dev/null @@ -1,37 +0,0 @@ -Allwinner sun9i USB PHY ------------------------ - -Required properties: -- compatible : should be one of - * allwinner,sun9i-a80-usb-phy -- reg : a list of offset + length pairs -- #phy-cells : from the generic phy bindings, must be 0 -- phy_type : "hsic" for HSIC usage; - other values or absence of this property indicates normal USB -- clocks : phandle + clock specifier for the phy clocks -- clock-names : depending on the "phy_type" property, - * "phy" for normal USB - * "hsic_480M", "hsic_12M" for HSIC -- resets : a list of phandle + reset specifier pairs -- reset-names : depending on the "phy_type" property, - * "phy" for normal USB - * "hsic" for HSIC - -Optional Properties: -- phy-supply : from the generic phy bindings, a phandle to a regulator that - provides power to VBUS. - -It is recommended to list all clocks and resets available. -The driver will only use those matching the phy_type. - -Example: - usbphy1: phy@a01800 { - compatible = "allwinner,sun9i-a80-usb-phy"; - reg = <0x00a01800 0x4>; - clocks = <&usb_phy_clk 2>, <&usb_phy_clk 10>, - <&usb_phy_clk 3>; - clock-names = "hsic_480M", "hsic_12M", "phy"; - resets = <&usb_phy_clk 18>, <&usb_phy_clk 19>; - reset-names = "hsic", "phy"; - #phy-cells = <0>; - };