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