5ef859aefca1fb259fe7284da1c5eb6a1395b94c
[dragonfly.git] / sys / dev / netif / axe / if_axe.c
1 /*
2  * Copyright (c) 1997, 1998, 1999, 2000-2003
3  *      Bill Paul <wpaul@windriver.com>.  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_axe.c,v 1.10 2003/12/08 07:54:14 obrien Exp $
33  * $DragonFly: src/sys/dev/netif/axe/if_axe.c,v 1.26 2007/11/06 07:37:00 hasso Exp $
34  */
35 /*
36  * ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
37  * LinkSys USB200M and various other adapters.
38  *
39  * Manuals available from:
40  * http://www.asix.com.tw/datasheet/mac/Ax88172.PDF
41  * Note: you need the manual for the AX88170 chip (USB 1.x ethernet
42  * controller) to find the definitions for the RX control register.
43  * http://www.asix.com.tw/datasheet/mac/Ax88170.PDF
44  *
45  * Written by Bill Paul <wpaul@windriver.com>
46  * Senior Engineer
47  * Wind River Systems
48  */
49
50 /*
51  * The AX88172 provides USB ethernet supports at 10 and 100Mbps.
52  * It uses an external PHY (reference designs use a RealTek chip),
53  * and has a 64-bit multicast hash filter. There is some information
54  * missing from the manual which one needs to know in order to make
55  * the chip function:
56  *
57  * - You must set bit 7 in the RX control register, otherwise the
58  *   chip won't receive any packets.
59  * - You must initialize all 3 IPG registers, or you won't be able
60  *   to send any packets.
61  *
62  * Note that this device appears to only support loading the station
63  * address via autload from the EEPROM (i.e. there's no way to manaully
64  * set it).
65  *
66  * (Adam Weinberger wanted me to name this driver if_gir.c.)
67  */
68
69 #include <sys/param.h>
70 #include <sys/systm.h>
71 #include <sys/sockio.h>
72 #include <sys/mbuf.h>
73 #include <sys/malloc.h>
74 #include <sys/kernel.h>
75 #include <sys/socket.h>
76 #include <sys/bus.h>
77 #include <sys/thread2.h>
78
79 #include <net/if.h>
80 #include <net/ifq_var.h>
81 #include <net/if_arp.h>
82 #include <net/ethernet.h>
83 #include <net/if_dl.h>
84 #include <net/if_media.h>
85
86 #include <net/bpf.h>
87
88 #include <bus/usb/usb.h>
89 #include <bus/usb/usbdi.h>
90 #include <bus/usb/usbdi_util.h>
91 #include <bus/usb/usbdivar.h>
92 #include <bus/usb/usb_ethersubr.h>
93
94 #include "../mii_layer//mii.h"
95 #include "../mii_layer/miivar.h"
96
97 /* "controller miibus0" required.  See GENERIC if you get errors here. */
98 #include "miibus_if.h"
99
100 #include "if_axereg.h"
101
102 /*
103  * Various supported device vendors/products.
104  */
105 static struct usb_devno axe_devs[] = {
106         { USB_DEVICE(0x0411, 0x003d) }, /* Melco LUA-U2-KTX */
107         { USB_DEVICE(0x04f1, 0x3008) }, /* JVC MP-PRX1 */
108         { USB_DEVICE(0x077b, 0x2226) }, /* Linksys USB200M */
109         { USB_DEVICE(0x0846, 0x1040) }, /* BayNETGEAR FA120 */
110         { USB_DEVICE(0x086e, 0x1920) }, /* System Talks SGC-X2UL */
111         { USB_DEVICE(0x0b95, 0x1720) }, /* ASIX Electronics AX88172 */
112         { USB_DEVICE(0x2001, 0x1a00) }, /* D-Link DUBE100 */
113         { USB_DEVICE(0x6189, 0x182d) }, /* Sitecom LN029 */
114 };
115
116 static int axe_match(device_t);
117 static int axe_attach(device_t);
118 static int axe_detach(device_t);
119
120 static int axe_tx_list_init(struct axe_softc *);
121 static int axe_rx_list_init(struct axe_softc *);
122 static int axe_newbuf(struct axe_softc *, struct axe_chain *, struct mbuf *);
123 static int axe_encap(struct axe_softc *, struct mbuf *, int);
124 static void axe_rxeof(usbd_xfer_handle, usbd_private_handle, usbd_status);
125 static void axe_txeof(usbd_xfer_handle, usbd_private_handle, usbd_status);
126 static void axe_tick(void *);
127 static void axe_rxstart(struct ifnet *);
128 static void axe_start(struct ifnet *);
129 static int axe_ioctl(struct ifnet *, u_long, caddr_t, struct ucred *);
130 static void axe_init(void *);
131 static void axe_stop(struct axe_softc *);
132 static void axe_watchdog(struct ifnet *);
133 static void axe_shutdown(device_t);
134 static int axe_miibus_readreg(device_t, int, int);
135 static int axe_miibus_writereg(device_t, int, int, int);
136 static void axe_miibus_statchg(device_t);
137 static int axe_cmd(struct axe_softc *, int, int, int, void *);
138 static int axe_ifmedia_upd(struct ifnet *);
139 static void axe_ifmedia_sts(struct ifnet *, struct ifmediareq *);
140
141 static void axe_setmulti(struct axe_softc *);
142
143 static device_method_t axe_methods[] = {
144         /* Device interface */
145         DEVMETHOD(device_probe,         axe_match),
146         DEVMETHOD(device_attach,        axe_attach),
147         DEVMETHOD(device_detach,        axe_detach),
148         DEVMETHOD(device_shutdown,      axe_shutdown),
149
150         /* bus interface */
151         DEVMETHOD(bus_print_child,      bus_generic_print_child),
152         DEVMETHOD(bus_driver_added,     bus_generic_driver_added),
153
154         /* MII interface */
155         DEVMETHOD(miibus_readreg,       axe_miibus_readreg),
156         DEVMETHOD(miibus_writereg,      axe_miibus_writereg),
157         DEVMETHOD(miibus_statchg,       axe_miibus_statchg),
158
159         { 0, 0 }
160 };
161
162 static driver_t axe_driver = {
163         "axe",
164         axe_methods,
165         sizeof(struct axe_softc)
166 };
167
168 static devclass_t axe_devclass;
169
170 DRIVER_MODULE(axe, uhub, axe_driver, axe_devclass, usbd_driver_load, 0);
171 DRIVER_MODULE(miibus, axe, miibus_driver, miibus_devclass, 0, 0);
172 MODULE_DEPEND(axe, usb, 1, 1, 1);
173 MODULE_DEPEND(axe, miibus, 1, 1, 1);
174
175 static int
176 axe_cmd(struct axe_softc *sc, int cmd, int index, int val, void *buf)
177 {
178         usb_device_request_t    req;
179         usbd_status             err;
180
181         if (sc->axe_dying)
182                 return(0);
183
184         if (AXE_CMD_DIR(cmd))
185                 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
186         else
187                 req.bmRequestType = UT_READ_VENDOR_DEVICE;
188         req.bRequest = AXE_CMD_CMD(cmd);
189         USETW(req.wValue, val);
190         USETW(req.wIndex, index);
191         USETW(req.wLength, AXE_CMD_LEN(cmd));
192
193         err = usbd_do_request(sc->axe_udev, &req, buf);
194
195         if (err)
196                 return(-1);
197
198         return(0);
199 }
200
201 static int
202 axe_miibus_readreg(device_t dev, int phy, int reg)
203 {
204         struct axe_softc        *sc = device_get_softc(dev);
205         usbd_status             err;
206         u_int16_t               val;
207
208         if (sc->axe_dying) {
209                 return(0);
210         }
211
212 #ifdef notdef
213         /*
214          * The chip tells us the MII address of any supported
215          * PHYs attached to the chip, so only read from those.
216          */
217
218         if (sc->axe_phyaddrs[0] != AXE_NOPHY && phy != sc->axe_phyaddrs[0]) {
219                 return (0);
220         }
221
222         if (sc->axe_phyaddrs[1] != AXE_NOPHY && phy != sc->axe_phyaddrs[1]) {
223                 return (0);
224         }
225 #endif
226         if (sc->axe_phyaddrs[0] != 0xFF && sc->axe_phyaddrs[0] != phy) {
227                 return (0);
228         }
229
230         axe_cmd(sc, AXE_CMD_MII_OPMODE_SW, 0, 0, NULL);
231         err = axe_cmd(sc, AXE_CMD_MII_READ_REG, reg, phy, (void *)&val);
232         axe_cmd(sc, AXE_CMD_MII_OPMODE_HW, 0, 0, NULL);
233
234         if (err) {
235                 if_printf(&sc->arpcom.ac_if, "read PHY failed\n");
236                 return(-1);
237         }
238
239         if (val)
240                 sc->axe_phyaddrs[0] = phy;
241
242         return (val);
243 }
244
245 static int
246 axe_miibus_writereg(device_t dev, int phy, int reg, int val)
247 {
248         struct axe_softc        *sc = device_get_softc(dev);
249         usbd_status             err;
250
251         if (sc->axe_dying) {
252                 return(0);
253         }
254
255         axe_cmd(sc, AXE_CMD_MII_OPMODE_SW, 0, 0, NULL);
256         err = axe_cmd(sc, AXE_CMD_MII_WRITE_REG, reg, phy, (void *)&val);
257         axe_cmd(sc, AXE_CMD_MII_OPMODE_HW, 0, 0, NULL);
258
259         if (err) {
260                 if_printf(&sc->arpcom.ac_if, "write PHY failed\n");
261                 return(-1);
262         }
263
264         return (0);
265 }
266
267 static void
268 axe_miibus_statchg(device_t dev)
269 {
270 #ifdef notdef
271         struct axe_softc        *sc = device_get_softc(dev);
272         struct mii_data         *mii = GET_MII(sc);
273 #endif
274         /* doesn't seem to be necessary */
275
276         return;
277 }
278
279 /*
280  * Set media options.
281  */
282 static int
283 axe_ifmedia_upd(struct ifnet *ifp)
284 {
285         struct axe_softc        *sc = ifp->if_softc;
286         struct mii_data         *mii = GET_MII(sc);
287
288         sc->axe_link = 0;
289         if (mii->mii_instance) {
290                 struct mii_softc        *miisc;
291                 LIST_FOREACH(miisc, &mii->mii_phys, mii_list)
292                          mii_phy_reset(miisc);
293         }
294         mii_mediachg(mii);
295
296         return (0);
297 }
298
299 /*
300  * Report current media status.
301  */
302 static void
303 axe_ifmedia_sts(struct ifnet *ifp, struct ifmediareq *ifmr)
304 {
305         struct axe_softc        *sc = ifp->if_softc;
306         struct mii_data         *mii = GET_MII(sc);
307
308         mii_pollstat(mii);
309         ifmr->ifm_active = mii->mii_media_active;
310         ifmr->ifm_status = mii->mii_media_status;
311
312         return;
313 }
314
315 static void
316 axe_setmulti(struct axe_softc *sc)
317 {
318         struct ifnet *ifp = &sc->arpcom.ac_if;
319         struct ifmultiaddr      *ifma;
320         u_int32_t               h = 0;
321         u_int16_t               rxmode;
322         u_int8_t                hashtbl[8] = { 0, 0, 0, 0, 0, 0, 0, 0 };
323
324         axe_cmd(sc, AXE_CMD_RXCTL_READ, 0, 0, (void *)&rxmode);
325
326         if (ifp->if_flags & IFF_ALLMULTI || ifp->if_flags & IFF_PROMISC) {
327                 rxmode |= AXE_RXCMD_ALLMULTI;
328                 axe_cmd(sc, AXE_CMD_RXCTL_WRITE, 0, rxmode, NULL);
329                 return;
330         } else
331                 rxmode &= ~AXE_RXCMD_ALLMULTI;
332
333         LIST_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
334                 if (ifma->ifma_addr->sa_family != AF_LINK)
335                         continue;
336                 h = ether_crc32_be(
337                         LLADDR((struct sockaddr_dl *)ifma->ifma_addr),
338                         ETHER_ADDR_LEN);
339                 /* the filter bit position */
340                 h = (h >> 26) & 0x0000003F;
341                 hashtbl[h / 8] |= 1 << (h % 8);
342         }
343
344         axe_cmd(sc, AXE_CMD_WRITE_MCAST, 0, 0, (void *)&hashtbl);
345         axe_cmd(sc, AXE_CMD_RXCTL_WRITE, 0, rxmode, NULL);
346 }
347
348 static void
349 axe_reset(struct axe_softc *sc)
350 {
351         if (sc->axe_dying)
352                 return;
353
354         if (usbd_set_config_no(sc->axe_udev, AXE_CONFIG_NO, 1) ||
355             usbd_device2interface_handle(sc->axe_udev, AXE_IFACE_IDX,
356             &sc->axe_iface)) {
357                 if_printf(&sc->arpcom.ac_if,
358                           "getting interface handle failed\n");
359         }
360
361         /* Wait a little while for the chip to get its brains in order. */
362         DELAY(1000);
363         return;
364 }
365
366 /*
367  * Probe for a AX88172 chip.
368  */
369 static int
370 axe_match(device_t self)
371 {
372         struct usb_attach_arg *uaa = device_get_ivars(self);
373
374         if (!uaa->iface)
375                 return(UMATCH_NONE);
376
377         return (usb_lookup(axe_devs, uaa->vendor, uaa->product) != NULL ?
378             UMATCH_VENDOR_PRODUCT : UMATCH_NONE);
379 }
380
381 /*
382  * Attach the interface. Allocate softc structures, do ifmedia
383  * setup and ethernet/BPF attach.
384  */
385 static int
386 axe_attach(device_t self)
387 {
388         struct axe_softc *sc = device_get_softc(self);
389         struct usb_attach_arg *uaa = device_get_ivars(self);
390         u_char                  eaddr[ETHER_ADDR_LEN];
391         struct ifnet            *ifp;
392         usb_interface_descriptor_t      *id;
393         usb_endpoint_descriptor_t       *ed;
394         int                     i;
395
396         sc->axe_udev = uaa->device;
397         callout_init(&sc->axe_stat_timer);
398
399         if (usbd_set_config_no(sc->axe_udev, AXE_CONFIG_NO, 1)) {
400                 device_printf(self, "setting config no %d failed\n",
401                     AXE_CONFIG_NO);
402                 return ENXIO;
403         }
404
405         if (usbd_device2interface_handle(uaa->device,
406             AXE_IFACE_IDX, &sc->axe_iface)) {
407                 device_printf(self, "getting interface handle failed\n");
408                 return ENXIO;
409         }
410
411         id = usbd_get_interface_descriptor(sc->axe_iface);
412
413         /* Find endpoints. */
414         for (i = 0; i < id->bNumEndpoints; i++) {
415                 ed = usbd_interface2endpoint_descriptor(sc->axe_iface, i);
416                 if (!ed) {
417                         device_printf(self, "couldn't get ep %d\n", i);
418                         return ENXIO;
419                 }
420                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
421                     UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
422                         sc->axe_ed[AXE_ENDPT_RX] = ed->bEndpointAddress;
423                 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
424                            UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
425                         sc->axe_ed[AXE_ENDPT_TX] = ed->bEndpointAddress;
426                 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
427                            UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
428                         sc->axe_ed[AXE_ENDPT_INTR] = ed->bEndpointAddress;
429                 }
430         }
431
432         /*
433          * Get station address.
434          */
435         axe_cmd(sc, AXE_CMD_READ_NODEID, 0, 0, &eaddr);
436
437         /*
438          * Load IPG values and PHY indexes.
439          */
440         axe_cmd(sc, AXE_CMD_READ_IPG012, 0, 0, (void *)&sc->axe_ipgs);
441         axe_cmd(sc, AXE_CMD_READ_PHYID, 0, 0, (void *)&sc->axe_phyaddrs);
442
443         /*
444          * Work around broken adapters that appear to lie about
445          * their PHY addresses.
446          */
447         sc->axe_phyaddrs[0] = sc->axe_phyaddrs[1] = 0xFF;
448
449         ifp = &sc->arpcom.ac_if;
450         ifp->if_softc = sc;
451         if_initname(ifp, device_get_name(self), device_get_unit(self));
452         ifp->if_mtu = ETHERMTU;
453         ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
454         ifp->if_ioctl = axe_ioctl;
455         ifp->if_start = axe_start;
456         ifp->if_watchdog = axe_watchdog;
457         ifp->if_init = axe_init;
458         ifp->if_baudrate = 10000000;
459         ifq_set_maxlen(&ifp->if_snd, IFQ_MAXLEN);
460         ifq_set_ready(&ifp->if_snd);
461
462         if (mii_phy_probe(self, &sc->axe_miibus,
463             axe_ifmedia_upd, axe_ifmedia_sts)) {
464                 device_printf(self, "MII without any PHY!\n");
465                 return ENXIO;
466         }
467
468         /*
469          * Call MI attach routine.
470          */
471
472         ether_ifattach(ifp, eaddr, NULL);
473
474         sc->axe_dying = 0;
475
476         usb_register_netisr();
477
478         return 0;
479 }
480
481 static int
482 axe_detach(device_t dev)
483 {
484         struct axe_softc *sc = device_get_softc(dev);
485         struct ifnet *ifp = &sc->arpcom.ac_if;
486
487         sc->axe_dying = 1;
488         callout_stop(&sc->axe_stat_timer);
489         ether_ifdetach(ifp);
490
491         if (sc->axe_ep[AXE_ENDPT_TX] != NULL)
492                 usbd_abort_pipe(sc->axe_ep[AXE_ENDPT_TX]);
493         if (sc->axe_ep[AXE_ENDPT_RX] != NULL)
494                 usbd_abort_pipe(sc->axe_ep[AXE_ENDPT_RX]);
495         if (sc->axe_ep[AXE_ENDPT_INTR] != NULL)
496                 usbd_abort_pipe(sc->axe_ep[AXE_ENDPT_INTR]);
497
498         return(0);
499 }
500
501 /*
502  * Initialize an RX descriptor and attach an MBUF cluster.
503  */
504 static int
505 axe_newbuf(struct axe_softc *sc, struct axe_chain *c, struct mbuf *m)
506 {
507         struct mbuf             *m_new = NULL;
508
509         if (m == NULL) {
510                 m_new = m_getcl(MB_DONTWAIT, MT_DATA, M_PKTHDR);
511                 if (m_new == NULL) {
512                         if_printf(&sc->arpcom.ac_if, "no memory for rx list "
513                             "-- packet dropped!\n");
514                         return(ENOBUFS);
515                 }
516                 m_new->m_len = m_new->m_pkthdr.len = MCLBYTES;
517         } else {
518                 m_new = m;
519                 m_new->m_len = m_new->m_pkthdr.len = MCLBYTES;
520                 m_new->m_data = m_new->m_ext.ext_buf;
521         }
522
523         m_adj(m_new, ETHER_ALIGN);
524         c->axe_mbuf = m_new;
525
526         return(0);
527 }
528
529 static int
530 axe_rx_list_init(struct axe_softc *sc)
531 {
532         struct axe_cdata        *cd;
533         struct axe_chain        *c;
534         int                     i;
535
536         cd = &sc->axe_cdata;
537         for (i = 0; i < AXE_RX_LIST_CNT; i++) {
538                 c = &cd->axe_rx_chain[i];
539                 c->axe_sc = sc;
540                 c->axe_idx = i;
541                 if (axe_newbuf(sc, c, NULL) == ENOBUFS)
542                         return(ENOBUFS);
543                 if (c->axe_xfer == NULL) {
544                         c->axe_xfer = usbd_alloc_xfer(sc->axe_udev);
545                         if (c->axe_xfer == NULL)
546                                 return(ENOBUFS);
547                 }
548         }
549
550         return(0);
551 }
552
553 static int
554 axe_tx_list_init(struct axe_softc *sc)
555 {
556         struct axe_cdata        *cd;
557         struct axe_chain        *c;
558         int                     i;
559
560         cd = &sc->axe_cdata;
561         for (i = 0; i < AXE_TX_LIST_CNT; i++) {
562                 c = &cd->axe_tx_chain[i];
563                 c->axe_sc = sc;
564                 c->axe_idx = i;
565                 c->axe_mbuf = NULL;
566                 if (c->axe_xfer == NULL) {
567                         c->axe_xfer = usbd_alloc_xfer(sc->axe_udev);
568                         if (c->axe_xfer == NULL)
569                                 return(ENOBUFS);
570                 }
571                 c->axe_buf = kmalloc(AXE_BUFSZ, M_USBDEV, M_WAITOK);
572                 if (c->axe_buf == NULL)
573                         return(ENOBUFS);
574         }
575
576         return(0);
577 }
578
579 static void
580 axe_rxstart(struct ifnet *ifp)
581 {
582         struct axe_softc *sc = ifp->if_softc;
583         struct axe_chain *c;
584
585         c = &sc->axe_cdata.axe_rx_chain[sc->axe_cdata.axe_rx_prod];
586
587         if (axe_newbuf(sc, c, NULL) == ENOBUFS) {
588                 ifp->if_ierrors++;
589                 return;
590         }
591
592         /* Setup new transfer. */
593         usbd_setup_xfer(c->axe_xfer, sc->axe_ep[AXE_ENDPT_RX],
594             c, mtod(c->axe_mbuf, char *), AXE_BUFSZ, USBD_SHORT_XFER_OK,
595             USBD_NO_TIMEOUT, axe_rxeof);
596         usbd_transfer(c->axe_xfer);
597 }
598
599 /*
600  * A frame has been uploaded: pass the resulting mbuf chain up to
601  * the higher level protocols.
602  */
603 static void
604 axe_rxeof(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
605 {
606         struct axe_chain *c = priv;
607         struct axe_softc *sc = c->axe_sc;
608         struct ifnet *ifp = &sc->arpcom.ac_if;
609         struct mbuf *m;
610         int total_len = 0;
611
612         lwkt_serialize_enter(ifp->if_serializer);
613
614         if (!(ifp->if_flags & IFF_RUNNING)) {
615                 lwkt_serialize_exit(ifp->if_serializer);
616                 return;
617         }
618
619         if (status != USBD_NORMAL_COMPLETION) {
620                 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) {
621                         lwkt_serialize_exit(ifp->if_serializer);
622                         return;
623                 }
624                 if (usbd_ratecheck(&sc->axe_rx_notice)) {
625                         if_printf(ifp, "usb error on rx: %s\n",
626                             usbd_errstr(status));
627                 }
628                 if (status == USBD_STALLED)
629                         usbd_clear_endpoint_stall(sc->axe_ep[AXE_ENDPT_RX]);
630                 goto done;
631         }
632
633         usbd_get_xfer_status(xfer, NULL, NULL, &total_len, NULL);
634
635         m = c->axe_mbuf;
636
637         if (total_len < sizeof(struct ether_header)) {
638                 ifp->if_ierrors++;
639                 goto done;
640         }
641
642         ifp->if_ipackets++;
643         m->m_pkthdr.rcvif = ifp;
644         m->m_pkthdr.len = m->m_len = total_len;
645
646         /* Put the packet on the special USB input queue. */
647         usb_ether_input(m);
648         axe_rxstart(ifp);
649         lwkt_serialize_exit(ifp->if_serializer);
650         return;
651 done:
652         /* Setup new transfer. */
653         usbd_setup_xfer(c->axe_xfer, sc->axe_ep[AXE_ENDPT_RX],
654             c, mtod(c->axe_mbuf, char *), AXE_BUFSZ, USBD_SHORT_XFER_OK,
655             USBD_NO_TIMEOUT, axe_rxeof);
656         usbd_transfer(c->axe_xfer);
657         lwkt_serialize_exit(ifp->if_serializer);
658 }
659
660 /*
661  * A frame was downloaded to the chip. It's safe for us to clean up
662  * the list buffers.
663  */
664
665 static void
666 axe_txeof(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
667 {
668         struct axe_chain *c = priv;
669         struct axe_softc *sc = c->axe_sc;
670         struct ifnet *ifp = &sc->arpcom.ac_if;
671         usbd_status err;
672
673         lwkt_serialize_enter(ifp->if_serializer);
674         if (status != USBD_NORMAL_COMPLETION) {
675                 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) {
676                         lwkt_serialize_exit(ifp->if_serializer);
677                         return;
678                 }
679                 if_printf(ifp, "usb error on tx: %s\n", usbd_errstr(status));
680                 if (status == USBD_STALLED)
681                         usbd_clear_endpoint_stall(sc->axe_ep[AXE_ENDPT_TX]);
682                 lwkt_serialize_exit(ifp->if_serializer);
683                 return;
684         }
685
686         ifp->if_timer = 0;
687         ifp->if_flags &= ~IFF_OACTIVE;
688         usbd_get_xfer_status(c->axe_xfer, NULL, NULL, NULL, &err);
689
690         if (c->axe_mbuf != NULL) {
691                 m_freem(c->axe_mbuf);
692                 c->axe_mbuf = NULL;
693         }
694
695         if (err)
696                 ifp->if_oerrors++;
697         else
698                 ifp->if_opackets++;
699
700         if (!ifq_is_empty(&ifp->if_snd))
701                 (*ifp->if_start)(ifp);
702         lwkt_serialize_exit(ifp->if_serializer);
703 }
704
705 static void
706 axe_tick(void *xsc)
707 {
708         struct axe_softc *sc = xsc;
709         struct ifnet *ifp = &sc->arpcom.ac_if;
710         struct mii_data         *mii;
711
712         mii = GET_MII(sc);
713         if (mii == NULL)
714                 return;
715
716         lwkt_serialize_enter(ifp->if_serializer);
717         mii_tick(mii);
718         if (!sc->axe_link && mii->mii_media_status & IFM_ACTIVE &&
719             IFM_SUBTYPE(mii->mii_media_active) != IFM_NONE) {
720                 sc->axe_link++;
721                 if (!ifq_is_empty(&ifp->if_snd))
722                         axe_start(ifp);
723         }
724         callout_reset(&sc->axe_stat_timer, hz, axe_tick, sc);
725         lwkt_serialize_exit(ifp->if_serializer);
726 }
727
728 static int
729 axe_encap(struct axe_softc *sc, struct mbuf *m, int idx)
730 {
731         struct axe_chain        *c;
732         usbd_status             err;
733
734         c = &sc->axe_cdata.axe_tx_chain[idx];
735
736         /*
737          * Copy the mbuf data into a contiguous buffer, leaving two
738          * bytes at the beginning to hold the frame length.
739          */
740         m_copydata(m, 0, m->m_pkthdr.len, c->axe_buf);
741         c->axe_mbuf = m;
742
743         usbd_setup_xfer(c->axe_xfer, sc->axe_ep[AXE_ENDPT_TX],
744             c, c->axe_buf, m->m_pkthdr.len, USBD_FORCE_SHORT_XFER,
745             10000, axe_txeof);
746
747         /* Transmit */
748         err = usbd_transfer(c->axe_xfer);
749         if (err != USBD_IN_PROGRESS) {
750                 axe_stop(sc);
751                 return(EIO);
752         }
753
754         sc->axe_cdata.axe_tx_cnt++;
755
756         return(0);
757 }
758
759 static void
760 axe_start(struct ifnet *ifp)
761 {
762         struct axe_softc *sc = ifp->if_softc;
763         struct mbuf *m_head = NULL;
764
765         if (!sc->axe_link) {
766                 return;
767         }
768
769         if (ifp->if_flags & IFF_OACTIVE) {
770                 return;
771         }
772
773         m_head = ifq_poll(&ifp->if_snd);
774         if (m_head == NULL) {
775                 return;
776         }
777
778         if (axe_encap(sc, m_head, 0)) {
779                 ifp->if_flags |= IFF_OACTIVE;
780                 return;
781         }
782         ifq_dequeue(&ifp->if_snd, m_head);
783
784         /*
785          * If there's a BPF listener, bounce a copy of this frame
786          * to him.
787          */
788         BPF_MTAP(ifp, m_head);
789
790         ifp->if_flags |= IFF_OACTIVE;
791
792         /*
793          * Set a timeout in case the chip goes out to lunch.
794          */
795         ifp->if_timer = 5;
796 }
797
798 static void
799 axe_init(void *xsc)
800 {
801         struct axe_softc        *sc = xsc;
802         struct ifnet            *ifp = &sc->arpcom.ac_if;
803         struct axe_chain        *c;
804         usbd_status             err;
805         int i, rxmode;
806
807         if (ifp->if_flags & IFF_RUNNING) {
808                 return;
809         }
810
811         /*
812          * Cancel pending I/O and free all RX/TX buffers.
813          */
814
815         axe_reset(sc);
816
817 #ifdef notdef
818         /* Set MAC address */
819         axe_mac(sc, sc->arpcom.ac_enaddr, 1);
820 #endif
821
822         /* Enable RX logic. */
823
824         /* Init TX ring. */
825         if (axe_tx_list_init(sc) == ENOBUFS) {
826                 if_printf(ifp, "tx list init failed\n");
827                 return;
828         }
829
830         /* Init RX ring. */
831         if (axe_rx_list_init(sc) == ENOBUFS) {
832                 if_printf(ifp, "rx list init failed\n");
833                 return;
834         }
835
836         /* Set transmitter IPG values */
837         axe_cmd(sc, AXE_CMD_WRITE_IPG0, 0, sc->axe_ipgs[0], NULL);
838         axe_cmd(sc, AXE_CMD_WRITE_IPG1, 0, sc->axe_ipgs[1], NULL);
839         axe_cmd(sc, AXE_CMD_WRITE_IPG2, 0, sc->axe_ipgs[2], NULL);
840
841         /* Enable receiver, set RX mode */
842         rxmode = AXE_RXCMD_UNICAST|AXE_RXCMD_MULTICAST|AXE_RXCMD_ENABLE;
843
844         /* If we want promiscuous mode, set the allframes bit. */
845         if (ifp->if_flags & IFF_PROMISC)
846                 rxmode |= AXE_RXCMD_PROMISC;
847
848         if (ifp->if_flags & IFF_BROADCAST)
849                 rxmode |= AXE_RXCMD_BROADCAST;
850
851         axe_cmd(sc, AXE_CMD_RXCTL_WRITE, 0, rxmode, NULL);
852
853         /* Load the multicast filter. */
854         axe_setmulti(sc);
855
856         /* Open RX and TX pipes. */
857         err = usbd_open_pipe(sc->axe_iface, sc->axe_ed[AXE_ENDPT_RX],
858             USBD_EXCLUSIVE_USE, &sc->axe_ep[AXE_ENDPT_RX]);
859         if (err) {
860                 if_printf(ifp, "open rx pipe failed: %s\n", usbd_errstr(err));
861                 return;
862         }
863
864         err = usbd_open_pipe(sc->axe_iface, sc->axe_ed[AXE_ENDPT_TX],
865             USBD_EXCLUSIVE_USE, &sc->axe_ep[AXE_ENDPT_TX]);
866         if (err) {
867                 if_printf(ifp, "open tx pipe failed: %s\n", usbd_errstr(err));
868                 return;
869         }
870
871         /* Start up the receive pipe. */
872         for (i = 0; i < AXE_RX_LIST_CNT; i++) {
873                 c = &sc->axe_cdata.axe_rx_chain[i];
874                 usbd_setup_xfer(c->axe_xfer, sc->axe_ep[AXE_ENDPT_RX],
875                     c, mtod(c->axe_mbuf, char *), AXE_BUFSZ,
876                     USBD_SHORT_XFER_OK, USBD_NO_TIMEOUT, axe_rxeof);
877                 usbd_transfer(c->axe_xfer);
878         }
879
880         ifp->if_flags |= IFF_RUNNING;
881         ifp->if_flags &= ~IFF_OACTIVE;
882
883         callout_reset(&sc->axe_stat_timer, hz, axe_tick, sc);
884 }
885
886 static int
887 axe_ioctl(struct ifnet *ifp, u_long command, caddr_t data, struct ucred *cr)
888 {
889         struct axe_softc        *sc = ifp->if_softc;
890         struct ifreq            *ifr = (struct ifreq *)data;
891         struct mii_data         *mii;
892         u_int16_t               rxmode;
893         int error = 0;
894
895         switch(command) {
896         case SIOCSIFFLAGS:
897                 if (ifp->if_flags & IFF_UP) {
898                         if (ifp->if_flags & IFF_RUNNING &&
899                             ifp->if_flags & IFF_PROMISC &&
900                             !(sc->axe_if_flags & IFF_PROMISC)) {
901                                 axe_cmd(sc, AXE_CMD_RXCTL_READ,
902                                         0, 0, (void *)&rxmode);
903                                 rxmode |= AXE_RXCMD_PROMISC;
904                                 axe_cmd(sc, AXE_CMD_RXCTL_WRITE,
905                                         0, rxmode, NULL);
906                                 axe_setmulti(sc);
907                         } else if (ifp->if_flags & IFF_RUNNING &&
908                             !(ifp->if_flags & IFF_PROMISC) &&
909                             sc->axe_if_flags & IFF_PROMISC) {
910                                 axe_cmd(sc, AXE_CMD_RXCTL_READ,
911                                         0, 0, (void *)&rxmode);
912                                 rxmode &= ~AXE_RXCMD_PROMISC;
913                                 axe_cmd(sc, AXE_CMD_RXCTL_WRITE,
914                                         0, rxmode, NULL);
915                                 axe_setmulti(sc);
916                         } else if (!(ifp->if_flags & IFF_RUNNING))
917                                 axe_init(sc);
918                 } else {
919                         if (ifp->if_flags & IFF_RUNNING)
920                                 axe_stop(sc);
921                 }
922                 sc->axe_if_flags = ifp->if_flags;
923                 error = 0;
924                 break;
925         case SIOCADDMULTI:
926         case SIOCDELMULTI:
927                 axe_setmulti(sc);
928                 error = 0;
929                 break;
930         case SIOCGIFMEDIA:
931         case SIOCSIFMEDIA:
932                 mii = GET_MII(sc);
933                 error = ifmedia_ioctl(ifp, ifr, &mii->mii_media, command);
934                 break;
935
936         default:
937                 error = ether_ioctl(ifp, command, data);
938                 break;
939         }
940         return(error);
941 }
942
943 static void
944 axe_watchdog(struct ifnet *ifp)
945 {
946         struct axe_softc *sc = ifp->if_softc;
947         struct axe_chain *c;
948         usbd_status stat;
949
950         ifp->if_oerrors++;
951         if_printf(ifp, "watchdog timeout\n");
952
953         c = &sc->axe_cdata.axe_tx_chain[0];
954         usbd_get_xfer_status(c->axe_xfer, NULL, NULL, NULL, &stat);
955         axe_txeof(c->axe_xfer, c, stat);
956
957         if (!ifq_is_empty(&ifp->if_snd))
958                 axe_start(ifp);
959 }
960
961 /*
962  * Stop the adapter and free any mbufs allocated to the
963  * RX and TX lists.
964  */
965 static void
966 axe_stop(struct axe_softc *sc)
967 {
968         usbd_status             err;
969         struct ifnet            *ifp;
970         int i;
971
972         ifp = &sc->arpcom.ac_if;
973         ifp->if_timer = 0;
974
975         callout_stop(&sc->axe_stat_timer);
976
977         /* Stop transfers. */
978         if (sc->axe_ep[AXE_ENDPT_RX] != NULL) {
979                 err = usbd_abort_pipe(sc->axe_ep[AXE_ENDPT_RX]);
980                 if (err) {
981                         if_printf(ifp, "abort rx pipe failed: %s\n",
982                             usbd_errstr(err));
983                 }
984                 err = usbd_close_pipe(sc->axe_ep[AXE_ENDPT_RX]);
985                 if (err) {
986                         if_printf(ifp, "close rx pipe failed: %s\n",
987                             usbd_errstr(err));
988                 }
989                 sc->axe_ep[AXE_ENDPT_RX] = NULL;
990         }
991
992         if (sc->axe_ep[AXE_ENDPT_TX] != NULL) {
993                 err = usbd_abort_pipe(sc->axe_ep[AXE_ENDPT_TX]);
994                 if (err) {
995                         if_printf(ifp, "abort tx pipe failed: %s\n",
996                             usbd_errstr(err));
997                 }
998                 err = usbd_close_pipe(sc->axe_ep[AXE_ENDPT_TX]);
999                 if (err) {
1000                         if_printf(ifp, "close tx pipe failed: %s\n",
1001                             usbd_errstr(err));
1002                 }
1003                 sc->axe_ep[AXE_ENDPT_TX] = NULL;
1004         }
1005
1006         if (sc->axe_ep[AXE_ENDPT_INTR] != NULL) {
1007                 err = usbd_abort_pipe(sc->axe_ep[AXE_ENDPT_INTR]);
1008                 if (err) {
1009                         if_printf(ifp, "abort intr pipe failed: %s\n",
1010                             usbd_errstr(err));
1011                 }
1012                 err = usbd_close_pipe(sc->axe_ep[AXE_ENDPT_INTR]);
1013                 if (err) {
1014                         if_printf(ifp, "close intr pipe failed: %s\n",
1015                             usbd_errstr(err));
1016                 }
1017                 sc->axe_ep[AXE_ENDPT_INTR] = NULL;
1018         }
1019
1020         axe_reset(sc);
1021
1022         /* Free RX resources. */
1023         for (i = 0; i < AXE_RX_LIST_CNT; i++) {
1024                 if (sc->axe_cdata.axe_rx_chain[i].axe_buf != NULL) {
1025                         kfree(sc->axe_cdata.axe_rx_chain[i].axe_buf, M_USBDEV);
1026                         sc->axe_cdata.axe_rx_chain[i].axe_buf = NULL;
1027                 }
1028                 if (sc->axe_cdata.axe_rx_chain[i].axe_mbuf != NULL) {
1029                         m_freem(sc->axe_cdata.axe_rx_chain[i].axe_mbuf);
1030                         sc->axe_cdata.axe_rx_chain[i].axe_mbuf = NULL;
1031                 }
1032                 if (sc->axe_cdata.axe_rx_chain[i].axe_xfer != NULL) {
1033                         usbd_free_xfer(sc->axe_cdata.axe_rx_chain[i].axe_xfer);
1034                         sc->axe_cdata.axe_rx_chain[i].axe_xfer = NULL;
1035                 }
1036         }
1037
1038         /* Free TX resources. */
1039         for (i = 0; i < AXE_TX_LIST_CNT; i++) {
1040                 if (sc->axe_cdata.axe_tx_chain[i].axe_buf != NULL) {
1041                         kfree(sc->axe_cdata.axe_tx_chain[i].axe_buf, M_USBDEV);
1042                         sc->axe_cdata.axe_tx_chain[i].axe_buf = NULL;
1043                 }
1044                 if (sc->axe_cdata.axe_tx_chain[i].axe_mbuf != NULL) {
1045                         m_freem(sc->axe_cdata.axe_tx_chain[i].axe_mbuf);
1046                         sc->axe_cdata.axe_tx_chain[i].axe_mbuf = NULL;
1047                 }
1048                 if (sc->axe_cdata.axe_tx_chain[i].axe_xfer != NULL) {
1049                         usbd_free_xfer(sc->axe_cdata.axe_tx_chain[i].axe_xfer);
1050                         sc->axe_cdata.axe_tx_chain[i].axe_xfer = NULL;
1051                 }
1052         }
1053
1054         ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
1055         sc->axe_link = 0;
1056 }
1057
1058 /*
1059  * Stop all chip I/O so that the kernel's probe routines don't
1060  * get confused by errant DMAs when rebooting.
1061  */
1062 static void
1063 axe_shutdown(device_t dev)
1064 {
1065         struct axe_softc        *sc;
1066
1067         sc = device_get_softc(dev);
1068
1069         axe_stop(sc);
1070 }