dt-bindings: usb: Convert Allwinner A10 mUSB controller to a schema
diff mbox series

Message ID 20191022161951.43567-1-mripard@kernel.org
State Changes Requested
Headers show
Series
  • dt-bindings: usb: Convert Allwinner A10 mUSB controller to a schema
Related show

Checks

Context Check Description
robh/dt-meta-schema success
robh/checkpatch warning "total: 0 errors, 2 warnings, 101 lines checked"

Commit Message

Maxime Ripard Oct. 22, 2019, 4:19 p.m. UTC
The Allwinner SoCs have an mUSB controller that is supported in 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.

Signed-off-by: Maxime Ripard <mripard@kernel.org>
---
 .../bindings/usb/allwinner,sun4i-a10-musb.txt |  28 -----
 .../usb/allwinner,sun4i-a10-musb.yaml         | 101 ++++++++++++++++++
 2 files changed, 101 insertions(+), 28 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/usb/allwinner,sun4i-a10-musb.txt
 create mode 100644 Documentation/devicetree/bindings/usb/allwinner,sun4i-a10-musb.yaml

Comments

Rob Herring Oct. 29, 2019, 5:10 p.m. UTC | #1
On Tue, Oct 22, 2019 at 06:19:51PM +0200, Maxime Ripard wrote:
> The Allwinner SoCs have an mUSB controller that is supported in 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.
> 
> Signed-off-by: Maxime Ripard <mripard@kernel.org>
> ---
>  .../bindings/usb/allwinner,sun4i-a10-musb.txt |  28 -----
>  .../usb/allwinner,sun4i-a10-musb.yaml         | 101 ++++++++++++++++++
>  2 files changed, 101 insertions(+), 28 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/usb/allwinner,sun4i-a10-musb.txt
>  create mode 100644 Documentation/devicetree/bindings/usb/allwinner,sun4i-a10-musb.yaml
> 
> diff --git a/Documentation/devicetree/bindings/usb/allwinner,sun4i-a10-musb.txt b/Documentation/devicetree/bindings/usb/allwinner,sun4i-a10-musb.txt
> deleted file mode 100644
> index 50abb20fe319..000000000000
> --- a/Documentation/devicetree/bindings/usb/allwinner,sun4i-a10-musb.txt
> +++ /dev/null
> @@ -1,28 +0,0 @@
> -Allwinner sun4i A10 musb DRC/OTG controller
> --------------------------------------------
> -
> -Required properties:
> - - compatible      : "allwinner,sun4i-a10-musb", "allwinner,sun6i-a31-musb",
> -                     "allwinner,sun8i-a33-musb" or "allwinner,sun8i-h3-musb"
> - - reg             : mmio address range of the musb controller
> - - clocks          : clock specifier for the musb controller ahb gate clock
> - - reset           : reset specifier for the ahb reset (A31 and newer only)
> - - interrupts      : interrupt to which the musb controller is connected
> - - interrupt-names : must be "mc"
> - - phys            : phy specifier for the otg phy
> - - phy-names       : must be "usb"
> - - dr_mode         : Dual-Role mode must be "host" or "otg"
> - - extcon          : extcon specifier for the otg phy
> -
> -Example:
> -
> -	usb_otg: usb@1c13000 {
> -		compatible = "allwinner,sun4i-a10-musb";
> -		reg = <0x01c13000 0x0400>;
> -		clocks = <&ahb_gates 0>;
> -		interrupts = <38>;
> -		interrupt-names = "mc";
> -		phys = <&usbphy 0>;
> -		phy-names = "usb";
> -		extcon = <&usbphy 0>;
> -	};
> diff --git a/Documentation/devicetree/bindings/usb/allwinner,sun4i-a10-musb.yaml b/Documentation/devicetree/bindings/usb/allwinner,sun4i-a10-musb.yaml
> new file mode 100644
> index 000000000000..81d0189ed5c8
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/usb/allwinner,sun4i-a10-musb.yaml
> @@ -0,0 +1,101 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/usb/allwinner,sun4i-a10-musb.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Allwinner A10 mUSB OTG Controller Device Tree Bindings
> +
> +maintainers:
> +  - Chen-Yu Tsai <wens@csie.org>
> +  - Maxime Ripard <maxime.ripard@bootlin.com>
> +
> +properties:
> +  compatible:
> +    oneOf:
> +      - const: allwinner,sun4i-a10-musb
> +      - const: allwinner,sun6i-a31-musb
> +      - const: allwinner,sun8i-a33-musb
> +      - items:
> +          - const: allwinner,sun8i-a83t-musb
> +          - const: allwinner,sun8i-a33-musb
> +      - const: allwinner,sun8i-h3-musb
> +      - items:
> +          - const: allwinner,sun50i-h6-musb
> +          - const: allwinner,sun8i-a33-musb

This could be 2 oneOf entries instead. Or just combine the 2 2 items 
entries.

> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  interrupt-names:
> +    const: mc
> +
> +  clocks:
> +    maxItems: 1
> +
> +  resets:
> +    maxItems: 1
> +
> +  phys:
> +    description: PHY specifier for the OTG PHY
> +
> +  phy-names:
> +    const: usb
> +
> +  extcon:
> +    description: Extcon specifier for the OTG PHY
> +
> +  dr_mode:
> +    enum:
> +      - host
> +      - otg
> +      - peripheral

3rd definition I've seen in the past day...

