Commit c39be5e8 authored by Jakub Kicinski's avatar Jakub Kicinski

Merge branch 'net-dsa-microchip-ksz8795-add-wake-on-lan-support'

Pieter Van Trappen says:

====================
net: dsa: microchip: ksz8795: add Wake on LAN support

Add WoL support for KSZ8795 family of switches. This code was tested
with a KSZ8794 chip.

Strongly based on existing KSZ9477 code which has now been moved to
ksz_common instead of duplicating, as proposed during the review of
the v1 version of this patch.

In addition to the device-tree addition and the actual code, there's
two additional patches that fix some bugs found when further testing
DSA with this KSZ8794 chip.

v5: https://lore.kernel.org/20240812153015.653044-1-vtpieter@gmail.com
v4: https://lore.kernel.org/20240812084945.578993-1-vtpieter@gmail.com
v3: https://lore.kernel.org/20240806132606.1438953-1-vtpieter@gmail.com
v2: https://lore.kernel.org/20240731103403.407818-1-vtpieter@gmail.com
v1: https://lore.kernel.org/20240717193725.469192-1-vtpieter@gmail.com
====================

Link: https://patch.msgid.link/20240813142750.772781-1-vtpieter@gmail.comSigned-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parents 20f77dc7 6f2b72c0
......@@ -51,6 +51,11 @@ properties:
Set if the output SYNCLKO clock should be disabled. Do not mix with
microchip,synclko-125.
microchip,pme-active-high:
$ref: /schemas/types.yaml#/definitions/flag
description:
Indicates if the PME pin polarity is active-high.
microchip,io-drive-strength-microamp:
description:
IO Pad Drive Strength
......
......@@ -54,6 +54,9 @@ int ksz8_reset_switch(struct ksz_device *dev);
int ksz8_switch_init(struct ksz_device *dev);
void ksz8_switch_exit(struct ksz_device *dev);
int ksz8_change_mtu(struct ksz_device *dev, int port, int mtu);
int ksz8_pme_write8(struct ksz_device *dev, u32 reg, u8 value);
int ksz8_pme_pread8(struct ksz_device *dev, int port, int offset, u8 *data);
int ksz8_pme_pwrite8(struct ksz_device *dev, int port, int offset, u8 data);
void ksz8_phylink_mac_link_up(struct phylink_config *config,
struct phy_device *phydev, unsigned int mode,
phy_interface_t interface, int speed, int duplex,
......
......@@ -38,6 +38,20 @@ static void ksz_port_cfg(struct ksz_device *dev, int port, int offset, u8 bits,
bits, set ? bits : 0);
}
/**
* ksz8_ind_write8 - EEE/ACL/PME indirect register write
* @dev: The device structure.
* @table: Function & table select, register 110.
* @addr: Indirect access control, register 111.
* @data: The data to be written.
*
* This function performs an indirect register write for EEE, ACL or
* PME switch functionalities. Both 8-bit registers 110 and 111 are
* written at once with ksz_write16, using the serial multiple write
* functionality.
*
* Return: 0 on success, or an error code on failure.
*/
static int ksz8_ind_write8(struct ksz_device *dev, u8 table, u16 addr, u8 data)
{
const u16 *regs;
......@@ -58,6 +72,59 @@ static int ksz8_ind_write8(struct ksz_device *dev, u8 table, u16 addr, u8 data)
return ret;
}
/**
* ksz8_ind_read8 - EEE/ACL/PME indirect register read
* @dev: The device structure.
* @table: Function & table select, register 110.
* @addr: Indirect access control, register 111.
* @val: The value read.
*
* This function performs an indirect register read for EEE, ACL or
* PME switch functionalities. Both 8-bit registers 110 and 111 are
* written at once with ksz_write16, using the serial multiple write
* functionality.
*
* Return: 0 on success, or an error code on failure.
*/
static int ksz8_ind_read8(struct ksz_device *dev, u8 table, u16 addr, u8 *val)
{
const u16 *regs;
u16 ctrl_addr;
int ret = 0;
regs = dev->info->regs;
mutex_lock(&dev->alu_mutex);
ctrl_addr = IND_ACC_TABLE(table | TABLE_READ) | addr;
ret = ksz_write16(dev, regs[REG_IND_CTRL_0], ctrl_addr);
if (!ret)
ret = ksz_read8(dev, regs[REG_IND_BYTE], val);
mutex_unlock(&dev->alu_mutex);
return ret;
}
int ksz8_pme_write8(struct ksz_device *dev, u32 reg, u8 value)
{
return ksz8_ind_write8(dev, (u8)(reg >> 8), (u8)(reg), value);
}
int ksz8_pme_pread8(struct ksz_device *dev, int port, int offset, u8 *data)
{
u8 table = (u8)(offset >> 8 | (port + 1));
return ksz8_ind_read8(dev, table, (u8)(offset), data);
}
int ksz8_pme_pwrite8(struct ksz_device *dev, int port, int offset, u8 data)
{
u8 table = (u8)(offset >> 8 | (port + 1));
return ksz8_ind_write8(dev, table, (u8)(offset), data);
}
int ksz8_reset_switch(struct ksz_device *dev)
{
if (ksz_is_ksz88x3(dev)) {
......@@ -1545,6 +1612,7 @@ static void ksz8795_cpu_interface_select(struct ksz_device *dev, int port)
void ksz8_port_setup(struct ksz_device *dev, int port, bool cpu_port)
{
const u16 *regs = dev->info->regs;
struct dsa_switch *ds = dev->ds;
const u32 *masks;
int queues;
......@@ -1575,6 +1643,13 @@ void ksz8_port_setup(struct ksz_device *dev, int port, bool cpu_port)
member = BIT(dsa_upstream_port(ds, port));
ksz8_cfg_port_member(dev, port, member);
/* Disable all WoL options by default. Otherwise
* ksz_switch_macaddr_get/put logic will not work properly.
* CPU port 4 has no WoL functionality.
*/
if (ksz_is_ksz87xx(dev) && !cpu_port)
ksz8_pme_pwrite8(dev, port, regs[REG_PORT_PME_CTRL], 0);
}
static void ksz88x3_config_rmii_clk(struct ksz_device *dev)
......@@ -1790,7 +1865,8 @@ int ksz8_enable_stp_addr(struct ksz_device *dev)
int ksz8_setup(struct dsa_switch *ds)
{
struct ksz_device *dev = ds->priv;
int i;
const u16 *regs = dev->info->regs;
int i, ret = 0;
ds->mtu_enforcement_ingress = true;
......@@ -1829,7 +1905,21 @@ int ksz8_setup(struct dsa_switch *ds)
for (i = 0; i < (dev->info->num_vlans / 4); i++)
ksz8_r_vlan_entries(dev, i);
return ksz8_handle_global_errata(ds);
/* Make sure PME (WoL) is not enabled. If requested, it will
* be enabled by ksz_wol_pre_shutdown(). Otherwise, some PMICs
* do not like PME events changes before shutdown. PME only
* available on KSZ87xx family.
*/
if (ksz_is_ksz87xx(dev)) {
ret = ksz8_pme_write8(dev, regs[REG_SW_PME_CTRL], 0);
if (!ret)
ret = ksz_rmw8(dev, REG_INT_ENABLE, INT_PME, 0);
}
if (!ret)
return ksz8_handle_global_errata(ds);
else
return ret;
}
void ksz8_get_caps(struct ksz_device *dev, int port,
......
......@@ -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;
......@@ -1204,6 +1023,7 @@ void ksz9477_port_queue_split(struct ksz_device *dev, int port)
void ksz9477_port_setup(struct ksz_device *dev, int port, bool cpu_port)
{
const u16 *regs = dev->info->regs;
struct dsa_switch *ds = dev->ds;
u16 data16;
u8 member;
......@@ -1248,12 +1068,12 @@ void ksz9477_port_setup(struct ksz_device *dev, int port, bool cpu_port)
ksz9477_port_acl_init(dev, port);
/* clear pending wake flags */
ksz9477_handle_wake_reason(dev, port);
ksz_handle_wake_reason(dev, port);
/* Disable all WoL options by default. Otherwise
* ksz_switch_macaddr_get/put logic will not work properly.
*/
ksz_pwrite8(dev, port, REG_PORT_PME_CTRL, 0);
ksz_pwrite8(dev, port, regs[REG_PORT_PME_CTRL], 0);
}
void ksz9477_config_cpu_port(struct dsa_switch *ds)
......@@ -1350,6 +1170,7 @@ int ksz9477_enable_stp_addr(struct ksz_device *dev)
int ksz9477_setup(struct dsa_switch *ds)
{
struct ksz_device *dev = ds->priv;
const u16 *regs = dev->info->regs;
int ret = 0;
ds->mtu_enforcement_ingress = true;
......@@ -1380,13 +1201,11 @@ int ksz9477_setup(struct dsa_switch *ds)
/* enable global MIB counter freeze function */
ksz_cfg(dev, REG_SW_MAC_CTRL_6, SW_MIB_COUNTER_FREEZE, true);
/* Make sure PME (WoL) is not enabled. If requested, it will be
* enabled by ksz9477_wol_pre_shutdown(). Otherwise, some PMICs do not
* like PME events changes before shutdown.
/* Make sure PME (WoL) is not enabled. If requested, it will
* be enabled by ksz_wol_pre_shutdown(). Otherwise, some PMICs
* do not like PME events changes before shutdown.
*/
ksz_write8(dev, REG_SW_PME_CTRL, 0);
return 0;
return ksz_write8(dev, regs[REG_SW_PME_CTRL], 0);
}
u32 ksz9477_get_port_addr(int port, int offset)
......
......@@ -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);
......
......@@ -38,11 +38,6 @@
#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)
......@@ -807,13 +802,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
......
This diff is collapsed.
......@@ -174,6 +174,7 @@ struct ksz_device {
bool synclko_125;
bool synclko_disable;
bool wakeup_source;
bool pme_active_high;
struct vlan_table *vlan_cache;
......@@ -235,6 +236,9 @@ enum ksz_regs {
S_MULTICAST_CTRL,
P_XMII_CTRL_0,
P_XMII_CTRL_1,
REG_SW_PME_CTRL,
REG_PORT_PME_STATUS,
REG_PORT_PME_CTRL,
};
enum ksz_masks {
......@@ -354,6 +358,11 @@ struct ksz_dev_ops {
void (*get_caps)(struct ksz_device *dev, int port,
struct phylink_config *config);
int (*change_mtu)(struct ksz_device *dev, int port, int mtu);
int (*pme_write8)(struct ksz_device *dev, u32 reg, u8 value);
int (*pme_pread8)(struct ksz_device *dev, int port, int offset,
u8 *data);
int (*pme_pwrite8)(struct ksz_device *dev, int port, int offset,
u8 data);
void (*freeze_mib)(struct ksz_device *dev, int port, bool freeze);
void (*port_init_cnt)(struct ksz_device *dev, int port);
void (*phylink_mac_link_up)(struct ksz_device *dev, int port,
......@@ -363,11 +372,6 @@ struct ksz_dev_ops {
int duplex, bool tx_pause, bool rx_pause);
void (*setup_rgmii_delay)(struct ksz_device *dev, int port);
int (*tc_cbs_set_cinc)(struct ksz_device *dev, int port, u32 val);
void (*get_wol)(struct ksz_device *dev, int port,
struct ethtool_wolinfo *wol);
int (*set_wol)(struct ksz_device *dev, int port,
struct ethtool_wolinfo *wol);
void (*wol_pre_shutdown)(struct ksz_device *dev, bool *wol_enabled);
void (*config_cpu_port)(struct dsa_switch *ds);
int (*enable_stp_addr)(struct ksz_device *dev);
int (*reset)(struct ksz_device *dev);
......@@ -391,6 +395,7 @@ 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 ksz_handle_wake_reason(struct ksz_device *dev, int port);
/* Common register access functions */
static inline struct regmap *ksz_regmap_8(struct ksz_device *dev)
......@@ -629,6 +634,11 @@ static inline bool is_ksz8(struct ksz_device *dev)
return ksz_is_ksz87xx(dev) || ksz_is_ksz88x3(dev);
}
static inline bool is_ksz9477(struct ksz_device *dev)
{
return dev->chip_id == KSZ9477_CHIP_ID;
}
static inline int is_lan937x(struct ksz_device *dev)
{
return dev->chip_id == LAN9370_CHIP_ID ||
......@@ -695,6 +705,17 @@ 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, KSZ87xx Wake-on-LAN (WoL) masks */
#define PME_WOL_MAGICPKT BIT(2)
#define PME_WOL_LINKUP BIT(1)
#define PME_WOL_ENERGY BIT(0)
#define PME_ENABLE BIT(1)
#define PME_POLARITY BIT(0)
#define KSZ87XX_REG_INT_EN 0x7D
#define KSZ87XX_INT_PME_MASK BIT(4)
/* Interrupt */
#define REG_SW_PORT_INT_STATUS__1 0x001B
#define REG_SW_PORT_INT_MASK__1 0x001F
......
......@@ -111,9 +111,10 @@ static struct sk_buff *ksz_common_rcv(struct sk_buff *skb,
* DA(6bytes)|SA(6bytes)|....|Data(nbytes)|tag0(1byte)|FCS(4bytes)
* ---------------------------------------------------------------------------
* tag0 : zero-based value represents port
* (eg, 0x00=port1, 0x02=port3, 0x06=port7)
* (eg, 0x0=port1, 0x2=port3, 0x3=port4)
*/
#define KSZ8795_TAIL_TAG_EG_PORT_M GENMASK(1, 0)
#define KSZ8795_TAIL_TAG_OVERRIDE BIT(6)
#define KSZ8795_TAIL_TAG_LOOKUP BIT(7)
......@@ -141,7 +142,8 @@ static struct sk_buff *ksz8795_rcv(struct sk_buff *skb, struct net_device *dev)
{
u8 *tag = skb_tail_pointer(skb) - KSZ_EGRESS_TAG_LEN;
return ksz_common_rcv(skb, dev, tag[0] & 7, KSZ_EGRESS_TAG_LEN);
return ksz_common_rcv(skb, dev, tag[0] & KSZ8795_TAIL_TAG_EG_PORT_M,
KSZ_EGRESS_TAG_LEN);
}
static const struct dsa_device_ops ksz8795_netdev_ops = {
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment