[PATCH v7 net-next 09/10] dt-bindings: net: add generic ethernet-switch-port binding

Colin Foster
2023-01-12T18:06:15Z

The dsa-port.yaml binding had several references that can be common to all
ethernet ports, not just dsa-specific ones. Break out the generic bindings
to ethernet-switch-port.yaml they can be used by non-dsa drivers.

Signed-off-by: Colin Foster <colin.foster@in-advantage.com>
Suggested-by: Vladimir Oltean <olteanv@gmail.com>
Reviewed-by: Florian Fainelli <f.fainelli@gmail.com>
Reviewed-by: Rob Herring <robh@kernel.org>
---

v6 -> v7
* Update Ethernet switch port description to have meaning
* Update DSA switch port description to suggest it has additional
features

v5 -> v6
* Minor change to fix conflict with the removal of "Device Tree
Binding" in the title line

v4 -> v5
* Add Rob Reviewed tag
* Change Vivien to Vladimir to match MAINTAINERS
* Capitalize all words in title line (Generic DSA Switch Port)
* Add better description of an Ethernet switch port

v3 -> v4
* Add Florian Reviewed tag

v2 -> v3
* Change dsa-port title from "DSA Switch port Device Tree Bindings"
to "Generic DSA Switch port"
* Add reference to ethernet-switch-port.yaml# in dsa-port.yaml
* Change title of ethernet-switch-port.yaml from "Ethernet Switch
port Device Tree Bindings" to "Generic Ethernet Switch port"
* Remove most properties from ethernet-switch-port.yaml. They're
all in ethernet-controller, and are all allowed.
* ethernet-switch.yaml now only references ethernet-switch-port.yaml#
under the port node.

v1 -> v2
* Remove accidental addition of
"$ref: /schemas/net/ethernet-switch-port.yaml" which should be kept
out of dsa-port so that it doesn't get referenced multiple times
through both ethernet-switch and dsa-port.

---
.../devicetree/bindings/net/dsa/dsa-port.yaml | 28 ++++---------------
.../bindings/net/ethernet-switch-port.yaml | 26 +++++++++++++++++
.../bindings/net/ethernet-switch.yaml | 6 +---
MAINTAINERS | 1 +
4 files changed, 33 insertions(+), 28 deletions(-)
create mode 100644 Documentation/devicetree/bindings/net/ethernet-switch-port.yaml

diff --git a/Documentation/devicetree/bindings/net/dsa/dsa-port.yaml b/Documentation/devicetree/bindings/net/dsa/dsa-port.yaml
index fb338486ce85..480120469953 100644
--- a/Documentation/devicetree/bindings/net/dsa/dsa-port.yaml
+++ b/Documentation/devicetree/bindings/net/dsa/dsa-port.yaml
@@ -4,7 +4,7 @@
$id: http://devicetree.org/schemas/net/dsa/dsa-port.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

-title: Ethernet Switch port
+title: Generic DSA Switch Port

maintainers:
- Andrew Lunn <andrew@lunn.ch>
@@ -12,10 +12,11 @@ maintainers:
- Vladimir Oltean <olteanv@gmail.com>

description:
- Ethernet switch port Description
+ A DSA switch port is a component of a switch that manages one MAC, and can
+ pass Ethernet frames. It can act as a stanadard Ethernet switch port, or have
+ DSA-specific functionality.

-allOf:
- - $ref: /schemas/net/ethernet-controller.yaml#
+$ref: /schemas/net/ethernet-switch-port.yaml#

properties:
reg:
@@ -58,25 +59,6 @@ properties:
- rtl8_4t
- seville

- phy-handle: true
-
- phy-mode: true
-
- fixed-link: true
-
- mac-address: true
-
- sfp: true
-
- managed: true
-
- rx-internal-delay-ps: true
-
- tx-internal-delay-ps: true
-
-required:
- - reg
-
# CPU and DSA ports must have phylink-compatible link descriptions
if:
oneOf:
diff --git a/Documentation/devicetree/bindings/net/ethernet-switch-port.yaml b/Documentation/devicetree/bindings/net/ethernet-switch-port.yaml
new file mode 100644
index 000000000000..d5cf7e40e3c3
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/ethernet-switch-port.yaml
@@ -0,0 +1,26 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/ethernet-switch-port.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Generic Ethernet Switch Port
+
+maintainers:
+ - Andrew Lunn <andrew@lunn.ch>
+ - Florian Fainelli <f.fainelli@gmail.com>
+ - Vladimir Oltean <olteanv@gmail.com>
+
+description:
+ An Ethernet switch port is a component of a switch that manages one MAC, and
+ can pass Ethernet frames.
+
+$ref: ethernet-controller.yaml#
+
+properties:
+ reg:
+ description: Port number
+
+additionalProperties: true
+
+...
diff --git a/Documentation/devicetree/bindings/net/ethernet-switch.yaml b/Documentation/devicetree/bindings/net/ethernet-switch.yaml
index 2466d05f9a6f..a04f8ef744aa 100644
--- a/Documentation/devicetree/bindings/net/ethernet-switch.yaml
+++ b/Documentation/devicetree/bindings/net/ethernet-switch.yaml
@@ -40,10 +40,6 @@ patternProperties:
type: object
description: Ethernet switch ports

- $ref: ethernet-controller.yaml#
-
- additionalProperties: true
-
oneOf:
- required:
- ports
@@ -60,7 +56,7 @@ $defs:
patternProperties:
"^(ethernet-)?port@[0-9]+$":
description: Ethernet switch ports
- $ref: ethernet-controller.yaml#
+ $ref: ethernet-switch-port.yaml#
unevaluatedProperties: false

...
diff --git a/MAINTAINERS b/MAINTAINERS
index b582e0835b46..efc9a12b6230 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -14542,6 +14542,7 @@ M: Florian Fainelli <f.fainelli@gmail.com>
M: Vladimir Oltean <olteanv@gmail.com>
S: Maintained
F: Documentation/devicetree/bindings/net/dsa/
+F: Documentation/devicetree/bindings/net/ethernet-switch-port.yaml
F: Documentation/devicetree/bindings/net/ethernet-switch.yaml
F: drivers/net/dsa/
F: include/linux/dsa/