diff mbox series

dt-bindings: usb: renesas: usb3-peri: convert bindings to json-schema

Message ID 1571818816-13941-1-git-send-email-yoshihiro.shimoda.uh@renesas.com (mailing list archive)
State Superseded
Headers show
Series dt-bindings: usb: renesas: usb3-peri: convert bindings to json-schema | expand

Commit Message

Yoshihiro Shimoda Oct. 23, 2019, 8:20 a.m. UTC 
Convert Renesas USB 3.0 Peripheral controller bindings documentation
to json-schema.

Signed-off-by: Yoshihiro Shimoda <yoshihiro.shimoda.uh@renesas.com>
---
 .../devicetree/bindings/usb/renesas,usb3-peri.txt  | 65 ---------------
 .../devicetree/bindings/usb/renesas,usb3-peri.yaml | 92 ++++++++++++++++++++++
 2 files changed, 92 insertions(+), 65 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/usb/renesas,usb3-peri.txt
 create mode 100644 Documentation/devicetree/bindings/usb/renesas,usb3-peri.yaml

Comments

Rob Herring (Arm) Oct. 29, 2019, 6:50 p.m. UTC | #1 
On Wed, Oct 23, 2019 at 05:20:16PM +0900, Yoshihiro Shimoda wrote:
> Convert Renesas USB 3.0 Peripheral controller bindings documentation
> to json-schema.
> 
> Signed-off-by: Yoshihiro Shimoda <yoshihiro.shimoda.uh@renesas.com>
> ---
>  .../devicetree/bindings/usb/renesas,usb3-peri.txt  | 65 ---------------
>  .../devicetree/bindings/usb/renesas,usb3-peri.yaml | 92 ++++++++++++++++++++++
>  2 files changed, 92 insertions(+), 65 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/usb/renesas,usb3-peri.txt
>  create mode 100644 Documentation/devicetree/bindings/usb/renesas,usb3-peri.yaml


> diff --git a/Documentation/devicetree/bindings/usb/renesas,usb3-peri.yaml b/Documentation/devicetree/bindings/usb/renesas,usb3-peri.yaml
> new file mode 100644
> index 00000000..489a8cd
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/usb/renesas,usb3-peri.yaml
> @@ -0,0 +1,92 @@
> +# SPDX-License-Identifier: GPL-2.0-only
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/usb/renesas,usb3-peri.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Renesas USB 3.0 Peripheral controller
> +
> +maintainers:
> +  - Yoshihiro Shimoda <yoshihiro.shimoda.uh@renesas.com>
> +
> +properties:
> +  compatible:
> +    oneOf:

Don't need oneOf here.

> +      - items:
> +          - enum:
> +              - renesas,r8a774a1-usb3-peri # RZ/G2M
> +              - renesas,r8a774b1-usb3-peri # RZ/G2N
> +              - renesas,r8a774c0-usb3-peri # RZ/G2E
> +              - renesas,r8a7795-usb3-peri  # R-Car H3
> +              - renesas,r8a7796-usb3-peri  # R-Car M3-W
> +              - renesas,r8a77965-usb3-peri # R-Car M3-N
> +              - renesas,r8a77990-usb3-peri # R-Car E3
> +          - const: renesas,rcar-gen3-usb3-peri
> +
> +  reg:
> +    # Base address and length of the register for the USB 3.0 Peripheral
> +    maxItems: 1
> +
> +  interrupts:
> +    # Interrupt specifier for the USB3.0 Peripheral
> +    maxItems: 1
> +
> +  clocks:
> +    # clock phandle and specifier pair
> +    maxItems: 1
> +
> +  phys:
> +    description: phandle + phy specifier pair.

maxItems: 1

And can drop the description

