From:   Clark Wang <xiaoning.wang@nxp.com>
To:     peppe.cavallaro@st.com, alexandre.torgue@foss.st.com,
        joabreu@synopsys.com, davem@davemloft.net, edumazet@google.com,
        kuba@kernel.org, pabeni@redhat.com, mcoquelin.stm32@gmail.com,
        linux@armlinux.org.uk, andrew@lunn.ch, hkallweit1@gmail.com
Cc:     netdev@vger.kernel.org, linux-stm32@st-md-mailman.stormreply.com,
        linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org,
        linux-imx@nxp.com
Subject: [PATCH V3 1/2] net: phylink: add a function to resume phy alone to fix resume issue with WoL enabled
Date:   Thu,  2 Feb 2023 16:15:59 +0800
Message-Id: <20230202081559.3553637-1-xiaoning.wang@nxp.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?K53gLX66Zx7VMCx1QV8v/Y2/wbpSgubE/tHpT8nHBnae1o7j+o4Zx5+JcMz3?=
 =?us-ascii?Q?UgVxrhWWE/Pr5k7M5l9g/Kj/xjBEw2ygaV3hJl77v4SDpdMm4ioXvIVusiRf?=
 =?us-ascii?Q?4bt1GYdjBR3PXrsgpxLOVT2DmcBdXjapjBo6Z1f6dezWNN4JikFtDwrLqp26?=
 =?us-ascii?Q?HYCTTmciGrx2yCiNWdtQM41le69ip1Mpihmbs03CKZuTgUhwi9n4hTzx04Xm?=
 =?us-ascii?Q?5gakOABJFokrltxs4n4R185cS1NTUrFMltFIYhzP3Ch85l3FTF6LEFQ0DE5a?=
 =?us-ascii?Q?McSgn3AQQBSFnFGqspNFEYfuGxgOtp1fNledu0mH+6SNCD0WDEnuWJ5mELx6?=
 =?us-ascii?Q?xW+GeHbaajbZFUsJ7GcN318yC7D+ajEAN6BfnudM6iULphZMf7GbMfrYIW7F?=
 =?us-ascii?Q?BxQgzWor3liwNG8wivjFAP3PcBnOEzRM3hUCm60/AvbV1C7VhIO+y6gQAg4h?=
 =?us-ascii?Q?mF/A20hMmC5L78attlc8BhDVQLi8LQeakw7oFtVRTI3f2wEmpbrooQ//Bok+?=
 =?us-ascii?Q?F1Iz48Q4Op33PwCK9MIPEPvwAoiIlh7ISL/1l02U4SbeEmsGstZb/FrB7jP9?=
 =?us-ascii?Q?ODiob2BDLQM8x6i8kbet5z/8jb8+kACtws4VEfh3L8tI7+ev4T8w8v2ELdpQ?=
 =?us-ascii?Q?+ELJJExGZpkWycvXsnZ0W3BsHdm/ZFDoBWzB8eosv+fi/DbjdtWdYCORNWBl?=
 =?us-ascii?Q?H3ay5bN/NkYR2/3pljDZhgc24xsqyHTNGyjIkLNmecV/5owgn//CdUKuHCE+?=
 =?us-ascii?Q?xMVe6JaCBWNkquoKuPERtBbdPAFoHnVkfDLe4zdsPGL/sKLLvJNsctSyu91r?=
 =?us-ascii?Q?1AcBDRwdpePhu/ceEdsRRpKdUgIEzMzuKjYSe9wWENGm/QfiwjMqtkakGB+D?=
 =?us-ascii?Q?N0RcN/z304SL0pNXky2cpMRI4whif9cVfoSQbr3OtsvNKISHKVTpOswStClO?=
 =?us-ascii?Q?XC2vXc9fT07O8J2bhA7rKWV1TdMWVa6viA34SPj1owd3Hzf1FWA/HgS55Hc3?=
 =?us-ascii?Q?MYdQKDm2kQ9QhATARcxwJjHDrCrwyDgWrwT/td7J6FpjSbYj/tYqcAmCxeAC?=
 =?us-ascii?Q?KKsaRQCJMjtSzBnA2zwNKh6PH/0SL0EiXcPv/ssqQ7xWsT6qSj88iPOCrB0v?=
 =?us-ascii?Q?ETmVvB4FkwPGoQ5BPtPYHChucSYf3l/7GQ4gqYZ1eQY8DBPP+am6UFlGIYmX?=
 =?us-ascii?Q?q7WANroqD9qNGRo7+sQv32v+tm6NT/bjv864UHGzUmoJfE6h/bYYTvNXqS4L?=
 =?us-ascii?Q?SvjnFfzsOTDUL4HWK7oED3FC38bfUtSCOQ3NVmkYxXczUBy/wNZCz58cjJAk?=
 =?us-ascii?Q?nS7ABfqWseM3vhn+CeCSrh1RUkxvHMDxb+sLQ1Huzug6UWgPG1U1Q9ivYk9w?=
 =?us-ascii?Q?kSKMx/VoZMdxS0g9GBYI1POFSHY+CJm/UFdfWLBh+DVqoVEPBD8ewAi84AIk?=
 =?us-ascii?Q?BJMxogCtliqpSuylyb0tR9a5ke4EJJsHUC+HkNKg82ui1IDiNelRAslP/9v6?=
 =?us-ascii?Q?I+LMsSIWrAWNVTR6wXXKIoQVImU+z2XmW8ybggtQNKM8x3b/qrSSCgRD97jm?=
 =?us-ascii?Q?vdL6xRipDZqA3oRxyrr5bvSFlOoyo3OQwlEFGFG+UqtrYlH8yAzG8gXSG6wf?=
 =?us-ascii?Q?yA=3D=3D?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 44ec787d-5d72-4f25-84bf-08db04f5dd25
