Skip to contentSkip to conversation

net: phy: fix WoL handling when suspending the PHY

PATCH In review Heiner Kallweit 4 participants 7 messages Sep 25, 2018 – Sep 29, 2018

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

v2 cover net: phy: fix WoL handling when suspending the PHY

phy_suspend doesn't always recognize that WoL is enabled and therefore suspends the PHY when it should not. First idea to address the issue was to reuse checks used in mdio_bus_phy_may_suspend which check whether relevant devices are wakeup-enabled.
Florian raised some concerns because drivers may enable wakeup even if WoL isn't enabled (e.g. certain USB network drivers).

The new approach focuses on reducing the risk to break existing stuff. We add a flag wol_enabled to struct net_device which is set in ethtool_set_wol(). Then this flag is checked in phy_suspend(). This doesn't cover 100% of the cases yet (e.g. if WoL is enabled w/o explicit configuration), but it covers the most relevant cases with very little risk of regressions.

v2:
- Fix a typo

Heiner Kallweit (2):
net: core: add member wol_enabled to struct net_device
net: phy: fix WoL handling when suspending the PHY

 drivers/net/phy/phy_device.c | 12 +++++++++---
 include/linux/netdevice.h    |  3 +++
 net/core/ethtool.c           |  9 ++++++++-
 3 files changed, 20 insertions(+), 4 deletions(-)
Signature · 1 line
2.19.0
#1 lore raw

PATCH v2 1/2 net: core: add member wol_enabled to struct net_device

Add flag wol_enabled to struct net_device indicating whether Wake-on-LAN is enabled. As first user phy_suspend() will use it to decide whether PHY can be suspended or not.

Fixes f1e911d5d0df ("r8169: add basic phylib support")
Fixes e8cfd9d6c772 ("net: phy: call state machine synchronously in phy_stop")
---
 include/linux/netdevice.h | 3 +++
 net/core/ethtool.c        | 9 ++++++++-
 2 files changed, 11 insertions(+), 1 deletion(-)
