1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /***************************************************************************
4 * Copyright (C) 2007-2008 SMSC
6 *****************************************************************************/
8 #include <linux/module.h>
9 #include <linux/kmod.h>
10 #include <linux/netdevice.h>
11 #include <linux/etherdevice.h>
12 #include <linux/ethtool.h>
13 #include <linux/mii.h>
14 #include <linux/usb.h>
15 #include <linux/bitrev.h>
16 #include <linux/crc16.h>
17 #include <linux/crc32.h>
18 #include <linux/usb/usbnet.h>
19 #include <linux/slab.h>
20 #include <linux/of_net.h>
21 #include <linux/irq.h>
22 #include <linux/irqdomain.h>
23 #include <linux/mdio.h>
24 #include <linux/phy.h>
25 #include <net/selftests.h>
29 #define SMSC_CHIPNAME "smsc95xx"
30 #define SMSC_DRIVER_VERSION "2.0.0"
31 #define HS_USB_PKT_SIZE (512)
32 #define FS_USB_PKT_SIZE (64)
33 #define DEFAULT_HS_BURST_CAP_SIZE (16 * 1024 + 5 * HS_USB_PKT_SIZE)
34 #define DEFAULT_FS_BURST_CAP_SIZE (6 * 1024 + 33 * FS_USB_PKT_SIZE)
35 #define DEFAULT_BULK_IN_DELAY (0x00002000)
36 #define MAX_SINGLE_PACKET_SIZE (2048)
37 #define LAN95XX_EEPROM_MAGIC (0x9500)
38 #define EEPROM_MAC_OFFSET (0x01)
39 #define DEFAULT_TX_CSUM_ENABLE (true)
40 #define DEFAULT_RX_CSUM_ENABLE (true)
41 #define SMSC95XX_INTERNAL_PHY_ID (1)
42 #define SMSC95XX_TX_OVERHEAD (8)
43 #define SMSC95XX_TX_OVERHEAD_CSUM (12)
44 #define SUPPORTED_WAKE (WAKE_PHY | WAKE_UCAST | WAKE_BCAST | \
45 WAKE_MCAST | WAKE_ARP | WAKE_MAGIC)
47 #define FEATURE_8_WAKEUP_FILTERS (0x01)
48 #define FEATURE_PHY_NLP_CROSSOVER (0x02)
49 #define FEATURE_REMOTE_WAKEUP (0x04)
51 #define SUSPEND_SUSPEND0 (0x01)
52 #define SUSPEND_SUSPEND1 (0x02)
53 #define SUSPEND_SUSPEND2 (0x04)
54 #define SUSPEND_SUSPEND3 (0x08)
55 #define SUSPEND_ALLMODES (SUSPEND_SUSPEND0 | SUSPEND_SUSPEND1 | \
56 SUSPEND_SUSPEND2 | SUSPEND_SUSPEND3)
58 #define SMSC95XX_NR_IRQS (1) /* raise to 12 for GPIOs */
59 #define PHY_HWIRQ (SMSC95XX_NR_IRQS - 1)
61 struct smsc95xx_priv {
66 spinlock_t mac_cr_lock;
70 struct irq_chip irqchip;
71 struct irq_domain *irqdomain;
72 struct fwnode_handle *irqfwnode;
73 struct mii_bus *mdiobus;
74 struct phy_device *phydev;
75 struct task_struct *pm_task;
78 static bool turbo_mode = true;
79 module_param(turbo_mode, bool, 0644);
80 MODULE_PARM_DESC(turbo_mode, "Enable multiple frames per Rx transaction");
82 static int __must_check smsc95xx_read_reg(struct usbnet *dev, u32 index,
85 struct smsc95xx_priv *pdata = dev->driver_priv;
88 int (*fn)(struct usbnet *, u8, u8, u16, u16, void *, u16);
90 if (current != pdata->pm_task)
93 fn = usbnet_read_cmd_nopm;
95 ret = fn(dev, USB_VENDOR_REQUEST_READ_REGISTER, USB_DIR_IN
96 | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
100 netdev_warn(dev->net, "Failed to read reg index 0x%08x: %d\n",
111 static int __must_check smsc95xx_write_reg(struct usbnet *dev, u32 index,
114 struct smsc95xx_priv *pdata = dev->driver_priv;
117 int (*fn)(struct usbnet *, u8, u8, u16, u16, const void *, u16);
119 if (current != pdata->pm_task)
120 fn = usbnet_write_cmd;
122 fn = usbnet_write_cmd_nopm;
127 ret = fn(dev, USB_VENDOR_REQUEST_WRITE_REGISTER, USB_DIR_OUT
128 | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
130 if (ret < 0 && ret != -ENODEV)
131 netdev_warn(dev->net, "Failed to write reg index 0x%08x: %d\n",
137 /* Loop until the read is completed with timeout
138 * called with phy_mutex held */
139 static int __must_check smsc95xx_phy_wait_not_busy(struct usbnet *dev)
141 unsigned long start_time = jiffies;
146 ret = smsc95xx_read_reg(dev, MII_ADDR, &val);
148 /* Ignore -ENODEV error during disconnect() */
151 netdev_warn(dev->net, "Error reading MII_ACCESS\n");
155 if (!(val & MII_BUSY_))
157 } while (!time_after(jiffies, start_time + HZ));
162 static u32 mii_address_cmd(int phy_id, int idx, u16 op)
164 return (phy_id & 0x1f) << 11 | (idx & 0x1f) << 6 | op;
167 static int smsc95xx_mdio_read(struct usbnet *dev, int phy_id, int idx)
172 mutex_lock(&dev->phy_mutex);
174 /* confirm MII not busy */
175 ret = smsc95xx_phy_wait_not_busy(dev);
177 netdev_warn(dev->net, "%s: MII is busy\n", __func__);
181 /* set the address, index & direction (read from PHY) */
182 addr = mii_address_cmd(phy_id, idx, MII_READ_ | MII_BUSY_);
183 ret = smsc95xx_write_reg(dev, MII_ADDR, addr);
186 netdev_warn(dev->net, "Error writing MII_ADDR\n");
190 ret = smsc95xx_phy_wait_not_busy(dev);
192 netdev_warn(dev->net, "Timed out reading MII reg %02X\n", idx);
196 ret = smsc95xx_read_reg(dev, MII_DATA, &val);
199 netdev_warn(dev->net, "Error reading MII_DATA\n");
203 ret = (u16)(val & 0xFFFF);
206 mutex_unlock(&dev->phy_mutex);
208 /* Ignore -ENODEV error during disconnect() */
214 static void smsc95xx_mdio_write(struct usbnet *dev, int phy_id, int idx,
220 mutex_lock(&dev->phy_mutex);
222 /* confirm MII not busy */
223 ret = smsc95xx_phy_wait_not_busy(dev);
225 netdev_warn(dev->net, "%s: MII is busy\n", __func__);
230 ret = smsc95xx_write_reg(dev, MII_DATA, val);
233 netdev_warn(dev->net, "Error writing MII_DATA\n");
237 /* set the address, index & direction (write to PHY) */
238 addr = mii_address_cmd(phy_id, idx, MII_WRITE_ | MII_BUSY_);
239 ret = smsc95xx_write_reg(dev, MII_ADDR, addr);
242 netdev_warn(dev->net, "Error writing MII_ADDR\n");
246 ret = smsc95xx_phy_wait_not_busy(dev);
248 netdev_warn(dev->net, "Timed out writing MII reg %02X\n", idx);
253 mutex_unlock(&dev->phy_mutex);
256 static int smsc95xx_mdiobus_reset(struct mii_bus *bus)
258 struct smsc95xx_priv *pdata;
264 pdata = dev->driver_priv;
266 if (pdata->is_internal_phy)
269 mutex_lock(&dev->phy_mutex);
271 ret = smsc95xx_read_reg(dev, PM_CTRL, &val);
275 val |= PM_CTL_PHY_RST_;
277 ret = smsc95xx_write_reg(dev, PM_CTRL, val);
281 /* Driver has no knowledge at this point about the external PHY.
282 * The 802.3 specifies that the reset process shall
283 * be completed within 0.5 s.
288 mutex_unlock(&dev->phy_mutex);
293 static int smsc95xx_mdiobus_read(struct mii_bus *bus, int phy_id, int idx)
295 struct usbnet *dev = bus->priv;
297 return smsc95xx_mdio_read(dev, phy_id, idx);
300 static int smsc95xx_mdiobus_write(struct mii_bus *bus, int phy_id, int idx,
303 struct usbnet *dev = bus->priv;
305 smsc95xx_mdio_write(dev, phy_id, idx, regval);
309 static int __must_check smsc95xx_wait_eeprom(struct usbnet *dev)
311 unsigned long start_time = jiffies;
316 ret = smsc95xx_read_reg(dev, E2P_CMD, &val);
318 netdev_warn(dev->net, "Error reading E2P_CMD\n");
322 if (!(val & E2P_CMD_BUSY_) || (val & E2P_CMD_TIMEOUT_))
325 } while (!time_after(jiffies, start_time + HZ));
327 if (val & (E2P_CMD_TIMEOUT_ | E2P_CMD_BUSY_)) {
328 netdev_warn(dev->net, "EEPROM read operation timeout\n");
335 static int __must_check smsc95xx_eeprom_confirm_not_busy(struct usbnet *dev)
337 unsigned long start_time = jiffies;
342 ret = smsc95xx_read_reg(dev, E2P_CMD, &val);
344 netdev_warn(dev->net, "Error reading E2P_CMD\n");
348 if (!(val & E2P_CMD_BUSY_))
352 } while (!time_after(jiffies, start_time + HZ));
354 netdev_warn(dev->net, "EEPROM is busy\n");
358 static int smsc95xx_read_eeprom(struct usbnet *dev, u32 offset, u32 length,
367 ret = smsc95xx_eeprom_confirm_not_busy(dev);
371 for (i = 0; i < length; i++) {
372 val = E2P_CMD_BUSY_ | E2P_CMD_READ_ | (offset & E2P_CMD_ADDR_);
373 ret = smsc95xx_write_reg(dev, E2P_CMD, val);
375 netdev_warn(dev->net, "Error writing E2P_CMD\n");
379 ret = smsc95xx_wait_eeprom(dev);
383 ret = smsc95xx_read_reg(dev, E2P_DATA, &val);
385 netdev_warn(dev->net, "Error reading E2P_DATA\n");
389 data[i] = val & 0xFF;
396 static int smsc95xx_write_eeprom(struct usbnet *dev, u32 offset, u32 length,
405 ret = smsc95xx_eeprom_confirm_not_busy(dev);
409 /* Issue write/erase enable command */
410 val = E2P_CMD_BUSY_ | E2P_CMD_EWEN_;
411 ret = smsc95xx_write_reg(dev, E2P_CMD, val);
413 netdev_warn(dev->net, "Error writing E2P_DATA\n");
417 ret = smsc95xx_wait_eeprom(dev);
421 for (i = 0; i < length; i++) {
423 /* Fill data register */
425 ret = smsc95xx_write_reg(dev, E2P_DATA, val);
427 netdev_warn(dev->net, "Error writing E2P_DATA\n");
431 /* Send "write" command */
432 val = E2P_CMD_BUSY_ | E2P_CMD_WRITE_ | (offset & E2P_CMD_ADDR_);
433 ret = smsc95xx_write_reg(dev, E2P_CMD, val);
435 netdev_warn(dev->net, "Error writing E2P_CMD\n");
439 ret = smsc95xx_wait_eeprom(dev);
449 static int __must_check smsc95xx_write_reg_async(struct usbnet *dev, u16 index,
459 ret = usbnet_write_cmd_async(dev, USB_VENDOR_REQUEST_WRITE_REGISTER,
460 USB_DIR_OUT | USB_TYPE_VENDOR |
462 0, index, &buf, size);
464 netdev_warn(dev->net, "Error write async cmd, sts=%d\n",
469 /* returns hash bit number for given MAC address
471 * 01 00 5E 00 00 01 -> returns bit number 31 */
472 static unsigned int smsc95xx_hash(char addr[ETH_ALEN])
474 return (ether_crc(ETH_ALEN, addr) >> 26) & 0x3f;
477 static void smsc95xx_set_multicast(struct net_device *netdev)
479 struct usbnet *dev = netdev_priv(netdev);
480 struct smsc95xx_priv *pdata = dev->driver_priv;
487 spin_lock_irqsave(&pdata->mac_cr_lock, flags);
489 if (dev->net->flags & IFF_PROMISC) {
490 netif_dbg(dev, drv, dev->net, "promiscuous mode enabled\n");
491 pdata->mac_cr |= MAC_CR_PRMS_;
492 pdata->mac_cr &= ~(MAC_CR_MCPAS_ | MAC_CR_HPFILT_);
493 } else if (dev->net->flags & IFF_ALLMULTI) {
494 netif_dbg(dev, drv, dev->net, "receive all multicast enabled\n");
495 pdata->mac_cr |= MAC_CR_MCPAS_;
496 pdata->mac_cr &= ~(MAC_CR_PRMS_ | MAC_CR_HPFILT_);
497 } else if (!netdev_mc_empty(dev->net)) {
498 struct netdev_hw_addr *ha;
500 pdata->mac_cr |= MAC_CR_HPFILT_;
501 pdata->mac_cr &= ~(MAC_CR_PRMS_ | MAC_CR_MCPAS_);
503 netdev_for_each_mc_addr(ha, netdev) {
504 u32 bitnum = smsc95xx_hash(ha->addr);
505 u32 mask = 0x01 << (bitnum & 0x1F);
507 pdata->hash_hi |= mask;
509 pdata->hash_lo |= mask;
512 netif_dbg(dev, drv, dev->net, "HASHH=0x%08X, HASHL=0x%08X\n",
513 pdata->hash_hi, pdata->hash_lo);
515 netif_dbg(dev, drv, dev->net, "receive own packets only\n");
517 ~(MAC_CR_PRMS_ | MAC_CR_MCPAS_ | MAC_CR_HPFILT_);
520 spin_unlock_irqrestore(&pdata->mac_cr_lock, flags);
522 /* Initiate async writes, as we can't wait for completion here */
523 ret = smsc95xx_write_reg_async(dev, HASHH, pdata->hash_hi);
525 netdev_warn(dev->net, "failed to initiate async write to HASHH\n");
527 ret = smsc95xx_write_reg_async(dev, HASHL, pdata->hash_lo);
529 netdev_warn(dev->net, "failed to initiate async write to HASHL\n");
531 ret = smsc95xx_write_reg_async(dev, MAC_CR, pdata->mac_cr);
533 netdev_warn(dev->net, "failed to initiate async write to MAC_CR\n");
536 static int smsc95xx_phy_update_flowcontrol(struct usbnet *dev)
538 u32 flow = 0, afc_cfg;
539 struct smsc95xx_priv *pdata = dev->driver_priv;
540 bool tx_pause, rx_pause;
542 int ret = smsc95xx_read_reg(dev, AFC_CFG, &afc_cfg);
546 if (pdata->phydev->duplex == DUPLEX_FULL) {
547 phy_get_pause(pdata->phydev, &tx_pause, &rx_pause);
559 netif_dbg(dev, link, dev->net, "rx pause %s, tx pause %s\n",
560 rx_pause ? "enabled" : "disabled",
561 tx_pause ? "enabled" : "disabled");
563 netif_dbg(dev, link, dev->net, "half duplex\n");
567 ret = smsc95xx_write_reg(dev, FLOW, flow);
571 return smsc95xx_write_reg(dev, AFC_CFG, afc_cfg);
574 static void smsc95xx_mac_update_fullduplex(struct usbnet *dev)
576 struct smsc95xx_priv *pdata = dev->driver_priv;
580 spin_lock_irqsave(&pdata->mac_cr_lock, flags);
581 if (pdata->phydev->duplex != DUPLEX_FULL) {
582 pdata->mac_cr &= ~MAC_CR_FDPX_;
583 pdata->mac_cr |= MAC_CR_RCVOWN_;
585 pdata->mac_cr &= ~MAC_CR_RCVOWN_;
586 pdata->mac_cr |= MAC_CR_FDPX_;
588 spin_unlock_irqrestore(&pdata->mac_cr_lock, flags);
590 ret = smsc95xx_write_reg(dev, MAC_CR, pdata->mac_cr);
593 netdev_warn(dev->net,
594 "Error updating MAC full duplex mode\n");
598 ret = smsc95xx_phy_update_flowcontrol(dev);
600 netdev_warn(dev->net, "Error updating PHY flow control\n");
603 static void smsc95xx_status(struct usbnet *dev, struct urb *urb)
605 struct smsc95xx_priv *pdata = dev->driver_priv;
609 if (urb->actual_length != 4) {
610 netdev_warn(dev->net, "unexpected urb length %d\n",
615 intdata = get_unaligned_le32(urb->transfer_buffer);
616 netif_dbg(dev, link, dev->net, "intdata: 0x%08X\n", intdata);
618 local_irq_save(flags);
620 if (intdata & INT_ENP_PHY_INT_)
621 generic_handle_domain_irq(pdata->irqdomain, PHY_HWIRQ);
623 netdev_warn(dev->net, "unexpected interrupt, intdata=0x%08X\n",
626 local_irq_restore(flags);
629 /* Enable or disable Tx & Rx checksum offload engines */
630 static int smsc95xx_set_features(struct net_device *netdev,
631 netdev_features_t features)
633 struct usbnet *dev = netdev_priv(netdev);
637 ret = smsc95xx_read_reg(dev, COE_CR, &read_buf);
641 if (features & NETIF_F_IP_CSUM)
642 read_buf |= Tx_COE_EN_;
644 read_buf &= ~Tx_COE_EN_;
646 if (features & NETIF_F_RXCSUM)
647 read_buf |= Rx_COE_EN_;
649 read_buf &= ~Rx_COE_EN_;
651 ret = smsc95xx_write_reg(dev, COE_CR, read_buf);
655 netif_dbg(dev, hw, dev->net, "COE_CR = 0x%08x\n", read_buf);
659 static int smsc95xx_ethtool_get_eeprom_len(struct net_device *net)
661 return MAX_EEPROM_SIZE;
664 static int smsc95xx_ethtool_get_eeprom(struct net_device *netdev,
665 struct ethtool_eeprom *ee, u8 *data)
667 struct usbnet *dev = netdev_priv(netdev);
669 ee->magic = LAN95XX_EEPROM_MAGIC;
671 return smsc95xx_read_eeprom(dev, ee->offset, ee->len, data);
674 static int smsc95xx_ethtool_set_eeprom(struct net_device *netdev,
675 struct ethtool_eeprom *ee, u8 *data)
677 struct usbnet *dev = netdev_priv(netdev);
679 if (ee->magic != LAN95XX_EEPROM_MAGIC) {
680 netdev_warn(dev->net, "EEPROM: magic value mismatch, magic = 0x%x\n",
685 return smsc95xx_write_eeprom(dev, ee->offset, ee->len, data);
688 static int smsc95xx_ethtool_getregslen(struct net_device *netdev)
690 /* all smsc95xx registers */
691 return COE_CR - ID_REV + sizeof(u32);
695 smsc95xx_ethtool_getregs(struct net_device *netdev, struct ethtool_regs *regs,
698 struct usbnet *dev = netdev_priv(netdev);
703 retval = smsc95xx_read_reg(dev, ID_REV, ®s->version);
705 netdev_warn(netdev, "REGS: cannot read ID_REV\n");
709 for (i = ID_REV, j = 0; i <= COE_CR; i += (sizeof(u32)), j++) {
710 retval = smsc95xx_read_reg(dev, i, &data[j]);
712 netdev_warn(netdev, "REGS: cannot read reg[%x]\n", i);
718 static void smsc95xx_ethtool_get_wol(struct net_device *net,
719 struct ethtool_wolinfo *wolinfo)
721 struct usbnet *dev = netdev_priv(net);
722 struct smsc95xx_priv *pdata = dev->driver_priv;
724 wolinfo->supported = SUPPORTED_WAKE;
725 wolinfo->wolopts = pdata->wolopts;
728 static int smsc95xx_ethtool_set_wol(struct net_device *net,
729 struct ethtool_wolinfo *wolinfo)
731 struct usbnet *dev = netdev_priv(net);
732 struct smsc95xx_priv *pdata = dev->driver_priv;
735 if (wolinfo->wolopts & ~SUPPORTED_WAKE)
738 pdata->wolopts = wolinfo->wolopts & SUPPORTED_WAKE;
740 ret = device_set_wakeup_enable(&dev->udev->dev, pdata->wolopts);
742 netdev_warn(dev->net, "device_set_wakeup_enable error %d\n", ret);
747 static u32 smsc95xx_get_link(struct net_device *net)
749 phy_read_status(net->phydev);
750 return net->phydev->link;
753 static void smsc95xx_ethtool_get_strings(struct net_device *netdev, u32 sset,
758 net_selftest_get_strings(data);
763 static int smsc95xx_ethtool_get_sset_count(struct net_device *ndev, int sset)
767 return net_selftest_get_count();
773 static const struct ethtool_ops smsc95xx_ethtool_ops = {
774 .get_link = smsc95xx_get_link,
775 .nway_reset = phy_ethtool_nway_reset,
776 .get_drvinfo = usbnet_get_drvinfo,
777 .get_msglevel = usbnet_get_msglevel,
778 .set_msglevel = usbnet_set_msglevel,
779 .get_eeprom_len = smsc95xx_ethtool_get_eeprom_len,
780 .get_eeprom = smsc95xx_ethtool_get_eeprom,
781 .set_eeprom = smsc95xx_ethtool_set_eeprom,
782 .get_regs_len = smsc95xx_ethtool_getregslen,
783 .get_regs = smsc95xx_ethtool_getregs,
784 .get_wol = smsc95xx_ethtool_get_wol,
785 .set_wol = smsc95xx_ethtool_set_wol,
786 .get_link_ksettings = phy_ethtool_get_link_ksettings,
787 .set_link_ksettings = phy_ethtool_set_link_ksettings,
788 .get_ts_info = ethtool_op_get_ts_info,
789 .self_test = net_selftest,
790 .get_strings = smsc95xx_ethtool_get_strings,
791 .get_sset_count = smsc95xx_ethtool_get_sset_count,
794 static int smsc95xx_ioctl(struct net_device *netdev, struct ifreq *rq, int cmd)
796 if (!netif_running(netdev))
799 return phy_mii_ioctl(netdev->phydev, rq, cmd);
802 static void smsc95xx_init_mac_address(struct usbnet *dev)
806 /* maybe the boot loader passed the MAC address in devicetree */
807 if (!platform_get_ethdev_address(&dev->udev->dev, dev->net)) {
808 if (is_valid_ether_addr(dev->net->dev_addr)) {
809 /* device tree values are valid so use them */
810 netif_dbg(dev, ifup, dev->net, "MAC address read from the device tree\n");
815 /* try reading mac address from EEPROM */
816 if (smsc95xx_read_eeprom(dev, EEPROM_MAC_OFFSET, ETH_ALEN, addr) == 0) {
817 eth_hw_addr_set(dev->net, addr);
818 if (is_valid_ether_addr(dev->net->dev_addr)) {
819 /* eeprom values are valid so use them */
820 netif_dbg(dev, ifup, dev->net, "MAC address read from EEPROM\n");
825 /* no useful static MAC address found. generate a random one */
826 eth_hw_addr_random(dev->net);
827 netif_dbg(dev, ifup, dev->net, "MAC address set to eth_random_addr\n");
830 static int smsc95xx_set_mac_address(struct usbnet *dev)
832 u32 addr_lo = dev->net->dev_addr[0] | dev->net->dev_addr[1] << 8 |
833 dev->net->dev_addr[2] << 16 | dev->net->dev_addr[3] << 24;
834 u32 addr_hi = dev->net->dev_addr[4] | dev->net->dev_addr[5] << 8;
837 ret = smsc95xx_write_reg(dev, ADDRL, addr_lo);
841 return smsc95xx_write_reg(dev, ADDRH, addr_hi);
844 /* starts the TX path */
845 static int smsc95xx_start_tx_path(struct usbnet *dev)
847 struct smsc95xx_priv *pdata = dev->driver_priv;
851 /* Enable Tx at MAC */
852 spin_lock_irqsave(&pdata->mac_cr_lock, flags);
853 pdata->mac_cr |= MAC_CR_TXEN_;
854 spin_unlock_irqrestore(&pdata->mac_cr_lock, flags);
856 ret = smsc95xx_write_reg(dev, MAC_CR, pdata->mac_cr);
860 /* Enable Tx at SCSRs */
861 return smsc95xx_write_reg(dev, TX_CFG, TX_CFG_ON_);
864 /* Starts the Receive path */
865 static int smsc95xx_start_rx_path(struct usbnet *dev)
867 struct smsc95xx_priv *pdata = dev->driver_priv;
870 spin_lock_irqsave(&pdata->mac_cr_lock, flags);
871 pdata->mac_cr |= MAC_CR_RXEN_;
872 spin_unlock_irqrestore(&pdata->mac_cr_lock, flags);
874 return smsc95xx_write_reg(dev, MAC_CR, pdata->mac_cr);
877 static int smsc95xx_reset(struct usbnet *dev)
879 struct smsc95xx_priv *pdata = dev->driver_priv;
880 u32 read_buf, write_buf, burst_cap;
881 int ret = 0, timeout;
883 netif_dbg(dev, ifup, dev->net, "entering smsc95xx_reset\n");
885 ret = smsc95xx_write_reg(dev, HW_CFG, HW_CFG_LRST_);
892 ret = smsc95xx_read_reg(dev, HW_CFG, &read_buf);
896 } while ((read_buf & HW_CFG_LRST_) && (timeout < 100));
898 if (timeout >= 100) {
899 netdev_warn(dev->net, "timeout waiting for completion of Lite Reset\n");
903 ret = smsc95xx_set_mac_address(dev);
907 netif_dbg(dev, ifup, dev->net, "MAC Address: %pM\n",
910 ret = smsc95xx_read_reg(dev, HW_CFG, &read_buf);
914 netif_dbg(dev, ifup, dev->net, "Read Value from HW_CFG : 0x%08x\n",
917 read_buf |= HW_CFG_BIR_;
919 ret = smsc95xx_write_reg(dev, HW_CFG, read_buf);
923 ret = smsc95xx_read_reg(dev, HW_CFG, &read_buf);
927 netif_dbg(dev, ifup, dev->net,
928 "Read Value from HW_CFG after writing HW_CFG_BIR_: 0x%08x\n",
933 dev->rx_urb_size = MAX_SINGLE_PACKET_SIZE;
934 } else if (dev->udev->speed == USB_SPEED_HIGH) {
935 burst_cap = DEFAULT_HS_BURST_CAP_SIZE / HS_USB_PKT_SIZE;
936 dev->rx_urb_size = DEFAULT_HS_BURST_CAP_SIZE;
938 burst_cap = DEFAULT_FS_BURST_CAP_SIZE / FS_USB_PKT_SIZE;
939 dev->rx_urb_size = DEFAULT_FS_BURST_CAP_SIZE;
942 netif_dbg(dev, ifup, dev->net, "rx_urb_size=%ld\n",
943 (ulong)dev->rx_urb_size);
945 ret = smsc95xx_write_reg(dev, BURST_CAP, burst_cap);
949 ret = smsc95xx_read_reg(dev, BURST_CAP, &read_buf);
953 netif_dbg(dev, ifup, dev->net,
954 "Read Value from BURST_CAP after writing: 0x%08x\n",
957 ret = smsc95xx_write_reg(dev, BULK_IN_DLY, DEFAULT_BULK_IN_DELAY);
961 ret = smsc95xx_read_reg(dev, BULK_IN_DLY, &read_buf);
965 netif_dbg(dev, ifup, dev->net,
966 "Read Value from BULK_IN_DLY after writing: 0x%08x\n",
969 ret = smsc95xx_read_reg(dev, HW_CFG, &read_buf);
973 netif_dbg(dev, ifup, dev->net, "Read Value from HW_CFG: 0x%08x\n",
977 read_buf |= (HW_CFG_MEF_ | HW_CFG_BCE_);
979 read_buf &= ~HW_CFG_RXDOFF_;
981 /* set Rx data offset=2, Make IP header aligns on word boundary. */
982 read_buf |= NET_IP_ALIGN << 9;
984 ret = smsc95xx_write_reg(dev, HW_CFG, read_buf);
988 ret = smsc95xx_read_reg(dev, HW_CFG, &read_buf);
992 netif_dbg(dev, ifup, dev->net,
993 "Read Value from HW_CFG after writing: 0x%08x\n", read_buf);
995 ret = smsc95xx_write_reg(dev, INT_STS, INT_STS_CLEAR_ALL_);
999 ret = smsc95xx_read_reg(dev, ID_REV, &read_buf);
1002 netif_dbg(dev, ifup, dev->net, "ID_REV = 0x%08x\n", read_buf);
1004 /* Configure GPIO pins as LED outputs */
1005 write_buf = LED_GPIO_CFG_SPD_LED | LED_GPIO_CFG_LNK_LED |
1006 LED_GPIO_CFG_FDX_LED;
1007 ret = smsc95xx_write_reg(dev, LED_GPIO_CFG, write_buf);
1012 ret = smsc95xx_write_reg(dev, FLOW, 0);
1016 ret = smsc95xx_write_reg(dev, AFC_CFG, AFC_CFG_DEFAULT);
1020 /* Don't need mac_cr_lock during initialisation */
1021 ret = smsc95xx_read_reg(dev, MAC_CR, &pdata->mac_cr);
1027 ret = smsc95xx_write_reg(dev, VLAN1, (u32)ETH_P_8021Q);
1031 /* Enable or disable checksum offload engines */
1032 ret = smsc95xx_set_features(dev->net, dev->net->features);
1034 netdev_warn(dev->net, "Failed to set checksum offload features\n");
1038 smsc95xx_set_multicast(dev->net);
1040 ret = smsc95xx_read_reg(dev, INT_EP_CTL, &read_buf);
1044 /* enable PHY interrupts */
1045 read_buf |= INT_EP_CTL_PHY_INT_;
1047 ret = smsc95xx_write_reg(dev, INT_EP_CTL, read_buf);
1051 ret = smsc95xx_start_tx_path(dev);
1053 netdev_warn(dev->net, "Failed to start TX path\n");
1057 ret = smsc95xx_start_rx_path(dev);
1059 netdev_warn(dev->net, "Failed to start RX path\n");
1063 netif_dbg(dev, ifup, dev->net, "smsc95xx_reset, return 0\n");
1067 static const struct net_device_ops smsc95xx_netdev_ops = {
1068 .ndo_open = usbnet_open,
1069 .ndo_stop = usbnet_stop,
1070 .ndo_start_xmit = usbnet_start_xmit,
1071 .ndo_tx_timeout = usbnet_tx_timeout,
1072 .ndo_change_mtu = usbnet_change_mtu,
1073 .ndo_get_stats64 = dev_get_tstats64,
1074 .ndo_set_mac_address = eth_mac_addr,
1075 .ndo_validate_addr = eth_validate_addr,
1076 .ndo_eth_ioctl = smsc95xx_ioctl,
1077 .ndo_set_rx_mode = smsc95xx_set_multicast,
1078 .ndo_set_features = smsc95xx_set_features,
1081 static void smsc95xx_handle_link_change(struct net_device *net)
1083 struct usbnet *dev = netdev_priv(net);
1085 phy_print_status(net->phydev);
1086 smsc95xx_mac_update_fullduplex(dev);
1087 usbnet_defer_kevent(dev, EVENT_LINK_CHANGE);
1090 static int smsc95xx_bind(struct usbnet *dev, struct usb_interface *intf)
1092 struct smsc95xx_priv *pdata;
1097 printk(KERN_INFO SMSC_CHIPNAME " v" SMSC_DRIVER_VERSION "\n");
1099 ret = usbnet_get_endpoints(dev, intf);
1101 netdev_warn(dev->net, "usbnet_get_endpoints failed: %d\n", ret);
1105 pdata = kzalloc(sizeof(*pdata), GFP_KERNEL);
1109 dev->driver_priv = pdata;
1111 spin_lock_init(&pdata->mac_cr_lock);
1113 /* LAN95xx devices do not alter the computed checksum of 0 to 0xffff.
1114 * RFC 2460, ipv6 UDP calculated checksum yields a result of zero must
1115 * be changed to 0xffff. RFC 768, ipv4 UDP computed checksum is zero,
1116 * it is transmitted as all ones. The zero transmitted checksum means
1117 * transmitter generated no checksum. Hence, enable csum offload only
1120 if (DEFAULT_TX_CSUM_ENABLE)
1121 dev->net->features |= NETIF_F_IP_CSUM;
1122 if (DEFAULT_RX_CSUM_ENABLE)
1123 dev->net->features |= NETIF_F_RXCSUM;
1125 dev->net->hw_features = NETIF_F_IP_CSUM | NETIF_F_RXCSUM;
1126 set_bit(EVENT_NO_IP_ALIGN, &dev->flags);
1128 smsc95xx_init_mac_address(dev);
1130 /* Init all registers */
1131 ret = smsc95xx_reset(dev);
1135 /* create irq domain for use by PHY driver and GPIO consumers */
1136 usb_make_path(dev->udev, usb_path, sizeof(usb_path));
1137 pdata->irqfwnode = irq_domain_alloc_named_fwnode(usb_path);
1138 if (!pdata->irqfwnode) {
1143 pdata->irqdomain = irq_domain_create_linear(pdata->irqfwnode,
1145 &irq_domain_simple_ops,
1147 if (!pdata->irqdomain) {
1149 goto free_irqfwnode;
1152 phy_irq = irq_create_mapping(pdata->irqdomain, PHY_HWIRQ);
1155 goto remove_irqdomain;
1158 pdata->irqchip = dummy_irq_chip;
1159 pdata->irqchip.name = SMSC_CHIPNAME;
1160 irq_set_chip_and_handler_name(phy_irq, &pdata->irqchip,
1161 handle_simple_irq, "phy");
1163 pdata->mdiobus = mdiobus_alloc();
1164 if (!pdata->mdiobus) {
1169 ret = smsc95xx_read_reg(dev, HW_CFG, &val);
1173 pdata->is_internal_phy = !(val & HW_CFG_PSEL_);
1174 if (pdata->is_internal_phy)
1175 pdata->mdiobus->phy_mask = ~(1u << SMSC95XX_INTERNAL_PHY_ID);
1177 pdata->mdiobus->priv = dev;
1178 pdata->mdiobus->read = smsc95xx_mdiobus_read;
1179 pdata->mdiobus->write = smsc95xx_mdiobus_write;
1180 pdata->mdiobus->reset = smsc95xx_mdiobus_reset;
1181 pdata->mdiobus->name = "smsc95xx-mdiobus";
1182 pdata->mdiobus->parent = &dev->udev->dev;
1184 snprintf(pdata->mdiobus->id, ARRAY_SIZE(pdata->mdiobus->id),
1185 "usb-%03d:%03d", dev->udev->bus->busnum, dev->udev->devnum);
1187 ret = mdiobus_register(pdata->mdiobus);
1189 netdev_err(dev->net, "Could not register MDIO bus\n");
1193 pdata->phydev = phy_find_first(pdata->mdiobus);
1194 if (!pdata->phydev) {
1195 netdev_err(dev->net, "no PHY found\n");
1197 goto unregister_mdio;
1200 pdata->phydev->irq = phy_irq;
1201 pdata->phydev->is_internal = pdata->is_internal_phy;
1203 /* detect device revision as different features may be available */
1204 ret = smsc95xx_read_reg(dev, ID_REV, &val);
1206 goto unregister_mdio;
1209 if ((val == ID_REV_CHIP_ID_9500A_) || (val == ID_REV_CHIP_ID_9530_) ||
1210 (val == ID_REV_CHIP_ID_89530_) || (val == ID_REV_CHIP_ID_9730_))
1211 pdata->features = (FEATURE_8_WAKEUP_FILTERS |
1212 FEATURE_PHY_NLP_CROSSOVER |
1213 FEATURE_REMOTE_WAKEUP);
1214 else if (val == ID_REV_CHIP_ID_9512_)
1215 pdata->features = FEATURE_8_WAKEUP_FILTERS;
1217 dev->net->netdev_ops = &smsc95xx_netdev_ops;
1218 dev->net->ethtool_ops = &smsc95xx_ethtool_ops;
1219 dev->net->flags |= IFF_MULTICAST;
1220 dev->net->hard_header_len += SMSC95XX_TX_OVERHEAD_CSUM;
1221 dev->net->min_mtu = ETH_MIN_MTU;
1222 dev->net->max_mtu = ETH_DATA_LEN;
1223 dev->hard_mtu = dev->net->mtu + dev->net->hard_header_len;
1225 ret = phy_connect_direct(dev->net, pdata->phydev,
1226 &smsc95xx_handle_link_change,
1227 PHY_INTERFACE_MODE_MII);
1229 netdev_err(dev->net, "can't attach PHY to %s\n", pdata->mdiobus->id);
1230 goto unregister_mdio;
1233 phy_attached_info(dev->net->phydev);
1238 mdiobus_unregister(pdata->mdiobus);
1241 mdiobus_free(pdata->mdiobus);
1244 irq_dispose_mapping(phy_irq);
1247 irq_domain_remove(pdata->irqdomain);
1250 irq_domain_free_fwnode(pdata->irqfwnode);
1257 static void smsc95xx_unbind(struct usbnet *dev, struct usb_interface *intf)
1259 struct smsc95xx_priv *pdata = dev->driver_priv;
1261 phy_disconnect(dev->net->phydev);
1262 mdiobus_unregister(pdata->mdiobus);
1263 mdiobus_free(pdata->mdiobus);
1264 irq_dispose_mapping(irq_find_mapping(pdata->irqdomain, PHY_HWIRQ));
1265 irq_domain_remove(pdata->irqdomain);
1266 irq_domain_free_fwnode(pdata->irqfwnode);
1267 netif_dbg(dev, ifdown, dev->net, "free pdata\n");
1271 static int smsc95xx_start_phy(struct usbnet *dev)
1273 phy_start(dev->net->phydev);
1278 static int smsc95xx_stop(struct usbnet *dev)
1280 phy_stop(dev->net->phydev);
1285 static u32 smsc_crc(const u8 *buffer, size_t len, int filter)
1287 u32 crc = bitrev16(crc16(0xFFFF, buffer, len));
1288 return crc << ((filter % 2) * 16);
1291 static int smsc95xx_link_ok(struct usbnet *dev)
1293 struct smsc95xx_priv *pdata = dev->driver_priv;
1296 /* first, a dummy read, needed to latch some MII phys */
1297 ret = smsc95xx_mdio_read(dev, pdata->phydev->mdio.addr, MII_BMSR);
1301 ret = smsc95xx_mdio_read(dev, pdata->phydev->mdio.addr, MII_BMSR);
1305 return !!(ret & BMSR_LSTATUS);
1308 static int smsc95xx_enter_suspend0(struct usbnet *dev)
1310 struct smsc95xx_priv *pdata = dev->driver_priv;
1314 ret = smsc95xx_read_reg(dev, PM_CTRL, &val);
1318 val &= (~(PM_CTL_SUS_MODE_ | PM_CTL_WUPS_ | PM_CTL_PHY_RST_));
1319 val |= PM_CTL_SUS_MODE_0;
1321 ret = smsc95xx_write_reg(dev, PM_CTRL, val);
1325 /* clear wol status */
1326 val &= ~PM_CTL_WUPS_;
1327 val |= PM_CTL_WUPS_WOL_;
1329 /* enable energy detection */
1330 if (pdata->wolopts & WAKE_PHY)
1331 val |= PM_CTL_WUPS_ED_;
1333 ret = smsc95xx_write_reg(dev, PM_CTRL, val);
1337 /* read back PM_CTRL */
1338 ret = smsc95xx_read_reg(dev, PM_CTRL, &val);
1342 pdata->suspend_flags |= SUSPEND_SUSPEND0;
1347 static int smsc95xx_enter_suspend1(struct usbnet *dev)
1349 struct smsc95xx_priv *pdata = dev->driver_priv;
1350 int ret, phy_id = pdata->phydev->mdio.addr;
1353 /* reconfigure link pulse detection timing for
1354 * compatibility with non-standard link partners
1356 if (pdata->features & FEATURE_PHY_NLP_CROSSOVER)
1357 smsc95xx_mdio_write(dev, phy_id, PHY_EDPD_CONFIG,
1358 PHY_EDPD_CONFIG_DEFAULT);
1360 /* enable energy detect power-down mode */
1361 ret = smsc95xx_mdio_read(dev, phy_id, PHY_MODE_CTRL_STS);
1365 ret |= MODE_CTRL_STS_EDPWRDOWN_;
1367 smsc95xx_mdio_write(dev, phy_id, PHY_MODE_CTRL_STS, ret);
1369 /* enter SUSPEND1 mode */
1370 ret = smsc95xx_read_reg(dev, PM_CTRL, &val);
1374 val &= ~(PM_CTL_SUS_MODE_ | PM_CTL_WUPS_ | PM_CTL_PHY_RST_);
1375 val |= PM_CTL_SUS_MODE_1;
1377 ret = smsc95xx_write_reg(dev, PM_CTRL, val);
1381 /* clear wol status, enable energy detection */
1382 val &= ~PM_CTL_WUPS_;
1383 val |= (PM_CTL_WUPS_ED_ | PM_CTL_ED_EN_);
1385 ret = smsc95xx_write_reg(dev, PM_CTRL, val);
1389 pdata->suspend_flags |= SUSPEND_SUSPEND1;
1394 static int smsc95xx_enter_suspend2(struct usbnet *dev)
1396 struct smsc95xx_priv *pdata = dev->driver_priv;
1400 ret = smsc95xx_read_reg(dev, PM_CTRL, &val);
1404 val &= ~(PM_CTL_SUS_MODE_ | PM_CTL_WUPS_ | PM_CTL_PHY_RST_);
1405 val |= PM_CTL_SUS_MODE_2;
1407 ret = smsc95xx_write_reg(dev, PM_CTRL, val);
1411 pdata->suspend_flags |= SUSPEND_SUSPEND2;
1416 static int smsc95xx_enter_suspend3(struct usbnet *dev)
1418 struct smsc95xx_priv *pdata = dev->driver_priv;
1422 ret = smsc95xx_read_reg(dev, RX_FIFO_INF, &val);
1426 if (val & RX_FIFO_INF_USED_) {
1427 netdev_info(dev->net, "rx fifo not empty in autosuspend\n");
1431 ret = smsc95xx_read_reg(dev, PM_CTRL, &val);
1435 val &= ~(PM_CTL_SUS_MODE_ | PM_CTL_WUPS_ | PM_CTL_PHY_RST_);
1436 val |= PM_CTL_SUS_MODE_3 | PM_CTL_RES_CLR_WKP_STS;
1438 ret = smsc95xx_write_reg(dev, PM_CTRL, val);
1442 /* clear wol status */
1443 val &= ~PM_CTL_WUPS_;
1444 val |= PM_CTL_WUPS_WOL_;
1446 ret = smsc95xx_write_reg(dev, PM_CTRL, val);
1450 pdata->suspend_flags |= SUSPEND_SUSPEND3;
1455 static int smsc95xx_autosuspend(struct usbnet *dev, u32 link_up)
1457 struct smsc95xx_priv *pdata = dev->driver_priv;
1459 if (!netif_running(dev->net)) {
1460 /* interface is ifconfig down so fully power down hw */
1461 netdev_dbg(dev->net, "autosuspend entering SUSPEND2\n");
1462 return smsc95xx_enter_suspend2(dev);
1466 /* link is down so enter EDPD mode, but only if device can
1467 * reliably resume from it. This check should be redundant
1468 * as current FEATURE_REMOTE_WAKEUP parts also support
1469 * FEATURE_PHY_NLP_CROSSOVER but it's included for clarity */
1470 if (!(pdata->features & FEATURE_PHY_NLP_CROSSOVER)) {
1471 netdev_warn(dev->net, "EDPD not supported\n");
1475 netdev_dbg(dev->net, "autosuspend entering SUSPEND1\n");
1476 netdev_info(dev->net, "entering SUSPEND1 mode\n");
1477 return smsc95xx_enter_suspend1(dev);
1480 netdev_dbg(dev->net, "autosuspend entering SUSPEND3\n");
1481 return smsc95xx_enter_suspend3(dev);
1484 static int smsc95xx_suspend(struct usb_interface *intf, pm_message_t message)
1486 struct usbnet *dev = usb_get_intfdata(intf);
1487 struct smsc95xx_priv *pdata = dev->driver_priv;
1491 pdata->pm_task = current;
1493 ret = usbnet_suspend(intf, message);
1495 netdev_warn(dev->net, "usbnet_suspend error\n");
1496 pdata->pm_task = NULL;
1500 if (pdata->suspend_flags) {
1501 netdev_warn(dev->net, "error during last resume\n");
1502 pdata->suspend_flags = 0;
1505 link_up = smsc95xx_link_ok(dev);
1507 if (message.event == PM_EVENT_AUTO_SUSPEND &&
1508 (pdata->features & FEATURE_REMOTE_WAKEUP)) {
1509 ret = smsc95xx_autosuspend(dev, link_up);
1513 /* if we get this far we're not autosuspending */
1514 /* if no wol options set, or if link is down and we're not waking on
1515 * PHY activity, enter lowest power SUSPEND2 mode
1517 if (!(pdata->wolopts & SUPPORTED_WAKE) ||
1518 !(link_up || (pdata->wolopts & WAKE_PHY))) {
1519 netdev_info(dev->net, "entering SUSPEND2 mode\n");
1521 /* disable energy detect (link up) & wake up events */
1522 ret = smsc95xx_read_reg(dev, WUCSR, &val);
1526 val &= ~(WUCSR_MPEN_ | WUCSR_WAKE_EN_);
1528 ret = smsc95xx_write_reg(dev, WUCSR, val);
1532 ret = smsc95xx_read_reg(dev, PM_CTRL, &val);
1536 val &= ~(PM_CTL_ED_EN_ | PM_CTL_WOL_EN_);
1538 ret = smsc95xx_write_reg(dev, PM_CTRL, val);
1542 ret = smsc95xx_enter_suspend2(dev);
1546 if (pdata->wolopts & WAKE_PHY) {
1547 /* if link is down then configure EDPD and enter SUSPEND1,
1548 * otherwise enter SUSPEND0 below
1551 netdev_info(dev->net, "entering SUSPEND1 mode\n");
1552 ret = smsc95xx_enter_suspend1(dev);
1557 if (pdata->wolopts & (WAKE_BCAST | WAKE_MCAST | WAKE_ARP | WAKE_UCAST)) {
1558 u32 *filter_mask = kcalloc(32, sizeof(u32), GFP_KERNEL);
1562 int wuff_filter_count =
1563 (pdata->features & FEATURE_8_WAKEUP_FILTERS) ?
1564 LAN9500A_WUFF_NUM : LAN9500_WUFF_NUM;
1568 netdev_warn(dev->net, "Unable to allocate filter_mask\n");
1573 memset(command, 0, sizeof(command));
1574 memset(offset, 0, sizeof(offset));
1575 memset(crc, 0, sizeof(crc));
1577 if (pdata->wolopts & WAKE_BCAST) {
1578 const u8 bcast[] = {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF};
1579 netdev_info(dev->net, "enabling broadcast detection\n");
1580 filter_mask[filter * 4] = 0x003F;
1581 filter_mask[filter * 4 + 1] = 0x00;
1582 filter_mask[filter * 4 + 2] = 0x00;
1583 filter_mask[filter * 4 + 3] = 0x00;
1584 command[filter/4] |= 0x05UL << ((filter % 4) * 8);
1585 offset[filter/4] |= 0x00 << ((filter % 4) * 8);
1586 crc[filter/2] |= smsc_crc(bcast, 6, filter);
1590 if (pdata->wolopts & WAKE_MCAST) {
1591 const u8 mcast[] = {0x01, 0x00, 0x5E};
1592 netdev_info(dev->net, "enabling multicast detection\n");
1593 filter_mask[filter * 4] = 0x0007;
1594 filter_mask[filter * 4 + 1] = 0x00;
1595 filter_mask[filter * 4 + 2] = 0x00;
1596 filter_mask[filter * 4 + 3] = 0x00;
1597 command[filter/4] |= 0x09UL << ((filter % 4) * 8);
1598 offset[filter/4] |= 0x00 << ((filter % 4) * 8);
1599 crc[filter/2] |= smsc_crc(mcast, 3, filter);
1603 if (pdata->wolopts & WAKE_ARP) {
1604 const u8 arp[] = {0x08, 0x06};
1605 netdev_info(dev->net, "enabling ARP detection\n");
1606 filter_mask[filter * 4] = 0x0003;
1607 filter_mask[filter * 4 + 1] = 0x00;
1608 filter_mask[filter * 4 + 2] = 0x00;
1609 filter_mask[filter * 4 + 3] = 0x00;
1610 command[filter/4] |= 0x05UL << ((filter % 4) * 8);
1611 offset[filter/4] |= 0x0C << ((filter % 4) * 8);
1612 crc[filter/2] |= smsc_crc(arp, 2, filter);
1616 if (pdata->wolopts & WAKE_UCAST) {
1617 netdev_info(dev->net, "enabling unicast detection\n");
1618 filter_mask[filter * 4] = 0x003F;
1619 filter_mask[filter * 4 + 1] = 0x00;
1620 filter_mask[filter * 4 + 2] = 0x00;
1621 filter_mask[filter * 4 + 3] = 0x00;
1622 command[filter/4] |= 0x01UL << ((filter % 4) * 8);
1623 offset[filter/4] |= 0x00 << ((filter % 4) * 8);
1624 crc[filter/2] |= smsc_crc(dev->net->dev_addr, ETH_ALEN, filter);
1628 for (i = 0; i < (wuff_filter_count * 4); i++) {
1629 ret = smsc95xx_write_reg(dev, WUFF, filter_mask[i]);
1637 for (i = 0; i < (wuff_filter_count / 4); i++) {
1638 ret = smsc95xx_write_reg(dev, WUFF, command[i]);
1643 for (i = 0; i < (wuff_filter_count / 4); i++) {
1644 ret = smsc95xx_write_reg(dev, WUFF, offset[i]);
1649 for (i = 0; i < (wuff_filter_count / 2); i++) {
1650 ret = smsc95xx_write_reg(dev, WUFF, crc[i]);
1655 /* clear any pending pattern match packet status */
1656 ret = smsc95xx_read_reg(dev, WUCSR, &val);
1662 ret = smsc95xx_write_reg(dev, WUCSR, val);
1667 if (pdata->wolopts & WAKE_MAGIC) {
1668 /* clear any pending magic packet status */
1669 ret = smsc95xx_read_reg(dev, WUCSR, &val);
1675 ret = smsc95xx_write_reg(dev, WUCSR, val);
1680 /* enable/disable wakeup sources */
1681 ret = smsc95xx_read_reg(dev, WUCSR, &val);
1685 if (pdata->wolopts & (WAKE_BCAST | WAKE_MCAST | WAKE_ARP | WAKE_UCAST)) {
1686 netdev_info(dev->net, "enabling pattern match wakeup\n");
1687 val |= WUCSR_WAKE_EN_;
1689 netdev_info(dev->net, "disabling pattern match wakeup\n");
1690 val &= ~WUCSR_WAKE_EN_;
1693 if (pdata->wolopts & WAKE_MAGIC) {
1694 netdev_info(dev->net, "enabling magic packet wakeup\n");
1697 netdev_info(dev->net, "disabling magic packet wakeup\n");
1698 val &= ~WUCSR_MPEN_;
1701 ret = smsc95xx_write_reg(dev, WUCSR, val);
1705 /* enable wol wakeup source */
1706 ret = smsc95xx_read_reg(dev, PM_CTRL, &val);
1710 val |= PM_CTL_WOL_EN_;
1712 /* phy energy detect wakeup source */
1713 if (pdata->wolopts & WAKE_PHY)
1714 val |= PM_CTL_ED_EN_;
1716 ret = smsc95xx_write_reg(dev, PM_CTRL, val);
1720 /* enable receiver to enable frame reception */
1721 smsc95xx_start_rx_path(dev);
1723 /* some wol options are enabled, so enter SUSPEND0 */
1724 netdev_info(dev->net, "entering SUSPEND0 mode\n");
1725 ret = smsc95xx_enter_suspend0(dev);
1729 * TODO: resume() might need to handle the suspend failure
1732 if (ret && PMSG_IS_AUTO(message))
1733 usbnet_resume(intf);
1735 pdata->pm_task = NULL;
1739 static int smsc95xx_resume(struct usb_interface *intf)
1741 struct usbnet *dev = usb_get_intfdata(intf);
1742 struct smsc95xx_priv *pdata;
1748 pdata = dev->driver_priv;
1749 suspend_flags = pdata->suspend_flags;
1751 netdev_dbg(dev->net, "resume suspend_flags=0x%02x\n", suspend_flags);
1753 /* do this first to ensure it's cleared even in error case */
1754 pdata->suspend_flags = 0;
1756 pdata->pm_task = current;
1758 if (suspend_flags & SUSPEND_ALLMODES) {
1759 /* clear wake-up sources */
1760 ret = smsc95xx_read_reg(dev, WUCSR, &val);
1764 val &= ~(WUCSR_WAKE_EN_ | WUCSR_MPEN_);
1766 ret = smsc95xx_write_reg(dev, WUCSR, val);
1770 /* clear wake-up status */
1771 ret = smsc95xx_read_reg(dev, PM_CTRL, &val);
1775 val &= ~PM_CTL_WOL_EN_;
1776 val |= PM_CTL_WUPS_;
1778 ret = smsc95xx_write_reg(dev, PM_CTRL, val);
1783 phy_init_hw(pdata->phydev);
1785 ret = usbnet_resume(intf);
1787 netdev_warn(dev->net, "usbnet_resume error\n");
1790 pdata->pm_task = NULL;
1794 static int smsc95xx_reset_resume(struct usb_interface *intf)
1796 struct usbnet *dev = usb_get_intfdata(intf);
1797 struct smsc95xx_priv *pdata = dev->driver_priv;
1800 pdata->pm_task = current;
1801 ret = smsc95xx_reset(dev);
1802 pdata->pm_task = NULL;
1806 return smsc95xx_resume(intf);
1809 static void smsc95xx_rx_csum_offload(struct sk_buff *skb)
1811 skb->csum = *(u16 *)(skb_tail_pointer(skb) - 2);
1812 skb->ip_summed = CHECKSUM_COMPLETE;
1813 skb_trim(skb, skb->len - 2);
1816 static int smsc95xx_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
1818 /* This check is no longer done by usbnet */
1819 if (skb->len < dev->net->hard_header_len)
1822 while (skb->len > 0) {
1823 u32 header, align_count;
1824 struct sk_buff *ax_skb;
1825 unsigned char *packet;
1828 header = get_unaligned_le32(skb->data);
1829 skb_pull(skb, 4 + NET_IP_ALIGN);
1832 /* get the packet length */
1833 size = (u16)((header & RX_STS_FL_) >> 16);
1834 align_count = (4 - ((size + NET_IP_ALIGN) % 4)) % 4;
1836 if (unlikely(size > skb->len)) {
1837 netif_dbg(dev, rx_err, dev->net,
1838 "size err header=0x%08x\n", header);
1842 if (unlikely(header & RX_STS_ES_)) {
1843 netif_dbg(dev, rx_err, dev->net,
1844 "Error header=0x%08x\n", header);
1845 dev->net->stats.rx_errors++;
1846 dev->net->stats.rx_dropped++;
1848 if (header & RX_STS_CRC_) {
1849 dev->net->stats.rx_crc_errors++;
1851 if (header & (RX_STS_TL_ | RX_STS_RF_))
1852 dev->net->stats.rx_frame_errors++;
1854 if ((header & RX_STS_LE_) &&
1855 (!(header & RX_STS_FT_)))
1856 dev->net->stats.rx_length_errors++;
1859 /* ETH_FRAME_LEN + 4(CRC) + 2(COE) + 4(Vlan) */
1860 if (unlikely(size > (ETH_FRAME_LEN + 12))) {
1861 netif_dbg(dev, rx_err, dev->net,
1862 "size err header=0x%08x\n", header);
1866 /* last frame in this batch */
1867 if (skb->len == size) {
1868 if (dev->net->features & NETIF_F_RXCSUM)
1869 smsc95xx_rx_csum_offload(skb);
1870 skb_trim(skb, skb->len - 4); /* remove fcs */
1871 skb->truesize = size + sizeof(struct sk_buff);
1876 ax_skb = skb_clone(skb, GFP_ATOMIC);
1877 if (unlikely(!ax_skb)) {
1878 netdev_warn(dev->net, "Error allocating skb\n");
1883 ax_skb->data = packet;
1884 skb_set_tail_pointer(ax_skb, size);
1886 if (dev->net->features & NETIF_F_RXCSUM)
1887 smsc95xx_rx_csum_offload(ax_skb);
1888 skb_trim(ax_skb, ax_skb->len - 4); /* remove fcs */
1889 ax_skb->truesize = size + sizeof(struct sk_buff);
1891 usbnet_skb_return(dev, ax_skb);
1894 skb_pull(skb, size);
1896 /* padding bytes before the next frame starts */
1898 skb_pull(skb, align_count);
1904 static u32 smsc95xx_calc_csum_preamble(struct sk_buff *skb)
1906 u16 low_16 = (u16)skb_checksum_start_offset(skb);
1907 u16 high_16 = low_16 + skb->csum_offset;
1908 return (high_16 << 16) | low_16;
1911 /* The TX CSUM won't work if the checksum lies in the last 4 bytes of the
1912 * transmission. This is fairly unlikely, only seems to trigger with some
1913 * short TCP ACK packets sent.
1915 * Note, this calculation should probably check for the alignment of the
1916 * data as well, but a straight check for csum being in the last four bytes
1917 * of the packet should be ok for now.
1919 static bool smsc95xx_can_tx_checksum(struct sk_buff *skb)
1921 unsigned int len = skb->len - skb_checksum_start_offset(skb);
1925 return skb->csum_offset < (len - (4 + 1));
1928 static struct sk_buff *smsc95xx_tx_fixup(struct usbnet *dev,
1929 struct sk_buff *skb, gfp_t flags)
1931 bool csum = skb->ip_summed == CHECKSUM_PARTIAL;
1932 int overhead = csum ? SMSC95XX_TX_OVERHEAD_CSUM : SMSC95XX_TX_OVERHEAD;
1933 u32 tx_cmd_a, tx_cmd_b;
1936 /* We do not advertise SG, so skbs should be already linearized */
1937 BUG_ON(skb_shinfo(skb)->nr_frags);
1939 /* Make writable and expand header space by overhead if required */
1940 if (skb_cow_head(skb, overhead)) {
1941 /* Must deallocate here as returning NULL to indicate error
1942 * means the skb won't be deallocated in the caller.
1944 dev_kfree_skb_any(skb);
1948 tx_cmd_b = (u32)skb->len;
1949 tx_cmd_a = tx_cmd_b | TX_CMD_A_FIRST_SEG_ | TX_CMD_A_LAST_SEG_;
1952 if (!smsc95xx_can_tx_checksum(skb)) {
1953 /* workaround - hardware tx checksum does not work
1954 * properly with extremely small packets */
1955 long csstart = skb_checksum_start_offset(skb);
1956 __wsum calc = csum_partial(skb->data + csstart,
1957 skb->len - csstart, 0);
1958 *((__sum16 *)(skb->data + csstart
1959 + skb->csum_offset)) = csum_fold(calc);
1963 u32 csum_preamble = smsc95xx_calc_csum_preamble(skb);
1964 ptr = skb_push(skb, 4);
1965 put_unaligned_le32(csum_preamble, ptr);
1969 tx_cmd_b |= TX_CMD_B_CSUM_ENABLE;
1973 ptr = skb_push(skb, 8);
1974 put_unaligned_le32(tx_cmd_a, ptr);
1975 put_unaligned_le32(tx_cmd_b, ptr+4);
1980 static int smsc95xx_manage_power(struct usbnet *dev, int on)
1982 struct smsc95xx_priv *pdata = dev->driver_priv;
1984 dev->intf->needs_remote_wakeup = on;
1986 if (pdata->features & FEATURE_REMOTE_WAKEUP)
1989 /* this chip revision isn't capable of remote wakeup */
1990 netdev_info(dev->net, "hardware isn't capable of remote wakeup\n");
1993 usb_autopm_get_interface_no_resume(dev->intf);
1995 usb_autopm_put_interface(dev->intf);
2000 static const struct driver_info smsc95xx_info = {
2001 .description = "smsc95xx USB 2.0 Ethernet",
2002 .bind = smsc95xx_bind,
2003 .unbind = smsc95xx_unbind,
2004 .reset = smsc95xx_reset,
2005 .check_connect = smsc95xx_start_phy,
2006 .stop = smsc95xx_stop,
2007 .rx_fixup = smsc95xx_rx_fixup,
2008 .tx_fixup = smsc95xx_tx_fixup,
2009 .status = smsc95xx_status,
2010 .manage_power = smsc95xx_manage_power,
2011 .flags = FLAG_ETHER | FLAG_SEND_ZLP | FLAG_LINK_INTR,
2014 static const struct usb_device_id products[] = {
2016 /* SMSC9500 USB Ethernet Device */
2017 USB_DEVICE(0x0424, 0x9500),
2018 .driver_info = (unsigned long) &smsc95xx_info,
2021 /* SMSC9505 USB Ethernet Device */
2022 USB_DEVICE(0x0424, 0x9505),
2023 .driver_info = (unsigned long) &smsc95xx_info,
2026 /* SMSC9500A USB Ethernet Device */
2027 USB_DEVICE(0x0424, 0x9E00),
2028 .driver_info = (unsigned long) &smsc95xx_info,
2031 /* SMSC9505A USB Ethernet Device */
2032 USB_DEVICE(0x0424, 0x9E01),
2033 .driver_info = (unsigned long) &smsc95xx_info,
2036 /* SMSC9512/9514 USB Hub & Ethernet Device */
2037 USB_DEVICE(0x0424, 0xec00),
2038 .driver_info = (unsigned long) &smsc95xx_info,
2041 /* SMSC9500 USB Ethernet Device (SAL10) */
2042 USB_DEVICE(0x0424, 0x9900),
2043 .driver_info = (unsigned long) &smsc95xx_info,
2046 /* SMSC9505 USB Ethernet Device (SAL10) */
2047 USB_DEVICE(0x0424, 0x9901),
2048 .driver_info = (unsigned long) &smsc95xx_info,
2051 /* SMSC9500A USB Ethernet Device (SAL10) */
2052 USB_DEVICE(0x0424, 0x9902),
2053 .driver_info = (unsigned long) &smsc95xx_info,
2056 /* SMSC9505A USB Ethernet Device (SAL10) */
2057 USB_DEVICE(0x0424, 0x9903),
2058 .driver_info = (unsigned long) &smsc95xx_info,
2061 /* SMSC9512/9514 USB Hub & Ethernet Device (SAL10) */
2062 USB_DEVICE(0x0424, 0x9904),
2063 .driver_info = (unsigned long) &smsc95xx_info,
2066 /* SMSC9500A USB Ethernet Device (HAL) */
2067 USB_DEVICE(0x0424, 0x9905),
2068 .driver_info = (unsigned long) &smsc95xx_info,
2071 /* SMSC9505A USB Ethernet Device (HAL) */
2072 USB_DEVICE(0x0424, 0x9906),
2073 .driver_info = (unsigned long) &smsc95xx_info,
2076 /* SMSC9500 USB Ethernet Device (Alternate ID) */
2077 USB_DEVICE(0x0424, 0x9907),
2078 .driver_info = (unsigned long) &smsc95xx_info,
2081 /* SMSC9500A USB Ethernet Device (Alternate ID) */
2082 USB_DEVICE(0x0424, 0x9908),
2083 .driver_info = (unsigned long) &smsc95xx_info,
2086 /* SMSC9512/9514 USB Hub & Ethernet Device (Alternate ID) */
2087 USB_DEVICE(0x0424, 0x9909),
2088 .driver_info = (unsigned long) &smsc95xx_info,
2091 /* SMSC LAN9530 USB Ethernet Device */
2092 USB_DEVICE(0x0424, 0x9530),
2093 .driver_info = (unsigned long) &smsc95xx_info,
2096 /* SMSC LAN9730 USB Ethernet Device */
2097 USB_DEVICE(0x0424, 0x9730),
2098 .driver_info = (unsigned long) &smsc95xx_info,
2101 /* SMSC LAN89530 USB Ethernet Device */
2102 USB_DEVICE(0x0424, 0x9E08),
2103 .driver_info = (unsigned long) &smsc95xx_info,
2106 /* Microchip's EVB-LAN8670-USB 10BASE-T1S Ethernet Device */
2107 USB_DEVICE(0x184F, 0x0051),
2108 .driver_info = (unsigned long)&smsc95xx_info,
2112 MODULE_DEVICE_TABLE(usb, products);
2114 static struct usb_driver smsc95xx_driver = {
2116 .id_table = products,
2117 .probe = usbnet_probe,
2118 .suspend = smsc95xx_suspend,
2119 .resume = smsc95xx_resume,
2120 .reset_resume = smsc95xx_reset_resume,
2121 .disconnect = usbnet_disconnect,
2122 .disable_hub_initiated_lpm = 1,
2123 .supports_autosuspend = 1,
2126 module_usb_driver(smsc95xx_driver);
2128 MODULE_AUTHOR("Nancy Lin");
2130 MODULE_DESCRIPTION("SMSC95XX USB 2.0 Ethernet Devices");
2131 MODULE_LICENSE("GPL");