diff mbox series

[net-next,7/7] dt-bindings: net: Convert iProc MDIO mux to YAML

Message ID 20211201041228.32444-8-f.fainelli@gmail.com (mailing list archive)
State Superseded
Delegated to: Netdev Maintainers
Headers show
Series Broadcom DT bindings conversion to YAML | expand

Checks

Context Check Description
netdev/tree_selection success Clearly marked for net-next
netdev/fixes_present success Fixes tag not required for -next series
netdev/subject_prefix success Link
netdev/cover_letter success Series has a cover letter
netdev/patch_count success Link
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 0 this patch: 0
netdev/cc_maintainers success CCed 10 of 10 maintainers
netdev/build_clang success Errors and warnings before: 0 this patch: 0
netdev/module_param success Was 0 now: 0
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 0 this patch: 0
netdev/checkpatch warning WARNING: DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst WARNING: DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause) WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Florian Fainelli Dec. 1, 2021, 4:12 a.m. UTC
Conver the Broadcom iProc MDIO mux Device Tree binding to YAML.

Signed-off-by: Florian Fainelli <f.fainelli@gmail.com>
---
 .../bindings/net/brcm,mdio-mux-iproc.txt      | 62 --------------
 .../bindings/net/brcm,mdio-mux-iproc.yaml     | 80 +++++++++++++++++++
 2 files changed, 80 insertions(+), 62 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/net/brcm,mdio-mux-iproc.txt
 create mode 100644 Documentation/devicetree/bindings/net/brcm,mdio-mux-iproc.yaml

Comments

Rob Herring (Arm) Dec. 1, 2021, 2:33 p.m. UTC | #1
On Tue, 30 Nov 2021 20:12:28 -0800, Florian Fainelli wrote:
> Conver the Broadcom iProc MDIO mux Device Tree binding to YAML.
> 
> Signed-off-by: Florian Fainelli <f.fainelli@gmail.com>
> ---
>  .../bindings/net/brcm,mdio-mux-iproc.txt      | 62 --------------
>  .../bindings/net/brcm,mdio-mux-iproc.yaml     | 80 +++++++++++++++++++
>  2 files changed, 80 insertions(+), 62 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/net/brcm,mdio-mux-iproc.txt
>  create mode 100644 Documentation/devicetree/bindings/net/brcm,mdio-mux-iproc.yaml
> 

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:

dtschema/dtc warnings/errors:
Documentation/devicetree/bindings/net/brcm,mdio-mux-iproc.example.dt.yaml:0:0: /example-0/mdio-mux@66020000/mdio@0/pci-phy@0: failed to match any schema with compatible: ['brcm,ns2-pcie-phy']
Documentation/devicetree/bindings/net/brcm,mdio-mux-iproc.example.dt.yaml:0:0: /example-0/mdio-mux@66020000/mdio@7/pci-phy@0: failed to match any schema with compatible: ['brcm,ns2-pcie-phy']

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/patch/1562000