> +
> +  phy-names:
> +    const: usb
> +
> +  power-domains:
> +    maxItems: 1
> +
> +  resets:
> +    maxItems: 1
> +
> +  usb-role-switch:
> +    $ref: /schemas/types.yaml#/definitions/flag
> +    description: |
> +      Support role switch. See usb/generic.txt.
> +
> +  companion:
> +    $ref: /schemas/types.yaml#/definitions/phandle
> +    description: |
> +      See usb/generic.txt.
> +
> +  port:
> +    description: |
> +      any connector to the data bus of this controller should be modelled
> +      using the OF graph bindings specified in bindings/graph.txt, if the
> +      "usb-role-switch" property is used.
> +
> +required:
> +  - compatible
> +  - interrupts
> +  - clocks
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/clock/r8a774c0-cpg-mssr.h>
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +    #include <dt-bindings/power/r8a774c0-sysc.h>
> +
> +    usb3_peri0: usb@ee020000 {
> +        compatible = "renesas,r8a774c0-usb3-peri", "renesas,rcar-gen3-usb3-peri";
> +        reg = <0 0xee020000 0 0x400>;
> +        interrupts = <GIC_SPI 104 IRQ_TYPE_LEVEL_HIGH>;
> +        clocks = <&cpg CPG_MOD 328>;
> +        companion = <&xhci0>;
> +        usb-role-switch;
> +
> +        port {
> +            usb3_role_switch: endpoint {
> +                remote-endpoint = <&hd3ss3220_ep>;
> +            };
> +        };
> +    };
> -- 
> 2.7.4
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/usb/renesas,usb3-peri.txt b/Documentation/devicetree/bindings/usb/renesas,usb3-peri.txt
deleted file mode 100644
index 1343dfc..00000000
--- a/Documentation/devicetree/bindings/usb/renesas,usb3-peri.txt
+++ /dev/null
@@ -1,65 +0,0 @@ 
-Renesas Electronics USB3.0 Peripheral driver
-
-Required properties:
-  - compatible: Must contain one of the following:
-	- "renesas,r8a774a1-usb3-peri"
-	- "renesas,r8a774b1-usb3-peri"
-	- "renesas,r8a774c0-usb3-peri"
-	- "renesas,r8a7795-usb3-peri"
-	- "renesas,r8a7796-usb3-peri"
-	- "renesas,r8a77965-usb3-peri"
-	- "renesas,r8a77990-usb3-peri"
-	- "renesas,rcar-gen3-usb3-peri" for a generic R-Car Gen3 or RZ/G2
-	  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: Base address and length of the register for the USB3.0 Peripheral
-  - interrupts: Interrupt specifier for the USB3.0 Peripheral
-  - clocks: clock phandle and specifier pair
-
-Optional properties:
-  - phys: phandle + phy specifier pair
-  - phy-names: must be "usb"
-  - usb-role-switch: support role switch. see usb/generic.txt
-
-Sub-nodes:
-- any connector to the data bus of this controller should be modelled using the
-  OF graph bindings specified in bindings/graph.txt, if the "usb-role-switch"
-  property is used.
-
-Example of R-Car H3 ES1.x:
-	usb3_peri0: usb@ee020000 {
-		compatible = "renesas,r8a7795-usb3-peri",
-			     "renesas,rcar-gen3-usb3-peri";
-		reg = <0 0xee020000 0 0x400>;
-		interrupts = <GIC_SPI 104 IRQ_TYPE_LEVEL_HIGH>;
-		clocks = <&cpg CPG_MOD 328>;
-	};
-
-	usb3_peri1: usb@ee060000 {
-		compatible = "renesas,r8a7795-usb3-peri",
-			     "renesas,rcar-gen3-usb3-peri";
-		reg = <0 0xee060000 0 0x400>;
-		interrupts = <GIC_SPI 100 IRQ_TYPE_LEVEL_HIGH>;
-		clocks = <&cpg CPG_MOD 327>;
-	};
-
-Example of RZ/G2E:
-	usb3_peri0: usb@ee020000 {
-		compatible = "renesas,r8a774c0-usb3-peri",
-			     "renesas,rcar-gen3-usb3-peri";
-		reg = <0 0xee020000 0 0x400>;
-		interrupts = <GIC_SPI 104 IRQ_TYPE_LEVEL_HIGH>;
-		clocks = <&cpg CPG_MOD 328>;
-		companion = <&xhci0>;
-		usb-role-switch;
-
-		port {
-			usb3_role_switch: endpoint {
-				remote-endpoint = <&hd3ss3220_ep>;
-			};
-		};
-	};
diff --git a/Documentation/devicetree/bindings/usb/renesas,usb3-peri.yaml b/Documentation/devicetree/bindings/usb/renesas,usb3-peri.yaml
new file mode 100644
index 00000000..489a8cd
--- /dev/null
+++ b/Documentation/devicetree/bindings/usb/renesas,usb3-peri.yaml
@@ -0,0 +1,92 @@ 
+# SPDX-License-Identifier: GPL-2.0-only
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/usb/renesas,usb3-peri.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Renesas USB 3.0 Peripheral controller
+
+maintainers:
+  - Yoshihiro Shimoda <yoshihiro.shimoda.uh@renesas.com>
+
+properties:
+  compatible:
+    oneOf:
+      - items:
+          - enum:
+              - renesas,r8a774a1-usb3-peri # RZ/G2M
+              - renesas,r8a774b1-usb3-peri # RZ/G2N
+              - renesas,r8a774c0-usb3-peri # RZ/G2E
+              - renesas,r8a7795-usb3-peri  # R-Car H3
+              - renesas,r8a7796-usb3-peri  # R-Car M3-W
+              - renesas,r8a77965-usb3-peri # R-Car M3-N
+              - renesas,r8a77990-usb3-peri # R-Car E3
+          - const: renesas,rcar-gen3-usb3-peri
+
+  reg:
+    # Base address and length of the register for the USB 3.0 Peripheral
+    maxItems: 1
+
+  interrupts:
+    # Interrupt specifier for the USB3.0 Peripheral
+    maxItems: 1
+
+  clocks:
+    # clock phandle and specifier pair
+    maxItems: 1
+
+  phys:
+    description: phandle + phy specifier pair.
+
+  phy-names:
+    const: usb
+
+  power-domains:
+    maxItems: 1
+
+  resets:
+    maxItems: 1
+
+  usb-role-switch:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description: |
+      Support role switch. See usb/generic.txt.
+
+  companion:
+    $ref: /schemas/types.yaml#/definitions/phandle
+    description: |
+      See usb/generic.txt.
+
+  port:
+    description: |
+      any connector to the data bus of this controller should be modelled
+      using the OF graph bindings specified in bindings/graph.txt, if the
+      "usb-role-switch" property is used.
+
+required:
+  - compatible
+  - interrupts
+  - clocks
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/r8a774c0-cpg-mssr.h>
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    #include <dt-bindings/power/r8a774c0-sysc.h>
+
+    usb3_peri0: usb@ee020000 {
+        compatible = "renesas,r8a774c0-usb3-peri", "renesas,rcar-gen3-usb3-peri";
+        reg = <0 0xee020000 0 0x400>;
+        interrupts = <GIC_SPI 104 IRQ_TYPE_LEVEL_HIGH>;
+        clocks = <&cpg CPG_MOD 328>;
+        companion = <&xhci0>;
+        usb-role-switch;
+
+        port {
+            usb3_role_switch: endpoint {
+                remote-endpoint = <&hd3ss3220_ep>;
+            };
+        };
+    };