From 0b0a41a369d789be105533f7e2d727018068b9af Mon Sep 17 00:00:00 2001
From: Jani Paalijarvi <jani.paalijarvi@unikie.com>
Date: Tue, 25 Jun 2024 08:44:03 +0300
Subject: [PATCH] drivers/net/ksz9477: Add port mirroring support

Signed-off-by: Jani Paalijarvi <jani.paalijarvi@unikie.com>
---
 drivers/net/Kconfig         |  9 +++++++
 drivers/net/ksz9477.c       | 48 +++++++++++++++++++++++++++++++++++--
 drivers/net/ksz9477_reg.h   | 12 ++++++++++
 include/nuttx/net/ksz9477.h | 21 ++++++++++++++++
 4 files changed, 88 insertions(+), 2 deletions(-)

diff --git a/drivers/net/Kconfig b/drivers/net/Kconfig
index 84b4f357201e8..25db4df667e04 100644
--- a/drivers/net/Kconfig
+++ b/drivers/net/Kconfig
@@ -472,6 +472,15 @@ config NET_KSZ9477_PORT_VLAN_SGMII
 	depends on NET_KSZ9477_PORT_VLAN
 	default 0x1f
 
+config NET_KSZ9477_PORT_SNIFF
+	bool "Enable support for the port mirroring and snooping"
+	depends on NET_KSZ9477
+	default n
+	---help---
+		Enables possibility to set rx/tx mirroring and sniffer port.
+		All the packets received on port A and/or transmitted on port B
+		can be mirrored on the sniffer port.
+
 menuconfig NET_LAN9250
 	bool "Microchip LAN9250 support"
 	default n
diff --git a/drivers/net/ksz9477.c b/drivers/net/ksz9477.c
index 1f348ea318848..dabc631110666 100644
--- a/drivers/net/ksz9477.c
+++ b/drivers/net/ksz9477.c
@@ -49,6 +49,8 @@ static uint8_t g_port_vlan_config[] =
   CONFIG_NET_KSZ9477_PORT_VLAN_SGMII
 };
 
+static uint8_t g_port_mirror_config[7] = {0};
+
 #endif
 
 /****************************************************************************
@@ -101,7 +103,6 @@ static int ksz9477_reg_read32(uint16_t reg, uint32_t *data)
   return ret;
 }
 
-#if 0  /* Enable when needed */
 static int ksz9477_reg_write8(uint16_t reg, uint8_t data)
 {
   struct ksz9477_transfer_s write_msg;
@@ -110,7 +111,6 @@ static int ksz9477_reg_write8(uint16_t reg, uint8_t data)
   write_msg.data = data;
   return ksz9477_write(&write_msg);
 }
-#endif
 
 static int ksz9477_reg_write32(uint16_t reg, uint32_t data)
 {
@@ -301,6 +301,37 @@ int ksz9477_configure_port_vlan(ksz9477_port_t port, uint8_t disable,
   return OK;
 }
 
+/****************************************************************************
+ * Name: ksz9477_configure_port_mirroring
+ *
+ * Description:
+ *   Configures the port mirroring and snooping.
+ *   The change will become effective next time when the switch is
+ *   initialized.
+ *
+ * Input Parameters:
+ *   port: The port being configured (1-7)
+ *   config: Bitmask to enable/disable rx/tx mirroring, sniffer port.
+ *           See header file or Port Mirroring Control Register
+ *           from datasheet for further details.
+ *
+ * Returned Value:
+ *   OK or negative error number
+ *
+ ****************************************************************************/
+
+int ksz9477_configure_port_mirroring(ksz9477_port_t port, uint8_t config)
+{
+  if (port < KSZ9477_PORT_PHY1 || port > KSZ9477_PORT_SGMII)
+    {
+      return -EINVAL;
+    }
+
+  g_port_mirror_config[port - KSZ9477_PORT_PHY1] = config;
+
+  return OK;
+}
+
 /****************************************************************************
  * Name: ksz9477_init
  *
@@ -378,6 +409,19 @@ int ksz9477_init(ksz9477_port_t master_port)
               g_port_vlan_config[i]);
     }
 
+#endif
+
+#ifdef CONFIG_NET_KSZ9477_PORT_SNIFF
+
+  /* Configure the port mirroring and snooping for each port */
+
+  for (i = 0; ret == OK && i < 7; i++)
+    {
+      ret = ksz9477_reg_write8(
+              KSZ9477_PORT_MIRROR_CONTROL(KSZ9477_PORT_PHY1 + i),
+              g_port_mirror_config[i]);
+    }
+
 #endif
 
   return ret;
diff --git a/drivers/net/ksz9477_reg.h b/drivers/net/ksz9477_reg.h
index 1d75da8fe930f..dd62d405387e8 100644
--- a/drivers/net/ksz9477_reg.h
+++ b/drivers/net/ksz9477_reg.h
@@ -118,6 +118,18 @@
 #define SGMII_AUTONEG_CONTROL_TC_MASTER    (1 << 3)
 #define SGMII_AUTONEG_CONTROL_LINK_STATUS  (1 << 4)
 
+/* Port Mirroring Control Register */
+
+#define KSZ9477_PORT_MIRROR_CONTROL(p)     KSZ9477_PORT_REG(p, 0x800)
+#define PORT_MIRROR_SNIFFER_PORT           (1 << 1)
+#define PORT_MIRROR_TX_SNIFF               (1 << 5)
+#define PORT_MIRROR_RX_SNIFF               (1 << 6)
+
+/* Global Port Mirroring and Snooping Control Register */
+
+#define KSZ9477_GLOBAL_PORT_MIRROR_CONTROL 0x0370
+#define GLOBAL_PORT_SNIFF_MODE             (1 << 0)
+
 /****************************************************************************
  * Public Types
  ****************************************************************************/
diff --git a/include/nuttx/net/ksz9477.h b/include/nuttx/net/ksz9477.h
index 3ca96f1fe6cd2..bd6c76646073a 100644
--- a/include/nuttx/net/ksz9477.h
+++ b/include/nuttx/net/ksz9477.h
@@ -147,6 +147,27 @@ int ksz9477_disable_port_vlan(void);
 int ksz9477_configure_port_vlan(ksz9477_port_t port, uint8_t disable,
                                 uint8_t enable);
 
+/****************************************************************************
+ * Name: ksz9477_configure_port_mirroring
+ *
+ * Description:
+ *   Configures the port mirroring and snooping
+ *   The change will become effective next time when the switch is
+ *   initialized.
+ *
+ * Input Parameters:
+ *   port: The port being configured (1-7)
+ *   config: Bitmask to enable/disable rx/tx mirroring, sniffer port.
+ *           See header file or Port Mirroring Control Register
+ *           from datasheet for further details.
+ *
+ * Returned Value:
+ *   OK or negative error number
+ *
+ ****************************************************************************/
+
+int ksz9477_configure_port_mirroring(ksz9477_port_t port, uint8_t config);
+
 #if defined(__cplusplus)
 }
 #endif