Convert Renesas R-Car generation 3 USB 2.0 PHY bindings documentation
to json-schema.
Signed-off-by: Yoshihiro Shimoda <[email protected]>
---
.../devicetree/bindings/phy/rcar-gen3-phy-usb2.txt | 70 --------------
.../devicetree/bindings/phy/renesas,usb2-phy.yaml | 106 +++++++++++++++++++++
2 files changed, 106 insertions(+), 70 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/phy/rcar-gen3-phy-usb2.txt
create mode 100644 Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml
diff --git a/Documentation/devicetree/bindings/phy/rcar-gen3-phy-usb2.txt b/Documentation/devicetree/bindings/phy/rcar-gen3-phy-usb2.txt
deleted file mode 100644
index 7734b21..00000000
--- a/Documentation/devicetree/bindings/phy/rcar-gen3-phy-usb2.txt
+++ /dev/null
@@ -1,70 +0,0 @@
-* Renesas R-Car generation 3 USB 2.0 PHY
-
-This file provides information on what the device node for the R-Car generation
-3, RZ/G1C, RZ/G2 and RZ/A2 USB 2.0 PHY contain.
-
-Required properties:
-- compatible: "renesas,usb2-phy-r7s9210" if the device is a part of an R7S9210
- SoC.
- "renesas,usb2-phy-r8a77470" if the device is a part of an R8A77470
- SoC.
- "renesas,usb2-phy-r8a774a1" if the device is a part of an R8A774A1
- SoC.
- "renesas,usb2-phy-r8a774b1" if the device is a part of an R8A774B1
- SoC.
- "renesas,usb2-phy-r8a774c0" if the device is a part of an R8A774C0
- SoC.
- "renesas,usb2-phy-r8a7795" if the device is a part of an R8A7795
- SoC.
- "renesas,usb2-phy-r8a7796" if the device is a part of an R8A7796
- SoC.
- "renesas,usb2-phy-r8a77965" if the device is a part of an
- R8A77965 SoC.
- "renesas,usb2-phy-r8a77990" if the device is a part of an
- R8A77990 SoC.
- "renesas,usb2-phy-r8a77995" if the device is a part of an
- R8A77995 SoC.
- "renesas,rcar-gen3-usb2-phy" for a generic R-Car Gen3, RZ/G2 or
- RZ/A2 compatible device.
-
- When compatible with the generic version, nodes must list the
- SoC-specific version corresponding to the platform first
- followed by the generic version.
-
-- reg: offset and length of the partial USB 2.0 Host register block.
-- clocks: clock phandle and specifier pair(s).
-- #phy-cells: see phy-bindings.txt in the same directory, must be <1> (and
- using <0> is deprecated).
-
-The phandle's argument in the PHY specifier is the INT_STATUS bit of controller:
-- 1 = USBH_INTA (OHCI)
-- 2 = USBH_INTB (EHCI)
-- 3 = UCOM_INT (OTG and BC)
-
-Optional properties:
-To use a USB channel where USB 2.0 Host and HSUSB (USB 2.0 Peripheral) are
-combined, the device tree node should set interrupt properties to use the
-channel as USB OTG:
-- interrupts: interrupt specifier for the PHY.
-- vbus-supply: Phandle to a regulator that provides power to the VBUS. This
- regulator will be managed during the PHY power on/off sequence.
-- renesas,no-otg-pins: boolean, specify when a board does not provide proper
- otg pins.
-- dr_mode: string, indicates the working mode for the PHY. Can be "host",
- "peripheral", or "otg". Should be set if otg controller is not used.
-
-
-Example (R-Car H3):
-
- usb-phy@ee080200 {
- compatible = "renesas,usb2-phy-r8a7795", "renesas,rcar-gen3-usb2-phy";
- reg = <0 0xee080200 0 0x700>;
- interrupts = <GIC_SPI 108 IRQ_TYPE_LEVEL_HIGH>;
- clocks = <&cpg CPG_MOD 703>;
- };
-
- usb-phy@ee0a0200 {
- compatible = "renesas,usb2-phy-r8a7795", "renesas,rcar-gen3-usb2-phy";
- reg = <0 0xee0a0200 0 0x700>;
- clocks = <&cpg CPG_MOD 702>;
- };
diff --git a/Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml b/Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml
new file mode 100644
index 00000000..0f109c2
--- /dev/null
+++ b/Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml
@@ -0,0 +1,106 @@
+# SPDX-License-Identifier: GPL-2.0-only
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/phy/renesas,usb2-phy.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Renesas R-Car generation 3 USB 2.0 PHY
+
+maintainers:
+ - Yoshihiro Shimoda <[email protected]>
+
+properties:
+ compatible:
+ oneOf:
+ - items:
+ - enum:
+ - renesas,usb2-phy-r8a77470 # RZ/G1C
+ - items:
+ - enum:
+ - renesas,usb2-phy-r7s9210 # RZ/A2
+ - renesas,usb2-phy-r8a774a1 # RZ/G2M
+ - renesas,usb2-phy-r8a774b1 # RZ/G2N
+ - renesas,usb2-phy-r8a774c0 # RZ/G2E
+ - renesas,usb2-phy-r8a7795 # R-Car H3
+ - renesas,usb2-phy-r8a7796 # R-Car M3-W
+ - renesas,usb2-phy-r8a77965 # R-Car M3-N
+ - renesas,usb2-phy-r8a77990 # R-Car E3
+ - renesas,usb2-phy-r8a77995 # R-Car D3
+ - const: renesas,rcar-gen3-usb2-phy
+
+ reg:
+ # base address and length of the registers block for the PHY.
+ maxItems: 1
+
+ clocks:
+ # clock phandle and specifier pair(s).
+ minItems: 1
+ maxItems: 2
+
+ clock-names:
+ # for RZ/A2
+ minItems: 1
+ maxItems: 2
+ items:
+ - const: fck
+ - const: usb_x1
+
+ '#phy-cells':
+ # see phy-bindings.txt in the same directory
+ enum: [0, 1] # and 0 is deprecated.
+
+ interrupts:
+ maxItems: 1
+
+ power-domains:
+ maxItems: 1
+
+ resets:
+ minItems: 1
+ maxItems: 2
+
+ vbus-supply:
+ $ref: /schemas/types.yaml#/definitions/phandle
+ description: |
+ Phandle to a regulator that provides power to the VBUS. This regulator
+ will be managed during the PHY power on/off sequence.
+
+ renesas,no-otg-pins:
+ $ref: /schemas/types.yaml#/definitions/flag
+ description: |
+ specify when a board does not provide proper otg pins.
+
+ dr_mode:
+ $ref: /schemas/types.yaml#/definitions/string
+ description: |
+ indicates the working mode for the PHY. Can be "host", "peripheral", or
+ "otg". Should be set if otg controller is not used.
+
+required:
+ - compatible
+ - reg
+ - clocks
+ - '#phy-cells'
+
+additionalProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/clock/r8a7795-cpg-mssr.h>
+ #include <dt-bindings/interrupt-controller/arm-gic.h>
+ #include <dt-bindings/power/r8a7795-sysc.h>
+
+ usb-phy@ee080200 {
+ compatible = "renesas,usb2-phy-r8a7795", "renesas,rcar-gen3-usb2-phy";
+ reg = <0 0xee080200 0 0x700>;
+ interrupts = <GIC_SPI 108 IRQ_TYPE_LEVEL_HIGH>;
+ clocks = <&cpg CPG_MOD 703>;
+ #phy-cells = <1>;
+ };
+
+ usb-phy@ee0a0200 {
+ compatible = "renesas,usb2-phy-r8a7795", "renesas,rcar-gen3-usb2-phy";
+ reg = <0 0xee0a0200 0 0x700>;
+ clocks = <&cpg CPG_MOD 702>;
+ #phy-cells = <1>;
+ };
--
2.7.4
On Fri, Oct 18, 2019 at 05:38:53PM +0900, Yoshihiro Shimoda wrote:
> Convert Renesas R-Car generation 3 USB 2.0 PHY bindings documentation
> to json-schema.
>
> Signed-off-by: Yoshihiro Shimoda <[email protected]>
> ---
> .../devicetree/bindings/phy/rcar-gen3-phy-usb2.txt | 70 --------------
> .../devicetree/bindings/phy/renesas,usb2-phy.yaml | 106 +++++++++++++++++++++
> 2 files changed, 106 insertions(+), 70 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/phy/rcar-gen3-phy-usb2.txt
> create mode 100644 Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml
> diff --git a/Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml b/Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml
> new file mode 100644
> index 00000000..0f109c2
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml
> @@ -0,0 +1,106 @@
> +# SPDX-License-Identifier: GPL-2.0-only
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/phy/renesas,usb2-phy.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Renesas R-Car generation 3 USB 2.0 PHY
> +
> +maintainers:
> + - Yoshihiro Shimoda <[email protected]>
> +
> +properties:
> + compatible:
> + oneOf:
This:
> + - items:
> + - enum:
> + - renesas,usb2-phy-r8a77470 # RZ/G1C
You can simplify to just:
- const: renesas,usb2-phy-r8a77470 # RZ/G1C
> + - items:
> + - enum:
> + - renesas,usb2-phy-r7s9210 # RZ/A2
> + - renesas,usb2-phy-r8a774a1 # RZ/G2M
> + - renesas,usb2-phy-r8a774b1 # RZ/G2N
> + - renesas,usb2-phy-r8a774c0 # RZ/G2E
> + - renesas,usb2-phy-r8a7795 # R-Car H3
> + - renesas,usb2-phy-r8a7796 # R-Car M3-W
> + - renesas,usb2-phy-r8a77965 # R-Car M3-N
> + - renesas,usb2-phy-r8a77990 # R-Car E3
> + - renesas,usb2-phy-r8a77995 # R-Car D3
> + - const: renesas,rcar-gen3-usb2-phy
> +
> + reg:
> + # base address and length of the registers block for the PHY.
> + maxItems: 1
> +
> + clocks:
> + # clock phandle and specifier pair(s).
> + minItems: 1
> + maxItems: 2
> +
> + clock-names:
> + # for RZ/A2
> + minItems: 1
> + maxItems: 2
> + items:
> + - const: fck
> + - const: usb_x1
> +
> + '#phy-cells':
> + # see phy-bindings.txt in the same directory
Drop this so we don't have to fix later.
> + enum: [0, 1] # and 0 is deprecated.
> +
> + interrupts:
> + maxItems: 1
> +
> + power-domains:
> + maxItems: 1
> +
> + resets:
> + minItems: 1
> + maxItems: 2
Needs 'items' to define each entry.
> +
> + vbus-supply:
> + $ref: /schemas/types.yaml#/definitions/phandle
Can drop this, *-supply already has a type.
> + description: |
> + Phandle to a regulator that provides power to the VBUS. This regulator
> + will be managed during the PHY power on/off sequence.
> +
> + renesas,no-otg-pins:
> + $ref: /schemas/types.yaml#/definitions/flag
> + description: |
> + specify when a board does not provide proper otg pins.
> +
> + dr_mode:
> + $ref: /schemas/types.yaml#/definitions/string
I think we already have a common definition, so just 'true' is enough.
> + description: |
> + indicates the working mode for the PHY. Can be "host", "peripheral", or
> + "otg". Should be set if otg controller is not used.
> +
> +required:
> + - compatible
> + - reg
> + - clocks
> + - '#phy-cells'
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/clock/r8a7795-cpg-mssr.h>
> + #include <dt-bindings/interrupt-controller/arm-gic.h>
> + #include <dt-bindings/power/r8a7795-sysc.h>
> +
> + usb-phy@ee080200 {
> + compatible = "renesas,usb2-phy-r8a7795", "renesas,rcar-gen3-usb2-phy";
> + reg = <0 0xee080200 0 0x700>;
> + interrupts = <GIC_SPI 108 IRQ_TYPE_LEVEL_HIGH>;
> + clocks = <&cpg CPG_MOD 703>;
> + #phy-cells = <1>;
> + };
> +
> + usb-phy@ee0a0200 {
> + compatible = "renesas,usb2-phy-r8a7795", "renesas,rcar-gen3-usb2-phy";
> + reg = <0 0xee0a0200 0 0x700>;
> + clocks = <&cpg CPG_MOD 702>;
> + #phy-cells = <1>;
> + };
> --
> 2.7.4
>
Hi Rob,
Thank you for your review!
> From: Rob Herring, Sent: Tuesday, October 29, 2019 10:57 AM
>
> On Fri, Oct 18, 2019 at 05:38:53PM +0900, Yoshihiro Shimoda wrote:
> > Convert Renesas R-Car generation 3 USB 2.0 PHY bindings documentation
> > to json-schema.
> >
> > Signed-off-by: Yoshihiro Shimoda <[email protected]>
> > ---
> > .../devicetree/bindings/phy/rcar-gen3-phy-usb2.txt | 70 --------------
> > .../devicetree/bindings/phy/renesas,usb2-phy.yaml | 106 +++++++++++++++++++++
> > 2 files changed, 106 insertions(+), 70 deletions(-)
> > delete mode 100644 Documentation/devicetree/bindings/phy/rcar-gen3-phy-usb2.txt
> > create mode 100644 Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml
>
>
> > diff --git a/Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml
> b/Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml
> > new file mode 100644
> > index 00000000..0f109c2
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml
> > @@ -0,0 +1,106 @@
> > +# SPDX-License-Identifier: GPL-2.0-only
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/phy/renesas,usb2-phy.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Renesas R-Car generation 3 USB 2.0 PHY
> > +
> > +maintainers:
> > + - Yoshihiro Shimoda <[email protected]>
> > +
> > +properties:
> > + compatible:
> > + oneOf:
>
> This:
What does the "This:" mean? If I replaced the "oneOf:" with "This:",
the following error happens when "make dt_binding_check":
SCHEMA Documentation/devicetree/bindings/processed-schema.yaml
warning: no schema found in file: Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml
[snip]/Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml: ignoring, error in schema 'compatible'
Documentation/devicetree/bindings/Makefile:33: recipe for target 'Documentation/devicetree/bindings/processed-schema.yaml' failed
make[1]: *** [Documentation/devicetree/bindings/processed-schema.yaml] Error 255
Makefile:1263: recipe for target 'dt_binding_check' failed
make: *** [dt_binding_check] Error 2
> > + - items:
> > + - enum:
> > + - renesas,usb2-phy-r8a77470 # RZ/G1C
>
> You can simplify to just:
>
> - const: renesas,usb2-phy-r8a77470 # RZ/G1C
I'll fix it.
> > + - items:
> > + - enum:
> > + - renesas,usb2-phy-r7s9210 # RZ/A2
> > + - renesas,usb2-phy-r8a774a1 # RZ/G2M
> > + - renesas,usb2-phy-r8a774b1 # RZ/G2N
> > + - renesas,usb2-phy-r8a774c0 # RZ/G2E
> > + - renesas,usb2-phy-r8a7795 # R-Car H3
> > + - renesas,usb2-phy-r8a7796 # R-Car M3-W
> > + - renesas,usb2-phy-r8a77965 # R-Car M3-N
> > + - renesas,usb2-phy-r8a77990 # R-Car E3
> > + - renesas,usb2-phy-r8a77995 # R-Car D3
> > + - const: renesas,rcar-gen3-usb2-phy
> > +
> > + reg:
> > + # base address and length of the registers block for the PHY.
> > + maxItems: 1
> > +
> > + clocks:
> > + # clock phandle and specifier pair(s).
> > + minItems: 1
> > + maxItems: 2
> > +
> > + clock-names:
> > + # for RZ/A2
> > + minItems: 1
> > + maxItems: 2
> > + items:
> > + - const: fck
> > + - const: usb_x1
> > +
> > + '#phy-cells':
> > + # see phy-bindings.txt in the same directory
>
> Drop this so we don't have to fix later.
I'll drop this.
> > + enum: [0, 1] # and 0 is deprecated.
> > +
> > + interrupts:
> > + maxItems: 1
> > +
> > + power-domains:
> > + maxItems: 1
> > +
> > + resets:
> > + minItems: 1
> > + maxItems: 2
>
> Needs 'items' to define each entry.
I'll add "items:" and two "description:" on the resets property.
> > +
> > + vbus-supply:
> > + $ref: /schemas/types.yaml#/definitions/phandle
>
> Can drop this, *-supply already has a type.
I'll drop it.
> > + description: |
> > + Phandle to a regulator that provides power to the VBUS. This regulator
> > + will be managed during the PHY power on/off sequence.
> > +
> > + renesas,no-otg-pins:
> > + $ref: /schemas/types.yaml#/definitions/flag
> > + description: |
> > + specify when a board does not provide proper otg pins.
> > +
> > + dr_mode:
> > + $ref: /schemas/types.yaml#/definitions/string
>
> I think we already have a common definition, so just 'true' is enough.
I'll fix it.
Best regards,
Yoshihiro Shimoda
On Mon, Oct 28, 2019 at 11:14 PM Yoshihiro Shimoda
<[email protected]> wrote:
>
> Hi Rob,
>
> Thank you for your review!
>
> > From: Rob Herring, Sent: Tuesday, October 29, 2019 10:57 AM
> >
> > On Fri, Oct 18, 2019 at 05:38:53PM +0900, Yoshihiro Shimoda wrote:
> > > Convert Renesas R-Car generation 3 USB 2.0 PHY bindings documentation
> > > to json-schema.
> > >
> > > Signed-off-by: Yoshihiro Shimoda <[email protected]>
> > > ---
> > > .../devicetree/bindings/phy/rcar-gen3-phy-usb2.txt | 70 --------------
> > > .../devicetree/bindings/phy/renesas,usb2-phy.yaml | 106 +++++++++++++++++++++
> > > 2 files changed, 106 insertions(+), 70 deletions(-)
> > > delete mode 100644 Documentation/devicetree/bindings/phy/rcar-gen3-phy-usb2.txt
> > > create mode 100644 Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml
> >
> >
> > > diff --git a/Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml
> > b/Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml
> > > new file mode 100644
> > > index 00000000..0f109c2
> > > --- /dev/null
> > > +++ b/Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml
> > > @@ -0,0 +1,106 @@
> > > +# SPDX-License-Identifier: GPL-2.0-only
> > > +%YAML 1.2
> > > +---
> > > +$id: http://devicetree.org/schemas/phy/renesas,usb2-phy.yaml#
> > > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > > +
> > > +title: Renesas R-Car generation 3 USB 2.0 PHY
> > > +
> > > +maintainers:
> > > + - Yoshihiro Shimoda <[email protected]>
> > > +
> > > +properties:
> > > + compatible:
> > > + oneOf:
> >
> > This:
>
> What does the "This:" mean?
I was referring to the 3 lines below. I was trying to be clear which
lines to replace with just 'const'.
> If I replaced the "oneOf:" with "This:",
> the following error happens when "make dt_binding_check":
>
> SCHEMA Documentation/devicetree/bindings/processed-schema.yaml
> warning: no schema found in file: Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml
> [snip]/Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml: ignoring, error in schema 'compatible'
> Documentation/devicetree/bindings/Makefile:33: recipe for target 'Documentation/devicetree/bindings/processed-schema.yaml' failed
> make[1]: *** [Documentation/devicetree/bindings/processed-schema.yaml] Error 255
> Makefile:1263: recipe for target 'dt_binding_check' failed
> make: *** [dt_binding_check] Error 2
>
> > > + - items:
> > > + - enum:
> > > + - renesas,usb2-phy-r8a77470 # RZ/G1C
> >
> > You can simplify to just:
> >
> > - const: renesas,usb2-phy-r8a77470 # RZ/G1C
>
> I'll fix it.
Hi Rob,
> From: Rob Herring, Sent: Wednesday, October 30, 2019 5:20 AM
>
> On Mon, Oct 28, 2019 at 11:14 PM Yoshihiro Shimoda
> <[email protected]> wrote:
<snip>
> > > > diff --git a/Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml
> > > b/Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml
> > > > new file mode 100644
> > > > index 00000000..0f109c2
> > > > --- /dev/null
> > > > +++ b/Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml
> > > > @@ -0,0 +1,106 @@
> > > > +# SPDX-License-Identifier: GPL-2.0-only
> > > > +%YAML 1.2
> > > > +---
> > > > +$id: http://devicetree.org/schemas/phy/renesas,usb2-phy.yaml#
> > > > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > > > +
> > > > +title: Renesas R-Car generation 3 USB 2.0 PHY
> > > > +
> > > > +maintainers:
> > > > + - Yoshihiro Shimoda <[email protected]>
> > > > +
> > > > +properties:
> > > > + compatible:
> > > > + oneOf:
> > >
> > > This:
> >
> > What does the "This:" mean?
>
> I was referring to the 3 lines below. I was trying to be clear which
> lines to replace with just 'const'.
Thank you for the reply! I understood it.
Best regards,
Yoshihiro Shimoda
> > If I replaced the "oneOf:" with "This:",
> > the following error happens when "make dt_binding_check":
> >
> > SCHEMA Documentation/devicetree/bindings/processed-schema.yaml
> > warning: no schema found in file: Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml
> > [snip]/Documentation/devicetree/bindings/phy/renesas,usb2-phy.yaml: ignoring, error in schema 'compatible'
> > Documentation/devicetree/bindings/Makefile:33: recipe for target
> 'Documentation/devicetree/bindings/processed-schema.yaml' failed
> > make[1]: *** [Documentation/devicetree/bindings/processed-schema.yaml] Error 255
> > Makefile:1263: recipe for target 'dt_binding_check' failed
> > make: *** [dt_binding_check] Error 2
> >
> > > > + - items:
> > > > + - enum:
> > > > + - renesas,usb2-phy-r8a77470 # RZ/G1C
> > >
> > > You can simplify to just:
> > >
> > > - const: renesas,usb2-phy-r8a77470 # RZ/G1C
> >
> > I'll fix it.