diff mbox series

[net-next,3/3] net: macb: Add ARP support to WOL

Message ID 20240130104845.3995341-4-vineeth.karumanchi@amd.com (mailing list archive)
State Changes Requested
Delegated to: Netdev Maintainers
Headers show
Series net: macb: WOL enhancements | expand

Checks

Context Check Description
netdev/series_format success Posting correctly formatted
netdev/tree_selection success Clearly marked for net-next
netdev/ynl success Generated files up to date; no warnings/errors; no diff in generated;
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit fail Errors and warnings before: 1069 this patch: 1074
netdev/build_tools success No tools touched, skip
netdev/cc_maintainers success CCed 0 of 0 maintainers
netdev/build_clang success Errors and warnings before: 1065 this patch: 1065
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn fail Errors and warnings before: 1087 this patch: 1092
netdev/checkpatch warning WARNING: line length of 81 exceeds 80 columns
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Vineeth Karumanchi Jan. 30, 2024, 10:48 a.m. UTC
Add wake-on LAN support using ARP with the provision to select
through ethtool. Advertise wakeup capability in the probe and
get the supported modes from the device tree.

Re-order MACB_WOL_<> macros for ease of extension.
Add ARP support configurable through ethtool, "wolopts" variable in
struct macb contains the current WOL options configured through ethtool.

For WOL via ARP, ensure the IP address is assigned and
report an error otherwise.

Co-developed-by: Harini Katakam <harini.katakam@amd.com>
Signed-off-by: Harini Katakam <harini.katakam@amd.com>
Signed-off-by: Vineeth Karumanchi <vineeth.karumanchi@amd.com>
---
 drivers/net/ethernet/cadence/macb.h      |  1 +
 drivers/net/ethernet/cadence/macb_main.c | 54 ++++++++++++++++++------
 2 files changed, 43 insertions(+), 12 deletions(-)

Comments

