2 * Copyright (c) 2015-2016 Kevin Lo <kevlo@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/systm.h>
33 #include <sys/condvar.h>
34 #include <sys/kernel.h>
36 #include <sys/module.h>
37 #include <sys/mutex.h>
38 #include <sys/socket.h>
39 #include <sys/sysctl.h>
40 #include <sys/unistd.h>
43 #include <net/if_var.h>
45 #include <dev/usb/usb.h>
46 #include <dev/usb/usbdi.h>
47 #include <dev/usb/usbdi_util.h>
50 #define USB_DEBUG_VAR ure_debug
51 #include <dev/usb/usb_debug.h>
52 #include <dev/usb/usb_process.h>
54 #include <dev/usb/net/usb_ethernet.h>
55 #include <dev/usb/net/if_urereg.h>
58 static int ure_debug = 0;
60 static SYSCTL_NODE(_hw_usb, OID_AUTO, ure, CTLFLAG_RW, 0, "USB ure");
61 SYSCTL_INT(_hw_usb_ure, OID_AUTO, debug, CTLFLAG_RWTUN, &ure_debug, 0,
65 #define ETHER_IS_ZERO(addr) \
66 (!(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]))
69 * Various supported device vendors/products.
71 static const STRUCT_USB_HOST_ID ure_devs[] = {
72 #define URE_DEV(v,p,i) { USB_VPI(USB_VENDOR_##v, USB_PRODUCT_##v##_##p, i) }
73 URE_DEV(LENOVO, RTL8153, 0),
74 URE_DEV(LENOVO, TBT3LAN, 0),
75 URE_DEV(LENOVO, ONELINK, 0),
76 URE_DEV(LENOVO, USBCLAN, 0),
77 URE_DEV(NVIDIA, RTL8153, 0),
78 URE_DEV(REALTEK, RTL8152, URE_FLAG_8152),
79 URE_DEV(REALTEK, RTL8153, 0),
80 URE_DEV(TPLINK, RTL8153, 0),
84 static device_probe_t ure_probe;
85 static device_attach_t ure_attach;
86 static device_detach_t ure_detach;
88 static usb_callback_t ure_bulk_read_callback;
89 static usb_callback_t ure_bulk_write_callback;
91 static miibus_readreg_t ure_miibus_readreg;
92 static miibus_writereg_t ure_miibus_writereg;
93 static miibus_statchg_t ure_miibus_statchg;
95 static uether_fn_t ure_attach_post;
96 static uether_fn_t ure_init;
97 static uether_fn_t ure_stop;
98 static uether_fn_t ure_start;
99 static uether_fn_t ure_tick;
100 static uether_fn_t ure_rxfilter;
102 static int ure_ctl(struct ure_softc *, uint8_t, uint16_t, uint16_t,
104 static int ure_read_mem(struct ure_softc *, uint16_t, uint16_t, void *,
106 static int ure_write_mem(struct ure_softc *, uint16_t, uint16_t, void *,
108 static uint8_t ure_read_1(struct ure_softc *, uint16_t, uint16_t);
109 static uint16_t ure_read_2(struct ure_softc *, uint16_t, uint16_t);
110 static uint32_t ure_read_4(struct ure_softc *, uint16_t, uint16_t);
111 static int ure_write_1(struct ure_softc *, uint16_t, uint16_t, uint32_t);
112 static int ure_write_2(struct ure_softc *, uint16_t, uint16_t, uint32_t);
113 static int ure_write_4(struct ure_softc *, uint16_t, uint16_t, uint32_t);
114 static uint16_t ure_ocp_reg_read(struct ure_softc *, uint16_t);
115 static void ure_ocp_reg_write(struct ure_softc *, uint16_t, uint16_t);
117 static void ure_read_chipver(struct ure_softc *);
118 static int ure_attach_post_sub(struct usb_ether *);
119 static void ure_reset(struct ure_softc *);
120 static int ure_ifmedia_upd(struct ifnet *);
121 static void ure_ifmedia_sts(struct ifnet *, struct ifmediareq *);
122 static int ure_ioctl(struct ifnet *, u_long, caddr_t);
123 static void ure_rtl8152_init(struct ure_softc *);
124 static void ure_rtl8153_init(struct ure_softc *);
125 static void ure_disable_teredo(struct ure_softc *);
126 static void ure_init_fifo(struct ure_softc *);
128 static const struct usb_config ure_config[URE_N_TRANSFER] = {
131 .endpoint = UE_ADDR_ANY,
132 .direction = UE_DIR_OUT,
134 .flags = {.pipe_bof = 1,.force_short_xfer = 1,},
135 .callback = ure_bulk_write_callback,
136 .timeout = 10000, /* 10 seconds */
140 .endpoint = UE_ADDR_ANY,
141 .direction = UE_DIR_IN,
143 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
144 .callback = ure_bulk_read_callback,
145 .timeout = 0, /* no timeout */
149 static device_method_t ure_methods[] = {
150 /* Device interface. */
151 DEVMETHOD(device_probe, ure_probe),
152 DEVMETHOD(device_attach, ure_attach),
153 DEVMETHOD(device_detach, ure_detach),
156 DEVMETHOD(miibus_readreg, ure_miibus_readreg),
157 DEVMETHOD(miibus_writereg, ure_miibus_writereg),
158 DEVMETHOD(miibus_statchg, ure_miibus_statchg),
163 static driver_t ure_driver = {
165 .methods = ure_methods,
166 .size = sizeof(struct ure_softc),
169 static devclass_t ure_devclass;
171 DRIVER_MODULE(ure, uhub, ure_driver, ure_devclass, NULL, NULL);
172 DRIVER_MODULE(miibus, ure, miibus_driver, miibus_devclass, NULL, NULL);
173 MODULE_DEPEND(ure, uether, 1, 1, 1);
174 MODULE_DEPEND(ure, usb, 1, 1, 1);
175 MODULE_DEPEND(ure, ether, 1, 1, 1);
176 MODULE_DEPEND(ure, miibus, 1, 1, 1);
177 MODULE_VERSION(ure, 1);
178 USB_PNP_HOST_INFO(ure_devs);
180 static const struct usb_ether_methods ure_ue_methods = {
181 .ue_attach_post = ure_attach_post,
182 .ue_attach_post_sub = ure_attach_post_sub,
183 .ue_start = ure_start,
187 .ue_setmulti = ure_rxfilter,
188 .ue_setpromisc = ure_rxfilter,
189 .ue_mii_upd = ure_ifmedia_upd,
190 .ue_mii_sts = ure_ifmedia_sts,
194 ure_ctl(struct ure_softc *sc, uint8_t rw, uint16_t val, uint16_t index,
197 struct usb_device_request req;
199 URE_LOCK_ASSERT(sc, MA_OWNED);
201 if (rw == URE_CTL_WRITE)
202 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
204 req.bmRequestType = UT_READ_VENDOR_DEVICE;
205 req.bRequest = UR_SET_ADDRESS;
206 USETW(req.wValue, val);
207 USETW(req.wIndex, index);
208 USETW(req.wLength, len);
210 return (uether_do_request(&sc->sc_ue, &req, buf, 1000));
214 ure_read_mem(struct ure_softc *sc, uint16_t addr, uint16_t index,
218 return (ure_ctl(sc, URE_CTL_READ, addr, index, buf, len));
222 ure_write_mem(struct ure_softc *sc, uint16_t addr, uint16_t index,
226 return (ure_ctl(sc, URE_CTL_WRITE, addr, index, buf, len));
230 ure_read_1(struct ure_softc *sc, uint16_t reg, uint16_t index)
236 shift = (reg & 3) << 3;
239 ure_read_mem(sc, reg, index, &temp, 4);
247 ure_read_2(struct ure_softc *sc, uint16_t reg, uint16_t index)
253 shift = (reg & 2) << 3;
256 ure_read_mem(sc, reg, index, &temp, 4);
260 return (val & 0xffff);
264 ure_read_4(struct ure_softc *sc, uint16_t reg, uint16_t index)
268 ure_read_mem(sc, reg, index, &temp, 4);
269 return (UGETDW(temp));
273 ure_write_1(struct ure_softc *sc, uint16_t reg, uint16_t index, uint32_t val)
279 byen = URE_BYTE_EN_BYTE;
285 val <<= (shift << 3);
290 return (ure_write_mem(sc, reg, index | byen, &temp, 4));
294 ure_write_2(struct ure_softc *sc, uint16_t reg, uint16_t index, uint32_t val)
300 byen = URE_BYTE_EN_WORD;
306 val <<= (shift << 3);
311 return (ure_write_mem(sc, reg, index | byen, &temp, 4));
315 ure_write_4(struct ure_softc *sc, uint16_t reg, uint16_t index, uint32_t val)
320 return (ure_write_mem(sc, reg, index | URE_BYTE_EN_DWORD, &temp, 4));
324 ure_ocp_reg_read(struct ure_softc *sc, uint16_t addr)
328 ure_write_2(sc, URE_PLA_OCP_GPHY_BASE, URE_MCU_TYPE_PLA, addr & 0xf000);
329 reg = (addr & 0x0fff) | 0xb000;
331 return (ure_read_2(sc, reg, URE_MCU_TYPE_PLA));
335 ure_ocp_reg_write(struct ure_softc *sc, uint16_t addr, uint16_t data)
339 ure_write_2(sc, URE_PLA_OCP_GPHY_BASE, URE_MCU_TYPE_PLA, addr & 0xf000);
340 reg = (addr & 0x0fff) | 0xb000;
342 ure_write_2(sc, reg, URE_MCU_TYPE_PLA, data);
346 ure_miibus_readreg(device_t dev, int phy, int reg)
348 struct ure_softc *sc;
352 sc = device_get_softc(dev);
353 locked = mtx_owned(&sc->sc_mtx);
357 /* Let the rgephy driver read the URE_GMEDIASTAT register. */
358 if (reg == URE_GMEDIASTAT) {
361 return (ure_read_1(sc, URE_GMEDIASTAT, URE_MCU_TYPE_PLA));
364 val = ure_ocp_reg_read(sc, URE_OCP_BASE_MII + reg * 2);
372 ure_miibus_writereg(device_t dev, int phy, int reg, int val)
374 struct ure_softc *sc;
377 sc = device_get_softc(dev);
378 if (sc->sc_phyno != phy)
381 locked = mtx_owned(&sc->sc_mtx);
385 ure_ocp_reg_write(sc, URE_OCP_BASE_MII + reg * 2, val);
393 ure_miibus_statchg(device_t dev)
395 struct ure_softc *sc;
396 struct mii_data *mii;
400 sc = device_get_softc(dev);
402 locked = mtx_owned(&sc->sc_mtx);
406 ifp = uether_getifp(&sc->sc_ue);
407 if (mii == NULL || ifp == NULL ||
408 (ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
411 sc->sc_flags &= ~URE_FLAG_LINK;
412 if ((mii->mii_media_status & (IFM_ACTIVE | IFM_AVALID)) ==
413 (IFM_ACTIVE | IFM_AVALID)) {
414 switch (IFM_SUBTYPE(mii->mii_media_active)) {
417 sc->sc_flags |= URE_FLAG_LINK;
420 if ((sc->sc_flags & URE_FLAG_8152) != 0)
422 sc->sc_flags |= URE_FLAG_LINK;
429 /* Lost link, do nothing. */
430 if ((sc->sc_flags & URE_FLAG_LINK) == 0)
438 * Probe for a RTL8152/RTL8153 chip.
441 ure_probe(device_t dev)
443 struct usb_attach_arg *uaa;
445 uaa = device_get_ivars(dev);
446 if (uaa->usb_mode != USB_MODE_HOST)
448 if (uaa->info.bConfigIndex != URE_CONFIG_IDX)
450 if (uaa->info.bIfaceIndex != URE_IFACE_IDX)
453 return (usbd_lookup_id_by_uaa(ure_devs, sizeof(ure_devs), uaa));
457 * Attach the interface. Allocate softc structures, do ifmedia
458 * setup and ethernet/BPF attach.
461 ure_attach(device_t dev)
463 struct usb_attach_arg *uaa = device_get_ivars(dev);
464 struct ure_softc *sc = device_get_softc(dev);
465 struct usb_ether *ue = &sc->sc_ue;
469 sc->sc_flags = USB_GET_DRIVER_INFO(uaa);
470 device_set_usb_desc(dev);
471 mtx_init(&sc->sc_mtx, device_get_nameunit(dev), NULL, MTX_DEF);
473 iface_index = URE_IFACE_IDX;
474 error = usbd_transfer_setup(uaa->device, &iface_index, sc->sc_xfer,
475 ure_config, URE_N_TRANSFER, sc, &sc->sc_mtx);
477 device_printf(dev, "allocating USB transfers failed\n");
483 ue->ue_udev = uaa->device;
484 ue->ue_mtx = &sc->sc_mtx;
485 ue->ue_methods = &ure_ue_methods;
487 error = uether_ifattach(ue);
489 device_printf(dev, "could not attach interface\n");
492 return (0); /* success */
496 return (ENXIO); /* failure */
500 ure_detach(device_t dev)
502 struct ure_softc *sc = device_get_softc(dev);
503 struct usb_ether *ue = &sc->sc_ue;
505 usbd_transfer_unsetup(sc->sc_xfer, URE_N_TRANSFER);
507 mtx_destroy(&sc->sc_mtx);
513 ure_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
515 struct ure_softc *sc = usbd_xfer_softc(xfer);
516 struct usb_ether *ue = &sc->sc_ue;
517 struct ifnet *ifp = uether_getifp(ue);
518 struct usb_page_cache *pc;
519 struct ure_rxpkt pkt;
522 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
524 switch (USB_GET_STATE(xfer)) {
525 case USB_ST_TRANSFERRED:
526 if (actlen < (int)(sizeof(pkt))) {
527 if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
530 pc = usbd_xfer_get_frame(xfer, 0);
531 usbd_copy_out(pc, 0, &pkt, sizeof(pkt));
532 len = le32toh(pkt.ure_pktlen) & URE_RXPKT_LEN_MASK;
533 len -= ETHER_CRC_LEN;
534 if (actlen < (int)(len + sizeof(pkt))) {
535 if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
539 uether_rxbuf(ue, pc, sizeof(pkt), len);
543 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
544 usbd_transfer_submit(xfer);
549 DPRINTF("bulk read error, %s\n",
552 if (error != USB_ERR_CANCELLED) {
553 /* try to clear stall first */
554 usbd_xfer_set_stall(xfer);
562 ure_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
564 struct ure_softc *sc = usbd_xfer_softc(xfer);
565 struct ifnet *ifp = uether_getifp(&sc->sc_ue);
566 struct usb_page_cache *pc;
568 struct ure_txpkt txpkt;
571 switch (USB_GET_STATE(xfer)) {
572 case USB_ST_TRANSFERRED:
573 DPRINTFN(11, "transfer complete\n");
574 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
578 if ((sc->sc_flags & URE_FLAG_LINK) == 0 ||
579 (ifp->if_drv_flags & IFF_DRV_OACTIVE) != 0) {
581 * don't send anything if there is no link !
585 IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
589 len = m->m_pkthdr.len;
590 pc = usbd_xfer_get_frame(xfer, 0);
591 memset(&txpkt, 0, sizeof(txpkt));
592 txpkt.ure_pktlen = htole32((len & URE_TXPKT_LEN_MASK) |
593 URE_TKPKT_TX_FS | URE_TKPKT_TX_LS);
594 usbd_copy_in(pc, pos, &txpkt, sizeof(txpkt));
595 pos += sizeof(txpkt);
596 usbd_m_copy_in(pc, pos, m, 0, m->m_pkthdr.len);
597 pos += m->m_pkthdr.len;
599 if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1);
602 * If there's a BPF listener, bounce a copy
603 * of this frame to him.
609 /* Set frame length. */
610 usbd_xfer_set_frame_len(xfer, 0, pos);
612 usbd_transfer_submit(xfer);
613 ifp->if_drv_flags |= IFF_DRV_OACTIVE;
616 DPRINTFN(11, "transfer error, %s\n",
619 if_inc_counter(ifp, IFCOUNTER_OERRORS, 1);
620 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
622 if (error != USB_ERR_CANCELLED) {
623 /* try to clear stall first */
624 usbd_xfer_set_stall(xfer);
632 ure_read_chipver(struct ure_softc *sc)
636 ver = ure_read_2(sc, URE_PLA_TCR1, URE_MCU_TYPE_PLA) & URE_VERSION_MASK;
639 sc->sc_chip |= URE_CHIP_VER_4C00;
642 sc->sc_chip |= URE_CHIP_VER_4C10;
645 sc->sc_chip |= URE_CHIP_VER_5C00;
648 sc->sc_chip |= URE_CHIP_VER_5C10;
651 sc->sc_chip |= URE_CHIP_VER_5C20;
654 sc->sc_chip |= URE_CHIP_VER_5C30;
657 device_printf(sc->sc_ue.ue_dev,
658 "unknown version 0x%04x\n", ver);
664 ure_attach_post(struct usb_ether *ue)
666 struct ure_softc *sc = uether_getsc(ue);
670 /* Determine the chip version. */
671 ure_read_chipver(sc);
673 /* Initialize controller and get station address. */
674 if (sc->sc_flags & URE_FLAG_8152)
675 ure_rtl8152_init(sc);
677 ure_rtl8153_init(sc);
679 if ((sc->sc_chip & URE_CHIP_VER_4C00) ||
680 (sc->sc_chip & URE_CHIP_VER_4C10))
681 ure_read_mem(sc, URE_PLA_IDR, URE_MCU_TYPE_PLA,
684 ure_read_mem(sc, URE_PLA_BACKUP, URE_MCU_TYPE_PLA,
687 if (ETHER_IS_ZERO(sc->sc_ue.ue_eaddr)) {
688 device_printf(sc->sc_ue.ue_dev, "MAC assigned randomly\n");
689 arc4rand(sc->sc_ue.ue_eaddr, ETHER_ADDR_LEN, 0);
690 sc->sc_ue.ue_eaddr[0] &= ~0x01; /* unicast */
691 sc->sc_ue.ue_eaddr[0] |= 0x02; /* locally administered */
696 ure_attach_post_sub(struct usb_ether *ue)
698 struct ure_softc *sc;
702 sc = uether_getsc(ue);
704 ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
705 ifp->if_start = uether_start;
706 ifp->if_ioctl = ure_ioctl;
707 ifp->if_init = uether_init;
708 IFQ_SET_MAXLEN(&ifp->if_snd, ifqmaxlen);
709 ifp->if_snd.ifq_drv_maxlen = ifqmaxlen;
710 IFQ_SET_READY(&ifp->if_snd);
713 error = mii_attach(ue->ue_dev, &ue->ue_miibus, ifp,
714 uether_ifmedia_upd, ue->ue_methods->ue_mii_sts,
715 BMSR_DEFCAPMASK, sc->sc_phyno, MII_OFFSET_ANY, 0);
722 ure_init(struct usb_ether *ue)
724 struct ure_softc *sc = uether_getsc(ue);
725 struct ifnet *ifp = uether_getifp(ue);
727 URE_LOCK_ASSERT(sc, MA_OWNED);
729 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) != 0)
732 /* Cancel pending I/O. */
737 /* Set MAC address. */
738 ure_write_1(sc, URE_PLA_CRWECR, URE_MCU_TYPE_PLA, URE_CRWECR_CONFIG);
739 ure_write_mem(sc, URE_PLA_IDR, URE_MCU_TYPE_PLA | URE_BYTE_EN_SIX_BYTES,
741 ure_write_1(sc, URE_PLA_CRWECR, URE_MCU_TYPE_PLA, URE_CRWECR_NORAML);
743 /* Reset the packet filter. */
744 ure_write_2(sc, URE_PLA_FMC, URE_MCU_TYPE_PLA,
745 ure_read_2(sc, URE_PLA_FMC, URE_MCU_TYPE_PLA) &
746 ~URE_FMC_FCR_MCU_EN);
747 ure_write_2(sc, URE_PLA_FMC, URE_MCU_TYPE_PLA,
748 ure_read_2(sc, URE_PLA_FMC, URE_MCU_TYPE_PLA) |
751 /* Enable transmit and receive. */
752 ure_write_1(sc, URE_PLA_CR, URE_MCU_TYPE_PLA,
753 ure_read_1(sc, URE_PLA_CR, URE_MCU_TYPE_PLA) | URE_CR_RE |
756 ure_write_2(sc, URE_PLA_MISC_1, URE_MCU_TYPE_PLA,
757 ure_read_2(sc, URE_PLA_MISC_1, URE_MCU_TYPE_PLA) &
760 /* Configure RX filters. */
763 usbd_xfer_set_stall(sc->sc_xfer[URE_BULK_DT_WR]);
765 /* Indicate we are up and running. */
766 ifp->if_drv_flags |= IFF_DRV_RUNNING;
768 /* Switch to selected media. */
769 ure_ifmedia_upd(ifp);
773 ure_tick(struct usb_ether *ue)
775 struct ure_softc *sc = uether_getsc(ue);
776 struct mii_data *mii = GET_MII(sc);
778 URE_LOCK_ASSERT(sc, MA_OWNED);
781 if ((sc->sc_flags & URE_FLAG_LINK) == 0
782 && mii->mii_media_status & IFM_ACTIVE &&
783 IFM_SUBTYPE(mii->mii_media_active) != IFM_NONE) {
784 sc->sc_flags |= URE_FLAG_LINK;
790 * Program the 64-bit multicast hash filter.
793 ure_rxfilter(struct usb_ether *ue)
795 struct ure_softc *sc = uether_getsc(ue);
796 struct ifnet *ifp = uether_getifp(ue);
797 struct ifmultiaddr *ifma;
799 uint32_t hashes[2] = { 0, 0 };
801 URE_LOCK_ASSERT(sc, MA_OWNED);
803 rxmode = URE_RCR_APM;
804 if (ifp->if_flags & IFF_BROADCAST)
805 rxmode |= URE_RCR_AB;
806 if (ifp->if_flags & (IFF_ALLMULTI | IFF_PROMISC)) {
807 if (ifp->if_flags & IFF_PROMISC)
808 rxmode |= URE_RCR_AAP;
809 rxmode |= URE_RCR_AM;
810 hashes[0] = hashes[1] = 0xffffffff;
814 rxmode |= URE_RCR_AM;
816 CK_STAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
817 if (ifma->ifma_addr->sa_family != AF_LINK)
819 h = ether_crc32_be(LLADDR((struct sockaddr_dl *)
820 ifma->ifma_addr), ETHER_ADDR_LEN) >> 26;
822 hashes[0] |= (1 << h);
824 hashes[1] |= (1 << (h - 32));
826 if_maddr_runlock(ifp);
828 h = bswap32(hashes[0]);
829 hashes[0] = bswap32(hashes[1]);
831 rxmode |= URE_RCR_AM;
834 ure_write_4(sc, URE_PLA_MAR0, URE_MCU_TYPE_PLA, hashes[0]);
835 ure_write_4(sc, URE_PLA_MAR4, URE_MCU_TYPE_PLA, hashes[1]);
836 ure_write_4(sc, URE_PLA_RCR, URE_MCU_TYPE_PLA, rxmode);
840 ure_start(struct usb_ether *ue)
842 struct ure_softc *sc = uether_getsc(ue);
845 * start the USB transfers, if not already started:
847 usbd_transfer_start(sc->sc_xfer[URE_BULK_DT_RD]);
848 usbd_transfer_start(sc->sc_xfer[URE_BULK_DT_WR]);
852 ure_reset(struct ure_softc *sc)
856 ure_write_1(sc, URE_PLA_CR, URE_MCU_TYPE_PLA, URE_CR_RST);
858 for (i = 0; i < URE_TIMEOUT; i++) {
859 if (!(ure_read_1(sc, URE_PLA_CR, URE_MCU_TYPE_PLA) &
862 uether_pause(&sc->sc_ue, hz / 100);
864 if (i == URE_TIMEOUT)
865 device_printf(sc->sc_ue.ue_dev, "reset never completed\n");
872 ure_ifmedia_upd(struct ifnet *ifp)
874 struct ure_softc *sc = ifp->if_softc;
875 struct mii_data *mii = GET_MII(sc);
876 struct mii_softc *miisc;
879 URE_LOCK_ASSERT(sc, MA_OWNED);
881 LIST_FOREACH(miisc, &mii->mii_phys, mii_list)
883 error = mii_mediachg(mii);
888 * Report current media status.
891 ure_ifmedia_sts(struct ifnet *ifp, struct ifmediareq *ifmr)
893 struct ure_softc *sc;
894 struct mii_data *mii;
901 ifmr->ifm_active = mii->mii_media_active;
902 ifmr->ifm_status = mii->mii_media_status;
907 ure_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
909 struct usb_ether *ue = ifp->if_softc;
910 struct ure_softc *sc;
912 int error, mask, reinit;
914 sc = uether_getsc(ue);
915 ifr = (struct ifreq *)data;
918 if (cmd == SIOCSIFCAP) {
920 mask = ifr->ifr_reqcap ^ ifp->if_capenable;
921 if (reinit > 0 && ifp->if_drv_flags & IFF_DRV_RUNNING)
922 ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
929 error = uether_ioctl(ifp, cmd, data);
935 ure_rtl8152_init(struct ure_softc *sc)
940 ure_ocp_reg_write(sc, URE_OCP_ALDPS_CONFIG, URE_ENPDNPS | URE_LINKENA |
942 uether_pause(&sc->sc_ue, hz / 50);
944 if (sc->sc_chip & URE_CHIP_VER_4C00) {
945 ure_write_2(sc, URE_PLA_LED_FEATURE, URE_MCU_TYPE_PLA,
946 ure_read_2(sc, URE_PLA_LED_FEATURE, URE_MCU_TYPE_PLA) &
950 ure_write_2(sc, URE_USB_UPS_CTRL, URE_MCU_TYPE_USB,
951 ure_read_2(sc, URE_USB_UPS_CTRL, URE_MCU_TYPE_USB) &
953 ure_write_2(sc, URE_USB_PM_CTRL_STATUS, URE_MCU_TYPE_USB,
954 ure_read_2(sc, URE_USB_PM_CTRL_STATUS, URE_MCU_TYPE_USB) &
955 ~URE_RESUME_INDICATE);
957 ure_write_2(sc, URE_PLA_PHY_PWR, URE_MCU_TYPE_PLA,
958 ure_read_2(sc, URE_PLA_PHY_PWR, URE_MCU_TYPE_PLA) |
959 URE_TX_10M_IDLE_EN | URE_PFM_PWM_SWITCH);
960 pwrctrl = ure_read_4(sc, URE_PLA_MAC_PWR_CTRL, URE_MCU_TYPE_PLA);
961 pwrctrl &= ~URE_MCU_CLK_RATIO_MASK;
962 pwrctrl |= URE_MCU_CLK_RATIO | URE_D3_CLK_GATED_EN;
963 ure_write_4(sc, URE_PLA_MAC_PWR_CTRL, URE_MCU_TYPE_PLA, pwrctrl);
964 ure_write_2(sc, URE_PLA_GPHY_INTR_IMR, URE_MCU_TYPE_PLA,
965 URE_GPHY_STS_MSK | URE_SPEED_DOWN_MSK | URE_SPDWN_RXDV_MSK |
966 URE_SPDWN_LINKCHG_MSK);
968 /* Disable Rx aggregation. */
969 ure_write_2(sc, URE_USB_USB_CTRL, URE_MCU_TYPE_USB,
970 ure_read_2(sc, URE_USB_USB_CTRL, URE_MCU_TYPE_USB) |
974 ure_ocp_reg_write(sc, URE_OCP_ALDPS_CONFIG, URE_ENPDNPS | URE_LINKENA |
976 uether_pause(&sc->sc_ue, hz / 50);
980 ure_write_1(sc, URE_USB_TX_AGG, URE_MCU_TYPE_USB,
981 URE_TX_AGG_MAX_THRESHOLD);
982 ure_write_4(sc, URE_USB_RX_BUF_TH, URE_MCU_TYPE_USB, URE_RX_THR_HIGH);
983 ure_write_4(sc, URE_USB_TX_DMA, URE_MCU_TYPE_USB,
984 URE_TEST_MODE_DISABLE | URE_TX_SIZE_ADJUST1);
988 ure_rtl8153_init(struct ure_softc *sc)
995 ure_ocp_reg_write(sc, URE_OCP_POWER_CFG,
996 ure_ocp_reg_read(sc, URE_OCP_POWER_CFG) & ~URE_EN_ALDPS);
997 uether_pause(&sc->sc_ue, hz / 50);
999 memset(u1u2, 0x00, sizeof(u1u2));
1000 ure_write_mem(sc, URE_USB_TOLERANCE,
1001 URE_MCU_TYPE_USB | URE_BYTE_EN_SIX_BYTES, u1u2, sizeof(u1u2));
1003 for (i = 0; i < URE_TIMEOUT; i++) {
1004 if (ure_read_2(sc, URE_PLA_BOOT_CTRL, URE_MCU_TYPE_PLA) &
1007 uether_pause(&sc->sc_ue, hz / 100);
1009 if (i == URE_TIMEOUT)
1010 device_printf(sc->sc_ue.ue_dev,
1011 "timeout waiting for chip autoload\n");
1013 for (i = 0; i < URE_TIMEOUT; i++) {
1014 val = ure_ocp_reg_read(sc, URE_OCP_PHY_STATUS) &
1016 if (val == URE_PHY_STAT_LAN_ON || val == URE_PHY_STAT_PWRDN)
1018 uether_pause(&sc->sc_ue, hz / 100);
1020 if (i == URE_TIMEOUT)
1021 device_printf(sc->sc_ue.ue_dev,
1022 "timeout waiting for phy to stabilize\n");
1024 ure_write_2(sc, URE_USB_U2P3_CTRL, URE_MCU_TYPE_USB,
1025 ure_read_2(sc, URE_USB_U2P3_CTRL, URE_MCU_TYPE_USB) &
1028 if (sc->sc_chip & URE_CHIP_VER_5C10) {
1029 val = ure_read_2(sc, URE_USB_SSPHYLINK2, URE_MCU_TYPE_USB);
1030 val &= ~URE_PWD_DN_SCALE_MASK;
1031 val |= URE_PWD_DN_SCALE(96);
1032 ure_write_2(sc, URE_USB_SSPHYLINK2, URE_MCU_TYPE_USB, val);
1034 ure_write_1(sc, URE_USB_USB2PHY, URE_MCU_TYPE_USB,
1035 ure_read_1(sc, URE_USB_USB2PHY, URE_MCU_TYPE_USB) |
1036 URE_USB2PHY_L1 | URE_USB2PHY_SUSPEND);
1037 } else if (sc->sc_chip & URE_CHIP_VER_5C20) {
1038 ure_write_1(sc, URE_PLA_DMY_REG0, URE_MCU_TYPE_PLA,
1039 ure_read_1(sc, URE_PLA_DMY_REG0, URE_MCU_TYPE_PLA) &
1042 if (sc->sc_chip & (URE_CHIP_VER_5C20 | URE_CHIP_VER_5C30)) {
1043 val = ure_read_1(sc, URE_USB_CSR_DUMMY1, URE_MCU_TYPE_USB);
1044 if (ure_read_2(sc, URE_USB_BURST_SIZE, URE_MCU_TYPE_USB) ==
1046 val &= ~URE_DYNAMIC_BURST;
1048 val |= URE_DYNAMIC_BURST;
1049 ure_write_1(sc, URE_USB_CSR_DUMMY1, URE_MCU_TYPE_USB, val);
1052 ure_write_1(sc, URE_USB_CSR_DUMMY2, URE_MCU_TYPE_USB,
1053 ure_read_1(sc, URE_USB_CSR_DUMMY2, URE_MCU_TYPE_USB) |
1056 ure_write_2(sc, URE_USB_WDT11_CTRL, URE_MCU_TYPE_USB,
1057 ure_read_2(sc, URE_USB_WDT11_CTRL, URE_MCU_TYPE_USB) &
1060 ure_write_2(sc, URE_PLA_LED_FEATURE, URE_MCU_TYPE_PLA,
1061 ure_read_2(sc, URE_PLA_LED_FEATURE, URE_MCU_TYPE_PLA) &
1062 ~URE_LED_MODE_MASK);
1064 if ((sc->sc_chip & URE_CHIP_VER_5C10) &&
1065 usbd_get_speed(sc->sc_ue.ue_udev) != USB_SPEED_SUPER)
1066 val = URE_LPM_TIMER_500MS;
1068 val = URE_LPM_TIMER_500US;
1069 ure_write_1(sc, URE_USB_LPM_CTRL, URE_MCU_TYPE_USB,
1070 val | URE_FIFO_EMPTY_1FB | URE_ROK_EXIT_LPM);
1072 val = ure_read_2(sc, URE_USB_AFE_CTRL2, URE_MCU_TYPE_USB);
1073 val &= ~URE_SEN_VAL_MASK;
1074 val |= URE_SEN_VAL_NORMAL | URE_SEL_RXIDLE;
1075 ure_write_2(sc, URE_USB_AFE_CTRL2, URE_MCU_TYPE_USB, val);
1077 ure_write_2(sc, URE_USB_CONNECT_TIMER, URE_MCU_TYPE_USB, 0x0001);
1079 ure_write_2(sc, URE_USB_POWER_CUT, URE_MCU_TYPE_USB,
1080 ure_read_2(sc, URE_USB_POWER_CUT, URE_MCU_TYPE_USB) &
1081 ~(URE_PWR_EN | URE_PHASE2_EN));
1082 ure_write_2(sc, URE_USB_MISC_0, URE_MCU_TYPE_USB,
1083 ure_read_2(sc, URE_USB_MISC_0, URE_MCU_TYPE_USB) &
1086 memset(u1u2, 0xff, sizeof(u1u2));
1087 ure_write_mem(sc, URE_USB_TOLERANCE,
1088 URE_MCU_TYPE_USB | URE_BYTE_EN_SIX_BYTES, u1u2, sizeof(u1u2));
1090 ure_write_2(sc, URE_PLA_MAC_PWR_CTRL, URE_MCU_TYPE_PLA,
1091 URE_ALDPS_SPDWN_RATIO);
1092 ure_write_2(sc, URE_PLA_MAC_PWR_CTRL2, URE_MCU_TYPE_PLA,
1093 URE_EEE_SPDWN_RATIO);
1094 ure_write_2(sc, URE_PLA_MAC_PWR_CTRL3, URE_MCU_TYPE_PLA,
1095 URE_PKT_AVAIL_SPDWN_EN | URE_SUSPEND_SPDWN_EN |
1096 URE_U1U2_SPDWN_EN | URE_L1_SPDWN_EN);
1097 ure_write_2(sc, URE_PLA_MAC_PWR_CTRL4, URE_MCU_TYPE_PLA,
1098 URE_PWRSAVE_SPDWN_EN | URE_RXDV_SPDWN_EN | URE_TX10MIDLE_EN |
1099 URE_TP100_SPDWN_EN | URE_TP500_SPDWN_EN | URE_TP1000_SPDWN_EN |
1102 val = ure_read_2(sc, URE_USB_U2P3_CTRL, URE_MCU_TYPE_USB);
1103 if (!(sc->sc_chip & (URE_CHIP_VER_5C00 | URE_CHIP_VER_5C10)))
1104 val |= URE_U2P3_ENABLE;
1106 val &= ~URE_U2P3_ENABLE;
1107 ure_write_2(sc, URE_USB_U2P3_CTRL, URE_MCU_TYPE_USB, val);
1109 memset(u1u2, 0x00, sizeof(u1u2));
1110 ure_write_mem(sc, URE_USB_TOLERANCE,
1111 URE_MCU_TYPE_USB | URE_BYTE_EN_SIX_BYTES, u1u2, sizeof(u1u2));
1113 /* Disable ALDPS. */
1114 ure_ocp_reg_write(sc, URE_OCP_POWER_CFG,
1115 ure_ocp_reg_read(sc, URE_OCP_POWER_CFG) & ~URE_EN_ALDPS);
1116 uether_pause(&sc->sc_ue, hz / 50);
1120 /* Disable Rx aggregation. */
1121 ure_write_2(sc, URE_USB_USB_CTRL, URE_MCU_TYPE_USB,
1122 ure_read_2(sc, URE_USB_USB_CTRL, URE_MCU_TYPE_USB) |
1123 URE_RX_AGG_DISABLE);
1125 val = ure_read_2(sc, URE_USB_U2P3_CTRL, URE_MCU_TYPE_USB);
1126 if (!(sc->sc_chip & (URE_CHIP_VER_5C00 | URE_CHIP_VER_5C10)))
1127 val |= URE_U2P3_ENABLE;
1129 val &= ~URE_U2P3_ENABLE;
1130 ure_write_2(sc, URE_USB_U2P3_CTRL, URE_MCU_TYPE_USB, val);
1132 memset(u1u2, 0xff, sizeof(u1u2));
1133 ure_write_mem(sc, URE_USB_TOLERANCE,
1134 URE_MCU_TYPE_USB | URE_BYTE_EN_SIX_BYTES, u1u2, sizeof(u1u2));
1138 ure_stop(struct usb_ether *ue)
1140 struct ure_softc *sc = uether_getsc(ue);
1141 struct ifnet *ifp = uether_getifp(ue);
1143 URE_LOCK_ASSERT(sc, MA_OWNED);
1145 ifp->if_drv_flags &= ~(IFF_DRV_RUNNING | IFF_DRV_OACTIVE);
1146 sc->sc_flags &= ~URE_FLAG_LINK;
1149 * stop all the transfers, if not already stopped:
1151 usbd_transfer_stop(sc->sc_xfer[URE_BULK_DT_WR]);
1152 usbd_transfer_stop(sc->sc_xfer[URE_BULK_DT_RD]);
1156 ure_disable_teredo(struct ure_softc *sc)
1159 ure_write_4(sc, URE_PLA_TEREDO_CFG, URE_MCU_TYPE_PLA,
1160 ure_read_4(sc, URE_PLA_TEREDO_CFG, URE_MCU_TYPE_PLA) &
1161 ~(URE_TEREDO_SEL | URE_TEREDO_RS_EVENT_MASK | URE_OOB_TEREDO_EN));
1162 ure_write_2(sc, URE_PLA_WDT6_CTRL, URE_MCU_TYPE_PLA,
1164 ure_write_2(sc, URE_PLA_REALWOW_TIMER, URE_MCU_TYPE_PLA, 0);
1165 ure_write_4(sc, URE_PLA_TEREDO_TIMER, URE_MCU_TYPE_PLA, 0);
1169 ure_init_fifo(struct ure_softc *sc)
1171 uint32_t rx_fifo1, rx_fifo2;
1174 ure_write_2(sc, URE_PLA_MISC_1, URE_MCU_TYPE_PLA,
1175 ure_read_2(sc, URE_PLA_MISC_1, URE_MCU_TYPE_PLA) |
1178 ure_disable_teredo(sc);
1180 ure_write_4(sc, URE_PLA_RCR, URE_MCU_TYPE_PLA,
1181 ure_read_4(sc, URE_PLA_RCR, URE_MCU_TYPE_PLA) &
1184 if (!(sc->sc_flags & URE_FLAG_8152)) {
1185 if (sc->sc_chip & (URE_CHIP_VER_5C00 | URE_CHIP_VER_5C10 |
1186 URE_CHIP_VER_5C20)) {
1187 ure_ocp_reg_write(sc, URE_OCP_ADC_CFG,
1188 URE_CKADSEL_L | URE_ADC_EN | URE_EN_EMI_L);
1190 if (sc->sc_chip & URE_CHIP_VER_5C00) {
1191 ure_ocp_reg_write(sc, URE_OCP_EEE_CFG,
1192 ure_ocp_reg_read(sc, URE_OCP_EEE_CFG) &
1193 ~URE_CTAP_SHORT_EN);
1195 ure_ocp_reg_write(sc, URE_OCP_POWER_CFG,
1196 ure_ocp_reg_read(sc, URE_OCP_POWER_CFG) |
1198 ure_ocp_reg_write(sc, URE_OCP_DOWN_SPEED,
1199 ure_ocp_reg_read(sc, URE_OCP_DOWN_SPEED) |
1201 ure_ocp_reg_write(sc, URE_OCP_POWER_CFG,
1202 ure_ocp_reg_read(sc, URE_OCP_POWER_CFG) |
1204 ure_ocp_reg_write(sc, URE_OCP_SRAM_ADDR, URE_SRAM_IMPEDANCE);
1205 ure_ocp_reg_write(sc, URE_OCP_SRAM_DATA, 0x0b13);
1206 ure_write_2(sc, URE_PLA_PHY_PWR, URE_MCU_TYPE_PLA,
1207 ure_read_2(sc, URE_PLA_PHY_PWR, URE_MCU_TYPE_PLA) |
1208 URE_PFM_PWM_SWITCH);
1210 /* Enable LPF corner auto tune. */
1211 ure_ocp_reg_write(sc, URE_OCP_SRAM_ADDR, URE_SRAM_LPF_CFG);
1212 ure_ocp_reg_write(sc, URE_OCP_SRAM_DATA, 0xf70f);
1214 /* Adjust 10M amplitude. */
1215 ure_ocp_reg_write(sc, URE_OCP_SRAM_ADDR, URE_SRAM_10M_AMP1);
1216 ure_ocp_reg_write(sc, URE_OCP_SRAM_DATA, 0x00af);
1217 ure_ocp_reg_write(sc, URE_OCP_SRAM_ADDR, URE_SRAM_10M_AMP2);
1218 ure_ocp_reg_write(sc, URE_OCP_SRAM_DATA, 0x0208);
1223 ure_write_1(sc, URE_PLA_CR, URE_MCU_TYPE_PLA, 0);
1225 ure_write_1(sc, URE_PLA_OOB_CTRL, URE_MCU_TYPE_PLA,
1226 ure_read_1(sc, URE_PLA_OOB_CTRL, URE_MCU_TYPE_PLA) &
1229 ure_write_2(sc, URE_PLA_SFF_STS_7, URE_MCU_TYPE_PLA,
1230 ure_read_2(sc, URE_PLA_SFF_STS_7, URE_MCU_TYPE_PLA) &
1232 for (i = 0; i < URE_TIMEOUT; i++) {
1233 if (ure_read_1(sc, URE_PLA_OOB_CTRL, URE_MCU_TYPE_PLA) &
1234 URE_LINK_LIST_READY)
1236 uether_pause(&sc->sc_ue, hz / 100);
1238 if (i == URE_TIMEOUT)
1239 device_printf(sc->sc_ue.ue_dev,
1240 "timeout waiting for OOB control\n");
1241 ure_write_2(sc, URE_PLA_SFF_STS_7, URE_MCU_TYPE_PLA,
1242 ure_read_2(sc, URE_PLA_SFF_STS_7, URE_MCU_TYPE_PLA) |
1244 for (i = 0; i < URE_TIMEOUT; i++) {
1245 if (ure_read_1(sc, URE_PLA_OOB_CTRL, URE_MCU_TYPE_PLA) &
1246 URE_LINK_LIST_READY)
1248 uether_pause(&sc->sc_ue, hz / 100);
1250 if (i == URE_TIMEOUT)
1251 device_printf(sc->sc_ue.ue_dev,
1252 "timeout waiting for OOB control\n");
1254 ure_write_2(sc, URE_PLA_CPCR, URE_MCU_TYPE_PLA,
1255 ure_read_2(sc, URE_PLA_CPCR, URE_MCU_TYPE_PLA) &
1257 ure_write_2(sc, URE_PLA_TCR0, URE_MCU_TYPE_PLA,
1258 ure_read_2(sc, URE_PLA_TCR0, URE_MCU_TYPE_PLA) |
1259 URE_TCR0_AUTO_FIFO);
1261 /* Configure Rx FIFO threshold. */
1262 ure_write_4(sc, URE_PLA_RXFIFO_CTRL0, URE_MCU_TYPE_PLA,
1263 URE_RXFIFO_THR1_NORMAL);
1264 if (usbd_get_speed(sc->sc_ue.ue_udev) == USB_SPEED_FULL) {
1265 rx_fifo1 = URE_RXFIFO_THR2_FULL;
1266 rx_fifo2 = URE_RXFIFO_THR3_FULL;
1268 rx_fifo1 = URE_RXFIFO_THR2_HIGH;
1269 rx_fifo2 = URE_RXFIFO_THR3_HIGH;
1271 ure_write_4(sc, URE_PLA_RXFIFO_CTRL1, URE_MCU_TYPE_PLA, rx_fifo1);
1272 ure_write_4(sc, URE_PLA_RXFIFO_CTRL2, URE_MCU_TYPE_PLA, rx_fifo2);
1274 /* Configure Tx FIFO threshold. */
1275 ure_write_4(sc, URE_PLA_TXFIFO_CTRL, URE_MCU_TYPE_PLA,
1276 URE_TXFIFO_THR_NORMAL);