Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Colin Foster <colin.foster@in-advantage.com>
To:     linux-renesas-soc@vger.kernel.org,
        linux-mediatek@lists.infradead.org,
        linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org,
        devicetree@vger.kernel.org, netdev@vger.kernel.org
Cc:     John Crispin <john@phrozen.org>,
        Alexandre Belloni <alexandre.belloni@bootlin.com>,
        Claudiu Manoil <claudiu.manoil@nxp.com>,
        Marek Vasut <marex@denx.de>,
        Sean Wang <sean.wang@mediatek.com>,
        DENG Qingfang <dqfext@gmail.com>,
        Landen Chao <Landen.Chao@mediatek.com>,
        =?UTF-8?q?n=C3=A7=20=C3=9CNAL?= <arinc.unal@arinc9.com>,
        Vivien Didelot <vivien.didelot@gmail.com>,
        =?UTF-8?q?Cl=C3=A9ment=20L=C3=A9ger?= <clement.leger@bootlin.com>,
        =?UTF-8?q?Alvin=20=C5=A0ipraga?= <alsi@bang-olufsen.dk>,
        Linus Walleij <linus.walleij@linaro.org>,
        UNGLinuxDriver@microchip.com,
        Woojung Huh <woojung.huh@microchip.com>,
        Matthias Brugger <matthias.bgg@gmail.com>,
        Kurt Kanzenbach <kurt@linutronix.de>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
        Rob Herring <robh+dt@kernel.org>,
        Paolo Abeni <pabeni@redhat.com>,
        Jakub Kicinski <kuba@kernel.org>,
        Eric Dumazet <edumazet@google.com>,
        "David S. Miller" <davem@davemloft.net>,
        Vladimir Oltean <olteanv@gmail.com>,
        Florian Fainelli <f.fainelli@gmail.com>,
        Andrew Lunn <andrew@lunn.ch>,
        George McCollister <george.mccollister@gmail.com>,
        Rob Herring <robh@kernel.org>
