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/init.h>
46 #include <linux/mii.h>
47 #include <linux/module.h>
48 #include <linux/netdevice.h>
49 #include <linux/slab.h>
50 #include <linux/usb.h>
51 #include <linux/usb/usbnet.h>
54 #define MCS7830_RD_BMREQ (USB_DIR_IN | USB_TYPE_VENDOR | \
56 #define MCS7830_WR_BMREQ (USB_DIR_OUT | USB_TYPE_VENDOR | \
58 #define MCS7830_RD_BREQ 0x0E
59 #define MCS7830_WR_BREQ 0x0D
61 #define MCS7830_CTRL_TIMEOUT 1000
62 #define MCS7830_MAX_MCAST 64
64 #define MCS7830_VENDOR_ID 0x9710
65 #define MCS7832_PRODUCT_ID 0x7832
66 #define MCS7830_PRODUCT_ID 0x7830
67 #define MCS7730_PRODUCT_ID 0x7730
69 #define SITECOM_VENDOR_ID 0x0DF6
70 #define LN_030_PRODUCT_ID 0x0021
72 #define MCS7830_MII_ADVERTISE (ADVERTISE_PAUSE_CAP | ADVERTISE_100FULL | \
73 ADVERTISE_100HALF | ADVERTISE_10FULL | \
74 ADVERTISE_10HALF | ADVERTISE_CSMA)
76 /* HIF_REG_XX corresponding index value */
78 HIF_REG_MULTICAST_HASH
= 0x00,
79 HIF_REG_PACKET_GAP1
= 0x08,
80 HIF_REG_PACKET_GAP2
= 0x09,
81 HIF_REG_PHY_DATA
= 0x0a,
82 HIF_REG_PHY_CMD1
= 0x0c,
83 HIF_REG_PHY_CMD1_READ
= 0x40,
84 HIF_REG_PHY_CMD1_WRITE
= 0x20,
85 HIF_REG_PHY_CMD1_PHYADDR
= 0x01,
86 HIF_REG_PHY_CMD2
= 0x0d,
87 HIF_REG_PHY_CMD2_PEND_FLAG_BIT
= 0x80,
88 HIF_REG_PHY_CMD2_READY_FLAG_BIT
= 0x40,
89 HIF_REG_CONFIG
= 0x0e,
90 /* hmm, spec sez: "R/W", "Except bit 3" (likely TXENABLE). */
91 HIF_REG_CONFIG_CFG
= 0x80,
92 HIF_REG_CONFIG_SPEED100
= 0x40,
93 HIF_REG_CONFIG_FULLDUPLEX_ENABLE
= 0x20,
94 HIF_REG_CONFIG_RXENABLE
= 0x10,
95 HIF_REG_CONFIG_TXENABLE
= 0x08,
96 HIF_REG_CONFIG_SLEEPMODE
= 0x04,
97 HIF_REG_CONFIG_ALLMULTICAST
= 0x02,
98 HIF_REG_CONFIG_PROMISCUOUS
= 0x01,
99 HIF_REG_ETHERNET_ADDR
= 0x0f,
100 HIF_REG_FRAME_DROP_COUNTER
= 0x15, /* 0..ff; reset: 0 */
101 HIF_REG_PAUSE_THRESHOLD
= 0x16,
102 HIF_REG_PAUSE_THRESHOLD_DEFAULT
= 0,
105 /* Trailing status byte in Ethernet Rx frame */
107 MCS7830_RX_SHORT_FRAME
= 0x01, /* < 64 bytes */
108 MCS7830_RX_LENGTH_ERROR
= 0x02, /* framelen != Ethernet length field */
109 MCS7830_RX_ALIGNMENT_ERROR
= 0x04, /* non-even number of nibbles */
110 MCS7830_RX_CRC_ERROR
= 0x08,
111 MCS7830_RX_LARGE_FRAME
= 0x10, /* > 1518 bytes */
112 MCS7830_RX_FRAME_CORRECT
= 0x20, /* frame is correct */
116 struct mcs7830_data
{
122 static const char driver_name
[] = "MOSCHIP usb-ethernet driver";
124 static int mcs7830_get_reg(struct usbnet
*dev
, u16 index
, u16 size
, void *data
)
126 return usbnet_read_cmd(dev
, MCS7830_RD_BREQ
, MCS7830_RD_BMREQ
,
127 0x0000, index
, data
, size
);
130 static int mcs7830_set_reg(struct usbnet
*dev
, u16 index
, u16 size
, const void *data
)
132 return usbnet_write_cmd(dev
, MCS7830_WR_BREQ
, MCS7830_WR_BMREQ
,
133 0x0000, index
, data
, size
);
136 static void mcs7830_set_reg_async(struct usbnet
*dev
, u16 index
, u16 size
, void *data
)
138 usbnet_write_cmd_async(dev
, MCS7830_WR_BREQ
, MCS7830_WR_BMREQ
,
139 0x0000, index
, data
, size
);
142 static int mcs7830_hif_get_mac_address(struct usbnet
*dev
, unsigned char *addr
)
144 int ret
= mcs7830_get_reg(dev
, HIF_REG_ETHERNET_ADDR
, ETH_ALEN
, addr
);
150 static int mcs7830_hif_set_mac_address(struct usbnet
*dev
, unsigned char *addr
)
152 int ret
= mcs7830_set_reg(dev
, HIF_REG_ETHERNET_ADDR
, ETH_ALEN
, addr
);
159 static int mcs7830_set_mac_address(struct net_device
*netdev
, void *p
)
162 struct usbnet
*dev
= netdev_priv(netdev
);
163 struct sockaddr
*addr
= p
;
165 if (netif_running(netdev
))
168 if (!is_valid_ether_addr(addr
->sa_data
))
169 return -EADDRNOTAVAIL
;
171 ret
= mcs7830_hif_set_mac_address(dev
, addr
->sa_data
);
176 /* it worked --> adopt it on netdev side */
177 memcpy(netdev
->dev_addr
, addr
->sa_data
, netdev
->addr_len
);
182 static int mcs7830_read_phy(struct usbnet
*dev
, u8 index
)
189 HIF_REG_PHY_CMD1_READ
| HIF_REG_PHY_CMD1_PHYADDR
,
190 HIF_REG_PHY_CMD2_PEND_FLAG_BIT
| index
,
193 mutex_lock(&dev
->phy_mutex
);
194 /* write the MII command */
195 ret
= mcs7830_set_reg(dev
, HIF_REG_PHY_CMD1
, 2, cmd
);
199 /* wait for the data to become valid, should be within < 1ms */
200 for (i
= 0; i
< 10; i
++) {
201 ret
= mcs7830_get_reg(dev
, HIF_REG_PHY_CMD1
, 2, cmd
);
202 if ((ret
< 0) || (cmd
[1] & HIF_REG_PHY_CMD2_READY_FLAG_BIT
))
210 /* read actual register contents */
211 ret
= mcs7830_get_reg(dev
, HIF_REG_PHY_DATA
, 2, &val
);
214 ret
= le16_to_cpu(val
);
215 dev_dbg(&dev
->udev
->dev
, "read PHY reg %02x: %04x (%d tries)\n",
218 mutex_unlock(&dev
->phy_mutex
);
222 static int mcs7830_write_phy(struct usbnet
*dev
, u8 index
, u16 val
)
229 HIF_REG_PHY_CMD1_WRITE
| HIF_REG_PHY_CMD1_PHYADDR
,
230 HIF_REG_PHY_CMD2_PEND_FLAG_BIT
| (index
& 0x1F),
233 mutex_lock(&dev
->phy_mutex
);
235 /* write the new register contents */
236 le_val
= cpu_to_le16(val
);
237 ret
= mcs7830_set_reg(dev
, HIF_REG_PHY_DATA
, 2, &le_val
);
241 /* write the MII command */
242 ret
= mcs7830_set_reg(dev
, HIF_REG_PHY_CMD1
, 2, cmd
);
246 /* wait for the command to be accepted by the PHY */
247 for (i
= 0; i
< 10; i
++) {
248 ret
= mcs7830_get_reg(dev
, HIF_REG_PHY_CMD1
, 2, cmd
);
249 if ((ret
< 0) || (cmd
[1] & HIF_REG_PHY_CMD2_READY_FLAG_BIT
))
258 dev_dbg(&dev
->udev
->dev
, "write PHY reg %02x: %04x (%d tries)\n",
261 mutex_unlock(&dev
->phy_mutex
);
266 * This algorithm comes from the original mcs7830 version 1.4 driver,
267 * not sure if it is needed.
269 static int mcs7830_set_autoneg(struct usbnet
*dev
, int ptrUserPhyMode
)
272 /* Enable all media types */
273 ret
= mcs7830_write_phy(dev
, MII_ADVERTISE
, MCS7830_MII_ADVERTISE
);
275 /* First reset BMCR */
277 ret
= mcs7830_write_phy(dev
, MII_BMCR
, 0x0000);
278 /* Enable Auto Neg */
280 ret
= mcs7830_write_phy(dev
, MII_BMCR
, BMCR_ANENABLE
);
281 /* Restart Auto Neg (Keep the Enable Auto Neg Bit Set) */
283 ret
= mcs7830_write_phy(dev
, MII_BMCR
,
284 BMCR_ANENABLE
| BMCR_ANRESTART
);
290 * if we can read register 22, the chip revision is C or higher
292 static int mcs7830_get_rev(struct usbnet
*dev
)
296 ret
= mcs7830_get_reg(dev
, HIF_REG_FRAME_DROP_COUNTER
, 2, dummy
);
298 return 2; /* Rev C or later */
299 return 1; /* earlier revision */
303 * On rev. C we need to set the pause threshold
305 static void mcs7830_rev_C_fixup(struct usbnet
*dev
)
307 u8 pause_threshold
= HIF_REG_PAUSE_THRESHOLD_DEFAULT
;
310 for (retry
= 0; retry
< 2; retry
++) {
311 if (mcs7830_get_rev(dev
) == 2) {
312 dev_info(&dev
->udev
->dev
, "applying rev.C fixup\n");
313 mcs7830_set_reg(dev
, HIF_REG_PAUSE_THRESHOLD
,
314 1, &pause_threshold
);
320 static int mcs7830_mdio_read(struct net_device
*netdev
, int phy_id
,
323 struct usbnet
*dev
= netdev_priv(netdev
);
324 return mcs7830_read_phy(dev
, location
);
327 static void mcs7830_mdio_write(struct net_device
*netdev
, int phy_id
,
328 int location
, int val
)
330 struct usbnet
*dev
= netdev_priv(netdev
);
331 mcs7830_write_phy(dev
, location
, val
);
334 static int mcs7830_ioctl(struct net_device
*net
, struct ifreq
*rq
, int cmd
)
336 struct usbnet
*dev
= netdev_priv(net
);
337 return generic_mii_ioctl(&dev
->mii
, if_mii(rq
), cmd
, NULL
);
340 static inline struct mcs7830_data
*mcs7830_get_data(struct usbnet
*dev
)
342 return (struct mcs7830_data
*)&dev
->data
;
345 static void mcs7830_hif_update_multicast_hash(struct usbnet
*dev
)
347 struct mcs7830_data
*data
= mcs7830_get_data(dev
);
348 mcs7830_set_reg_async(dev
, HIF_REG_MULTICAST_HASH
,
349 sizeof data
->multi_filter
,
353 static void mcs7830_hif_update_config(struct usbnet
*dev
)
355 /* implementation specific to data->config
356 (argument needs to be heap-based anyway - USB DMA!) */
357 struct mcs7830_data
*data
= mcs7830_get_data(dev
);
358 mcs7830_set_reg_async(dev
, HIF_REG_CONFIG
, 1, &data
->config
);
361 static void mcs7830_data_set_multicast(struct net_device
*net
)
363 struct usbnet
*dev
= netdev_priv(net
);
364 struct mcs7830_data
*data
= mcs7830_get_data(dev
);
366 memset(data
->multi_filter
, 0, sizeof data
->multi_filter
);
368 data
->config
= HIF_REG_CONFIG_TXENABLE
;
370 /* this should not be needed, but it doesn't work otherwise */
371 data
->config
|= HIF_REG_CONFIG_ALLMULTICAST
;
373 if (net
->flags
& IFF_PROMISC
) {
374 data
->config
|= HIF_REG_CONFIG_PROMISCUOUS
;
375 } else if (net
->flags
& IFF_ALLMULTI
||
376 netdev_mc_count(net
) > MCS7830_MAX_MCAST
) {
377 data
->config
|= HIF_REG_CONFIG_ALLMULTICAST
;
378 } else if (netdev_mc_empty(net
)) {
379 /* just broadcast and directed */
381 /* We use the 20 byte dev->data
382 * for our 8 byte filter buffer
383 * to avoid allocating memory that
384 * is tricky to free later */
385 struct netdev_hw_addr
*ha
;
388 /* Build the multicast hash filter. */
389 netdev_for_each_mc_addr(ha
, net
) {
390 crc_bits
= ether_crc(ETH_ALEN
, ha
->addr
) >> 26;
391 data
->multi_filter
[crc_bits
>> 3] |= 1 << (crc_bits
& 7);
396 static int mcs7830_apply_base_config(struct usbnet
*dev
)
400 /* re-configure known MAC (suspend case etc.) */
401 ret
= mcs7830_hif_set_mac_address(dev
, dev
->net
->dev_addr
);
403 dev_info(&dev
->udev
->dev
, "Cannot set MAC address\n");
408 ret
= mcs7830_set_autoneg(dev
, 0);
410 dev_info(&dev
->udev
->dev
, "Cannot set autoneg\n");
414 mcs7830_hif_update_multicast_hash(dev
);
415 mcs7830_hif_update_config(dev
);
417 mcs7830_rev_C_fixup(dev
);
423 /* credits go to asix_set_multicast */
424 static void mcs7830_set_multicast(struct net_device
*net
)
426 struct usbnet
*dev
= netdev_priv(net
);
428 mcs7830_data_set_multicast(net
);
430 mcs7830_hif_update_multicast_hash(dev
);
431 mcs7830_hif_update_config(dev
);
434 static int mcs7830_get_regs_len(struct net_device
*net
)
436 struct usbnet
*dev
= netdev_priv(net
);
438 switch (mcs7830_get_rev(dev
)) {
447 static void mcs7830_get_drvinfo(struct net_device
*net
, struct ethtool_drvinfo
*drvinfo
)
449 usbnet_get_drvinfo(net
, drvinfo
);
450 drvinfo
->regdump_len
= mcs7830_get_regs_len(net
);
453 static void mcs7830_get_regs(struct net_device
*net
, struct ethtool_regs
*regs
, void *data
)
455 struct usbnet
*dev
= netdev_priv(net
);
457 regs
->version
= mcs7830_get_rev(dev
);
458 mcs7830_get_reg(dev
, 0, regs
->len
, data
);
461 static const struct ethtool_ops mcs7830_ethtool_ops
= {
462 .get_drvinfo
= mcs7830_get_drvinfo
,
463 .get_regs_len
= mcs7830_get_regs_len
,
464 .get_regs
= mcs7830_get_regs
,
466 /* common usbnet calls */
467 .get_link
= usbnet_get_link
,
468 .get_msglevel
= usbnet_get_msglevel
,
469 .set_msglevel
= usbnet_set_msglevel
,
470 .get_settings
= usbnet_get_settings
,
471 .set_settings
= usbnet_set_settings
,
472 .nway_reset
= usbnet_nway_reset
,
475 static const struct net_device_ops mcs7830_netdev_ops
= {
476 .ndo_open
= usbnet_open
,
477 .ndo_stop
= usbnet_stop
,
478 .ndo_start_xmit
= usbnet_start_xmit
,
479 .ndo_tx_timeout
= usbnet_tx_timeout
,
480 .ndo_change_mtu
= usbnet_change_mtu
,
481 .ndo_validate_addr
= eth_validate_addr
,
482 .ndo_do_ioctl
= mcs7830_ioctl
,
483 .ndo_set_rx_mode
= mcs7830_set_multicast
,
484 .ndo_set_mac_address
= mcs7830_set_mac_address
,
487 static int mcs7830_bind(struct usbnet
*dev
, struct usb_interface
*udev
)
489 struct net_device
*net
= dev
->net
;
493 /* Initial startup: Gather MAC address setting from EEPROM */
495 for (retry
= 0; retry
< 5 && ret
; retry
++)
496 ret
= mcs7830_hif_get_mac_address(dev
, net
->dev_addr
);
498 dev_warn(&dev
->udev
->dev
, "Cannot read MAC address\n");
502 mcs7830_data_set_multicast(net
);
504 ret
= mcs7830_apply_base_config(dev
);
508 net
->ethtool_ops
= &mcs7830_ethtool_ops
;
509 net
->netdev_ops
= &mcs7830_netdev_ops
;
511 /* reserve space for the status byte on rx */
512 dev
->rx_urb_size
= ETH_FRAME_LEN
+ 1;
514 dev
->mii
.mdio_read
= mcs7830_mdio_read
;
515 dev
->mii
.mdio_write
= mcs7830_mdio_write
;
517 dev
->mii
.phy_id_mask
= 0x3f;
518 dev
->mii
.reg_num_mask
= 0x1f;
519 dev
->mii
.phy_id
= *((u8
*) net
->dev_addr
+ 1);
521 ret
= usbnet_get_endpoints(dev
, udev
);
526 /* The chip always appends a status byte that we need to strip */
527 static int mcs7830_rx_fixup(struct usbnet
*dev
, struct sk_buff
*skb
)
532 dev_err(&dev
->udev
->dev
, "unexpected empty rx frame\n");
536 skb_trim(skb
, skb
->len
- 1);
537 status
= skb
->data
[skb
->len
];
539 if (status
!= MCS7830_RX_FRAME_CORRECT
) {
540 dev_dbg(&dev
->udev
->dev
, "rx fixup status %x\n", status
);
542 /* hmm, perhaps usbnet.c already sees a globally visible
543 frame error and increments rx_errors on its own already? */
544 dev
->net
->stats
.rx_errors
++;
546 if (status
& (MCS7830_RX_SHORT_FRAME
547 |MCS7830_RX_LENGTH_ERROR
548 |MCS7830_RX_LARGE_FRAME
))
549 dev
->net
->stats
.rx_length_errors
++;
550 if (status
& MCS7830_RX_ALIGNMENT_ERROR
)
551 dev
->net
->stats
.rx_frame_errors
++;
552 if (status
& MCS7830_RX_CRC_ERROR
)
553 dev
->net
->stats
.rx_crc_errors
++;
559 static void mcs7830_status(struct usbnet
*dev
, struct urb
*urb
)
561 u8
*buf
= urb
->transfer_buffer
;
562 bool link
, link_changed
;
563 struct mcs7830_data
*data
= mcs7830_get_data(dev
);
565 if (urb
->actual_length
< 16)
568 link
= !(buf
[1] & 0x20);
569 link_changed
= netif_carrier_ok(dev
->net
) != link
;
571 data
->link_counter
++;
573 track link state 20 times to guard against erroneous
574 link state changes reported sometimes by the chip
576 if (data
->link_counter
> 20) {
577 data
->link_counter
= 0;
578 usbnet_link_change(dev
, link
, 0);
579 netdev_dbg(dev
->net
, "Link Status is: %d\n", link
);
582 data
->link_counter
= 0;
585 static const struct driver_info moschip_info
= {
586 .description
= "MOSCHIP 7830/7832/7730 usb-NET adapter",
587 .bind
= mcs7830_bind
,
588 .rx_fixup
= mcs7830_rx_fixup
,
589 .flags
= FLAG_ETHER
| FLAG_LINK_INTR
,
590 .status
= mcs7830_status
,
595 static const struct driver_info sitecom_info
= {
596 .description
= "Sitecom LN-30 usb-NET adapter",
597 .bind
= mcs7830_bind
,
598 .rx_fixup
= mcs7830_rx_fixup
,
599 .flags
= FLAG_ETHER
| FLAG_LINK_INTR
,
600 .status
= mcs7830_status
,
605 static const struct usb_device_id products
[] = {
607 USB_DEVICE(MCS7830_VENDOR_ID
, MCS7832_PRODUCT_ID
),
608 .driver_info
= (unsigned long) &moschip_info
,
611 USB_DEVICE(MCS7830_VENDOR_ID
, MCS7830_PRODUCT_ID
),
612 .driver_info
= (unsigned long) &moschip_info
,
615 USB_DEVICE(MCS7830_VENDOR_ID
, MCS7730_PRODUCT_ID
),
616 .driver_info
= (unsigned long) &moschip_info
,
619 USB_DEVICE(SITECOM_VENDOR_ID
, LN_030_PRODUCT_ID
),
620 .driver_info
= (unsigned long) &sitecom_info
,
624 MODULE_DEVICE_TABLE(usb
, products
);
626 static int mcs7830_reset_resume (struct usb_interface
*intf
)
628 /* YES, this function is successful enough that ethtool -d
629 does show same output pre-/post-suspend */
631 struct usbnet
*dev
= usb_get_intfdata(intf
);
633 mcs7830_apply_base_config(dev
);
640 static struct usb_driver mcs7830_driver
= {
642 .id_table
= products
,
643 .probe
= usbnet_probe
,
644 .disconnect
= usbnet_disconnect
,
645 .suspend
= usbnet_suspend
,
646 .resume
= usbnet_resume
,
647 .reset_resume
= mcs7830_reset_resume
,
648 .disable_hub_initiated_lpm
= 1,
651 module_usb_driver(mcs7830_driver
);
653 MODULE_DESCRIPTION("USB to network adapter MCS7830)");
654 MODULE_LICENSE("GPL");