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