Subject: [PATCH v4 net-next 3/9] dt-bindings: net: dsa: utilize base definitions for standard dsa switches
Date:   Fri,  2 Dec 2022 12:45:53 -0800
Message-Id: <20221202204559.162619-4-colin.foster@in-advantage.com>
In-Reply-To: <20221202204559.162619-1-colin.foster@in-advantage.com>
References: <20221202204559.162619-1-colin.foster@in-advantage.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?WitONjR3RGdOcDZPRVd3S3dSSWRlcnlxZEE4RzJIalpDeFJ2WTV0YUtvYzlJ?=
 =?utf-8?B?bGQ2NnV0YWhzdVBkZWNaenhrS2lxRmI0azArUVJmMGdIVmpJakdxM0Yrazlx?=
 =?utf-8?B?MjBZdG5TN2lKc24yZFZoL2I3NUhtM2tsVWZKZG1WSkVzeEVuRUpxQ05Gc3Bo?=
 =?utf-8?B?Yi91dzRWRUZJZ0dIams0YWtTcnlObWlKOGxram90MkZzdEVhVnUyYmlDazJL?=
 =?utf-8?B?NjgxSExUM1I3bjk0R1BmMmVKZDhSU1QwWWIwWDBaQmF6dFY3bGhZWWUyUkIy?=
 =?utf-8?B?TGJTcVV4TDFLQW9qOXJhYm1ObmtjS1ZXOFZQZkpqZkFzaHNPY3pkUVBzcGN4?=
 =?utf-8?B?MzhtRlFrcEpMSlBTRzJSd05IUlRlU0Y1T2Q5d3RDTnVIQ2JES09NSTBXSzVq?=
 =?utf-8?B?Qkk3U2YwOWVaSk9ja0xVYWVpZmYzc254QnR0U3VHaitlK1BzRVlYUHByZTR6?=
 =?utf-8?B?c2NFSForbTRNVGcxZHFldGNQc0RPUUtGZFN6VjE5TmxHMlZveGkrWDBvbG5x?=
 =?utf-8?B?K0orUmFkMGR3ZU5QV3R0S25jdGVyNitQYXJDS3NqbjUwTjZjVkpOdE1OUVFS?=
 =?utf-8?B?YUZ2dW9pZzBTYmV4WjFUbWU0SXRtOFdQbDJsWkdIY28rUDZRZFdUc3J2V3dy?=
 =?utf-8?B?M0VYeHFPaWJTUnM1OEsydzRuUENkYTkyYXREcHFrbDZMeE1EMWJpcy92MWRL?=
 =?utf-8?B?Y3c1RnVCRFJoMUJYSmU3Um1WUUM0VVIvNkhJTjF1Ymk1SkZCZGFQVGl3MVpQ?=
 =?utf-8?B?cHU3dTB6eDBDN0h4TTRGYWlNcWwyS3BCWWpCWUN3SWZlaTAvSVBKMUZLeUpz?=
 =?utf-8?B?RHdCZkRGMG1wdDhuUlRkVDFDRGVUalNuSFFEUWxpNm54VGpYZEI1VE00YUQz?=
 =?utf-8?B?c05PNnN1R3NlNk02L3NLY0NqV2dabnc3SHBIYVFTeDRkZGJ3YW0zNU5xTmNk?=
 =?utf-8?B?VkZtQSszQ1ZwNlVyOGxqT2N2VHBPZE9lazRwcy9MVlp1SVZYNVBQZ1crL2hY?=
 =?utf-8?B?NFFXbHIxaEN1RlpkQTFZTnMzOXQ4dy8xOFZxY0l4VUpZU1NYeHJYbmRkUElk?=
 =?utf-8?B?WXNLS0FEYzBnMzUvY2pjRm1memtCVUQwRzZpNkdncWtQaTRaTUFtWnRkZUJR?=
 =?utf-8?B?S3Jia2FxN0xzSEdNdkY0ejBBZzF5ZENrZ2FVUDdhOU4zUCtUdTRQZlB0M0F4?=
 =?utf-8?B?aUdFMVZPTHhZZ1I4N2JRTTl3TW9CTXJlQlpNUmMrYWpBQ2ZXbGhvM3F0b1ZZ?=
 =?utf-8?B?VE53U1hDMTJnd0dVY25ZV0Q0Mk5SdGs0YUM5S2NZTkFuN29YYnBtOHNSeHZv?=
 =?utf-8?B?TU9qRkhYWjA3RXdESUdZcTQ4VXh1WEpjOGx0MTV3MUMrZ0dudDhkYUMwWVE3?=
 =?utf-8?B?Qzg1NUdwN2ZOR25Tc09XcGNTblR0a2ZrcU05SVF3dmU5RUZ4L2pyWUlPbFBq?=
 =?utf-8?B?b0VFYmpvUTd5TU4wMldWYjNQUW5ZKzJDMndWa1lvWTJWNFhZU1c1bXoyQ1dY?=
 =?utf-8?B?VG9nOEtnRVFqdGd4TUVlUUxKdmNQZDVWSE1JOCtsMnFRZGZsNXVxVXRjTHNl?=
 =?utf-8?B?S3FoT2VrSEhSUEhUWDlNcWFiaEVXNVRDQWI4S1l0TEtXYVBwVUJCVGlaRGZX?=
 =?utf-8?B?VHAxcDRuZXRHSHQ3UlFvdGNyQVorSTNGdXUvK0VkazFQRkJSYStLaHlaZE5S?=
 =?utf-8?B?NjdUTHJjYjFUTURMd3BRMXlMWkplUTRoemZiYXp5RlY5YWRGZG9kVXRVMHdv?=
 =?utf-8?B?VTUzckN0SDlsT1JqSFYvRVl4V21uNkZUd2JaNmJqWWdPWnVocWtJRUdhNHp3?=
 =?utf-8?B?SFpxdlFLNkRva3RmZzU4cHdENkJpeUI0bmx0WEdoUzlUdXU0S3ZqR0FDNjVR?=
 =?utf-8?B?Mlo5ZVpnZjV0SXdWN2t2cDhyQ05LOWhmTUx6Y3djeVFPaU9iSDE3RmpvbWlw?=
 =?utf-8?B?NUx0aWQxVW5Tdkh4bi9SUnBnMkttNXhkYTI1a0VJQVk5N1Q1UGRVZ2lFeUFp?=
 =?utf-8?B?dEFLSjJjV1lsNXZpN1hvdHhFV0l6NmxCVjlsR0dLeWFmZGJZcnkzZW5JSEJT?=
 =?utf-8?B?NUk5Q3dMMlE4c2lTTDU5Vml2WkErUXVvWldsY2pCZUJSUnhoSHk3aS94ZUJZ?=
 =?utf-8?B?QVpCeEVCUmxGQ0tCLzI3cEtYd0pWeG83ajE1Zi83enhNWG5ISXlWVlNWUXB3?=
 =?utf-8?B?NUE9PQ==?=
