diff mbox series

[v4,1/8] dt-bindings: usb: convert rockchip,dwc3.txt to yaml

Message ID 20210206185017.1817-1-jbx6244@gmail.com
State Superseded
Headers show
Series [v4,1/8] dt-bindings: usb: convert rockchip,dwc3.txt to yaml | expand

Commit Message

Johan Jonker Feb. 6, 2021, 6:50 p.m. UTC
In the past Rockchip dwc3 usb nodes were manually checked.
With the conversion of snps,dwc3.yaml as common document
we now can convert rockchip,dwc3.txt to yaml as well.
Remove node wrapper.

Added properties for rk3399 are:
  power-domains
  resets
  reset-names

Signed-off-by: Johan Jonker <jbx6244@gmail.com>
---
Changed V3:
  remove aclk_usb3_rksoc_axi_perf
  remove aclk_usb3

Changed V2:
  remove node wrapper
---
 .../devicetree/bindings/usb/rockchip,dwc3.txt      | 56 -------------
 .../devicetree/bindings/usb/rockchip,dwc3.yaml     | 95 ++++++++++++++++++++++
 2 files changed, 95 insertions(+), 56 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/usb/rockchip,dwc3.txt
 create mode 100644 Documentation/devicetree/bindings/usb/rockchip,dwc3.yaml

Comments

Rob Herring (Arm) Feb. 9, 2021, 3:22 p.m. UTC | #1
On Sat, Feb 06, 2021 at 07:50:10PM +0100, Johan Jonker wrote:
> In the past Rockchip dwc3 usb nodes were manually checked.

> With the conversion of snps,dwc3.yaml as common document

> we now can convert rockchip,dwc3.txt to yaml as well.

> Remove node wrapper.

> 

> Added properties for rk3399 are:

>   power-domains

>   resets

>   reset-names

> 

> Signed-off-by: Johan Jonker <jbx6244@gmail.com>

> ---

> Changed V3:

>   remove aclk_usb3_rksoc_axi_perf

>   remove aclk_usb3

> 

> Changed V2:

>   remove node wrapper

> ---

>  .../devicetree/bindings/usb/rockchip,dwc3.txt      | 56 -------------

>  .../devicetree/bindings/usb/rockchip,dwc3.yaml     | 95 ++++++++++++++++++++++

>  2 files changed, 95 insertions(+), 56 deletions(-)

>  delete mode 100644 Documentation/devicetree/bindings/usb/rockchip,dwc3.txt

>  create mode 100644 Documentation/devicetree/bindings/usb/rockchip,dwc3.yaml

> 

> diff --git a/Documentation/devicetree/bindings/usb/rockchip,dwc3.txt b/Documentation/devicetree/bindings/usb/rockchip,dwc3.txt

> deleted file mode 100644

> index 945204932..000000000

> --- a/Documentation/devicetree/bindings/usb/rockchip,dwc3.txt

> +++ /dev/null

> @@ -1,56 +0,0 @@

> -Rockchip SuperSpeed DWC3 USB SoC controller

> -

> -Required properties:

> -- compatible:	should contain "rockchip,rk3399-dwc3" for rk3399 SoC

> -- clocks:	A list of phandle + clock-specifier pairs for the

> -		clocks listed in clock-names

> -- clock-names:	Should contain the following:

> -  "ref_clk"	Controller reference clk, have to be 24 MHz

> -  "suspend_clk"	Controller suspend clk, have to be 24 MHz or 32 KHz

> -  "bus_clk"	Master/Core clock, have to be >= 62.5 MHz for SS

> -		operation and >= 30MHz for HS operation

> -  "grf_clk"	Controller grf clk

> -

> -Required child node:

> -A child node must exist to represent the core DWC3 IP block. The name of

> -the node is not important. The content of the node is defined in dwc3.txt.

> -

> -Phy documentation is provided in the following places:

