2 * Copyright (c) 2011 The Chromium OS Authors.
3 * See file CREDITS for list of people who contributed to this
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License as
8 * published by the Free Software Foundation; either version 2 of
9 * the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
24 #include <linux/mii.h>
25 #include "usb_ether.h"
28 /* ASIX AX8817X based USB 2.0 Ethernet Devices */
30 #define AX_CMD_SET_SW_MII 0x06
31 #define AX_CMD_READ_MII_REG 0x07
32 #define AX_CMD_WRITE_MII_REG 0x08
33 #define AX_CMD_SET_HW_MII 0x0a
34 #define AX_CMD_READ_RX_CTL 0x0f
35 #define AX_CMD_WRITE_RX_CTL 0x10
36 #define AX_CMD_WRITE_IPG0 0x12
37 #define AX_CMD_READ_NODE_ID 0x13
38 #define AX_CMD_READ_PHY_ID 0x19
39 #define AX_CMD_WRITE_MEDIUM_MODE 0x1b
40 #define AX_CMD_WRITE_GPIOS 0x1f
41 #define AX_CMD_SW_RESET 0x20
42 #define AX_CMD_SW_PHY_SELECT 0x22
44 #define AX_SWRESET_CLEAR 0x00
45 #define AX_SWRESET_PRTE 0x04
46 #define AX_SWRESET_PRL 0x08
47 #define AX_SWRESET_IPRL 0x20
48 #define AX_SWRESET_IPPD 0x40
50 #define AX88772_IPG0_DEFAULT 0x15
51 #define AX88772_IPG1_DEFAULT 0x0c
52 #define AX88772_IPG2_DEFAULT 0x12
54 /* AX88772 & AX88178 Medium Mode Register */
55 #define AX_MEDIUM_PF 0x0080
56 #define AX_MEDIUM_JFE 0x0040
57 #define AX_MEDIUM_TFC 0x0020
58 #define AX_MEDIUM_RFC 0x0010
59 #define AX_MEDIUM_ENCK 0x0008
60 #define AX_MEDIUM_AC 0x0004
61 #define AX_MEDIUM_FD 0x0002
62 #define AX_MEDIUM_GM 0x0001
63 #define AX_MEDIUM_SM 0x1000
64 #define AX_MEDIUM_SBP 0x0800
65 #define AX_MEDIUM_PS 0x0200
66 #define AX_MEDIUM_RE 0x0100
68 #define AX88178_MEDIUM_DEFAULT \
69 (AX_MEDIUM_PS | AX_MEDIUM_FD | AX_MEDIUM_AC | \
70 AX_MEDIUM_RFC | AX_MEDIUM_TFC | AX_MEDIUM_JFE | \
73 #define AX88772_MEDIUM_DEFAULT \
74 (AX_MEDIUM_FD | AX_MEDIUM_RFC | \
75 AX_MEDIUM_TFC | AX_MEDIUM_PS | \
76 AX_MEDIUM_AC | AX_MEDIUM_RE)
78 /* AX88772 & AX88178 RX_CTL values */
79 #define AX_RX_CTL_SO 0x0080
80 #define AX_RX_CTL_AB 0x0008
82 #define AX_DEFAULT_RX_CTL \
83 (AX_RX_CTL_SO | AX_RX_CTL_AB)
86 #define AX_GPIO_GPO2EN 0x10 /* GPIO2 Output enable */
87 #define AX_GPIO_GPO_2 0x20 /* GPIO2 Output value */
88 #define AX_GPIO_RSE 0x80 /* Reload serial EEPROM */
91 #define ASIX_BASE_NAME "asx"
92 #define USB_CTRL_SET_TIMEOUT 5000
93 #define USB_CTRL_GET_TIMEOUT 5000
94 #define USB_BULK_SEND_TIMEOUT 5000
95 #define USB_BULK_RECV_TIMEOUT 5000
97 #define AX_RX_URB_SIZE 2048
98 #define PHY_CONNECT_TIMEOUT 5000
101 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);
292 * mii_nway_restart - restart NWay (autonegotiation) for this interface
294 * Returns 0 on success, negative on error.
296 static int mii_nway_restart(struct ueth_data *dev)
301 /* if autoneg is off, it's an error */
302 bmcr = asix_mdio_read(dev, dev->phy_id, MII_BMCR);
304 if (bmcr & BMCR_ANENABLE) {
305 bmcr |= BMCR_ANRESTART;
306 asix_mdio_write(dev, dev->phy_id, MII_BMCR, bmcr);
313 static int asix_basic_reset(struct ueth_data *dev)
318 if (asix_write_gpio(dev,
319 AX_GPIO_RSE | AX_GPIO_GPO_2 | AX_GPIO_GPO2EN, 5) < 0)
322 /* 0x10 is the phy id of the embedded 10/100 ethernet phy */
323 embd_phy = ((asix_get_phy_addr(dev) & 0x1f) == 0x10 ? 1 : 0);
324 if (asix_write_cmd(dev, AX_CMD_SW_PHY_SELECT,
325 embd_phy, 0, 0, NULL) < 0) {
326 debug("Select PHY #1 failed\n");
330 if (asix_sw_reset(dev, AX_SWRESET_IPPD | AX_SWRESET_PRL) < 0)
333 if (asix_sw_reset(dev, AX_SWRESET_CLEAR) < 0)
337 if (asix_sw_reset(dev, AX_SWRESET_IPRL) < 0)
340 if (asix_sw_reset(dev, AX_SWRESET_PRTE) < 0)
344 rx_ctl = asix_read_rx_ctl(dev);
345 debug("RX_CTL is 0x%04x after software reset\n", rx_ctl);
346 if (asix_write_rx_ctl(dev, 0x0000) < 0)
349 rx_ctl = asix_read_rx_ctl(dev);
350 debug("RX_CTL is 0x%04x setting to 0x0000\n", rx_ctl);
358 static int asix_init(struct eth_device *eth, bd_t *bd)
360 struct ueth_data *dev = (struct ueth_data *)eth->priv;
362 #define TIMEOUT_RESOLUTION 50 /* ms */
365 debug("** %s()\n", __func__);
367 /* Get the MAC address */
368 if (asix_read_cmd(dev, AX_CMD_READ_NODE_ID,
369 0, 0, ETH_ALEN, buf) < 0) {
370 debug("Failed to read MAC address.\n");
373 memcpy(eth->enetaddr, buf, ETH_ALEN);
374 debug("MAC %02x:%02x:%02x:%02x:%02x:%02x\n",
375 eth->enetaddr[0], eth->enetaddr[1],
376 eth->enetaddr[2], eth->enetaddr[3],
377 eth->enetaddr[4], eth->enetaddr[5]);
379 dev->phy_id = asix_get_phy_addr(dev);
381 debug("Failed to read phy id\n");
383 if (asix_sw_reset(dev, AX_SWRESET_PRL) < 0)
386 if (asix_sw_reset(dev, AX_SWRESET_IPRL | AX_SWRESET_PRL) < 0)
389 asix_mdio_write(dev, dev->phy_id, MII_BMCR, BMCR_RESET);
390 asix_mdio_write(dev, dev->phy_id, MII_ADVERTISE,
391 ADVERTISE_ALL | ADVERTISE_CSMA);
392 mii_nway_restart(dev);
394 if (asix_write_medium_mode(dev, AX88772_MEDIUM_DEFAULT) < 0)
397 if (asix_write_cmd(dev, AX_CMD_WRITE_IPG0,
398 AX88772_IPG0_DEFAULT | AX88772_IPG1_DEFAULT,
399 AX88772_IPG2_DEFAULT, 0, NULL) < 0) {
400 debug("Write IPG,IPG1,IPG2 failed\n");
404 if (asix_write_rx_ctl(dev, AX_DEFAULT_RX_CTL) < 0)
408 link_detected = asix_mdio_read(dev, dev->phy_id, MII_BMSR) &
410 if (!link_detected) {
412 printf("Waiting for Ethernet connection... ");
413 udelay(TIMEOUT_RESOLUTION * 1000);
414 timeout += TIMEOUT_RESOLUTION;
416 } while (!link_detected && timeout < PHY_CONNECT_TIMEOUT);
421 printf("unable to connect.\n");
430 static int asix_send(struct eth_device *eth, void *packet, int length)
432 struct ueth_data *dev = (struct ueth_data *)eth->priv;
436 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, msg,
437 PKTSIZE + sizeof(packet_len));
439 debug("** %s(), len %d\n", __func__, length);
441 packet_len = (((length) ^ 0x0000ffff) << 16) + (length);
442 cpu_to_le32s(&packet_len);
444 memcpy(msg, &packet_len, sizeof(packet_len));
445 memcpy(msg + sizeof(packet_len), (void *)packet, length);
449 err = usb_bulk_msg(dev->pusb_dev,
450 usb_sndbulkpipe(dev->pusb_dev, dev->ep_out),
452 length + sizeof(packet_len),
454 USB_BULK_SEND_TIMEOUT);
455 debug("Tx: len = %u, actual = %u, err = %d\n",
456 length + sizeof(packet_len), actual_len, err);
461 static int asix_recv(struct eth_device *eth)
463 struct ueth_data *dev = (struct ueth_data *)eth->priv;
464 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, recv_buf, AX_RX_URB_SIZE);
465 unsigned char *buf_ptr;
470 debug("** %s()\n", __func__);
472 err = usb_bulk_msg(dev->pusb_dev,
473 usb_rcvbulkpipe(dev->pusb_dev, dev->ep_in),
477 USB_BULK_RECV_TIMEOUT);
478 debug("Rx: len = %u, actual = %u, err = %d\n", AX_RX_URB_SIZE,
481 debug("Rx: failed to receive\n");
484 if (actual_len > AX_RX_URB_SIZE) {
485 debug("Rx: received too many bytes %d\n", actual_len);
490 while (actual_len > 0) {
492 * 1st 4 bytes contain the length of the actual data as two
493 * complementary 16-bit words. Extract the length of the data.
495 if (actual_len < sizeof(packet_len)) {
496 debug("Rx: incomplete packet length\n");
499 memcpy(&packet_len, buf_ptr, sizeof(packet_len));
500 le32_to_cpus(&packet_len);
501 if (((packet_len >> 16) ^ 0xffff) != (packet_len & 0xffff)) {
502 debug("Rx: malformed packet length: %#x (%#x:%#x)\n",
503 packet_len, (packet_len >> 16) ^ 0xffff,
504 packet_len & 0xffff);
507 packet_len = packet_len & 0xffff;
508 if (packet_len > actual_len - sizeof(packet_len)) {
509 debug("Rx: too large packet: %d\n", packet_len);
513 /* Notify net stack */
514 NetReceive(buf_ptr + sizeof(packet_len), packet_len);
516 /* Adjust for next iteration. Packets are padded to 16-bits */
519 actual_len -= sizeof(packet_len) + packet_len;
520 buf_ptr += sizeof(packet_len) + packet_len;
526 static void asix_halt(struct eth_device *eth)
528 debug("** %s()\n", __func__);
532 * Asix probing functions
534 void asix_eth_before_probe(void)
540 unsigned short vendor;
541 unsigned short product;
544 static struct asix_dongle asix_dongles[] = {
545 { 0x05ac, 0x1402 }, /* Apple USB Ethernet Adapter */
546 { 0x07d1, 0x3c05 }, /* D-Link DUB-E100 H/W Ver B1 */
547 { 0x0b95, 0x772a }, /* Cables-to-Go USB Ethernet Adapter */
548 { 0x0b95, 0x7720 }, /* Trendnet TU2-ET100 V3.0R */
549 { 0x0b95, 0x1720 }, /* SMC */
550 { 0x0db0, 0xa877 }, /* MSI - ASIX 88772a */
551 { 0x13b1, 0x0018 }, /* Linksys 200M v2.1 */
552 { 0x1557, 0x7720 }, /* 0Q0 cable ethernet */
553 { 0x2001, 0x3c05 }, /* DLink DUB-E100 H/W Ver B1 Alternate */
554 { 0x0000, 0x0000 } /* END - Do not remove */
557 /* Probe to see if a new device is actually an asix device */
558 int asix_eth_probe(struct usb_device *dev, unsigned int ifnum,
559 struct ueth_data *ss)
561 struct usb_interface *iface;
562 struct usb_interface_descriptor *iface_desc;
565 /* let's examine the device now */
566 iface = &dev->config.if_desc[ifnum];
567 iface_desc = &dev->config.if_desc[ifnum].desc;
569 for (i = 0; asix_dongles[i].vendor != 0; i++) {
570 if (dev->descriptor.idVendor == asix_dongles[i].vendor &&
571 dev->descriptor.idProduct == asix_dongles[i].product)
572 /* Found a supported dongle */
576 if (asix_dongles[i].vendor == 0)
579 memset(ss, 0, sizeof(struct ueth_data));
581 /* At this point, we know we've got a live one */
582 debug("\n\nUSB Ethernet device detected: %#04x:%#04x\n",
583 dev->descriptor.idVendor, dev->descriptor.idProduct);
585 /* Initialize the ueth_data structure with some useful info */
588 ss->subclass = iface_desc->bInterfaceSubClass;
589 ss->protocol = iface_desc->bInterfaceProtocol;
592 * We are expecting a minimum of 3 endpoints - in, out (bulk), and
593 * int. We will ignore any others.
595 for (i = 0; i < iface_desc->bNumEndpoints; i++) {
596 /* is it an BULK endpoint? */
597 if ((iface->ep_desc[i].bmAttributes &
598 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_BULK) {
599 if (iface->ep_desc[i].bEndpointAddress & USB_DIR_IN)
600 ss->ep_in = iface->ep_desc[i].bEndpointAddress &
601 USB_ENDPOINT_NUMBER_MASK;
604 iface->ep_desc[i].bEndpointAddress &
605 USB_ENDPOINT_NUMBER_MASK;
608 /* is it an interrupt endpoint? */
609 if ((iface->ep_desc[i].bmAttributes &
610 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT) {
611 ss->ep_int = iface->ep_desc[i].bEndpointAddress &
612 USB_ENDPOINT_NUMBER_MASK;
613 ss->irqinterval = iface->ep_desc[i].bInterval;
616 debug("Endpoints In %d Out %d Int %d\n",
617 ss->ep_in, ss->ep_out, ss->ep_int);
619 /* Do some basic sanity checks, and bail if we find a problem */
620 if (usb_set_interface(dev, iface_desc->bInterfaceNumber, 0) ||
621 !ss->ep_in || !ss->ep_out || !ss->ep_int) {
622 debug("Problems with device\n");
625 dev->privptr = (void *)ss;
629 int asix_eth_get_info(struct usb_device *dev, struct ueth_data *ss,
630 struct eth_device *eth)
633 debug("%s: missing parameter.\n", __func__);
636 sprintf(eth->name, "%s%d", ASIX_BASE_NAME, curr_eth_dev++);
637 eth->init = asix_init;
638 eth->send = asix_send;
639 eth->recv = asix_recv;
640 eth->halt = asix_halt;
643 if (asix_basic_reset(ss))