diff mbox series

dt-bindings: phy: bcm-ns-usb2-phy: convert to yaml

Message ID 20201116074650.16070-2-zajec5@gmail.com
State New
Headers show
Series dt-bindings: phy: bcm-ns-usb2-phy: convert to yaml | expand

Commit Message

Rafał Miłecki Nov. 16, 2020, 7:46 a.m. UTC
From: Rafał Miłecki <rafal@milecki.pl>

1. Convert from txt to yaml
2. Drop "Driver for" from the title
3. Document "#phy-cells"
4. Fix example node name (noticed by dt_binding_check)
5. Add #include to example (noticed by dt_binding_check)
6. Specify license

Signed-off-by: Rafał Miłecki <rafal@milecki.pl>
---
I think this should go through linux-phy tree. Kishon, Vinod, can you
take this patch?

This patch generates a false positive checkpatch.pl warning [0].
Please ignore:
WARNING: DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst

[0] https://lkml.org/lkml/2020/2/18/1084
---
 .../bindings/phy/bcm-ns-usb2-phy.txt          | 21 -------
 .../bindings/phy/bcm-ns-usb2-phy.yaml         | 59 +++++++++++++++++++
 2 files changed, 59 insertions(+), 21 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/phy/bcm-ns-usb2-phy.txt
 create mode 100644 Documentation/devicetree/bindings/phy/bcm-ns-usb2-phy.yaml

Comments

Rob Herring Dec. 7, 2020, 7:21 p.m. UTC | #1
On Mon, 16 Nov 2020 08:46:50 +0100, Rafał Miłecki wrote:
> From: Rafał Miłecki <rafal@milecki.pl>

> 

> 1. Convert from txt to yaml

> 2. Drop "Driver for" from the title

> 3. Document "#phy-cells"

> 4. Fix example node name (noticed by dt_binding_check)

> 5. Add #include to example (noticed by dt_binding_check)

> 6. Specify license

> 

> Signed-off-by: Rafał Miłecki <rafal@milecki.pl>

> ---

> I think this should go through linux-phy tree. Kishon, Vinod, can you

> take this patch?

> 

> This patch generates a false positive checkpatch.pl warning [0].

> Please ignore:

> WARNING: DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst

> 

> [0] https://lkml.org/lkml/2020/2/18/1084

> ---

>  .../bindings/phy/bcm-ns-usb2-phy.txt          | 21 -------

>  .../bindings/phy/bcm-ns-usb2-phy.yaml         | 59 +++++++++++++++++++

>  2 files changed, 59 insertions(+), 21 deletions(-)

>  delete mode 100644 Documentation/devicetree/bindings/phy/bcm-ns-usb2-phy.txt

>  create mode 100644 Documentation/devicetree/bindings/phy/bcm-ns-usb2-phy.yaml

> 


Reviewed-by: Rob Herring <robh@kernel.org>
Rafał Miłecki March 11, 2021, 8:33 p.m. UTC | #2
On 16.11.2020 08:46, Rafał Miłecki wrote:
> From: Rafał Miłecki <rafal@milecki.pl>

> 

> 1. Convert from txt to yaml

> 2. Drop "Driver for" from the title

> 3. Document "#phy-cells"

> 4. Fix example node name (noticed by dt_binding_check)

> 5. Add #include to example (noticed by dt_binding_check)

> 6. Specify license

> 

> Signed-off-by: Rafał Miłecki <rafal@milecki.pl>

> ---

> I think this should go through linux-phy tree. Kishon, Vinod, can you

> take this patch?

> 

> This patch generates a false positive checkpatch.pl warning [0].

> Please ignore:

> WARNING: DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst

> 

> [0] https://lkml.org/lkml/2020/2/18/1084


Same thing here.

Kishon, Vinod: I sent this patch back in December, it was Reviewed-by
Rob, but never accepted.

Could you push this patch to the linux-phy.git?


> ---

>   .../bindings/phy/bcm-ns-usb2-phy.txt          | 21 -------

>   .../bindings/phy/bcm-ns-usb2-phy.yaml         | 59 +++++++++++++++++++

>   2 files changed, 59 insertions(+), 21 deletions(-)

>   delete mode 100644 Documentation/devicetree/bindings/phy/bcm-ns-usb2-phy.txt

>   create mode 100644 Documentation/devicetree/bindings/phy/bcm-ns-usb2-phy.yaml

> 

> diff --git a/Documentation/devicetree/bindings/phy/bcm-ns-usb2-phy.txt b/Documentation/devicetree/bindings/phy/bcm-ns-usb2-phy.txt

> deleted file mode 100644

> index a7aee9ea8926..000000000000

> --- a/Documentation/devicetree/bindings/phy/bcm-ns-usb2-phy.txt

> +++ /dev/null

> @@ -1,21 +0,0 @@

> -Driver for Broadcom Northstar USB 2.0 PHY

> -

> -Required properties:

> -- compatible: brcm,ns-usb2-phy

> -- reg: iomem address range of DMU (Device Management Unit)

> -- reg-names: "dmu", the only needed & supported reg right now

> -- clocks: USB PHY reference clock

> -- clock-names: "phy-ref-clk", the only needed & supported clock right now

> -

> -To initialize USB 2.0 PHY driver needs to setup PLL correctly. To do this it

> -requires passing phandle to the USB PHY reference clock.

> -

> -Example:

