1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * ASIX AX8817X based USB 2.0 Ethernet Devices
4 * Copyright (C) 2003-2006 David Hollis <dhollis@davehollis.com>
5 * Copyright (C) 2005 Phil Chang <pchang23@sbcglobal.net>
6 * Copyright (C) 2006 James Painter <jamie.painter@iname.com>
7 * Copyright (c) 2002-2003 TiVo Inc.
12 #define PHY_MODE_MARVELL 0x0000
13 #define MII_MARVELL_LED_CTRL 0x0018
14 #define MII_MARVELL_STATUS 0x001b
15 #define MII_MARVELL_CTRL 0x0014
17 #define MARVELL_LED_MANUAL 0x0019
19 #define MARVELL_STATUS_HWCFG 0x0004
21 #define MARVELL_CTRL_TXDELAY 0x0002
22 #define MARVELL_CTRL_RXDELAY 0x0080
24 #define PHY_MODE_RTL8211CL 0x000C
26 #define AX88772A_PHY14H 0x14
27 #define AX88772A_PHY14H_DEFAULT 0x442C
29 #define AX88772A_PHY15H 0x15
30 #define AX88772A_PHY15H_DEFAULT 0x03C8
32 #define AX88772A_PHY16H 0x16
33 #define AX88772A_PHY16H_DEFAULT 0x4044
35 struct ax88172_int_data {
43 static void asix_status(struct usbnet *dev, struct urb *urb)
45 struct ax88172_int_data *event;
48 if (urb->actual_length < 8)
51 event = urb->transfer_buffer;
52 link = event->link & 0x01;
53 if (netif_carrier_ok(dev->net) != link) {
54 usbnet_link_change(dev, link, 1);
55 netdev_dbg(dev->net, "Link Status is: %d\n", link);
59 static void asix_set_netdev_dev_addr(struct usbnet *dev, u8 *addr)
61 if (is_valid_ether_addr(addr)) {
62 memcpy(dev->net->dev_addr, addr, ETH_ALEN);
64 netdev_info(dev->net, "invalid hw address, using random\n");
65 eth_hw_addr_random(dev->net);
69 /* Get the PHY Identifier from the PHYSID1 & PHYSID2 MII registers */
70 static u32 asix_get_phyid(struct usbnet *dev)
76 /* Poll for the rare case the FW or phy isn't ready yet. */
77 for (i = 0; i < 100; i++) {
78 phy_reg = asix_mdio_read(dev->net, dev->mii.phy_id, MII_PHYSID1);
81 if (phy_reg != 0 && phy_reg != 0xFFFF)
86 if (phy_reg <= 0 || phy_reg == 0xFFFF)
89 phy_id = (phy_reg & 0xffff) << 16;
91 phy_reg = asix_mdio_read(dev->net, dev->mii.phy_id, MII_PHYSID2);
95 phy_id |= (phy_reg & 0xffff);
100 static u32 asix_get_link(struct net_device *net)
102 struct usbnet *dev = netdev_priv(net);
104 return mii_link_ok(&dev->mii);
107 static int asix_ioctl (struct net_device *net, struct ifreq *rq, int cmd)
109 struct usbnet *dev = netdev_priv(net);
111 return generic_mii_ioctl(&dev->mii, if_mii(rq), cmd, NULL);
114 /* We need to override some ethtool_ops so we require our
115 own structure so we don't interfere with other usbnet
116 devices that may be connected at the same time. */
117 static const struct ethtool_ops ax88172_ethtool_ops = {
118 .get_drvinfo = asix_get_drvinfo,
119 .get_link = asix_get_link,
120 .get_msglevel = usbnet_get_msglevel,
121 .set_msglevel = usbnet_set_msglevel,
122 .get_wol = asix_get_wol,
123 .set_wol = asix_set_wol,
124 .get_eeprom_len = asix_get_eeprom_len,
125 .get_eeprom = asix_get_eeprom,
126 .set_eeprom = asix_set_eeprom,
127 .nway_reset = usbnet_nway_reset,
128 .get_link_ksettings = usbnet_get_link_ksettings_mii,
129 .set_link_ksettings = usbnet_set_link_ksettings_mii,
132 static void ax88172_set_multicast(struct net_device *net)
134 struct usbnet *dev = netdev_priv(net);
135 struct asix_data *data = (struct asix_data *)&dev->data;
138 if (net->flags & IFF_PROMISC) {
140 } else if (net->flags & IFF_ALLMULTI ||
141 netdev_mc_count(net) > AX_MAX_MCAST) {
143 } else if (netdev_mc_empty(net)) {
144 /* just broadcast and directed */
146 /* We use the 20 byte dev->data
147 * for our 8 byte filter buffer
148 * to avoid allocating memory that
149 * is tricky to free later */
150 struct netdev_hw_addr *ha;
153 memset(data->multi_filter, 0, AX_MCAST_FILTER_SIZE);
155 /* Build the multicast hash filter. */
156 netdev_for_each_mc_addr(ha, net) {
157 crc_bits = ether_crc(ETH_ALEN, ha->addr) >> 26;
158 data->multi_filter[crc_bits >> 3] |=
162 asix_write_cmd_async(dev, AX_CMD_WRITE_MULTI_FILTER, 0, 0,
163 AX_MCAST_FILTER_SIZE, data->multi_filter);
168 asix_write_cmd_async(dev, AX_CMD_WRITE_RX_CTL, rx_ctl, 0, 0, NULL);
171 static int ax88172_link_reset(struct usbnet *dev)
174 struct ethtool_cmd ecmd = { .cmd = ETHTOOL_GSET };
176 mii_check_media(&dev->mii, 1, 1);
177 mii_ethtool_gset(&dev->mii, &ecmd);
178 mode = AX88172_MEDIUM_DEFAULT;
180 if (ecmd.duplex != DUPLEX_FULL)
181 mode |= ~AX88172_MEDIUM_FD;
183 netdev_dbg(dev->net, "ax88172_link_reset() speed: %u duplex: %d setting mode to 0x%04x\n",
184 ethtool_cmd_speed(&ecmd), ecmd.duplex, mode);
186 asix_write_medium_mode(dev, mode, 0);
191 static const struct net_device_ops ax88172_netdev_ops = {
192 .ndo_open = usbnet_open,
193 .ndo_stop = usbnet_stop,
194 .ndo_start_xmit = usbnet_start_xmit,
195 .ndo_tx_timeout = usbnet_tx_timeout,
196 .ndo_change_mtu = usbnet_change_mtu,
197 .ndo_get_stats64 = dev_get_tstats64,
198 .ndo_set_mac_address = eth_mac_addr,
199 .ndo_validate_addr = eth_validate_addr,
200 .ndo_eth_ioctl = asix_ioctl,
201 .ndo_set_rx_mode = ax88172_set_multicast,
204 static void asix_phy_reset(struct usbnet *dev, unsigned int reset_bits)
206 unsigned int timeout = 5000;
208 asix_mdio_write(dev->net, dev->mii.phy_id, MII_BMCR, reset_bits);
210 /* give phy_id a chance to process reset */
213 /* See IEEE 802.3 "22.2.4.1.1 Reset": 500ms max */
215 if (asix_mdio_read(dev->net, dev->mii.phy_id, MII_BMCR)
222 netdev_err(dev->net, "BMCR_RESET timeout on phy_id %d\n",
226 static int ax88172_bind(struct usbnet *dev, struct usb_interface *intf)
229 u8 buf[ETH_ALEN] = {0};
231 unsigned long gpio_bits = dev->driver_info->data;
233 usbnet_get_endpoints(dev,intf);
235 /* Toggle the GPIOs in a manufacturer/model specific way */
236 for (i = 2; i >= 0; i--) {
237 ret = asix_write_cmd(dev, AX_CMD_WRITE_GPIOS,
238 (gpio_bits >> (i * 8)) & 0xff, 0, 0, NULL, 0);
244 ret = asix_write_rx_ctl(dev, 0x80, 0);
248 /* Get the MAC address */
249 ret = asix_read_cmd(dev, AX88172_CMD_READ_NODE_ID,
250 0, 0, ETH_ALEN, buf, 0);
252 netdev_dbg(dev->net, "read AX_CMD_READ_NODE_ID failed: %d\n",
257 asix_set_netdev_dev_addr(dev, buf);
259 /* Initialize MII structure */
260 dev->mii.dev = dev->net;
261 dev->mii.mdio_read = asix_mdio_read;
262 dev->mii.mdio_write = asix_mdio_write;
263 dev->mii.phy_id_mask = 0x3f;
264 dev->mii.reg_num_mask = 0x1f;
266 dev->mii.phy_id = asix_read_phy_addr(dev, true);
267 if (dev->mii.phy_id < 0)
268 return dev->mii.phy_id;
270 dev->net->netdev_ops = &ax88172_netdev_ops;
271 dev->net->ethtool_ops = &ax88172_ethtool_ops;
272 dev->net->needed_headroom = 4; /* cf asix_tx_fixup() */
273 dev->net->needed_tailroom = 4; /* cf asix_tx_fixup() */
275 asix_phy_reset(dev, BMCR_RESET);
276 asix_mdio_write(dev->net, dev->mii.phy_id, MII_ADVERTISE,
277 ADVERTISE_ALL | ADVERTISE_CSMA | ADVERTISE_PAUSE_CAP);
278 mii_nway_restart(&dev->mii);
286 static void ax88772_ethtool_get_strings(struct net_device *netdev, u32 sset,
291 net_selftest_get_strings(data);
296 static int ax88772_ethtool_get_sset_count(struct net_device *ndev, int sset)
300 return net_selftest_get_count();
306 static const struct ethtool_ops ax88772_ethtool_ops = {
307 .get_drvinfo = asix_get_drvinfo,
308 .get_link = usbnet_get_link,
309 .get_msglevel = usbnet_get_msglevel,
310 .set_msglevel = usbnet_set_msglevel,
311 .get_wol = asix_get_wol,
312 .set_wol = asix_set_wol,
313 .get_eeprom_len = asix_get_eeprom_len,
314 .get_eeprom = asix_get_eeprom,
315 .set_eeprom = asix_set_eeprom,
316 .nway_reset = phy_ethtool_nway_reset,
317 .get_link_ksettings = phy_ethtool_get_link_ksettings,
318 .set_link_ksettings = phy_ethtool_set_link_ksettings,
319 .self_test = net_selftest,
320 .get_strings = ax88772_ethtool_get_strings,
321 .get_sset_count = ax88772_ethtool_get_sset_count,
324 static int ax88772_reset(struct usbnet *dev)
326 struct asix_data *data = (struct asix_data *)&dev->data;
327 struct asix_common_private *priv = dev->driver_priv;
330 /* Rewrite MAC address */
331 ether_addr_copy(data->mac_addr, dev->net->dev_addr);
332 ret = asix_write_cmd(dev, AX_CMD_WRITE_NODE_ID, 0, 0,
333 ETH_ALEN, data->mac_addr, 0);
337 /* Set RX_CTL to default values with 2k buffer, and enable cactus */
338 ret = asix_write_rx_ctl(dev, AX_DEFAULT_RX_CTL, 0);
342 ret = asix_write_medium_mode(dev, AX88772_MEDIUM_DEFAULT, 0);
346 phy_start(priv->phydev);
354 static int ax88772_hw_reset(struct usbnet *dev, int in_pm)
356 struct asix_data *data = (struct asix_data *)&dev->data;
357 struct asix_common_private *priv = dev->driver_priv;
361 ret = asix_write_gpio(dev, AX_GPIO_RSE | AX_GPIO_GPO_2 |
362 AX_GPIO_GPO2EN, 5, in_pm);
366 ret = asix_write_cmd(dev, AX_CMD_SW_PHY_SELECT, priv->embd_phy,
369 netdev_dbg(dev->net, "Select PHY #1 failed: %d\n", ret);
373 if (priv->embd_phy) {
374 ret = asix_sw_reset(dev, AX_SWRESET_IPPD, in_pm);
378 usleep_range(10000, 11000);
380 ret = asix_sw_reset(dev, AX_SWRESET_CLEAR, in_pm);
386 ret = asix_sw_reset(dev, AX_SWRESET_IPRL | AX_SWRESET_PRL,
391 ret = asix_sw_reset(dev, AX_SWRESET_IPPD | AX_SWRESET_PRL,
399 if (in_pm && (!asix_mdio_read_nopm(dev->net, dev->mii.phy_id,
405 ret = asix_write_rx_ctl(dev, AX_DEFAULT_RX_CTL, in_pm);
409 ret = asix_write_medium_mode(dev, AX88772_MEDIUM_DEFAULT, in_pm);
413 ret = asix_write_cmd(dev, AX_CMD_WRITE_IPG0,
414 AX88772_IPG0_DEFAULT | AX88772_IPG1_DEFAULT,
415 AX88772_IPG2_DEFAULT, 0, NULL, in_pm);
417 netdev_dbg(dev->net, "Write IPG,IPG1,IPG2 failed: %d\n", ret);
421 /* Rewrite MAC address */
422 ether_addr_copy(data->mac_addr, dev->net->dev_addr);
423 ret = asix_write_cmd(dev, AX_CMD_WRITE_NODE_ID, 0, 0,
424 ETH_ALEN, data->mac_addr, in_pm);
428 /* Set RX_CTL to default values with 2k buffer, and enable cactus */
429 ret = asix_write_rx_ctl(dev, AX_DEFAULT_RX_CTL, in_pm);
433 rx_ctl = asix_read_rx_ctl(dev, in_pm);
434 netdev_dbg(dev->net, "RX_CTL is 0x%04x after all initializations\n",
437 rx_ctl = asix_read_medium_status(dev, in_pm);
439 "Medium Status is 0x%04x after all initializations\n",
448 static int ax88772a_hw_reset(struct usbnet *dev, int in_pm)
450 struct asix_data *data = (struct asix_data *)&dev->data;
451 struct asix_common_private *priv = dev->driver_priv;
452 u16 rx_ctl, phy14h, phy15h, phy16h;
456 ret = asix_write_gpio(dev, AX_GPIO_RSE, 5, in_pm);
460 ret = asix_write_cmd(dev, AX_CMD_SW_PHY_SELECT, priv->embd_phy |
461 AX_PHYSEL_SSEN, 0, 0, NULL, in_pm);
463 netdev_dbg(dev->net, "Select PHY #1 failed: %d\n", ret);
466 usleep_range(10000, 11000);
468 ret = asix_sw_reset(dev, AX_SWRESET_IPPD | AX_SWRESET_IPRL, in_pm);
472 usleep_range(10000, 11000);
474 ret = asix_sw_reset(dev, AX_SWRESET_IPRL, in_pm);
480 ret = asix_sw_reset(dev, AX_SWRESET_CLEAR, in_pm);
484 ret = asix_sw_reset(dev, AX_SWRESET_IPRL, in_pm);
490 if (in_pm && (!asix_mdio_read_nopm(dev->net, dev->mii.phy_id,
496 ret = asix_read_cmd(dev, AX_CMD_STATMNGSTS_REG, 0,
497 0, 1, &chipcode, in_pm);
501 if ((chipcode & AX_CHIPCODE_MASK) == AX_AX88772B_CHIPCODE) {
502 ret = asix_write_cmd(dev, AX_QCTCTRL, 0x8000, 0x8001,
505 netdev_dbg(dev->net, "Write BQ setting failed: %d\n",
509 } else if ((chipcode & AX_CHIPCODE_MASK) == AX_AX88772A_CHIPCODE) {
510 /* Check if the PHY registers have default settings */
511 phy14h = asix_mdio_read_nopm(dev->net, dev->mii.phy_id,
513 phy15h = asix_mdio_read_nopm(dev->net, dev->mii.phy_id,
515 phy16h = asix_mdio_read_nopm(dev->net, dev->mii.phy_id,
519 "772a_hw_reset: MR20=0x%x MR21=0x%x MR22=0x%x\n",
520 phy14h, phy15h, phy16h);
522 /* Restore PHY registers default setting if not */
523 if (phy14h != AX88772A_PHY14H_DEFAULT)
524 asix_mdio_write_nopm(dev->net, dev->mii.phy_id,
526 AX88772A_PHY14H_DEFAULT);
527 if (phy15h != AX88772A_PHY15H_DEFAULT)
528 asix_mdio_write_nopm(dev->net, dev->mii.phy_id,
530 AX88772A_PHY15H_DEFAULT);
531 if (phy16h != AX88772A_PHY16H_DEFAULT)
532 asix_mdio_write_nopm(dev->net, dev->mii.phy_id,
534 AX88772A_PHY16H_DEFAULT);
537 ret = asix_write_cmd(dev, AX_CMD_WRITE_IPG0,
538 AX88772_IPG0_DEFAULT | AX88772_IPG1_DEFAULT,
539 AX88772_IPG2_DEFAULT, 0, NULL, in_pm);
541 netdev_dbg(dev->net, "Write IPG,IPG1,IPG2 failed: %d\n", ret);
545 /* Rewrite MAC address */
546 memcpy(data->mac_addr, dev->net->dev_addr, ETH_ALEN);
547 ret = asix_write_cmd(dev, AX_CMD_WRITE_NODE_ID, 0, 0, ETH_ALEN,
548 data->mac_addr, in_pm);
552 /* Set RX_CTL to default values with 2k buffer, and enable cactus */
553 ret = asix_write_rx_ctl(dev, AX_DEFAULT_RX_CTL, in_pm);
557 ret = asix_write_medium_mode(dev, AX88772_MEDIUM_DEFAULT, in_pm);
561 /* Set RX_CTL to default values with 2k buffer, and enable cactus */
562 ret = asix_write_rx_ctl(dev, AX_DEFAULT_RX_CTL, in_pm);
566 rx_ctl = asix_read_rx_ctl(dev, in_pm);
567 netdev_dbg(dev->net, "RX_CTL is 0x%04x after all initializations\n",
570 rx_ctl = asix_read_medium_status(dev, in_pm);
572 "Medium Status is 0x%04x after all initializations\n",
581 static const struct net_device_ops ax88772_netdev_ops = {
582 .ndo_open = usbnet_open,
583 .ndo_stop = usbnet_stop,
584 .ndo_start_xmit = usbnet_start_xmit,
585 .ndo_tx_timeout = usbnet_tx_timeout,
586 .ndo_change_mtu = usbnet_change_mtu,
587 .ndo_get_stats64 = dev_get_tstats64,
588 .ndo_set_mac_address = asix_set_mac_address,
589 .ndo_validate_addr = eth_validate_addr,
590 .ndo_eth_ioctl = phy_do_ioctl_running,
591 .ndo_set_rx_mode = asix_set_multicast,
594 static void ax88772_suspend(struct usbnet *dev)
596 struct asix_common_private *priv = dev->driver_priv;
599 if (netif_running(dev->net))
600 phy_stop(priv->phydev);
602 /* Stop MAC operation */
603 medium = asix_read_medium_status(dev, 1);
604 medium &= ~AX_MEDIUM_RE;
605 asix_write_medium_mode(dev, medium, 1);
607 netdev_dbg(dev->net, "ax88772_suspend: medium=0x%04x\n",
608 asix_read_medium_status(dev, 1));
611 static int asix_suspend(struct usb_interface *intf, pm_message_t message)
613 struct usbnet *dev = usb_get_intfdata(intf);
614 struct asix_common_private *priv = dev->driver_priv;
616 if (priv && priv->suspend)
619 return usbnet_suspend(intf, message);
622 static void ax88772_resume(struct usbnet *dev)
624 struct asix_common_private *priv = dev->driver_priv;
627 for (i = 0; i < 3; i++)
628 if (!ax88772_hw_reset(dev, 1))
631 if (netif_running(dev->net))
632 phy_start(priv->phydev);
635 static void ax88772a_resume(struct usbnet *dev)
637 struct asix_common_private *priv = dev->driver_priv;
640 for (i = 0; i < 3; i++) {
641 if (!ax88772a_hw_reset(dev, 1))
645 if (netif_running(dev->net))
646 phy_start(priv->phydev);
649 static int asix_resume(struct usb_interface *intf)
651 struct usbnet *dev = usb_get_intfdata(intf);
652 struct asix_common_private *priv = dev->driver_priv;
654 if (priv && priv->resume)
657 return usbnet_resume(intf);
660 static int ax88772_init_mdio(struct usbnet *dev)
662 struct asix_common_private *priv = dev->driver_priv;
664 priv->mdio = devm_mdiobus_alloc(&dev->udev->dev);
668 priv->mdio->priv = dev;
669 priv->mdio->read = &asix_mdio_bus_read;
670 priv->mdio->write = &asix_mdio_bus_write;
671 priv->mdio->name = "Asix MDIO Bus";
672 /* mii bus name is usb-<usb bus number>-<usb device number> */
673 snprintf(priv->mdio->id, MII_BUS_ID_SIZE, "usb-%03d:%03d",
674 dev->udev->bus->busnum, dev->udev->devnum);
676 return devm_mdiobus_register(&dev->udev->dev, priv->mdio);
679 static int ax88772_init_phy(struct usbnet *dev)
681 struct asix_common_private *priv = dev->driver_priv;
684 snprintf(priv->phy_name, sizeof(priv->phy_name), PHY_ID_FMT,
685 priv->mdio->id, priv->phy_addr);
687 priv->phydev = phy_connect(dev->net, priv->phy_name, &asix_adjust_link,
688 PHY_INTERFACE_MODE_INTERNAL);
689 if (IS_ERR(priv->phydev)) {
690 netdev_err(dev->net, "Could not connect to PHY device %s\n",
692 ret = PTR_ERR(priv->phydev);
696 phy_suspend(priv->phydev);
697 priv->phydev->mac_managed_pm = 1;
699 phy_attached_info(priv->phydev);
704 static int ax88772_bind(struct usbnet *dev, struct usb_interface *intf)
706 u8 buf[ETH_ALEN] = {0}, chipcode = 0;
707 struct asix_common_private *priv;
710 priv = devm_kzalloc(&dev->udev->dev, sizeof(*priv), GFP_KERNEL);
714 dev->driver_priv = priv;
716 usbnet_get_endpoints(dev, intf);
718 /* Maybe the boot loader passed the MAC address via device tree */
719 if (!eth_platform_get_mac_address(&dev->udev->dev, buf)) {
720 netif_dbg(dev, ifup, dev->net,
721 "MAC address read from device tree");
723 /* Try getting the MAC address from EEPROM */
724 if (dev->driver_info->data & FLAG_EEPROM_MAC) {
725 for (i = 0; i < (ETH_ALEN >> 1); i++) {
726 ret = asix_read_cmd(dev, AX_CMD_READ_EEPROM,
727 0x04 + i, 0, 2, buf + i * 2,
733 ret = asix_read_cmd(dev, AX_CMD_READ_NODE_ID,
734 0, 0, ETH_ALEN, buf, 0);
738 netdev_dbg(dev->net, "Failed to read MAC address: %d\n",
744 asix_set_netdev_dev_addr(dev, buf);
746 dev->net->netdev_ops = &ax88772_netdev_ops;
747 dev->net->ethtool_ops = &ax88772_ethtool_ops;
748 dev->net->needed_headroom = 4; /* cf asix_tx_fixup() */
749 dev->net->needed_tailroom = 4; /* cf asix_tx_fixup() */
751 ret = asix_read_phy_addr(dev, true);
755 priv->phy_addr = ret;
756 priv->embd_phy = ((priv->phy_addr & 0x1f) == 0x10);
758 asix_read_cmd(dev, AX_CMD_STATMNGSTS_REG, 0, 0, 1, &chipcode, 0);
759 chipcode &= AX_CHIPCODE_MASK;
761 ret = (chipcode == AX_AX88772_CHIPCODE) ? ax88772_hw_reset(dev, 0) :
762 ax88772a_hw_reset(dev, 0);
765 netdev_dbg(dev->net, "Failed to reset AX88772: %d\n", ret);
769 /* Asix framing packs multiple eth frames into a 2K usb bulk transfer */
770 if (dev->driver_info->flags & FLAG_FRAMING_AX) {
771 /* hard_mtu is still the default - the device does not support
773 dev->rx_urb_size = 2048;
776 priv->presvd_phy_bmcr = 0;
777 priv->presvd_phy_advertise = 0;
778 if (chipcode == AX_AX88772_CHIPCODE) {
779 priv->resume = ax88772_resume;
780 priv->suspend = ax88772_suspend;
782 priv->resume = ax88772a_resume;
783 priv->suspend = ax88772_suspend;
786 ret = ax88772_init_mdio(dev);
790 return ax88772_init_phy(dev);
793 static int ax88772_stop(struct usbnet *dev)
795 struct asix_common_private *priv = dev->driver_priv;
797 /* On unplugged USB, we will get MDIO communication errors and the
798 * PHY will be set in to PHY_HALTED state.
800 if (priv->phydev->state != PHY_HALTED)
801 phy_stop(priv->phydev);
806 static void ax88772_unbind(struct usbnet *dev, struct usb_interface *intf)
808 struct asix_common_private *priv = dev->driver_priv;
810 phy_disconnect(priv->phydev);
811 asix_rx_fixup_common_free(dev->driver_priv);
814 static void ax88178_unbind(struct usbnet *dev, struct usb_interface *intf)
816 asix_rx_fixup_common_free(dev->driver_priv);
817 kfree(dev->driver_priv);
820 static const struct ethtool_ops ax88178_ethtool_ops = {
821 .get_drvinfo = asix_get_drvinfo,
822 .get_link = asix_get_link,
823 .get_msglevel = usbnet_get_msglevel,
824 .set_msglevel = usbnet_set_msglevel,
825 .get_wol = asix_get_wol,
826 .set_wol = asix_set_wol,
827 .get_eeprom_len = asix_get_eeprom_len,
828 .get_eeprom = asix_get_eeprom,
829 .set_eeprom = asix_set_eeprom,
830 .nway_reset = usbnet_nway_reset,
831 .get_link_ksettings = usbnet_get_link_ksettings_mii,
832 .set_link_ksettings = usbnet_set_link_ksettings_mii,
835 static int marvell_phy_init(struct usbnet *dev)
837 struct asix_data *data = (struct asix_data *)&dev->data;
840 netdev_dbg(dev->net, "marvell_phy_init()\n");
842 reg = asix_mdio_read(dev->net, dev->mii.phy_id, MII_MARVELL_STATUS);
843 netdev_dbg(dev->net, "MII_MARVELL_STATUS = 0x%04x\n", reg);
845 asix_mdio_write(dev->net, dev->mii.phy_id, MII_MARVELL_CTRL,
846 MARVELL_CTRL_RXDELAY | MARVELL_CTRL_TXDELAY);
849 reg = asix_mdio_read(dev->net, dev->mii.phy_id,
850 MII_MARVELL_LED_CTRL);
851 netdev_dbg(dev->net, "MII_MARVELL_LED_CTRL (1) = 0x%04x\n", reg);
855 asix_mdio_write(dev->net, dev->mii.phy_id,
856 MII_MARVELL_LED_CTRL, reg);
858 reg = asix_mdio_read(dev->net, dev->mii.phy_id,
859 MII_MARVELL_LED_CTRL);
860 netdev_dbg(dev->net, "MII_MARVELL_LED_CTRL (2) = 0x%04x\n", reg);
867 static int rtl8211cl_phy_init(struct usbnet *dev)
869 struct asix_data *data = (struct asix_data *)&dev->data;
871 netdev_dbg(dev->net, "rtl8211cl_phy_init()\n");
873 asix_mdio_write (dev->net, dev->mii.phy_id, 0x1f, 0x0005);
874 asix_mdio_write (dev->net, dev->mii.phy_id, 0x0c, 0);
875 asix_mdio_write (dev->net, dev->mii.phy_id, 0x01,
876 asix_mdio_read (dev->net, dev->mii.phy_id, 0x01) | 0x0080);
877 asix_mdio_write (dev->net, dev->mii.phy_id, 0x1f, 0);
879 if (data->ledmode == 12) {
880 asix_mdio_write (dev->net, dev->mii.phy_id, 0x1f, 0x0002);
881 asix_mdio_write (dev->net, dev->mii.phy_id, 0x1a, 0x00cb);
882 asix_mdio_write (dev->net, dev->mii.phy_id, 0x1f, 0);
888 static int marvell_led_status(struct usbnet *dev, u16 speed)
890 u16 reg = asix_mdio_read(dev->net, dev->mii.phy_id, MARVELL_LED_MANUAL);
892 netdev_dbg(dev->net, "marvell_led_status() read 0x%04x\n", reg);
894 /* Clear out the center LED bits - 0x03F0 */
908 netdev_dbg(dev->net, "marvell_led_status() writing 0x%04x\n", reg);
909 asix_mdio_write(dev->net, dev->mii.phy_id, MARVELL_LED_MANUAL, reg);
914 static int ax88178_reset(struct usbnet *dev)
916 struct asix_data *data = (struct asix_data *)&dev->data;
923 asix_read_cmd(dev, AX_CMD_READ_GPIOS, 0, 0, 1, &status, 0);
924 netdev_dbg(dev->net, "GPIO Status: 0x%04x\n", status);
926 asix_write_cmd(dev, AX_CMD_WRITE_ENABLE, 0, 0, 0, NULL, 0);
927 asix_read_cmd(dev, AX_CMD_READ_EEPROM, 0x0017, 0, 2, &eeprom, 0);
928 asix_write_cmd(dev, AX_CMD_WRITE_DISABLE, 0, 0, 0, NULL, 0);
930 netdev_dbg(dev->net, "EEPROM index 0x17 is 0x%04x\n", eeprom);
932 if (eeprom == cpu_to_le16(0xffff)) {
933 data->phymode = PHY_MODE_MARVELL;
937 data->phymode = le16_to_cpu(eeprom) & 0x7F;
938 data->ledmode = le16_to_cpu(eeprom) >> 8;
939 gpio0 = (le16_to_cpu(eeprom) & 0x80) ? 0 : 1;
941 netdev_dbg(dev->net, "GPIO0: %d, PhyMode: %d\n", gpio0, data->phymode);
943 /* Power up external GigaPHY through AX88178 GPIO pin */
944 asix_write_gpio(dev, AX_GPIO_RSE | AX_GPIO_GPO_1 |
945 AX_GPIO_GPO1EN, 40, 0);
946 if ((le16_to_cpu(eeprom) >> 8) != 1) {
947 asix_write_gpio(dev, 0x003c, 30, 0);
948 asix_write_gpio(dev, 0x001c, 300, 0);
949 asix_write_gpio(dev, 0x003c, 30, 0);
951 netdev_dbg(dev->net, "gpio phymode == 1 path\n");
952 asix_write_gpio(dev, AX_GPIO_GPO1EN, 30, 0);
953 asix_write_gpio(dev, AX_GPIO_GPO1EN | AX_GPIO_GPO_1, 30, 0);
956 /* Read PHYID register *AFTER* powering up PHY */
957 phyid = asix_get_phyid(dev);
958 netdev_dbg(dev->net, "PHYID=0x%08x\n", phyid);
960 /* Set AX88178 to enable MII/GMII/RGMII interface for external PHY */
961 asix_write_cmd(dev, AX_CMD_SW_PHY_SELECT, 0, 0, 0, NULL, 0);
963 asix_sw_reset(dev, 0, 0);
966 asix_sw_reset(dev, AX_SWRESET_PRL | AX_SWRESET_IPPD, 0);
969 asix_write_rx_ctl(dev, 0, 0);
971 if (data->phymode == PHY_MODE_MARVELL) {
972 marvell_phy_init(dev);
974 } else if (data->phymode == PHY_MODE_RTL8211CL)
975 rtl8211cl_phy_init(dev);
977 asix_phy_reset(dev, BMCR_RESET | BMCR_ANENABLE);
978 asix_mdio_write(dev->net, dev->mii.phy_id, MII_ADVERTISE,
979 ADVERTISE_ALL | ADVERTISE_CSMA | ADVERTISE_PAUSE_CAP);
980 asix_mdio_write(dev->net, dev->mii.phy_id, MII_CTRL1000,
983 asix_write_medium_mode(dev, AX88178_MEDIUM_DEFAULT, 0);
984 mii_nway_restart(&dev->mii);
986 /* Rewrite MAC address */
987 memcpy(data->mac_addr, dev->net->dev_addr, ETH_ALEN);
988 ret = asix_write_cmd(dev, AX_CMD_WRITE_NODE_ID, 0, 0, ETH_ALEN,
993 ret = asix_write_rx_ctl(dev, AX_DEFAULT_RX_CTL, 0);
1000 static int ax88178_link_reset(struct usbnet *dev)
1003 struct ethtool_cmd ecmd = { .cmd = ETHTOOL_GSET };
1004 struct asix_data *data = (struct asix_data *)&dev->data;
1007 netdev_dbg(dev->net, "ax88178_link_reset()\n");
1009 mii_check_media(&dev->mii, 1, 1);
1010 mii_ethtool_gset(&dev->mii, &ecmd);
1011 mode = AX88178_MEDIUM_DEFAULT;
1012 speed = ethtool_cmd_speed(&ecmd);
1014 if (speed == SPEED_1000)
1015 mode |= AX_MEDIUM_GM;
1016 else if (speed == SPEED_100)
1017 mode |= AX_MEDIUM_PS;
1019 mode &= ~(AX_MEDIUM_PS | AX_MEDIUM_GM);
1021 mode |= AX_MEDIUM_ENCK;
1023 if (ecmd.duplex == DUPLEX_FULL)
1024 mode |= AX_MEDIUM_FD;
1026 mode &= ~AX_MEDIUM_FD;
1028 netdev_dbg(dev->net, "ax88178_link_reset() speed: %u duplex: %d setting mode to 0x%04x\n",
1029 speed, ecmd.duplex, mode);
1031 asix_write_medium_mode(dev, mode, 0);
1033 if (data->phymode == PHY_MODE_MARVELL && data->ledmode)
1034 marvell_led_status(dev, speed);
1039 static void ax88178_set_mfb(struct usbnet *dev)
1041 u16 mfb = AX_RX_CTL_MFB_16384;
1044 int old_rx_urb_size = dev->rx_urb_size;
1046 if (dev->hard_mtu < 2048) {
1047 dev->rx_urb_size = 2048;
1048 mfb = AX_RX_CTL_MFB_2048;
1049 } else if (dev->hard_mtu < 4096) {
1050 dev->rx_urb_size = 4096;
1051 mfb = AX_RX_CTL_MFB_4096;
1052 } else if (dev->hard_mtu < 8192) {
1053 dev->rx_urb_size = 8192;
1054 mfb = AX_RX_CTL_MFB_8192;
1055 } else if (dev->hard_mtu < 16384) {
1056 dev->rx_urb_size = 16384;
1057 mfb = AX_RX_CTL_MFB_16384;
1060 rxctl = asix_read_rx_ctl(dev, 0);
1061 asix_write_rx_ctl(dev, (rxctl & ~AX_RX_CTL_MFB_16384) | mfb, 0);
1063 medium = asix_read_medium_status(dev, 0);
1064 if (dev->net->mtu > 1500)
1065 medium |= AX_MEDIUM_JFE;
1067 medium &= ~AX_MEDIUM_JFE;
1068 asix_write_medium_mode(dev, medium, 0);
1070 if (dev->rx_urb_size > old_rx_urb_size)
1071 usbnet_unlink_rx_urbs(dev);
1074 static int ax88178_change_mtu(struct net_device *net, int new_mtu)
1076 struct usbnet *dev = netdev_priv(net);
1077 int ll_mtu = new_mtu + net->hard_header_len + 4;
1079 netdev_dbg(dev->net, "ax88178_change_mtu() new_mtu=%d\n", new_mtu);
1081 if ((ll_mtu % dev->maxpacket) == 0)
1085 dev->hard_mtu = net->mtu + net->hard_header_len;
1086 ax88178_set_mfb(dev);
1088 /* max qlen depend on hard_mtu and rx_urb_size */
1089 usbnet_update_max_qlen(dev);
1094 static const struct net_device_ops ax88178_netdev_ops = {
1095 .ndo_open = usbnet_open,
1096 .ndo_stop = usbnet_stop,
1097 .ndo_start_xmit = usbnet_start_xmit,
1098 .ndo_tx_timeout = usbnet_tx_timeout,
1099 .ndo_get_stats64 = dev_get_tstats64,
1100 .ndo_set_mac_address = asix_set_mac_address,
1101 .ndo_validate_addr = eth_validate_addr,
1102 .ndo_set_rx_mode = asix_set_multicast,
1103 .ndo_eth_ioctl = asix_ioctl,
1104 .ndo_change_mtu = ax88178_change_mtu,
1107 static int ax88178_bind(struct usbnet *dev, struct usb_interface *intf)
1110 u8 buf[ETH_ALEN] = {0};
1112 usbnet_get_endpoints(dev,intf);
1114 /* Get the MAC address */
1115 ret = asix_read_cmd(dev, AX_CMD_READ_NODE_ID, 0, 0, ETH_ALEN, buf, 0);
1117 netdev_dbg(dev->net, "Failed to read MAC address: %d\n", ret);
1121 asix_set_netdev_dev_addr(dev, buf);
1123 /* Initialize MII structure */
1124 dev->mii.dev = dev->net;
1125 dev->mii.mdio_read = asix_mdio_read;
1126 dev->mii.mdio_write = asix_mdio_write;
1127 dev->mii.phy_id_mask = 0x1f;
1128 dev->mii.reg_num_mask = 0xff;
1129 dev->mii.supports_gmii = 1;
1131 dev->mii.phy_id = asix_read_phy_addr(dev, true);
1132 if (dev->mii.phy_id < 0)
1133 return dev->mii.phy_id;
1135 dev->net->netdev_ops = &ax88178_netdev_ops;
1136 dev->net->ethtool_ops = &ax88178_ethtool_ops;
1137 dev->net->max_mtu = 16384 - (dev->net->hard_header_len + 4);
1139 /* Blink LEDS so users know driver saw dongle */
1140 asix_sw_reset(dev, 0, 0);
1143 asix_sw_reset(dev, AX_SWRESET_PRL | AX_SWRESET_IPPD, 0);
1146 /* Asix framing packs multiple eth frames into a 2K usb bulk transfer */
1147 if (dev->driver_info->flags & FLAG_FRAMING_AX) {
1148 /* hard_mtu is still the default - the device does not support
1150 dev->rx_urb_size = 2048;
1153 dev->driver_priv = kzalloc(sizeof(struct asix_common_private), GFP_KERNEL);
1154 if (!dev->driver_priv)
1160 static const struct driver_info ax8817x_info = {
1161 .description = "ASIX AX8817x USB 2.0 Ethernet",
1162 .bind = ax88172_bind,
1163 .status = asix_status,
1164 .link_reset = ax88172_link_reset,
1165 .reset = ax88172_link_reset,
1166 .flags = FLAG_ETHER | FLAG_LINK_INTR,
1170 static const struct driver_info dlink_dub_e100_info = {
1171 .description = "DLink DUB-E100 USB Ethernet",
1172 .bind = ax88172_bind,
1173 .status = asix_status,
1174 .link_reset = ax88172_link_reset,
1175 .reset = ax88172_link_reset,
1176 .flags = FLAG_ETHER | FLAG_LINK_INTR,
1180 static const struct driver_info netgear_fa120_info = {
1181 .description = "Netgear FA-120 USB Ethernet",
1182 .bind = ax88172_bind,
1183 .status = asix_status,
1184 .link_reset = ax88172_link_reset,
1185 .reset = ax88172_link_reset,
1186 .flags = FLAG_ETHER | FLAG_LINK_INTR,
1190 static const struct driver_info hawking_uf200_info = {
1191 .description = "Hawking UF200 USB Ethernet",
1192 .bind = ax88172_bind,
1193 .status = asix_status,
1194 .link_reset = ax88172_link_reset,
1195 .reset = ax88172_link_reset,
1196 .flags = FLAG_ETHER | FLAG_LINK_INTR,
1200 static const struct driver_info ax88772_info = {
1201 .description = "ASIX AX88772 USB 2.0 Ethernet",
1202 .bind = ax88772_bind,
1203 .unbind = ax88772_unbind,
1204 .status = asix_status,
1205 .reset = ax88772_reset,
1206 .stop = ax88772_stop,
1207 .flags = FLAG_ETHER | FLAG_FRAMING_AX | FLAG_LINK_INTR | FLAG_MULTI_PACKET,
1208 .rx_fixup = asix_rx_fixup_common,
1209 .tx_fixup = asix_tx_fixup,
1212 static const struct driver_info ax88772b_info = {
1213 .description = "ASIX AX88772B USB 2.0 Ethernet",
1214 .bind = ax88772_bind,
1215 .unbind = ax88772_unbind,
1216 .status = asix_status,
1217 .reset = ax88772_reset,
1218 .stop = ax88772_stop,
1219 .flags = FLAG_ETHER | FLAG_FRAMING_AX | FLAG_LINK_INTR |
1221 .rx_fixup = asix_rx_fixup_common,
1222 .tx_fixup = asix_tx_fixup,
1223 .data = FLAG_EEPROM_MAC,
1226 static const struct driver_info ax88178_info = {
1227 .description = "ASIX AX88178 USB 2.0 Ethernet",
1228 .bind = ax88178_bind,
1229 .unbind = ax88178_unbind,
1230 .status = asix_status,
1231 .link_reset = ax88178_link_reset,
1232 .reset = ax88178_reset,
1233 .flags = FLAG_ETHER | FLAG_FRAMING_AX | FLAG_LINK_INTR |
1235 .rx_fixup = asix_rx_fixup_common,
1236 .tx_fixup = asix_tx_fixup,
1240 * USBLINK 20F9 "USB 2.0 LAN" USB ethernet adapter, typically found in
1241 * no-name packaging.
1242 * USB device strings are:
1243 * 1: Manufacturer: USBLINK
1244 * 2: Product: HG20F9 USB2.0
1246 * Appears to be compatible with Asix 88772B.
1248 static const struct driver_info hg20f9_info = {
1249 .description = "HG20F9 USB 2.0 Ethernet",
1250 .bind = ax88772_bind,
1251 .unbind = ax88772_unbind,
1252 .status = asix_status,
1253 .reset = ax88772_reset,
1254 .flags = FLAG_ETHER | FLAG_FRAMING_AX | FLAG_LINK_INTR |
1256 .rx_fixup = asix_rx_fixup_common,
1257 .tx_fixup = asix_tx_fixup,
1258 .data = FLAG_EEPROM_MAC,
1261 static const struct usb_device_id products [] = {
1264 USB_DEVICE (0x077b, 0x2226),
1265 .driver_info = (unsigned long) &ax8817x_info,
1268 USB_DEVICE (0x0846, 0x1040),
1269 .driver_info = (unsigned long) &netgear_fa120_info,
1272 USB_DEVICE (0x2001, 0x1a00),
1273 .driver_info = (unsigned long) &dlink_dub_e100_info,
1275 // Intellinet, ST Lab USB Ethernet
1276 USB_DEVICE (0x0b95, 0x1720),
1277 .driver_info = (unsigned long) &ax8817x_info,
1279 // Hawking UF200, TrendNet TU2-ET100
1280 USB_DEVICE (0x07b8, 0x420a),
1281 .driver_info = (unsigned long) &hawking_uf200_info,
1283 // Billionton Systems, USB2AR
1284 USB_DEVICE (0x08dd, 0x90ff),
1285 .driver_info = (unsigned long) &ax8817x_info,
1287 // Billionton Systems, GUSB2AM-1G-B
1288 USB_DEVICE(0x08dd, 0x0114),
1289 .driver_info = (unsigned long) &ax88178_info,
1292 USB_DEVICE (0x0557, 0x2009),
1293 .driver_info = (unsigned long) &ax8817x_info,
1295 // Buffalo LUA-U2-KTX
1296 USB_DEVICE (0x0411, 0x003d),
1297 .driver_info = (unsigned long) &ax8817x_info,
1299 // Buffalo LUA-U2-GT 10/100/1000
1300 USB_DEVICE (0x0411, 0x006e),
1301 .driver_info = (unsigned long) &ax88178_info,
1303 // Sitecom LN-029 "USB 2.0 10/100 Ethernet adapter"
1304 USB_DEVICE (0x6189, 0x182d),
1305 .driver_info = (unsigned long) &ax8817x_info,
1307 // Sitecom LN-031 "USB 2.0 10/100/1000 Ethernet adapter"
1308 USB_DEVICE (0x0df6, 0x0056),
1309 .driver_info = (unsigned long) &ax88178_info,
1311 // Sitecom LN-028 "USB 2.0 10/100/1000 Ethernet adapter"
1312 USB_DEVICE (0x0df6, 0x061c),
1313 .driver_info = (unsigned long) &ax88178_info,
1315 // corega FEther USB2-TX
1316 USB_DEVICE (0x07aa, 0x0017),
1317 .driver_info = (unsigned long) &ax8817x_info,
1319 // Surecom EP-1427X-2
1320 USB_DEVICE (0x1189, 0x0893),
1321 .driver_info = (unsigned long) &ax8817x_info,
1323 // goodway corp usb gwusb2e
1324 USB_DEVICE (0x1631, 0x6200),
1325 .driver_info = (unsigned long) &ax8817x_info,
1327 // JVC MP-PRX1 Port Replicator
1328 USB_DEVICE (0x04f1, 0x3008),
1329 .driver_info = (unsigned long) &ax8817x_info,
1331 // Lenovo U2L100P 10/100
1332 USB_DEVICE (0x17ef, 0x7203),
1333 .driver_info = (unsigned long)&ax88772b_info,
1335 // ASIX AX88772B 10/100
1336 USB_DEVICE (0x0b95, 0x772b),
1337 .driver_info = (unsigned long) &ax88772b_info,
1339 // ASIX AX88772 10/100
1340 USB_DEVICE (0x0b95, 0x7720),
1341 .driver_info = (unsigned long) &ax88772_info,
1343 // ASIX AX88178 10/100/1000
1344 USB_DEVICE (0x0b95, 0x1780),
1345 .driver_info = (unsigned long) &ax88178_info,
1347 // Logitec LAN-GTJ/U2A
1348 USB_DEVICE (0x0789, 0x0160),
1349 .driver_info = (unsigned long) &ax88178_info,
1351 // Linksys USB200M Rev 2
1352 USB_DEVICE (0x13b1, 0x0018),
1353 .driver_info = (unsigned long) &ax88772_info,
1355 // 0Q0 cable ethernet
1356 USB_DEVICE (0x1557, 0x7720),
1357 .driver_info = (unsigned long) &ax88772_info,
1359 // DLink DUB-E100 H/W Ver B1
1360 USB_DEVICE (0x07d1, 0x3c05),
1361 .driver_info = (unsigned long) &ax88772_info,
1363 // DLink DUB-E100 H/W Ver B1 Alternate
1364 USB_DEVICE (0x2001, 0x3c05),
1365 .driver_info = (unsigned long) &ax88772_info,
1367 // DLink DUB-E100 H/W Ver C1
1368 USB_DEVICE (0x2001, 0x1a02),
1369 .driver_info = (unsigned long) &ax88772_info,
1372 USB_DEVICE (0x1737, 0x0039),
1373 .driver_info = (unsigned long) &ax88178_info,
1376 USB_DEVICE (0x04bb, 0x0930),
1377 .driver_info = (unsigned long) &ax88178_info,
1380 USB_DEVICE(0x050d, 0x5055),
1381 .driver_info = (unsigned long) &ax88178_info,
1383 // Apple USB Ethernet Adapter
1384 USB_DEVICE(0x05ac, 0x1402),
1385 .driver_info = (unsigned long) &ax88772_info,
1387 // Cables-to-Go USB Ethernet Adapter
1388 USB_DEVICE(0x0b95, 0x772a),
1389 .driver_info = (unsigned long) &ax88772_info,
1392 USB_DEVICE(0x14ea, 0xab11),
1393 .driver_info = (unsigned long) &ax88178_info,
1396 USB_DEVICE(0x0db0, 0xa877),
1397 .driver_info = (unsigned long) &ax88772_info,
1399 // Asus USB Ethernet Adapter
1400 USB_DEVICE (0x0b95, 0x7e2b),
1401 .driver_info = (unsigned long)&ax88772b_info,
1403 /* ASIX 88172a demo board */
1404 USB_DEVICE(0x0b95, 0x172a),
1405 .driver_info = (unsigned long) &ax88172a_info,
1408 * USBLINK HG20F9 "USB 2.0 LAN"
1409 * Appears to have gazumped Linksys's manufacturer ID but
1410 * doesn't (yet) conflict with any known Linksys product.
1412 USB_DEVICE(0x066b, 0x20f9),
1413 .driver_info = (unsigned long) &hg20f9_info,
1417 MODULE_DEVICE_TABLE(usb, products);
1419 static struct usb_driver asix_driver = {
1420 .name = DRIVER_NAME,
1421 .id_table = products,
1422 .probe = usbnet_probe,
1423 .suspend = asix_suspend,
1424 .resume = asix_resume,
1425 .reset_resume = asix_resume,
1426 .disconnect = usbnet_disconnect,
1427 .supports_autosuspend = 1,
1428 .disable_hub_initiated_lpm = 1,
1431 module_usb_driver(asix_driver);
1433 MODULE_AUTHOR("David Hollis");
1434 MODULE_VERSION(DRIVER_VERSION);
1435 MODULE_DESCRIPTION("ASIX AX8817X based USB 2.0 Ethernet Devices");
1436 MODULE_LICENSE("GPL");