[1/6] dt-bindings: usb: Convert USB HCD generic binding to YAML
diff mbox series

Message ID d930537cfe3124de37b8ecf4eaa02b68ec94cb40.1555403233.git-series.maxime.ripard@bootlin.com
State Not Applicable
Headers show
Series
  • [1/6] dt-bindings: usb: Convert USB HCD generic binding to YAML
Related show

Checks

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

Commit Message

Maxime Ripard April 16, 2019, 8:27 a.m. UTC
The USB HCD generic binding is used by many USB host bindings.

In order to allow the DT validation to happen on those, let's create a YAML
description for that generic binding that can be referenced later on.

Signed-off-by: Maxime Ripard <maxime.ripard@bootlin.com>
---
 Documentation/devicetree/bindings/usb/usb-hcd.txt  |  9 +-----
 Documentation/devicetree/bindings/usb/usb-hcd.yaml | 25 +++++++++++++++-
 2 files changed, 25 insertions(+), 9 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/usb/usb-hcd.txt
 create mode 100644 Documentation/devicetree/bindings/usb/usb-hcd.yaml


base-commit: f9221a7a1014d8a047b277a73289678646ddc110

Comments

Chen-Yu Tsai April 16, 2019, 8:43 a.m. UTC | #1
On Tue, Apr 16, 2019 at 4:28 PM Maxime Ripard <maxime.ripard@bootlin.com> wrote:
>
> Neither the OHCI or EHCI bindings are using the phy-names property, so we
> can just drop it.
>
> Signed-off-by: Maxime Ripard <maxime.ripard@bootlin.com>

Acked-by: Chen-Yu Tsai <wens@csie.org>

for all the DT patches in this series.
Maxime Ripard April 17, 2019, 7:58 a.m. UTC | #2
On Tue, Apr 16, 2019 at 04:43:48PM +0800, Chen-Yu Tsai wrote:
> On Tue, Apr 16, 2019 at 4:28 PM Maxime Ripard <maxime.ripard@bootlin.com> wrote:
> >
> > Neither the OHCI or EHCI bindings are using the phy-names property, so we
> > can just drop it.
> >
> > Signed-off-by: Maxime Ripard <maxime.ripard@bootlin.com>
>
> Acked-by: Chen-Yu Tsai <wens@csie.org>
>
> for all the DT patches in this series.

Applied 4, 5 and 6, thanks!
Maxime

--
Maxime Ripard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
Emmanuel Vadot Oct. 1, 2019, 8:42 p.m. UTC | #3
Hi Maxime,

On Tue, 16 Apr 2019 10:28:00 +0200
Maxime Ripard <maxime.ripard@bootlin.com> wrote:

