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:   Sean Anderson <sean.anderson@seco.com>
To:     "David S . Miller" <davem@davemloft.net>,
        Jakub Kicinski <kuba@kernel.org>,
        Madalin Bucur <madalin.bucur@nxp.com>,
        Camelia Alexandra Groza <camelia.groza@nxp.com>,
        netdev@vger.kernel.org
Cc:     Eric Dumazet <edumazet@google.com>,
        "linuxppc-dev @ lists . ozlabs . org" <linuxppc-dev@lists.ozlabs.org>,
        linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org,
        Russell King <linux@armlinux.org.uk>,
        Paolo Abeni <pabeni@redhat.com>,
        "Russell King (Oracle)" <rmk+kernel@armlinux.org.uk>,
        Sean Anderson <sean.anderson@seco.com>
Subject: [PATCH net-next v7 04/10] net: phylink: provide phylink_validate_mask_caps() helper
Date:   Mon, 17 Oct 2022 16:22:35 -0400
Message-Id: <20221017202241.1741671-5-sean.anderson@seco.com>
In-Reply-To: <20221017202241.1741671-1-sean.anderson@seco.com>
References: <20221017202241.1741671-1-sean.anderson@seco.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?n58S0iGIB+J5sPCXhBmsubKF7xalmF+Yx46TcohpHszRMjbPG5Q5k1EmGa25?=
 =?us-ascii?Q?fFqeV63rSIMHLU9xPGQ7vWpGOY/2Hiyf4Y0fJC1Nk0vtM1BE93ODtTsL4Vo9?=
 =?us-ascii?Q?jN/5vjZQEhu3STCNpL2D8Rze6DWgn9YX6KY2NZkBElxnvjMCrCX8ljK60P7u?=
 =?us-ascii?Q?/CEORpUOr4gMFPx+ie8vTdNgULCKmi45BHdXMlJo84JgZA0Z0O/SR2cTl7WM?=
 =?us-ascii?Q?u1L/aZygMjaOxkyNW10dhrlJPWdHytCBE11LVJZrsL/c05kEKm3lwDRYyKoU?=
 =?us-ascii?Q?S4PMHGUwulSuFyImCjtFUxYwYtrdmh9K2cFJIH1j2AENqG2cfQf6L0DuGnkd?=
 =?us-ascii?Q?t1G1yYbZC+KVgnoQSTCJj5hssw1dpRksFORdP7+KY4YHCDjJMUBnFqZtSGrt?=
 =?us-ascii?Q?HYYJrroqNkvpgiYKEdY5FH5hknM0ZezZK719T/ghOJzKn9naAG2PywWrNjWK?=
 =?us-ascii?Q?KsbJNWBiQv8rPuz4WySVIcknlQoB3tD4s4pu7F+gz855OkSXC87Fjj9u1EnX?=
 =?us-ascii?Q?gAUYFbxUkDZ19qpTfaydP2FtYTeXsDNOYluKa8ahfXyqcE5CpBnhe4xjagXL?=
 =?us-ascii?Q?CD2NBkklPIuANeKHMVjqL8JSuyOimKw8ef5wb2DsOHmbTivDHq68x2+7b6DT?=
 =?us-ascii?Q?w+tvmA7/qv6VDYbz0E2CwYizhd2IVwjPdtwSjlR6gkl4HcWA3OWEWL5I3Ui7?=
 =?us-ascii?Q?PvkxuHZixJBN/TBomVcdZ9zc3drfuxsGxpQinvpkigtWLkLZvPTT2JwZlhBQ?=
 =?us-ascii?Q?DA9n+XykZA89+fEGMnMycgsVEmv/Hgj+bgkdZDzL47FQD5lzQMZYj9/wsOiV?=
 =?us-ascii?Q?OZ2+YyJoKVCLovoLKZeIr335nb07khvVkFX/QDxuczBbX4HRTYyDT7UdkdbV?=
 =?us-ascii?Q?5MHxLTGIK2KImJ7/7E5k3SMY4j9jr6TQ0FXdRu7xTGxi+Ey0932OiQl5xROP?=
 =?us-ascii?Q?m8EwBhQLjMECEdQKA0JjWLIBa5BIStT06hL0H6hLdWL+vUpFL6zdgWG6Xh8k?=
 =?us-ascii?Q?5gV0GF1bWDUjrlzNQgMJMew0xzvcFWbQkre5rFIKwjmHMZhpf6GaeUXVK162?=
 =?us-ascii?Q?z1vwavg5YlCE1uu2+hFTf/vpKOeuNHh2m/48/VUoY3Y9RMLTLL80Kl84/TWD?=
 =?us-ascii?Q?MJjnNEJyQuI5/XAL4gtk8TqcpYNTpXZBXM1KluWj/DaLOBUTmjBMe+XK4qzh?=
 =?us-ascii?Q?TWpEW9V0qRu66obnlHEGyzh97snyjLSZKuYPBTaVn3SX5SVpTxxIolZLycHO?=
 =?us-ascii?Q?9GxyKziWM/w2Jo0qRXbC9y3O5bZUzQ7vFJpadlRNhc0aVUaNM6HBd4w1trs4?=
 =?us-ascii?Q?xFFHrJfniNB7/7Z7UdimRwomBtWI8ocVHjIW759NQqrGX8plGakmgbAcPAdh?=
 =?us-ascii?Q?5nz/j5uy9tGHkN7elGwah6VOkDZ+MaYkE+GAhSr4FNYQAhTUi0cVLGUw3HD9?=
 =?us-ascii?Q?7wnaJGTh7HG4cijQ+YcjzSG6n7fsKRZWriwNU+6Jo3rJXrGzpjAc4Y16NTwB?=
 =?us-ascii?Q?yncQsVpPk+QGZnetlImpFP25rK268aH+PHSVpf6FR71gD4caJCEJtm1EBtZX?=
 =?us-ascii?Q?x++d1lkcPC4mVVfVH4jHQMlrbzj+C4caqKwTE+9SeUk2hxeAyASOy6g/7nPE?=
 =?us-ascii?Q?Qg=3D=3D?=
