Merge from vendor branch ZLIB:
[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.7 2004/09/27 05:57:58 asmodai 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
77 #include <net/if.h>
78 #include <net/if_arp.h>
79 #include <net/ethernet.h>
80 #include <net/if_dl.h>
81 #include <net/if_media.h>
82
83 #include <net/bpf.h>
84
85 #include <sys/bus.h>
86 #include <machine/bus.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/usbdevs.h>
93 #include <bus/usb/usb_ethersubr.h>
94
95 #include "../mii_layer//mii.h"
96 #include "../mii_layer/miivar.h"
97
98 /* "controller miibus0" required.  See GENERIC if you get errors here. */
99 #include "miibus_if.h"
100
101 #include "if_axereg.h"
102
103 /*
104  * Various supported device vendors/products.
105  */
106 Static struct axe_type axe_devs[] = {
107         { USB_VENDOR_ASIX, USB_PRODUCT_ASIX_AX88172 },
108         { USB_VENDOR_DLINK, USB_PRODUCT_DLINK_DUBE100 },
109         { USB_VENDOR_LINKSYS2, USB_PRODUCT_LINKSYS2_USB200M },
110         { USB_VENDOR_NETGEAR, USB_PRODUCT_NETGEAR_FA120 },
111         { 0, 0 }
112 };
113
114 Static struct usb_qdat axe_qdat;
115
116 Static int axe_match(device_ptr_t);
117 Static int axe_attach(device_ptr_t);
118 Static int axe_detach(device_ptr_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_ptr_t);
134 Static int axe_miibus_readreg(device_ptr_t, int, int);
135 Static int axe_miibus_writereg(device_ptr_t, int, int, int);
136 Static void axe_miibus_statchg(device_ptr_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 Static uint32_t axe_mchash(const uint8_t *);
143
144 Static device_method_t axe_methods[] = {
145         /* Device interface */
146         DEVMETHOD(device_probe,         axe_match),
147         DEVMETHOD(device_attach,        axe_attach),
148         DEVMETHOD(device_detach,        axe_detach),
149         DEVMETHOD(device_shutdown,      axe_shutdown),
150
151         /* bus interface */
152         DEVMETHOD(bus_print_child,      bus_generic_print_child),
153         DEVMETHOD(bus_driver_added,     bus_generic_driver_added),
154
155         /* MII interface */
156         DEVMETHOD(miibus_readreg,       axe_miibus_readreg),
157         DEVMETHOD(miibus_writereg,      axe_miibus_writereg),
158         DEVMETHOD(miibus_statchg,       axe_miibus_statchg),
159
160         { 0, 0 }
161 };
162
163 Static driver_t axe_driver = {
164         "axe",
165         axe_methods,
166         sizeof(struct axe_softc)
167 };
168
169 Static devclass_t axe_devclass;
170
171 DRIVER_MODULE(axe, uhub, axe_driver, axe_devclass, usbd_driver_load, 0);
172 DRIVER_MODULE(miibus, axe, miibus_driver, miibus_devclass, 0, 0);
173 MODULE_DEPEND(axe, usb, 1, 1, 1);
174 MODULE_DEPEND(axe, miibus, 1, 1, 1);
175
176 Static int
177 axe_cmd(struct axe_softc *sc, int cmd, int index, int val, void *buf)
178 {
179         usb_device_request_t    req;
180         usbd_status             err;
181
182         if (sc->axe_dying)
183                 return(0);
184
185         if (AXE_CMD_DIR(cmd))
186                 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
187         else
188                 req.bmRequestType = UT_READ_VENDOR_DEVICE;
189         req.bRequest = AXE_CMD_CMD(cmd);
190         USETW(req.wValue, val);
191         USETW(req.wIndex, index);
192         USETW(req.wLength, AXE_CMD_LEN(cmd));
193
194         err = usbd_do_request(sc->axe_udev, &req, buf);
195
196         if (err)
197                 return(-1);
198
199         return(0);
200 }
201
202 Static int
203 axe_miibus_readreg(device_ptr_t dev, int phy, int reg)
204 {
205         struct axe_softc        *sc = USBGETSOFTC(dev);
206         usbd_status             err;
207         u_int16_t               val;
208         int s;
209
210         if (sc->axe_dying)
211                 return(0);
212
213 #ifdef notdef
214         /*
215          * The chip tells us the MII address of any supported
216          * PHYs attached to the chip, so only read from those.
217          */
218
219         if (sc->axe_phyaddrs[0] != AXE_NOPHY && phy != sc->axe_phyaddrs[0])
220                 return (0);
221
222         if (sc->axe_phyaddrs[1] != AXE_NOPHY && phy != sc->axe_phyaddrs[1])
223                 return (0);
224 #endif
225         if (sc->axe_phyaddrs[0] != 0xFF && sc->axe_phyaddrs[0] != phy)
226                 return (0);
227
228         s = splimp();
229         axe_cmd(sc, AXE_CMD_MII_OPMODE_SW, 0, 0, NULL);
230         err = axe_cmd(sc, AXE_CMD_MII_READ_REG, reg, phy, (void *)&val);
231         axe_cmd(sc, AXE_CMD_MII_OPMODE_HW, 0, 0, NULL);
232         splx(s);
233
234         if (err) {
235                 printf("axe%d: read PHY failed\n", sc->axe_unit);
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_ptr_t dev, int phy, int reg, int val)
247 {
248         struct axe_softc        *sc = USBGETSOFTC(dev);
249         usbd_status             err;
250         int s;
251
252         if (sc->axe_dying)
253                 return(0);
254
255         s = splimp();
256         axe_cmd(sc, AXE_CMD_MII_OPMODE_SW, 0, 0, NULL);
257         err = axe_cmd(sc, AXE_CMD_MII_WRITE_REG, reg, phy, (void *)&val);
258         axe_cmd(sc, AXE_CMD_MII_OPMODE_HW, 0, 0, NULL);
259         splx(s);
260
261         if (err) {
262                 printf("axe%d: write PHY failed\n", sc->axe_unit);
263                 return(-1);
264         }
265
266         return (0);
267 }
268
269 Static void
270 axe_miibus_statchg(device_ptr_t dev)
271 {
272 #ifdef notdef
273         struct axe_softc        *sc = USBGETSOFTC(dev);
274         struct mii_data         *mii = GET_MII(sc);
275 #endif
276         /* doesn't seem to be necessary */
277
278         return;
279 }
280
281 /*
282  * Set media options.
283  */
284 Static int
285 axe_ifmedia_upd(struct ifnet *ifp)
286 {
287         struct axe_softc        *sc = ifp->if_softc;
288         struct mii_data         *mii = GET_MII(sc);
289
290         sc->axe_link = 0;
291         if (mii->mii_instance) {
292                 struct mii_softc        *miisc;
293                 LIST_FOREACH(miisc, &mii->mii_phys, mii_list)
294                          mii_phy_reset(miisc);
295         }
296         mii_mediachg(mii);
297
298         return (0);
299 }
300
301 /*
302  * Report current media status.
303  */
304 Static void
305 axe_ifmedia_sts(struct ifnet *ifp, struct ifmediareq *ifmr)
306 {
307         struct axe_softc        *sc = ifp->if_softc;
308         struct mii_data         *mii = GET_MII(sc);
309
310         mii_pollstat(mii);
311         ifmr->ifm_active = mii->mii_media_active;
312         ifmr->ifm_status = mii->mii_media_status;
313
314         return;
315 }
316
317 Static uint32_t
318 axe_mchash(const uint8_t *addr)
319 {
320         uint32_t crc, carry;
321         int idx, bit;
322         uint8_t data;
323
324         /* Compute CRC for the address value. */
325         crc = 0xFFFFFFFF; /* initial value */
326
327         for (idx = 0; idx < 6; idx++) {
328                 for (data = *addr++, bit = 0; bit < 8; bit++, data >>= 1) {
329                         carry = ((crc & 0x80000000) ? 1 : 0) ^ (data & 0x01);
330                         crc <<= 1;
331                         if (carry)
332                                 crc = (crc ^ 0x04c11db6) | carry;
333                 }
334         }
335
336         /* return the filter bit position */
337         return((crc >> 26) & 0x0000003F);
338 }
339
340 Static void
341 axe_setmulti(struct axe_softc *sc)
342 {
343         struct ifnet            *ifp;
344         struct ifmultiaddr      *ifma;
345         u_int32_t               h = 0;
346         u_int16_t               rxmode;
347         u_int8_t                hashtbl[8] = { 0, 0, 0, 0, 0, 0, 0, 0 };
348         int s;
349
350         ifp = &sc->arpcom.ac_if;
351
352         s = splimp();
353         axe_cmd(sc, AXE_CMD_RXCTL_READ, 0, 0, (void *)&rxmode);
354
355         if (ifp->if_flags & IFF_ALLMULTI || ifp->if_flags & IFF_PROMISC) {
356                 rxmode |= AXE_RXCMD_ALLMULTI;
357                 axe_cmd(sc, AXE_CMD_RXCTL_WRITE, 0, rxmode, NULL);
358                 splx(s);
359                 return;
360         } else
361                 rxmode &= ~AXE_RXCMD_ALLMULTI;
362
363         LIST_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
364                 if (ifma->ifma_addr->sa_family != AF_LINK)
365                         continue;
366                 h = axe_mchash(LLADDR((struct sockaddr_dl *)ifma->ifma_addr));
367                 hashtbl[h / 8] |= 1 << (h % 8);
368         }
369
370         axe_cmd(sc, AXE_CMD_WRITE_MCAST, 0, 0, (void *)&hashtbl);
371         axe_cmd(sc, AXE_CMD_RXCTL_WRITE, 0, rxmode, NULL);
372
373         splx(s);
374 }
375
376 Static void
377 axe_reset(struct axe_softc *sc)
378 {
379         if (sc->axe_dying)
380                 return;
381
382         if (usbd_set_config_no(sc->axe_udev, AXE_CONFIG_NO, 1) ||
383             usbd_device2interface_handle(sc->axe_udev, AXE_IFACE_IDX,
384             &sc->axe_iface)) {
385                 printf("axe%d: getting interface handle failed\n",
386                     sc->axe_unit);
387         }
388
389         /* Wait a little while for the chip to get its brains in order. */
390         DELAY(1000);
391         return;
392 }
393
394 /*
395  * Probe for a AX88172 chip.
396  */
397 USB_MATCH(axe)
398 {
399         USB_MATCH_START(axe, uaa);
400         struct axe_type                 *t;
401
402         if (!uaa->iface)
403                 return(UMATCH_NONE);
404
405         t = axe_devs;
406         while(t->axe_vid) {
407                 if (uaa->vendor == t->axe_vid &&
408                     uaa->product == t->axe_did) {
409                         return(UMATCH_VENDOR_PRODUCT);
410                 }
411                 t++;
412         }
413
414         return(UMATCH_NONE);
415 }
416
417 /*
418  * Attach the interface. Allocate softc structures, do ifmedia
419  * setup and ethernet/BPF attach.
420  */
421 USB_ATTACH(axe)
422 {
423         USB_ATTACH_START(axe, sc, uaa);
424         char                    devinfo[1024];
425         u_char                  eaddr[ETHER_ADDR_LEN];
426         struct ifnet            *ifp;
427         usb_interface_descriptor_t      *id;
428         usb_endpoint_descriptor_t       *ed;
429         int                     i;
430
431         bzero(sc, sizeof(struct axe_softc));
432         sc->axe_udev = uaa->device;
433         sc->axe_dev = self;
434         sc->axe_unit = device_get_unit(self);
435         callout_init(&sc->axe_stat_timer);
436
437         if (usbd_set_config_no(sc->axe_udev, AXE_CONFIG_NO, 1)) {
438                 printf("axe%d: getting interface handle failed\n",
439                     sc->axe_unit);
440                 USB_ATTACH_ERROR_RETURN;
441         }
442
443         if (usbd_device2interface_handle(uaa->device,
444             AXE_IFACE_IDX, &sc->axe_iface)) {
445                 printf("axe%d: getting interface handle failed\n",
446                     sc->axe_unit);
447                 USB_ATTACH_ERROR_RETURN;
448         }
449
450         id = usbd_get_interface_descriptor(sc->axe_iface);
451
452         usbd_devinfo(uaa->device, 0, devinfo);
453         device_set_desc_copy(self, devinfo);
454         printf("%s: %s\n", USBDEVNAME(self), devinfo);
455
456         /* Find endpoints. */
457         for (i = 0; i < id->bNumEndpoints; i++) {
458                 ed = usbd_interface2endpoint_descriptor(sc->axe_iface, i);
459                 if (!ed) {
460                         printf("axe%d: couldn't get ep %d\n",
461                             sc->axe_unit, i);
462                         USB_ATTACH_ERROR_RETURN;
463                 }
464                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
465                     UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
466                         sc->axe_ed[AXE_ENDPT_RX] = ed->bEndpointAddress;
467                 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
468                            UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
469                         sc->axe_ed[AXE_ENDPT_TX] = ed->bEndpointAddress;
470                 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
471                            UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
472                         sc->axe_ed[AXE_ENDPT_INTR] = ed->bEndpointAddress;
473                 }
474         }
475
476         /*
477          * Get station address.
478          */
479         axe_cmd(sc, AXE_CMD_READ_NODEID, 0, 0, &eaddr);
480
481         /*
482          * Load IPG values and PHY indexes.
483          */
484         axe_cmd(sc, AXE_CMD_READ_IPG012, 0, 0, (void *)&sc->axe_ipgs);
485         axe_cmd(sc, AXE_CMD_READ_PHYID, 0, 0, (void *)&sc->axe_phyaddrs);
486
487         /*
488          * Work around broken adapters that appear to lie about
489          * their PHY addresses.
490          */
491         sc->axe_phyaddrs[0] = sc->axe_phyaddrs[1] = 0xFF;
492
493         ifp = &sc->arpcom.ac_if;
494         ifp->if_softc = sc;
495         if_initname(ifp, "axe", sc->axe_unit);
496         ifp->if_mtu = ETHERMTU;
497         ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
498         ifp->if_ioctl = axe_ioctl;
499         ifp->if_start = axe_start;
500         ifp->if_watchdog = axe_watchdog;
501         ifp->if_init = axe_init;
502         ifp->if_baudrate = 10000000;
503         ifp->if_snd.ifq_maxlen = IFQ_MAXLEN;
504
505         axe_qdat.ifp = ifp;
506         axe_qdat.if_rxstart = axe_rxstart;
507
508         if (mii_phy_probe(self, &sc->axe_miibus,
509             axe_ifmedia_upd, axe_ifmedia_sts)) {
510                 printf("axe%d: MII without any PHY!\n", sc->axe_unit);
511                 USB_ATTACH_ERROR_RETURN;
512         }
513
514         /*
515          * Call MI attach routine.
516          */
517
518         ether_ifattach(ifp, eaddr);
519
520         sc->axe_dying = 0;
521
522         usb_register_netisr();
523
524         USB_ATTACH_SUCCESS_RETURN;
525 }
526
527 Static int
528 axe_detach(device_ptr_t dev)
529 {
530         struct axe_softc        *sc;
531         struct ifnet            *ifp;
532         int s;
533
534         sc = device_get_softc(dev);
535         ifp = &sc->arpcom.ac_if;
536
537         s = splimp();
538         sc->axe_dying = 1;
539         callout_stop(&sc->axe_stat_timer);
540         ether_ifdetach(ifp);
541
542         if (sc->axe_ep[AXE_ENDPT_TX] != NULL)
543                 usbd_abort_pipe(sc->axe_ep[AXE_ENDPT_TX]);
544         if (sc->axe_ep[AXE_ENDPT_RX] != NULL)
545                 usbd_abort_pipe(sc->axe_ep[AXE_ENDPT_RX]);
546         if (sc->axe_ep[AXE_ENDPT_INTR] != NULL)
547                 usbd_abort_pipe(sc->axe_ep[AXE_ENDPT_INTR]);
548
549         splx(s);
550
551         return(0);
552 }
553
554 /*
555  * Initialize an RX descriptor and attach an MBUF cluster.
556  */
557 Static int
558 axe_newbuf(struct axe_softc *sc, struct axe_chain *c, struct mbuf *m)
559 {
560         struct mbuf             *m_new = NULL;
561
562         if (m == NULL) {
563                 m_new = m_getcl(MB_DONTWAIT, MT_DATA, M_PKTHDR);
564                 if (m_new == NULL) {
565                         printf("axe%d: no memory for rx list "
566                             "-- packet dropped!\n", sc->axe_unit);
567                         return(ENOBUFS);
568                 }
569                 m_new->m_len = m_new->m_pkthdr.len = MCLBYTES;
570         } else {
571                 m_new = m;
572                 m_new->m_len = m_new->m_pkthdr.len = MCLBYTES;
573                 m_new->m_data = m_new->m_ext.ext_buf;
574         }
575
576         m_adj(m_new, ETHER_ALIGN);
577         c->axe_mbuf = m_new;
578
579         return(0);
580 }
581
582 Static int
583 axe_rx_list_init(struct axe_softc *sc)
584 {
585         struct axe_cdata        *cd;
586         struct axe_chain        *c;
587         int                     i;
588
589         cd = &sc->axe_cdata;
590         for (i = 0; i < AXE_RX_LIST_CNT; i++) {
591                 c = &cd->axe_rx_chain[i];
592                 c->axe_sc = sc;
593                 c->axe_idx = i;
594                 if (axe_newbuf(sc, c, NULL) == ENOBUFS)
595                         return(ENOBUFS);
596                 if (c->axe_xfer == NULL) {
597                         c->axe_xfer = usbd_alloc_xfer(sc->axe_udev);
598                         if (c->axe_xfer == NULL)
599                                 return(ENOBUFS);
600                 }
601         }
602
603         return(0);
604 }
605
606 Static int
607 axe_tx_list_init(struct axe_softc *sc)
608 {
609         struct axe_cdata        *cd;
610         struct axe_chain        *c;
611         int                     i;
612
613         cd = &sc->axe_cdata;
614         for (i = 0; i < AXE_TX_LIST_CNT; i++) {
615                 c = &cd->axe_tx_chain[i];
616                 c->axe_sc = sc;
617                 c->axe_idx = i;
618                 c->axe_mbuf = NULL;
619                 if (c->axe_xfer == NULL) {
620                         c->axe_xfer = usbd_alloc_xfer(sc->axe_udev);
621                         if (c->axe_xfer == NULL)
622                                 return(ENOBUFS);
623                 }
624                 c->axe_buf = malloc(AXE_BUFSZ, M_USBDEV, M_WAITOK);
625                 if (c->axe_buf == NULL)
626                         return(ENOBUFS);
627         }
628
629         return(0);
630 }
631
632 Static void
633 axe_rxstart(struct ifnet *ifp)
634 {
635         struct axe_softc        *sc;
636         struct axe_chain        *c;
637         int s;
638
639         sc = ifp->if_softc;
640         s = splimp();
641         c = &sc->axe_cdata.axe_rx_chain[sc->axe_cdata.axe_rx_prod];
642
643         if (axe_newbuf(sc, c, NULL) == ENOBUFS) {
644                 ifp->if_ierrors++;
645                 splx(s);
646                 return;
647         }
648
649         /* Setup new transfer. */
650         usbd_setup_xfer(c->axe_xfer, sc->axe_ep[AXE_ENDPT_RX],
651             c, mtod(c->axe_mbuf, char *), AXE_BUFSZ, USBD_SHORT_XFER_OK,
652             USBD_NO_TIMEOUT, axe_rxeof);
653         usbd_transfer(c->axe_xfer);
654         splx(s);
655
656         return;
657 }
658
659 /*
660  * A frame has been uploaded: pass the resulting mbuf chain up to
661  * the higher level protocols.
662  */
663 Static void
664 axe_rxeof(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
665 {
666         struct axe_softc        *sc;
667         struct axe_chain        *c;
668         struct mbuf             *m;
669         struct ifnet            *ifp;
670         int s, total_len = 0;
671
672         c = priv;
673         sc = c->axe_sc;
674         s = splimp();
675         ifp = &sc->arpcom.ac_if;
676
677         if (!(ifp->if_flags & IFF_RUNNING)) {
678                 splx(s);
679                 return;
680         }
681
682         if (status != USBD_NORMAL_COMPLETION) {
683                 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) {
684                         splx(s);
685                         return;
686                 }
687                 if (usbd_ratecheck(&sc->axe_rx_notice))
688                         printf("axe%d: usb error on rx: %s\n", sc->axe_unit,
689                             usbd_errstr(status));
690                 if (status == USBD_STALLED)
691                         usbd_clear_endpoint_stall(sc->axe_ep[AXE_ENDPT_RX]);
692                 goto done;
693         }
694
695         usbd_get_xfer_status(xfer, NULL, NULL, &total_len, NULL);
696
697         m = c->axe_mbuf;
698
699         if (total_len < sizeof(struct ether_header)) {
700                 ifp->if_ierrors++;
701                 goto done;
702         }
703
704         ifp->if_ipackets++;
705         m->m_pkthdr.rcvif = (struct ifnet *)&axe_qdat;
706         m->m_pkthdr.len = m->m_len = total_len;
707
708         /* Put the packet on the special USB input queue. */
709         usb_ether_input(m);
710         splx(s);
711
712         return;
713 done:
714         /* Setup new transfer. */
715         usbd_setup_xfer(c->axe_xfer, sc->axe_ep[AXE_ENDPT_RX],
716             c, mtod(c->axe_mbuf, char *), AXE_BUFSZ, USBD_SHORT_XFER_OK,
717             USBD_NO_TIMEOUT, axe_rxeof);
718         usbd_transfer(c->axe_xfer);
719         splx(s);
720
721         return;
722 }
723
724 /*
725  * A frame was downloaded to the chip. It's safe for us to clean up
726  * the list buffers.
727  */
728
729 Static void
730 axe_txeof(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
731 {
732         struct axe_softc        *sc;
733         struct axe_chain        *c;
734         struct ifnet            *ifp;
735         usbd_status             err;
736         int s;
737
738         c = priv;
739         sc = c->axe_sc;
740         ifp = &sc->arpcom.ac_if;
741
742         s = splimp();
743
744         if (status != USBD_NORMAL_COMPLETION) {
745                 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) {
746                         splx(s);
747                         return;
748                 }
749                 printf("axe%d: usb error on tx: %s\n", sc->axe_unit,
750                     usbd_errstr(status));
751                 if (status == USBD_STALLED)
752                         usbd_clear_endpoint_stall(sc->axe_ep[AXE_ENDPT_TX]);
753                 splx(s);
754                 return;
755         }
756
757         ifp->if_timer = 0;
758         ifp->if_flags &= ~IFF_OACTIVE;
759         usbd_get_xfer_status(c->axe_xfer, NULL, NULL, NULL, &err);
760
761         if (c->axe_mbuf != NULL) {
762                 c->axe_mbuf->m_pkthdr.rcvif = ifp;
763                 usb_tx_done(c->axe_mbuf);
764                 c->axe_mbuf = NULL;
765         }
766
767         if (err)
768                 ifp->if_oerrors++;
769         else
770                 ifp->if_opackets++;
771
772         splx(s);
773 }
774
775 Static void
776 axe_tick(void *xsc)
777 {
778         struct axe_softc        *sc;
779         struct ifnet            *ifp;
780         struct mii_data         *mii;
781         int s;
782
783         sc = xsc;
784
785         if (sc == NULL)
786                 return;
787
788         ifp = &sc->arpcom.ac_if;
789         mii = GET_MII(sc);
790         if (mii == NULL)
791                 return;
792
793         s = splimp();
794
795         mii_tick(mii);
796         if (!sc->axe_link && mii->mii_media_status & IFM_ACTIVE &&
797             IFM_SUBTYPE(mii->mii_media_active) != IFM_NONE) {
798                 sc->axe_link++;
799                 if (ifp->if_snd.ifq_head != NULL)
800                         axe_start(ifp);
801         }
802
803         callout_reset(&sc->axe_stat_timer, hz, axe_tick, sc);
804
805         splx(s);
806 }
807
808 Static int
809 axe_encap(struct axe_softc *sc, struct mbuf *m, int idx)
810 {
811         struct axe_chain        *c;
812         usbd_status             err;
813
814         c = &sc->axe_cdata.axe_tx_chain[idx];
815
816         /*
817          * Copy the mbuf data into a contiguous buffer, leaving two
818          * bytes at the beginning to hold the frame length.
819          */
820         m_copydata(m, 0, m->m_pkthdr.len, c->axe_buf);
821         c->axe_mbuf = m;
822
823         usbd_setup_xfer(c->axe_xfer, sc->axe_ep[AXE_ENDPT_TX],
824             c, c->axe_buf, m->m_pkthdr.len, 0, 10000, axe_txeof);
825
826         /* Transmit */
827         err = usbd_transfer(c->axe_xfer);
828         if (err != USBD_IN_PROGRESS) {
829                 axe_stop(sc);
830                 return(EIO);
831         }
832
833         sc->axe_cdata.axe_tx_cnt++;
834
835         return(0);
836 }
837
838 Static void
839 axe_start(struct ifnet *ifp)
840 {
841         struct axe_softc        *sc;
842         struct mbuf             *m_head = NULL;
843         int s;
844
845         sc = ifp->if_softc;
846         s = splimp();
847
848         if (!sc->axe_link) {
849                 splx(s);
850                 return;
851         }
852
853         if (ifp->if_flags & IFF_OACTIVE) {
854                 splx(s);
855                 return;
856         }
857
858         IF_DEQUEUE(&ifp->if_snd, m_head);
859         if (m_head == NULL) {
860                 splx(s);
861                 return;
862         }
863
864         if (axe_encap(sc, m_head, 0)) {
865                 IF_PREPEND(&ifp->if_snd, m_head);
866                 ifp->if_flags |= IFF_OACTIVE;
867                 splx(s);
868                 return;
869         }
870
871         /*
872          * If there's a BPF listener, bounce a copy of this frame
873          * to him.
874          */
875         BPF_MTAP(ifp, m_head);
876
877         ifp->if_flags |= IFF_OACTIVE;
878
879         /*
880          * Set a timeout in case the chip goes out to lunch.
881          */
882         ifp->if_timer = 5;
883         splx(s);
884 }
885
886 Static void
887 axe_init(void *xsc)
888 {
889         struct axe_softc        *sc = xsc;
890         struct ifnet            *ifp = &sc->arpcom.ac_if;
891         struct axe_chain        *c;
892         usbd_status             err;
893         int i, rxmode, s;
894
895         if (ifp->if_flags & IFF_RUNNING)
896                 return;
897
898         s = splimp();
899
900         /*
901          * Cancel pending I/O and free all RX/TX buffers.
902          */
903
904         axe_reset(sc);
905
906 #ifdef notdef
907         /* Set MAC address */
908         axe_mac(sc, sc->arpcom.ac_enaddr, 1);
909 #endif
910
911         /* Enable RX logic. */
912
913         /* Init TX ring. */
914         if (axe_tx_list_init(sc) == ENOBUFS) {
915                 printf("axe%d: tx list init failed\n", sc->axe_unit);
916                 splx(s);
917                 return;
918         }
919
920         /* Init RX ring. */
921         if (axe_rx_list_init(sc) == ENOBUFS) {
922                 printf("axe%d: rx list init failed\n", sc->axe_unit);
923                 splx(s);
924                 return;
925         }
926
927         /* Set transmitter IPG values */
928         axe_cmd(sc, AXE_CMD_WRITE_IPG0, 0, sc->axe_ipgs[0], NULL);
929         axe_cmd(sc, AXE_CMD_WRITE_IPG1, 0, sc->axe_ipgs[1], NULL);
930         axe_cmd(sc, AXE_CMD_WRITE_IPG2, 0, sc->axe_ipgs[2], NULL);
931
932         /* Enable receiver, set RX mode */
933         rxmode = AXE_RXCMD_UNICAST|AXE_RXCMD_MULTICAST|AXE_RXCMD_ENABLE;
934
935         /* If we want promiscuous mode, set the allframes bit. */
936         if (ifp->if_flags & IFF_PROMISC)
937                 rxmode |= AXE_RXCMD_PROMISC;
938
939         if (ifp->if_flags & IFF_BROADCAST)
940                 rxmode |= AXE_RXCMD_BROADCAST;
941
942         axe_cmd(sc, AXE_CMD_RXCTL_WRITE, 0, rxmode, NULL);
943
944         /* Load the multicast filter. */
945         axe_setmulti(sc);
946
947         /* Open RX and TX pipes. */
948         err = usbd_open_pipe(sc->axe_iface, sc->axe_ed[AXE_ENDPT_RX],
949             USBD_EXCLUSIVE_USE, &sc->axe_ep[AXE_ENDPT_RX]);
950         if (err) {
951                 printf("axe%d: open rx pipe failed: %s\n",
952                     sc->axe_unit, usbd_errstr(err));
953                 splx(s);
954                 return;
955         }
956
957         err = usbd_open_pipe(sc->axe_iface, sc->axe_ed[AXE_ENDPT_TX],
958             USBD_EXCLUSIVE_USE, &sc->axe_ep[AXE_ENDPT_TX]);
959         if (err) {
960                 printf("axe%d: open tx pipe failed: %s\n",
961                     sc->axe_unit, usbd_errstr(err));
962                 splx(s);
963                 return;
964         }
965
966         /* Start up the receive pipe. */
967         for (i = 0; i < AXE_RX_LIST_CNT; i++) {
968                 c = &sc->axe_cdata.axe_rx_chain[i];
969                 usbd_setup_xfer(c->axe_xfer, sc->axe_ep[AXE_ENDPT_RX],
970                     c, mtod(c->axe_mbuf, char *), AXE_BUFSZ,
971                     USBD_SHORT_XFER_OK, USBD_NO_TIMEOUT, axe_rxeof);
972                 usbd_transfer(c->axe_xfer);
973         }
974
975         ifp->if_flags |= IFF_RUNNING;
976         ifp->if_flags &= ~IFF_OACTIVE;
977
978         splx(s);
979
980         callout_reset(&sc->axe_stat_timer, hz, axe_tick, sc);
981
982         return;
983 }
984
985 Static int
986 axe_ioctl(struct ifnet *ifp, u_long command, caddr_t data, struct ucred *cr)
987 {
988         struct axe_softc        *sc = ifp->if_softc;
989         struct ifreq            *ifr = (struct ifreq *)data;
990         struct mii_data         *mii;
991         u_int16_t               rxmode;
992         int error = 0, s;
993
994         s = splimp();
995
996         switch(command) {
997         case SIOCSIFFLAGS:
998                 if (ifp->if_flags & IFF_UP) {
999                         if (ifp->if_flags & IFF_RUNNING &&
1000                             ifp->if_flags & IFF_PROMISC &&
1001                             !(sc->axe_if_flags & IFF_PROMISC)) {
1002                                 axe_cmd(sc, AXE_CMD_RXCTL_READ,
1003                                         0, 0, (void *)&rxmode);
1004                                 rxmode |= AXE_RXCMD_PROMISC;
1005                                 axe_cmd(sc, AXE_CMD_RXCTL_WRITE,
1006                                         0, rxmode, NULL);
1007                                 axe_setmulti(sc);
1008                         } else if (ifp->if_flags & IFF_RUNNING &&
1009                             !(ifp->if_flags & IFF_PROMISC) &&
1010                             sc->axe_if_flags & IFF_PROMISC) {
1011                                 axe_cmd(sc, AXE_CMD_RXCTL_READ,
1012                                         0, 0, (void *)&rxmode);
1013                                 rxmode &= ~AXE_RXCMD_PROMISC;
1014                                 axe_cmd(sc, AXE_CMD_RXCTL_WRITE,
1015                                         0, rxmode, NULL);
1016                                 axe_setmulti(sc);
1017                         } else if (!(ifp->if_flags & IFF_RUNNING))
1018                                 axe_init(sc);
1019                 } else {
1020                         if (ifp->if_flags & IFF_RUNNING)
1021                                 axe_stop(sc);
1022                 }
1023                 sc->axe_if_flags = ifp->if_flags;
1024                 error = 0;
1025                 break;
1026         case SIOCADDMULTI:
1027         case SIOCDELMULTI:
1028                 axe_setmulti(sc);
1029                 error = 0;
1030                 break;
1031         case SIOCGIFMEDIA:
1032         case SIOCSIFMEDIA:
1033                 mii = GET_MII(sc);
1034                 error = ifmedia_ioctl(ifp, ifr, &mii->mii_media, command);
1035                 break;
1036
1037         default:
1038                 error = ether_ioctl(ifp, command, data);
1039                 break;
1040         }
1041
1042         splx(s);
1043
1044         return(error);
1045 }
1046
1047 Static void
1048 axe_watchdog(struct ifnet *ifp)
1049 {
1050         struct axe_softc        *sc;
1051         struct axe_chain        *c;
1052         usbd_status             stat;
1053         int s;
1054
1055         sc = ifp->if_softc;
1056         s = splimp();
1057
1058         ifp->if_oerrors++;
1059         printf("axe%d: watchdog timeout\n", sc->axe_unit);
1060
1061         c = &sc->axe_cdata.axe_tx_chain[0];
1062         usbd_get_xfer_status(c->axe_xfer, NULL, NULL, NULL, &stat);
1063         axe_txeof(c->axe_xfer, c, stat);
1064
1065         if (ifp->if_snd.ifq_head != NULL)
1066                 axe_start(ifp);
1067
1068         splx(s);
1069 }
1070
1071 /*
1072  * Stop the adapter and free any mbufs allocated to the
1073  * RX and TX lists.
1074  */
1075 Static void
1076 axe_stop(struct axe_softc *sc)
1077 {
1078         usbd_status             err;
1079         struct ifnet            *ifp;
1080         int i, s;
1081
1082         s = splimp();
1083
1084         axe_reset(sc);
1085
1086         ifp = &sc->arpcom.ac_if;
1087         ifp->if_timer = 0;
1088
1089         callout_stop(&sc->axe_stat_timer);
1090
1091         /* Stop transfers. */
1092         if (sc->axe_ep[AXE_ENDPT_RX] != NULL) {
1093                 err = usbd_abort_pipe(sc->axe_ep[AXE_ENDPT_RX]);
1094                 if (err) {
1095                         printf("axe%d: abort rx pipe failed: %s\n",
1096                         sc->axe_unit, usbd_errstr(err));
1097                 }
1098                 err = usbd_close_pipe(sc->axe_ep[AXE_ENDPT_RX]);
1099                 if (err) {
1100                         printf("axe%d: close rx pipe failed: %s\n",
1101                         sc->axe_unit, usbd_errstr(err));
1102                 }
1103                 sc->axe_ep[AXE_ENDPT_RX] = NULL;
1104         }
1105
1106         if (sc->axe_ep[AXE_ENDPT_TX] != NULL) {
1107                 err = usbd_abort_pipe(sc->axe_ep[AXE_ENDPT_TX]);
1108                 if (err) {
1109                         printf("axe%d: abort tx pipe failed: %s\n",
1110                         sc->axe_unit, usbd_errstr(err));
1111                 }
1112                 err = usbd_close_pipe(sc->axe_ep[AXE_ENDPT_TX]);
1113                 if (err) {
1114                         printf("axe%d: close tx pipe failed: %s\n",
1115                             sc->axe_unit, usbd_errstr(err));
1116                 }
1117                 sc->axe_ep[AXE_ENDPT_TX] = NULL;
1118         }
1119
1120         if (sc->axe_ep[AXE_ENDPT_INTR] != NULL) {
1121                 err = usbd_abort_pipe(sc->axe_ep[AXE_ENDPT_INTR]);
1122                 if (err) {
1123                         printf("axe%d: abort intr pipe failed: %s\n",
1124                         sc->axe_unit, usbd_errstr(err));
1125                 }
1126                 err = usbd_close_pipe(sc->axe_ep[AXE_ENDPT_INTR]);
1127                 if (err) {
1128                         printf("axe%d: close intr pipe failed: %s\n",
1129                             sc->axe_unit, usbd_errstr(err));
1130                 }
1131                 sc->axe_ep[AXE_ENDPT_INTR] = NULL;
1132         }
1133
1134         /* Free RX resources. */
1135         for (i = 0; i < AXE_RX_LIST_CNT; i++) {
1136                 if (sc->axe_cdata.axe_rx_chain[i].axe_buf != NULL) {
1137                         free(sc->axe_cdata.axe_rx_chain[i].axe_buf, M_USBDEV);
1138                         sc->axe_cdata.axe_rx_chain[i].axe_buf = NULL;
1139                 }
1140                 if (sc->axe_cdata.axe_rx_chain[i].axe_mbuf != NULL) {
1141                         m_freem(sc->axe_cdata.axe_rx_chain[i].axe_mbuf);
1142                         sc->axe_cdata.axe_rx_chain[i].axe_mbuf = NULL;
1143                 }
1144                 if (sc->axe_cdata.axe_rx_chain[i].axe_xfer != NULL) {
1145                         usbd_free_xfer(sc->axe_cdata.axe_rx_chain[i].axe_xfer);
1146                         sc->axe_cdata.axe_rx_chain[i].axe_xfer = NULL;
1147                 }
1148         }
1149
1150         /* Free TX resources. */
1151         for (i = 0; i < AXE_TX_LIST_CNT; i++) {
1152                 if (sc->axe_cdata.axe_tx_chain[i].axe_buf != NULL) {
1153                         free(sc->axe_cdata.axe_tx_chain[i].axe_buf, M_USBDEV);
1154                         sc->axe_cdata.axe_tx_chain[i].axe_buf = NULL;
1155                 }
1156                 if (sc->axe_cdata.axe_tx_chain[i].axe_mbuf != NULL) {
1157                         m_freem(sc->axe_cdata.axe_tx_chain[i].axe_mbuf);
1158                         sc->axe_cdata.axe_tx_chain[i].axe_mbuf = NULL;
1159                 }
1160                 if (sc->axe_cdata.axe_tx_chain[i].axe_xfer != NULL) {
1161                         usbd_free_xfer(sc->axe_cdata.axe_tx_chain[i].axe_xfer);
1162                         sc->axe_cdata.axe_tx_chain[i].axe_xfer = NULL;
1163                 }
1164         }
1165
1166         ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
1167         sc->axe_link = 0;
1168         splx(s);
1169 }
1170
1171 /*
1172  * Stop all chip I/O so that the kernel's probe routines don't
1173  * get confused by errant DMAs when rebooting.
1174  */
1175 Static void
1176 axe_shutdown(device_ptr_t dev)
1177 {
1178         struct axe_softc        *sc;
1179
1180         sc = device_get_softc(dev);
1181
1182         axe_stop(sc);
1183 }