X-OriginatorOrg: in-advantage.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 63e64de8-d2dd-4232-df2a-08dad4a64126
X-MS-Exchange-CrossTenant-AuthSource: MWHPR1001MB2351.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 02 Dec 2022 20:46:15.1416
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 48e842ca-fbd8-4633-a79d-0c955a7d3aae
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: EHUNTYqiTwvQI6RpWJ8tg12STAdmEZmAhOOh4cy7s/CJjlow+Nb9r6Orx89dZaM0vX6F76GnZlpUX82sf6+EfH5WzPenaNa5Lf0Cde4Ml6g=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH0PR10MB5547
X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS
        autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

DSA switches can fall into one of two categories: switches where all ports
follow standard '(ethernet-)?port' properties, and switches that have
additional properties for the ports.

The scenario where DSA ports are all standardized can be handled by
swtiches with a reference to the new 'dsa.yaml#/$defs/ethernet-ports'.

The scenario where DSA ports require additional properties can reference
'$dsa.yaml#' directly. This will allow switches to reference these standard
defitions of the DSA switch, but add additional properties under the port
nodes.

Suggested-by: Rob Herring <robh@kernel.org>
Signed-off-by: Colin Foster <colin.foster@in-advantage.com>
Reviewed-by: Linus Walleij <linus.walleij@linaro.org>
Reviewed-by: Florian Fainelli <f.fainelli@gmail.com>
Acked-by: Alvin Šipraga <alsi@bang-olufsen.dk> # realtek
---

v3 -> v4
  * Rename "$defs/base" to "$defs/ethernet-ports" to avoid implication of a
    "base class" and fix commit message accordingly
  * Add the following to the common etherent-ports node:
      "additionalProperties: false"
      "#address-cells" property
      "#size-cells" property
  * Fix "etherenet-ports@[0-9]+" to correctly be "ethernet-port@[0-9]+"
  * Remove unnecessary newline
  * Apply changes to mediatek,mt7530.yaml that were previously in a separate patch
  * Add Reviewed and Acked tags

v3
  * New patch

---
 .../bindings/net/dsa/arrow,xrs700x.yaml       |  2 +-
 .../devicetree/bindings/net/dsa/brcm,b53.yaml |  2 +-
 .../devicetree/bindings/net/dsa/dsa.yaml      | 25 ++++++++++++++++---
 .../net/dsa/hirschmann,hellcreek.yaml         |  2 +-
 .../bindings/net/dsa/mediatek,mt7530.yaml     | 16 +++---------
 .../bindings/net/dsa/microchip,ksz.yaml       |  2 +-
 .../bindings/net/dsa/microchip,lan937x.yaml   |  2 +-
 .../bindings/net/dsa/mscc,ocelot.yaml         |  2 +-
 .../bindings/net/dsa/nxp,sja1105.yaml         |  2 +-
 .../devicetree/bindings/net/dsa/realtek.yaml  |  2 +-
 .../bindings/net/dsa/renesas,rzn1-a5psw.yaml  |  2 +-
 11 files changed, 35 insertions(+), 24 deletions(-)

diff --git a/Documentation/devicetree/bindings/net/dsa/arrow,xrs700x.yaml b/Documentation/devicetree/bindings/net/dsa/arrow,xrs700x.yaml
index 259a0c6547f3..5888e3a0169a 100644
--- a/Documentation/devicetree/bindings/net/dsa/arrow,xrs700x.yaml
+++ b/Documentation/devicetree/bindings/net/dsa/arrow,xrs700x.yaml
@@ -7,7 +7,7 @@ $schema: http://devicetree.org/meta-schemas/core.yaml#
 title: Arrow SpeedChips XRS7000 Series Switch Device Tree Bindings
 
 allOf:
-  - $ref: dsa.yaml#
+  - $ref: dsa.yaml#/$defs/ethernet-ports
 
 maintainers:
   - George McCollister <george.mccollister@gmail.com>
