net: dsa: microchip: move KSZ9477 WoL functions to ksz_common
authorPieter Van Trappen <pieter.van.trappen@cern.ch>
Tue, 13 Aug 2024 14:27:36 +0000 (16:27 +0200)
committerJakub Kicinski <kuba@kernel.org>
Fri, 16 Aug 2024 17:25:02 +0000 (10:25 -0700)
Move KSZ9477 WoL functions to ksz_common, in preparation for adding
KSZ87xx family support.

Signed-off-by: Pieter Van Trappen <pieter.van.trappen@cern.ch>
Acked-by: Arun Ramadoss <arun.ramadoss@microchip.com>
Link: https://patch.msgid.link/20240813142750.772781-3-vtpieter@gmail.com
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
drivers/net/dsa/microchip/ksz9477.c
drivers/net/dsa/microchip/ksz9477.h
drivers/net/dsa/microchip/ksz9477_reg.h
drivers/net/dsa/microchip/ksz_common.c
drivers/net/dsa/microchip/ksz_common.h

index 755de09..6c1540f 100644 (file)
@@ -56,187 +56,6 @@ int ksz9477_change_mtu(struct ksz_device *dev, int port, int mtu)
                                  REG_SW_MTU_MASK, frame_size);
 }
 
-/**
- * ksz9477_handle_wake_reason - Handle wake reason on a specified port.
- * @dev: The device structure.
- * @port: The port number.
- *
- * This function reads the PME (Power Management Event) status register of a
- * specified port to determine the wake reason. If there is no wake event, it
- * returns early. Otherwise, it logs the wake reason which could be due to a
- * "Magic Packet", "Link Up", or "Energy Detect" event. The PME status register
- * is then cleared to acknowledge the handling of the wake event.
- *
- * Return: 0 on success, or an error code on failure.
- */
-static int ksz9477_handle_wake_reason(struct ksz_device *dev, int port)
-{
-       u8 pme_status;
-       int ret;
-
-       ret = ksz_pread8(dev, port, REG_PORT_PME_STATUS, &pme_status);
-       if (ret)
-               return ret;
-
-       if (!pme_status)
-               return 0;
-
-       dev_dbg(dev->dev, "Wake event on port %d due to:%s%s%s\n", port,
-               pme_status & PME_WOL_MAGICPKT ? " \"Magic Packet\"" : "",
-               pme_status & PME_WOL_LINKUP ? " \"Link Up\"" : "",
-               pme_status & PME_WOL_ENERGY ? " \"Energy detect\"" : "");
-
-       return ksz_pwrite8(dev, port, REG_PORT_PME_STATUS, pme_status);
-}
-
-/**
- * ksz9477_get_wol - Get Wake-on-LAN settings for a specified port.
- * @dev: The device structure.
- * @port: The port number.
- * @wol: Pointer to ethtool Wake-on-LAN settings structure.
- *
- * This function checks the PME Pin Control Register to see if  PME Pin Output
- * Enable is set, indicating PME is enabled. If enabled, it sets the supported
- * and active WoL flags.
- */
-void ksz9477_get_wol(struct ksz_device *dev, int port,
-                    struct ethtool_wolinfo *wol)
-{
-       u8 pme_ctrl;
-       int ret;
-
-       if (!dev->wakeup_source)
-               return;
-
-       wol->supported = WAKE_PHY;
-
-       /* Check if the current MAC address on this port can be set
-        * as global for WAKE_MAGIC support. The result may vary
-        * dynamically based on other ports configurations.
-        */
-       if (ksz_is_port_mac_global_usable(dev->ds, port))
-               wol->supported |= WAKE_MAGIC;
-
-       ret = ksz_pread8(dev, port, REG_PORT_PME_CTRL, &pme_ctrl);
-       if (ret)
-               return;
-
-       if (pme_ctrl & PME_WOL_MAGICPKT)
-               wol->wolopts |= WAKE_MAGIC;
-       if (pme_ctrl & (PME_WOL_LINKUP | PME_WOL_ENERGY))
-               wol->wolopts |= WAKE_PHY;
-}
-
-/**
- * ksz9477_set_wol - Set Wake-on-LAN settings for a specified port.
- * @dev: The device structure.
- * @port: The port number.
- * @wol: Pointer to ethtool Wake-on-LAN settings structure.
- *
- * This function configures Wake-on-LAN (WoL) settings for a specified port.
- * It validates the provided WoL options, checks if PME is enabled via the
- * switch's PME Pin Control Register, clears any previous wake reasons,
- * and sets the Magic Packet flag in the port's PME control register if
- * specified.
- *
- * Return: 0 on success, or other error codes on failure.
- */
-int ksz9477_set_wol(struct ksz_device *dev, int port,
-                   struct ethtool_wolinfo *wol)
-{
-       u8 pme_ctrl = 0, pme_ctrl_old = 0;
-       bool magic_switched_off;
-       bool magic_switched_on;
-       int ret;
-
-       if (wol->wolopts & ~(WAKE_PHY | WAKE_MAGIC))
-               return -EINVAL;
-
-       if (!dev->wakeup_source)
-               return -EOPNOTSUPP;
-
-       ret = ksz9477_handle_wake_reason(dev, port);
-       if (ret)
-               return ret;
-
-       if (wol->wolopts & WAKE_MAGIC)
-               pme_ctrl |= PME_WOL_MAGICPKT;
-       if (wol->wolopts & WAKE_PHY)
-               pme_ctrl |= PME_WOL_LINKUP | PME_WOL_ENERGY;
-
-       ret = ksz_pread8(dev, port, REG_PORT_PME_CTRL, &pme_ctrl_old);
-       if (ret)
-               return ret;
-
-       if (pme_ctrl_old == pme_ctrl)
-               return 0;
-
-       magic_switched_off = (pme_ctrl_old & PME_WOL_MAGICPKT) &&
-                           !(pme_ctrl & PME_WOL_MAGICPKT);
-       magic_switched_on = !(pme_ctrl_old & PME_WOL_MAGICPKT) &&
-                           (pme_ctrl & PME_WOL_MAGICPKT);
-
-       /* To keep reference count of MAC address, we should do this
-        * operation only on change of WOL settings.
-        */
-       if (magic_switched_on) {
-               ret = ksz_switch_macaddr_get(dev->ds, port, NULL);
-               if (ret)
-                       return ret;
-       } else if (magic_switched_off) {
-               ksz_switch_macaddr_put(dev->ds);
-       }
-
-       ret = ksz_pwrite8(dev, port, REG_PORT_PME_CTRL, pme_ctrl);
-       if (ret) {
-               if (magic_switched_on)
-                       ksz_switch_macaddr_put(dev->ds);
-               return ret;
-       }
-
-       return 0;
-}
-
-/**
- * ksz9477_wol_pre_shutdown - Prepares the switch device for shutdown while
- *                            considering Wake-on-LAN (WoL) settings.
- * @dev: The switch device structure.
- * @wol_enabled: Pointer to a boolean which will be set to true if WoL is
- *               enabled on any port.
- *
- * This function prepares the switch device for a safe shutdown while taking
- * into account the Wake-on-LAN (WoL) settings on the user ports. It updates
- * the wol_enabled flag accordingly to reflect whether WoL is active on any
- * port.
- */
-void ksz9477_wol_pre_shutdown(struct ksz_device *dev, bool *wol_enabled)
-{
-       struct dsa_port *dp;
-       int ret;
-
-       *wol_enabled = false;
-
-       if (!dev->wakeup_source)
-               return;
-
-       dsa_switch_for_each_user_port(dp, dev->ds) {
-               u8 pme_ctrl = 0;
-
-               ret = ksz_pread8(dev, dp->index, REG_PORT_PME_CTRL, &pme_ctrl);
-               if (!ret && pme_ctrl)
-                       *wol_enabled = true;
-
-               /* make sure there are no pending wake events which would
-                * prevent the device from going to sleep/shutdown.
-                */
-               ksz9477_handle_wake_reason(dev, dp->index);
-       }
-
-       /* Now we are save to enable PME pin. */
-       if (*wol_enabled)
-               ksz_write8(dev, REG_SW_PME_CTRL, PME_ENABLE);
-}
-
 static int ksz9477_wait_vlan_ctrl_ready(struct ksz_device *dev)
 {
        unsigned int val;
index 239a281..d2166b0 100644 (file)
@@ -60,11 +60,6 @@ void ksz9477_switch_exit(struct ksz_device *dev);
 void ksz9477_port_queue_split(struct ksz_device *dev, int port);
 void ksz9477_hsr_join(struct dsa_switch *ds, int port, struct net_device *hsr);
 void ksz9477_hsr_leave(struct dsa_switch *ds, int port, struct net_device *hsr);
-void ksz9477_get_wol(struct ksz_device *dev, int port,
-                    struct ethtool_wolinfo *wol);
-int ksz9477_set_wol(struct ksz_device *dev, int port,
-                   struct ethtool_wolinfo *wol);
-void ksz9477_wol_pre_shutdown(struct ksz_device *dev, bool *wol_enabled);
 
 int ksz9477_port_acl_init(struct ksz_device *dev, int port);
 void ksz9477_port_acl_free(struct ksz_device *dev, int port);
index d5354c6..04235c2 100644 (file)
 #define SWITCH_REVISION_S              4
 #define SWITCH_RESET                   0x01
 
-#define REG_SW_PME_CTRL                        0x0006
-
-#define PME_ENABLE                     BIT(1)
-#define PME_POLARITY                   BIT(0)
-
 #define REG_GLOBAL_OPTIONS             0x000F
 
 #define SW_GIGABIT_ABLE                        BIT(6)
 #define REG_PORT_AVB_SR_1_TYPE         0x0008
 #define REG_PORT_AVB_SR_2_TYPE         0x000A
 
-#define REG_PORT_PME_STATUS            0x0013
-#define REG_PORT_PME_CTRL              0x0017
-
-#define PME_WOL_MAGICPKT               BIT(2)
-#define PME_WOL_LINKUP                 BIT(1)
-#define PME_WOL_ENERGY                 BIT(0)
-
 #define REG_PORT_INT_STATUS            0x001B
 #define REG_PORT_INT_MASK              0x001F
 
index 1491099..7afe958 100644 (file)
@@ -3751,6 +3751,77 @@ static void ksz_get_wol(struct dsa_switch *ds, int port,
                dev->dev_ops->get_wol(dev, port, wol);
 }
 
+/**
+ * ksz9477_handle_wake_reason - Handle wake reason on a specified port.
+ * @dev: The device structure.
+ * @port: The port number.
+ *
+ * This function reads the PME (Power Management Event) status register of a
+ * specified port to determine the wake reason. If there is no wake event, it
+ * returns early. Otherwise, it logs the wake reason which could be due to a
+ * "Magic Packet", "Link Up", or "Energy Detect" event. The PME status register
+ * is then cleared to acknowledge the handling of the wake event.
+ *
+ * Return: 0 on success, or an error code on failure.
+ */
+int ksz9477_handle_wake_reason(struct ksz_device *dev, int port)
+{
+       u8 pme_status;
+       int ret;
+
+       ret = ksz_pread8(dev, port, REG_PORT_PME_STATUS, &pme_status);
+       if (ret)
+               return ret;
+
+       if (!pme_status)
+               return 0;
+
+       dev_dbg(dev->dev, "Wake event on port %d due to:%s%s%s\n", port,
+               pme_status & PME_WOL_MAGICPKT ? " \"Magic Packet\"" : "",
+               pme_status & PME_WOL_LINKUP ? " \"Link Up\"" : "",
+               pme_status & PME_WOL_ENERGY ? " \"Energy detect\"" : "");
+
+       return ksz_pwrite8(dev, port, REG_PORT_PME_STATUS, pme_status);
+}
+
+/**
+ * ksz9477_get_wol - Get Wake-on-LAN settings for a specified port.
+ * @dev: The device structure.
+ * @port: The port number.
+ * @wol: Pointer to ethtool Wake-on-LAN settings structure.
+ *
+ * This function checks the PME Pin Control Register to see if  PME Pin Output
+ * Enable is set, indicating PME is enabled. If enabled, it sets the supported
+ * and active WoL flags.
+ */
+void ksz9477_get_wol(struct ksz_device *dev, int port,
+                    struct ethtool_wolinfo *wol)
+{
+       u8 pme_ctrl;
+       int ret;
+
+       if (!dev->wakeup_source)
+               return;
+
+       wol->supported = WAKE_PHY;
+
+       /* Check if the current MAC address on this port can be set
+        * as global for WAKE_MAGIC support. The result may vary
+        * dynamically based on other ports configurations.
+        */
+       if (ksz_is_port_mac_global_usable(dev->ds, port))
+               wol->supported |= WAKE_MAGIC;
+
+       ret = ksz_pread8(dev, port, REG_PORT_PME_CTRL, &pme_ctrl);
+       if (ret)
+               return;
+
+       if (pme_ctrl & PME_WOL_MAGICPKT)
+               wol->wolopts |= WAKE_MAGIC;
+       if (pme_ctrl & (PME_WOL_LINKUP | PME_WOL_ENERGY))
+               wol->wolopts |= WAKE_PHY;
+}
+
 static int ksz_set_wol(struct dsa_switch *ds, int port,
                       struct ethtool_wolinfo *wol)
 {
@@ -3762,6 +3833,116 @@ static int ksz_set_wol(struct dsa_switch *ds, int port,
        return -EOPNOTSUPP;
 }
 
+/**
+ * ksz9477_set_wol - Set Wake-on-LAN settings for a specified port.
+ * @dev: The device structure.
+ * @port: The port number.
+ * @wol: Pointer to ethtool Wake-on-LAN settings structure.
+ *
+ * This function configures Wake-on-LAN (WoL) settings for a specified port.
+ * It validates the provided WoL options, checks if PME is enabled via the
+ * switch's PME Pin Control Register, clears any previous wake reasons,
+ * and sets the Magic Packet flag in the port's PME control register if
+ * specified.
+ *
+ * Return: 0 on success, or other error codes on failure.
+ */
+int ksz9477_set_wol(struct ksz_device *dev, int port,
+                   struct ethtool_wolinfo *wol)
+{
+       u8 pme_ctrl = 0, pme_ctrl_old = 0;
+       bool magic_switched_off;
+       bool magic_switched_on;
+       int ret;
+
+       if (wol->wolopts & ~(WAKE_PHY | WAKE_MAGIC))
+               return -EINVAL;
+
+       if (!dev->wakeup_source)
+               return -EOPNOTSUPP;
+
+       ret = ksz9477_handle_wake_reason(dev, port);
+       if (ret)
+               return ret;
+
+       if (wol->wolopts & WAKE_MAGIC)
+               pme_ctrl |= PME_WOL_MAGICPKT;
+       if (wol->wolopts & WAKE_PHY)
+               pme_ctrl |= PME_WOL_LINKUP | PME_WOL_ENERGY;
+
+       ret = ksz_pread8(dev, port, REG_PORT_PME_CTRL, &pme_ctrl_old);
+       if (ret)
+               return ret;
+
+       if (pme_ctrl_old == pme_ctrl)
+               return 0;
+
+       magic_switched_off = (pme_ctrl_old & PME_WOL_MAGICPKT) &&
+                           !(pme_ctrl & PME_WOL_MAGICPKT);
+       magic_switched_on = !(pme_ctrl_old & PME_WOL_MAGICPKT) &&
+                           (pme_ctrl & PME_WOL_MAGICPKT);
+
+       /* To keep reference count of MAC address, we should do this
+        * operation only on change of WOL settings.
+        */
+       if (magic_switched_on) {
+               ret = ksz_switch_macaddr_get(dev->ds, port, NULL);
+               if (ret)
+                       return ret;
+       } else if (magic_switched_off) {
+               ksz_switch_macaddr_put(dev->ds);
+       }
+
+       ret = ksz_pwrite8(dev, port, REG_PORT_PME_CTRL, pme_ctrl);
+       if (ret) {
+               if (magic_switched_on)
+                       ksz_switch_macaddr_put(dev->ds);
+               return ret;
+       }
+
+       return 0;
+}
+
+/**
+ * ksz9477_wol_pre_shutdown - Prepares the switch device for shutdown while
+ *                            considering Wake-on-LAN (WoL) settings.
+ * @dev: The switch device structure.
+ * @wol_enabled: Pointer to a boolean which will be set to true if WoL is
+ *               enabled on any port.
+ *
+ * This function prepares the switch device for a safe shutdown while taking
+ * into account the Wake-on-LAN (WoL) settings on the user ports. It updates
+ * the wol_enabled flag accordingly to reflect whether WoL is active on any
+ * port.
+ */
+void ksz9477_wol_pre_shutdown(struct ksz_device *dev, bool *wol_enabled)
+{
+       struct dsa_port *dp;
+       int ret;
+
+       *wol_enabled = false;
+
+       if (!dev->wakeup_source)
+               return;
+
+       dsa_switch_for_each_user_port(dp, dev->ds) {
+               u8 pme_ctrl = 0;
+
+               ret = ksz_pread8(dev, dp->index, REG_PORT_PME_CTRL, &pme_ctrl);
+               if (!ret && pme_ctrl)
+                       *wol_enabled = true;
+
+               /* make sure there are no pending wake events which would
+                * prevent the device from going to sleep/shutdown.
+                */
+               ksz9477_handle_wake_reason(dev, dp->index);
+       }
+
+       /* Now we are save to enable PME pin. */
+       if (*wol_enabled)
+               ksz_write8(dev, REG_SW_PME_CTRL, PME_ENABLE);
+}
+
 static int ksz_port_set_mac_address(struct dsa_switch *ds, int port,
                                    const unsigned char *addr)
 {
index 5f0a628..e35caca 100644 (file)
@@ -391,6 +391,12 @@ int ksz_switch_macaddr_get(struct dsa_switch *ds, int port,
                           struct netlink_ext_ack *extack);
 void ksz_switch_macaddr_put(struct dsa_switch *ds);
 void ksz_switch_shutdown(struct ksz_device *dev);
+int ksz9477_handle_wake_reason(struct ksz_device *dev, int port);
+void ksz9477_get_wol(struct ksz_device *dev, int port,
+                    struct ethtool_wolinfo *wol);
+int ksz9477_set_wol(struct ksz_device *dev, int port,
+                   struct ethtool_wolinfo *wol);
+void ksz9477_wol_pre_shutdown(struct ksz_device *dev, bool *wol_enabled);
 
 /* Common register access functions */
 static inline struct regmap *ksz_regmap_8(struct ksz_device *dev)
@@ -695,6 +701,19 @@ static inline bool is_lan937x_tx_phy(struct ksz_device *dev, int port)
 #define P_MII_MAC_MODE                 BIT(2)
 #define P_MII_SEL_M                    0x3
 
+/* KSZ9477, KSZ8795 Wake-on-LAN (WoL) masks */
+#define REG_PORT_PME_STATUS            0x0013
+#define REG_PORT_PME_CTRL              0x0017
+
+#define PME_WOL_MAGICPKT               BIT(2)
+#define PME_WOL_LINKUP                 BIT(1)
+#define PME_WOL_ENERGY                 BIT(0)
+
+#define REG_SW_PME_CTRL                        0x0006
+
+#define PME_ENABLE                     BIT(1)
+#define PME_POLARITY                   BIT(0)
+
 /* Interrupt */
 #define REG_SW_PORT_INT_STATUS__1      0x001B
 #define REG_SW_PORT_INT_MASK__1                0x001F