2 * Copyright (c) 1997, 1998, 1999, 2000
3 * Bill Paul <wpaul@ee.columbia.edu>. All rights reserved.
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.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by Bill Paul.
16 * 4. Neither the name of the author nor the names of any co-contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
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.
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
37 * Kawasaki LSI KL5KUSB101B USB to ethernet adapter driver.
39 * Written by Bill Paul <wpaul@ee.columbia.edu>
40 * Electrical Engineering Department
41 * Columbia University, New York City
45 * The KLSI USB to ethernet adapter chip contains an USB serial interface,
46 * ethernet MAC and embedded microcontroller (called the QT Engine).
47 * The chip must have firmware loaded into it before it will operate.
48 * Packets are passed between the chip and host via bulk transfers.
49 * There is an interrupt endpoint mentioned in the software spec, however
50 * it's currently unused. This device is 10Mbps half-duplex only, hence
51 * there is no media selection logic. The MAC supports a 128 entry
52 * multicast filter, though the exact size of the filter can depend
53 * on the firmware. Curiously, while the software spec describes various
54 * ethernet statistics counters, my sample adapter and firmware combination
55 * claims not to support any statistics counters at all.
57 * Note that once we load the firmware in the device, we have to be
58 * careful not to load it again: if you restart your computer but
59 * leave the adapter attached to the USB controller, it may remain
60 * powered on and retain its firmware. In this case, we don't need
61 * to load the firmware a second time.
63 * Special thanks to Rob Furr for providing an ADS Technologies
64 * adapter for development and testing. No monkeys were harmed during
65 * the development of this driver.
68 #include <sys/stdint.h>
69 #include <sys/stddef.h>
70 #include <sys/param.h>
71 #include <sys/queue.h>
72 #include <sys/types.h>
73 #include <sys/systm.h>
74 #include <sys/socket.h>
75 #include <sys/kernel.h>
77 #include <sys/module.h>
79 #include <sys/mutex.h>
80 #include <sys/condvar.h>
81 #include <sys/sysctl.h>
83 #include <sys/unistd.h>
84 #include <sys/callout.h>
85 #include <sys/malloc.h>
89 #include <net/if_var.h>
91 #include <dev/usb/usb.h>
92 #include <dev/usb/usbdi.h>
93 #include <dev/usb/usbdi_util.h>
96 #define USB_DEBUG_VAR kue_debug
97 #include <dev/usb/usb_debug.h>
98 #include <dev/usb/usb_process.h>
100 #include <dev/usb/net/usb_ethernet.h>
101 #include <dev/usb/net/if_kuereg.h>
102 #include <dev/usb/net/if_kuefw.h>
105 * Various supported device vendors/products.
107 static const STRUCT_USB_HOST_ID kue_devs[] = {
108 #define KUE_DEV(v,p) { USB_VP(USB_VENDOR_##v, USB_PRODUCT_##v##_##p) }
109 KUE_DEV(3COM, 3C19250),
110 KUE_DEV(3COM, 3C460),
111 KUE_DEV(ABOCOM, URE450),
112 KUE_DEV(ADS, UBS10BT),
113 KUE_DEV(ADS, UBS10BTX),
114 KUE_DEV(AOX, USB101),
116 KUE_DEV(ATEN, DSB650C),
117 KUE_DEV(ATEN, UC10T),
118 KUE_DEV(COREGA, ETHER_USB_T),
119 KUE_DEV(DLINK, DSB650C),
120 KUE_DEV(ENTREGA, E45),
121 KUE_DEV(ENTREGA, XX1),
122 KUE_DEV(ENTREGA, XX2),
123 KUE_DEV(IODATA, USBETT),
125 KUE_DEV(KINGSTON, XX1),
126 KUE_DEV(KLSI, DUH3E10BT),
127 KUE_DEV(KLSI, DUH3E10BTN),
128 KUE_DEV(LINKSYS, USB10T),
129 KUE_DEV(MOBILITY, EA),
130 KUE_DEV(NETGEAR, EA101),
131 KUE_DEV(NETGEAR, EA101X),
132 KUE_DEV(PERACOM, ENET),
133 KUE_DEV(PERACOM, ENET2),
134 KUE_DEV(PERACOM, ENET3),
135 KUE_DEV(PORTGEAR, EA8),
136 KUE_DEV(PORTGEAR, EA9),
137 KUE_DEV(PORTSMITH, EEA),
139 KUE_DEV(SILICOM, GPE),
140 KUE_DEV(SILICOM, U2E),
141 KUE_DEV(SMC, 2102USB),
147 static device_probe_t kue_probe;
148 static device_attach_t kue_attach;
149 static device_detach_t kue_detach;
151 static usb_callback_t kue_bulk_read_callback;
152 static usb_callback_t kue_bulk_write_callback;
154 static uether_fn_t kue_attach_post;
155 static uether_fn_t kue_init;
156 static uether_fn_t kue_stop;
157 static uether_fn_t kue_start;
158 static uether_fn_t kue_setmulti;
159 static uether_fn_t kue_setpromisc;
161 static int kue_do_request(struct kue_softc *,
162 struct usb_device_request *, void *);
163 static int kue_setword(struct kue_softc *, uint8_t, uint16_t);
164 static int kue_ctl(struct kue_softc *, uint8_t, uint8_t, uint16_t,
166 static int kue_load_fw(struct kue_softc *);
167 static void kue_reset(struct kue_softc *);
170 static int kue_debug = 0;
172 static SYSCTL_NODE(_hw_usb, OID_AUTO, kue, CTLFLAG_RW, 0, "USB kue");
173 SYSCTL_INT(_hw_usb_kue, OID_AUTO, debug, CTLFLAG_RWTUN, &kue_debug, 0,
177 static const struct usb_config kue_config[KUE_N_TRANSFER] = {
181 .endpoint = UE_ADDR_ANY,
182 .direction = UE_DIR_OUT,
183 .bufsize = (MCLBYTES + 2 + 64),
184 .flags = {.pipe_bof = 1,},
185 .callback = kue_bulk_write_callback,
186 .timeout = 10000, /* 10 seconds */
191 .endpoint = UE_ADDR_ANY,
192 .direction = UE_DIR_IN,
193 .bufsize = (MCLBYTES + 2),
194 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
195 .callback = kue_bulk_read_callback,
196 .timeout = 0, /* no timeout */
200 static device_method_t kue_methods[] = {
201 /* Device interface */
202 DEVMETHOD(device_probe, kue_probe),
203 DEVMETHOD(device_attach, kue_attach),
204 DEVMETHOD(device_detach, kue_detach),
209 static driver_t kue_driver = {
211 .methods = kue_methods,
212 .size = sizeof(struct kue_softc),
215 static devclass_t kue_devclass;
217 DRIVER_MODULE(kue, uhub, kue_driver, kue_devclass, NULL, 0);
218 MODULE_DEPEND(kue, uether, 1, 1, 1);
219 MODULE_DEPEND(kue, usb, 1, 1, 1);
220 MODULE_DEPEND(kue, ether, 1, 1, 1);
221 MODULE_VERSION(kue, 1);
222 USB_PNP_HOST_INFO(kue_devs);
224 static const struct usb_ether_methods kue_ue_methods = {
225 .ue_attach_post = kue_attach_post,
226 .ue_start = kue_start,
229 .ue_setmulti = kue_setmulti,
230 .ue_setpromisc = kue_setpromisc,
234 * We have a custom do_request function which is almost like the
235 * regular do_request function, except it has a much longer timeout.
236 * Why? Because we need to make requests over the control endpoint
237 * to download the firmware to the device, which can take longer
238 * than the default timeout.
241 kue_do_request(struct kue_softc *sc, struct usb_device_request *req,
246 err = uether_do_request(&sc->sc_ue, req, data, 60000);
252 kue_setword(struct kue_softc *sc, uint8_t breq, uint16_t word)
254 struct usb_device_request req;
256 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
258 USETW(req.wValue, word);
259 USETW(req.wIndex, 0);
260 USETW(req.wLength, 0);
262 return (kue_do_request(sc, &req, NULL));
266 kue_ctl(struct kue_softc *sc, uint8_t rw, uint8_t breq,
267 uint16_t val, void *data, int len)
269 struct usb_device_request req;
271 if (rw == KUE_CTL_WRITE)
272 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
274 req.bmRequestType = UT_READ_VENDOR_DEVICE;
278 USETW(req.wValue, val);
279 USETW(req.wIndex, 0);
280 USETW(req.wLength, len);
282 return (kue_do_request(sc, &req, data));
286 kue_load_fw(struct kue_softc *sc)
288 struct usb_device_descriptor *dd;
292 dd = usbd_get_device_descriptor(sc->sc_ue.ue_udev);
293 hwrev = UGETW(dd->bcdDevice);
296 * First, check if we even need to load the firmware.
297 * If the device was still attached when the system was
298 * rebooted, it may already have firmware loaded in it.
299 * If this is the case, we don't need to do it again.
300 * And in fact, if we try to load it again, we'll hang,
301 * so we have to avoid this condition if we don't want
304 * We can test this quickly by checking the bcdRevision
305 * code. The NIC will return a different revision code if
306 * it's probed while the firmware is still loaded and
312 /* Load code segment */
313 err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN,
314 0, kue_code_seg, sizeof(kue_code_seg));
316 device_printf(sc->sc_ue.ue_dev, "failed to load code segment: %s\n",
321 /* Load fixup segment */
322 err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN,
323 0, kue_fix_seg, sizeof(kue_fix_seg));
325 device_printf(sc->sc_ue.ue_dev, "failed to load fixup segment: %s\n",
330 /* Send trigger command. */
331 err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN,
332 0, kue_trig_seg, sizeof(kue_trig_seg));
334 device_printf(sc->sc_ue.ue_dev, "failed to load trigger segment: %s\n",
343 kue_setpromisc(struct usb_ether *ue)
345 struct kue_softc *sc = uether_getsc(ue);
346 struct ifnet *ifp = uether_getifp(ue);
348 KUE_LOCK_ASSERT(sc, MA_OWNED);
350 if (ifp->if_flags & IFF_PROMISC)
351 sc->sc_rxfilt |= KUE_RXFILT_PROMISC;
353 sc->sc_rxfilt &= ~KUE_RXFILT_PROMISC;
355 kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->sc_rxfilt);
359 kue_setmulti(struct usb_ether *ue)
361 struct kue_softc *sc = uether_getsc(ue);
362 struct ifnet *ifp = uether_getifp(ue);
363 struct ifmultiaddr *ifma;
366 KUE_LOCK_ASSERT(sc, MA_OWNED);
368 if (ifp->if_flags & IFF_ALLMULTI || ifp->if_flags & IFF_PROMISC) {
369 sc->sc_rxfilt |= KUE_RXFILT_ALLMULTI;
370 sc->sc_rxfilt &= ~KUE_RXFILT_MULTICAST;
371 kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->sc_rxfilt);
375 sc->sc_rxfilt &= ~KUE_RXFILT_ALLMULTI;
378 TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link)
380 if (ifma->ifma_addr->sa_family != AF_LINK)
383 * If there are too many addresses for the
384 * internal filter, switch over to allmulti mode.
386 if (i == KUE_MCFILTCNT(sc))
388 memcpy(KUE_MCFILT(sc, i),
389 LLADDR((struct sockaddr_dl *)ifma->ifma_addr),
393 if_maddr_runlock(ifp);
395 if (i == KUE_MCFILTCNT(sc))
396 sc->sc_rxfilt |= KUE_RXFILT_ALLMULTI;
398 sc->sc_rxfilt |= KUE_RXFILT_MULTICAST;
399 kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SET_MCAST_FILTERS,
400 i, sc->sc_mcfilters, i * ETHER_ADDR_LEN);
403 kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->sc_rxfilt);
407 * Issue a SET_CONFIGURATION command to reset the MAC. This should be
408 * done after the firmware is loaded into the adapter in order to
409 * bring it into proper operation.
412 kue_reset(struct kue_softc *sc)
414 struct usb_config_descriptor *cd;
417 cd = usbd_get_config_descriptor(sc->sc_ue.ue_udev);
419 err = usbd_req_set_config(sc->sc_ue.ue_udev, &sc->sc_mtx,
420 cd->bConfigurationValue);
422 DPRINTF("reset failed (ignored)\n");
424 /* wait a little while for the chip to get its brains in order */
425 uether_pause(&sc->sc_ue, hz / 100);
429 kue_attach_post(struct usb_ether *ue)
431 struct kue_softc *sc = uether_getsc(ue);
434 /* load the firmware into the NIC */
435 error = kue_load_fw(sc);
437 device_printf(sc->sc_ue.ue_dev, "could not load firmware\n");
438 /* ignore the error */
441 /* reset the adapter */
444 /* read ethernet descriptor */
445 kue_ctl(sc, KUE_CTL_READ, KUE_CMD_GET_ETHER_DESCRIPTOR,
446 0, &sc->sc_desc, sizeof(sc->sc_desc));
448 /* copy in ethernet address */
449 memcpy(ue->ue_eaddr, sc->sc_desc.kue_macaddr, sizeof(ue->ue_eaddr));
453 * Probe for a KLSI chip.
456 kue_probe(device_t dev)
458 struct usb_attach_arg *uaa = device_get_ivars(dev);
460 if (uaa->usb_mode != USB_MODE_HOST)
462 if (uaa->info.bConfigIndex != KUE_CONFIG_IDX)
464 if (uaa->info.bIfaceIndex != KUE_IFACE_IDX)
467 return (usbd_lookup_id_by_uaa(kue_devs, sizeof(kue_devs), uaa));
471 * Attach the interface. Allocate softc structures, do
472 * setup and ethernet/BPF attach.
475 kue_attach(device_t dev)
477 struct usb_attach_arg *uaa = device_get_ivars(dev);
478 struct kue_softc *sc = device_get_softc(dev);
479 struct usb_ether *ue = &sc->sc_ue;
483 device_set_usb_desc(dev);
484 mtx_init(&sc->sc_mtx, device_get_nameunit(dev), NULL, MTX_DEF);
486 iface_index = KUE_IFACE_IDX;
487 error = usbd_transfer_setup(uaa->device, &iface_index,
488 sc->sc_xfer, kue_config, KUE_N_TRANSFER, sc, &sc->sc_mtx);
490 device_printf(dev, "allocating USB transfers failed\n");
494 sc->sc_mcfilters = malloc(KUE_MCFILTCNT(sc) * ETHER_ADDR_LEN,
496 if (sc->sc_mcfilters == NULL) {
497 device_printf(dev, "failed allocating USB memory\n");
503 ue->ue_udev = uaa->device;
504 ue->ue_mtx = &sc->sc_mtx;
505 ue->ue_methods = &kue_ue_methods;
507 error = uether_ifattach(ue);
509 device_printf(dev, "could not attach interface\n");
512 return (0); /* success */
516 return (ENXIO); /* failure */
520 kue_detach(device_t dev)
522 struct kue_softc *sc = device_get_softc(dev);
523 struct usb_ether *ue = &sc->sc_ue;
525 usbd_transfer_unsetup(sc->sc_xfer, KUE_N_TRANSFER);
527 mtx_destroy(&sc->sc_mtx);
528 free(sc->sc_mcfilters, M_USBDEV);
534 * A frame has been uploaded: pass the resulting mbuf chain up to
535 * the higher level protocols.
538 kue_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
540 struct kue_softc *sc = usbd_xfer_softc(xfer);
541 struct usb_ether *ue = &sc->sc_ue;
542 struct ifnet *ifp = uether_getifp(ue);
543 struct usb_page_cache *pc;
548 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
550 switch (USB_GET_STATE(xfer)) {
551 case USB_ST_TRANSFERRED:
553 if (actlen <= (int)(2 + sizeof(struct ether_header))) {
554 if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
557 pc = usbd_xfer_get_frame(xfer, 0);
558 usbd_copy_out(pc, 0, buf, 2);
560 len = buf[0] | (buf[1] << 8);
561 len = min(actlen, len);
563 uether_rxbuf(ue, pc, 2, len);
567 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
568 usbd_transfer_submit(xfer);
573 DPRINTF("bulk read error, %s\n",
576 if (error != USB_ERR_CANCELLED) {
577 /* try to clear stall first */
578 usbd_xfer_set_stall(xfer);
587 kue_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
589 struct kue_softc *sc = usbd_xfer_softc(xfer);
590 struct ifnet *ifp = uether_getifp(&sc->sc_ue);
591 struct usb_page_cache *pc;
597 switch (USB_GET_STATE(xfer)) {
598 case USB_ST_TRANSFERRED:
599 DPRINTFN(11, "transfer complete\n");
600 if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1);
605 IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
609 if (m->m_pkthdr.len > MCLBYTES)
610 m->m_pkthdr.len = MCLBYTES;
611 temp_len = (m->m_pkthdr.len + 2);
612 total_len = (temp_len + (64 - (temp_len % 64)));
614 /* the first two bytes are the frame length */
616 buf[0] = (uint8_t)(m->m_pkthdr.len);
617 buf[1] = (uint8_t)(m->m_pkthdr.len >> 8);
619 pc = usbd_xfer_get_frame(xfer, 0);
620 usbd_copy_in(pc, 0, buf, 2);
621 usbd_m_copy_in(pc, 2, m, 0, m->m_pkthdr.len);
623 usbd_frame_zero(pc, temp_len, total_len - temp_len);
624 usbd_xfer_set_frame_len(xfer, 0, total_len);
627 * if there's a BPF listener, bounce a copy
628 * of this frame to him:
634 usbd_transfer_submit(xfer);
639 DPRINTFN(11, "transfer error, %s\n",
642 if_inc_counter(ifp, IFCOUNTER_OERRORS, 1);
644 if (error != USB_ERR_CANCELLED) {
645 /* try to clear stall first */
646 usbd_xfer_set_stall(xfer);
655 kue_start(struct usb_ether *ue)
657 struct kue_softc *sc = uether_getsc(ue);
660 * start the USB transfers, if not already started:
662 usbd_transfer_start(sc->sc_xfer[KUE_BULK_DT_RD]);
663 usbd_transfer_start(sc->sc_xfer[KUE_BULK_DT_WR]);
667 kue_init(struct usb_ether *ue)
669 struct kue_softc *sc = uether_getsc(ue);
670 struct ifnet *ifp = uether_getifp(ue);
672 KUE_LOCK_ASSERT(sc, MA_OWNED);
674 /* set MAC address */
675 kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SET_MAC,
676 0, IF_LLADDR(ifp), ETHER_ADDR_LEN);
678 /* I'm not sure how to tune these. */
681 * Leave this one alone for now; setting it
682 * wrong causes lockups on some machines/controllers.
684 kue_setword(sc, KUE_CMD_SET_SOFS, 1);
686 kue_setword(sc, KUE_CMD_SET_URB_SIZE, 64);
688 /* load the multicast filter */
691 usbd_xfer_set_stall(sc->sc_xfer[KUE_BULK_DT_WR]);
693 ifp->if_drv_flags |= IFF_DRV_RUNNING;
698 kue_stop(struct usb_ether *ue)
700 struct kue_softc *sc = uether_getsc(ue);
701 struct ifnet *ifp = uether_getifp(ue);
703 KUE_LOCK_ASSERT(sc, MA_OWNED);
705 ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
708 * stop all the transfers, if not already stopped:
710 usbd_transfer_stop(sc->sc_xfer[KUE_BULK_DT_WR]);
711 usbd_transfer_stop(sc->sc_xfer[KUE_BULK_DT_RD]);