> Neither the OHCI or EHCI bindings are using the phy-names property, so we
> can just drop it.
> 
> Signed-off-by: Maxime Ripard <maxime.ripard@bootlin.com>
> ---
>  arch/arm/boot/dts/sun4i-a10.dtsi     | 4 ----
>  arch/arm/boot/dts/sun5i.dtsi         | 2 --
>  arch/arm/boot/dts/sun6i-a31.dtsi     | 4 ----
>  arch/arm/boot/dts/sun7i-a20.dtsi     | 4 ----
>  arch/arm/boot/dts/sun8i-a23-a33.dtsi | 2 --
>  arch/arm/boot/dts/sun8i-a83t.dtsi    | 3 ---
>  arch/arm/boot/dts/sun8i-r40.dtsi     | 4 ----
>  arch/arm/boot/dts/sun9i-a80.dtsi     | 5 -----
>  8 files changed, 28 deletions(-)
> 
> diff --git a/arch/arm/boot/dts/sun4i-a10.dtsi b/arch/arm/boot/dts/sun4i-a10.dtsi
> index ef6ec526f394..e88daa4ef1af 100644
> --- a/arch/arm/boot/dts/sun4i-a10.dtsi
> +++ b/arch/arm/boot/dts/sun4i-a10.dtsi
> @@ -520,7 +520,6 @@
>  			interrupts = <39>;
>  			clocks = <&ccu CLK_AHB_EHCI0>;
>  			phys = <&usbphy 1>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> @@ -530,7 +529,6 @@
>  			interrupts = <64>;
>  			clocks = <&ccu CLK_USB_OHCI0>, <&ccu CLK_AHB_OHCI0>;
>  			phys = <&usbphy 1>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> @@ -610,7 +608,6 @@
>  			interrupts = <40>;
>  			clocks = <&ccu CLK_AHB_EHCI1>;
>  			phys = <&usbphy 2>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> @@ -620,7 +617,6 @@
>  			interrupts = <65>;
>  			clocks = <&ccu CLK_USB_OHCI1>, <&ccu CLK_AHB_OHCI1>;
>  			phys = <&usbphy 2>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> diff --git a/arch/arm/boot/dts/sun5i.dtsi b/arch/arm/boot/dts/sun5i.dtsi
> index cb820bd7974c..0d71b01967a3 100644
> --- a/arch/arm/boot/dts/sun5i.dtsi
> +++ b/arch/arm/boot/dts/sun5i.dtsi
> @@ -391,7 +391,6 @@
>  			interrupts = <39>;
>  			clocks = <&ccu CLK_AHB_EHCI>;
>  			phys = <&usbphy 1>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> @@ -401,7 +400,6 @@
>  			interrupts = <40>;
>  			clocks = <&ccu CLK_USB_OHCI>, <&ccu CLK_AHB_OHCI>;
>  			phys = <&usbphy 1>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> diff --git a/arch/arm/boot/dts/sun6i-a31.dtsi b/arch/arm/boot/dts/sun6i-a31.dtsi
> index fa983f9ff5f5..c04efad81bbc 100644
> --- a/arch/arm/boot/dts/sun6i-a31.dtsi
> +++ b/arch/arm/boot/dts/sun6i-a31.dtsi
> @@ -543,7 +543,6 @@
>  			clocks = <&ccu CLK_AHB1_EHCI0>;
>  			resets = <&ccu RST_AHB1_EHCI0>;
>  			phys = <&usbphy 1>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> @@ -554,7 +553,6 @@
>  			clocks = <&ccu CLK_AHB1_OHCI0>, <&ccu CLK_USB_OHCI0>;
>  			resets = <&ccu RST_AHB1_OHCI0>;
>  			phys = <&usbphy 1>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> @@ -565,7 +563,6 @@
>  			clocks = <&ccu CLK_AHB1_EHCI1>;
>  			resets = <&ccu RST_AHB1_EHCI1>;
>  			phys = <&usbphy 2>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> @@ -576,7 +573,6 @@
>  			clocks = <&ccu CLK_AHB1_OHCI1>, <&ccu CLK_USB_OHCI1>;
>  			resets = <&ccu RST_AHB1_OHCI1>;
>  			phys = <&usbphy 2>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> diff --git a/arch/arm/boot/dts/sun7i-a20.dtsi b/arch/arm/boot/dts/sun7i-a20.dtsi
> index 794c915f504b..9ad8e445b240 100644
> --- a/arch/arm/boot/dts/sun7i-a20.dtsi
> +++ b/arch/arm/boot/dts/sun7i-a20.dtsi
> @@ -612,7 +612,6 @@
>  			interrupts = <GIC_SPI 39 IRQ_TYPE_LEVEL_HIGH>;
>  			clocks = <&ccu CLK_AHB_EHCI0>;
>  			phys = <&usbphy 1>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> @@ -622,7 +621,6 @@
>  			interrupts = <GIC_SPI 64 IRQ_TYPE_LEVEL_HIGH>;
>  			clocks = <&ccu CLK_USB_OHCI0>, <&ccu CLK_AHB_OHCI0>;
>  			phys = <&usbphy 1>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> @@ -705,7 +703,6 @@
>  			interrupts = <GIC_SPI 40 IRQ_TYPE_LEVEL_HIGH>;
>  			clocks = <&ccu CLK_AHB_EHCI1>;
>  			phys = <&usbphy 2>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> @@ -715,7 +712,6 @@
>  			interrupts = <GIC_SPI 65 IRQ_TYPE_LEVEL_HIGH>;
>  			clocks = <&ccu CLK_USB_OHCI1>, <&ccu CLK_AHB_OHCI1>;
>  			phys = <&usbphy 2>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> diff --git a/arch/arm/boot/dts/sun8i-a23-a33.dtsi b/arch/arm/boot/dts/sun8i-a23-a33.dtsi
> index f76aad0c5d4d..af2fa694a467 100644
> --- a/arch/arm/boot/dts/sun8i-a23-a33.dtsi
> +++ b/arch/arm/boot/dts/sun8i-a23-a33.dtsi
> @@ -307,7 +307,6 @@
>  			clocks = <&ccu CLK_BUS_EHCI>;
>  			resets = <&ccu RST_BUS_EHCI>;
>  			phys = <&usbphy 1>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> @@ -318,7 +317,6 @@
>  			clocks = <&ccu CLK_BUS_OHCI>, <&ccu CLK_USB_OHCI>;
>  			resets = <&ccu RST_BUS_OHCI>;
>  			phys = <&usbphy 1>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> diff --git a/arch/arm/boot/dts/sun8i-a83t.dtsi b/arch/arm/boot/dts/sun8i-a83t.dtsi
> index b105a85467b3..392b0cabbf0d 100644
> --- a/arch/arm/boot/dts/sun8i-a83t.dtsi
> +++ b/arch/arm/boot/dts/sun8i-a83t.dtsi
> @@ -632,7 +632,6 @@
>  			clocks = <&ccu CLK_BUS_EHCI0>;
>  			resets = <&ccu RST_BUS_EHCI0>;
>  			phys = <&usbphy 1>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> @@ -644,7 +643,6 @@
>  			clocks = <&ccu CLK_BUS_OHCI0>, <&ccu CLK_USB_OHCI0>;
>  			resets = <&ccu RST_BUS_OHCI0>;
>  			phys = <&usbphy 1>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> @@ -656,7 +654,6 @@
>  			clocks = <&ccu CLK_BUS_EHCI1>;
>  			resets = <&ccu RST_BUS_EHCI1>;
>  			phys = <&usbphy 2>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> diff --git a/arch/arm/boot/dts/sun8i-r40.dtsi b/arch/arm/boot/dts/sun8i-r40.dtsi
> index 56c6885b02d1..bb856e53b806 100644
> --- a/arch/arm/boot/dts/sun8i-r40.dtsi
> +++ b/arch/arm/boot/dts/sun8i-r40.dtsi
> @@ -273,7 +273,6 @@
>  			clocks = <&ccu CLK_BUS_EHCI1>;
>  			resets = <&ccu RST_BUS_EHCI1>;
>  			phys = <&usbphy 1>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> @@ -285,7 +284,6 @@
>  				 <&ccu CLK_USB_OHCI1>;
>  			resets = <&ccu RST_BUS_OHCI1>;
>  			phys = <&usbphy 1>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> @@ -296,7 +294,6 @@
>  			clocks = <&ccu CLK_BUS_EHCI2>;
>  			resets = <&ccu RST_BUS_EHCI2>;
>  			phys = <&usbphy 2>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> @@ -308,7 +305,6 @@
>  				 <&ccu CLK_USB_OHCI2>;
>  			resets = <&ccu RST_BUS_OHCI2>;
>  			phys = <&usbphy 2>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> diff --git a/arch/arm/boot/dts/sun9i-a80.dtsi b/arch/arm/boot/dts/sun9i-a80.dtsi
> index c1aa26db44ae..0c1eec9000e3 100644
> --- a/arch/arm/boot/dts/sun9i-a80.dtsi
> +++ b/arch/arm/boot/dts/sun9i-a80.dtsi
> @@ -342,7 +342,6 @@
>  			clocks = <&usb_clocks CLK_BUS_HCI0>;
>  			resets = <&usb_clocks RST_USB0_HCI>;
>  			phys = <&usbphy1>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> @@ -354,7 +353,6 @@
>  				 <&usb_clocks CLK_USB_OHCI0>;
>  			resets = <&usb_clocks RST_USB0_HCI>;
>  			phys = <&usbphy1>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> @@ -376,7 +374,6 @@
>  			clocks = <&usb_clocks CLK_BUS_HCI1>;
>  			resets = <&usb_clocks RST_USB1_HCI>;
>  			phys = <&usbphy2>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> @@ -406,7 +403,6 @@
>  			clocks = <&usb_clocks CLK_BUS_HCI2>;
>  			resets = <&usb_clocks RST_USB2_HCI>;
>  			phys = <&usbphy3>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> @@ -418,7 +414,6 @@
>  				 <&usb_clocks CLK_USB_OHCI2>;
>  			resets = <&usb_clocks RST_USB2_HCI>;
>  			phys = <&usbphy3>;
> -			phy-names = "usb";
>  			status = "disabled";
>  		};
>  
> -- 
> git-series 0.9.1

 Sorry for the late reply on this mail but it seems that it was only
