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:   Alexandru Gagniuc <alexandru.gagniuc@hp.com>
To:     linux-usb@vger.kernel.org, netdev@vger.kernel.org
Cc:     davem@davemloft.net, edumazet@google.com, kuba@kernel.org,
        pabeni@redhat.com, hayeswang@realtek.com, jflf_kernel@gmx.com,
        bjorn@mork.no, svenva@chromium.org, linux-kernel@vger.kernel.org,
        eniac-xw.zhang@hp.com,
        Alexandru Gagniuc <alexandru.gagniuc@hp.com>,
        stable@vger.kernel.org
Subject: [PATCH v2] r8152: Suspend USB device before shutdown when WoL is enabled
Date:   Wed, 19 Jul 2023 17:37:56 +0000
Message-Id: <20230719173756.380829-1-alexandru.gagniuc@hp.com>
In-Reply-To: <2c12d7a0-3edb-48b3-abf7-135e1a8838ca@rowland.harvard.edu>
References: <2c12d7a0-3edb-48b3-abf7-135e1a8838ca@rowland.harvard.edu>
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Content-Type: text/plain; charset=WINDOWS-1252; x-default=true
Precedence: bulk

For Wake-on-LAN to work from S5 (shutdown), the USB link must be put
in U3 state. If it is not, and the host "disappears", the chip will
no longer respond to WoL triggers.

To resolve this, add a notifier block and register it as a reboot
notifier. When WoL is enabled, work through the usb_device struct to
get to the suspend function. Calling this function puts the link in
the correct state for WoL to function.

Fixes: 21ff2e8976b1 ("r8152: support WOL")
Cc: stable@vger.kernel.org
Signed-off-by: Alexandru Gagniuc <alexandru.gagniuc@hp.com>
---
Changes since v1:
    * Add "Fixes:" tag to commit message

 drivers/net/usb/r8152.c | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/drivers/net/usb/r8152.c b/drivers/net/usb/r8152.c
index 0738baa5b82e..abb82a80d262 100644
--- a/drivers/net/usb/r8152.c
+++ b/drivers/net/usb/r8152.c
@@ -20,6 +20,7 @@
 #include <net/ip6_checksum.h>
 #include <uapi/linux/mdio.h>
 #include <linux/mdio.h>
+#include <linux/reboot.h>
 #include <linux/usb/cdc.h>
 #include <linux/suspend.h>
 #include <linux/atomic.h>
@@ -876,6 +877,7 @@ struct r8152 {
 =09struct delayed_work schedule, hw_phy_work;
 =09struct mii_if_info mii;
 =09struct mutex control;=09/* use for hw setting */
+=09struct notifier_block reboot_notifier;
 #ifdef CONFIG_PM_SLEEP
 =09struct notifier_block pm_notifier;
 #endif
@@ -9610,6 +9612,25 @@ static bool rtl8152_supports_lenovo_macpassthru(stru=
ct usb_device *udev)
 =09return 0;
 }
=20
+/* Suspend realtek chip before system shutdown
+ *
+ * For Wake-on-LAN to work from S5, the USB link must be put in U3 state. =
If
+ * the host otherwise "disappears", the chip will not respond to WoL trigg=
ers.
+ */
+static int rtl8152_notify(struct notifier_block *nb, unsigned long code,
+=09=09=09  void *unused)
+{
+=09struct r8152 *tp =3D container_of(nb, struct r8152, reboot_notifier);
+=09struct device *dev =3D &tp->udev->dev;
+
+=09if (code =3D=3D SYS_POWER_OFF) {
+=09=09if (tp->saved_wolopts && dev->type->pm->suspend)
+=09=09=09dev->type->pm->suspend(dev);
+=09}
+
+=09return NOTIFY_DONE;
+}
+
 static int rtl8152_probe(struct usb_interface *intf,
 =09=09=09 const struct usb_device_id *id)
 {
@@ -9792,6 +9813,9 @@ static int rtl8152_probe(struct usb_interface *intf,
 =09else
 =09=09device_set_wakeup_enable(&udev->dev, false);
=20
+=09tp->reboot_notifier.notifier_call =3D rtl8152_notify;
+=09register_reboot_notifier(&tp->reboot_notifier);
+
 =09netif_info(tp, probe, netdev, "%s\n", DRIVER_VERSION);
=20
 =09return 0;
@@ -9812,6 +9836,7 @@ static void rtl8152_disconnect(struct usb_interface *=
intf)
 =09if (tp) {
 =09=09rtl_set_unplug(tp);
=20
+=09=09unregister_reboot_notifier(&tp->reboot_notifier);
 =09=09unregister_netdev(tp->netdev);
 =09=09tasklet_kill(&tp->tx_tl);
 =09=09cancel_delayed_work_sync(&tp->hw_phy_work);
--=20
2.39.1