2 * MOSCHIP MCS7830 based (7730/7830/7832) USB 2.0 Ethernet Devices
4 * based on usbnet.c, asix.c and the vendor provided mcs7830 driver
6 * Copyright (C) 2010 Andreas Mohr <andi@lisas.de>
7 * Copyright (C) 2006 Arnd Bergmann <arnd@arndb.de>
8 * Copyright (C) 2003-2005 David Hollis <dhollis@davehollis.com>
9 * Copyright (C) 2005 Phil Chang <pchang23@sbcglobal.net>
10 * Copyright (c) 2002-2003 TiVo Inc.
12 * Definitions gathered from MOSCHIP, Data Sheet_7830DA.pdf (thanks!).
14 * 2010-12-19: add 7832 USB PID ("functionality same as MCS7830"),
15 * per active notification by manufacturer
18 * - support HIF_REG_CONFIG_SLEEPMODE/HIF_REG_CONFIG_TXENABLE (via autopm?)
19 * - implement ethtool_ops get_pauseparam/set_pauseparam
20 * via HIF_REG_PAUSE_THRESHOLD (>= revision C only!)
21 * - implement get_eeprom/[set_eeprom]
22 * - switch PHY on/off on ifup/ifdown (perhaps in usbnet.c, via MII)
23 * - mcs7830_get_regs() handling is weird: for rev 2 we return 32 regs,
24 * can access only ~ 24, remaining user buffer is uninitialized garbage
28 * This program is free software; you can redistribute it and/or modify
29 * it under the terms of the GNU General Public License as published by
30 * the Free Software Foundation; either version 2 of the License, or
31 * (at your option) any later version.
33 * This program is distributed in the hope that it will be useful,
34 * but WITHOUT ANY WARRANTY; without even the implied warranty of
35 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
36 * GNU General Public License for more details.
38 * You should have received a copy of the GNU General Public License
39 * along with this program; if not, see <http://www.gnu.org/licenses/>.
42 #include <linux/crc32.h>
43 #include <linux/etherdevice.h>
44 #include <linux/ethtool.h>
45 #include <linux/mii.h>
46 #include <linux/module.h>
47 #include <linux/netdevice.h>
48 #include <linux/slab.h>
49 #include <linux/usb.h>
50 #include <linux/usb/usbnet.h>
53 #define MCS7830_RD_BMREQ (USB_DIR_IN | USB_TYPE_VENDOR | \
55 #define MCS7830_WR_BMREQ (USB_DIR_OUT | USB_TYPE_VENDOR | \
57 #define MCS7830_RD_BREQ 0x0E
58 #define MCS7830_WR_BREQ 0x0D
60 #define MCS7830_CTRL_TIMEOUT 1000
61 #define MCS7830_MAX_MCAST 64
63 #define MCS7830_VENDOR_ID 0x9710
64 #define MCS7832_PRODUCT_ID 0x7832
65 #define MCS7830_PRODUCT_ID 0x7830
66 #define MCS7730_PRODUCT_ID 0x7730
68 #define SITECOM_VENDOR_ID 0x0DF6
69 #define LN_030_PRODUCT_ID 0x0021
71 #define MCS7830_MII_ADVERTISE (ADVERTISE_PAUSE_CAP | ADVERTISE_100FULL | \
72 ADVERTISE_100HALF | ADVERTISE_10FULL | \
73 ADVERTISE_10HALF | ADVERTISE_CSMA)
75 /* HIF_REG_XX corresponding index value */
77 HIF_REG_MULTICAST_HASH = 0x00,
78 HIF_REG_PACKET_GAP1 = 0x08,
79 HIF_REG_PACKET_GAP2 = 0x09,
80 HIF_REG_PHY_DATA = 0x0a,
81 HIF_REG_PHY_CMD1 = 0x0c,
82 HIF_REG_PHY_CMD1_READ = 0x40,
83 HIF_REG_PHY_CMD1_WRITE = 0x20,
84 HIF_REG_PHY_CMD1_PHYADDR = 0x01,
85 HIF_REG_PHY_CMD2 = 0x0d,
86 HIF_REG_PHY_CMD2_PEND_FLAG_BIT = 0x80,
87 HIF_REG_PHY_CMD2_READY_FLAG_BIT = 0x40,
88 HIF_REG_CONFIG = 0x0e,
89 /* hmm, spec sez: "R/W", "Except bit 3" (likely TXENABLE). */
90 HIF_REG_CONFIG_CFG = 0x80,
91 HIF_REG_CONFIG_SPEED100 = 0x40,
92 HIF_REG_CONFIG_FULLDUPLEX_ENABLE = 0x20,
93 HIF_REG_CONFIG_RXENABLE = 0x10,
94 HIF_REG_CONFIG_TXENABLE = 0x08,
95 HIF_REG_CONFIG_SLEEPMODE = 0x04,
96 HIF_REG_CONFIG_ALLMULTICAST = 0x02,
97 HIF_REG_CONFIG_PROMISCUOUS = 0x01,
98 HIF_REG_ETHERNET_ADDR = 0x0f,
99 HIF_REG_FRAME_DROP_COUNTER = 0x15, /* 0..ff; reset: 0 */
100 HIF_REG_PAUSE_THRESHOLD = 0x16,
101 HIF_REG_PAUSE_THRESHOLD_DEFAULT = 0,
104 /* Trailing status byte in Ethernet Rx frame */
106 MCS7830_RX_SHORT_FRAME = 0x01, /* < 64 bytes */
107 MCS7830_RX_LENGTH_ERROR = 0x02, /* framelen != Ethernet length field */
108 MCS7830_RX_ALIGNMENT_ERROR = 0x04, /* non-even number of nibbles */
109 MCS7830_RX_CRC_ERROR = 0x08,
110 MCS7830_RX_LARGE_FRAME = 0x10, /* > 1518 bytes */
111 MCS7830_RX_FRAME_CORRECT = 0x20, /* frame is correct */
115 struct mcs7830_data {
120 static const char driver_name[] = "MOSCHIP usb-ethernet driver";
122 static int mcs7830_get_reg(struct usbnet *dev, u16 index, u16 size, void *data)
126 ret = usbnet_read_cmd(dev, MCS7830_RD_BREQ, MCS7830_RD_BMREQ,
127 0x0000, index, data, size);
136 static int mcs7830_set_reg(struct usbnet *dev, u16 index, u16 size, const void *data)
138 return usbnet_write_cmd(dev, MCS7830_WR_BREQ, MCS7830_WR_BMREQ,
139 0x0000, index, data, size);
142 static void mcs7830_set_reg_async(struct usbnet *dev, u16 index, u16 size, void *data)
144 usbnet_write_cmd_async(dev, MCS7830_WR_BREQ, MCS7830_WR_BMREQ,
145 0x0000, index, data, size);
148 static int mcs7830_hif_get_mac_address(struct usbnet *dev, unsigned char *addr)
150 int ret = mcs7830_get_reg(dev, HIF_REG_ETHERNET_ADDR, ETH_ALEN, addr);
156 static int mcs7830_hif_set_mac_address(struct usbnet *dev, unsigned char *addr)
158 int ret = mcs7830_set_reg(dev, HIF_REG_ETHERNET_ADDR, ETH_ALEN, addr);
165 static int mcs7830_set_mac_address(struct net_device *netdev, void *p)
168 struct usbnet *dev = netdev_priv(netdev);
169 struct sockaddr *addr = p;
171 if (netif_running(netdev))
174 if (!is_valid_ether_addr(addr->sa_data))
175 return -EADDRNOTAVAIL;
177 ret = mcs7830_hif_set_mac_address(dev, addr->sa_data);
182 /* it worked --> adopt it on netdev side */
183 memcpy(netdev->dev_addr, addr->sa_data, netdev->addr_len);
188 static int mcs7830_read_phy(struct usbnet *dev, u8 index)
195 HIF_REG_PHY_CMD1_READ | HIF_REG_PHY_CMD1_PHYADDR,
196 HIF_REG_PHY_CMD2_PEND_FLAG_BIT | index,
199 mutex_lock(&dev->phy_mutex);
200 /* write the MII command */
201 ret = mcs7830_set_reg(dev, HIF_REG_PHY_CMD1, 2, cmd);
205 /* wait for the data to become valid, should be within < 1ms */
206 for (i = 0; i < 10; i++) {
207 ret = mcs7830_get_reg(dev, HIF_REG_PHY_CMD1, 2, cmd);
208 if ((ret < 0) || (cmd[1] & HIF_REG_PHY_CMD2_READY_FLAG_BIT))
216 /* read actual register contents */
217 ret = mcs7830_get_reg(dev, HIF_REG_PHY_DATA, 2, &val);
220 ret = le16_to_cpu(val);
221 dev_dbg(&dev->udev->dev, "read PHY reg %02x: %04x (%d tries)\n",
224 mutex_unlock(&dev->phy_mutex);
228 static int mcs7830_write_phy(struct usbnet *dev, u8 index, u16 val)
235 HIF_REG_PHY_CMD1_WRITE | HIF_REG_PHY_CMD1_PHYADDR,
236 HIF_REG_PHY_CMD2_PEND_FLAG_BIT | (index & 0x1F),
239 mutex_lock(&dev->phy_mutex);
241 /* write the new register contents */
242 le_val = cpu_to_le16(val);
243 ret = mcs7830_set_reg(dev, HIF_REG_PHY_DATA, 2, &le_val);
247 /* write the MII command */
248 ret = mcs7830_set_reg(dev, HIF_REG_PHY_CMD1, 2, cmd);
252 /* wait for the command to be accepted by the PHY */
253 for (i = 0; i < 10; i++) {
254 ret = mcs7830_get_reg(dev, HIF_REG_PHY_CMD1, 2, cmd);
255 if ((ret < 0) || (cmd[1] & HIF_REG_PHY_CMD2_READY_FLAG_BIT))
264 dev_dbg(&dev->udev->dev, "write PHY reg %02x: %04x (%d tries)\n",
267 mutex_unlock(&dev->phy_mutex);
272 * This algorithm comes from the original mcs7830 version 1.4 driver,
273 * not sure if it is needed.
275 static int mcs7830_set_autoneg(struct usbnet *dev, int ptrUserPhyMode)
278 /* Enable all media types */
279 ret = mcs7830_write_phy(dev, MII_ADVERTISE, MCS7830_MII_ADVERTISE);
281 /* First reset BMCR */
283 ret = mcs7830_write_phy(dev, MII_BMCR, 0x0000);
284 /* Enable Auto Neg */
286 ret = mcs7830_write_phy(dev, MII_BMCR, BMCR_ANENABLE);
287 /* Restart Auto Neg (Keep the Enable Auto Neg Bit Set) */
289 ret = mcs7830_write_phy(dev, MII_BMCR,
290 BMCR_ANENABLE | BMCR_ANRESTART );
296 * if we can read register 22, the chip revision is C or higher
298 static int mcs7830_get_rev(struct usbnet *dev)
302 ret = mcs7830_get_reg(dev, HIF_REG_FRAME_DROP_COUNTER, 2, dummy);
304 return 2; /* Rev C or later */
305 return 1; /* earlier revision */
309 * On rev. C we need to set the pause threshold
311 static void mcs7830_rev_C_fixup(struct usbnet *dev)
313 u8 pause_threshold = HIF_REG_PAUSE_THRESHOLD_DEFAULT;
316 for (retry = 0; retry < 2; retry++) {
317 if (mcs7830_get_rev(dev) == 2) {
318 dev_info(&dev->udev->dev, "applying rev.C fixup\n");
319 mcs7830_set_reg(dev, HIF_REG_PAUSE_THRESHOLD,
320 1, &pause_threshold);
326 static int mcs7830_mdio_read(struct net_device *netdev, int phy_id,
329 struct usbnet *dev = netdev_priv(netdev);
330 return mcs7830_read_phy(dev, location);
333 static void mcs7830_mdio_write(struct net_device *netdev, int phy_id,
334 int location, int val)
336 struct usbnet *dev = netdev_priv(netdev);
337 mcs7830_write_phy(dev, location, val);
340 static int mcs7830_ioctl(struct net_device *net, struct ifreq *rq, int cmd)
342 struct usbnet *dev = netdev_priv(net);
343 return generic_mii_ioctl(&dev->mii, if_mii(rq), cmd, NULL);
346 static inline struct mcs7830_data *mcs7830_get_data(struct usbnet *dev)
348 return (struct mcs7830_data *)&dev->data;
351 static void mcs7830_hif_update_multicast_hash(struct usbnet *dev)
353 struct mcs7830_data *data = mcs7830_get_data(dev);
354 mcs7830_set_reg_async(dev, HIF_REG_MULTICAST_HASH,
355 sizeof data->multi_filter,
359 static void mcs7830_hif_update_config(struct usbnet *dev)
361 /* implementation specific to data->config
362 (argument needs to be heap-based anyway - USB DMA!) */
363 struct mcs7830_data *data = mcs7830_get_data(dev);
364 mcs7830_set_reg_async(dev, HIF_REG_CONFIG, 1, &data->config);
367 static void mcs7830_data_set_multicast(struct net_device *net)
369 struct usbnet *dev = netdev_priv(net);
370 struct mcs7830_data *data = mcs7830_get_data(dev);
372 memset(data->multi_filter, 0, sizeof data->multi_filter);
374 data->config = HIF_REG_CONFIG_TXENABLE;
376 /* this should not be needed, but it doesn't work otherwise */
377 data->config |= HIF_REG_CONFIG_ALLMULTICAST;
379 if (net->flags & IFF_PROMISC) {
380 data->config |= HIF_REG_CONFIG_PROMISCUOUS;
381 } else if (net->flags & IFF_ALLMULTI ||
382 netdev_mc_count(net) > MCS7830_MAX_MCAST) {
383 data->config |= HIF_REG_CONFIG_ALLMULTICAST;
384 } else if (netdev_mc_empty(net)) {
385 /* just broadcast and directed */
387 /* We use the 20 byte dev->data
388 * for our 8 byte filter buffer
389 * to avoid allocating memory that
390 * is tricky to free later */
391 struct netdev_hw_addr *ha;
394 /* Build the multicast hash filter. */
395 netdev_for_each_mc_addr(ha, net) {
396 crc_bits = ether_crc(ETH_ALEN, ha->addr) >> 26;
397 data->multi_filter[crc_bits >> 3] |= 1 << (crc_bits & 7);
402 static int mcs7830_apply_base_config(struct usbnet *dev)
406 /* re-configure known MAC (suspend case etc.) */
407 ret = mcs7830_hif_set_mac_address(dev, dev->net->dev_addr);
409 dev_info(&dev->udev->dev, "Cannot set MAC address\n");
414 ret = mcs7830_set_autoneg(dev, 0);
416 dev_info(&dev->udev->dev, "Cannot set autoneg\n");
420 mcs7830_hif_update_multicast_hash(dev);
421 mcs7830_hif_update_config(dev);
423 mcs7830_rev_C_fixup(dev);
429 /* credits go to asix_set_multicast */
430 static void mcs7830_set_multicast(struct net_device *net)
432 struct usbnet *dev = netdev_priv(net);
434 mcs7830_data_set_multicast(net);
436 mcs7830_hif_update_multicast_hash(dev);
437 mcs7830_hif_update_config(dev);
440 static int mcs7830_get_regs_len(struct net_device *net)
442 struct usbnet *dev = netdev_priv(net);
444 switch (mcs7830_get_rev(dev)) {
453 static void mcs7830_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *drvinfo)
455 usbnet_get_drvinfo(net, drvinfo);
458 static void mcs7830_get_regs(struct net_device *net, struct ethtool_regs *regs, void *data)
460 struct usbnet *dev = netdev_priv(net);
462 regs->version = mcs7830_get_rev(dev);
463 mcs7830_get_reg(dev, 0, regs->len, data);
466 static const struct ethtool_ops mcs7830_ethtool_ops = {
467 .get_drvinfo = mcs7830_get_drvinfo,
468 .get_regs_len = mcs7830_get_regs_len,
469 .get_regs = mcs7830_get_regs,
471 /* common usbnet calls */
472 .get_link = usbnet_get_link,
473 .get_msglevel = usbnet_get_msglevel,
474 .set_msglevel = usbnet_set_msglevel,
475 .nway_reset = usbnet_nway_reset,
476 .get_link_ksettings = usbnet_get_link_ksettings,
477 .set_link_ksettings = usbnet_set_link_ksettings,
480 static const struct net_device_ops mcs7830_netdev_ops = {
481 .ndo_open = usbnet_open,
482 .ndo_stop = usbnet_stop,
483 .ndo_start_xmit = usbnet_start_xmit,
484 .ndo_tx_timeout = usbnet_tx_timeout,
485 .ndo_change_mtu = usbnet_change_mtu,
486 .ndo_get_stats64 = usbnet_get_stats64,
487 .ndo_validate_addr = eth_validate_addr,
488 .ndo_do_ioctl = mcs7830_ioctl,
489 .ndo_set_rx_mode = mcs7830_set_multicast,
490 .ndo_set_mac_address = mcs7830_set_mac_address,
493 static int mcs7830_bind(struct usbnet *dev, struct usb_interface *udev)
495 struct net_device *net = dev->net;
499 /* Initial startup: Gather MAC address setting from EEPROM */
501 for (retry = 0; retry < 5 && ret; retry++)
502 ret = mcs7830_hif_get_mac_address(dev, net->dev_addr);
504 dev_warn(&dev->udev->dev, "Cannot read MAC address\n");
508 mcs7830_data_set_multicast(net);
510 ret = mcs7830_apply_base_config(dev);
514 net->ethtool_ops = &mcs7830_ethtool_ops;
515 net->netdev_ops = &mcs7830_netdev_ops;
517 /* reserve space for the status byte on rx */
518 dev->rx_urb_size = ETH_FRAME_LEN + 1;
520 dev->mii.mdio_read = mcs7830_mdio_read;
521 dev->mii.mdio_write = mcs7830_mdio_write;
523 dev->mii.phy_id_mask = 0x3f;
524 dev->mii.reg_num_mask = 0x1f;
525 dev->mii.phy_id = *((u8 *) net->dev_addr + 1);
527 ret = usbnet_get_endpoints(dev, udev);
532 /* The chip always appends a status byte that we need to strip */
533 static int mcs7830_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
537 /* This check is no longer done by usbnet */
538 if (skb->len < dev->net->hard_header_len) {
539 dev_err(&dev->udev->dev, "unexpected tiny rx frame\n");
543 skb_trim(skb, skb->len - 1);
544 status = skb->data[skb->len];
546 if (status != MCS7830_RX_FRAME_CORRECT) {
547 dev_dbg(&dev->udev->dev, "rx fixup status %x\n", status);
549 /* hmm, perhaps usbnet.c already sees a globally visible
550 frame error and increments rx_errors on its own already? */
551 dev->net->stats.rx_errors++;
553 if (status & (MCS7830_RX_SHORT_FRAME
554 |MCS7830_RX_LENGTH_ERROR
555 |MCS7830_RX_LARGE_FRAME))
556 dev->net->stats.rx_length_errors++;
557 if (status & MCS7830_RX_ALIGNMENT_ERROR)
558 dev->net->stats.rx_frame_errors++;
559 if (status & MCS7830_RX_CRC_ERROR)
560 dev->net->stats.rx_crc_errors++;
566 static void mcs7830_status(struct usbnet *dev, struct urb *urb)
568 u8 *buf = urb->transfer_buffer;
569 bool link, link_changed;
571 if (urb->actual_length < 16)
574 link = !(buf[1] == 0x20);
575 link_changed = netif_carrier_ok(dev->net) != link;
577 usbnet_link_change(dev, link, 0);
578 netdev_dbg(dev->net, "Link Status is: %d\n", link);
582 static const struct driver_info moschip_info = {
583 .description = "MOSCHIP 7830/7832/7730 usb-NET adapter",
584 .bind = mcs7830_bind,
585 .rx_fixup = mcs7830_rx_fixup,
586 .flags = FLAG_ETHER | FLAG_LINK_INTR,
587 .status = mcs7830_status,
592 static const struct driver_info sitecom_info = {
593 .description = "Sitecom LN-30 usb-NET adapter",
594 .bind = mcs7830_bind,
595 .rx_fixup = mcs7830_rx_fixup,
596 .flags = FLAG_ETHER | FLAG_LINK_INTR,
597 .status = mcs7830_status,
602 static const struct usb_device_id products[] = {
604 USB_DEVICE(MCS7830_VENDOR_ID, MCS7832_PRODUCT_ID),
605 .driver_info = (unsigned long) &moschip_info,
608 USB_DEVICE(MCS7830_VENDOR_ID, MCS7830_PRODUCT_ID),
609 .driver_info = (unsigned long) &moschip_info,
612 USB_DEVICE(MCS7830_VENDOR_ID, MCS7730_PRODUCT_ID),
613 .driver_info = (unsigned long) &moschip_info,
616 USB_DEVICE(SITECOM_VENDOR_ID, LN_030_PRODUCT_ID),
617 .driver_info = (unsigned long) &sitecom_info,
621 MODULE_DEVICE_TABLE(usb, products);
623 static int mcs7830_reset_resume (struct usb_interface *intf)
625 /* YES, this function is successful enough that ethtool -d
626 does show same output pre-/post-suspend */
628 struct usbnet *dev = usb_get_intfdata(intf);
630 mcs7830_apply_base_config(dev);
637 static struct usb_driver mcs7830_driver = {
639 .id_table = products,
640 .probe = usbnet_probe,
641 .disconnect = usbnet_disconnect,
642 .suspend = usbnet_suspend,
643 .resume = usbnet_resume,
644 .reset_resume = mcs7830_reset_resume,
645 .disable_hub_initiated_lpm = 1,
648 module_usb_driver(mcs7830_driver);
650 MODULE_DESCRIPTION("USB to network adapter MCS7830)");
651 MODULE_LICENSE("GPL");