Home | History | Annotate | Line # | Download | only in usb
if_kue.c revision 1.9
      1 /*	$NetBSD: if_kue.c,v 1.9 2000/02/29 19:08:09 hubertf Exp $	*/
      2 /*
      3  * Copyright (c) 1997, 1998, 1999, 2000
      4  *	Bill Paul <wpaul (at) ee.columbia.edu>.  All rights reserved.
      5  *
      6  * Redistribution and use in source and binary forms, with or without
      7  * modification, are permitted provided that the following conditions
      8  * are met:
      9  * 1. Redistributions of source code must retain the above copyright
     10  *    notice, this list of conditions and the following disclaimer.
     11  * 2. Redistributions in binary form must reproduce the above copyright
     12  *    notice, this list of conditions and the following disclaimer in the
     13  *    documentation and/or other materials provided with the distribution.
     14  * 3. All advertising materials mentioning features or use of this software
     15  *    must display the following acknowledgement:
     16  *	This product includes software developed by Bill Paul.
     17  * 4. Neither the name of the author nor the names of any co-contributors
     18  *    may be used to endorse or promote products derived from this software
     19  *    without specific prior written permission.
     20  *
     21  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
     22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     24  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
     25  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
     31  * THE POSSIBILITY OF SUCH DAMAGE.
     32  *
     33  * $FreeBSD: src/sys/dev/usb/if_kue.c,v 1.14 2000/01/14 01:36:15 wpaul Exp $
     34  */
     35 
     36 /*
     37  * Kawasaki LSI KL5KUSB101B USB to ethernet adapter driver.
     38  *
     39  * Written by Bill Paul <wpaul (at) 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 /*
     69  * Ported to NetBSD and somewhat rewritten by Lennart Augustsson.
     70  */
     71 
     72 /*
     73  * TODO:
     74  * only use kue_do_request for downloading firmware.
     75  * more DPRINTF
     76  * proper cleanup on errors
     77  */
     78 #if defined(__NetBSD__) || defined(__OpenBSD__)
     79 #include "opt_inet.h"
     80 #include "opt_ns.h"
     81 #include "bpfilter.h"
     82 #include "rnd.h"
     83 #endif
     84 
     85 #include <sys/param.h>
     86 #include <sys/systm.h>
     87 #include <sys/sockio.h>
     88 #include <sys/mbuf.h>
     89 #include <sys/malloc.h>
     90 #include <sys/kernel.h>
     91 #include <sys/socket.h>
     92 
     93 #if defined(__FreeBSD__)
     94 
     95 #include <net/ethernet.h>
     96 #include <machine/clock.h>	/* for DELAY */
     97 #include <sys/bus.h>
     98 
     99 #elif defined(__NetBSD__) || defined(__OpenBSD__)
    100 
    101 #include <sys/device.h>
    102 #if NRND > 0
    103 #include <sys/rnd.h>
    104 #endif
    105 
    106 #endif
    107 
    108 #include <net/if.h>
    109 #include <net/if_arp.h>
    110 #include <net/if_dl.h>
    111 
    112 #if defined(__NetBSD__) || defined(__OpenBSD__)
    113 #include <net/if_ether.h>
    114 #define BPF_MTAP(ifp, m) bpf_mtap((ifp)->if_bpf, (m))
    115 #else
    116 #define BPF_MTAP(ifp, m) bpf_mtap((ifp), (m))
    117 #endif
    118 
    119 #if defined(__FreeBSD__) || NBPFILTER > 0
    120 #include <net/bpf.h>
    121 #endif
    122 
    123 #if defined(__NetBSD__) || defined(__OpenBSD__)
    124 #ifdef INET
    125 #include <netinet/in.h>
    126 #include <netinet/if_inarp.h>
    127 #endif
    128 
    129 #ifdef NS
    130 #include <netns/ns.h>
    131 #include <netns/ns_if.h>
    132 #endif
    133 #endif /* defined(__NetBSD__) || defined(__OpenBSD__) */
    134 
    135 #include <dev/usb/usb.h>
    136 #include <dev/usb/usbdi.h>
    137 #include <dev/usb/usbdi_util.h>
    138 #include <dev/usb/usbdevs.h>
    139 
    140 #ifdef __FreeBSD__
    141 #include <dev/usb/usb_ethersubr.h>
    142 #endif
    143 
    144 #include <dev/usb/if_kuereg.h>
    145 #include <dev/usb/kue_fw.h>
    146 
    147 #ifdef KUE_DEBUG
    148 #define DPRINTF(x)	if (kuedebug) logprintf x
    149 #define DPRINTFN(n,x)	if (kuedebug >= (n)) logprintf x
    150 int	kuedebug = 0;
    151 #else
    152 #define DPRINTF(x)
    153 #define DPRINTFN(n,x)
    154 #endif
    155 
    156 /*
    157  * Various supported device vendors/products.
    158  */
    159 static struct kue_type kue_devs[] = {
    160 	{ USB_VENDOR_AOX, USB_PRODUCT_AOX_USB101 },
    161 	{ USB_VENDOR_ADS, USB_PRODUCT_ADS_UBS10BT },
    162 	{ USB_VENDOR_ATEN, USB_PRODUCT_ATEN_UC10T },
    163 	{ USB_VENDOR_NETGEAR, USB_PRODUCT_NETGEAR_EA101 },
    164 	{ USB_VENDOR_PERACOM, USB_PRODUCT_PERACOM_ENET },
    165 	{ USB_VENDOR_PERACOM, USB_PRODUCT_PERACOM_ENET2 },
    166 	{ USB_VENDOR_ENTREGA, USB_PRODUCT_ENTREGA_E45 },
    167 	{ USB_VENDOR_3COM, USB_PRODUCT_3COM_3C19250 },
    168 	{ USB_VENDOR_3COM, USB_PRODUCT_3COM_3C460 },
    169 	{ USB_VENDOR_COREGA, USB_PRODUCT_COREGA_ETHER_USB_T },
    170 	{ USB_VENDOR_DLINK, USB_PRODUCT_DLINK_DSB650C },
    171 	{ USB_VENDOR_SMC, USB_PRODUCT_SMC_2102USB },
    172 	{ USB_VENDOR_LINKSYS, USB_PRODUCT_LINKSYS_USB10T },
    173 	{ 0, 0 }
    174 };
    175 
    176 USB_DECLARE_DRIVER(kue);
    177 
    178 static int kue_tx_list_init	__P((struct kue_softc *));
    179 static int kue_rx_list_init	__P((struct kue_softc *));
    180 static int kue_newbuf		__P((struct kue_softc *, struct kue_chain *,
    181 				    struct mbuf *));
    182 static int kue_send		__P((struct kue_softc *, struct mbuf *, int));
    183 static int kue_open_pipes	__P((struct kue_softc *));
    184 static void kue_rxeof		__P((usbd_xfer_handle,
    185 				    usbd_private_handle, usbd_status));
    186 static void kue_txeof		__P((usbd_xfer_handle,
    187 				    usbd_private_handle, usbd_status));
    188 static void kue_start		__P((struct ifnet *));
    189 static int kue_ioctl		__P((struct ifnet *, u_long, caddr_t));
    190 static void kue_init		__P((void *));
    191 static void kue_stop		__P((struct kue_softc *));
    192 static void kue_watchdog		__P((struct ifnet *));
    193 
    194 static void kue_setmulti	__P((struct kue_softc *));
    195 static void kue_reset		__P((struct kue_softc *));
    196 
    197 static usbd_status kue_do_request
    198 				__P((usbd_device_handle,
    199 				   usb_device_request_t *, void *, u_int16_t,
    200 				   u_int32_t *));
    201 static usbd_status kue_ctl_l	__P((struct kue_softc *, int, u_int8_t,
    202 				    u_int16_t, char *, u_int32_t,
    203 				    u_int32_t, u_int32_t *));
    204 #define kue_ctl(sc, rw, breq, val, data, len) \
    205 	kue_ctl_l(sc, rw, breq, val, data, len, 0, 0)
    206 static usbd_status kue_setword	__P((struct kue_softc *, u_int8_t, u_int16_t));
    207 static int kue_load_fw		__P((struct kue_softc *));
    208 
    209 #if defined(__FreeBSD__)
    210 #ifndef lint
    211 static const char rcsid[] =
    212   "$FreeBSD: src/sys/dev/usb/if_kue.c,v 1.14 2000/01/14 01:36:15 wpaul Exp $";
    213 #endif
    214 
    215 static void kue_rxstart		__P((struct ifnet *));
    216 static void kue_shutdown	__P((device_t));
    217 
    218 static struct usb_qdat kue_qdat;
    219 
    220 static device_method_t kue_methods[] = {
    221 	/* Device interface */
    222 	DEVMETHOD(device_probe,		kue_match),
    223 	DEVMETHOD(device_attach,	kue_attach),
    224 	DEVMETHOD(device_detach,	kue_detach),
    225 	DEVMETHOD(device_shutdown,	kue_shutdown),
    226 
    227 	{ 0, 0 }
    228 };
    229 
    230 static driver_t kue_driver = {
    231 	"kue",
    232 	kue_methods,
    233 	sizeof(struct kue_softc)
    234 };
    235 
    236 static devclass_t kue_devclass;
    237 
    238 DRIVER_MODULE(if_kue, uhub, kue_driver, kue_devclass, usbd_driver_load, 0);
    239 
    240 #endif /* __FreeBSD__ */
    241 
    242 /*
    243  * We have a custom do_request function which is almost like the
    244  * regular do_request function, except it has a much longer timeout.
    245  * Why? Because we need to make requests over the control endpoint
    246  * to download the firmware to the device, which can take longer
    247  * than the default timeout.
    248  */
    249 static usbd_status
    250 kue_do_request(dev, req, data, flags, lenp)
    251 	usbd_device_handle	dev;
    252 	usb_device_request_t	*req;
    253 	void			*data;
    254 	u_int16_t		flags;
    255 	u_int32_t		*lenp;
    256 {
    257 	usbd_xfer_handle	xfer;
    258 	usbd_status		err;
    259 
    260 	DPRINTFN(15,("kue_do_request: enter\n"));
    261 
    262 	xfer = usbd_alloc_xfer(dev);
    263 	/* XXX 20000 */
    264 	usbd_setup_default_xfer(xfer, dev, 0, 20000, req,
    265 	    data, UGETW(req->wLength), flags, 0);
    266 	err = usbd_sync_transfer(xfer);
    267 	if (lenp != NULL)
    268 		usbd_get_xfer_status(xfer, NULL, NULL, lenp, NULL);
    269 	usbd_free_xfer(xfer);
    270 
    271 	return (err);
    272 }
    273 
    274 static usbd_status
    275 kue_setword(sc, breq, word)
    276 	struct kue_softc	*sc;
    277 	u_int8_t		breq;
    278 	u_int16_t		word;
    279 {
    280 	usb_device_request_t	req;
    281 	usbd_status		err;
    282 	int			s;
    283 
    284 	DPRINTFN(10,("%s: %s: enter\n", USBDEVNAME(sc->kue_dev),__FUNCTION__));
    285 
    286 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
    287 	req.bRequest = breq;
    288 	USETW(req.wValue, word);
    289 	USETW(req.wIndex, 0);
    290 	USETW(req.wLength, 0);
    291 
    292 	s = splusb();
    293 	err = kue_do_request(sc->kue_udev, &req, NULL, sc->kue_xfer_flags, 0);
    294 	splx(s);
    295 
    296 	return (err);
    297 }
    298 
    299 static usbd_status
    300 kue_ctl_l(sc, rw, breq, val, data, len, flags, lenp)
    301 	struct kue_softc	*sc;
    302 	int			rw;
    303 	u_int8_t		breq;
    304 	u_int16_t		val;
    305 	char			*data;
    306 	u_int32_t		len;
    307 	u_int32_t		flags;
    308 	u_int32_t		*lenp;
    309 {
    310 	usb_device_request_t	req;
    311 	usbd_status		err;
    312 	int			s;
    313 
    314 	DPRINTFN(10,("%s: %s: enter, len=%d\n", USBDEVNAME(sc->kue_dev),
    315 		     __FUNCTION__, len));
    316 
    317 	if (rw == KUE_CTL_WRITE)
    318 		req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
    319 	else
    320 		req.bmRequestType = UT_READ_VENDOR_DEVICE;
    321 
    322 	req.bRequest = breq;
    323 	USETW(req.wValue, val);
    324 	USETW(req.wIndex, 0);
    325 	USETW(req.wLength, len);
    326 
    327 	s = splusb();
    328 	err = kue_do_request(sc->kue_udev, &req, data,
    329 		  sc->kue_xfer_flags | flags, lenp);
    330 	splx(s);
    331 
    332 	return (err);
    333 }
    334 
    335 static int
    336 kue_load_fw(sc)
    337 	struct kue_softc	*sc;
    338 {
    339 	usbd_status		err;
    340 	u_char			eaddr[ETHER_ADDR_LEN];
    341 	u_int32_t		alen;
    342 
    343 	DPRINTFN(1,("%s: %s: enter\n", USBDEVNAME(sc->kue_dev), __FUNCTION__));
    344 
    345 	/*
    346 	 * First, check if we even need to load the firmware.
    347 	 * If the device was still attached when the system was
    348 	 * rebooted, it may already have firmware loaded in it.
    349 	 * If this is the case, we don't need to do it again.
    350 	 * And in fact, if we try to load it again, we'll hang,
    351 	 * so we have to avoid this condition if we don't want
    352 	 * to look stupid.
    353 	 *
    354 	 * We can test this quickly by trying to read the MAC
    355 	 * address; if this fails to return any data, the firmware
    356 	 * needs to be reloaded, otherwise the device is already
    357 	 * operational and we can just return.
    358 	 */
    359 	err = kue_ctl_l(sc, KUE_CTL_READ, KUE_CMD_GET_MAC, 0, (char *)&eaddr,
    360 		  ETHER_ADDR_LEN, USBD_SHORT_XFER_OK, &alen);
    361 
    362 	if (err) {
    363 		printf("%s: kue_load_fw: failed to read MAC: %s\n",
    364 		    USBDEVNAME(sc->kue_dev), usbd_errstr(err));
    365 			return (EIO);
    366 	}
    367 
    368 	if (alen == ETHER_ADDR_LEN) {
    369 		printf("%s: warm boot, no firmware download\n",
    370 		       USBDEVNAME(sc->kue_dev));
    371 		return (0);
    372 	}
    373 
    374 	printf("%s: cold boot, downloading firmware\n",
    375 	       USBDEVNAME(sc->kue_dev));
    376 
    377 	/* Load code segment */
    378 	DPRINTFN(1,("%s: kue_load_fw: download code_seg\n",
    379 		    USBDEVNAME(sc->kue_dev)));
    380 	err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN,
    381 	    0, kue_code_seg, sizeof(kue_code_seg));
    382 	if (err) {
    383 		printf("%s: failed to load code segment: %s\n",
    384 		    USBDEVNAME(sc->kue_dev), usbd_errstr(err));
    385 			return (EIO);
    386 	}
    387 
    388 	/* Load fixup segment */
    389 	DPRINTFN(1,("%s: kue_load_fw: download fix_seg\n",
    390 		    USBDEVNAME(sc->kue_dev)));
    391 	err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN,
    392 	    0, kue_fix_seg, sizeof(kue_fix_seg));
    393 	if (err) {
    394 		printf("%s: failed to load fixup segment: %s\n",
    395 		    USBDEVNAME(sc->kue_dev), usbd_errstr(err));
    396 			return (EIO);
    397 	}
    398 
    399 	/* Send trigger command. */
    400 	DPRINTFN(1,("%s: kue_load_fw: download trig_seg\n",
    401 		    USBDEVNAME(sc->kue_dev)));
    402 	err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN,
    403 	    0, kue_trig_seg, sizeof(kue_trig_seg));
    404 	if (err) {
    405 		printf("%s: failed to load trigger segment: %s\n",
    406 		    USBDEVNAME(sc->kue_dev), usbd_errstr(err));
    407 			return (EIO);
    408 	}
    409 
    410 	usbd_delay_ms(sc->kue_udev, 10);
    411 
    412 	/*
    413 	 * Reload device descriptor.
    414 	 * Why? The chip without the firmware loaded returns
    415 	 * one revision code. The chip with the firmware
    416 	 * loaded and running returns a *different* revision
    417 	 * code. This confuses the quirk mechanism, which is
    418 	 * dependent on the revision data.
    419 	 */
    420 	(void)usbd_reload_device_desc(sc->kue_udev);
    421 
    422 	DPRINTFN(1,("%s: %s: done\n", USBDEVNAME(sc->kue_dev), __FUNCTION__));
    423 
    424 	/* Reset the adapter. */
    425 	kue_reset(sc);
    426 
    427 	return (0);
    428 }
    429 
    430 static void
    431 kue_setmulti(sc)
    432 	struct kue_softc	*sc;
    433 {
    434 	struct ifnet		*ifp = GET_IFP(sc);
    435 #if defined(__FreeBSD__)
    436 	struct ifmultiaddr	*ifma;
    437 #elif defined(__NetBSD__) || defined(__OpenBSD__)
    438 	struct ether_multi	*enm;
    439 	struct ether_multistep	step;
    440 #endif
    441 	int			i;
    442 
    443 	DPRINTFN(5,("%s: %s: enter\n", USBDEVNAME(sc->kue_dev), __FUNCTION__));
    444 
    445 	if (ifp->if_flags & IFF_ALLMULTI || ifp->if_flags & IFF_PROMISC) {
    446 		sc->kue_rxfilt |= KUE_RXFILT_ALLMULTI;
    447 		sc->kue_rxfilt &= ~KUE_RXFILT_MULTICAST;
    448 		kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->kue_rxfilt);
    449 		return;
    450 	}
    451 
    452 	sc->kue_rxfilt &= ~KUE_RXFILT_ALLMULTI;
    453 
    454 	i = 0;
    455 #if defined(__FreeBSD__)
    456 	for (ifma = ifp->if_multiaddrs.lh_first; ifma != NULL;
    457 	    ifma = ifma->ifma_link.le_next) {
    458 		if (ifma->ifma_addr->sa_family != AF_LINK)
    459 			continue;
    460 		/*
    461 		 * If there are too many addresses for the
    462 		 * internal filter, switch over to allmulti mode.
    463 		 */
    464 		if (i == KUE_MCFILTCNT(sc))
    465 			break;
    466 		bcopy(LLADDR((struct sockaddr_dl *)ifma->ifma_addr),
    467 		    KUE_MCFILT(sc, i), ETHER_ADDR_LEN);
    468 		i++;
    469 	}
    470 #elif defined(__NetBSD__) || defined(__OpenBSD__)
    471 	ETHER_FIRST_MULTI(step, &sc->kue_ec, enm);
    472 	while (enm != NULL) {
    473 		if (i == KUE_MCFILTCNT(sc))
    474 			break;
    475 #if 0
    476 		if (memcmp(enm->enm_addrlo,
    477 			   enm->enm_addrhi, ETHER_ADDR_LEN) != 0) {
    478 			ifp->if_flags |= IFF_ALLMULTI;
    479 			/* XXX what now? */
    480 			return;
    481 		}
    482 #endif
    483 		memcpy(KUE_MCFILT(sc, i), enm->enm_addrlo, ETHER_ADDR_LEN);
    484 		ETHER_NEXT_MULTI(step, enm);
    485 		i++;
    486 	}
    487 #endif
    488 
    489 	if (i == KUE_MCFILTCNT(sc))
    490 		sc->kue_rxfilt |= KUE_RXFILT_ALLMULTI;
    491 	else {
    492 		sc->kue_rxfilt |= KUE_RXFILT_MULTICAST;
    493 		kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SET_MCAST_FILTERS,
    494 		    i, sc->kue_mcfilters, i * ETHER_ADDR_LEN);
    495 	}
    496 
    497 	kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->kue_rxfilt);
    498 }
    499 
    500 /*
    501  * Issue a SET_CONFIGURATION command to reset the MAC. This should be
    502  * done after the firmware is loaded into the adapter in order to
    503  * bring it into proper operation.
    504  */
    505 static void
    506 kue_reset(sc)
    507 	struct kue_softc	*sc;
    508 {
    509 	usbd_status		err;
    510 
    511 	DPRINTFN(5,("%s: %s: enter\n", USBDEVNAME(sc->kue_dev), __FUNCTION__));
    512 
    513 	err = usbd_set_config_no(sc->kue_udev, KUE_CONFIG_NO, 0);
    514 	if (err)
    515 		printf("%s: reset failed\n", USBDEVNAME(sc->kue_dev));
    516 
    517 	/* Wait a little while for the chip to get its brains in order. */
    518 	usbd_delay_ms(sc->kue_udev, 10);
    519 }
    520 
    521 /*
    522  * Probe for a KLSI chip.
    523  */
    524 USB_MATCH(kue)
    525 {
    526 	USB_MATCH_START(kue, uaa);
    527 	struct kue_type			*t;
    528 
    529 	DPRINTFN(25,("kue_match: enter\n"));
    530 
    531 	if (uaa->iface != NULL)
    532 		return (UMATCH_NONE);
    533 
    534 	for (t = kue_devs; t->kue_vid != 0; t++)
    535 		if (uaa->vendor == t->kue_vid && uaa->product == t->kue_did)
    536 			return (UMATCH_VENDOR_PRODUCT);
    537 
    538 	return (UMATCH_NONE);
    539 }
    540 
    541 /*
    542  * Attach the interface. Allocate softc structures, do
    543  * setup and ethernet/BPF attach.
    544  */
    545 USB_ATTACH(kue)
    546 {
    547 	USB_ATTACH_START(kue, sc, uaa);
    548 	char			devinfo[1024];
    549 	int			s;
    550 	struct ifnet		*ifp;
    551 	usbd_device_handle	dev = uaa->device;
    552 	usbd_interface_handle	iface;
    553 	usbd_status		err;
    554 	usb_interface_descriptor_t	*id;
    555 	usb_endpoint_descriptor_t	*ed;
    556 	int			i;
    557 
    558 #ifdef __FreeBSD__
    559 	bzero(sc, sizeof(struct kue_softc));
    560 #endif
    561 
    562 	DPRINTFN(5,(" : kue_attach: sc=%p, dev=%p", sc, dev));
    563 
    564 	usbd_devinfo(dev, 0, devinfo);
    565 	USB_ATTACH_SETUP;
    566 	printf("%s: %s\n", USBDEVNAME(sc->kue_dev), devinfo);
    567 
    568 	err = usbd_set_config_no(dev, KUE_CONFIG_NO, 0);
    569 	if (err) {
    570 		printf("%s: setting config no failed\n",
    571 		    USBDEVNAME(sc->kue_dev));
    572 		USB_ATTACH_ERROR_RETURN;
    573 	}
    574 
    575 	sc->kue_udev = dev;
    576 	sc->kue_product = uaa->product;
    577 	sc->kue_vendor = uaa->vendor;
    578 
    579 	/* Load the firmware into the NIC. */
    580 	if (kue_load_fw(sc)) {
    581 		printf("%s: loading firmware failed\n",
    582 		    USBDEVNAME(sc->kue_dev));
    583 		USB_ATTACH_ERROR_RETURN;
    584 	}
    585 
    586 	err = usbd_device2interface_handle(dev, KUE_IFACE_IDX, &iface);
    587 	if (err) {
    588 		printf("%s: getting interface handle failed\n",
    589 		    USBDEVNAME(sc->kue_dev));
    590 		USB_ATTACH_ERROR_RETURN;
    591 	}
    592 
    593 	sc->kue_iface = iface;
    594 	id = usbd_get_interface_descriptor(iface);
    595 
    596 	/* Find endpoints. */
    597 	for (i = 0; i < id->bNumEndpoints; i++) {
    598 		ed = usbd_interface2endpoint_descriptor(iface, i);
    599 		if (ed == NULL) {
    600 			printf("%s: couldn't get ep %d\n",
    601 			    USBDEVNAME(sc->kue_dev), i);
    602 			splx(s);
    603 			USB_ATTACH_ERROR_RETURN;
    604 		}
    605 		if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
    606 		    (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
    607 			sc->kue_ed[KUE_ENDPT_RX] = ed->bEndpointAddress;
    608 		} else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
    609 		    (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
    610 			sc->kue_ed[KUE_ENDPT_TX] = ed->bEndpointAddress;
    611 		} else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
    612 		    (ed->bmAttributes & UE_XFERTYPE) == UE_INTERRUPT) {
    613 			sc->kue_ed[KUE_ENDPT_INTR] = ed->bEndpointAddress;
    614 		}
    615 	}
    616 
    617 	if (sc->kue_ed[KUE_ENDPT_RX] == 0 || sc->kue_ed[KUE_ENDPT_TX] == 0) {
    618 		printf("%s: missing endpoint\n", USBDEVNAME(sc->kue_dev));
    619 		USB_ATTACH_ERROR_RETURN;
    620 	}
    621 
    622 	/* Read ethernet descriptor */
    623 	err = kue_ctl(sc, KUE_CTL_READ, KUE_CMD_GET_ETHER_DESCRIPTOR,
    624 	    0, (char *)&sc->kue_desc, sizeof(sc->kue_desc));
    625 	if (err) {
    626 		printf("%s: could not read Ethernet descriptor\n",
    627 		    USBDEVNAME(sc->kue_dev));
    628 		USB_ATTACH_ERROR_RETURN;
    629 	}
    630 
    631 	sc->kue_mcfilters = malloc(KUE_MCFILTCNT(sc) * ETHER_ADDR_LEN,
    632 	    M_USBDEV, M_NOWAIT);
    633 	if (sc->kue_mcfilters == NULL) {
    634 		printf("%s: no memory for multicast filter buffer\n",
    635 		    USBDEVNAME(sc->kue_dev));
    636 		USB_ATTACH_ERROR_RETURN;
    637 	}
    638 
    639 	sc->kue_xfer_flags = USBD_NO_TSLEEP;
    640 
    641 	s = splimp();
    642 
    643 	/*
    644 	 * A KLSI chip was detected. Inform the world.
    645 	 */
    646 #if defined(__FreeBSD__)
    647 	printf("%s: Ethernet address: %6D\n", USBDEVNAME(sc->kue_dev),
    648 	    sc->kue_desc.kue_macaddr, ":");
    649 
    650 	bcopy(sc->kue_desc.kue_macaddr,
    651 	    (char *)&sc->arpcom.ac_enaddr, ETHER_ADDR_LEN);
    652 
    653 	ifp = GET_IFP(sc);
    654 	ifp->if_softc = sc;
    655 	ifp->if_unit = sc->kue_unit;
    656 	ifp->if_name = "kue";
    657 	ifp->if_mtu = ETHERMTU;
    658 	ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
    659 	ifp->if_ioctl = kue_ioctl;
    660 	ifp->if_output = ether_output;
    661 	ifp->if_start = kue_start;
    662 	ifp->if_watchdog = kue_watchdog;
    663 	ifp->if_init = kue_init;
    664 	ifp->if_baudrate = 10000000;
    665 	ifp->if_snd.ifq_maxlen = IFQ_MAXLEN;
    666 
    667 	kue_qdat.ifp = ifp;
    668 	kue_qdat.if_rxstart = kue_rxstart;
    669 
    670 	/*
    671 	 * Call MI attach routines.
    672 	 */
    673 	if_attach(ifp);
    674 	ether_ifattach(ifp);
    675 	bpfattach(ifp, DLT_EN10MB, sizeof(struct ether_header));
    676 	usb_register_netisr();
    677 
    678 #elif defined(__NetBSD__) || defined(__OpenBSD__)
    679 
    680 	printf("%s: Ethernet address %s\n", USBDEVNAME(sc->kue_dev),
    681 	    ether_sprintf(sc->kue_desc.kue_macaddr));
    682 
    683 	/* Initialize interface info.*/
    684 	ifp = GET_IFP(sc);
    685 	ifp->if_softc = sc;
    686 	ifp->if_mtu = ETHERMTU;
    687 	ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
    688 	ifp->if_ioctl = kue_ioctl;
    689 	ifp->if_start = kue_start;
    690 	ifp->if_watchdog = kue_watchdog;
    691 	ifp->if_baudrate = 10000000;
    692 	strncpy(ifp->if_xname, USBDEVNAME(sc->kue_dev), IFNAMSIZ);
    693 
    694 	/* Attach the interface. */
    695 	if_attach(ifp);
    696 	ether_ifattach(ifp, sc->kue_desc.kue_macaddr);
    697 
    698 #if NBPFILTER > 0
    699 	bpfattach(&ifp->if_bpf, ifp, DLT_EN10MB,
    700 		  sizeof(struct ether_header));
    701 #endif
    702 #if NRND > 0
    703 	rnd_attach_source(&sc->rnd_source, USBDEVNAME(sc->kue_dev),
    704 	    RND_TYPE_NET, 0);
    705 #endif
    706 
    707 #endif /* __NetBSD__ */
    708 	sc->kue_attached = 1;
    709 	splx(s);
    710 
    711 	usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->kue_udev,
    712 			   USBDEV(sc->kue_dev));
    713 
    714 	USB_ATTACH_SUCCESS_RETURN;
    715 }
    716 
    717 USB_DETACH(kue)
    718 {
    719 	USB_DETACH_START(kue, sc);
    720 	struct ifnet		*ifp = GET_IFP(sc);
    721 	int			s;
    722 
    723 	s = splusb();		/* XXX why? */
    724 
    725 	if (sc->kue_mcfilters != NULL) {
    726 		free(sc->kue_mcfilters, M_USBDEV);
    727 		sc->kue_mcfilters = NULL;
    728 	}
    729 
    730 	if (!sc->kue_attached) {
    731 		/* Detached before attached finished, so just bail out. */
    732 		splx(s);
    733 		return (0);
    734 	}
    735 
    736 	if (ifp->if_flags & IFF_RUNNING)
    737 		kue_stop(sc);
    738 
    739 #if defined(__NetBSD__)
    740 #if NRND > 0
    741 	rnd_detach_source(&sc->rnd_source);
    742 #endif
    743 #if NBPFILTER > 0
    744 	bpfdetach(ifp);
    745 #endif
    746 	ether_ifdetach(ifp);
    747 #endif /* __NetBSD__ */
    748 
    749 	if_detach(ifp);
    750 
    751 #ifdef DIAGNOSTIC
    752 	if (sc->kue_ep[KUE_ENDPT_TX] != NULL ||
    753 	    sc->kue_ep[KUE_ENDPT_RX] != NULL ||
    754 	    sc->kue_ep[KUE_ENDPT_INTR] != NULL)
    755 		printf("%s: detach has active endpoints\n",
    756 		       USBDEVNAME(sc->kue_dev));
    757 #endif
    758 
    759 	sc->kue_attached = 0;
    760 	splx(s);
    761 
    762 	return (0);
    763 }
    764 
    765 #if defined(__NetBSD__) || defined(__OpenBSD__)
    766 int
    767 kue_activate(self, act)
    768 	device_ptr_t self;
    769 	enum devact act;
    770 {
    771 	struct kue_softc *sc = (struct kue_softc *)self;
    772 
    773 	DPRINTFN(2,("%s: %s: enter\n", USBDEVNAME(sc->kue_dev), __FUNCTION__));
    774 
    775 	switch (act) {
    776 	case DVACT_ACTIVATE:
    777 		return (EOPNOTSUPP);
    778 		break;
    779 
    780 	case DVACT_DEACTIVATE:
    781 		/* Deactivate the interface. */
    782 		if_deactivate(&sc->kue_ec.ec_if);
    783 		sc->kue_dying = 1;
    784 		break;
    785 	}
    786 	return (0);
    787 }
    788 #endif /* defined(__NetBSD__) || defined(__OpenBSD__) */
    789 
    790 /*
    791  * Initialize an RX descriptor and attach an MBUF cluster.
    792  */
    793 static int
    794 kue_newbuf(sc, c, m)
    795 	struct kue_softc	*sc;
    796 	struct kue_chain	*c;
    797 	struct mbuf		*m;
    798 {
    799 	struct mbuf		*m_new = NULL;
    800 
    801 	DPRINTFN(10,("%s: %s: enter\n", USBDEVNAME(sc->kue_dev),__FUNCTION__));
    802 
    803 	if (m == NULL) {
    804 		MGETHDR(m_new, M_DONTWAIT, MT_DATA);
    805 		if (m_new == NULL) {
    806 			printf("%s: no memory for rx list "
    807 			    "-- packet dropped!\n", USBDEVNAME(sc->kue_dev));
    808 			return (ENOBUFS);
    809 		}
    810 
    811 		MCLGET(m_new, M_DONTWAIT);
    812 		if (!(m_new->m_flags & M_EXT)) {
    813 			printf("%s: no memory for rx list "
    814 			    "-- packet dropped!\n", USBDEVNAME(sc->kue_dev));
    815 			m_freem(m_new);
    816 			return (ENOBUFS);
    817 		}
    818 		m_new->m_len = m_new->m_pkthdr.len = MCLBYTES;
    819 	} else {
    820 		m_new = m;
    821 		m_new->m_len = m_new->m_pkthdr.len = MCLBYTES;
    822 		m_new->m_data = m_new->m_ext.ext_buf;
    823 	}
    824 
    825 	c->kue_mbuf = m_new;
    826 
    827 	return (0);
    828 }
    829 
    830 static int
    831 kue_rx_list_init(sc)
    832 	struct kue_softc	*sc;
    833 {
    834 	struct kue_cdata	*cd;
    835 	struct kue_chain	*c;
    836 	int			i;
    837 
    838 	DPRINTFN(5,("%s: %s: enter\n", USBDEVNAME(sc->kue_dev), __FUNCTION__));
    839 
    840 	cd = &sc->kue_cdata;
    841 	for (i = 0; i < KUE_RX_LIST_CNT; i++) {
    842 		c = &cd->kue_rx_chain[i];
    843 		c->kue_sc = sc;
    844 		c->kue_idx = i;
    845 		if (kue_newbuf(sc, c, NULL) == ENOBUFS)
    846 			return (ENOBUFS);
    847 		if (c->kue_xfer == NULL) {
    848 			c->kue_xfer = usbd_alloc_xfer(sc->kue_udev);
    849 			if (c->kue_xfer == NULL)
    850 				return (ENOBUFS);
    851 			c->kue_buf = usbd_alloc_buffer(c->kue_xfer, KUE_BUFSZ);
    852 			if (c->kue_buf == NULL)
    853 				return (ENOBUFS); /* XXX free xfer */
    854 		}
    855 	}
    856 
    857 	return (0);
    858 }
    859 
    860 static int
    861 kue_tx_list_init(sc)
    862 	struct kue_softc	*sc;
    863 {
    864 	struct kue_cdata	*cd;
    865 	struct kue_chain	*c;
    866 	int			i;
    867 
    868 	DPRINTFN(5,("%s: %s: enter\n", USBDEVNAME(sc->kue_dev), __FUNCTION__));
    869 
    870 	cd = &sc->kue_cdata;
    871 	for (i = 0; i < KUE_TX_LIST_CNT; i++) {
    872 		c = &cd->kue_tx_chain[i];
    873 		c->kue_sc = sc;
    874 		c->kue_idx = i;
    875 		c->kue_mbuf = NULL;
    876 		if (c->kue_xfer == NULL) {
    877 			c->kue_xfer = usbd_alloc_xfer(sc->kue_udev);
    878 			if (c->kue_xfer == NULL)
    879 				return (ENOBUFS);
    880 			c->kue_buf = usbd_alloc_buffer(c->kue_xfer, KUE_BUFSZ);
    881 			if (c->kue_buf == NULL)
    882 				return (ENOBUFS);
    883 		}
    884 	}
    885 
    886 	return (0);
    887 }
    888 
    889 #ifdef __FreeBSD__
    890 static void
    891 kue_rxstart(ifp)
    892 	struct ifnet		*ifp;
    893 {
    894 	struct kue_softc	*sc;
    895 	struct kue_chain	*c;
    896 
    897 	sc = ifp->if_softc;
    898 	c = &sc->kue_cdata.kue_rx_chain[sc->kue_cdata.kue_rx_prod];
    899 
    900 	if (kue_newbuf(sc, c, NULL) == ENOBUFS) {
    901 		ifp->if_ierrors++;
    902 		return;
    903 	}
    904 
    905 	/* Setup new transfer. */
    906 	usbd_setup_xfer(c->kue_xfer, sc->kue_ep[KUE_ENDPT_RX],
    907 	    c, c->kue_buf, KUE_BUFSZ, USBD_SHORT_XFER_OK | USBD_NO_COPY,
    908 	    USBD_NO_TIMEOUT, kue_rxeof);
    909 	usbd_transfer(c->kue_xfer);
    910 }
    911 #endif
    912 
    913 /*
    914  * A frame has been uploaded: pass the resulting mbuf chain up to
    915  * the higher level protocols.
    916  */
    917 static void
    918 kue_rxeof(xfer, priv, status)
    919 	usbd_xfer_handle	xfer;
    920 	usbd_private_handle	priv;
    921 	usbd_status		status;
    922 {
    923 	struct kue_chain	*c = priv;
    924 	struct kue_softc	*sc = c->kue_sc;
    925 	struct ifnet		*ifp = GET_IFP(sc);
    926 	struct mbuf		*m;
    927 	int			total_len = 0;
    928 #if defined(__NetBSD__) || defined(__OpenBSD__)
    929 	int			s;
    930 #endif /* defined(__NetBSD__) || defined(__OpenBSD__) */
    931 
    932 	DPRINTFN(10,("%s: %s: enter status=%d\n", USBDEVNAME(sc->kue_dev),
    933 		     __FUNCTION__, status));
    934 
    935 	if (sc->kue_dying)
    936 		return;
    937 
    938 	if (!(ifp->if_flags & IFF_RUNNING))
    939 		return;
    940 
    941 	if (status != USBD_NORMAL_COMPLETION) {
    942 		if (status == USBD_NOT_STARTED || status == USBD_CANCELLED)
    943 			return;
    944 		printf("%s: usb error on rx: %s\n", USBDEVNAME(sc->kue_dev),
    945 		    usbd_errstr(status));
    946 		if (status == USBD_STALLED)
    947 			usbd_clear_endpoint_stall(sc->kue_ep[KUE_ENDPT_RX]);
    948 		goto done;
    949 	}
    950 
    951 	usbd_get_xfer_status(xfer, NULL, NULL, &total_len, NULL);
    952 
    953 	DPRINTFN(10,("%s: %s: total_len=%d len=%d\n", USBDEVNAME(sc->kue_dev),
    954 		     __FUNCTION__, total_len,
    955 		     UGETW(mtod(c->kue_mbuf, u_int8_t *))));
    956 
    957 	m = c->kue_mbuf;
    958 	if (total_len <= 1)
    959 		goto done;
    960 
    961 	/* copy data to mbuf */
    962 	memcpy(mtod(m, char*), c->kue_buf, total_len);
    963 
    964 	/* No errors; receive the packet. */
    965 	total_len = UGETW(mtod(m, u_int8_t *));
    966 	m_adj(m, sizeof(u_int16_t));
    967 
    968 	if (total_len < sizeof(struct ether_header)) {
    969 		ifp->if_ierrors++;
    970 		goto done;
    971 	}
    972 
    973 	ifp->if_ipackets++;
    974 	m->m_pkthdr.len = m->m_len = total_len;
    975 
    976 #if defined(__FreeBSD__)
    977 	m->m_pkthdr.rcvif = (struct ifnet *)&kue_qdat;
    978 	/* Put the packet on the special USB input queue. */
    979 	usb_ether_input(m);
    980 
    981 	return;
    982 
    983 #elif defined(__NetBSD__) || defined(__OpenBSD__)
    984 	m->m_pkthdr.rcvif = ifp;
    985 
    986 	s = splimp();
    987 
    988 	/* XXX ugly */
    989 	if (kue_newbuf(sc, c, NULL) == ENOBUFS) {
    990 		ifp->if_ierrors++;
    991 		goto done1;
    992 	}
    993 
    994 	/*
    995 	 * Handle BPF listeners. Let the BPF user see the packet, but
    996 	 * don't pass it up to the ether_input() layer unless it's
    997 	 * a broadcast packet, multicast packet, matches our ethernet
    998 	 * address or the interface is in promiscuous mode.
    999 	 */
   1000 	if (ifp->if_bpf) {
   1001 		struct ether_header *eh = mtod(m, struct ether_header *);
   1002 		BPF_MTAP(ifp, m);
   1003 		if ((ifp->if_flags & IFF_PROMISC) &&
   1004 		    memcmp(eh->ether_dhost, LLADDR(ifp->if_sadl),
   1005 			   ETHER_ADDR_LEN) &&
   1006 		    !(eh->ether_dhost[0] & 1)) {
   1007 			m_freem(m);
   1008 			goto done1;
   1009 		}
   1010 	}
   1011 
   1012 	DPRINTFN(10,("%s: %s: deliver %d\n", USBDEVNAME(sc->kue_dev),
   1013 		    __FUNCTION__, m->m_len));
   1014 	(*ifp->if_input)(ifp, m);
   1015  done1:
   1016 	splx(s);
   1017 #endif /* defined(__NetBSD__) || defined(__OpenBSD__) */
   1018 
   1019  done:
   1020 
   1021 	/* Setup new transfer. */
   1022 	usbd_setup_xfer(c->kue_xfer, sc->kue_ep[KUE_ENDPT_RX],
   1023 	    c, c->kue_buf, KUE_BUFSZ, USBD_SHORT_XFER_OK | USBD_NO_COPY,
   1024 	    USBD_NO_TIMEOUT, kue_rxeof);
   1025 	usbd_transfer(c->kue_xfer);
   1026 
   1027 	DPRINTFN(10,("%s: %s: start rx\n", USBDEVNAME(sc->kue_dev),
   1028 		    __FUNCTION__));
   1029 }
   1030 
   1031 /*
   1032  * A frame was downloaded to the chip. It's safe for us to clean up
   1033  * the list buffers.
   1034  */
   1035 
   1036 static void
   1037 kue_txeof(xfer, priv, status)
   1038 	usbd_xfer_handle	xfer;
   1039 	usbd_private_handle	priv;
   1040 	usbd_status		status;
   1041 {
   1042 	struct kue_chain	*c = priv;
   1043 	struct kue_softc	*sc = c->kue_sc;
   1044 	struct ifnet		*ifp = GET_IFP(sc);
   1045 	int			s;
   1046 
   1047 	if (sc->kue_dying)
   1048 		return;
   1049 
   1050 	s = splimp();
   1051 
   1052 	DPRINTFN(10,("%s: %s: enter status=%d\n", USBDEVNAME(sc->kue_dev),
   1053 		    __FUNCTION__, status));
   1054 
   1055 	ifp->if_timer = 0;
   1056 	ifp->if_flags &= ~IFF_OACTIVE;
   1057 
   1058 	if (status != USBD_NORMAL_COMPLETION) {
   1059 		if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) {
   1060 			splx(s);
   1061 			return;
   1062 		}
   1063 		ifp->if_oerrors++;
   1064 		printf("%s: usb error on tx: %s\n", USBDEVNAME(sc->kue_dev),
   1065 		    usbd_errstr(status));
   1066 		if (status == USBD_STALLED)
   1067 			usbd_clear_endpoint_stall(sc->kue_ep[KUE_ENDPT_TX]);
   1068 		splx(s);
   1069 		return;
   1070 	}
   1071 
   1072 	ifp->if_opackets++;
   1073 
   1074 #if defined(__FreeBSD__)
   1075 	c->kue_mbuf->m_pkthdr.rcvif = ifp;
   1076 	usb_tx_done(c->kue_mbuf);
   1077 	c->kue_mbuf = NULL;
   1078 #elif defined(__NetBSD__) || defined(__OpenBSD__)
   1079 	m_freem(c->kue_mbuf);
   1080 	c->kue_mbuf = NULL;
   1081 
   1082 	if (ifp->if_snd.ifq_head != NULL)
   1083 		kue_start(ifp);
   1084 #endif /* defined(__NetBSD__) || defined(__OpenBSD__) */
   1085 
   1086 	splx(s);
   1087 }
   1088 
   1089 static int
   1090 kue_send(sc, m, idx)
   1091 	struct kue_softc	*sc;
   1092 	struct mbuf		*m;
   1093 	int			idx;
   1094 {
   1095 	int			total_len;
   1096 	struct kue_chain	*c;
   1097 	usbd_status		err;
   1098 
   1099 	DPRINTFN(10,("%s: %s: enter\n", USBDEVNAME(sc->kue_dev),__FUNCTION__));
   1100 
   1101 	c = &sc->kue_cdata.kue_tx_chain[idx];
   1102 
   1103 	/*
   1104 	 * Copy the mbuf data into a contiguous buffer, leaving two
   1105 	 * bytes at the beginning to hold the frame length.
   1106 	 */
   1107 	m_copydata(m, 0, m->m_pkthdr.len, c->kue_buf + 2);
   1108 	c->kue_mbuf = m;
   1109 
   1110 	total_len = m->m_pkthdr.len + 2;
   1111 	/* XXX what's this? */
   1112 	total_len += 64 - (total_len % 64);
   1113 
   1114 	/* Frame length is specified in the first 2 bytes of the buffer. */
   1115 	c->kue_buf[0] = (u_int8_t)m->m_pkthdr.len;
   1116 	c->kue_buf[1] = (u_int8_t)(m->m_pkthdr.len >> 8);
   1117 
   1118 	/* XXX 10000 */
   1119 	usbd_setup_xfer(c->kue_xfer, sc->kue_ep[KUE_ENDPT_TX],
   1120 	    c, c->kue_buf, total_len, USBD_NO_COPY, 10000, kue_txeof);
   1121 
   1122 	/* Transmit */
   1123 	err = usbd_transfer(c->kue_xfer);
   1124 	if (err != USBD_IN_PROGRESS) {
   1125 		kue_stop(sc);
   1126 		return (EIO);
   1127 	}
   1128 
   1129 	sc->kue_cdata.kue_tx_cnt++;
   1130 
   1131 	return (0);
   1132 }
   1133 
   1134 static void
   1135 kue_start(ifp)
   1136 	struct ifnet		*ifp;
   1137 {
   1138 	struct kue_softc	*sc = ifp->if_softc;
   1139 	struct mbuf		*m_head = NULL;
   1140 
   1141 	DPRINTFN(10,("%s: %s: enter\n", USBDEVNAME(sc->kue_dev),__FUNCTION__));
   1142 
   1143 	if (sc->kue_dying)
   1144 		return;
   1145 
   1146 	if (ifp->if_flags & IFF_OACTIVE)
   1147 		return;
   1148 
   1149 	IF_DEQUEUE(&ifp->if_snd, m_head);
   1150 	if (m_head == NULL)
   1151 		return;
   1152 
   1153 	if (kue_send(sc, m_head, 0)) {
   1154 		IF_PREPEND(&ifp->if_snd, m_head);
   1155 		ifp->if_flags |= IFF_OACTIVE;
   1156 		return;
   1157 	}
   1158 
   1159 	/*
   1160 	 * If there's a BPF listener, bounce a copy of this frame
   1161 	 * to him.
   1162 	 */
   1163 	if (ifp->if_bpf)
   1164 		BPF_MTAP(ifp, m_head);
   1165 
   1166 	ifp->if_flags |= IFF_OACTIVE;
   1167 
   1168 	/*
   1169 	 * Set a timeout in case the chip goes out to lunch.
   1170 	 */
   1171 	ifp->if_timer = 5;
   1172 }
   1173 
   1174 static void
   1175 kue_init(xsc)
   1176 	void			*xsc;
   1177 {
   1178 	struct kue_softc	*sc = xsc;
   1179 	struct ifnet		*ifp = GET_IFP(sc);
   1180 	int			s;
   1181 	u_char			*eaddr;
   1182 
   1183 	DPRINTFN(5,("%s: %s: enter\n", USBDEVNAME(sc->kue_dev),__FUNCTION__));
   1184 
   1185 	if (ifp->if_flags & IFF_RUNNING)
   1186 		return;
   1187 
   1188 	s = splimp();
   1189 
   1190 #if defined(__FreeBSD__)
   1191 	eaddr = sc->arpcom.ac_enaddr;
   1192 #elif defined(__NetBSD__) || defined(__OpenBSD__)
   1193 	eaddr = LLADDR(ifp->if_sadl);
   1194 #endif /* defined(__NetBSD__) || defined(__OpenBSD__) */
   1195 	/* Set MAC address */
   1196 	kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SET_MAC, 0, eaddr, ETHER_ADDR_LEN);
   1197 
   1198 	sc->kue_rxfilt = KUE_RXFILT_UNICAST | KUE_RXFILT_BROADCAST;
   1199 
   1200 	 /* If we want promiscuous mode, set the allframes bit. */
   1201 	if (ifp->if_flags & IFF_PROMISC)
   1202 		sc->kue_rxfilt |= KUE_RXFILT_PROMISC;
   1203 
   1204 	kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->kue_rxfilt);
   1205 
   1206 	/* I'm not sure how to tune these. */
   1207 #if 0
   1208 	/*
   1209 	 * Leave this one alone for now; setting it
   1210 	 * wrong causes lockups on some machines/controllers.
   1211 	 */
   1212 	kue_setword(sc, KUE_CMD_SET_SOFS, 1);
   1213 #endif
   1214 	kue_setword(sc, KUE_CMD_SET_URB_SIZE, 64);
   1215 
   1216 	/* Init TX ring. */
   1217 	if (kue_tx_list_init(sc) == ENOBUFS) {
   1218 		printf("%s: tx list init failed\n", USBDEVNAME(sc->kue_dev));
   1219 		splx(s);
   1220 		return;
   1221 	}
   1222 
   1223 	/* Init RX ring. */
   1224 	if (kue_rx_list_init(sc) == ENOBUFS) {
   1225 		printf("%s: rx list init failed\n", USBDEVNAME(sc->kue_dev));
   1226 		splx(s);
   1227 		return;
   1228 	}
   1229 
   1230 	/* Load the multicast filter. */
   1231 	kue_setmulti(sc);
   1232 
   1233 	if (sc->kue_ep[KUE_ENDPT_RX] == NULL) {
   1234 		if (kue_open_pipes(sc)) {
   1235 			splx(s);
   1236 			return;
   1237 		}
   1238 	}
   1239 
   1240 	ifp->if_flags |= IFF_RUNNING;
   1241 	ifp->if_flags &= ~IFF_OACTIVE;
   1242 
   1243 	splx(s);
   1244 }
   1245 
   1246 static int
   1247 kue_open_pipes(sc)
   1248 	struct kue_softc	*sc;
   1249 {
   1250 	usbd_status		err;
   1251 	struct kue_chain	*c;
   1252 	int			i;
   1253 
   1254 	DPRINTFN(5,("%s: %s: enter\n", USBDEVNAME(sc->kue_dev),__FUNCTION__));
   1255 
   1256 	/* Open RX and TX pipes. */
   1257 	err = usbd_open_pipe(sc->kue_iface, sc->kue_ed[KUE_ENDPT_RX],
   1258 	    USBD_EXCLUSIVE_USE, &sc->kue_ep[KUE_ENDPT_RX]);
   1259 	if (err) {
   1260 		printf("%s: open rx pipe failed: %s\n",
   1261 		    USBDEVNAME(sc->kue_dev), usbd_errstr(err));
   1262 		return (EIO);
   1263 	}
   1264 
   1265 	err = usbd_open_pipe(sc->kue_iface, sc->kue_ed[KUE_ENDPT_TX],
   1266 	    USBD_EXCLUSIVE_USE, &sc->kue_ep[KUE_ENDPT_TX]);
   1267 	if (err) {
   1268 		printf("%s: open tx pipe failed: %s\n",
   1269 		    USBDEVNAME(sc->kue_dev), usbd_errstr(err));
   1270 		return (EIO);
   1271 	}
   1272 
   1273 	/* Start up the receive pipe. */
   1274 	for (i = 0; i < KUE_RX_LIST_CNT; i++) {
   1275 		c = &sc->kue_cdata.kue_rx_chain[i];
   1276 		usbd_setup_xfer(c->kue_xfer, sc->kue_ep[KUE_ENDPT_RX],
   1277 		    c, c->kue_buf, KUE_BUFSZ,
   1278 		    USBD_SHORT_XFER_OK | USBD_NO_COPY, USBD_NO_TIMEOUT,
   1279 		    kue_rxeof);
   1280 		usbd_transfer(c->kue_xfer);
   1281 		DPRINTFN(5,("%s: %s: start read\n", USBDEVNAME(sc->kue_dev),
   1282 			    __FUNCTION__));
   1283 	}
   1284 
   1285 	return (0);
   1286 }
   1287 
   1288 static int
   1289 kue_ioctl(ifp, command, data)
   1290 	struct ifnet		*ifp;
   1291 	u_long			command;
   1292 	caddr_t			data;
   1293 {
   1294 	struct kue_softc	*sc = ifp->if_softc;
   1295 #if defined(__NetBSD__) || defined(__OpenBSD__)
   1296 	struct ifaddr 		*ifa = (struct ifaddr *)data;
   1297 	struct ifreq		*ifr = (struct ifreq *)data;
   1298 #endif
   1299 	int			s, error = 0;
   1300 
   1301 	DPRINTFN(5,("%s: %s: enter\n", USBDEVNAME(sc->kue_dev),__FUNCTION__));
   1302 
   1303 	if (sc->kue_dying)
   1304 		return (EIO);
   1305 
   1306 	s = splimp();
   1307 
   1308 	switch(command) {
   1309 #if defined(__FreeBSD__)
   1310 	case SIOCSIFADDR:
   1311 	case SIOCGIFADDR:
   1312 	case SIOCSIFMTU:
   1313 		error = ether_ioctl(ifp, command, data);
   1314 		break;
   1315 #elif defined(__NetBSD__) || defined(__OpenBSD__)
   1316 	case SIOCSIFADDR:
   1317 		ifp->if_flags |= IFF_UP;
   1318 		kue_init(sc);
   1319 
   1320 		switch (ifa->ifa_addr->sa_family) {
   1321 #ifdef INET
   1322 		case AF_INET:
   1323 			arp_ifinit(ifp, ifa);
   1324 			break;
   1325 #endif /* INET */
   1326 #ifdef NS
   1327 		case AF_NS:
   1328 		    {
   1329 			struct ns_addr *ina = &IA_SNS(ifa)->sns_addr;
   1330 
   1331 			if (ns_nullhost(*ina))
   1332 				ina->x_host = *(union ns_host *)
   1333 					LLADDR(ifp->if_sadl);
   1334 			else
   1335 				memcpy(LLADDR(ifp->if_sadl),
   1336 				       ina->x_host.c_host,
   1337 				       ifp->if_addrlen);
   1338 			break;
   1339 		    }
   1340 #endif /* NS */
   1341 		}
   1342 		break;
   1343 
   1344 	case SIOCSIFMTU:
   1345 		if (ifr->ifr_mtu > ETHERMTU)
   1346 			error = EINVAL;
   1347 		else
   1348 			ifp->if_mtu = ifr->ifr_mtu;
   1349 		break;
   1350 
   1351 #endif /* defined(__NetBSD__) || defined(__OpenBSD__) */
   1352 
   1353 	case SIOCSIFFLAGS:
   1354 		if (ifp->if_flags & IFF_UP) {
   1355 			if (ifp->if_flags & IFF_RUNNING &&
   1356 			    ifp->if_flags & IFF_PROMISC &&
   1357 			    !(sc->kue_if_flags & IFF_PROMISC)) {
   1358 				sc->kue_rxfilt |= KUE_RXFILT_PROMISC;
   1359 				kue_setword(sc, KUE_CMD_SET_PKT_FILTER,
   1360 				    sc->kue_rxfilt);
   1361 			} else if (ifp->if_flags & IFF_RUNNING &&
   1362 			    !(ifp->if_flags & IFF_PROMISC) &&
   1363 			    sc->kue_if_flags & IFF_PROMISC) {
   1364 				sc->kue_rxfilt &= ~KUE_RXFILT_PROMISC;
   1365 				kue_setword(sc, KUE_CMD_SET_PKT_FILTER,
   1366 				    sc->kue_rxfilt);
   1367 			} else if (!(ifp->if_flags & IFF_RUNNING))
   1368 				kue_init(sc);
   1369 		} else {
   1370 			if (ifp->if_flags & IFF_RUNNING)
   1371 				kue_stop(sc);
   1372 		}
   1373 		sc->kue_if_flags = ifp->if_flags;
   1374 		error = 0;
   1375 		break;
   1376 	case SIOCADDMULTI:
   1377 	case SIOCDELMULTI:
   1378 		kue_setmulti(sc);
   1379 		error = 0;
   1380 		break;
   1381 	default:
   1382 		error = EINVAL;
   1383 		break;
   1384 	}
   1385 
   1386 	splx(s);
   1387 
   1388 	return (error);
   1389 }
   1390 
   1391 static void
   1392 kue_watchdog(ifp)
   1393 	struct ifnet		*ifp;
   1394 {
   1395 	struct kue_softc	*sc = ifp->if_softc;
   1396 
   1397 	DPRINTFN(5,("%s: %s: enter\n", USBDEVNAME(sc->kue_dev),__FUNCTION__));
   1398 
   1399 	if (sc->kue_dying)
   1400 		return;
   1401 
   1402 	ifp->if_oerrors++;
   1403 	printf("%s: watchdog timeout\n", USBDEVNAME(sc->kue_dev));
   1404 
   1405 	/*
   1406 	 * The polling business is a kludge to avoid allowing the
   1407 	 * USB code to call tsleep() in usbd_delay_ms(), which will
   1408 	 * kill us since the watchdog routine is invoked from
   1409 	 * interrupt context.
   1410 	 */
   1411 	usbd_set_polling(sc->kue_udev, 1);
   1412 	kue_stop(sc);
   1413 	kue_init(sc);
   1414 	usbd_set_polling(sc->kue_udev, 0);
   1415 
   1416 	if (ifp->if_snd.ifq_head != NULL)
   1417 		kue_start(ifp);
   1418 }
   1419 
   1420 /*
   1421  * Stop the adapter and free any mbufs allocated to the
   1422  * RX and TX lists.
   1423  */
   1424 static void
   1425 kue_stop(sc)
   1426 	struct kue_softc	*sc;
   1427 {
   1428 	usbd_status		err;
   1429 	struct ifnet		*ifp;
   1430 	int			i;
   1431 
   1432 	DPRINTFN(5,("%s: %s: enter\n", USBDEVNAME(sc->kue_dev),__FUNCTION__));
   1433 
   1434 	ifp = GET_IFP(sc);
   1435 	ifp->if_timer = 0;
   1436 
   1437 	/* Stop transfers. */
   1438 	if (sc->kue_ep[KUE_ENDPT_RX] != NULL) {
   1439 		err = usbd_abort_pipe(sc->kue_ep[KUE_ENDPT_RX]);
   1440 		if (err) {
   1441 			printf("%s: abort rx pipe failed: %s\n",
   1442 			    USBDEVNAME(sc->kue_dev), usbd_errstr(err));
   1443 		}
   1444 		err = usbd_close_pipe(sc->kue_ep[KUE_ENDPT_RX]);
   1445 		if (err) {
   1446 			printf("%s: close rx pipe failed: %s\n",
   1447 			    USBDEVNAME(sc->kue_dev), usbd_errstr(err));
   1448 		}
   1449 		sc->kue_ep[KUE_ENDPT_RX] = NULL;
   1450 	}
   1451 
   1452 	if (sc->kue_ep[KUE_ENDPT_TX] != NULL) {
   1453 		err = usbd_abort_pipe(sc->kue_ep[KUE_ENDPT_TX]);
   1454 		if (err) {
   1455 			printf("%s: abort tx pipe failed: %s\n",
   1456 			    USBDEVNAME(sc->kue_dev), usbd_errstr(err));
   1457 		}
   1458 		err = usbd_close_pipe(sc->kue_ep[KUE_ENDPT_TX]);
   1459 		if (err) {
   1460 			printf("%s: close tx pipe failed: %s\n",
   1461 			    USBDEVNAME(sc->kue_dev), usbd_errstr(err));
   1462 		}
   1463 		sc->kue_ep[KUE_ENDPT_TX] = NULL;
   1464 	}
   1465 
   1466 	if (sc->kue_ep[KUE_ENDPT_INTR] != NULL) {
   1467 		err = usbd_abort_pipe(sc->kue_ep[KUE_ENDPT_INTR]);
   1468 		if (err) {
   1469 			printf("%s: abort intr pipe failed: %s\n",
   1470 			    USBDEVNAME(sc->kue_dev), usbd_errstr(err));
   1471 		}
   1472 		err = usbd_close_pipe(sc->kue_ep[KUE_ENDPT_INTR]);
   1473 		if (err) {
   1474 			printf("%s: close intr pipe failed: %s\n",
   1475 			    USBDEVNAME(sc->kue_dev), usbd_errstr(err));
   1476 		}
   1477 		sc->kue_ep[KUE_ENDPT_INTR] = NULL;
   1478 	}
   1479 
   1480 	/* Free RX resources. */
   1481 	for (i = 0; i < KUE_RX_LIST_CNT; i++) {
   1482 		if (sc->kue_cdata.kue_rx_chain[i].kue_mbuf != NULL) {
   1483 			m_freem(sc->kue_cdata.kue_rx_chain[i].kue_mbuf);
   1484 			sc->kue_cdata.kue_rx_chain[i].kue_mbuf = NULL;
   1485 		}
   1486 		if (sc->kue_cdata.kue_rx_chain[i].kue_xfer != NULL) {
   1487 			usbd_free_xfer(sc->kue_cdata.kue_rx_chain[i].kue_xfer);
   1488 			sc->kue_cdata.kue_rx_chain[i].kue_xfer = NULL;
   1489 		}
   1490 	}
   1491 
   1492 	/* Free TX resources. */
   1493 	for (i = 0; i < KUE_TX_LIST_CNT; i++) {
   1494 		if (sc->kue_cdata.kue_tx_chain[i].kue_mbuf != NULL) {
   1495 			m_freem(sc->kue_cdata.kue_tx_chain[i].kue_mbuf);
   1496 			sc->kue_cdata.kue_tx_chain[i].kue_mbuf = NULL;
   1497 		}
   1498 		if (sc->kue_cdata.kue_tx_chain[i].kue_xfer != NULL) {
   1499 			usbd_free_xfer(sc->kue_cdata.kue_tx_chain[i].kue_xfer);
   1500 			sc->kue_cdata.kue_tx_chain[i].kue_xfer = NULL;
   1501 		}
   1502 	}
   1503 
   1504 	ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
   1505 }
   1506 
   1507 #ifdef __FreeBSD__
   1508 /*
   1509  * Stop all chip I/O so that the kernel's probe routines don't
   1510  * get confused by errant DMAs when rebooting.
   1511  */
   1512 static void
   1513 kue_shutdown(dev)
   1514 	device_t		dev;
   1515 {
   1516 	struct kue_softc	*sc;
   1517 
   1518 	sc = device_get_softc(dev);
   1519 
   1520 	kue_stop(sc);
   1521 }
   1522 #endif
   1523