2 * Copyright (c) 1997, 1998, 1999, 2000
3 * Bill Paul <wpaul@ee.columbia.edu>. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
32 * $FreeBSD: src/sys/dev/usb/if_aue.c,v 1.78 2003/12/17 14:23:07 sanpei Exp $
33 * $DragonFly: src/sys/dev/netif/aue/if_aue.c,v 1.25 2005/07/25 12:46:59 joerg Exp $
37 * ADMtek AN986 Pegasus and AN8511 Pegasus II USB to ethernet driver.
38 * Datasheet is available from http://www.admtek.com.tw.
40 * Written by Bill Paul <wpaul@ee.columbia.edu>
41 * Electrical Engineering Department
42 * Columbia University, New York City
46 * The Pegasus chip uses four USB "endpoints" to provide 10/100 ethernet
47 * support: the control endpoint for reading/writing registers, burst
48 * read endpoint for packet reception, burst write for packet transmission
49 * and one for "interrupts." The chip uses the same RX filter scheme
50 * as the other ADMtek ethernet parts: one perfect filter entry for the
51 * the station address and a 64-bit multicast hash table. The chip supports
52 * both MII and HomePNA attachments.
54 * Since the maximum data transfer speed of USB is supposed to be 12Mbps,
55 * you're never really going to get 100Mbps speeds from this device. I
56 * think the idea is to allow the device to connect to 10 or 100Mbps
57 * networks, not necessarily to provide 100Mbps performance. Also, since
58 * the controller uses an external PHY chip, it's possible that board
59 * designers might simply choose a 10Mbps PHY.
61 * Registers are accessed using usbd_do_request(). Packet transfers are
62 * done using usbd_transfer() and friends.
65 #include <sys/param.h>
66 #include <sys/systm.h>
67 #include <sys/sockio.h>
69 #include <sys/malloc.h>
70 #include <sys/kernel.h>
71 #include <sys/socket.h>
74 #include <net/ifq_var.h>
75 #include <net/if_arp.h>
76 #include <net/ethernet.h>
77 #include <net/if_dl.h>
78 #include <net/if_media.h>
83 #include <machine/bus.h>
85 #include <bus/usb/usb.h>
86 #include <bus/usb/usbdi.h>
87 #include <bus/usb/usbdi_util.h>
88 #include <bus/usb/usbdivar.h>
89 #include <bus/usb/usbdevs.h>
90 #include <bus/usb/usb_ethersubr.h>
92 #include "../mii_layer/mii.h"
93 #include "../mii_layer/miivar.h"
95 #include "if_auereg.h"
97 MODULE_DEPEND(aue, usb, 1, 1, 1);
98 MODULE_DEPEND(aue, miibus, 1, 1, 1);
100 /* "controller miibus0" required. See GENERIC if you get errors here. */
101 #include "miibus_if.h"
104 struct usb_devno aue_dev;
106 #define LSYS 0x0001 /* use Linksys reset */
107 #define PNA 0x0002 /* has Home PNA */
108 #define PII 0x0004 /* Pegasus II chip */
111 Static const struct aue_type aue_devs[] = {
112 {{ USB_VENDOR_3COM, USB_PRODUCT_3COM_3C460B}, PII },
113 {{ USB_VENDOR_ABOCOM, USB_PRODUCT_ABOCOM_XX1}, PNA|PII },
114 {{ USB_VENDOR_ABOCOM, USB_PRODUCT_ABOCOM_XX2}, PII },
115 {{ USB_VENDOR_ABOCOM, USB_PRODUCT_ABOCOM_UFE1000}, LSYS },
116 {{ USB_VENDOR_ABOCOM, USB_PRODUCT_ABOCOM_XX4}, PNA },
117 {{ USB_VENDOR_ABOCOM, USB_PRODUCT_ABOCOM_XX5}, PNA },
118 {{ USB_VENDOR_ABOCOM, USB_PRODUCT_ABOCOM_XX6}, PII },
119 {{ USB_VENDOR_ABOCOM, USB_PRODUCT_ABOCOM_XX7}, PII },
120 {{ USB_VENDOR_ABOCOM, USB_PRODUCT_ABOCOM_XX8}, PII },
121 {{ USB_VENDOR_ABOCOM, USB_PRODUCT_ABOCOM_XX9}, PNA },
122 {{ USB_VENDOR_ABOCOM, USB_PRODUCT_ABOCOM_XX10}, 0 },
123 {{ USB_VENDOR_ABOCOM, USB_PRODUCT_ABOCOM_DSB650TX_PNA}, 0 },
124 {{ USB_VENDOR_ACCTON, USB_PRODUCT_ACCTON_USB320_EC}, 0 },
125 {{ USB_VENDOR_ACCTON, USB_PRODUCT_ACCTON_SS1001}, PII },
126 {{ USB_VENDOR_ADMTEK, USB_PRODUCT_ADMTEK_PEGASUS}, PNA },
127 {{ USB_VENDOR_ADMTEK, USB_PRODUCT_ADMTEK_PEGASUSII}, PII },
128 {{ USB_VENDOR_ADMTEK, USB_PRODUCT_ADMTEK_PEGASUSII_2}, PII },
129 {{ USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_USB2LAN}, PII },
130 {{ USB_VENDOR_BILLIONTON, USB_PRODUCT_BILLIONTON_USB100}, 0 },
131 {{ USB_VENDOR_BILLIONTON, USB_PRODUCT_BILLIONTON_USBLP100}, PNA },
132 {{ USB_VENDOR_BILLIONTON, USB_PRODUCT_BILLIONTON_USBEL100}, 0 },
133 {{ USB_VENDOR_BILLIONTON, USB_PRODUCT_BILLIONTON_USBE100}, PII },
134 {{ USB_VENDOR_COREGA, USB_PRODUCT_COREGA_FETHER_USB_TX}, 0 },
135 {{ USB_VENDOR_COREGA, USB_PRODUCT_COREGA_FETHER_USB_TXS},PII },
136 {{ USB_VENDOR_DLINK, USB_PRODUCT_DLINK_DSB650TX4}, LSYS|PII },
137 {{ USB_VENDOR_DLINK, USB_PRODUCT_DLINK_DSB650TX1}, LSYS },
138 {{ USB_VENDOR_DLINK, USB_PRODUCT_DLINK_DSB650TX}, LSYS },
139 {{ USB_VENDOR_DLINK, USB_PRODUCT_DLINK_DSB650TX_PNA}, PNA },
140 {{ USB_VENDOR_DLINK, USB_PRODUCT_DLINK_DSB650TX3}, LSYS|PII },
141 {{ USB_VENDOR_DLINK, USB_PRODUCT_DLINK_DSB650TX2}, LSYS|PII },
142 {{ USB_VENDOR_DLINK, USB_PRODUCT_DLINK_DSB650}, LSYS },
143 {{ USB_VENDOR_ELECOM, USB_PRODUCT_ELECOM_LDUSBTX0}, 0 },
144 {{ USB_VENDOR_ELECOM, USB_PRODUCT_ELECOM_LDUSBTX1}, LSYS },
145 {{ USB_VENDOR_ELECOM, USB_PRODUCT_ELECOM_LDUSBTX2}, 0 },
146 {{ USB_VENDOR_ELECOM, USB_PRODUCT_ELECOM_LDUSBTX3}, LSYS },
147 {{ USB_VENDOR_ELECOM, USB_PRODUCT_ELECOM_LDUSBLTX}, PII },
148 {{ USB_VENDOR_ELSA, USB_PRODUCT_ELSA_USB2ETHERNET}, 0 },
149 {{ USB_VENDOR_HAWKING, USB_PRODUCT_HAWKING_UF100}, PII },
150 {{ USB_VENDOR_HP, USB_PRODUCT_HP_HN210E}, PII },
151 {{ USB_VENDOR_IODATA, USB_PRODUCT_IODATA_USBETTX}, 0 },
152 {{ USB_VENDOR_IODATA, USB_PRODUCT_IODATA_USBETTXS}, PII },
153 {{ USB_VENDOR_KINGSTON, USB_PRODUCT_KINGSTON_KNU101TX}, 0 },
154 {{ USB_VENDOR_LINKSYS, USB_PRODUCT_LINKSYS_USB10TX1}, LSYS|PII },
155 {{ USB_VENDOR_LINKSYS, USB_PRODUCT_LINKSYS_USB10T}, LSYS },
156 {{ USB_VENDOR_LINKSYS, USB_PRODUCT_LINKSYS_USB100TX}, LSYS },
157 {{ USB_VENDOR_LINKSYS, USB_PRODUCT_LINKSYS_USB100H1}, LSYS|PNA },
158 {{ USB_VENDOR_LINKSYS, USB_PRODUCT_LINKSYS_USB10TA}, LSYS },
159 {{ USB_VENDOR_LINKSYS, USB_PRODUCT_LINKSYS_USB10TX2}, LSYS|PII },
160 {{ USB_VENDOR_MICROSOFT, USB_PRODUCT_MICROSOFT_MN110}, PII },
161 {{ USB_VENDOR_MELCO, USB_PRODUCT_MELCO_LUATX1}, 0 },
162 {{ USB_VENDOR_MELCO, USB_PRODUCT_MELCO_LUATX5}, 0 },
163 {{ USB_VENDOR_MELCO, USB_PRODUCT_MELCO_LUA2TX5}, PII },
164 {{ USB_VENDOR_SIEMENS, USB_PRODUCT_SIEMENS_SPEEDSTREAM}, PII },
165 {{ USB_VENDOR_SMARTBRIDGES, USB_PRODUCT_SMARTBRIDGES_SMARTNIC},PII },
166 {{ USB_VENDOR_SMC, USB_PRODUCT_SMC_2202USB}, 0 },
167 {{ USB_VENDOR_SMC, USB_PRODUCT_SMC_2206USB}, PII },
168 {{ USB_VENDOR_SOHOWARE, USB_PRODUCT_SOHOWARE_NUB100}, 0 },
170 #define aue_lookup(v, p) ((const struct aue_type *)usb_lookup(aue_devs, v, p))
172 Static int aue_match(device_ptr_t);
173 Static int aue_attach(device_ptr_t);
174 Static int aue_detach(device_ptr_t);
176 Static void aue_reset_pegasus_II(struct aue_softc *sc);
177 Static int aue_tx_list_init(struct aue_softc *);
178 Static int aue_rx_list_init(struct aue_softc *);
179 Static int aue_newbuf(struct aue_softc *, struct aue_chain *, struct mbuf *);
180 Static int aue_encap(struct aue_softc *, struct mbuf *, int);
182 Static void aue_intr(usbd_xfer_handle, usbd_private_handle, usbd_status);
184 Static void aue_rxeof(usbd_xfer_handle, usbd_private_handle, usbd_status);
185 Static void aue_txeof(usbd_xfer_handle, usbd_private_handle, usbd_status);
186 Static void aue_tick(void *);
187 Static void aue_rxstart(struct ifnet *);
188 Static void aue_start(struct ifnet *);
189 Static int aue_ioctl(struct ifnet *, u_long, caddr_t, struct ucred *);
190 Static void aue_init(void *);
191 Static void aue_stop(struct aue_softc *);
192 Static void aue_watchdog(struct ifnet *);
193 Static void aue_shutdown(device_ptr_t);
194 Static int aue_ifmedia_upd(struct ifnet *);
195 Static void aue_ifmedia_sts(struct ifnet *, struct ifmediareq *);
197 Static void aue_eeprom_getword(struct aue_softc *, int, u_int16_t *);
198 Static void aue_read_eeprom(struct aue_softc *, caddr_t, int, int, int);
199 Static int aue_miibus_readreg(device_ptr_t, int, int);
200 Static int aue_miibus_writereg(device_ptr_t, int, int, int);
201 Static void aue_miibus_statchg(device_ptr_t);
203 Static void aue_setmulti(struct aue_softc *);
204 Static void aue_reset(struct aue_softc *);
206 Static int aue_csr_read_1(struct aue_softc *, int);
207 Static int aue_csr_write_1(struct aue_softc *, int, int);
208 Static int aue_csr_read_2(struct aue_softc *, int);
209 Static int aue_csr_write_2(struct aue_softc *, int, int);
211 Static device_method_t aue_methods[] = {
212 /* Device interface */
213 DEVMETHOD(device_probe, aue_match),
214 DEVMETHOD(device_attach, aue_attach),
215 DEVMETHOD(device_detach, aue_detach),
216 DEVMETHOD(device_shutdown, aue_shutdown),
219 DEVMETHOD(bus_print_child, bus_generic_print_child),
220 DEVMETHOD(bus_driver_added, bus_generic_driver_added),
223 DEVMETHOD(miibus_readreg, aue_miibus_readreg),
224 DEVMETHOD(miibus_writereg, aue_miibus_writereg),
225 DEVMETHOD(miibus_statchg, aue_miibus_statchg),
230 Static driver_t aue_driver = {
233 sizeof(struct aue_softc)
236 Static devclass_t aue_devclass;
238 DECLARE_DUMMY_MODULE(if_aue);
239 DRIVER_MODULE(aue, uhub, aue_driver, aue_devclass, usbd_driver_load, 0);
240 DRIVER_MODULE(miibus, aue, miibus_driver, miibus_devclass, 0, 0);
242 #define AUE_SETBIT(sc, reg, x) \
243 aue_csr_write_1(sc, reg, aue_csr_read_1(sc, reg) | (x))
245 #define AUE_CLRBIT(sc, reg, x) \
246 aue_csr_write_1(sc, reg, aue_csr_read_1(sc, reg) & ~(x))
249 aue_csr_read_1(struct aue_softc *sc, int reg)
251 usb_device_request_t req;
260 req.bmRequestType = UT_READ_VENDOR_DEVICE;
261 req.bRequest = AUE_UR_READREG;
262 USETW(req.wValue, 0);
263 USETW(req.wIndex, reg);
264 USETW(req.wLength, 1);
266 err = usbd_do_request(sc->aue_udev, &req, &val);
278 aue_csr_read_2(struct aue_softc *sc, int reg)
280 usb_device_request_t req;
289 req.bmRequestType = UT_READ_VENDOR_DEVICE;
290 req.bRequest = AUE_UR_READREG;
291 USETW(req.wValue, 0);
292 USETW(req.wIndex, reg);
293 USETW(req.wLength, 2);
295 err = usbd_do_request(sc->aue_udev, &req, &val);
307 aue_csr_write_1(struct aue_softc *sc, int reg, int val)
309 usb_device_request_t req;
317 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
318 req.bRequest = AUE_UR_WRITEREG;
319 USETW(req.wValue, val);
320 USETW(req.wIndex, reg);
321 USETW(req.wLength, 1);
323 err = usbd_do_request(sc->aue_udev, &req, &val);
335 aue_csr_write_2(struct aue_softc *sc, int reg, int val)
337 usb_device_request_t req;
345 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
346 req.bRequest = AUE_UR_WRITEREG;
347 USETW(req.wValue, val);
348 USETW(req.wIndex, reg);
349 USETW(req.wLength, 2);
351 err = usbd_do_request(sc->aue_udev, &req, &val);
363 * Read a word of data stored in the EEPROM at address 'addr.'
366 aue_eeprom_getword(struct aue_softc *sc, int addr, u_int16_t *dest)
371 aue_csr_write_1(sc, AUE_EE_REG, addr);
372 aue_csr_write_1(sc, AUE_EE_CTL, AUE_EECTL_READ);
374 for (i = 0; i < AUE_TIMEOUT; i++) {
375 if (aue_csr_read_1(sc, AUE_EE_CTL) & AUE_EECTL_DONE)
379 if (i == AUE_TIMEOUT)
380 if_printf(&sc->arpcom.ac_if, "EEPROM read timed out\n");
382 word = aue_csr_read_2(sc, AUE_EE_DATA);
389 * Read a sequence of words from the EEPROM.
392 aue_read_eeprom(struct aue_softc *sc, caddr_t dest, int off, int cnt, int swap)
395 u_int16_t word = 0, *ptr;
397 for (i = 0; i < cnt; i++) {
398 aue_eeprom_getword(sc, off + i, &word);
399 ptr = (u_int16_t *)(dest + (i * 2));
410 aue_miibus_readreg(device_ptr_t dev, int phy, int reg)
412 struct aue_softc *sc = USBGETSOFTC(dev);
417 * The Am79C901 HomePNA PHY actually contains
418 * two transceivers: a 1Mbps HomePNA PHY and a
419 * 10Mbps full/half duplex ethernet PHY with
420 * NWAY autoneg. However in the ADMtek adapter,
421 * only the 1Mbps PHY is actually connected to
422 * anything, so we ignore the 10Mbps one. It
423 * happens to be configured for MII address 3,
424 * so we filter that out.
426 if (sc->aue_vendor == USB_VENDOR_ADMTEK &&
427 sc->aue_product == USB_PRODUCT_ADMTEK_PEGASUS) {
436 aue_csr_write_1(sc, AUE_PHY_ADDR, phy);
437 aue_csr_write_1(sc, AUE_PHY_CTL, reg | AUE_PHYCTL_READ);
439 for (i = 0; i < AUE_TIMEOUT; i++) {
440 if (aue_csr_read_1(sc, AUE_PHY_CTL) & AUE_PHYCTL_DONE)
444 if (i == AUE_TIMEOUT)
445 if_printf(&sc->arpcom.ac_if, "MII read timed out\n");
447 val = aue_csr_read_2(sc, AUE_PHY_DATA);
453 aue_miibus_writereg(device_ptr_t dev, int phy, int reg, int data)
455 struct aue_softc *sc = USBGETSOFTC(dev);
461 aue_csr_write_2(sc, AUE_PHY_DATA, data);
462 aue_csr_write_1(sc, AUE_PHY_ADDR, phy);
463 aue_csr_write_1(sc, AUE_PHY_CTL, reg | AUE_PHYCTL_WRITE);
465 for (i = 0; i < AUE_TIMEOUT; i++) {
466 if (aue_csr_read_1(sc, AUE_PHY_CTL) & AUE_PHYCTL_DONE)
470 if (i == AUE_TIMEOUT)
471 if_printf(&sc->arpcom.ac_if, "MII read timed out\n");
477 aue_miibus_statchg(device_ptr_t dev)
479 struct aue_softc *sc = USBGETSOFTC(dev);
480 struct mii_data *mii = GET_MII(sc);
482 AUE_CLRBIT(sc, AUE_CTL0, AUE_CTL0_RX_ENB | AUE_CTL0_TX_ENB);
483 if (IFM_SUBTYPE(mii->mii_media_active) == IFM_100_TX) {
484 AUE_SETBIT(sc, AUE_CTL1, AUE_CTL1_SPEEDSEL);
486 AUE_CLRBIT(sc, AUE_CTL1, AUE_CTL1_SPEEDSEL);
489 if ((mii->mii_media_active & IFM_GMASK) == IFM_FDX)
490 AUE_SETBIT(sc, AUE_CTL1, AUE_CTL1_DUPLEX);
492 AUE_CLRBIT(sc, AUE_CTL1, AUE_CTL1_DUPLEX);
494 AUE_SETBIT(sc, AUE_CTL0, AUE_CTL0_RX_ENB | AUE_CTL0_TX_ENB);
497 * Set the LED modes on the LinkSys adapter.
498 * This turns on the 'dual link LED' bin in the auxmode
499 * register of the Broadcom PHY.
501 if (sc->aue_flags & LSYS) {
503 auxmode = aue_miibus_readreg(dev, 0, 0x1b);
504 aue_miibus_writereg(dev, 0, 0x1b, auxmode | 0x04);
513 aue_setmulti(struct aue_softc *sc)
516 struct ifmultiaddr *ifma;
519 ifp = &sc->arpcom.ac_if;
521 if (ifp->if_flags & IFF_ALLMULTI || ifp->if_flags & IFF_PROMISC) {
522 AUE_SETBIT(sc, AUE_CTL0, AUE_CTL0_ALLMULTI);
526 AUE_CLRBIT(sc, AUE_CTL0, AUE_CTL0_ALLMULTI);
528 /* first, zot all the existing hash bits */
529 for (i = 0; i < 8; i++)
530 aue_csr_write_1(sc, AUE_MAR0 + i, 0);
532 /* now program new ones */
533 LIST_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link)
535 if (ifma->ifma_addr->sa_family != AF_LINK)
537 h = ether_crc32_le(LLADDR((struct sockaddr_dl *)
538 ifma->ifma_addr), ETHER_ADDR_LEN) & ((1 << AUE_BITS) - 1);
539 AUE_SETBIT(sc, AUE_MAR + (h >> 3), 1 << (h & 0x7));
546 aue_reset_pegasus_II(struct aue_softc *sc)
548 /* Magic constants taken from Linux driver. */
549 aue_csr_write_1(sc, AUE_REG_1D, 0);
550 aue_csr_write_1(sc, AUE_REG_7B, 2);
552 if ((sc->aue_flags & HAS_HOME_PNA) && mii_mode)
553 aue_csr_write_1(sc, AUE_REG_81, 6);
556 aue_csr_write_1(sc, AUE_REG_81, 2);
560 aue_reset(struct aue_softc *sc)
564 AUE_SETBIT(sc, AUE_CTL1, AUE_CTL1_RESETMAC);
566 for (i = 0; i < AUE_TIMEOUT; i++) {
567 if (!(aue_csr_read_1(sc, AUE_CTL1) & AUE_CTL1_RESETMAC))
571 if (i == AUE_TIMEOUT)
572 if_printf(&sc->arpcom.ac_if, "reset failed\n");
575 * The PHY(s) attached to the Pegasus chip may be held
576 * in reset until we flip on the GPIO outputs. Make sure
577 * to set the GPIO pins high so that the PHY(s) will
580 * Note: We force all of the GPIO pins low first, *then*
581 * enable the ones we want.
583 aue_csr_write_1(sc, AUE_GPIO0, AUE_GPIO_OUT0|AUE_GPIO_SEL0);
584 aue_csr_write_1(sc, AUE_GPIO0, AUE_GPIO_OUT0|AUE_GPIO_SEL0|AUE_GPIO_SEL1);
586 if (sc->aue_flags & LSYS) {
587 /* Grrr. LinkSys has to be different from everyone else. */
588 aue_csr_write_1(sc, AUE_GPIO0,
589 AUE_GPIO_SEL0 | AUE_GPIO_SEL1);
590 aue_csr_write_1(sc, AUE_GPIO0,
591 AUE_GPIO_SEL0 | AUE_GPIO_SEL1 | AUE_GPIO_OUT0);
594 if (sc->aue_flags & PII)
595 aue_reset_pegasus_II(sc);
597 /* Wait a little while for the chip to get its brains in order. */
604 * Probe for a Pegasus chip.
608 USB_MATCH_START(aue, uaa);
610 if (uaa->iface != NULL)
611 return (UMATCH_NONE);
613 return (aue_lookup(uaa->vendor, uaa->product) != NULL ?
614 UMATCH_VENDOR_PRODUCT : UMATCH_NONE);
618 * Attach the interface. Allocate softc structures, do ifmedia
619 * setup and ethernet/BPF attach.
623 USB_ATTACH_START(aue, sc, uaa);
625 u_char eaddr[ETHER_ADDR_LEN];
627 usbd_interface_handle iface;
629 usb_interface_descriptor_t *id;
630 usb_endpoint_descriptor_t *ed;
633 bzero(sc, sizeof(struct aue_softc));
635 usbd_devinfo(uaa->device, 0, devinfo);
637 sc->aue_udev = uaa->device;
638 callout_init(&sc->aue_stat_timer);
640 if (usbd_set_config_no(sc->aue_udev, AUE_CONFIG_NO, 0)) {
641 device_printf(self, "setting config no %d failed\n",
643 USB_ATTACH_ERROR_RETURN;
646 err = usbd_device2interface_handle(uaa->device, AUE_IFACE_IDX, &iface);
648 device_printf(self, "getting interface handle failed\n");
649 USB_ATTACH_ERROR_RETURN;
652 sc->aue_iface = iface;
653 sc->aue_flags = aue_lookup(uaa->vendor, uaa->product)->aue_flags;
655 sc->aue_product = uaa->product;
656 sc->aue_vendor = uaa->vendor;
658 id = usbd_get_interface_descriptor(sc->aue_iface);
660 usbd_devinfo(uaa->device, 0, devinfo);
661 device_set_desc_copy(self, devinfo);
662 device_printf(self, "%s\n", devinfo);
664 /* Find endpoints. */
665 for (i = 0; i < id->bNumEndpoints; i++) {
666 ed = usbd_interface2endpoint_descriptor(iface, i);
668 device_printf(self, "couldn't get ep %d\n", i);
669 USB_ATTACH_ERROR_RETURN;
671 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
672 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
673 sc->aue_ed[AUE_ENDPT_RX] = ed->bEndpointAddress;
674 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
675 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
676 sc->aue_ed[AUE_ENDPT_TX] = ed->bEndpointAddress;
677 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
678 UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
679 sc->aue_ed[AUE_ENDPT_INTR] = ed->bEndpointAddress;
685 ifp = &sc->arpcom.ac_if;
686 if_initname(ifp, device_get_name(self), device_get_unit(self));
688 /* Reset the adapter. */
692 * Get station address from the EEPROM.
694 aue_read_eeprom(sc, (caddr_t)&eaddr, 0, 3, 0);
697 ifp->if_mtu = ETHERMTU;
698 ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
699 ifp->if_ioctl = aue_ioctl;
700 ifp->if_start = aue_start;
701 ifp->if_watchdog = aue_watchdog;
702 ifp->if_init = aue_init;
703 ifp->if_baudrate = 10000000;
704 ifq_set_maxlen(&ifp->if_snd, IFQ_MAXLEN);
705 ifq_set_ready(&ifp->if_snd);
709 * NOTE: Doing this causes child devices to be attached to us,
710 * which we would normally disconnect at in the detach routine
711 * using device_delete_child(). However the USB code is set up
712 * such that when this driver is removed, all children devices
713 * are removed as well. In effect, the USB code ends up detaching
714 * all of our children for us, so we don't have to do is ourselves
715 * in aue_detach(). It's important to point this out since if
716 * we *do* try to detach the child devices ourselves, we will
717 * end up getting the children deleted twice, which will crash
720 if (mii_phy_probe(self, &sc->aue_miibus,
721 aue_ifmedia_upd, aue_ifmedia_sts)) {
722 device_printf(self, "MII without any PHY!\n");
724 USB_ATTACH_ERROR_RETURN;
728 * Call MI attach routine.
730 ether_ifattach(ifp, eaddr);
731 usb_register_netisr();
735 USB_ATTACH_SUCCESS_RETURN;
739 aue_detach(device_ptr_t dev)
741 struct aue_softc *sc;
744 sc = device_get_softc(dev);
746 ifp = &sc->arpcom.ac_if;
749 callout_stop(&sc->aue_stat_timer);
752 if (sc->aue_ep[AUE_ENDPT_TX] != NULL)
753 usbd_abort_pipe(sc->aue_ep[AUE_ENDPT_TX]);
754 if (sc->aue_ep[AUE_ENDPT_RX] != NULL)
755 usbd_abort_pipe(sc->aue_ep[AUE_ENDPT_RX]);
757 if (sc->aue_ep[AUE_ENDPT_INTR] != NULL)
758 usbd_abort_pipe(sc->aue_ep[AUE_ENDPT_INTR]);
767 * Initialize an RX descriptor and attach an MBUF cluster.
770 aue_newbuf(struct aue_softc *sc, struct aue_chain *c, struct mbuf *m)
772 struct mbuf *m_new = NULL;
775 m_new = m_getcl(MB_DONTWAIT, MT_DATA, M_PKTHDR);
777 if_printf(&sc->arpcom.ac_if,
778 "no memory for rx list -- packet dropped!\n");
781 m_new->m_len = m_new->m_pkthdr.len = MCLBYTES;
784 m_new->m_len = m_new->m_pkthdr.len = MCLBYTES;
785 m_new->m_data = m_new->m_ext.ext_buf;
788 m_adj(m_new, ETHER_ALIGN);
795 aue_rx_list_init(struct aue_softc *sc)
797 struct aue_cdata *cd;
802 for (i = 0; i < AUE_RX_LIST_CNT; i++) {
803 c = &cd->aue_rx_chain[i];
806 if (aue_newbuf(sc, c, NULL) == ENOBUFS)
808 if (c->aue_xfer == NULL) {
809 c->aue_xfer = usbd_alloc_xfer(sc->aue_udev);
810 if (c->aue_xfer == NULL)
819 aue_tx_list_init(struct aue_softc *sc)
821 struct aue_cdata *cd;
826 for (i = 0; i < AUE_TX_LIST_CNT; i++) {
827 c = &cd->aue_tx_chain[i];
831 if (c->aue_xfer == NULL) {
832 c->aue_xfer = usbd_alloc_xfer(sc->aue_udev);
833 if (c->aue_xfer == NULL)
836 c->aue_buf = malloc(AUE_BUFSZ, M_USBDEV, M_WAITOK);
837 if (c->aue_buf == NULL)
846 aue_intr(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
848 struct aue_softc *sc = priv;
850 struct aue_intrpkt *p;
853 ifp = &sc->arpcom.ac_if;
855 if (!(ifp->if_flags & IFF_RUNNING)) {
860 if (status != USBD_NORMAL_COMPLETION) {
861 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) {
865 if_printf(ifp, "usb error on intr: %s\n", usbd_errstr(status));
866 if (status == USBD_STALLED)
867 usbd_clear_endpoint_stall(sc->aue_ep[AUE_ENDPT_RX]);
872 usbd_get_xfer_status(xfer, NULL, (void **)&p, NULL, NULL);
877 if (p->aue_txstat0 & (AUE_TXSTAT0_LATECOLL & AUE_TXSTAT0_EXCESSCOLL))
878 ifp->if_collisions++;
886 aue_rxstart(struct ifnet *ifp)
888 struct aue_softc *sc;
893 c = &sc->aue_cdata.aue_rx_chain[sc->aue_cdata.aue_rx_prod];
895 if (aue_newbuf(sc, c, NULL) == ENOBUFS) {
901 /* Setup new transfer. */
902 usbd_setup_xfer(c->aue_xfer, sc->aue_ep[AUE_ENDPT_RX],
903 c, mtod(c->aue_mbuf, char *), AUE_BUFSZ, USBD_SHORT_XFER_OK,
904 USBD_NO_TIMEOUT, aue_rxeof);
905 usbd_transfer(c->aue_xfer);
912 * A frame has been uploaded: pass the resulting mbuf chain up to
913 * the higher level protocols.
916 aue_rxeof(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
918 struct aue_chain *c = priv;
919 struct aue_softc *sc = c->aue_sc;
928 ifp = &sc->arpcom.ac_if;
930 if (!(ifp->if_flags & IFF_RUNNING)) {
935 if (status != USBD_NORMAL_COMPLETION) {
936 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) {
940 if (usbd_ratecheck(&sc->aue_rx_notice)) {
941 if_printf(ifp, "usb error on rx: %s\n",
942 usbd_errstr(status));
944 if (status == USBD_STALLED)
945 usbd_clear_endpoint_stall(sc->aue_ep[AUE_ENDPT_RX]);
949 usbd_get_xfer_status(xfer, NULL, NULL, &total_len, NULL);
951 if (total_len <= 4 + ETHER_CRC_LEN) {
957 bcopy(mtod(m, char *) + total_len - 4, (char *)&r, sizeof(r));
959 /* Turn off all the non-error bits in the rx status word. */
960 r.aue_rxstat &= AUE_RXSTAT_MASK;
967 /* No errors; receive the packet. */
968 total_len -= (4 + ETHER_CRC_LEN);
971 m->m_pkthdr.rcvif = ifp;
972 m->m_pkthdr.len = m->m_len = total_len;
974 /* Put the packet on the special USB input queue. */
977 if (!ifq_is_empty(&ifp->if_snd))
978 (*ifp->if_start)(ifp);
983 /* Setup new transfer. */
984 usbd_setup_xfer(xfer, sc->aue_ep[AUE_ENDPT_RX],
985 c, mtod(c->aue_mbuf, char *), AUE_BUFSZ, USBD_SHORT_XFER_OK,
986 USBD_NO_TIMEOUT, aue_rxeof);
994 * A frame was downloaded to the chip. It's safe for us to clean up
999 aue_txeof(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
1001 struct aue_chain *c = priv;
1002 struct aue_softc *sc = c->aue_sc;
1007 ifp = &sc->arpcom.ac_if;
1009 if (status != USBD_NORMAL_COMPLETION) {
1010 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) {
1014 if_printf(ifp, "usb error on tx: %s\n", usbd_errstr(status));
1015 if (status == USBD_STALLED)
1016 usbd_clear_endpoint_stall(sc->aue_ep[AUE_ENDPT_TX]);
1022 ifp->if_flags &= ~IFF_OACTIVE;
1023 usbd_get_xfer_status(c->aue_xfer, NULL, NULL, NULL, &err);
1025 if (c->aue_mbuf != NULL) {
1026 m_free(c->aue_mbuf);
1035 if (!ifq_is_empty(&ifp->if_snd))
1036 (*ifp->if_start)(ifp);
1046 struct aue_softc *sc = xsc;
1048 struct mii_data *mii;
1055 ifp = &sc->arpcom.ac_if;
1063 if (!sc->aue_link && mii->mii_media_status & IFM_ACTIVE &&
1064 IFM_SUBTYPE(mii->mii_media_active) != IFM_NONE) {
1066 if (!ifq_is_empty(&ifp->if_snd))
1070 callout_reset(&sc->aue_stat_timer, hz, aue_tick, sc);
1078 aue_encap(struct aue_softc *sc, struct mbuf *m, int idx)
1081 struct aue_chain *c;
1084 c = &sc->aue_cdata.aue_tx_chain[idx];
1087 * Copy the mbuf data into a contiguous buffer, leaving two
1088 * bytes at the beginning to hold the frame length.
1090 m_copydata(m, 0, m->m_pkthdr.len, c->aue_buf + 2);
1093 total_len = m->m_pkthdr.len + 2;
1096 * The ADMtek documentation says that the packet length is
1097 * supposed to be specified in the first two bytes of the
1098 * transfer, however it actually seems to ignore this info
1099 * and base the frame size on the bulk transfer length.
1101 c->aue_buf[0] = (u_int8_t)m->m_pkthdr.len;
1102 c->aue_buf[1] = (u_int8_t)(m->m_pkthdr.len >> 8);
1104 usbd_setup_xfer(c->aue_xfer, sc->aue_ep[AUE_ENDPT_TX],
1105 c, c->aue_buf, total_len, USBD_FORCE_SHORT_XFER,
1109 err = usbd_transfer(c->aue_xfer);
1110 if (err != USBD_IN_PROGRESS) {
1115 sc->aue_cdata.aue_tx_cnt++;
1121 aue_start(struct ifnet *ifp)
1123 struct aue_softc *sc = ifp->if_softc;
1124 struct mbuf *m_head = NULL;
1128 if (!sc->aue_link) {
1133 if (ifp->if_flags & IFF_OACTIVE) {
1138 m_head = ifq_poll(&ifp->if_snd);
1139 if (m_head == NULL) {
1144 if (aue_encap(sc, m_head, 0)) {
1145 ifp->if_flags |= IFF_OACTIVE;
1149 m_head = ifq_dequeue(&ifp->if_snd);
1152 * If there's a BPF listener, bounce a copy of this frame
1155 BPF_MTAP(ifp, m_head);
1157 ifp->if_flags |= IFF_OACTIVE;
1160 * Set a timeout in case the chip goes out to lunch.
1171 struct aue_softc *sc = xsc;
1172 struct ifnet *ifp = &sc->arpcom.ac_if;
1173 struct mii_data *mii = GET_MII(sc);
1174 struct aue_chain *c;
1180 if (ifp->if_flags & IFF_RUNNING) {
1186 * Cancel pending I/O and free all RX/TX buffers.
1190 /* Set MAC address */
1191 for (i = 0; i < ETHER_ADDR_LEN; i++)
1192 aue_csr_write_1(sc, AUE_PAR0 + i, sc->arpcom.ac_enaddr[i]);
1194 /* If we want promiscuous mode, set the allframes bit. */
1195 if (ifp->if_flags & IFF_PROMISC)
1196 AUE_SETBIT(sc, AUE_CTL2, AUE_CTL2_RX_PROMISC);
1198 AUE_CLRBIT(sc, AUE_CTL2, AUE_CTL2_RX_PROMISC);
1201 if (aue_tx_list_init(sc) == ENOBUFS) {
1202 if_printf(&sc->arpcom.ac_if, "tx list init failed\n");
1208 if (aue_rx_list_init(sc) == ENOBUFS) {
1209 if_printf(&sc->arpcom.ac_if, "rx list init failed\n");
1214 #ifdef AUE_INTR_PIPE
1215 sc->aue_cdata.aue_ibuf = malloc(AUE_INTR_PKTLEN, M_USBDEV, M_WAITOK);
1218 /* Load the multicast filter. */
1221 /* Enable RX and TX */
1222 aue_csr_write_1(sc, AUE_CTL0, AUE_CTL0_RXSTAT_APPEND | AUE_CTL0_RX_ENB);
1223 AUE_SETBIT(sc, AUE_CTL0, AUE_CTL0_TX_ENB);
1224 AUE_SETBIT(sc, AUE_CTL2, AUE_CTL2_EP3_CLR);
1228 /* Open RX and TX pipes. */
1229 err = usbd_open_pipe(sc->aue_iface, sc->aue_ed[AUE_ENDPT_RX],
1230 USBD_EXCLUSIVE_USE, &sc->aue_ep[AUE_ENDPT_RX]);
1232 if_printf(&sc->arpcom.ac_if, "open rx pipe failed: %s\n",
1237 err = usbd_open_pipe(sc->aue_iface, sc->aue_ed[AUE_ENDPT_TX],
1238 USBD_EXCLUSIVE_USE, &sc->aue_ep[AUE_ENDPT_TX]);
1240 if_printf(&sc->arpcom.ac_if, "open tx pipe failed: %s\n",
1246 #ifdef AUE_INTR_PIPE
1247 err = usbd_open_pipe_intr(sc->aue_iface, sc->aue_ed[AUE_ENDPT_INTR],
1248 USBD_SHORT_XFER_OK, &sc->aue_ep[AUE_ENDPT_INTR], sc,
1249 sc->aue_cdata.aue_ibuf, AUE_INTR_PKTLEN, aue_intr,
1252 if_printf(&sc->arpcom.ac_if, "open intr pipe failed: %s\n",
1259 /* Start up the receive pipe. */
1260 for (i = 0; i < AUE_RX_LIST_CNT; i++) {
1261 c = &sc->aue_cdata.aue_rx_chain[i];
1262 usbd_setup_xfer(c->aue_xfer, sc->aue_ep[AUE_ENDPT_RX],
1263 c, mtod(c->aue_mbuf, char *), AUE_BUFSZ,
1264 USBD_SHORT_XFER_OK, USBD_NO_TIMEOUT, aue_rxeof);
1265 usbd_transfer(c->aue_xfer);
1268 ifp->if_flags |= IFF_RUNNING;
1269 ifp->if_flags &= ~IFF_OACTIVE;
1271 callout_reset(&sc->aue_stat_timer, hz, aue_tick, sc);
1279 * Set media options.
1282 aue_ifmedia_upd(struct ifnet *ifp)
1284 struct aue_softc *sc = ifp->if_softc;
1285 struct mii_data *mii = GET_MII(sc);
1288 if (mii->mii_instance) {
1289 struct mii_softc *miisc;
1290 LIST_FOREACH(miisc, &mii->mii_phys, mii_list)
1291 mii_phy_reset(miisc);
1299 * Report current media status.
1302 aue_ifmedia_sts(struct ifnet *ifp, struct ifmediareq *ifmr)
1304 struct aue_softc *sc = ifp->if_softc;
1305 struct mii_data *mii = GET_MII(sc);
1308 ifmr->ifm_active = mii->mii_media_active;
1309 ifmr->ifm_status = mii->mii_media_status;
1315 aue_ioctl(struct ifnet *ifp, u_long command, caddr_t data, struct ucred *cr)
1317 struct aue_softc *sc = ifp->if_softc;
1318 struct ifreq *ifr = (struct ifreq *)data;
1319 struct mii_data *mii;
1326 if (ifp->if_flags & IFF_UP) {
1327 if (ifp->if_flags & IFF_RUNNING &&
1328 ifp->if_flags & IFF_PROMISC &&
1329 !(sc->aue_if_flags & IFF_PROMISC)) {
1330 AUE_SETBIT(sc, AUE_CTL2, AUE_CTL2_RX_PROMISC);
1331 } else if (ifp->if_flags & IFF_RUNNING &&
1332 !(ifp->if_flags & IFF_PROMISC) &&
1333 sc->aue_if_flags & IFF_PROMISC) {
1334 AUE_CLRBIT(sc, AUE_CTL2, AUE_CTL2_RX_PROMISC);
1335 } else if (!(ifp->if_flags & IFF_RUNNING))
1338 if (ifp->if_flags & IFF_RUNNING)
1341 sc->aue_if_flags = ifp->if_flags;
1352 error = ifmedia_ioctl(ifp, ifr, &mii->mii_media, command);
1355 error = ether_ioctl(ifp, command, data);
1365 aue_watchdog(struct ifnet *ifp)
1367 struct aue_softc *sc = ifp->if_softc;
1368 struct aue_chain *c;
1374 if_printf(ifp, "watchdog timeout\n");
1376 c = &sc->aue_cdata.aue_tx_chain[0];
1377 usbd_get_xfer_status(c->aue_xfer, NULL, NULL, NULL, &stat);
1378 aue_txeof(c->aue_xfer, c, stat);
1380 if (!ifq_is_empty(&ifp->if_snd))
1387 * Stop the adapter and free any mbufs allocated to the
1391 aue_stop(struct aue_softc *sc)
1398 ifp = &sc->arpcom.ac_if;
1401 aue_csr_write_1(sc, AUE_CTL0, 0);
1402 aue_csr_write_1(sc, AUE_CTL1, 0);
1404 callout_stop(&sc->aue_stat_timer);
1406 /* Stop transfers. */
1407 if (sc->aue_ep[AUE_ENDPT_RX] != NULL) {
1408 err = usbd_abort_pipe(sc->aue_ep[AUE_ENDPT_RX]);
1410 if_printf(ifp, "abort rx pipe failed: %s\n",
1413 err = usbd_close_pipe(sc->aue_ep[AUE_ENDPT_RX]);
1415 if_printf(ifp, "close rx pipe failed: %s\n",
1418 sc->aue_ep[AUE_ENDPT_RX] = NULL;
1421 if (sc->aue_ep[AUE_ENDPT_TX] != NULL) {
1422 err = usbd_abort_pipe(sc->aue_ep[AUE_ENDPT_TX]);
1424 if_printf(ifp, "abort tx pipe failed: %s\n",
1427 err = usbd_close_pipe(sc->aue_ep[AUE_ENDPT_TX]);
1429 if_printf(ifp, "close tx pipe failed: %s\n",
1432 sc->aue_ep[AUE_ENDPT_TX] = NULL;
1435 #ifdef AUE_INTR_PIPE
1436 if (sc->aue_ep[AUE_ENDPT_INTR] != NULL) {
1437 err = usbd_abort_pipe(sc->aue_ep[AUE_ENDPT_INTR]);
1439 if_printf(ifp, "abort intr pipe failed: %s\n",
1442 err = usbd_close_pipe(sc->aue_ep[AUE_ENDPT_INTR]);
1444 if_printf(ifp, "close intr pipe failed: %s\n",
1447 sc->aue_ep[AUE_ENDPT_INTR] = NULL;
1451 /* Free RX resources. */
1452 for (i = 0; i < AUE_RX_LIST_CNT; i++) {
1453 if (sc->aue_cdata.aue_rx_chain[i].aue_buf != NULL) {
1454 free(sc->aue_cdata.aue_rx_chain[i].aue_buf, M_USBDEV);
1455 sc->aue_cdata.aue_rx_chain[i].aue_buf = NULL;
1457 if (sc->aue_cdata.aue_rx_chain[i].aue_mbuf != NULL) {
1458 m_freem(sc->aue_cdata.aue_rx_chain[i].aue_mbuf);
1459 sc->aue_cdata.aue_rx_chain[i].aue_mbuf = NULL;
1461 if (sc->aue_cdata.aue_rx_chain[i].aue_xfer != NULL) {
1462 usbd_free_xfer(sc->aue_cdata.aue_rx_chain[i].aue_xfer);
1463 sc->aue_cdata.aue_rx_chain[i].aue_xfer = NULL;
1467 /* Free TX resources. */
1468 for (i = 0; i < AUE_TX_LIST_CNT; i++) {
1469 if (sc->aue_cdata.aue_tx_chain[i].aue_buf != NULL) {
1470 free(sc->aue_cdata.aue_tx_chain[i].aue_buf, M_USBDEV);
1471 sc->aue_cdata.aue_tx_chain[i].aue_buf = NULL;
1473 if (sc->aue_cdata.aue_tx_chain[i].aue_mbuf != NULL) {
1474 m_freem(sc->aue_cdata.aue_tx_chain[i].aue_mbuf);
1475 sc->aue_cdata.aue_tx_chain[i].aue_mbuf = NULL;
1477 if (sc->aue_cdata.aue_tx_chain[i].aue_xfer != NULL) {
1478 usbd_free_xfer(sc->aue_cdata.aue_tx_chain[i].aue_xfer);
1479 sc->aue_cdata.aue_tx_chain[i].aue_xfer = NULL;
1483 #ifdef AUE_INTR_PIPE
1484 free(sc->aue_cdata.aue_ibuf, M_USBDEV);
1485 sc->aue_cdata.aue_ibuf = NULL;
1490 ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
1497 * Stop all chip I/O so that the kernel's probe routines don't
1498 * get confused by errant DMAs when rebooting.
1501 aue_shutdown(device_ptr_t dev)
1503 struct aue_softc *sc;
1505 sc = device_get_softc(dev);