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 int asix_read_cmd(struct usbnet *dev, u8 cmd, u16 value, u16 index,
13 u16 size, void *data, int in_pm)
16 int (*fn)(struct usbnet *, u8, u8, u16, u16, void *, u16);
23 fn = usbnet_read_cmd_nopm;
25 ret = fn(dev, cmd, USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
26 value, index, data, size);
28 if (unlikely(ret < 0))
29 netdev_warn(dev->net, "Failed to read reg index 0x%04x: %d\n",
35 int asix_write_cmd(struct usbnet *dev, u8 cmd, u16 value, u16 index,
36 u16 size, void *data, int in_pm)
39 int (*fn)(struct usbnet *, u8, u8, u16, u16, const void *, u16);
44 fn = usbnet_write_cmd;
46 fn = usbnet_write_cmd_nopm;
48 ret = fn(dev, cmd, USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
49 value, index, data, size);
51 if (unlikely(ret < 0))
52 netdev_warn(dev->net, "Failed to write reg index 0x%04x: %d\n",
58 void asix_write_cmd_async(struct usbnet *dev, u8 cmd, u16 value, u16 index,
61 usbnet_write_cmd_async(dev, cmd,
62 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
63 value, index, data, size);
66 static void reset_asix_rx_fixup_info(struct asix_rx_fixup_info *rx)
68 /* Reset the variables that have a lifetime outside of
69 * asix_rx_fixup_internal() so that future processing starts from a
70 * known set of initial conditions.
74 /* Discard any incomplete Ethernet frame in the netdev buffer */
75 kfree_skb(rx->ax_skb);
79 /* Assume the Data header 32-bit word is at the start of the current
80 * or next URB socket buffer so reset all the state variables.
83 rx->split_head = false;
87 int asix_rx_fixup_internal(struct usbnet *dev, struct sk_buff *skb,
88 struct asix_rx_fixup_info *rx)
93 /* When an Ethernet frame spans multiple URB socket buffers,
94 * do a sanity test for the Data header synchronisation.
95 * Attempt to detect the situation of the previous socket buffer having
96 * been truncated or a socket buffer was missing. These situations
97 * cause a discontinuity in the data stream and therefore need to avoid
98 * appending bad data to the end of the current netdev socket buffer.
99 * Also avoid unnecessarily discarding a good current netdev socket
102 if (rx->remaining && (rx->remaining + sizeof(u32) <= skb->len)) {
103 offset = ((rx->remaining + 1) & 0xfffe);
104 rx->header = get_unaligned_le32(skb->data + offset);
107 size = (u16)(rx->header & 0x7ff);
108 if (size != ((~rx->header >> 16) & 0x7ff)) {
109 netdev_err(dev->net, "asix_rx_fixup() Data Header synchronisation was lost, remaining %d\n",
111 reset_asix_rx_fixup_info(rx);
115 while (offset + sizeof(u16) <= skb->len) {
118 if (!rx->remaining) {
119 if (skb->len - offset == sizeof(u16)) {
120 rx->header = get_unaligned_le16(
122 rx->split_head = true;
123 offset += sizeof(u16);
127 if (rx->split_head == true) {
128 rx->header |= (get_unaligned_le16(
129 skb->data + offset) << 16);
130 rx->split_head = false;
131 offset += sizeof(u16);
133 rx->header = get_unaligned_le32(skb->data +
135 offset += sizeof(u32);
138 /* take frame length from Data header 32-bit word */
139 size = (u16)(rx->header & 0x7ff);
140 if (size != ((~rx->header >> 16) & 0x7ff)) {
141 netdev_err(dev->net, "asix_rx_fixup() Bad Header Length 0x%x, offset %d\n",
143 reset_asix_rx_fixup_info(rx);
146 if (size > dev->net->mtu + ETH_HLEN + VLAN_HLEN) {
147 netdev_dbg(dev->net, "asix_rx_fixup() Bad RX Length %d\n",
149 reset_asix_rx_fixup_info(rx);
153 /* Sometimes may fail to get a netdev socket buffer but
154 * continue to process the URB socket buffer so that
155 * synchronisation of the Ethernet frame Data header
156 * word is maintained.
158 rx->ax_skb = netdev_alloc_skb_ip_align(dev->net, size);
160 rx->remaining = size;
163 if (rx->remaining > skb->len - offset) {
164 copy_length = skb->len - offset;
165 rx->remaining -= copy_length;
167 copy_length = rx->remaining;
172 skb_put_data(rx->ax_skb, skb->data + offset,
174 if (!rx->remaining) {
175 usbnet_skb_return(dev, rx->ax_skb);
180 offset += (copy_length + 1) & 0xfffe;
183 if (skb->len != offset) {
184 netdev_err(dev->net, "asix_rx_fixup() Bad SKB Length %d, %d\n",
186 reset_asix_rx_fixup_info(rx);
193 int asix_rx_fixup_common(struct usbnet *dev, struct sk_buff *skb)
195 struct asix_common_private *dp = dev->driver_priv;
196 struct asix_rx_fixup_info *rx = &dp->rx_fixup_info;
198 return asix_rx_fixup_internal(dev, skb, rx);
201 void asix_rx_fixup_common_free(struct asix_common_private *dp)
203 struct asix_rx_fixup_info *rx;
208 rx = &dp->rx_fixup_info;
211 kfree_skb(rx->ax_skb);
216 struct sk_buff *asix_tx_fixup(struct usbnet *dev, struct sk_buff *skb,
220 int headroom = skb_headroom(skb);
221 int tailroom = skb_tailroom(skb);
223 u32 padbytes = 0xffff0000;
226 padlen = ((skb->len + 4) & (dev->maxpacket - 1)) ? 0 : 4;
228 /* We need to push 4 bytes in front of frame (packet_len)
229 * and maybe add 4 bytes after the end (if padlen is 4)
231 * Avoid skb_copy_expand() expensive call, using following rules :
232 * - We are allowed to push 4 bytes in headroom if skb_header_cloned()
233 * is false (and if we have 4 bytes of headroom)
234 * - We are allowed to put 4 bytes at tail if skb_cloned()
235 * is false (and if we have 4 bytes of tailroom)
237 * TCP packets for example are cloned, but __skb_header_release()
238 * was called in tcp stack, allowing us to use headroom for our needs.
240 if (!skb_header_cloned(skb) &&
241 !(padlen && skb_cloned(skb)) &&
242 headroom + tailroom >= 4 + padlen) {
243 /* following should not happen, but better be safe */
246 skb->data = memmove(skb->head + 4, skb->data, skb->len);
247 skb_set_tail_pointer(skb, skb->len);
250 struct sk_buff *skb2;
252 skb2 = skb_copy_expand(skb, 4, padlen, flags);
253 dev_kfree_skb_any(skb);
259 packet_len = ((skb->len ^ 0x0000ffff) << 16) + skb->len;
260 ptr = skb_push(skb, 4);
261 put_unaligned_le32(packet_len, ptr);
264 put_unaligned_le32(padbytes, skb_tail_pointer(skb));
265 skb_put(skb, sizeof(padbytes));
268 usbnet_set_skb_tx_stats(skb, 1, 0);
272 int asix_set_sw_mii(struct usbnet *dev, int in_pm)
275 ret = asix_write_cmd(dev, AX_CMD_SET_SW_MII, 0x0000, 0, 0, NULL, in_pm);
278 netdev_err(dev->net, "Failed to enable software MII access\n");
282 int asix_set_hw_mii(struct usbnet *dev, int in_pm)
285 ret = asix_write_cmd(dev, AX_CMD_SET_HW_MII, 0x0000, 0, 0, NULL, in_pm);
287 netdev_err(dev->net, "Failed to enable hardware MII access\n");
291 int asix_read_phy_addr(struct usbnet *dev, int internal)
293 int offset = (internal ? 1 : 0);
295 int ret = asix_read_cmd(dev, AX_CMD_READ_PHY_ID, 0, 0, 2, buf, 0);
297 netdev_dbg(dev->net, "asix_get_phy_addr()\n");
300 netdev_err(dev->net, "Error reading PHYID register: %02x\n", ret);
303 netdev_dbg(dev->net, "asix_get_phy_addr() returning 0x%04x\n",
311 int asix_get_phy_addr(struct usbnet *dev)
313 /* return the address of the internal phy */
314 return asix_read_phy_addr(dev, 1);
318 int asix_sw_reset(struct usbnet *dev, u8 flags, int in_pm)
322 ret = asix_write_cmd(dev, AX_CMD_SW_RESET, flags, 0, 0, NULL, in_pm);
324 netdev_err(dev->net, "Failed to send software reset: %02x\n", ret);
329 u16 asix_read_rx_ctl(struct usbnet *dev, int in_pm)
332 int ret = asix_read_cmd(dev, AX_CMD_READ_RX_CTL, 0, 0, 2, &v, in_pm);
335 netdev_err(dev->net, "Error reading RX_CTL register: %02x\n", ret);
338 ret = le16_to_cpu(v);
343 int asix_write_rx_ctl(struct usbnet *dev, u16 mode, int in_pm)
347 netdev_dbg(dev->net, "asix_write_rx_ctl() - mode = 0x%04x\n", mode);
348 ret = asix_write_cmd(dev, AX_CMD_WRITE_RX_CTL, mode, 0, 0, NULL, in_pm);
350 netdev_err(dev->net, "Failed to write RX_CTL mode to 0x%04x: %02x\n",
356 u16 asix_read_medium_status(struct usbnet *dev, int in_pm)
359 int ret = asix_read_cmd(dev, AX_CMD_READ_MEDIUM_STATUS,
363 netdev_err(dev->net, "Error reading Medium Status register: %02x\n",
365 return ret; /* TODO: callers not checking for error ret */
368 return le16_to_cpu(v);
372 int asix_write_medium_mode(struct usbnet *dev, u16 mode, int in_pm)
376 netdev_dbg(dev->net, "asix_write_medium_mode() - mode = 0x%04x\n", mode);
377 ret = asix_write_cmd(dev, AX_CMD_WRITE_MEDIUM_MODE,
378 mode, 0, 0, NULL, in_pm);
380 netdev_err(dev->net, "Failed to write Medium Mode mode to 0x%04x: %02x\n",
386 int asix_write_gpio(struct usbnet *dev, u16 value, int sleep, int in_pm)
390 netdev_dbg(dev->net, "asix_write_gpio() - value = 0x%04x\n", value);
391 ret = asix_write_cmd(dev, AX_CMD_WRITE_GPIOS, value, 0, 0, NULL, in_pm);
393 netdev_err(dev->net, "Failed to write GPIO value 0x%04x: %02x\n",
403 * AX88772 & AX88178 have a 16-bit RX_CTL value
405 void asix_set_multicast(struct net_device *net)
407 struct usbnet *dev = netdev_priv(net);
408 struct asix_data *data = (struct asix_data *)&dev->data;
409 u16 rx_ctl = AX_DEFAULT_RX_CTL;
411 if (net->flags & IFF_PROMISC) {
412 rx_ctl |= AX_RX_CTL_PRO;
413 } else if (net->flags & IFF_ALLMULTI ||
414 netdev_mc_count(net) > AX_MAX_MCAST) {
415 rx_ctl |= AX_RX_CTL_AMALL;
416 } else if (netdev_mc_empty(net)) {
417 /* just broadcast and directed */
419 /* We use the 20 byte dev->data
420 * for our 8 byte filter buffer
421 * to avoid allocating memory that
422 * is tricky to free later */
423 struct netdev_hw_addr *ha;
426 memset(data->multi_filter, 0, AX_MCAST_FILTER_SIZE);
428 /* Build the multicast hash filter. */
429 netdev_for_each_mc_addr(ha, net) {
430 crc_bits = ether_crc(ETH_ALEN, ha->addr) >> 26;
431 data->multi_filter[crc_bits >> 3] |=
435 asix_write_cmd_async(dev, AX_CMD_WRITE_MULTI_FILTER, 0, 0,
436 AX_MCAST_FILTER_SIZE, data->multi_filter);
438 rx_ctl |= AX_RX_CTL_AM;
441 asix_write_cmd_async(dev, AX_CMD_WRITE_RX_CTL, rx_ctl, 0, 0, NULL);
444 int asix_mdio_read(struct net_device *netdev, int phy_id, int loc)
446 struct usbnet *dev = netdev_priv(netdev);
452 mutex_lock(&dev->phy_mutex);
454 ret = asix_set_sw_mii(dev, 0);
455 if (ret == -ENODEV || ret == -ETIMEDOUT)
457 usleep_range(1000, 1100);
458 ret = asix_read_cmd(dev, AX_CMD_STATMNGSTS_REG,
460 } while (!(smsr & AX_HOST_EN) && (i++ < 30) && (ret != -ENODEV));
461 if (ret == -ENODEV || ret == -ETIMEDOUT) {
462 mutex_unlock(&dev->phy_mutex);
466 asix_read_cmd(dev, AX_CMD_READ_MII_REG, phy_id,
467 (__u16)loc, 2, &res, 0);
468 asix_set_hw_mii(dev, 0);
469 mutex_unlock(&dev->phy_mutex);
471 netdev_dbg(dev->net, "asix_mdio_read() phy_id=0x%02x, loc=0x%02x, returns=0x%04x\n",
472 phy_id, loc, le16_to_cpu(res));
474 return le16_to_cpu(res);
477 void asix_mdio_write(struct net_device *netdev, int phy_id, int loc, int val)
479 struct usbnet *dev = netdev_priv(netdev);
480 __le16 res = cpu_to_le16(val);
485 netdev_dbg(dev->net, "asix_mdio_write() phy_id=0x%02x, loc=0x%02x, val=0x%04x\n",
488 mutex_lock(&dev->phy_mutex);
490 ret = asix_set_sw_mii(dev, 0);
493 usleep_range(1000, 1100);
494 ret = asix_read_cmd(dev, AX_CMD_STATMNGSTS_REG,
496 } while (!(smsr & AX_HOST_EN) && (i++ < 30) && (ret != -ENODEV));
497 if (ret == -ENODEV) {
498 mutex_unlock(&dev->phy_mutex);
502 asix_write_cmd(dev, AX_CMD_WRITE_MII_REG, phy_id,
503 (__u16)loc, 2, &res, 0);
504 asix_set_hw_mii(dev, 0);
505 mutex_unlock(&dev->phy_mutex);
508 int asix_mdio_read_nopm(struct net_device *netdev, int phy_id, int loc)
510 struct usbnet *dev = netdev_priv(netdev);
516 mutex_lock(&dev->phy_mutex);
518 ret = asix_set_sw_mii(dev, 1);
519 if (ret == -ENODEV || ret == -ETIMEDOUT)
521 usleep_range(1000, 1100);
522 ret = asix_read_cmd(dev, AX_CMD_STATMNGSTS_REG,
524 } while (!(smsr & AX_HOST_EN) && (i++ < 30) && (ret != -ENODEV));
525 if (ret == -ENODEV || ret == -ETIMEDOUT) {
526 mutex_unlock(&dev->phy_mutex);
530 asix_read_cmd(dev, AX_CMD_READ_MII_REG, phy_id,
531 (__u16)loc, 2, &res, 1);
532 asix_set_hw_mii(dev, 1);
533 mutex_unlock(&dev->phy_mutex);
535 netdev_dbg(dev->net, "asix_mdio_read_nopm() phy_id=0x%02x, loc=0x%02x, returns=0x%04x\n",
536 phy_id, loc, le16_to_cpu(res));
538 return le16_to_cpu(res);
542 asix_mdio_write_nopm(struct net_device *netdev, int phy_id, int loc, int val)
544 struct usbnet *dev = netdev_priv(netdev);
545 __le16 res = cpu_to_le16(val);
550 netdev_dbg(dev->net, "asix_mdio_write() phy_id=0x%02x, loc=0x%02x, val=0x%04x\n",
553 mutex_lock(&dev->phy_mutex);
555 ret = asix_set_sw_mii(dev, 1);
558 usleep_range(1000, 1100);
559 ret = asix_read_cmd(dev, AX_CMD_STATMNGSTS_REG,
561 } while (!(smsr & AX_HOST_EN) && (i++ < 30) && (ret != -ENODEV));
562 if (ret == -ENODEV) {
563 mutex_unlock(&dev->phy_mutex);
567 asix_write_cmd(dev, AX_CMD_WRITE_MII_REG, phy_id,
568 (__u16)loc, 2, &res, 1);
569 asix_set_hw_mii(dev, 1);
570 mutex_unlock(&dev->phy_mutex);
573 void asix_get_wol(struct net_device *net, struct ethtool_wolinfo *wolinfo)
575 struct usbnet *dev = netdev_priv(net);
578 if (asix_read_cmd(dev, AX_CMD_READ_MONITOR_MODE,
579 0, 0, 1, &opt, 0) < 0) {
580 wolinfo->supported = 0;
581 wolinfo->wolopts = 0;
584 wolinfo->supported = WAKE_PHY | WAKE_MAGIC;
585 wolinfo->wolopts = 0;
586 if (opt & AX_MONITOR_LINK)
587 wolinfo->wolopts |= WAKE_PHY;
588 if (opt & AX_MONITOR_MAGIC)
589 wolinfo->wolopts |= WAKE_MAGIC;
592 int asix_set_wol(struct net_device *net, struct ethtool_wolinfo *wolinfo)
594 struct usbnet *dev = netdev_priv(net);
597 if (wolinfo->wolopts & ~(WAKE_PHY | WAKE_MAGIC))
600 if (wolinfo->wolopts & WAKE_PHY)
601 opt |= AX_MONITOR_LINK;
602 if (wolinfo->wolopts & WAKE_MAGIC)
603 opt |= AX_MONITOR_MAGIC;
605 if (asix_write_cmd(dev, AX_CMD_WRITE_MONITOR_MODE,
606 opt, 0, 0, NULL, 0) < 0)
612 int asix_get_eeprom_len(struct net_device *net)
614 return AX_EEPROM_LEN;
617 int asix_get_eeprom(struct net_device *net, struct ethtool_eeprom *eeprom,
620 struct usbnet *dev = netdev_priv(net);
622 int first_word, last_word;
625 if (eeprom->len == 0)
628 eeprom->magic = AX_EEPROM_MAGIC;
630 first_word = eeprom->offset >> 1;
631 last_word = (eeprom->offset + eeprom->len - 1) >> 1;
633 eeprom_buff = kmalloc_array(last_word - first_word + 1, sizeof(u16),
638 /* ax8817x returns 2 bytes from eeprom on read */
639 for (i = first_word; i <= last_word; i++) {
640 if (asix_read_cmd(dev, AX_CMD_READ_EEPROM, i, 0, 2,
641 &eeprom_buff[i - first_word], 0) < 0) {
647 memcpy(data, (u8 *)eeprom_buff + (eeprom->offset & 1), eeprom->len);
652 int asix_set_eeprom(struct net_device *net, struct ethtool_eeprom *eeprom,
655 struct usbnet *dev = netdev_priv(net);
657 int first_word, last_word;
661 netdev_dbg(net, "write EEPROM len %d, offset %d, magic 0x%x\n",
662 eeprom->len, eeprom->offset, eeprom->magic);
664 if (eeprom->len == 0)
667 if (eeprom->magic != AX_EEPROM_MAGIC)
670 first_word = eeprom->offset >> 1;
671 last_word = (eeprom->offset + eeprom->len - 1) >> 1;
673 eeprom_buff = kmalloc_array(last_word - first_word + 1, sizeof(u16),
678 /* align data to 16 bit boundaries, read the missing data from
680 if (eeprom->offset & 1) {
681 ret = asix_read_cmd(dev, AX_CMD_READ_EEPROM, first_word, 0, 2,
684 netdev_err(net, "Failed to read EEPROM at offset 0x%02x.\n", first_word);
689 if ((eeprom->offset + eeprom->len) & 1) {
690 ret = asix_read_cmd(dev, AX_CMD_READ_EEPROM, last_word, 0, 2,
691 &eeprom_buff[last_word - first_word], 0);
693 netdev_err(net, "Failed to read EEPROM at offset 0x%02x.\n", last_word);
698 memcpy((u8 *)eeprom_buff + (eeprom->offset & 1), data, eeprom->len);
700 /* write data to EEPROM */
701 ret = asix_write_cmd(dev, AX_CMD_WRITE_ENABLE, 0x0000, 0, 0, NULL, 0);
703 netdev_err(net, "Failed to enable EEPROM write\n");
708 for (i = first_word; i <= last_word; i++) {
709 netdev_dbg(net, "write to EEPROM at offset 0x%02x, data 0x%04x\n",
710 i, eeprom_buff[i - first_word]);
711 ret = asix_write_cmd(dev, AX_CMD_WRITE_EEPROM, i,
712 eeprom_buff[i - first_word], 0, NULL, 0);
714 netdev_err(net, "Failed to write EEPROM at offset 0x%02x.\n",
721 ret = asix_write_cmd(dev, AX_CMD_WRITE_DISABLE, 0x0000, 0, 0, NULL, 0);
723 netdev_err(net, "Failed to disable EEPROM write\n");
733 void asix_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *info)
735 /* Inherit standard device info */
736 usbnet_get_drvinfo(net, info);
737 strlcpy(info->driver, DRIVER_NAME, sizeof(info->driver));
738 strlcpy(info->version, DRIVER_VERSION, sizeof(info->version));
741 int asix_set_mac_address(struct net_device *net, void *p)
743 struct usbnet *dev = netdev_priv(net);
744 struct asix_data *data = (struct asix_data *)&dev->data;
745 struct sockaddr *addr = p;
747 if (netif_running(net))
749 if (!is_valid_ether_addr(addr->sa_data))
750 return -EADDRNOTAVAIL;
752 memcpy(net->dev_addr, addr->sa_data, ETH_ALEN);
754 /* We use the 20 byte dev->data
755 * for our 6 byte mac buffer
756 * to avoid allocating memory that
757 * is tricky to free later */
758 memcpy(data->mac_addr, addr->sa_data, ETH_ALEN);
759 asix_write_cmd_async(dev, AX_CMD_WRITE_NODE_ID, 0, 0, ETH_ALEN,