diff mbox series

dt-bindings: net: orion-mdio: Convert to JSON schema

Message ID 20220504043603.949134-1-chris.packham@alliedtelesis.co.nz
State Superseded, archived
Headers show
Series dt-bindings: net: orion-mdio: Convert to JSON schema | expand

Checks

Context Check Description
robh/checkpatch warning total: 0 errors, 1 warnings, 62 lines checked
robh/patch-applied success
robh/dtbs-check warning build log
robh/dt-meta-schema success

Commit Message

Chris Packham May 4, 2022, 4:36 a.m. UTC 
Convert the marvell,orion-mdio binding to JSON schema.

Signed-off-by: Chris Packham <chris.packham@alliedtelesis.co.nz>
---

Notes:
    Thomas, Antione & Florian I hope you don't mind me putting you as
    maintainers of the binding. Between you you've written the majority of
    the mvmdio.c driver.
    
    This does throw up the following dtbs_check warnings for turris-mox:
    
    arch/arm64/boot/dts/marvell/armada-3720-turris-mox.dtb: mdio@32004: switch0@10:reg: [[16], [0]] is too long
            From schema: Documentation/devicetree/bindings/net/marvell,orion-mdio.yaml
    arch/arm64/boot/dts/marvell/armada-3720-turris-mox.dtb: mdio@32004: switch0@2:reg: [[2], [0]] is too long
            From schema: Documentation/devicetree/bindings/net/marvell,orion-mdio.yaml
    arch/arm64/boot/dts/marvell/armada-3720-turris-mox.dtb: mdio@32004: switch1@11:reg: [[17], [0]] is too long
            From schema: Documentation/devicetree/bindings/net/marvell,orion-mdio.yaml
    arch/arm64/boot/dts/marvell/armada-3720-turris-mox.dtb: mdio@32004: switch1@2:reg: [[2], [0]] is too long
            From schema: Documentation/devicetree/bindings/net/marvell,orion-mdio.yaml
    arch/arm64/boot/dts/marvell/armada-3720-turris-mox.dtb: mdio@32004: switch2@12:reg: [[18], [0]] is too long
            From schema: Documentation/devicetree/bindings/net/marvell,orion-mdio.yaml
    arch/arm64/boot/dts/marvell/armada-3720-turris-mox.dtb: mdio@32004: switch2@2:reg: [[2], [0]] is too long
            From schema: Documentation/devicetree/bindings/net/marvell,orion-mdio.yaml
    
    I think they're all genuine but I'm hesitant to leap in and fix them
    without being able to test them.
    
    I also need to set unevaluatedProperties: true to cater for the L2
    switch on turris-mox (and probably others). That might be better tackled
    in the core mdio.yaml schema but I wasn't planning on touching that.

 .../bindings/net/marvell,orion-mdio.yaml      | 62 +++++++++++++++++++
 .../bindings/net/marvell-orion-mdio.txt       | 54 ----------------
 2 files changed, 62 insertions(+), 54 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/net/marvell,orion-mdio.yaml
 delete mode 100644 Documentation/devicetree/bindings/net/marvell-orion-mdio.txt

Comments

Andrew Lunn May 4, 2022, 9:35 p.m. UTC | #1 
On Wed, May 04, 2022 at 04:36:02PM +1200, Chris Packham wrote:
> Convert the marvell,orion-mdio binding to JSON schema.
> 
> Signed-off-by: Chris Packham <chris.packham@alliedtelesis.co.nz>
> ---
> 
> Notes:
>     Thomas, Antione & Florian I hope you don't mind me putting you as
>     maintainers of the binding. Between you you've written the majority of
>     the mvmdio.c driver.

I actually think it will be me doing any maintenance work on that
driver.

>     This does throw up the following dtbs_check warnings for turris-mox:
>     
>     arch/arm64/boot/dts/marvell/armada-3720-turris-mox.dtb: mdio@32004: switch0@10:reg: [[16], [0]] is too long
>             From schema: Documentation/devicetree/bindings/net/marvell,orion-mdio.yaml

I assume this is coming from

		reg = <0x10 0>;

This is odd. Lets see what Marek Behún has to say.

     Andrew
Chris Packham May 4, 2022, 9:44 p.m. UTC | #2 
On 5/05/22 09:35, Andrew Lunn wrote:
> On Wed, May 04, 2022 at 04:36:02PM +1200, Chris Packham wrote:
>> Convert the marvell,orion-mdio binding to JSON schema.
>>
>> Signed-off-by: Chris Packham <chris.packham@alliedtelesis.co.nz>
>> ---
>>
>> Notes:
>>      Thomas, Antione & Florian I hope you don't mind me putting you as
>>      maintainers of the binding. Between you you've written the majority of
>>      the mvmdio.c driver.
> I actually think it will be me doing any maintenance work on that
> driver.
I didn't want to assume. But thanks for volunteering. I'll see if 
there's any other comments and send a v2 with you as maintainer for the 
binding tomorrow.
>>      This does throw up the following dtbs_check warnings for turris-mox:
>>      
>>      arch/arm64/boot/dts/marvell/armada-3720-turris-mox.dtb: mdio@32004: switch0@10:reg: [[16], [0]] is too long
>>              From schema: Documentation/devicetree/bindings/net/marvell,orion-mdio.yaml
> I assume this is coming from
>
> 		reg = <0x10 0>;
>
> This is odd. Lets see what Marek Behún has to say.
>
>       Andrew
Marek Behún May 7, 2022, 10:29 a.m. UTC | #3 
On Wed, 4 May 2022 23:35:59 +0200
Andrew Lunn <andrew@lunn.ch> wrote:

