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