Received-SPF: pass (google.com: domain of linux-kernel+bounces-73765-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) client-ip=2604:1380:40f1:3f00::1;
From: Vladimir Oltean <vladimir.oltean@nxp.com>
To: netdev@vger.kernel.org
Cc: "David S. Miller" <davem@davemloft.net>,
	Eric Dumazet <edumazet@google.com>,
	Jakub Kicinski <kuba@kernel.org>,
	Paolo Abeni <pabeni@redhat.com>,
	Madalin Bucur <madalin.bucur@nxp.com>,
	Sean Anderson <sean.anderson@seco.com>,
	Russell King <linux@armlinux.org.uk>,
	Zachary Goldstein <zachary.goldstein@concurrent-rt.com>,
	linux-kernel@vger.kernel.org
Subject: [PATCH net] net: dpaa: fman_memac: accept phy-interface-type = "10gbase-r" in the device tree
Date: Wed, 21 Feb 2024 00:34:42 +0200
Message-Id: <20240220223442.1275946-1-vladimir.oltean@nxp.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
 =?us-ascii?Q?hRXMBTrsE1YVPiaFj/+TSQXL4UW80vfZC02ZgMVbUFn2ma1ZClXyMPwODDlp?=
 =?us-ascii?Q?KRo2zZ9VXuO64FEkirPYlm5Wt5BOUEmYkAN1WV1qYG2ElVsA5/gsweXaKq2Q?=
 =?us-ascii?Q?2uKCEwWAdTtZPL7DUROSc44WdDFOpJFUzvRPxWCuQoankn9ra22n4M1DYkP7?=
 =?us-ascii?Q?Txqv9hHVDZgN7Llp0n4/9mpHFxEo8fQqtMXYke/KuFQ5kMJrfXUQpiHYhFJY?=
 =?us-ascii?Q?fK4pB+hDd3O9e5NCLFS0wviWJSiOxv4e+aj/DmZjLSUFspOtgQ+W/Nx1oY3i?=
 =?us-ascii?Q?M9iH/wODkNjQPily7zfolgA7p8ngS6VWt7FX6x28ucUeLgjRJQ5jy3oWWoLa?=
 =?us-ascii?Q?k6Xyz2Ne/GwilSUqj6UzkpBPfwv2BKgklnXw21KOtkr8LxnYnM3FD2eZCTdN?=
 =?us-ascii?Q?twd+JzbknrBIJ39+fQ/7mCFTag5H9MfxOpK3AMHS8bbivItmgfjKLJT3A9Rq?=
 =?us-ascii?Q?k6dlfX8x4VijzXPqNkbV7DNR0g1h1eNgWy3cRdomHeLsso2dlLMjsFh0pJow?=
 =?us-ascii?Q?BMaOKKDY8sfiWse9Tn90J09V+XFvNynj+BYDuH0pSpDF8h1VQwA+K2t/MqAF?=
 =?us-ascii?Q?hff9ufZ3zHQDAujSr4n8T5DYmAUJl6M79BpTQ1j5YxBwX+Dp1Z4b418cho44?=
 =?us-ascii?Q?C1fSoDq4F4tPnDNHMnOS9yaI5s/NwRtVTHUQaAaIExfOiOTKNOmVSDSQnRTW?=
 =?us-ascii?Q?P8yM27LZKzQp/oPKqxBavm2TzT9MCvW2uB9hHaGI9e1Aks7uaA6c/ov75l7a?=
 =?us-ascii?Q?08g1eH5OzcrR0jeMSDf5pLMpmiAaYXVLRNTz9twEf4NYyVtysoRyHNXhYZ3w?=
 =?us-ascii?Q?/Nuym7auJ1rU//eL3ogG2XF+4UHgKcAb9rddIpesliW2KN131xnHqGlw9RTs?=
 =?us-ascii?Q?Kd+ZfOybPHRO60Z/mp/Ur6AecSAy6kXfalu0Dk6aqgYI/R4wQIahI3mUjNjk?=
 =?us-ascii?Q?uSv/cBqzza17HAnVBOINv+ChUGxSnrTgdV4H6/p+FOAtTcgBDkYX/mVkH9C4?=
 =?us-ascii?Q?V+SjhGykEyLMCUfUKSqtEn+V2X1LgwO0/V6v1tMmFRWtsSSm2fCjcIIQS0Z7?=
 =?us-ascii?Q?WgbfpxM8egGpt+Q2YFWwdd83yOeaGLKmkr43wNACSG9MSmmIMO5EOOsq7Pix?=
 =?us-ascii?Q?y4nl1b/UW6Ri/znIyOC4wFYweWR8hn3RyX+cd3A/Zkr5x2Rkkj7F5wK+6ZI5?=
 =?us-ascii?Q?nbMbqvuzzYn5Bitwla/lWxd4A6ktpb/PeJ4BhAbmej1ftCioj/RVlCzden1m?=
 =?us-ascii?Q?wIbyc61NgcSlkc/nNbwcAPB01xsjMuGznLrWmGDFDBG77nXI4wdDIBqclBtO?=
 =?us-ascii?Q?OfA/ynkRfHjfGTw9GxKZ/VhFKblL/QQce8VXpfG53SP6VZDG40qJ5dzFzoy4?=
 =?us-ascii?Q?KcTy8hzhEWpGdYa3CRRpinej7xsbbBdRizGmIEvr0te6UYgwzpshi0YAEaON?=
 =?us-ascii?Q?2jpE63Ht9Y6w8pGb0W688QBcFMEEcedgq2RF3VjGZ6nbcKTL4qXgoAi7Rj9h?=
 =?us-ascii?Q?DmMA+plBRvOik5Fyv4kFeJs45pCflsc6di3ZT1ha2tYCqR8CvPyS/p+7YMCL?=
 =?us-ascii?Q?pDeL/sFU1USf3QPFABiN6t6V5jTjO2w/xq+7RS/wFsLhg5iTrQCH4IKA74Tv?=
 =?us-ascii?Q?BlPNJLD6fBez6Ws+umghfdQ=3D?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 24b6c959-d9e4-49d0-f16b-08dc32642bff
