diff mbox series

[1/5] dt-bindings: usb: Convert jz4740-musb doc to YAML

Message ID 20200115220008.91445-2-paul@crapouillou.net (mailing list archive)
State New, archived
Headers show
Series usb: musb: jz4740-musb driver updates | expand

Commit Message

Paul Cercueil Jan. 15, 2020, 10 p.m. UTC 
Convert ingenic,jz4740-musb.txt to ingenic,musb.yaml, and add the
new ingenic,jz4770-musb compatible string in the process.

Signed-off-by: Paul Cercueil <paul@crapouillou.net>
---
 .../bindings/usb/ingenic,jz4740-musb.txt      | 32 ---------
 .../devicetree/bindings/usb/ingenic,musb.yaml | 72 +++++++++++++++++++
 2 files changed, 72 insertions(+), 32 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/usb/ingenic,jz4740-musb.txt
 create mode 100644 Documentation/devicetree/bindings/usb/ingenic,musb.yaml

Comments

Rob Herring (Arm) Jan. 21, 2020, 11:16 p.m. UTC | #1 
On Wed, Jan 15, 2020 at 07:00:04PM -0300, Paul Cercueil wrote:
> Convert ingenic,jz4740-musb.txt to ingenic,musb.yaml, and add the
> new ingenic,jz4770-musb compatible string in the process.
> 
> Signed-off-by: Paul Cercueil <paul@crapouillou.net>
> ---
>  .../bindings/usb/ingenic,jz4740-musb.txt      | 32 ---------
>  .../devicetree/bindings/usb/ingenic,musb.yaml | 72 +++++++++++++++++++
>  2 files changed, 72 insertions(+), 32 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/usb/ingenic,jz4740-musb.txt
>  create mode 100644 Documentation/devicetree/bindings/usb/ingenic,musb.yaml
> 
> diff --git a/Documentation/devicetree/bindings/usb/ingenic,jz4740-musb.txt b/Documentation/devicetree/bindings/usb/ingenic,jz4740-musb.txt
> deleted file mode 100644
> index 16808721f3ff..000000000000
> --- a/Documentation/devicetree/bindings/usb/ingenic,jz4740-musb.txt
> +++ /dev/null
> @@ -1,32 +0,0 @@
> -Ingenic JZ4740 MUSB driver
> -
> -Required properties:
> -
> -- compatible: Must be "ingenic,jz4740-musb"
> -- reg: Address range of the UDC register set
> -- interrupts: IRQ number related to the UDC hardware
> -- interrupt-names: must be "mc"
> -- clocks: phandle to the "udc" clock
> -- clock-names: must be "udc"
> -- phys: phandle to the USB PHY
> -
> -Example:
> -
> -usb_phy: usb-phy@0 {
> -	compatible = "usb-nop-xceiv";
> -	#phy-cells = <0>;
> -};
> -
> -udc: usb@13040000 {
> -	compatible = "ingenic,jz4740-musb";
> -	reg = <0x13040000 0x10000>;
> -
> -	interrupt-parent = <&intc>;
> -	interrupts = <24>;
> -	interrupt-names = "mc";
> -
> -	clocks = <&cgu JZ4740_CLK_UDC>;
> -	clock-names = "udc";
> -
> -	phys = <&usb_phy>;
> -};
> diff --git a/Documentation/devicetree/bindings/usb/ingenic,musb.yaml b/Documentation/devicetree/bindings/usb/ingenic,musb.yaml
> new file mode 100644
> index 000000000000..f8902ee83e56
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/usb/ingenic,musb.yaml
> @@ -0,0 +1,72 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/usb/ingenic,musb.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Ingenic JZ47xx USB IP DT bindings
> +
> +maintainers:
> +  - Paul Cercueil <paul@crapouillou.net>
> +
> +properties:
> +  $nodename:
> +    pattern: '^usb@.*'
> +
> +  compatible:
> +    oneOf:
> +      - const: ingenic,jz4770-musb
> +      - const: ingenic,jz4740-musb

'enum' is preferred over a oneOf + const.

Otherwise,

