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