xref: /freebsd/sys/dev/usb/net/if_kue.c (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1 /*-
2  * SPDX-License-Identifier: BSD-4-Clause
3  *
4  * Copyright (c) 1997, 1998, 1999, 2000
5  *	Bill Paul <wpaul@ee.columbia.edu>.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by Bill Paul.
18  * 4. Neither the name of the author nor the names of any co-contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
26  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32  * THE POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
37 
38 /*
39  * Kawasaki LSI KL5KUSB101B USB to ethernet adapter driver.
40  *
41  * Written by Bill Paul <wpaul@ee.columbia.edu>
42  * Electrical Engineering Department
43  * Columbia University, New York City
44  */
45 
46 /*
47  * The KLSI USB to ethernet adapter chip contains an USB serial interface,
48  * ethernet MAC and embedded microcontroller (called the QT Engine).
49  * The chip must have firmware loaded into it before it will operate.
50  * Packets are passed between the chip and host via bulk transfers.
51  * There is an interrupt endpoint mentioned in the software spec, however
52  * it's currently unused. This device is 10Mbps half-duplex only, hence
53  * there is no media selection logic. The MAC supports a 128 entry
54  * multicast filter, though the exact size of the filter can depend
55  * on the firmware. Curiously, while the software spec describes various
56  * ethernet statistics counters, my sample adapter and firmware combination
57  * claims not to support any statistics counters at all.
58  *
59  * Note that once we load the firmware in the device, we have to be
60  * careful not to load it again: if you restart your computer but
61  * leave the adapter attached to the USB controller, it may remain
62  * powered on and retain its firmware. In this case, we don't need
63  * to load the firmware a second time.
64  *
65  * Special thanks to Rob Furr for providing an ADS Technologies
66  * adapter for development and testing. No monkeys were harmed during
67  * the development of this driver.
68  */
69 
70 #include <sys/stdint.h>
71 #include <sys/stddef.h>
72 #include <sys/param.h>
73 #include <sys/queue.h>
74 #include <sys/types.h>
75 #include <sys/systm.h>
76 #include <sys/socket.h>
77 #include <sys/kernel.h>
78 #include <sys/bus.h>
79 #include <sys/module.h>
80 #include <sys/lock.h>
81 #include <sys/mutex.h>
82 #include <sys/condvar.h>
83 #include <sys/sysctl.h>
84 #include <sys/sx.h>
85 #include <sys/unistd.h>
86 #include <sys/callout.h>
87 #include <sys/malloc.h>
88 #include <sys/priv.h>
89 
90 #include <net/if.h>
91 #include <net/if_var.h>
92 
93 #include <dev/usb/usb.h>
94 #include <dev/usb/usbdi.h>
95 #include <dev/usb/usbdi_util.h>
96 #include "usbdevs.h"
97 
98 #define	USB_DEBUG_VAR kue_debug
99 #include <dev/usb/usb_debug.h>
100 #include <dev/usb/usb_process.h>
101 
102 #include <dev/usb/net/usb_ethernet.h>
103 #include <dev/usb/net/if_kuereg.h>
104 #include <dev/usb/net/if_kuefw.h>
105 
106 /*
107  * Various supported device vendors/products.
108  */
109 static const STRUCT_USB_HOST_ID kue_devs[] = {
110 #define	KUE_DEV(v,p) { USB_VP(USB_VENDOR_##v, USB_PRODUCT_##v##_##p) }
111 	KUE_DEV(3COM, 3C19250),
112 	KUE_DEV(3COM, 3C460),
113 	KUE_DEV(ABOCOM, URE450),
114 	KUE_DEV(ADS, UBS10BT),
115 	KUE_DEV(ADS, UBS10BTX),
116 	KUE_DEV(AOX, USB101),
117 	KUE_DEV(ASANTE, EA),
118 	KUE_DEV(ATEN, DSB650C),
119 	KUE_DEV(ATEN, UC10T),
120 	KUE_DEV(COREGA, ETHER_USB_T),
121 	KUE_DEV(DLINK, DSB650C),
122 	KUE_DEV(ENTREGA, E45),
123 	KUE_DEV(ENTREGA, XX1),
124 	KUE_DEV(ENTREGA, XX2),
125 	KUE_DEV(IODATA, USBETT),
126 	KUE_DEV(JATON, EDA),
127 	KUE_DEV(KINGSTON, XX1),
128 	KUE_DEV(KLSI, DUH3E10BT),
129 	KUE_DEV(KLSI, DUH3E10BTN),
130 	KUE_DEV(LINKSYS, USB10T),
131 	KUE_DEV(MOBILITY, EA),
132 	KUE_DEV(NETGEAR, EA101),
133 	KUE_DEV(NETGEAR, EA101X),
134 	KUE_DEV(PERACOM, ENET),
135 	KUE_DEV(PERACOM, ENET2),
136 	KUE_DEV(PERACOM, ENET3),
137 	KUE_DEV(PORTGEAR, EA8),
138 	KUE_DEV(PORTGEAR, EA9),
139 	KUE_DEV(PORTSMITH, EEA),
140 	KUE_DEV(SHARK, PA),
141 	KUE_DEV(SILICOM, GPE),
142 	KUE_DEV(SILICOM, U2E),
143 	KUE_DEV(SMC, 2102USB),
144 #undef KUE_DEV
145 };
146 
147 /* prototypes */
148 
149 static device_probe_t kue_probe;
150 static device_attach_t kue_attach;
151 static device_detach_t kue_detach;
152 
153 static usb_callback_t kue_bulk_read_callback;
154 static usb_callback_t kue_bulk_write_callback;
155 
156 static uether_fn_t kue_attach_post;
157 static uether_fn_t kue_init;
158 static uether_fn_t kue_stop;
159 static uether_fn_t kue_start;
160 static uether_fn_t kue_setmulti;
161 static uether_fn_t kue_setpromisc;
162 
163 static int	kue_do_request(struct kue_softc *,
164 		    struct usb_device_request *, void *);
165 static int	kue_setword(struct kue_softc *, uint8_t, uint16_t);
166 static int	kue_ctl(struct kue_softc *, uint8_t, uint8_t, uint16_t,
167 		    void *, int);
168 static int	kue_load_fw(struct kue_softc *);
169 static void	kue_reset(struct kue_softc *);
170 
171 #ifdef USB_DEBUG
172 static int kue_debug = 0;
173 
174 static SYSCTL_NODE(_hw_usb, OID_AUTO, kue, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
175     "USB kue");
176 SYSCTL_INT(_hw_usb_kue, OID_AUTO, debug, CTLFLAG_RWTUN, &kue_debug, 0,
177     "Debug level");
178 #endif
179 
180 static const struct usb_config kue_config[KUE_N_TRANSFER] = {
181 	[KUE_BULK_DT_WR] = {
182 		.type = UE_BULK,
183 		.endpoint = UE_ADDR_ANY,
184 		.direction = UE_DIR_OUT,
185 		.bufsize = (MCLBYTES + 2 + 64),
186 		.flags = {.pipe_bof = 1,},
187 		.callback = kue_bulk_write_callback,
188 		.timeout = 10000,	/* 10 seconds */
189 	},
190 
191 	[KUE_BULK_DT_RD] = {
192 		.type = UE_BULK,
193 		.endpoint = UE_ADDR_ANY,
194 		.direction = UE_DIR_IN,
195 		.bufsize = (MCLBYTES + 2),
196 		.flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
197 		.callback = kue_bulk_read_callback,
198 		.timeout = 0,	/* no timeout */
199 	},
200 };
201 
202 static device_method_t kue_methods[] = {
203 	/* Device interface */
204 	DEVMETHOD(device_probe, kue_probe),
205 	DEVMETHOD(device_attach, kue_attach),
206 	DEVMETHOD(device_detach, kue_detach),
207 
208 	DEVMETHOD_END
209 };
210 
211 static driver_t kue_driver = {
212 	.name = "kue",
213 	.methods = kue_methods,
214 	.size = sizeof(struct kue_softc),
215 };
216 
217 DRIVER_MODULE(kue, uhub, kue_driver, NULL, NULL);
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);
223 
224 static const struct usb_ether_methods kue_ue_methods = {
225 	.ue_attach_post = kue_attach_post,
226 	.ue_start = kue_start,
227 	.ue_init = kue_init,
228 	.ue_stop = kue_stop,
229 	.ue_setmulti = kue_setmulti,
230 	.ue_setpromisc = kue_setpromisc,
231 };
232 
233 /*
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.
239  */
240 static int
241 kue_do_request(struct kue_softc *sc, struct usb_device_request *req,
242     void *data)
243 {
244 	usb_error_t err;
245 
246 	err = uether_do_request(&sc->sc_ue, req, data, 60000);
247 
248 	return (err);
249 }
250 
251 static int
252 kue_setword(struct kue_softc *sc, uint8_t breq, uint16_t word)
253 {
254 	struct usb_device_request req;
255 
256 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
257 	req.bRequest = breq;
258 	USETW(req.wValue, word);
259 	USETW(req.wIndex, 0);
260 	USETW(req.wLength, 0);
261 
262 	return (kue_do_request(sc, &req, NULL));
263 }
264 
265 static int
266 kue_ctl(struct kue_softc *sc, uint8_t rw, uint8_t breq,
267     uint16_t val, void *data, int len)
268 {
269 	struct usb_device_request req;
270 
271 	if (rw == KUE_CTL_WRITE)
272 		req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
273 	else
274 		req.bmRequestType = UT_READ_VENDOR_DEVICE;
275 
276 	req.bRequest = breq;
277 	USETW(req.wValue, val);
278 	USETW(req.wIndex, 0);
279 	USETW(req.wLength, len);
280 
281 	return (kue_do_request(sc, &req, data));
282 }
283 
284 static int
285 kue_load_fw(struct kue_softc *sc)
286 {
287 	struct usb_device_descriptor *dd;
288 	uint16_t hwrev;
289 	usb_error_t err;
290 
291 	dd = usbd_get_device_descriptor(sc->sc_ue.ue_udev);
292 	hwrev = UGETW(dd->bcdDevice);
293 
294 	/*
295 	 * First, check if we even need to load the firmware.
296 	 * If the device was still attached when the system was
297 	 * rebooted, it may already have firmware loaded in it.
298 	 * If this is the case, we don't need to do it again.
299 	 * And in fact, if we try to load it again, we'll hang,
300 	 * so we have to avoid this condition if we don't want
301 	 * to look stupid.
302 	 *
303 	 * We can test this quickly by checking the bcdRevision
304 	 * code. The NIC will return a different revision code if
305 	 * it's probed while the firmware is still loaded and
306 	 * running.
307 	 */
308 	if (hwrev == 0x0202)
309 		return(0);
310 
311 	/* Load code segment */
312 	err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN,
313 	    0, kue_code_seg, sizeof(kue_code_seg));
314 	if (err) {
315 		device_printf(sc->sc_ue.ue_dev, "failed to load code segment: %s\n",
316 		    usbd_errstr(err));
317 		return(ENXIO);
318 	}
319 
320 	/* Load fixup segment */
321 	err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN,
322 	    0, kue_fix_seg, sizeof(kue_fix_seg));
323 	if (err) {
324 		device_printf(sc->sc_ue.ue_dev, "failed to load fixup segment: %s\n",
325 		    usbd_errstr(err));
326 		return(ENXIO);
327 	}
328 
329 	/* Send trigger command. */
330 	err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN,
331 	    0, kue_trig_seg, sizeof(kue_trig_seg));
332 	if (err) {
333 		device_printf(sc->sc_ue.ue_dev, "failed to load trigger segment: %s\n",
334 		    usbd_errstr(err));
335 		return(ENXIO);
336 	}
337 
338 	return (0);
339 }
340 
341 static void
342 kue_setpromisc(struct usb_ether *ue)
343 {
344 	struct kue_softc *sc = uether_getsc(ue);
345 	struct ifnet *ifp = uether_getifp(ue);
346 
347 	KUE_LOCK_ASSERT(sc, MA_OWNED);
348 
349 	if (ifp->if_flags & IFF_PROMISC)
350 		sc->sc_rxfilt |= KUE_RXFILT_PROMISC;
351 	else
352 		sc->sc_rxfilt &= ~KUE_RXFILT_PROMISC;
353 
354 	kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->sc_rxfilt);
355 }
356 
357 static u_int
358 kue_copy_maddr(void *arg, struct sockaddr_dl *sdl, u_int cnt)
359 {
360 	struct kue_softc *sc = arg;
361 
362 	if (cnt >= KUE_MCFILTCNT(sc))
363 		return (1);
364 
365 	memcpy(KUE_MCFILT(sc, cnt), LLADDR(sdl), ETHER_ADDR_LEN);
366 
367 	return (1);
368 }
369 
370 static void
371 kue_setmulti(struct usb_ether *ue)
372 {
373 	struct kue_softc *sc = uether_getsc(ue);
374 	struct ifnet *ifp = uether_getifp(ue);
375 	int i;
376 
377 	KUE_LOCK_ASSERT(sc, MA_OWNED);
378 
379 	if (ifp->if_flags & IFF_ALLMULTI || ifp->if_flags & IFF_PROMISC) {
380 		sc->sc_rxfilt |= KUE_RXFILT_ALLMULTI;
381 		sc->sc_rxfilt &= ~KUE_RXFILT_MULTICAST;
382 		kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->sc_rxfilt);
383 		return;
384 	}
385 
386 	sc->sc_rxfilt &= ~KUE_RXFILT_ALLMULTI;
387 
388 	i = if_foreach_llmaddr(ifp, kue_copy_maddr, sc);
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  */
406 static void
407 kue_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 
423 static void
424 kue_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  */
450 static int
451 kue_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  */
469 static int
470 kue_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 
509 detach:
510 	kue_detach(dev);
511 	return (ENXIO);			/* failure */
512 }
513 
514 static int
515 kue_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  */
532 static void
533 kue_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 <= (int)(2 + sizeof(struct ether_header))) {
549 			if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
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:
561 tr_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 static void
581 kue_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
582 {
583 	struct kue_softc *sc = usbd_xfer_softc(xfer);
584 	struct ifnet *ifp = uether_getifp(&sc->sc_ue);
585 	struct usb_page_cache *pc;
586 	struct mbuf *m;
587 	int total_len;
588 	int temp_len;
589 	uint8_t buf[2];
590 
591 	switch (USB_GET_STATE(xfer)) {
592 	case USB_ST_TRANSFERRED:
593 		DPRINTFN(11, "transfer complete\n");
594 		if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1);
595 
596 		/* FALLTHROUGH */
597 	case USB_ST_SETUP:
598 tr_setup:
599 		IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
600 
601 		if (m == NULL)
602 			return;
603 		if (m->m_pkthdr.len > MCLBYTES)
604 			m->m_pkthdr.len = MCLBYTES;
605 		temp_len = (m->m_pkthdr.len + 2);
606 		total_len = (temp_len + (64 - (temp_len % 64)));
607 
608 		/* the first two bytes are the frame length */
609 
610 		buf[0] = (uint8_t)(m->m_pkthdr.len);
611 		buf[1] = (uint8_t)(m->m_pkthdr.len >> 8);
612 
613 		pc = usbd_xfer_get_frame(xfer, 0);
614 		usbd_copy_in(pc, 0, buf, 2);
615 		usbd_m_copy_in(pc, 2, m, 0, m->m_pkthdr.len);
616 
617 		usbd_frame_zero(pc, temp_len, total_len - temp_len);
618 		usbd_xfer_set_frame_len(xfer, 0, total_len);
619 
620 		/*
621 		 * if there's a BPF listener, bounce a copy
622 		 * of this frame to him:
623 		 */
624 		BPF_MTAP(ifp, m);
625 
626 		m_freem(m);
627 
628 		usbd_transfer_submit(xfer);
629 
630 		return;
631 
632 	default:			/* Error */
633 		DPRINTFN(11, "transfer error, %s\n",
634 		    usbd_errstr(error));
635 
636 		if_inc_counter(ifp, IFCOUNTER_OERRORS, 1);
637 
638 		if (error != USB_ERR_CANCELLED) {
639 			/* try to clear stall first */
640 			usbd_xfer_set_stall(xfer);
641 			goto tr_setup;
642 		}
643 		return;
644 	}
645 }
646 
647 static void
648 kue_start(struct usb_ether *ue)
649 {
650 	struct kue_softc *sc = uether_getsc(ue);
651 
652 	/*
653 	 * start the USB transfers, if not already started:
654 	 */
655 	usbd_transfer_start(sc->sc_xfer[KUE_BULK_DT_RD]);
656 	usbd_transfer_start(sc->sc_xfer[KUE_BULK_DT_WR]);
657 }
658 
659 static void
660 kue_init(struct usb_ether *ue)
661 {
662 	struct kue_softc *sc = uether_getsc(ue);
663 	struct ifnet *ifp = uether_getifp(ue);
664 
665 	KUE_LOCK_ASSERT(sc, MA_OWNED);
666 
667 	/* set MAC address */
668 	kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SET_MAC,
669 	    0, IF_LLADDR(ifp), ETHER_ADDR_LEN);
670 
671 	/* I'm not sure how to tune these. */
672 #if 0
673 	/*
674 	 * Leave this one alone for now; setting it
675 	 * wrong causes lockups on some machines/controllers.
676 	 */
677 	kue_setword(sc, KUE_CMD_SET_SOFS, 1);
678 #endif
679 	kue_setword(sc, KUE_CMD_SET_URB_SIZE, 64);
680 
681 	/* load the multicast filter */
682 	kue_setpromisc(ue);
683 
684 	usbd_xfer_set_stall(sc->sc_xfer[KUE_BULK_DT_WR]);
685 
686 	ifp->if_drv_flags |= IFF_DRV_RUNNING;
687 	kue_start(ue);
688 }
689 
690 static void
691 kue_stop(struct usb_ether *ue)
692 {
693 	struct kue_softc *sc = uether_getsc(ue);
694 	struct ifnet *ifp = uether_getifp(ue);
695 
696 	KUE_LOCK_ASSERT(sc, MA_OWNED);
697 
698 	ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
699 
700 	/*
701 	 * stop all the transfers, if not already stopped:
702 	 */
703 	usbd_transfer_stop(sc->sc_xfer[KUE_BULK_DT_WR]);
704 	usbd_transfer_stop(sc->sc_xfer[KUE_BULK_DT_RD]);
705 }
706