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/mdio.h>
22 #include <linux/phy.h>
25 #define SMSC_CHIPNAME "smsc95xx"
26 #define SMSC_DRIVER_VERSION "2.0.0"
27 #define HS_USB_PKT_SIZE (512)
28 #define FS_USB_PKT_SIZE (64)
29 #define DEFAULT_HS_BURST_CAP_SIZE (16 * 1024 + 5 * HS_USB_PKT_SIZE)
30 #define DEFAULT_FS_BURST_CAP_SIZE (6 * 1024 + 33 * FS_USB_PKT_SIZE)
31 #define DEFAULT_BULK_IN_DELAY (0x00002000)
32 #define MAX_SINGLE_PACKET_SIZE (2048)
33 #define LAN95XX_EEPROM_MAGIC (0x9500)
34 #define EEPROM_MAC_OFFSET (0x01)
35 #define DEFAULT_TX_CSUM_ENABLE (true)
36 #define DEFAULT_RX_CSUM_ENABLE (true)
37 #define SMSC95XX_INTERNAL_PHY_ID (1)
38 #define SMSC95XX_TX_OVERHEAD (8)
39 #define SMSC95XX_TX_OVERHEAD_CSUM (12)
40 #define SUPPORTED_WAKE (WAKE_PHY | WAKE_UCAST | WAKE_BCAST | \
41 WAKE_MCAST | WAKE_ARP | WAKE_MAGIC)
43 #define FEATURE_8_WAKEUP_FILTERS (0x01)
44 #define FEATURE_PHY_NLP_CROSSOVER (0x02)
45 #define FEATURE_REMOTE_WAKEUP (0x04)
47 #define SUSPEND_SUSPEND0 (0x01)
48 #define SUSPEND_SUSPEND1 (0x02)
49 #define SUSPEND_SUSPEND2 (0x04)
50 #define SUSPEND_SUSPEND3 (0x08)
51 #define SUSPEND_ALLMODES (SUSPEND_SUSPEND0 | SUSPEND_SUSPEND1 | \
52 SUSPEND_SUSPEND2 | SUSPEND_SUSPEND3)
53 #define MAC_ADDR_LEN (6)
55 struct smsc95xx_priv {
60 spinlock_t mac_cr_lock;
63 struct mii_bus *mdiobus;
64 struct phy_device *phydev;
67 static bool turbo_mode = true;
68 module_param(turbo_mode, bool, 0644);
69 MODULE_PARM_DESC(turbo_mode, "Enable multiple frames per Rx transaction");
71 static bool truesize_mode = false;
72 module_param(truesize_mode, bool, 0644);
73 MODULE_PARM_DESC(truesize_mode, "Report larger truesize value");
75 static int packetsize = 2560;
76 module_param(packetsize, int, 0644);
77 MODULE_PARM_DESC(packetsize, "Override the RX URB packet size");
79 static char *macaddr = ":";
80 module_param(macaddr, charp, 0);
81 MODULE_PARM_DESC(macaddr, "MAC address");
83 static int __must_check __smsc95xx_read_reg(struct usbnet *dev, u32 index,
88 int (*fn)(struct usbnet *, u8, u8, u16, u16, void *, u16);
95 fn = usbnet_read_cmd_nopm;
97 ret = fn(dev, USB_VENDOR_REQUEST_READ_REGISTER, USB_DIR_IN
98 | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
102 netdev_warn(dev->net, "Failed to read reg index 0x%08x: %d\n",
113 static int __must_check __smsc95xx_write_reg(struct usbnet *dev, u32 index,
118 int (*fn)(struct usbnet *, u8, u8, u16, u16, const void *, u16);
123 fn = usbnet_write_cmd;
125 fn = usbnet_write_cmd_nopm;
130 ret = fn(dev, USB_VENDOR_REQUEST_WRITE_REGISTER, USB_DIR_OUT
131 | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
133 if (ret < 0 && ret != -ENODEV)
134 netdev_warn(dev->net, "Failed to write reg index 0x%08x: %d\n",
140 static int __must_check smsc95xx_read_reg_nopm(struct usbnet *dev, u32 index,
143 return __smsc95xx_read_reg(dev, index, data, 1);
146 static int __must_check smsc95xx_write_reg_nopm(struct usbnet *dev, u32 index,
149 return __smsc95xx_write_reg(dev, index, data, 1);
152 static int __must_check smsc95xx_read_reg(struct usbnet *dev, u32 index,
155 return __smsc95xx_read_reg(dev, index, data, 0);
158 static int __must_check smsc95xx_write_reg(struct usbnet *dev, u32 index,
161 return __smsc95xx_write_reg(dev, index, data, 0);
164 /* Loop until the read is completed with timeout
165 * called with phy_mutex held */
166 static int __must_check __smsc95xx_phy_wait_not_busy(struct usbnet *dev,
169 unsigned long start_time = jiffies;
174 ret = __smsc95xx_read_reg(dev, MII_ADDR, &val, in_pm);
176 /* Ignore -ENODEV error during disconnect() */
179 netdev_warn(dev->net, "Error reading MII_ACCESS\n");
183 if (!(val & MII_BUSY_))
185 } while (!time_after(jiffies, start_time + HZ));
190 static u32 mii_address_cmd(int phy_id, int idx, u16 op)
192 return (phy_id & 0x1f) << 11 | (idx & 0x1f) << 6 | op;
195 static int __smsc95xx_mdio_read(struct usbnet *dev, int phy_id, int idx,
201 mutex_lock(&dev->phy_mutex);
203 /* confirm MII not busy */
204 ret = __smsc95xx_phy_wait_not_busy(dev, in_pm);
206 netdev_warn(dev->net, "%s: MII is busy\n", __func__);
210 /* set the address, index & direction (read from PHY) */
211 addr = mii_address_cmd(phy_id, idx, MII_READ_ | MII_BUSY_);
212 ret = __smsc95xx_write_reg(dev, MII_ADDR, addr, in_pm);
215 netdev_warn(dev->net, "Error writing MII_ADDR\n");
219 ret = __smsc95xx_phy_wait_not_busy(dev, in_pm);
221 netdev_warn(dev->net, "Timed out reading MII reg %02X\n", idx);
225 ret = __smsc95xx_read_reg(dev, MII_DATA, &val, in_pm);
228 netdev_warn(dev->net, "Error reading MII_DATA\n");
232 ret = (u16)(val & 0xFFFF);
235 mutex_unlock(&dev->phy_mutex);
237 /* Ignore -ENODEV error during disconnect() */
243 static void __smsc95xx_mdio_write(struct usbnet *dev, int phy_id,
244 int idx, int regval, int in_pm)
249 mutex_lock(&dev->phy_mutex);
251 /* confirm MII not busy */
252 ret = __smsc95xx_phy_wait_not_busy(dev, in_pm);
254 netdev_warn(dev->net, "%s: MII is busy\n", __func__);
259 ret = __smsc95xx_write_reg(dev, MII_DATA, val, in_pm);
262 netdev_warn(dev->net, "Error writing MII_DATA\n");
266 /* set the address, index & direction (write to PHY) */
267 addr = mii_address_cmd(phy_id, idx, MII_WRITE_ | MII_BUSY_);
268 ret = __smsc95xx_write_reg(dev, MII_ADDR, addr, in_pm);
271 netdev_warn(dev->net, "Error writing MII_ADDR\n");
275 ret = __smsc95xx_phy_wait_not_busy(dev, in_pm);
277 netdev_warn(dev->net, "Timed out writing MII reg %02X\n", idx);
282 mutex_unlock(&dev->phy_mutex);
285 static int smsc95xx_mdio_read_nopm(struct usbnet *dev, int idx)
287 struct smsc95xx_priv *pdata = dev->driver_priv;
289 return __smsc95xx_mdio_read(dev, pdata->phydev->mdio.addr, idx, 1);
292 static void smsc95xx_mdio_write_nopm(struct usbnet *dev, int idx, int regval)
294 struct smsc95xx_priv *pdata = dev->driver_priv;
296 __smsc95xx_mdio_write(dev, pdata->phydev->mdio.addr, idx, regval, 1);
299 static int smsc95xx_mdiobus_read(struct mii_bus *bus, int phy_id, int idx)
301 struct usbnet *dev = bus->priv;
303 return __smsc95xx_mdio_read(dev, phy_id, idx, 0);
306 static int smsc95xx_mdiobus_write(struct mii_bus *bus, int phy_id, int idx,
309 struct usbnet *dev = bus->priv;
311 __smsc95xx_mdio_write(dev, phy_id, idx, regval, 0);
315 static int __must_check smsc95xx_wait_eeprom(struct usbnet *dev)
317 unsigned long start_time = jiffies;
322 ret = smsc95xx_read_reg(dev, E2P_CMD, &val);
324 netdev_warn(dev->net, "Error reading E2P_CMD\n");
328 if (!(val & E2P_CMD_BUSY_) || (val & E2P_CMD_TIMEOUT_))
331 } while (!time_after(jiffies, start_time + HZ));
333 if (val & (E2P_CMD_TIMEOUT_ | E2P_CMD_BUSY_)) {
334 netdev_warn(dev->net, "EEPROM read operation timeout\n");
341 static int __must_check smsc95xx_eeprom_confirm_not_busy(struct usbnet *dev)
343 unsigned long start_time = jiffies;
348 ret = smsc95xx_read_reg(dev, E2P_CMD, &val);
350 netdev_warn(dev->net, "Error reading E2P_CMD\n");
354 if (!(val & E2P_CMD_BUSY_))
358 } while (!time_after(jiffies, start_time + HZ));
360 netdev_warn(dev->net, "EEPROM is busy\n");
364 static int smsc95xx_read_eeprom(struct usbnet *dev, u32 offset, u32 length,
373 ret = smsc95xx_eeprom_confirm_not_busy(dev);
377 for (i = 0; i < length; i++) {
378 val = E2P_CMD_BUSY_ | E2P_CMD_READ_ | (offset & E2P_CMD_ADDR_);
379 ret = smsc95xx_write_reg(dev, E2P_CMD, val);
381 netdev_warn(dev->net, "Error writing E2P_CMD\n");
385 ret = smsc95xx_wait_eeprom(dev);
389 ret = smsc95xx_read_reg(dev, E2P_DATA, &val);
391 netdev_warn(dev->net, "Error reading E2P_DATA\n");
395 data[i] = val & 0xFF;
402 static int smsc95xx_write_eeprom(struct usbnet *dev, u32 offset, u32 length,
411 ret = smsc95xx_eeprom_confirm_not_busy(dev);
415 /* Issue write/erase enable command */
416 val = E2P_CMD_BUSY_ | E2P_CMD_EWEN_;
417 ret = smsc95xx_write_reg(dev, E2P_CMD, val);
419 netdev_warn(dev->net, "Error writing E2P_DATA\n");
423 ret = smsc95xx_wait_eeprom(dev);
427 for (i = 0; i < length; i++) {
429 /* Fill data register */
431 ret = smsc95xx_write_reg(dev, E2P_DATA, val);
433 netdev_warn(dev->net, "Error writing E2P_DATA\n");
437 /* Send "write" command */
438 val = E2P_CMD_BUSY_ | E2P_CMD_WRITE_ | (offset & E2P_CMD_ADDR_);
439 ret = smsc95xx_write_reg(dev, E2P_CMD, val);
441 netdev_warn(dev->net, "Error writing E2P_CMD\n");
445 ret = smsc95xx_wait_eeprom(dev);
455 static int __must_check smsc95xx_write_reg_async(struct usbnet *dev, u16 index,
465 ret = usbnet_write_cmd_async(dev, USB_VENDOR_REQUEST_WRITE_REGISTER,
466 USB_DIR_OUT | USB_TYPE_VENDOR |
468 0, index, &buf, size);
470 netdev_warn(dev->net, "Error write async cmd, sts=%d\n",
475 /* returns hash bit number for given MAC address
477 * 01 00 5E 00 00 01 -> returns bit number 31 */
478 static unsigned int smsc95xx_hash(char addr[ETH_ALEN])
480 return (ether_crc(ETH_ALEN, addr) >> 26) & 0x3f;
483 static void smsc95xx_set_multicast(struct net_device *netdev)
485 struct usbnet *dev = netdev_priv(netdev);
486 struct smsc95xx_priv *pdata = dev->driver_priv;
493 spin_lock_irqsave(&pdata->mac_cr_lock, flags);
495 if (dev->net->flags & IFF_PROMISC) {
496 netif_dbg(dev, drv, dev->net, "promiscuous mode enabled\n");
497 pdata->mac_cr |= MAC_CR_PRMS_;
498 pdata->mac_cr &= ~(MAC_CR_MCPAS_ | MAC_CR_HPFILT_);
499 } else if (dev->net->flags & IFF_ALLMULTI) {
500 netif_dbg(dev, drv, dev->net, "receive all multicast enabled\n");
501 pdata->mac_cr |= MAC_CR_MCPAS_;
502 pdata->mac_cr &= ~(MAC_CR_PRMS_ | MAC_CR_HPFILT_);
503 } else if (!netdev_mc_empty(dev->net)) {
504 struct netdev_hw_addr *ha;
506 pdata->mac_cr |= MAC_CR_HPFILT_;
507 pdata->mac_cr &= ~(MAC_CR_PRMS_ | MAC_CR_MCPAS_);
509 netdev_for_each_mc_addr(ha, netdev) {
510 u32 bitnum = smsc95xx_hash(ha->addr);
511 u32 mask = 0x01 << (bitnum & 0x1F);
513 pdata->hash_hi |= mask;
515 pdata->hash_lo |= mask;
518 netif_dbg(dev, drv, dev->net, "HASHH=0x%08X, HASHL=0x%08X\n",
519 pdata->hash_hi, pdata->hash_lo);
521 netif_dbg(dev, drv, dev->net, "receive own packets only\n");
523 ~(MAC_CR_PRMS_ | MAC_CR_MCPAS_ | MAC_CR_HPFILT_);
526 spin_unlock_irqrestore(&pdata->mac_cr_lock, flags);
528 /* Initiate async writes, as we can't wait for completion here */
529 ret = smsc95xx_write_reg_async(dev, HASHH, pdata->hash_hi);
531 netdev_warn(dev->net, "failed to initiate async write to HASHH\n");
533 ret = smsc95xx_write_reg_async(dev, HASHL, pdata->hash_lo);
535 netdev_warn(dev->net, "failed to initiate async write to HASHL\n");
537 ret = smsc95xx_write_reg_async(dev, MAC_CR, pdata->mac_cr);
539 netdev_warn(dev->net, "failed to initiate async write to MAC_CR\n");
542 static int smsc95xx_phy_update_flowcontrol(struct usbnet *dev)
544 u32 flow = 0, afc_cfg;
545 struct smsc95xx_priv *pdata = dev->driver_priv;
546 bool tx_pause, rx_pause;
548 int ret = smsc95xx_read_reg(dev, AFC_CFG, &afc_cfg);
552 if (pdata->phydev->duplex == DUPLEX_FULL) {
553 phy_get_pause(pdata->phydev, &tx_pause, &rx_pause);
565 netif_dbg(dev, link, dev->net, "rx pause %s, tx pause %s\n",
566 rx_pause ? "enabled" : "disabled",
567 tx_pause ? "enabled" : "disabled");
569 netif_dbg(dev, link, dev->net, "half duplex\n");
573 ret = smsc95xx_write_reg(dev, FLOW, flow);
577 return smsc95xx_write_reg(dev, AFC_CFG, afc_cfg);
580 static int smsc95xx_link_reset(struct usbnet *dev)
582 struct smsc95xx_priv *pdata = dev->driver_priv;
586 ret = smsc95xx_write_reg(dev, INT_STS, INT_STS_CLEAR_ALL_);
590 spin_lock_irqsave(&pdata->mac_cr_lock, flags);
591 if (pdata->phydev->duplex != DUPLEX_FULL) {
592 pdata->mac_cr &= ~MAC_CR_FDPX_;
593 pdata->mac_cr |= MAC_CR_RCVOWN_;
595 pdata->mac_cr &= ~MAC_CR_RCVOWN_;
596 pdata->mac_cr |= MAC_CR_FDPX_;
598 spin_unlock_irqrestore(&pdata->mac_cr_lock, flags);
600 ret = smsc95xx_write_reg(dev, MAC_CR, pdata->mac_cr);
604 ret = smsc95xx_phy_update_flowcontrol(dev);
606 netdev_warn(dev->net, "Error updating PHY flow control\n");
611 static void smsc95xx_status(struct usbnet *dev, struct urb *urb)
615 if (urb->actual_length != 4) {
616 netdev_warn(dev->net, "unexpected urb length %d\n",
621 intdata = get_unaligned_le32(urb->transfer_buffer);
622 netif_dbg(dev, link, dev->net, "intdata: 0x%08X\n", intdata);
624 if (intdata & INT_ENP_PHY_INT_)
625 usbnet_defer_kevent(dev, EVENT_LINK_RESET);
627 netdev_warn(dev->net, "unexpected interrupt, intdata=0x%08X\n",
631 /* Enable or disable Tx & Rx checksum offload engines */
632 static int smsc95xx_set_features(struct net_device *netdev,
633 netdev_features_t features)
635 struct usbnet *dev = netdev_priv(netdev);
639 ret = smsc95xx_read_reg(dev, COE_CR, &read_buf);
643 if (features & NETIF_F_IP_CSUM)
644 read_buf |= Tx_COE_EN_;
646 read_buf &= ~Tx_COE_EN_;
648 if (features & NETIF_F_RXCSUM)
649 read_buf |= Rx_COE_EN_;
651 read_buf &= ~Rx_COE_EN_;
653 ret = smsc95xx_write_reg(dev, COE_CR, read_buf);
657 netif_dbg(dev, hw, dev->net, "COE_CR = 0x%08x\n", read_buf);
661 static int smsc95xx_ethtool_get_eeprom_len(struct net_device *net)
663 return MAX_EEPROM_SIZE;
666 static int smsc95xx_ethtool_get_eeprom(struct net_device *netdev,
667 struct ethtool_eeprom *ee, u8 *data)
669 struct usbnet *dev = netdev_priv(netdev);
671 ee->magic = LAN95XX_EEPROM_MAGIC;
673 return smsc95xx_read_eeprom(dev, ee->offset, ee->len, data);
676 static int smsc95xx_ethtool_set_eeprom(struct net_device *netdev,
677 struct ethtool_eeprom *ee, u8 *data)
679 struct usbnet *dev = netdev_priv(netdev);
681 if (ee->magic != LAN95XX_EEPROM_MAGIC) {
682 netdev_warn(dev->net, "EEPROM: magic value mismatch, magic = 0x%x\n",
687 return smsc95xx_write_eeprom(dev, ee->offset, ee->len, data);
690 static int smsc95xx_ethtool_getregslen(struct net_device *netdev)
692 /* all smsc95xx registers */
693 return COE_CR - ID_REV + sizeof(u32);
697 smsc95xx_ethtool_getregs(struct net_device *netdev, struct ethtool_regs *regs,
700 struct usbnet *dev = netdev_priv(netdev);
705 retval = smsc95xx_read_reg(dev, ID_REV, ®s->version);
707 netdev_warn(netdev, "REGS: cannot read ID_REV\n");
711 for (i = ID_REV, j = 0; i <= COE_CR; i += (sizeof(u32)), j++) {
712 retval = smsc95xx_read_reg(dev, i, &data[j]);
714 netdev_warn(netdev, "REGS: cannot read reg[%x]\n", i);
720 static void smsc95xx_ethtool_get_wol(struct net_device *net,
721 struct ethtool_wolinfo *wolinfo)
723 struct usbnet *dev = netdev_priv(net);
724 struct smsc95xx_priv *pdata = dev->driver_priv;
726 wolinfo->supported = SUPPORTED_WAKE;
727 wolinfo->wolopts = pdata->wolopts;
730 static int smsc95xx_ethtool_set_wol(struct net_device *net,
731 struct ethtool_wolinfo *wolinfo)
733 struct usbnet *dev = netdev_priv(net);
734 struct smsc95xx_priv *pdata = dev->driver_priv;
737 if (wolinfo->wolopts & ~SUPPORTED_WAKE)
740 pdata->wolopts = wolinfo->wolopts & SUPPORTED_WAKE;
742 ret = device_set_wakeup_enable(&dev->udev->dev, pdata->wolopts);
744 netdev_warn(dev->net, "device_set_wakeup_enable error %d\n", ret);
749 static u32 smsc95xx_get_link(struct net_device *net)
751 phy_read_status(net->phydev);
752 return net->phydev->link;
755 static const struct ethtool_ops smsc95xx_ethtool_ops = {
756 .get_link = smsc95xx_get_link,
757 .nway_reset = phy_ethtool_nway_reset,
758 .get_drvinfo = usbnet_get_drvinfo,
759 .get_msglevel = usbnet_get_msglevel,
760 .set_msglevel = usbnet_set_msglevel,
761 .get_eeprom_len = smsc95xx_ethtool_get_eeprom_len,
762 .get_eeprom = smsc95xx_ethtool_get_eeprom,
763 .set_eeprom = smsc95xx_ethtool_set_eeprom,
764 .get_regs_len = smsc95xx_ethtool_getregslen,
765 .get_regs = smsc95xx_ethtool_getregs,
766 .get_wol = smsc95xx_ethtool_get_wol,
767 .set_wol = smsc95xx_ethtool_set_wol,
768 .get_link_ksettings = phy_ethtool_get_link_ksettings,
769 .set_link_ksettings = phy_ethtool_set_link_ksettings,
770 .get_ts_info = ethtool_op_get_ts_info,
773 static int smsc95xx_ioctl(struct net_device *netdev, struct ifreq *rq, int cmd)
775 if (!netif_running(netdev))
778 return phy_mii_ioctl(netdev->phydev, rq, cmd);
781 /* Check the macaddr module parameter for a MAC address */
782 static int smsc95xx_is_macaddr_param(struct usbnet *dev, u8 *dev_mac)
784 int i, j, got_num, num;
785 u8 mtbl[MAC_ADDR_LEN];
787 if (macaddr[0] == ':')
794 while (j < MAC_ADDR_LEN) {
795 if (macaddr[i] && macaddr[i] != ':') {
797 if ('0' <= macaddr[i] && macaddr[i] <= '9')
798 num = num * 16 + macaddr[i] - '0';
799 else if ('A' <= macaddr[i] && macaddr[i] <= 'F')
800 num = num * 16 + 10 + macaddr[i] - 'A';
801 else if ('a' <= macaddr[i] && macaddr[i] <= 'f')
802 num = num * 16 + 10 + macaddr[i] - 'a';
806 } else if (got_num == 2) {
807 mtbl[j++] = (u8) num;
816 if (j == MAC_ADDR_LEN) {
817 netif_dbg(dev, ifup, dev->net, "Overriding MAC address with: "
818 "%02x:%02x:%02x:%02x:%02x:%02x\n", mtbl[0], mtbl[1], mtbl[2],
819 mtbl[3], mtbl[4], mtbl[5]);
820 for (i = 0; i < MAC_ADDR_LEN; i++)
821 dev_mac[i] = mtbl[i];
828 static void smsc95xx_init_mac_address(struct usbnet *dev)
830 /* maybe the boot loader passed the MAC address in devicetree */
831 if (!eth_platform_get_mac_address(&dev->udev->dev,
832 dev->net->dev_addr)) {
833 if (is_valid_ether_addr(dev->net->dev_addr)) {
834 /* device tree values are valid so use them */
835 netif_dbg(dev, ifup, dev->net, "MAC address read from the device tree\n");
840 /* try reading mac address from EEPROM */
841 if (smsc95xx_read_eeprom(dev, EEPROM_MAC_OFFSET, ETH_ALEN,
842 dev->net->dev_addr) == 0) {
843 if (is_valid_ether_addr(dev->net->dev_addr)) {
844 /* eeprom values are valid so use them */
845 netif_dbg(dev, ifup, dev->net, "MAC address read from EEPROM\n");
850 /* Check module parameters */
851 if (smsc95xx_is_macaddr_param(dev, dev->net->dev_addr))
854 /* no useful static MAC address found. generate a random one */
855 eth_hw_addr_random(dev->net);
856 netif_dbg(dev, ifup, dev->net, "MAC address set to eth_random_addr\n");
859 static int smsc95xx_set_mac_address(struct usbnet *dev)
861 u32 addr_lo = dev->net->dev_addr[0] | dev->net->dev_addr[1] << 8 |
862 dev->net->dev_addr[2] << 16 | dev->net->dev_addr[3] << 24;
863 u32 addr_hi = dev->net->dev_addr[4] | dev->net->dev_addr[5] << 8;
866 ret = smsc95xx_write_reg(dev, ADDRL, addr_lo);
870 return smsc95xx_write_reg(dev, ADDRH, addr_hi);
873 /* starts the TX path */
874 static int smsc95xx_start_tx_path(struct usbnet *dev)
876 struct smsc95xx_priv *pdata = dev->driver_priv;
880 /* Enable Tx at MAC */
881 spin_lock_irqsave(&pdata->mac_cr_lock, flags);
882 pdata->mac_cr |= MAC_CR_TXEN_;
883 spin_unlock_irqrestore(&pdata->mac_cr_lock, flags);
885 ret = smsc95xx_write_reg(dev, MAC_CR, pdata->mac_cr);
889 /* Enable Tx at SCSRs */
890 return smsc95xx_write_reg(dev, TX_CFG, TX_CFG_ON_);
893 /* Starts the Receive path */
894 static int smsc95xx_start_rx_path(struct usbnet *dev, int in_pm)
896 struct smsc95xx_priv *pdata = dev->driver_priv;
899 spin_lock_irqsave(&pdata->mac_cr_lock, flags);
900 pdata->mac_cr |= MAC_CR_RXEN_;
901 spin_unlock_irqrestore(&pdata->mac_cr_lock, flags);
903 return __smsc95xx_write_reg(dev, MAC_CR, pdata->mac_cr, in_pm);
906 static int smsc95xx_reset(struct usbnet *dev)
908 struct smsc95xx_priv *pdata = dev->driver_priv;
909 u32 read_buf, write_buf, burst_cap;
910 int ret = 0, timeout;
912 netif_dbg(dev, ifup, dev->net, "entering smsc95xx_reset\n");
914 ret = smsc95xx_write_reg(dev, HW_CFG, HW_CFG_LRST_);
921 ret = smsc95xx_read_reg(dev, HW_CFG, &read_buf);
925 } while ((read_buf & HW_CFG_LRST_) && (timeout < 100));
927 if (timeout >= 100) {
928 netdev_warn(dev->net, "timeout waiting for completion of Lite Reset\n");
932 ret = smsc95xx_write_reg(dev, PM_CTRL, PM_CTL_PHY_RST_);
939 ret = smsc95xx_read_reg(dev, PM_CTRL, &read_buf);
943 } while ((read_buf & PM_CTL_PHY_RST_) && (timeout < 100));
945 if (timeout >= 100) {
946 netdev_warn(dev->net, "timeout waiting for PHY Reset\n");
950 ret = smsc95xx_set_mac_address(dev);
954 netif_dbg(dev, ifup, dev->net, "MAC Address: %pM\n",
957 ret = smsc95xx_read_reg(dev, HW_CFG, &read_buf);
961 netif_dbg(dev, ifup, dev->net, "Read Value from HW_CFG : 0x%08x\n",
964 read_buf |= HW_CFG_BIR_;
966 ret = smsc95xx_write_reg(dev, HW_CFG, read_buf);
970 ret = smsc95xx_read_reg(dev, HW_CFG, &read_buf);
974 netif_dbg(dev, ifup, dev->net,
975 "Read Value from HW_CFG after writing HW_CFG_BIR_: 0x%08x\n",
980 dev->rx_urb_size = packetsize ? packetsize : MAX_SINGLE_PACKET_SIZE;
981 } else if (dev->udev->speed == USB_SPEED_HIGH) {
982 dev->rx_urb_size = packetsize ? packetsize : DEFAULT_HS_BURST_CAP_SIZE;
983 burst_cap = dev->rx_urb_size / HS_USB_PKT_SIZE;
985 dev->rx_urb_size = packetsize ? packetsize : DEFAULT_FS_BURST_CAP_SIZE;
986 burst_cap = dev->rx_urb_size / FS_USB_PKT_SIZE;
989 netif_dbg(dev, ifup, dev->net, "rx_urb_size=%ld\n",
990 (ulong)dev->rx_urb_size);
992 ret = smsc95xx_write_reg(dev, BURST_CAP, burst_cap);
996 ret = smsc95xx_read_reg(dev, BURST_CAP, &read_buf);
1000 netif_dbg(dev, ifup, dev->net,
1001 "Read Value from BURST_CAP after writing: 0x%08x\n",
1004 ret = smsc95xx_write_reg(dev, BULK_IN_DLY, DEFAULT_BULK_IN_DELAY);
1008 ret = smsc95xx_read_reg(dev, BULK_IN_DLY, &read_buf);
1012 netif_dbg(dev, ifup, dev->net,
1013 "Read Value from BULK_IN_DLY after writing: 0x%08x\n",
1016 ret = smsc95xx_read_reg(dev, HW_CFG, &read_buf);
1020 netif_dbg(dev, ifup, dev->net, "Read Value from HW_CFG: 0x%08x\n",
1024 read_buf |= (HW_CFG_MEF_ | HW_CFG_BCE_);
1026 read_buf &= ~HW_CFG_RXDOFF_;
1028 /* set Rx data offset=2, Make IP header aligns on word boundary. */
1029 read_buf |= NET_IP_ALIGN << 9;
1031 ret = smsc95xx_write_reg(dev, HW_CFG, read_buf);
1035 ret = smsc95xx_read_reg(dev, HW_CFG, &read_buf);
1039 netif_dbg(dev, ifup, dev->net,
1040 "Read Value from HW_CFG after writing: 0x%08x\n", read_buf);
1042 ret = smsc95xx_write_reg(dev, INT_STS, INT_STS_CLEAR_ALL_);
1046 ret = smsc95xx_read_reg(dev, ID_REV, &read_buf);
1049 netif_dbg(dev, ifup, dev->net, "ID_REV = 0x%08x\n", read_buf);
1051 /* Configure GPIO pins as LED outputs */
1052 write_buf = LED_GPIO_CFG_SPD_LED | LED_GPIO_CFG_LNK_LED |
1053 LED_GPIO_CFG_FDX_LED;
1054 ret = smsc95xx_write_reg(dev, LED_GPIO_CFG, write_buf);
1059 ret = smsc95xx_write_reg(dev, FLOW, 0);
1063 ret = smsc95xx_write_reg(dev, AFC_CFG, AFC_CFG_DEFAULT);
1067 /* Don't need mac_cr_lock during initialisation */
1068 ret = smsc95xx_read_reg(dev, MAC_CR, &pdata->mac_cr);
1074 ret = smsc95xx_write_reg(dev, VLAN1, (u32)ETH_P_8021Q);
1078 /* Enable or disable checksum offload engines */
1079 ret = smsc95xx_set_features(dev->net, dev->net->features);
1081 netdev_warn(dev->net, "Failed to set checksum offload features\n");
1085 smsc95xx_set_multicast(dev->net);
1087 ret = smsc95xx_read_reg(dev, INT_EP_CTL, &read_buf);
1091 /* enable PHY interrupts */
1092 read_buf |= INT_EP_CTL_PHY_INT_;
1094 ret = smsc95xx_write_reg(dev, INT_EP_CTL, read_buf);
1098 ret = smsc95xx_start_tx_path(dev);
1100 netdev_warn(dev->net, "Failed to start TX path\n");
1104 ret = smsc95xx_start_rx_path(dev, 0);
1106 netdev_warn(dev->net, "Failed to start RX path\n");
1110 netif_dbg(dev, ifup, dev->net, "smsc95xx_reset, return 0\n");
1114 static const struct net_device_ops smsc95xx_netdev_ops = {
1115 .ndo_open = usbnet_open,
1116 .ndo_stop = usbnet_stop,
1117 .ndo_start_xmit = usbnet_start_xmit,
1118 .ndo_tx_timeout = usbnet_tx_timeout,
1119 .ndo_change_mtu = usbnet_change_mtu,
1120 .ndo_get_stats64 = dev_get_tstats64,
1121 .ndo_set_mac_address = eth_mac_addr,
1122 .ndo_validate_addr = eth_validate_addr,
1123 .ndo_eth_ioctl = smsc95xx_ioctl,
1124 .ndo_set_rx_mode = smsc95xx_set_multicast,
1125 .ndo_set_features = smsc95xx_set_features,
1128 static void smsc95xx_handle_link_change(struct net_device *net)
1130 struct usbnet *dev = netdev_priv(net);
1132 phy_print_status(net->phydev);
1133 usbnet_defer_kevent(dev, EVENT_LINK_CHANGE);
1136 static int smsc95xx_bind(struct usbnet *dev, struct usb_interface *intf)
1138 struct smsc95xx_priv *pdata;
1139 bool is_internal_phy;
1143 printk(KERN_INFO SMSC_CHIPNAME " v" SMSC_DRIVER_VERSION "\n");
1145 ret = usbnet_get_endpoints(dev, intf);
1147 netdev_warn(dev->net, "usbnet_get_endpoints failed: %d\n", ret);
1151 pdata = kzalloc(sizeof(*pdata), GFP_KERNEL);
1155 dev->driver_priv = pdata;
1157 spin_lock_init(&pdata->mac_cr_lock);
1159 /* LAN95xx devices do not alter the computed checksum of 0 to 0xffff.
1160 * RFC 2460, ipv6 UDP calculated checksum yields a result of zero must
1161 * be changed to 0xffff. RFC 768, ipv4 UDP computed checksum is zero,
1162 * it is transmitted as all ones. The zero transmitted checksum means
1163 * transmitter generated no checksum. Hence, enable csum offload only
1166 if (DEFAULT_TX_CSUM_ENABLE)
1167 dev->net->features |= NETIF_F_IP_CSUM;
1168 if (DEFAULT_RX_CSUM_ENABLE)
1169 dev->net->features |= NETIF_F_RXCSUM;
1171 dev->net->hw_features = NETIF_F_IP_CSUM | NETIF_F_RXCSUM;
1172 set_bit(EVENT_NO_IP_ALIGN, &dev->flags);
1174 smsc95xx_init_mac_address(dev);
1176 /* Init all registers */
1177 ret = smsc95xx_reset(dev);
1181 pdata->mdiobus = mdiobus_alloc();
1182 if (!pdata->mdiobus) {
1187 ret = smsc95xx_read_reg(dev, HW_CFG, &val);
1191 is_internal_phy = !(val & HW_CFG_PSEL_);
1192 if (is_internal_phy)
1193 pdata->mdiobus->phy_mask = ~(1u << SMSC95XX_INTERNAL_PHY_ID);
1195 pdata->mdiobus->priv = dev;
1196 pdata->mdiobus->read = smsc95xx_mdiobus_read;
1197 pdata->mdiobus->write = smsc95xx_mdiobus_write;
1198 pdata->mdiobus->name = "smsc95xx-mdiobus";
1199 pdata->mdiobus->parent = &dev->udev->dev;
1201 snprintf(pdata->mdiobus->id, ARRAY_SIZE(pdata->mdiobus->id),
1202 "usb-%03d:%03d", dev->udev->bus->busnum, dev->udev->devnum);
1204 ret = mdiobus_register(pdata->mdiobus);
1206 netdev_err(dev->net, "Could not register MDIO bus\n");
1210 pdata->phydev = phy_find_first(pdata->mdiobus);
1211 if (!pdata->phydev) {
1212 netdev_err(dev->net, "no PHY found\n");
1214 goto unregister_mdio;
1217 pdata->phydev->is_internal = is_internal_phy;
1219 /* detect device revision as different features may be available */
1220 ret = smsc95xx_read_reg(dev, ID_REV, &val);
1222 goto unregister_mdio;
1225 if ((val == ID_REV_CHIP_ID_9500A_) || (val == ID_REV_CHIP_ID_9530_) ||
1226 (val == ID_REV_CHIP_ID_89530_) || (val == ID_REV_CHIP_ID_9730_))
1227 pdata->features = (FEATURE_8_WAKEUP_FILTERS |
1228 FEATURE_PHY_NLP_CROSSOVER |
1229 FEATURE_REMOTE_WAKEUP);
1230 else if (val == ID_REV_CHIP_ID_9512_)
1231 pdata->features = FEATURE_8_WAKEUP_FILTERS;
1233 dev->net->netdev_ops = &smsc95xx_netdev_ops;
1234 dev->net->ethtool_ops = &smsc95xx_ethtool_ops;
1235 dev->net->flags |= IFF_MULTICAST;
1236 dev->net->hard_header_len += SMSC95XX_TX_OVERHEAD_CSUM;
1237 dev->net->min_mtu = ETH_MIN_MTU;
1238 dev->net->max_mtu = ETH_DATA_LEN;
1239 dev->hard_mtu = dev->net->mtu + dev->net->hard_header_len;
1241 ret = phy_connect_direct(dev->net, pdata->phydev,
1242 &smsc95xx_handle_link_change,
1243 PHY_INTERFACE_MODE_MII);
1245 netdev_err(dev->net, "can't attach PHY to %s\n", pdata->mdiobus->id);
1246 goto unregister_mdio;
1249 phy_attached_info(dev->net->phydev);
1254 mdiobus_unregister(pdata->mdiobus);
1257 mdiobus_free(pdata->mdiobus);
1264 static void smsc95xx_unbind(struct usbnet *dev, struct usb_interface *intf)
1266 struct smsc95xx_priv *pdata = dev->driver_priv;
1268 phy_disconnect(dev->net->phydev);
1269 mdiobus_unregister(pdata->mdiobus);
1270 mdiobus_free(pdata->mdiobus);
1271 netif_dbg(dev, ifdown, dev->net, "free pdata\n");
1275 static int smsc95xx_start_phy(struct usbnet *dev)
1277 phy_start(dev->net->phydev);
1282 static int smsc95xx_stop(struct usbnet *dev)
1284 phy_stop(dev->net->phydev);
1289 static u32 smsc_crc(const u8 *buffer, size_t len, int filter)
1291 u32 crc = bitrev16(crc16(0xFFFF, buffer, len));
1292 return crc << ((filter % 2) * 16);
1295 static int smsc95xx_enable_phy_wakeup_interrupts(struct usbnet *dev, u16 mask)
1299 netdev_dbg(dev->net, "enabling PHY wakeup interrupts\n");
1302 ret = smsc95xx_mdio_read_nopm(dev, PHY_INT_SRC);
1306 /* enable interrupt source */
1307 ret = smsc95xx_mdio_read_nopm(dev, PHY_INT_MASK);
1313 smsc95xx_mdio_write_nopm(dev, PHY_INT_MASK, ret);
1318 static int smsc95xx_link_ok_nopm(struct usbnet *dev)
1322 /* first, a dummy read, needed to latch some MII phys */
1323 ret = smsc95xx_mdio_read_nopm(dev, MII_BMSR);
1327 ret = smsc95xx_mdio_read_nopm(dev, MII_BMSR);
1331 return !!(ret & BMSR_LSTATUS);
1334 static int smsc95xx_enter_suspend0(struct usbnet *dev)
1336 struct smsc95xx_priv *pdata = dev->driver_priv;
1340 ret = smsc95xx_read_reg_nopm(dev, PM_CTRL, &val);
1344 val &= (~(PM_CTL_SUS_MODE_ | PM_CTL_WUPS_ | PM_CTL_PHY_RST_));
1345 val |= PM_CTL_SUS_MODE_0;
1347 ret = smsc95xx_write_reg_nopm(dev, PM_CTRL, val);
1351 /* clear wol status */
1352 val &= ~PM_CTL_WUPS_;
1353 val |= PM_CTL_WUPS_WOL_;
1355 /* enable energy detection */
1356 if (pdata->wolopts & WAKE_PHY)
1357 val |= PM_CTL_WUPS_ED_;
1359 ret = smsc95xx_write_reg_nopm(dev, PM_CTRL, val);
1363 /* read back PM_CTRL */
1364 ret = smsc95xx_read_reg_nopm(dev, PM_CTRL, &val);
1368 pdata->suspend_flags |= SUSPEND_SUSPEND0;
1373 static int smsc95xx_enter_suspend1(struct usbnet *dev)
1375 struct smsc95xx_priv *pdata = dev->driver_priv;
1379 /* reconfigure link pulse detection timing for
1380 * compatibility with non-standard link partners
1382 if (pdata->features & FEATURE_PHY_NLP_CROSSOVER)
1383 smsc95xx_mdio_write_nopm(dev, PHY_EDPD_CONFIG,
1384 PHY_EDPD_CONFIG_DEFAULT);
1386 /* enable energy detect power-down mode */
1387 ret = smsc95xx_mdio_read_nopm(dev, PHY_MODE_CTRL_STS);
1391 ret |= MODE_CTRL_STS_EDPWRDOWN_;
1393 smsc95xx_mdio_write_nopm(dev, PHY_MODE_CTRL_STS, ret);
1395 /* enter SUSPEND1 mode */
1396 ret = smsc95xx_read_reg_nopm(dev, PM_CTRL, &val);
1400 val &= ~(PM_CTL_SUS_MODE_ | PM_CTL_WUPS_ | PM_CTL_PHY_RST_);
1401 val |= PM_CTL_SUS_MODE_1;
1403 ret = smsc95xx_write_reg_nopm(dev, PM_CTRL, val);
1407 /* clear wol status, enable energy detection */
1408 val &= ~PM_CTL_WUPS_;
1409 val |= (PM_CTL_WUPS_ED_ | PM_CTL_ED_EN_);
1411 ret = smsc95xx_write_reg_nopm(dev, PM_CTRL, val);
1415 pdata->suspend_flags |= SUSPEND_SUSPEND1;
1420 static int smsc95xx_enter_suspend2(struct usbnet *dev)
1422 struct smsc95xx_priv *pdata = dev->driver_priv;
1426 ret = smsc95xx_read_reg_nopm(dev, PM_CTRL, &val);
1430 val &= ~(PM_CTL_SUS_MODE_ | PM_CTL_WUPS_ | PM_CTL_PHY_RST_);
1431 val |= PM_CTL_SUS_MODE_2;
1433 ret = smsc95xx_write_reg_nopm(dev, PM_CTRL, val);
1437 pdata->suspend_flags |= SUSPEND_SUSPEND2;
1442 static int smsc95xx_enter_suspend3(struct usbnet *dev)
1444 struct smsc95xx_priv *pdata = dev->driver_priv;
1448 ret = smsc95xx_read_reg_nopm(dev, RX_FIFO_INF, &val);
1452 if (val & RX_FIFO_INF_USED_) {
1453 netdev_info(dev->net, "rx fifo not empty in autosuspend\n");
1457 ret = smsc95xx_read_reg_nopm(dev, PM_CTRL, &val);
1461 val &= ~(PM_CTL_SUS_MODE_ | PM_CTL_WUPS_ | PM_CTL_PHY_RST_);
1462 val |= PM_CTL_SUS_MODE_3 | PM_CTL_RES_CLR_WKP_STS;
1464 ret = smsc95xx_write_reg_nopm(dev, PM_CTRL, val);
1468 /* clear wol status */
1469 val &= ~PM_CTL_WUPS_;
1470 val |= PM_CTL_WUPS_WOL_;
1472 ret = smsc95xx_write_reg_nopm(dev, PM_CTRL, val);
1476 pdata->suspend_flags |= SUSPEND_SUSPEND3;
1481 static int smsc95xx_autosuspend(struct usbnet *dev, u32 link_up)
1483 struct smsc95xx_priv *pdata = dev->driver_priv;
1486 if (!netif_running(dev->net)) {
1487 /* interface is ifconfig down so fully power down hw */
1488 netdev_dbg(dev->net, "autosuspend entering SUSPEND2\n");
1489 return smsc95xx_enter_suspend2(dev);
1493 /* link is down so enter EDPD mode, but only if device can
1494 * reliably resume from it. This check should be redundant
1495 * as current FEATURE_REMOTE_WAKEUP parts also support
1496 * FEATURE_PHY_NLP_CROSSOVER but it's included for clarity */
1497 if (!(pdata->features & FEATURE_PHY_NLP_CROSSOVER)) {
1498 netdev_warn(dev->net, "EDPD not supported\n");
1502 netdev_dbg(dev->net, "autosuspend entering SUSPEND1\n");
1504 /* enable PHY wakeup events for if cable is attached */
1505 ret = smsc95xx_enable_phy_wakeup_interrupts(dev,
1506 PHY_INT_MASK_ANEG_COMP_);
1508 netdev_warn(dev->net, "error enabling PHY wakeup ints\n");
1512 netdev_info(dev->net, "entering SUSPEND1 mode\n");
1513 return smsc95xx_enter_suspend1(dev);
1516 /* enable PHY wakeup events so we remote wakeup if cable is pulled */
1517 ret = smsc95xx_enable_phy_wakeup_interrupts(dev,
1518 PHY_INT_MASK_LINK_DOWN_);
1520 netdev_warn(dev->net, "error enabling PHY wakeup ints\n");
1524 netdev_dbg(dev->net, "autosuspend entering SUSPEND3\n");
1525 return smsc95xx_enter_suspend3(dev);
1528 static int smsc95xx_suspend(struct usb_interface *intf, pm_message_t message)
1530 struct usbnet *dev = usb_get_intfdata(intf);
1531 struct smsc95xx_priv *pdata = dev->driver_priv;
1535 ret = usbnet_suspend(intf, message);
1537 netdev_warn(dev->net, "usbnet_suspend error\n");
1541 if (pdata->suspend_flags) {
1542 netdev_warn(dev->net, "error during last resume\n");
1543 pdata->suspend_flags = 0;
1546 /* determine if link is up using only _nopm functions */
1547 link_up = smsc95xx_link_ok_nopm(dev);
1549 if (message.event == PM_EVENT_AUTO_SUSPEND &&
1550 (pdata->features & FEATURE_REMOTE_WAKEUP)) {
1551 ret = smsc95xx_autosuspend(dev, link_up);
1555 /* if we get this far we're not autosuspending */
1556 /* if no wol options set, or if link is down and we're not waking on
1557 * PHY activity, enter lowest power SUSPEND2 mode
1559 if (!(pdata->wolopts & SUPPORTED_WAKE) ||
1560 !(link_up || (pdata->wolopts & WAKE_PHY))) {
1561 netdev_info(dev->net, "entering SUSPEND2 mode\n");
1563 /* disable energy detect (link up) & wake up events */
1564 ret = smsc95xx_read_reg_nopm(dev, WUCSR, &val);
1568 val &= ~(WUCSR_MPEN_ | WUCSR_WAKE_EN_);
1570 ret = smsc95xx_write_reg_nopm(dev, WUCSR, val);
1574 ret = smsc95xx_read_reg_nopm(dev, PM_CTRL, &val);
1578 val &= ~(PM_CTL_ED_EN_ | PM_CTL_WOL_EN_);
1580 ret = smsc95xx_write_reg_nopm(dev, PM_CTRL, val);
1584 ret = smsc95xx_enter_suspend2(dev);
1588 if (pdata->wolopts & WAKE_PHY) {
1589 ret = smsc95xx_enable_phy_wakeup_interrupts(dev,
1590 (PHY_INT_MASK_ANEG_COMP_ | PHY_INT_MASK_LINK_DOWN_));
1592 netdev_warn(dev->net, "error enabling PHY wakeup ints\n");
1596 /* if link is down then configure EDPD and enter SUSPEND1,
1597 * otherwise enter SUSPEND0 below
1600 netdev_info(dev->net, "entering SUSPEND1 mode\n");
1601 ret = smsc95xx_enter_suspend1(dev);
1606 if (pdata->wolopts & (WAKE_BCAST | WAKE_MCAST | WAKE_ARP | WAKE_UCAST)) {
1607 u32 *filter_mask = kcalloc(32, sizeof(u32), GFP_KERNEL);
1611 int wuff_filter_count =
1612 (pdata->features & FEATURE_8_WAKEUP_FILTERS) ?
1613 LAN9500A_WUFF_NUM : LAN9500_WUFF_NUM;
1617 netdev_warn(dev->net, "Unable to allocate filter_mask\n");
1622 memset(command, 0, sizeof(command));
1623 memset(offset, 0, sizeof(offset));
1624 memset(crc, 0, sizeof(crc));
1626 if (pdata->wolopts & WAKE_BCAST) {
1627 const u8 bcast[] = {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF};
1628 netdev_info(dev->net, "enabling broadcast detection\n");
1629 filter_mask[filter * 4] = 0x003F;
1630 filter_mask[filter * 4 + 1] = 0x00;
1631 filter_mask[filter * 4 + 2] = 0x00;
1632 filter_mask[filter * 4 + 3] = 0x00;
1633 command[filter/4] |= 0x05UL << ((filter % 4) * 8);
1634 offset[filter/4] |= 0x00 << ((filter % 4) * 8);
1635 crc[filter/2] |= smsc_crc(bcast, 6, filter);
1639 if (pdata->wolopts & WAKE_MCAST) {
1640 const u8 mcast[] = {0x01, 0x00, 0x5E};
1641 netdev_info(dev->net, "enabling multicast detection\n");
1642 filter_mask[filter * 4] = 0x0007;
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] |= 0x09UL << ((filter % 4) * 8);
1647 offset[filter/4] |= 0x00 << ((filter % 4) * 8);
1648 crc[filter/2] |= smsc_crc(mcast, 3, filter);
1652 if (pdata->wolopts & WAKE_ARP) {
1653 const u8 arp[] = {0x08, 0x06};
1654 netdev_info(dev->net, "enabling ARP detection\n");
1655 filter_mask[filter * 4] = 0x0003;
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] |= 0x05UL << ((filter % 4) * 8);
1660 offset[filter/4] |= 0x0C << ((filter % 4) * 8);
1661 crc[filter/2] |= smsc_crc(arp, 2, filter);
1665 if (pdata->wolopts & WAKE_UCAST) {
1666 netdev_info(dev->net, "enabling unicast detection\n");
1667 filter_mask[filter * 4] = 0x003F;
1668 filter_mask[filter * 4 + 1] = 0x00;
1669 filter_mask[filter * 4 + 2] = 0x00;
1670 filter_mask[filter * 4 + 3] = 0x00;
1671 command[filter/4] |= 0x01UL << ((filter % 4) * 8);
1672 offset[filter/4] |= 0x00 << ((filter % 4) * 8);
1673 crc[filter/2] |= smsc_crc(dev->net->dev_addr, ETH_ALEN, filter);
1677 for (i = 0; i < (wuff_filter_count * 4); i++) {
1678 ret = smsc95xx_write_reg_nopm(dev, WUFF, filter_mask[i]);
1686 for (i = 0; i < (wuff_filter_count / 4); i++) {
1687 ret = smsc95xx_write_reg_nopm(dev, WUFF, command[i]);
1692 for (i = 0; i < (wuff_filter_count / 4); i++) {
1693 ret = smsc95xx_write_reg_nopm(dev, WUFF, offset[i]);
1698 for (i = 0; i < (wuff_filter_count / 2); i++) {
1699 ret = smsc95xx_write_reg_nopm(dev, WUFF, crc[i]);
1704 /* clear any pending pattern match packet status */
1705 ret = smsc95xx_read_reg_nopm(dev, WUCSR, &val);
1711 ret = smsc95xx_write_reg_nopm(dev, WUCSR, val);
1716 if (pdata->wolopts & WAKE_MAGIC) {
1717 /* clear any pending magic packet status */
1718 ret = smsc95xx_read_reg_nopm(dev, WUCSR, &val);
1724 ret = smsc95xx_write_reg_nopm(dev, WUCSR, val);
1729 /* enable/disable wakeup sources */
1730 ret = smsc95xx_read_reg_nopm(dev, WUCSR, &val);
1734 if (pdata->wolopts & (WAKE_BCAST | WAKE_MCAST | WAKE_ARP | WAKE_UCAST)) {
1735 netdev_info(dev->net, "enabling pattern match wakeup\n");
1736 val |= WUCSR_WAKE_EN_;
1738 netdev_info(dev->net, "disabling pattern match wakeup\n");
1739 val &= ~WUCSR_WAKE_EN_;
1742 if (pdata->wolopts & WAKE_MAGIC) {
1743 netdev_info(dev->net, "enabling magic packet wakeup\n");
1746 netdev_info(dev->net, "disabling magic packet wakeup\n");
1747 val &= ~WUCSR_MPEN_;
1750 ret = smsc95xx_write_reg_nopm(dev, WUCSR, val);
1754 /* enable wol wakeup source */
1755 ret = smsc95xx_read_reg_nopm(dev, PM_CTRL, &val);
1759 val |= PM_CTL_WOL_EN_;
1761 /* phy energy detect wakeup source */
1762 if (pdata->wolopts & WAKE_PHY)
1763 val |= PM_CTL_ED_EN_;
1765 ret = smsc95xx_write_reg_nopm(dev, PM_CTRL, val);
1769 /* enable receiver to enable frame reception */
1770 smsc95xx_start_rx_path(dev, 1);
1772 /* some wol options are enabled, so enter SUSPEND0 */
1773 netdev_info(dev->net, "entering SUSPEND0 mode\n");
1774 ret = smsc95xx_enter_suspend0(dev);
1778 * TODO: resume() might need to handle the suspend failure
1781 if (ret && PMSG_IS_AUTO(message))
1782 usbnet_resume(intf);
1787 static int smsc95xx_resume(struct usb_interface *intf)
1789 struct usbnet *dev = usb_get_intfdata(intf);
1790 struct smsc95xx_priv *pdata;
1796 pdata = dev->driver_priv;
1797 suspend_flags = pdata->suspend_flags;
1799 netdev_dbg(dev->net, "resume suspend_flags=0x%02x\n", suspend_flags);
1801 /* do this first to ensure it's cleared even in error case */
1802 pdata->suspend_flags = 0;
1804 if (suspend_flags & SUSPEND_ALLMODES) {
1805 /* clear wake-up sources */
1806 ret = smsc95xx_read_reg_nopm(dev, WUCSR, &val);
1810 val &= ~(WUCSR_WAKE_EN_ | WUCSR_MPEN_);
1812 ret = smsc95xx_write_reg_nopm(dev, WUCSR, val);
1816 /* clear wake-up status */
1817 ret = smsc95xx_read_reg_nopm(dev, PM_CTRL, &val);
1821 val &= ~PM_CTL_WOL_EN_;
1822 val |= PM_CTL_WUPS_;
1824 ret = smsc95xx_write_reg_nopm(dev, PM_CTRL, val);
1829 ret = usbnet_resume(intf);
1831 netdev_warn(dev->net, "usbnet_resume error\n");
1833 phy_init_hw(pdata->phydev);
1837 static int smsc95xx_reset_resume(struct usb_interface *intf)
1839 struct usbnet *dev = usb_get_intfdata(intf);
1842 ret = smsc95xx_reset(dev);
1846 return smsc95xx_resume(intf);
1849 static void smsc95xx_rx_csum_offload(struct sk_buff *skb)
1851 skb->csum = *(u16 *)(skb_tail_pointer(skb) - 2);
1852 skb->ip_summed = CHECKSUM_COMPLETE;
1853 skb_trim(skb, skb->len - 2);
1856 static int smsc95xx_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
1858 /* This check is no longer done by usbnet */
1859 if (skb->len < dev->net->hard_header_len)
1862 while (skb->len > 0) {
1863 u32 header, align_count;
1864 struct sk_buff *ax_skb;
1865 unsigned char *packet;
1868 header = get_unaligned_le32(skb->data);
1869 skb_pull(skb, 4 + NET_IP_ALIGN);
1872 /* get the packet length */
1873 size = (u16)((header & RX_STS_FL_) >> 16);
1874 align_count = (4 - ((size + NET_IP_ALIGN) % 4)) % 4;
1876 if (unlikely(header & RX_STS_ES_)) {
1877 netif_dbg(dev, rx_err, dev->net,
1878 "Error header=0x%08x\n", header);
1879 dev->net->stats.rx_errors++;
1880 dev->net->stats.rx_dropped++;
1882 if (header & RX_STS_CRC_) {
1883 dev->net->stats.rx_crc_errors++;
1885 if (header & (RX_STS_TL_ | RX_STS_RF_))
1886 dev->net->stats.rx_frame_errors++;
1888 if ((header & RX_STS_LE_) &&
1889 (!(header & RX_STS_FT_)))
1890 dev->net->stats.rx_length_errors++;
1893 /* ETH_FRAME_LEN + 4(CRC) + 2(COE) + 4(Vlan) */
1894 if (unlikely(size > (ETH_FRAME_LEN + 12))) {
1895 netif_dbg(dev, rx_err, dev->net,
1896 "size err header=0x%08x\n", header);
1900 /* last frame in this batch */
1901 if (skb->len == size) {
1902 if (dev->net->features & NETIF_F_RXCSUM)
1903 smsc95xx_rx_csum_offload(skb);
1904 skb_trim(skb, skb->len - 4); /* remove fcs */
1906 skb->truesize = size + sizeof(struct sk_buff);
1911 ax_skb = skb_clone(skb, GFP_ATOMIC);
1912 if (unlikely(!ax_skb)) {
1913 netdev_warn(dev->net, "Error allocating skb\n");
1918 ax_skb->data = packet;
1919 skb_set_tail_pointer(ax_skb, size);
1921 if (dev->net->features & NETIF_F_RXCSUM)
1922 smsc95xx_rx_csum_offload(ax_skb);
1923 skb_trim(ax_skb, ax_skb->len - 4); /* remove fcs */
1925 ax_skb->truesize = size + sizeof(struct sk_buff);
1927 usbnet_skb_return(dev, ax_skb);
1930 skb_pull(skb, size);
1932 /* padding bytes before the next frame starts */
1934 skb_pull(skb, align_count);
1940 static u32 smsc95xx_calc_csum_preamble(struct sk_buff *skb)
1942 u16 low_16 = (u16)skb_checksum_start_offset(skb);
1943 u16 high_16 = low_16 + skb->csum_offset;
1944 return (high_16 << 16) | low_16;
1947 /* The TX CSUM won't work if the checksum lies in the last 4 bytes of the
1948 * transmission. This is fairly unlikely, only seems to trigger with some
1949 * short TCP ACK packets sent.
1951 * Note, this calculation should probably check for the alignment of the
1952 * data as well, but a straight check for csum being in the last four bytes
1953 * of the packet should be ok for now.
1955 static bool smsc95xx_can_tx_checksum(struct sk_buff *skb)
1957 unsigned int len = skb->len - skb_checksum_start_offset(skb);
1961 return skb->csum_offset < (len - (4 + 1));
1964 static struct sk_buff *smsc95xx_tx_fixup(struct usbnet *dev,
1965 struct sk_buff *skb, gfp_t flags)
1967 bool csum = skb->ip_summed == CHECKSUM_PARTIAL;
1968 int overhead = csum ? SMSC95XX_TX_OVERHEAD_CSUM : SMSC95XX_TX_OVERHEAD;
1969 u32 tx_cmd_a, tx_cmd_b;
1972 /* We do not advertise SG, so skbs should be already linearized */
1973 BUG_ON(skb_shinfo(skb)->nr_frags);
1975 /* Make writable and expand header space by overhead if required */
1976 if (skb_cow_head(skb, overhead)) {
1977 /* Must deallocate here as returning NULL to indicate error
1978 * means the skb won't be deallocated in the caller.
1980 dev_kfree_skb_any(skb);
1984 tx_cmd_b = (u32)skb->len;
1985 tx_cmd_a = tx_cmd_b | TX_CMD_A_FIRST_SEG_ | TX_CMD_A_LAST_SEG_;
1988 if (!smsc95xx_can_tx_checksum(skb)) {
1989 /* workaround - hardware tx checksum does not work
1990 * properly with extremely small packets */
1991 long csstart = skb_checksum_start_offset(skb);
1992 __wsum calc = csum_partial(skb->data + csstart,
1993 skb->len - csstart, 0);
1994 *((__sum16 *)(skb->data + csstart
1995 + skb->csum_offset)) = csum_fold(calc);
1999 u32 csum_preamble = smsc95xx_calc_csum_preamble(skb);
2000 ptr = skb_push(skb, 4);
2001 put_unaligned_le32(csum_preamble, ptr);
2005 tx_cmd_b |= TX_CMD_B_CSUM_ENABLE;
2009 ptr = skb_push(skb, 8);
2010 put_unaligned_le32(tx_cmd_a, ptr);
2011 put_unaligned_le32(tx_cmd_b, ptr+4);
2016 static int smsc95xx_manage_power(struct usbnet *dev, int on)
2018 struct smsc95xx_priv *pdata = dev->driver_priv;
2020 dev->intf->needs_remote_wakeup = on;
2022 if (pdata->features & FEATURE_REMOTE_WAKEUP)
2025 /* this chip revision isn't capable of remote wakeup */
2026 netdev_info(dev->net, "hardware isn't capable of remote wakeup\n");
2029 usb_autopm_get_interface_no_resume(dev->intf);
2031 usb_autopm_put_interface(dev->intf);
2036 static const struct driver_info smsc95xx_info = {
2037 .description = "smsc95xx USB 2.0 Ethernet",
2038 .bind = smsc95xx_bind,
2039 .unbind = smsc95xx_unbind,
2040 .link_reset = smsc95xx_link_reset,
2041 .reset = smsc95xx_reset,
2042 .check_connect = smsc95xx_start_phy,
2043 .stop = smsc95xx_stop,
2044 .rx_fixup = smsc95xx_rx_fixup,
2045 .tx_fixup = smsc95xx_tx_fixup,
2046 .status = smsc95xx_status,
2047 .manage_power = smsc95xx_manage_power,
2048 .flags = FLAG_ETHER | FLAG_SEND_ZLP | FLAG_LINK_INTR,
2051 static const struct usb_device_id products[] = {
2053 /* SMSC9500 USB Ethernet Device */
2054 USB_DEVICE(0x0424, 0x9500),
2055 .driver_info = (unsigned long) &smsc95xx_info,
2058 /* SMSC9505 USB Ethernet Device */
2059 USB_DEVICE(0x0424, 0x9505),
2060 .driver_info = (unsigned long) &smsc95xx_info,
2063 /* SMSC9500A USB Ethernet Device */
2064 USB_DEVICE(0x0424, 0x9E00),
2065 .driver_info = (unsigned long) &smsc95xx_info,
2068 /* SMSC9505A USB Ethernet Device */
2069 USB_DEVICE(0x0424, 0x9E01),
2070 .driver_info = (unsigned long) &smsc95xx_info,
2073 /* SMSC9512/9514 USB Hub & Ethernet Device */
2074 USB_DEVICE(0x0424, 0xec00),
2075 .driver_info = (unsigned long) &smsc95xx_info,
2078 /* SMSC9500 USB Ethernet Device (SAL10) */
2079 USB_DEVICE(0x0424, 0x9900),
2080 .driver_info = (unsigned long) &smsc95xx_info,
2083 /* SMSC9505 USB Ethernet Device (SAL10) */
2084 USB_DEVICE(0x0424, 0x9901),
2085 .driver_info = (unsigned long) &smsc95xx_info,
2088 /* SMSC9500A USB Ethernet Device (SAL10) */
2089 USB_DEVICE(0x0424, 0x9902),
2090 .driver_info = (unsigned long) &smsc95xx_info,
2093 /* SMSC9505A USB Ethernet Device (SAL10) */
2094 USB_DEVICE(0x0424, 0x9903),
2095 .driver_info = (unsigned long) &smsc95xx_info,
2098 /* SMSC9512/9514 USB Hub & Ethernet Device (SAL10) */
2099 USB_DEVICE(0x0424, 0x9904),
2100 .driver_info = (unsigned long) &smsc95xx_info,
2103 /* SMSC9500A USB Ethernet Device (HAL) */
2104 USB_DEVICE(0x0424, 0x9905),
2105 .driver_info = (unsigned long) &smsc95xx_info,
2108 /* SMSC9505A USB Ethernet Device (HAL) */
2109 USB_DEVICE(0x0424, 0x9906),
2110 .driver_info = (unsigned long) &smsc95xx_info,
2113 /* SMSC9500 USB Ethernet Device (Alternate ID) */
2114 USB_DEVICE(0x0424, 0x9907),
2115 .driver_info = (unsigned long) &smsc95xx_info,
2118 /* SMSC9500A USB Ethernet Device (Alternate ID) */
2119 USB_DEVICE(0x0424, 0x9908),
2120 .driver_info = (unsigned long) &smsc95xx_info,
2123 /* SMSC9512/9514 USB Hub & Ethernet Device (Alternate ID) */
2124 USB_DEVICE(0x0424, 0x9909),
2125 .driver_info = (unsigned long) &smsc95xx_info,
2128 /* SMSC LAN9530 USB Ethernet Device */
2129 USB_DEVICE(0x0424, 0x9530),
2130 .driver_info = (unsigned long) &smsc95xx_info,
2133 /* SMSC LAN9730 USB Ethernet Device */
2134 USB_DEVICE(0x0424, 0x9730),
2135 .driver_info = (unsigned long) &smsc95xx_info,
2138 /* SMSC LAN89530 USB Ethernet Device */
2139 USB_DEVICE(0x0424, 0x9E08),
2140 .driver_info = (unsigned long) &smsc95xx_info,
2144 MODULE_DEVICE_TABLE(usb, products);
2146 static struct usb_driver smsc95xx_driver = {
2148 .id_table = products,
2149 .probe = usbnet_probe,
2150 .suspend = smsc95xx_suspend,
2151 .resume = smsc95xx_resume,
2152 .reset_resume = smsc95xx_reset_resume,
2153 .disconnect = usbnet_disconnect,
2154 .disable_hub_initiated_lpm = 1,
2155 .supports_autosuspend = 1,
2158 module_usb_driver(smsc95xx_driver);
2160 MODULE_AUTHOR("Nancy Lin");
2161 MODULE_AUTHOR("Steve Glendinning <steve.glendinning@shawell.net>");
2162 MODULE_DESCRIPTION("SMSC95XX USB 2.0 Ethernet Devices");
2163 MODULE_LICENSE("GPL");