Vadim Fedorenko Jan. 30, 2024, 9:27 p.m. UTC | #1
On 30/01/2024 10:48, Vineeth Karumanchi wrote:
> Add wake-on LAN support using ARP with the provision to select
> through ethtool. Advertise wakeup capability in the probe and
> get the supported modes from the device tree.
> 
> Re-order MACB_WOL_<> macros for ease of extension.
> Add ARP support configurable through ethtool, "wolopts" variable in
> struct macb contains the current WOL options configured through ethtool.
> 
> For WOL via ARP, ensure the IP address is assigned and
> report an error otherwise.
> 
> Co-developed-by: Harini Katakam <harini.katakam@amd.com>
> Signed-off-by: Harini Katakam <harini.katakam@amd.com>
> Signed-off-by: Vineeth Karumanchi <vineeth.karumanchi@amd.com>
> ---
>   drivers/net/ethernet/cadence/macb.h      |  1 +
>   drivers/net/ethernet/cadence/macb_main.c | 54 ++++++++++++++++++------
>   2 files changed, 43 insertions(+), 12 deletions(-)
> 
> diff --git a/drivers/net/ethernet/cadence/macb.h b/drivers/net/ethernet/cadence/macb.h
> index f68ff163aa18..db7e95dc56e3 100644
> --- a/drivers/net/ethernet/cadence/macb.h
> +++ b/drivers/net/ethernet/cadence/macb.h
> @@ -1306,6 +1306,7 @@ struct macb {
>   	unsigned int		jumbo_max_len;
>   
>   	u32			wol;
> +	u32			wolopts;
>   
>   	/* holds value of rx watermark value for pbuf_rxcutthru register */
>   	u32			rx_watermark;
> diff --git a/drivers/net/ethernet/cadence/macb_main.c b/drivers/net/ethernet/cadence/macb_main.c
> index 47cbea58e6c3..cbe1a9de692a 100644
> --- a/drivers/net/ethernet/cadence/macb_main.c
> +++ b/drivers/net/ethernet/cadence/macb_main.c
> @@ -38,6 +38,7 @@
>   #include <linux/ptp_classify.h>
>   #include <linux/reset.h>
>   #include <linux/firmware/xlnx-zynqmp.h>
> +#include <linux/inetdevice.h>
>   #include "macb.h"
>   
>   /* This structure is only used for MACB on SiFive FU540 devices */
> @@ -84,8 +85,9 @@ struct sifive_fu540_macb_mgmt {
>   #define GEM_MTU_MIN_SIZE	ETH_MIN_MTU
>   #define MACB_NETIF_LSO		NETIF_F_TSO
>   
> -#define MACB_WOL_HAS_MAGIC_PACKET	(0x1 << 0)
> -#define MACB_WOL_ENABLED		(0x1 << 1)
> +#define MACB_WOL_ENABLED		(0x1 << 0)
> +#define MACB_WOL_HAS_MAGIC_PACKET	(0x1 << 1)
> +#define MACB_WOL_HAS_ARP_PACKET	(0x1 << 2)
>   
>   #define HS_SPEED_10000M			4
>   #define MACB_SERDES_RATE_10G		1
> @@ -3276,19 +3278,21 @@ static void macb_get_wol(struct net_device *netdev, struct ethtool_wolinfo *wol)
>   {
>   	struct macb *bp = netdev_priv(netdev);
>   
> -	if (bp->wol & MACB_WOL_HAS_MAGIC_PACKET) {
> +	if (bp->wol & (MACB_WOL_HAS_MAGIC_PACKET | MACB_WOL_HAS_ARP_PACKET))
>   		phylink_ethtool_get_wol(bp->phylink, wol);
> +	if (bp->wol & MACB_WOL_HAS_MAGIC_PACKET)
>   		wol->supported |= WAKE_MAGIC;
> -
> -		if (bp->wol & MACB_WOL_ENABLED)
> -			wol->wolopts |= WAKE_MAGIC;
> -	}
> +	if (bp->wol & MACB_WOL_HAS_ARP_PACKET)
> +		wol->supported |= WAKE_ARP;
> +	/* Pass wolopts to ethtool */
> +	wol->wolopts = bp->wolopts;
>   }
>   
>   static int macb_set_wol(struct net_device *netdev, struct ethtool_wolinfo *wol)
>   {
>   	struct macb *bp = netdev_priv(netdev);
>   	int ret;
> +	bp->wolopts = 0;

as there will be another spin, could you please use reverse xmas-tree order.

>   	/* Pass the order to phylink layer */
>   	ret = phylink_ethtool_set_wol(bp->phylink, wol);
> @@ -3298,11 +3302,16 @@ static int macb_set_wol(struct net_device *netdev, struct ethtool_wolinfo *wol)
>   	if (!ret || ret != -EOPNOTSUPP)
>   		return ret;
>   
> -	if (!(bp->wol & MACB_WOL_HAS_MAGIC_PACKET) ||
> -	    (wol->wolopts & ~WAKE_MAGIC))
> +	if (!(bp->wol & (MACB_WOL_HAS_MAGIC_PACKET | MACB_WOL_HAS_ARP_PACKET)) ||
> +	    (wol->wolopts & ~(WAKE_MAGIC | WAKE_ARP)))
>   		return -EOPNOTSUPP;
>   
>   	if (wol->wolopts & WAKE_MAGIC)
> +		bp->wolopts |= WAKE_MAGIC;
> +	if (wol->wolopts & WAKE_ARP)
> +		bp->wolopts |= WAKE_ARP;
> +
> +	if (bp->wolopts)
>   		bp->wol |= MACB_WOL_ENABLED;
>   	else
>   		bp->wol &= ~MACB_WOL_ENABLED;
> @@ -5086,7 +5095,10 @@ static int macb_probe(struct platform_device *pdev)
>   	bp->wol = 0;
>   	if (of_property_read_bool(np, "magic-packet"))
>   		bp->wol |= MACB_WOL_HAS_MAGIC_PACKET;
> -	device_set_wakeup_capable(&pdev->dev, bp->wol & MACB_WOL_HAS_MAGIC_PACKET);
> +	if (of_property_read_bool(np, "wol-arp-packet"))
> +		bp->wol |= MACB_WOL_HAS_ARP_PACKET;
> +
> +	device_set_wakeup_capable(&pdev->dev, (bp->wol) ? true : false);
>   
>   	bp->usrio = macb_config->usrio;
>   
> @@ -5243,6 +5255,7 @@ static int __maybe_unused macb_suspend(struct device *dev)
>   	struct net_device *netdev = dev_get_drvdata(dev);
>   	struct macb *bp = netdev_priv(netdev);
>   	struct macb_queue *queue;
> +	struct in_ifaddr *ifa;
>   	unsigned long flags;
>   	unsigned int q;
>   	u32 ctrlmask;
> @@ -5255,6 +5268,12 @@ static int __maybe_unused macb_suspend(struct device *dev)
>   		return 0;
>   
>   	if (bp->wol & MACB_WOL_ENABLED) {
> +		/* Check for IP address in WOL ARP mode */
> +		ifa = rtnl_dereference(bp->dev->ip_ptr->ifa_list);
> +		if ((bp->wolopts & WAKE_ARP) && !ifa) {
> +			netdev_err(netdev, "IP address not assigned\n");
> +			return -EOPNOTSUPP;
> +		}
>   		spin_lock_irqsave(&bp->lock, flags);
>   
>   		/* Disable Tx and Rx engines before  disabling the queues,
> @@ -5291,6 +5310,17 @@ static int __maybe_unused macb_suspend(struct device *dev)
>   			if (bp->caps & MACB_CAPS_ISR_CLEAR_ON_WRITE)
>   				queue_writel(queue, ISR, -1);
>   		}
> +
> +		ctrlmask = 0;
> +		if (bp->wolopts & WAKE_MAGIC)
> +			ctrlmask = MACB_BIT(MAG);
> +		if (bp->wolopts & WAKE_ARP) {
> +			ctrlmask |= MACB_BIT(ARP);
> +			/* write IP address into register */
> +			ctrlmask |= cpu_to_be32p(&ifa->ifa_local)
> +						& GENMASK(MACB_IP_SIZE - 1, 0);
> +		}
> +
>   		/* Change interrupt handler and
>   		 * Enable WoL IRQ on queue 0
>   		 */
> @@ -5306,7 +5336,7 @@ static int __maybe_unused macb_suspend(struct device *dev)
>   				return err;
>   			}
>   			queue_writel(bp->queues, IER, GEM_BIT(WOL));
> -			gem_writel(bp, WOL, MACB_BIT(MAG));
> +			gem_writel(bp, WOL, ctrlmask);
>   		} else {
>   			err = devm_request_irq(dev, bp->queues[0].irq, macb_wol_interrupt,
>   					       IRQF_SHARED, netdev->name, bp->queues);
> @@ -5318,7 +5348,7 @@ static int __maybe_unused macb_suspend(struct device *dev)
>   				return err;
>   			}
>   			queue_writel(bp->queues, IER, MACB_BIT(WOL));
> -			macb_writel(bp, WOL, MACB_BIT(MAG));
> +			macb_writel(bp, WOL, ctrlmask);
>   		}
>   		spin_unlock_irqrestore(&bp->lock, flags);
>
diff mbox series

