net: bcmgenet: protect stop from timeout

A timing hazard exists when the network interface is stopped that
allows a watchdog timeout to be processed by a separate core in
parallel. This creates the potential for the timeout handler to
wake the queues while the driver is shutting down, or access
registers after their clocks have been removed.

The more common case is that the watchdog timeout will produce a
warning message which doesn't lead to a crash. The chances of this
are greatly increased by the fact that bcmgenet_netif_stop stops
the transmit queues which can easily precipitate a watchdog time-
out because of stale trans_start data in the queues.

This commit corrects the behavior by ensuring that the watchdog
timeout is disabled before enterring bcmgenet_netif_stop. There
are currently only two users of the bcmgenet_netif_stop function:
close and suspend.

The close case already handles the issue by exiting the RUNNING
state before invoking the driver close service.

The suspend case now performs the netif_device_detach to exit the
PRESENT state before the call to bcmgenet_netif_stop rather than
after it.

These behaviors prevent any future scheduling of the driver timeout
service during the window. The netif_tx_stop_all_queues function
in bcmgenet_netif_stop is replaced with netif_tx_disable to ensure
synchronization with any transmit or timeout threads that may
already be executing on other cores.

For symmetry, the netif_device_attach call upon resume is moved to
after the call to bcmgenet_netif_start. Since it wakes the transmit
queues it is not necessary to invoke netif_tx_start_all_queues from
bcmgenet_netif_start so it is moved into the driver open service.

Fixes: 1c1008c793fa ("net: bcmgenet: add main driver file")
Signed-off-by: Doug Berger <opendmb@gmail.com>
Signed-off-by: Florian Fainelli <f.fainelli@gmail.com>
Signed-off-by: David S. Miller <davem@davemloft.net>

1 files changed, 7 insertions, 6 deletions

diff --git a/drivers/net/ethernet/broadcom/genet/bcmgenet.c b/drivers/net/ethernet/broadcom/genet/bcmgenet.c
index 20c1681bb1af..2d6f090bf644 100644
--- a/drivers/net/ethernet/broadcom/genet/bcmgenet.c
+++ b/drivers/net/ethernet/broadcom/genet/bcmgenet.c
@@ -2855,7 +2855,6 @@ static void bcmgenet_netif_start(struct net_device *dev)
 
         umac_enable_set(priv, CMD_TX_EN | CMD_RX_EN, true);
 
-        netif_tx_start_all_queues(dev);
         bcmgenet_enable_tx_napi(priv);
 
         /* Monitor link interrupts now */
@@ -2937,6 +2936,8 @@ static int bcmgenet_open(struct net_device *dev)
 
         bcmgenet_netif_start(dev);
 
+        netif_tx_start_all_queues(dev);
+
         return 0;
 
 err_irq1:
@@ -2958,7 +2959,7 @@ static void bcmgenet_netif_stop(struct net_device *dev)
         struct bcmgenet_priv *priv = netdev_priv(dev);
 
         bcmgenet_disable_tx_napi(priv);
-        netif_tx_stop_all_queues(dev);
+        netif_tx_disable(dev);
 
         /* Disable MAC receive */
         umac_enable_set(priv, CMD_RX_EN, false);
@@ -3620,13 +3621,13 @@ static int bcmgenet_suspend(struct device *d)
         if (!netif_running(dev))
                 return 0;
 
+        netif_device_detach(dev);
+
         bcmgenet_netif_stop(dev);
 
         if (!device_may_wakeup(d))
                 phy_suspend(dev->phydev);
 
-        netif_device_detach(dev);
-
         /* Prepare the device for Wake-on-LAN and switch to the slow clock */
         if (device_may_wakeup(d) && priv->wolopts) {
                 ret = bcmgenet_power_down(priv, GENET_POWER_WOL_MAGIC);
@@ -3700,8 +3701,6 @@ static int bcmgenet_resume(struct device *d)
         /* Always enable ring 16 - descriptor ring */
         bcmgenet_enable_dma(priv, dma_ctrl);
 
-        netif_device_attach(dev);
-
         if (!device_may_wakeup(d))
                 phy_resume(dev->phydev);
 
@@ -3710,6 +3709,8 @@ static int bcmgenet_resume(struct device *d)
 
         bcmgenet_netif_start(dev);
 
+        netif_device_attach(dev);
+
         return 0;
 
 out_clk_disable: