1/*-
2 * Copyright (c) 1997, 1998, 1999, 2000
3 * Bill Paul <wpaul@ee.columbia.edu>. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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.
19 *
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_kue.c 212122 2010-09-01 23:47:53Z thompsa $");
35
36/*
37 * Kawasaki LSI KL5KUSB101B USB to ethernet adapter driver.
38 *
39 * Written by Bill Paul <wpaul@ee.columbia.edu>
40 * Electrical Engineering Department
41 * Columbia University, New York City
42 */
43
44/*
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.
56 *
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.
62 *
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.
66 */
67
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>
75#include <sys/bus.h>
76#include <sys/linker_set.h>
77#include <sys/module.h>
78#include <sys/lock.h>
79#include <sys/mutex.h>
80#include <sys/condvar.h>
81#include <sys/sysctl.h>
82#include <sys/sx.h>
83#include <sys/unistd.h>
84#include <sys/callout.h>
85#include <sys/malloc.h>
86#include <sys/priv.h>
87
88#include <dev/usb/usb.h>
89#include <dev/usb/usbdi.h>
90#include <dev/usb/usbdi_util.h>
91#include "usbdevs.h"
92
93#define USB_DEBUG_VAR kue_debug
94#include <dev/usb/usb_debug.h>
95#include <dev/usb/usb_process.h>
96
97#include <dev/usb/net/usb_ethernet.h>
98#include <dev/usb/net/if_kuereg.h>
99#include <dev/usb/net/if_kuefw.h>
100
101/*
102 * Various supported device vendors/products.
103 */
104static const struct usb_device_id kue_devs[] = {
105#define KUE_DEV(v,p) { USB_VP(USB_VENDOR_##v, USB_PRODUCT_##v##_##p) }
106 KUE_DEV(3COM, 3C19250),
107 KUE_DEV(3COM, 3C460),
108 KUE_DEV(ABOCOM, URE450),
109 KUE_DEV(ADS, UBS10BT),
110 KUE_DEV(ADS, UBS10BTX),
111 KUE_DEV(AOX, USB101),
112 KUE_DEV(ASANTE, EA),
113 KUE_DEV(ATEN, DSB650C),
114 KUE_DEV(ATEN, UC10T),
115 KUE_DEV(COREGA, ETHER_USB_T),
116 KUE_DEV(DLINK, DSB650C),
117 KUE_DEV(ENTREGA, E45),
118 KUE_DEV(ENTREGA, XX1),
119 KUE_DEV(ENTREGA, XX2),
120 KUE_DEV(IODATA, USBETT),
121 KUE_DEV(JATON, EDA),
122 KUE_DEV(KINGSTON, XX1),
123 KUE_DEV(KLSI, DUH3E10BT),
124 KUE_DEV(KLSI, DUH3E10BTN),
125 KUE_DEV(LINKSYS, USB10T),
126 KUE_DEV(MOBILITY, EA),
127 KUE_DEV(NETGEAR, EA101),
128 KUE_DEV(NETGEAR, EA101X),
129 KUE_DEV(PERACOM, ENET),
130 KUE_DEV(PERACOM, ENET2),
131 KUE_DEV(PERACOM, ENET3),
132 KUE_DEV(PORTGEAR, EA8),
133 KUE_DEV(PORTGEAR, EA9),
134 KUE_DEV(PORTSMITH, EEA),
135 KUE_DEV(SHARK, PA),
136 KUE_DEV(SILICOM, GPE),
137 KUE_DEV(SILICOM, U2E),
138 KUE_DEV(SMC, 2102USB),
139#undef KUE_DEV
140};
141
142/* prototypes */
143
144static device_probe_t kue_probe;
145static device_attach_t kue_attach;
146static device_detach_t kue_detach;
147
148static usb_callback_t kue_bulk_read_callback;
149static usb_callback_t kue_bulk_write_callback;
150
151static uether_fn_t kue_attach_post;
152static uether_fn_t kue_init;
153static uether_fn_t kue_stop;
154static uether_fn_t kue_start;
155static uether_fn_t kue_setmulti;
156static uether_fn_t kue_setpromisc;
157
158static int kue_do_request(struct kue_softc *,
159 struct usb_device_request *, void *);
160static int kue_setword(struct kue_softc *, uint8_t, uint16_t);
161static int kue_ctl(struct kue_softc *, uint8_t, uint8_t, uint16_t,
162 void *, int);
163static int kue_load_fw(struct kue_softc *);
164static void kue_reset(struct kue_softc *);
165
166#ifdef USB_DEBUG
167static int kue_debug = 0;
168
169SYSCTL_NODE(_hw_usb, OID_AUTO, kue, CTLFLAG_RW, 0, "USB kue");
170SYSCTL_INT(_hw_usb_kue, OID_AUTO, debug, CTLFLAG_RW, &kue_debug, 0,
171 "Debug level");
172#endif
173
174static const struct usb_config kue_config[KUE_N_TRANSFER] = {
175
176 [KUE_BULK_DT_WR] = {
177 .type = UE_BULK,
178 .endpoint = UE_ADDR_ANY,
179 .direction = UE_DIR_OUT,
180 .bufsize = (MCLBYTES + 2 + 64),
181 .flags = {.pipe_bof = 1,},
182 .callback = kue_bulk_write_callback,
183 .timeout = 10000, /* 10 seconds */
184 },
185
186 [KUE_BULK_DT_RD] = {
187 .type = UE_BULK,
188 .endpoint = UE_ADDR_ANY,
189 .direction = UE_DIR_IN,
190 .bufsize = (MCLBYTES + 2),
191 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
192 .callback = kue_bulk_read_callback,
193 .timeout = 0, /* no timeout */
194 },
195};
196
197static device_method_t kue_methods[] = {
198 /* Device interface */
199 DEVMETHOD(device_probe, kue_probe),
200 DEVMETHOD(device_attach, kue_attach),
201 DEVMETHOD(device_detach, kue_detach),
202
203 {0, 0}
204};
205
206static driver_t kue_driver = {
207 .name = "kue",
208 .methods = kue_methods,
209 .size = sizeof(struct kue_softc),
210};
211
212static devclass_t kue_devclass;
213
214DRIVER_MODULE(kue, uhub, kue_driver, kue_devclass, NULL, 0);
215MODULE_DEPEND(kue, uether, 1, 1, 1);
216MODULE_DEPEND(kue, usb, 1, 1, 1);
217MODULE_DEPEND(kue, ether, 1, 1, 1);
218MODULE_VERSION(kue, 1);
219
220static const struct usb_ether_methods kue_ue_methods = {
221 .ue_attach_post = kue_attach_post,
222 .ue_start = kue_start,
223 .ue_init = kue_init,
224 .ue_stop = kue_stop,
225 .ue_setmulti = kue_setmulti,
226 .ue_setpromisc = kue_setpromisc,
227};
228
229/*
230 * We have a custom do_request function which is almost like the
231 * regular do_request function, except it has a much longer timeout.
232 * Why? Because we need to make requests over the control endpoint
233 * to download the firmware to the device, which can take longer
234 * than the default timeout.
235 */
236static int
237kue_do_request(struct kue_softc *sc, struct usb_device_request *req,
238 void *data)
239{
240 usb_error_t err;
241
242 err = uether_do_request(&sc->sc_ue, req, data, 60000);
243
244 return (err);
245}
246
247static int
248kue_setword(struct kue_softc *sc, uint8_t breq, uint16_t word)
249{
250 struct usb_device_request req;
251
252 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
253 req.bRequest = breq;
254 USETW(req.wValue, word);
255 USETW(req.wIndex, 0);
256 USETW(req.wLength, 0);
257
258 return (kue_do_request(sc, &req, NULL));
259}
260
261static int
262kue_ctl(struct kue_softc *sc, uint8_t rw, uint8_t breq,
263 uint16_t val, void *data, int len)
264{
265 struct usb_device_request req;
266
267 if (rw == KUE_CTL_WRITE)
268 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
269 else
270 req.bmRequestType = UT_READ_VENDOR_DEVICE;
271
272
273 req.bRequest = breq;
274 USETW(req.wValue, val);
275 USETW(req.wIndex, 0);
276 USETW(req.wLength, len);
277
278 return (kue_do_request(sc, &req, data));
279}
280
281static int
282kue_load_fw(struct kue_softc *sc)
283{
284 struct usb_device_descriptor *dd;
285 uint16_t hwrev;
286 usb_error_t err;
287
288 dd = usbd_get_device_descriptor(sc->sc_ue.ue_udev);
289 hwrev = UGETW(dd->bcdDevice);
290
291 /*
292 * First, check if we even need to load the firmware.
293 * If the device was still attached when the system was
294 * rebooted, it may already have firmware loaded in it.
295 * If this is the case, we don't need to do it again.
296 * And in fact, if we try to load it again, we'll hang,
297 * so we have to avoid this condition if we don't want
298 * to look stupid.
299 *
300 * We can test this quickly by checking the bcdRevision
301 * code. The NIC will return a different revision code if
302 * it's probed while the firmware is still loaded and
303 * running.
304 */
305 if (hwrev == 0x0202)
306 return(0);
307
308 /* Load code segment */
309 err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN,
310 0, kue_code_seg, sizeof(kue_code_seg));
311 if (err) {
312 device_printf(sc->sc_ue.ue_dev, "failed to load code segment: %s\n",
313 usbd_errstr(err));
314 return(ENXIO);
315 }
316
317 /* Load fixup segment */
318 err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN,
319 0, kue_fix_seg, sizeof(kue_fix_seg));
320 if (err) {
321 device_printf(sc->sc_ue.ue_dev, "failed to load fixup segment: %s\n",
322 usbd_errstr(err));
323 return(ENXIO);
324 }
325
326 /* Send trigger command. */
327 err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN,
328 0, kue_trig_seg, sizeof(kue_trig_seg));
329 if (err) {
330 device_printf(sc->sc_ue.ue_dev, "failed to load trigger segment: %s\n",
331 usbd_errstr(err));
332 return(ENXIO);
333 }
334
335 return (0);
336}
337
338static void
339kue_setpromisc(struct usb_ether *ue)
340{
341 struct kue_softc *sc = uether_getsc(ue);
342 struct ifnet *ifp = uether_getifp(ue);
343
344 KUE_LOCK_ASSERT(sc, MA_OWNED);
345
346 if (ifp->if_flags & IFF_PROMISC)
347 sc->sc_rxfilt |= KUE_RXFILT_PROMISC;
348 else
349 sc->sc_rxfilt &= ~KUE_RXFILT_PROMISC;
350
351 kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->sc_rxfilt);
352}
353
354static void
355kue_setmulti(struct usb_ether *ue)
356{
357 struct kue_softc *sc = uether_getsc(ue);
358 struct ifnet *ifp = uether_getifp(ue);
359 struct ifmultiaddr *ifma;
360 int i = 0;
361
362 KUE_LOCK_ASSERT(sc, MA_OWNED);
363
364 if (ifp->if_flags & IFF_ALLMULTI || ifp->if_flags & IFF_PROMISC) {
365 sc->sc_rxfilt |= KUE_RXFILT_ALLMULTI;
366 sc->sc_rxfilt &= ~KUE_RXFILT_MULTICAST;
367 kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->sc_rxfilt);
368 return;
369 }
370
371 sc->sc_rxfilt &= ~KUE_RXFILT_ALLMULTI;
372
373 if_maddr_rlock(ifp);
374 TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link)
375 {
376 if (ifma->ifma_addr->sa_family != AF_LINK)
377 continue;
378 /*
379 * If there are too many addresses for the
380 * internal filter, switch over to allmulti mode.
381 */
382 if (i == KUE_MCFILTCNT(sc))
383 break;
384 bcopy(LLADDR((struct sockaddr_dl *)ifma->ifma_addr),
385 KUE_MCFILT(sc, i), ETHER_ADDR_LEN);
386 i++;
387 }
388 if_maddr_runlock(ifp);
389
390 if (i == KUE_MCFILTCNT(sc))
391 sc->sc_rxfilt |= KUE_RXFILT_ALLMULTI;
392 else {
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);
396 }
397
398 kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->sc_rxfilt);
399}
400
401/*
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.
405 */
406static void
407kue_reset(struct kue_softc *sc)
408{
409 struct usb_config_descriptor *cd;
410 usb_error_t err;
411
412 cd = usbd_get_config_descriptor(sc->sc_ue.ue_udev);
413
414 err = usbd_req_set_config(sc->sc_ue.ue_udev, &sc->sc_mtx,
415 cd->bConfigurationValue);
416 if (err)
417 DPRINTF("reset failed (ignored)\n");
418
419 /* wait a little while for the chip to get its brains in order */
420 uether_pause(&sc->sc_ue, hz / 100);
421}
422
423static void
424kue_attach_post(struct usb_ether *ue)
425{
426 struct kue_softc *sc = uether_getsc(ue);
427 int error;
428
429 /* load the firmware into the NIC */
430 error = kue_load_fw(sc);
431 if (error) {
432 device_printf(sc->sc_ue.ue_dev, "could not load firmware\n");
433 /* ignore the error */
434 }
435
436 /* reset the adapter */
437 kue_reset(sc);
438
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));
442
443 /* copy in ethernet address */
444 memcpy(ue->ue_eaddr, sc->sc_desc.kue_macaddr, sizeof(ue->ue_eaddr));
445}
446
447/*
448 * Probe for a KLSI chip.
449 */
450static int
451kue_probe(device_t dev)
452{
453 struct usb_attach_arg *uaa = device_get_ivars(dev);
454
455 if (uaa->usb_mode != USB_MODE_HOST)
456 return (ENXIO);
457 if (uaa->info.bConfigIndex != KUE_CONFIG_IDX)
458 return (ENXIO);
459 if (uaa->info.bIfaceIndex != KUE_IFACE_IDX)
460 return (ENXIO);
461
462 return (usbd_lookup_id_by_uaa(kue_devs, sizeof(kue_devs), uaa));
463}
464
465/*
466 * Attach the interface. Allocate softc structures, do
467 * setup and ethernet/BPF attach.
468 */
469static int
470kue_attach(device_t dev)
471{
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;
475 uint8_t iface_index;
476 int error;
477
478 device_set_usb_desc(dev);
479 mtx_init(&sc->sc_mtx, device_get_nameunit(dev), NULL, MTX_DEF);
480
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);
484 if (error) {
485 device_printf(dev, "allocating USB transfers failed\n");
486 goto detach;
487 }
488
489 sc->sc_mcfilters = malloc(KUE_MCFILTCNT(sc) * ETHER_ADDR_LEN,
490 M_USBDEV, M_WAITOK);
491 if (sc->sc_mcfilters == NULL) {
492 device_printf(dev, "failed allocating USB memory\n");
493 goto detach;
494 }
495
496 ue->ue_sc = sc;
497 ue->ue_dev = dev;
498 ue->ue_udev = uaa->device;
499 ue->ue_mtx = &sc->sc_mtx;
500 ue->ue_methods = &kue_ue_methods;
501
502 error = uether_ifattach(ue);
503 if (error) {
504 device_printf(dev, "could not attach interface\n");
505 goto detach;
506 }
507 return (0); /* success */
508
509detach:
510 kue_detach(dev);
511 return (ENXIO); /* failure */
512}
513
514static int
515kue_detach(device_t dev)
516{
517 struct kue_softc *sc = device_get_softc(dev);
518 struct usb_ether *ue = &sc->sc_ue;
519
520 usbd_transfer_unsetup(sc->sc_xfer, KUE_N_TRANSFER);
521 uether_ifdetach(ue);
522 mtx_destroy(&sc->sc_mtx);
523 free(sc->sc_mcfilters, M_USBDEV);
524
525 return (0);
526}
527
528/*
529 * A frame has been uploaded: pass the resulting mbuf chain up to
530 * the higher level protocols.
531 */
532static void
533kue_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
534{
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;
539 uint8_t buf[2];
540 int len;
541 int actlen;
542
543 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
544
545 switch (USB_GET_STATE(xfer)) {
546 case USB_ST_TRANSFERRED:
547
548 if (actlen <= (2 + sizeof(struct ether_header))) {
549 ifp->if_ierrors++;
550 goto tr_setup;
551 }
552 pc = usbd_xfer_get_frame(xfer, 0);
553 usbd_copy_out(pc, 0, buf, 2);
554 actlen -= 2;
555 len = buf[0] | (buf[1] << 8);
556 len = min(actlen, len);
557
558 uether_rxbuf(ue, pc, 2, len);
559 /* FALLTHROUGH */
560 case USB_ST_SETUP:
561tr_setup:
562 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
563 usbd_transfer_submit(xfer);
564 uether_rxflush(ue);
565 return;
566
567 default: /* Error */
568 DPRINTF("bulk read error, %s\n",
569 usbd_errstr(error));
570
571 if (error != USB_ERR_CANCELLED) {
572 /* try to clear stall first */
573 usbd_xfer_set_stall(xfer);
574 goto tr_setup;
575 }
576 return;
577
578 }
579}
580
581static void
582kue_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
583{
584 struct kue_softc *sc = usbd_xfer_softc(xfer);
585 struct ifnet *ifp = uether_getifp(&sc->sc_ue);
586 struct usb_page_cache *pc;
587 struct mbuf *m;
588 int total_len;
589 int temp_len;
590 uint8_t buf[2];
591
592 switch (USB_GET_STATE(xfer)) {
593 case USB_ST_TRANSFERRED:
594 DPRINTFN(11, "transfer complete\n");
595 ifp->if_opackets++;
596
597 /* FALLTHROUGH */
598 case USB_ST_SETUP:
599tr_setup:
600 IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
601
602 if (m == NULL)
603 return;
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)));
608
609 /* the first two bytes are the frame length */
610
611 buf[0] = (uint8_t)(m->m_pkthdr.len);
612 buf[1] = (uint8_t)(m->m_pkthdr.len >> 8);
613
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);
617
618 usbd_frame_zero(pc, temp_len, total_len - temp_len);
619 usbd_xfer_set_frame_len(xfer, 0, total_len);
620
621 /*
622 * if there's a BPF listener, bounce a copy
623 * of this frame to him:
624 */
625 BPF_MTAP(ifp, m);
626
627 m_freem(m);
628
629 usbd_transfer_submit(xfer);
630
631 return;
632
633 default: /* Error */
634 DPRINTFN(11, "transfer error, %s\n",
635 usbd_errstr(error));
636
637 ifp->if_oerrors++;
638
639 if (error != USB_ERR_CANCELLED) {
640 /* try to clear stall first */
641 usbd_xfer_set_stall(xfer);
642 goto tr_setup;
643 }
644 return;
645
646 }
647}
648
649static void
650kue_start(struct usb_ether *ue)
651{
652 struct kue_softc *sc = uether_getsc(ue);
653
654 /*
655 * start the USB transfers, if not already started:
656 */
657 usbd_transfer_start(sc->sc_xfer[KUE_BULK_DT_RD]);
658 usbd_transfer_start(sc->sc_xfer[KUE_BULK_DT_WR]);
659}
660
661static void
662kue_init(struct usb_ether *ue)
663{
664 struct kue_softc *sc = uether_getsc(ue);
665 struct ifnet *ifp = uether_getifp(ue);
666
667 KUE_LOCK_ASSERT(sc, MA_OWNED);
668
669 /* set MAC address */
670 kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SET_MAC,
671 0, IF_LLADDR(ifp), ETHER_ADDR_LEN);
672
673 /* I'm not sure how to tune these. */
674#if 0
675 /*
676 * Leave this one alone for now; setting it
677 * wrong causes lockups on some machines/controllers.
678 */
679 kue_setword(sc, KUE_CMD_SET_SOFS, 1);
680#endif
681 kue_setword(sc, KUE_CMD_SET_URB_SIZE, 64);
682
683 /* load the multicast filter */
684 kue_setpromisc(ue);
685
686 usbd_xfer_set_stall(sc->sc_xfer[KUE_BULK_DT_WR]);
687
688 ifp->if_drv_flags |= IFF_DRV_RUNNING;
689 kue_start(ue);
690}
691
692static void
693kue_stop(struct usb_ether *ue)
694{
695 struct kue_softc *sc = uether_getsc(ue);
696 struct ifnet *ifp = uether_getifp(ue);
697
698 KUE_LOCK_ASSERT(sc, MA_OWNED);
699
700 ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
701
702 /*
703 * stop all the transfers, if not already stopped:
704 */
705 usbd_transfer_stop(sc->sc_xfer[KUE_BULK_DT_WR]);
706 usbd_transfer_stop(sc->sc_xfer[KUE_BULK_DT_RD]);
707}
2 * Copyright (c) 1997, 1998, 1999, 2000
3 * Bill Paul <wpaul@ee.columbia.edu>. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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.
19 *
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_kue.c 212122 2010-09-01 23:47:53Z thompsa $");
35
36/*
37 * Kawasaki LSI KL5KUSB101B USB to ethernet adapter driver.
38 *
39 * Written by Bill Paul <wpaul@ee.columbia.edu>
40 * Electrical Engineering Department
41 * Columbia University, New York City
42 */
43
44/*
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.
56 *
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.
62 *
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.
66 */
67
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>
75#include <sys/bus.h>
76#include <sys/linker_set.h>
77#include <sys/module.h>
78#include <sys/lock.h>
79#include <sys/mutex.h>
80#include <sys/condvar.h>
81#include <sys/sysctl.h>
82#include <sys/sx.h>
83#include <sys/unistd.h>
84#include <sys/callout.h>
85#include <sys/malloc.h>
86#include <sys/priv.h>
87
88#include <dev/usb/usb.h>
89#include <dev/usb/usbdi.h>
90#include <dev/usb/usbdi_util.h>
91#include "usbdevs.h"
92
93#define USB_DEBUG_VAR kue_debug
94#include <dev/usb/usb_debug.h>
95#include <dev/usb/usb_process.h>
96
97#include <dev/usb/net/usb_ethernet.h>
98#include <dev/usb/net/if_kuereg.h>
99#include <dev/usb/net/if_kuefw.h>
100
101/*
102 * Various supported device vendors/products.
103 */
104static const struct usb_device_id kue_devs[] = {
105#define KUE_DEV(v,p) { USB_VP(USB_VENDOR_##v, USB_PRODUCT_##v##_##p) }
106 KUE_DEV(3COM, 3C19250),
107 KUE_DEV(3COM, 3C460),
108 KUE_DEV(ABOCOM, URE450),
109 KUE_DEV(ADS, UBS10BT),
110 KUE_DEV(ADS, UBS10BTX),
111 KUE_DEV(AOX, USB101),
112 KUE_DEV(ASANTE, EA),
113 KUE_DEV(ATEN, DSB650C),
114 KUE_DEV(ATEN, UC10T),
115 KUE_DEV(COREGA, ETHER_USB_T),
116 KUE_DEV(DLINK, DSB650C),
117 KUE_DEV(ENTREGA, E45),
118 KUE_DEV(ENTREGA, XX1),
119 KUE_DEV(ENTREGA, XX2),
120 KUE_DEV(IODATA, USBETT),
121 KUE_DEV(JATON, EDA),
122 KUE_DEV(KINGSTON, XX1),
123 KUE_DEV(KLSI, DUH3E10BT),
124 KUE_DEV(KLSI, DUH3E10BTN),
125 KUE_DEV(LINKSYS, USB10T),
126 KUE_DEV(MOBILITY, EA),
127 KUE_DEV(NETGEAR, EA101),
128 KUE_DEV(NETGEAR, EA101X),
129 KUE_DEV(PERACOM, ENET),
130 KUE_DEV(PERACOM, ENET2),
131 KUE_DEV(PERACOM, ENET3),
132 KUE_DEV(PORTGEAR, EA8),
133 KUE_DEV(PORTGEAR, EA9),
134 KUE_DEV(PORTSMITH, EEA),
135 KUE_DEV(SHARK, PA),
136 KUE_DEV(SILICOM, GPE),
137 KUE_DEV(SILICOM, U2E),
138 KUE_DEV(SMC, 2102USB),
139#undef KUE_DEV
140};
141
142/* prototypes */
143
144static device_probe_t kue_probe;
145static device_attach_t kue_attach;
146static device_detach_t kue_detach;
147
148static usb_callback_t kue_bulk_read_callback;
149static usb_callback_t kue_bulk_write_callback;
150
151static uether_fn_t kue_attach_post;
152static uether_fn_t kue_init;
153static uether_fn_t kue_stop;
154static uether_fn_t kue_start;
155static uether_fn_t kue_setmulti;
156static uether_fn_t kue_setpromisc;
157
158static int kue_do_request(struct kue_softc *,
159 struct usb_device_request *, void *);
160static int kue_setword(struct kue_softc *, uint8_t, uint16_t);
161static int kue_ctl(struct kue_softc *, uint8_t, uint8_t, uint16_t,
162 void *, int);
163static int kue_load_fw(struct kue_softc *);
164static void kue_reset(struct kue_softc *);
165
166#ifdef USB_DEBUG
167static int kue_debug = 0;
168
169SYSCTL_NODE(_hw_usb, OID_AUTO, kue, CTLFLAG_RW, 0, "USB kue");
170SYSCTL_INT(_hw_usb_kue, OID_AUTO, debug, CTLFLAG_RW, &kue_debug, 0,
171 "Debug level");
172#endif
173
174static const struct usb_config kue_config[KUE_N_TRANSFER] = {
175
176 [KUE_BULK_DT_WR] = {
177 .type = UE_BULK,
178 .endpoint = UE_ADDR_ANY,
179 .direction = UE_DIR_OUT,
180 .bufsize = (MCLBYTES + 2 + 64),
181 .flags = {.pipe_bof = 1,},
182 .callback = kue_bulk_write_callback,
183 .timeout = 10000, /* 10 seconds */
184 },
185
186 [KUE_BULK_DT_RD] = {
187 .type = UE_BULK,
188 .endpoint = UE_ADDR_ANY,
189 .direction = UE_DIR_IN,
190 .bufsize = (MCLBYTES + 2),
191 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
192 .callback = kue_bulk_read_callback,
193 .timeout = 0, /* no timeout */
194 },
195};
196
197static device_method_t kue_methods[] = {
198 /* Device interface */
199 DEVMETHOD(device_probe, kue_probe),
200 DEVMETHOD(device_attach, kue_attach),
201 DEVMETHOD(device_detach, kue_detach),
202
203 {0, 0}
204};
205
206static driver_t kue_driver = {
207 .name = "kue",
208 .methods = kue_methods,
209 .size = sizeof(struct kue_softc),
210};
211
212static devclass_t kue_devclass;
213
214DRIVER_MODULE(kue, uhub, kue_driver, kue_devclass, NULL, 0);
215MODULE_DEPEND(kue, uether, 1, 1, 1);
216MODULE_DEPEND(kue, usb, 1, 1, 1);
217MODULE_DEPEND(kue, ether, 1, 1, 1);
218MODULE_VERSION(kue, 1);
219
220static const struct usb_ether_methods kue_ue_methods = {
221 .ue_attach_post = kue_attach_post,
222 .ue_start = kue_start,
223 .ue_init = kue_init,
224 .ue_stop = kue_stop,
225 .ue_setmulti = kue_setmulti,
226 .ue_setpromisc = kue_setpromisc,
227};
228
229/*
230 * We have a custom do_request function which is almost like the
231 * regular do_request function, except it has a much longer timeout.
232 * Why? Because we need to make requests over the control endpoint
233 * to download the firmware to the device, which can take longer
234 * than the default timeout.
235 */
236static int
237kue_do_request(struct kue_softc *sc, struct usb_device_request *req,
238 void *data)
239{
240 usb_error_t err;
241
242 err = uether_do_request(&sc->sc_ue, req, data, 60000);
243
244 return (err);
245}
246
247static int
248kue_setword(struct kue_softc *sc, uint8_t breq, uint16_t word)
249{
250 struct usb_device_request req;
251
252 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
253 req.bRequest = breq;
254 USETW(req.wValue, word);
255 USETW(req.wIndex, 0);
256 USETW(req.wLength, 0);
257
258 return (kue_do_request(sc, &req, NULL));
259}
260
261static int
262kue_ctl(struct kue_softc *sc, uint8_t rw, uint8_t breq,
263 uint16_t val, void *data, int len)
264{
265 struct usb_device_request req;
266
267 if (rw == KUE_CTL_WRITE)
268 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
269 else
270 req.bmRequestType = UT_READ_VENDOR_DEVICE;
271
272
273 req.bRequest = breq;
274 USETW(req.wValue, val);
275 USETW(req.wIndex, 0);
276 USETW(req.wLength, len);
277
278 return (kue_do_request(sc, &req, data));
279}
280
281static int
282kue_load_fw(struct kue_softc *sc)
283{
284 struct usb_device_descriptor *dd;
285 uint16_t hwrev;
286 usb_error_t err;
287
288 dd = usbd_get_device_descriptor(sc->sc_ue.ue_udev);
289 hwrev = UGETW(dd->bcdDevice);
290
291 /*
292 * First, check if we even need to load the firmware.
293 * If the device was still attached when the system was
294 * rebooted, it may already have firmware loaded in it.
295 * If this is the case, we don't need to do it again.
296 * And in fact, if we try to load it again, we'll hang,
297 * so we have to avoid this condition if we don't want
298 * to look stupid.
299 *
300 * We can test this quickly by checking the bcdRevision
301 * code. The NIC will return a different revision code if
302 * it's probed while the firmware is still loaded and
303 * running.
304 */
305 if (hwrev == 0x0202)
306 return(0);
307
308 /* Load code segment */
309 err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN,
310 0, kue_code_seg, sizeof(kue_code_seg));
311 if (err) {
312 device_printf(sc->sc_ue.ue_dev, "failed to load code segment: %s\n",
313 usbd_errstr(err));
314 return(ENXIO);
315 }
316
317 /* Load fixup segment */
318 err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN,
319 0, kue_fix_seg, sizeof(kue_fix_seg));
320 if (err) {
321 device_printf(sc->sc_ue.ue_dev, "failed to load fixup segment: %s\n",
322 usbd_errstr(err));
323 return(ENXIO);
324 }
325
326 /* Send trigger command. */
327 err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN,
328 0, kue_trig_seg, sizeof(kue_trig_seg));
329 if (err) {
330 device_printf(sc->sc_ue.ue_dev, "failed to load trigger segment: %s\n",
331 usbd_errstr(err));
332 return(ENXIO);
333 }
334
335 return (0);
336}
337
338static void
339kue_setpromisc(struct usb_ether *ue)
340{
341 struct kue_softc *sc = uether_getsc(ue);
342 struct ifnet *ifp = uether_getifp(ue);
343
344 KUE_LOCK_ASSERT(sc, MA_OWNED);
345
346 if (ifp->if_flags & IFF_PROMISC)
347 sc->sc_rxfilt |= KUE_RXFILT_PROMISC;
348 else
349 sc->sc_rxfilt &= ~KUE_RXFILT_PROMISC;
350
351 kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->sc_rxfilt);
352}
353
354static void
355kue_setmulti(struct usb_ether *ue)
356{
357 struct kue_softc *sc = uether_getsc(ue);
358 struct ifnet *ifp = uether_getifp(ue);
359 struct ifmultiaddr *ifma;
360 int i = 0;
361
362 KUE_LOCK_ASSERT(sc, MA_OWNED);
363
364 if (ifp->if_flags & IFF_ALLMULTI || ifp->if_flags & IFF_PROMISC) {
365 sc->sc_rxfilt |= KUE_RXFILT_ALLMULTI;
366 sc->sc_rxfilt &= ~KUE_RXFILT_MULTICAST;
367 kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->sc_rxfilt);
368 return;
369 }
370
371 sc->sc_rxfilt &= ~KUE_RXFILT_ALLMULTI;
372
373 if_maddr_rlock(ifp);
374 TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link)
375 {
376 if (ifma->ifma_addr->sa_family != AF_LINK)
377 continue;
378 /*
379 * If there are too many addresses for the
380 * internal filter, switch over to allmulti mode.
381 */
382 if (i == KUE_MCFILTCNT(sc))
383 break;
384 bcopy(LLADDR((struct sockaddr_dl *)ifma->ifma_addr),
385 KUE_MCFILT(sc, i), ETHER_ADDR_LEN);
386 i++;
387 }
388 if_maddr_runlock(ifp);
389
390 if (i == KUE_MCFILTCNT(sc))
391 sc->sc_rxfilt |= KUE_RXFILT_ALLMULTI;
392 else {
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);
396 }
397
398 kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->sc_rxfilt);
399}
400
401/*
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.
405 */
406static void
407kue_reset(struct kue_softc *sc)
408{
409 struct usb_config_descriptor *cd;
410 usb_error_t err;
411
412 cd = usbd_get_config_descriptor(sc->sc_ue.ue_udev);
413
414 err = usbd_req_set_config(sc->sc_ue.ue_udev, &sc->sc_mtx,
415 cd->bConfigurationValue);
416 if (err)
417 DPRINTF("reset failed (ignored)\n");
418
419 /* wait a little while for the chip to get its brains in order */
420 uether_pause(&sc->sc_ue, hz / 100);
421}
422
423static void
424kue_attach_post(struct usb_ether *ue)
425{
426 struct kue_softc *sc = uether_getsc(ue);
427 int error;
428
429 /* load the firmware into the NIC */
430 error = kue_load_fw(sc);
431 if (error) {
432 device_printf(sc->sc_ue.ue_dev, "could not load firmware\n");
433 /* ignore the error */
434 }
435
436 /* reset the adapter */
437 kue_reset(sc);
438
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));
442
443 /* copy in ethernet address */
444 memcpy(ue->ue_eaddr, sc->sc_desc.kue_macaddr, sizeof(ue->ue_eaddr));
445}
446
447/*
448 * Probe for a KLSI chip.
449 */
450static int
451kue_probe(device_t dev)
452{
453 struct usb_attach_arg *uaa = device_get_ivars(dev);
454
455 if (uaa->usb_mode != USB_MODE_HOST)
456 return (ENXIO);
457 if (uaa->info.bConfigIndex != KUE_CONFIG_IDX)
458 return (ENXIO);
459 if (uaa->info.bIfaceIndex != KUE_IFACE_IDX)
460 return (ENXIO);
461
462 return (usbd_lookup_id_by_uaa(kue_devs, sizeof(kue_devs), uaa));
463}
464
465/*
466 * Attach the interface. Allocate softc structures, do
467 * setup and ethernet/BPF attach.
468 */
469static int
470kue_attach(device_t dev)
471{
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;
475 uint8_t iface_index;
476 int error;
477
478 device_set_usb_desc(dev);
479 mtx_init(&sc->sc_mtx, device_get_nameunit(dev), NULL, MTX_DEF);
480
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);
484 if (error) {
485 device_printf(dev, "allocating USB transfers failed\n");
486 goto detach;
487 }
488
489 sc->sc_mcfilters = malloc(KUE_MCFILTCNT(sc) * ETHER_ADDR_LEN,
490 M_USBDEV, M_WAITOK);
491 if (sc->sc_mcfilters == NULL) {
492 device_printf(dev, "failed allocating USB memory\n");
493 goto detach;
494 }
495
496 ue->ue_sc = sc;
497 ue->ue_dev = dev;
498 ue->ue_udev = uaa->device;
499 ue->ue_mtx = &sc->sc_mtx;
500 ue->ue_methods = &kue_ue_methods;
501
502 error = uether_ifattach(ue);
503 if (error) {
504 device_printf(dev, "could not attach interface\n");
505 goto detach;
506 }
507 return (0); /* success */
508
509detach:
510 kue_detach(dev);
511 return (ENXIO); /* failure */
512}
513
514static int
515kue_detach(device_t dev)
516{
517 struct kue_softc *sc = device_get_softc(dev);
518 struct usb_ether *ue = &sc->sc_ue;
519
520 usbd_transfer_unsetup(sc->sc_xfer, KUE_N_TRANSFER);
521 uether_ifdetach(ue);
522 mtx_destroy(&sc->sc_mtx);
523 free(sc->sc_mcfilters, M_USBDEV);
524
525 return (0);
526}
527
528/*
529 * A frame has been uploaded: pass the resulting mbuf chain up to
530 * the higher level protocols.
531 */
532static void
533kue_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
534{
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;
539 uint8_t buf[2];
540 int len;
541 int actlen;
542
543 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
544
545 switch (USB_GET_STATE(xfer)) {
546 case USB_ST_TRANSFERRED:
547
548 if (actlen <= (2 + sizeof(struct ether_header))) {
549 ifp->if_ierrors++;
550 goto tr_setup;
551 }
552 pc = usbd_xfer_get_frame(xfer, 0);
553 usbd_copy_out(pc, 0, buf, 2);
554 actlen -= 2;
555 len = buf[0] | (buf[1] << 8);
556 len = min(actlen, len);
557
558 uether_rxbuf(ue, pc, 2, len);
559 /* FALLTHROUGH */
560 case USB_ST_SETUP:
561tr_setup:
562 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
563 usbd_transfer_submit(xfer);
564 uether_rxflush(ue);
565 return;
566
567 default: /* Error */
568 DPRINTF("bulk read error, %s\n",
569 usbd_errstr(error));
570
571 if (error != USB_ERR_CANCELLED) {
572 /* try to clear stall first */
573 usbd_xfer_set_stall(xfer);
574 goto tr_setup;
575 }
576 return;
577
578 }
579}
580
581static void
582kue_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
583{
584 struct kue_softc *sc = usbd_xfer_softc(xfer);
585 struct ifnet *ifp = uether_getifp(&sc->sc_ue);
586 struct usb_page_cache *pc;
587 struct mbuf *m;
588 int total_len;
589 int temp_len;
590 uint8_t buf[2];
591
592 switch (USB_GET_STATE(xfer)) {
593 case USB_ST_TRANSFERRED:
594 DPRINTFN(11, "transfer complete\n");
595 ifp->if_opackets++;
596
597 /* FALLTHROUGH */
598 case USB_ST_SETUP:
599tr_setup:
600 IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
601
602 if (m == NULL)
603 return;
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)));
608
609 /* the first two bytes are the frame length */
610
611 buf[0] = (uint8_t)(m->m_pkthdr.len);
612 buf[1] = (uint8_t)(m->m_pkthdr.len >> 8);
613
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);
617
618 usbd_frame_zero(pc, temp_len, total_len - temp_len);
619 usbd_xfer_set_frame_len(xfer, 0, total_len);
620
621 /*
622 * if there's a BPF listener, bounce a copy
623 * of this frame to him:
624 */
625 BPF_MTAP(ifp, m);
626
627 m_freem(m);
628
629 usbd_transfer_submit(xfer);
630
631 return;
632
633 default: /* Error */
634 DPRINTFN(11, "transfer error, %s\n",
635 usbd_errstr(error));
636
637 ifp->if_oerrors++;
638
639 if (error != USB_ERR_CANCELLED) {
640 /* try to clear stall first */
641 usbd_xfer_set_stall(xfer);
642 goto tr_setup;
643 }
644 return;
645
646 }
647}
648
649static void
650kue_start(struct usb_ether *ue)
651{
652 struct kue_softc *sc = uether_getsc(ue);
653
654 /*
655 * start the USB transfers, if not already started:
656 */
657 usbd_transfer_start(sc->sc_xfer[KUE_BULK_DT_RD]);
658 usbd_transfer_start(sc->sc_xfer[KUE_BULK_DT_WR]);
659}
660
661static void
662kue_init(struct usb_ether *ue)
663{
664 struct kue_softc *sc = uether_getsc(ue);
665 struct ifnet *ifp = uether_getifp(ue);
666
667 KUE_LOCK_ASSERT(sc, MA_OWNED);
668
669 /* set MAC address */
670 kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SET_MAC,
671 0, IF_LLADDR(ifp), ETHER_ADDR_LEN);
672
673 /* I'm not sure how to tune these. */
674#if 0
675 /*
676 * Leave this one alone for now; setting it
677 * wrong causes lockups on some machines/controllers.
678 */
679 kue_setword(sc, KUE_CMD_SET_SOFS, 1);
680#endif
681 kue_setword(sc, KUE_CMD_SET_URB_SIZE, 64);
682
683 /* load the multicast filter */
684 kue_setpromisc(ue);
685
686 usbd_xfer_set_stall(sc->sc_xfer[KUE_BULK_DT_WR]);
687
688 ifp->if_drv_flags |= IFF_DRV_RUNNING;
689 kue_start(ue);
690}
691
692static void
693kue_stop(struct usb_ether *ue)
694{
695 struct kue_softc *sc = uether_getsc(ue);
696 struct ifnet *ifp = uether_getifp(ue);
697
698 KUE_LOCK_ASSERT(sc, MA_OWNED);
699
700 ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
701
702 /*
703 * stop all the transfers, if not already stopped:
704 */
705 usbd_transfer_stop(sc->sc_xfer[KUE_BULK_DT_WR]);
706 usbd_transfer_stop(sc->sc_xfer[KUE_BULK_DT_RD]);
707}