diff mbox series

[RFC,v2,1/8] dt-bindings: net: sparx5: Add sparx5-switch bindings

Message ID 20201217075134.919699-2-steen.hegelund@microchip.com
State New
Headers show
Series [RFC,v2,1/8] dt-bindings: net: sparx5: Add sparx5-switch bindings | expand

Commit Message

Steen Hegelund Dec. 17, 2020, 7:51 a.m. UTC
Document the Sparx5 switch device driver bindings

Signed-off-by: Steen Hegelund <steen.hegelund@microchip.com>
Signed-off-by: Lars Povlsen <lars.povlsen@microchip.com>
---
 .../bindings/net/microchip,sparx5-switch.yaml | 178 ++++++++++++++++++
 1 file changed, 178 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/net/microchip,sparx5-switch.yaml

Comments

Andrew Lunn Dec. 19, 2020, 5:54 p.m. UTC | #1
On Thu, Dec 17, 2020 at 08:51:27AM +0100, Steen Hegelund wrote:
> Document the Sparx5 switch device driver bindings

> 

> Signed-off-by: Steen Hegelund <steen.hegelund@microchip.com>

> Signed-off-by: Lars Povlsen <lars.povlsen@microchip.com>


Reviewed-by: Andrew Lunn <andrew@lunn.ch>


    Andrew
Florian Fainelli Dec. 21, 2020, 12:55 a.m. UTC | #2
On 12/16/2020 11:51 PM, Steen Hegelund wrote:
> Document the Sparx5 switch device driver bindings

> 

> Signed-off-by: Steen Hegelund <steen.hegelund@microchip.com>

> Signed-off-by: Lars Povlsen <lars.povlsen@microchip.com>

> ---


[snip]

> +          max-speed:

> +            maxItems: 1

> +            description: Bandwidth allocated to this port

> +

> +          phys:

> +            description: phandle of a Ethernet Serdes PHY

> +

> +          phy-handle:

> +            description: phandle of a Ethernet PHY

> +

> +          phy-mode:

> +            description: Interface between the serdes and the phy


Can you specify this pertains to the Serdes and Ethernet PHY?
-- 
Florian
Steen Hegelund Dec. 21, 2020, 10 a.m. UTC | #3
On Sun, 2020-12-20 at 16:55 -0800, Florian Fainelli wrote:
> EXTERNAL EMAIL: Do not click links or open attachments unless you

> know the content is safe

> 

> On 12/16/2020 11:51 PM, Steen Hegelund wrote:

> > Document the Sparx5 switch device driver bindings

> > 

> > Signed-off-by: Steen Hegelund <steen.hegelund@microchip.com>

> > Signed-off-by: Lars Povlsen <lars.povlsen@microchip.com>

> > ---

> 

> [snip]

> 

> > +          max-speed:

> > +            maxItems: 1

> > +            description: Bandwidth allocated to this port

> > +

> > +          phys:

> > +            description: phandle of a Ethernet Serdes PHY

> > +

> > +          phy-handle:

> > +            description: phandle of a Ethernet PHY

> > +

> > +          phy-mode:

> > +            description: Interface between the serdes and the phy

> 

> Can you specify this pertains to the Serdes and Ethernet PHY?

Hi Florian,

Yes: I will clarify that phy-mode is for the optional Ethernet cuPHY.

Thanks for your comments
Steen

> --

> Florian
Rob Herring Dec. 21, 2020, 9:40 p.m. UTC | #4
On Thu, Dec 17, 2020 at 08:51:27AM +0100, Steen Hegelund wrote:
> Document the Sparx5 switch device driver bindings

> 

> Signed-off-by: Steen Hegelund <steen.hegelund@microchip.com>

> Signed-off-by: Lars Povlsen <lars.povlsen@microchip.com>

> ---

>  .../bindings/net/microchip,sparx5-switch.yaml | 178 ++++++++++++++++++

>  1 file changed, 178 insertions(+)

>  create mode 100644 Documentation/devicetree/bindings/net/microchip,sparx5-switch.yaml

> 

> diff --git a/Documentation/devicetree/bindings/net/microchip,sparx5-switch.yaml b/Documentation/devicetree/bindings/net/microchip,sparx5-switch.yaml

> new file mode 100644

> index 000000000000..6e3ef8285e9a

> --- /dev/null

> +++ b/Documentation/devicetree/bindings/net/microchip,sparx5-switch.yaml

> @@ -0,0 +1,178 @@

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

> +%YAML 1.2

> +---

> +$id: http://devicetree.org/schemas/net/microchip,sparx5-switch.yaml#

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

> +

> +title: Microchip Sparx5 Ethernet switch controller

> +

> +maintainers:

> +  - Lars Povlsen <lars.povlsen@microchip.com>

> +  - Steen Hegelund <steen.hegelund@microchip.com>

> +

> +description: |

> +  The SparX-5 Enterprise Ethernet switch family provides a rich set of

