Re: [PATCH net-next v3 1/6] dt-bindings: marvell: Rewrite MV88E6xxx in schema

From: Vladimir Oltean
Date: Mon Oct 16 2023 - 07:09:06 EST

On Mon, Oct 16, 2023 at 11:12:54AM +0200, Linus Walleij wrote:
> This is an attempt to rewrite the Marvell MV88E6xxx switch bindings
> in YAML schema.
>
> The current text binding says:
> WARNING: This binding is currently unstable. Do not program it into a
> FLASH never to be changed again. Once this binding is stable, this
> warning will be removed.
>
> Well that never happened before we switched to YAML markup,
> we can't have it like this, what about fixing the mess?

Removing that remark seems in order.

>
> Signed-off-by: Linus Walleij <linus.walleij@xxxxxxxxxx>
> ---
> .../bindings/net/dsa/marvell,mv88e6xxx.yaml | 243 +++++++++++++++++++++
> .../devicetree/bindings/net/dsa/marvell.txt | 109 ---------
> MAINTAINERS | 2 +-
> 3 files changed, 244 insertions(+), 110 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/net/dsa/marvell,mv88e6xxx.yaml b/Documentation/devicetree/bindings/net/dsa/marvell,mv88e6xxx.yaml
> new file mode 100644
> index 000000000000..954db04147f8
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/dsa/marvell,mv88e6xxx.yaml
> @@ -0,0 +1,243 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/dsa/marvell,mv88e6xxx.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Marvell MV88E6xxx DSA switch family
> +
> +maintainers:
> + - Andrew Lunn <andrew@xxxxxxx>
> +
> +description:
> + The Marvell MV88E6xxx switch series has been produced and sold
> + by Marvell since at least 2010. The switch has a few compatibles which
> + just indicate the base address of the switch, then operating systems
> + can investigate switch ID registers to find out which actual version
> + of the switch it is dealing with.
> +
> +properties:
> + compatible:
> + oneOf:
> + - enum:
> + - marvell,mv88e6085
> + - marvell,mv88e6190
> + - marvell,mv88e6250
> + description: |
> + marvell,mv88e6085: This switch uses base address 0x10.
> + This switch and its siblings will be autodetected from
> + ID registers found in the switch, so only "marvell,mv88e6085" should be
> + specified. This includes the following list of MV88Exxxx switches:
> + 6085, 6095, 6097, 6123, 6131, 6141, 6161, 6165, 6171, 6172, 6175, 6176,
> + 6185, 6240, 6320, 6321, 6341, 6350, 6351, 6352
> + marvell,mv88e6190: This switch uses base address 0x00.
> + This switch and its siblings will be autodetected from
> + ID registers found in the switch, so only "marvell,mv88e6190" should be
> + specified. This includes the following list of MV88Exxxx switches:
> + 6190, 6190X, 6191, 6290, 6361, 6390, 6390X
> + marvell,mv88e6250: This switch uses base address 0x08 or 0x18.
> + This switch and its siblings will be autodetected from
> + ID registers found in the switch, so only "marvell,mv88e6250" should be
> + specified. This includes the following list of MV88Exxxx switches:
> + 6220, 6250
> +
> + reg:
> + maxItems: 1
> +
> + eeprom-length:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: Set to the length of an EEPROM connected to the switch. Must be
> + set if the switch can not detect the presence and/or size of a connected
> + EEPROM, otherwise optional.
> +
> + reset-gpios:
> + description:
> + GPIO to be used to reset the whole device
> + maxItems: 1
> +
> + interrupts:
> + description: The switch provides an external interrupt line, but it is
> + not always used by target systems.
> + maxItems: 1
> +
> + interrupt-controller:
> + description: The switch has an internal interrupt controller used by
> + the different sub-blocks.
> +
> + '#interrupt-cells':
> + description: The internal interrupt controller only supports triggering
> + on active high level interrupts so the second cell must alway be set to
> + IRQ_TYPE_LEVEL_HIGH.
> + const: 2
> +
> + mdio:
> + $ref: /schemas/net/mdio.yaml#
> + unevaluatedProperties: false
> + description: Marvell MV88E6xxx switches have an varying combination of
> + internal and external MDIO buses, in some cases a combined bus that
> + can be used both internally and externally. This node is for the
> + primary bus, used internally and sometimes also externally.
> +
> + mdio-external:
> + $ref: /schemas/net/mdio.yaml#
> + unevaluatedProperties: false
> + description: Marvell MV88E6xxx switches that have a separate external
> + MDIO bus use this port to access external components on the MDIO bus.
> +
> + properties:
> + compatible:
> + const: marvell,mv88e6xxx-mdio-external
> +
> + required:
> + - compatible
> +
> +$ref: dsa.yaml#
> +
> +patternProperties:
> + "^(ethernet-)?ports$":
> + type: object
> + patternProperties:
> + "^(ethernet-)?port@[0-9]+$":
> + type: object
> + description: Ethernet switch ports
> +
> + $ref: dsa-port.yaml#
> +
> + unevaluatedProperties: false
> +
> +oneOf:
> + - required:
> + - ports
> + - required:
> + - ethernet-ports
> +
> +required:
> + - compatible
> + - reg
> +
> +unevaluatedProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/gpio/gpio.h>
> + #include <dt-bindings/interrupt-controller/irq.h>
> + mdio {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + switch0: switch@0 {

ethernet-switch is preferred

> + compatible = "marvell,mv88e6085";
> + reg = <0>;
> + reset-gpios = <&gpio5 1 GPIO_ACTIVE_LOW>;
> + interrupt-parent = <&gpio0>;

I don't see interrupt-parent as an accepted property in the schema.
Should interrupts-extended also be accepted?

> + interrupts = <27 IRQ_TYPE_LEVEL_LOW>;
> + interrupt-controller;
> + #interrupt-cells = <2>;
> +
> + ports {

ethernet-ports is preferred

> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + port@0 {
> + reg = <0>;
> + label = "lan1";
> + };
> + port@1 {
> + reg = <1>;
> + label = "lan2";
> + };
> + port@2 {
> + reg = <2>;
> + label = "lan3";
> + };
> + port@3 {
> + reg = <3>;
> + label = "lan4";
> + };
> + port@4 {
> + reg = <4>;
> + label = "wan";
> + };
> +
> + port@5 {
> + reg = <5>;
> + phy-mode = "sgmii";
> + ethernet = <&eth2>;
> +
> + fixed-link {
> + speed = <1000>;
> + full-duplex;
> + };
> + };
> + };
> +
> + mdio {
> + #address-cells = <1>;
> + #size-cells = <0>;

One blank link here

> + switch0phy0: switch0phy@0 {

ethernet-phy@0

> + reg = <0>;
> + interrupt-parent = <&switch0>;
> + interrupts = <0 IRQ_TYPE_LEVEL_HIGH>;

interrupts-extended = <&switch0 0 IRQ_TYPE_LEVEL_HIGH>; would be shorter

> + };
> + };
> + };
> + };
> +
> + - |
> + #include <dt-bindings/gpio/gpio.h>
> + #include <dt-bindings/interrupt-controller/irq.h>
> + mdio {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + switch1: switch@0 {
> + compatible = "marvell,mv88e6190";
> + reg = <0>;
> + reset-gpios = <&gpio5 1 GPIO_ACTIVE_LOW>;
> + interrupt-parent = <&gpio0>;
> + interrupts = <27 IRQ_TYPE_LEVEL_LOW>;
> + interrupt-controller;
> + #interrupt-cells = <2>;
> +
> + ports {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + port@0 {
> + reg = <0>;
> + label = "lan1";
> + };
> + port@1 {
> + reg = <1>;
> + label = "lan2";
> + };
> + port@2 {
> + reg = <2>;
> + label = "lan3";
> + };
> + port@3 {
> + reg = <3>;
> + label = "lan4";
> + };

FWIW, this example would be rejected by real-life DSA, because a CPU
port is missing (no port has an "ethernet" phandle).

> + };
> +
> + mdio {
> + #address-cells = <1>;
> + #size-cells = <0>;
> + switch1phy0: switch1phy@0 {

ethernet-phy@0

> + reg = <0>;
> + interrupt-parent = <&switch1>;
> + interrupts = <0 IRQ_TYPE_LEVEL_HIGH>;
> + };
> + };
> +
> + mdio-external {
> + compatible = "marvell,mv88e6xxx-mdio-external";
> + #address-cells = <1>;
> + #size-cells = <0>;
> + switch1phy9: switch1phy@9 {

ethernet-phy@9

> + reg = <9>;
> + };
> + };
> + };
> + };