| Message ID | 20210920095218.1108151-9-horatiu.vultur@microchip.com |
|---|---|
| State | RFC |
| Headers | show |
| Series | Add lan966x driver | expand |
On Mon, Sep 20, 2021 at 11:52:14AM +0200, Horatiu Vultur wrote: > Document the lan966x switch device driver bindings > > Signed-off-by: Horatiu Vultur <horatiu.vultur@microchip.com> > --- > .../net/microchip,lan966x-switch.yaml | 114 ++++++++++++++++++ > 1 file changed, 114 insertions(+) > create mode 100644 Documentation/devicetree/bindings/net/microchip,lan966x-switch.yaml > > diff --git a/Documentation/devicetree/bindings/net/microchip,lan966x-switch.yaml b/Documentation/devicetree/bindings/net/microchip,lan966x-switch.yaml > new file mode 100644 > index 000000000000..53d72a65c168 > --- /dev/null > +++ b/Documentation/devicetree/bindings/net/microchip,lan966x-switch.yaml > @@ -0,0 +1,114 @@ > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/net/microchip,lan966x-switch.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Microchip Lan966x Ethernet switch controller > + > +maintainers: > + - Horatiu Vultur <horatiu.vultur@microchip.com> > + - UNGLinuxDriver@microchip.com > + > +description: | > + The Lan966x 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). > + > +properties: > + $nodename: > + pattern: "^switch@[0-9a-f]+$" > + > + compatible: > + const: microchip,lan966x-switch > + > + reg: > + items: > + - description: cpu target > + - description: devices target > + - description: general control block target > + > + reg-names: > + items: > + - const: cpu > + - const: devices > + - const: gcb > + > + interrupts: > + minItems: 1 Don't need minItems unless it is less than number of entries for 'items'. > + items: > + - description: register based extraction > + > + interrupt-names: > + minItems: 1 > + items: > + - const: xtr > + > + mac-address: true > + > + ethernet-ports: > + type: object > + patternProperties: > + "^port@[0-9a-f]+$": ethernet-port is preferred on new bindings. > + type: object > + > + properties: > + '#address-cells': > + const: 1 > + '#size-cells': > + const: 0 > + > + reg: > + description: Switch port number > + > + phy-mode: > + description: > + This specifies the interface used by the Ethernet SerDes towards > + the PHY or SFP. > + > + phy-handle: > + description: > + phandle of a Ethernet PHY. > + > + required: > + - reg > + - phy-mode > + - phy-handle > + > +required: > + - compatible > + - reg > + - reg-names > + - interrupts > + - interrupt-names > + - ethernet-ports > + > +additionalProperties: false > + > +examples: > + - | > + #include <dt-bindings/interrupt-controller/arm-gic.h> > + switch: switch@600000000 { Drop unused labels. > + compatible = "microchip,lan966x-switch"; > + reg = <0 0x401000>, > + <0x10004000 0x7fc000>, > + <0x11010000 0xaf0000>; > + reg-names = "cpu", "devices", "gcb"; > + interrupts = <GIC_SPI 30 IRQ_TYPE_LEVEL_HIGH>; > + interrupt-names = "xtr"; > + ethernet-ports { > + #address-cells = <1>; > + #size-cells = <0>; > + > + port0: port@0 { > + reg = <0>; > + phy-handle = <&phy0>; > + phy-mode = "gmii"; > + }; > + }; > + }; > + > +... > +# vim: set ts=2 sw=2 sts=2 tw=80 et cc=80 ft=yaml : Ummm, no. > -- > 2.31.1 > >
diff --git a/Documentation/devicetree/bindings/net/microchip,lan966x-switch.yaml b/Documentation/devicetree/bindings/net/microchip,lan966x-switch.yaml new file mode 100644 index 000000000000..53d72a65c168 --- /dev/null +++ b/Documentation/devicetree/bindings/net/microchip,lan966x-switch.yaml @@ -0,0 +1,114 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/net/microchip,lan966x-switch.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Microchip Lan966x Ethernet switch controller + +maintainers: + - Horatiu Vultur <horatiu.vultur@microchip.com> + - UNGLinuxDriver@microchip.com + +description: | + The Lan966x 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). + +properties: + $nodename: + pattern: "^switch@[0-9a-f]+$" + + compatible: + const: microchip,lan966x-switch + + reg: + items: + - description: cpu target + - description: devices target + - description: general control block target + + reg-names: + items: + - const: cpu + - const: devices + - const: gcb + + interrupts: + minItems: 1 + items: + - description: register based extraction + + interrupt-names: + minItems: 1 + items: + - const: xtr + + mac-address: true + + ethernet-ports: + type: object + patternProperties: + "^port@[0-9a-f]+$": + type: object + + properties: + '#address-cells': + const: 1 + '#size-cells': + const: 0 + + reg: + description: Switch port number + + phy-mode: + description: + This specifies the interface used by the Ethernet SerDes towards + the PHY or SFP. + + phy-handle: + description: + phandle of a Ethernet PHY. + + required: + - reg + - phy-mode + - phy-handle + +required: + - compatible + - reg + - reg-names + - interrupts + - interrupt-names + - ethernet-ports + +additionalProperties: false + +examples: + - | + #include <dt-bindings/interrupt-controller/arm-gic.h> + switch: switch@600000000 { + compatible = "microchip,lan966x-switch"; + reg = <0 0x401000>, + <0x10004000 0x7fc000>, + <0x11010000 0xaf0000>; + reg-names = "cpu", "devices", "gcb"; + interrupts = <GIC_SPI 30 IRQ_TYPE_LEVEL_HIGH>; + interrupt-names = "xtr"; + ethernet-ports { + #address-cells = <1>; + #size-cells = <0>; + + port0: port@0 { + reg = <0>; + phy-handle = <&phy0>; + phy-mode = "gmii"; + }; + }; + }; + +... +# vim: set ts=2 sw=2 sts=2 tw=80 et cc=80 ft=yaml :
Document the lan966x switch device driver bindings Signed-off-by: Horatiu Vultur <horatiu.vultur@microchip.com> --- .../net/microchip,lan966x-switch.yaml | 114 ++++++++++++++++++ 1 file changed, 114 insertions(+) create mode 100644 Documentation/devicetree/bindings/net/microchip,lan966x-switch.yaml