This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit.
Rob Herring (Arm) Dec. 1, 2021, 7:06 p.m. UTC | #2
On Tue, Nov 30, 2021 at 08:12:28PM -0800, Florian Fainelli wrote:
> Conver the Broadcom iProc MDIO mux Device Tree binding to YAML.
> 
> Signed-off-by: Florian Fainelli <f.fainelli@gmail.com>
> ---
>  .../bindings/net/brcm,mdio-mux-iproc.txt      | 62 --------------
>  .../bindings/net/brcm,mdio-mux-iproc.yaml     | 80 +++++++++++++++++++
>  2 files changed, 80 insertions(+), 62 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/net/brcm,mdio-mux-iproc.txt
>  create mode 100644 Documentation/devicetree/bindings/net/brcm,mdio-mux-iproc.yaml
> 
> diff --git a/Documentation/devicetree/bindings/net/brcm,mdio-mux-iproc.txt b/Documentation/devicetree/bindings/net/brcm,mdio-mux-iproc.txt
> deleted file mode 100644
> index deb9e852ea27..000000000000
> --- a/Documentation/devicetree/bindings/net/brcm,mdio-mux-iproc.txt
> +++ /dev/null
> @@ -1,62 +0,0 @@
> -Properties for an MDIO bus multiplexer found in Broadcom iProc based SoCs.
> -
> -This MDIO bus multiplexer defines buses that could be internal as well as
> -external to SoCs and could accept MDIO transaction compatible to C-22 or
> -C-45 Clause. When child bus is selected, one needs to select these two
> -properties as well to generate desired MDIO transaction on appropriate bus.
> -
> -Required properties in addition to the generic multiplexer properties:
> -
> -MDIO multiplexer node:
> -- compatible: brcm,mdio-mux-iproc.
> -
> -Every non-ethernet PHY requires a compatible so that it could be probed based
> -on this compatible string.
> -
> -Optional properties:
> -- clocks: phandle of the core clock which drives the mdio block.
> -
> -Additional information regarding generic multiplexer properties can be found
> -at- Documentation/devicetree/bindings/net/mdio-mux.yaml
> -
> -
> -for example:
> -		mdio_mux_iproc: mdio-mux@66020000 {
> -			compatible = "brcm,mdio-mux-iproc";
> -			reg = <0x66020000 0x250>;
> -			#address-cells = <1>;
> -			#size-cells = <0>;
> -
> -			mdio@0 {
> -				reg = <0x0>;
> -				#address-cells = <1>;
> -				#size-cells = <0>;
> -
> -				pci_phy0: pci-phy@0 {
> -					compatible = "brcm,ns2-pcie-phy";
> -					reg = <0x0>;
> -					#phy-cells = <0>;
> -				};
> -			};
> -
> -			mdio@7 {
> -				reg = <0x7>;
> -				#address-cells = <1>;
> -				#size-cells = <0>;
> -
> -				pci_phy1: pci-phy@0 {
> -					compatible = "brcm,ns2-pcie-phy";
> -					reg = <0x0>;
> -					#phy-cells = <0>;
> -				};
> -			};
> -			mdio@10 {
> -				reg = <0x10>;
> -				#address-cells = <1>;
> -				#size-cells = <0>;
> -
> -				gphy0: eth-phy@10 {
> -					reg = <0x10>;
> -				};
> -			};
> -		};
> diff --git a/Documentation/devicetree/bindings/net/brcm,mdio-mux-iproc.yaml b/Documentation/devicetree/bindings/net/brcm,mdio-mux-iproc.yaml
> new file mode 100644
> index 000000000000..a576fb87bfc8
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/brcm,mdio-mux-iproc.yaml
> @@ -0,0 +1,80 @@
> +# SPDX-License-Identifier: GPL-2.0

All Broadcom authors on the original. Please add BSD-2-Clause.

> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/brcm,mdio-mux-iproc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: MDIO bus multiplexer found in Broadcom iProc based SoCs.
> +
> +maintainers:
> +  - Florian Fainelli <f.fainelli@gmail.com>
> +
> +description:
> +  This MDIO bus multiplexer defines buses that could be internal as well as
> +  external to SoCs and could accept MDIO transaction compatible to C-22 or
> +  C-45 Clause. When child bus is selected, one needs to select these two
> +  properties as well to generate desired MDIO transaction on appropriate bus.
> +
> +allOf:
> +  - $ref: /schemas/net/mdio-mux.yaml#
> +
> +properties:
> +  compatible:
> +    const: brcm,mdio-mux-iproc
> +
> +  reg:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +    description: core clock driving the MDIO block
> +
> +
> +required:
> +  - compatible
> +  - reg
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    mdio_mux_iproc: mdio-mux@66020000 {
> +        compatible = "brcm,mdio-mux-iproc";
> +        reg = <0x66020000 0x250>;
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        mdio@0 {
> +           reg = <0x0>;
> +           #address-cells = <1>;
> +           #size-cells = <0>;
> +
> +           pci_phy0: pci-phy@0 {
> +              compatible = "brcm,ns2-pcie-phy";
> +              reg = <0x0>;
> +              #phy-cells = <0>;
> +           };
> +        };
> +
> +        mdio@7 {
> +           reg = <0x7>;
> +           #address-cells = <1>;
> +           #size-cells = <0>;
> +
> +           pci_phy1: pci-phy@0 {
> +              compatible = "brcm,ns2-pcie-phy";
> +              reg = <0x0>;
> +              #phy-cells = <0>;
> +           };
> +        };
> +
> +        mdio@10 {
> +           reg = <0x10>;
> +           #address-cells = <1>;
> +           #size-cells = <0>;
> +
> +           gphy0: eth-phy@10 {
> +              reg = <0x10>;
> +           };
> +        };
> +    };
> -- 
> 2.25.1
> 
>
Florian Fainelli Dec. 1, 2021, 7:48 p.m. UTC | #3
On 12/1/21 11:06 AM, Rob Herring wrote:

[snip]

>> diff --git a/Documentation/devicetree/bindings/net/brcm,mdio-mux-iproc.yaml b/Documentation/devicetree/bindings/net/brcm,mdio-mux-iproc.yaml
>> new file mode 100644
>> index 000000000000..a576fb87bfc8
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/net/brcm,mdio-mux-iproc.yaml
>> @@ -0,0 +1,80 @@
>> +# SPDX-License-Identifier: GPL-2.0
> 
> All Broadcom authors on the original. Please add BSD-2-Clause.

