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