Skip to content

Commit

Permalink
Merge branch 'sh_eth-wol'
Browse files Browse the repository at this point in the history
Niklas Söderlund says:

====================
sh_eth: add wake-on-lan support via magic packet

This series adds support for Wake-on-Lan using Magic Packet for a few
models of the sh_eth driver. Patch 1/6 fix a naming error, patch 2/6
adds generic support to control and support WoL while patches 3/6 - 6/6
enable different models.

Based ontop of net-next master.

Changes since v2.
- Fix bookkeeping for "active_count" and "event_count" reported in
  /sys/kernel/debug/wakeup_sources. Thanks Geert for noticing this.
- Add new patch 1/6 which corrects the name of ECMR_MPDE bit, suggested
  by Sergei.
- s/sh7743/sh7734/ in patch 5/6. Thanks Geert for spotting this.
- Spelling improvements suggested by Sergei and Geert.
- Add Tested-by to 3/6 and 4/6.

Changes since v1.
- Split generic WoL functionality and device enablement to different
  patches.
- Enable more devices then Gen2 after feedback from Geert and
  datasheets.
- Do not set mdp->irq_enabled = false and remove specific MagicPacket
  interrupt clearing, instead let sh_eth_error() clear the interrupt as
  for other EMAC interrupts, thanks Sergei for the suggestion.
- Use the original return logic in sh_eth_resume().
- Moved sh_eth_private variable *clk to top of data structure  to avoid
  possible gaps due to alignment restrictions.
- Make wol_enabled in sh_eth_private part of the already existing
  bitfield instead of a bool.
- Do not initiate mdp->wol_enabled to 0, the struct is kzalloc'ed so
  it's already set to 0.
====================

Signed-off-by: David S. Miller <davem@davemloft.net>
  • Loading branch information
David S. Miller committed Jan 9, 2017
2 parents 9f2f27a + 267e1d5 commit c8584b3
Show file tree
Hide file tree
Showing 2 changed files with 117 additions and 11 deletions.
123 changes: 113 additions & 10 deletions drivers/net/ethernet/renesas/sh_eth.c
Original file line number Diff line number Diff line change
Expand Up @@ -576,6 +576,7 @@ static struct sh_eth_cpu_data r8a7740_data = {
.hw_checksum = 1,
.tsu = 1,
.select_mii = 1,
.magic = 1,
};

/* There is CPU dependent code */
Expand Down Expand Up @@ -622,8 +623,9 @@ static struct sh_eth_cpu_data r8a779x_data = {

.register_type = SH_ETH_REG_FAST_RCAR,

.ecsr_value = ECSR_PSRTO | ECSR_LCHNG | ECSR_ICD,
.ecsipr_value = ECSIPR_PSRTOIP | ECSIPR_LCHNGIP | ECSIPR_ICDIP,
.ecsr_value = ECSR_PSRTO | ECSR_LCHNG | ECSR_ICD | ECSR_MPD,
.ecsipr_value = ECSIPR_PSRTOIP | ECSIPR_LCHNGIP | ECSIPR_ICDIP |
ECSIPR_MPDIP,
.eesipr_value = 0x01ff009f,

.tx_check = EESR_FTC | EESR_CND | EESR_DLC | EESR_CD | EESR_RTO,
Expand All @@ -638,6 +640,7 @@ static struct sh_eth_cpu_data r8a779x_data = {
.tpauser = 1,
.hw_swap = 1,
.rmiimode = 1,
.magic = 1,
};
#endif /* CONFIG_OF */

Expand Down Expand Up @@ -814,6 +817,7 @@ static struct sh_eth_cpu_data sh7734_data = {
.tsu = 1,
.hw_checksum = 1,
.select_mii = 1,
.magic = 1,
};

/* SH7763 */
Expand Down Expand Up @@ -841,6 +845,7 @@ static struct sh_eth_cpu_data sh7763_data = {
.no_ade = 1,
.tsu = 1,
.irq_flags = IRQF_SHARED,
.magic = 1,
};

static struct sh_eth_cpu_data sh7619_data = {
Expand Down Expand Up @@ -1550,6 +1555,8 @@ static void sh_eth_emac_interrupt(struct net_device *ndev)
sh_eth_rcv_snd_enable(ndev);
}
}
if (felic_stat & ECSR_MPD)
pm_wakeup_event(&mdp->pdev->dev, 0);
}

