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>
27 #define SMSC_CHIPNAME "smsc95xx"
28 #define SMSC_DRIVER_VERSION "2.0.0"
29 #define HS_USB_PKT_SIZE (512)
30 #define FS_USB_PKT_SIZE (64)
31 #define DEFAULT_HS_BURST_CAP_SIZE (16 * 1024 + 5 * HS_USB_PKT_SIZE)
32 #define DEFAULT_FS_BURST_CAP_SIZE (6 * 1024 + 33 * FS_USB_PKT_SIZE)
33 #define DEFAULT_BULK_IN_DELAY (0x00002000)
34 #define MAX_SINGLE_PACKET_SIZE (2048)
35 #define LAN95XX_EEPROM_MAGIC (0x9500)
36 #define EEPROM_MAC_OFFSET (0x01)
37 #define DEFAULT_TX_CSUM_ENABLE (true)
38 #define DEFAULT_RX_CSUM_ENABLE (true)
39 #define SMSC95XX_INTERNAL_PHY_ID (1)
40 #define SMSC95XX_TX_OVERHEAD (8)
41 #define SMSC95XX_TX_OVERHEAD_CSUM (12)
42 #define SUPPORTED_WAKE (WAKE_PHY | WAKE_UCAST | WAKE_BCAST | \
43 WAKE_MCAST | WAKE_ARP | WAKE_MAGIC)
45 #define FEATURE_8_WAKEUP_FILTERS (0x01)
46 #define FEATURE_PHY_NLP_CROSSOVER (0x02)
47 #define FEATURE_REMOTE_WAKEUP (0x04)
49 #define SUSPEND_SUSPEND0 (0x01)
50 #define SUSPEND_SUSPEND1 (0x02)
51 #define SUSPEND_SUSPEND2 (0x04)
52 #define SUSPEND_SUSPEND3 (0x08)
53 #define SUSPEND_ALLMODES (SUSPEND_SUSPEND0 | SUSPEND_SUSPEND1 | \
54 SUSPEND_SUSPEND2 | SUSPEND_SUSPEND3)
55 #define MAC_ADDR_LEN (6)
57 #define SMSC95XX_NR_IRQS (1) /* raise to 12 for GPIOs */
58 #define PHY_HWIRQ (SMSC95XX_NR_IRQS - 1)
60 struct smsc95xx_priv {
65 spinlock_t mac_cr_lock;
68 struct irq_chip irqchip;
69 struct irq_domain *irqdomain;
70 struct fwnode_handle *irqfwnode;
71 struct mii_bus *mdiobus;
72 struct phy_device *phydev;
73 struct task_struct *pm_task;
76 static bool turbo_mode = true;
77 module_param(turbo_mode, bool, 0644);
78 MODULE_PARM_DESC(turbo_mode, "Enable multiple frames per Rx transaction");
80 static bool truesize_mode = false;
81 module_param(truesize_mode, bool, 0644);
82 MODULE_PARM_DESC(truesize_mode, "Report larger truesize value");
84 static int packetsize = 2560;
85 module_param(packetsize, int, 0644);
86 MODULE_PARM_DESC(packetsize, "Override the RX URB packet size");
88 static char *macaddr = ":";
89 module_param(macaddr, charp, 0);
90 MODULE_PARM_DESC(macaddr, "MAC address");
92 static int __must_check __smsc95xx_read_reg(struct usbnet *dev, u32 index,
95 struct smsc95xx_priv *pdata = dev->driver_priv;
98 int (*fn)(struct usbnet *, u8, u8, u16, u16, void *, u16);
102 if (current != pdata->pm_task)
103 fn = usbnet_read_cmd;
105 fn = usbnet_read_cmd_nopm;
107 ret = fn(dev, USB_VENDOR_REQUEST_READ_REGISTER, USB_DIR_IN
108 | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
112 netdev_warn(dev->net, "Failed to read reg index 0x%08x: %d\n",
123 static int __must_check __smsc95xx_write_reg(struct usbnet *dev, u32 index,
126 struct smsc95xx_priv *pdata = dev->driver_priv;
129 int (*fn)(struct usbnet *, u8, u8, u16, u16, const void *, u16);
133 if (current != pdata->pm_task)
134 fn = usbnet_write_cmd;
136 fn = usbnet_write_cmd_nopm;
141 ret = fn(dev, USB_VENDOR_REQUEST_WRITE_REGISTER, USB_DIR_OUT
142 | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
144 if (ret < 0 && ret != -ENODEV)
145 netdev_warn(dev->net, "Failed to write reg index 0x%08x: %d\n",
151 static int __must_check smsc95xx_read_reg_nopm(struct usbnet *dev, u32 index,
154 return __smsc95xx_read_reg(dev, index, data, 1);
157 static int __must_check smsc95xx_write_reg_nopm(struct usbnet *dev, u32 index,
160 return __smsc95xx_write_reg(dev, index, data, 1);
163 static int __must_check smsc95xx_read_reg(struct usbnet *dev, u32 index,
166 return __smsc95xx_read_reg(dev, index, data, 0);
169 static int __must_check smsc95xx_write_reg(struct usbnet *dev, u32 index,
172 return __smsc95xx_write_reg(dev, index, data, 0);
175 /* Loop until the read is completed with timeout
176 * called with phy_mutex held */
177 static int __must_check __smsc95xx_phy_wait_not_busy(struct usbnet *dev,
180 unsigned long start_time = jiffies;
185 ret = __smsc95xx_read_reg(dev, MII_ADDR, &val, in_pm);
187 /* Ignore -ENODEV error during disconnect() */
190 netdev_warn(dev->net, "Error reading MII_ACCESS\n");
194 if (!(val & MII_BUSY_))
196 } while (!time_after(jiffies, start_time + HZ));
201 static u32 mii_address_cmd(int phy_id, int idx, u16 op)
203 return (phy_id & 0x1f) << 11 | (idx & 0x1f) << 6 | op;
206 static int __smsc95xx_mdio_read(struct usbnet *dev, int phy_id, int idx,
212 mutex_lock(&dev->phy_mutex);
214 /* confirm MII not busy */
215 ret = __smsc95xx_phy_wait_not_busy(dev, in_pm);
217 netdev_warn(dev->net, "%s: MII is busy\n", __func__);
221 /* set the address, index & direction (read from PHY) */
222 addr = mii_address_cmd(phy_id, idx, MII_READ_ | MII_BUSY_);
223 ret = __smsc95xx_write_reg(dev, MII_ADDR, addr, in_pm);
226 netdev_warn(dev->net, "Error writing MII_ADDR\n");
230 ret = __smsc95xx_phy_wait_not_busy(dev, in_pm);
232 netdev_warn(dev->net, "Timed out reading MII reg %02X\n", idx);
236 ret = __smsc95xx_read_reg(dev, MII_DATA, &val, in_pm);
239 netdev_warn(dev->net, "Error reading MII_DATA\n");
243 ret = (u16)(val & 0xFFFF);
246 mutex_unlock(&dev->phy_mutex);
248 /* Ignore -ENODEV error during disconnect() */
254 static void __smsc95xx_mdio_write(struct usbnet *dev, int phy_id,
255 int idx, int regval, int in_pm)
260 mutex_lock(&dev->phy_mutex);
262 /* confirm MII not busy */
263 ret = __smsc95xx_phy_wait_not_busy(dev, in_pm);
265 netdev_warn(dev->net, "%s: MII is busy\n", __func__);
270 ret = __smsc95xx_write_reg(dev, MII_DATA, val, in_pm);
273 netdev_warn(dev->net, "Error writing MII_DATA\n");
277 /* set the address, index & direction (write to PHY) */
278 addr = mii_address_cmd(phy_id, idx, MII_WRITE_ | MII_BUSY_);
279 ret = __smsc95xx_write_reg(dev, MII_ADDR, addr, in_pm);
282 netdev_warn(dev->net, "Error writing MII_ADDR\n");
286 ret = __smsc95xx_phy_wait_not_busy(dev, in_pm);
288 netdev_warn(dev->net, "Timed out writing MII reg %02X\n", idx);
293 mutex_unlock(&dev->phy_mutex);
296 static int smsc95xx_mdio_read_nopm(struct usbnet *dev, int idx)
298 struct smsc95xx_priv *pdata = dev->driver_priv;
300 return __smsc95xx_mdio_read(dev, pdata->phydev->mdio.addr, idx, 1);
303 static void smsc95xx_mdio_write_nopm(struct usbnet *dev, int idx, int regval)
305 struct smsc95xx_priv *pdata = dev->driver_priv;
307 __smsc95xx_mdio_write(dev, pdata->phydev->mdio.addr, idx, regval, 1);
310 static int smsc95xx_mdiobus_read(struct mii_bus *bus, int phy_id, int idx)
312 struct usbnet *dev = bus->priv;
314 return __smsc95xx_mdio_read(dev, phy_id, idx, 0);
317 static int smsc95xx_mdiobus_write(struct mii_bus *bus, int phy_id, int idx,
320 struct usbnet *dev = bus->priv;
322 __smsc95xx_mdio_write(dev, phy_id, idx, regval, 0);
326 static int __must_check smsc95xx_wait_eeprom(struct usbnet *dev)
328 unsigned long start_time = jiffies;
333 ret = smsc95xx_read_reg(dev, E2P_CMD, &val);
335 netdev_warn(dev->net, "Error reading E2P_CMD\n");
339 if (!(val & E2P_CMD_BUSY_) || (val & E2P_CMD_TIMEOUT_))
342 } while (!time_after(jiffies, start_time + HZ));
344 if (val & (E2P_CMD_TIMEOUT_ | E2P_CMD_BUSY_)) {
345 netdev_warn(dev->net, "EEPROM read operation timeout\n");
352 static int __must_check smsc95xx_eeprom_confirm_not_busy(struct usbnet *dev)
354 unsigned long start_time = jiffies;
359 ret = smsc95xx_read_reg(dev, E2P_CMD, &val);
361 netdev_warn(dev->net, "Error reading E2P_CMD\n");
365 if (!(val & E2P_CMD_BUSY_))
369 } while (!time_after(jiffies, start_time + HZ));
371 netdev_warn(dev->net, "EEPROM is busy\n");
375 static int smsc95xx_read_eeprom(struct usbnet *dev, u32 offset, u32 length,
384 ret = smsc95xx_eeprom_confirm_not_busy(dev);
388 for (i = 0; i < length; i++) {
389 val = E2P_CMD_BUSY_ | E2P_CMD_READ_ | (offset & E2P_CMD_ADDR_);
390 ret = smsc95xx_write_reg(dev, E2P_CMD, val);
392 netdev_warn(dev->net, "Error writing E2P_CMD\n");
396 ret = smsc95xx_wait_eeprom(dev);
400 ret = smsc95xx_read_reg(dev, E2P_DATA, &val);
402 netdev_warn(dev->net, "Error reading E2P_DATA\n");
406 data[i] = val & 0xFF;
413 static int smsc95xx_write_eeprom(struct usbnet *dev, u32 offset, u32 length,
422 ret = smsc95xx_eeprom_confirm_not_busy(dev);
426 /* Issue write/erase enable command */
427 val = E2P_CMD_BUSY_ | E2P_CMD_EWEN_;
428 ret = smsc95xx_write_reg(dev, E2P_CMD, val);
430 netdev_warn(dev->net, "Error writing E2P_DATA\n");
434 ret = smsc95xx_wait_eeprom(dev);
438 for (i = 0; i < length; i++) {
440 /* Fill data register */
442 ret = smsc95xx_write_reg(dev, E2P_DATA, val);
444 netdev_warn(dev->net, "Error writing E2P_DATA\n");
448 /* Send "write" command */
449 val = E2P_CMD_BUSY_ | E2P_CMD_WRITE_ | (offset & E2P_CMD_ADDR_);
450 ret = smsc95xx_write_reg(dev, E2P_CMD, val);
452 netdev_warn(dev->net, "Error writing E2P_CMD\n");
456 ret = smsc95xx_wait_eeprom(dev);
466 static int __must_check smsc95xx_write_reg_async(struct usbnet *dev, u16 index,
476 ret = usbnet_write_cmd_async(dev, USB_VENDOR_REQUEST_WRITE_REGISTER,
477 USB_DIR_OUT | USB_TYPE_VENDOR |
479 0, index, &buf, size);
481 netdev_warn(dev->net, "Error write async cmd, sts=%d\n",
486 /* returns hash bit number for given MAC address
488 * 01 00 5E 00 00 01 -> returns bit number 31 */
489 static unsigned int smsc95xx_hash(char addr[ETH_ALEN])
491 return (ether_crc(ETH_ALEN, addr) >> 26) & 0x3f;
494 static void smsc95xx_set_multicast(struct net_device *netdev)
496 struct usbnet *dev = netdev_priv(netdev);
497 struct smsc95xx_priv *pdata = dev->driver_priv;
504 spin_lock_irqsave(&pdata->mac_cr_lock, flags);
506 if (dev->net->flags & IFF_PROMISC) {
507 netif_dbg(dev, drv, dev->net, "promiscuous mode enabled\n");
508 pdata->mac_cr |= MAC_CR_PRMS_;
509 pdata->mac_cr &= ~(MAC_CR_MCPAS_ | MAC_CR_HPFILT_);
510 } else if (dev->net->flags & IFF_ALLMULTI) {
511 netif_dbg(dev, drv, dev->net, "receive all multicast enabled\n");
512 pdata->mac_cr |= MAC_CR_MCPAS_;
513 pdata->mac_cr &= ~(MAC_CR_PRMS_ | MAC_CR_HPFILT_);
514 } else if (!netdev_mc_empty(dev->net)) {
515 struct netdev_hw_addr *ha;
517 pdata->mac_cr |= MAC_CR_HPFILT_;
518 pdata->mac_cr &= ~(MAC_CR_PRMS_ | MAC_CR_MCPAS_);
520 netdev_for_each_mc_addr(ha, netdev) {
521 u32 bitnum = smsc95xx_hash(ha->addr);
522 u32 mask = 0x01 << (bitnum & 0x1F);
524 pdata->hash_hi |= mask;
526 pdata->hash_lo |= mask;
529 netif_dbg(dev, drv, dev->net, "HASHH=0x%08X, HASHL=0x%08X\n",
530 pdata->hash_hi, pdata->hash_lo);
532 netif_dbg(dev, drv, dev->net, "receive own packets only\n");
534 ~(MAC_CR_PRMS_ | MAC_CR_MCPAS_ | MAC_CR_HPFILT_);
537 spin_unlock_irqrestore(&pdata->mac_cr_lock, flags);
539 /* Initiate async writes, as we can't wait for completion here */
540 ret = smsc95xx_write_reg_async(dev, HASHH, pdata->hash_hi);
542 netdev_warn(dev->net, "failed to initiate async write to HASHH\n");
544 ret = smsc95xx_write_reg_async(dev, HASHL, pdata->hash_lo);
546 netdev_warn(dev->net, "failed to initiate async write to HASHL\n");
548 ret = smsc95xx_write_reg_async(dev, MAC_CR, pdata->mac_cr);
550 netdev_warn(dev->net, "failed to initiate async write to MAC_CR\n");
553 static int smsc95xx_phy_update_flowcontrol(struct usbnet *dev)
555 u32 flow = 0, afc_cfg;
556 struct smsc95xx_priv *pdata = dev->driver_priv;
557 bool tx_pause, rx_pause;
559 int ret = smsc95xx_read_reg(dev, AFC_CFG, &afc_cfg);
563 if (pdata->phydev->duplex == DUPLEX_FULL) {
564 phy_get_pause(pdata->phydev, &tx_pause, &rx_pause);
576 netif_dbg(dev, link, dev->net, "rx pause %s, tx pause %s\n",
577 rx_pause ? "enabled" : "disabled",
578 tx_pause ? "enabled" : "disabled");
580 netif_dbg(dev, link, dev->net, "half duplex\n");
584 ret = smsc95xx_write_reg(dev, FLOW, flow);
588 return smsc95xx_write_reg(dev, AFC_CFG, afc_cfg);
591 static void smsc95xx_mac_update_fullduplex(struct usbnet *dev)
593 struct smsc95xx_priv *pdata = dev->driver_priv;
597 spin_lock_irqsave(&pdata->mac_cr_lock, flags);
598 if (pdata->phydev->duplex != DUPLEX_FULL) {
599 pdata->mac_cr &= ~MAC_CR_FDPX_;
600 pdata->mac_cr |= MAC_CR_RCVOWN_;
602 pdata->mac_cr &= ~MAC_CR_RCVOWN_;
603 pdata->mac_cr |= MAC_CR_FDPX_;
605 spin_unlock_irqrestore(&pdata->mac_cr_lock, flags);
607 ret = smsc95xx_write_reg(dev, MAC_CR, pdata->mac_cr);
610 netdev_warn(dev->net,
611 "Error updating MAC full duplex mode\n");
615 ret = smsc95xx_phy_update_flowcontrol(dev);
617 netdev_warn(dev->net, "Error updating PHY flow control\n");
620 static void smsc95xx_status(struct usbnet *dev, struct urb *urb)
622 struct smsc95xx_priv *pdata = dev->driver_priv;
626 if (urb->actual_length != 4) {
627 netdev_warn(dev->net, "unexpected urb length %d\n",
632 intdata = get_unaligned_le32(urb->transfer_buffer);
633 netif_dbg(dev, link, dev->net, "intdata: 0x%08X\n", intdata);
635 local_irq_save(flags);
637 if (intdata & INT_ENP_PHY_INT_)
638 generic_handle_domain_irq(pdata->irqdomain, PHY_HWIRQ);
640 netdev_warn(dev->net, "unexpected interrupt, intdata=0x%08X\n",
643 local_irq_restore(flags);
646 /* Enable or disable Tx & Rx checksum offload engines */
647 static int smsc95xx_set_features(struct net_device *netdev,
648 netdev_features_t features)
650 struct usbnet *dev = netdev_priv(netdev);
654 ret = smsc95xx_read_reg(dev, COE_CR, &read_buf);
658 if (features & NETIF_F_IP_CSUM)
659 read_buf |= Tx_COE_EN_;
661 read_buf &= ~Tx_COE_EN_;
663 if (features & NETIF_F_RXCSUM)
664 read_buf |= Rx_COE_EN_;
666 read_buf &= ~Rx_COE_EN_;
668 ret = smsc95xx_write_reg(dev, COE_CR, read_buf);
672 netif_dbg(dev, hw, dev->net, "COE_CR = 0x%08x\n", read_buf);
676 static int smsc95xx_ethtool_get_eeprom_len(struct net_device *net)
678 return MAX_EEPROM_SIZE;
681 static int smsc95xx_ethtool_get_eeprom(struct net_device *netdev,
682 struct ethtool_eeprom *ee, u8 *data)
684 struct usbnet *dev = netdev_priv(netdev);
686 ee->magic = LAN95XX_EEPROM_MAGIC;
688 return smsc95xx_read_eeprom(dev, ee->offset, ee->len, data);
691 static int smsc95xx_ethtool_set_eeprom(struct net_device *netdev,
692 struct ethtool_eeprom *ee, u8 *data)
694 struct usbnet *dev = netdev_priv(netdev);
696 if (ee->magic != LAN95XX_EEPROM_MAGIC) {
697 netdev_warn(dev->net, "EEPROM: magic value mismatch, magic = 0x%x\n",
702 return smsc95xx_write_eeprom(dev, ee->offset, ee->len, data);
705 static int smsc95xx_ethtool_getregslen(struct net_device *netdev)
707 /* all smsc95xx registers */
708 return COE_CR - ID_REV + sizeof(u32);
712 smsc95xx_ethtool_getregs(struct net_device *netdev, struct ethtool_regs *regs,
715 struct usbnet *dev = netdev_priv(netdev);
720 retval = smsc95xx_read_reg(dev, ID_REV, ®s->version);
722 netdev_warn(netdev, "REGS: cannot read ID_REV\n");
726 for (i = ID_REV, j = 0; i <= COE_CR; i += (sizeof(u32)), j++) {
727 retval = smsc95xx_read_reg(dev, i, &data[j]);
729 netdev_warn(netdev, "REGS: cannot read reg[%x]\n", i);
735 static void smsc95xx_ethtool_get_wol(struct net_device *net,
736 struct ethtool_wolinfo *wolinfo)
738 struct usbnet *dev = netdev_priv(net);
739 struct smsc95xx_priv *pdata = dev->driver_priv;
741 wolinfo->supported = SUPPORTED_WAKE;
742 wolinfo->wolopts = pdata->wolopts;
745 static int smsc95xx_ethtool_set_wol(struct net_device *net,
746 struct ethtool_wolinfo *wolinfo)
748 struct usbnet *dev = netdev_priv(net);
749 struct smsc95xx_priv *pdata = dev->driver_priv;
752 if (wolinfo->wolopts & ~SUPPORTED_WAKE)
755 pdata->wolopts = wolinfo->wolopts & SUPPORTED_WAKE;
757 ret = device_set_wakeup_enable(&dev->udev->dev, pdata->wolopts);
759 netdev_warn(dev->net, "device_set_wakeup_enable error %d\n", ret);
764 static u32 smsc95xx_get_link(struct net_device *net)
766 phy_read_status(net->phydev);
767 return net->phydev->link;
770 static const struct ethtool_ops smsc95xx_ethtool_ops = {
771 .get_link = smsc95xx_get_link,
772 .nway_reset = phy_ethtool_nway_reset,
773 .get_drvinfo = usbnet_get_drvinfo,
774 .get_msglevel = usbnet_get_msglevel,
775 .set_msglevel = usbnet_set_msglevel,
776 .get_eeprom_len = smsc95xx_ethtool_get_eeprom_len,
777 .get_eeprom = smsc95xx_ethtool_get_eeprom,
778 .set_eeprom = smsc95xx_ethtool_set_eeprom,
779 .get_regs_len = smsc95xx_ethtool_getregslen,
780 .get_regs = smsc95xx_ethtool_getregs,
781 .get_wol = smsc95xx_ethtool_get_wol,
782 .set_wol = smsc95xx_ethtool_set_wol,
783 .get_link_ksettings = phy_ethtool_get_link_ksettings,
784 .set_link_ksettings = phy_ethtool_set_link_ksettings,
785 .get_ts_info = ethtool_op_get_ts_info,
788 static int smsc95xx_ioctl(struct net_device *netdev, struct ifreq *rq, int cmd)
790 if (!netif_running(netdev))
793 return phy_mii_ioctl(netdev->phydev, rq, cmd);
796 /* Check the macaddr module parameter for a MAC address */
797 static int smsc95xx_is_macaddr_param(struct usbnet *dev, u8 *dev_mac)
799 int i, j, got_num, num;
800 u8 mtbl[MAC_ADDR_LEN];
802 if (macaddr[0] == ':')
809 while (j < MAC_ADDR_LEN) {
810 if (macaddr[i] && macaddr[i] != ':') {
812 if ('0' <= macaddr[i] && macaddr[i] <= '9')
813 num = num * 16 + macaddr[i] - '0';
814 else if ('A' <= macaddr[i] && macaddr[i] <= 'F')
815 num = num * 16 + 10 + macaddr[i] - 'A';
816 else if ('a' <= macaddr[i] && macaddr[i] <= 'f')
817 num = num * 16 + 10 + macaddr[i] - 'a';
821 } else if (got_num == 2) {
822 mtbl[j++] = (u8) num;
831 if (j == MAC_ADDR_LEN) {
832 netif_dbg(dev, ifup, dev->net, "Overriding MAC address with: "
833 "%02x:%02x:%02x:%02x:%02x:%02x\n", mtbl[0], mtbl[1], mtbl[2],
834 mtbl[3], mtbl[4], mtbl[5]);
835 for (i = 0; i < MAC_ADDR_LEN; i++)
836 dev_mac[i] = mtbl[i];
843 static void smsc95xx_init_mac_address(struct usbnet *dev)
845 /* maybe the boot loader passed the MAC address in devicetree */
846 if (!eth_platform_get_mac_address(&dev->udev->dev,
847 dev->net->dev_addr)) {
848 if (is_valid_ether_addr(dev->net->dev_addr)) {
849 /* device tree values are valid so use them */
850 netif_dbg(dev, ifup, dev->net, "MAC address read from the device tree\n");
855 /* try reading mac address from EEPROM */
856 if (smsc95xx_read_eeprom(dev, EEPROM_MAC_OFFSET, ETH_ALEN,
857 dev->net->dev_addr) == 0) {
858 if (is_valid_ether_addr(dev->net->dev_addr)) {
859 /* eeprom values are valid so use them */
860 netif_dbg(dev, ifup, dev->net, "MAC address read from EEPROM\n");
865 /* Check module parameters */
866 if (smsc95xx_is_macaddr_param(dev, dev->net->dev_addr))
869 /* no useful static MAC address found. generate a random one */
870 eth_hw_addr_random(dev->net);
871 netif_dbg(dev, ifup, dev->net, "MAC address set to eth_random_addr\n");
874 static int smsc95xx_set_mac_address(struct usbnet *dev)
876 u32 addr_lo = dev->net->dev_addr[0] | dev->net->dev_addr[1] << 8 |
877 dev->net->dev_addr[2] << 16 | dev->net->dev_addr[3] << 24;
878 u32 addr_hi = dev->net->dev_addr[4] | dev->net->dev_addr[5] << 8;
881 ret = smsc95xx_write_reg(dev, ADDRL, addr_lo);
885 return smsc95xx_write_reg(dev, ADDRH, addr_hi);
888 /* starts the TX path */
889 static int smsc95xx_start_tx_path(struct usbnet *dev)
891 struct smsc95xx_priv *pdata = dev->driver_priv;
895 /* Enable Tx at MAC */
896 spin_lock_irqsave(&pdata->mac_cr_lock, flags);
897 pdata->mac_cr |= MAC_CR_TXEN_;
898 spin_unlock_irqrestore(&pdata->mac_cr_lock, flags);
900 ret = smsc95xx_write_reg(dev, MAC_CR, pdata->mac_cr);
904 /* Enable Tx at SCSRs */
905 return smsc95xx_write_reg(dev, TX_CFG, TX_CFG_ON_);
908 /* Starts the Receive path */
909 static int smsc95xx_start_rx_path(struct usbnet *dev, int in_pm)
911 struct smsc95xx_priv *pdata = dev->driver_priv;
914 spin_lock_irqsave(&pdata->mac_cr_lock, flags);
915 pdata->mac_cr |= MAC_CR_RXEN_;
916 spin_unlock_irqrestore(&pdata->mac_cr_lock, flags);
918 return __smsc95xx_write_reg(dev, MAC_CR, pdata->mac_cr, in_pm);
921 static int smsc95xx_reset(struct usbnet *dev)
923 struct smsc95xx_priv *pdata = dev->driver_priv;
924 u32 read_buf, write_buf, burst_cap;
925 int ret = 0, timeout;
927 netif_dbg(dev, ifup, dev->net, "entering smsc95xx_reset\n");
929 ret = smsc95xx_write_reg(dev, HW_CFG, HW_CFG_LRST_);
936 ret = smsc95xx_read_reg(dev, HW_CFG, &read_buf);
940 } while ((read_buf & HW_CFG_LRST_) && (timeout < 100));
942 if (timeout >= 100) {
943 netdev_warn(dev->net, "timeout waiting for completion of Lite Reset\n");
947 ret = smsc95xx_write_reg(dev, PM_CTRL, PM_CTL_PHY_RST_);
954 ret = smsc95xx_read_reg(dev, PM_CTRL, &read_buf);
958 } while ((read_buf & PM_CTL_PHY_RST_) && (timeout < 100));
960 if (timeout >= 100) {
961 netdev_warn(dev->net, "timeout waiting for PHY Reset\n");
965 ret = smsc95xx_set_mac_address(dev);
969 netif_dbg(dev, ifup, dev->net, "MAC Address: %pM\n",
972 ret = smsc95xx_read_reg(dev, HW_CFG, &read_buf);
976 netif_dbg(dev, ifup, dev->net, "Read Value from HW_CFG : 0x%08x\n",
979 read_buf |= HW_CFG_BIR_;
981 ret = smsc95xx_write_reg(dev, HW_CFG, read_buf);
985 ret = smsc95xx_read_reg(dev, HW_CFG, &read_buf);
989 netif_dbg(dev, ifup, dev->net,
990 "Read Value from HW_CFG after writing HW_CFG_BIR_: 0x%08x\n",
995 dev->rx_urb_size = packetsize ? packetsize : MAX_SINGLE_PACKET_SIZE;
996 } else if (dev->udev->speed == USB_SPEED_HIGH) {
997 dev->rx_urb_size = packetsize ? packetsize : DEFAULT_HS_BURST_CAP_SIZE;
998 burst_cap = dev->rx_urb_size / HS_USB_PKT_SIZE;
1000 dev->rx_urb_size = packetsize ? packetsize : DEFAULT_FS_BURST_CAP_SIZE;
1001 burst_cap = dev->rx_urb_size / FS_USB_PKT_SIZE;
1004 netif_dbg(dev, ifup, dev->net, "rx_urb_size=%ld\n",
1005 (ulong)dev->rx_urb_size);
1007 ret = smsc95xx_write_reg(dev, BURST_CAP, burst_cap);
1011 ret = smsc95xx_read_reg(dev, BURST_CAP, &read_buf);
1015 netif_dbg(dev, ifup, dev->net,
1016 "Read Value from BURST_CAP after writing: 0x%08x\n",
1019 ret = smsc95xx_write_reg(dev, BULK_IN_DLY, DEFAULT_BULK_IN_DELAY);
1023 ret = smsc95xx_read_reg(dev, BULK_IN_DLY, &read_buf);
1027 netif_dbg(dev, ifup, dev->net,
1028 "Read Value from BULK_IN_DLY after writing: 0x%08x\n",
1031 ret = smsc95xx_read_reg(dev, HW_CFG, &read_buf);
1035 netif_dbg(dev, ifup, dev->net, "Read Value from HW_CFG: 0x%08x\n",
1039 read_buf |= (HW_CFG_MEF_ | HW_CFG_BCE_);
1041 read_buf &= ~HW_CFG_RXDOFF_;
1043 /* set Rx data offset=2, Make IP header aligns on word boundary. */
1044 read_buf |= NET_IP_ALIGN << 9;
1046 ret = smsc95xx_write_reg(dev, HW_CFG, read_buf);
1050 ret = smsc95xx_read_reg(dev, HW_CFG, &read_buf);
1054 netif_dbg(dev, ifup, dev->net,
1055 "Read Value from HW_CFG after writing: 0x%08x\n", read_buf);
1057 ret = smsc95xx_write_reg(dev, INT_STS, INT_STS_CLEAR_ALL_);
1061 ret = smsc95xx_read_reg(dev, ID_REV, &read_buf);
1064 netif_dbg(dev, ifup, dev->net, "ID_REV = 0x%08x\n", read_buf);
1066 /* Configure GPIO pins as LED outputs */
1067 write_buf = LED_GPIO_CFG_SPD_LED | LED_GPIO_CFG_LNK_LED |
1068 LED_GPIO_CFG_FDX_LED;
1069 ret = smsc95xx_write_reg(dev, LED_GPIO_CFG, write_buf);
1074 ret = smsc95xx_write_reg(dev, FLOW, 0);
1078 ret = smsc95xx_write_reg(dev, AFC_CFG, AFC_CFG_DEFAULT);
1082 /* Don't need mac_cr_lock during initialisation */
1083 ret = smsc95xx_read_reg(dev, MAC_CR, &pdata->mac_cr);
1089 ret = smsc95xx_write_reg(dev, VLAN1, (u32)ETH_P_8021Q);
1093 /* Enable or disable checksum offload engines */
1094 ret = smsc95xx_set_features(dev->net, dev->net->features);
1096 netdev_warn(dev->net, "Failed to set checksum offload features\n");
1100 smsc95xx_set_multicast(dev->net);
1102 ret = smsc95xx_read_reg(dev, INT_EP_CTL, &read_buf);
1106 /* enable PHY interrupts */
1107 read_buf |= INT_EP_CTL_PHY_INT_;
1109 ret = smsc95xx_write_reg(dev, INT_EP_CTL, read_buf);
1113 ret = smsc95xx_start_tx_path(dev);
1115 netdev_warn(dev->net, "Failed to start TX path\n");
1119 ret = smsc95xx_start_rx_path(dev, 0);
1121 netdev_warn(dev->net, "Failed to start RX path\n");
1125 netif_dbg(dev, ifup, dev->net, "smsc95xx_reset, return 0\n");
1129 static const struct net_device_ops smsc95xx_netdev_ops = {
1130 .ndo_open = usbnet_open,
1131 .ndo_stop = usbnet_stop,
1132 .ndo_start_xmit = usbnet_start_xmit,
1133 .ndo_tx_timeout = usbnet_tx_timeout,
1134 .ndo_change_mtu = usbnet_change_mtu,
1135 .ndo_get_stats64 = dev_get_tstats64,
1136 .ndo_set_mac_address = eth_mac_addr,
1137 .ndo_validate_addr = eth_validate_addr,
1138 .ndo_eth_ioctl = smsc95xx_ioctl,
1139 .ndo_set_rx_mode = smsc95xx_set_multicast,
1140 .ndo_set_features = smsc95xx_set_features,
1143 static void smsc95xx_handle_link_change(struct net_device *net)
1145 struct usbnet *dev = netdev_priv(net);
1147 phy_print_status(net->phydev);
1148 smsc95xx_mac_update_fullduplex(dev);
1149 usbnet_defer_kevent(dev, EVENT_LINK_CHANGE);
1152 static int smsc95xx_bind(struct usbnet *dev, struct usb_interface *intf)
1154 struct smsc95xx_priv *pdata;
1155 bool is_internal_phy;
1160 printk(KERN_INFO SMSC_CHIPNAME " v" SMSC_DRIVER_VERSION "\n");
1162 ret = usbnet_get_endpoints(dev, intf);
1164 netdev_warn(dev->net, "usbnet_get_endpoints failed: %d\n", ret);
1168 pdata = kzalloc(sizeof(*pdata), GFP_KERNEL);
1172 dev->driver_priv = pdata;
1174 spin_lock_init(&pdata->mac_cr_lock);
1176 /* LAN95xx devices do not alter the computed checksum of 0 to 0xffff.
1177 * RFC 2460, ipv6 UDP calculated checksum yields a result of zero must
1178 * be changed to 0xffff. RFC 768, ipv4 UDP computed checksum is zero,
1179 * it is transmitted as all ones. The zero transmitted checksum means
1180 * transmitter generated no checksum. Hence, enable csum offload only
1183 if (DEFAULT_TX_CSUM_ENABLE)
1184 dev->net->features |= NETIF_F_IP_CSUM;
1185 if (DEFAULT_RX_CSUM_ENABLE)
1186 dev->net->features |= NETIF_F_RXCSUM;
1188 dev->net->hw_features = NETIF_F_IP_CSUM | NETIF_F_RXCSUM;
1189 set_bit(EVENT_NO_IP_ALIGN, &dev->flags);
1191 smsc95xx_init_mac_address(dev);
1193 /* Init all registers */
1194 ret = smsc95xx_reset(dev);
1198 /* create irq domain for use by PHY driver and GPIO consumers */
1199 usb_make_path(dev->udev, usb_path, sizeof(usb_path));
1200 pdata->irqfwnode = irq_domain_alloc_named_fwnode(usb_path);
1201 if (!pdata->irqfwnode) {
1206 pdata->irqdomain = irq_domain_create_linear(pdata->irqfwnode,
1208 &irq_domain_simple_ops,
1210 if (!pdata->irqdomain) {
1212 goto free_irqfwnode;
1215 phy_irq = irq_create_mapping(pdata->irqdomain, PHY_HWIRQ);
1218 goto remove_irqdomain;
1221 pdata->irqchip = dummy_irq_chip;
1222 pdata->irqchip.name = SMSC_CHIPNAME;
1223 irq_set_chip_and_handler_name(phy_irq, &pdata->irqchip,
1224 handle_simple_irq, "phy");
1226 pdata->mdiobus = mdiobus_alloc();
1227 if (!pdata->mdiobus) {
1232 ret = smsc95xx_read_reg(dev, HW_CFG, &val);
1236 is_internal_phy = !(val & HW_CFG_PSEL_);
1237 if (is_internal_phy)
1238 pdata->mdiobus->phy_mask = ~(1u << SMSC95XX_INTERNAL_PHY_ID);
1240 pdata->mdiobus->priv = dev;
1241 pdata->mdiobus->read = smsc95xx_mdiobus_read;
1242 pdata->mdiobus->write = smsc95xx_mdiobus_write;
1243 pdata->mdiobus->name = "smsc95xx-mdiobus";
1244 pdata->mdiobus->parent = &dev->udev->dev;
1246 snprintf(pdata->mdiobus->id, ARRAY_SIZE(pdata->mdiobus->id),
1247 "usb-%03d:%03d", dev->udev->bus->busnum, dev->udev->devnum);
1249 ret = mdiobus_register(pdata->mdiobus);
1251 netdev_err(dev->net, "Could not register MDIO bus\n");
1255 pdata->phydev = phy_find_first(pdata->mdiobus);
1256 if (!pdata->phydev) {
1257 netdev_err(dev->net, "no PHY found\n");
1259 goto unregister_mdio;
1262 pdata->phydev->irq = phy_irq;
1263 pdata->phydev->is_internal = is_internal_phy;
1265 /* detect device revision as different features may be available */
1266 ret = smsc95xx_read_reg(dev, ID_REV, &val);
1268 goto unregister_mdio;
1271 if ((val == ID_REV_CHIP_ID_9500A_) || (val == ID_REV_CHIP_ID_9530_) ||
1272 (val == ID_REV_CHIP_ID_89530_) || (val == ID_REV_CHIP_ID_9730_))
1273 pdata->features = (FEATURE_8_WAKEUP_FILTERS |
1274 FEATURE_PHY_NLP_CROSSOVER |
1275 FEATURE_REMOTE_WAKEUP);
1276 else if (val == ID_REV_CHIP_ID_9512_)
1277 pdata->features = FEATURE_8_WAKEUP_FILTERS;
1279 dev->net->netdev_ops = &smsc95xx_netdev_ops;
1280 dev->net->ethtool_ops = &smsc95xx_ethtool_ops;
1281 dev->net->flags |= IFF_MULTICAST;
1282 dev->net->hard_header_len += SMSC95XX_TX_OVERHEAD_CSUM;
1283 dev->net->min_mtu = ETH_MIN_MTU;
1284 dev->net->max_mtu = ETH_DATA_LEN;
1285 dev->hard_mtu = dev->net->mtu + dev->net->hard_header_len;
1287 ret = phy_connect_direct(dev->net, pdata->phydev,
1288 &smsc95xx_handle_link_change,
1289 PHY_INTERFACE_MODE_MII);
1291 netdev_err(dev->net, "can't attach PHY to %s\n", pdata->mdiobus->id);
1292 goto unregister_mdio;
1295 phy_attached_info(dev->net->phydev);
1300 mdiobus_unregister(pdata->mdiobus);
1303 mdiobus_free(pdata->mdiobus);
1306 irq_dispose_mapping(phy_irq);
1309 irq_domain_remove(pdata->irqdomain);
1312 irq_domain_free_fwnode(pdata->irqfwnode);
1319 static void smsc95xx_unbind(struct usbnet *dev, struct usb_interface *intf)
1321 struct smsc95xx_priv *pdata = dev->driver_priv;
1323 phy_disconnect(dev->net->phydev);
1324 mdiobus_unregister(pdata->mdiobus);
1325 mdiobus_free(pdata->mdiobus);
1326 irq_dispose_mapping(irq_find_mapping(pdata->irqdomain, PHY_HWIRQ));
1327 irq_domain_remove(pdata->irqdomain);
1328 irq_domain_free_fwnode(pdata->irqfwnode);
1329 netif_dbg(dev, ifdown, dev->net, "free pdata\n");
1333 static int smsc95xx_start_phy(struct usbnet *dev)
1335 phy_start(dev->net->phydev);
1340 static int smsc95xx_stop(struct usbnet *dev)
1342 phy_stop(dev->net->phydev);
1347 static u32 smsc_crc(const u8 *buffer, size_t len, int filter)
1349 u32 crc = bitrev16(crc16(0xFFFF, buffer, len));
1350 return crc << ((filter % 2) * 16);
1353 static int smsc95xx_link_ok_nopm(struct usbnet *dev)
1357 /* first, a dummy read, needed to latch some MII phys */
1358 ret = smsc95xx_mdio_read_nopm(dev, MII_BMSR);
1362 ret = smsc95xx_mdio_read_nopm(dev, MII_BMSR);
1366 return !!(ret & BMSR_LSTATUS);
1369 static int smsc95xx_enter_suspend0(struct usbnet *dev)
1371 struct smsc95xx_priv *pdata = dev->driver_priv;
1375 ret = smsc95xx_read_reg_nopm(dev, PM_CTRL, &val);
1379 val &= (~(PM_CTL_SUS_MODE_ | PM_CTL_WUPS_ | PM_CTL_PHY_RST_));
1380 val |= PM_CTL_SUS_MODE_0;
1382 ret = smsc95xx_write_reg_nopm(dev, PM_CTRL, val);
1386 /* clear wol status */
1387 val &= ~PM_CTL_WUPS_;
1388 val |= PM_CTL_WUPS_WOL_;
1390 /* enable energy detection */
1391 if (pdata->wolopts & WAKE_PHY)
1392 val |= PM_CTL_WUPS_ED_;
1394 ret = smsc95xx_write_reg_nopm(dev, PM_CTRL, val);
1398 /* read back PM_CTRL */
1399 ret = smsc95xx_read_reg_nopm(dev, PM_CTRL, &val);
1403 pdata->suspend_flags |= SUSPEND_SUSPEND0;
1408 static int smsc95xx_enter_suspend1(struct usbnet *dev)
1410 struct smsc95xx_priv *pdata = dev->driver_priv;
1414 /* reconfigure link pulse detection timing for
1415 * compatibility with non-standard link partners
1417 if (pdata->features & FEATURE_PHY_NLP_CROSSOVER)
1418 smsc95xx_mdio_write_nopm(dev, PHY_EDPD_CONFIG,
1419 PHY_EDPD_CONFIG_DEFAULT);
1421 /* enable energy detect power-down mode */
1422 ret = smsc95xx_mdio_read_nopm(dev, PHY_MODE_CTRL_STS);
1426 ret |= MODE_CTRL_STS_EDPWRDOWN_;
1428 smsc95xx_mdio_write_nopm(dev, PHY_MODE_CTRL_STS, ret);
1430 /* enter SUSPEND1 mode */
1431 ret = smsc95xx_read_reg_nopm(dev, PM_CTRL, &val);
1435 val &= ~(PM_CTL_SUS_MODE_ | PM_CTL_WUPS_ | PM_CTL_PHY_RST_);
1436 val |= PM_CTL_SUS_MODE_1;
1438 ret = smsc95xx_write_reg_nopm(dev, PM_CTRL, val);
1442 /* clear wol status, enable energy detection */
1443 val &= ~PM_CTL_WUPS_;
1444 val |= (PM_CTL_WUPS_ED_ | PM_CTL_ED_EN_);
1446 ret = smsc95xx_write_reg_nopm(dev, PM_CTRL, val);
1450 pdata->suspend_flags |= SUSPEND_SUSPEND1;
1455 static int smsc95xx_enter_suspend2(struct usbnet *dev)
1457 struct smsc95xx_priv *pdata = dev->driver_priv;
1461 ret = smsc95xx_read_reg_nopm(dev, PM_CTRL, &val);
1465 val &= ~(PM_CTL_SUS_MODE_ | PM_CTL_WUPS_ | PM_CTL_PHY_RST_);
1466 val |= PM_CTL_SUS_MODE_2;
1468 ret = smsc95xx_write_reg_nopm(dev, PM_CTRL, val);
1472 pdata->suspend_flags |= SUSPEND_SUSPEND2;
1477 static int smsc95xx_enter_suspend3(struct usbnet *dev)
1479 struct smsc95xx_priv *pdata = dev->driver_priv;
1483 ret = smsc95xx_read_reg_nopm(dev, RX_FIFO_INF, &val);
1487 if (val & RX_FIFO_INF_USED_) {
1488 netdev_info(dev->net, "rx fifo not empty in autosuspend\n");
1492 ret = smsc95xx_read_reg_nopm(dev, PM_CTRL, &val);
1496 val &= ~(PM_CTL_SUS_MODE_ | PM_CTL_WUPS_ | PM_CTL_PHY_RST_);
1497 val |= PM_CTL_SUS_MODE_3 | PM_CTL_RES_CLR_WKP_STS;
1499 ret = smsc95xx_write_reg_nopm(dev, PM_CTRL, val);
1503 /* clear wol status */
1504 val &= ~PM_CTL_WUPS_;
1505 val |= PM_CTL_WUPS_WOL_;
1507 ret = smsc95xx_write_reg_nopm(dev, PM_CTRL, val);
1511 pdata->suspend_flags |= SUSPEND_SUSPEND3;
1516 static int smsc95xx_autosuspend(struct usbnet *dev, u32 link_up)
1518 struct smsc95xx_priv *pdata = dev->driver_priv;
1520 if (!netif_running(dev->net)) {
1521 /* interface is ifconfig down so fully power down hw */
1522 netdev_dbg(dev->net, "autosuspend entering SUSPEND2\n");
1523 return smsc95xx_enter_suspend2(dev);
1527 /* link is down so enter EDPD mode, but only if device can
1528 * reliably resume from it. This check should be redundant
1529 * as current FEATURE_REMOTE_WAKEUP parts also support
1530 * FEATURE_PHY_NLP_CROSSOVER but it's included for clarity */
1531 if (!(pdata->features & FEATURE_PHY_NLP_CROSSOVER)) {
1532 netdev_warn(dev->net, "EDPD not supported\n");
1536 netdev_dbg(dev->net, "autosuspend entering SUSPEND1\n");
1537 netdev_info(dev->net, "entering SUSPEND1 mode\n");
1538 return smsc95xx_enter_suspend1(dev);
1541 netdev_dbg(dev->net, "autosuspend entering SUSPEND3\n");
1542 return smsc95xx_enter_suspend3(dev);
1545 static int smsc95xx_suspend(struct usb_interface *intf, pm_message_t message)
1547 struct usbnet *dev = usb_get_intfdata(intf);
1548 struct smsc95xx_priv *pdata = dev->driver_priv;
1552 pdata->pm_task = current;
1554 ret = usbnet_suspend(intf, message);
1556 netdev_warn(dev->net, "usbnet_suspend error\n");
1557 pdata->pm_task = NULL;
1561 if (pdata->suspend_flags) {
1562 netdev_warn(dev->net, "error during last resume\n");
1563 pdata->suspend_flags = 0;
1566 /* determine if link is up using only _nopm functions */
1567 link_up = smsc95xx_link_ok_nopm(dev);
1569 if (message.event == PM_EVENT_AUTO_SUSPEND &&
1570 (pdata->features & FEATURE_REMOTE_WAKEUP)) {
1571 ret = smsc95xx_autosuspend(dev, link_up);
1575 /* if we get this far we're not autosuspending */
1576 /* if no wol options set, or if link is down and we're not waking on
1577 * PHY activity, enter lowest power SUSPEND2 mode
1579 if (!(pdata->wolopts & SUPPORTED_WAKE) ||
1580 !(link_up || (pdata->wolopts & WAKE_PHY))) {
1581 netdev_info(dev->net, "entering SUSPEND2 mode\n");
1583 /* disable energy detect (link up) & wake up events */
1584 ret = smsc95xx_read_reg_nopm(dev, WUCSR, &val);
1588 val &= ~(WUCSR_MPEN_ | WUCSR_WAKE_EN_);
1590 ret = smsc95xx_write_reg_nopm(dev, WUCSR, val);
1594 ret = smsc95xx_read_reg_nopm(dev, PM_CTRL, &val);
1598 val &= ~(PM_CTL_ED_EN_ | PM_CTL_WOL_EN_);
1600 ret = smsc95xx_write_reg_nopm(dev, PM_CTRL, val);
1604 ret = smsc95xx_enter_suspend2(dev);
1608 if (pdata->wolopts & WAKE_PHY) {
1609 /* if link is down then configure EDPD and enter SUSPEND1,
1610 * otherwise enter SUSPEND0 below
1613 netdev_info(dev->net, "entering SUSPEND1 mode\n");
1614 ret = smsc95xx_enter_suspend1(dev);
1619 if (pdata->wolopts & (WAKE_BCAST | WAKE_MCAST | WAKE_ARP | WAKE_UCAST)) {
1620 u32 *filter_mask = kcalloc(32, sizeof(u32), GFP_KERNEL);
1624 int wuff_filter_count =
1625 (pdata->features & FEATURE_8_WAKEUP_FILTERS) ?
1626 LAN9500A_WUFF_NUM : LAN9500_WUFF_NUM;
1630 netdev_warn(dev->net, "Unable to allocate filter_mask\n");
1635 memset(command, 0, sizeof(command));
1636 memset(offset, 0, sizeof(offset));
1637 memset(crc, 0, sizeof(crc));
1639 if (pdata->wolopts & WAKE_BCAST) {
1640 const u8 bcast[] = {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF};
1641 netdev_info(dev->net, "enabling broadcast detection\n");
1642 filter_mask[filter * 4] = 0x003F;
1643 filter_mask[filter * 4 + 1] = 0x00;
1644 filter_mask[filter * 4 + 2] = 0x00;
1645 filter_mask[filter * 4 + 3] = 0x00;
1646 command[filter/4] |= 0x05UL << ((filter % 4) * 8);
1647 offset[filter/4] |= 0x00 << ((filter % 4) * 8);
1648 crc[filter/2] |= smsc_crc(bcast, 6, filter);
1652 if (pdata->wolopts & WAKE_MCAST) {
1653 const u8 mcast[] = {0x01, 0x00, 0x5E};
1654 netdev_info(dev->net, "enabling multicast detection\n");
1655 filter_mask[filter * 4] = 0x0007;
1656 filter_mask[filter * 4 + 1] = 0x00;
1657 filter_mask[filter * 4 + 2] = 0x00;
1658 filter_mask[filter * 4 + 3] = 0x00;
1659 command[filter/4] |= 0x09UL << ((filter % 4) * 8);
1660 offset[filter/4] |= 0x00 << ((filter % 4) * 8);
1661 crc[filter/2] |= smsc_crc(mcast, 3, filter);
1665 if (pdata->wolopts & WAKE_ARP) {
1666 const u8 arp[] = {0x08, 0x06};
1667 netdev_info(dev->net, "enabling ARP detection\n");
1668 filter_mask[filter * 4] = 0x0003;
1669 filter_mask[filter * 4 + 1] = 0x00;
1670 filter_mask[filter * 4 + 2] = 0x00;
1671 filter_mask[filter * 4 + 3] = 0x00;
1672 command[filter/4] |= 0x05UL << ((filter % 4) * 8);
1673 offset[filter/4] |= 0x0C << ((filter % 4) * 8);
1674 crc[filter/2] |= smsc_crc(arp, 2, filter);
1678 if (pdata->wolopts & WAKE_UCAST) {
1679 netdev_info(dev->net, "enabling unicast detection\n");
1680 filter_mask[filter * 4] = 0x003F;
1681 filter_mask[filter * 4 + 1] = 0x00;
1682 filter_mask[filter * 4 + 2] = 0x00;
1683 filter_mask[filter * 4 + 3] = 0x00;
1684 command[filter/4] |= 0x01UL << ((filter % 4) * 8);
1685 offset[filter/4] |= 0x00 << ((filter % 4) * 8);
1686 crc[filter/2] |= smsc_crc(dev->net->dev_addr, ETH_ALEN, filter);
1690 for (i = 0; i < (wuff_filter_count * 4); i++) {
1691 ret = smsc95xx_write_reg_nopm(dev, WUFF, filter_mask[i]);
1699 for (i = 0; i < (wuff_filter_count / 4); i++) {
1700 ret = smsc95xx_write_reg_nopm(dev, WUFF, command[i]);
1705 for (i = 0; i < (wuff_filter_count / 4); i++) {
1706 ret = smsc95xx_write_reg_nopm(dev, WUFF, offset[i]);
1711 for (i = 0; i < (wuff_filter_count / 2); i++) {
1712 ret = smsc95xx_write_reg_nopm(dev, WUFF, crc[i]);
1717 /* clear any pending pattern match packet status */
1718 ret = smsc95xx_read_reg_nopm(dev, WUCSR, &val);
1724 ret = smsc95xx_write_reg_nopm(dev, WUCSR, val);
1729 if (pdata->wolopts & WAKE_MAGIC) {
1730 /* clear any pending magic packet status */
1731 ret = smsc95xx_read_reg_nopm(dev, WUCSR, &val);
1737 ret = smsc95xx_write_reg_nopm(dev, WUCSR, val);
1742 /* enable/disable wakeup sources */
1743 ret = smsc95xx_read_reg_nopm(dev, WUCSR, &val);
1747 if (pdata->wolopts & (WAKE_BCAST | WAKE_MCAST | WAKE_ARP | WAKE_UCAST)) {
1748 netdev_info(dev->net, "enabling pattern match wakeup\n");
1749 val |= WUCSR_WAKE_EN_;
1751 netdev_info(dev->net, "disabling pattern match wakeup\n");
1752 val &= ~WUCSR_WAKE_EN_;
1755 if (pdata->wolopts & WAKE_MAGIC) {
1756 netdev_info(dev->net, "enabling magic packet wakeup\n");
1759 netdev_info(dev->net, "disabling magic packet wakeup\n");
1760 val &= ~WUCSR_MPEN_;
1763 ret = smsc95xx_write_reg_nopm(dev, WUCSR, val);
1767 /* enable wol wakeup source */
1768 ret = smsc95xx_read_reg_nopm(dev, PM_CTRL, &val);
1772 val |= PM_CTL_WOL_EN_;
1774 /* phy energy detect wakeup source */
1775 if (pdata->wolopts & WAKE_PHY)
1776 val |= PM_CTL_ED_EN_;
1778 ret = smsc95xx_write_reg_nopm(dev, PM_CTRL, val);
1782 /* enable receiver to enable frame reception */
1783 smsc95xx_start_rx_path(dev, 1);
1785 /* some wol options are enabled, so enter SUSPEND0 */
1786 netdev_info(dev->net, "entering SUSPEND0 mode\n");
1787 ret = smsc95xx_enter_suspend0(dev);
1791 * TODO: resume() might need to handle the suspend failure
1794 if (ret && PMSG_IS_AUTO(message))
1795 usbnet_resume(intf);
1797 pdata->pm_task = NULL;
1801 static int smsc95xx_resume(struct usb_interface *intf)
1803 struct usbnet *dev = usb_get_intfdata(intf);
1804 struct smsc95xx_priv *pdata;
1810 pdata = dev->driver_priv;
1811 suspend_flags = pdata->suspend_flags;
1813 netdev_dbg(dev->net, "resume suspend_flags=0x%02x\n", suspend_flags);
1815 /* do this first to ensure it's cleared even in error case */
1816 pdata->suspend_flags = 0;
1818 pdata->pm_task = current;
1820 if (suspend_flags & SUSPEND_ALLMODES) {
1821 /* clear wake-up sources */
1822 ret = smsc95xx_read_reg_nopm(dev, WUCSR, &val);
1826 val &= ~(WUCSR_WAKE_EN_ | WUCSR_MPEN_);
1828 ret = smsc95xx_write_reg_nopm(dev, WUCSR, val);
1832 /* clear wake-up status */
1833 ret = smsc95xx_read_reg_nopm(dev, PM_CTRL, &val);
1837 val &= ~PM_CTL_WOL_EN_;
1838 val |= PM_CTL_WUPS_;
1840 ret = smsc95xx_write_reg_nopm(dev, PM_CTRL, val);
1845 phy_init_hw(pdata->phydev);
1847 ret = usbnet_resume(intf);
1849 netdev_warn(dev->net, "usbnet_resume error\n");
1852 pdata->pm_task = NULL;
1856 static int smsc95xx_reset_resume(struct usb_interface *intf)
1858 struct usbnet *dev = usb_get_intfdata(intf);
1859 struct smsc95xx_priv *pdata = dev->driver_priv;
1862 pdata->pm_task = current;
1863 ret = smsc95xx_reset(dev);
1864 pdata->pm_task = NULL;
1868 return smsc95xx_resume(intf);
1871 static void smsc95xx_rx_csum_offload(struct sk_buff *skb)
1873 skb->csum = *(u16 *)(skb_tail_pointer(skb) - 2);
1874 skb->ip_summed = CHECKSUM_COMPLETE;
1875 skb_trim(skb, skb->len - 2);
1878 static int smsc95xx_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
1880 /* This check is no longer done by usbnet */
1881 if (skb->len < dev->net->hard_header_len)
1884 while (skb->len > 0) {
1885 u32 header, align_count;
1886 struct sk_buff *ax_skb;
1887 unsigned char *packet;
1890 header = get_unaligned_le32(skb->data);
1891 skb_pull(skb, 4 + NET_IP_ALIGN);
1894 /* get the packet length */
1895 size = (u16)((header & RX_STS_FL_) >> 16);
1896 align_count = (4 - ((size + NET_IP_ALIGN) % 4)) % 4;
1898 if (unlikely(header & RX_STS_ES_)) {
1899 netif_dbg(dev, rx_err, dev->net,
1900 "Error header=0x%08x\n", header);
1901 dev->net->stats.rx_errors++;
1902 dev->net->stats.rx_dropped++;
1904 if (header & RX_STS_CRC_) {
1905 dev->net->stats.rx_crc_errors++;
1907 if (header & (RX_STS_TL_ | RX_STS_RF_))
1908 dev->net->stats.rx_frame_errors++;
1910 if ((header & RX_STS_LE_) &&
1911 (!(header & RX_STS_FT_)))
1912 dev->net->stats.rx_length_errors++;
1915 /* ETH_FRAME_LEN + 4(CRC) + 2(COE) + 4(Vlan) */
1916 if (unlikely(size > (ETH_FRAME_LEN + 12))) {
1917 netif_dbg(dev, rx_err, dev->net,
1918 "size err header=0x%08x\n", header);
1922 /* last frame in this batch */
1923 if (skb->len == size) {
1924 if (dev->net->features & NETIF_F_RXCSUM)
1925 smsc95xx_rx_csum_offload(skb);
1926 skb_trim(skb, skb->len - 4); /* remove fcs */
1928 skb->truesize = size + sizeof(struct sk_buff);
1933 ax_skb = skb_clone(skb, GFP_ATOMIC);
1934 if (unlikely(!ax_skb)) {
1935 netdev_warn(dev->net, "Error allocating skb\n");
1940 ax_skb->data = packet;
1941 skb_set_tail_pointer(ax_skb, size);
1943 if (dev->net->features & NETIF_F_RXCSUM)
1944 smsc95xx_rx_csum_offload(ax_skb);
1945 skb_trim(ax_skb, ax_skb->len - 4); /* remove fcs */
1947 ax_skb->truesize = size + sizeof(struct sk_buff);
1949 usbnet_skb_return(dev, ax_skb);
1952 skb_pull(skb, size);
1954 /* padding bytes before the next frame starts */
1956 skb_pull(skb, align_count);
1962 static u32 smsc95xx_calc_csum_preamble(struct sk_buff *skb)
1964 u16 low_16 = (u16)skb_checksum_start_offset(skb);
1965 u16 high_16 = low_16 + skb->csum_offset;
1966 return (high_16 << 16) | low_16;
1969 /* The TX CSUM won't work if the checksum lies in the last 4 bytes of the
1970 * transmission. This is fairly unlikely, only seems to trigger with some
1971 * short TCP ACK packets sent.
1973 * Note, this calculation should probably check for the alignment of the
1974 * data as well, but a straight check for csum being in the last four bytes
1975 * of the packet should be ok for now.
1977 static bool smsc95xx_can_tx_checksum(struct sk_buff *skb)
1979 unsigned int len = skb->len - skb_checksum_start_offset(skb);
1983 return skb->csum_offset < (len - (4 + 1));
1986 static struct sk_buff *smsc95xx_tx_fixup(struct usbnet *dev,
1987 struct sk_buff *skb, gfp_t flags)
1989 bool csum = skb->ip_summed == CHECKSUM_PARTIAL;
1990 int overhead = csum ? SMSC95XX_TX_OVERHEAD_CSUM : SMSC95XX_TX_OVERHEAD;
1991 u32 tx_cmd_a, tx_cmd_b;
1994 /* We do not advertise SG, so skbs should be already linearized */
1995 BUG_ON(skb_shinfo(skb)->nr_frags);
1997 /* Make writable and expand header space by overhead if required */
1998 if (skb_cow_head(skb, overhead)) {
1999 /* Must deallocate here as returning NULL to indicate error
2000 * means the skb won't be deallocated in the caller.
2002 dev_kfree_skb_any(skb);
2006 tx_cmd_b = (u32)skb->len;
2007 tx_cmd_a = tx_cmd_b | TX_CMD_A_FIRST_SEG_ | TX_CMD_A_LAST_SEG_;
2010 if (!smsc95xx_can_tx_checksum(skb)) {
2011 /* workaround - hardware tx checksum does not work
2012 * properly with extremely small packets */
2013 long csstart = skb_checksum_start_offset(skb);
2014 __wsum calc = csum_partial(skb->data + csstart,
2015 skb->len - csstart, 0);
2016 *((__sum16 *)(skb->data + csstart
2017 + skb->csum_offset)) = csum_fold(calc);
2021 u32 csum_preamble = smsc95xx_calc_csum_preamble(skb);
2022 ptr = skb_push(skb, 4);
2023 put_unaligned_le32(csum_preamble, ptr);
2027 tx_cmd_b |= TX_CMD_B_CSUM_ENABLE;
2031 ptr = skb_push(skb, 8);
2032 put_unaligned_le32(tx_cmd_a, ptr);
2033 put_unaligned_le32(tx_cmd_b, ptr+4);
2038 static int smsc95xx_manage_power(struct usbnet *dev, int on)
2040 struct smsc95xx_priv *pdata = dev->driver_priv;
2042 dev->intf->needs_remote_wakeup = on;
2044 if (pdata->features & FEATURE_REMOTE_WAKEUP)
2047 /* this chip revision isn't capable of remote wakeup */
2048 netdev_info(dev->net, "hardware isn't capable of remote wakeup\n");
2051 usb_autopm_get_interface_no_resume(dev->intf);
2053 usb_autopm_put_interface(dev->intf);
2058 static const struct driver_info smsc95xx_info = {
2059 .description = "smsc95xx USB 2.0 Ethernet",
2060 .bind = smsc95xx_bind,
2061 .unbind = smsc95xx_unbind,
2062 .reset = smsc95xx_reset,
2063 .check_connect = smsc95xx_start_phy,
2064 .stop = smsc95xx_stop,
2065 .rx_fixup = smsc95xx_rx_fixup,
2066 .tx_fixup = smsc95xx_tx_fixup,
2067 .status = smsc95xx_status,
2068 .manage_power = smsc95xx_manage_power,
2069 .flags = FLAG_ETHER | FLAG_SEND_ZLP | FLAG_LINK_INTR,
2072 static const struct usb_device_id products[] = {
2074 /* SMSC9500 USB Ethernet Device */
2075 USB_DEVICE(0x0424, 0x9500),
2076 .driver_info = (unsigned long) &smsc95xx_info,
2079 /* SMSC9505 USB Ethernet Device */
2080 USB_DEVICE(0x0424, 0x9505),
2081 .driver_info = (unsigned long) &smsc95xx_info,
2084 /* SMSC9500A USB Ethernet Device */
2085 USB_DEVICE(0x0424, 0x9E00),
2086 .driver_info = (unsigned long) &smsc95xx_info,
2089 /* SMSC9505A USB Ethernet Device */
2090 USB_DEVICE(0x0424, 0x9E01),
2091 .driver_info = (unsigned long) &smsc95xx_info,
2094 /* SMSC9512/9514 USB Hub & Ethernet Device */
2095 USB_DEVICE(0x0424, 0xec00),
2096 .driver_info = (unsigned long) &smsc95xx_info,
2099 /* SMSC9500 USB Ethernet Device (SAL10) */
2100 USB_DEVICE(0x0424, 0x9900),
2101 .driver_info = (unsigned long) &smsc95xx_info,
2104 /* SMSC9505 USB Ethernet Device (SAL10) */
2105 USB_DEVICE(0x0424, 0x9901),
2106 .driver_info = (unsigned long) &smsc95xx_info,
2109 /* SMSC9500A USB Ethernet Device (SAL10) */
2110 USB_DEVICE(0x0424, 0x9902),
2111 .driver_info = (unsigned long) &smsc95xx_info,
2114 /* SMSC9505A USB Ethernet Device (SAL10) */
2115 USB_DEVICE(0x0424, 0x9903),
2116 .driver_info = (unsigned long) &smsc95xx_info,
2119 /* SMSC9512/9514 USB Hub & Ethernet Device (SAL10) */
2120 USB_DEVICE(0x0424, 0x9904),
2121 .driver_info = (unsigned long) &smsc95xx_info,
2124 /* SMSC9500A USB Ethernet Device (HAL) */
2125 USB_DEVICE(0x0424, 0x9905),
2126 .driver_info = (unsigned long) &smsc95xx_info,
2129 /* SMSC9505A USB Ethernet Device (HAL) */
2130 USB_DEVICE(0x0424, 0x9906),
2131 .driver_info = (unsigned long) &smsc95xx_info,
2134 /* SMSC9500 USB Ethernet Device (Alternate ID) */
2135 USB_DEVICE(0x0424, 0x9907),
2136 .driver_info = (unsigned long) &smsc95xx_info,
2139 /* SMSC9500A USB Ethernet Device (Alternate ID) */
2140 USB_DEVICE(0x0424, 0x9908),
2141 .driver_info = (unsigned long) &smsc95xx_info,
2144 /* SMSC9512/9514 USB Hub & Ethernet Device (Alternate ID) */
2145 USB_DEVICE(0x0424, 0x9909),
2146 .driver_info = (unsigned long) &smsc95xx_info,
2149 /* SMSC LAN9530 USB Ethernet Device */
2150 USB_DEVICE(0x0424, 0x9530),
2151 .driver_info = (unsigned long) &smsc95xx_info,
2154 /* SMSC LAN9730 USB Ethernet Device */
2155 USB_DEVICE(0x0424, 0x9730),
2156 .driver_info = (unsigned long) &smsc95xx_info,
2159 /* SMSC LAN89530 USB Ethernet Device */
2160 USB_DEVICE(0x0424, 0x9E08),
2161 .driver_info = (unsigned long) &smsc95xx_info,
2165 MODULE_DEVICE_TABLE(usb, products);
2167 static struct usb_driver smsc95xx_driver = {
2169 .id_table = products,
2170 .probe = usbnet_probe,
2171 .suspend = smsc95xx_suspend,
2172 .resume = smsc95xx_resume,
2173 .reset_resume = smsc95xx_reset_resume,
2174 .disconnect = usbnet_disconnect,
2175 .disable_hub_initiated_lpm = 1,
2176 .supports_autosuspend = 1,
2179 module_usb_driver(smsc95xx_driver);
2181 MODULE_AUTHOR("Nancy Lin");
2182 MODULE_AUTHOR("Steve Glendinning <steve.glendinning@shawell.net>");
2183 MODULE_DESCRIPTION("SMSC95XX USB 2.0 Ethernet Devices");
2184 MODULE_LICENSE("GPL");