X-OriginatorOrg: seco.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 549a1767-1d88-45cb-6610-08dab07d6d04
X-MS-Exchange-CrossTenant-AuthSource: DB7PR03MB4972.eurprd03.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 17 Oct 2022 20:23:17.4314
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: bebe97c3-6438-442e-ade3-ff17aa50e733
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: v5LRAz6/A9TlyipcJI2CvcvXYBGBIr0I94aoS1OPkWfGh5Z90ibilbDYwFA6quEBdDb1ZU5KXbwIr8/L6+laFg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DBBPR03MB6761
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,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

From: "Russell King (Oracle)" <rmk+kernel@armlinux.org.uk>

Provide a helper that restricts the link modes according to the
phylink capabilities.

Signed-off-by: Russell King (Oracle) <rmk+kernel@armlinux.org.uk>
[rebased on net-next/master and added documentation]
Signed-off-by: Sean Anderson <sean.anderson@seco.com>
---

Changes in v7:
- New

 drivers/net/phy/phylink.c | 43 +++++++++++++++++++++++++++------------
 include/linux/phylink.h   |  3 +++
 2 files changed, 33 insertions(+), 13 deletions(-)

diff --git a/drivers/net/phy/phylink.c b/drivers/net/phy/phylink.c
index 75464df191ef..ef10f5a70e5a 100644
--- a/drivers/net/phy/phylink.c
+++ b/drivers/net/phy/phylink.c
@@ -561,6 +561,35 @@ unsigned long phylink_get_capabilities(phy_interface_t interface,
 }
 EXPORT_SYMBOL_GPL(phylink_get_capabilities);
 
+/**
+ * phylink_validate_mask_caps() - Restrict link modes based on caps
+ * @supported: ethtool bitmask for supported link modes.
+ * @state: an (optional) pointer to a &struct phylink_link_state.
+ * @mac_capabilities: bitmask of MAC capabilities
+ *
+ * Calculate the supported link modes based on @mac_capabilities, and restrict
+ * @supported and @state based on that. Use this function if your capabiliies
+ * aren't constant, such as if they vary depending on the interface.
+ */
+void phylink_validate_mask_caps(unsigned long *supported,
+				struct phylink_link_state *state,
+				unsigned long mac_capabilities)
+{
+	__ETHTOOL_DECLARE_LINK_MODE_MASK(mask) = { 0, };
+	unsigned long caps;
+
+	phylink_set_port_modes(mask);
+	phylink_set(mask, Autoneg);
+	caps = phylink_get_capabilities(state->interface, mac_capabilities,
+					state->rate_matching);
+	phylink_caps_to_linkmodes(mask, caps);
+
+	linkmode_and(supported, supported, mask);
+	if (state)
+		linkmode_and(state->advertising, state->advertising, mask);
+}
+EXPORT_SYMBOL_GPL(phylink_validate_mask_caps);
+
 /**
  * phylink_generic_validate() - generic validate() callback implementation
  * @config: a pointer to a &struct phylink_config.
@@ -569,24 +598,12 @@ EXPORT_SYMBOL_GPL(phylink_get_capabilities);
  *
  * Generic implementation of the validate() callback that MAC drivers can
  * use when they pass the range of supported interfaces and MAC capabilities.
- * This makes use of phylink_get_linkmodes().
  */
 void phylink_generic_validate(struct phylink_config *config,
 			      unsigned long *supported,
 			      struct phylink_link_state *state)
 {
-	__ETHTOOL_DECLARE_LINK_MODE_MASK(mask) = { 0, };
-	unsigned long caps;
-
-	phylink_set_port_modes(mask);
-	phylink_set(mask, Autoneg);
-	caps = phylink_get_capabilities(state->interface,
-					config->mac_capabilities,
-					state->rate_matching);
-	phylink_caps_to_linkmodes(mask, caps);
-
-	linkmode_and(supported, supported, mask);
-	linkmode_and(state->advertising, state->advertising, mask);
+	phylink_validate_mask_caps(supported, state, config->mac_capabilities);
 }
 EXPORT_SYMBOL_GPL(phylink_generic_validate);
 
diff --git a/include/linux/phylink.h b/include/linux/phylink.h
index 664dd409feb9..c29c3f174972 100644
--- a/include/linux/phylink.h
+++ b/include/linux/phylink.h
@@ -556,6 +556,9 @@ void phylink_caps_to_linkmodes(unsigned long *linkmodes, unsigned long caps);
 unsigned long phylink_get_capabilities(phy_interface_t interface,
 				       unsigned long mac_capabilities,
 				       int rate_matching);
+void phylink_validate_mask_caps(unsigned long *supported,
+				struct phylink_link_state *state,
+				unsigned long caps);
 void phylink_generic_validate(struct phylink_config *config,
 			      unsigned long *supported,
 			      struct phylink_link_state *state);
-- 
2.35.1.1320.gc452695387.dirty