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/kernel.h>
76 #include <sys/module.h>
78 #include <sys/mutex.h>
79 #include <sys/condvar.h>
80 #include <sys/sysctl.h>
82 #include <sys/unistd.h>
83 #include <sys/callout.h>
84 #include <sys/malloc.h>
87 #include <dev/usb/usb.h>
88 #include <dev/usb/usbdi.h>
89 #include <dev/usb/usbdi_util.h>
92 #define USB_DEBUG_VAR kue_debug
93 #include <dev/usb/usb_debug.h>
94 #include <dev/usb/usb_process.h>
96 #include <dev/usb/net/usb_ethernet.h>
97 #include <dev/usb/net/if_kuereg.h>
98 #include <dev/usb/net/if_kuefw.h>
101 * Various supported device vendors/products.
103 static const STRUCT_USB_HOST_ID kue_devs[] = {
104 #define KUE_DEV(v,p) { USB_VP(USB_VENDOR_##v, USB_PRODUCT_##v##_##p) }
105 KUE_DEV(3COM, 3C19250),
106 KUE_DEV(3COM, 3C460),
107 KUE_DEV(ABOCOM, URE450),
108 KUE_DEV(ADS, UBS10BT),
109 KUE_DEV(ADS, UBS10BTX),
110 KUE_DEV(AOX, USB101),
112 KUE_DEV(ATEN, DSB650C),
113 KUE_DEV(ATEN, UC10T),
114 KUE_DEV(COREGA, ETHER_USB_T),
115 KUE_DEV(DLINK, DSB650C),
116 KUE_DEV(ENTREGA, E45),
117 KUE_DEV(ENTREGA, XX1),
118 KUE_DEV(ENTREGA, XX2),
119 KUE_DEV(IODATA, USBETT),
121 KUE_DEV(KINGSTON, XX1),
122 KUE_DEV(KLSI, DUH3E10BT),
123 KUE_DEV(KLSI, DUH3E10BTN),
124 KUE_DEV(LINKSYS, USB10T),
125 KUE_DEV(MOBILITY, EA),
126 KUE_DEV(NETGEAR, EA101),
127 KUE_DEV(NETGEAR, EA101X),
128 KUE_DEV(PERACOM, ENET),
129 KUE_DEV(PERACOM, ENET2),
130 KUE_DEV(PERACOM, ENET3),
131 KUE_DEV(PORTGEAR, EA8),
132 KUE_DEV(PORTGEAR, EA9),
133 KUE_DEV(PORTSMITH, EEA),
135 KUE_DEV(SILICOM, GPE),
136 KUE_DEV(SILICOM, U2E),
137 KUE_DEV(SMC, 2102USB),
143 static device_probe_t kue_probe;
144 static device_attach_t kue_attach;
145 static device_detach_t kue_detach;
147 static usb_callback_t kue_bulk_read_callback;
148 static usb_callback_t kue_bulk_write_callback;
150 static uether_fn_t kue_attach_post;
151 static uether_fn_t kue_init;
152 static uether_fn_t kue_stop;
153 static uether_fn_t kue_start;
154 static uether_fn_t kue_setmulti;
155 static uether_fn_t kue_setpromisc;
157 static int kue_do_request(struct kue_softc *,
158 struct usb_device_request *, void *);
159 static int kue_setword(struct kue_softc *, uint8_t, uint16_t);
160 static int kue_ctl(struct kue_softc *, uint8_t, uint8_t, uint16_t,
162 static int kue_load_fw(struct kue_softc *);
163 static void kue_reset(struct kue_softc *);
166 static int kue_debug = 0;
168 static SYSCTL_NODE(_hw_usb, OID_AUTO, kue, CTLFLAG_RW, 0, "USB kue");
169 SYSCTL_INT(_hw_usb_kue, OID_AUTO, debug, CTLFLAG_RW, &kue_debug, 0,
173 static const struct usb_config kue_config[KUE_N_TRANSFER] = {
177 .endpoint = UE_ADDR_ANY,
178 .direction = UE_DIR_OUT,
179 .bufsize = (MCLBYTES + 2 + 64),
180 .flags = {.pipe_bof = 1,},
181 .callback = kue_bulk_write_callback,
182 .timeout = 10000, /* 10 seconds */
187 .endpoint = UE_ADDR_ANY,
188 .direction = UE_DIR_IN,
189 .bufsize = (MCLBYTES + 2),
190 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
191 .callback = kue_bulk_read_callback,
192 .timeout = 0, /* no timeout */
196 static device_method_t kue_methods[] = {
197 /* Device interface */
198 DEVMETHOD(device_probe, kue_probe),
199 DEVMETHOD(device_attach, kue_attach),
200 DEVMETHOD(device_detach, kue_detach),
205 static driver_t kue_driver = {
207 .methods = kue_methods,
208 .size = sizeof(struct kue_softc),
211 static devclass_t kue_devclass;
213 DRIVER_MODULE(kue, uhub, kue_driver, kue_devclass, NULL, 0);
214 MODULE_DEPEND(kue, uether, 1, 1, 1);
215 MODULE_DEPEND(kue, usb, 1, 1, 1);
216 MODULE_DEPEND(kue, ether, 1, 1, 1);
217 MODULE_VERSION(kue, 1);
219 static const struct usb_ether_methods kue_ue_methods = {
220 .ue_attach_post = kue_attach_post,
221 .ue_start = kue_start,
224 .ue_setmulti = kue_setmulti,
225 .ue_setpromisc = kue_setpromisc,
229 * We have a custom do_request function which is almost like the
230 * regular do_request function, except it has a much longer timeout.
231 * Why? Because we need to make requests over the control endpoint
232 * to download the firmware to the device, which can take longer
233 * than the default timeout.
236 kue_do_request(struct kue_softc *sc, struct usb_device_request *req,
241 err = uether_do_request(&sc->sc_ue, req, data, 60000);
247 kue_setword(struct kue_softc *sc, uint8_t breq, uint16_t word)
249 struct usb_device_request req;
251 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
253 USETW(req.wValue, word);
254 USETW(req.wIndex, 0);
255 USETW(req.wLength, 0);
257 return (kue_do_request(sc, &req, NULL));
261 kue_ctl(struct kue_softc *sc, uint8_t rw, uint8_t breq,
262 uint16_t val, void *data, int len)
264 struct usb_device_request req;
266 if (rw == KUE_CTL_WRITE)
267 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
269 req.bmRequestType = UT_READ_VENDOR_DEVICE;
273 USETW(req.wValue, val);
274 USETW(req.wIndex, 0);
275 USETW(req.wLength, len);
277 return (kue_do_request(sc, &req, data));
281 kue_load_fw(struct kue_softc *sc)
283 struct usb_device_descriptor *dd;
287 dd = usbd_get_device_descriptor(sc->sc_ue.ue_udev);
288 hwrev = UGETW(dd->bcdDevice);
291 * First, check if we even need to load the firmware.
292 * If the device was still attached when the system was
293 * rebooted, it may already have firmware loaded in it.
294 * If this is the case, we don't need to do it again.
295 * And in fact, if we try to load it again, we'll hang,
296 * so we have to avoid this condition if we don't want
299 * We can test this quickly by checking the bcdRevision
300 * code. The NIC will return a different revision code if
301 * it's probed while the firmware is still loaded and
307 /* Load code segment */
308 err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN,
309 0, kue_code_seg, sizeof(kue_code_seg));
311 device_printf(sc->sc_ue.ue_dev, "failed to load code segment: %s\n",
316 /* Load fixup segment */
317 err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN,
318 0, kue_fix_seg, sizeof(kue_fix_seg));
320 device_printf(sc->sc_ue.ue_dev, "failed to load fixup segment: %s\n",
325 /* Send trigger command. */
326 err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN,
327 0, kue_trig_seg, sizeof(kue_trig_seg));
329 device_printf(sc->sc_ue.ue_dev, "failed to load trigger segment: %s\n",
338 kue_setpromisc(struct usb_ether *ue)
340 struct kue_softc *sc = uether_getsc(ue);
341 struct ifnet *ifp = uether_getifp(ue);
343 KUE_LOCK_ASSERT(sc, MA_OWNED);
345 if (ifp->if_flags & IFF_PROMISC)
346 sc->sc_rxfilt |= KUE_RXFILT_PROMISC;
348 sc->sc_rxfilt &= ~KUE_RXFILT_PROMISC;
350 kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->sc_rxfilt);
354 kue_setmulti(struct usb_ether *ue)
356 struct kue_softc *sc = uether_getsc(ue);
357 struct ifnet *ifp = uether_getifp(ue);
358 struct ifmultiaddr *ifma;
361 KUE_LOCK_ASSERT(sc, MA_OWNED);
363 if (ifp->if_flags & IFF_ALLMULTI || ifp->if_flags & IFF_PROMISC) {
364 sc->sc_rxfilt |= KUE_RXFILT_ALLMULTI;
365 sc->sc_rxfilt &= ~KUE_RXFILT_MULTICAST;
366 kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->sc_rxfilt);
370 sc->sc_rxfilt &= ~KUE_RXFILT_ALLMULTI;
373 TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link)
375 if (ifma->ifma_addr->sa_family != AF_LINK)
378 * If there are too many addresses for the
379 * internal filter, switch over to allmulti mode.
381 if (i == KUE_MCFILTCNT(sc))
383 memcpy(KUE_MCFILT(sc, i),
384 LLADDR((struct sockaddr_dl *)ifma->ifma_addr),
388 if_maddr_runlock(ifp);
390 if (i == KUE_MCFILTCNT(sc))
391 sc->sc_rxfilt |= KUE_RXFILT_ALLMULTI;
393 sc->sc_rxfilt |= KUE_RXFILT_MULTICAST;
394 kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SET_MCAST_FILTERS,
395 i, sc->sc_mcfilters, i * ETHER_ADDR_LEN);
398 kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->sc_rxfilt);
402 * Issue a SET_CONFIGURATION command to reset the MAC. This should be
403 * done after the firmware is loaded into the adapter in order to
404 * bring it into proper operation.
407 kue_reset(struct kue_softc *sc)
409 struct usb_config_descriptor *cd;
412 cd = usbd_get_config_descriptor(sc->sc_ue.ue_udev);
414 err = usbd_req_set_config(sc->sc_ue.ue_udev, &sc->sc_mtx,
415 cd->bConfigurationValue);
417 DPRINTF("reset failed (ignored)\n");
419 /* wait a little while for the chip to get its brains in order */
420 uether_pause(&sc->sc_ue, hz / 100);
424 kue_attach_post(struct usb_ether *ue)
426 struct kue_softc *sc = uether_getsc(ue);
429 /* load the firmware into the NIC */
430 error = kue_load_fw(sc);
432 device_printf(sc->sc_ue.ue_dev, "could not load firmware\n");
433 /* ignore the error */
436 /* reset the adapter */
439 /* read ethernet descriptor */
440 kue_ctl(sc, KUE_CTL_READ, KUE_CMD_GET_ETHER_DESCRIPTOR,
441 0, &sc->sc_desc, sizeof(sc->sc_desc));
443 /* copy in ethernet address */
444 memcpy(ue->ue_eaddr, sc->sc_desc.kue_macaddr, sizeof(ue->ue_eaddr));
448 * Probe for a KLSI chip.
451 kue_probe(device_t dev)
453 struct usb_attach_arg *uaa = device_get_ivars(dev);
455 if (uaa->usb_mode != USB_MODE_HOST)
457 if (uaa->info.bConfigIndex != KUE_CONFIG_IDX)
459 if (uaa->info.bIfaceIndex != KUE_IFACE_IDX)
462 return (usbd_lookup_id_by_uaa(kue_devs, sizeof(kue_devs), uaa));
466 * Attach the interface. Allocate softc structures, do
467 * setup and ethernet/BPF attach.
470 kue_attach(device_t dev)
472 struct usb_attach_arg *uaa = device_get_ivars(dev);
473 struct kue_softc *sc = device_get_softc(dev);
474 struct usb_ether *ue = &sc->sc_ue;
478 device_set_usb_desc(dev);
479 mtx_init(&sc->sc_mtx, device_get_nameunit(dev), NULL, MTX_DEF);
481 iface_index = KUE_IFACE_IDX;
482 error = usbd_transfer_setup(uaa->device, &iface_index,
483 sc->sc_xfer, kue_config, KUE_N_TRANSFER, sc, &sc->sc_mtx);
485 device_printf(dev, "allocating USB transfers failed\n");
489 sc->sc_mcfilters = malloc(KUE_MCFILTCNT(sc) * ETHER_ADDR_LEN,
491 if (sc->sc_mcfilters == NULL) {
492 device_printf(dev, "failed allocating USB memory\n");
498 ue->ue_udev = uaa->device;
499 ue->ue_mtx = &sc->sc_mtx;
500 ue->ue_methods = &kue_ue_methods;
502 error = uether_ifattach(ue);
504 device_printf(dev, "could not attach interface\n");
507 return (0); /* success */
511 return (ENXIO); /* failure */
515 kue_detach(device_t dev)
517 struct kue_softc *sc = device_get_softc(dev);
518 struct usb_ether *ue = &sc->sc_ue;
520 usbd_transfer_unsetup(sc->sc_xfer, KUE_N_TRANSFER);
522 mtx_destroy(&sc->sc_mtx);
523 free(sc->sc_mcfilters, M_USBDEV);
529 * A frame has been uploaded: pass the resulting mbuf chain up to
530 * the higher level protocols.
533 kue_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
535 struct kue_softc *sc = usbd_xfer_softc(xfer);
536 struct usb_ether *ue = &sc->sc_ue;
537 struct ifnet *ifp = uether_getifp(ue);
538 struct usb_page_cache *pc;
543 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
545 switch (USB_GET_STATE(xfer)) {
546 case USB_ST_TRANSFERRED:
548 if (actlen <= (2 + sizeof(struct ether_header))) {
552 pc = usbd_xfer_get_frame(xfer, 0);
553 usbd_copy_out(pc, 0, buf, 2);
555 len = buf[0] | (buf[1] << 8);
556 len = min(actlen, len);
558 uether_rxbuf(ue, pc, 2, len);
562 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
563 usbd_transfer_submit(xfer);
568 DPRINTF("bulk read error, %s\n",
571 if (error != USB_ERR_CANCELLED) {
572 /* try to clear stall first */
573 usbd_xfer_set_stall(xfer);
582 kue_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
584 struct kue_softc *sc = usbd_xfer_softc(xfer);
585 struct ifnet *ifp = uether_getifp(&sc->sc_ue);
586 struct usb_page_cache *pc;
592 switch (USB_GET_STATE(xfer)) {
593 case USB_ST_TRANSFERRED:
594 DPRINTFN(11, "transfer complete\n");
600 IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
604 if (m->m_pkthdr.len > MCLBYTES)
605 m->m_pkthdr.len = MCLBYTES;
606 temp_len = (m->m_pkthdr.len + 2);
607 total_len = (temp_len + (64 - (temp_len % 64)));
609 /* the first two bytes are the frame length */
611 buf[0] = (uint8_t)(m->m_pkthdr.len);
612 buf[1] = (uint8_t)(m->m_pkthdr.len >> 8);
614 pc = usbd_xfer_get_frame(xfer, 0);
615 usbd_copy_in(pc, 0, buf, 2);
616 usbd_m_copy_in(pc, 2, m, 0, m->m_pkthdr.len);
618 usbd_frame_zero(pc, temp_len, total_len - temp_len);
619 usbd_xfer_set_frame_len(xfer, 0, total_len);
622 * if there's a BPF listener, bounce a copy
623 * of this frame to him:
629 usbd_transfer_submit(xfer);
634 DPRINTFN(11, "transfer error, %s\n",
639 if (error != USB_ERR_CANCELLED) {
640 /* try to clear stall first */
641 usbd_xfer_set_stall(xfer);
650 kue_start(struct usb_ether *ue)
652 struct kue_softc *sc = uether_getsc(ue);
655 * start the USB transfers, if not already started:
657 usbd_transfer_start(sc->sc_xfer[KUE_BULK_DT_RD]);
658 usbd_transfer_start(sc->sc_xfer[KUE_BULK_DT_WR]);
662 kue_init(struct usb_ether *ue)
664 struct kue_softc *sc = uether_getsc(ue);
665 struct ifnet *ifp = uether_getifp(ue);
667 KUE_LOCK_ASSERT(sc, MA_OWNED);
669 /* set MAC address */
670 kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SET_MAC,
671 0, IF_LLADDR(ifp), ETHER_ADDR_LEN);
673 /* I'm not sure how to tune these. */
676 * Leave this one alone for now; setting it
677 * wrong causes lockups on some machines/controllers.
679 kue_setword(sc, KUE_CMD_SET_SOFS, 1);
681 kue_setword(sc, KUE_CMD_SET_URB_SIZE, 64);
683 /* load the multicast filter */
686 usbd_xfer_set_stall(sc->sc_xfer[KUE_BULK_DT_WR]);
688 ifp->if_drv_flags |= IFF_DRV_RUNNING;
693 kue_stop(struct usb_ether *ue)
695 struct kue_softc *sc = uether_getsc(ue);
696 struct ifnet *ifp = uether_getifp(ue);
698 KUE_LOCK_ASSERT(sc, MA_OWNED);
700 ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
703 * stop all the transfers, if not already stopped:
705 usbd_transfer_stop(sc->sc_xfer[KUE_BULK_DT_WR]);
706 usbd_transfer_stop(sc->sc_xfer[KUE_BULK_DT_RD]);