applied for 5.2 and I've just imported those DTS for FreeBSD recently.

 So, this is not correct, the phy-bindings.txt documents says that
phy-names is a required property for any phy user node. I agree that
the generic-{o,e}hci doesn't say what name the phy should be
represented but almost all DTS seems to agree on the "usb" name (at
least when they have only one phy).
 All the BSDs requires (or used to since this change) the phy-names to
be present since it's a required property.
 I've badly patched FreeBSD since I though this was an Allwinner thing
before someone directed me to the phy-bindings.txt document.

 Please revert this patch or send a patch to update the documentation.

 Thank you.

Patch
diff mbox series

diff --git a/Documentation/devicetree/bindings/usb/usb-hcd.txt b/Documentation/devicetree/bindings/usb/usb-hcd.txt
deleted file mode 100644
index 50529b838c9c..000000000000
--- a/Documentation/devicetree/bindings/usb/usb-hcd.txt
+++ /dev/null
@@ -1,9 +0,0 @@ 
-Generic USB HCD (Host Controller Device) Properties
-
-Optional properties:
-- phys: a list of all USB PHYs on this HCD
-
-Example:
-	&usb1 {
-		phys = <&usb2_phy1>, <&usb3_phy1>;
-	};
diff --git a/Documentation/devicetree/bindings/usb/usb-hcd.yaml b/Documentation/devicetree/bindings/usb/usb-hcd.yaml
new file mode 100644
index 000000000000..9c8c56d3a792
--- /dev/null
+++ b/Documentation/devicetree/bindings/usb/usb-hcd.yaml
@@ -0,0 +1,25 @@ 
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/usb/usb-hcd.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Generic USB Host Controller Device Tree Bindings
+
+maintainers:
+  - Greg Kroah-Hartman <gregkh@linuxfoundation.org>
+
+properties:
+  $nodename:
+    pattern: "^usb(@.*)?"
+
+  phys:
+    $ref: /schemas/types.yaml#/definitions/phandle-array
+    description:
+      List of all the USB PHYs on this HCD
+
+examples:
+  - |
+    usb {
+        phys = <&usb2_phy1>, <&usb3_phy1>;
+    };