Merge from vendor branch LESS:
[dragonfly.git] / 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.9 2004/04/07 05:45:27 dillon 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 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
390                 h = cue_mchash(ifp->if_broadcastaddr);
391 #else
392                 h = cue_mchash(etherbroadcastaddr);
393 #endif
394                 sc->cue_mctab[h >> 3] |= 1 << (h & 0x7);
395         }
396
397         cue_mem(sc, CUE_CMD_WRITESRAM, CUE_MCAST_TABLE_ADDR,
398             &sc->cue_mctab, CUE_MCAST_TABLE_LEN);
399
400         return;
401 }
402
403 Static void
404 cue_reset(struct cue_softc *sc)
405 {
406         usb_device_request_t    req;
407         usbd_status             err;
408
409         if (sc->cue_dying)
410                 return;
411
412         req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
413         req.bRequest = CUE_CMD_RESET;
414         USETW(req.wValue, 0);
415         USETW(req.wIndex, 0);
416         USETW(req.wLength, 0);
417         err = usbd_do_request(sc->cue_udev, &req, NULL);
418         if (err)
419                 printf("cue%d: reset failed\n", sc->cue_unit);
420
421         /* Wait a little while for the chip to get its brains in order. */
422         DELAY(1000);
423         return;
424 }
425
426 /*
427  * Probe for a Pegasus chip.
428  */
429 USB_MATCH(cue)
430 {
431         USB_MATCH_START(cue, uaa);
432         struct cue_type                 *t;
433
434         if (!uaa->iface)
435                 return(UMATCH_NONE);
436
437         t = cue_devs;
438         while(t->cue_vid) {
439                 if (uaa->vendor == t->cue_vid &&
440                     uaa->product == t->cue_did) {
441                         return(UMATCH_VENDOR_PRODUCT);
442                 }
443                 t++;
444         }
445
446         return(UMATCH_NONE);
447 }
448
449 /*
450  * Attach the interface. Allocate softc structures, do ifmedia
451  * setup and ethernet/BPF attach.
452  */
453 USB_ATTACH(cue)
454 {
455         USB_ATTACH_START(cue, sc, uaa);
456         char                    devinfo[1024];
457         u_char                  eaddr[ETHER_ADDR_LEN];
458         struct ifnet            *ifp;
459         usb_interface_descriptor_t      *id;
460         usb_endpoint_descriptor_t       *ed;
461         int                     i;
462
463         bzero(sc, sizeof(struct cue_softc));
464         sc->cue_iface = uaa->iface;
465         sc->cue_udev = uaa->device;
466         sc->cue_unit = device_get_unit(self);
467
468         if (usbd_set_config_no(sc->cue_udev, CUE_CONFIG_NO, 0)) {
469                 printf("cue%d: getting interface handle failed\n",
470                     sc->cue_unit);
471                 USB_ATTACH_ERROR_RETURN;
472         }
473
474         id = usbd_get_interface_descriptor(uaa->iface);
475
476         usbd_devinfo(uaa->device, 0, devinfo);
477         device_set_desc_copy(self, devinfo);
478         printf("%s: %s\n", USBDEVNAME(self), devinfo);
479
480         /* Find endpoints. */
481         for (i = 0; i < id->bNumEndpoints; i++) {
482                 ed = usbd_interface2endpoint_descriptor(uaa->iface, i);
483                 if (!ed) {
484                         printf("cue%d: couldn't get ep %d\n",
485                             sc->cue_unit, i);
486                         USB_ATTACH_ERROR_RETURN;
487                 }
488                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
489                     UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
490                         sc->cue_ed[CUE_ENDPT_RX] = ed->bEndpointAddress;
491                 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
492                            UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
493                         sc->cue_ed[CUE_ENDPT_TX] = ed->bEndpointAddress;
494                 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
495                            UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
496                         sc->cue_ed[CUE_ENDPT_INTR] = ed->bEndpointAddress;
497                 }
498         }
499
500 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
501         mtx_init(&sc->cue_mtx, device_get_nameunit(self), MTX_NETWORK_LOCK,
502             MTX_DEF | MTX_RECURSE);
503 #endif
504         CUE_LOCK(sc);
505
506 #ifdef notdef
507         /* Reset the adapter. */
508         cue_reset(sc);
509 #endif
510         /*
511          * Get station address.
512          */
513         cue_getmac(sc, &eaddr);
514
515         /*
516          * A CATC chip was detected. Inform the world.
517          */
518         printf("cue%d: Ethernet address: %6D\n", sc->cue_unit, eaddr, ":");
519
520         bcopy(eaddr, (char *)&sc->arpcom.ac_enaddr, ETHER_ADDR_LEN);
521
522         ifp = &sc->arpcom.ac_if;
523         ifp->if_softc = sc;
524         if_initname(ifp, "cue", sc->cue_unit);
525         ifp->if_mtu = ETHERMTU;
526         ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
527         ifp->if_ioctl = cue_ioctl;
528         ifp->if_output = ether_output;
529         ifp->if_start = cue_start;
530         ifp->if_watchdog = cue_watchdog;
531         ifp->if_init = cue_init;
532         ifp->if_baudrate = 10000000;
533         ifp->if_snd.ifq_maxlen = IFQ_MAXLEN;
534
535         cue_qdat.ifp = ifp;
536         cue_qdat.if_rxstart = cue_rxstart;
537
538         /*
539          * Call MI attach routine.
540          */
541         ether_ifattach(ifp, eaddr);
542         callout_handle_init(&sc->cue_stat_ch);
543         usb_register_netisr();
544         sc->cue_dying = 0;
545
546         CUE_UNLOCK(sc);
547         USB_ATTACH_SUCCESS_RETURN;
548 }
549
550 Static int
551 cue_detach(device_ptr_t dev)
552 {
553         struct cue_softc        *sc;
554         struct ifnet            *ifp;
555
556         sc = device_get_softc(dev);
557         CUE_LOCK(sc);
558         ifp = &sc->arpcom.ac_if;
559
560         sc->cue_dying = 1;
561         untimeout(cue_tick, sc, sc->cue_stat_ch);
562         ether_ifdetach(ifp);
563
564         if (sc->cue_ep[CUE_ENDPT_TX] != NULL)
565                 usbd_abort_pipe(sc->cue_ep[CUE_ENDPT_TX]);
566         if (sc->cue_ep[CUE_ENDPT_RX] != NULL)
567                 usbd_abort_pipe(sc->cue_ep[CUE_ENDPT_RX]);
568         if (sc->cue_ep[CUE_ENDPT_INTR] != NULL)
569                 usbd_abort_pipe(sc->cue_ep[CUE_ENDPT_INTR]);
570
571         CUE_UNLOCK(sc);
572 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
573         mtx_destroy(&sc->cue_mtx);
574 #endif
575
576         return(0);
577 }
578
579 /*
580  * Initialize an RX descriptor and attach an MBUF cluster.
581  */
582 Static int
583 cue_newbuf(struct cue_softc *sc, struct cue_chain *c, struct mbuf *m)
584 {
585         struct mbuf             *m_new = NULL;
586
587         if (m == NULL) {
588                 MGETHDR(m_new, M_DONTWAIT, MT_DATA);
589                 if (m_new == NULL) {
590                         printf("cue%d: no memory for rx list "
591                             "-- packet dropped!\n", sc->cue_unit);
592                         return(ENOBUFS);
593                 }
594
595                 MCLGET(m_new, M_DONTWAIT);
596                 if (!(m_new->m_flags & M_EXT)) {
597                         printf("cue%d: no memory for rx list "
598                             "-- packet dropped!\n", sc->cue_unit);
599                         m_freem(m_new);
600                         return(ENOBUFS);
601                 }
602                 m_new->m_len = m_new->m_pkthdr.len = MCLBYTES;
603         } else {
604                 m_new = m;
605                 m_new->m_len = m_new->m_pkthdr.len = MCLBYTES;
606                 m_new->m_data = m_new->m_ext.ext_buf;
607         }
608
609         m_adj(m_new, ETHER_ALIGN);
610         c->cue_mbuf = m_new;
611
612         return(0);
613 }
614
615 Static int
616 cue_rx_list_init(struct cue_softc *sc)
617 {
618         struct cue_cdata        *cd;
619         struct cue_chain        *c;
620         int                     i;
621
622         cd = &sc->cue_cdata;
623         for (i = 0; i < CUE_RX_LIST_CNT; i++) {
624                 c = &cd->cue_rx_chain[i];
625                 c->cue_sc = sc;
626                 c->cue_idx = i;
627                 if (cue_newbuf(sc, c, NULL) == ENOBUFS)
628                         return(ENOBUFS);
629                 if (c->cue_xfer == NULL) {
630                         c->cue_xfer = usbd_alloc_xfer(sc->cue_udev);
631                         if (c->cue_xfer == NULL)
632                                 return(ENOBUFS);
633                 }
634         }
635
636         return(0);
637 }
638
639 Static int
640 cue_tx_list_init(struct cue_softc *sc)
641 {
642         struct cue_cdata        *cd;
643         struct cue_chain        *c;
644         int                     i;
645
646         cd = &sc->cue_cdata;
647         for (i = 0; i < CUE_TX_LIST_CNT; i++) {
648                 c = &cd->cue_tx_chain[i];
649                 c->cue_sc = sc;
650                 c->cue_idx = i;
651                 c->cue_mbuf = NULL;
652                 if (c->cue_xfer == NULL) {
653                         c->cue_xfer = usbd_alloc_xfer(sc->cue_udev);
654                         if (c->cue_xfer == NULL)
655                                 return(ENOBUFS);
656                 }
657                 c->cue_buf = malloc(CUE_BUFSZ, M_USBDEV, M_WAITOK);
658         }
659
660         return(0);
661 }
662
663 Static void
664 cue_rxstart(struct ifnet *ifp)
665 {
666         struct cue_softc        *sc;
667         struct cue_chain        *c;
668
669         sc = ifp->if_softc;
670         CUE_LOCK(sc);
671         c = &sc->cue_cdata.cue_rx_chain[sc->cue_cdata.cue_rx_prod];
672
673         if (cue_newbuf(sc, c, NULL) == ENOBUFS) {
674                 ifp->if_ierrors++;
675                 CUE_UNLOCK(sc);
676                 return;
677         }
678
679         /* Setup new transfer. */
680         usbd_setup_xfer(c->cue_xfer, sc->cue_ep[CUE_ENDPT_RX],
681             c, mtod(c->cue_mbuf, char *), CUE_BUFSZ, USBD_SHORT_XFER_OK,
682             USBD_NO_TIMEOUT, cue_rxeof);
683         usbd_transfer(c->cue_xfer);
684         CUE_UNLOCK(sc);
685
686         return;
687 }
688
689 /*
690  * A frame has been uploaded: pass the resulting mbuf chain up to
691  * the higher level protocols.
692  */
693 Static void
694 cue_rxeof(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
695 {
696         struct cue_softc        *sc;
697         struct cue_chain        *c;
698         struct mbuf             *m;
699         struct ifnet            *ifp;
700         int                     total_len = 0;
701         u_int16_t               len;
702
703         c = priv;
704         sc = c->cue_sc;
705         CUE_LOCK(sc);
706         ifp = &sc->arpcom.ac_if;
707
708         if (!(ifp->if_flags & IFF_RUNNING)) {
709                 CUE_UNLOCK(sc);
710                 return;
711         }
712
713         if (status != USBD_NORMAL_COMPLETION) {
714                 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) {
715                         CUE_UNLOCK(sc);
716                         return;
717                 }
718                 if (usbd_ratecheck(&sc->cue_rx_notice))
719                         printf("cue%d: usb error on rx: %s\n", sc->cue_unit,
720                             usbd_errstr(status));
721                 if (status == USBD_STALLED)
722                         usbd_clear_endpoint_stall(sc->cue_ep[CUE_ENDPT_RX]);
723                 goto done;
724         }
725
726         usbd_get_xfer_status(xfer, NULL, NULL, &total_len, NULL);
727
728         m = c->cue_mbuf;
729         len = *mtod(m, u_int16_t *);
730
731         /* No errors; receive the packet. */
732         total_len = len;
733
734         if (len < sizeof(struct ether_header)) {
735                 ifp->if_ierrors++;
736                 goto done;
737         }
738
739         ifp->if_ipackets++;
740         m_adj(m, sizeof(u_int16_t));
741         m->m_pkthdr.rcvif = (struct ifnet *)&cue_qdat;
742         m->m_pkthdr.len = m->m_len = total_len;
743
744         /* Put the packet on the special USB input queue. */
745         usb_ether_input(m);
746         CUE_UNLOCK(sc);
747
748         return;
749 done:
750         /* Setup new transfer. */
751         usbd_setup_xfer(c->cue_xfer, sc->cue_ep[CUE_ENDPT_RX],
752             c, mtod(c->cue_mbuf, char *), CUE_BUFSZ, USBD_SHORT_XFER_OK,
753             USBD_NO_TIMEOUT, cue_rxeof);
754         usbd_transfer(c->cue_xfer);
755         CUE_UNLOCK(sc);
756
757         return;
758 }
759
760 /*
761  * A frame was downloaded to the chip. It's safe for us to clean up
762  * the list buffers.
763  */
764
765 Static void
766 cue_txeof(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
767 {
768         struct cue_softc        *sc;
769         struct cue_chain        *c;
770         struct ifnet            *ifp;
771         usbd_status             err;
772
773         c = priv;
774         sc = c->cue_sc;
775         CUE_LOCK(sc);
776         ifp = &sc->arpcom.ac_if;
777
778         if (status != USBD_NORMAL_COMPLETION) {
779                 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) {
780                         CUE_UNLOCK(sc);
781                         return;
782                 }
783                 printf("cue%d: usb error on tx: %s\n", sc->cue_unit,
784                     usbd_errstr(status));
785                 if (status == USBD_STALLED)
786                         usbd_clear_endpoint_stall(sc->cue_ep[CUE_ENDPT_TX]);
787                 CUE_UNLOCK(sc);
788                 return;
789         }
790
791         ifp->if_timer = 0;
792         ifp->if_flags &= ~IFF_OACTIVE;
793         usbd_get_xfer_status(c->cue_xfer, NULL, NULL, NULL, &err);
794
795         if (c->cue_mbuf != NULL) {
796                 c->cue_mbuf->m_pkthdr.rcvif = ifp;
797                 usb_tx_done(c->cue_mbuf);
798                 c->cue_mbuf = NULL;
799         }
800
801         if (err)
802                 ifp->if_oerrors++;
803         else
804                 ifp->if_opackets++;
805
806         CUE_UNLOCK(sc);
807
808         return;
809 }
810
811 Static void
812 cue_tick(void *xsc)
813 {
814         struct cue_softc        *sc;
815         struct ifnet            *ifp;
816
817         sc = xsc;
818
819         if (sc == NULL)
820                 return;
821
822         CUE_LOCK(sc);
823
824         ifp = &sc->arpcom.ac_if;
825
826         ifp->if_collisions += cue_csr_read_2(sc, CUE_TX_SINGLECOLL);
827         ifp->if_collisions += cue_csr_read_2(sc, CUE_TX_MULTICOLL);
828         ifp->if_collisions += cue_csr_read_2(sc, CUE_TX_EXCESSCOLL);
829
830         if (cue_csr_read_2(sc, CUE_RX_FRAMEERR))
831                 ifp->if_ierrors++;
832
833         sc->cue_stat_ch = timeout(cue_tick, sc, hz);
834
835         CUE_UNLOCK(sc);
836
837         return;
838 }
839
840 Static int
841 cue_encap(struct cue_softc *sc, struct mbuf *m, int idx)
842 {
843         int                     total_len;
844         struct cue_chain        *c;
845         usbd_status             err;
846
847         c = &sc->cue_cdata.cue_tx_chain[idx];
848
849         /*
850          * Copy the mbuf data into a contiguous buffer, leaving two
851          * bytes at the beginning to hold the frame length.
852          */
853         m_copydata(m, 0, m->m_pkthdr.len, c->cue_buf + 2);
854         c->cue_mbuf = m;
855
856         total_len = m->m_pkthdr.len + 2;
857
858         /* The first two bytes are the frame length */
859         c->cue_buf[0] = (u_int8_t)m->m_pkthdr.len;
860         c->cue_buf[1] = (u_int8_t)(m->m_pkthdr.len >> 8);
861
862         usbd_setup_xfer(c->cue_xfer, sc->cue_ep[CUE_ENDPT_TX],
863             c, c->cue_buf, total_len, 0, 10000, cue_txeof);
864
865         /* Transmit */
866         err = usbd_transfer(c->cue_xfer);
867         if (err != USBD_IN_PROGRESS) {
868                 cue_stop(sc);
869                 return(EIO);
870         }
871
872         sc->cue_cdata.cue_tx_cnt++;
873
874         return(0);
875 }
876
877 Static void
878 cue_start(struct ifnet *ifp)
879 {
880         struct cue_softc        *sc;
881         struct mbuf             *m_head = NULL;
882
883         sc = ifp->if_softc;
884         CUE_LOCK(sc);
885
886         if (ifp->if_flags & IFF_OACTIVE) {
887                 CUE_UNLOCK(sc);
888                 return;
889         }
890
891         IF_DEQUEUE(&ifp->if_snd, m_head);
892         if (m_head == NULL) {
893                 CUE_UNLOCK(sc);
894                 return;
895         }
896
897         if (cue_encap(sc, m_head, 0)) {
898                 IF_PREPEND(&ifp->if_snd, m_head);
899                 ifp->if_flags |= IFF_OACTIVE;
900                 CUE_UNLOCK(sc);
901                 return;
902         }
903
904         /*
905          * If there's a BPF listener, bounce a copy of this frame
906          * to him.
907          */
908         BPF_MTAP(ifp, m_head);
909
910         ifp->if_flags |= IFF_OACTIVE;
911
912         /*
913          * Set a timeout in case the chip goes out to lunch.
914          */
915         ifp->if_timer = 5;
916         CUE_UNLOCK(sc);
917
918         return;
919 }
920
921 Static void
922 cue_init(void *xsc)
923 {
924         struct cue_softc        *sc = xsc;
925         struct ifnet            *ifp = &sc->arpcom.ac_if;
926         struct cue_chain        *c;
927         usbd_status             err;
928         int                     i;
929
930         if (ifp->if_flags & IFF_RUNNING)
931                 return;
932
933         CUE_LOCK(sc);
934
935         /*
936          * Cancel pending I/O and free all RX/TX buffers.
937          */
938 #ifdef foo
939         cue_reset(sc);
940 #endif
941
942         /* Set MAC address */
943         for (i = 0; i < ETHER_ADDR_LEN; i++)
944                 cue_csr_write_1(sc, CUE_PAR0 - i, sc->arpcom.ac_enaddr[i]);
945
946         /* Enable RX logic. */
947         cue_csr_write_1(sc, CUE_ETHCTL, CUE_ETHCTL_RX_ON|CUE_ETHCTL_MCAST_ON);
948
949          /* If we want promiscuous mode, set the allframes bit. */
950         if (ifp->if_flags & IFF_PROMISC) {
951                 CUE_SETBIT(sc, CUE_ETHCTL, CUE_ETHCTL_PROMISC);
952         } else {
953                 CUE_CLRBIT(sc, CUE_ETHCTL, CUE_ETHCTL_PROMISC);
954         }
955
956         /* Init TX ring. */
957         if (cue_tx_list_init(sc) == ENOBUFS) {
958                 printf("cue%d: tx list init failed\n", sc->cue_unit);
959                 CUE_UNLOCK(sc);
960                 return;
961         }
962
963         /* Init RX ring. */
964         if (cue_rx_list_init(sc) == ENOBUFS) {
965                 printf("cue%d: rx list init failed\n", sc->cue_unit);
966                 CUE_UNLOCK(sc);
967                 return;
968         }
969
970         /* Load the multicast filter. */
971         cue_setmulti(sc);
972
973         /*
974          * Set the number of RX and TX buffers that we want
975          * to reserve inside the ASIC.
976          */
977         cue_csr_write_1(sc, CUE_RX_BUFPKTS, CUE_RX_FRAMES);
978         cue_csr_write_1(sc, CUE_TX_BUFPKTS, CUE_TX_FRAMES);
979
980         /* Set advanced operation modes. */
981         cue_csr_write_1(sc, CUE_ADVANCED_OPMODES,
982             CUE_AOP_EMBED_RXLEN|0x01); /* 1 wait state */
983
984         /* Program the LED operation. */
985         cue_csr_write_1(sc, CUE_LEDCTL, CUE_LEDCTL_FOLLOW_LINK);
986
987         /* Open RX and TX pipes. */
988         err = usbd_open_pipe(sc->cue_iface, sc->cue_ed[CUE_ENDPT_RX],
989             USBD_EXCLUSIVE_USE, &sc->cue_ep[CUE_ENDPT_RX]);
990         if (err) {
991                 printf("cue%d: open rx pipe failed: %s\n",
992                     sc->cue_unit, usbd_errstr(err));
993                 CUE_UNLOCK(sc);
994                 return;
995         }
996         err = usbd_open_pipe(sc->cue_iface, sc->cue_ed[CUE_ENDPT_TX],
997             USBD_EXCLUSIVE_USE, &sc->cue_ep[CUE_ENDPT_TX]);
998         if (err) {
999                 printf("cue%d: open tx pipe failed: %s\n",
1000                     sc->cue_unit, usbd_errstr(err));
1001                 CUE_UNLOCK(sc);
1002                 return;
1003         }
1004
1005         /* Start up the receive pipe. */
1006         for (i = 0; i < CUE_RX_LIST_CNT; i++) {
1007                 c = &sc->cue_cdata.cue_rx_chain[i];
1008                 usbd_setup_xfer(c->cue_xfer, sc->cue_ep[CUE_ENDPT_RX],
1009                     c, mtod(c->cue_mbuf, char *), CUE_BUFSZ,
1010                     USBD_SHORT_XFER_OK, USBD_NO_TIMEOUT, cue_rxeof);
1011                 usbd_transfer(c->cue_xfer);
1012         }
1013
1014         ifp->if_flags |= IFF_RUNNING;
1015         ifp->if_flags &= ~IFF_OACTIVE;
1016
1017         CUE_UNLOCK(sc);
1018
1019         sc->cue_stat_ch = timeout(cue_tick, sc, hz);
1020
1021         return;
1022 }
1023
1024 Static int
1025 cue_ioctl(struct ifnet *ifp, u_long command, caddr_t data, struct ucred *cr)
1026 {
1027         struct cue_softc        *sc = ifp->if_softc;
1028         int                     error = 0;
1029
1030         CUE_LOCK(sc);
1031
1032         switch(command) {
1033         case SIOCSIFFLAGS:
1034                 if (ifp->if_flags & IFF_UP) {
1035                         if (ifp->if_flags & IFF_RUNNING &&
1036                             ifp->if_flags & IFF_PROMISC &&
1037                             !(sc->cue_if_flags & IFF_PROMISC)) {
1038                                 CUE_SETBIT(sc, CUE_ETHCTL, CUE_ETHCTL_PROMISC);
1039                                 cue_setmulti(sc);
1040                         } else if (ifp->if_flags & IFF_RUNNING &&
1041                             !(ifp->if_flags & IFF_PROMISC) &&
1042                             sc->cue_if_flags & IFF_PROMISC) {
1043                                 CUE_CLRBIT(sc, CUE_ETHCTL, CUE_ETHCTL_PROMISC);
1044                                 cue_setmulti(sc);
1045                         } else if (!(ifp->if_flags & IFF_RUNNING))
1046                                 cue_init(sc);
1047                 } else {
1048                         if (ifp->if_flags & IFF_RUNNING)
1049                                 cue_stop(sc);
1050                 }
1051                 sc->cue_if_flags = ifp->if_flags;
1052                 error = 0;
1053                 break;
1054         case SIOCADDMULTI:
1055         case SIOCDELMULTI:
1056                 cue_setmulti(sc);
1057                 error = 0;
1058                 break;
1059         default:
1060                 error = ether_ioctl(ifp, command, data);
1061                 break;
1062         }
1063
1064         CUE_UNLOCK(sc);
1065
1066         return(error);
1067 }
1068
1069 Static void
1070 cue_watchdog(struct ifnet *ifp)
1071 {
1072         struct cue_softc        *sc;
1073         struct cue_chain        *c;
1074         usbd_status             stat;
1075
1076         sc = ifp->if_softc;
1077         CUE_LOCK(sc);
1078
1079         ifp->if_oerrors++;
1080         printf("cue%d: watchdog timeout\n", sc->cue_unit);
1081
1082         c = &sc->cue_cdata.cue_tx_chain[0];
1083         usbd_get_xfer_status(c->cue_xfer, NULL, NULL, NULL, &stat);
1084         cue_txeof(c->cue_xfer, c, stat);
1085
1086         if (ifp->if_snd.ifq_head != NULL)
1087                 cue_start(ifp);
1088         CUE_UNLOCK(sc);
1089
1090         return;
1091 }
1092
1093 /*
1094  * Stop the adapter and free any mbufs allocated to the
1095  * RX and TX lists.
1096  */
1097 Static void
1098 cue_stop(struct cue_softc *sc)
1099 {
1100         usbd_status             err;
1101         struct ifnet            *ifp;
1102         int                     i;
1103
1104         CUE_LOCK(sc);
1105
1106         ifp = &sc->arpcom.ac_if;
1107         ifp->if_timer = 0;
1108
1109         cue_csr_write_1(sc, CUE_ETHCTL, 0);
1110         cue_reset(sc);
1111         untimeout(cue_tick, sc, sc->cue_stat_ch);
1112
1113         /* Stop transfers. */
1114         if (sc->cue_ep[CUE_ENDPT_RX] != NULL) {
1115                 err = usbd_abort_pipe(sc->cue_ep[CUE_ENDPT_RX]);
1116                 if (err) {
1117                         printf("cue%d: abort rx pipe failed: %s\n",
1118                         sc->cue_unit, usbd_errstr(err));
1119                 }
1120                 err = usbd_close_pipe(sc->cue_ep[CUE_ENDPT_RX]);
1121                 if (err) {
1122                         printf("cue%d: close rx pipe failed: %s\n",
1123                         sc->cue_unit, usbd_errstr(err));
1124                 }
1125                 sc->cue_ep[CUE_ENDPT_RX] = NULL;
1126         }
1127
1128         if (sc->cue_ep[CUE_ENDPT_TX] != NULL) {
1129                 err = usbd_abort_pipe(sc->cue_ep[CUE_ENDPT_TX]);
1130                 if (err) {
1131                         printf("cue%d: abort tx pipe failed: %s\n",
1132                         sc->cue_unit, usbd_errstr(err));
1133                 }
1134                 err = usbd_close_pipe(sc->cue_ep[CUE_ENDPT_TX]);
1135                 if (err) {
1136                         printf("cue%d: close tx pipe failed: %s\n",
1137                             sc->cue_unit, usbd_errstr(err));
1138                 }
1139                 sc->cue_ep[CUE_ENDPT_TX] = NULL;
1140         }
1141
1142         if (sc->cue_ep[CUE_ENDPT_INTR] != NULL) {
1143                 err = usbd_abort_pipe(sc->cue_ep[CUE_ENDPT_INTR]);
1144                 if (err) {
1145                         printf("cue%d: abort intr pipe failed: %s\n",
1146                         sc->cue_unit, usbd_errstr(err));
1147                 }
1148                 err = usbd_close_pipe(sc->cue_ep[CUE_ENDPT_INTR]);
1149                 if (err) {
1150                         printf("cue%d: close intr pipe failed: %s\n",
1151                             sc->cue_unit, usbd_errstr(err));
1152                 }
1153                 sc->cue_ep[CUE_ENDPT_INTR] = NULL;
1154         }
1155
1156         /* Free RX resources. */
1157         for (i = 0; i < CUE_RX_LIST_CNT; i++) {
1158                 if (sc->cue_cdata.cue_rx_chain[i].cue_buf != NULL) {
1159                         free(sc->cue_cdata.cue_rx_chain[i].cue_buf, M_USBDEV);
1160                         sc->cue_cdata.cue_rx_chain[i].cue_buf = NULL;
1161                 }
1162                 if (sc->cue_cdata.cue_rx_chain[i].cue_mbuf != NULL) {
1163                         m_freem(sc->cue_cdata.cue_rx_chain[i].cue_mbuf);
1164                         sc->cue_cdata.cue_rx_chain[i].cue_mbuf = NULL;
1165                 }
1166                 if (sc->cue_cdata.cue_rx_chain[i].cue_xfer != NULL) {
1167                         usbd_free_xfer(sc->cue_cdata.cue_rx_chain[i].cue_xfer);
1168                         sc->cue_cdata.cue_rx_chain[i].cue_xfer = NULL;
1169                 }
1170         }
1171
1172         /* Free TX resources. */
1173         for (i = 0; i < CUE_TX_LIST_CNT; i++) {
1174                 if (sc->cue_cdata.cue_tx_chain[i].cue_buf != NULL) {
1175                         free(sc->cue_cdata.cue_tx_chain[i].cue_buf, M_USBDEV);
1176                         sc->cue_cdata.cue_tx_chain[i].cue_buf = NULL;
1177                 }
1178                 if (sc->cue_cdata.cue_tx_chain[i].cue_mbuf != NULL) {
1179                         m_freem(sc->cue_cdata.cue_tx_chain[i].cue_mbuf);
1180                         sc->cue_cdata.cue_tx_chain[i].cue_mbuf = NULL;
1181                 }
1182                 if (sc->cue_cdata.cue_tx_chain[i].cue_xfer != NULL) {
1183                         usbd_free_xfer(sc->cue_cdata.cue_tx_chain[i].cue_xfer);
1184                         sc->cue_cdata.cue_tx_chain[i].cue_xfer = NULL;
1185                 }
1186         }
1187
1188         ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
1189         CUE_UNLOCK(sc);
1190
1191         return;
1192 }
1193
1194 /*
1195  * Stop all chip I/O so that the kernel's probe routines don't
1196  * get confused by errant DMAs when rebooting.
1197  */
1198 Static void
1199 cue_shutdown(device_ptr_t dev)
1200 {
1201         struct cue_softc        *sc;
1202
1203         sc = device_get_softc(dev);
1204
1205         CUE_LOCK(sc);
1206         cue_reset(sc);
1207         cue_stop(sc);
1208         CUE_UNLOCK(sc);
1209
1210         return;
1211 }