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