> On Wed, May 04, 2022 at 04:36:02PM +1200, Chris Packham wrote:
> > Convert the marvell,orion-mdio binding to JSON schema.
> > 
> > Signed-off-by: Chris Packham <chris.packham@alliedtelesis.co.nz>
> > ---
> > 
> > Notes:
> >     Thomas, Antione & Florian I hope you don't mind me putting you as
> >     maintainers of the binding. Between you you've written the majority of
> >     the mvmdio.c driver.  
> 
> I actually think it will be me doing any maintenance work on that
> driver.
> 
> >     This does throw up the following dtbs_check warnings for turris-mox:
> >     
> >     arch/arm64/boot/dts/marvell/armada-3720-turris-mox.dtb: mdio@32004: switch0@10:reg: [[16], [0]] is too long
> >             From schema: Documentation/devicetree/bindings/net/marvell,orion-mdio.yaml  
> 
> I assume this is coming from
> 
> 		reg = <0x10 0>;
> 
> This is odd. Lets see what Marek Behún has to say.

Looks like a mistake on my part.

Marek
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/net/marvell,orion-mdio.yaml b/Documentation/devicetree/bindings/net/marvell,orion-mdio.yaml
new file mode 100644
index 000000000000..43cd896a0851
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/marvell,orion-mdio.yaml
@@ -0,0 +1,62 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/marvell,orion-mdio.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Marvell MDIO Ethernet Controller interface
+
+maintainers:
+  - Antoine Tenart <atenart@kernel.org>
+  - Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
+  - Florian Fainelli <f.fainelli@gmail.com>
+
+description: |
+  The Ethernet controllers of the Marvel Kirkwood, Dove, Orion5x, MV78xx0,
+  Armada 370, Armada XP, Armada 7k and Armada 8k have an identical unit that
+  provides an interface with the MDIO bus. Additionally, Armada 7k and Armada
+  8k has a second unit which provides an interface with the xMDIO bus. This
+  driver handles these interfaces.
+
+allOf:
+  - $ref: "mdio.yaml#"
+
+properties:
+  compatible:
+    enum:
+      - marvell,orion-mdio
+      - marvell,xmdio
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    minItems: 1
+    maxItems: 4
+
+required:
+  - compatible
+  - reg
+
+unevaluatedProperties: true
+
+examples:
+  - |
+    mdio@d0072004 {
+      compatible = "marvell,orion-mdio";
+      reg = <0xd0072004 0x4>;
+      #address-cells = <1>;
+      #size-cells = <0>;
+      interrupts = <30>;
+
+      phy0: ethernet-phy@0 {
+        reg = <0>;
+      };
+
+      phy1: ethernet-phy@1 {
+        reg = <1>;
+      };
+    };
diff --git a/Documentation/devicetree/bindings/net/marvell-orion-mdio.txt b/Documentation/devicetree/bindings/net/marvell-orion-mdio.txt
deleted file mode 100644
index 3f3cfc1d8d4d..000000000000
--- a/Documentation/devicetree/bindings/net/marvell-orion-mdio.txt
+++ /dev/null
@@ -1,54 +0,0 @@ 
-* Marvell MDIO Ethernet Controller interface
-
-The Ethernet controllers of the Marvel Kirkwood, Dove, Orion5x,
-MV78xx0, Armada 370, Armada XP, Armada 7k and Armada 8k have an
-identical unit that provides an interface with the MDIO bus.
-Additionally, Armada 7k and Armada 8k has a second unit which
-provides an interface with the xMDIO bus. This driver handles
-these interfaces.
-
-Required properties:
-- compatible: "marvell,orion-mdio" or "marvell,xmdio"
-- reg: address and length of the MDIO registers.  When an interrupt is
-  not present, the length is the size of the SMI register (4 bytes)
-  otherwise it must be 0x84 bytes to cover the interrupt control
-  registers.
-
-Optional properties:
-- interrupts: interrupt line number for the SMI error/done interrupt
-- clocks: phandle for up to four required clocks for the MDIO instance
-
-The child nodes of the MDIO driver are the individual PHY devices
-connected to this MDIO bus. They must have a "reg" property given the
-PHY address on the MDIO bus.
-
-Example at the SoC level without an interrupt property:
-
-mdio {
-	#address-cells = <1>;
-	#size-cells = <0>;
-	compatible = "marvell,orion-mdio";
-	reg = <0xd0072004 0x4>;
-};
-
-Example with an interrupt property:
-
-mdio {
-	#address-cells = <1>;
-	#size-cells = <0>;
-	compatible = "marvell,orion-mdio";
-	reg = <0xd0072004 0x84>;
-	interrupts = <30>;
-};
-
-And at the board level:
-
-mdio {
-	phy0: ethernet-phy@0 {
-		reg = <0>;
-	};
-
-	phy1: ethernet-phy@1 {
-		reg = <1>;
-	};
-}