Reviewed-by: Rob Herring <robh@kernel.org>

> +
> +  reg:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +
> +  clock-names:
> +    items:
> +      - const: udc
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  interrupt-names:
> +    items:
> +      - const: mc
> +
> +  phys:
> +    description: PHY specifier for the USB PHY
> +
> +required:
> +  - compatible
> +  - reg
> +  - clocks
> +  - clock-names
> +  - interrupts
> +  - interrupt-names
> +  - phys
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/clock/jz4740-cgu.h>
> +    usb_phy: usb-phy@0 {
> +      compatible = "usb-nop-xceiv";
> +      #phy-cells = <0>;
> +    };
> +
> +    udc: usb@13040000 {
> +      compatible = "ingenic,jz4740-musb";
> +      reg = <0x13040000 0x10000>;
> +
> +      interrupt-parent = <&intc>;
> +      interrupts = <24>;
> +      interrupt-names = "mc";
> +
> +      clocks = <&cgu JZ4740_CLK_UDC>;
> +      clock-names = "udc";
> +
> +      phys = <&usb_phy>;
> +    };
> -- 
> 2.24.1
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/usb/ingenic,jz4740-musb.txt b/Documentation/devicetree/bindings/usb/ingenic,jz4740-musb.txt
deleted file mode 100644
index 16808721f3ff..000000000000
--- a/Documentation/devicetree/bindings/usb/ingenic,jz4740-musb.txt
+++ /dev/null
@@ -1,32 +0,0 @@ 
-Ingenic JZ4740 MUSB driver
-
-Required properties:
-
-- compatible: Must be "ingenic,jz4740-musb"
-- reg: Address range of the UDC register set
-- interrupts: IRQ number related to the UDC hardware
-- interrupt-names: must be "mc"
-- clocks: phandle to the "udc" clock
-- clock-names: must be "udc"
-- phys: phandle to the USB PHY
-
-Example:
-
-usb_phy: usb-phy@0 {
-	compatible = "usb-nop-xceiv";
-	#phy-cells = <0>;
-};
-
-udc: usb@13040000 {
-	compatible = "ingenic,jz4740-musb";
-	reg = <0x13040000 0x10000>;
-
-	interrupt-parent = <&intc>;
-	interrupts = <24>;
-	interrupt-names = "mc";
-
-	clocks = <&cgu JZ4740_CLK_UDC>;
-	clock-names = "udc";
-
-	phys = <&usb_phy>;
-};
diff --git a/Documentation/devicetree/bindings/usb/ingenic,musb.yaml b/Documentation/devicetree/bindings/usb/ingenic,musb.yaml
new file mode 100644
index 000000000000..f8902ee83e56
--- /dev/null
+++ b/Documentation/devicetree/bindings/usb/ingenic,musb.yaml
@@ -0,0 +1,72 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/usb/ingenic,musb.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Ingenic JZ47xx USB IP DT bindings
+
+maintainers:
+  - Paul Cercueil <paul@crapouillou.net>
+
+properties:
+  $nodename:
+    pattern: '^usb@.*'
+
+  compatible:
+    oneOf:
+      - const: ingenic,jz4770-musb
+      - const: ingenic,jz4740-musb
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  clock-names:
+    items:
+      - const: udc
+
+  interrupts:
+    maxItems: 1
+
+  interrupt-names:
+    items:
+      - const: mc
+
+  phys:
+    description: PHY specifier for the USB PHY
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - clock-names
+  - interrupts
+  - interrupt-names
+  - phys
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/jz4740-cgu.h>
+    usb_phy: usb-phy@0 {
+      compatible = "usb-nop-xceiv";
+      #phy-cells = <0>;
+    };
+
+    udc: usb@13040000 {
+      compatible = "ingenic,jz4740-musb";
+      reg = <0x13040000 0x10000>;
+
+      interrupt-parent = <&intc>;
+      interrupts = <24>;
+      interrupt-names = "mc";
+
+      clocks = <&cgu JZ4740_CLK_UDC>;
+      clock-names = "udc";
+
+      phys = <&usb_phy>;
+    };