2 * Copyright (c) 2011 The Chromium OS Authors.
4 * SPDX-License-Identifier: GPL-2.0+
10 #include "usb_ether.h"
14 /* ASIX AX8817X based USB 2.0 Ethernet Devices */
16 #define AX_CMD_SET_SW_MII 0x06
17 #define AX_CMD_READ_MII_REG 0x07
18 #define AX_CMD_WRITE_MII_REG 0x08
19 #define AX_CMD_SET_HW_MII 0x0a
20 #define AX_CMD_READ_EEPROM 0x0b
21 #define AX_CMD_READ_RX_CTL 0x0f
22 #define AX_CMD_WRITE_RX_CTL 0x10
23 #define AX_CMD_WRITE_IPG0 0x12
24 #define AX_CMD_READ_NODE_ID 0x13
25 #define AX_CMD_WRITE_NODE_ID 0x14
26 #define AX_CMD_READ_PHY_ID 0x19
27 #define AX_CMD_WRITE_MEDIUM_MODE 0x1b
28 #define AX_CMD_WRITE_GPIOS 0x1f
29 #define AX_CMD_SW_RESET 0x20
30 #define AX_CMD_SW_PHY_SELECT 0x22
32 #define AX_SWRESET_CLEAR 0x00
33 #define AX_SWRESET_PRTE 0x04
34 #define AX_SWRESET_PRL 0x08
35 #define AX_SWRESET_IPRL 0x20
36 #define AX_SWRESET_IPPD 0x40
38 #define AX88772_IPG0_DEFAULT 0x15
39 #define AX88772_IPG1_DEFAULT 0x0c
40 #define AX88772_IPG2_DEFAULT 0x12
42 /* AX88772 & AX88178 Medium Mode Register */
43 #define AX_MEDIUM_PF 0x0080
44 #define AX_MEDIUM_JFE 0x0040
45 #define AX_MEDIUM_TFC 0x0020
46 #define AX_MEDIUM_RFC 0x0010
47 #define AX_MEDIUM_ENCK 0x0008
48 #define AX_MEDIUM_AC 0x0004
49 #define AX_MEDIUM_FD 0x0002
50 #define AX_MEDIUM_GM 0x0001
51 #define AX_MEDIUM_SM 0x1000
52 #define AX_MEDIUM_SBP 0x0800
53 #define AX_MEDIUM_PS 0x0200
54 #define AX_MEDIUM_RE 0x0100
56 #define AX88178_MEDIUM_DEFAULT \
57 (AX_MEDIUM_PS | AX_MEDIUM_FD | AX_MEDIUM_AC | \
58 AX_MEDIUM_RFC | AX_MEDIUM_TFC | AX_MEDIUM_JFE | \
61 #define AX88772_MEDIUM_DEFAULT \
62 (AX_MEDIUM_FD | AX_MEDIUM_RFC | \
63 AX_MEDIUM_TFC | AX_MEDIUM_PS | \
64 AX_MEDIUM_AC | AX_MEDIUM_RE)
66 /* AX88772 & AX88178 RX_CTL values */
67 #define AX_RX_CTL_SO 0x0080
68 #define AX_RX_CTL_AB 0x0008
70 #define AX_DEFAULT_RX_CTL \
71 (AX_RX_CTL_SO | AX_RX_CTL_AB)
74 #define AX_GPIO_GPO2EN 0x10 /* GPIO2 Output enable */
75 #define AX_GPIO_GPO_2 0x20 /* GPIO2 Output value */
76 #define AX_GPIO_RSE 0x80 /* Reload serial EEPROM */
79 #define ASIX_BASE_NAME "asx"
80 #define USB_CTRL_SET_TIMEOUT 5000
81 #define USB_CTRL_GET_TIMEOUT 5000
82 #define USB_BULK_SEND_TIMEOUT 5000
83 #define USB_BULK_RECV_TIMEOUT 5000
85 #define AX_RX_URB_SIZE 2048
86 #define PHY_CONNECT_TIMEOUT 5000
88 /* asix_flags defines */
90 #define FLAG_TYPE_AX88172 (1U << 0)
91 #define FLAG_TYPE_AX88772 (1U << 1)
92 #define FLAG_TYPE_AX88772B (1U << 2)
93 #define FLAG_EEPROM_MAC (1U << 3) /* initial mac address in eeprom */
96 static int curr_eth_dev; /* index for name of next device detected */
104 * Asix infrastructure commands
106 static int asix_write_cmd(struct ueth_data *dev, u8 cmd, u16 value, u16 index,
107 u16 size, void *data)
111 debug("asix_write_cmd() cmd=0x%02x value=0x%04x index=0x%04x "
112 "size=%d\n", cmd, value, index, size);
114 len = usb_control_msg(
116 usb_sndctrlpipe(dev->pusb_dev, 0),
118 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
123 USB_CTRL_SET_TIMEOUT);
125 return len == size ? 0 : -1;
128 static int asix_read_cmd(struct ueth_data *dev, u8 cmd, u16 value, u16 index,
129 u16 size, void *data)
133 debug("asix_read_cmd() cmd=0x%02x value=0x%04x index=0x%04x size=%d\n",
134 cmd, value, index, size);
136 len = usb_control_msg(
138 usb_rcvctrlpipe(dev->pusb_dev, 0),
140 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
145 USB_CTRL_GET_TIMEOUT);
146 return len == size ? 0 : -1;
149 static inline int asix_set_sw_mii(struct ueth_data *dev)
153 ret = asix_write_cmd(dev, AX_CMD_SET_SW_MII, 0x0000, 0, 0, NULL);
155 debug("Failed to enable software MII access\n");
159 static inline int asix_set_hw_mii(struct ueth_data *dev)
163 ret = asix_write_cmd(dev, AX_CMD_SET_HW_MII, 0x0000, 0, 0, NULL);
165 debug("Failed to enable hardware MII access\n");
169 static int asix_mdio_read(struct ueth_data *dev, int phy_id, int loc)
171 ALLOC_CACHE_ALIGN_BUFFER(__le16, res, 1);
173 asix_set_sw_mii(dev);
174 asix_read_cmd(dev, AX_CMD_READ_MII_REG, phy_id, (__u16)loc, 2, res);
175 asix_set_hw_mii(dev);
177 debug("asix_mdio_read() phy_id=0x%02x, loc=0x%02x, returns=0x%04x\n",
178 phy_id, loc, le16_to_cpu(*res));
180 return le16_to_cpu(*res);
184 asix_mdio_write(struct ueth_data *dev, int phy_id, int loc, int val)
186 ALLOC_CACHE_ALIGN_BUFFER(__le16, res, 1);
187 *res = cpu_to_le16(val);
189 debug("asix_mdio_write() phy_id=0x%02x, loc=0x%02x, val=0x%04x\n",
191 asix_set_sw_mii(dev);
192 asix_write_cmd(dev, AX_CMD_WRITE_MII_REG, phy_id, (__u16)loc, 2, res);
193 asix_set_hw_mii(dev);
197 * Asix "high level" commands
199 static int asix_sw_reset(struct ueth_data *dev, u8 flags)
203 ret = asix_write_cmd(dev, AX_CMD_SW_RESET, flags, 0, 0, NULL);
205 debug("Failed to send software reset: %02x\n", ret);
212 static inline int asix_get_phy_addr(struct ueth_data *dev)
214 ALLOC_CACHE_ALIGN_BUFFER(u8, buf, 2);
216 int ret = asix_read_cmd(dev, AX_CMD_READ_PHY_ID, 0, 0, 2, buf);
218 debug("asix_get_phy_addr()\n");
221 debug("Error reading PHYID register: %02x\n", ret);
224 debug("asix_get_phy_addr() returning 0x%02x%02x\n", buf[0], buf[1]);
231 static int asix_write_medium_mode(struct ueth_data *dev, u16 mode)
235 debug("asix_write_medium_mode() - mode = 0x%04x\n", mode);
236 ret = asix_write_cmd(dev, AX_CMD_WRITE_MEDIUM_MODE, mode,
239 debug("Failed to write Medium Mode mode to 0x%04x: %02x\n",
245 static u16 asix_read_rx_ctl(struct ueth_data *dev)
247 ALLOC_CACHE_ALIGN_BUFFER(__le16, v, 1);
249 int ret = asix_read_cmd(dev, AX_CMD_READ_RX_CTL, 0, 0, 2, v);
252 debug("Error reading RX_CTL register: %02x\n", ret);
254 ret = le16_to_cpu(*v);
258 static int asix_write_rx_ctl(struct ueth_data *dev, u16 mode)
262 debug("asix_write_rx_ctl() - mode = 0x%04x\n", mode);
263 ret = asix_write_cmd(dev, AX_CMD_WRITE_RX_CTL, mode, 0, 0, NULL);
265 debug("Failed to write RX_CTL mode to 0x%04x: %02x\n",
271 static int asix_write_gpio(struct ueth_data *dev, u16 value, int sleep)
275 debug("asix_write_gpio() - value = 0x%04x\n", value);
276 ret = asix_write_cmd(dev, AX_CMD_WRITE_GPIOS, value, 0, 0, NULL);
278 debug("Failed to write GPIO value 0x%04x: %02x\n",
282 udelay(sleep * 1000);
287 static int asix_write_hwaddr(struct eth_device *eth)
289 struct ueth_data *dev = (struct ueth_data *)eth->priv;
291 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buf, ETH_ALEN);
293 memcpy(buf, eth->enetaddr, ETH_ALEN);
295 ret = asix_write_cmd(dev, AX_CMD_WRITE_NODE_ID, 0, 0, ETH_ALEN, buf);
297 debug("Failed to set MAC address: %02x\n", ret);
307 * mii_nway_restart - restart NWay (autonegotiation) for this interface
309 * Returns 0 on success, negative on error.
311 static int mii_nway_restart(struct ueth_data *dev)
316 /* if autoneg is off, it's an error */
317 bmcr = asix_mdio_read(dev, dev->phy_id, MII_BMCR);
319 if (bmcr & BMCR_ANENABLE) {
320 bmcr |= BMCR_ANRESTART;
321 asix_mdio_write(dev, dev->phy_id, MII_BMCR, bmcr);
328 static int asix_read_mac(struct eth_device *eth)
330 struct ueth_data *dev = (struct ueth_data *)eth->priv;
331 struct asix_private *priv = (struct asix_private *)dev->dev_priv;
333 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buf, ETH_ALEN);
335 if (priv->flags & FLAG_EEPROM_MAC) {
336 for (i = 0; i < (ETH_ALEN >> 1); i++) {
337 if (asix_read_cmd(dev, AX_CMD_READ_EEPROM,
338 0x04 + i, 0, 2, buf) < 0) {
339 debug("Failed to read SROM address 04h.\n");
342 memcpy((eth->enetaddr + i * 2), buf, 2);
345 if (asix_read_cmd(dev, AX_CMD_READ_NODE_ID, 0, 0, ETH_ALEN, buf)
347 debug("Failed to read MAC address.\n");
350 memcpy(eth->enetaddr, buf, ETH_ALEN);
356 static int asix_basic_reset(struct ueth_data *dev)
361 if (asix_write_gpio(dev,
362 AX_GPIO_RSE | AX_GPIO_GPO_2 | AX_GPIO_GPO2EN, 5) < 0)
365 /* 0x10 is the phy id of the embedded 10/100 ethernet phy */
366 embd_phy = ((asix_get_phy_addr(dev) & 0x1f) == 0x10 ? 1 : 0);
367 if (asix_write_cmd(dev, AX_CMD_SW_PHY_SELECT,
368 embd_phy, 0, 0, NULL) < 0) {
369 debug("Select PHY #1 failed\n");
373 if (asix_sw_reset(dev, AX_SWRESET_IPPD | AX_SWRESET_PRL) < 0)
376 if (asix_sw_reset(dev, AX_SWRESET_CLEAR) < 0)
380 if (asix_sw_reset(dev, AX_SWRESET_IPRL) < 0)
383 if (asix_sw_reset(dev, AX_SWRESET_PRTE) < 0)
387 rx_ctl = asix_read_rx_ctl(dev);
388 debug("RX_CTL is 0x%04x after software reset\n", rx_ctl);
389 if (asix_write_rx_ctl(dev, 0x0000) < 0)
392 rx_ctl = asix_read_rx_ctl(dev);
393 debug("RX_CTL is 0x%04x setting to 0x0000\n", rx_ctl);
395 dev->phy_id = asix_get_phy_addr(dev);
397 debug("Failed to read phy id\n");
399 asix_mdio_write(dev, dev->phy_id, MII_BMCR, BMCR_RESET);
400 asix_mdio_write(dev, dev->phy_id, MII_ADVERTISE,
401 ADVERTISE_ALL | ADVERTISE_CSMA);
402 mii_nway_restart(dev);
404 if (asix_write_medium_mode(dev, AX88772_MEDIUM_DEFAULT) < 0)
407 if (asix_write_cmd(dev, AX_CMD_WRITE_IPG0,
408 AX88772_IPG0_DEFAULT | AX88772_IPG1_DEFAULT,
409 AX88772_IPG2_DEFAULT, 0, NULL) < 0) {
410 debug("Write IPG,IPG1,IPG2 failed\n");
420 static int asix_init(struct eth_device *eth, bd_t *bd)
422 struct ueth_data *dev = (struct ueth_data *)eth->priv;
424 #define TIMEOUT_RESOLUTION 50 /* ms */
427 debug("** %s()\n", __func__);
429 if (asix_write_rx_ctl(dev, AX_DEFAULT_RX_CTL) < 0)
433 link_detected = asix_mdio_read(dev, dev->phy_id, MII_BMSR) &
435 if (!link_detected) {
437 printf("Waiting for Ethernet connection... ");
438 udelay(TIMEOUT_RESOLUTION * 1000);
439 timeout += TIMEOUT_RESOLUTION;
441 } while (!link_detected && timeout < PHY_CONNECT_TIMEOUT);
446 printf("unable to connect.\n");
455 static int asix_send(struct eth_device *eth, void *packet, int length)
457 struct ueth_data *dev = (struct ueth_data *)eth->priv;
461 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, msg,
462 PKTSIZE + sizeof(packet_len));
464 debug("** %s(), len %d\n", __func__, length);
466 packet_len = (((length) ^ 0x0000ffff) << 16) + (length);
467 cpu_to_le32s(&packet_len);
469 memcpy(msg, &packet_len, sizeof(packet_len));
470 memcpy(msg + sizeof(packet_len), (void *)packet, length);
472 err = usb_bulk_msg(dev->pusb_dev,
473 usb_sndbulkpipe(dev->pusb_dev, dev->ep_out),
475 length + sizeof(packet_len),
477 USB_BULK_SEND_TIMEOUT);
478 debug("Tx: len = %zu, actual = %u, err = %d\n",
479 length + sizeof(packet_len), actual_len, err);
484 static int asix_recv(struct eth_device *eth)
486 struct ueth_data *dev = (struct ueth_data *)eth->priv;
487 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, recv_buf, AX_RX_URB_SIZE);
488 unsigned char *buf_ptr;
493 debug("** %s()\n", __func__);
495 err = usb_bulk_msg(dev->pusb_dev,
496 usb_rcvbulkpipe(dev->pusb_dev, dev->ep_in),
500 USB_BULK_RECV_TIMEOUT);
501 debug("Rx: len = %u, actual = %u, err = %d\n", AX_RX_URB_SIZE,
504 debug("Rx: failed to receive\n");
507 if (actual_len > AX_RX_URB_SIZE) {
508 debug("Rx: received too many bytes %d\n", actual_len);
513 while (actual_len > 0) {
515 * 1st 4 bytes contain the length of the actual data as two
516 * complementary 16-bit words. Extract the length of the data.
518 if (actual_len < sizeof(packet_len)) {
519 debug("Rx: incomplete packet length\n");
522 memcpy(&packet_len, buf_ptr, sizeof(packet_len));
523 le32_to_cpus(&packet_len);
524 if (((~packet_len >> 16) & 0x7ff) != (packet_len & 0x7ff)) {
525 debug("Rx: malformed packet length: %#x (%#x:%#x)\n",
526 packet_len, (~packet_len >> 16) & 0x7ff,
530 packet_len = packet_len & 0x7ff;
531 if (packet_len > actual_len - sizeof(packet_len)) {
532 debug("Rx: too large packet: %d\n", packet_len);
536 /* Notify net stack */
537 net_process_received_packet(buf_ptr + sizeof(packet_len),
540 /* Adjust for next iteration. Packets are padded to 16-bits */
543 actual_len -= sizeof(packet_len) + packet_len;
544 buf_ptr += sizeof(packet_len) + packet_len;
550 static void asix_halt(struct eth_device *eth)
552 debug("** %s()\n", __func__);
556 * Asix probing functions
558 void asix_eth_before_probe(void)
564 unsigned short vendor;
565 unsigned short product;
569 static const struct asix_dongle asix_dongles[] = {
570 { 0x05ac, 0x1402, FLAG_TYPE_AX88772 }, /* Apple USB Ethernet Adapter */
571 { 0x07d1, 0x3c05, FLAG_TYPE_AX88772 }, /* D-Link DUB-E100 H/W Ver B1 */
572 { 0x2001, 0x1a02, FLAG_TYPE_AX88772 }, /* D-Link DUB-E100 H/W Ver C1 */
573 /* Cables-to-Go USB Ethernet Adapter */
574 { 0x0b95, 0x772a, FLAG_TYPE_AX88772 },
575 { 0x0b95, 0x7720, FLAG_TYPE_AX88772 }, /* Trendnet TU2-ET100 V3.0R */
576 { 0x0b95, 0x1720, FLAG_TYPE_AX88172 }, /* SMC */
577 { 0x0db0, 0xa877, FLAG_TYPE_AX88772 }, /* MSI - ASIX 88772a */
578 { 0x13b1, 0x0018, FLAG_TYPE_AX88172 }, /* Linksys 200M v2.1 */
579 { 0x1557, 0x7720, FLAG_TYPE_AX88772 }, /* 0Q0 cable ethernet */
580 /* DLink DUB-E100 H/W Ver B1 Alternate */
581 { 0x2001, 0x3c05, FLAG_TYPE_AX88772 },
583 { 0x0b95, 0x772b, FLAG_TYPE_AX88772B | FLAG_EEPROM_MAC },
584 { 0x0b95, 0x7e2b, FLAG_TYPE_AX88772B },
585 { 0x0000, 0x0000, FLAG_NONE } /* END - Do not remove */
588 /* Probe to see if a new device is actually an asix device */
589 int asix_eth_probe(struct usb_device *dev, unsigned int ifnum,
590 struct ueth_data *ss)
592 struct usb_interface *iface;
593 struct usb_interface_descriptor *iface_desc;
594 int ep_in_found = 0, ep_out_found = 0;
597 /* let's examine the device now */
598 iface = &dev->config.if_desc[ifnum];
599 iface_desc = &dev->config.if_desc[ifnum].desc;
601 for (i = 0; asix_dongles[i].vendor != 0; i++) {
602 if (dev->descriptor.idVendor == asix_dongles[i].vendor &&
603 dev->descriptor.idProduct == asix_dongles[i].product)
604 /* Found a supported dongle */
608 if (asix_dongles[i].vendor == 0)
611 memset(ss, 0, sizeof(struct ueth_data));
613 /* At this point, we know we've got a live one */
614 debug("\n\nUSB Ethernet device detected: %#04x:%#04x\n",
615 dev->descriptor.idVendor, dev->descriptor.idProduct);
617 /* Initialize the ueth_data structure with some useful info */
620 ss->subclass = iface_desc->bInterfaceSubClass;
621 ss->protocol = iface_desc->bInterfaceProtocol;
623 /* alloc driver private */
624 ss->dev_priv = calloc(1, sizeof(struct asix_private));
628 ((struct asix_private *)ss->dev_priv)->flags = asix_dongles[i].flags;
631 * We are expecting a minimum of 3 endpoints - in, out (bulk), and
632 * int. We will ignore any others.
634 for (i = 0; i < iface_desc->bNumEndpoints; i++) {
635 /* is it an BULK endpoint? */
636 if ((iface->ep_desc[i].bmAttributes &
637 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_BULK) {
638 u8 ep_addr = iface->ep_desc[i].bEndpointAddress;
639 if (ep_addr & USB_DIR_IN) {
641 ss->ep_in = ep_addr &
642 USB_ENDPOINT_NUMBER_MASK;
647 ss->ep_out = ep_addr &
648 USB_ENDPOINT_NUMBER_MASK;
654 /* is it an interrupt endpoint? */
655 if ((iface->ep_desc[i].bmAttributes &
656 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT) {
657 ss->ep_int = iface->ep_desc[i].bEndpointAddress &
658 USB_ENDPOINT_NUMBER_MASK;
659 ss->irqinterval = iface->ep_desc[i].bInterval;
662 debug("Endpoints In %d Out %d Int %d\n",
663 ss->ep_in, ss->ep_out, ss->ep_int);
665 /* Do some basic sanity checks, and bail if we find a problem */
666 if (usb_set_interface(dev, iface_desc->bInterfaceNumber, 0) ||
667 !ss->ep_in || !ss->ep_out || !ss->ep_int) {
668 debug("Problems with device\n");
671 dev->privptr = (void *)ss;
675 int asix_eth_get_info(struct usb_device *dev, struct ueth_data *ss,
676 struct eth_device *eth)
678 struct asix_private *priv = (struct asix_private *)ss->dev_priv;
681 debug("%s: missing parameter.\n", __func__);
684 sprintf(eth->name, "%s%d", ASIX_BASE_NAME, curr_eth_dev++);
685 eth->init = asix_init;
686 eth->send = asix_send;
687 eth->recv = asix_recv;
688 eth->halt = asix_halt;
689 if (!(priv->flags & FLAG_TYPE_AX88172))
690 eth->write_hwaddr = asix_write_hwaddr;
693 if (asix_basic_reset(ss))
696 /* Get the MAC address */
697 if (asix_read_mac(eth))
699 debug("MAC %pM\n", eth->enetaddr);