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,
28 ret = usbnet_read_cmd(dev, cmd,
29 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
30 value, index, data, size);
32 if (ret != size && ret >= 0)
37 int asix_write_cmd(struct usbnet *dev, u8 cmd, u16 value, u16 index,
40 return usbnet_write_cmd(dev, cmd,
41 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
42 value, index, data, size);
45 void asix_write_cmd_async(struct usbnet *dev, u8 cmd, u16 value, u16 index,
48 usbnet_write_cmd_async(dev, cmd,
49 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
50 value, index, data, size);
53 int asix_rx_fixup_internal(struct usbnet *dev, struct sk_buff *skb,
54 struct asix_rx_fixup_info *rx)
58 while (offset + sizeof(u16) <= skb->len) {
63 if ((skb->len - offset == sizeof(u16)) ||
66 rx->header = get_unaligned_le16(
68 rx->split_head = true;
69 offset += sizeof(u16);
72 rx->header |= (get_unaligned_le16(
75 rx->split_head = false;
76 offset += sizeof(u16);
79 rx->header = get_unaligned_le32(skb->data +
81 offset += sizeof(u32);
84 /* get the packet length */
85 rx->size = (u16) (rx->header & 0x7ff);
86 if (rx->size != ((~rx->header >> 16) & 0x7ff)) {
87 netdev_err(dev->net, "asix_rx_fixup() Bad Header Length 0x%x, offset %d\n",
92 rx->ax_skb = netdev_alloc_skb_ip_align(dev->net,
100 if (rx->size > dev->net->mtu + ETH_HLEN + VLAN_HLEN) {
101 netdev_err(dev->net, "asix_rx_fixup() Bad RX Length %d\n",
103 kfree_skb(rx->ax_skb);
110 if (rx->size > skb->len - offset) {
111 remaining = rx->size - (skb->len - offset);
112 rx->size = skb->len - offset;
115 data = skb_put(rx->ax_skb, rx->size);
116 memcpy(data, skb->data + offset, rx->size);
118 usbnet_skb_return(dev, rx->ax_skb);
120 offset += (rx->size + 1) & 0xfffe;
121 rx->size = remaining;
124 if (skb->len != offset) {
125 netdev_err(dev->net, "asix_rx_fixup() Bad SKB Length %d, %d\n",
133 int asix_rx_fixup_common(struct usbnet *dev, struct sk_buff *skb)
135 struct asix_common_private *dp = dev->driver_priv;
136 struct asix_rx_fixup_info *rx = &dp->rx_fixup_info;
138 return asix_rx_fixup_internal(dev, skb, rx);
141 struct sk_buff *asix_tx_fixup(struct usbnet *dev, struct sk_buff *skb,
145 int headroom = skb_headroom(skb);
146 int tailroom = skb_tailroom(skb);
148 u32 padbytes = 0xffff0000;
150 padlen = ((skb->len + 4) & (dev->maxpacket - 1)) ? 0 : 4;
152 /* We need to push 4 bytes in front of frame (packet_len)
153 * and maybe add 4 bytes after the end (if padlen is 4)
155 * Avoid skb_copy_expand() expensive call, using following rules :
156 * - We are allowed to push 4 bytes in headroom if skb_header_cloned()
157 * is false (and if we have 4 bytes of headroom)
158 * - We are allowed to put 4 bytes at tail if skb_cloned()
159 * is false (and if we have 4 bytes of tailroom)
161 * TCP packets for example are cloned, but skb_header_release()
162 * was called in tcp stack, allowing us to use headroom for our needs.
164 if (!skb_header_cloned(skb) &&
165 !(padlen && skb_cloned(skb)) &&
166 headroom + tailroom >= 4 + padlen) {
167 /* following should not happen, but better be safe */
170 skb->data = memmove(skb->head + 4, skb->data, skb->len);
171 skb_set_tail_pointer(skb, skb->len);
174 struct sk_buff *skb2;
176 skb2 = skb_copy_expand(skb, 4, padlen, flags);
177 dev_kfree_skb_any(skb);
183 packet_len = ((skb->len ^ 0x0000ffff) << 16) + skb->len;
185 cpu_to_le32s(&packet_len);
186 skb_copy_to_linear_data(skb, &packet_len, sizeof(packet_len));
189 cpu_to_le32s(&padbytes);
190 memcpy(skb_tail_pointer(skb), &padbytes, sizeof(padbytes));
191 skb_put(skb, sizeof(padbytes));
194 usbnet_set_skb_tx_stats(skb, 1, 0);
198 int asix_set_sw_mii(struct usbnet *dev)
201 ret = asix_write_cmd(dev, AX_CMD_SET_SW_MII, 0x0000, 0, 0, NULL);
203 netdev_err(dev->net, "Failed to enable software MII access\n");
207 int asix_set_hw_mii(struct usbnet *dev)
210 ret = asix_write_cmd(dev, AX_CMD_SET_HW_MII, 0x0000, 0, 0, NULL);
212 netdev_err(dev->net, "Failed to enable hardware MII access\n");
216 int asix_read_phy_addr(struct usbnet *dev, int internal)
218 int offset = (internal ? 1 : 0);
220 int ret = asix_read_cmd(dev, AX_CMD_READ_PHY_ID, 0, 0, 2, buf);
222 netdev_dbg(dev->net, "asix_get_phy_addr()\n");
225 netdev_err(dev->net, "Error reading PHYID register: %02x\n", ret);
228 netdev_dbg(dev->net, "asix_get_phy_addr() returning 0x%04x\n",
236 int asix_get_phy_addr(struct usbnet *dev)
238 /* return the address of the internal phy */
239 return asix_read_phy_addr(dev, 1);
243 int asix_sw_reset(struct usbnet *dev, u8 flags)
247 ret = asix_write_cmd(dev, AX_CMD_SW_RESET, flags, 0, 0, NULL);
249 netdev_err(dev->net, "Failed to send software reset: %02x\n", ret);
254 u16 asix_read_rx_ctl(struct usbnet *dev)
257 int ret = asix_read_cmd(dev, AX_CMD_READ_RX_CTL, 0, 0, 2, &v);
260 netdev_err(dev->net, "Error reading RX_CTL register: %02x\n", ret);
263 ret = le16_to_cpu(v);
268 int asix_write_rx_ctl(struct usbnet *dev, u16 mode)
272 netdev_dbg(dev->net, "asix_write_rx_ctl() - mode = 0x%04x\n", mode);
273 ret = asix_write_cmd(dev, AX_CMD_WRITE_RX_CTL, mode, 0, 0, NULL);
275 netdev_err(dev->net, "Failed to write RX_CTL mode to 0x%04x: %02x\n",
281 u16 asix_read_medium_status(struct usbnet *dev)
284 int ret = asix_read_cmd(dev, AX_CMD_READ_MEDIUM_STATUS, 0, 0, 2, &v);
287 netdev_err(dev->net, "Error reading Medium Status register: %02x\n",
289 return ret; /* TODO: callers not checking for error ret */
292 return le16_to_cpu(v);
296 int asix_write_medium_mode(struct usbnet *dev, u16 mode)
300 netdev_dbg(dev->net, "asix_write_medium_mode() - mode = 0x%04x\n", mode);
301 ret = asix_write_cmd(dev, AX_CMD_WRITE_MEDIUM_MODE, mode, 0, 0, NULL);
303 netdev_err(dev->net, "Failed to write Medium Mode mode to 0x%04x: %02x\n",
309 int asix_write_gpio(struct usbnet *dev, u16 value, int sleep)
313 netdev_dbg(dev->net, "asix_write_gpio() - value = 0x%04x\n", value);
314 ret = asix_write_cmd(dev, AX_CMD_WRITE_GPIOS, value, 0, 0, NULL);
316 netdev_err(dev->net, "Failed to write GPIO value 0x%04x: %02x\n",
326 * AX88772 & AX88178 have a 16-bit RX_CTL value
328 void asix_set_multicast(struct net_device *net)
330 struct usbnet *dev = netdev_priv(net);
331 struct asix_data *data = (struct asix_data *)&dev->data;
332 u16 rx_ctl = AX_DEFAULT_RX_CTL;
334 if (net->flags & IFF_PROMISC) {
335 rx_ctl |= AX_RX_CTL_PRO;
336 } else if (net->flags & IFF_ALLMULTI ||
337 netdev_mc_count(net) > AX_MAX_MCAST) {
338 rx_ctl |= AX_RX_CTL_AMALL;
339 } else if (netdev_mc_empty(net)) {
340 /* just broadcast and directed */
342 /* We use the 20 byte dev->data
343 * for our 8 byte filter buffer
344 * to avoid allocating memory that
345 * is tricky to free later */
346 struct netdev_hw_addr *ha;
349 memset(data->multi_filter, 0, AX_MCAST_FILTER_SIZE);
351 /* Build the multicast hash filter. */
352 netdev_for_each_mc_addr(ha, net) {
353 crc_bits = ether_crc(ETH_ALEN, ha->addr) >> 26;
354 data->multi_filter[crc_bits >> 3] |=
358 asix_write_cmd_async(dev, AX_CMD_WRITE_MULTI_FILTER, 0, 0,
359 AX_MCAST_FILTER_SIZE, data->multi_filter);
361 rx_ctl |= AX_RX_CTL_AM;
364 asix_write_cmd_async(dev, AX_CMD_WRITE_RX_CTL, rx_ctl, 0, 0, NULL);
367 int asix_mdio_read(struct net_device *netdev, int phy_id, int loc)
369 struct usbnet *dev = netdev_priv(netdev);
372 mutex_lock(&dev->phy_mutex);
373 asix_set_sw_mii(dev);
374 asix_read_cmd(dev, AX_CMD_READ_MII_REG, phy_id,
375 (__u16)loc, 2, &res);
376 asix_set_hw_mii(dev);
377 mutex_unlock(&dev->phy_mutex);
379 netdev_dbg(dev->net, "asix_mdio_read() phy_id=0x%02x, loc=0x%02x, returns=0x%04x\n",
380 phy_id, loc, le16_to_cpu(res));
382 return le16_to_cpu(res);
385 void asix_mdio_write(struct net_device *netdev, int phy_id, int loc, int val)
387 struct usbnet *dev = netdev_priv(netdev);
388 __le16 res = cpu_to_le16(val);
390 netdev_dbg(dev->net, "asix_mdio_write() phy_id=0x%02x, loc=0x%02x, val=0x%04x\n",
392 mutex_lock(&dev->phy_mutex);
393 asix_set_sw_mii(dev);
394 asix_write_cmd(dev, AX_CMD_WRITE_MII_REG, phy_id, (__u16)loc, 2, &res);
395 asix_set_hw_mii(dev);
396 mutex_unlock(&dev->phy_mutex);
399 void asix_get_wol(struct net_device *net, struct ethtool_wolinfo *wolinfo)
401 struct usbnet *dev = netdev_priv(net);
404 if (asix_read_cmd(dev, AX_CMD_READ_MONITOR_MODE, 0, 0, 1, &opt) < 0) {
405 wolinfo->supported = 0;
406 wolinfo->wolopts = 0;
409 wolinfo->supported = WAKE_PHY | WAKE_MAGIC;
410 wolinfo->wolopts = 0;
411 if (opt & AX_MONITOR_LINK)
412 wolinfo->wolopts |= WAKE_PHY;
413 if (opt & AX_MONITOR_MAGIC)
414 wolinfo->wolopts |= WAKE_MAGIC;
417 int asix_set_wol(struct net_device *net, struct ethtool_wolinfo *wolinfo)
419 struct usbnet *dev = netdev_priv(net);
422 if (wolinfo->wolopts & WAKE_PHY)
423 opt |= AX_MONITOR_LINK;
424 if (wolinfo->wolopts & WAKE_MAGIC)
425 opt |= AX_MONITOR_MAGIC;
427 if (asix_write_cmd(dev, AX_CMD_WRITE_MONITOR_MODE,
428 opt, 0, 0, NULL) < 0)
434 int asix_get_eeprom_len(struct net_device *net)
436 return AX_EEPROM_LEN;
439 int asix_get_eeprom(struct net_device *net, struct ethtool_eeprom *eeprom,
442 struct usbnet *dev = netdev_priv(net);
444 int first_word, last_word;
447 if (eeprom->len == 0)
450 eeprom->magic = AX_EEPROM_MAGIC;
452 first_word = eeprom->offset >> 1;
453 last_word = (eeprom->offset + eeprom->len - 1) >> 1;
455 eeprom_buff = kmalloc(sizeof(u16) * (last_word - first_word + 1),
460 /* ax8817x returns 2 bytes from eeprom on read */
461 for (i = first_word; i <= last_word; i++) {
462 if (asix_read_cmd(dev, AX_CMD_READ_EEPROM, i, 0, 2,
463 &(eeprom_buff[i - first_word])) < 0) {
469 memcpy(data, (u8 *)eeprom_buff + (eeprom->offset & 1), eeprom->len);
474 int asix_set_eeprom(struct net_device *net, struct ethtool_eeprom *eeprom,
477 struct usbnet *dev = netdev_priv(net);
479 int first_word, last_word;
483 netdev_dbg(net, "write EEPROM len %d, offset %d, magic 0x%x\n",
484 eeprom->len, eeprom->offset, eeprom->magic);
486 if (eeprom->len == 0)
489 if (eeprom->magic != AX_EEPROM_MAGIC)
492 first_word = eeprom->offset >> 1;
493 last_word = (eeprom->offset + eeprom->len - 1) >> 1;
495 eeprom_buff = kmalloc(sizeof(u16) * (last_word - first_word + 1),
500 /* align data to 16 bit boundaries, read the missing data from
502 if (eeprom->offset & 1) {
503 ret = asix_read_cmd(dev, AX_CMD_READ_EEPROM, first_word, 0, 2,
506 netdev_err(net, "Failed to read EEPROM at offset 0x%02x.\n", first_word);
511 if ((eeprom->offset + eeprom->len) & 1) {
512 ret = asix_read_cmd(dev, AX_CMD_READ_EEPROM, last_word, 0, 2,
513 &(eeprom_buff[last_word - first_word]));
515 netdev_err(net, "Failed to read EEPROM at offset 0x%02x.\n", last_word);
520 memcpy((u8 *)eeprom_buff + (eeprom->offset & 1), data, eeprom->len);
522 /* write data to EEPROM */
523 ret = asix_write_cmd(dev, AX_CMD_WRITE_ENABLE, 0x0000, 0, 0, NULL);
525 netdev_err(net, "Failed to enable EEPROM write\n");
530 for (i = first_word; i <= last_word; i++) {
531 netdev_dbg(net, "write to EEPROM at offset 0x%02x, data 0x%04x\n",
532 i, eeprom_buff[i - first_word]);
533 ret = asix_write_cmd(dev, AX_CMD_WRITE_EEPROM, i,
534 eeprom_buff[i - first_word], 0, NULL);
536 netdev_err(net, "Failed to write EEPROM at offset 0x%02x.\n",
543 ret = asix_write_cmd(dev, AX_CMD_WRITE_DISABLE, 0x0000, 0, 0, NULL);
545 netdev_err(net, "Failed to disable EEPROM write\n");
555 void asix_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *info)
557 /* Inherit standard device info */
558 usbnet_get_drvinfo(net, info);
559 strlcpy(info->driver, DRIVER_NAME, sizeof(info->driver));
560 strlcpy(info->version, DRIVER_VERSION, sizeof(info->version));
561 info->eedump_len = AX_EEPROM_LEN;
564 int asix_set_mac_address(struct net_device *net, void *p)
566 struct usbnet *dev = netdev_priv(net);
567 struct asix_data *data = (struct asix_data *)&dev->data;
568 struct sockaddr *addr = p;
570 if (netif_running(net))
572 if (!is_valid_ether_addr(addr->sa_data))
573 return -EADDRNOTAVAIL;
575 memcpy(net->dev_addr, addr->sa_data, ETH_ALEN);
577 /* We use the 20 byte dev->data
578 * for our 6 byte mac buffer
579 * to avoid allocating memory that
580 * is tricky to free later */
581 memcpy(data->mac_addr, addr->sa_data, ETH_ALEN);
582 asix_write_cmd_async(dev, AX_CMD_WRITE_NODE_ID, 0, 0, ETH_ALEN,