diff --git a/Documentation/devicetree/bindings/net/dsa/brcm,b53.yaml b/Documentation/devicetree/bindings/net/dsa/brcm,b53.yaml
index 1219b830b1a4..5bef4128d175 100644
--- a/Documentation/devicetree/bindings/net/dsa/brcm,b53.yaml
+++ b/Documentation/devicetree/bindings/net/dsa/brcm,b53.yaml
@@ -66,7 +66,7 @@ required:
   - reg
 
 allOf:
-  - $ref: dsa.yaml#
+  - $ref: dsa.yaml#/$defs/ethernet-ports
   - if:
       properties:
         compatible:
diff --git a/Documentation/devicetree/bindings/net/dsa/dsa.yaml b/Documentation/devicetree/bindings/net/dsa/dsa.yaml
index b9d48e357e77..b9e366e46aed 100644
--- a/Documentation/devicetree/bindings/net/dsa/dsa.yaml
+++ b/Documentation/devicetree/bindings/net/dsa/dsa.yaml
@@ -19,9 +19,6 @@ description:
 select: false
 
 properties:
-  $nodename:
-    pattern: "^(ethernet-)?switch(@.*)?$"
-
   dsa,member:
     minItems: 2
     maxItems: 2
@@ -58,4 +55,26 @@ oneOf:
 
 additionalProperties: true
 
+$defs:
+  ethernet-ports:
+    description: A DSA switch without any extra port properties
+    $ref: '#/'
+
+    patternProperties:
+      "^(ethernet-)?ports$":
+        type: object
+        additionalProperties: false
+
+        properties:
+          '#address-cells':
+            const: 1
+          '#size-cells':
+            const: 0
+
+        patternProperties:
+          "^(ethernet-)?port@[0-9]+$":
+            description: Ethernet switch ports
+            $ref: dsa-port.yaml#
+            unevaluatedProperties: false
+
 ...
diff --git a/Documentation/devicetree/bindings/net/dsa/hirschmann,hellcreek.yaml b/Documentation/devicetree/bindings/net/dsa/hirschmann,hellcreek.yaml
index 73b774eadd0b..748ef9983ce2 100644
--- a/Documentation/devicetree/bindings/net/dsa/hirschmann,hellcreek.yaml
+++ b/Documentation/devicetree/bindings/net/dsa/hirschmann,hellcreek.yaml
@@ -7,7 +7,7 @@ $schema: http://devicetree.org/meta-schemas/core.yaml#
 title: Hirschmann Hellcreek TSN Switch Device Tree Bindings
 
 allOf:
-  - $ref: dsa.yaml#
+  - $ref: dsa.yaml#/$defs/ethernet-ports
 
 maintainers:
   - Andrew Lunn <andrew@lunn.ch>
diff --git a/Documentation/devicetree/bindings/net/dsa/mediatek,mt7530.yaml b/Documentation/devicetree/bindings/net/dsa/mediatek,mt7530.yaml
index f2e9ff3f580b..b815272531fa 100644
--- a/Documentation/devicetree/bindings/net/dsa/mediatek,mt7530.yaml
+++ b/Documentation/devicetree/bindings/net/dsa/mediatek,mt7530.yaml
@@ -156,17 +156,6 @@ patternProperties:
 
     patternProperties:
       "^(ethernet-)?port@[0-9]+$":
-        type: object
-        description: Ethernet switch ports
-
-        unevaluatedProperties: false
-
-        properties:
-          reg:
-            description:
-              Port address described must be 5 or 6 for CPU port and from 0 to 5
-              for user ports.
-
         allOf:
           - $ref: dsa-port.yaml#
           - if:
@@ -174,6 +163,9 @@ patternProperties:
             then:
               properties:
                 reg:
+                  description:
+                    Port address described must be 5 or 6 for CPU port and from
+                    0 to 5 for user ports
                   enum:
                     - 5
                     - 6
@@ -238,7 +230,7 @@ $defs:
                       - sgmii
 
 allOf:
-  - $ref: dsa.yaml#
+  - $ref: dsa.yaml#/$defs/ethernet-ports
   - if:
       required:
         - mediatek,mcm