> +  Enterprise switching features such as advanced TCAM-based VLAN and

> +  QoS processing enabling delivery of differentiated services, and

> +  security through TCAM-based frame processing using versatile content

> +  aware processor (VCAP).

> +

> +  IPv4/IPv6 Layer 3 (L3) unicast and multicast routing is supported

> +  with up to 18K IPv4/9K IPv6 unicast LPM entries and up to 9K IPv4/3K

> +  IPv6 (S,G) multicast groups.

> +

> +  L3 security features include source guard and reverse path

> +  forwarding (uRPF) tasks. Additional L3 features include VRF-Lite and

> +  IP tunnels (IP over GRE/IP).

> +

> +  The SparX-5 switch family targets managed Layer 2 and Layer 3

> +  equipment in SMB, SME, and Enterprise where high port count

> +  1G/2.5G/5G/10G switching with 10G/25G aggregation links is required.

> +

> +properties:

> +  $nodename:

> +    pattern: "^switch@[0-9a-f]+$"

> +

> +  compatible:

> +    const: microchip,sparx5-switch

> +

> +  reg:

> +    minItems: 2

> +

> +  reg-names:

> +    minItems: 2


This is the default based on 'items' length.

> +    items:

> +      - const: devices

> +      - const: gcb

> +

> +  interrupts:

> +    maxItems: 1

> +    description: Interrupt used for reception of packets to the CPU

> +

> +  ethernet-ports:

> +    type: object

> +    properties:

> +      '#address-cells':

> +        const: 1

> +      '#size-cells':

> +        const: 0

> +

> +    patternProperties:

> +      "^port@[0-9]+$":

> +        type: object

> +        description: Switch ports

> +

> +        allOf:

> +          - $ref: ethernet-controller.yaml#

> +

> +        properties:

> +          reg:

> +            description: Switch port number

> +

> +          max-speed:

> +            maxItems: 1


Is that an array?

> +            description: Bandwidth allocated to this port

> +

> +          phys:


How many? (maxItems)

> +            description: phandle of a Ethernet Serdes PHY

> +

> +          phy-handle:

> +            description: phandle of a Ethernet PHY

> +

> +          phy-mode:

> +            description: Interface between the serdes and the phy


The whole set of modes defined is supported?

> +

> +          sfp:

> +            description: phandle of an SFP

> +

> +          managed:

> +            maxItems: 1


An array?

> +            description: SFP management

> +

> +        required:

> +          - reg

> +          - max-speed

> +          - phys

> +

> +        oneOf:

> +          - required:

> +              - phy-handle

> +              - phy-mode

> +          - required:

> +              - sfp

> +              - managed

> +

> +        additionalProperties: false

> +

> +required:

> +  - compatible

> +  - reg

> +  - reg-names

> +  - interrupts

> +  - ethernet-ports

> +

> +additionalProperties: false

> +

> +examples:

> +  - |

> +    #include <dt-bindings/interrupt-controller/arm-gic.h>

> +    switch: switch@600000000 {

> +      compatible = "microchip,sparx5-switch";

> +      reg =  <0x10000000 0x800000>,

> +             <0x11010000 0x1b00000>;

> +      reg-names = "devices", "gcb";

> +

> +      interrupts = <GIC_SPI 30 IRQ_TYPE_LEVEL_HIGH>;

> +      ethernet-ports {

> +        #address-cells = <1>;

> +        #size-cells = <0>;

> +

> +        port0: port@0 {

> +          reg = <0>;

> +          max-speed = <1000>;

> +          phys = <&serdes 13>;

> +          phy-handle = <&phy0>;

> +          phy-mode = "qsgmii";

> +        };

> +        /* ... */

> +        /* Then the 25G interfaces */

> +        port60: port@60 {

> +          reg = <60>;

> +          max-speed = <25000>;

> +          phys = <&serdes 29>;

> +          sfp = <&sfp_eth60>;

> +          managed = "in-band-status";

> +        };

> +        port61: port@61 {

> +          reg = <61>;

> +          max-speed = <25000>;

> +          phys = <&serdes 30>;

> +          sfp = <&sfp_eth61>;

> +          managed = "in-band-status";

> +        };

> +        port62: port@62 {

> +          reg = <62>;

> +          max-speed = <25000>;

> +          phys = <&serdes 31>;

> +          sfp = <&sfp_eth62>;

> +          managed = "in-band-status";

> +        };

> +        port63: port@63 {

> +          reg = <63>;

> +          max-speed = <25000>;

> +          phys = <&serdes 32>;

> +          sfp = <&sfp_eth63>;

> +          managed = "in-band-status";

> +        };

> +        /* Finally the Management interface */

> +        port64: port@64 {

> +          reg = <64>;

> +          max-speed = <1000>;

> +          phys = <&serdes 0>;

> +          phy-handle = <&phy64>;

> +          phy-mode = "sgmii";

> +        };

> +      };

> +    };