X-MS-Exchange-CrossTenant-AuthSource: VE1PR04MB7374.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 20 Feb 2024 22:34:59.7647
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: ly/ExEXVRBtcAEkeD3zeRpvnRMSsY3b4Z1gRUrAjvJat5HI3Lj1pCNVuRjpdmlgV0kYRawCj0Rq2unBdNucLNg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PA4PR04MB9639

Since commit 5d93cfcf7360 ("net: dpaa: Convert to phylink"), we support
the "10gbase-r" phy-mode through a driver-based conversion of "xgmii",
but we still don't actually support it when the device tree specifies
"10gbase-r" proper.

This is because boards such as LS1046A-RDB do not define pcs-handle-names
(for whatever reason) in the ethernet@f0000 device tree node, and the
code enters through this code path:

	err = of_property_match_string(mac_node, "pcs-handle-names", "xfi");
	// code takes neither branch and falls through
	if (err >= 0) {
		(...)
	} else if (err != -EINVAL && err != -ENODATA) {
		goto _return_fm_mac_free;
	}

	(...)

	/* For compatibility, if pcs-handle-names is missing, we assume this
	 * phy is the first one in pcsphy-handle
	 */
	err = of_property_match_string(mac_node, "pcs-handle-names", "sgmii");
	if (err == -EINVAL || err == -ENODATA)
		pcs = memac_pcs_create(mac_node, 0); // code takes this branch
	else if (err < 0)
		goto _return_fm_mac_free;
	else
		pcs = memac_pcs_create(mac_node, err);

	// A default PCS is created and saved in "pcs"

	// This determination fails and mistakenly saves the default PCS
	// memac->sgmii_pcs instead of memac->xfi_pcs, because at this
	// stage, mac_dev->phy_if == PHY_INTERFACE_MODE_10GBASER.
	if (err && mac_dev->phy_if == PHY_INTERFACE_MODE_XGMII)
		memac->xfi_pcs = pcs;
	else
		memac->sgmii_pcs = pcs;

