1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * MOSCHIP MCS7830 based (7730/7830/7832) USB 2.0 Ethernet Devices
5 * based on usbnet.c, asix.c and the vendor provided mcs7830 driver
7 * Copyright (C) 2010 Andreas Mohr <andi@lisas.de>
8 * Copyright (C) 2006 Arnd Bergmann <arnd@arndb.de>
9 * Copyright (C) 2003-2005 David Hollis <dhollis@davehollis.com>
10 * Copyright (C) 2005 Phil Chang <pchang23@sbcglobal.net>
11 * Copyright (c) 2002-2003 TiVo Inc.
13 * Definitions gathered from MOSCHIP, Data Sheet_7830DA.pdf (thanks!).
15 * 2010-12-19: add 7832 USB PID ("functionality same as MCS7830"),
16 * per active notification by manufacturer
19 * - support HIF_REG_CONFIG_SLEEPMODE/HIF_REG_CONFIG_TXENABLE (via autopm?)
20 * - implement ethtool_ops get_pauseparam/set_pauseparam
21 * via HIF_REG_PAUSE_THRESHOLD (>= revision C only!)
22 * - implement get_eeprom/[set_eeprom]
23 * - switch PHY on/off on ifup/ifdown (perhaps in usbnet.c, via MII)
24 * - mcs7830_get_regs() handling is weird: for rev 2 we return 32 regs,
25 * can access only ~ 24, remaining user buffer is uninitialized garbage
29 #include <linux/crc32.h>
30 #include <linux/etherdevice.h>
31 #include <linux/ethtool.h>
32 #include <linux/mii.h>
33 #include <linux/module.h>
34 #include <linux/netdevice.h>
35 #include <linux/slab.h>
36 #include <linux/usb.h>
37 #include <linux/usb/usbnet.h>
40 #define MCS7830_RD_BMREQ (USB_DIR_IN | USB_TYPE_VENDOR | \
42 #define MCS7830_WR_BMREQ (USB_DIR_OUT | USB_TYPE_VENDOR | \
44 #define MCS7830_RD_BREQ 0x0E
45 #define MCS7830_WR_BREQ 0x0D
47 #define MCS7830_CTRL_TIMEOUT 1000
48 #define MCS7830_MAX_MCAST 64
50 #define MCS7830_VENDOR_ID 0x9710
51 #define MCS7832_PRODUCT_ID 0x7832
52 #define MCS7830_PRODUCT_ID 0x7830
53 #define MCS7730_PRODUCT_ID 0x7730
55 #define SITECOM_VENDOR_ID 0x0DF6
56 #define LN_030_PRODUCT_ID 0x0021
58 #define MCS7830_MII_ADVERTISE (ADVERTISE_PAUSE_CAP | ADVERTISE_100FULL | \
59 ADVERTISE_100HALF | ADVERTISE_10FULL | \
60 ADVERTISE_10HALF | ADVERTISE_CSMA)
62 /* HIF_REG_XX corresponding index value */
64 HIF_REG_MULTICAST_HASH
= 0x00,
65 HIF_REG_PACKET_GAP1
= 0x08,
66 HIF_REG_PACKET_GAP2
= 0x09,
67 HIF_REG_PHY_DATA
= 0x0a,
68 HIF_REG_PHY_CMD1
= 0x0c,
69 HIF_REG_PHY_CMD1_READ
= 0x40,
70 HIF_REG_PHY_CMD1_WRITE
= 0x20,
71 HIF_REG_PHY_CMD1_PHYADDR
= 0x01,
72 HIF_REG_PHY_CMD2
= 0x0d,
73 HIF_REG_PHY_CMD2_PEND_FLAG_BIT
= 0x80,
74 HIF_REG_PHY_CMD2_READY_FLAG_BIT
= 0x40,
75 HIF_REG_CONFIG
= 0x0e,
76 /* hmm, spec sez: "R/W", "Except bit 3" (likely TXENABLE). */
77 HIF_REG_CONFIG_CFG
= 0x80,
78 HIF_REG_CONFIG_SPEED100
= 0x40,
79 HIF_REG_CONFIG_FULLDUPLEX_ENABLE
= 0x20,
80 HIF_REG_CONFIG_RXENABLE
= 0x10,
81 HIF_REG_CONFIG_TXENABLE
= 0x08,
82 HIF_REG_CONFIG_SLEEPMODE
= 0x04,
83 HIF_REG_CONFIG_ALLMULTICAST
= 0x02,
84 HIF_REG_CONFIG_PROMISCUOUS
= 0x01,
85 HIF_REG_ETHERNET_ADDR
= 0x0f,
86 HIF_REG_FRAME_DROP_COUNTER
= 0x15, /* 0..ff; reset: 0 */
87 HIF_REG_PAUSE_THRESHOLD
= 0x16,
88 HIF_REG_PAUSE_THRESHOLD_DEFAULT
= 0,
91 /* Trailing status byte in Ethernet Rx frame */
93 MCS7830_RX_SHORT_FRAME
= 0x01, /* < 64 bytes */
94 MCS7830_RX_LENGTH_ERROR
= 0x02, /* framelen != Ethernet length field */
95 MCS7830_RX_ALIGNMENT_ERROR
= 0x04, /* non-even number of nibbles */
96 MCS7830_RX_CRC_ERROR
= 0x08,
97 MCS7830_RX_LARGE_FRAME
= 0x10, /* > 1518 bytes */
98 MCS7830_RX_FRAME_CORRECT
= 0x20, /* frame is correct */
102 struct mcs7830_data
{
107 static const char driver_name
[] = "MOSCHIP usb-ethernet driver";
109 static int mcs7830_get_reg(struct usbnet
*dev
, u16 index
, u16 size
, void *data
)
111 return usbnet_read_cmd(dev
, MCS7830_RD_BREQ
, MCS7830_RD_BMREQ
,
112 0x0000, index
, data
, size
);
115 static int mcs7830_set_reg(struct usbnet
*dev
, u16 index
, u16 size
, const void *data
)
117 return usbnet_write_cmd(dev
, MCS7830_WR_BREQ
, MCS7830_WR_BMREQ
,
118 0x0000, index
, data
, size
);
121 static void mcs7830_set_reg_async(struct usbnet
*dev
, u16 index
, u16 size
, void *data
)
123 usbnet_write_cmd_async(dev
, MCS7830_WR_BREQ
, MCS7830_WR_BMREQ
,
124 0x0000, index
, data
, size
);
127 static int mcs7830_hif_get_mac_address(struct usbnet
*dev
, unsigned char *addr
)
129 int ret
= mcs7830_get_reg(dev
, HIF_REG_ETHERNET_ADDR
, ETH_ALEN
, addr
);
135 static int mcs7830_hif_set_mac_address(struct usbnet
*dev
, unsigned char *addr
)
137 int ret
= mcs7830_set_reg(dev
, HIF_REG_ETHERNET_ADDR
, ETH_ALEN
, addr
);
144 static int mcs7830_set_mac_address(struct net_device
*netdev
, void *p
)
147 struct usbnet
*dev
= netdev_priv(netdev
);
148 struct sockaddr
*addr
= p
;
150 if (netif_running(netdev
))
153 if (!is_valid_ether_addr(addr
->sa_data
))
154 return -EADDRNOTAVAIL
;
156 ret
= mcs7830_hif_set_mac_address(dev
, addr
->sa_data
);
161 /* it worked --> adopt it on netdev side */
162 memcpy(netdev
->dev_addr
, addr
->sa_data
, netdev
->addr_len
);
167 static int mcs7830_read_phy(struct usbnet
*dev
, u8 index
)
174 HIF_REG_PHY_CMD1_READ
| HIF_REG_PHY_CMD1_PHYADDR
,
175 HIF_REG_PHY_CMD2_PEND_FLAG_BIT
| index
,
178 mutex_lock(&dev
->phy_mutex
);
179 /* write the MII command */
180 ret
= mcs7830_set_reg(dev
, HIF_REG_PHY_CMD1
, 2, cmd
);
184 /* wait for the data to become valid, should be within < 1ms */
185 for (i
= 0; i
< 10; i
++) {
186 ret
= mcs7830_get_reg(dev
, HIF_REG_PHY_CMD1
, 2, cmd
);
187 if ((ret
< 0) || (cmd
[1] & HIF_REG_PHY_CMD2_READY_FLAG_BIT
))
195 /* read actual register contents */
196 ret
= mcs7830_get_reg(dev
, HIF_REG_PHY_DATA
, 2, &val
);
199 ret
= le16_to_cpu(val
);
200 dev_dbg(&dev
->udev
->dev
, "read PHY reg %02x: %04x (%d tries)\n",
203 mutex_unlock(&dev
->phy_mutex
);
207 static int mcs7830_write_phy(struct usbnet
*dev
, u8 index
, u16 val
)
214 HIF_REG_PHY_CMD1_WRITE
| HIF_REG_PHY_CMD1_PHYADDR
,
215 HIF_REG_PHY_CMD2_PEND_FLAG_BIT
| (index
& 0x1F),
218 mutex_lock(&dev
->phy_mutex
);
220 /* write the new register contents */
221 le_val
= cpu_to_le16(val
);
222 ret
= mcs7830_set_reg(dev
, HIF_REG_PHY_DATA
, 2, &le_val
);
226 /* write the MII command */
227 ret
= mcs7830_set_reg(dev
, HIF_REG_PHY_CMD1
, 2, cmd
);
231 /* wait for the command to be accepted by the PHY */
232 for (i
= 0; i
< 10; i
++) {
233 ret
= mcs7830_get_reg(dev
, HIF_REG_PHY_CMD1
, 2, cmd
);
234 if ((ret
< 0) || (cmd
[1] & HIF_REG_PHY_CMD2_READY_FLAG_BIT
))
243 dev_dbg(&dev
->udev
->dev
, "write PHY reg %02x: %04x (%d tries)\n",
246 mutex_unlock(&dev
->phy_mutex
);
251 * This algorithm comes from the original mcs7830 version 1.4 driver,
252 * not sure if it is needed.
254 static int mcs7830_set_autoneg(struct usbnet
*dev
, int ptrUserPhyMode
)
257 /* Enable all media types */
258 ret
= mcs7830_write_phy(dev
, MII_ADVERTISE
, MCS7830_MII_ADVERTISE
);
260 /* First reset BMCR */
262 ret
= mcs7830_write_phy(dev
, MII_BMCR
, 0x0000);
263 /* Enable Auto Neg */
265 ret
= mcs7830_write_phy(dev
, MII_BMCR
, BMCR_ANENABLE
);
266 /* Restart Auto Neg (Keep the Enable Auto Neg Bit Set) */
268 ret
= mcs7830_write_phy(dev
, MII_BMCR
,
269 BMCR_ANENABLE
| BMCR_ANRESTART
);
275 * if we can read register 22, the chip revision is C or higher
277 static int mcs7830_get_rev(struct usbnet
*dev
)
281 ret
= mcs7830_get_reg(dev
, HIF_REG_FRAME_DROP_COUNTER
, 2, dummy
);
283 return 2; /* Rev C or later */
284 return 1; /* earlier revision */
288 * On rev. C we need to set the pause threshold
290 static void mcs7830_rev_C_fixup(struct usbnet
*dev
)
292 u8 pause_threshold
= HIF_REG_PAUSE_THRESHOLD_DEFAULT
;
295 for (retry
= 0; retry
< 2; retry
++) {
296 if (mcs7830_get_rev(dev
) == 2) {
297 dev_info(&dev
->udev
->dev
, "applying rev.C fixup\n");
298 mcs7830_set_reg(dev
, HIF_REG_PAUSE_THRESHOLD
,
299 1, &pause_threshold
);
305 static int mcs7830_mdio_read(struct net_device
*netdev
, int phy_id
,
308 struct usbnet
*dev
= netdev_priv(netdev
);
309 return mcs7830_read_phy(dev
, location
);
312 static void mcs7830_mdio_write(struct net_device
*netdev
, int phy_id
,
313 int location
, int val
)
315 struct usbnet
*dev
= netdev_priv(netdev
);
316 mcs7830_write_phy(dev
, location
, val
);
319 static int mcs7830_ioctl(struct net_device
*net
, struct ifreq
*rq
, int cmd
)
321 struct usbnet
*dev
= netdev_priv(net
);
322 return generic_mii_ioctl(&dev
->mii
, if_mii(rq
), cmd
, NULL
);
325 static inline struct mcs7830_data
*mcs7830_get_data(struct usbnet
*dev
)
327 return (struct mcs7830_data
*)&dev
->data
;
330 static void mcs7830_hif_update_multicast_hash(struct usbnet
*dev
)
332 struct mcs7830_data
*data
= mcs7830_get_data(dev
);
333 mcs7830_set_reg_async(dev
, HIF_REG_MULTICAST_HASH
,
334 sizeof data
->multi_filter
,
338 static void mcs7830_hif_update_config(struct usbnet
*dev
)
340 /* implementation specific to data->config
341 (argument needs to be heap-based anyway - USB DMA!) */
342 struct mcs7830_data
*data
= mcs7830_get_data(dev
);
343 mcs7830_set_reg_async(dev
, HIF_REG_CONFIG
, 1, &data
->config
);
346 static void mcs7830_data_set_multicast(struct net_device
*net
)
348 struct usbnet
*dev
= netdev_priv(net
);
349 struct mcs7830_data
*data
= mcs7830_get_data(dev
);
351 memset(data
->multi_filter
, 0, sizeof data
->multi_filter
);
353 data
->config
= HIF_REG_CONFIG_TXENABLE
;
355 /* this should not be needed, but it doesn't work otherwise */
356 data
->config
|= HIF_REG_CONFIG_ALLMULTICAST
;
358 if (net
->flags
& IFF_PROMISC
) {
359 data
->config
|= HIF_REG_CONFIG_PROMISCUOUS
;
360 } else if (net
->flags
& IFF_ALLMULTI
||
361 netdev_mc_count(net
) > MCS7830_MAX_MCAST
) {
362 data
->config
|= HIF_REG_CONFIG_ALLMULTICAST
;
363 } else if (netdev_mc_empty(net
)) {
364 /* just broadcast and directed */
366 /* We use the 20 byte dev->data
367 * for our 8 byte filter buffer
368 * to avoid allocating memory that
369 * is tricky to free later */
370 struct netdev_hw_addr
*ha
;
373 /* Build the multicast hash filter. */
374 netdev_for_each_mc_addr(ha
, net
) {
375 crc_bits
= ether_crc(ETH_ALEN
, ha
->addr
) >> 26;
376 data
->multi_filter
[crc_bits
>> 3] |= 1 << (crc_bits
& 7);
381 static int mcs7830_apply_base_config(struct usbnet
*dev
)
385 /* re-configure known MAC (suspend case etc.) */
386 ret
= mcs7830_hif_set_mac_address(dev
, dev
->net
->dev_addr
);
388 dev_info(&dev
->udev
->dev
, "Cannot set MAC address\n");
393 ret
= mcs7830_set_autoneg(dev
, 0);
395 dev_info(&dev
->udev
->dev
, "Cannot set autoneg\n");
399 mcs7830_hif_update_multicast_hash(dev
);
400 mcs7830_hif_update_config(dev
);
402 mcs7830_rev_C_fixup(dev
);
408 /* credits go to asix_set_multicast */
409 static void mcs7830_set_multicast(struct net_device
*net
)
411 struct usbnet
*dev
= netdev_priv(net
);
413 mcs7830_data_set_multicast(net
);
415 mcs7830_hif_update_multicast_hash(dev
);
416 mcs7830_hif_update_config(dev
);
419 static int mcs7830_get_regs_len(struct net_device
*net
)
421 struct usbnet
*dev
= netdev_priv(net
);
423 switch (mcs7830_get_rev(dev
)) {
432 static void mcs7830_get_drvinfo(struct net_device
*net
, struct ethtool_drvinfo
*drvinfo
)
434 usbnet_get_drvinfo(net
, drvinfo
);
437 static void mcs7830_get_regs(struct net_device
*net
, struct ethtool_regs
*regs
, void *data
)
439 struct usbnet
*dev
= netdev_priv(net
);
441 regs
->version
= mcs7830_get_rev(dev
);
442 mcs7830_get_reg(dev
, 0, regs
->len
, data
);
445 static const struct ethtool_ops mcs7830_ethtool_ops
= {
446 .get_drvinfo
= mcs7830_get_drvinfo
,
447 .get_regs_len
= mcs7830_get_regs_len
,
448 .get_regs
= mcs7830_get_regs
,
450 /* common usbnet calls */
451 .get_link
= usbnet_get_link
,
452 .get_msglevel
= usbnet_get_msglevel
,
453 .set_msglevel
= usbnet_set_msglevel
,
454 .nway_reset
= usbnet_nway_reset
,
455 .get_link_ksettings
= usbnet_get_link_ksettings
,
456 .set_link_ksettings
= usbnet_set_link_ksettings
,
459 static const struct net_device_ops mcs7830_netdev_ops
= {
460 .ndo_open
= usbnet_open
,
461 .ndo_stop
= usbnet_stop
,
462 .ndo_start_xmit
= usbnet_start_xmit
,
463 .ndo_tx_timeout
= usbnet_tx_timeout
,
464 .ndo_change_mtu
= usbnet_change_mtu
,
465 .ndo_get_stats64
= usbnet_get_stats64
,
466 .ndo_validate_addr
= eth_validate_addr
,
467 .ndo_do_ioctl
= mcs7830_ioctl
,
468 .ndo_set_rx_mode
= mcs7830_set_multicast
,
469 .ndo_set_mac_address
= mcs7830_set_mac_address
,
472 static int mcs7830_bind(struct usbnet
*dev
, struct usb_interface
*udev
)
474 struct net_device
*net
= dev
->net
;
478 /* Initial startup: Gather MAC address setting from EEPROM */
480 for (retry
= 0; retry
< 5 && ret
; retry
++)
481 ret
= mcs7830_hif_get_mac_address(dev
, net
->dev_addr
);
483 dev_warn(&dev
->udev
->dev
, "Cannot read MAC address\n");
487 mcs7830_data_set_multicast(net
);
489 ret
= mcs7830_apply_base_config(dev
);
493 net
->ethtool_ops
= &mcs7830_ethtool_ops
;
494 net
->netdev_ops
= &mcs7830_netdev_ops
;
496 /* reserve space for the status byte on rx */
497 dev
->rx_urb_size
= ETH_FRAME_LEN
+ 1;
499 dev
->mii
.mdio_read
= mcs7830_mdio_read
;
500 dev
->mii
.mdio_write
= mcs7830_mdio_write
;
502 dev
->mii
.phy_id_mask
= 0x3f;
503 dev
->mii
.reg_num_mask
= 0x1f;
504 dev
->mii
.phy_id
= *((u8
*) net
->dev_addr
+ 1);
506 ret
= usbnet_get_endpoints(dev
, udev
);
511 /* The chip always appends a status byte that we need to strip */
512 static int mcs7830_rx_fixup(struct usbnet
*dev
, struct sk_buff
*skb
)
516 /* This check is no longer done by usbnet */
517 if (skb
->len
< dev
->net
->hard_header_len
) {
518 dev_err(&dev
->udev
->dev
, "unexpected tiny rx frame\n");
522 skb_trim(skb
, skb
->len
- 1);
523 status
= skb
->data
[skb
->len
];
525 if (status
!= MCS7830_RX_FRAME_CORRECT
) {
526 dev_dbg(&dev
->udev
->dev
, "rx fixup status %x\n", status
);
528 /* hmm, perhaps usbnet.c already sees a globally visible
529 frame error and increments rx_errors on its own already? */
530 dev
->net
->stats
.rx_errors
++;
532 if (status
& (MCS7830_RX_SHORT_FRAME
533 |MCS7830_RX_LENGTH_ERROR
534 |MCS7830_RX_LARGE_FRAME
))
535 dev
->net
->stats
.rx_length_errors
++;
536 if (status
& MCS7830_RX_ALIGNMENT_ERROR
)
537 dev
->net
->stats
.rx_frame_errors
++;
538 if (status
& MCS7830_RX_CRC_ERROR
)
539 dev
->net
->stats
.rx_crc_errors
++;
545 static void mcs7830_status(struct usbnet
*dev
, struct urb
*urb
)
547 u8
*buf
= urb
->transfer_buffer
;
548 bool link
, link_changed
;
550 if (urb
->actual_length
< 16)
553 link
= !(buf
[1] == 0x20);
554 link_changed
= netif_carrier_ok(dev
->net
) != link
;
556 usbnet_link_change(dev
, link
, 0);
557 netdev_dbg(dev
->net
, "Link Status is: %d\n", link
);
561 static const struct driver_info moschip_info
= {
562 .description
= "MOSCHIP 7830/7832/7730 usb-NET adapter",
563 .bind
= mcs7830_bind
,
564 .rx_fixup
= mcs7830_rx_fixup
,
565 .flags
= FLAG_ETHER
| FLAG_LINK_INTR
,
566 .status
= mcs7830_status
,
571 static const struct driver_info sitecom_info
= {
572 .description
= "Sitecom LN-30 usb-NET adapter",
573 .bind
= mcs7830_bind
,
574 .rx_fixup
= mcs7830_rx_fixup
,
575 .flags
= FLAG_ETHER
| FLAG_LINK_INTR
,
576 .status
= mcs7830_status
,
581 static const struct usb_device_id products
[] = {
583 USB_DEVICE(MCS7830_VENDOR_ID
, MCS7832_PRODUCT_ID
),
584 .driver_info
= (unsigned long) &moschip_info
,
587 USB_DEVICE(MCS7830_VENDOR_ID
, MCS7830_PRODUCT_ID
),
588 .driver_info
= (unsigned long) &moschip_info
,
591 USB_DEVICE(MCS7830_VENDOR_ID
, MCS7730_PRODUCT_ID
),
592 .driver_info
= (unsigned long) &moschip_info
,
595 USB_DEVICE(SITECOM_VENDOR_ID
, LN_030_PRODUCT_ID
),
596 .driver_info
= (unsigned long) &sitecom_info
,
600 MODULE_DEVICE_TABLE(usb
, products
);
602 static int mcs7830_reset_resume (struct usb_interface
*intf
)
604 /* YES, this function is successful enough that ethtool -d
605 does show same output pre-/post-suspend */
607 struct usbnet
*dev
= usb_get_intfdata(intf
);
609 mcs7830_apply_base_config(dev
);
616 static struct usb_driver mcs7830_driver
= {
618 .id_table
= products
,
619 .probe
= usbnet_probe
,
620 .disconnect
= usbnet_disconnect
,
621 .suspend
= usbnet_suspend
,
622 .resume
= usbnet_resume
,
623 .reset_resume
= mcs7830_reset_resume
,
624 .disable_hub_initiated_lpm
= 1,
627 module_usb_driver(mcs7830_driver
);
629 MODULE_DESCRIPTION("USB to network adapter MCS7830)");
630 MODULE_LICENSE("GPL");