sys/dev/netif/cue/if_cue.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_cue.c,v 1.45 2003/12/08 07:54:14 obrien Exp $
  33  * $DragonFly: src/sys/dev/netif/cue/if_cue.c,v 1.28 2007/07/01 21:24:02 hasso Exp $
  34  */
  35
  36 /*
  37  * CATC USB-EL1210A USB to ethernet driver. Used in the CATC Netmate
  38  * adapters and others.
  39  *
  40  * Written by Bill Paul <wpaul@ee.columbia.edu>
  41  * Electrical Engineering Department
  42  * Columbia University, New York City
  43  */
  44
  45 /*
  46  * The CATC USB-EL1210A provides USB ethernet support at 10Mbps. The
  47  * RX filter uses a 512-bit multicast hash table, single perfect entry
  48  * for the station address, and promiscuous mode. Unlike the ADMtek
  49  * and KLSI chips, the CATC ASIC supports read and write combining
  50  * mode where multiple packets can be transfered using a single bulk
  51  * transaction, which helps performance a great deal.
  52  */
  53
  54 #include <sys/param.h>
  55 #include <sys/systm.h>
  56 #include <sys/sockio.h>
  57 #include <sys/mbuf.h>
  58 #include <sys/malloc.h>
  59 #include <sys/kernel.h>
  60 #include <sys/socket.h>
  61 #include <sys/bus.h>
  62
  63 #include <net/if.h>
  64 #include <net/ifq_var.h>
  65 #include <net/if_arp.h>
  66 #include <net/ethernet.h>
  67 #include <net/if_dl.h>
  68 #include <net/bpf.h>
  69
  70 #include <bus/usb/usb.h>
  71 #include <bus/usb/usbdi.h>
  72 #include <bus/usb/usbdi_util.h>
  73 #include <bus/usb/usbdivar.h>
  74 #include <bus/usb/usbdevs.h>
  75 #include <bus/usb/usb_ethersubr.h>
  76
  77 #include "if_cuereg.h"
  78
  79 /*
  80  * Various supported device vendors/products.
  81  */
  82 static struct cue_type cue_devs[] = {
  83         { USB_VENDOR_CATC, USB_PRODUCT_CATC_NETMATE },
  84         { USB_VENDOR_CATC, USB_PRODUCT_CATC_NETMATE2 },
  85         { USB_VENDOR_SMARTBRIDGES, USB_PRODUCT_SMARTBRIDGES_SMARTLINK },
  86         { 0, 0 }
  87 };
  88
  89 static int cue_match(device_t);
  90 static int cue_attach(device_t);
  91 static int cue_detach(device_t);
  92
  93 static int cue_tx_list_init(struct cue_softc *);
  94 static int cue_rx_list_init(struct cue_softc *);
  95 static int cue_newbuf(struct cue_softc *, struct cue_chain *, struct mbuf *);
  96 static int cue_encap(struct cue_softc *, struct mbuf *, int);
  97 static void cue_rxeof(usbd_xfer_handle, usbd_private_handle, usbd_status);
  98 static void cue_txeof(usbd_xfer_handle, usbd_private_handle, usbd_status);
  99 static void cue_tick(void *);
 100 static void cue_rxstart(struct ifnet *);
 101 static void cue_start(struct ifnet *);
 102 static int cue_ioctl(struct ifnet *, u_long, caddr_t, struct ucred *);
 103 static void cue_init(void *);
 104 static void cue_stop(struct cue_softc *);
 105 static void cue_watchdog(struct ifnet *);
 106 static void cue_shutdown(device_t);
 107
 108 static void cue_setmulti(struct cue_softc *);
 109 static void cue_reset(struct cue_softc *);
 110
 111 static int cue_csr_read_1(struct cue_softc *, int);
 112 static int cue_csr_write_1(struct cue_softc *, int, int);
 113 static int cue_csr_read_2(struct cue_softc *, int);
 114 #ifdef notdef
 115 static int cue_csr_write_2(struct cue_softc *, int, int);
 116 #endif
 117 static int cue_mem(struct cue_softc *, int, int, void *, int);
 118 static int cue_getmac(struct cue_softc *, void *);
 119
 120 static device_method_t cue_methods[] = {
 121         /* Device interface */
 122         DEVMETHOD(device_probe,         cue_match),
 123         DEVMETHOD(device_attach,        cue_attach),
 124         DEVMETHOD(device_detach,        cue_detach),
 125         DEVMETHOD(device_shutdown,      cue_shutdown),
 126
 127         { 0, 0 }
 128 };
 129
 130 static driver_t cue_driver = {
 131         "cue",
 132         cue_methods,
 133         sizeof(struct cue_softc)
 134 };
 135
 136 static devclass_t cue_devclass;
 137
 138 DECLARE_DUMMY_MODULE(if_cue);
 139 DRIVER_MODULE(cue, uhub, cue_driver, cue_devclass, usbd_driver_load, 0);
 140 MODULE_DEPEND(cue, usb, 1, 1, 1);
 141
 142 #define CUE_SETBIT(sc, reg, x)                          \
 143         cue_csr_write_1(sc, reg, cue_csr_read_1(sc, reg) | (x))
 144
 145 #define CUE_CLRBIT(sc, reg, x)                          \
 146         cue_csr_write_1(sc, reg, cue_csr_read_1(sc, reg) & ~(x))
 147
 148 static int
 149 cue_csr_read_1(struct cue_softc *sc, int reg)
 150 {
 151         usb_device_request_t    req;
 152         usbd_status             err;
 153         u_int8_t                val = 0;
 154
 155         if (sc->cue_dying)
 156                 return(0);
 157
 158         CUE_LOCK(sc);
 159
 160         req.bmRequestType = UT_READ_VENDOR_DEVICE;
 161         req.bRequest = CUE_CMD_READREG;
 162         USETW(req.wValue, 0);
 163         USETW(req.wIndex, reg);
 164         USETW(req.wLength, 1);
 165
 166         err = usbd_do_request(sc->cue_udev, &req, &val);
 167
 168         CUE_UNLOCK(sc);
 169
 170         if (err)
 171                 return(0);
 172
 173         return(val);
 174 }
 175
 176 static int
 177 cue_csr_read_2(struct cue_softc *sc, int reg)
 178 {
 179         usb_device_request_t    req;
 180         usbd_status             err;
 181         u_int16_t               val = 0;
 182
 183         if (sc->cue_dying)
 184                 return(0);
 185
 186         CUE_LOCK(sc);
 187
 188         req.bmRequestType = UT_READ_VENDOR_DEVICE;
 189         req.bRequest = CUE_CMD_READREG;
 190         USETW(req.wValue, 0);
 191         USETW(req.wIndex, reg);
 192         USETW(req.wLength, 2);
 193
 194         err = usbd_do_request(sc->cue_udev, &req, &val);
 195
 196         CUE_UNLOCK(sc);
 197
 198         if (err)
 199                 return(0);
 200
 201         return(val);
 202 }
 203
 204 static int
 205 cue_csr_write_1(struct cue_softc *sc, int reg, int val)
 206 {
 207         usb_device_request_t    req;
 208         usbd_status             err;
 209
 210         if (sc->cue_dying)
 211                 return(0);
 212
 213         CUE_LOCK(sc);
 214
 215         req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
 216         req.bRequest = CUE_CMD_WRITEREG;
 217         USETW(req.wValue, val);
 218         USETW(req.wIndex, reg);
 219         USETW(req.wLength, 0);
 220
 221         err = usbd_do_request(sc->cue_udev, &req, NULL);
 222
 223         CUE_UNLOCK(sc);
 224
 225         if (err)
 226                 return(-1);
 227
 228         return(0);
 229 }
 230
 231 #ifdef notdef
 232 static int
 233 cue_csr_write_2(struct cue_softc *sc, int reg, int val)
 234 {
 235         usb_device_request_t    req;
 236         usbd_status             err;
 237
 238         if (sc->cue_dying)
 239                 return(0);
 240
 241         CUE_LOCK(sc);
 242
 243         req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
 244         req.bRequest = CUE_CMD_WRITEREG;
 245         USETW(req.wValue, val);
 246         USETW(req.wIndex, reg);
 247         USETW(req.wLength, 0);
 248
 249         err = usbd_do_request(sc->cue_udev, &req, NULL);
 250
 251         CUE_UNLOCK(sc);
 252
 253         if (err)
 254                 return(-1);
 255
 256         return(0);
 257 }
 258 #endif
 259
 260 static int
 261 cue_mem(struct cue_softc *sc, int cmd, int addr, void *buf, int len)
 262 {
 263         usb_device_request_t    req;
 264         usbd_status             err;
 265
 266         if (sc->cue_dying)
 267                 return(0);
 268
 269         CUE_LOCK(sc);
 270
 271         if (cmd == CUE_CMD_READSRAM)
 272                 req.bmRequestType = UT_READ_VENDOR_DEVICE;
 273         else
 274                 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
 275         req.bRequest = cmd;
 276         USETW(req.wValue, 0);
 277         USETW(req.wIndex, addr);
 278         USETW(req.wLength, len);
 279
 280         err = usbd_do_request(sc->cue_udev, &req, buf);
 281
 282         CUE_UNLOCK(sc);
 283
 284         if (err)
 285                 return(-1);
 286
 287         return(0);
 288 }
 289
 290 static int
 291 cue_getmac(struct cue_softc *sc, void *buf)
 292 {
 293         usb_device_request_t    req;
 294         usbd_status             err;
 295
 296         if (sc->cue_dying)
 297                 return(0);
 298
 299         CUE_LOCK(sc);
 300
 301         req.bmRequestType = UT_READ_VENDOR_DEVICE;
 302         req.bRequest = CUE_CMD_GET_MACADDR;
 303         USETW(req.wValue, 0);
 304         USETW(req.wIndex, 0);
 305         USETW(req.wLength, ETHER_ADDR_LEN);
 306
 307         err = usbd_do_request(sc->cue_udev, &req, buf);
 308
 309         CUE_UNLOCK(sc);
 310
 311         if (err) {
 312                 if_printf(&sc->arpcom.ac_if, "read MAC address failed\n");
 313                 return(-1);
 314         }
 315
 316         return(0);
 317 }
 318
 319 #define CUE_BITS        9
 320
 321 static void
 322 cue_setmulti(struct cue_softc *sc)
 323 {
 324         struct ifnet            *ifp;
 325         struct ifmultiaddr      *ifma;
 326         u_int32_t               h = 0, i;
 327
 328         ifp = &sc->arpcom.ac_if;
 329
 330         if (ifp->if_flags & IFF_ALLMULTI || ifp->if_flags & IFF_PROMISC) {
 331                 for (i = 0; i < CUE_MCAST_TABLE_LEN; i++)
 332                         sc->cue_mctab[i] = 0xFF;
 333                 cue_mem(sc, CUE_CMD_WRITESRAM, CUE_MCAST_TABLE_ADDR,
 334                     &sc->cue_mctab, CUE_MCAST_TABLE_LEN);
 335                 return;
 336         }
 337
 338         /* first, zot all the existing hash bits */
 339         for (i = 0; i < CUE_MCAST_TABLE_LEN; i++)
 340                 sc->cue_mctab[i] = 0;
 341
 342         /* now program new ones */
 343         LIST_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link)
 344         {
 345                 if (ifma->ifma_addr->sa_family != AF_LINK)
 346                         continue;
 347                 h = ether_crc32_le(
 348                     LLADDR((struct sockaddr_dl *)ifma->ifma_addr),
 349                     ETHER_ADDR_LEN) & ((1 << CUE_BITS) - 1);
 350                 sc->cue_mctab[h >> 3] |= 1 << (h & 0x7);
 351         }
 352
 353         /*
 354          * Also include the broadcast address in the filter
 355          * so we can receive broadcast frames.
 356          */
 357         if (ifp->if_flags & IFF_BROADCAST) {
 358                 h = ether_crc32_le(ifp->if_broadcastaddr, ETHER_ADDR_LEN) &
 359                     ((1 << CUE_BITS) - 1);
 360                 sc->cue_mctab[h >> 3] |= 1 << (h & 0x7);
 361         }
 362
 363         cue_mem(sc, CUE_CMD_WRITESRAM, CUE_MCAST_TABLE_ADDR,
 364             &sc->cue_mctab, CUE_MCAST_TABLE_LEN);
 365
 366         return;
 367 }
 368
 369 static void
 370 cue_reset(struct cue_softc *sc)
 371 {
 372         usb_device_request_t    req;
 373         usbd_status             err;
 374
 375         if (sc->cue_dying)
 376                 return;
 377
 378         req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
 379         req.bRequest = CUE_CMD_RESET;
 380         USETW(req.wValue, 0);
 381         USETW(req.wIndex, 0);
 382         USETW(req.wLength, 0);
 383         err = usbd_do_request(sc->cue_udev, &req, NULL);
 384         if (err)
 385                 if_printf(&sc->arpcom.ac_if, "reset failed\n");
 386
 387         /* Wait a little while for the chip to get its brains in order. */
 388         DELAY(1000);
 389         return;
 390 }
 391
 392 /*
 393  * Probe for a Pegasus chip.
 394  */
 395 static int
 396 cue_match(device_t self)
 397 {
 398         struct usb_attach_arg *uaa = device_get_ivars(self);
 399         struct cue_type                 *t;
 400
 401         if (!uaa->iface)
 402                 return(UMATCH_NONE);
 403
 404         t = cue_devs;
 405         while(t->cue_vid) {
 406                 if (uaa->vendor == t->cue_vid &&
 407                     uaa->product == t->cue_did) {
 408                         return(UMATCH_VENDOR_PRODUCT);
 409                 }
 410                 t++;
 411         }
 412
 413         return(UMATCH_NONE);
 414 }
 415
 416 /*
 417  * Attach the interface. Allocate softc structures, do ifmedia
 418  * setup and ethernet/BPF attach.
 419  */
 420 static int
 421 cue_attach(device_t self)
 422 {
 423         struct cue_softc *sc = device_get_softc(self);
 424         struct usb_attach_arg *uaa = device_get_ivars(self);
 425         char                    devinfo[1024];
 426         u_char                  eaddr[ETHER_ADDR_LEN];
 427         struct ifnet            *ifp;
 428         usb_interface_descriptor_t      *id;
 429         usb_endpoint_descriptor_t       *ed;
 430         int                     i;
 431
 432         sc->cue_iface = uaa->iface;
 433         sc->cue_udev = uaa->device;
 434         callout_init(&sc->cue_stat_timer);
 435
 436         if (usbd_set_config_no(sc->cue_udev, CUE_CONFIG_NO, 0)) {
 437                 device_printf(self, "setting config no %d failed\n",
 438                               CUE_CONFIG_NO);
 439                 return ENXIO;
 440         }
 441
 442         id = usbd_get_interface_descriptor(uaa->iface);
 443
 444         usbd_devinfo(uaa->device, 0, devinfo);
 445         device_set_desc_copy(self, devinfo);
 446         device_printf(self, "%s\n", devinfo);
 447
 448         /* Find endpoints. */
 449         for (i = 0; i < id->bNumEndpoints; i++) {
 450                 ed = usbd_interface2endpoint_descriptor(uaa->iface, i);
 451                 if (!ed) {
 452                         device_printf(self, "couldn't get ep %d\n", i);
 453                         return ENXIO;
 454                 }
 455                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
 456                     UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
 457                         sc->cue_ed[CUE_ENDPT_RX] = ed->bEndpointAddress;
 458                 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
 459                            UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
 460                         sc->cue_ed[CUE_ENDPT_TX] = ed->bEndpointAddress;
 461                 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
 462                            UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
 463                         sc->cue_ed[CUE_ENDPT_INTR] = ed->bEndpointAddress;
 464                 }
 465         }
 466
 467         CUE_LOCK(sc);
 468
 469         ifp = &sc->arpcom.ac_if;
 470         if_initname(ifp, device_get_name(self), device_get_unit(self));
 471
 472 #ifdef notdef
 473         /* Reset the adapter. */
 474         cue_reset(sc);
 475 #endif
 476         /*
 477          * Get station address.
 478          */
 479         cue_getmac(sc, &eaddr);
 480
 481         ifp->if_softc = sc;
 482         ifp->if_mtu = ETHERMTU;
 483         ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
 484         ifp->if_ioctl = cue_ioctl;
 485         ifp->if_start = cue_start;
 486         ifp->if_watchdog = cue_watchdog;
 487         ifp->if_init = cue_init;
 488         ifp->if_baudrate = 10000000;
 489         ifq_set_maxlen(&ifp->if_snd, IFQ_MAXLEN);
 490         ifq_set_ready(&ifp->if_snd);
 491
 492         /*
 493          * Call MI attach routine.
 494          */
 495         ether_ifattach(ifp, eaddr, NULL);
 496         usb_register_netisr();
 497         sc->cue_dying = 0;
 498
 499         CUE_UNLOCK(sc);
 500         return 0;
 501 }
 502
 503 static int
 504 cue_detach(device_t dev)
 505 {
 506         struct cue_softc        *sc;
 507         struct ifnet            *ifp;
 508
 509         sc = device_get_softc(dev);
 510         CUE_LOCK(sc);
 511         ifp = &sc->arpcom.ac_if;
 512
 513         sc->cue_dying = 1;
 514         callout_stop(&sc->cue_stat_timer);
 515         ether_ifdetach(ifp);
 516
 517         if (sc->cue_ep[CUE_ENDPT_TX] != NULL)
 518                 usbd_abort_pipe(sc->cue_ep[CUE_ENDPT_TX]);
 519         if (sc->cue_ep[CUE_ENDPT_RX] != NULL)
 520                 usbd_abort_pipe(sc->cue_ep[CUE_ENDPT_RX]);
 521         if (sc->cue_ep[CUE_ENDPT_INTR] != NULL)
 522                 usbd_abort_pipe(sc->cue_ep[CUE_ENDPT_INTR]);
 523
 524         CUE_UNLOCK(sc);
 525
 526         return(0);
 527 }
 528
 529 /*
 530  * Initialize an RX descriptor and attach an MBUF cluster.
 531  */
 532 static int
 533 cue_newbuf(struct cue_softc *sc, struct cue_chain *c, struct mbuf *m)
 534 {
 535         struct mbuf             *m_new = NULL;
 536
 537         if (m == NULL) {
 538                 MGETHDR(m_new, MB_DONTWAIT, MT_DATA);
 539                 if (m_new == NULL) {
 540                         if_printf(&sc->arpcom.ac_if, "no memory for rx list "
 541                                   "-- packet dropped!\n");
 542                         return(ENOBUFS);
 543                 }
 544
 545                 MCLGET(m_new, MB_DONTWAIT);
 546                 if (!(m_new->m_flags & M_EXT)) {
 547                         if_printf(&sc->arpcom.ac_if, "no memory for rx list "
 548                                   "-- packet dropped!\n");
 549                         m_freem(m_new);
 550                         return(ENOBUFS);
 551                 }
 552                 m_new->m_len = m_new->m_pkthdr.len = MCLBYTES;
 553         } else {
 554                 m_new = m;
 555                 m_new->m_len = m_new->m_pkthdr.len = MCLBYTES;
 556                 m_new->m_data = m_new->m_ext.ext_buf;
 557         }
 558
 559         m_adj(m_new, ETHER_ALIGN);
 560         c->cue_mbuf = m_new;
 561
 562         return(0);
 563 }
 564
 565 static int
 566 cue_rx_list_init(struct cue_softc *sc)
 567 {
 568         struct cue_cdata        *cd;
 569         struct cue_chain        *c;
 570         int                     i;
 571
 572         cd = &sc->cue_cdata;
 573         for (i = 0; i < CUE_RX_LIST_CNT; i++) {
 574                 c = &cd->cue_rx_chain[i];
 575                 c->cue_sc = sc;
 576                 c->cue_idx = i;
 577                 if (cue_newbuf(sc, c, NULL) == ENOBUFS)
 578                         return(ENOBUFS);
 579                 if (c->cue_xfer == NULL) {
 580                         c->cue_xfer = usbd_alloc_xfer(sc->cue_udev);
 581                         if (c->cue_xfer == NULL)
 582                                 return(ENOBUFS);
 583                 }
 584         }
 585
 586         return(0);
 587 }
 588
 589 static int
 590 cue_tx_list_init(struct cue_softc *sc)
 591 {
 592         struct cue_cdata        *cd;
 593         struct cue_chain        *c;
 594         int                     i;
 595
 596         cd = &sc->cue_cdata;
 597         for (i = 0; i < CUE_TX_LIST_CNT; i++) {
 598                 c = &cd->cue_tx_chain[i];
 599                 c->cue_sc = sc;
 600                 c->cue_idx = i;
 601                 c->cue_mbuf = NULL;
 602                 if (c->cue_xfer == NULL) {
 603                         c->cue_xfer = usbd_alloc_xfer(sc->cue_udev);
 604                         if (c->cue_xfer == NULL)
 605                                 return(ENOBUFS);
 606                 }
 607                 c->cue_buf = kmalloc(CUE_BUFSZ, M_USBDEV, M_WAITOK);
 608         }
 609
 610         return(0);
 611 }
 612
 613 static void
 614 cue_rxstart(struct ifnet *ifp)
 615 {
 616         struct cue_softc        *sc;
 617         struct cue_chain        *c;
 618
 619         sc = ifp->if_softc;
 620         CUE_LOCK(sc);
 621         c = &sc->cue_cdata.cue_rx_chain[sc->cue_cdata.cue_rx_prod];
 622
 623         if (cue_newbuf(sc, c, NULL) == ENOBUFS) {
 624                 ifp->if_ierrors++;
 625                 CUE_UNLOCK(sc);
 626                 return;
 627         }
 628
 629         /* Setup new transfer. */
 630         usbd_setup_xfer(c->cue_xfer, sc->cue_ep[CUE_ENDPT_RX],
 631             c, mtod(c->cue_mbuf, char *), CUE_BUFSZ, USBD_SHORT_XFER_OK,
 632             USBD_NO_TIMEOUT, cue_rxeof);
 633         usbd_transfer(c->cue_xfer);
 634         CUE_UNLOCK(sc);
 635
 636         return;
 637 }
 638
 639 /*
 640  * A frame has been uploaded: pass the resulting mbuf chain up to
 641  * the higher level protocols.
 642  */
 643 static void
 644 cue_rxeof(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
 645 {
 646         struct cue_softc        *sc;
 647         struct cue_chain        *c;
 648         struct mbuf             *m;
 649         struct ifnet            *ifp;
 650         int                     total_len = 0;
 651         u_int16_t               len;
 652
 653         c = priv;
 654         sc = c->cue_sc;
 655         CUE_LOCK(sc);
 656         ifp = &sc->arpcom.ac_if;
 657
 658         if (!(ifp->if_flags & IFF_RUNNING)) {
 659                 CUE_UNLOCK(sc);
 660                 return;
 661         }
 662
 663         if (status != USBD_NORMAL_COMPLETION) {
 664                 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) {
 665                         CUE_UNLOCK(sc);
 666                         return;
 667                 }
 668                 if (usbd_ratecheck(&sc->cue_rx_notice)) {
 669                         if_printf(ifp, "usb error on rx: %s\n",
 670                                   usbd_errstr(status));
 671                 }
 672                 if (status == USBD_STALLED)
 673                         usbd_clear_endpoint_stall(sc->cue_ep[CUE_ENDPT_RX]);
 674                 goto done;
 675         }
 676
 677         usbd_get_xfer_status(xfer, NULL, NULL, &total_len, NULL);
 678
 679         m = c->cue_mbuf;
 680         len = *mtod(m, u_int16_t *);
 681
 682         /* No errors; receive the packet. */
 683         total_len = len;
 684
 685         if (len < sizeof(struct ether_header)) {
 686                 ifp->if_ierrors++;
 687                 goto done;
 688         }
 689
 690         ifp->if_ipackets++;
 691         m_adj(m, sizeof(u_int16_t));
 692         m->m_pkthdr.rcvif = ifp;
 693         m->m_pkthdr.len = m->m_len = total_len;
 694
 695         /* Put the packet on the special USB input queue. */
 696         usb_ether_input(m);
 697         cue_rxstart(ifp);
 698
 699         CUE_UNLOCK(sc);
 700
 701         return;
 702 done:
 703         /* Setup new transfer. */
 704         usbd_setup_xfer(c->cue_xfer, sc->cue_ep[CUE_ENDPT_RX],
 705             c, mtod(c->cue_mbuf, char *), CUE_BUFSZ, USBD_SHORT_XFER_OK,
 706             USBD_NO_TIMEOUT, cue_rxeof);
 707         usbd_transfer(c->cue_xfer);
 708         CUE_UNLOCK(sc);
 709
 710         return;
 711 }
 712
 713 /*
 714  * A frame was downloaded to the chip. It's safe for us to clean up
 715  * the list buffers.
 716  */
 717
 718 static void
 719 cue_txeof(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
 720 {
 721         struct cue_softc        *sc;
 722         struct cue_chain        *c;
 723         struct ifnet            *ifp;
 724         usbd_status             err;
 725
 726         c = priv;
 727         sc = c->cue_sc;
 728         CUE_LOCK(sc);
 729         ifp = &sc->arpcom.ac_if;
 730
 731         if (status != USBD_NORMAL_COMPLETION) {
 732                 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) {
 733                         CUE_UNLOCK(sc);
 734                         return;
 735                 }
 736                 if_printf(ifp, "usb error on tx: %s\n", usbd_errstr(status));
 737                 if (status == USBD_STALLED)
 738                         usbd_clear_endpoint_stall(sc->cue_ep[CUE_ENDPT_TX]);
 739                 CUE_UNLOCK(sc);
 740                 return;
 741         }
 742
 743         ifp->if_timer = 0;
 744         ifp->if_flags &= ~IFF_OACTIVE;
 745         usbd_get_xfer_status(c->cue_xfer, NULL, NULL, NULL, &err);
 746
 747         if (c->cue_mbuf != NULL) {
 748                 m_freem(c->cue_mbuf);
 749                 c->cue_mbuf = NULL;
 750         }
 751
 752         if (err)
 753                 ifp->if_oerrors++;
 754         else
 755                 ifp->if_opackets++;
 756
 757         if (!ifq_is_empty(&ifp->if_snd))
 758                 (*ifp->if_start)(ifp);
 759
 760         CUE_UNLOCK(sc);
 761
 762         return;
 763 }
 764
 765 static void
 766 cue_tick(void *xsc)
 767 {
 768         struct cue_softc        *sc;
 769         struct ifnet            *ifp;
 770
 771         sc = xsc;
 772
 773         if (sc == NULL)
 774                 return;
 775
 776         CUE_LOCK(sc);
 777
 778         ifp = &sc->arpcom.ac_if;
 779
 780         ifp->if_collisions += cue_csr_read_2(sc, CUE_TX_SINGLECOLL);
 781         ifp->if_collisions += cue_csr_read_2(sc, CUE_TX_MULTICOLL);
 782         ifp->if_collisions += cue_csr_read_2(sc, CUE_TX_EXCESSCOLL);
 783
 784         if (cue_csr_read_2(sc, CUE_RX_FRAMEERR))
 785                 ifp->if_ierrors++;
 786
 787         callout_reset(&sc->cue_stat_timer, hz, cue_tick, sc);
 788
 789         CUE_UNLOCK(sc);
 790
 791         return;
 792 }
 793
 794 static int
 795 cue_encap(struct cue_softc *sc, struct mbuf *m, int idx)
 796 {
 797         int                     total_len;
 798         struct cue_chain        *c;
 799         usbd_status             err;
 800
 801         c = &sc->cue_cdata.cue_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->cue_buf + 2);
 808         c->cue_mbuf = m;
 809
 810         total_len = m->m_pkthdr.len + 2;
 811
 812         /* The first two bytes are the frame length */
 813         c->cue_buf[0] = (u_int8_t)m->m_pkthdr.len;
 814         c->cue_buf[1] = (u_int8_t)(m->m_pkthdr.len >> 8);
 815
 816         usbd_setup_xfer(c->cue_xfer, sc->cue_ep[CUE_ENDPT_TX],
 817             c, c->cue_buf, total_len, 0, 10000, cue_txeof);
 818
 819         /* Transmit */
 820         err = usbd_transfer(c->cue_xfer);
 821         if (err != USBD_IN_PROGRESS) {
 822                 cue_stop(sc);
 823                 return(EIO);
 824         }
 825
 826         sc->cue_cdata.cue_tx_cnt++;
 827
 828         return(0);
 829 }
 830
 831 static void
 832 cue_start(struct ifnet *ifp)
 833 {
 834         struct cue_softc        *sc;
 835         struct mbuf             *m_head = NULL;
 836
 837         sc = ifp->if_softc;
 838         CUE_LOCK(sc);
 839
 840         if (ifp->if_flags & IFF_OACTIVE) {
 841                 CUE_UNLOCK(sc);
 842                 return;
 843         }
 844
 845         m_head = ifq_poll(&ifp->if_snd);
 846         if (m_head == NULL) {
 847                 CUE_UNLOCK(sc);
 848                 return;
 849         }
 850
 851         if (cue_encap(sc, m_head, 0)) {
 852                 ifp->if_flags |= IFF_OACTIVE;
 853                 CUE_UNLOCK(sc);
 854                 return;
 855         }
 856         ifq_dequeue(&ifp->if_snd, m_head);
 857
 858         /*
 859          * If there's a BPF listener, bounce a copy of this frame
 860          * to him.
 861          */
 862         BPF_MTAP(ifp, m_head);
 863
 864         ifp->if_flags |= IFF_OACTIVE;
 865
 866         /*
 867          * Set a timeout in case the chip goes out to lunch.
 868          */
 869         ifp->if_timer = 5;
 870         CUE_UNLOCK(sc);
 871
 872         return;
 873 }
 874
 875 static void
 876 cue_init(void *xsc)
 877 {
 878         struct cue_softc        *sc = xsc;
 879         struct ifnet            *ifp = &sc->arpcom.ac_if;
 880         struct cue_chain        *c;
 881         usbd_status             err;
 882         int                     i;
 883
 884         if (ifp->if_flags & IFF_RUNNING)
 885                 return;
 886
 887         CUE_LOCK(sc);
 888
 889         /*
 890          * Cancel pending I/O and free all RX/TX buffers.
 891          */
 892 #ifdef foo
 893         cue_reset(sc);
 894 #endif
 895
 896         /* Set MAC address */
 897         for (i = 0; i < ETHER_ADDR_LEN; i++)
 898                 cue_csr_write_1(sc, CUE_PAR0 - i, sc->arpcom.ac_enaddr[i]);
 899
 900         /* Enable RX logic. */
 901         cue_csr_write_1(sc, CUE_ETHCTL, CUE_ETHCTL_RX_ON|CUE_ETHCTL_MCAST_ON);
 902
 903          /* If we want promiscuous mode, set the allframes bit. */
 904         if (ifp->if_flags & IFF_PROMISC) {
 905                 CUE_SETBIT(sc, CUE_ETHCTL, CUE_ETHCTL_PROMISC);
 906         } else {
 907                 CUE_CLRBIT(sc, CUE_ETHCTL, CUE_ETHCTL_PROMISC);
 908         }
 909
 910         /* Init TX ring. */
 911         if (cue_tx_list_init(sc) == ENOBUFS) {
 912                 if_printf(ifp, "tx list init failed\n");
 913                 CUE_UNLOCK(sc);
 914                 return;
 915         }
 916
 917         /* Init RX ring. */
 918         if (cue_rx_list_init(sc) == ENOBUFS) {
 919                 if_printf(ifp, "rx list init failed\n");
 920                 CUE_UNLOCK(sc);
 921                 return;
 922         }
 923
 924         /* Load the multicast filter. */
 925         cue_setmulti(sc);
 926
 927         /*
 928          * Set the number of RX and TX buffers that we want
 929          * to reserve inside the ASIC.
 930          */
 931         cue_csr_write_1(sc, CUE_RX_BUFPKTS, CUE_RX_FRAMES);
 932         cue_csr_write_1(sc, CUE_TX_BUFPKTS, CUE_TX_FRAMES);
 933
 934         /* Set advanced operation modes. */
 935         cue_csr_write_1(sc, CUE_ADVANCED_OPMODES,
 936             CUE_AOP_EMBED_RXLEN|0x01); /* 1 wait state */
 937
 938         /* Program the LED operation. */
 939         cue_csr_write_1(sc, CUE_LEDCTL, CUE_LEDCTL_FOLLOW_LINK);
 940
 941         /* Open RX and TX pipes. */
 942         err = usbd_open_pipe(sc->cue_iface, sc->cue_ed[CUE_ENDPT_RX],
 943             USBD_EXCLUSIVE_USE, &sc->cue_ep[CUE_ENDPT_RX]);
 944         if (err) {
 945                 if_printf(ifp, "open rx pipe failed: %s\n", usbd_errstr(err));
 946                 CUE_UNLOCK(sc);
 947                 return;
 948         }
 949         err = usbd_open_pipe(sc->cue_iface, sc->cue_ed[CUE_ENDPT_TX],
 950             USBD_EXCLUSIVE_USE, &sc->cue_ep[CUE_ENDPT_TX]);
 951         if (err) {
 952                 if_printf(ifp, "open tx pipe failed: %s\n", usbd_errstr(err));
 953                 CUE_UNLOCK(sc);
 954                 return;
 955         }
 956
 957         /* Start up the receive pipe. */
 958         for (i = 0; i < CUE_RX_LIST_CNT; i++) {
 959                 c = &sc->cue_cdata.cue_rx_chain[i];
 960                 usbd_setup_xfer(c->cue_xfer, sc->cue_ep[CUE_ENDPT_RX],
 961                     c, mtod(c->cue_mbuf, char *), CUE_BUFSZ,
 962                     USBD_SHORT_XFER_OK, USBD_NO_TIMEOUT, cue_rxeof);
 963                 usbd_transfer(c->cue_xfer);
 964         }
 965
 966         ifp->if_flags |= IFF_RUNNING;
 967         ifp->if_flags &= ~IFF_OACTIVE;
 968
 969         CUE_UNLOCK(sc);
 970
 971         callout_reset(&sc->cue_stat_timer, hz, cue_tick, sc);
 972 }
 973
 974 static int
 975 cue_ioctl(struct ifnet *ifp, u_long command, caddr_t data, struct ucred *cr)
 976 {
 977         struct cue_softc        *sc = ifp->if_softc;
 978         int                     error = 0;
 979
 980         CUE_LOCK(sc);
 981
 982         switch(command) {
 983         case SIOCSIFFLAGS:
 984                 if (ifp->if_flags & IFF_UP) {
 985                         if (ifp->if_flags & IFF_RUNNING &&
 986                             ifp->if_flags & IFF_PROMISC &&
 987                             !(sc->cue_if_flags & IFF_PROMISC)) {
 988                                 CUE_SETBIT(sc, CUE_ETHCTL, CUE_ETHCTL_PROMISC);
 989                                 cue_setmulti(sc);
 990                         } else if (ifp->if_flags & IFF_RUNNING &&
 991                             !(ifp->if_flags & IFF_PROMISC) &&
 992                             sc->cue_if_flags & IFF_PROMISC) {
 993                                 CUE_CLRBIT(sc, CUE_ETHCTL, CUE_ETHCTL_PROMISC);
 994                                 cue_setmulti(sc);
 995                         } else if (!(ifp->if_flags & IFF_RUNNING))
 996                                 cue_init(sc);
 997                 } else {
 998                         if (ifp->if_flags & IFF_RUNNING)
 999                                 cue_stop(sc);
1000                 }
1001                 sc->cue_if_flags = ifp->if_flags;
1002                 error = 0;
1003                 break;
1004         case SIOCADDMULTI:
1005         case SIOCDELMULTI:
1006                 cue_setmulti(sc);
1007                 error = 0;
1008                 break;
1009         default:
1010                 error = ether_ioctl(ifp, command, data);
1011                 break;
1012         }
1013
1014         CUE_UNLOCK(sc);
1015
1016         return(error);
1017 }
1018
1019 static void
1020 cue_watchdog(struct ifnet *ifp)
1021 {
1022         struct cue_softc        *sc;
1023         struct cue_chain        *c;
1024         usbd_status             stat;
1025
1026         sc = ifp->if_softc;
1027         CUE_LOCK(sc);
1028
1029         ifp->if_oerrors++;
1030         if_printf(ifp, "watchdog timeout\n");
1031
1032         c = &sc->cue_cdata.cue_tx_chain[0];
1033         usbd_get_xfer_status(c->cue_xfer, NULL, NULL, NULL, &stat);
1034         cue_txeof(c->cue_xfer, c, stat);
1035
1036         if (!ifq_is_empty(&ifp->if_snd))
1037                 cue_start(ifp);
1038         CUE_UNLOCK(sc);
1039
1040         return;
1041 }
1042
1043 /*
1044  * Stop the adapter and free any mbufs allocated to the
1045  * RX and TX lists.
1046  */
1047 static void
1048 cue_stop(struct cue_softc *sc)
1049 {
1050         usbd_status             err;
1051         struct ifnet            *ifp;
1052         int                     i;
1053
1054         CUE_LOCK(sc);
1055
1056         ifp = &sc->arpcom.ac_if;
1057         ifp->if_timer = 0;
1058
1059         cue_csr_write_1(sc, CUE_ETHCTL, 0);
1060         cue_reset(sc);
1061         callout_stop(&sc->cue_stat_timer);
1062
1063         /* Stop transfers. */
1064         if (sc->cue_ep[CUE_ENDPT_RX] != NULL) {
1065                 err = usbd_abort_pipe(sc->cue_ep[CUE_ENDPT_RX]);
1066                 if (err) {
1067                         if_printf(ifp, "abort rx pipe failed: %s\n",
1068                                   usbd_errstr(err));
1069                 }
1070                 err = usbd_close_pipe(sc->cue_ep[CUE_ENDPT_RX]);
1071                 if (err) {
1072                         if_printf(ifp, "close rx pipe failed: %s\n",
1073                                   usbd_errstr(err));
1074                 }
1075                 sc->cue_ep[CUE_ENDPT_RX] = NULL;
1076         }
1077
1078         if (sc->cue_ep[CUE_ENDPT_TX] != NULL) {
1079                 err = usbd_abort_pipe(sc->cue_ep[CUE_ENDPT_TX]);
1080                 if (err) {
1081                         if_printf(ifp, "abort tx pipe failed: %s\n",
1082                                   usbd_errstr(err));
1083                 }
1084                 err = usbd_close_pipe(sc->cue_ep[CUE_ENDPT_TX]);
1085                 if (err) {
1086                         if_printf(ifp, "close tx pipe failed: %s\n",
1087                                   usbd_errstr(err));
1088                 }
1089                 sc->cue_ep[CUE_ENDPT_TX] = NULL;
1090         }
1091
1092         if (sc->cue_ep[CUE_ENDPT_INTR] != NULL) {
1093                 err = usbd_abort_pipe(sc->cue_ep[CUE_ENDPT_INTR]);
1094                 if (err) {
1095                         if_printf(ifp, "abort intr pipe failed: %s\n",
1096                                   usbd_errstr(err));
1097                 }
1098                 err = usbd_close_pipe(sc->cue_ep[CUE_ENDPT_INTR]);
1099                 if (err) {
1100                         if_printf(ifp, "close intr pipe failed: %s\n",
1101                                   usbd_errstr(err));
1102                 }
1103                 sc->cue_ep[CUE_ENDPT_INTR] = NULL;
1104         }
1105
1106         /* Free RX resources. */
1107         for (i = 0; i < CUE_RX_LIST_CNT; i++) {
1108                 if (sc->cue_cdata.cue_rx_chain[i].cue_buf != NULL) {
1109                         kfree(sc->cue_cdata.cue_rx_chain[i].cue_buf, M_USBDEV);
1110                         sc->cue_cdata.cue_rx_chain[i].cue_buf = NULL;
1111                 }
1112                 if (sc->cue_cdata.cue_rx_chain[i].cue_mbuf != NULL) {
1113                         m_freem(sc->cue_cdata.cue_rx_chain[i].cue_mbuf);
1114                         sc->cue_cdata.cue_rx_chain[i].cue_mbuf = NULL;
1115                 }
1116                 if (sc->cue_cdata.cue_rx_chain[i].cue_xfer != NULL) {
1117                         usbd_free_xfer(sc->cue_cdata.cue_rx_chain[i].cue_xfer);
1118                         sc->cue_cdata.cue_rx_chain[i].cue_xfer = NULL;
1119                 }
1120         }
1121
1122         /* Free TX resources. */
1123         for (i = 0; i < CUE_TX_LIST_CNT; i++) {
1124                 if (sc->cue_cdata.cue_tx_chain[i].cue_buf != NULL) {
1125                         kfree(sc->cue_cdata.cue_tx_chain[i].cue_buf, M_USBDEV);
1126                         sc->cue_cdata.cue_tx_chain[i].cue_buf = NULL;
1127                 }
1128                 if (sc->cue_cdata.cue_tx_chain[i].cue_mbuf != NULL) {
1129                         m_freem(sc->cue_cdata.cue_tx_chain[i].cue_mbuf);
1130                         sc->cue_cdata.cue_tx_chain[i].cue_mbuf = NULL;
1131                 }
1132                 if (sc->cue_cdata.cue_tx_chain[i].cue_xfer != NULL) {
1133                         usbd_free_xfer(sc->cue_cdata.cue_tx_chain[i].cue_xfer);
1134                         sc->cue_cdata.cue_tx_chain[i].cue_xfer = NULL;
1135                 }
1136         }
1137
1138         ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
1139         CUE_UNLOCK(sc);
1140
1141         return;
1142 }
1143
1144 /*
1145  * Stop all chip I/O so that the kernel's probe routines don't
1146  * get confused by errant DMAs when rebooting.
1147  */
1148 static void
1149 cue_shutdown(device_t dev)
1150 {
1151         struct cue_softc        *sc;
1152
1153         sc = device_get_softc(dev);
1154
1155         CUE_LOCK(sc);
1156         cue_reset(sc);
1157         cue_stop(sc);
1158         CUE_UNLOCK(sc);
1159
1160         return;
1161 }