X-MS-Exchange-CrossTenant-AuthSource: HE1PR0402MB2939.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 02 Feb 2023 08:17:02.9279
 (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: MAO4Ie4UNuXNzcpHBhoWvq89O16atess6pvf4hB644OlP5n6WwvBaCbxhAhW/mklnhARYzY+xA+5nkZpCytvJQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR04MB6912
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Issue we met:
On some platforms, mac cannot work after resumed from the suspend with WoL
enabled.

The cause of the issue:
1. phylink_resolve() is in a workqueue which will not be executed immediately.
   This is the call sequence:
       phylink_resolve()->phylink_link_up()->pl->mac_ops->mac_link_up()
   For stmmac driver, mac_link_up() will set the correct speed/duplex...
   values which are from link_state.
2. In stmmac_resume(), it will call stmmac_hw_setup() after called the
   phylink_resume(), because mac need phy rx_clk to do the reset.
   stmmac_core_init() is called in function stmmac_hw_setup(), which will
   reset the mac and set the speed/duplex... to default value.
Conclusion: Because phylink_resolve() cannot determine when it is called, it
            cannot be guaranteed to be called after stmmac_core_init().
	    Once stmmac_core_init() is called after phylink_resolve(),
	    the mac will be misconfigured and cannot be used.

In order to avoid this problem, add a function called phylink_phy_resume()
to resume phy separately. This eliminates the need to call phylink_resume()
before stmmac_hw_setup().

Add another judgement before called phy_start() in phylink_start(). This way
phy_start() will not be called multiple times when resumes. At the same time,
it may not affect other drivers that do not use phylink_phy_resume().

Signed-off-by: Clark Wang <xiaoning.wang@nxp.com>
---
V2 change:
 - add mac_resume_phy_separately flag to struct phylink to mark if the mac
   driver uses the phylink_phy_resume() first.
V3 change:
 - add brace to avoid ambiguous 'else'
   Reported-by: kernel test robot <lkp@intel.com>
---
 drivers/net/phy/phylink.c | 32 ++++++++++++++++++++++++++++++--
 include/linux/phylink.h   |  1 +
 2 files changed, 31 insertions(+), 2 deletions(-)

diff --git a/drivers/net/phy/phylink.c b/drivers/net/phy/phylink.c
index 319790221d7f..c2fe66f0b78f 100644
--- a/drivers/net/phy/phylink.c
+++ b/drivers/net/phy/phylink.c
@@ -80,6 +80,8 @@ struct phylink {
 	DECLARE_PHY_INTERFACE_MASK(sfp_interfaces);
 	__ETHTOOL_DECLARE_LINK_MODE_MASK(sfp_support);
 	u8 sfp_port;
+
+	bool mac_resume_phy_separately;
 };
 
 #define phylink_printk(level, pl, fmt, ...) \
@@ -1509,6 +1511,7 @@ struct phylink *phylink_create(struct phylink_config *config,
 		return ERR_PTR(-EINVAL);
 	}
 
+	pl->mac_resume_phy_separately = false;
 	pl->using_mac_select_pcs = using_mac_select_pcs;
 	pl->phy_state.interface = iface;
 	pl->link_interface = iface;
@@ -1943,8 +1946,12 @@ void phylink_start(struct phylink *pl)
 	}
 	if (poll)
 		mod_timer(&pl->link_poll, jiffies + HZ);
-	if (pl->phydev)
-		phy_start(pl->phydev);
+	if (pl->phydev) {
+		if (!pl->mac_resume_phy_separately)
+			phy_start(pl->phydev);
+		else
+			pl->mac_resume_phy_separately = false;
+	}
 	if (pl->sfp_bus)
 		sfp_upstream_start(pl->sfp_bus);
 }
@@ -2024,6 +2031,27 @@ void phylink_suspend(struct phylink *pl, bool mac_wol)
 }
 EXPORT_SYMBOL_GPL(phylink_suspend);
 
+/**
+ * phylink_phy_resume() - resume phy alone
+ * @pl: a pointer to a &struct phylink returned from phylink_create()
+ *
+ * In the MAC driver using phylink, if the MAC needs the clock of the phy
+ * when it resumes, can call this function to resume the phy separately.
+ * Then proceed to MAC resume operations.
+ */
+void phylink_phy_resume(struct phylink *pl)
+{
+	ASSERT_RTNL();
+
+	if (!test_bit(PHYLINK_DISABLE_MAC_WOL, &pl->phylink_disable_state)
+	    && pl->phydev) {
+		phy_start(pl->phydev);
+		pl->mac_resume_phy_separately = true;
+	}
+
+}
+EXPORT_SYMBOL_GPL(phylink_phy_resume);
+
 /**
  * phylink_resume() - handle a network device resume event
  * @pl: a pointer to a &struct phylink returned from phylink_create()
diff --git a/include/linux/phylink.h b/include/linux/phylink.h
index c492c26202b5..6edfab5f754c 100644
--- a/include/linux/phylink.h
+++ b/include/linux/phylink.h
@@ -589,6 +589,7 @@ void phylink_stop(struct phylink *);
 
 void phylink_suspend(struct phylink *pl, bool mac_wol);
 void phylink_resume(struct phylink *pl);
+void phylink_phy_resume(struct phylink *pl);
 
 void phylink_ethtool_get_wol(struct phylink *, struct ethtool_wolinfo *);
 int phylink_ethtool_set_wol(struct phylink *, struct ethtool_wolinfo *);
-- 
2.34.1