> -Documentation/devicetree/bindings/phy/phy-rockchip-inno-usb2.yaml - USB2.0 PHY

> -Documentation/devicetree/bindings/phy/phy-rockchip-typec.txt     - Type-C PHY

> -

> -Example device nodes:

> -

> -	usbdrd3_0: usb@fe800000 {

> -		compatible = "rockchip,rk3399-dwc3";

> -		clocks = <&cru SCLK_USB3OTG0_REF>, <&cru SCLK_USB3OTG0_SUSPEND>,

> -			 <&cru ACLK_USB3OTG0>, <&cru ACLK_USB3_GRF>;

> -		clock-names = "ref_clk", "suspend_clk",

> -			      "bus_clk", "grf_clk";

> -		#address-cells = <2>;

> -		#size-cells = <2>;

> -		ranges;

> -		usbdrd_dwc3_0: dwc3@fe800000 {

> -			compatible = "snps,dwc3";

> -			reg = <0x0 0xfe800000 0x0 0x100000>;

> -			interrupts = <GIC_SPI 105 IRQ_TYPE_LEVEL_HIGH>;

> -			dr_mode = "otg";

> -		};

> -	};

> -

> -	usbdrd3_1: usb@fe900000 {

> -		compatible = "rockchip,rk3399-dwc3";

> -		clocks = <&cru SCLK_USB3OTG1_REF>, <&cru SCLK_USB3OTG1_SUSPEND>,

> -			 <&cru ACLK_USB3OTG1>, <&cru ACLK_USB3_GRF>;

> -		clock-names = "ref_clk", "suspend_clk",

> -			      "bus_clk", "grf_clk";

> -		#address-cells = <2>;

> -		#size-cells = <2>;

> -		ranges;

> -		usbdrd_dwc3_1: dwc3@fe900000 {

> -			compatible = "snps,dwc3";

> -			reg = <0x0 0xfe900000 0x0 0x100000>;

> -			interrupts = <GIC_SPI 110 IRQ_TYPE_LEVEL_HIGH>;

> -			dr_mode = "otg";

> -		};

> -	};

> diff --git a/Documentation/devicetree/bindings/usb/rockchip,dwc3.yaml b/Documentation/devicetree/bindings/usb/rockchip,dwc3.yaml

> new file mode 100644

> index 000000000..d815aacfc

> --- /dev/null

> +++ b/Documentation/devicetree/bindings/usb/rockchip,dwc3.yaml

> @@ -0,0 +1,95 @@

> +# SPDX-License-Identifier: GPL-2.0

> +%YAML 1.2

> +---

> +$id: http://devicetree.org/schemas/usb/rockchip,dwc3.yaml#

> +$schema: http://devicetree.org/meta-schemas/core.yaml#

> +

> +title: Rockchip SuperSpeed DWC3 USB SoC controller

> +

> +maintainers:

> +  - Heiko Stuebner <heiko@sntech.de>

> +

> +description:

> +  The common content of the node is defined in snps,dwc3.yaml.

> +

> +  Phy documentation is provided in the following places.

> +

> +  USB2.0 PHY

> +  Documentation/devicetree/bindings/phy/phy-rockchip-inno-usb2.yaml

> +

> +  Type-C PHY

> +  Documentation/devicetree/bindings/phy/phy-rockchip-typec.txt

> +

> +allOf:

> +  - $ref: snps,dwc3.yaml#

> +

> +properties:

> +  compatible:

> +    items:

> +      - enum:

> +          - rockchip,rk3399-dwc3

> +      - const: snps,dwc3


This will match on all 'snps,dwc3' nodes. You will need a custom 
'select' to only match on rockchip,rk3399-dwc3.

> +

> +  reg:

> +    maxItems: 1

> +

> +  interrupts:

> +    maxItems: 1

> +

> +  clocks:

> +    items:

> +      - description:

> +          Controller reference clock, must to be 24 MHz

