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
) {
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",
145 if (size
> dev
->net
->mtu
+ ETH_HLEN
+ VLAN_HLEN
) {
146 netdev_dbg(dev
->net
, "asix_rx_fixup() Bad RX Length %d\n",
151 /* Sometimes may fail to get a netdev socket buffer but
152 * continue to process the URB socket buffer so that
153 * synchronisation of the Ethernet frame Data header
154 * word is maintained.
156 rx
->ax_skb
= netdev_alloc_skb_ip_align(dev
->net
, size
);
158 rx
->remaining
= size
;
161 if (rx
->remaining
> skb
->len
- offset
) {
162 copy_length
= skb
->len
- offset
;
163 rx
->remaining
-= copy_length
;
165 copy_length
= rx
->remaining
;
170 data
= skb_put(rx
->ax_skb
, copy_length
);
171 memcpy(data
, skb
->data
+ offset
, copy_length
);
173 usbnet_skb_return(dev
, rx
->ax_skb
);
176 offset
+= (copy_length
+ 1) & 0xfffe;
179 if (skb
->len
!= offset
) {
180 netdev_err(dev
->net
, "asix_rx_fixup() Bad SKB Length %d, %d\n",
188 int asix_rx_fixup_common(struct usbnet
*dev
, struct sk_buff
*skb
)
190 struct asix_common_private
*dp
= dev
->driver_priv
;
191 struct asix_rx_fixup_info
*rx
= &dp
->rx_fixup_info
;
193 return asix_rx_fixup_internal(dev
, skb
, rx
);
196 struct sk_buff
*asix_tx_fixup(struct usbnet
*dev
, struct sk_buff
*skb
,
200 int headroom
= skb_headroom(skb
);
201 int tailroom
= skb_tailroom(skb
);
203 u32 padbytes
= 0xffff0000;
205 padlen
= ((skb
->len
+ 4) & (dev
->maxpacket
- 1)) ? 0 : 4;
207 /* We need to push 4 bytes in front of frame (packet_len)
208 * and maybe add 4 bytes after the end (if padlen is 4)
210 * Avoid skb_copy_expand() expensive call, using following rules :
211 * - We are allowed to push 4 bytes in headroom if skb_header_cloned()
212 * is false (and if we have 4 bytes of headroom)
213 * - We are allowed to put 4 bytes at tail if skb_cloned()
214 * is false (and if we have 4 bytes of tailroom)
216 * TCP packets for example are cloned, but skb_header_release()
217 * was called in tcp stack, allowing us to use headroom for our needs.
219 if (!skb_header_cloned(skb
) &&
220 !(padlen
&& skb_cloned(skb
)) &&
221 headroom
+ tailroom
>= 4 + padlen
) {
222 /* following should not happen, but better be safe */
225 skb
->data
= memmove(skb
->head
+ 4, skb
->data
, skb
->len
);
226 skb_set_tail_pointer(skb
, skb
->len
);
229 struct sk_buff
*skb2
;
231 skb2
= skb_copy_expand(skb
, 4, padlen
, flags
);
232 dev_kfree_skb_any(skb
);
238 packet_len
= ((skb
->len
^ 0x0000ffff) << 16) + skb
->len
;
240 cpu_to_le32s(&packet_len
);
241 skb_copy_to_linear_data(skb
, &packet_len
, sizeof(packet_len
));
244 cpu_to_le32s(&padbytes
);
245 memcpy(skb_tail_pointer(skb
), &padbytes
, sizeof(padbytes
));
246 skb_put(skb
, sizeof(padbytes
));
249 usbnet_set_skb_tx_stats(skb
, 1, 0);
253 int asix_set_sw_mii(struct usbnet
*dev
, int in_pm
)
256 ret
= asix_write_cmd(dev
, AX_CMD_SET_SW_MII
, 0x0000, 0, 0, NULL
, in_pm
);
259 netdev_err(dev
->net
, "Failed to enable software MII access\n");
263 int asix_set_hw_mii(struct usbnet
*dev
, int in_pm
)
266 ret
= asix_write_cmd(dev
, AX_CMD_SET_HW_MII
, 0x0000, 0, 0, NULL
, in_pm
);
268 netdev_err(dev
->net
, "Failed to enable hardware MII access\n");
272 int asix_read_phy_addr(struct usbnet
*dev
, int internal
)
274 int offset
= (internal
? 1 : 0);
276 int ret
= asix_read_cmd(dev
, AX_CMD_READ_PHY_ID
, 0, 0, 2, buf
, 0);
278 netdev_dbg(dev
->net
, "asix_get_phy_addr()\n");
281 netdev_err(dev
->net
, "Error reading PHYID register: %02x\n", ret
);
284 netdev_dbg(dev
->net
, "asix_get_phy_addr() returning 0x%04x\n",
292 int asix_get_phy_addr(struct usbnet
*dev
)
294 /* return the address of the internal phy */
295 return asix_read_phy_addr(dev
, 1);
299 int asix_sw_reset(struct usbnet
*dev
, u8 flags
, int in_pm
)
303 ret
= asix_write_cmd(dev
, AX_CMD_SW_RESET
, flags
, 0, 0, NULL
, in_pm
);
305 netdev_err(dev
->net
, "Failed to send software reset: %02x\n", ret
);
310 u16
asix_read_rx_ctl(struct usbnet
*dev
, int in_pm
)
313 int ret
= asix_read_cmd(dev
, AX_CMD_READ_RX_CTL
, 0, 0, 2, &v
, in_pm
);
316 netdev_err(dev
->net
, "Error reading RX_CTL register: %02x\n", ret
);
319 ret
= le16_to_cpu(v
);
324 int asix_write_rx_ctl(struct usbnet
*dev
, u16 mode
, int in_pm
)
328 netdev_dbg(dev
->net
, "asix_write_rx_ctl() - mode = 0x%04x\n", mode
);
329 ret
= asix_write_cmd(dev
, AX_CMD_WRITE_RX_CTL
, mode
, 0, 0, NULL
, in_pm
);
331 netdev_err(dev
->net
, "Failed to write RX_CTL mode to 0x%04x: %02x\n",
337 u16
asix_read_medium_status(struct usbnet
*dev
, int in_pm
)
340 int ret
= asix_read_cmd(dev
, AX_CMD_READ_MEDIUM_STATUS
,
344 netdev_err(dev
->net
, "Error reading Medium Status register: %02x\n",
346 return ret
; /* TODO: callers not checking for error ret */
349 return le16_to_cpu(v
);
353 int asix_write_medium_mode(struct usbnet
*dev
, u16 mode
, int in_pm
)
357 netdev_dbg(dev
->net
, "asix_write_medium_mode() - mode = 0x%04x\n", mode
);
358 ret
= asix_write_cmd(dev
, AX_CMD_WRITE_MEDIUM_MODE
,
359 mode
, 0, 0, NULL
, in_pm
);
361 netdev_err(dev
->net
, "Failed to write Medium Mode mode to 0x%04x: %02x\n",
367 int asix_write_gpio(struct usbnet
*dev
, u16 value
, int sleep
, int in_pm
)
371 netdev_dbg(dev
->net
, "asix_write_gpio() - value = 0x%04x\n", value
);
372 ret
= asix_write_cmd(dev
, AX_CMD_WRITE_GPIOS
, value
, 0, 0, NULL
, in_pm
);
374 netdev_err(dev
->net
, "Failed to write GPIO value 0x%04x: %02x\n",
384 * AX88772 & AX88178 have a 16-bit RX_CTL value
386 void asix_set_multicast(struct net_device
*net
)
388 struct usbnet
*dev
= netdev_priv(net
);
389 struct asix_data
*data
= (struct asix_data
*)&dev
->data
;
390 u16 rx_ctl
= AX_DEFAULT_RX_CTL
;
392 if (net
->flags
& IFF_PROMISC
) {
393 rx_ctl
|= AX_RX_CTL_PRO
;
394 } else if (net
->flags
& IFF_ALLMULTI
||
395 netdev_mc_count(net
) > AX_MAX_MCAST
) {
396 rx_ctl
|= AX_RX_CTL_AMALL
;
397 } else if (netdev_mc_empty(net
)) {
398 /* just broadcast and directed */
400 /* We use the 20 byte dev->data
401 * for our 8 byte filter buffer
402 * to avoid allocating memory that
403 * is tricky to free later */
404 struct netdev_hw_addr
*ha
;
407 memset(data
->multi_filter
, 0, AX_MCAST_FILTER_SIZE
);
409 /* Build the multicast hash filter. */
410 netdev_for_each_mc_addr(ha
, net
) {
411 crc_bits
= ether_crc(ETH_ALEN
, ha
->addr
) >> 26;
412 data
->multi_filter
[crc_bits
>> 3] |=
416 asix_write_cmd_async(dev
, AX_CMD_WRITE_MULTI_FILTER
, 0, 0,
417 AX_MCAST_FILTER_SIZE
, data
->multi_filter
);
419 rx_ctl
|= AX_RX_CTL_AM
;
422 asix_write_cmd_async(dev
, AX_CMD_WRITE_RX_CTL
, rx_ctl
, 0, 0, NULL
);
425 int asix_mdio_read(struct net_device
*netdev
, int phy_id
, int loc
)
427 struct usbnet
*dev
= netdev_priv(netdev
);
433 mutex_lock(&dev
->phy_mutex
);
435 ret
= asix_set_sw_mii(dev
, 0);
436 if (ret
== -ENODEV
|| ret
== -ETIMEDOUT
)
438 usleep_range(1000, 1100);
439 ret
= asix_read_cmd(dev
, AX_CMD_STATMNGSTS_REG
,
441 } while (!(smsr
& AX_HOST_EN
) && (i
++ < 30) && (ret
!= -ENODEV
));
442 if (ret
== -ENODEV
|| ret
== -ETIMEDOUT
) {
443 mutex_unlock(&dev
->phy_mutex
);
447 asix_read_cmd(dev
, AX_CMD_READ_MII_REG
, phy_id
,
448 (__u16
)loc
, 2, &res
, 0);
449 asix_set_hw_mii(dev
, 0);
450 mutex_unlock(&dev
->phy_mutex
);
452 netdev_dbg(dev
->net
, "asix_mdio_read() phy_id=0x%02x, loc=0x%02x, returns=0x%04x\n",
453 phy_id
, loc
, le16_to_cpu(res
));
455 return le16_to_cpu(res
);
458 void asix_mdio_write(struct net_device
*netdev
, int phy_id
, int loc
, int val
)
460 struct usbnet
*dev
= netdev_priv(netdev
);
461 __le16 res
= cpu_to_le16(val
);
466 netdev_dbg(dev
->net
, "asix_mdio_write() phy_id=0x%02x, loc=0x%02x, val=0x%04x\n",
469 mutex_lock(&dev
->phy_mutex
);
471 ret
= asix_set_sw_mii(dev
, 0);
474 usleep_range(1000, 1100);
475 ret
= asix_read_cmd(dev
, AX_CMD_STATMNGSTS_REG
,
477 } while (!(smsr
& AX_HOST_EN
) && (i
++ < 30) && (ret
!= -ENODEV
));
478 if (ret
== -ENODEV
) {
479 mutex_unlock(&dev
->phy_mutex
);
483 asix_write_cmd(dev
, AX_CMD_WRITE_MII_REG
, phy_id
,
484 (__u16
)loc
, 2, &res
, 0);
485 asix_set_hw_mii(dev
, 0);
486 mutex_unlock(&dev
->phy_mutex
);
489 int asix_mdio_read_nopm(struct net_device
*netdev
, int phy_id
, int loc
)
491 struct usbnet
*dev
= netdev_priv(netdev
);
497 mutex_lock(&dev
->phy_mutex
);
499 ret
= asix_set_sw_mii(dev
, 1);
500 if (ret
== -ENODEV
|| ret
== -ETIMEDOUT
)
502 usleep_range(1000, 1100);
503 ret
= asix_read_cmd(dev
, AX_CMD_STATMNGSTS_REG
,
505 } while (!(smsr
& AX_HOST_EN
) && (i
++ < 30) && (ret
!= -ENODEV
));
506 if (ret
== -ENODEV
|| ret
== -ETIMEDOUT
) {
507 mutex_unlock(&dev
->phy_mutex
);
511 asix_read_cmd(dev
, AX_CMD_READ_MII_REG
, phy_id
,
512 (__u16
)loc
, 2, &res
, 1);
513 asix_set_hw_mii(dev
, 1);
514 mutex_unlock(&dev
->phy_mutex
);
516 netdev_dbg(dev
->net
, "asix_mdio_read_nopm() phy_id=0x%02x, loc=0x%02x, returns=0x%04x\n",
517 phy_id
, loc
, le16_to_cpu(res
));
519 return le16_to_cpu(res
);
523 asix_mdio_write_nopm(struct net_device
*netdev
, int phy_id
, int loc
, int val
)
525 struct usbnet
*dev
= netdev_priv(netdev
);
526 __le16 res
= cpu_to_le16(val
);
531 netdev_dbg(dev
->net
, "asix_mdio_write() phy_id=0x%02x, loc=0x%02x, val=0x%04x\n",
534 mutex_lock(&dev
->phy_mutex
);
536 ret
= asix_set_sw_mii(dev
, 1);
539 usleep_range(1000, 1100);
540 ret
= asix_read_cmd(dev
, AX_CMD_STATMNGSTS_REG
,
542 } while (!(smsr
& AX_HOST_EN
) && (i
++ < 30) && (ret
!= -ENODEV
));
543 if (ret
== -ENODEV
) {
544 mutex_unlock(&dev
->phy_mutex
);
548 asix_write_cmd(dev
, AX_CMD_WRITE_MII_REG
, phy_id
,
549 (__u16
)loc
, 2, &res
, 1);
550 asix_set_hw_mii(dev
, 1);
551 mutex_unlock(&dev
->phy_mutex
);
554 void asix_get_wol(struct net_device
*net
, struct ethtool_wolinfo
*wolinfo
)
556 struct usbnet
*dev
= netdev_priv(net
);
559 if (asix_read_cmd(dev
, AX_CMD_READ_MONITOR_MODE
,
560 0, 0, 1, &opt
, 0) < 0) {
561 wolinfo
->supported
= 0;
562 wolinfo
->wolopts
= 0;
565 wolinfo
->supported
= WAKE_PHY
| WAKE_MAGIC
;
566 wolinfo
->wolopts
= 0;
567 if (opt
& AX_MONITOR_LINK
)
568 wolinfo
->wolopts
|= WAKE_PHY
;
569 if (opt
& AX_MONITOR_MAGIC
)
570 wolinfo
->wolopts
|= WAKE_MAGIC
;
573 int asix_set_wol(struct net_device
*net
, struct ethtool_wolinfo
*wolinfo
)
575 struct usbnet
*dev
= netdev_priv(net
);
578 if (wolinfo
->wolopts
& WAKE_PHY
)
579 opt
|= AX_MONITOR_LINK
;
580 if (wolinfo
->wolopts
& WAKE_MAGIC
)
581 opt
|= AX_MONITOR_MAGIC
;
583 if (asix_write_cmd(dev
, AX_CMD_WRITE_MONITOR_MODE
,
584 opt
, 0, 0, NULL
, 0) < 0)
590 int asix_get_eeprom_len(struct net_device
*net
)
592 return AX_EEPROM_LEN
;
595 int asix_get_eeprom(struct net_device
*net
, struct ethtool_eeprom
*eeprom
,
598 struct usbnet
*dev
= netdev_priv(net
);
600 int first_word
, last_word
;
603 if (eeprom
->len
== 0)
606 eeprom
->magic
= AX_EEPROM_MAGIC
;
608 first_word
= eeprom
->offset
>> 1;
609 last_word
= (eeprom
->offset
+ eeprom
->len
- 1) >> 1;
611 eeprom_buff
= kmalloc(sizeof(u16
) * (last_word
- first_word
+ 1),
616 /* ax8817x returns 2 bytes from eeprom on read */
617 for (i
= first_word
; i
<= last_word
; i
++) {
618 if (asix_read_cmd(dev
, AX_CMD_READ_EEPROM
, i
, 0, 2,
619 &eeprom_buff
[i
- first_word
], 0) < 0) {
625 memcpy(data
, (u8
*)eeprom_buff
+ (eeprom
->offset
& 1), eeprom
->len
);
630 int asix_set_eeprom(struct net_device
*net
, struct ethtool_eeprom
*eeprom
,
633 struct usbnet
*dev
= netdev_priv(net
);
635 int first_word
, last_word
;
639 netdev_dbg(net
, "write EEPROM len %d, offset %d, magic 0x%x\n",
640 eeprom
->len
, eeprom
->offset
, eeprom
->magic
);
642 if (eeprom
->len
== 0)
645 if (eeprom
->magic
!= AX_EEPROM_MAGIC
)
648 first_word
= eeprom
->offset
>> 1;
649 last_word
= (eeprom
->offset
+ eeprom
->len
- 1) >> 1;
651 eeprom_buff
= kmalloc(sizeof(u16
) * (last_word
- first_word
+ 1),
656 /* align data to 16 bit boundaries, read the missing data from
658 if (eeprom
->offset
& 1) {
659 ret
= asix_read_cmd(dev
, AX_CMD_READ_EEPROM
, first_word
, 0, 2,
662 netdev_err(net
, "Failed to read EEPROM at offset 0x%02x.\n", first_word
);
667 if ((eeprom
->offset
+ eeprom
->len
) & 1) {
668 ret
= asix_read_cmd(dev
, AX_CMD_READ_EEPROM
, last_word
, 0, 2,
669 &eeprom_buff
[last_word
- first_word
], 0);
671 netdev_err(net
, "Failed to read EEPROM at offset 0x%02x.\n", last_word
);
676 memcpy((u8
*)eeprom_buff
+ (eeprom
->offset
& 1), data
, eeprom
->len
);
678 /* write data to EEPROM */
679 ret
= asix_write_cmd(dev
, AX_CMD_WRITE_ENABLE
, 0x0000, 0, 0, NULL
, 0);
681 netdev_err(net
, "Failed to enable EEPROM write\n");
686 for (i
= first_word
; i
<= last_word
; i
++) {
687 netdev_dbg(net
, "write to EEPROM at offset 0x%02x, data 0x%04x\n",
688 i
, eeprom_buff
[i
- first_word
]);
689 ret
= asix_write_cmd(dev
, AX_CMD_WRITE_EEPROM
, i
,
690 eeprom_buff
[i
- first_word
], 0, NULL
, 0);
692 netdev_err(net
, "Failed to write EEPROM at offset 0x%02x.\n",
699 ret
= asix_write_cmd(dev
, AX_CMD_WRITE_DISABLE
, 0x0000, 0, 0, NULL
, 0);
701 netdev_err(net
, "Failed to disable EEPROM write\n");
711 void asix_get_drvinfo(struct net_device
*net
, struct ethtool_drvinfo
*info
)
713 /* Inherit standard device info */
714 usbnet_get_drvinfo(net
, info
);
715 strlcpy(info
->driver
, DRIVER_NAME
, sizeof(info
->driver
));
716 strlcpy(info
->version
, DRIVER_VERSION
, sizeof(info
->version
));
719 int asix_set_mac_address(struct net_device
*net
, void *p
)
721 struct usbnet
*dev
= netdev_priv(net
);
722 struct asix_data
*data
= (struct asix_data
*)&dev
->data
;
723 struct sockaddr
*addr
= p
;
725 if (netif_running(net
))
727 if (!is_valid_ether_addr(addr
->sa_data
))
728 return -EADDRNOTAVAIL
;
730 memcpy(net
->dev_addr
, addr
->sa_data
, ETH_ALEN
);
732 /* We use the 20 byte dev->data
733 * for our 6 byte mac buffer
734 * to avoid allocating memory that
735 * is tricky to free later */
736 memcpy(data
->mac_addr
, addr
->sa_data
, ETH_ALEN
);
737 asix_write_cmd_async(dev
, AX_CMD_WRITE_NODE_ID
, 0, 0, ETH_ALEN
,