if_aue.c revision 199816
1/*- 2 * Copyright (c) 1997, 1998, 1999, 2000 3 * Bill Paul <wpaul@ee.columbia.edu>. All rights reserved. 4 * 5 * Copyright (c) 2006 6 * Alfred Perlstein <alfred@FreeBSD.org>. All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 3. All advertising materials mentioning features or use of this software 17 * must display the following acknowledgement: 18 * This product includes software developed by Bill Paul. 19 * 4. Neither the name of the author nor the names of any co-contributors 20 * may be used to endorse or promote products derived from this software 21 * without specific prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26 * ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD 27 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 33 * THE POSSIBILITY OF SUCH DAMAGE. 34 */ 35 36#include <sys/cdefs.h> 37__FBSDID("$FreeBSD: head/sys/dev/usb/net/if_aue.c 199816 2009-11-26 00:43:17Z thompsa $"); 38 39/* 40 * ADMtek AN986 Pegasus and AN8511 Pegasus II USB to ethernet driver. 41 * Datasheet is available from http://www.admtek.com.tw. 42 * 43 * Written by Bill Paul <wpaul@ee.columbia.edu> 44 * Electrical Engineering Department 45 * Columbia University, New York City 46 * 47 * SMP locking by Alfred Perlstein <alfred@FreeBSD.org>. 48 * RED Inc. 49 */ 50 51/* 52 * The Pegasus chip uses four USB "endpoints" to provide 10/100 ethernet 53 * support: the control endpoint for reading/writing registers, burst 54 * read endpoint for packet reception, burst write for packet transmission 55 * and one for "interrupts." The chip uses the same RX filter scheme 56 * as the other ADMtek ethernet parts: one perfect filter entry for the 57 * the station address and a 64-bit multicast hash table. The chip supports 58 * both MII and HomePNA attachments. 59 * 60 * Since the maximum data transfer speed of USB is supposed to be 12Mbps, 61 * you're never really going to get 100Mbps speeds from this device. I 62 * think the idea is to allow the device to connect to 10 or 100Mbps 63 * networks, not necessarily to provide 100Mbps performance. Also, since 64 * the controller uses an external PHY chip, it's possible that board 65 * designers might simply choose a 10Mbps PHY. 66 * 67 * Registers are accessed using uether_do_request(). Packet 68 * transfers are done using usbd_transfer() and friends. 69 */ 70 71#include <sys/stdint.h> 72#include <sys/stddef.h> 73#include <sys/param.h> 74#include <sys/queue.h> 75#include <sys/types.h> 76#include <sys/systm.h> 77#include <sys/kernel.h> 78#include <sys/bus.h> 79#include <sys/linker_set.h> 80#include <sys/module.h> 81#include <sys/lock.h> 82#include <sys/mutex.h> 83#include <sys/condvar.h> 84#include <sys/sysctl.h> 85#include <sys/sx.h> 86#include <sys/unistd.h> 87#include <sys/callout.h> 88#include <sys/malloc.h> 89#include <sys/priv.h> 90 91#include <dev/usb/usb.h> 92#include <dev/usb/usbdi.h> 93#include <dev/usb/usbdi_util.h> 94#include "usbdevs.h" 95 96#define USB_DEBUG_VAR aue_debug 97#include <dev/usb/usb_debug.h> 98#include <dev/usb/usb_process.h> 99 100#include <dev/usb/net/usb_ethernet.h> 101#include <dev/usb/net/if_auereg.h> 102 103#if USB_DEBUG 104static int aue_debug = 0; 105 106SYSCTL_NODE(_hw_usb, OID_AUTO, aue, CTLFLAG_RW, 0, "USB aue"); 107SYSCTL_INT(_hw_usb_aue, OID_AUTO, debug, CTLFLAG_RW, &aue_debug, 0, 108 "Debug level"); 109#endif 110 111/* 112 * Various supported device vendors/products. 113 */ 114static const struct usb_device_id aue_devs[] = { 115 {USB_VPI(USB_VENDOR_3COM, USB_PRODUCT_3COM_3C460B, AUE_FLAG_PII)}, 116 {USB_VPI(USB_VENDOR_ABOCOM, USB_PRODUCT_ABOCOM_DSB650TX_PNA, 0)}, 117 {USB_VPI(USB_VENDOR_ABOCOM, USB_PRODUCT_ABOCOM_UFE1000, AUE_FLAG_LSYS)}, 118 {USB_VPI(USB_VENDOR_ABOCOM, USB_PRODUCT_ABOCOM_XX10, 0)}, 119 {USB_VPI(USB_VENDOR_ABOCOM, USB_PRODUCT_ABOCOM_XX1, AUE_FLAG_PNA | AUE_FLAG_PII)}, 120 {USB_VPI(USB_VENDOR_ABOCOM, USB_PRODUCT_ABOCOM_XX2, AUE_FLAG_PII)}, 121 {USB_VPI(USB_VENDOR_ABOCOM, USB_PRODUCT_ABOCOM_XX4, AUE_FLAG_PNA)}, 122 {USB_VPI(USB_VENDOR_ABOCOM, USB_PRODUCT_ABOCOM_XX5, AUE_FLAG_PNA)}, 123 {USB_VPI(USB_VENDOR_ABOCOM, USB_PRODUCT_ABOCOM_XX6, AUE_FLAG_PII)}, 124 {USB_VPI(USB_VENDOR_ABOCOM, USB_PRODUCT_ABOCOM_XX7, AUE_FLAG_PII)}, 125 {USB_VPI(USB_VENDOR_ABOCOM, USB_PRODUCT_ABOCOM_XX8, AUE_FLAG_PII)}, 126 {USB_VPI(USB_VENDOR_ABOCOM, USB_PRODUCT_ABOCOM_XX9, AUE_FLAG_PNA)}, 127 {USB_VPI(USB_VENDOR_ACCTON, USB_PRODUCT_ACCTON_SS1001, AUE_FLAG_PII)}, 128 {USB_VPI(USB_VENDOR_ACCTON, USB_PRODUCT_ACCTON_USB320_EC, 0)}, 129 {USB_VPI(USB_VENDOR_ADMTEK, USB_PRODUCT_ADMTEK_PEGASUSII_2, AUE_FLAG_PII)}, 130 {USB_VPI(USB_VENDOR_ADMTEK, USB_PRODUCT_ADMTEK_PEGASUSII_3, AUE_FLAG_PII)}, 131 {USB_VPI(USB_VENDOR_ADMTEK, USB_PRODUCT_ADMTEK_PEGASUSII_4, AUE_FLAG_PII)}, 132 {USB_VPI(USB_VENDOR_ADMTEK, USB_PRODUCT_ADMTEK_PEGASUSII, AUE_FLAG_PII)}, 133 {USB_VPI(USB_VENDOR_ADMTEK, USB_PRODUCT_ADMTEK_PEGASUS, AUE_FLAG_PNA | AUE_FLAG_DUAL_PHY)}, 134 {USB_VPI(USB_VENDOR_AEI, USB_PRODUCT_AEI_FASTETHERNET, AUE_FLAG_PII)}, 135 {USB_VPI(USB_VENDOR_ALLIEDTELESYN, USB_PRODUCT_ALLIEDTELESYN_ATUSB100, AUE_FLAG_PII)}, 136 {USB_VPI(USB_VENDOR_ATEN, USB_PRODUCT_ATEN_UC110T, AUE_FLAG_PII)}, 137 {USB_VPI(USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_USB2LAN, AUE_FLAG_PII)}, 138 {USB_VPI(USB_VENDOR_BILLIONTON, USB_PRODUCT_BILLIONTON_USB100, 0)}, 139 {USB_VPI(USB_VENDOR_BILLIONTON, USB_PRODUCT_BILLIONTON_USBE100, AUE_FLAG_PII)}, 140 {USB_VPI(USB_VENDOR_BILLIONTON, USB_PRODUCT_BILLIONTON_USBEL100, 0)}, 141 {USB_VPI(USB_VENDOR_BILLIONTON, USB_PRODUCT_BILLIONTON_USBLP100, AUE_FLAG_PNA)}, 142 {USB_VPI(USB_VENDOR_COREGA, USB_PRODUCT_COREGA_FETHER_USB_TXS, AUE_FLAG_PII)}, 143 {USB_VPI(USB_VENDOR_COREGA, USB_PRODUCT_COREGA_FETHER_USB_TX, 0)}, 144 {USB_VPI(USB_VENDOR_DLINK, USB_PRODUCT_DLINK_DSB650TX1, AUE_FLAG_LSYS)}, 145 {USB_VPI(USB_VENDOR_DLINK, USB_PRODUCT_DLINK_DSB650TX2, AUE_FLAG_LSYS | AUE_FLAG_PII)}, 146 {USB_VPI(USB_VENDOR_DLINK, USB_PRODUCT_DLINK_DSB650TX3, AUE_FLAG_LSYS | AUE_FLAG_PII)}, 147 {USB_VPI(USB_VENDOR_DLINK, USB_PRODUCT_DLINK_DSB650TX4, AUE_FLAG_LSYS | AUE_FLAG_PII)}, 148 {USB_VPI(USB_VENDOR_DLINK, USB_PRODUCT_DLINK_DSB650TX_PNA, AUE_FLAG_PNA)}, 149 {USB_VPI(USB_VENDOR_DLINK, USB_PRODUCT_DLINK_DSB650TX, AUE_FLAG_LSYS)}, 150 {USB_VPI(USB_VENDOR_DLINK, USB_PRODUCT_DLINK_DSB650, AUE_FLAG_LSYS)}, 151 {USB_VPI(USB_VENDOR_ELCON, USB_PRODUCT_ELCON_PLAN, AUE_FLAG_PNA | AUE_FLAG_PII)}, 152 {USB_VPI(USB_VENDOR_ELECOM, USB_PRODUCT_ELECOM_LDUSB20, AUE_FLAG_PII)}, 153 {USB_VPI(USB_VENDOR_ELECOM, USB_PRODUCT_ELECOM_LDUSBLTX, AUE_FLAG_PII)}, 154 {USB_VPI(USB_VENDOR_ELECOM, USB_PRODUCT_ELECOM_LDUSBTX0, 0)}, 155 {USB_VPI(USB_VENDOR_ELECOM, USB_PRODUCT_ELECOM_LDUSBTX1, AUE_FLAG_LSYS)}, 156 {USB_VPI(USB_VENDOR_ELECOM, USB_PRODUCT_ELECOM_LDUSBTX2, 0)}, 157 {USB_VPI(USB_VENDOR_ELECOM, USB_PRODUCT_ELECOM_LDUSBTX3, AUE_FLAG_LSYS)}, 158 {USB_VPI(USB_VENDOR_ELSA, USB_PRODUCT_ELSA_USB2ETHERNET, 0)}, 159 {USB_VPI(USB_VENDOR_GIGABYTE, USB_PRODUCT_GIGABYTE_GNBR402W, 0)}, 160 {USB_VPI(USB_VENDOR_HAWKING, USB_PRODUCT_HAWKING_UF100, AUE_FLAG_PII)}, 161 {USB_VPI(USB_VENDOR_HP, USB_PRODUCT_HP_HN210E, AUE_FLAG_PII)}, 162 {USB_VPI(USB_VENDOR_IODATA, USB_PRODUCT_IODATA_USBETTXS, AUE_FLAG_PII)}, 163 {USB_VPI(USB_VENDOR_IODATA, USB_PRODUCT_IODATA_USBETTX, 0)}, 164 {USB_VPI(USB_VENDOR_KINGSTON, USB_PRODUCT_KINGSTON_KNU101TX, 0)}, 165 {USB_VPI(USB_VENDOR_LINKSYS, USB_PRODUCT_LINKSYS_USB100H1, AUE_FLAG_LSYS | AUE_FLAG_PNA)}, 166 {USB_VPI(USB_VENDOR_LINKSYS, USB_PRODUCT_LINKSYS_USB100TX, AUE_FLAG_LSYS)}, 167 {USB_VPI(USB_VENDOR_LINKSYS, USB_PRODUCT_LINKSYS_USB10TA, AUE_FLAG_LSYS)}, 168 {USB_VPI(USB_VENDOR_LINKSYS, USB_PRODUCT_LINKSYS_USB10TX1, AUE_FLAG_LSYS | AUE_FLAG_PII)}, 169 {USB_VPI(USB_VENDOR_LINKSYS, USB_PRODUCT_LINKSYS_USB10TX2, AUE_FLAG_LSYS | AUE_FLAG_PII)}, 170 {USB_VPI(USB_VENDOR_LINKSYS, USB_PRODUCT_LINKSYS_USB10T, AUE_FLAG_LSYS)}, 171 {USB_VPI(USB_VENDOR_MELCO, USB_PRODUCT_MELCO_LUA2TX5, AUE_FLAG_PII)}, 172 {USB_VPI(USB_VENDOR_MELCO, USB_PRODUCT_MELCO_LUATX1, 0)}, 173 {USB_VPI(USB_VENDOR_MELCO, USB_PRODUCT_MELCO_LUATX5, 0)}, 174 {USB_VPI(USB_VENDOR_MICROSOFT, USB_PRODUCT_MICROSOFT_MN110, AUE_FLAG_PII)}, 175 {USB_VPI(USB_VENDOR_NETGEAR, USB_PRODUCT_NETGEAR_FA101, AUE_FLAG_PII)}, 176 {USB_VPI(USB_VENDOR_SIEMENS, USB_PRODUCT_SIEMENS_SPEEDSTREAM, AUE_FLAG_PII)}, 177 {USB_VPI(USB_VENDOR_SIIG2, USB_PRODUCT_SIIG2_USBTOETHER, AUE_FLAG_PII)}, 178 {USB_VPI(USB_VENDOR_SMARTBRIDGES, USB_PRODUCT_SMARTBRIDGES_SMARTNIC, AUE_FLAG_PII)}, 179 {USB_VPI(USB_VENDOR_SMC, USB_PRODUCT_SMC_2202USB, 0)}, 180 {USB_VPI(USB_VENDOR_SMC, USB_PRODUCT_SMC_2206USB, AUE_FLAG_PII)}, 181 {USB_VPI(USB_VENDOR_SOHOWARE, USB_PRODUCT_SOHOWARE_NUB100, 0)}, 182 {USB_VPI(USB_VENDOR_SOHOWARE, USB_PRODUCT_SOHOWARE_NUB110, AUE_FLAG_PII)}, 183}; 184 185/* prototypes */ 186 187static device_probe_t aue_probe; 188static device_attach_t aue_attach; 189static device_detach_t aue_detach; 190static miibus_readreg_t aue_miibus_readreg; 191static miibus_writereg_t aue_miibus_writereg; 192static miibus_statchg_t aue_miibus_statchg; 193 194static usb_callback_t aue_intr_callback; 195static usb_callback_t aue_bulk_read_callback; 196static usb_callback_t aue_bulk_write_callback; 197 198static uether_fn_t aue_attach_post; 199static uether_fn_t aue_init; 200static uether_fn_t aue_stop; 201static uether_fn_t aue_start; 202static uether_fn_t aue_tick; 203static uether_fn_t aue_setmulti; 204static uether_fn_t aue_setpromisc; 205 206static uint8_t aue_csr_read_1(struct aue_softc *, uint16_t); 207static uint16_t aue_csr_read_2(struct aue_softc *, uint16_t); 208static void aue_csr_write_1(struct aue_softc *, uint16_t, uint8_t); 209static void aue_csr_write_2(struct aue_softc *, uint16_t, uint16_t); 210static void aue_eeprom_getword(struct aue_softc *, int, uint16_t *); 211static void aue_read_eeprom(struct aue_softc *, uint8_t *, uint16_t, 212 uint16_t); 213static void aue_reset(struct aue_softc *); 214static void aue_reset_pegasus_II(struct aue_softc *); 215 216static int aue_ifmedia_upd(struct ifnet *); 217static void aue_ifmedia_sts(struct ifnet *, struct ifmediareq *); 218 219static const struct usb_config aue_config[AUE_N_TRANSFER] = { 220 221 [AUE_BULK_DT_WR] = { 222 .type = UE_BULK, 223 .endpoint = UE_ADDR_ANY, 224 .direction = UE_DIR_OUT, 225 .bufsize = (MCLBYTES + 2), 226 .flags = {.pipe_bof = 1,.force_short_xfer = 1,}, 227 .callback = aue_bulk_write_callback, 228 .timeout = 10000, /* 10 seconds */ 229 }, 230 231 [AUE_BULK_DT_RD] = { 232 .type = UE_BULK, 233 .endpoint = UE_ADDR_ANY, 234 .direction = UE_DIR_IN, 235 .bufsize = (MCLBYTES + 4 + ETHER_CRC_LEN), 236 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,}, 237 .callback = aue_bulk_read_callback, 238 }, 239 240 [AUE_INTR_DT_RD] = { 241 .type = UE_INTERRUPT, 242 .endpoint = UE_ADDR_ANY, 243 .direction = UE_DIR_IN, 244 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,}, 245 .bufsize = 0, /* use wMaxPacketSize */ 246 .callback = aue_intr_callback, 247 }, 248}; 249 250static device_method_t aue_methods[] = { 251 /* Device interface */ 252 DEVMETHOD(device_probe, aue_probe), 253 DEVMETHOD(device_attach, aue_attach), 254 DEVMETHOD(device_detach, aue_detach), 255 256 /* bus interface */ 257 DEVMETHOD(bus_print_child, bus_generic_print_child), 258 DEVMETHOD(bus_driver_added, bus_generic_driver_added), 259 260 /* MII interface */ 261 DEVMETHOD(miibus_readreg, aue_miibus_readreg), 262 DEVMETHOD(miibus_writereg, aue_miibus_writereg), 263 DEVMETHOD(miibus_statchg, aue_miibus_statchg), 264 265 {0, 0} 266}; 267 268static driver_t aue_driver = { 269 .name = "aue", 270 .methods = aue_methods, 271 .size = sizeof(struct aue_softc) 272}; 273 274static devclass_t aue_devclass; 275 276DRIVER_MODULE(aue, uhub, aue_driver, aue_devclass, NULL, 0); 277DRIVER_MODULE(miibus, aue, miibus_driver, miibus_devclass, 0, 0); 278MODULE_DEPEND(aue, uether, 1, 1, 1); 279MODULE_DEPEND(aue, usb, 1, 1, 1); 280MODULE_DEPEND(aue, ether, 1, 1, 1); 281MODULE_DEPEND(aue, miibus, 1, 1, 1); 282 283static const struct usb_ether_methods aue_ue_methods = { 284 .ue_attach_post = aue_attach_post, 285 .ue_start = aue_start, 286 .ue_init = aue_init, 287 .ue_stop = aue_stop, 288 .ue_tick = aue_tick, 289 .ue_setmulti = aue_setmulti, 290 .ue_setpromisc = aue_setpromisc, 291 .ue_mii_upd = aue_ifmedia_upd, 292 .ue_mii_sts = aue_ifmedia_sts, 293}; 294 295#define AUE_SETBIT(sc, reg, x) \ 296 aue_csr_write_1(sc, reg, aue_csr_read_1(sc, reg) | (x)) 297 298#define AUE_CLRBIT(sc, reg, x) \ 299 aue_csr_write_1(sc, reg, aue_csr_read_1(sc, reg) & ~(x)) 300 301static uint8_t 302aue_csr_read_1(struct aue_softc *sc, uint16_t reg) 303{ 304 struct usb_device_request req; 305 usb_error_t err; 306 uint8_t val; 307 308 req.bmRequestType = UT_READ_VENDOR_DEVICE; 309 req.bRequest = AUE_UR_READREG; 310 USETW(req.wValue, 0); 311 USETW(req.wIndex, reg); 312 USETW(req.wLength, 1); 313 314 err = uether_do_request(&sc->sc_ue, &req, &val, 1000); 315 if (err) 316 return (0); 317 return (val); 318} 319 320static uint16_t 321aue_csr_read_2(struct aue_softc *sc, uint16_t reg) 322{ 323 struct usb_device_request req; 324 usb_error_t err; 325 uint16_t val; 326 327 req.bmRequestType = UT_READ_VENDOR_DEVICE; 328 req.bRequest = AUE_UR_READREG; 329 USETW(req.wValue, 0); 330 USETW(req.wIndex, reg); 331 USETW(req.wLength, 2); 332 333 err = uether_do_request(&sc->sc_ue, &req, &val, 1000); 334 if (err) 335 return (0); 336 return (le16toh(val)); 337} 338 339static void 340aue_csr_write_1(struct aue_softc *sc, uint16_t reg, uint8_t val) 341{ 342 struct usb_device_request req; 343 344 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 345 req.bRequest = AUE_UR_WRITEREG; 346 req.wValue[0] = val; 347 req.wValue[1] = 0; 348 USETW(req.wIndex, reg); 349 USETW(req.wLength, 1); 350 351 if (uether_do_request(&sc->sc_ue, &req, &val, 1000)) { 352 /* error ignored */ 353 } 354} 355 356static void 357aue_csr_write_2(struct aue_softc *sc, uint16_t reg, uint16_t val) 358{ 359 struct usb_device_request req; 360 361 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 362 req.bRequest = AUE_UR_WRITEREG; 363 USETW(req.wValue, val); 364 USETW(req.wIndex, reg); 365 USETW(req.wLength, 2); 366 367 val = htole16(val); 368 369 if (uether_do_request(&sc->sc_ue, &req, &val, 1000)) { 370 /* error ignored */ 371 } 372} 373 374/* 375 * Read a word of data stored in the EEPROM at address 'addr.' 376 */ 377static void 378aue_eeprom_getword(struct aue_softc *sc, int addr, uint16_t *dest) 379{ 380 int i; 381 uint16_t word = 0; 382 383 aue_csr_write_1(sc, AUE_EE_REG, addr); 384 aue_csr_write_1(sc, AUE_EE_CTL, AUE_EECTL_READ); 385 386 for (i = 0; i != AUE_TIMEOUT; i++) { 387 if (aue_csr_read_1(sc, AUE_EE_CTL) & AUE_EECTL_DONE) 388 break; 389 if (uether_pause(&sc->sc_ue, hz / 100)) 390 break; 391 } 392 393 if (i == AUE_TIMEOUT) 394 device_printf(sc->sc_ue.ue_dev, "EEPROM read timed out\n"); 395 396 word = aue_csr_read_2(sc, AUE_EE_DATA); 397 *dest = word; 398} 399 400/* 401 * Read a sequence of words from the EEPROM. 402 */ 403static void 404aue_read_eeprom(struct aue_softc *sc, uint8_t *dest, 405 uint16_t off, uint16_t len) 406{ 407 uint16_t *ptr = (uint16_t *)dest; 408 int i; 409 410 for (i = 0; i != len; i++, ptr++) 411 aue_eeprom_getword(sc, off + i, ptr); 412} 413 414static int 415aue_miibus_readreg(device_t dev, int phy, int reg) 416{ 417 struct aue_softc *sc = device_get_softc(dev); 418 int i, locked; 419 uint16_t val = 0; 420 421 locked = mtx_owned(&sc->sc_mtx); 422 if (!locked) 423 AUE_LOCK(sc); 424 425 /* 426 * The Am79C901 HomePNA PHY actually contains two transceivers: a 1Mbps 427 * HomePNA PHY and a 10Mbps full/half duplex ethernet PHY with NWAY 428 * autoneg. However in the ADMtek adapter, only the 1Mbps PHY is 429 * actually connected to anything, so we ignore the 10Mbps one. It 430 * happens to be configured for MII address 3, so we filter that out. 431 */ 432 if (sc->sc_flags & AUE_FLAG_DUAL_PHY) { 433 if (phy == 3) 434 goto done; 435#if 0 436 if (phy != 1) 437 goto done; 438#endif 439 } 440 aue_csr_write_1(sc, AUE_PHY_ADDR, phy); 441 aue_csr_write_1(sc, AUE_PHY_CTL, reg | AUE_PHYCTL_READ); 442 443 for (i = 0; i != AUE_TIMEOUT; i++) { 444 if (aue_csr_read_1(sc, AUE_PHY_CTL) & AUE_PHYCTL_DONE) 445 break; 446 if (uether_pause(&sc->sc_ue, hz / 100)) 447 break; 448 } 449 450 if (i == AUE_TIMEOUT) 451 device_printf(sc->sc_ue.ue_dev, "MII read timed out\n"); 452 453 val = aue_csr_read_2(sc, AUE_PHY_DATA); 454 455done: 456 if (!locked) 457 AUE_UNLOCK(sc); 458 return (val); 459} 460 461static int 462aue_miibus_writereg(device_t dev, int phy, int reg, int data) 463{ 464 struct aue_softc *sc = device_get_softc(dev); 465 int i; 466 int locked; 467 468 if (phy == 3) 469 return (0); 470 471 locked = mtx_owned(&sc->sc_mtx); 472 if (!locked) 473 AUE_LOCK(sc); 474 475 aue_csr_write_2(sc, AUE_PHY_DATA, data); 476 aue_csr_write_1(sc, AUE_PHY_ADDR, phy); 477 aue_csr_write_1(sc, AUE_PHY_CTL, reg | AUE_PHYCTL_WRITE); 478 479 for (i = 0; i != AUE_TIMEOUT; i++) { 480 if (aue_csr_read_1(sc, AUE_PHY_CTL) & AUE_PHYCTL_DONE) 481 break; 482 if (uether_pause(&sc->sc_ue, hz / 100)) 483 break; 484 } 485 486 if (i == AUE_TIMEOUT) 487 device_printf(sc->sc_ue.ue_dev, "MII write timed out\n"); 488 489 if (!locked) 490 AUE_UNLOCK(sc); 491 return (0); 492} 493 494static void 495aue_miibus_statchg(device_t dev) 496{ 497 struct aue_softc *sc = device_get_softc(dev); 498 struct mii_data *mii = GET_MII(sc); 499 int locked; 500 501 locked = mtx_owned(&sc->sc_mtx); 502 if (!locked) 503 AUE_LOCK(sc); 504 505 AUE_CLRBIT(sc, AUE_CTL0, AUE_CTL0_RX_ENB | AUE_CTL0_TX_ENB); 506 if (IFM_SUBTYPE(mii->mii_media_active) == IFM_100_TX) 507 AUE_SETBIT(sc, AUE_CTL1, AUE_CTL1_SPEEDSEL); 508 else 509 AUE_CLRBIT(sc, AUE_CTL1, AUE_CTL1_SPEEDSEL); 510 511 if ((mii->mii_media_active & IFM_GMASK) == IFM_FDX) 512 AUE_SETBIT(sc, AUE_CTL1, AUE_CTL1_DUPLEX); 513 else 514 AUE_CLRBIT(sc, AUE_CTL1, AUE_CTL1_DUPLEX); 515 516 AUE_SETBIT(sc, AUE_CTL0, AUE_CTL0_RX_ENB | AUE_CTL0_TX_ENB); 517 518 /* 519 * Set the LED modes on the LinkSys adapter. 520 * This turns on the 'dual link LED' bin in the auxmode 521 * register of the Broadcom PHY. 522 */ 523 if (sc->sc_flags & AUE_FLAG_LSYS) { 524 uint16_t auxmode; 525 526 auxmode = aue_miibus_readreg(dev, 0, 0x1b); 527 aue_miibus_writereg(dev, 0, 0x1b, auxmode | 0x04); 528 } 529 if (!locked) 530 AUE_UNLOCK(sc); 531} 532 533#define AUE_BITS 6 534static void 535aue_setmulti(struct usb_ether *ue) 536{ 537 struct aue_softc *sc = uether_getsc(ue); 538 struct ifnet *ifp = uether_getifp(ue); 539 struct ifmultiaddr *ifma; 540 uint32_t h = 0; 541 uint32_t i; 542 uint8_t hashtbl[8] = { 0, 0, 0, 0, 0, 0, 0, 0 }; 543 544 AUE_LOCK_ASSERT(sc, MA_OWNED); 545 546 if (ifp->if_flags & IFF_ALLMULTI || ifp->if_flags & IFF_PROMISC) { 547 AUE_SETBIT(sc, AUE_CTL0, AUE_CTL0_ALLMULTI); 548 return; 549 } 550 551 AUE_CLRBIT(sc, AUE_CTL0, AUE_CTL0_ALLMULTI); 552 553 /* now program new ones */ 554 if_maddr_rlock(ifp); 555 TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) { 556 if (ifma->ifma_addr->sa_family != AF_LINK) 557 continue; 558 h = ether_crc32_le(LLADDR((struct sockaddr_dl *) 559 ifma->ifma_addr), ETHER_ADDR_LEN) & ((1 << AUE_BITS) - 1); 560 hashtbl[(h >> 3)] |= 1 << (h & 0x7); 561 } 562 if_maddr_runlock(ifp); 563 564 /* write the hashtable */ 565 for (i = 0; i != 8; i++) 566 aue_csr_write_1(sc, AUE_MAR0 + i, hashtbl[i]); 567} 568 569static void 570aue_reset_pegasus_II(struct aue_softc *sc) 571{ 572 /* Magic constants taken from Linux driver. */ 573 aue_csr_write_1(sc, AUE_REG_1D, 0); 574 aue_csr_write_1(sc, AUE_REG_7B, 2); 575#if 0 576 if ((sc->sc_flags & HAS_HOME_PNA) && mii_mode) 577 aue_csr_write_1(sc, AUE_REG_81, 6); 578 else 579#endif 580 aue_csr_write_1(sc, AUE_REG_81, 2); 581} 582 583static void 584aue_reset(struct aue_softc *sc) 585{ 586 int i; 587 588 AUE_SETBIT(sc, AUE_CTL1, AUE_CTL1_RESETMAC); 589 590 for (i = 0; i != AUE_TIMEOUT; i++) { 591 if (!(aue_csr_read_1(sc, AUE_CTL1) & AUE_CTL1_RESETMAC)) 592 break; 593 if (uether_pause(&sc->sc_ue, hz / 100)) 594 break; 595 } 596 597 if (i == AUE_TIMEOUT) 598 device_printf(sc->sc_ue.ue_dev, "reset failed\n"); 599 600 /* 601 * The PHY(s) attached to the Pegasus chip may be held 602 * in reset until we flip on the GPIO outputs. Make sure 603 * to set the GPIO pins high so that the PHY(s) will 604 * be enabled. 605 * 606 * NOTE: We used to force all of the GPIO pins low first and then 607 * enable the ones we want. This has been changed to better 608 * match the ADMtek's reference design to avoid setting the 609 * power-down configuration line of the PHY at the same time 610 * it is reset. 611 */ 612 aue_csr_write_1(sc, AUE_GPIO0, AUE_GPIO_SEL0|AUE_GPIO_SEL1); 613 aue_csr_write_1(sc, AUE_GPIO0, AUE_GPIO_SEL0|AUE_GPIO_SEL1|AUE_GPIO_OUT0); 614 615 if (sc->sc_flags & AUE_FLAG_LSYS) { 616 /* Grrr. LinkSys has to be different from everyone else. */ 617 aue_csr_write_1(sc, AUE_GPIO0, AUE_GPIO_SEL0|AUE_GPIO_SEL1); 618 aue_csr_write_1(sc, AUE_GPIO0, 619 AUE_GPIO_SEL0|AUE_GPIO_SEL1|AUE_GPIO_OUT0); 620 } 621 if (sc->sc_flags & AUE_FLAG_PII) 622 aue_reset_pegasus_II(sc); 623 624 /* Wait a little while for the chip to get its brains in order: */ 625 uether_pause(&sc->sc_ue, hz / 100); 626} 627 628static void 629aue_attach_post(struct usb_ether *ue) 630{ 631 struct aue_softc *sc = uether_getsc(ue); 632 633 /* reset the adapter */ 634 aue_reset(sc); 635 636 /* get station address from the EEPROM */ 637 aue_read_eeprom(sc, ue->ue_eaddr, 0, 3); 638} 639 640/* 641 * Probe for a Pegasus chip. 642 */ 643static int 644aue_probe(device_t dev) 645{ 646 struct usb_attach_arg *uaa = device_get_ivars(dev); 647 648 if (uaa->usb_mode != USB_MODE_HOST) 649 return (ENXIO); 650 if (uaa->info.bConfigIndex != AUE_CONFIG_INDEX) 651 return (ENXIO); 652 if (uaa->info.bIfaceIndex != AUE_IFACE_IDX) 653 return (ENXIO); 654 /* 655 * Belkin USB Bluetooth dongles of the F8T012xx1 model series conflict 656 * with older Belkin USB2LAN adapters. Skip if_aue if we detect one of 657 * the devices that look like Bluetooth adapters. 658 */ 659 if (uaa->info.idVendor == USB_VENDOR_BELKIN && 660 uaa->info.idProduct == USB_PRODUCT_BELKIN_F8T012 && 661 uaa->info.bcdDevice == 0x0413) 662 return (ENXIO); 663 664 return (usbd_lookup_id_by_uaa(aue_devs, sizeof(aue_devs), uaa)); 665} 666 667/* 668 * Attach the interface. Allocate softc structures, do ifmedia 669 * setup and ethernet/BPF attach. 670 */ 671static int 672aue_attach(device_t dev) 673{ 674 struct usb_attach_arg *uaa = device_get_ivars(dev); 675 struct aue_softc *sc = device_get_softc(dev); 676 struct usb_ether *ue = &sc->sc_ue; 677 uint8_t iface_index; 678 int error; 679 680 sc->sc_flags = USB_GET_DRIVER_INFO(uaa); 681 682 if (uaa->info.bcdDevice >= 0x0201) { 683 /* XXX currently undocumented */ 684 sc->sc_flags |= AUE_FLAG_VER_2; 685 } 686 687 device_set_usb_desc(dev); 688 mtx_init(&sc->sc_mtx, device_get_nameunit(dev), NULL, MTX_DEF); 689 690 iface_index = AUE_IFACE_IDX; 691 error = usbd_transfer_setup(uaa->device, &iface_index, 692 sc->sc_xfer, aue_config, AUE_N_TRANSFER, 693 sc, &sc->sc_mtx); 694 if (error) { 695 device_printf(dev, "allocating USB transfers failed\n"); 696 goto detach; 697 } 698 699 ue->ue_sc = sc; 700 ue->ue_dev = dev; 701 ue->ue_udev = uaa->device; 702 ue->ue_mtx = &sc->sc_mtx; 703 ue->ue_methods = &aue_ue_methods; 704 705 error = uether_ifattach(ue); 706 if (error) { 707 device_printf(dev, "could not attach interface\n"); 708 goto detach; 709 } 710 return (0); /* success */ 711 712detach: 713 aue_detach(dev); 714 return (ENXIO); /* failure */ 715} 716 717static int 718aue_detach(device_t dev) 719{ 720 struct aue_softc *sc = device_get_softc(dev); 721 struct usb_ether *ue = &sc->sc_ue; 722 723 usbd_transfer_unsetup(sc->sc_xfer, AUE_N_TRANSFER); 724 uether_ifdetach(ue); 725 mtx_destroy(&sc->sc_mtx); 726 727 return (0); 728} 729 730static void 731aue_intr_callback(struct usb_xfer *xfer, usb_error_t error) 732{ 733 struct aue_softc *sc = usbd_xfer_softc(xfer); 734 struct ifnet *ifp = uether_getifp(&sc->sc_ue); 735 struct aue_intrpkt pkt; 736 struct usb_page_cache *pc; 737 int actlen; 738 739 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 740 741 switch (USB_GET_STATE(xfer)) { 742 case USB_ST_TRANSFERRED: 743 744 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) && 745 actlen >= sizeof(pkt)) { 746 747 pc = usbd_xfer_get_frame(xfer, 0); 748 usbd_copy_out(pc, 0, &pkt, sizeof(pkt)); 749 750 if (pkt.aue_txstat0) 751 ifp->if_oerrors++; 752 if (pkt.aue_txstat0 & (AUE_TXSTAT0_LATECOLL & 753 AUE_TXSTAT0_EXCESSCOLL)) 754 ifp->if_collisions++; 755 } 756 /* FALLTHROUGH */ 757 case USB_ST_SETUP: 758tr_setup: 759 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 760 usbd_transfer_submit(xfer); 761 return; 762 763 default: /* Error */ 764 if (error != USB_ERR_CANCELLED) { 765 /* try to clear stall first */ 766 usbd_xfer_set_stall(xfer); 767 goto tr_setup; 768 } 769 return; 770 } 771} 772 773static void 774aue_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error) 775{ 776 struct aue_softc *sc = usbd_xfer_softc(xfer); 777 struct usb_ether *ue = &sc->sc_ue; 778 struct ifnet *ifp = uether_getifp(ue); 779 struct aue_rxpkt stat; 780 struct usb_page_cache *pc; 781 int actlen; 782 783 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 784 pc = usbd_xfer_get_frame(xfer, 0); 785 786 switch (USB_GET_STATE(xfer)) { 787 case USB_ST_TRANSFERRED: 788 DPRINTFN(11, "received %d bytes\n", actlen); 789 790 if (sc->sc_flags & AUE_FLAG_VER_2) { 791 792 if (actlen == 0) { 793 ifp->if_ierrors++; 794 goto tr_setup; 795 } 796 } else { 797 798 if (actlen <= sizeof(stat) + ETHER_CRC_LEN) { 799 ifp->if_ierrors++; 800 goto tr_setup; 801 } 802 usbd_copy_out(pc, actlen - sizeof(stat), &stat, 803 sizeof(stat)); 804 805 /* 806 * turn off all the non-error bits in the rx status 807 * word: 808 */ 809 stat.aue_rxstat &= AUE_RXSTAT_MASK; 810 if (stat.aue_rxstat) { 811 ifp->if_ierrors++; 812 goto tr_setup; 813 } 814 /* No errors; receive the packet. */ 815 actlen -= (sizeof(stat) + ETHER_CRC_LEN); 816 } 817 uether_rxbuf(ue, pc, 0, actlen); 818 819 /* FALLTHROUGH */ 820 case USB_ST_SETUP: 821tr_setup: 822 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 823 usbd_transfer_submit(xfer); 824 uether_rxflush(ue); 825 return; 826 827 default: /* Error */ 828 DPRINTF("bulk read error, %s\n", 829 usbd_errstr(error)); 830 831 if (error != USB_ERR_CANCELLED) { 832 /* try to clear stall first */ 833 usbd_xfer_set_stall(xfer); 834 goto tr_setup; 835 } 836 return; 837 } 838} 839 840static void 841aue_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error) 842{ 843 struct aue_softc *sc = usbd_xfer_softc(xfer); 844 struct ifnet *ifp = uether_getifp(&sc->sc_ue); 845 struct usb_page_cache *pc; 846 struct mbuf *m; 847 uint8_t buf[2]; 848 int actlen; 849 850 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 851 pc = usbd_xfer_get_frame(xfer, 0); 852 853 switch (USB_GET_STATE(xfer)) { 854 case USB_ST_TRANSFERRED: 855 DPRINTFN(11, "transfer of %d bytes complete\n", actlen); 856 ifp->if_opackets++; 857 858 /* FALLTHROUGH */ 859 case USB_ST_SETUP: 860tr_setup: 861 if ((sc->sc_flags & AUE_FLAG_LINK) == 0) { 862 /* 863 * don't send anything if there is no link ! 864 */ 865 return; 866 } 867 IFQ_DRV_DEQUEUE(&ifp->if_snd, m); 868 869 if (m == NULL) 870 return; 871 if (m->m_pkthdr.len > MCLBYTES) 872 m->m_pkthdr.len = MCLBYTES; 873 if (sc->sc_flags & AUE_FLAG_VER_2) { 874 875 usbd_xfer_set_frame_len(xfer, 0, m->m_pkthdr.len); 876 877 usbd_m_copy_in(pc, 0, m, 0, m->m_pkthdr.len); 878 879 } else { 880 881 usbd_xfer_set_frame_len(xfer, 0, (m->m_pkthdr.len + 2)); 882 883 /* 884 * The ADMtek documentation says that the 885 * packet length is supposed to be specified 886 * in the first two bytes of the transfer, 887 * however it actually seems to ignore this 888 * info and base the frame size on the bulk 889 * transfer length. 890 */ 891 buf[0] = (uint8_t)(m->m_pkthdr.len); 892 buf[1] = (uint8_t)(m->m_pkthdr.len >> 8); 893 894 usbd_copy_in(pc, 0, buf, 2); 895 usbd_m_copy_in(pc, 2, m, 0, m->m_pkthdr.len); 896 } 897 898 /* 899 * if there's a BPF listener, bounce a copy 900 * of this frame to him: 901 */ 902 BPF_MTAP(ifp, m); 903 904 m_freem(m); 905 906 usbd_transfer_submit(xfer); 907 return; 908 909 default: /* Error */ 910 DPRINTFN(11, "transfer error, %s\n", 911 usbd_errstr(error)); 912 913 ifp->if_oerrors++; 914 915 if (error != USB_ERR_CANCELLED) { 916 /* try to clear stall first */ 917 usbd_xfer_set_stall(xfer); 918 goto tr_setup; 919 } 920 return; 921 } 922} 923 924static void 925aue_tick(struct usb_ether *ue) 926{ 927 struct aue_softc *sc = uether_getsc(ue); 928 struct mii_data *mii = GET_MII(sc); 929 930 AUE_LOCK_ASSERT(sc, MA_OWNED); 931 932 mii_tick(mii); 933 if ((sc->sc_flags & AUE_FLAG_LINK) == 0 934 && mii->mii_media_status & IFM_ACTIVE && 935 IFM_SUBTYPE(mii->mii_media_active) != IFM_NONE) { 936 sc->sc_flags |= AUE_FLAG_LINK; 937 aue_start(ue); 938 } 939} 940 941static void 942aue_start(struct usb_ether *ue) 943{ 944 struct aue_softc *sc = uether_getsc(ue); 945 946 /* 947 * start the USB transfers, if not already started: 948 */ 949 usbd_transfer_start(sc->sc_xfer[AUE_INTR_DT_RD]); 950 usbd_transfer_start(sc->sc_xfer[AUE_BULK_DT_RD]); 951 usbd_transfer_start(sc->sc_xfer[AUE_BULK_DT_WR]); 952} 953 954static void 955aue_init(struct usb_ether *ue) 956{ 957 struct aue_softc *sc = uether_getsc(ue); 958 struct ifnet *ifp = uether_getifp(ue); 959 int i; 960 961 AUE_LOCK_ASSERT(sc, MA_OWNED); 962 963 /* 964 * Cancel pending I/O 965 */ 966 aue_reset(sc); 967 968 /* Set MAC address */ 969 for (i = 0; i != ETHER_ADDR_LEN; i++) 970 aue_csr_write_1(sc, AUE_PAR0 + i, IF_LLADDR(ifp)[i]); 971 972 /* update promiscuous setting */ 973 aue_setpromisc(ue); 974 975 /* Load the multicast filter. */ 976 aue_setmulti(ue); 977 978 /* Enable RX and TX */ 979 aue_csr_write_1(sc, AUE_CTL0, AUE_CTL0_RXSTAT_APPEND | AUE_CTL0_RX_ENB); 980 AUE_SETBIT(sc, AUE_CTL0, AUE_CTL0_TX_ENB); 981 AUE_SETBIT(sc, AUE_CTL2, AUE_CTL2_EP3_CLR); 982 983 usbd_xfer_set_stall(sc->sc_xfer[AUE_BULK_DT_WR]); 984 985 ifp->if_drv_flags |= IFF_DRV_RUNNING; 986 aue_start(ue); 987} 988 989static void 990aue_setpromisc(struct usb_ether *ue) 991{ 992 struct aue_softc *sc = uether_getsc(ue); 993 struct ifnet *ifp = uether_getifp(ue); 994 995 AUE_LOCK_ASSERT(sc, MA_OWNED); 996 997 /* if we want promiscuous mode, set the allframes bit: */ 998 if (ifp->if_flags & IFF_PROMISC) 999 AUE_SETBIT(sc, AUE_CTL2, AUE_CTL2_RX_PROMISC); 1000 else 1001 AUE_CLRBIT(sc, AUE_CTL2, AUE_CTL2_RX_PROMISC); 1002} 1003 1004/* 1005 * Set media options. 1006 */ 1007static int 1008aue_ifmedia_upd(struct ifnet *ifp) 1009{ 1010 struct aue_softc *sc = ifp->if_softc; 1011 struct mii_data *mii = GET_MII(sc); 1012 1013 AUE_LOCK_ASSERT(sc, MA_OWNED); 1014 1015 sc->sc_flags &= ~AUE_FLAG_LINK; 1016 if (mii->mii_instance) { 1017 struct mii_softc *miisc; 1018 1019 LIST_FOREACH(miisc, &mii->mii_phys, mii_list) 1020 mii_phy_reset(miisc); 1021 } 1022 mii_mediachg(mii); 1023 return (0); 1024} 1025 1026/* 1027 * Report current media status. 1028 */ 1029static void 1030aue_ifmedia_sts(struct ifnet *ifp, struct ifmediareq *ifmr) 1031{ 1032 struct aue_softc *sc = ifp->if_softc; 1033 struct mii_data *mii = GET_MII(sc); 1034 1035 AUE_LOCK(sc); 1036 mii_pollstat(mii); 1037 AUE_UNLOCK(sc); 1038 ifmr->ifm_active = mii->mii_media_active; 1039 ifmr->ifm_status = mii->mii_media_status; 1040} 1041 1042/* 1043 * Stop the adapter and free any mbufs allocated to the 1044 * RX and TX lists. 1045 */ 1046static void 1047aue_stop(struct usb_ether *ue) 1048{ 1049 struct aue_softc *sc = uether_getsc(ue); 1050 struct ifnet *ifp = uether_getifp(ue); 1051 1052 AUE_LOCK_ASSERT(sc, MA_OWNED); 1053 1054 ifp->if_drv_flags &= ~IFF_DRV_RUNNING; 1055 sc->sc_flags &= ~AUE_FLAG_LINK; 1056 1057 /* 1058 * stop all the transfers, if not already stopped: 1059 */ 1060 usbd_transfer_stop(sc->sc_xfer[AUE_BULK_DT_WR]); 1061 usbd_transfer_stop(sc->sc_xfer[AUE_BULK_DT_RD]); 1062 usbd_transfer_stop(sc->sc_xfer[AUE_INTR_DT_RD]); 1063 1064 aue_csr_write_1(sc, AUE_CTL0, 0); 1065 aue_csr_write_1(sc, AUE_CTL1, 0); 1066 aue_reset(sc); 1067} 1068