> -	usb2-phy {

> -		compatible = "brcm,ns-usb2-phy";

> -		reg = <0x1800c000 0x1000>;

> -		reg-names = "dmu";

> -		#phy-cells = <0>;

> -		clocks = <&genpll BCM_NSP_GENPLL_USB_PHY_REF_CLK>;

> -		clock-names = "phy-ref-clk";

> -	};

> diff --git a/Documentation/devicetree/bindings/phy/bcm-ns-usb2-phy.yaml b/Documentation/devicetree/bindings/phy/bcm-ns-usb2-phy.yaml

> new file mode 100644

> index 000000000000..05b4dcd80019

> --- /dev/null

> +++ b/Documentation/devicetree/bindings/phy/bcm-ns-usb2-phy.yaml

> @@ -0,0 +1,59 @@

> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause

> +%YAML 1.2

> +---

> +$id: http://devicetree.org/schemas/phy/bcm-ns-usb2-phy.yaml#

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

> +

> +title: Broadcom Northstar USB 2.0 PHY

> +

> +description: >

> +  To initialize USB 2.0 PHY driver needs to setup PLL correctly.

> +  To do this it requires passing phandle to the USB PHY reference clock.

> +

> +maintainers:

> +  - Rafał Miłecki <rafal@milecki.pl>

> +

> +properties:

> +  compatible:

> +    const: brcm,ns-usb2-phy

> +

> +  reg:

> +    items:

> +      - description: iomem address range of DMU (Device Management Unit)

> +

> +  reg-names:

> +    items:

> +      - const: dmu

> +

> +  clocks:

> +    items:

> +      - description: USB PHY reference clock

> +

> +  clock-names:

> +    items:

> +      - const: phy-ref-clk

> +

> +  "#phy-cells":

> +    const: 0

> +

> +required:

> +  - compatible

> +  - reg

> +  - reg-names

> +  - clocks

> +  - clock-names

> +  - "#phy-cells"

> +

> +additionalProperties: false

> +

> +examples:

> +  - |

> +    #include <dt-bindings/clock/bcm-nsp.h>

> +    phy@1800c000 {

> +        compatible = "brcm,ns-usb2-phy";

> +        reg = <0x1800c000 0x1000>;

> +        reg-names = "dmu";

> +        clocks = <&genpll BCM_NSP_GENPLL_USB_PHY_REF_CLK>;

> +        clock-names = "phy-ref-clk";

> +        #phy-cells = <0>;

> +    };

>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/phy/bcm-ns-usb2-phy.txt b/Documentation/devicetree/bindings/phy/bcm-ns-usb2-phy.txt
deleted file mode 100644
index a7aee9ea8926..000000000000
--- a/Documentation/devicetree/bindings/phy/bcm-ns-usb2-phy.txt
+++ /dev/null
@@ -1,21 +0,0 @@ 
-Driver for Broadcom Northstar USB 2.0 PHY
-
-Required properties:
-- compatible: brcm,ns-usb2-phy
-- reg: iomem address range of DMU (Device Management Unit)
-- reg-names: "dmu", the only needed & supported reg right now
-- clocks: USB PHY reference clock
-- clock-names: "phy-ref-clk", the only needed & supported clock right now
-
-To initialize USB 2.0 PHY driver needs to setup PLL correctly. To do this it
-requires passing phandle to the USB PHY reference clock.
-
-Example:
-	usb2-phy {
-		compatible = "brcm,ns-usb2-phy";
-		reg = <0x1800c000 0x1000>;
-		reg-names = "dmu";
-		#phy-cells = <0>;
-		clocks = <&genpll BCM_NSP_GENPLL_USB_PHY_REF_CLK>;
-		clock-names = "phy-ref-clk";
-	};
diff --git a/Documentation/devicetree/bindings/phy/bcm-ns-usb2-phy.yaml b/Documentation/devicetree/bindings/phy/bcm-ns-usb2-phy.yaml
new file mode 100644
index 000000000000..05b4dcd80019
--- /dev/null
+++ b/Documentation/devicetree/bindings/phy/bcm-ns-usb2-phy.yaml
@@ -0,0 +1,59 @@ 
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/phy/bcm-ns-usb2-phy.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Broadcom Northstar USB 2.0 PHY
+
+description: >
+  To initialize USB 2.0 PHY driver needs to setup PLL correctly.
+  To do this it requires passing phandle to the USB PHY reference clock.
+
+maintainers:
+  - Rafał Miłecki <rafal@milecki.pl>
+
+properties:
+  compatible:
+    const: brcm,ns-usb2-phy
+
+  reg:
+    items:
+      - description: iomem address range of DMU (Device Management Unit)
+
+  reg-names:
+    items:
+      - const: dmu
+
+  clocks:
+    items:
+      - description: USB PHY reference clock
+
+  clock-names:
+    items:
+      - const: phy-ref-clk
+
+  "#phy-cells":
+    const: 0
+
+required:
+  - compatible
+  - reg
+  - reg-names
+  - clocks
+  - clock-names
+  - "#phy-cells"
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/bcm-nsp.h>
+    phy@1800c000 {
+        compatible = "brcm,ns-usb2-phy";
+        reg = <0x1800c000 0x1000>;
+        reg-names = "dmu";
+        clocks = <&genpll BCM_NSP_GENPLL_USB_PHY_REF_CLK>;
+        clock-names = "phy-ref-clk";
+        #phy-cells = <0>;
+    };