> +      - description:

> +          Controller suspend clock, must to be 24 MHz or 32 KHz

> +      - description:

> +          Master/Core clock, must to be >= 62.5 MHz for SS

> +          operation and >= 30MHz for HS operation

> +      - description:

> +          Controller grf clock

> +

> +  clock-names:

> +    items:

> +      - const: ref_clk

> +      - const: suspend_clk

> +      - const: bus_clk

> +      - const: grf_clk

> +

> +  power-domains:

> +    maxItems: 1

> +

> +  resets:

> +    maxItems: 1

> +

> +  reset-names:

> +    const: usb3-otg

> +

> +unevaluatedProperties: false

> +

> +required:

> +  - compatible

> +  - reg

> +  - interrupts

> +  - clocks

> +  - clock-names

> +

> +examples:

> +  - |

> +    #include <dt-bindings/clock/rk3399-cru.h>

> +    #include <dt-bindings/interrupt-controller/arm-gic.h>

> +

> +    bus {

> +      #address-cells = <2>;

> +      #size-cells = <2>;

> +

> +      usbdrd3_0: usb@fe800000 {

> +        compatible = "rockchip,rk3399-dwc3", "snps,dwc3";

> +        reg = <0x0 0xfe800000 0x0 0x100000>;

> +        interrupts = <GIC_SPI 105 IRQ_TYPE_LEVEL_HIGH>;

> +        clocks = <&cru SCLK_USB3OTG0_REF>, <&cru SCLK_USB3OTG0_SUSPEND>,

> +                 <&cru ACLK_USB3OTG0>, <&cru ACLK_USB3_GRF>;

> +        clock-names = "ref_clk", "suspend_clk",

> +                      "bus_clk", "grf_clk";

> +        dr_mode = "otg";

> +      };

> +    };

> -- 

> 2.11.0

