Home | History | Annotate | Line # | Download | only in usb
if_axen.c revision 1.71
      1 /*	$NetBSD: if_axen.c,v 1.71 2020/03/13 18:17:40 christos Exp $	*/
      2 /*	$OpenBSD: if_axen.c,v 1.3 2013/10/21 10:10:22 yuo Exp $	*/
      3 
      4 /*
      5  * Copyright (c) 2013 Yojiro UO <yuo (at) openbsd.org>
      6  *
      7  * Permission to use, copy, modify, and distribute this software for any
      8  * purpose with or without fee is hereby granted, provided that the above
      9  * copyright notice and this permission notice appear in all copies.
     10  *
     11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
     12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
     13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
     14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
     15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
     16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
     17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
     18  */
     19 
     20 /*
     21  * ASIX Electronics AX88178a USB 2.0 ethernet and AX88179 USB 3.0 Ethernet
     22  * driver.
     23  */
     24 
     25 #include <sys/cdefs.h>
     26 __KERNEL_RCSID(0, "$NetBSD: if_axen.c,v 1.71 2020/03/13 18:17:40 christos Exp $");
     27 
     28 #ifdef _KERNEL_OPT
     29 #include "opt_usb.h"
     30 #endif
     31 
     32 #include <sys/param.h>
     33 
     34 #include <netinet/in.h>		/* XXX for netinet/ip.h */
     35 #include <netinet/ip.h>		/* XXX for IP_MAXPACKET */
     36 
     37 #include <dev/usb/usbnet.h>
     38 
     39 #include <dev/usb/if_axenreg.h>
     40 
     41 #ifdef AXEN_DEBUG
     42 #define DPRINTF(x)	do { if (axendebug) printf x; } while (/*CONSTCOND*/0)
     43 #define DPRINTFN(n, x)	do { if (axendebug >= (n)) printf x; } while (/*CONSTCOND*/0)
     44 int	axendebug = 0;
     45 #else
     46 #define DPRINTF(x)
     47 #define DPRINTFN(n, x)
     48 #endif
     49 
     50 struct axen_type {
     51 	struct usb_devno	axen_devno;
     52 	uint16_t		axen_flags;
     53 #define AX178A	0x0001		/* AX88178a */
     54 #define AX179	0x0002		/* AX88179 */
     55 };
     56 
     57 /*
     58  * Various supported device vendors/products.
     59  */
     60 static const struct axen_type axen_devs[] = {
     61 #if 0 /* not tested */
     62 	{ { USB_VENDOR_ASIX, USB_PRODUCT_ASIX_AX88178A}, AX178A },
     63 #endif
     64 	{ { USB_VENDOR_ASIX, USB_PRODUCT_ASIX_AX88179}, AX179 },
     65 	{ { USB_VENDOR_DLINK, USB_PRODUCT_DLINK_DUB1312}, AX179 }
     66 };
     67 
     68 #define axen_lookup(v, p) ((const struct axen_type *)usb_lookup(axen_devs, v, p))
     69 
     70 static int	axen_match(device_t, cfdata_t, void *);
     71 static void	axen_attach(device_t, device_t, void *);
     72 
     73 CFATTACH_DECL_NEW(axen, sizeof(struct usbnet),
     74 	axen_match, axen_attach, usbnet_detach, usbnet_activate);
     75 
     76 static int	axen_cmd(struct usbnet *, int, int, int, void *);
     77 static void	axen_reset(struct usbnet *);
     78 static int	axen_get_eaddr(struct usbnet *, void *);
     79 static void	axen_ax88179_init(struct usbnet *);
     80 
     81 static void	axen_stop_cb(struct ifnet *, int);
     82 static int	axen_ioctl_cb(struct ifnet *, u_long, void *);
     83 static int	axen_mii_read_reg(struct usbnet *, int, int, uint16_t *);
     84 static int	axen_mii_write_reg(struct usbnet *, int, int, uint16_t);
     85 static void	axen_mii_statchg(struct ifnet *);
     86 static void	axen_rx_loop(struct usbnet *, struct usbnet_chain *, uint32_t);
     87 static unsigned	axen_tx_prepare(struct usbnet *, struct mbuf *,
     88 			        struct usbnet_chain *);
     89 static int	axen_init(struct ifnet *);
     90 
     91 static const struct usbnet_ops axen_ops = {
     92 	.uno_stop = axen_stop_cb,
     93 	.uno_ioctl = axen_ioctl_cb,
     94 	.uno_read_reg = axen_mii_read_reg,
     95 	.uno_write_reg = axen_mii_write_reg,
     96 	.uno_statchg = axen_mii_statchg,
     97 	.uno_tx_prepare = axen_tx_prepare,
     98 	.uno_rx_loop = axen_rx_loop,
     99 	.uno_init = axen_init,
    100 };
    101 
    102 static int
    103 axen_cmd(struct usbnet *un, int cmd, int index, int val, void *buf)
    104 {
    105 	usb_device_request_t req;
    106 	usbd_status err;
    107 
    108 	usbnet_isowned_mii(un);
    109 
    110 	if (usbnet_isdying(un))
    111 		return 0;
    112 
    113 	if (AXEN_CMD_DIR(cmd))
    114 		req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
    115 	else
    116 		req.bmRequestType = UT_READ_VENDOR_DEVICE;
    117 	req.bRequest = AXEN_CMD_CMD(cmd);
    118 	USETW(req.wValue, val);
    119 	USETW(req.wIndex, index);
    120 	USETW(req.wLength, AXEN_CMD_LEN(cmd));
    121 
    122 	err = usbd_do_request(un->un_udev, &req, buf);
    123 	DPRINTFN(5, ("axen_cmd: cmd %#04x val %#04x len %d\n",
    124 	    cmd, val, AXEN_CMD_LEN(cmd)));
    125 
    126 	if (err) {
    127 		DPRINTF(("%s: cmd: %d, error: %d\n", __func__, cmd, err));
    128 		return -1;
    129 	}
    130 
    131 	return 0;
    132 }
    133 
    134 static int
    135 axen_mii_read_reg(struct usbnet *un, int phy, int reg, uint16_t *val)
    136 {
    137 	uint16_t data;
    138 
    139 	if (un->un_phyno != phy)
    140 		return EINVAL;
    141 
    142 	usbd_status err = axen_cmd(un, AXEN_CMD_MII_READ_REG, reg, phy, &data);
    143 	if (err)
    144 		return EIO;
    145 
    146 	*val = le16toh(data);
    147 	if (reg == MII_BMSR)
    148 		*val &= ~BMSR_EXTCAP;
    149 
    150 	return 0;
    151 }
    152 
    153 static int
    154 axen_mii_write_reg(struct usbnet *un, int phy, int reg, uint16_t val)
    155 {
    156 	uint16_t uval = htole16(val);
    157 
    158 	if (un->un_phyno != phy)
    159 		return EINVAL;
    160 
    161 	usbd_status err = axen_cmd(un, AXEN_CMD_MII_WRITE_REG, reg, phy, &uval);
    162 	if (err)
    163 		return EIO;
    164 
    165 	return 0;
    166 }
    167 
    168 static void
    169 axen_mii_statchg(struct ifnet *ifp)
    170 {
    171 	struct usbnet * const un = ifp->if_softc;
    172 	struct mii_data * const mii = usbnet_mii(un);
    173 	int err;
    174 	uint16_t val;
    175 	uint16_t wval;
    176 
    177 	if (usbnet_isdying(un))
    178 		return;
    179 
    180 	if ((mii->mii_media_status & (IFM_ACTIVE | IFM_AVALID)) ==
    181 	    (IFM_ACTIVE | IFM_AVALID)) {
    182 		switch (IFM_SUBTYPE(mii->mii_media_active)) {
    183 		case IFM_10_T:
    184 		case IFM_100_TX:
    185 			usbnet_set_link(un, true);
    186 			break;
    187 		case IFM_1000_T:
    188 			usbnet_set_link(un, true);
    189 			break;
    190 		default:
    191 			break;
    192 		}
    193 	}
    194 
    195 	/* Lost link, do nothing. */
    196 	if (!usbnet_havelink(un))
    197 		return;
    198 
    199 	val = 0;
    200 	if ((mii->mii_media_active & IFM_FDX) != 0)
    201 		val |= AXEN_MEDIUM_FDX;
    202 
    203 	val |= AXEN_MEDIUM_RXFLOW_CTRL_EN | AXEN_MEDIUM_TXFLOW_CTRL_EN |
    204 	    AXEN_MEDIUM_RECV_EN;
    205 	switch (IFM_SUBTYPE(mii->mii_media_active)) {
    206 	case IFM_1000_T:
    207 		val |= AXEN_MEDIUM_GIGA | AXEN_MEDIUM_EN_125MHZ;
    208 		break;
    209 	case IFM_100_TX:
    210 		val |= AXEN_MEDIUM_PS;
    211 		break;
    212 	case IFM_10_T:
    213 		/* doesn't need to be handled */
    214 		break;
    215 	}
    216 
    217 	DPRINTF(("%s: val=%#x\n", __func__, val));
    218 	wval = htole16(val);
    219 	usbnet_lock_mii(un);
    220 	err = axen_cmd(un, AXEN_CMD_MAC_WRITE2, 2, AXEN_MEDIUM_STATUS, &wval);
    221 	usbnet_unlock_mii(un);
    222 	if (err)
    223 		aprint_error_dev(un->un_dev, "media change failed\n");
    224 }
    225 
    226 static void
    227 axen_setiff_locked(struct usbnet *un)
    228 {
    229 	struct ifnet * const ifp = usbnet_ifp(un);
    230 	struct ethercom *ec = usbnet_ec(un);
    231 	struct ether_multi *enm;
    232 	struct ether_multistep step;
    233 	uint32_t h = 0;
    234 	uint16_t rxmode;
    235 	uint8_t hashtbl[8] = { 0, 0, 0, 0, 0, 0, 0, 0 };
    236 	uint16_t wval;
    237 
    238 	if (usbnet_isdying(un))
    239 		return;
    240 
    241 	usbnet_isowned_mii(un);
    242 
    243 	rxmode = 0;
    244 
    245 	/* Enable receiver, set RX mode */
    246 	axen_cmd(un, AXEN_CMD_MAC_READ2, 2, AXEN_MAC_RXCTL, &wval);
    247 	rxmode = le16toh(wval);
    248 	rxmode &= ~(AXEN_RXCTL_ACPT_ALL_MCAST | AXEN_RXCTL_PROMISC |
    249 	    AXEN_RXCTL_ACPT_MCAST);
    250 
    251 	if (ifp->if_flags & IFF_PROMISC) {
    252 		DPRINTF(("%s: promisc\n", device_xname(un->un_dev)));
    253 		rxmode |= AXEN_RXCTL_PROMISC;
    254 allmulti:
    255 		ETHER_LOCK(ec);
    256 		ec->ec_flags |= ETHER_F_ALLMULTI;
    257 		ETHER_UNLOCK(ec);
    258 		rxmode |= AXEN_RXCTL_ACPT_ALL_MCAST
    259 		/* | AXEN_RXCTL_ACPT_PHY_MCAST */;
    260 	} else {
    261 		/* now program new ones */
    262 		DPRINTF(("%s: initializing hash table\n",
    263 		    device_xname(un->un_dev)));
    264 		ETHER_LOCK(ec);
    265 		ec->ec_flags &= ~ETHER_F_ALLMULTI;
    266 
    267 		ETHER_FIRST_MULTI(step, ec, enm);
    268 		while (enm != NULL) {
    269 			if (memcmp(enm->enm_addrlo, enm->enm_addrhi,
    270 			    ETHER_ADDR_LEN)) {
    271 				DPRINTF(("%s: allmulti\n",
    272 				    device_xname(un->un_dev)));
    273 				memset(hashtbl, 0, sizeof(hashtbl));
    274 				ETHER_UNLOCK(ec);
    275 				goto allmulti;
    276 			}
    277 			h = ether_crc32_be(enm->enm_addrlo,
    278 			    ETHER_ADDR_LEN) >> 26;
    279 			hashtbl[h / 8] |= 1 << (h % 8);
    280 			DPRINTF(("%s: %s added\n",
    281 			    device_xname(un->un_dev),
    282 			    ether_sprintf(enm->enm_addrlo)));
    283 			ETHER_NEXT_MULTI(step, enm);
    284 		}
    285 		ETHER_UNLOCK(ec);
    286 		rxmode |= AXEN_RXCTL_ACPT_MCAST;
    287 	}
    288 
    289 	axen_cmd(un, AXEN_CMD_MAC_WRITE_FILTER, 8, AXEN_FILTER_MULTI, hashtbl);
    290 	wval = htole16(rxmode);
    291 	axen_cmd(un, AXEN_CMD_MAC_WRITE2, 2, AXEN_MAC_RXCTL, &wval);
    292 }
    293 
    294 static void
    295 axen_setiff(struct usbnet *un)
    296 {
    297 	usbnet_lock_mii(un);
    298 	axen_setiff_locked(un);
    299 	usbnet_unlock_mii(un);
    300 }
    301 
    302 static void
    303 axen_reset(struct usbnet *un)
    304 {
    305 	usbnet_isowned(un);
    306 	if (usbnet_isdying(un))
    307 		return;
    308 	/* XXX What to reset? */
    309 
    310 	/* Wait a little while for the chip to get its brains in order. */
    311 	DELAY(1000);
    312 }
    313 
    314 static int
    315 axen_get_eaddr(struct usbnet *un, void *addr)
    316 {
    317 #if 1
    318 	return axen_cmd(un, AXEN_CMD_MAC_READ_ETHER, 6, AXEN_CMD_MAC_NODE_ID,
    319 	    addr);
    320 #else
    321 	int i, retry;
    322 	uint8_t eeprom[20];
    323 	uint16_t csum;
    324 	uint16_t buf;
    325 
    326 	for (i = 0; i < 6; i++) {
    327 		/* set eeprom address */
    328 		buf = htole16(i);
    329 		axen_cmd(un, AXEN_CMD_MAC_WRITE, 1, AXEN_MAC_EEPROM_ADDR, &buf);
    330 
    331 		/* set eeprom command */
    332 		buf = htole16(AXEN_EEPROM_READ);
    333 		axen_cmd(un, AXEN_CMD_MAC_WRITE, 1, AXEN_MAC_EEPROM_CMD, &buf);
    334 
    335 		/* check the value is ready */
    336 		retry = 3;
    337 		do {
    338 			buf = htole16(AXEN_EEPROM_READ);
    339 			usbd_delay_ms(un->un_udev, 10);
    340 			axen_cmd(un, AXEN_CMD_MAC_READ, 1, AXEN_MAC_EEPROM_CMD,
    341 			    &buf);
    342 			retry--;
    343 			if (retry < 0)
    344 				return EINVAL;
    345 		} while ((le16toh(buf) & 0xff) & AXEN_EEPROM_BUSY);
    346 
    347 		/* read data */
    348 		axen_cmd(un, AXEN_CMD_MAC_READ2, 2, AXEN_EEPROM_READ,
    349 		    &eeprom[i * 2]);
    350 
    351 		/* sanity check */
    352 		if ((i == 0) && (eeprom[0] == 0xff))
    353 			return EINVAL;
    354 	}
    355 
    356 	/* check checksum */
    357 	csum = eeprom[6] + eeprom[7] + eeprom[8] + eeprom[9];
    358 	csum = (csum >> 8) + (csum & 0xff) + eeprom[10];
    359 	if (csum != 0xff) {
    360 		printf("eeprom checksum mismatch(%#02x)\n", csum);
    361 		return EINVAL;
    362 	}
    363 
    364 	memcpy(addr, eeprom, ETHER_ADDR_LEN);
    365 	return 0;
    366 #endif
    367 }
    368 
    369 static void
    370 axen_ax88179_init(struct usbnet *un)
    371 {
    372 	struct axen_qctrl qctrl;
    373 	uint16_t ctl, temp;
    374 	uint16_t wval;
    375 	uint8_t val;
    376 
    377 	usbnet_lock_mii(un);
    378 
    379 	/* XXX: ? */
    380 	axen_cmd(un, AXEN_CMD_MAC_READ, 1, AXEN_UNK_05, &val);
    381 	DPRINTFN(5, ("AXEN_CMD_MAC_READ(0x05): %#02x\n", val));
    382 
    383 	/* check AX88179 version, UA1 / UA2 */
    384 	axen_cmd(un, AXEN_CMD_MAC_READ, 1, AXEN_GENERAL_STATUS, &val);
    385 	/* UA1 */
    386 	if (!(val & AXEN_GENERAL_STATUS_MASK)) {
    387 		DPRINTF(("AX88179 ver. UA1\n"));
    388 	} else {
    389 		DPRINTF(("AX88179 ver. UA2\n"));
    390 	}
    391 
    392 	/* power up ethernet PHY */
    393 	wval = htole16(0);
    394 	axen_cmd(un, AXEN_CMD_MAC_WRITE2, 2, AXEN_PHYPWR_RSTCTL, &wval);
    395 
    396 	wval = htole16(AXEN_PHYPWR_RSTCTL_IPRL);
    397 	axen_cmd(un, AXEN_CMD_MAC_WRITE2, 2, AXEN_PHYPWR_RSTCTL, &wval);
    398 	usbd_delay_ms(un->un_udev, 200);
    399 
    400 	/* set clock mode */
    401 	val = AXEN_PHYCLK_ACS | AXEN_PHYCLK_BCS;
    402 	axen_cmd(un, AXEN_CMD_MAC_WRITE, 1, AXEN_PHYCLK, &val);
    403 	usbd_delay_ms(un->un_udev, 100);
    404 
    405 	/* set monitor mode (disable) */
    406 	val = AXEN_MONITOR_NONE;
    407 	axen_cmd(un, AXEN_CMD_MAC_WRITE, 1, AXEN_MONITOR_MODE, &val);
    408 
    409 	/* enable auto detach */
    410 	axen_cmd(un, AXEN_CMD_EEPROM_READ, 2, AXEN_EEPROM_STAT, &wval);
    411 	temp = le16toh(wval);
    412 	DPRINTFN(2,("EEPROM0x43 = %#04x\n", temp));
    413 	if (!(temp == 0xffff) && !(temp & 0x0100)) {
    414 		/* Enable auto detach bit */
    415 		val = 0;
    416 		axen_cmd(un, AXEN_CMD_MAC_WRITE, 1, AXEN_PHYCLK, &val);
    417 		val = AXEN_PHYCLK_ULR;
    418 		axen_cmd(un, AXEN_CMD_MAC_WRITE, 1, AXEN_PHYCLK, &val);
    419 		usbd_delay_ms(un->un_udev, 100);
    420 
    421 		axen_cmd(un, AXEN_CMD_MAC_READ2, 2, AXEN_PHYPWR_RSTCTL, &wval);
    422 		ctl = le16toh(wval);
    423 		ctl |= AXEN_PHYPWR_RSTCTL_AUTODETACH;
    424 		wval = htole16(ctl);
    425 		axen_cmd(un, AXEN_CMD_MAC_WRITE2, 2, AXEN_PHYPWR_RSTCTL, &wval);
    426 		usbd_delay_ms(un->un_udev, 200);
    427 		aprint_error_dev(un->un_dev, "enable auto detach (%#04x)\n",
    428 		    ctl);
    429 	}
    430 
    431 	/* bulkin queue setting */
    432 	axen_cmd(un, AXEN_CMD_MAC_READ, 1, AXEN_USB_UPLINK, &val);
    433 	switch (val) {
    434 	case AXEN_USB_FS:
    435 		DPRINTF(("uplink: USB1.1\n"));
    436 		qctrl.ctrl	 = 0x07;
    437 		qctrl.timer_low	 = 0xcc;
    438 		qctrl.timer_high = 0x4c;
    439 		qctrl.bufsize	 = AXEN_BUFSZ_LS - 1;
    440 		qctrl.ifg	 = 0x08;
    441 		break;
    442 	case AXEN_USB_HS:
    443 		DPRINTF(("uplink: USB2.0\n"));
    444 		qctrl.ctrl	 = 0x07;
    445 		qctrl.timer_low	 = 0x02;
    446 		qctrl.timer_high = 0xa0;
    447 		qctrl.bufsize	 = AXEN_BUFSZ_HS - 1;
    448 		qctrl.ifg	 = 0xff;
    449 		break;
    450 	case AXEN_USB_SS:
    451 		DPRINTF(("uplink: USB3.0\n"));
    452 		qctrl.ctrl	 = 0x07;
    453 		qctrl.timer_low	 = 0x4f;
    454 		qctrl.timer_high = 0x00;
    455 		qctrl.bufsize	 = AXEN_BUFSZ_SS - 1;
    456 		qctrl.ifg	 = 0xff;
    457 		break;
    458 	default:
    459 		aprint_error_dev(un->un_dev, "unknown uplink bus:%#02x\n",
    460 		    val);
    461 		usbnet_unlock_mii(un);
    462 		return;
    463 	}
    464 	axen_cmd(un, AXEN_CMD_MAC_SET_RXSR, 5, AXEN_RX_BULKIN_QCTRL, &qctrl);
    465 
    466 	/*
    467 	 * set buffer high/low watermark to pause/resume.
    468 	 * write 2byte will set high/log simultaneous with AXEN_PAUSE_HIGH.
    469 	 * XXX: what is the best value? OSX driver uses 0x3c-0x4c as LOW-HIGH
    470 	 * watermark parameters.
    471 	 */
    472 	val = 0x34;
    473 	axen_cmd(un, AXEN_CMD_MAC_WRITE, 1, AXEN_PAUSE_LOW_WATERMARK, &val);
    474 	val = 0x52;
    475 	axen_cmd(un, AXEN_CMD_MAC_WRITE, 1, AXEN_PAUSE_HIGH_WATERMARK, &val);
    476 
    477 	/* Set RX/TX configuration. */
    478 	/* Set RX control register */
    479 	ctl = AXEN_RXCTL_IPE | AXEN_RXCTL_DROPCRCERR | AXEN_RXCTL_AUTOB;
    480 	wval = htole16(ctl);
    481 	axen_cmd(un, AXEN_CMD_MAC_WRITE2, 2, AXEN_MAC_RXCTL, &wval);
    482 
    483 	/* set monitor mode (enable) */
    484 	val = AXEN_MONITOR_PMETYPE | AXEN_MONITOR_PMEPOL | AXEN_MONITOR_RWMP;
    485 	axen_cmd(un, AXEN_CMD_MAC_WRITE, 1, AXEN_MONITOR_MODE, &val);
    486 	axen_cmd(un, AXEN_CMD_MAC_READ, 1, AXEN_MONITOR_MODE, &val);
    487 	DPRINTF(("axen: Monitor mode = %#02x\n", val));
    488 
    489 	/* set medium type */
    490 	ctl = AXEN_MEDIUM_GIGA | AXEN_MEDIUM_FDX | AXEN_MEDIUM_EN_125MHZ |
    491 	    AXEN_MEDIUM_RXFLOW_CTRL_EN | AXEN_MEDIUM_TXFLOW_CTRL_EN |
    492 	    AXEN_MEDIUM_RECV_EN;
    493 	wval = htole16(ctl);
    494 	DPRINTF(("axen: set to medium mode: %#04x\n", ctl));
    495 	axen_cmd(un, AXEN_CMD_MAC_WRITE2, 2, AXEN_MEDIUM_STATUS, &wval);
    496 	usbd_delay_ms(un->un_udev, 100);
    497 
    498 	axen_cmd(un, AXEN_CMD_MAC_READ2, 2, AXEN_MEDIUM_STATUS, &wval);
    499 	DPRINTF(("axen: current medium mode: %#04x\n", le16toh(wval)));
    500 
    501 	usbnet_unlock_mii(un);
    502 
    503 #if 0 /* XXX: TBD.... */
    504 #define GMII_LED_ACTIVE		0x1a
    505 #define GMII_PHY_PAGE_SEL	0x1e
    506 #define GMII_PHY_PAGE_SEL	0x1f
    507 #define GMII_PAGE_EXT		0x0007
    508 	usbnet_mii_writereg(un->un_dev, un->un_phyno, GMII_PHY_PAGE_SEL,
    509 	    GMII_PAGE_EXT);
    510 	usbnet_mii_writereg(un->un_dev, un->un_phyno, GMII_PHY_PAGE,
    511 	    0x002c);
    512 #endif
    513 
    514 #if 1 /* XXX: phy hack ? */
    515 	usbnet_mii_writereg(un->un_dev, un->un_phyno, 0x1F, 0x0005);
    516 	usbnet_mii_writereg(un->un_dev, un->un_phyno, 0x0C, 0x0000);
    517 	usbnet_mii_readreg(un->un_dev, un->un_phyno, 0x0001, &wval);
    518 	usbnet_mii_writereg(un->un_dev, un->un_phyno, 0x01, wval | 0x0080);
    519 	usbnet_mii_writereg(un->un_dev, un->un_phyno, 0x1F, 0x0000);
    520 #endif
    521 }
    522 
    523 static void
    524 axen_setoe_locked(struct usbnet *un)
    525 {
    526 	struct ifnet * const ifp = usbnet_ifp(un);
    527 	uint64_t enabled = ifp->if_capenable;
    528 	uint8_t val;
    529 
    530 	usbnet_isowned_mii(un);
    531 
    532 	val = AXEN_RXCOE_OFF;
    533 	if (enabled & IFCAP_CSUM_IPv4_Rx)
    534 		val |= AXEN_RXCOE_IPv4;
    535 	if (enabled & IFCAP_CSUM_TCPv4_Rx)
    536 		val |= AXEN_RXCOE_TCPv4;
    537 	if (enabled & IFCAP_CSUM_UDPv4_Rx)
    538 		val |= AXEN_RXCOE_UDPv4;
    539 	if (enabled & IFCAP_CSUM_TCPv6_Rx)
    540 		val |= AXEN_RXCOE_TCPv6;
    541 	if (enabled & IFCAP_CSUM_UDPv6_Rx)
    542 		val |= AXEN_RXCOE_UDPv6;
    543 	axen_cmd(un, AXEN_CMD_MAC_WRITE, 1, AXEN_RX_COE, &val);
    544 
    545 	val = AXEN_TXCOE_OFF;
    546 	if (enabled & IFCAP_CSUM_IPv4_Tx)
    547 		val |= AXEN_TXCOE_IPv4;
    548 	if (enabled & IFCAP_CSUM_TCPv4_Tx)
    549 		val |= AXEN_TXCOE_TCPv4;
    550 	if (enabled & IFCAP_CSUM_UDPv4_Tx)
    551 		val |= AXEN_TXCOE_UDPv4;
    552 	if (enabled & IFCAP_CSUM_TCPv6_Tx)
    553 		val |= AXEN_TXCOE_TCPv6;
    554 	if (enabled & IFCAP_CSUM_UDPv6_Tx)
    555 		val |= AXEN_TXCOE_UDPv6;
    556 	axen_cmd(un, AXEN_CMD_MAC_WRITE, 1, AXEN_TX_COE, &val);
    557 }
    558 
    559 static void
    560 axen_setoe(struct usbnet *un)
    561 {
    562 
    563 	usbnet_lock_mii(un);
    564 	axen_setoe_locked(un);
    565 	usbnet_unlock_mii(un);
    566 }
    567 
    568 static int
    569 axen_ioctl_cb(struct ifnet *ifp, u_long cmd, void *data)
    570 {
    571 	struct usbnet * const un = ifp->if_softc;
    572 
    573 	switch (cmd) {
    574 	case SIOCSIFFLAGS:
    575 	case SIOCSETHERCAP:
    576 	case SIOCADDMULTI:
    577 	case SIOCDELMULTI:
    578 		axen_setiff(un);
    579 		break;
    580 	case SIOCSIFCAP:
    581 		axen_setoe(un);
    582 		break;
    583 	default:
    584 		break;
    585 	}
    586 
    587 	return 0;
    588 }
    589 
    590 static int
    591 axen_match(device_t parent, cfdata_t match, void *aux)
    592 {
    593 	struct usb_attach_arg *uaa = aux;
    594 
    595 	return axen_lookup(uaa->uaa_vendor, uaa->uaa_product) != NULL ?
    596 		UMATCH_VENDOR_PRODUCT : UMATCH_NONE;
    597 }
    598 
    599 static void
    600 axen_attach(device_t parent, device_t self, void *aux)
    601 {
    602 	USBNET_MII_DECL_DEFAULT(unm);
    603 	struct usbnet * const un = device_private(self);
    604 	struct usb_attach_arg *uaa = aux;
    605 	struct usbd_device *dev = uaa->uaa_device;
    606 	usbd_status err;
    607 	usb_interface_descriptor_t *id;
    608 	usb_endpoint_descriptor_t *ed;
    609 	char *devinfop;
    610 	uint16_t axen_flags;
    611 	int i;
    612 
    613 	aprint_naive("\n");
    614 	aprint_normal("\n");
    615 	devinfop = usbd_devinfo_alloc(dev, 0);
    616 	aprint_normal_dev(self, "%s\n", devinfop);
    617 	usbd_devinfo_free(devinfop);
    618 
    619 	un->un_dev = self;
    620 	un->un_udev = dev;
    621 	un->un_sc = un;
    622 	un->un_ops = &axen_ops;
    623 	un->un_rx_xfer_flags = USBD_SHORT_XFER_OK;
    624 	un->un_tx_xfer_flags = USBD_FORCE_SHORT_XFER;
    625 	un->un_rx_list_cnt = AXEN_RX_LIST_CNT;
    626 	un->un_tx_list_cnt = AXEN_TX_LIST_CNT;
    627 
    628 	err = usbd_set_config_no(dev, AXEN_CONFIG_NO, 1);
    629 	if (err) {
    630 		aprint_error_dev(self, "failed to set configuration"
    631 		    ", err=%s\n", usbd_errstr(err));
    632 		return;
    633 	}
    634 
    635 	axen_flags = axen_lookup(uaa->uaa_vendor, uaa->uaa_product)->axen_flags;
    636 
    637 	err = usbd_device2interface_handle(dev, AXEN_IFACE_IDX, &un->un_iface);
    638 	if (err) {
    639 		aprint_error_dev(self, "getting interface handle failed\n");
    640 		return;
    641 	}
    642 
    643 	/* decide on what our bufsize will be */
    644 	switch (dev->ud_speed) {
    645 	case USB_SPEED_SUPER:
    646 		un->un_rx_bufsz = AXEN_BUFSZ_SS * 1024;
    647 		break;
    648 	case USB_SPEED_HIGH:
    649 		un->un_rx_bufsz = AXEN_BUFSZ_HS * 1024;
    650 		break;
    651 	default:
    652 		un->un_rx_bufsz = AXEN_BUFSZ_LS * 1024;
    653 		break;
    654 	}
    655 	un->un_tx_bufsz = IP_MAXPACKET + ETHER_HDR_LEN + ETHER_CRC_LEN +
    656 	    ETHER_VLAN_ENCAP_LEN + sizeof(struct axen_sframe_hdr);
    657 
    658 	/* Find endpoints. */
    659 	id = usbd_get_interface_descriptor(un->un_iface);
    660 	for (i = 0; i < id->bNumEndpoints; i++) {
    661 		ed = usbd_interface2endpoint_descriptor(un->un_iface, i);
    662 		if (!ed) {
    663 			aprint_error_dev(self, "couldn't get ep %d\n", i);
    664 			return;
    665 		}
    666 		if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
    667 		    UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
    668 			un->un_ed[USBNET_ENDPT_RX] = ed->bEndpointAddress;
    669 		} else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
    670 			   UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
    671 			un->un_ed[USBNET_ENDPT_TX] = ed->bEndpointAddress;
    672 #if 0 /* not used yet */
    673 		} else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
    674 			   UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
    675 			un->un_ed[USBNET_ENDPT_INTR] = ed->bEndpointAddress;
    676 #endif
    677 		}
    678 	}
    679 
    680 	/* Set these up now for axen_cmd().  */
    681 	usbnet_attach(un, "axendet");
    682 
    683 	un->un_phyno = AXEN_PHY_ID;
    684 	DPRINTF(("%s: phyno %d\n", device_xname(self), un->un_phyno));
    685 
    686 	/* Get station address.  */
    687 	usbnet_lock_mii(un);
    688 	if (axen_get_eaddr(un, &un->un_eaddr)) {
    689 		usbnet_unlock_mii(un);
    690 		printf("EEPROM checksum error\n");
    691 		return;
    692 	}
    693 	usbnet_unlock_mii(un);
    694 
    695 	axen_ax88179_init(un);
    696 
    697 	/* An ASIX chip was detected. Inform the world.  */
    698 	if (axen_flags & AX178A)
    699 		aprint_normal_dev(self, "AX88178a\n");
    700 	else if (axen_flags & AX179)
    701 		aprint_normal_dev(self, "AX88179\n");
    702 	else
    703 		aprint_normal_dev(self, "(unknown)\n");
    704 
    705 	struct ethercom *ec = usbnet_ec(un);
    706 	ec->ec_capabilities = ETHERCAP_VLAN_MTU;
    707 
    708 	/* Adapter does not support TSOv6 (They call it LSOv2). */
    709 	struct ifnet *ifp = usbnet_ifp(un);
    710 	ifp->if_capabilities |= IFCAP_TSOv4 |
    711 	    IFCAP_CSUM_IPv4_Rx	| IFCAP_CSUM_IPv4_Tx  |
    712 	    IFCAP_CSUM_TCPv4_Rx | IFCAP_CSUM_TCPv4_Tx |
    713 	    IFCAP_CSUM_UDPv4_Rx | IFCAP_CSUM_UDPv4_Tx |
    714 	    IFCAP_CSUM_TCPv6_Rx | IFCAP_CSUM_TCPv6_Tx |
    715 	    IFCAP_CSUM_UDPv6_Rx | IFCAP_CSUM_UDPv6_Tx;
    716 
    717 	usbnet_attach_ifp(un, IFF_SIMPLEX | IFF_BROADCAST | IFF_MULTICAST,
    718 	    0, &unm);
    719 }
    720 
    721 static int
    722 axen_csum_flags_rx(struct ifnet *ifp, uint32_t pkt_hdr)
    723 {
    724 	int enabled_flags = ifp->if_csum_flags_rx;
    725 	int csum_flags = 0;
    726 	int l3_type, l4_type;
    727 
    728 	if (enabled_flags == 0)
    729 		return 0;
    730 
    731 	l3_type = (pkt_hdr & AXEN_RXHDR_L3_TYPE_MASK) >>
    732 	    AXEN_RXHDR_L3_TYPE_OFFSET;
    733 
    734 	if (l3_type == AXEN_RXHDR_L3_TYPE_IPV4)
    735 		csum_flags |= M_CSUM_IPv4;
    736 
    737 	l4_type = (pkt_hdr & AXEN_RXHDR_L4_TYPE_MASK) >>
    738 	    AXEN_RXHDR_L4_TYPE_OFFSET;
    739 
    740 	switch (l4_type) {
    741 	case AXEN_RXHDR_L4_TYPE_TCP:
    742 		if (l3_type == AXEN_RXHDR_L3_TYPE_IPV4)
    743 			csum_flags |= M_CSUM_TCPv4;
    744 		else
    745 			csum_flags |= M_CSUM_TCPv6;
    746 		break;
    747 	case AXEN_RXHDR_L4_TYPE_UDP:
    748 		if (l3_type == AXEN_RXHDR_L3_TYPE_IPV4)
    749 			csum_flags |= M_CSUM_UDPv4;
    750 		else
    751 			csum_flags |= M_CSUM_UDPv6;
    752 		break;
    753 	default:
    754 		break;
    755 	}
    756 
    757 	csum_flags &= enabled_flags;
    758 	if ((csum_flags & M_CSUM_IPv4) && (pkt_hdr & AXEN_RXHDR_L3CSUM_ERR))
    759 		csum_flags |= M_CSUM_IPv4_BAD;
    760 	if ((csum_flags & ~M_CSUM_IPv4) && (pkt_hdr & AXEN_RXHDR_L4CSUM_ERR))
    761 		csum_flags |= M_CSUM_TCP_UDP_BAD;
    762 
    763 	return csum_flags;
    764 }
    765 
    766 static void
    767 axen_rx_loop(struct usbnet *un, struct usbnet_chain *c, uint32_t total_len)
    768 {
    769 	struct ifnet *ifp = usbnet_ifp(un);
    770 	uint8_t *buf = c->unc_buf;
    771 	uint32_t rx_hdr, pkt_hdr;
    772 	uint32_t *hdr_p;
    773 	uint16_t hdr_offset, pkt_count;
    774 	size_t pkt_len;
    775 	size_t temp;
    776 
    777 	usbnet_isowned_rx(un);
    778 
    779 	if (total_len < sizeof(pkt_hdr)) {
    780 		aprint_error_dev(un->un_dev, "rxeof: too short transfer\n");
    781 		if_statinc(ifp, if_ierrors);
    782 		return;
    783 	}
    784 
    785 	/*
    786 	 * buffer map
    787 	 * [packet #0]...[packet #n][pkt hdr#0]..[pkt hdr#n][recv_hdr]
    788 	 * each packet has 0xeeee as psuedo header..
    789 	 */
    790 	hdr_p = (uint32_t *)(buf + total_len - sizeof(uint32_t));
    791 	rx_hdr = le32toh(*hdr_p);
    792 	hdr_offset = (uint16_t)(rx_hdr >> 16);
    793 	pkt_count  = (uint16_t)(rx_hdr & 0xffff);
    794 
    795 	/* sanity check */
    796 	if (hdr_offset > total_len) {
    797 		aprint_error_dev(un->un_dev,
    798 		    "rxeof: invalid hdr offset (%u > %u)\n",
    799 		    hdr_offset, total_len);
    800 		if_statinc(ifp, if_ierrors);
    801 		usbd_delay_ms(un->un_udev, 100);
    802 		return;
    803 	}
    804 
    805 	/* point first packet header */
    806 	hdr_p = (uint32_t *)(buf + hdr_offset);
    807 
    808 	/*
    809 	 * ax88179 will pack multiple ip packet to a USB transaction.
    810 	 * process all of packets in the buffer
    811 	 */
    812 
    813 #if 1 /* XXX: paranoiac check. need to remove later */
    814 #define AXEN_MAX_PACKED_PACKET 200
    815 	if (pkt_count > AXEN_MAX_PACKED_PACKET) {
    816 		DPRINTF(("%s: Too many packets (%d) in a transaction, discard.\n",
    817 		    device_xname(un->un_dev), pkt_count));
    818 		return;
    819 	}
    820 #endif
    821 
    822 	if (pkt_count)
    823 		rnd_add_uint32(usbnet_rndsrc(un), pkt_count);
    824 
    825 	do {
    826 		if ((buf[0] != 0xee) || (buf[1] != 0xee)) {
    827 			aprint_error_dev(un->un_dev,
    828 			    "invalid buffer(pkt#%d), continue\n", pkt_count);
    829 			if_statadd(ifp, if_ierrors, pkt_count);
    830 			return;
    831 		}
    832 
    833 		pkt_hdr = le32toh(*hdr_p);
    834 		pkt_len = (pkt_hdr >> 16) & 0x1fff;
    835 		DPRINTFN(10,
    836 		    ("%s: rxeof: packet#%d, pkt_hdr %#08x, pkt_len %zu\n",
    837 		   device_xname(un->un_dev), pkt_count, pkt_hdr, pkt_len));
    838 
    839 		if (pkt_hdr & (AXEN_RXHDR_CRC_ERR | AXEN_RXHDR_DROP_ERR)) {
    840 			if_statinc(ifp, if_ierrors);
    841 			/* move to next pkt header */
    842 			DPRINTF(("%s: %s err (pkt#%d)\n",
    843 			    device_xname(un->un_dev),
    844 			    (pkt_hdr & AXEN_RXHDR_CRC_ERR) ? "crc" : "drop",
    845 			    pkt_count));
    846 			goto nextpkt;
    847 		}
    848 
    849 		usbnet_enqueue(un, buf + ETHER_ALIGN, pkt_len - 6,
    850 			       axen_csum_flags_rx(ifp, pkt_hdr), 0, 0);
    851 
    852 nextpkt:
    853 		/*
    854 		 * prepare next packet
    855 		 * as each packet will be aligned 8byte boundary,
    856 		 * need to fix up the start point of the buffer.
    857 		 */
    858 		temp = ((pkt_len + 7) & 0xfff8);
    859 		buf = buf + temp;
    860 		hdr_p++;
    861 		pkt_count--;
    862 	} while (pkt_count > 0);
    863 }
    864 
    865 static unsigned
    866 axen_tx_prepare(struct usbnet *un, struct mbuf *m, struct usbnet_chain *c)
    867 {
    868 	struct axen_sframe_hdr hdr;
    869 	u_int length, boundary;
    870 
    871 	usbnet_isowned_tx(un);
    872 
    873 	if ((unsigned)m->m_pkthdr.len > un->un_tx_bufsz - sizeof(hdr))
    874 		return 0;
    875 	length = m->m_pkthdr.len + sizeof(hdr);
    876 
    877 	/* XXX Is this needed?  wMaxPacketSize? */
    878 	switch (un->un_udev->ud_speed) {
    879 	case USB_SPEED_SUPER:
    880 		boundary = 4096;
    881 		break;
    882 	case USB_SPEED_HIGH:
    883 		boundary = 512;
    884 		break;
    885 	default:
    886 		boundary = 64;
    887 		break;
    888 	}
    889 
    890 	hdr.plen = htole32(m->m_pkthdr.len);
    891 
    892 	hdr.gso = (m->m_pkthdr.csum_flags & M_CSUM_TSOv4) ?
    893 	    m->m_pkthdr.segsz : 0;
    894 	if ((length % boundary) == 0) {
    895 		DPRINTF(("%s: boundary hit\n", device_xname(un->un_dev)));
    896 		hdr.gso |= 0x80008000;	/* XXX enable padding */
    897 	}
    898 	hdr.gso = htole32(hdr.gso);
    899 
    900 	memcpy(c->unc_buf, &hdr, sizeof(hdr));
    901 	m_copydata(m, 0, m->m_pkthdr.len, c->unc_buf + sizeof(hdr));
    902 
    903 	return length;
    904 }
    905 
    906 static int
    907 axen_init_locked(struct ifnet *ifp)
    908 {
    909 	struct usbnet * const un = ifp->if_softc;
    910 	uint16_t rxmode;
    911 	uint16_t wval;
    912 	uint8_t bval;
    913 
    914 	usbnet_isowned(un);
    915 
    916 	if (usbnet_isdying(un))
    917 		return EIO;
    918 
    919 	/* Cancel pending I/O */
    920 	usbnet_stop(un, ifp, 1);
    921 
    922 	/* Reset the ethernet interface. */
    923 	axen_reset(un);
    924 
    925 	usbnet_lock_mii_un_locked(un);
    926 
    927 	/* XXX: ? */
    928 	bval = 0x01;
    929 	axen_cmd(un, AXEN_CMD_MAC_WRITE, 1, AXEN_UNK_28, &bval);
    930 
    931 	/* Configure offloading engine. */
    932 	axen_setoe_locked(un);
    933 
    934 	/* Program promiscuous mode and multicast filters. */
    935 	axen_setiff_locked(un);
    936 
    937 	/* Enable receiver, set RX mode */
    938 	axen_cmd(un, AXEN_CMD_MAC_READ2, 2, AXEN_MAC_RXCTL, &wval);
    939 	rxmode = le16toh(wval);
    940 	rxmode |= AXEN_RXCTL_START;
    941 	wval = htole16(rxmode);
    942 	axen_cmd(un, AXEN_CMD_MAC_WRITE2, 2, AXEN_MAC_RXCTL, &wval);
    943 
    944 	usbnet_unlock_mii_un_locked(un);
    945 
    946 	return usbnet_init_rx_tx(un);
    947 }
    948 
    949 static int
    950 axen_init(struct ifnet *ifp)
    951 {
    952 	struct usbnet * const un = ifp->if_softc;
    953 
    954 	usbnet_lock(un);
    955 	int ret = axen_init_locked(ifp);
    956 	usbnet_unlock(un);
    957 
    958 	return ret;
    959 }
    960 
    961 static void
    962 axen_stop_cb(struct ifnet *ifp, int disable)
    963 {
    964 	struct usbnet * const un = ifp->if_softc;
    965 	uint16_t rxmode, wval;
    966 
    967 	axen_reset(un);
    968 
    969 	/* Disable receiver, set RX mode */
    970 	usbnet_lock_mii_un_locked(un);
    971 	axen_cmd(un, AXEN_CMD_MAC_READ2, 2, AXEN_MAC_RXCTL, &wval);
    972 	rxmode = le16toh(wval);
    973 	rxmode &= ~AXEN_RXCTL_START;
    974 	wval = htole16(rxmode);
    975 	axen_cmd(un, AXEN_CMD_MAC_WRITE2, 2, AXEN_MAC_RXCTL, &wval);
    976 	usbnet_unlock_mii_un_locked(un);
    977 }
    978 
    979 #ifdef _MODULE
    980 #include "ioconf.c"
    981 #endif
    982 
    983 USBNET_MODULE(axen)
    984