Sure, please review v2 and let me know if there are other changes that
should be done, v2 was sent before you had a chance to reply to this one.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/net/brcm,mdio-mux-iproc.txt b/Documentation/devicetree/bindings/net/brcm,mdio-mux-iproc.txt
deleted file mode 100644
index deb9e852ea27..000000000000
--- a/Documentation/devicetree/bindings/net/brcm,mdio-mux-iproc.txt
+++ /dev/null
@@ -1,62 +0,0 @@ 
-Properties for an MDIO bus multiplexer found in Broadcom iProc based SoCs.
-
-This MDIO bus multiplexer defines buses that could be internal as well as
-external to SoCs and could accept MDIO transaction compatible to C-22 or
-C-45 Clause. When child bus is selected, one needs to select these two
-properties as well to generate desired MDIO transaction on appropriate bus.
-
-Required properties in addition to the generic multiplexer properties:
-
-MDIO multiplexer node:
-- compatible: brcm,mdio-mux-iproc.
-
-Every non-ethernet PHY requires a compatible so that it could be probed based
-on this compatible string.
-
-Optional properties:
-- clocks: phandle of the core clock which drives the mdio block.
-
-Additional information regarding generic multiplexer properties can be found
-at- Documentation/devicetree/bindings/net/mdio-mux.yaml
-
-
-for example:
-		mdio_mux_iproc: mdio-mux@66020000 {
-			compatible = "brcm,mdio-mux-iproc";
-			reg = <0x66020000 0x250>;
-			#address-cells = <1>;
-			#size-cells = <0>;
-
-			mdio@0 {
-				reg = <0x0>;
-				#address-cells = <1>;
-				#size-cells = <0>;
-
-				pci_phy0: pci-phy@0 {
-					compatible = "brcm,ns2-pcie-phy";
-					reg = <0x0>;
-					#phy-cells = <0>;
-				};
-			};
-
-			mdio@7 {
-				reg = <0x7>;
-				#address-cells = <1>;
-				#size-cells = <0>;
-
-				pci_phy1: pci-phy@0 {
-					compatible = "brcm,ns2-pcie-phy";
-					reg = <0x0>;
-					#phy-cells = <0>;
-				};
-			};
-			mdio@10 {
-				reg = <0x10>;
-				#address-cells = <1>;
-				#size-cells = <0>;
-
-				gphy0: eth-phy@10 {
-					reg = <0x10>;
-				};
-			};
-		};
diff --git a/Documentation/devicetree/bindings/net/brcm,mdio-mux-iproc.yaml b/Documentation/devicetree/bindings/net/brcm,mdio-mux-iproc.yaml
new file mode 100644
index 000000000000..a576fb87bfc8
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/brcm,mdio-mux-iproc.yaml
@@ -0,0 +1,80 @@ 
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/brcm,mdio-mux-iproc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: MDIO bus multiplexer found in Broadcom iProc based SoCs.
+
+maintainers:
+  - Florian Fainelli <f.fainelli@gmail.com>
+
+description:
+  This MDIO bus multiplexer defines buses that could be internal as well as
+  external to SoCs and could accept MDIO transaction compatible to C-22 or
+  C-45 Clause. When child bus is selected, one needs to select these two
+  properties as well to generate desired MDIO transaction on appropriate bus.
+
+allOf:
+  - $ref: /schemas/net/mdio-mux.yaml#
+
+properties:
+  compatible:
+    const: brcm,mdio-mux-iproc
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+    description: core clock driving the MDIO block
+
+
+required:
+  - compatible
+  - reg
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    mdio_mux_iproc: mdio-mux@66020000 {
+        compatible = "brcm,mdio-mux-iproc";
+        reg = <0x66020000 0x250>;
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        mdio@0 {
+           reg = <0x0>;
+           #address-cells = <1>;
+           #size-cells = <0>;
+
+           pci_phy0: pci-phy@0 {
+              compatible = "brcm,ns2-pcie-phy";
+              reg = <0x0>;
+              #phy-cells = <0>;
+           };
+        };
+
+        mdio@7 {
+           reg = <0x7>;
+           #address-cells = <1>;
+           #size-cells = <0>;
+
+           pci_phy1: pci-phy@0 {
+              compatible = "brcm,ns2-pcie-phy";
+              reg = <0x0>;
+              #phy-cells = <0>;
+           };
+        };
+
+        mdio@10 {
+           reg = <0x10>;
+           #address-cells = <1>;
+           #size-cells = <0>;
+
+           gphy0: eth-phy@10 {
+              reg = <0x10>;
+           };
+        };
+    };