> +
> +  allwinner,sram:
> +    description: Phandle to the device SRAM
> +    $ref: /schemas/types.yaml#/definitions/phandle-array
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - interrupt-names
> +  - clocks
> +  - phys
> +  - phy-names
> +  - dr_mode
> +  - extcon
> +
> +if:
> +  properties:
> +    compatible:
> +      contains:
> +        enum:
> +          - allwinner,sun6i-a31-musb
> +          - allwinner,sun8i-a33-musb
> +          - allwinner,sun8i-h3-musb
> +
> +then:
> +  required:
> +    - resets
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    usb_otg: usb@1c13000 {
> +      compatible = "allwinner,sun4i-a10-musb";
> +      reg = <0x01c13000 0x0400>;
> +      clocks = <&ahb_gates 0>;
> +      interrupts = <38>;
> +      interrupt-names = "mc";
> +      phys = <&usbphy 0>;
> +      phy-names = "usb";
> +      extcon = <&usbphy 0>;
> +      dr_mode = "peripheral";
> +    };
> +
> +...
> -- 
> 2.23.0
>

Patch
diff mbox series

diff --git a/Documentation/devicetree/bindings/usb/allwinner,sun4i-a10-musb.txt b/Documentation/devicetree/bindings/usb/allwinner,sun4i-a10-musb.txt
deleted file mode 100644
index 50abb20fe319..000000000000
--- a/Documentation/devicetree/bindings/usb/allwinner,sun4i-a10-musb.txt
+++ /dev/null
@@ -1,28 +0,0 @@ 
-Allwinner sun4i A10 musb DRC/OTG controller
--------------------------------------------
-
-Required properties:
- - compatible      : "allwinner,sun4i-a10-musb", "allwinner,sun6i-a31-musb",
-                     "allwinner,sun8i-a33-musb" or "allwinner,sun8i-h3-musb"
- - reg             : mmio address range of the musb controller
- - clocks          : clock specifier for the musb controller ahb gate clock
- - reset           : reset specifier for the ahb reset (A31 and newer only)
- - interrupts      : interrupt to which the musb controller is connected
- - interrupt-names : must be "mc"
- - phys            : phy specifier for the otg phy
- - phy-names       : must be "usb"
- - dr_mode         : Dual-Role mode must be "host" or "otg"
- - extcon          : extcon specifier for the otg phy
-
-Example:
-
-	usb_otg: usb@1c13000 {
-		compatible = "allwinner,sun4i-a10-musb";
-		reg = <0x01c13000 0x0400>;
-		clocks = <&ahb_gates 0>;
-		interrupts = <38>;
-		interrupt-names = "mc";
-		phys = <&usbphy 0>;
-		phy-names = "usb";
-		extcon = <&usbphy 0>;
-	};
diff --git a/Documentation/devicetree/bindings/usb/allwinner,sun4i-a10-musb.yaml b/Documentation/devicetree/bindings/usb/allwinner,sun4i-a10-musb.yaml
new file mode 100644
index 000000000000..81d0189ed5c8
--- /dev/null
+++ b/Documentation/devicetree/bindings/usb/allwinner,sun4i-a10-musb.yaml
@@ -0,0 +1,101 @@ 
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/usb/allwinner,sun4i-a10-musb.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Allwinner A10 mUSB OTG Controller Device Tree Bindings
+
+maintainers:
+  - Chen-Yu Tsai <wens@csie.org>
+  - Maxime Ripard <maxime.ripard@bootlin.com>
+
+properties:
+  compatible:
+    oneOf:
+      - const: allwinner,sun4i-a10-musb
+      - const: allwinner,sun6i-a31-musb
+      - const: allwinner,sun8i-a33-musb
+      - items:
+          - const: allwinner,sun8i-a83t-musb
+          - const: allwinner,sun8i-a33-musb
+      - const: allwinner,sun8i-h3-musb
+      - items:
+          - const: allwinner,sun50i-h6-musb
+          - const: allwinner,sun8i-a33-musb
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  interrupt-names:
+    const: mc
+
+  clocks:
+    maxItems: 1
+
+  resets:
+    maxItems: 1
+
+  phys:
+    description: PHY specifier for the OTG PHY
+
+  phy-names:
+    const: usb
+
+  extcon:
+    description: Extcon specifier for the OTG PHY
+
+  dr_mode:
+    enum:
+      - host
+      - otg
+      - peripheral
+
+  allwinner,sram:
+    description: Phandle to the device SRAM
+    $ref: /schemas/types.yaml#/definitions/phandle-array
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - interrupt-names
+  - clocks
+  - phys
+  - phy-names
+  - dr_mode
+  - extcon
+
+if:
+  properties:
+    compatible:
+      contains:
+        enum:
+          - allwinner,sun6i-a31-musb
+          - allwinner,sun8i-a33-musb
+          - allwinner,sun8i-h3-musb
+
+then:
+  required:
+    - resets
+
+additionalProperties: false
+
+examples:
+  - |
+    usb_otg: usb@1c13000 {
+      compatible = "allwinner,sun4i-a10-musb";
+      reg = <0x01c13000 0x0400>;
+      clocks = <&ahb_gates 0>;
+      interrupts = <38>;
+      interrupt-names = "mc";
+      phys = <&usbphy 0>;
+      phy-names = "usb";
+      extcon = <&usbphy 0>;
+      dr_mode = "peripheral";
+    };
+
+...