2 * ASIX AX8817X based USB 2.0 Ethernet Devices
3 * Copyright (C) 2003-2006 David Hollis <dhollis@davehollis.com>
4 * Copyright (C) 2005 Phil Chang <pchang23@sbcglobal.net>
5 * Copyright (C) 2006 James Painter <jamie.painter@iname.com>
6 * Copyright (c) 2002-2003 TiVo Inc.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, see <http://www.gnu.org/licenses/>.
24 int asix_read_cmd(struct usbnet *dev, u8 cmd, u16 value, u16 index,
25 u16 size, void *data, int in_pm)
28 int (*fn)(struct usbnet *, u8, u8, u16, u16, void *, u16);
35 fn = usbnet_read_cmd_nopm;
37 ret = fn(dev, cmd, USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
38 value, index, data, size);
40 if (unlikely(ret < 0))
41 netdev_warn(dev->net, "Failed to read reg index 0x%04x: %d\n",
47 int asix_write_cmd(struct usbnet *dev, u8 cmd, u16 value, u16 index,
48 u16 size, void *data, int in_pm)
51 int (*fn)(struct usbnet *, u8, u8, u16, u16, const void *, u16);
56 fn = usbnet_write_cmd;
58 fn = usbnet_write_cmd_nopm;
60 ret = fn(dev, cmd, USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
61 value, index, data, size);
63 if (unlikely(ret < 0))
64 netdev_warn(dev->net, "Failed to write reg index 0x%04x: %d\n",
70 void asix_write_cmd_async(struct usbnet *dev, u8 cmd, u16 value, u16 index,
73 usbnet_write_cmd_async(dev, cmd,
74 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
75 value, index, data, size);
78 int asix_rx_fixup_internal(struct usbnet *dev, struct sk_buff *skb,
79 struct asix_rx_fixup_info *rx)
84 /* When an Ethernet frame spans multiple URB socket buffers,
85 * do a sanity test for the Data header synchronisation.
86 * Attempt to detect the situation of the previous socket buffer having
87 * been truncated or a socket buffer was missing. These situations
88 * cause a discontinuity in the data stream and therefore need to avoid
89 * appending bad data to the end of the current netdev socket buffer.
90 * Also avoid unnecessarily discarding a good current netdev socket
93 if (rx->remaining && (rx->remaining + sizeof(u32) <= skb->len)) {
94 offset = ((rx->remaining + 1) & 0xfffe);
95 rx->header = get_unaligned_le32(skb->data + offset);
98 size = (u16)(rx->header & 0x7ff);
99 if (size != ((~rx->header >> 16) & 0x7ff)) {
100 netdev_err(dev->net, "asix_rx_fixup() Data Header synchronisation was lost, remaining %d\n",
103 kfree_skb(rx->ax_skb);
105 /* Discard the incomplete netdev Ethernet frame
106 * and assume the Data header is at the start of
107 * the current URB socket buffer.
114 while (offset + sizeof(u16) <= skb->len) {
117 if (!rx->remaining) {
118 if (skb->len - offset == sizeof(u16)) {
119 rx->header = get_unaligned_le16(
121 rx->split_head = true;
122 offset += sizeof(u16);
126 if (rx->split_head == true) {
127 rx->header |= (get_unaligned_le16(
128 skb->data + offset) << 16);
129 rx->split_head = false;
130 offset += sizeof(u16);
132 rx->header = get_unaligned_le32(skb->data +
134 offset += sizeof(u32);
137 /* take frame length from Data header 32-bit word */
138 size = (u16)(rx->header & 0x7ff);
139 if (size != ((~rx->header >> 16) & 0x7ff)) {
140 netdev_err(dev->net, "asix_rx_fixup() Bad Header Length 0x%x, offset %d\n",
144 if (size > dev->net->mtu + ETH_HLEN + VLAN_HLEN) {
145 netdev_dbg(dev->net, "asix_rx_fixup() Bad RX Length %d\n",
150 /* Sometimes may fail to get a netdev socket buffer but
151 * continue to process the URB socket buffer so that
152 * synchronisation of the Ethernet frame Data header
153 * word is maintained.
155 rx->ax_skb = netdev_alloc_skb_ip_align(dev->net, size);
157 rx->remaining = size;
160 if (rx->remaining > skb->len - offset) {
161 copy_length = skb->len - offset;
162 rx->remaining -= copy_length;
164 copy_length = rx->remaining;
169 skb_put_data(rx->ax_skb, skb->data + offset,
171 if (!rx->remaining) {
172 usbnet_skb_return(dev, rx->ax_skb);
177 offset += (copy_length + 1) & 0xfffe;
180 if (skb->len != offset) {
181 netdev_err(dev->net, "asix_rx_fixup() Bad SKB Length %d, %d\n",
189 int asix_rx_fixup_common(struct usbnet *dev, struct sk_buff *skb)
191 struct asix_common_private *dp = dev->driver_priv;
192 struct asix_rx_fixup_info *rx = &dp->rx_fixup_info;
194 return asix_rx_fixup_internal(dev, skb, rx);
197 struct sk_buff *asix_tx_fixup(struct usbnet *dev, struct sk_buff *skb,
201 int headroom = skb_headroom(skb);
202 int tailroom = skb_tailroom(skb);
204 u32 padbytes = 0xffff0000;
206 padlen = ((skb->len + 4) & (dev->maxpacket - 1)) ? 0 : 4;
208 /* We need to push 4 bytes in front of frame (packet_len)
209 * and maybe add 4 bytes after the end (if padlen is 4)
211 * Avoid skb_copy_expand() expensive call, using following rules :
212 * - We are allowed to push 4 bytes in headroom if skb_header_cloned()
213 * is false (and if we have 4 bytes of headroom)
214 * - We are allowed to put 4 bytes at tail if skb_cloned()
215 * is false (and if we have 4 bytes of tailroom)
217 * TCP packets for example are cloned, but skb_header_release()
218 * was called in tcp stack, allowing us to use headroom for our needs.
220 if (!skb_header_cloned(skb) &&
221 !(padlen && skb_cloned(skb)) &&
222 headroom + tailroom >= 4 + padlen) {
223 /* following should not happen, but better be safe */
226 skb->data = memmove(skb->head + 4, skb->data, skb->len);
227 skb_set_tail_pointer(skb, skb->len);
230 struct sk_buff *skb2;
232 skb2 = skb_copy_expand(skb, 4, padlen, flags);
233 dev_kfree_skb_any(skb);
239 packet_len = ((skb->len ^ 0x0000ffff) << 16) + skb->len;
241 cpu_to_le32s(&packet_len);
242 skb_copy_to_linear_data(skb, &packet_len, sizeof(packet_len));
245 cpu_to_le32s(&padbytes);
246 memcpy(skb_tail_pointer(skb), &padbytes, sizeof(padbytes));
247 skb_put(skb, sizeof(padbytes));
250 usbnet_set_skb_tx_stats(skb, 1, 0);
254 int asix_set_sw_mii(struct usbnet *dev, int in_pm)
257 ret = asix_write_cmd(dev, AX_CMD_SET_SW_MII, 0x0000, 0, 0, NULL, in_pm);
260 netdev_err(dev->net, "Failed to enable software MII access\n");
264 int asix_set_hw_mii(struct usbnet *dev, int in_pm)
267 ret = asix_write_cmd(dev, AX_CMD_SET_HW_MII, 0x0000, 0, 0, NULL, in_pm);
269 netdev_err(dev->net, "Failed to enable hardware MII access\n");
273 int asix_read_phy_addr(struct usbnet *dev, int internal)
275 int offset = (internal ? 1 : 0);
277 int ret = asix_read_cmd(dev, AX_CMD_READ_PHY_ID, 0, 0, 2, buf, 0);
279 netdev_dbg(dev->net, "asix_get_phy_addr()\n");
282 netdev_err(dev->net, "Error reading PHYID register: %02x\n", ret);
285 netdev_dbg(dev->net, "asix_get_phy_addr() returning 0x%04x\n",
293 int asix_get_phy_addr(struct usbnet *dev)
295 /* return the address of the internal phy */
296 return asix_read_phy_addr(dev, 1);
300 int asix_sw_reset(struct usbnet *dev, u8 flags, int in_pm)
304 ret = asix_write_cmd(dev, AX_CMD_SW_RESET, flags, 0, 0, NULL, in_pm);
306 netdev_err(dev->net, "Failed to send software reset: %02x\n", ret);
311 u16 asix_read_rx_ctl(struct usbnet *dev, int in_pm)
314 int ret = asix_read_cmd(dev, AX_CMD_READ_RX_CTL, 0, 0, 2, &v, in_pm);
317 netdev_err(dev->net, "Error reading RX_CTL register: %02x\n", ret);
320 ret = le16_to_cpu(v);
325 int asix_write_rx_ctl(struct usbnet *dev, u16 mode, int in_pm)
329 netdev_dbg(dev->net, "asix_write_rx_ctl() - mode = 0x%04x\n", mode);
330 ret = asix_write_cmd(dev, AX_CMD_WRITE_RX_CTL, mode, 0, 0, NULL, in_pm);
332 netdev_err(dev->net, "Failed to write RX_CTL mode to 0x%04x: %02x\n",
338 u16 asix_read_medium_status(struct usbnet *dev, int in_pm)
341 int ret = asix_read_cmd(dev, AX_CMD_READ_MEDIUM_STATUS,
345 netdev_err(dev->net, "Error reading Medium Status register: %02x\n",
347 return ret; /* TODO: callers not checking for error ret */
350 return le16_to_cpu(v);
354 int asix_write_medium_mode(struct usbnet *dev, u16 mode, int in_pm)
358 netdev_dbg(dev->net, "asix_write_medium_mode() - mode = 0x%04x\n", mode);
359 ret = asix_write_cmd(dev, AX_CMD_WRITE_MEDIUM_MODE,
360 mode, 0, 0, NULL, in_pm);
362 netdev_err(dev->net, "Failed to write Medium Mode mode to 0x%04x: %02x\n",
368 int asix_write_gpio(struct usbnet *dev, u16 value, int sleep, int in_pm)
372 netdev_dbg(dev->net, "asix_write_gpio() - value = 0x%04x\n", value);
373 ret = asix_write_cmd(dev, AX_CMD_WRITE_GPIOS, value, 0, 0, NULL, in_pm);
375 netdev_err(dev->net, "Failed to write GPIO value 0x%04x: %02x\n",
385 * AX88772 & AX88178 have a 16-bit RX_CTL value
387 void asix_set_multicast(struct net_device *net)
389 struct usbnet *dev = netdev_priv(net);
390 struct asix_data *data = (struct asix_data *)&dev->data;
391 u16 rx_ctl = AX_DEFAULT_RX_CTL;
393 if (net->flags & IFF_PROMISC) {
394 rx_ctl |= AX_RX_CTL_PRO;
395 } else if (net->flags & IFF_ALLMULTI ||
396 netdev_mc_count(net) > AX_MAX_MCAST) {
397 rx_ctl |= AX_RX_CTL_AMALL;
398 } else if (netdev_mc_empty(net)) {
399 /* just broadcast and directed */
401 /* We use the 20 byte dev->data
402 * for our 8 byte filter buffer
403 * to avoid allocating memory that
404 * is tricky to free later */
405 struct netdev_hw_addr *ha;
408 memset(data->multi_filter, 0, AX_MCAST_FILTER_SIZE);
410 /* Build the multicast hash filter. */
411 netdev_for_each_mc_addr(ha, net) {
412 crc_bits = ether_crc(ETH_ALEN, ha->addr) >> 26;
413 data->multi_filter[crc_bits >> 3] |=
417 asix_write_cmd_async(dev, AX_CMD_WRITE_MULTI_FILTER, 0, 0,
418 AX_MCAST_FILTER_SIZE, data->multi_filter);
420 rx_ctl |= AX_RX_CTL_AM;
423 asix_write_cmd_async(dev, AX_CMD_WRITE_RX_CTL, rx_ctl, 0, 0, NULL);
426 int asix_mdio_read(struct net_device *netdev, int phy_id, int loc)
428 struct usbnet *dev = netdev_priv(netdev);
434 mutex_lock(&dev->phy_mutex);
436 ret = asix_set_sw_mii(dev, 0);
437 if (ret == -ENODEV || ret == -ETIMEDOUT)
439 usleep_range(1000, 1100);
440 ret = asix_read_cmd(dev, AX_CMD_STATMNGSTS_REG,
442 } while (!(smsr & AX_HOST_EN) && (i++ < 30) && (ret != -ENODEV));
443 if (ret == -ENODEV || ret == -ETIMEDOUT) {
444 mutex_unlock(&dev->phy_mutex);
448 asix_read_cmd(dev, AX_CMD_READ_MII_REG, phy_id,
449 (__u16)loc, 2, &res, 0);
450 asix_set_hw_mii(dev, 0);
451 mutex_unlock(&dev->phy_mutex);
453 netdev_dbg(dev->net, "asix_mdio_read() phy_id=0x%02x, loc=0x%02x, returns=0x%04x\n",
454 phy_id, loc, le16_to_cpu(res));
456 return le16_to_cpu(res);
459 void asix_mdio_write(struct net_device *netdev, int phy_id, int loc, int val)
461 struct usbnet *dev = netdev_priv(netdev);
462 __le16 res = cpu_to_le16(val);
467 netdev_dbg(dev->net, "asix_mdio_write() phy_id=0x%02x, loc=0x%02x, val=0x%04x\n",
470 mutex_lock(&dev->phy_mutex);
472 ret = asix_set_sw_mii(dev, 0);
475 usleep_range(1000, 1100);
476 ret = asix_read_cmd(dev, AX_CMD_STATMNGSTS_REG,
478 } while (!(smsr & AX_HOST_EN) && (i++ < 30) && (ret != -ENODEV));
479 if (ret == -ENODEV) {
480 mutex_unlock(&dev->phy_mutex);
484 asix_write_cmd(dev, AX_CMD_WRITE_MII_REG, phy_id,
485 (__u16)loc, 2, &res, 0);
486 asix_set_hw_mii(dev, 0);
487 mutex_unlock(&dev->phy_mutex);
490 int asix_mdio_read_nopm(struct net_device *netdev, int phy_id, int loc)
492 struct usbnet *dev = netdev_priv(netdev);
498 mutex_lock(&dev->phy_mutex);
500 ret = asix_set_sw_mii(dev, 1);
501 if (ret == -ENODEV || ret == -ETIMEDOUT)
503 usleep_range(1000, 1100);
504 ret = asix_read_cmd(dev, AX_CMD_STATMNGSTS_REG,
506 } while (!(smsr & AX_HOST_EN) && (i++ < 30) && (ret != -ENODEV));
507 if (ret == -ENODEV || ret == -ETIMEDOUT) {
508 mutex_unlock(&dev->phy_mutex);
512 asix_read_cmd(dev, AX_CMD_READ_MII_REG, phy_id,
513 (__u16)loc, 2, &res, 1);
514 asix_set_hw_mii(dev, 1);
515 mutex_unlock(&dev->phy_mutex);
517 netdev_dbg(dev->net, "asix_mdio_read_nopm() phy_id=0x%02x, loc=0x%02x, returns=0x%04x\n",
518 phy_id, loc, le16_to_cpu(res));
520 return le16_to_cpu(res);
524 asix_mdio_write_nopm(struct net_device *netdev, int phy_id, int loc, int val)
526 struct usbnet *dev = netdev_priv(netdev);
527 __le16 res = cpu_to_le16(val);
532 netdev_dbg(dev->net, "asix_mdio_write() phy_id=0x%02x, loc=0x%02x, val=0x%04x\n",
535 mutex_lock(&dev->phy_mutex);
537 ret = asix_set_sw_mii(dev, 1);
540 usleep_range(1000, 1100);
541 ret = asix_read_cmd(dev, AX_CMD_STATMNGSTS_REG,
543 } while (!(smsr & AX_HOST_EN) && (i++ < 30) && (ret != -ENODEV));
544 if (ret == -ENODEV) {
545 mutex_unlock(&dev->phy_mutex);
549 asix_write_cmd(dev, AX_CMD_WRITE_MII_REG, phy_id,
550 (__u16)loc, 2, &res, 1);
551 asix_set_hw_mii(dev, 1);
552 mutex_unlock(&dev->phy_mutex);
555 void asix_get_wol(struct net_device *net, struct ethtool_wolinfo *wolinfo)
557 struct usbnet *dev = netdev_priv(net);
560 if (asix_read_cmd(dev, AX_CMD_READ_MONITOR_MODE,
561 0, 0, 1, &opt, 0) < 0) {
562 wolinfo->supported = 0;
563 wolinfo->wolopts = 0;
566 wolinfo->supported = WAKE_PHY | WAKE_MAGIC;
567 wolinfo->wolopts = 0;
568 if (opt & AX_MONITOR_LINK)
569 wolinfo->wolopts |= WAKE_PHY;
570 if (opt & AX_MONITOR_MAGIC)
571 wolinfo->wolopts |= WAKE_MAGIC;
574 int asix_set_wol(struct net_device *net, struct ethtool_wolinfo *wolinfo)
576 struct usbnet *dev = netdev_priv(net);
579 if (wolinfo->wolopts & WAKE_PHY)
580 opt |= AX_MONITOR_LINK;
581 if (wolinfo->wolopts & WAKE_MAGIC)
582 opt |= AX_MONITOR_MAGIC;
584 if (asix_write_cmd(dev, AX_CMD_WRITE_MONITOR_MODE,
585 opt, 0, 0, NULL, 0) < 0)
591 int asix_get_eeprom_len(struct net_device *net)
593 return AX_EEPROM_LEN;
596 int asix_get_eeprom(struct net_device *net, struct ethtool_eeprom *eeprom,
599 struct usbnet *dev = netdev_priv(net);
601 int first_word, last_word;
604 if (eeprom->len == 0)
607 eeprom->magic = AX_EEPROM_MAGIC;
609 first_word = eeprom->offset >> 1;
610 last_word = (eeprom->offset + eeprom->len - 1) >> 1;
612 eeprom_buff = kmalloc(sizeof(u16) * (last_word - first_word + 1),
617 /* ax8817x returns 2 bytes from eeprom on read */
618 for (i = first_word; i <= last_word; i++) {
619 if (asix_read_cmd(dev, AX_CMD_READ_EEPROM, i, 0, 2,
620 &eeprom_buff[i - first_word], 0) < 0) {
626 memcpy(data, (u8 *)eeprom_buff + (eeprom->offset & 1), eeprom->len);
631 int asix_set_eeprom(struct net_device *net, struct ethtool_eeprom *eeprom,
634 struct usbnet *dev = netdev_priv(net);
636 int first_word, last_word;
640 netdev_dbg(net, "write EEPROM len %d, offset %d, magic 0x%x\n",
641 eeprom->len, eeprom->offset, eeprom->magic);
643 if (eeprom->len == 0)
646 if (eeprom->magic != AX_EEPROM_MAGIC)
649 first_word = eeprom->offset >> 1;
650 last_word = (eeprom->offset + eeprom->len - 1) >> 1;
652 eeprom_buff = kmalloc(sizeof(u16) * (last_word - first_word + 1),
657 /* align data to 16 bit boundaries, read the missing data from
659 if (eeprom->offset & 1) {
660 ret = asix_read_cmd(dev, AX_CMD_READ_EEPROM, first_word, 0, 2,
663 netdev_err(net, "Failed to read EEPROM at offset 0x%02x.\n", first_word);
668 if ((eeprom->offset + eeprom->len) & 1) {
669 ret = asix_read_cmd(dev, AX_CMD_READ_EEPROM, last_word, 0, 2,
670 &eeprom_buff[last_word - first_word], 0);
672 netdev_err(net, "Failed to read EEPROM at offset 0x%02x.\n", last_word);
677 memcpy((u8 *)eeprom_buff + (eeprom->offset & 1), data, eeprom->len);
679 /* write data to EEPROM */
680 ret = asix_write_cmd(dev, AX_CMD_WRITE_ENABLE, 0x0000, 0, 0, NULL, 0);
682 netdev_err(net, "Failed to enable EEPROM write\n");
687 for (i = first_word; i <= last_word; i++) {
688 netdev_dbg(net, "write to EEPROM at offset 0x%02x, data 0x%04x\n",
689 i, eeprom_buff[i - first_word]);
690 ret = asix_write_cmd(dev, AX_CMD_WRITE_EEPROM, i,
691 eeprom_buff[i - first_word], 0, NULL, 0);
693 netdev_err(net, "Failed to write EEPROM at offset 0x%02x.\n",
700 ret = asix_write_cmd(dev, AX_CMD_WRITE_DISABLE, 0x0000, 0, 0, NULL, 0);
702 netdev_err(net, "Failed to disable EEPROM write\n");
712 void asix_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *info)
714 /* Inherit standard device info */
715 usbnet_get_drvinfo(net, info);
716 strlcpy(info->driver, DRIVER_NAME, sizeof(info->driver));
717 strlcpy(info->version, DRIVER_VERSION, sizeof(info->version));
720 int asix_set_mac_address(struct net_device *net, void *p)
722 struct usbnet *dev = netdev_priv(net);
723 struct asix_data *data = (struct asix_data *)&dev->data;
724 struct sockaddr *addr = p;
726 if (netif_running(net))
728 if (!is_valid_ether_addr(addr->sa_data))
729 return -EADDRNOTAVAIL;
731 memcpy(net->dev_addr, addr->sa_data, ETH_ALEN);
733 /* We use the 20 byte dev->data
734 * for our 6 byte mac buffer
735 * to avoid allocating memory that
736 * is tricky to free later */
737 memcpy(data->mac_addr, addr->sa_data, ETH_ALEN);
738 asix_write_cmd_async(dev, AX_CMD_WRITE_NODE_ID, 0, 0, ETH_ALEN,