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
)
124 return usbnet_read_cmd(dev
, MCS7830_RD_BREQ
, MCS7830_RD_BMREQ
,
125 0x0000, index
, data
, size
);
128 static int mcs7830_set_reg(struct usbnet
*dev
, u16 index
, u16 size
, const void *data
)
130 return usbnet_write_cmd(dev
, MCS7830_WR_BREQ
, MCS7830_WR_BMREQ
,
131 0x0000, index
, data
, size
);
134 static void mcs7830_set_reg_async(struct usbnet
*dev
, u16 index
, u16 size
, void *data
)
136 usbnet_write_cmd_async(dev
, MCS7830_WR_BREQ
, MCS7830_WR_BMREQ
,
137 0x0000, index
, data
, size
);
140 static int mcs7830_hif_get_mac_address(struct usbnet
*dev
, unsigned char *addr
)
142 int ret
= mcs7830_get_reg(dev
, HIF_REG_ETHERNET_ADDR
, ETH_ALEN
, addr
);
148 static int mcs7830_hif_set_mac_address(struct usbnet
*dev
, unsigned char *addr
)
150 int ret
= mcs7830_set_reg(dev
, HIF_REG_ETHERNET_ADDR
, ETH_ALEN
, addr
);
157 static int mcs7830_set_mac_address(struct net_device
*netdev
, void *p
)
160 struct usbnet
*dev
= netdev_priv(netdev
);
161 struct sockaddr
*addr
= p
;
163 if (netif_running(netdev
))
166 if (!is_valid_ether_addr(addr
->sa_data
))
167 return -EADDRNOTAVAIL
;
169 ret
= mcs7830_hif_set_mac_address(dev
, addr
->sa_data
);
174 /* it worked --> adopt it on netdev side */
175 memcpy(netdev
->dev_addr
, addr
->sa_data
, netdev
->addr_len
);
180 static int mcs7830_read_phy(struct usbnet
*dev
, u8 index
)
187 HIF_REG_PHY_CMD1_READ
| HIF_REG_PHY_CMD1_PHYADDR
,
188 HIF_REG_PHY_CMD2_PEND_FLAG_BIT
| index
,
191 mutex_lock(&dev
->phy_mutex
);
192 /* write the MII command */
193 ret
= mcs7830_set_reg(dev
, HIF_REG_PHY_CMD1
, 2, cmd
);
197 /* wait for the data to become valid, should be within < 1ms */
198 for (i
= 0; i
< 10; i
++) {
199 ret
= mcs7830_get_reg(dev
, HIF_REG_PHY_CMD1
, 2, cmd
);
200 if ((ret
< 0) || (cmd
[1] & HIF_REG_PHY_CMD2_READY_FLAG_BIT
))
208 /* read actual register contents */
209 ret
= mcs7830_get_reg(dev
, HIF_REG_PHY_DATA
, 2, &val
);
212 ret
= le16_to_cpu(val
);
213 dev_dbg(&dev
->udev
->dev
, "read PHY reg %02x: %04x (%d tries)\n",
216 mutex_unlock(&dev
->phy_mutex
);
220 static int mcs7830_write_phy(struct usbnet
*dev
, u8 index
, u16 val
)
227 HIF_REG_PHY_CMD1_WRITE
| HIF_REG_PHY_CMD1_PHYADDR
,
228 HIF_REG_PHY_CMD2_PEND_FLAG_BIT
| (index
& 0x1F),
231 mutex_lock(&dev
->phy_mutex
);
233 /* write the new register contents */
234 le_val
= cpu_to_le16(val
);
235 ret
= mcs7830_set_reg(dev
, HIF_REG_PHY_DATA
, 2, &le_val
);
239 /* write the MII command */
240 ret
= mcs7830_set_reg(dev
, HIF_REG_PHY_CMD1
, 2, cmd
);
244 /* wait for the command to be accepted by the PHY */
245 for (i
= 0; i
< 10; i
++) {
246 ret
= mcs7830_get_reg(dev
, HIF_REG_PHY_CMD1
, 2, cmd
);
247 if ((ret
< 0) || (cmd
[1] & HIF_REG_PHY_CMD2_READY_FLAG_BIT
))
256 dev_dbg(&dev
->udev
->dev
, "write PHY reg %02x: %04x (%d tries)\n",
259 mutex_unlock(&dev
->phy_mutex
);
264 * This algorithm comes from the original mcs7830 version 1.4 driver,
265 * not sure if it is needed.
267 static int mcs7830_set_autoneg(struct usbnet
*dev
, int ptrUserPhyMode
)
270 /* Enable all media types */
271 ret
= mcs7830_write_phy(dev
, MII_ADVERTISE
, MCS7830_MII_ADVERTISE
);
273 /* First reset BMCR */
275 ret
= mcs7830_write_phy(dev
, MII_BMCR
, 0x0000);
276 /* Enable Auto Neg */
278 ret
= mcs7830_write_phy(dev
, MII_BMCR
, BMCR_ANENABLE
);
279 /* Restart Auto Neg (Keep the Enable Auto Neg Bit Set) */
281 ret
= mcs7830_write_phy(dev
, MII_BMCR
,
282 BMCR_ANENABLE
| BMCR_ANRESTART
);
288 * if we can read register 22, the chip revision is C or higher
290 static int mcs7830_get_rev(struct usbnet
*dev
)
294 ret
= mcs7830_get_reg(dev
, HIF_REG_FRAME_DROP_COUNTER
, 2, dummy
);
296 return 2; /* Rev C or later */
297 return 1; /* earlier revision */
301 * On rev. C we need to set the pause threshold
303 static void mcs7830_rev_C_fixup(struct usbnet
*dev
)
305 u8 pause_threshold
= HIF_REG_PAUSE_THRESHOLD_DEFAULT
;
308 for (retry
= 0; retry
< 2; retry
++) {
309 if (mcs7830_get_rev(dev
) == 2) {
310 dev_info(&dev
->udev
->dev
, "applying rev.C fixup\n");
311 mcs7830_set_reg(dev
, HIF_REG_PAUSE_THRESHOLD
,
312 1, &pause_threshold
);
318 static int mcs7830_mdio_read(struct net_device
*netdev
, int phy_id
,
321 struct usbnet
*dev
= netdev_priv(netdev
);
322 return mcs7830_read_phy(dev
, location
);
325 static void mcs7830_mdio_write(struct net_device
*netdev
, int phy_id
,
326 int location
, int val
)
328 struct usbnet
*dev
= netdev_priv(netdev
);
329 mcs7830_write_phy(dev
, location
, val
);
332 static int mcs7830_ioctl(struct net_device
*net
, struct ifreq
*rq
, int cmd
)
334 struct usbnet
*dev
= netdev_priv(net
);
335 return generic_mii_ioctl(&dev
->mii
, if_mii(rq
), cmd
, NULL
);
338 static inline struct mcs7830_data
*mcs7830_get_data(struct usbnet
*dev
)
340 return (struct mcs7830_data
*)&dev
->data
;
343 static void mcs7830_hif_update_multicast_hash(struct usbnet
*dev
)
345 struct mcs7830_data
*data
= mcs7830_get_data(dev
);
346 mcs7830_set_reg_async(dev
, HIF_REG_MULTICAST_HASH
,
347 sizeof data
->multi_filter
,
351 static void mcs7830_hif_update_config(struct usbnet
*dev
)
353 /* implementation specific to data->config
354 (argument needs to be heap-based anyway - USB DMA!) */
355 struct mcs7830_data
*data
= mcs7830_get_data(dev
);
356 mcs7830_set_reg_async(dev
, HIF_REG_CONFIG
, 1, &data
->config
);
359 static void mcs7830_data_set_multicast(struct net_device
*net
)
361 struct usbnet
*dev
= netdev_priv(net
);
362 struct mcs7830_data
*data
= mcs7830_get_data(dev
);
364 memset(data
->multi_filter
, 0, sizeof data
->multi_filter
);
366 data
->config
= HIF_REG_CONFIG_TXENABLE
;
368 /* this should not be needed, but it doesn't work otherwise */
369 data
->config
|= HIF_REG_CONFIG_ALLMULTICAST
;
371 if (net
->flags
& IFF_PROMISC
) {
372 data
->config
|= HIF_REG_CONFIG_PROMISCUOUS
;
373 } else if (net
->flags
& IFF_ALLMULTI
||
374 netdev_mc_count(net
) > MCS7830_MAX_MCAST
) {
375 data
->config
|= HIF_REG_CONFIG_ALLMULTICAST
;
376 } else if (netdev_mc_empty(net
)) {
377 /* just broadcast and directed */
379 /* We use the 20 byte dev->data
380 * for our 8 byte filter buffer
381 * to avoid allocating memory that
382 * is tricky to free later */
383 struct netdev_hw_addr
*ha
;
386 /* Build the multicast hash filter. */
387 netdev_for_each_mc_addr(ha
, net
) {
388 crc_bits
= ether_crc(ETH_ALEN
, ha
->addr
) >> 26;
389 data
->multi_filter
[crc_bits
>> 3] |= 1 << (crc_bits
& 7);
394 static int mcs7830_apply_base_config(struct usbnet
*dev
)
398 /* re-configure known MAC (suspend case etc.) */
399 ret
= mcs7830_hif_set_mac_address(dev
, dev
->net
->dev_addr
);
401 dev_info(&dev
->udev
->dev
, "Cannot set MAC address\n");
406 ret
= mcs7830_set_autoneg(dev
, 0);
408 dev_info(&dev
->udev
->dev
, "Cannot set autoneg\n");
412 mcs7830_hif_update_multicast_hash(dev
);
413 mcs7830_hif_update_config(dev
);
415 mcs7830_rev_C_fixup(dev
);
421 /* credits go to asix_set_multicast */
422 static void mcs7830_set_multicast(struct net_device
*net
)
424 struct usbnet
*dev
= netdev_priv(net
);
426 mcs7830_data_set_multicast(net
);
428 mcs7830_hif_update_multicast_hash(dev
);
429 mcs7830_hif_update_config(dev
);
432 static int mcs7830_get_regs_len(struct net_device
*net
)
434 struct usbnet
*dev
= netdev_priv(net
);
436 switch (mcs7830_get_rev(dev
)) {
445 static void mcs7830_get_drvinfo(struct net_device
*net
, struct ethtool_drvinfo
*drvinfo
)
447 usbnet_get_drvinfo(net
, drvinfo
);
450 static void mcs7830_get_regs(struct net_device
*net
, struct ethtool_regs
*regs
, void *data
)
452 struct usbnet
*dev
= netdev_priv(net
);
454 regs
->version
= mcs7830_get_rev(dev
);
455 mcs7830_get_reg(dev
, 0, regs
->len
, data
);
458 static const struct ethtool_ops mcs7830_ethtool_ops
= {
459 .get_drvinfo
= mcs7830_get_drvinfo
,
460 .get_regs_len
= mcs7830_get_regs_len
,
461 .get_regs
= mcs7830_get_regs
,
463 /* common usbnet calls */
464 .get_link
= usbnet_get_link
,
465 .get_msglevel
= usbnet_get_msglevel
,
466 .set_msglevel
= usbnet_set_msglevel
,
467 .nway_reset
= usbnet_nway_reset
,
468 .get_link_ksettings
= usbnet_get_link_ksettings
,
469 .set_link_ksettings
= usbnet_set_link_ksettings
,
472 static const struct net_device_ops mcs7830_netdev_ops
= {
473 .ndo_open
= usbnet_open
,
474 .ndo_stop
= usbnet_stop
,
475 .ndo_start_xmit
= usbnet_start_xmit
,
476 .ndo_tx_timeout
= usbnet_tx_timeout
,
477 .ndo_change_mtu
= usbnet_change_mtu
,
478 .ndo_get_stats64
= usbnet_get_stats64
,
479 .ndo_validate_addr
= eth_validate_addr
,
480 .ndo_do_ioctl
= mcs7830_ioctl
,
481 .ndo_set_rx_mode
= mcs7830_set_multicast
,
482 .ndo_set_mac_address
= mcs7830_set_mac_address
,
485 static int mcs7830_bind(struct usbnet
*dev
, struct usb_interface
*udev
)
487 struct net_device
*net
= dev
->net
;
491 /* Initial startup: Gather MAC address setting from EEPROM */
493 for (retry
= 0; retry
< 5 && ret
; retry
++)
494 ret
= mcs7830_hif_get_mac_address(dev
, net
->dev_addr
);
496 dev_warn(&dev
->udev
->dev
, "Cannot read MAC address\n");
500 mcs7830_data_set_multicast(net
);
502 ret
= mcs7830_apply_base_config(dev
);
506 net
->ethtool_ops
= &mcs7830_ethtool_ops
;
507 net
->netdev_ops
= &mcs7830_netdev_ops
;
509 /* reserve space for the status byte on rx */
510 dev
->rx_urb_size
= ETH_FRAME_LEN
+ 1;
512 dev
->mii
.mdio_read
= mcs7830_mdio_read
;
513 dev
->mii
.mdio_write
= mcs7830_mdio_write
;
515 dev
->mii
.phy_id_mask
= 0x3f;
516 dev
->mii
.reg_num_mask
= 0x1f;
517 dev
->mii
.phy_id
= *((u8
*) net
->dev_addr
+ 1);
519 ret
= usbnet_get_endpoints(dev
, udev
);
524 /* The chip always appends a status byte that we need to strip */
525 static int mcs7830_rx_fixup(struct usbnet
*dev
, struct sk_buff
*skb
)
529 /* This check is no longer done by usbnet */
530 if (skb
->len
< dev
->net
->hard_header_len
) {
531 dev_err(&dev
->udev
->dev
, "unexpected tiny rx frame\n");
535 skb_trim(skb
, skb
->len
- 1);
536 status
= skb
->data
[skb
->len
];
538 if (status
!= MCS7830_RX_FRAME_CORRECT
) {
539 dev_dbg(&dev
->udev
->dev
, "rx fixup status %x\n", status
);
541 /* hmm, perhaps usbnet.c already sees a globally visible
542 frame error and increments rx_errors on its own already? */
543 dev
->net
->stats
.rx_errors
++;
545 if (status
& (MCS7830_RX_SHORT_FRAME
546 |MCS7830_RX_LENGTH_ERROR
547 |MCS7830_RX_LARGE_FRAME
))
548 dev
->net
->stats
.rx_length_errors
++;
549 if (status
& MCS7830_RX_ALIGNMENT_ERROR
)
550 dev
->net
->stats
.rx_frame_errors
++;
551 if (status
& MCS7830_RX_CRC_ERROR
)
552 dev
->net
->stats
.rx_crc_errors
++;
558 static void mcs7830_status(struct usbnet
*dev
, struct urb
*urb
)
560 u8
*buf
= urb
->transfer_buffer
;
561 bool link
, link_changed
;
563 if (urb
->actual_length
< 16)
566 link
= !(buf
[1] == 0x20);
567 link_changed
= netif_carrier_ok(dev
->net
) != link
;
569 usbnet_link_change(dev
, link
, 0);
570 netdev_dbg(dev
->net
, "Link Status is: %d\n", link
);
574 static const struct driver_info moschip_info
= {
575 .description
= "MOSCHIP 7830/7832/7730 usb-NET adapter",
576 .bind
= mcs7830_bind
,
577 .rx_fixup
= mcs7830_rx_fixup
,
578 .flags
= FLAG_ETHER
| FLAG_LINK_INTR
,
579 .status
= mcs7830_status
,
584 static const struct driver_info sitecom_info
= {
585 .description
= "Sitecom LN-30 usb-NET adapter",
586 .bind
= mcs7830_bind
,
587 .rx_fixup
= mcs7830_rx_fixup
,
588 .flags
= FLAG_ETHER
| FLAG_LINK_INTR
,
589 .status
= mcs7830_status
,
594 static const struct usb_device_id products
[] = {
596 USB_DEVICE(MCS7830_VENDOR_ID
, MCS7832_PRODUCT_ID
),
597 .driver_info
= (unsigned long) &moschip_info
,
600 USB_DEVICE(MCS7830_VENDOR_ID
, MCS7830_PRODUCT_ID
),
601 .driver_info
= (unsigned long) &moschip_info
,
604 USB_DEVICE(MCS7830_VENDOR_ID
, MCS7730_PRODUCT_ID
),
605 .driver_info
= (unsigned long) &moschip_info
,
608 USB_DEVICE(SITECOM_VENDOR_ID
, LN_030_PRODUCT_ID
),
609 .driver_info
= (unsigned long) &sitecom_info
,
613 MODULE_DEVICE_TABLE(usb
, products
);
615 static int mcs7830_reset_resume (struct usb_interface
*intf
)
617 /* YES, this function is successful enough that ethtool -d
618 does show same output pre-/post-suspend */
620 struct usbnet
*dev
= usb_get_intfdata(intf
);
622 mcs7830_apply_base_config(dev
);
629 static struct usb_driver mcs7830_driver
= {
631 .id_table
= products
,
632 .probe
= usbnet_probe
,
633 .disconnect
= usbnet_disconnect
,
634 .suspend
= usbnet_suspend
,
635 .resume
= usbnet_resume
,
636 .reset_resume
= mcs7830_reset_resume
,
637 .disable_hub_initiated_lpm
= 1,
640 module_usb_driver(mcs7830_driver
);
642 MODULE_DESCRIPTION("USB to network adapter MCS7830)");
643 MODULE_LICENSE("GPL");