2 * MOSCHIP MCS7830 based 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!).
15 * - support HIF_REG_CONFIG_SLEEPMODE/HIF_REG_CONFIG_TXENABLE (via autopm?)
16 * - implement ethtool_ops get_pauseparam/set_pauseparam
17 * via HIF_REG_PAUSE_THRESHOLD (>= revision C only!)
18 * - implement get_eeprom/[set_eeprom]
19 * - switch PHY on/off on ifup/ifdown (perhaps in usbnet.c, via MII)
20 * - mcs7830_get_regs() handling is weird: for rev 2 we return 32 regs,
21 * can access only ~ 24, remaining user buffer is uninitialized garbage
25 * This program is free software; you can redistribute it and/or modify
26 * it under the terms of the GNU General Public License as published by
27 * the Free Software Foundation; either version 2 of the License, or
28 * (at your option) any later version.
30 * This program is distributed in the hope that it will be useful,
31 * but WITHOUT ANY WARRANTY; without even the implied warranty of
32 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
33 * GNU General Public License for more details.
35 * You should have received a copy of the GNU General Public License
36 * along with this program; if not, write to the Free Software
37 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
40 #include <linux/crc32.h>
41 #include <linux/etherdevice.h>
42 #include <linux/ethtool.h>
43 #include <linux/init.h>
44 #include <linux/mii.h>
45 #include <linux/module.h>
46 #include <linux/netdevice.h>
47 #include <linux/slab.h>
48 #include <linux/usb.h>
49 #include <linux/usb/usbnet.h>
52 #define MCS7830_RD_BMREQ (USB_DIR_IN | USB_TYPE_VENDOR | \
54 #define MCS7830_WR_BMREQ (USB_DIR_OUT | USB_TYPE_VENDOR | \
56 #define MCS7830_RD_BREQ 0x0E
57 #define MCS7830_WR_BREQ 0x0D
59 #define MCS7830_CTRL_TIMEOUT 1000
60 #define MCS7830_MAX_MCAST 64
62 #define MCS7830_VENDOR_ID 0x9710
63 #define MCS7830_PRODUCT_ID 0x7830
64 #define MCS7730_PRODUCT_ID 0x7730
66 #define SITECOM_VENDOR_ID 0x0DF6
67 #define LN_030_PRODUCT_ID 0x0021
69 #define MCS7830_MII_ADVERTISE (ADVERTISE_PAUSE_CAP | ADVERTISE_100FULL | \
70 ADVERTISE_100HALF | ADVERTISE_10FULL | \
71 ADVERTISE_10HALF | ADVERTISE_CSMA)
73 /* HIF_REG_XX corresponding index value */
75 HIF_REG_MULTICAST_HASH
= 0x00,
76 HIF_REG_PACKET_GAP1
= 0x08,
77 HIF_REG_PACKET_GAP2
= 0x09,
78 HIF_REG_PHY_DATA
= 0x0a,
79 HIF_REG_PHY_CMD1
= 0x0c,
80 HIF_REG_PHY_CMD1_READ
= 0x40,
81 HIF_REG_PHY_CMD1_WRITE
= 0x20,
82 HIF_REG_PHY_CMD1_PHYADDR
= 0x01,
83 HIF_REG_PHY_CMD2
= 0x0d,
84 HIF_REG_PHY_CMD2_PEND_FLAG_BIT
= 0x80,
85 HIF_REG_PHY_CMD2_READY_FLAG_BIT
= 0x40,
86 HIF_REG_CONFIG
= 0x0e,
87 /* hmm, spec sez: "R/W", "Except bit 3" (likely TXENABLE). */
88 HIF_REG_CONFIG_CFG
= 0x80,
89 HIF_REG_CONFIG_SPEED100
= 0x40,
90 HIF_REG_CONFIG_FULLDUPLEX_ENABLE
= 0x20,
91 HIF_REG_CONFIG_RXENABLE
= 0x10,
92 HIF_REG_CONFIG_TXENABLE
= 0x08,
93 HIF_REG_CONFIG_SLEEPMODE
= 0x04,
94 HIF_REG_CONFIG_ALLMULTICAST
= 0x02,
95 HIF_REG_CONFIG_PROMISCUOUS
= 0x01,
96 HIF_REG_ETHERNET_ADDR
= 0x0f,
97 HIF_REG_FRAME_DROP_COUNTER
= 0x15, /* 0..ff; reset: 0 */
98 HIF_REG_PAUSE_THRESHOLD
= 0x16,
99 HIF_REG_PAUSE_THRESHOLD_DEFAULT
= 0,
102 /* Trailing status byte in Ethernet Rx frame */
104 MCS7830_RX_SHORT_FRAME
= 0x01, /* < 64 bytes */
105 MCS7830_RX_LENGTH_ERROR
= 0x02, /* framelen != Ethernet length field */
106 MCS7830_RX_ALIGNMENT_ERROR
= 0x04, /* non-even number of nibbles */
107 MCS7830_RX_CRC_ERROR
= 0x08,
108 MCS7830_RX_LARGE_FRAME
= 0x10, /* > 1518 bytes */
109 MCS7830_RX_FRAME_CORRECT
= 0x20, /* frame is correct */
113 struct mcs7830_data
{
118 static const char driver_name
[] = "MOSCHIP usb-ethernet driver";
120 static int mcs7830_get_reg(struct usbnet
*dev
, u16 index
, u16 size
, void *data
)
122 struct usb_device
*xdev
= dev
->udev
;
126 buffer
= kmalloc(size
, GFP_NOIO
);
130 ret
= usb_control_msg(xdev
, usb_rcvctrlpipe(xdev
, 0), MCS7830_RD_BREQ
,
131 MCS7830_RD_BMREQ
, 0x0000, index
, buffer
,
132 size
, MCS7830_CTRL_TIMEOUT
);
133 memcpy(data
, buffer
, size
);
139 static int mcs7830_set_reg(struct usbnet
*dev
, u16 index
, u16 size
, const void *data
)
141 struct usb_device
*xdev
= dev
->udev
;
145 buffer
= kmalloc(size
, GFP_NOIO
);
149 memcpy(buffer
, data
, size
);
151 ret
= usb_control_msg(xdev
, usb_sndctrlpipe(xdev
, 0), MCS7830_WR_BREQ
,
152 MCS7830_WR_BMREQ
, 0x0000, index
, buffer
,
153 size
, MCS7830_CTRL_TIMEOUT
);
158 static void mcs7830_async_cmd_callback(struct urb
*urb
)
160 struct usb_ctrlrequest
*req
= (struct usb_ctrlrequest
*)urb
->context
;
161 int status
= urb
->status
;
164 printk(KERN_DEBUG
"%s() failed with %d\n",
171 static void mcs7830_set_reg_async(struct usbnet
*dev
, u16 index
, u16 size
, void *data
)
173 struct usb_ctrlrequest
*req
;
177 urb
= usb_alloc_urb(0, GFP_ATOMIC
);
179 dev_dbg(&dev
->udev
->dev
,
180 "Error allocating URB in write_cmd_async!\n");
184 req
= kmalloc(sizeof *req
, GFP_ATOMIC
);
186 dev_err(&dev
->udev
->dev
,
187 "Failed to allocate memory for control request\n");
190 req
->bRequestType
= MCS7830_WR_BMREQ
;
191 req
->bRequest
= MCS7830_WR_BREQ
;
193 req
->wIndex
= cpu_to_le16(index
);
194 req
->wLength
= cpu_to_le16(size
);
196 usb_fill_control_urb(urb
, dev
->udev
,
197 usb_sndctrlpipe(dev
->udev
, 0),
198 (void *)req
, data
, size
,
199 mcs7830_async_cmd_callback
, req
);
201 ret
= usb_submit_urb(urb
, GFP_ATOMIC
);
203 dev_err(&dev
->udev
->dev
,
204 "Error submitting the control message: ret=%d\n", ret
);
213 static int mcs7830_hif_get_mac_address(struct usbnet
*dev
, unsigned char *addr
)
215 int ret
= mcs7830_get_reg(dev
, HIF_REG_ETHERNET_ADDR
, ETH_ALEN
, addr
);
221 static int mcs7830_hif_set_mac_address(struct usbnet
*dev
, unsigned char *addr
)
223 int ret
= mcs7830_set_reg(dev
, HIF_REG_ETHERNET_ADDR
, ETH_ALEN
, addr
);
230 static int mcs7830_set_mac_address(struct net_device
*netdev
, void *p
)
233 struct usbnet
*dev
= netdev_priv(netdev
);
234 struct sockaddr
*addr
= p
;
236 if (netif_running(netdev
))
239 if (!is_valid_ether_addr(addr
->sa_data
))
242 ret
= mcs7830_hif_set_mac_address(dev
, addr
->sa_data
);
247 /* it worked --> adopt it on netdev side */
248 memcpy(netdev
->dev_addr
, addr
->sa_data
, netdev
->addr_len
);
253 static int mcs7830_read_phy(struct usbnet
*dev
, u8 index
)
260 HIF_REG_PHY_CMD1_READ
| HIF_REG_PHY_CMD1_PHYADDR
,
261 HIF_REG_PHY_CMD2_PEND_FLAG_BIT
| index
,
264 mutex_lock(&dev
->phy_mutex
);
265 /* write the MII command */
266 ret
= mcs7830_set_reg(dev
, HIF_REG_PHY_CMD1
, 2, cmd
);
270 /* wait for the data to become valid, should be within < 1ms */
271 for (i
= 0; i
< 10; i
++) {
272 ret
= mcs7830_get_reg(dev
, HIF_REG_PHY_CMD1
, 2, cmd
);
273 if ((ret
< 0) || (cmd
[1] & HIF_REG_PHY_CMD2_READY_FLAG_BIT
))
281 /* read actual register contents */
282 ret
= mcs7830_get_reg(dev
, HIF_REG_PHY_DATA
, 2, &val
);
285 ret
= le16_to_cpu(val
);
286 dev_dbg(&dev
->udev
->dev
, "read PHY reg %02x: %04x (%d tries)\n",
289 mutex_unlock(&dev
->phy_mutex
);
293 static int mcs7830_write_phy(struct usbnet
*dev
, u8 index
, u16 val
)
300 HIF_REG_PHY_CMD1_WRITE
| HIF_REG_PHY_CMD1_PHYADDR
,
301 HIF_REG_PHY_CMD2_PEND_FLAG_BIT
| (index
& 0x1F),
304 mutex_lock(&dev
->phy_mutex
);
306 /* write the new register contents */
307 le_val
= cpu_to_le16(val
);
308 ret
= mcs7830_set_reg(dev
, HIF_REG_PHY_DATA
, 2, &le_val
);
312 /* write the MII command */
313 ret
= mcs7830_set_reg(dev
, HIF_REG_PHY_CMD1
, 2, cmd
);
317 /* wait for the command to be accepted by the PHY */
318 for (i
= 0; i
< 10; i
++) {
319 ret
= mcs7830_get_reg(dev
, HIF_REG_PHY_CMD1
, 2, cmd
);
320 if ((ret
< 0) || (cmd
[1] & HIF_REG_PHY_CMD2_READY_FLAG_BIT
))
329 dev_dbg(&dev
->udev
->dev
, "write PHY reg %02x: %04x (%d tries)\n",
332 mutex_unlock(&dev
->phy_mutex
);
337 * This algorithm comes from the original mcs7830 version 1.4 driver,
338 * not sure if it is needed.
340 static int mcs7830_set_autoneg(struct usbnet
*dev
, int ptrUserPhyMode
)
343 /* Enable all media types */
344 ret
= mcs7830_write_phy(dev
, MII_ADVERTISE
, MCS7830_MII_ADVERTISE
);
346 /* First reset BMCR */
348 ret
= mcs7830_write_phy(dev
, MII_BMCR
, 0x0000);
349 /* Enable Auto Neg */
351 ret
= mcs7830_write_phy(dev
, MII_BMCR
, BMCR_ANENABLE
);
352 /* Restart Auto Neg (Keep the Enable Auto Neg Bit Set) */
354 ret
= mcs7830_write_phy(dev
, MII_BMCR
,
355 BMCR_ANENABLE
| BMCR_ANRESTART
);
356 return ret
< 0 ? : 0;
361 * if we can read register 22, the chip revision is C or higher
363 static int mcs7830_get_rev(struct usbnet
*dev
)
367 ret
= mcs7830_get_reg(dev
, HIF_REG_FRAME_DROP_COUNTER
, 2, dummy
);
369 return 2; /* Rev C or later */
370 return 1; /* earlier revision */
374 * On rev. C we need to set the pause threshold
376 static void mcs7830_rev_C_fixup(struct usbnet
*dev
)
378 u8 pause_threshold
= HIF_REG_PAUSE_THRESHOLD_DEFAULT
;
381 for (retry
= 0; retry
< 2; retry
++) {
382 if (mcs7830_get_rev(dev
) == 2) {
383 dev_info(&dev
->udev
->dev
, "applying rev.C fixup\n");
384 mcs7830_set_reg(dev
, HIF_REG_PAUSE_THRESHOLD
,
385 1, &pause_threshold
);
391 static int mcs7830_mdio_read(struct net_device
*netdev
, int phy_id
,
394 struct usbnet
*dev
= netdev_priv(netdev
);
395 return mcs7830_read_phy(dev
, location
);
398 static void mcs7830_mdio_write(struct net_device
*netdev
, int phy_id
,
399 int location
, int val
)
401 struct usbnet
*dev
= netdev_priv(netdev
);
402 mcs7830_write_phy(dev
, location
, val
);
405 static int mcs7830_ioctl(struct net_device
*net
, struct ifreq
*rq
, int cmd
)
407 struct usbnet
*dev
= netdev_priv(net
);
408 return generic_mii_ioctl(&dev
->mii
, if_mii(rq
), cmd
, NULL
);
411 static inline struct mcs7830_data
*mcs7830_get_data(struct usbnet
*dev
)
413 return (struct mcs7830_data
*)&dev
->data
;
416 static void mcs7830_hif_update_multicast_hash(struct usbnet
*dev
)
418 struct mcs7830_data
*data
= mcs7830_get_data(dev
);
419 mcs7830_set_reg_async(dev
, HIF_REG_MULTICAST_HASH
,
420 sizeof data
->multi_filter
,
424 static void mcs7830_hif_update_config(struct usbnet
*dev
)
426 /* implementation specific to data->config
427 (argument needs to be heap-based anyway - USB DMA!) */
428 struct mcs7830_data
*data
= mcs7830_get_data(dev
);
429 mcs7830_set_reg_async(dev
, HIF_REG_CONFIG
, 1, &data
->config
);
432 static void mcs7830_data_set_multicast(struct net_device
*net
)
434 struct usbnet
*dev
= netdev_priv(net
);
435 struct mcs7830_data
*data
= mcs7830_get_data(dev
);
437 memset(data
->multi_filter
, 0, sizeof data
->multi_filter
);
439 data
->config
= HIF_REG_CONFIG_TXENABLE
;
441 /* this should not be needed, but it doesn't work otherwise */
442 data
->config
|= HIF_REG_CONFIG_ALLMULTICAST
;
444 if (net
->flags
& IFF_PROMISC
) {
445 data
->config
|= HIF_REG_CONFIG_PROMISCUOUS
;
446 } else if (net
->flags
& IFF_ALLMULTI
||
447 netdev_mc_count(net
) > MCS7830_MAX_MCAST
) {
448 data
->config
|= HIF_REG_CONFIG_ALLMULTICAST
;
449 } else if (netdev_mc_empty(net
)) {
450 /* just broadcast and directed */
452 /* We use the 20 byte dev->data
453 * for our 8 byte filter buffer
454 * to avoid allocating memory that
455 * is tricky to free later */
456 struct dev_mc_list
*mc_list
;
459 /* Build the multicast hash filter. */
460 netdev_for_each_mc_addr(mc_list
, net
) {
461 crc_bits
= ether_crc(ETH_ALEN
, mc_list
->dmi_addr
) >> 26;
462 data
->multi_filter
[crc_bits
>> 3] |= 1 << (crc_bits
& 7);
467 static int mcs7830_apply_base_config(struct usbnet
*dev
)
471 /* re-configure known MAC (suspend case etc.) */
472 ret
= mcs7830_hif_set_mac_address(dev
, dev
->net
->dev_addr
);
474 dev_info(&dev
->udev
->dev
, "Cannot set MAC address\n");
479 ret
= mcs7830_set_autoneg(dev
, 0);
481 dev_info(&dev
->udev
->dev
, "Cannot set autoneg\n");
485 mcs7830_hif_update_multicast_hash(dev
);
486 mcs7830_hif_update_config(dev
);
488 mcs7830_rev_C_fixup(dev
);
494 /* credits go to asix_set_multicast */
495 static void mcs7830_set_multicast(struct net_device
*net
)
497 struct usbnet
*dev
= netdev_priv(net
);
499 mcs7830_data_set_multicast(net
);
501 mcs7830_hif_update_multicast_hash(dev
);
502 mcs7830_hif_update_config(dev
);
505 static int mcs7830_get_regs_len(struct net_device
*net
)
507 struct usbnet
*dev
= netdev_priv(net
);
509 switch (mcs7830_get_rev(dev
)) {
518 static void mcs7830_get_drvinfo(struct net_device
*net
, struct ethtool_drvinfo
*drvinfo
)
520 usbnet_get_drvinfo(net
, drvinfo
);
521 drvinfo
->regdump_len
= mcs7830_get_regs_len(net
);
524 static void mcs7830_get_regs(struct net_device
*net
, struct ethtool_regs
*regs
, void *data
)
526 struct usbnet
*dev
= netdev_priv(net
);
528 regs
->version
= mcs7830_get_rev(dev
);
529 mcs7830_get_reg(dev
, 0, regs
->len
, data
);
532 static const struct ethtool_ops mcs7830_ethtool_ops
= {
533 .get_drvinfo
= mcs7830_get_drvinfo
,
534 .get_regs_len
= mcs7830_get_regs_len
,
535 .get_regs
= mcs7830_get_regs
,
537 /* common usbnet calls */
538 .get_link
= usbnet_get_link
,
539 .get_msglevel
= usbnet_get_msglevel
,
540 .set_msglevel
= usbnet_set_msglevel
,
541 .get_settings
= usbnet_get_settings
,
542 .set_settings
= usbnet_set_settings
,
543 .nway_reset
= usbnet_nway_reset
,
546 static const struct net_device_ops mcs7830_netdev_ops
= {
547 .ndo_open
= usbnet_open
,
548 .ndo_stop
= usbnet_stop
,
549 .ndo_start_xmit
= usbnet_start_xmit
,
550 .ndo_tx_timeout
= usbnet_tx_timeout
,
551 .ndo_change_mtu
= usbnet_change_mtu
,
552 .ndo_validate_addr
= eth_validate_addr
,
553 .ndo_do_ioctl
= mcs7830_ioctl
,
554 .ndo_set_multicast_list
= mcs7830_set_multicast
,
555 .ndo_set_mac_address
= mcs7830_set_mac_address
,
558 static int mcs7830_bind(struct usbnet
*dev
, struct usb_interface
*udev
)
560 struct net_device
*net
= dev
->net
;
564 /* Initial startup: Gather MAC address setting from EEPROM */
566 for (retry
= 0; retry
< 5 && ret
; retry
++)
567 ret
= mcs7830_hif_get_mac_address(dev
, net
->dev_addr
);
569 dev_warn(&dev
->udev
->dev
, "Cannot read MAC address\n");
573 mcs7830_data_set_multicast(net
);
575 ret
= mcs7830_apply_base_config(dev
);
579 net
->ethtool_ops
= &mcs7830_ethtool_ops
;
580 net
->netdev_ops
= &mcs7830_netdev_ops
;
582 /* reserve space for the status byte on rx */
583 dev
->rx_urb_size
= ETH_FRAME_LEN
+ 1;
585 dev
->mii
.mdio_read
= mcs7830_mdio_read
;
586 dev
->mii
.mdio_write
= mcs7830_mdio_write
;
588 dev
->mii
.phy_id_mask
= 0x3f;
589 dev
->mii
.reg_num_mask
= 0x1f;
590 dev
->mii
.phy_id
= *((u8
*) net
->dev_addr
+ 1);
592 ret
= usbnet_get_endpoints(dev
, udev
);
597 /* The chip always appends a status byte that we need to strip */
598 static int mcs7830_rx_fixup(struct usbnet
*dev
, struct sk_buff
*skb
)
603 dev_err(&dev
->udev
->dev
, "unexpected empty rx frame\n");
607 skb_trim(skb
, skb
->len
- 1);
608 status
= skb
->data
[skb
->len
];
610 if (status
!= MCS7830_RX_FRAME_CORRECT
) {
611 dev_dbg(&dev
->udev
->dev
, "rx fixup status %x\n", status
);
613 /* hmm, perhaps usbnet.c already sees a globally visible
614 frame error and increments rx_errors on its own already? */
615 dev
->net
->stats
.rx_errors
++;
617 if (status
& (MCS7830_RX_SHORT_FRAME
618 |MCS7830_RX_LENGTH_ERROR
619 |MCS7830_RX_LARGE_FRAME
))
620 dev
->net
->stats
.rx_length_errors
++;
621 if (status
& MCS7830_RX_ALIGNMENT_ERROR
)
622 dev
->net
->stats
.rx_frame_errors
++;
623 if (status
& MCS7830_RX_CRC_ERROR
)
624 dev
->net
->stats
.rx_crc_errors
++;
630 static const struct driver_info moschip_info
= {
631 .description
= "MOSCHIP 7830/7730 usb-NET adapter",
632 .bind
= mcs7830_bind
,
633 .rx_fixup
= mcs7830_rx_fixup
,
639 static const struct driver_info sitecom_info
= {
640 .description
= "Sitecom LN-30 usb-NET adapter",
641 .bind
= mcs7830_bind
,
642 .rx_fixup
= mcs7830_rx_fixup
,
648 static const struct usb_device_id products
[] = {
650 USB_DEVICE(MCS7830_VENDOR_ID
, MCS7830_PRODUCT_ID
),
651 .driver_info
= (unsigned long) &moschip_info
,
654 USB_DEVICE(MCS7830_VENDOR_ID
, MCS7730_PRODUCT_ID
),
655 .driver_info
= (unsigned long) &moschip_info
,
658 USB_DEVICE(SITECOM_VENDOR_ID
, LN_030_PRODUCT_ID
),
659 .driver_info
= (unsigned long) &sitecom_info
,
663 MODULE_DEVICE_TABLE(usb
, products
);
665 static int mcs7830_reset_resume (struct usb_interface
*intf
)
667 /* YES, this function is successful enough that ethtool -d
668 does show same output pre-/post-suspend */
670 struct usbnet
*dev
= usb_get_intfdata(intf
);
672 mcs7830_apply_base_config(dev
);
679 static struct usb_driver mcs7830_driver
= {
681 .id_table
= products
,
682 .probe
= usbnet_probe
,
683 .disconnect
= usbnet_disconnect
,
684 .suspend
= usbnet_suspend
,
685 .resume
= usbnet_resume
,
686 .reset_resume
= mcs7830_reset_resume
,
689 static int __init
mcs7830_init(void)
691 return usb_register(&mcs7830_driver
);
693 module_init(mcs7830_init
);
695 static void __exit
mcs7830_exit(void)
697 usb_deregister(&mcs7830_driver
);
699 module_exit(mcs7830_exit
);
701 MODULE_DESCRIPTION("USB to network adapter MCS7830)");
702 MODULE_LICENSE("GPL");