include/linux/netdevice.h +3 -0
index 1cbbf77a6..f5f1f1450 100644
@@ -1756,6 +1756,8 @@ enum netdev_priv_flags {
  *			switch driver and used to set the phys state of the
  *			switch port.
  *
+ *	@wol_enabled:	Wake-on-LAN is enabled
+ *
  *	FIXME: cleanup struct net_device such that network protocol info
  *	moves out.
  */
@@ -2039,6 +2041,7 @@ struct net_device {
 	struct lock_class_key	*qdisc_tx_busylock;
 	struct lock_class_key	*qdisc_running_key;
 	bool			proto_down;
+	unsigned		wol_enabled:1;
 };
 #define to_net_dev(d) container_of(d, struct net_device, dev)
 
net/core/ethtool.c +8 -1
index 9d4e56d97..86f765d42 100644
@@ -1395,6 +1395,7 @@ static int ethtool_get_wol(struct net_device *dev, char __user *useraddr)
 static int ethtool_set_wol(struct net_device *dev, char __user *useraddr)
 {
 	struct ethtool_wolinfo wol;
+	int ret;
 
 	if (!dev->ethtool_ops->set_wol)
 		return -EOPNOTSUPP;
@@ -1402,7 +1403,13 @@ static int ethtool_set_wol(struct net_device *dev, char __user *useraddr)
 	if (copy_from_user(&wol, useraddr, sizeof(wol)))
 		return -EFAULT;
 
-	return dev->ethtool_ops->set_wol(dev, &wol);
+	ret = dev->ethtool_ops->set_wol(dev, &wol);
+	if (ret)
+		return ret;
+
+	dev->wol_enabled = !!wol.wolopts;
+
+	return 0;
 }
 
 static int ethtool_get_eee(struct net_device *dev, char __user *useraddr)
Signature · 1 line
2.19.0
Reviewed-by on v2 1/2
#2 lore raw

Re: [PATCH net v2 1/2] net: core: add member wol_enabled to struct net_device

Quoted 7 lines · Heiner Kallweit

Add flag wol_enabled to struct net_device indicating whether Wake-on-LAN is enabled. As first user phy_suspend() will use it to decide whether PHY can be suspended or not.

Fixes f1e911d5d0df ("r8169: add basic phylib support")
Fixes e8cfd9d6c772 ("net: phy: call state machine synchronously in phy_stop")

Thanks Heiner!

Signature · 1 line
Florian
#3 lore raw

Re: [PATCH net v2 1/2] net: core: add member wol_enabled to struct net_device

In reply to Heiner Kallweit

(I wrote my comment to v1 because I overlooked there is a v2 already; duplicating it here.)

Quoted 26 lines · Heiner Kallweit

Add flag wol_enabled to struct net_device indicating whether Wake-on-LAN is enabled. As first user phy_suspend() will use it to decide whether PHY can be suspended or not.

Fixes f1e911d5d0df ("r8169: add basic phylib support")
Fixes e8cfd9d6c772 ("net: phy: call state machine synchronously in phy_stop")
---
 include/linux/netdevice.h | 3 +++
 net/core/ethtool.c        | 9 ++++++++-
 2 files changed, 11 insertions(+), 1 deletion(-)
include/linux/netdevice.h +2 -0
index 1cbbf77a6..f5f1f1450 100644
@@ -1756,6 +1756,8 @@ enum netdev_priv_flags {
  *			switch driver and used to set the phys state of the
  *			switch port.
  *
+ *	@wol_enabled:	Wake-on-LAN is enabled
+ *
  *	FIXME: cleanup struct net_device such that network protocol info
  *	moves out.
  */

include/linux/netdevice.h struct net_device { · line 2047

Quoted 7 lines
include/linux/netdevice.h +1 -0
@@ -2039,6 +2041,7 @@ struct net_device {
 	struct lock_class_key	*qdisc_tx_busylock;
 	struct lock_class_key	*qdisc_running_key;
 	bool			proto_down;
+	unsigned		wol_enabled:1;
 };
 #define to_net_dev(d) container_of(d, struct net_device, dev)
 

As there is no bitfield yet, this would add 4 bytes to struct net_device. How about using a bit in net_device::priv_flags like IFF_RXFH_CONFIGURED in ethtool_set_rxfh_indir() and ethtool_set_rxfh()?

Michal Kubecek

#4 lore raw

Re: [PATCH net v2 1/2] net: core: add member wol_enabled to struct net_device

Quoted 33 lines · Michal Kubecek

(I wrote my comment to v1 because I overlooked there is a v2 already; duplicating it here.)

Quoted 29 lines · Heiner Kallweit

Add flag wol_enabled to struct net_device indicating whether Wake-on-LAN is enabled. As first user phy_suspend() will use it to decide whether PHY can be suspended or not.

Fixes f1e911d5d0df ("r8169: add basic phylib support")
Fixes e8cfd9d6c772 ("net: phy: call state machine synchronously in phy_stop")
---
 include/linux/netdevice.h | 3 +++
 net/core/ethtool.c        | 9 ++++++++-
 2 files changed, 11 insertions(+), 1 deletion(-)
include/linux/netdevice.h +2 -0
index 1cbbf77a6..f5f1f1450 100644
@@ -1756,6 +1756,8 @@ enum netdev_priv_flags {
  *			switch driver and used to set the phys state of the
  *			switch port.
  *
+ *	@wol_enabled:	Wake-on-LAN is enabled
+ *
  *	FIXME: cleanup struct net_device such that network protocol info
  *	moves out.
  */
@@ -2039,6 +2041,7 @@ struct net_device {
 	struct lock_class_key	*qdisc_tx_busylock;
 	struct lock_class_key	*qdisc_running_key;
 	bool			proto_down;
Quoted 9 lines

include/linux/netdevice.h struct net_device { · line 2047

Quoted 4 lines
include/linux/netdevice.h +1 -0
+	unsigned		wol_enabled:1;
 };
 #define to_net_dev(d) container_of(d, struct net_device, dev)
 

As there is no bitfield yet, this would add 4 bytes to struct net_device. How about using a bit in net_device::priv_flags like IFF_RXFH_CONFIGURED in ethtool_set_rxfh_indir() and ethtool_set_rxfh()?

Indeed alternatively we could add a private flag and the related getter/setter.
Regarding the size argument: We have few bool members in struct net_device (uc_promisc, dismantle, needs_free_netdev, proto_down) which most likely can be transparently converted to bitfield members. Then a wol_enabled bitfield member would be no overhead. I don't have a strong preference and would leave it up to David.

Quoted 2 lines

Michal Kubecek

Heiner

maintainer
#5 lore raw
In reply to Heiner Kallweit

From: Heiner Kallweit <[email protected]>
Date: Mon, 24 Sep 2018 21:58:04 +0200

Quoted 14 lines

phy_suspend doesn't always recognize that WoL is enabled and therefore suspends the PHY when it should not. First idea to address the issue was to reuse checks used in mdio_bus_phy_may_suspend which check whether relevant devices are wakeup-enabled.
Florian raised some concerns because drivers may enable wakeup even if WoL isn't enabled (e.g. certain USB network drivers).

The new approach focuses on reducing the risk to break existing stuff. We add a flag wol_enabled to struct net_device which is set in ethtool_set_wol(). Then this flag is checked in phy_suspend(). This doesn't cover 100% of the cases yet (e.g. if WoL is enabled w/o explicit configuration), but it covers the most relevant cases with very little risk of regressions.

Quoted 2 lines

v2:
- Fix a typo

Series applied, thanks.

Please deal with the extra 4 byte size of net_device in net-next.

Thanks.

#6 lore raw
Quoted 17 lines · David Miller

From: Heiner Kallweit <[email protected]>
Date: Mon, 24 Sep 2018 21:58:04 +0200

Quoted 14 lines

phy_suspend doesn't always recognize that WoL is enabled and therefore suspends the PHY when it should not. First idea to address the issue was to reuse checks used in mdio_bus_phy_may_suspend which check whether relevant devices are wakeup-enabled.
Florian raised some concerns because drivers may enable wakeup even if WoL isn't enabled (e.g. certain USB network drivers).

The new approach focuses on reducing the risk to break existing stuff. We add a flag wol_enabled to struct net_device which is set in ethtool_set_wol(). Then this flag is checked in phy_suspend(). This doesn't cover 100% of the cases yet (e.g. if WoL is enabled w/o explicit configuration), but it covers the most relevant cases with very little risk of regressions.

Quoted 7 lines
Quoted 2 lines

v2:
- Fix a typo

Series applied, thanks.

Please deal with the extra 4 byte size of net_device in net-next.

Sure. Next week I'm on travel, will do it the week after.

Quoted 2 lines

Thanks.