/* error control function */
Expand Down Expand Up @@ -2199,6 +2206,33 @@ static int sh_eth_set_ringparam(struct net_device *ndev,
return 0;
}

static void sh_eth_get_wol(struct net_device *ndev, struct ethtool_wolinfo *wol)
{
struct sh_eth_private *mdp = netdev_priv(ndev);

wol->supported = 0;
wol->wolopts = 0;

if (mdp->cd->magic && mdp->clk) {
wol->supported = WAKE_MAGIC;
wol->wolopts = mdp->wol_enabled ? WAKE_MAGIC : 0;
}
}

static int sh_eth_set_wol(struct net_device *ndev, struct ethtool_wolinfo *wol)
{
struct sh_eth_private *mdp = netdev_priv(ndev);

if (!mdp->cd->magic || !mdp->clk || wol->wolopts & ~WAKE_MAGIC)
return -EOPNOTSUPP;

mdp->wol_enabled = !!(wol->wolopts & WAKE_MAGIC);

device_set_wakeup_enable(&mdp->pdev->dev, mdp->wol_enabled);

return 0;
}

static const struct ethtool_ops sh_eth_ethtool_ops = {
.get_regs_len = sh_eth_get_regs_len,
.get_regs = sh_eth_get_regs,
Expand All @@ -2213,6 +2247,8 @@ static const struct ethtool_ops sh_eth_ethtool_ops = {
.set_ringparam = sh_eth_set_ringparam,
.get_link_ksettings = sh_eth_get_link_ksettings,
.set_link_ksettings = sh_eth_set_link_ksettings,
.get_wol = sh_eth_get_wol,
.set_wol = sh_eth_set_wol,
};

/* network device open function */
Expand Down Expand Up @@ -3015,6 +3051,11 @@ static int sh_eth_drv_probe(struct platform_device *pdev)
goto out_release;
}

/* Get clock, if not found that's OK but Wake-On-Lan is unavailable */
mdp->clk = devm_clk_get(&pdev->dev, NULL);
if (IS_ERR(mdp->clk))
mdp->clk = NULL;

ndev->base_addr = res->start;

spin_lock_init(&mdp->lock);
Expand Down Expand Up @@ -3109,6 +3150,9 @@ static int sh_eth_drv_probe(struct platform_device *pdev)
if (ret)
goto out_napi_del;

if (mdp->cd->magic && mdp->clk)
device_set_wakeup_capable(&pdev->dev, 1);

/* print device information */
netdev_info(ndev, "Base address at 0x%x, %pM, IRQ %d.\n",
(u32)ndev->base_addr, ndev->dev_addr, ndev->irq);
Expand Down Expand Up @@ -3148,30 +3192,89 @@ static int sh_eth_drv_remove(struct platform_device *pdev)

#ifdef CONFIG_PM
#ifdef CONFIG_PM_SLEEP
static int sh_eth_wol_setup(struct net_device *ndev)
{
struct sh_eth_private *mdp = netdev_priv(ndev);

/* Only allow ECI interrupts */
synchronize_irq(ndev->irq);
napi_disable(&mdp->napi);
sh_eth_write(ndev, DMAC_M_ECI, EESIPR);

/* Enable MagicPacket */
sh_eth_modify(ndev, ECMR, 0, ECMR_MPDE);

/* Increased clock usage so device won't be suspended */
clk_enable(mdp->clk);

return enable_irq_wake(ndev->irq);
}

