sys/dev/netif/kue/if_kue.c

   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  * $FreeBSD: src/sys/dev/usb/if_kue.c,v 1.17.2.9 2003/04/13 02:39:25 murray Exp $
  33  * $DragonFly: src/sys/dev/netif/kue/if_kue.c,v 1.26 2007/11/05 13:32:27 hasso Exp $
  34  */
  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/param.h>
  69 #include <sys/systm.h>
  70 #include <sys/sockio.h>
  71 #include <sys/mbuf.h>
  72 #include <sys/malloc.h>
  73 #include <sys/kernel.h>
  74 #include <sys/socket.h>
  75 #include <sys/bus.h>
  76
  77 #include <net/if.h>
  78 #include <net/ifq_var.h>
  79 #include <net/if_arp.h>
  80 #include <net/ethernet.h>
  81 #include <net/if_dl.h>
  82 #include <net/if_media.h>
  83 #include <net/bpf.h>
  84
  85 #include <machine/clock.h>
  86
  87 #include <bus/usb/usb.h>
  88 #include <bus/usb/usbdi.h>
  89 #include <bus/usb/usbdi_util.h>
  90 #include <bus/usb/usbdivar.h>
  91 #include <bus/usb/usbdevs.h>
  92 #include <bus/usb/usb_ethersubr.h>
  93
  94 #include "if_kuereg.h"
  95 #include <bus/usb/kue_fw.h>
  96
  97 MODULE_DEPEND(kue, usb, 1, 1, 1);
  98
  99 /*
 100  * Various supported device vendors/products.
 101  */
 102 static const struct usb_devno kue_devs[] = {
 103         { USB_DEVICE(0x03e8, 0x0008) }, /* AOX USB101 */
 104         { USB_DEVICE(0x04bb, 0x0901) }, /* I-O DATA USBETT */
 105         { USB_DEVICE(0x0506, 0x03e8) }, /* 3Com 3C19250 */
 106         { USB_DEVICE(0x0557, 0x2002) }, /* ATen UC10T */
 107         { USB_DEVICE(0x0565, 0x0002) }, /* Peracom Ethernet adapter */
 108         { USB_DEVICE(0x0565, 0x0003) }, /* Peracom Ethernet adapter*/
 109         { USB_DEVICE(0x0565, 0x0005) }, /* Peracom Ethernet adapter */
 110         { USB_DEVICE(0x05e9, 0x0008) }, /* AOX (rebranded Kawasaki?) USB101*/
 111         { USB_DEVICE(0x05e9, 0x0008) }, /* Kawasaki LSI DUH3E10BT */
 112         { USB_DEVICE(0x05e9, 0x0009) }, /* Kawasaki LSI DUH3E10BTN */
 113         { USB_DEVICE(0x066b, 0x2202) }, /* Linksys USB10T */
 114         { USB_DEVICE(0x06e1, 0x0008) }, /* ADS UBS-10BT */
 115         { USB_DEVICE(0x0707, 0x0100) }, /* SMC 2102USB */
 116         { USB_DEVICE(0x07aa, 0x0001) }, /* Corega USB-T*/
 117         { USB_DEVICE(0x07b8, 0x4000) }, /* AboCom URE450 */
 118         { USB_DEVICE(0x0846, 0x1001) }, /* Netgear EA101 */
 119         { USB_DEVICE(0x1645, 0x0005) }, /* Entrega E45*/
 120         { USB_DEVICE(0x2001, 0x4000) }, /* D-Link DSB650C */
 121 };
 122
 123 static int kue_match(device_t);
 124 static int kue_attach(device_t);
 125 static int kue_detach(device_t);
 126 static void kue_shutdown(device_t);
 127 static int kue_tx_list_init(struct kue_softc *);
 128 static int kue_rx_list_init(struct kue_softc *);
 129 static int kue_newbuf(struct kue_softc *, struct kue_chain *, struct mbuf *);
 130 static int kue_encap(struct kue_softc *, struct mbuf *, int);
 131 static void kue_rxeof(usbd_xfer_handle, usbd_private_handle, usbd_status);
 132 static void kue_txeof(usbd_xfer_handle, usbd_private_handle, usbd_status);
 133 static void kue_start(struct ifnet *);
 134 static void kue_rxstart(struct ifnet *);
 135 static int kue_ioctl(struct ifnet *, u_long, caddr_t, struct ucred *);
 136 static void kue_init(void *);
 137 static void kue_stop(struct kue_softc *);
 138 static void kue_watchdog(struct ifnet *);
 139
 140 static void kue_setmulti(struct kue_softc *);
 141 static void kue_reset(struct kue_softc *);
 142
 143 static usbd_status kue_do_request(usbd_device_handle,
 144                                   usb_device_request_t *, void *);
 145 static usbd_status kue_ctl(struct kue_softc *, int, u_int8_t,
 146                            u_int16_t, char *, int);
 147 static usbd_status kue_setword(struct kue_softc *, u_int8_t, u_int16_t);
 148 static int kue_load_fw(struct kue_softc *);
 149
 150 static device_method_t kue_methods[] = {
 151         /* Device interface */
 152         DEVMETHOD(device_probe,         kue_match),
 153         DEVMETHOD(device_attach,        kue_attach),
 154         DEVMETHOD(device_detach,        kue_detach),
 155         DEVMETHOD(device_shutdown,      kue_shutdown),
 156
 157         { 0, 0 }
 158 };
 159
 160 static driver_t kue_driver = {
 161         "kue",
 162         kue_methods,
 163         sizeof(struct kue_softc)
 164 };
 165
 166 static devclass_t kue_devclass;
 167
 168 DECLARE_DUMMY_MODULE(if_kue);
 169 DRIVER_MODULE(kue, uhub, kue_driver, kue_devclass, usbd_driver_load, 0);
 170
 171 /*
 172  * We have a custom do_request function which is almost like the
 173  * regular do_request function, except it has a much longer timeout.
 174  * Why? Because we need to make requests over the control endpoint
 175  * to download the firmware to the device, which can take longer
 176  * than the default timeout.
 177  */
 178 static usbd_status
 179 kue_do_request(usbd_device_handle dev, usb_device_request_t *req, void *data)
 180 {
 181         usbd_xfer_handle        xfer;
 182         usbd_status             err;
 183
 184         xfer = usbd_alloc_xfer(dev);
 185         usbd_setup_default_xfer(xfer, dev, 0, 500000, req,
 186             data, UGETW(req->wLength), USBD_SHORT_XFER_OK, 0);
 187         err = usbd_sync_transfer(xfer);
 188         usbd_free_xfer(xfer);
 189         return(err);
 190 }
 191
 192 static usbd_status
 193 kue_setword(struct kue_softc *sc, u_int8_t breq, u_int16_t word)
 194 {
 195         usbd_device_handle      dev;
 196         usb_device_request_t    req;
 197         usbd_status             err;
 198
 199         if (sc->kue_dying)
 200                 return(USBD_NORMAL_COMPLETION);
 201
 202         dev = sc->kue_udev;
 203
 204         KUE_LOCK(sc);
 205
 206         req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
 207
 208         req.bRequest = breq;
 209         USETW(req.wValue, word);
 210         USETW(req.wIndex, 0);
 211         USETW(req.wLength, 0);
 212
 213         err = kue_do_request(dev, &req, NULL);
 214
 215         KUE_UNLOCK(sc);
 216
 217         return(err);
 218 }
 219
 220 static usbd_status
 221 kue_ctl(struct kue_softc *sc, int rw, u_int8_t breq, u_int16_t val,
 222         char *data, int len)
 223 {
 224         usbd_device_handle      dev;
 225         usb_device_request_t    req;
 226         usbd_status             err;
 227
 228         dev = sc->kue_udev;
 229
 230         if (sc->kue_dying)
 231                 return(USBD_NORMAL_COMPLETION);
 232
 233         KUE_LOCK(sc);
 234
 235         if (rw == KUE_CTL_WRITE)
 236                 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
 237         else
 238                 req.bmRequestType = UT_READ_VENDOR_DEVICE;
 239
 240         req.bRequest = breq;
 241         USETW(req.wValue, val);
 242         USETW(req.wIndex, 0);
 243         USETW(req.wLength, len);
 244
 245         err = kue_do_request(dev, &req, data);
 246
 247         KUE_UNLOCK(sc);
 248
 249         return(err);
 250 }
 251
 252 static int
 253 kue_load_fw(struct kue_softc *sc)
 254 {
 255         usbd_status             err;
 256         usb_device_descriptor_t *dd;
 257         int                     hwrev;
 258
 259         dd = &sc->kue_udev->ddesc;
 260         hwrev = UGETW(dd->bcdDevice);
 261
 262         /*
 263          * First, check if we even need to load the firmware.
 264          * If the device was still attached when the system was
 265          * rebooted, it may already have firmware loaded in it.
 266          * If this is the case, we don't need to do it again.
 267          * And in fact, if we try to load it again, we'll hang,
 268          * so we have to avoid this condition if we don't want
 269          * to look stupid.
 270          *
 271          * We can test this quickly by checking the bcdRevision
 272          * code. The NIC will return a different revision code if
 273          * it's probed while the firmware is still loaded and
 274          * running.
 275          */
 276         if (hwrev == 0x0202)
 277                 return(0);
 278
 279         /* Load code segment */
 280         err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN,
 281             0, kue_code_seg, sizeof(kue_code_seg));
 282         if (err) {
 283                 kprintf("kue%d: failed to load code segment: %s\n",
 284                     sc->kue_unit, usbd_errstr(err));
 285                         return(ENXIO);
 286         }
 287
 288         /* Load fixup segment */
 289         err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN,
 290             0, kue_fix_seg, sizeof(kue_fix_seg));
 291         if (err) {
 292                 kprintf("kue%d: failed to load fixup segment: %s\n",
 293                     sc->kue_unit, usbd_errstr(err));
 294                         return(ENXIO);
 295         }
 296
 297         /* Send trigger command. */
 298         err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN,
 299             0, kue_trig_seg, sizeof(kue_trig_seg));
 300         if (err) {
 301                 kprintf("kue%d: failed to load trigger segment: %s\n",
 302                     sc->kue_unit, usbd_errstr(err));
 303                         return(ENXIO);
 304         }
 305
 306         return(0);
 307 }
 308
 309 static void
 310 kue_setmulti(struct kue_softc *sc)
 311 {
 312         struct ifnet            *ifp;
 313         struct ifmultiaddr      *ifma;
 314         int                     i = 0;
 315
 316         ifp = &sc->arpcom.ac_if;
 317
 318         if (ifp->if_flags & IFF_ALLMULTI || ifp->if_flags & IFF_PROMISC) {
 319                 sc->kue_rxfilt |= KUE_RXFILT_ALLMULTI;
 320                 sc->kue_rxfilt &= ~KUE_RXFILT_MULTICAST;
 321                 kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->kue_rxfilt);
 322                 return;
 323         }
 324
 325         sc->kue_rxfilt &= ~KUE_RXFILT_ALLMULTI;
 326
 327 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
 328         TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link)
 329 #else
 330         LIST_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link)
 331 #endif
 332         {
 333                 if (ifma->ifma_addr->sa_family != AF_LINK)
 334                         continue;
 335                 /*
 336                  * If there are too many addresses for the
 337                  * internal filter, switch over to allmulti mode.
 338                  */
 339                 if (i == KUE_MCFILTCNT(sc))
 340                         break;
 341                 bcopy(LLADDR((struct sockaddr_dl *)ifma->ifma_addr),
 342                     KUE_MCFILT(sc, i), ETHER_ADDR_LEN);
 343                 i++;
 344         }
 345
 346         if (i == KUE_MCFILTCNT(sc))
 347                 sc->kue_rxfilt |= KUE_RXFILT_ALLMULTI;
 348         else {
 349                 sc->kue_rxfilt |= KUE_RXFILT_MULTICAST;
 350                 kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SET_MCAST_FILTERS,
 351                     i, sc->kue_mcfilters, i * ETHER_ADDR_LEN);
 352         }
 353
 354         kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->kue_rxfilt);
 355
 356         return;
 357 }
 358
 359 /*
 360  * Issue a SET_CONFIGURATION command to reset the MAC. This should be
 361  * done after the firmware is loaded into the adapter in order to
 362  * bring it into proper operation.
 363  */
 364 static void
 365 kue_reset(struct kue_softc *sc)
 366 {
 367         if (usbd_set_config_no(sc->kue_udev, KUE_CONFIG_NO, 0) ||
 368             usbd_device2interface_handle(sc->kue_udev, KUE_IFACE_IDX,
 369             &sc->kue_iface)) {
 370                 kprintf("kue%d: getting interface handle failed\n",
 371                     sc->kue_unit);
 372         }
 373
 374         /* Wait a little while for the chip to get its brains in order. */
 375         DELAY(1000);
 376         return;
 377 }
 378
 379 /*
 380  * Probe for a KLSI chip.
 381  */
 382 static int
 383 kue_match(device_t self)
 384 {
 385         struct usb_attach_arg *uaa = device_get_ivars(self);
 386
 387         if (uaa->iface == NULL)
 388                 return(UMATCH_NONE);
 389
 390         return (usb_lookup(kue_devs, uaa->vendor, uaa->product) != NULL ?
 391             UMATCH_VENDOR_PRODUCT : UMATCH_NONE);
 392 }
 393
 394 /*
 395  * Attach the interface. Allocate softc structures, do
 396  * setup and ethernet/BPF attach.
 397  */
 398 static int
 399 kue_attach(device_t self)
 400 {
 401         struct kue_softc *sc = device_get_softc(self);
 402         struct usb_attach_arg *uaa = device_get_ivars(self);
 403         char                    devinfo[1024];
 404         struct ifnet            *ifp;
 405         usbd_status             err;
 406         usb_interface_descriptor_t      *id;
 407         usb_endpoint_descriptor_t       *ed;
 408         int                     i;
 409
 410         sc->kue_iface = uaa->iface;
 411         sc->kue_udev = uaa->device;
 412         sc->kue_unit = device_get_unit(self);
 413
 414         id = usbd_get_interface_descriptor(uaa->iface);
 415
 416         usbd_devinfo(uaa->device, 0, devinfo);
 417         device_set_desc_copy(self, devinfo);
 418         kprintf("%s: %s\n", device_get_nameunit(self), devinfo);
 419
 420         /* Find endpoints. */
 421         for (i = 0; i < id->bNumEndpoints; i++) {
 422                 ed = usbd_interface2endpoint_descriptor(uaa->iface, i);
 423                 if (!ed) {
 424                         kprintf("kue%d: couldn't get ep %d\n",
 425                             sc->kue_unit, i);
 426                         return ENXIO;
 427                 }
 428                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
 429                     UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
 430                         sc->kue_ed[KUE_ENDPT_RX] = ed->bEndpointAddress;
 431                 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
 432                            UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
 433                         sc->kue_ed[KUE_ENDPT_TX] = ed->bEndpointAddress;
 434                 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
 435                            UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
 436                         sc->kue_ed[KUE_ENDPT_INTR] = ed->bEndpointAddress;
 437                 }
 438         }
 439
 440 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
 441         mtx_init(&sc->kue_mtx, device_get_nameunit(self), MTX_NETWORK_LOCK,
 442             MTX_DEF | MTX_RECURSE);
 443 #endif
 444         KUE_LOCK(sc);
 445
 446         /* Load the firmware into the NIC. */
 447         if (kue_load_fw(sc)) {
 448                 KUE_UNLOCK(sc);
 449 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
 450                 mtx_destroy(&sc->kue_mtx);
 451 #endif
 452                 return ENXIO;
 453         }
 454
 455         /* Reset the adapter. */
 456         kue_reset(sc);
 457
 458         /* Read ethernet descriptor */
 459         err = kue_ctl(sc, KUE_CTL_READ, KUE_CMD_GET_ETHER_DESCRIPTOR,
 460             0, (char *)&sc->kue_desc, sizeof(sc->kue_desc));
 461
 462         sc->kue_mcfilters = kmalloc(KUE_MCFILTCNT(sc) * ETHER_ADDR_LEN,
 463             M_USBDEV, M_WAITOK);
 464
 465         ifp = &sc->arpcom.ac_if;
 466         ifp->if_softc = sc;
 467         if_initname(ifp, "kue", sc->kue_unit);
 468         ifp->if_mtu = ETHERMTU;
 469         ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
 470         ifp->if_ioctl = kue_ioctl;
 471         ifp->if_start = kue_start;
 472         ifp->if_watchdog = kue_watchdog;
 473         ifp->if_init = kue_init;
 474         ifp->if_baudrate = 10000000;
 475         ifq_set_maxlen(&ifp->if_snd, IFQ_MAXLEN);
 476         ifq_set_ready(&ifp->if_snd);
 477
 478         /*
 479          * Call MI attach routine.
 480          */
 481         ether_ifattach(ifp, sc->kue_desc.kue_macaddr, NULL);
 482         usb_register_netisr();
 483         sc->kue_dying = 0;
 484
 485         KUE_UNLOCK(sc);
 486
 487         return 0;
 488 }
 489
 490 static int
 491 kue_detach(device_t dev)
 492 {
 493         struct kue_softc        *sc;
 494         struct ifnet            *ifp;
 495
 496         sc = device_get_softc(dev);
 497         KUE_LOCK(sc);
 498         ifp = &sc->arpcom.ac_if;
 499
 500         sc->kue_dying = 1;
 501
 502         if (ifp != NULL)
 503                 ether_ifdetach(ifp);
 504
 505         if (sc->kue_ep[KUE_ENDPT_TX] != NULL)
 506                 usbd_abort_pipe(sc->kue_ep[KUE_ENDPT_TX]);
 507         if (sc->kue_ep[KUE_ENDPT_RX] != NULL)
 508                 usbd_abort_pipe(sc->kue_ep[KUE_ENDPT_RX]);
 509         if (sc->kue_ep[KUE_ENDPT_INTR] != NULL)
 510                 usbd_abort_pipe(sc->kue_ep[KUE_ENDPT_INTR]);
 511
 512         if (sc->kue_mcfilters != NULL)
 513                 kfree(sc->kue_mcfilters, M_USBDEV);
 514
 515         KUE_UNLOCK(sc);
 516 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
 517         mtx_destroy(&sc->kue_mtx);
 518 #endif
 519
 520         return(0);
 521 }
 522
 523 /*
 524  * Initialize an RX descriptor and attach an MBUF cluster.
 525  */
 526 static int
 527 kue_newbuf(struct kue_softc *sc, struct kue_chain *c, struct mbuf *m)
 528 {
 529         struct mbuf             *m_new = NULL;
 530
 531         if (m == NULL) {
 532                 MGETHDR(m_new, MB_DONTWAIT, MT_DATA);
 533                 if (m_new == NULL) {
 534                         kprintf("kue%d: no memory for rx list "
 535                             "-- packet dropped!\n", sc->kue_unit);
 536                         return(ENOBUFS);
 537                 }
 538
 539                 MCLGET(m_new, MB_DONTWAIT);
 540                 if (!(m_new->m_flags & M_EXT)) {
 541                         kprintf("kue%d: no memory for rx list "
 542                             "-- packet dropped!\n", sc->kue_unit);
 543                         m_freem(m_new);
 544                         return(ENOBUFS);
 545                 }
 546                 m_new->m_len = m_new->m_pkthdr.len = MCLBYTES;
 547         } else {
 548                 m_new = m;
 549                 m_new->m_len = m_new->m_pkthdr.len = MCLBYTES;
 550                 m_new->m_data = m_new->m_ext.ext_buf;
 551         }
 552
 553         c->kue_mbuf = m_new;
 554
 555         return(0);
 556 }
 557
 558 static int
 559 kue_rx_list_init(struct kue_softc *sc)
 560 {
 561         struct kue_cdata        *cd;
 562         struct kue_chain        *c;
 563         int                     i;
 564
 565         cd = &sc->kue_cdata;
 566         for (i = 0; i < KUE_RX_LIST_CNT; i++) {
 567                 c = &cd->kue_rx_chain[i];
 568                 c->kue_sc = sc;
 569                 c->kue_idx = i;
 570                 if (kue_newbuf(sc, c, NULL) == ENOBUFS)
 571                         return(ENOBUFS);
 572                 if (c->kue_xfer == NULL) {
 573                         c->kue_xfer = usbd_alloc_xfer(sc->kue_udev);
 574                         if (c->kue_xfer == NULL)
 575                                 return(ENOBUFS);
 576                 }
 577         }
 578
 579         return(0);
 580 }
 581
 582 static int
 583 kue_tx_list_init(struct kue_softc *sc)
 584 {
 585         struct kue_cdata        *cd;
 586         struct kue_chain        *c;
 587         int                     i;
 588
 589         cd = &sc->kue_cdata;
 590         for (i = 0; i < KUE_TX_LIST_CNT; i++) {
 591                 c = &cd->kue_tx_chain[i];
 592                 c->kue_sc = sc;
 593                 c->kue_idx = i;
 594                 c->kue_mbuf = NULL;
 595                 if (c->kue_xfer == NULL) {
 596                         c->kue_xfer = usbd_alloc_xfer(sc->kue_udev);
 597                         if (c->kue_xfer == NULL)
 598                                 return(ENOBUFS);
 599                 }
 600                 c->kue_buf = kmalloc(KUE_BUFSZ, M_USBDEV, M_WAITOK);
 601                 if (c->kue_buf == NULL)
 602                         return(ENOBUFS);
 603         }
 604
 605         return(0);
 606 }
 607
 608 static void
 609 kue_rxstart(struct ifnet *ifp)
 610 {
 611         struct kue_softc        *sc;
 612         struct kue_chain        *c;
 613
 614         sc = ifp->if_softc;
 615         KUE_LOCK(sc);
 616         c = &sc->kue_cdata.kue_rx_chain[sc->kue_cdata.kue_rx_prod];
 617
 618         if (kue_newbuf(sc, c, NULL) == ENOBUFS) {
 619                 ifp->if_ierrors++;
 620                 return;
 621         }
 622
 623         /* Setup new transfer. */
 624         usbd_setup_xfer(c->kue_xfer, sc->kue_ep[KUE_ENDPT_RX],
 625             c, mtod(c->kue_mbuf, char *), KUE_BUFSZ, USBD_SHORT_XFER_OK,
 626             USBD_NO_TIMEOUT, kue_rxeof);
 627         usbd_transfer(c->kue_xfer);
 628
 629         KUE_UNLOCK(sc);
 630
 631         return;
 632 }
 633
 634 /*
 635  * A frame has been uploaded: pass the resulting mbuf chain up to
 636  * the higher level protocols.
 637  */
 638 static void
 639 kue_rxeof(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
 640 {
 641         struct kue_softc        *sc;
 642         struct kue_chain        *c;
 643         struct mbuf             *m;
 644         struct ifnet            *ifp;
 645         int                     total_len = 0;
 646         u_int16_t               len;
 647
 648         c = priv;
 649         sc = c->kue_sc;
 650         KUE_LOCK(sc);
 651         ifp = &sc->arpcom.ac_if;
 652
 653         if (!(ifp->if_flags & IFF_RUNNING)) {
 654                 KUE_UNLOCK(sc);
 655                 return;
 656         }
 657
 658         if (status != USBD_NORMAL_COMPLETION) {
 659                 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) {
 660                         KUE_UNLOCK(sc);
 661                         return;
 662                 }
 663                 if (usbd_ratecheck(&sc->kue_rx_notice))
 664                         kprintf("kue%d: usb error on rx: %s\n", sc->kue_unit,
 665                             usbd_errstr(status));
 666                 if (status == USBD_STALLED)
 667                         usbd_clear_endpoint_stall(sc->kue_ep[KUE_ENDPT_RX]);
 668                 goto done;
 669         }
 670
 671         usbd_get_xfer_status(xfer, NULL, NULL, &total_len, NULL);
 672         m = c->kue_mbuf;
 673         if (total_len <= 1)
 674                 goto done;
 675
 676         len = *mtod(m, u_int16_t *);
 677         m_adj(m, sizeof(u_int16_t));
 678
 679         /* No errors; receive the packet. */
 680         total_len = len;
 681
 682         if (len < sizeof(struct ether_header)) {
 683                 ifp->if_ierrors++;
 684                 goto done;
 685         }
 686
 687         ifp->if_ipackets++;
 688         m->m_pkthdr.rcvif = ifp;
 689         m->m_pkthdr.len = m->m_len = total_len;
 690
 691         /* Put the packet on the special USB input queue. */
 692         usb_ether_input(m);
 693         kue_rxstart(ifp);
 694
 695         KUE_UNLOCK(sc);
 696
 697         return;
 698 done:
 699
 700         /* Setup new transfer. */
 701         usbd_setup_xfer(c->kue_xfer, sc->kue_ep[KUE_ENDPT_RX],
 702             c, mtod(c->kue_mbuf, char *), KUE_BUFSZ, USBD_SHORT_XFER_OK,
 703             USBD_NO_TIMEOUT, kue_rxeof);
 704         usbd_transfer(c->kue_xfer);
 705         KUE_UNLOCK(sc);
 706
 707         return;
 708 }
 709
 710 /*
 711  * A frame was downloaded to the chip. It's safe for us to clean up
 712  * the list buffers.
 713  */
 714
 715 static void
 716 kue_txeof(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
 717 {
 718         struct kue_softc        *sc;
 719         struct kue_chain        *c;
 720         struct ifnet            *ifp;
 721         usbd_status             err;
 722
 723         c = priv;
 724         sc = c->kue_sc;
 725         KUE_LOCK(sc);
 726
 727         ifp = &sc->arpcom.ac_if;
 728         ifp->if_timer = 0;
 729         ifp->if_flags &= ~IFF_OACTIVE;
 730
 731         if (status != USBD_NORMAL_COMPLETION) {
 732                 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) {
 733                         KUE_UNLOCK(sc);
 734                         return;
 735                 }
 736                 kprintf("kue%d: usb error on tx: %s\n", sc->kue_unit,
 737                     usbd_errstr(status));
 738                 if (status == USBD_STALLED)
 739                         usbd_clear_endpoint_stall(sc->kue_ep[KUE_ENDPT_TX]);
 740                 KUE_UNLOCK(sc);
 741                 return;
 742         }
 743
 744         usbd_get_xfer_status(c->kue_xfer, NULL, NULL, NULL, &err);
 745
 746         if (c->kue_mbuf != NULL) {
 747                 m_freem(c->kue_mbuf);
 748                 c->kue_mbuf = NULL;
 749         }
 750
 751         if (err)
 752                 ifp->if_oerrors++;
 753         else
 754                 ifp->if_opackets++;
 755
 756         if (!ifq_is_empty(&ifp->if_snd))
 757                 (*ifp->if_start)(ifp);
 758
 759         KUE_UNLOCK(sc);
 760
 761         return;
 762 }
 763
 764 static int
 765 kue_encap(struct kue_softc *sc, struct mbuf *m, int idx)
 766 {
 767         int                     total_len;
 768         struct kue_chain        *c;
 769         usbd_status             err;
 770
 771         c = &sc->kue_cdata.kue_tx_chain[idx];
 772
 773         /*
 774          * Copy the mbuf data into a contiguous buffer, leaving two
 775          * bytes at the beginning to hold the frame length.
 776          */
 777         m_copydata(m, 0, m->m_pkthdr.len, c->kue_buf + 2);
 778         c->kue_mbuf = m;
 779
 780         total_len = m->m_pkthdr.len + 2;
 781         total_len += 64 - (total_len % 64);
 782
 783         /* Frame length is specified in the first 2 bytes of the buffer. */
 784         c->kue_buf[0] = (u_int8_t)m->m_pkthdr.len;
 785         c->kue_buf[1] = (u_int8_t)(m->m_pkthdr.len >> 8);
 786
 787         usbd_setup_xfer(c->kue_xfer, sc->kue_ep[KUE_ENDPT_TX],
 788             c, c->kue_buf, total_len, 0, 10000, kue_txeof);
 789
 790         /* Transmit */
 791         err = usbd_transfer(c->kue_xfer);
 792         if (err != USBD_IN_PROGRESS) {
 793                 kue_stop(sc);
 794                 return(EIO);
 795         }
 796
 797         sc->kue_cdata.kue_tx_cnt++;
 798
 799         return(0);
 800 }
 801
 802 static void
 803 kue_start(struct ifnet *ifp)
 804 {
 805         struct kue_softc        *sc;
 806         struct mbuf             *m_head = NULL;
 807
 808         sc = ifp->if_softc;
 809         KUE_LOCK(sc);
 810
 811         if (ifp->if_flags & IFF_OACTIVE) {
 812                 KUE_UNLOCK(sc);
 813                 return;
 814         }
 815
 816         m_head = ifq_poll(&ifp->if_snd);
 817         if (m_head == NULL) {
 818                 KUE_UNLOCK(sc);
 819                 return;
 820         }
 821
 822         if (kue_encap(sc, m_head, 0)) {
 823                 ifp->if_flags |= IFF_OACTIVE;
 824                 KUE_UNLOCK(sc);
 825                 return;
 826         }
 827         ifq_dequeue(&ifp->if_snd, m_head);
 828
 829         /*
 830          * If there's a BPF listener, bounce a copy of this frame
 831          * to him.
 832          */
 833         BPF_MTAP(ifp, m_head);
 834
 835         ifp->if_flags |= IFF_OACTIVE;
 836
 837         /*
 838          * Set a timeout in case the chip goes out to lunch.
 839          */
 840         ifp->if_timer = 5;
 841         KUE_UNLOCK(sc);
 842
 843         return;
 844 }
 845
 846 static void
 847 kue_init(void *xsc)
 848 {
 849         struct kue_softc        *sc = xsc;
 850         struct ifnet            *ifp = &sc->arpcom.ac_if;
 851         struct kue_chain        *c;
 852         usbd_status             err;
 853         int                     i;
 854
 855         KUE_LOCK(sc);
 856
 857         if (ifp->if_flags & IFF_RUNNING) {
 858                 KUE_UNLOCK(sc);
 859                 return;
 860         }
 861
 862         /* Set MAC address */
 863         kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SET_MAC,
 864             0, sc->arpcom.ac_enaddr, ETHER_ADDR_LEN);
 865
 866         sc->kue_rxfilt = KUE_RXFILT_UNICAST|KUE_RXFILT_BROADCAST;
 867
 868          /* If we want promiscuous mode, set the allframes bit. */
 869         if (ifp->if_flags & IFF_PROMISC)
 870                 sc->kue_rxfilt |= KUE_RXFILT_PROMISC;
 871
 872         kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->kue_rxfilt);
 873
 874         /* I'm not sure how to tune these. */
 875 #ifdef notdef
 876         /*
 877          * Leave this one alone for now; setting it
 878          * wrong causes lockups on some machines/controllers.
 879          */
 880         kue_setword(sc, KUE_CMD_SET_SOFS, 1);
 881 #endif
 882         kue_setword(sc, KUE_CMD_SET_URB_SIZE, 64);
 883
 884         /* Init TX ring. */
 885         if (kue_tx_list_init(sc) == ENOBUFS) {
 886                 kprintf("kue%d: tx list init failed\n", sc->kue_unit);
 887                 KUE_UNLOCK(sc);
 888                 return;
 889         }
 890
 891         /* Init RX ring. */
 892         if (kue_rx_list_init(sc) == ENOBUFS) {
 893                 kprintf("kue%d: rx list init failed\n", sc->kue_unit);
 894                 KUE_UNLOCK(sc);
 895                 return;
 896         }
 897
 898         /* Load the multicast filter. */
 899         kue_setmulti(sc);
 900
 901         /* Open RX and TX pipes. */
 902         err = usbd_open_pipe(sc->kue_iface, sc->kue_ed[KUE_ENDPT_RX],
 903             USBD_EXCLUSIVE_USE, &sc->kue_ep[KUE_ENDPT_RX]);
 904         if (err) {
 905                 kprintf("kue%d: open rx pipe failed: %s\n",
 906                     sc->kue_unit, usbd_errstr(err));
 907                 KUE_UNLOCK(sc);
 908                 return;
 909         }
 910
 911         err = usbd_open_pipe(sc->kue_iface, sc->kue_ed[KUE_ENDPT_TX],
 912             USBD_EXCLUSIVE_USE, &sc->kue_ep[KUE_ENDPT_TX]);
 913         if (err) {
 914                 kprintf("kue%d: open tx pipe failed: %s\n",
 915                     sc->kue_unit, usbd_errstr(err));
 916                 KUE_UNLOCK(sc);
 917                 return;
 918         }
 919
 920         /* Start up the receive pipe. */
 921         for (i = 0; i < KUE_RX_LIST_CNT; i++) {
 922                 c = &sc->kue_cdata.kue_rx_chain[i];
 923                 usbd_setup_xfer(c->kue_xfer, sc->kue_ep[KUE_ENDPT_RX],
 924                     c, mtod(c->kue_mbuf, char *), KUE_BUFSZ,
 925                 USBD_SHORT_XFER_OK, USBD_NO_TIMEOUT, kue_rxeof);
 926                 usbd_transfer(c->kue_xfer);
 927         }
 928
 929         ifp->if_flags |= IFF_RUNNING;
 930         ifp->if_flags &= ~IFF_OACTIVE;
 931
 932         KUE_UNLOCK(sc);
 933
 934         return;
 935 }
 936
 937 static int
 938 kue_ioctl(struct ifnet *ifp, u_long command, caddr_t data, struct ucred *cr)
 939 {
 940         struct kue_softc        *sc = ifp->if_softc;
 941         int                     error = 0;
 942
 943         KUE_LOCK(sc);
 944
 945         switch(command) {
 946         case SIOCSIFFLAGS:
 947                 if (ifp->if_flags & IFF_UP) {
 948                         if (ifp->if_flags & IFF_RUNNING &&
 949                             ifp->if_flags & IFF_PROMISC &&
 950                             !(sc->kue_if_flags & IFF_PROMISC)) {
 951                                 sc->kue_rxfilt |= KUE_RXFILT_PROMISC;
 952                                 kue_setword(sc, KUE_CMD_SET_PKT_FILTER,
 953                                     sc->kue_rxfilt);
 954                         } else if (ifp->if_flags & IFF_RUNNING &&
 955                             !(ifp->if_flags & IFF_PROMISC) &&
 956                             sc->kue_if_flags & IFF_PROMISC) {
 957                                 sc->kue_rxfilt &= ~KUE_RXFILT_PROMISC;
 958                                 kue_setword(sc, KUE_CMD_SET_PKT_FILTER,
 959                                     sc->kue_rxfilt);
 960                         } else if (!(ifp->if_flags & IFF_RUNNING))
 961                                 kue_init(sc);
 962                 } else {
 963                         if (ifp->if_flags & IFF_RUNNING)
 964                                 kue_stop(sc);
 965                 }
 966                 sc->kue_if_flags = ifp->if_flags;
 967                 error = 0;
 968                 break;
 969         case SIOCADDMULTI:
 970         case SIOCDELMULTI:
 971                 kue_setmulti(sc);
 972                 error = 0;
 973                 break;
 974         default:
 975                 error = ether_ioctl(ifp, command, data);
 976                 break;
 977         }
 978
 979         KUE_UNLOCK(sc);
 980
 981         return(error);
 982 }
 983
 984 static void
 985 kue_watchdog(struct ifnet *ifp)
 986 {
 987         struct kue_softc        *sc;
 988         struct kue_chain        *c;
 989         usbd_status             stat;
 990
 991         sc = ifp->if_softc;
 992         KUE_LOCK(sc);
 993         ifp->if_oerrors++;
 994         kprintf("kue%d: watchdog timeout\n", sc->kue_unit);
 995
 996         c = &sc->kue_cdata.kue_tx_chain[0];
 997         usbd_get_xfer_status(c->kue_xfer, NULL, NULL, NULL, &stat);
 998         kue_txeof(c->kue_xfer, c, stat);
 999
1000         if (ifq_is_empty(&ifp->if_snd))
1001                 kue_start(ifp);
1002         KUE_UNLOCK(sc);
1003
1004         return;
1005 }
1006
1007 /*
1008  * Stop the adapter and free any mbufs allocated to the
1009  * RX and TX lists.
1010  */
1011 static void
1012 kue_stop(struct kue_softc *sc)
1013 {
1014         usbd_status             err;
1015         struct ifnet            *ifp;
1016         int                     i;
1017
1018         KUE_LOCK(sc);
1019         ifp = &sc->arpcom.ac_if;
1020         ifp->if_timer = 0;
1021
1022         /* Stop transfers. */
1023         if (sc->kue_ep[KUE_ENDPT_RX] != NULL) {
1024                 err = usbd_abort_pipe(sc->kue_ep[KUE_ENDPT_RX]);
1025                 if (err) {
1026                         kprintf("kue%d: abort rx pipe failed: %s\n",
1027                         sc->kue_unit, usbd_errstr(err));
1028                 }
1029                 err = usbd_close_pipe(sc->kue_ep[KUE_ENDPT_RX]);
1030                 if (err) {
1031                         kprintf("kue%d: close rx pipe failed: %s\n",
1032                         sc->kue_unit, usbd_errstr(err));
1033                 }
1034                 sc->kue_ep[KUE_ENDPT_RX] = NULL;
1035         }
1036
1037         if (sc->kue_ep[KUE_ENDPT_TX] != NULL) {
1038                 err = usbd_abort_pipe(sc->kue_ep[KUE_ENDPT_TX]);
1039                 if (err) {
1040                         kprintf("kue%d: abort tx pipe failed: %s\n",
1041                         sc->kue_unit, usbd_errstr(err));
1042                 }
1043                 err = usbd_close_pipe(sc->kue_ep[KUE_ENDPT_TX]);
1044                 if (err) {
1045                         kprintf("kue%d: close tx pipe failed: %s\n",
1046                             sc->kue_unit, usbd_errstr(err));
1047                 }
1048                 sc->kue_ep[KUE_ENDPT_TX] = NULL;
1049         }
1050
1051         if (sc->kue_ep[KUE_ENDPT_INTR] != NULL) {
1052                 err = usbd_abort_pipe(sc->kue_ep[KUE_ENDPT_INTR]);
1053                 if (err) {
1054                         kprintf("kue%d: abort intr pipe failed: %s\n",
1055                         sc->kue_unit, usbd_errstr(err));
1056                 }
1057                 err = usbd_close_pipe(sc->kue_ep[KUE_ENDPT_INTR]);
1058                 if (err) {
1059                         kprintf("kue%d: close intr pipe failed: %s\n",
1060                             sc->kue_unit, usbd_errstr(err));
1061                 }
1062                 sc->kue_ep[KUE_ENDPT_INTR] = NULL;
1063         }
1064
1065         /* Free RX resources. */
1066         for (i = 0; i < KUE_RX_LIST_CNT; i++) {
1067                 if (sc->kue_cdata.kue_rx_chain[i].kue_buf != NULL) {
1068                         kfree(sc->kue_cdata.kue_rx_chain[i].kue_buf, M_USBDEV);
1069                         sc->kue_cdata.kue_rx_chain[i].kue_buf = NULL;
1070                 }
1071                 if (sc->kue_cdata.kue_rx_chain[i].kue_mbuf != NULL) {
1072                         m_freem(sc->kue_cdata.kue_rx_chain[i].kue_mbuf);
1073                         sc->kue_cdata.kue_rx_chain[i].kue_mbuf = NULL;
1074                 }
1075                 if (sc->kue_cdata.kue_rx_chain[i].kue_xfer != NULL) {
1076                         usbd_free_xfer(sc->kue_cdata.kue_rx_chain[i].kue_xfer);
1077                         sc->kue_cdata.kue_rx_chain[i].kue_xfer = NULL;
1078                 }
1079         }
1080
1081         /* Free TX resources. */
1082         for (i = 0; i < KUE_TX_LIST_CNT; i++) {
1083                 if (sc->kue_cdata.kue_tx_chain[i].kue_buf != NULL) {
1084                         kfree(sc->kue_cdata.kue_tx_chain[i].kue_buf, M_USBDEV);
1085                         sc->kue_cdata.kue_tx_chain[i].kue_buf = NULL;
1086                 }
1087                 if (sc->kue_cdata.kue_tx_chain[i].kue_mbuf != NULL) {
1088                         m_freem(sc->kue_cdata.kue_tx_chain[i].kue_mbuf);
1089                         sc->kue_cdata.kue_tx_chain[i].kue_mbuf = NULL;
1090                 }
1091                 if (sc->kue_cdata.kue_tx_chain[i].kue_xfer != NULL) {
1092                         usbd_free_xfer(sc->kue_cdata.kue_tx_chain[i].kue_xfer);
1093                         sc->kue_cdata.kue_tx_chain[i].kue_xfer = NULL;
1094                 }
1095         }
1096
1097         ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
1098         KUE_UNLOCK(sc);
1099
1100         return;
1101 }
1102
1103 /*
1104  * Stop all chip I/O so that the kernel's probe routines don't
1105  * get confused by errant DMAs when rebooting.
1106  */
1107 static void
1108 kue_shutdown(device_t dev)
1109 {
1110         struct kue_softc        *sc;
1111
1112         sc = device_get_softc(dev);
1113
1114         kue_stop(sc);
1115
1116         return;
1117 }