In other words, in the absence of pcs-handle-names, the default
xfi_pcs assignment logic only works when in the device tree we have
PHY_INTERFACE_MODE_XGMII.

By reversing the order between the fallback xfi_pcs assignment and the
"xgmii" overwrite with "10gbase-r", we are able to support both values
in the device tree, with identical behavior.

Currently, it is impossible to make the s/xgmii/10gbase-r/ device tree
conversion, because it would break forward compatibility (new device
tree with old kernel). The only way to modify existing device trees to
phy-interface-mode = "10gbase-r" is to fix stable kernels to accept this
value and handle it properly.

One reason why the conversion is desirable is because with pre-phylink
kernels, the Aquantia PHY driver used to warn about the improper use
of PHY_INTERFACE_MODE_XGMII [1]. It is best to have a single (latest)
device tree that works with all supported stable kernel versions.

Note that the blamed commit does not constitute a regression per se.
Older stable kernels like 6.1 still do not work with "10gbase-r", but
for a different reason. That is a battle for another time.

[1] https://lore.kernel.org/netdev/20240214-ls1046-dts-use-10gbase-r-v1-1-8c2d68547393@concurrent-rt.com/

Fixes: 5d93cfcf7360 ("net: dpaa: Convert to phylink")
Signed-off-by: Vladimir Oltean <vladimir.oltean@nxp.com>
---
 .../net/ethernet/freescale/fman/fman_memac.c   | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/drivers/net/ethernet/freescale/fman/fman_memac.c b/drivers/net/ethernet/freescale/fman/fman_memac.c
index e30bf75b1d48..0996759907a8 100644
--- a/drivers/net/ethernet/freescale/fman/fman_memac.c
+++ b/drivers/net/ethernet/freescale/fman/fman_memac.c
@@ -1076,6 +1076,14 @@ int memac_initialization(struct mac_device *mac_dev,
 	unsigned long		 capabilities;
 	unsigned long		*supported;
 
+	/* The internal connection to the serdes is XGMII, but this isn't
+	 * really correct for the phy mode (which is the external connection).
+	 * However, this is how all older device trees say that they want
+	 * 10GBASE-R (aka XFI), so just convert it for them.
+	 */
+	if (mac_dev->phy_if == PHY_INTERFACE_MODE_XGMII)
+		mac_dev->phy_if = PHY_INTERFACE_MODE_10GBASER;
+
 	mac_dev->phylink_ops		= &memac_mac_ops;
 	mac_dev->set_promisc		= memac_set_promiscuous;
 	mac_dev->change_addr		= memac_modify_mac_address;
@@ -1142,7 +1150,7 @@ int memac_initialization(struct mac_device *mac_dev,
 	 * (and therefore that xfi_pcs cannot be set). If we are defaulting to
 	 * XGMII, assume this is for XFI. Otherwise, assume it is for SGMII.
 	 */
-	if (err && mac_dev->phy_if == PHY_INTERFACE_MODE_XGMII)
+	if (err && mac_dev->phy_if == PHY_INTERFACE_MODE_10GBASER)
 		memac->xfi_pcs = pcs;
 	else
 		memac->sgmii_pcs = pcs;
@@ -1156,14 +1164,6 @@ int memac_initialization(struct mac_device *mac_dev,
 		goto _return_fm_mac_free;
 	}
 
-	/* The internal connection to the serdes is XGMII, but this isn't
-	 * really correct for the phy mode (which is the external connection).
-	 * However, this is how all older device trees say that they want
-	 * 10GBASE-R (aka XFI), so just convert it for them.
-	 */
-	if (mac_dev->phy_if == PHY_INTERFACE_MODE_XGMII)
-		mac_dev->phy_if = PHY_INTERFACE_MODE_10GBASER;
-
 	/* TODO: The following interface modes are supported by (some) hardware
 	 * but not by this driver:
 	 * - 1000BASE-KX
-- 
2.34.1