>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/usb/rockchip,dwc3.txt b/Documentation/devicetree/bindings/usb/rockchip,dwc3.txt
deleted file mode 100644
index 945204932..000000000
--- a/Documentation/devicetree/bindings/usb/rockchip,dwc3.txt
+++ /dev/null
@@ -1,56 +0,0 @@ 
-Rockchip SuperSpeed DWC3 USB SoC controller
-
-Required properties:
-- compatible:	should contain "rockchip,rk3399-dwc3" for rk3399 SoC
-- clocks:	A list of phandle + clock-specifier pairs for the
-		clocks listed in clock-names
-- clock-names:	Should contain the following:
-  "ref_clk"	Controller reference clk, have to be 24 MHz
-  "suspend_clk"	Controller suspend clk, have to be 24 MHz or 32 KHz
-  "bus_clk"	Master/Core clock, have to be >= 62.5 MHz for SS
-		operation and >= 30MHz for HS operation
-  "grf_clk"	Controller grf clk
-
-Required child node:
-A child node must exist to represent the core DWC3 IP block. The name of
-the node is not important. The content of the node is defined in dwc3.txt.
-
-Phy documentation is provided in the following places:
-Documentation/devicetree/bindings/phy/phy-rockchip-inno-usb2.yaml - USB2.0 PHY
-Documentation/devicetree/bindings/phy/phy-rockchip-typec.txt     - Type-C PHY
-
-Example device nodes:
-
-	usbdrd3_0: usb@fe800000 {
-		compatible = "rockchip,rk3399-dwc3";
-		clocks = <&cru SCLK_USB3OTG0_REF>, <&cru SCLK_USB3OTG0_SUSPEND>,
-			 <&cru ACLK_USB3OTG0>, <&cru ACLK_USB3_GRF>;
-		clock-names = "ref_clk", "suspend_clk",
-			      "bus_clk", "grf_clk";
-		#address-cells = <2>;
-		#size-cells = <2>;
-		ranges;
-		usbdrd_dwc3_0: dwc3@fe800000 {
-			compatible = "snps,dwc3";
-			reg = <0x0 0xfe800000 0x0 0x100000>;
-			interrupts = <GIC_SPI 105 IRQ_TYPE_LEVEL_HIGH>;
-			dr_mode = "otg";
-		};
-	};
-
-	usbdrd3_1: usb@fe900000 {
-		compatible = "rockchip,rk3399-dwc3";
-		clocks = <&cru SCLK_USB3OTG1_REF>, <&cru SCLK_USB3OTG1_SUSPEND>,
-			 <&cru ACLK_USB3OTG1>, <&cru ACLK_USB3_GRF>;
-		clock-names = "ref_clk", "suspend_clk",
-			      "bus_clk", "grf_clk";
-		#address-cells = <2>;
-		#size-cells = <2>;
-		ranges;
-		usbdrd_dwc3_1: dwc3@fe900000 {
-			compatible = "snps,dwc3";
-			reg = <0x0 0xfe900000 0x0 0x100000>;
-			interrupts = <GIC_SPI 110 IRQ_TYPE_LEVEL_HIGH>;
-			dr_mode = "otg";
-		};
-	};
diff --git a/Documentation/devicetree/bindings/usb/rockchip,dwc3.yaml b/Documentation/devicetree/bindings/usb/rockchip,dwc3.yaml
new file mode 100644
index 000000000..d815aacfc
--- /dev/null
+++ b/Documentation/devicetree/bindings/usb/rockchip,dwc3.yaml
@@ -0,0 +1,95 @@ 
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/usb/rockchip,dwc3.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Rockchip SuperSpeed DWC3 USB SoC controller
+
+maintainers:
+  - Heiko Stuebner <heiko@sntech.de>
+
+description:
+  The common content of the node is defined in snps,dwc3.yaml.
+
+  Phy documentation is provided in the following places.
+
+  USB2.0 PHY
+  Documentation/devicetree/bindings/phy/phy-rockchip-inno-usb2.yaml
+
+  Type-C PHY
+  Documentation/devicetree/bindings/phy/phy-rockchip-typec.txt
+
+allOf:
+  - $ref: snps,dwc3.yaml#
+
+properties:
+  compatible:
+    items:
+      - enum:
+          - rockchip,rk3399-dwc3
+      - const: snps,dwc3
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    items:
+      - description:
+          Controller reference clock, must to be 24 MHz
+      - description:
+          Controller suspend clock, must to be 24 MHz or 32 KHz
+      - description:
+          Master/Core clock, must to be >= 62.5 MHz for SS
+          operation and >= 30MHz for HS operation
+      - description:
+          Controller grf clock
+
+  clock-names:
+    items:
+      - const: ref_clk
+      - const: suspend_clk
+      - const: bus_clk
+      - const: grf_clk
+
+  power-domains:
+    maxItems: 1
+
+  resets:
+    maxItems: 1
+
+  reset-names:
+    const: usb3-otg
+
+unevaluatedProperties: false
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+  - clock-names
+
+examples:
+  - |
+    #include <dt-bindings/clock/rk3399-cru.h>
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+
+    bus {
+      #address-cells = <2>;
+      #size-cells = <2>;
+
+      usbdrd3_0: usb@fe800000 {
+        compatible = "rockchip,rk3399-dwc3", "snps,dwc3";
+        reg = <0x0 0xfe800000 0x0 0x100000>;
+        interrupts = <GIC_SPI 105 IRQ_TYPE_LEVEL_HIGH>;
+        clocks = <&cru SCLK_USB3OTG0_REF>, <&cru SCLK_USB3OTG0_SUSPEND>,
+                 <&cru ACLK_USB3OTG0>, <&cru ACLK_USB3_GRF>;
+        clock-names = "ref_clk", "suspend_clk",
+                      "bus_clk", "grf_clk";
+        dr_mode = "otg";
+      };
+    };