diff --git a/Documentation/devicetree/bindings/net/dsa/microchip,ksz.yaml b/Documentation/devicetree/bindings/net/dsa/microchip,ksz.yaml
index 4da75b1f9533..a4b53434c85c 100644
--- a/Documentation/devicetree/bindings/net/dsa/microchip,ksz.yaml
+++ b/Documentation/devicetree/bindings/net/dsa/microchip,ksz.yaml
@@ -11,7 +11,7 @@ maintainers:
   - Woojung Huh <Woojung.Huh@microchip.com>
 
 allOf:
-  - $ref: dsa.yaml#
+  - $ref: dsa.yaml#/$defs/ethernet-ports
   - $ref: /schemas/spi/spi-peripheral-props.yaml#
 
 properties:
diff --git a/Documentation/devicetree/bindings/net/dsa/microchip,lan937x.yaml b/Documentation/devicetree/bindings/net/dsa/microchip,lan937x.yaml
index 630bf0f8294b..4aee3bf4c2f4 100644
--- a/Documentation/devicetree/bindings/net/dsa/microchip,lan937x.yaml
+++ b/Documentation/devicetree/bindings/net/dsa/microchip,lan937x.yaml
@@ -10,7 +10,7 @@ maintainers:
   - UNGLinuxDriver@microchip.com
 
 allOf:
-  - $ref: dsa.yaml#
+  - $ref: dsa.yaml#/$defs/ethernet-ports
 
 properties:
   compatible:
diff --git a/Documentation/devicetree/bindings/net/dsa/mscc,ocelot.yaml b/Documentation/devicetree/bindings/net/dsa/mscc,ocelot.yaml
index 8d93ed9c172c..85014a590a35 100644
--- a/Documentation/devicetree/bindings/net/dsa/mscc,ocelot.yaml
+++ b/Documentation/devicetree/bindings/net/dsa/mscc,ocelot.yaml
@@ -78,7 +78,7 @@ required:
   - reg
 
 allOf:
-  - $ref: dsa.yaml#
+  - $ref: dsa.yaml#/$defs/ethernet-ports
   - if:
       properties:
         compatible:
diff --git a/Documentation/devicetree/bindings/net/dsa/nxp,sja1105.yaml b/Documentation/devicetree/bindings/net/dsa/nxp,sja1105.yaml
index 1e26d876d146..826e2db98974 100644
--- a/Documentation/devicetree/bindings/net/dsa/nxp,sja1105.yaml
+++ b/Documentation/devicetree/bindings/net/dsa/nxp,sja1105.yaml
@@ -13,7 +13,7 @@ description:
   depends on the SPI bus master driver.
 
 allOf:
-  - $ref: "dsa.yaml#"
+  - $ref: dsa.yaml#/$defs/ethernet-ports
   - $ref: /schemas/spi/spi-peripheral-props.yaml#
 
 maintainers:
diff --git a/Documentation/devicetree/bindings/net/dsa/realtek.yaml b/Documentation/devicetree/bindings/net/dsa/realtek.yaml
index 1a7d45a8ad66..cfd69c2604ea 100644
--- a/Documentation/devicetree/bindings/net/dsa/realtek.yaml
+++ b/Documentation/devicetree/bindings/net/dsa/realtek.yaml
@@ -7,7 +7,7 @@ $schema: http://devicetree.org/meta-schemas/core.yaml#
 title: Realtek switches for unmanaged switches
 
 allOf:
-  - $ref: dsa.yaml#
+  - $ref: dsa.yaml#/$defs/ethernet-ports
 
 maintainers:
   - Linus Walleij <linus.walleij@linaro.org>
diff --git a/Documentation/devicetree/bindings/net/dsa/renesas,rzn1-a5psw.yaml b/Documentation/devicetree/bindings/net/dsa/renesas,rzn1-a5psw.yaml
index 0a0d62b6c00e..833d2f68daa1 100644
--- a/Documentation/devicetree/bindings/net/dsa/renesas,rzn1-a5psw.yaml
+++ b/Documentation/devicetree/bindings/net/dsa/renesas,rzn1-a5psw.yaml
@@ -14,7 +14,7 @@ description: |
   handles 4 ports + 1 CPU management port.
 
 allOf:
-  - $ref: dsa.yaml#
+  - $ref: dsa.yaml#/$defs/ethernet-ports
 
 properties:
   compatible:
-- 
2.25.1