static int sh_eth_wol_restore(struct net_device *ndev)
{
struct sh_eth_private *mdp = netdev_priv(ndev);
int ret;

napi_enable(&mdp->napi);

/* Disable MagicPacket */
sh_eth_modify(ndev, ECMR, ECMR_MPDE, 0);

/* The device needs to be reset to restore MagicPacket logic
* for next wakeup. If we close and open the device it will
* both be reset and all registers restored. This is what
* happens during suspend and resume without WoL enabled.
*/
ret = sh_eth_close(ndev);
if (ret < 0)
return ret;
ret = sh_eth_open(ndev);
if (ret < 0)
return ret;

/* Restore clock usage count */
clk_disable(mdp->clk);

return disable_irq_wake(ndev->irq);
}

static int sh_eth_suspend(struct device *dev)
{
struct net_device *ndev = dev_get_drvdata(dev);
struct sh_eth_private *mdp = netdev_priv(ndev);
int ret = 0;

if (netif_running(ndev)) {
netif_device_detach(ndev);
if (!netif_running(ndev))
return 0;

netif_device_detach(ndev);

if (mdp->wol_enabled)
ret = sh_eth_wol_setup(ndev);
else
ret = sh_eth_close(ndev);
}

return ret;
}

static int sh_eth_resume(struct device *dev)
{
struct net_device *ndev = dev_get_drvdata(dev);
struct sh_eth_private *mdp = netdev_priv(ndev);
int ret = 0;

if (netif_running(ndev)) {
if (!netif_running(ndev))
return 0;

if (mdp->wol_enabled)
ret = sh_eth_wol_restore(ndev);
else
ret = sh_eth_open(ndev);
if (ret < 0)
return ret;
netif_device_attach(ndev);
}

if (ret < 0)
return ret;

netif_device_attach(ndev);

return ret;
}
Expand Down
5 changes: 4 additions & 1 deletion drivers/net/ethernet/renesas/sh_eth.h
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ enum FELIC_MODE_BIT {
ECMR_DPAD = 0x00200000, ECMR_RZPF = 0x00100000,
ECMR_ZPF = 0x00080000, ECMR_PFR = 0x00040000, ECMR_RXF = 0x00020000,
ECMR_TXF = 0x00010000, ECMR_MCT = 0x00002000, ECMR_PRCEF = 0x00001000,
ECMR_PMDE = 0x00000200, ECMR_RE = 0x00000040, ECMR_TE = 0x00000020,
ECMR_MPDE = 0x00000200, ECMR_RE = 0x00000040, ECMR_TE = 0x00000020,
ECMR_RTM = 0x00000010, ECMR_ILB = 0x00000008, ECMR_ELB = 0x00000004,
ECMR_DM = 0x00000002, ECMR_PRM = 0x00000001,
};
Expand Down Expand Up @@ -492,6 +492,7 @@ struct sh_eth_cpu_data {
unsigned select_mii:1; /* EtherC have RMII_MII (MII select register) */
unsigned rmiimode:1; /* EtherC has RMIIMODE register */
unsigned rtrate:1; /* EtherC has RTRATE register */
unsigned magic:1; /* EtherC has ECMR.MPDE and ECSR.MPD */
};

struct sh_eth_private {
Expand All @@ -500,6 +501,7 @@ struct sh_eth_private {
const u16 *reg_offset;
void __iomem *addr;
void __iomem *tsu_addr;
struct clk *clk;
u32 num_rx_ring;
u32 num_tx_ring;
dma_addr_t rx_desc_dma;
Expand Down Expand Up @@ -528,6 +530,7 @@ struct sh_eth_private {
unsigned no_ether_link:1;
unsigned ether_link_active_low:1;
unsigned is_opened:1;
unsigned wol_enabled:1;
};

static inline void sh_eth_soft_swap(char *src, int len)
Expand Down

0 comments on commit c8584b3

Please sign in to comment.