if_axe.c revision 195049
189099Sfjoe/*- 289099Sfjoe * Copyright (c) 1997, 1998, 1999, 2000-2003 3319182Sngie * Bill Paul <wpaul@windriver.com>. All rights reserved. 489099Sfjoe * 589099Sfjoe * Redistribution and use in source and binary forms, with or without 689099Sfjoe * modification, are permitted provided that the following conditions 7263140Sglebius * are met: 889099Sfjoe * 1. Redistributions of source code must retain the above copyright 989244Smsmith * notice, this list of conditions and the following disclaimer. 1089244Smsmith * 2. Redistributions in binary form must reproduce the above copyright 1189244Smsmith * notice, this list of conditions and the following disclaimer in the 1289244Smsmith * documentation and/or other materials provided with the distribution. 1389244Smsmith * 3. All advertising materials mentioning features or use of this software 1489244Smsmith * must display the following acknowledgement: 1589244Smsmith * This product includes software developed by Bill Paul. 1689244Smsmith * 4. Neither the name of the author nor the names of any co-contributors 1789244Smsmith * may be used to endorse or promote products derived from this software 1889244Smsmith * without specific prior written permission. 1989099Sfjoe * 20 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD 24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 30 * THE POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33#include <sys/cdefs.h> 34__FBSDID("$FreeBSD: head/sys/dev/usb/net/if_axe.c 195049 2009-06-26 11:45:06Z rwatson $"); 35 36/* 37 * ASIX Electronics AX88172/AX88178/AX88778 USB 2.0 ethernet driver. 38 * Used in the LinkSys USB200M and various other adapters. 39 * 40 * Manuals available from: 41 * http://www.asix.com.tw/datasheet/mac/Ax88172.PDF 42 * Note: you need the manual for the AX88170 chip (USB 1.x ethernet 43 * controller) to find the definitions for the RX control register. 44 * http://www.asix.com.tw/datasheet/mac/Ax88170.PDF 45 * 46 * Written by Bill Paul <wpaul@windriver.com> 47 * Senior Engineer 48 * Wind River Systems 49 */ 50 51/* 52 * The AX88172 provides USB ethernet supports at 10 and 100Mbps. 53 * It uses an external PHY (reference designs use a RealTek chip), 54 * and has a 64-bit multicast hash filter. There is some information 55 * missing from the manual which one needs to know in order to make 56 * the chip function: 57 * 58 * - You must set bit 7 in the RX control register, otherwise the 59 * chip won't receive any packets. 60 * - You must initialize all 3 IPG registers, or you won't be able 61 * to send any packets. 62 * 63 * Note that this device appears to only support loading the station 64 * address via autload from the EEPROM (i.e. there's no way to manaully 65 * set it). 66 * 67 * (Adam Weinberger wanted me to name this driver if_gir.c.) 68 */ 69 70/* 71 * Ax88178 and Ax88772 support backported from the OpenBSD driver. 72 * 2007/02/12, J.R. Oldroyd, fbsd@opal.com 73 * 74 * Manual here: 75 * http://www.asix.com.tw/FrootAttach/datasheet/AX88178_datasheet_Rev10.pdf 76 * http://www.asix.com.tw/FrootAttach/datasheet/AX88772_datasheet_Rev10.pdf 77 */ 78 79#include <sys/stdint.h> 80#include <sys/stddef.h> 81#include <sys/param.h> 82#include <sys/queue.h> 83#include <sys/types.h> 84#include <sys/systm.h> 85#include <sys/kernel.h> 86#include <sys/bus.h> 87#include <sys/linker_set.h> 88#include <sys/module.h> 89#include <sys/lock.h> 90#include <sys/mutex.h> 91#include <sys/condvar.h> 92#include <sys/sysctl.h> 93#include <sys/sx.h> 94#include <sys/unistd.h> 95#include <sys/callout.h> 96#include <sys/malloc.h> 97#include <sys/priv.h> 98 99#include <dev/usb/usb.h> 100#include <dev/usb/usbdi.h> 101#include <dev/usb/usbdi_util.h> 102#include "usbdevs.h" 103 104#define USB_DEBUG_VAR axe_debug 105#include <dev/usb/usb_debug.h> 106#include <dev/usb/usb_process.h> 107 108#include <dev/usb/net/usb_ethernet.h> 109#include <dev/usb/net/if_axereg.h> 110 111/* 112 * AXE_178_MAX_FRAME_BURST 113 * max frame burst size for Ax88178 and Ax88772 114 * 0 2048 bytes 115 * 1 4096 bytes 116 * 2 8192 bytes 117 * 3 16384 bytes 118 * use the largest your system can handle without USB stalling. 119 * 120 * NB: 88772 parts appear to generate lots of input errors with 121 * a 2K rx buffer and 8K is only slightly faster than 4K on an 122 * EHCI port on a T42 so change at your own risk. 123 */ 124#define AXE_178_MAX_FRAME_BURST 1 125 126#if USB_DEBUG 127static int axe_debug = 0; 128 129SYSCTL_NODE(_hw_usb, OID_AUTO, axe, CTLFLAG_RW, 0, "USB axe"); 130SYSCTL_INT(_hw_usb_axe, OID_AUTO, debug, CTLFLAG_RW, &axe_debug, 0, 131 "Debug level"); 132#endif 133 134/* 135 * Various supported device vendors/products. 136 */ 137static const struct usb_device_id axe_devs[] = { 138 {USB_VPI(USB_VENDOR_ABOCOM, USB_PRODUCT_ABOCOM_UF200, 0)}, 139 {USB_VPI(USB_VENDOR_ACERCM, USB_PRODUCT_ACERCM_EP1427X2, 0)}, 140 {USB_VPI(USB_VENDOR_APPLE, USB_PRODUCT_APPLE_ETHERNET, AXE_FLAG_772)}, 141 {USB_VPI(USB_VENDOR_ASIX, USB_PRODUCT_ASIX_AX88172, 0)}, 142 {USB_VPI(USB_VENDOR_ASIX, USB_PRODUCT_ASIX_AX88178, AXE_FLAG_178)}, 143 {USB_VPI(USB_VENDOR_ASIX, USB_PRODUCT_ASIX_AX88772, AXE_FLAG_772)}, 144 {USB_VPI(USB_VENDOR_ATEN, USB_PRODUCT_ATEN_UC210T, 0)}, 145 {USB_VPI(USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5D5055, AXE_FLAG_178)}, 146 {USB_VPI(USB_VENDOR_BILLIONTON, USB_PRODUCT_BILLIONTON_USB2AR, 0)}, 147 {USB_VPI(USB_VENDOR_CISCOLINKSYS, USB_PRODUCT_CISCOLINKSYS_USB200MV2, AXE_FLAG_772)}, 148 {USB_VPI(USB_VENDOR_COREGA, USB_PRODUCT_COREGA_FETHER_USB2_TX, 0)}, 149 {USB_VPI(USB_VENDOR_DLINK, USB_PRODUCT_DLINK_DUBE100, 0)}, 150 {USB_VPI(USB_VENDOR_DLINK, USB_PRODUCT_DLINK_DUBE100B1, AXE_FLAG_772)}, 151 {USB_VPI(USB_VENDOR_GOODWAY, USB_PRODUCT_GOODWAY_GWUSB2E, 0)}, 152 {USB_VPI(USB_VENDOR_IODATA, USB_PRODUCT_IODATA_ETGUS2, AXE_FLAG_178)}, 153 {USB_VPI(USB_VENDOR_JVC, USB_PRODUCT_JVC_MP_PRX1, 0)}, 154 {USB_VPI(USB_VENDOR_LINKSYS2, USB_PRODUCT_LINKSYS2_USB200M, 0)}, 155 {USB_VPI(USB_VENDOR_LINKSYS4, USB_PRODUCT_LINKSYS4_USB1000, AXE_FLAG_178)}, 156 {USB_VPI(USB_VENDOR_MELCO, USB_PRODUCT_MELCO_LUAU2KTX, 0)}, 157 {USB_VPI(USB_VENDOR_NETGEAR, USB_PRODUCT_NETGEAR_FA120, 0)}, 158 {USB_VPI(USB_VENDOR_OQO, USB_PRODUCT_OQO_ETHER01PLUS, AXE_FLAG_772)}, 159 {USB_VPI(USB_VENDOR_PLANEX3, USB_PRODUCT_PLANEX3_GU1000T, AXE_FLAG_178)}, 160 {USB_VPI(USB_VENDOR_SITECOM, USB_PRODUCT_SITECOM_LN029, 0)}, 161 {USB_VPI(USB_VENDOR_SITECOMEU, USB_PRODUCT_SITECOMEU_LN028, AXE_FLAG_178)}, 162 {USB_VPI(USB_VENDOR_SYSTEMTALKS, USB_PRODUCT_SYSTEMTALKS_SGCX2UL, 0)}, 163}; 164 165static device_probe_t axe_probe; 166static device_attach_t axe_attach; 167static device_detach_t axe_detach; 168 169static usb_callback_t axe_intr_callback; 170static usb_callback_t axe_bulk_read_callback; 171static usb_callback_t axe_bulk_write_callback; 172 173static miibus_readreg_t axe_miibus_readreg; 174static miibus_writereg_t axe_miibus_writereg; 175static miibus_statchg_t axe_miibus_statchg; 176 177static uether_fn_t axe_attach_post; 178static uether_fn_t axe_init; 179static uether_fn_t axe_stop; 180static uether_fn_t axe_start; 181static uether_fn_t axe_tick; 182static uether_fn_t axe_setmulti; 183static uether_fn_t axe_setpromisc; 184 185static int axe_ifmedia_upd(struct ifnet *); 186static void axe_ifmedia_sts(struct ifnet *, struct ifmediareq *); 187static int axe_cmd(struct axe_softc *, int, int, int, void *); 188static void axe_ax88178_init(struct axe_softc *); 189static void axe_ax88772_init(struct axe_softc *); 190static int axe_get_phyno(struct axe_softc *, int); 191 192static const struct usb_config axe_config[AXE_N_TRANSFER] = { 193 194 [AXE_BULK_DT_WR] = { 195 .type = UE_BULK, 196 .endpoint = UE_ADDR_ANY, 197 .direction = UE_DIR_OUT, 198 .bufsize = AXE_BULK_BUF_SIZE, 199 .flags = {.pipe_bof = 1,.force_short_xfer = 1,}, 200 .callback = axe_bulk_write_callback, 201 .timeout = 10000, /* 10 seconds */ 202 }, 203 204 [AXE_BULK_DT_RD] = { 205 .type = UE_BULK, 206 .endpoint = UE_ADDR_ANY, 207 .direction = UE_DIR_IN, 208#if (MCLBYTES < 2048) 209#error "(MCLBYTES < 2048)" 210#endif 211 .bufsize = MCLBYTES, 212 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,}, 213 .callback = axe_bulk_read_callback, 214 .timeout = 0, /* no timeout */ 215 }, 216 217 [AXE_INTR_DT_RD] = { 218 .type = UE_INTERRUPT, 219 .endpoint = UE_ADDR_ANY, 220 .direction = UE_DIR_IN, 221 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,}, 222 .bufsize = 0, /* use wMaxPacketSize */ 223 .callback = axe_intr_callback, 224 }, 225}; 226 227static device_method_t axe_methods[] = { 228 /* Device interface */ 229 DEVMETHOD(device_probe, axe_probe), 230 DEVMETHOD(device_attach, axe_attach), 231 DEVMETHOD(device_detach, axe_detach), 232 233 /* bus interface */ 234 DEVMETHOD(bus_print_child, bus_generic_print_child), 235 DEVMETHOD(bus_driver_added, bus_generic_driver_added), 236 237 /* MII interface */ 238 DEVMETHOD(miibus_readreg, axe_miibus_readreg), 239 DEVMETHOD(miibus_writereg, axe_miibus_writereg), 240 DEVMETHOD(miibus_statchg, axe_miibus_statchg), 241 242 {0, 0} 243}; 244 245static driver_t axe_driver = { 246 .name = "axe", 247 .methods = axe_methods, 248 .size = sizeof(struct axe_softc), 249}; 250 251static devclass_t axe_devclass; 252 253DRIVER_MODULE(axe, uhub, axe_driver, axe_devclass, NULL, 0); 254DRIVER_MODULE(miibus, axe, miibus_driver, miibus_devclass, 0, 0); 255MODULE_DEPEND(axe, uether, 1, 1, 1); 256MODULE_DEPEND(axe, usb, 1, 1, 1); 257MODULE_DEPEND(axe, ether, 1, 1, 1); 258MODULE_DEPEND(axe, miibus, 1, 1, 1); 259 260static const struct usb_ether_methods axe_ue_methods = { 261 .ue_attach_post = axe_attach_post, 262 .ue_start = axe_start, 263 .ue_init = axe_init, 264 .ue_stop = axe_stop, 265 .ue_tick = axe_tick, 266 .ue_setmulti = axe_setmulti, 267 .ue_setpromisc = axe_setpromisc, 268 .ue_mii_upd = axe_ifmedia_upd, 269 .ue_mii_sts = axe_ifmedia_sts, 270}; 271 272static int 273axe_cmd(struct axe_softc *sc, int cmd, int index, int val, void *buf) 274{ 275 struct usb_device_request req; 276 usb_error_t err; 277 278 AXE_LOCK_ASSERT(sc, MA_OWNED); 279 280 req.bmRequestType = (AXE_CMD_IS_WRITE(cmd) ? 281 UT_WRITE_VENDOR_DEVICE : 282 UT_READ_VENDOR_DEVICE); 283 req.bRequest = AXE_CMD_CMD(cmd); 284 USETW(req.wValue, val); 285 USETW(req.wIndex, index); 286 USETW(req.wLength, AXE_CMD_LEN(cmd)); 287 288 err = uether_do_request(&sc->sc_ue, &req, buf, 1000); 289 290 return (err); 291} 292 293static int 294axe_miibus_readreg(device_t dev, int phy, int reg) 295{ 296 struct axe_softc *sc = device_get_softc(dev); 297 uint16_t val; 298 int locked; 299 300 if (sc->sc_phyno != phy) 301 return (0); 302 303 locked = mtx_owned(&sc->sc_mtx); 304 if (!locked) 305 AXE_LOCK(sc); 306 307 axe_cmd(sc, AXE_CMD_MII_OPMODE_SW, 0, 0, NULL); 308 axe_cmd(sc, AXE_CMD_MII_READ_REG, reg, phy, &val); 309 axe_cmd(sc, AXE_CMD_MII_OPMODE_HW, 0, 0, NULL); 310 311 val = le16toh(val); 312 if ((sc->sc_flags & AXE_FLAG_772) != 0 && reg == MII_BMSR) { 313 /* 314 * BMSR of AX88772 indicates that it supports extended 315 * capability but the extended status register is 316 * revered for embedded ethernet PHY. So clear the 317 * extended capability bit of BMSR. 318 */ 319 val &= ~BMSR_EXTCAP; 320 } 321 322 if (!locked) 323 AXE_UNLOCK(sc); 324 return (val); 325} 326 327static int 328axe_miibus_writereg(device_t dev, int phy, int reg, int val) 329{ 330 struct axe_softc *sc = device_get_softc(dev); 331 int locked; 332 333 val = htole32(val); 334 335 if (sc->sc_phyno != phy) 336 return (0); 337 338 locked = mtx_owned(&sc->sc_mtx); 339 if (!locked) 340 AXE_LOCK(sc); 341 342 axe_cmd(sc, AXE_CMD_MII_OPMODE_SW, 0, 0, NULL); 343 axe_cmd(sc, AXE_CMD_MII_WRITE_REG, reg, phy, &val); 344 axe_cmd(sc, AXE_CMD_MII_OPMODE_HW, 0, 0, NULL); 345 346 if (!locked) 347 AXE_UNLOCK(sc); 348 return (0); 349} 350 351static void 352axe_miibus_statchg(device_t dev) 353{ 354 struct axe_softc *sc = device_get_softc(dev); 355 struct mii_data *mii = GET_MII(sc); 356 struct ifnet *ifp; 357 uint16_t val; 358 int err, locked; 359 360 locked = mtx_owned(&sc->sc_mtx); 361 if (!locked) 362 AXE_LOCK(sc); 363 364 ifp = uether_getifp(&sc->sc_ue); 365 if (mii == NULL || ifp == NULL || 366 (ifp->if_drv_flags & IFF_DRV_RUNNING) == 0) 367 goto done; 368 369 sc->sc_flags &= ~AXE_FLAG_LINK; 370 if ((mii->mii_media_status & (IFM_ACTIVE | IFM_AVALID)) == 371 (IFM_ACTIVE | IFM_AVALID)) { 372 switch (IFM_SUBTYPE(mii->mii_media_active)) { 373 case IFM_10_T: 374 case IFM_100_TX: 375 sc->sc_flags |= AXE_FLAG_LINK; 376 break; 377 case IFM_1000_T: 378 if ((sc->sc_flags & AXE_FLAG_178) == 0) 379 break; 380 sc->sc_flags |= AXE_FLAG_LINK; 381 break; 382 default: 383 break; 384 } 385 } 386 387 /* Lost link, do nothing. */ 388 if ((sc->sc_flags & AXE_FLAG_LINK) == 0) 389 goto done; 390 391 val = 0; 392 if ((IFM_OPTIONS(mii->mii_media_active) & IFM_FDX) != 0) 393 val |= AXE_MEDIA_FULL_DUPLEX; 394 if (sc->sc_flags & (AXE_FLAG_178 | AXE_FLAG_772)) { 395 val |= AXE_178_MEDIA_RX_EN | AXE_178_MEDIA_MAGIC; 396 if ((sc->sc_flags & AXE_FLAG_178) != 0) 397 val |= AXE_178_MEDIA_ENCK; 398 switch (IFM_SUBTYPE(mii->mii_media_active)) { 399 case IFM_1000_T: 400 val |= AXE_178_MEDIA_GMII | AXE_178_MEDIA_ENCK; 401 break; 402 case IFM_100_TX: 403 val |= AXE_178_MEDIA_100TX; 404 break; 405 case IFM_10_T: 406 /* doesn't need to be handled */ 407 break; 408 } 409 } 410 err = axe_cmd(sc, AXE_CMD_WRITE_MEDIA, 0, val, NULL); 411 if (err) 412 device_printf(dev, "media change failed, error %d\n", err); 413done: 414 if (!locked) 415 AXE_UNLOCK(sc); 416} 417 418/* 419 * Set media options. 420 */ 421static int 422axe_ifmedia_upd(struct ifnet *ifp) 423{ 424 struct axe_softc *sc = ifp->if_softc; 425 struct mii_data *mii = GET_MII(sc); 426 int error; 427 428 AXE_LOCK_ASSERT(sc, MA_OWNED); 429 430 if (mii->mii_instance) { 431 struct mii_softc *miisc; 432 433 LIST_FOREACH(miisc, &mii->mii_phys, mii_list) 434 mii_phy_reset(miisc); 435 } 436 error = mii_mediachg(mii); 437 return (error); 438} 439 440/* 441 * Report current media status. 442 */ 443static void 444axe_ifmedia_sts(struct ifnet *ifp, struct ifmediareq *ifmr) 445{ 446 struct axe_softc *sc = ifp->if_softc; 447 struct mii_data *mii = GET_MII(sc); 448 449 AXE_LOCK(sc); 450 mii_pollstat(mii); 451 AXE_UNLOCK(sc); 452 ifmr->ifm_active = mii->mii_media_active; 453 ifmr->ifm_status = mii->mii_media_status; 454} 455 456static void 457axe_setmulti(struct usb_ether *ue) 458{ 459 struct axe_softc *sc = uether_getsc(ue); 460 struct ifnet *ifp = uether_getifp(ue); 461 struct ifmultiaddr *ifma; 462 uint32_t h = 0; 463 uint16_t rxmode; 464 uint8_t hashtbl[8] = { 0, 0, 0, 0, 0, 0, 0, 0 }; 465 466 AXE_LOCK_ASSERT(sc, MA_OWNED); 467 468 axe_cmd(sc, AXE_CMD_RXCTL_READ, 0, 0, &rxmode); 469 rxmode = le16toh(rxmode); 470 471 if (ifp->if_flags & (IFF_ALLMULTI | IFF_PROMISC)) { 472 rxmode |= AXE_RXCMD_ALLMULTI; 473 axe_cmd(sc, AXE_CMD_RXCTL_WRITE, 0, rxmode, NULL); 474 return; 475 } 476 rxmode &= ~AXE_RXCMD_ALLMULTI; 477 478 if_maddr_rlock(ifp); 479 TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) 480 { 481 if (ifma->ifma_addr->sa_family != AF_LINK) 482 continue; 483 h = ether_crc32_be(LLADDR((struct sockaddr_dl *) 484 ifma->ifma_addr), ETHER_ADDR_LEN) >> 26; 485 hashtbl[h / 8] |= 1 << (h % 8); 486 } 487 if_maddr_runlock(ifp); 488 489 axe_cmd(sc, AXE_CMD_WRITE_MCAST, 0, 0, (void *)&hashtbl); 490 axe_cmd(sc, AXE_CMD_RXCTL_WRITE, 0, rxmode, NULL); 491} 492 493static int 494axe_get_phyno(struct axe_softc *sc, int sel) 495{ 496 int phyno; 497 498 switch (AXE_PHY_TYPE(sc->sc_phyaddrs[sel])) { 499 case PHY_TYPE_100_HOME: 500 case PHY_TYPE_GIG: 501 phyno = AXE_PHY_NO(sc->sc_phyaddrs[sel]); 502 break; 503 case PHY_TYPE_SPECIAL: 504 /* FALLTHROUGH */ 505 case PHY_TYPE_RSVD: 506 /* FALLTHROUGH */ 507 case PHY_TYPE_NON_SUP: 508 /* FALLTHROUGH */ 509 default: 510 phyno = -1; 511 break; 512 } 513 514 return (phyno); 515} 516 517static void 518axe_ax88178_init(struct axe_softc *sc) 519{ 520 int gpio0 = 0, phymode = 0; 521 uint16_t eeprom; 522 523 axe_cmd(sc, AXE_CMD_SROM_WR_ENABLE, 0, 0, NULL); 524 /* XXX magic */ 525 axe_cmd(sc, AXE_CMD_SROM_READ, 0, 0x0017, &eeprom); 526 eeprom = le16toh(eeprom); 527 axe_cmd(sc, AXE_CMD_SROM_WR_DISABLE, 0, 0, NULL); 528 529 /* if EEPROM is invalid we have to use to GPIO0 */ 530 if (eeprom == 0xffff) { 531 phymode = 0; 532 gpio0 = 1; 533 } else { 534 phymode = eeprom & 7; 535 gpio0 = (eeprom & 0x80) ? 0 : 1; 536 } 537 538 axe_cmd(sc, AXE_CMD_WRITE_GPIO, 0, 0x008c, NULL); 539 uether_pause(&sc->sc_ue, hz / 16); 540 541 if ((eeprom >> 8) != 0x01) { 542 axe_cmd(sc, AXE_CMD_WRITE_GPIO, 0, 0x003c, NULL); 543 uether_pause(&sc->sc_ue, hz / 32); 544 545 axe_cmd(sc, AXE_CMD_WRITE_GPIO, 0, 0x001c, NULL); 546 uether_pause(&sc->sc_ue, hz / 3); 547 548 axe_cmd(sc, AXE_CMD_WRITE_GPIO, 0, 0x003c, NULL); 549 uether_pause(&sc->sc_ue, hz / 32); 550 } else { 551 axe_cmd(sc, AXE_CMD_WRITE_GPIO, 0, 0x0004, NULL); 552 uether_pause(&sc->sc_ue, hz / 32); 553 554 axe_cmd(sc, AXE_CMD_WRITE_GPIO, 0, 0x000c, NULL); 555 uether_pause(&sc->sc_ue, hz / 32); 556 } 557 558 /* soft reset */ 559 axe_cmd(sc, AXE_CMD_SW_RESET_REG, 0, AXE_SW_RESET_CLEAR, NULL); 560 uether_pause(&sc->sc_ue, hz / 4); 561 562 axe_cmd(sc, AXE_CMD_SW_RESET_REG, 0, 563 AXE_SW_RESET_PRL | AXE_178_RESET_MAGIC, NULL); 564 uether_pause(&sc->sc_ue, hz / 4); 565 /* Enable MII/GMII/RGMII interface to work with external PHY. */ 566 axe_cmd(sc, AXE_CMD_SW_PHY_SELECT, 0, 0, NULL); 567 uether_pause(&sc->sc_ue, hz / 4); 568 569 axe_cmd(sc, AXE_CMD_RXCTL_WRITE, 0, 0, NULL); 570} 571 572static void 573axe_ax88772_init(struct axe_softc *sc) 574{ 575 axe_cmd(sc, AXE_CMD_WRITE_GPIO, 0, 0x00b0, NULL); 576 uether_pause(&sc->sc_ue, hz / 16); 577 578 if (sc->sc_phyno == AXE_772_PHY_NO_EPHY) { 579 /* ask for the embedded PHY */ 580 axe_cmd(sc, AXE_CMD_SW_PHY_SELECT, 0, 0x01, NULL); 581 uether_pause(&sc->sc_ue, hz / 64); 582 583 /* power down and reset state, pin reset state */ 584 axe_cmd(sc, AXE_CMD_SW_RESET_REG, 0, 585 AXE_SW_RESET_CLEAR, NULL); 586 uether_pause(&sc->sc_ue, hz / 16); 587 588 /* power down/reset state, pin operating state */ 589 axe_cmd(sc, AXE_CMD_SW_RESET_REG, 0, 590 AXE_SW_RESET_IPPD | AXE_SW_RESET_PRL, NULL); 591 uether_pause(&sc->sc_ue, hz / 4); 592 593 /* power up, reset */ 594 axe_cmd(sc, AXE_CMD_SW_RESET_REG, 0, AXE_SW_RESET_PRL, NULL); 595 596 /* power up, operating */ 597 axe_cmd(sc, AXE_CMD_SW_RESET_REG, 0, 598 AXE_SW_RESET_IPRL | AXE_SW_RESET_PRL, NULL); 599 } else { 600 /* ask for external PHY */ 601 axe_cmd(sc, AXE_CMD_SW_PHY_SELECT, 0, 0x00, NULL); 602 uether_pause(&sc->sc_ue, hz / 64); 603 604 /* power down internal PHY */ 605 axe_cmd(sc, AXE_CMD_SW_RESET_REG, 0, 606 AXE_SW_RESET_IPPD | AXE_SW_RESET_PRL, NULL); 607 } 608 609 uether_pause(&sc->sc_ue, hz / 4); 610 axe_cmd(sc, AXE_CMD_RXCTL_WRITE, 0, 0, NULL); 611} 612 613static void 614axe_reset(struct axe_softc *sc) 615{ 616 struct usb_config_descriptor *cd; 617 usb_error_t err; 618 619 cd = usbd_get_config_descriptor(sc->sc_ue.ue_udev); 620 621 err = usbd_req_set_config(sc->sc_ue.ue_udev, &sc->sc_mtx, 622 cd->bConfigurationValue); 623 if (err) 624 DPRINTF("reset failed (ignored)\n"); 625 626 /* Wait a little while for the chip to get its brains in order. */ 627 uether_pause(&sc->sc_ue, hz / 100); 628} 629 630static void 631axe_attach_post(struct usb_ether *ue) 632{ 633 struct axe_softc *sc = uether_getsc(ue); 634 635 /* 636 * Load PHY indexes first. Needed by axe_xxx_init(). 637 */ 638 axe_cmd(sc, AXE_CMD_READ_PHYID, 0, 0, sc->sc_phyaddrs); 639#if 1 640 device_printf(sc->sc_ue.ue_dev, "PHYADDR 0x%02x:0x%02x\n", 641 sc->sc_phyaddrs[0], sc->sc_phyaddrs[1]); 642#endif 643 sc->sc_phyno = axe_get_phyno(sc, AXE_PHY_SEL_PRI); 644 if (sc->sc_phyno == -1) 645 sc->sc_phyno = axe_get_phyno(sc, AXE_PHY_SEL_SEC); 646 if (sc->sc_phyno == -1) { 647 device_printf(sc->sc_ue.ue_dev, 648 "no valid PHY address found, assuming PHY address 0\n"); 649 sc->sc_phyno = 0; 650 } 651 652 if (sc->sc_flags & AXE_FLAG_178) 653 axe_ax88178_init(sc); 654 else if (sc->sc_flags & AXE_FLAG_772) 655 axe_ax88772_init(sc); 656 657 /* 658 * Get station address. 659 */ 660 if (sc->sc_flags & (AXE_FLAG_178 | AXE_FLAG_772)) 661 axe_cmd(sc, AXE_178_CMD_READ_NODEID, 0, 0, ue->ue_eaddr); 662 else 663 axe_cmd(sc, AXE_172_CMD_READ_NODEID, 0, 0, ue->ue_eaddr); 664 665 /* 666 * Fetch IPG values. 667 */ 668 axe_cmd(sc, AXE_CMD_READ_IPG012, 0, 0, sc->sc_ipgs); 669} 670 671/* 672 * Probe for a AX88172 chip. 673 */ 674static int 675axe_probe(device_t dev) 676{ 677 struct usb_attach_arg *uaa = device_get_ivars(dev); 678 679 if (uaa->usb_mode != USB_MODE_HOST) 680 return (ENXIO); 681 if (uaa->info.bConfigIndex != AXE_CONFIG_IDX) 682 return (ENXIO); 683 if (uaa->info.bIfaceIndex != AXE_IFACE_IDX) 684 return (ENXIO); 685 686 return (usbd_lookup_id_by_uaa(axe_devs, sizeof(axe_devs), uaa)); 687} 688 689/* 690 * Attach the interface. Allocate softc structures, do ifmedia 691 * setup and ethernet/BPF attach. 692 */ 693static int 694axe_attach(device_t dev) 695{ 696 struct usb_attach_arg *uaa = device_get_ivars(dev); 697 struct axe_softc *sc = device_get_softc(dev); 698 struct usb_ether *ue = &sc->sc_ue; 699 uint8_t iface_index; 700 int error; 701 702 sc->sc_flags = USB_GET_DRIVER_INFO(uaa); 703 704 device_set_usb_desc(dev); 705 706 mtx_init(&sc->sc_mtx, device_get_nameunit(dev), NULL, MTX_DEF); 707 708 iface_index = AXE_IFACE_IDX; 709 error = usbd_transfer_setup(uaa->device, &iface_index, sc->sc_xfer, 710 axe_config, AXE_N_TRANSFER, sc, &sc->sc_mtx); 711 if (error) { 712 device_printf(dev, "allocating USB transfers failed!\n"); 713 goto detach; 714 } 715 716 ue->ue_sc = sc; 717 ue->ue_dev = dev; 718 ue->ue_udev = uaa->device; 719 ue->ue_mtx = &sc->sc_mtx; 720 ue->ue_methods = &axe_ue_methods; 721 722 error = uether_ifattach(ue); 723 if (error) { 724 device_printf(dev, "could not attach interface\n"); 725 goto detach; 726 } 727 return (0); /* success */ 728 729detach: 730 axe_detach(dev); 731 return (ENXIO); /* failure */ 732} 733 734static int 735axe_detach(device_t dev) 736{ 737 struct axe_softc *sc = device_get_softc(dev); 738 struct usb_ether *ue = &sc->sc_ue; 739 740 usbd_transfer_unsetup(sc->sc_xfer, AXE_N_TRANSFER); 741 uether_ifdetach(ue); 742 mtx_destroy(&sc->sc_mtx); 743 744 return (0); 745} 746 747static void 748axe_intr_callback(struct usb_xfer *xfer, usb_error_t error) 749{ 750 switch (USB_GET_STATE(xfer)) { 751 case USB_ST_TRANSFERRED: 752 case USB_ST_SETUP: 753tr_setup: 754 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 755 usbd_transfer_submit(xfer); 756 return; 757 758 default: /* Error */ 759 if (error != USB_ERR_CANCELLED) { 760 /* try to clear stall first */ 761 usbd_xfer_set_stall(xfer); 762 goto tr_setup; 763 } 764 return; 765 } 766} 767 768#if (AXE_BULK_BUF_SIZE >= 0x10000) 769#error "Please update axe_bulk_read_callback()!" 770#endif 771 772static void 773axe_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error) 774{ 775 struct axe_softc *sc = usbd_xfer_softc(xfer); 776 struct usb_ether *ue = &sc->sc_ue; 777 struct ifnet *ifp = uether_getifp(ue); 778 struct axe_sframe_hdr hdr; 779 struct usb_page_cache *pc; 780 int err, pos, len, adjust; 781 int actlen; 782 783 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 784 785 switch (USB_GET_STATE(xfer)) { 786 case USB_ST_TRANSFERRED: 787 pos = 0; 788 pc = usbd_xfer_get_frame(xfer, 0); 789 while (1) { 790 if (sc->sc_flags & (AXE_FLAG_772 | AXE_FLAG_178)) { 791 if (actlen < sizeof(hdr)) { 792 /* too little data */ 793 break; 794 } 795 usbd_copy_out(pc, pos, &hdr, sizeof(hdr)); 796 797 if ((hdr.len ^ hdr.ilen) != 0xFFFF) { 798 /* we lost sync */ 799 break; 800 } 801 actlen -= sizeof(hdr); 802 pos += sizeof(hdr); 803 804 len = le16toh(hdr.len); 805 if (len > actlen) { 806 /* invalid length */ 807 break; 808 } 809 adjust = (len & 1); 810 811 } else { 812 len = actlen; 813 adjust = 0; 814 } 815 err = uether_rxbuf(ue, pc, pos, len); 816 if (err) 817 break; 818 819 pos += len; 820 actlen -= len; 821 822 if (actlen <= adjust) { 823 /* we are finished */ 824 goto tr_setup; 825 } 826 pos += adjust; 827 actlen -= adjust; 828 } 829 830 /* count an error */ 831 ifp->if_ierrors++; 832 833 /* FALLTHROUGH */ 834 case USB_ST_SETUP: 835tr_setup: 836 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 837 usbd_transfer_submit(xfer); 838 uether_rxflush(ue); 839 return; 840 841 default: /* Error */ 842 DPRINTF("bulk read error, %s\n", usbd_errstr(error)); 843 844 if (error != USB_ERR_CANCELLED) { 845 /* try to clear stall first */ 846 usbd_xfer_set_stall(xfer); 847 goto tr_setup; 848 } 849 return; 850 851 } 852} 853 854#if ((AXE_BULK_BUF_SIZE >= 0x10000) || (AXE_BULK_BUF_SIZE < (MCLBYTES+4))) 855#error "Please update axe_bulk_write_callback()!" 856#endif 857 858static void 859axe_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error) 860{ 861 struct axe_softc *sc = usbd_xfer_softc(xfer); 862 struct axe_sframe_hdr hdr; 863 struct ifnet *ifp = uether_getifp(&sc->sc_ue); 864 struct usb_page_cache *pc; 865 struct mbuf *m; 866 int pos; 867 868 switch (USB_GET_STATE(xfer)) { 869 case USB_ST_TRANSFERRED: 870 DPRINTFN(11, "transfer complete\n"); 871 ifp->if_opackets++; 872 /* FALLTHROUGH */ 873 case USB_ST_SETUP: 874tr_setup: 875 if ((sc->sc_flags & AXE_FLAG_LINK) == 0) { 876 /* 877 * don't send anything if there is no link ! 878 */ 879 return; 880 } 881 pos = 0; 882 pc = usbd_xfer_get_frame(xfer, 0); 883 884 while (1) { 885 886 IFQ_DRV_DEQUEUE(&ifp->if_snd, m); 887 888 if (m == NULL) { 889 if (pos > 0) 890 break; /* send out data */ 891 return; 892 } 893 if (m->m_pkthdr.len > MCLBYTES) { 894 m->m_pkthdr.len = MCLBYTES; 895 } 896 if (sc->sc_flags & (AXE_FLAG_772 | AXE_FLAG_178)) { 897 898 hdr.len = htole16(m->m_pkthdr.len); 899 hdr.ilen = ~hdr.len; 900 901 usbd_copy_in(pc, pos, &hdr, sizeof(hdr)); 902 903 pos += sizeof(hdr); 904 905 /* 906 * NOTE: Some drivers force a short packet 907 * by appending a dummy header with zero 908 * length at then end of the USB transfer. 909 * This driver uses the 910 * USB_FORCE_SHORT_XFER flag instead. 911 */ 912 } 913 usbd_m_copy_in(pc, pos, m, 0, m->m_pkthdr.len); 914 pos += m->m_pkthdr.len; 915 916 /* 917 * if there's a BPF listener, bounce a copy 918 * of this frame to him: 919 */ 920 BPF_MTAP(ifp, m); 921 922 m_freem(m); 923 924 if (sc->sc_flags & (AXE_FLAG_772 | AXE_FLAG_178)) { 925 if (pos > (AXE_BULK_BUF_SIZE - MCLBYTES - sizeof(hdr))) { 926 /* send out frame(s) */ 927 break; 928 } 929 } else { 930 /* send out frame */ 931 break; 932 } 933 } 934 935 usbd_xfer_set_frame_len(xfer, 0, pos); 936 usbd_transfer_submit(xfer); 937 return; 938 939 default: /* Error */ 940 DPRINTFN(11, "transfer error, %s\n", 941 usbd_errstr(error)); 942 943 ifp->if_oerrors++; 944 945 if (error != USB_ERR_CANCELLED) { 946 /* try to clear stall first */ 947 usbd_xfer_set_stall(xfer); 948 goto tr_setup; 949 } 950 return; 951 952 } 953} 954 955static void 956axe_tick(struct usb_ether *ue) 957{ 958 struct axe_softc *sc = uether_getsc(ue); 959 struct mii_data *mii = GET_MII(sc); 960 961 AXE_LOCK_ASSERT(sc, MA_OWNED); 962 963 mii_tick(mii); 964 if ((sc->sc_flags & AXE_FLAG_LINK) == 0) { 965 axe_miibus_statchg(ue->ue_dev); 966 if ((sc->sc_flags & AXE_FLAG_LINK) != 0) 967 axe_start(ue); 968 } 969} 970 971static void 972axe_start(struct usb_ether *ue) 973{ 974 struct axe_softc *sc = uether_getsc(ue); 975 976 /* 977 * start the USB transfers, if not already started: 978 */ 979 usbd_transfer_start(sc->sc_xfer[AXE_INTR_DT_RD]); 980 usbd_transfer_start(sc->sc_xfer[AXE_BULK_DT_RD]); 981 usbd_transfer_start(sc->sc_xfer[AXE_BULK_DT_WR]); 982} 983 984static void 985axe_init(struct usb_ether *ue) 986{ 987 struct axe_softc *sc = uether_getsc(ue); 988 struct ifnet *ifp = uether_getifp(ue); 989 uint16_t rxmode; 990 991 AXE_LOCK_ASSERT(sc, MA_OWNED); 992 993 /* Cancel pending I/O */ 994 axe_stop(ue); 995 996#ifdef notdef 997 /* Set MAC address */ 998 axe_mac(sc, IF_LLADDR(ifp), 1); 999#endif 1000 1001 /* Set transmitter IPG values */ 1002 if (sc->sc_flags & (AXE_FLAG_178 | AXE_FLAG_772)) { 1003 axe_cmd(sc, AXE_178_CMD_WRITE_IPG012, sc->sc_ipgs[2], 1004 (sc->sc_ipgs[1] << 8) | (sc->sc_ipgs[0]), NULL); 1005 } else { 1006 axe_cmd(sc, AXE_172_CMD_WRITE_IPG0, 0, sc->sc_ipgs[0], NULL); 1007 axe_cmd(sc, AXE_172_CMD_WRITE_IPG1, 0, sc->sc_ipgs[1], NULL); 1008 axe_cmd(sc, AXE_172_CMD_WRITE_IPG2, 0, sc->sc_ipgs[2], NULL); 1009 } 1010 1011 /* Enable receiver, set RX mode */ 1012 rxmode = (AXE_RXCMD_MULTICAST | AXE_RXCMD_ENABLE); 1013 if (sc->sc_flags & (AXE_FLAG_178 | AXE_FLAG_772)) { 1014 rxmode |= AXE_178_RXCMD_MFB_2048; /* chip default */ 1015 } else { 1016 rxmode |= AXE_172_RXCMD_UNICAST; 1017 } 1018 1019 /* If we want promiscuous mode, set the allframes bit. */ 1020 if (ifp->if_flags & IFF_PROMISC) 1021 rxmode |= AXE_RXCMD_PROMISC; 1022 1023 if (ifp->if_flags & IFF_BROADCAST) 1024 rxmode |= AXE_RXCMD_BROADCAST; 1025 1026 axe_cmd(sc, AXE_CMD_RXCTL_WRITE, 0, rxmode, NULL); 1027 1028 /* Load the multicast filter. */ 1029 axe_setmulti(ue); 1030 1031 usbd_xfer_set_stall(sc->sc_xfer[AXE_BULK_DT_WR]); 1032 1033 ifp->if_drv_flags |= IFF_DRV_RUNNING; 1034 axe_start(ue); 1035} 1036 1037static void 1038axe_setpromisc(struct usb_ether *ue) 1039{ 1040 struct axe_softc *sc = uether_getsc(ue); 1041 struct ifnet *ifp = uether_getifp(ue); 1042 uint16_t rxmode; 1043 1044 axe_cmd(sc, AXE_CMD_RXCTL_READ, 0, 0, &rxmode); 1045 1046 rxmode = le16toh(rxmode); 1047 1048 if (ifp->if_flags & IFF_PROMISC) { 1049 rxmode |= AXE_RXCMD_PROMISC; 1050 } else { 1051 rxmode &= ~AXE_RXCMD_PROMISC; 1052 } 1053 1054 axe_cmd(sc, AXE_CMD_RXCTL_WRITE, 0, rxmode, NULL); 1055 1056 axe_setmulti(ue); 1057} 1058 1059static void 1060axe_stop(struct usb_ether *ue) 1061{ 1062 struct axe_softc *sc = uether_getsc(ue); 1063 struct ifnet *ifp = uether_getifp(ue); 1064 1065 AXE_LOCK_ASSERT(sc, MA_OWNED); 1066 1067 ifp->if_drv_flags &= ~IFF_DRV_RUNNING; 1068 sc->sc_flags &= ~AXE_FLAG_LINK; 1069 1070 /* 1071 * stop all the transfers, if not already stopped: 1072 */ 1073 usbd_transfer_stop(sc->sc_xfer[AXE_BULK_DT_WR]); 1074 usbd_transfer_stop(sc->sc_xfer[AXE_BULK_DT_RD]); 1075 usbd_transfer_stop(sc->sc_xfer[AXE_INTR_DT_RD]); 1076 1077 axe_reset(sc); 1078} 1079