Patch

diff --git a/drivers/net/ethernet/cadence/macb.h b/drivers/net/ethernet/cadence/macb.h
index f68ff163aa18..db7e95dc56e3 100644
--- a/drivers/net/ethernet/cadence/macb.h
+++ b/drivers/net/ethernet/cadence/macb.h
@@ -1306,6 +1306,7 @@  struct macb {
 	unsigned int		jumbo_max_len;
 
 	u32			wol;
+	u32			wolopts;
 
 	/* holds value of rx watermark value for pbuf_rxcutthru register */
 	u32			rx_watermark;
diff --git a/drivers/net/ethernet/cadence/macb_main.c b/drivers/net/ethernet/cadence/macb_main.c
index 47cbea58e6c3..cbe1a9de692a 100644
--- a/drivers/net/ethernet/cadence/macb_main.c
+++ b/drivers/net/ethernet/cadence/macb_main.c
@@ -38,6 +38,7 @@ 
 #include <linux/ptp_classify.h>
 #include <linux/reset.h>
 #include <linux/firmware/xlnx-zynqmp.h>
+#include <linux/inetdevice.h>
 #include "macb.h"
 
 /* This structure is only used for MACB on SiFive FU540 devices */
@@ -84,8 +85,9 @@  struct sifive_fu540_macb_mgmt {
 #define GEM_MTU_MIN_SIZE	ETH_MIN_MTU
 #define MACB_NETIF_LSO		NETIF_F_TSO
 
-#define MACB_WOL_HAS_MAGIC_PACKET	(0x1 << 0)
-#define MACB_WOL_ENABLED		(0x1 << 1)
+#define MACB_WOL_ENABLED		(0x1 << 0)
+#define MACB_WOL_HAS_MAGIC_PACKET	(0x1 << 1)
+#define MACB_WOL_HAS_ARP_PACKET	(0x1 << 2)
 
 #define HS_SPEED_10000M			4
 #define MACB_SERDES_RATE_10G		1
@@ -3276,19 +3278,21 @@  static void macb_get_wol(struct net_device *netdev, struct ethtool_wolinfo *wol)
 {
 	struct macb *bp = netdev_priv(netdev);
 
-	if (bp->wol & MACB_WOL_HAS_MAGIC_PACKET) {
+	if (bp->wol & (MACB_WOL_HAS_MAGIC_PACKET | MACB_WOL_HAS_ARP_PACKET))
 		phylink_ethtool_get_wol(bp->phylink, wol);
+	if (bp->wol & MACB_WOL_HAS_MAGIC_PACKET)
 		wol->supported |= WAKE_MAGIC;
-
-		if (bp->wol & MACB_WOL_ENABLED)
-			wol->wolopts |= WAKE_MAGIC;
-	}
+	if (bp->wol & MACB_WOL_HAS_ARP_PACKET)
+		wol->supported |= WAKE_ARP;
+	/* Pass wolopts to ethtool */
+	wol->wolopts = bp->wolopts;
 }
 
 static int macb_set_wol(struct net_device *netdev, struct ethtool_wolinfo *wol)
 {
 	struct macb *bp = netdev_priv(netdev);
 	int ret;
+	bp->wolopts = 0;
 
 	/* Pass the order to phylink layer */
 	ret = phylink_ethtool_set_wol(bp->phylink, wol);
@@ -3298,11 +3302,16 @@  static int macb_set_wol(struct net_device *netdev, struct ethtool_wolinfo *wol)
 	if (!ret || ret != -EOPNOTSUPP)
 		return ret;
 
-	if (!(bp->wol & MACB_WOL_HAS_MAGIC_PACKET) ||
-	    (wol->wolopts & ~WAKE_MAGIC))
+	if (!(bp->wol & (MACB_WOL_HAS_MAGIC_PACKET | MACB_WOL_HAS_ARP_PACKET)) ||
+	    (wol->wolopts & ~(WAKE_MAGIC | WAKE_ARP)))
 		return -EOPNOTSUPP;
 
 	if (wol->wolopts & WAKE_MAGIC)
+		bp->wolopts |= WAKE_MAGIC;
+	if (wol->wolopts & WAKE_ARP)
+		bp->wolopts |= WAKE_ARP;
+
+	if (bp->wolopts)
 		bp->wol |= MACB_WOL_ENABLED;
 	else
 		bp->wol &= ~MACB_WOL_ENABLED;
@@ -5086,7 +5095,10 @@  static int macb_probe(struct platform_device *pdev)
 	bp->wol = 0;
 	if (of_property_read_bool(np, "magic-packet"))
 		bp->wol |= MACB_WOL_HAS_MAGIC_PACKET;
-	device_set_wakeup_capable(&pdev->dev, bp->wol & MACB_WOL_HAS_MAGIC_PACKET);
+	if (of_property_read_bool(np, "wol-arp-packet"))
+		bp->wol |= MACB_WOL_HAS_ARP_PACKET;
+
+	device_set_wakeup_capable(&pdev->dev, (bp->wol) ? true : false);
 
 	bp->usrio = macb_config->usrio;
 
@@ -5243,6 +5255,7 @@  static int __maybe_unused macb_suspend(struct device *dev)
 	struct net_device *netdev = dev_get_drvdata(dev);
 	struct macb *bp = netdev_priv(netdev);
 	struct macb_queue *queue;
+	struct in_ifaddr *ifa;
 	unsigned long flags;
 	unsigned int q;
 	u32 ctrlmask;
@@ -5255,6 +5268,12 @@  static int __maybe_unused macb_suspend(struct device *dev)
 		return 0;
 
 	if (bp->wol & MACB_WOL_ENABLED) {
+		/* Check for IP address in WOL ARP mode */
+		ifa = rtnl_dereference(bp->dev->ip_ptr->ifa_list);
+		if ((bp->wolopts & WAKE_ARP) && !ifa) {
+			netdev_err(netdev, "IP address not assigned\n");
+			return -EOPNOTSUPP;
+		}
 		spin_lock_irqsave(&bp->lock, flags);
 
 		/* Disable Tx and Rx engines before  disabling the queues,
@@ -5291,6 +5310,17 @@  static int __maybe_unused macb_suspend(struct device *dev)
 			if (bp->caps & MACB_CAPS_ISR_CLEAR_ON_WRITE)
 				queue_writel(queue, ISR, -1);
 		}
+
+		ctrlmask = 0;
+		if (bp->wolopts & WAKE_MAGIC)
+			ctrlmask = MACB_BIT(MAG);
+		if (bp->wolopts & WAKE_ARP) {
+			ctrlmask |= MACB_BIT(ARP);
+			/* write IP address into register */
+			ctrlmask |= cpu_to_be32p(&ifa->ifa_local)
+						& GENMASK(MACB_IP_SIZE - 1, 0);
+		}
+
 		/* Change interrupt handler and
 		 * Enable WoL IRQ on queue 0
 		 */
@@ -5306,7 +5336,7 @@  static int __maybe_unused macb_suspend(struct device *dev)
 				return err;
 			}
 			queue_writel(bp->queues, IER, GEM_BIT(WOL));
-			gem_writel(bp, WOL, MACB_BIT(MAG));
+			gem_writel(bp, WOL, ctrlmask);
 		} else {
 			err = devm_request_irq(dev, bp->queues[0].irq, macb_wol_interrupt,
 					       IRQF_SHARED, netdev->name, bp->queues);
@@ -5318,7 +5348,7 @@  static int __maybe_unused macb_suspend(struct device *dev)
 				return err;
 			}
 			queue_writel(bp->queues, IER, MACB_BIT(WOL));
-			macb_writel(bp, WOL, MACB_BIT(MAG));
+			macb_writel(bp, WOL, ctrlmask);
 		}
 		spin_unlock_irqrestore(&bp->lock, flags);