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.5 2003/12/30 01:01:46 dillon 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 __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);
 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 __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 __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 __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_NOWAIT);
 478
 479         /*
 480          * A KLSI chip was detected. Inform the world.
 481          */
 482         printf("kue%d: Ethernet address: %6D\n", sc->kue_unit,
 483             sc->kue_desc.kue_macaddr, ":");
 484
 485         bcopy(sc->kue_desc.kue_macaddr,
 486             (char *)&sc->arpcom.ac_enaddr, ETHER_ADDR_LEN);
 487
 488         ifp = &sc->arpcom.ac_if;
 489         ifp->if_softc = sc;
 490         if_initname(ifp, "kue", sc->kue_unit);
 491         ifp->if_mtu = ETHERMTU;
 492         ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
 493         ifp->if_ioctl = kue_ioctl;
 494         ifp->if_output = ether_output;
 495         ifp->if_start = kue_start;
 496         ifp->if_watchdog = kue_watchdog;
 497         ifp->if_init = kue_init;
 498         ifp->if_baudrate = 10000000;
 499         ifp->if_snd.ifq_maxlen = IFQ_MAXLEN;
 500
 501         kue_qdat.ifp = ifp;
 502         kue_qdat.if_rxstart = kue_rxstart;
 503
 504         /*
 505          * Call MI attach routine.
 506          */
 507 #if __FreeBSD_version >= 500000
 508         ether_ifattach(ifp, sc->kue_desc.kue_macaddr);
 509 #else
 510         ether_ifattach(ifp, ETHER_BPF_SUPPORTED);
 511 #endif
 512         usb_register_netisr();
 513         sc->kue_dying = 0;
 514
 515         KUE_UNLOCK(sc);
 516
 517         USB_ATTACH_SUCCESS_RETURN;
 518 }
 519
 520 Static int
 521 kue_detach(device_ptr_t dev)
 522 {
 523         struct kue_softc        *sc;
 524         struct ifnet            *ifp;
 525
 526         sc = device_get_softc(dev);
 527         KUE_LOCK(sc);
 528         ifp = &sc->arpcom.ac_if;
 529
 530         sc->kue_dying = 1;
 531
 532         if (ifp != NULL)
 533 #if __FreeBSD_version >= 500000
 534                 ether_ifdetach(ifp);
 535 #else
 536                 ether_ifdetach(ifp, ETHER_BPF_SUPPORTED);
 537 #endif
 538
 539         if (sc->kue_ep[KUE_ENDPT_TX] != NULL)
 540                 usbd_abort_pipe(sc->kue_ep[KUE_ENDPT_TX]);
 541         if (sc->kue_ep[KUE_ENDPT_RX] != NULL)
 542                 usbd_abort_pipe(sc->kue_ep[KUE_ENDPT_RX]);
 543         if (sc->kue_ep[KUE_ENDPT_INTR] != NULL)
 544                 usbd_abort_pipe(sc->kue_ep[KUE_ENDPT_INTR]);
 545
 546         if (sc->kue_mcfilters != NULL)
 547                 free(sc->kue_mcfilters, M_USBDEV);
 548
 549         KUE_UNLOCK(sc);
 550 #if __FreeBSD_version >= 500000
 551         mtx_destroy(&sc->kue_mtx);
 552 #endif
 553
 554         return(0);
 555 }
 556
 557 /*
 558  * Initialize an RX descriptor and attach an MBUF cluster.
 559  */
 560 Static int
 561 kue_newbuf(struct kue_softc *sc, struct kue_chain *c, struct mbuf *m)
 562 {
 563         struct mbuf             *m_new = NULL;
 564
 565         if (m == NULL) {
 566                 MGETHDR(m_new, M_DONTWAIT, MT_DATA);
 567                 if (m_new == NULL) {
 568                         printf("kue%d: no memory for rx list "
 569                             "-- packet dropped!\n", sc->kue_unit);
 570                         return(ENOBUFS);
 571                 }
 572
 573                 MCLGET(m_new, M_DONTWAIT);
 574                 if (!(m_new->m_flags & M_EXT)) {
 575                         printf("kue%d: no memory for rx list "
 576                             "-- packet dropped!\n", sc->kue_unit);
 577                         m_freem(m_new);
 578                         return(ENOBUFS);
 579                 }
 580                 m_new->m_len = m_new->m_pkthdr.len = MCLBYTES;
 581         } else {
 582                 m_new = m;
 583                 m_new->m_len = m_new->m_pkthdr.len = MCLBYTES;
 584                 m_new->m_data = m_new->m_ext.ext_buf;
 585         }
 586
 587         c->kue_mbuf = m_new;
 588
 589         return(0);
 590 }
 591
 592 Static int
 593 kue_rx_list_init(struct kue_softc *sc)
 594 {
 595         struct kue_cdata        *cd;
 596         struct kue_chain        *c;
 597         int                     i;
 598
 599         cd = &sc->kue_cdata;
 600         for (i = 0; i < KUE_RX_LIST_CNT; i++) {
 601                 c = &cd->kue_rx_chain[i];
 602                 c->kue_sc = sc;
 603                 c->kue_idx = i;
 604                 if (kue_newbuf(sc, c, NULL) == ENOBUFS)
 605                         return(ENOBUFS);
 606                 if (c->kue_xfer == NULL) {
 607                         c->kue_xfer = usbd_alloc_xfer(sc->kue_udev);
 608                         if (c->kue_xfer == NULL)
 609                                 return(ENOBUFS);
 610                 }
 611         }
 612
 613         return(0);
 614 }
 615
 616 Static int
 617 kue_tx_list_init(struct kue_softc *sc)
 618 {
 619         struct kue_cdata        *cd;
 620         struct kue_chain        *c;
 621         int                     i;
 622
 623         cd = &sc->kue_cdata;
 624         for (i = 0; i < KUE_TX_LIST_CNT; i++) {
 625                 c = &cd->kue_tx_chain[i];
 626                 c->kue_sc = sc;
 627                 c->kue_idx = i;
 628                 c->kue_mbuf = NULL;
 629                 if (c->kue_xfer == NULL) {
 630                         c->kue_xfer = usbd_alloc_xfer(sc->kue_udev);
 631                         if (c->kue_xfer == NULL)
 632                                 return(ENOBUFS);
 633                 }
 634                 c->kue_buf = malloc(KUE_BUFSZ, M_USBDEV, M_NOWAIT);
 635                 if (c->kue_buf == NULL)
 636                         return(ENOBUFS);
 637         }
 638
 639         return(0);
 640 }
 641
 642 Static void
 643 kue_rxstart(struct ifnet *ifp)
 644 {
 645         struct kue_softc        *sc;
 646         struct kue_chain        *c;
 647
 648         sc = ifp->if_softc;
 649         KUE_LOCK(sc);
 650         c = &sc->kue_cdata.kue_rx_chain[sc->kue_cdata.kue_rx_prod];
 651
 652         if (kue_newbuf(sc, c, NULL) == ENOBUFS) {
 653                 ifp->if_ierrors++;
 654                 return;
 655         }
 656
 657         /* Setup new transfer. */
 658         usbd_setup_xfer(c->kue_xfer, sc->kue_ep[KUE_ENDPT_RX],
 659             c, mtod(c->kue_mbuf, char *), KUE_BUFSZ, USBD_SHORT_XFER_OK,
 660             USBD_NO_TIMEOUT, kue_rxeof);
 661         usbd_transfer(c->kue_xfer);
 662
 663         KUE_UNLOCK(sc);
 664
 665         return;
 666 }
 667
 668 /*
 669  * A frame has been uploaded: pass the resulting mbuf chain up to
 670  * the higher level protocols.
 671  */
 672 Static void kue_rxeof(usbd_xfer_handle xfer, usbd_private_handle priv,
 673                       usbd_status status)
 674 {
 675         struct kue_softc        *sc;
 676         struct kue_chain        *c;
 677         struct mbuf             *m;
 678         struct ifnet            *ifp;
 679         int                     total_len = 0;
 680         u_int16_t               len;
 681
 682         c = priv;
 683         sc = c->kue_sc;
 684         KUE_LOCK(sc);
 685         ifp = &sc->arpcom.ac_if;
 686
 687         if (!(ifp->if_flags & IFF_RUNNING)) {
 688                 KUE_UNLOCK(sc);
 689                 return;
 690         }
 691
 692         if (status != USBD_NORMAL_COMPLETION) {
 693                 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) {
 694                         KUE_UNLOCK(sc);
 695                         return;
 696                 }
 697                 if (usbd_ratecheck(&sc->kue_rx_notice))
 698                         printf("kue%d: usb error on rx: %s\n", sc->kue_unit,
 699                             usbd_errstr(status));
 700                 if (status == USBD_STALLED)
 701                         usbd_clear_endpoint_stall(sc->kue_ep[KUE_ENDPT_RX]);
 702                 goto done;
 703         }
 704
 705         usbd_get_xfer_status(xfer, NULL, NULL, &total_len, NULL);
 706         m = c->kue_mbuf;
 707         if (total_len <= 1)
 708                 goto done;
 709
 710         len = *mtod(m, u_int16_t *);
 711         m_adj(m, sizeof(u_int16_t));
 712
 713         /* No errors; receive the packet. */
 714         total_len = len;
 715
 716         if (len < sizeof(struct ether_header)) {
 717                 ifp->if_ierrors++;
 718                 goto done;
 719         }
 720
 721         ifp->if_ipackets++;
 722         m->m_pkthdr.rcvif = (struct ifnet *)&kue_qdat;
 723         m->m_pkthdr.len = m->m_len = total_len;
 724
 725         /* Put the packet on the special USB input queue. */
 726         usb_ether_input(m);
 727         KUE_UNLOCK(sc);
 728
 729         return;
 730 done:
 731
 732         /* Setup new transfer. */
 733         usbd_setup_xfer(c->kue_xfer, sc->kue_ep[KUE_ENDPT_RX],
 734             c, mtod(c->kue_mbuf, char *), KUE_BUFSZ, USBD_SHORT_XFER_OK,
 735             USBD_NO_TIMEOUT, kue_rxeof);
 736         usbd_transfer(c->kue_xfer);
 737         KUE_UNLOCK(sc);
 738
 739         return;
 740 }
 741
 742 /*
 743  * A frame was downloaded to the chip. It's safe for us to clean up
 744  * the list buffers.
 745  */
 746
 747 Static void
 748 kue_txeof(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
 749 {
 750         struct kue_softc        *sc;
 751         struct kue_chain        *c;
 752         struct ifnet            *ifp;
 753         usbd_status             err;
 754
 755         c = priv;
 756         sc = c->kue_sc;
 757         KUE_LOCK(sc);
 758
 759         ifp = &sc->arpcom.ac_if;
 760         ifp->if_timer = 0;
 761         ifp->if_flags &= ~IFF_OACTIVE;
 762
 763         if (status != USBD_NORMAL_COMPLETION) {
 764                 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) {
 765                         KUE_UNLOCK(sc);
 766                         return;
 767                 }
 768                 printf("kue%d: usb error on tx: %s\n", sc->kue_unit,
 769                     usbd_errstr(status));
 770                 if (status == USBD_STALLED)
 771                         usbd_clear_endpoint_stall(sc->kue_ep[KUE_ENDPT_TX]);
 772                 KUE_UNLOCK(sc);
 773                 return;
 774         }
 775
 776         usbd_get_xfer_status(c->kue_xfer, NULL, NULL, NULL, &err);
 777
 778         if (c->kue_mbuf != NULL) {
 779                 c->kue_mbuf->m_pkthdr.rcvif = ifp;
 780                 usb_tx_done(c->kue_mbuf);
 781                 c->kue_mbuf = NULL;
 782         }
 783
 784         if (err)
 785                 ifp->if_oerrors++;
 786         else
 787                 ifp->if_opackets++;
 788
 789         KUE_UNLOCK(sc);
 790
 791         return;
 792 }
 793
 794 Static int
 795 kue_encap(struct kue_softc *sc, struct mbuf *m, int idx)
 796 {
 797         int                     total_len;
 798         struct kue_chain        *c;
 799         usbd_status             err;
 800
 801         c = &sc->kue_cdata.kue_tx_chain[idx];
 802
 803         /*
 804          * Copy the mbuf data into a contiguous buffer, leaving two
 805          * bytes at the beginning to hold the frame length.
 806          */
 807         m_copydata(m, 0, m->m_pkthdr.len, c->kue_buf + 2);
 808         c->kue_mbuf = m;
 809
 810         total_len = m->m_pkthdr.len + 2;
 811         total_len += 64 - (total_len % 64);
 812
 813         /* Frame length is specified in the first 2 bytes of the buffer. */
 814         c->kue_buf[0] = (u_int8_t)m->m_pkthdr.len;
 815         c->kue_buf[1] = (u_int8_t)(m->m_pkthdr.len >> 8);
 816
 817         usbd_setup_xfer(c->kue_xfer, sc->kue_ep[KUE_ENDPT_TX],
 818             c, c->kue_buf, total_len, 0, 10000, kue_txeof);
 819
 820         /* Transmit */
 821         err = usbd_transfer(c->kue_xfer);
 822         if (err != USBD_IN_PROGRESS) {
 823                 kue_stop(sc);
 824                 return(EIO);
 825         }
 826
 827         sc->kue_cdata.kue_tx_cnt++;
 828
 829         return(0);
 830 }
 831
 832 Static void
 833 kue_start(struct ifnet *ifp)
 834 {
 835         struct kue_softc        *sc;
 836         struct mbuf             *m_head = NULL;
 837
 838         sc = ifp->if_softc;
 839         KUE_LOCK(sc);
 840
 841         if (ifp->if_flags & IFF_OACTIVE) {
 842                 KUE_UNLOCK(sc);
 843                 return;
 844         }
 845
 846         IF_DEQUEUE(&ifp->if_snd, m_head);
 847         if (m_head == NULL) {
 848                 KUE_UNLOCK(sc);
 849                 return;
 850         }
 851
 852         if (kue_encap(sc, m_head, 0)) {
 853                 IF_PREPEND(&ifp->if_snd, m_head);
 854                 ifp->if_flags |= IFF_OACTIVE;
 855                 KUE_UNLOCK(sc);
 856                 return;
 857         }
 858
 859         /*
 860          * If there's a BPF listener, bounce a copy of this frame
 861          * to him.
 862          */
 863         BPF_MTAP(ifp, m_head);
 864
 865         ifp->if_flags |= IFF_OACTIVE;
 866
 867         /*
 868          * Set a timeout in case the chip goes out to lunch.
 869          */
 870         ifp->if_timer = 5;
 871         KUE_UNLOCK(sc);
 872
 873         return;
 874 }
 875
 876 Static void
 877 kue_init(void *xsc)
 878 {
 879         struct kue_softc        *sc = xsc;
 880         struct ifnet            *ifp = &sc->arpcom.ac_if;
 881         struct kue_chain        *c;
 882         usbd_status             err;
 883         int                     i;
 884
 885         KUE_LOCK(sc);
 886
 887         if (ifp->if_flags & IFF_RUNNING) {
 888                 KUE_UNLOCK(sc);
 889                 return;
 890         }
 891
 892         /* Set MAC address */
 893         kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SET_MAC,
 894             0, sc->arpcom.ac_enaddr, ETHER_ADDR_LEN);
 895
 896         sc->kue_rxfilt = KUE_RXFILT_UNICAST|KUE_RXFILT_BROADCAST;
 897
 898          /* If we want promiscuous mode, set the allframes bit. */
 899         if (ifp->if_flags & IFF_PROMISC)
 900                 sc->kue_rxfilt |= KUE_RXFILT_PROMISC;
 901
 902         kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->kue_rxfilt);
 903
 904         /* I'm not sure how to tune these. */
 905 #ifdef notdef
 906         /*
 907          * Leave this one alone for now; setting it
 908          * wrong causes lockups on some machines/controllers.
 909          */
 910         kue_setword(sc, KUE_CMD_SET_SOFS, 1);
 911 #endif
 912         kue_setword(sc, KUE_CMD_SET_URB_SIZE, 64);
 913
 914         /* Init TX ring. */
 915         if (kue_tx_list_init(sc) == ENOBUFS) {
 916                 printf("kue%d: tx list init failed\n", sc->kue_unit);
 917                 KUE_UNLOCK(sc);
 918                 return;
 919         }
 920
 921         /* Init RX ring. */
 922         if (kue_rx_list_init(sc) == ENOBUFS) {
 923                 printf("kue%d: rx list init failed\n", sc->kue_unit);
 924                 KUE_UNLOCK(sc);
 925                 return;
 926         }
 927
 928         /* Load the multicast filter. */
 929         kue_setmulti(sc);
 930
 931         /* Open RX and TX pipes. */
 932         err = usbd_open_pipe(sc->kue_iface, sc->kue_ed[KUE_ENDPT_RX],
 933             USBD_EXCLUSIVE_USE, &sc->kue_ep[KUE_ENDPT_RX]);
 934         if (err) {
 935                 printf("kue%d: open rx pipe failed: %s\n",
 936                     sc->kue_unit, usbd_errstr(err));
 937                 KUE_UNLOCK(sc);
 938                 return;
 939         }
 940
 941         err = usbd_open_pipe(sc->kue_iface, sc->kue_ed[KUE_ENDPT_TX],
 942             USBD_EXCLUSIVE_USE, &sc->kue_ep[KUE_ENDPT_TX]);
 943         if (err) {
 944                 printf("kue%d: open tx pipe failed: %s\n",
 945                     sc->kue_unit, usbd_errstr(err));
 946                 KUE_UNLOCK(sc);
 947                 return;
 948         }
 949
 950         /* Start up the receive pipe. */
 951         for (i = 0; i < KUE_RX_LIST_CNT; i++) {
 952                 c = &sc->kue_cdata.kue_rx_chain[i];
 953                 usbd_setup_xfer(c->kue_xfer, sc->kue_ep[KUE_ENDPT_RX],
 954                     c, mtod(c->kue_mbuf, char *), KUE_BUFSZ,
 955                 USBD_SHORT_XFER_OK, USBD_NO_TIMEOUT, kue_rxeof);
 956                 usbd_transfer(c->kue_xfer);
 957         }
 958
 959         ifp->if_flags |= IFF_RUNNING;
 960         ifp->if_flags &= ~IFF_OACTIVE;
 961
 962         KUE_UNLOCK(sc);
 963
 964         return;
 965 }
 966
 967 Static int
 968 kue_ioctl(struct ifnet *ifp, u_long command, caddr_t data)
 969 {
 970         struct kue_softc        *sc = ifp->if_softc;
 971         int                     error = 0;
 972
 973         KUE_LOCK(sc);
 974
 975         switch(command) {
 976         case SIOCSIFFLAGS:
 977                 if (ifp->if_flags & IFF_UP) {
 978                         if (ifp->if_flags & IFF_RUNNING &&
 979                             ifp->if_flags & IFF_PROMISC &&
 980                             !(sc->kue_if_flags & IFF_PROMISC)) {
 981                                 sc->kue_rxfilt |= KUE_RXFILT_PROMISC;
 982                                 kue_setword(sc, KUE_CMD_SET_PKT_FILTER,
 983                                     sc->kue_rxfilt);
 984                         } else if (ifp->if_flags & IFF_RUNNING &&
 985                             !(ifp->if_flags & IFF_PROMISC) &&
 986                             sc->kue_if_flags & IFF_PROMISC) {
 987                                 sc->kue_rxfilt &= ~KUE_RXFILT_PROMISC;
 988                                 kue_setword(sc, KUE_CMD_SET_PKT_FILTER,
 989                                     sc->kue_rxfilt);
 990                         } else if (!(ifp->if_flags & IFF_RUNNING))
 991                                 kue_init(sc);
 992                 } else {
 993                         if (ifp->if_flags & IFF_RUNNING)
 994                                 kue_stop(sc);
 995                 }
 996                 sc->kue_if_flags = ifp->if_flags;
 997                 error = 0;
 998                 break;
 999         case SIOCADDMULTI:
1000         case SIOCDELMULTI:
1001                 kue_setmulti(sc);
1002                 error = 0;
1003                 break;
1004         default:
1005                 error = ether_ioctl(ifp, command, data);
1006                 break;
1007         }
1008
1009         KUE_UNLOCK(sc);
1010
1011         return(error);
1012 }
1013
1014 Static void
1015 kue_watchdog(struct ifnet *ifp)
1016 {
1017         struct kue_softc        *sc;
1018         struct kue_chain        *c;
1019         usbd_status             stat;
1020
1021         sc = ifp->if_softc;
1022         KUE_LOCK(sc);
1023         ifp->if_oerrors++;
1024         printf("kue%d: watchdog timeout\n", sc->kue_unit);
1025
1026         c = &sc->kue_cdata.kue_tx_chain[0];
1027         usbd_get_xfer_status(c->kue_xfer, NULL, NULL, NULL, &stat);
1028         kue_txeof(c->kue_xfer, c, stat);
1029
1030         if (ifp->if_snd.ifq_head != NULL)
1031                 kue_start(ifp);
1032         KUE_UNLOCK(sc);
1033
1034         return;
1035 }
1036
1037 /*
1038  * Stop the adapter and free any mbufs allocated to the
1039  * RX and TX lists.
1040  */
1041 Static void
1042 kue_stop(struct kue_softc *sc)
1043 {
1044         usbd_status             err;
1045         struct ifnet            *ifp;
1046         int                     i;
1047
1048         KUE_LOCK(sc);
1049         ifp = &sc->arpcom.ac_if;
1050         ifp->if_timer = 0;
1051
1052         /* Stop transfers. */
1053         if (sc->kue_ep[KUE_ENDPT_RX] != NULL) {
1054                 err = usbd_abort_pipe(sc->kue_ep[KUE_ENDPT_RX]);
1055                 if (err) {
1056                         printf("kue%d: abort rx pipe failed: %s\n",
1057                         sc->kue_unit, usbd_errstr(err));
1058                 }
1059                 err = usbd_close_pipe(sc->kue_ep[KUE_ENDPT_RX]);
1060                 if (err) {
1061                         printf("kue%d: close rx pipe failed: %s\n",
1062                         sc->kue_unit, usbd_errstr(err));
1063                 }
1064                 sc->kue_ep[KUE_ENDPT_RX] = NULL;
1065         }
1066
1067         if (sc->kue_ep[KUE_ENDPT_TX] != NULL) {
1068                 err = usbd_abort_pipe(sc->kue_ep[KUE_ENDPT_TX]);
1069                 if (err) {
1070                         printf("kue%d: abort tx pipe failed: %s\n",
1071                         sc->kue_unit, usbd_errstr(err));
1072                 }
1073                 err = usbd_close_pipe(sc->kue_ep[KUE_ENDPT_TX]);
1074                 if (err) {
1075                         printf("kue%d: close tx pipe failed: %s\n",
1076                             sc->kue_unit, usbd_errstr(err));
1077                 }
1078                 sc->kue_ep[KUE_ENDPT_TX] = NULL;
1079         }
1080
1081         if (sc->kue_ep[KUE_ENDPT_INTR] != NULL) {
1082                 err = usbd_abort_pipe(sc->kue_ep[KUE_ENDPT_INTR]);
1083                 if (err) {
1084                         printf("kue%d: abort intr pipe failed: %s\n",
1085                         sc->kue_unit, usbd_errstr(err));
1086                 }
1087                 err = usbd_close_pipe(sc->kue_ep[KUE_ENDPT_INTR]);
1088                 if (err) {
1089                         printf("kue%d: close intr pipe failed: %s\n",
1090                             sc->kue_unit, usbd_errstr(err));
1091                 }
1092                 sc->kue_ep[KUE_ENDPT_INTR] = NULL;
1093         }
1094
1095         /* Free RX resources. */
1096         for (i = 0; i < KUE_RX_LIST_CNT; i++) {
1097                 if (sc->kue_cdata.kue_rx_chain[i].kue_buf != NULL) {
1098                         free(sc->kue_cdata.kue_rx_chain[i].kue_buf, M_USBDEV);
1099                         sc->kue_cdata.kue_rx_chain[i].kue_buf = NULL;
1100                 }
1101                 if (sc->kue_cdata.kue_rx_chain[i].kue_mbuf != NULL) {
1102                         m_freem(sc->kue_cdata.kue_rx_chain[i].kue_mbuf);
1103                         sc->kue_cdata.kue_rx_chain[i].kue_mbuf = NULL;
1104                 }
1105                 if (sc->kue_cdata.kue_rx_chain[i].kue_xfer != NULL) {
1106                         usbd_free_xfer(sc->kue_cdata.kue_rx_chain[i].kue_xfer);
1107                         sc->kue_cdata.kue_rx_chain[i].kue_xfer = NULL;
1108                 }
1109         }
1110
1111         /* Free TX resources. */
1112         for (i = 0; i < KUE_TX_LIST_CNT; i++) {
1113                 if (sc->kue_cdata.kue_tx_chain[i].kue_buf != NULL) {
1114                         free(sc->kue_cdata.kue_tx_chain[i].kue_buf, M_USBDEV);
1115                         sc->kue_cdata.kue_tx_chain[i].kue_buf = NULL;
1116                 }
1117                 if (sc->kue_cdata.kue_tx_chain[i].kue_mbuf != NULL) {
1118                         m_freem(sc->kue_cdata.kue_tx_chain[i].kue_mbuf);
1119                         sc->kue_cdata.kue_tx_chain[i].kue_mbuf = NULL;
1120                 }
1121                 if (sc->kue_cdata.kue_tx_chain[i].kue_xfer != NULL) {
1122                         usbd_free_xfer(sc->kue_cdata.kue_tx_chain[i].kue_xfer);
1123                         sc->kue_cdata.kue_tx_chain[i].kue_xfer = NULL;
1124                 }
1125         }
1126
1127         ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
1128         KUE_UNLOCK(sc);
1129
1130         return;
1131 }
1132
1133 /*
1134  * Stop all chip I/O so that the kernel's probe routines don't
1135  * get confused by errant DMAs when rebooting.
1136  */
1137 Static void
1138 kue_shutdown(device_ptr_t dev)
1139 {
1140         struct kue_softc        *sc;
1141
1142         sc = device_get_softc(dev);
1143
1144         kue_stop(sc);
1145
1146         return;
1147 }