> +

> +...

> -- 

> 2.29.2

>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/net/microchip,sparx5-switch.yaml b/Documentation/devicetree/bindings/net/microchip,sparx5-switch.yaml
new file mode 100644
index 000000000000..6e3ef8285e9a
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/microchip,sparx5-switch.yaml
@@ -0,0 +1,178 @@ 
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/microchip,sparx5-switch.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Microchip Sparx5 Ethernet switch controller
+
+maintainers:
+  - Lars Povlsen <lars.povlsen@microchip.com>
+  - Steen Hegelund <steen.hegelund@microchip.com>
+
+description: |
+  The SparX-5 Enterprise Ethernet switch family provides a rich set of
+  Enterprise switching features such as advanced TCAM-based VLAN and
+  QoS processing enabling delivery of differentiated services, and
+  security through TCAM-based frame processing using versatile content
+  aware processor (VCAP).
+
+  IPv4/IPv6 Layer 3 (L3) unicast and multicast routing is supported
+  with up to 18K IPv4/9K IPv6 unicast LPM entries and up to 9K IPv4/3K
+  IPv6 (S,G) multicast groups.
+
+  L3 security features include source guard and reverse path
+  forwarding (uRPF) tasks. Additional L3 features include VRF-Lite and
+  IP tunnels (IP over GRE/IP).
+
+  The SparX-5 switch family targets managed Layer 2 and Layer 3
+  equipment in SMB, SME, and Enterprise where high port count
+  1G/2.5G/5G/10G switching with 10G/25G aggregation links is required.
+
+properties:
+  $nodename:
+    pattern: "^switch@[0-9a-f]+$"
+
+  compatible:
+    const: microchip,sparx5-switch
+
+  reg:
+    minItems: 2
+
+  reg-names:
+    minItems: 2
+    items:
+      - const: devices
+      - const: gcb
+
+  interrupts:
+    maxItems: 1
+    description: Interrupt used for reception of packets to the CPU
+
+  ethernet-ports:
+    type: object
+    properties:
+      '#address-cells':
+        const: 1
+      '#size-cells':
+        const: 0
+
+    patternProperties:
+      "^port@[0-9]+$":
+        type: object
+        description: Switch ports
+
+        allOf:
+          - $ref: ethernet-controller.yaml#
+
+        properties:
+          reg:
+            description: Switch port number
+
+          max-speed:
+            maxItems: 1
+            description: Bandwidth allocated to this port
+
+          phys:
+            description: phandle of a Ethernet Serdes PHY
+
+          phy-handle:
+            description: phandle of a Ethernet PHY
+
+          phy-mode:
+            description: Interface between the serdes and the phy
+
+          sfp:
+            description: phandle of an SFP
+
+          managed:
+            maxItems: 1
+            description: SFP management
+
+        required:
+          - reg
+          - max-speed
+          - phys
+
+        oneOf:
+          - required:
+              - phy-handle
+              - phy-mode
+          - required:
+              - sfp
+              - managed
+
+        additionalProperties: false
+
+required:
+  - compatible
+  - reg
+  - reg-names
+  - interrupts
+  - ethernet-ports
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    switch: switch@600000000 {
+      compatible = "microchip,sparx5-switch";
+      reg =  <0x10000000 0x800000>,
+             <0x11010000 0x1b00000>;
+      reg-names = "devices", "gcb";
+
+      interrupts = <GIC_SPI 30 IRQ_TYPE_LEVEL_HIGH>;
+      ethernet-ports {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        port0: port@0 {
+          reg = <0>;
+          max-speed = <1000>;
+          phys = <&serdes 13>;
+          phy-handle = <&phy0>;
+          phy-mode = "qsgmii";
+        };
+        /* ... */
+        /* Then the 25G interfaces */
+        port60: port@60 {
+          reg = <60>;
+          max-speed = <25000>;
+          phys = <&serdes 29>;
+          sfp = <&sfp_eth60>;
+          managed = "in-band-status";
+        };
+        port61: port@61 {
+          reg = <61>;
+          max-speed = <25000>;
+          phys = <&serdes 30>;
+          sfp = <&sfp_eth61>;
+          managed = "in-band-status";
+        };
+        port62: port@62 {
+          reg = <62>;
+          max-speed = <25000>;
+          phys = <&serdes 31>;
+          sfp = <&sfp_eth62>;
+          managed = "in-band-status";
+        };
+        port63: port@63 {
+          reg = <63>;
+          max-speed = <25000>;
+          phys = <&serdes 32>;
+          sfp = <&sfp_eth63>;
+          managed = "in-band-status";
+        };
+        /* Finally the Management interface */
+        port64: port@64 {
+          reg = <64>;
+          max-speed = <1000>;
+          phys = <&serdes 0>;
+          phy-handle = <&phy64>;
+          phy-mode = "sgmii";
+        };
+      };
+    };
+
+...