1 /*- 2 * SPDX-License-Identifier: (BSD-1-Clause AND BSD-4-Clause) 3 * 4 * Copyright (c) 2011 Rick van der Zwet <info@rickvanderzwet.nl> 5 * 6 * Permission to use, copy, modify, and distribute this software for any 7 * purpose with or without fee is hereby granted, provided that the above 8 * copyright notice and this permission notice appear in all copies. 9 * 10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 17 */ 18 19 /*- 20 * Copyright (c) 2008 Johann Christian Rode <jcrode@gmx.net> 21 * 22 * Permission to use, copy, modify, and distribute this software for any 23 * purpose with or without fee is hereby granted, provided that the above 24 * copyright notice and this permission notice appear in all copies. 25 * 26 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 27 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 28 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 29 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 30 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 31 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 32 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 33 */ 34 35 /*- 36 * Copyright (c) 2005, 2006, 2007 Jonathan Gray <jsg@openbsd.org> 37 * 38 * Permission to use, copy, modify, and distribute this software for any 39 * purpose with or without fee is hereby granted, provided that the above 40 * copyright notice and this permission notice appear in all copies. 41 * 42 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 43 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 44 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 45 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 46 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 47 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 48 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 49 */ 50 51 /*- 52 * Copyright (c) 1997, 1998, 1999, 2000-2003 53 * Bill Paul <wpaul@windriver.com>. All rights reserved. 54 * 55 * Redistribution and use in source and binary forms, with or without 56 * modification, are permitted provided that the following conditions 57 * are met: 58 * 1. Redistributions of source code must retain the above copyright 59 * notice, this list of conditions and the following disclaimer. 60 * 2. Redistributions in binary form must reproduce the above copyright 61 * notice, this list of conditions and the following disclaimer in the 62 * documentation and/or other materials provided with the distribution. 63 * 3. All advertising materials mentioning features or use of this software 64 * must display the following acknowledgement: 65 * This product includes software developed by Bill Paul. 66 * 4. Neither the name of the author nor the names of any co-contributors 67 * may be used to endorse or promote products derived from this software 68 * without specific prior written permission. 69 * 70 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND 71 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 72 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 73 * ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD 74 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 75 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 76 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 77 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 78 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 79 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 80 * THE POSSIBILITY OF SUCH DAMAGE. 81 */ 82 83 #include <sys/cdefs.h> 84 __FBSDID("$FreeBSD$"); 85 86 /* 87 * Moschip MCS7730/MCS7830/MCS7832 USB to Ethernet controller 88 * The datasheet is available at the following URL: 89 * http://www.moschip.com/data/products/MCS7830/Data%20Sheet_7830.pdf 90 */ 91 92 /* 93 * The FreeBSD if_mos.c driver is based on various different sources: 94 * The vendor provided driver at the following URL: 95 * http://www.moschip.com/data/products/MCS7830/Driver_FreeBSD_7830.tar.gz 96 * 97 * Mixed together with the OpenBSD if_mos.c driver for validation and checking 98 * and the FreeBSD if_reu.c as reference for the USB Ethernet framework. 99 */ 100 101 #include <sys/stdint.h> 102 #include <sys/stddef.h> 103 #include <sys/param.h> 104 #include <sys/queue.h> 105 #include <sys/types.h> 106 #include <sys/systm.h> 107 #include <sys/socket.h> 108 #include <sys/kernel.h> 109 #include <sys/bus.h> 110 #include <sys/module.h> 111 #include <sys/lock.h> 112 #include <sys/mutex.h> 113 #include <sys/condvar.h> 114 #include <sys/sysctl.h> 115 #include <sys/sx.h> 116 #include <sys/unistd.h> 117 #include <sys/callout.h> 118 #include <sys/malloc.h> 119 #include <sys/priv.h> 120 121 #include <net/if.h> 122 #include <net/if_var.h> 123 #include <net/if_media.h> 124 125 #include <dev/mii/mii.h> 126 #include <dev/mii/miivar.h> 127 128 #include <dev/usb/usb.h> 129 #include <dev/usb/usbdi.h> 130 #include <dev/usb/usbdi_util.h> 131 #include "usbdevs.h" 132 133 #define USB_DEBUG_VAR mos_debug 134 #include <dev/usb/usb_debug.h> 135 #include <dev/usb/usb_process.h> 136 137 #include <dev/usb/net/usb_ethernet.h> 138 139 #include "miibus_if.h" 140 141 //#include <dev/usb/net/if_mosreg.h> 142 #include "if_mosreg.h" 143 144 #ifdef USB_DEBUG 145 static int mos_debug = 0; 146 147 static SYSCTL_NODE(_hw_usb, OID_AUTO, mos, CTLFLAG_RW | CTLFLAG_MPSAFE, 0, 148 "USB mos"); 149 SYSCTL_INT(_hw_usb_mos, OID_AUTO, debug, CTLFLAG_RWTUN, &mos_debug, 0, 150 "Debug level"); 151 #endif 152 153 #define MOS_DPRINTFN(fmt,...) \ 154 DPRINTF("mos: %s: " fmt "\n",__FUNCTION__,## __VA_ARGS__) 155 156 #define USB_PRODUCT_MOSCHIP_MCS7730 0x7730 157 #define USB_PRODUCT_SITECOMEU_LN030 0x0021 158 159 /* Various supported device vendors/products. */ 160 static const STRUCT_USB_HOST_ID mos_devs[] = { 161 {USB_VPI(USB_VENDOR_MOSCHIP, USB_PRODUCT_MOSCHIP_MCS7730, MCS7730)}, 162 {USB_VPI(USB_VENDOR_MOSCHIP, USB_PRODUCT_MOSCHIP_MCS7830, MCS7830)}, 163 {USB_VPI(USB_VENDOR_MOSCHIP, USB_PRODUCT_MOSCHIP_MCS7832, MCS7832)}, 164 {USB_VPI(USB_VENDOR_SITECOMEU, USB_PRODUCT_SITECOMEU_LN030, MCS7830)}, 165 }; 166 167 static int mos_probe(device_t dev); 168 static int mos_attach(device_t dev); 169 static void mos_attach_post(struct usb_ether *ue); 170 static int mos_detach(device_t dev); 171 172 static void mos_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error); 173 static void mos_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error); 174 static void mos_intr_callback(struct usb_xfer *xfer, usb_error_t error); 175 static void mos_tick(struct usb_ether *); 176 static void mos_start(struct usb_ether *); 177 static void mos_init(struct usb_ether *); 178 static void mos_chip_init(struct mos_softc *); 179 static void mos_stop(struct usb_ether *); 180 static int mos_miibus_readreg(device_t, int, int); 181 static int mos_miibus_writereg(device_t, int, int, int); 182 static void mos_miibus_statchg(device_t); 183 static int mos_ifmedia_upd(if_t); 184 static void mos_ifmedia_sts(if_t, struct ifmediareq *); 185 static void mos_reset(struct mos_softc *sc); 186 187 static int mos_reg_read_1(struct mos_softc *, int); 188 static int mos_reg_read_2(struct mos_softc *, int); 189 static int mos_reg_write_1(struct mos_softc *, int, int); 190 static int mos_reg_write_2(struct mos_softc *, int, int); 191 static int mos_readmac(struct mos_softc *, uint8_t *); 192 static int mos_writemac(struct mos_softc *, uint8_t *); 193 static int mos_write_mcast(struct mos_softc *, u_char *); 194 195 static void mos_setmulti(struct usb_ether *); 196 static void mos_setpromisc(struct usb_ether *); 197 198 static const struct usb_config mos_config[MOS_ENDPT_MAX] = { 199 [MOS_ENDPT_TX] = { 200 .type = UE_BULK, 201 .endpoint = UE_ADDR_ANY, 202 .direction = UE_DIR_OUT, 203 .bufsize = (MCLBYTES + 2), 204 .flags = {.pipe_bof = 1,.force_short_xfer = 1,}, 205 .callback = mos_bulk_write_callback, 206 .timeout = 10000, 207 }, 208 209 [MOS_ENDPT_RX] = { 210 .type = UE_BULK, 211 .endpoint = UE_ADDR_ANY, 212 .direction = UE_DIR_IN, 213 .bufsize = (MCLBYTES + 4 + ETHER_CRC_LEN), 214 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,}, 215 .callback = mos_bulk_read_callback, 216 }, 217 218 [MOS_ENDPT_INTR] = { 219 .type = UE_INTERRUPT, 220 .endpoint = UE_ADDR_ANY, 221 .direction = UE_DIR_IN, 222 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,}, 223 .bufsize = 0, 224 .callback = mos_intr_callback, 225 }, 226 }; 227 228 static device_method_t mos_methods[] = { 229 /* Device interface */ 230 DEVMETHOD(device_probe, mos_probe), 231 DEVMETHOD(device_attach, mos_attach), 232 DEVMETHOD(device_detach, mos_detach), 233 234 /* MII interface */ 235 DEVMETHOD(miibus_readreg, mos_miibus_readreg), 236 DEVMETHOD(miibus_writereg, mos_miibus_writereg), 237 DEVMETHOD(miibus_statchg, mos_miibus_statchg), 238 239 DEVMETHOD_END 240 }; 241 242 static driver_t mos_driver = { 243 .name = "mos", 244 .methods = mos_methods, 245 .size = sizeof(struct mos_softc) 246 }; 247 248 DRIVER_MODULE(mos, uhub, mos_driver, NULL, NULL); 249 DRIVER_MODULE(miibus, mos, miibus_driver, 0, 0); 250 MODULE_DEPEND(mos, uether, 1, 1, 1); 251 MODULE_DEPEND(mos, usb, 1, 1, 1); 252 MODULE_DEPEND(mos, ether, 1, 1, 1); 253 MODULE_DEPEND(mos, miibus, 1, 1, 1); 254 USB_PNP_HOST_INFO(mos_devs); 255 256 static const struct usb_ether_methods mos_ue_methods = { 257 .ue_attach_post = mos_attach_post, 258 .ue_start = mos_start, 259 .ue_init = mos_init, 260 .ue_stop = mos_stop, 261 .ue_tick = mos_tick, 262 .ue_setmulti = mos_setmulti, 263 .ue_setpromisc = mos_setpromisc, 264 .ue_mii_upd = mos_ifmedia_upd, 265 .ue_mii_sts = mos_ifmedia_sts, 266 }; 267 268 static int 269 mos_reg_read_1(struct mos_softc *sc, int reg) 270 { 271 struct usb_device_request req; 272 usb_error_t err; 273 uByte val = 0; 274 275 req.bmRequestType = UT_READ_VENDOR_DEVICE; 276 req.bRequest = MOS_UR_READREG; 277 USETW(req.wValue, 0); 278 USETW(req.wIndex, reg); 279 USETW(req.wLength, 1); 280 281 err = uether_do_request(&sc->sc_ue, &req, &val, 1000); 282 283 if (err) { 284 MOS_DPRINTFN("mos_reg_read_1 error, reg: %d\n", reg); 285 return (-1); 286 } 287 return (val); 288 } 289 290 static int 291 mos_reg_read_2(struct mos_softc *sc, int reg) 292 { 293 struct usb_device_request req; 294 usb_error_t err; 295 uWord val; 296 297 USETW(val, 0); 298 299 req.bmRequestType = UT_READ_VENDOR_DEVICE; 300 req.bRequest = MOS_UR_READREG; 301 USETW(req.wValue, 0); 302 USETW(req.wIndex, reg); 303 USETW(req.wLength, 2); 304 305 err = uether_do_request(&sc->sc_ue, &req, &val, 1000); 306 307 if (err) { 308 MOS_DPRINTFN("mos_reg_read_2 error, reg: %d", reg); 309 return (-1); 310 } 311 return (UGETW(val)); 312 } 313 314 static int 315 mos_reg_write_1(struct mos_softc *sc, int reg, int aval) 316 { 317 struct usb_device_request req; 318 usb_error_t err; 319 uByte val; 320 val = aval; 321 322 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 323 req.bRequest = MOS_UR_WRITEREG; 324 USETW(req.wValue, 0); 325 USETW(req.wIndex, reg); 326 USETW(req.wLength, 1); 327 328 err = uether_do_request(&sc->sc_ue, &req, &val, 1000); 329 330 if (err) { 331 MOS_DPRINTFN("mos_reg_write_1 error, reg: %d", reg); 332 return (-1); 333 } 334 return (0); 335 } 336 337 static int 338 mos_reg_write_2(struct mos_softc *sc, int reg, int aval) 339 { 340 struct usb_device_request req; 341 usb_error_t err; 342 uWord val; 343 344 USETW(val, aval); 345 346 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 347 req.bRequest = MOS_UR_WRITEREG; 348 USETW(req.wValue, 0); 349 USETW(req.wIndex, reg); 350 USETW(req.wLength, 2); 351 352 err = uether_do_request(&sc->sc_ue, &req, &val, 1000); 353 354 if (err) { 355 MOS_DPRINTFN("mos_reg_write_2 error, reg: %d", reg); 356 return (-1); 357 } 358 return (0); 359 } 360 361 static int 362 mos_readmac(struct mos_softc *sc, u_char *mac) 363 { 364 struct usb_device_request req; 365 usb_error_t err; 366 367 req.bmRequestType = UT_READ_VENDOR_DEVICE; 368 req.bRequest = MOS_UR_READREG; 369 USETW(req.wValue, 0); 370 USETW(req.wIndex, MOS_MAC); 371 USETW(req.wLength, ETHER_ADDR_LEN); 372 373 err = uether_do_request(&sc->sc_ue, &req, mac, 1000); 374 375 if (err) { 376 return (-1); 377 } 378 return (0); 379 } 380 381 static int 382 mos_writemac(struct mos_softc *sc, uint8_t *mac) 383 { 384 struct usb_device_request req; 385 usb_error_t err; 386 387 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 388 req.bRequest = MOS_UR_WRITEREG; 389 USETW(req.wValue, 0); 390 USETW(req.wIndex, MOS_MAC); 391 USETW(req.wLength, ETHER_ADDR_LEN); 392 393 err = uether_do_request(&sc->sc_ue, &req, mac, 1000); 394 395 if (err) { 396 MOS_DPRINTFN("mos_writemac error"); 397 return (-1); 398 } 399 return (0); 400 } 401 402 static int 403 mos_write_mcast(struct mos_softc *sc, u_char *hashtbl) 404 { 405 struct usb_device_request req; 406 usb_error_t err; 407 408 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 409 req.bRequest = MOS_UR_WRITEREG; 410 USETW(req.wValue, 0); 411 USETW(req.wIndex, MOS_MCAST_TABLE); 412 USETW(req.wLength, 8); 413 414 err = uether_do_request(&sc->sc_ue, &req, hashtbl, 1000); 415 416 if (err) { 417 MOS_DPRINTFN("mos_reg_mcast error"); 418 return (-1); 419 } 420 return (0); 421 } 422 423 static int 424 mos_miibus_readreg(device_t dev, int phy, int reg) 425 { 426 struct mos_softc *sc = device_get_softc(dev); 427 int i, res, locked; 428 429 locked = mtx_owned(&sc->sc_mtx); 430 if (!locked) 431 MOS_LOCK(sc); 432 433 mos_reg_write_2(sc, MOS_PHY_DATA, 0); 434 mos_reg_write_1(sc, MOS_PHY_CTL, (phy & MOS_PHYCTL_PHYADDR) | 435 MOS_PHYCTL_READ); 436 mos_reg_write_1(sc, MOS_PHY_STS, (reg & MOS_PHYSTS_PHYREG) | 437 MOS_PHYSTS_PENDING); 438 439 for (i = 0; i < MOS_TIMEOUT; i++) { 440 if (mos_reg_read_1(sc, MOS_PHY_STS) & MOS_PHYSTS_READY) 441 break; 442 } 443 if (i == MOS_TIMEOUT) { 444 MOS_DPRINTFN("MII read timeout"); 445 } 446 res = mos_reg_read_2(sc, MOS_PHY_DATA); 447 448 if (!locked) 449 MOS_UNLOCK(sc); 450 return (res); 451 } 452 453 static int 454 mos_miibus_writereg(device_t dev, int phy, int reg, int val) 455 { 456 struct mos_softc *sc = device_get_softc(dev); 457 int i, locked; 458 459 locked = mtx_owned(&sc->sc_mtx); 460 if (!locked) 461 MOS_LOCK(sc); 462 463 mos_reg_write_2(sc, MOS_PHY_DATA, val); 464 mos_reg_write_1(sc, MOS_PHY_CTL, (phy & MOS_PHYCTL_PHYADDR) | 465 MOS_PHYCTL_WRITE); 466 mos_reg_write_1(sc, MOS_PHY_STS, (reg & MOS_PHYSTS_PHYREG) | 467 MOS_PHYSTS_PENDING); 468 469 for (i = 0; i < MOS_TIMEOUT; i++) { 470 if (mos_reg_read_1(sc, MOS_PHY_STS) & MOS_PHYSTS_READY) 471 break; 472 } 473 if (i == MOS_TIMEOUT) 474 MOS_DPRINTFN("MII write timeout"); 475 476 if (!locked) 477 MOS_UNLOCK(sc); 478 return 0; 479 } 480 481 static void 482 mos_miibus_statchg(device_t dev) 483 { 484 struct mos_softc *sc = device_get_softc(dev); 485 struct mii_data *mii = GET_MII(sc); 486 int val, err, locked; 487 488 locked = mtx_owned(&sc->sc_mtx); 489 if (!locked) 490 MOS_LOCK(sc); 491 492 /* disable RX, TX prior to changing FDX, SPEEDSEL */ 493 val = mos_reg_read_1(sc, MOS_CTL); 494 val &= ~(MOS_CTL_TX_ENB | MOS_CTL_RX_ENB); 495 mos_reg_write_1(sc, MOS_CTL, val); 496 497 /* reset register which counts dropped frames */ 498 mos_reg_write_1(sc, MOS_FRAME_DROP_CNT, 0); 499 500 if ((mii->mii_media_active & IFM_GMASK) == IFM_FDX) 501 val |= MOS_CTL_FDX_ENB; 502 else 503 val &= ~(MOS_CTL_FDX_ENB); 504 505 switch (IFM_SUBTYPE(mii->mii_media_active)) { 506 case IFM_100_TX: 507 val |= MOS_CTL_SPEEDSEL; 508 break; 509 case IFM_10_T: 510 val &= ~(MOS_CTL_SPEEDSEL); 511 break; 512 } 513 514 /* re-enable TX, RX */ 515 val |= (MOS_CTL_TX_ENB | MOS_CTL_RX_ENB); 516 err = mos_reg_write_1(sc, MOS_CTL, val); 517 518 if (err) 519 MOS_DPRINTFN("media change failed"); 520 521 if (!locked) 522 MOS_UNLOCK(sc); 523 } 524 525 /* 526 * Set media options. 527 */ 528 static int 529 mos_ifmedia_upd(if_t ifp) 530 { 531 struct mos_softc *sc = if_getsoftc(ifp); 532 struct mii_data *mii = GET_MII(sc); 533 struct mii_softc *miisc; 534 int error; 535 536 MOS_LOCK_ASSERT(sc, MA_OWNED); 537 538 sc->mos_link = 0; 539 LIST_FOREACH(miisc, &mii->mii_phys, mii_list) 540 PHY_RESET(miisc); 541 error = mii_mediachg(mii); 542 return (error); 543 } 544 545 /* 546 * Report current media status. 547 */ 548 static void 549 mos_ifmedia_sts(if_t ifp, struct ifmediareq *ifmr) 550 { 551 struct mos_softc *sc = if_getsoftc(ifp); 552 struct mii_data *mii = GET_MII(sc); 553 554 MOS_LOCK(sc); 555 mii_pollstat(mii); 556 557 ifmr->ifm_active = mii->mii_media_active; 558 ifmr->ifm_status = mii->mii_media_status; 559 MOS_UNLOCK(sc); 560 } 561 562 static void 563 mos_setpromisc(struct usb_ether *ue) 564 { 565 struct mos_softc *sc = uether_getsc(ue); 566 if_t ifp = uether_getifp(ue); 567 568 uint8_t rxmode; 569 570 MOS_LOCK_ASSERT(sc, MA_OWNED); 571 572 rxmode = mos_reg_read_1(sc, MOS_CTL); 573 574 /* If we want promiscuous mode, set the allframes bit. */ 575 if (if_getflags(ifp) & IFF_PROMISC) { 576 rxmode |= MOS_CTL_RX_PROMISC; 577 } else { 578 rxmode &= ~MOS_CTL_RX_PROMISC; 579 } 580 581 mos_reg_write_1(sc, MOS_CTL, rxmode); 582 } 583 584 static u_int 585 mos_hash_maddr(void *arg, struct sockaddr_dl *sdl, u_int cnt) 586 { 587 uint8_t *hashtbl = arg; 588 uint32_t h; 589 590 h = ether_crc32_be(LLADDR(sdl), ETHER_ADDR_LEN) >> 26; 591 hashtbl[h / 8] |= 1 << (h % 8); 592 593 return (1); 594 } 595 596 static void 597 mos_setmulti(struct usb_ether *ue) 598 { 599 struct mos_softc *sc = uether_getsc(ue); 600 if_t ifp = uether_getifp(ue); 601 uint8_t rxmode; 602 uint8_t hashtbl[8] = {0, 0, 0, 0, 0, 0, 0, 0}; 603 int allmulti = 0; 604 605 MOS_LOCK_ASSERT(sc, MA_OWNED); 606 607 rxmode = mos_reg_read_1(sc, MOS_CTL); 608 609 if (if_getflags(ifp) & IFF_ALLMULTI || if_getflags(ifp) & IFF_PROMISC) 610 allmulti = 1; 611 612 /* get all new ones */ 613 if_foreach_llmaddr(ifp, mos_hash_maddr, &hashtbl); 614 615 /* now program new ones */ 616 if (allmulti == 1) { 617 rxmode |= MOS_CTL_ALLMULTI; 618 mos_reg_write_1(sc, MOS_CTL, rxmode); 619 } else { 620 rxmode &= ~MOS_CTL_ALLMULTI; 621 mos_write_mcast(sc, (void *)&hashtbl); 622 mos_reg_write_1(sc, MOS_CTL, rxmode); 623 } 624 } 625 626 static void 627 mos_reset(struct mos_softc *sc) 628 { 629 uint8_t ctl; 630 631 ctl = mos_reg_read_1(sc, MOS_CTL); 632 ctl &= ~(MOS_CTL_RX_PROMISC | MOS_CTL_ALLMULTI | MOS_CTL_TX_ENB | 633 MOS_CTL_RX_ENB); 634 /* Disable RX, TX, promiscuous and allmulticast mode */ 635 mos_reg_write_1(sc, MOS_CTL, ctl); 636 637 /* Reset frame drop counter register to zero */ 638 mos_reg_write_1(sc, MOS_FRAME_DROP_CNT, 0); 639 640 /* Wait a little while for the chip to get its brains in order. */ 641 usb_pause_mtx(&sc->sc_mtx, hz / 128); 642 return; 643 } 644 645 static void 646 mos_chip_init(struct mos_softc *sc) 647 { 648 int i; 649 650 /* 651 * Rev.C devices have a pause threshold register which needs to be set 652 * at startup. 653 */ 654 if (mos_reg_read_1(sc, MOS_PAUSE_TRHD) != -1) { 655 for (i = 0; i < MOS_PAUSE_REWRITES; i++) 656 mos_reg_write_1(sc, MOS_PAUSE_TRHD, 0); 657 } 658 sc->mos_phyaddrs[0] = 1; 659 sc->mos_phyaddrs[1] = 0xFF; 660 } 661 662 /* 663 * Probe for a MCS7x30 chip. 664 */ 665 static int 666 mos_probe(device_t dev) 667 { 668 struct usb_attach_arg *uaa = device_get_ivars(dev); 669 int retval; 670 671 if (uaa->usb_mode != USB_MODE_HOST) 672 return (ENXIO); 673 if (uaa->info.bConfigIndex != MOS_CONFIG_IDX) 674 return (ENXIO); 675 if (uaa->info.bIfaceIndex != MOS_IFACE_IDX) 676 return (ENXIO); 677 678 retval = usbd_lookup_id_by_uaa(mos_devs, sizeof(mos_devs), uaa); 679 return (retval); 680 } 681 682 /* 683 * Attach the interface. Allocate softc structures, do ifmedia 684 * setup and ethernet/BPF attach. 685 */ 686 static int 687 mos_attach(device_t dev) 688 { 689 struct usb_attach_arg *uaa = device_get_ivars(dev); 690 struct mos_softc *sc = device_get_softc(dev); 691 struct usb_ether *ue = &sc->sc_ue; 692 uint8_t iface_index; 693 int error; 694 695 sc->mos_flags = USB_GET_DRIVER_INFO(uaa); 696 697 device_set_usb_desc(dev); 698 mtx_init(&sc->sc_mtx, device_get_nameunit(dev), NULL, MTX_DEF); 699 700 iface_index = MOS_IFACE_IDX; 701 error = usbd_transfer_setup(uaa->device, &iface_index, 702 sc->sc_xfer, mos_config, MOS_ENDPT_MAX, 703 sc, &sc->sc_mtx); 704 705 if (error) { 706 device_printf(dev, "allocating USB transfers failed\n"); 707 goto detach; 708 } 709 ue->ue_sc = sc; 710 ue->ue_dev = dev; 711 ue->ue_udev = uaa->device; 712 ue->ue_mtx = &sc->sc_mtx; 713 ue->ue_methods = &mos_ue_methods; 714 715 if (sc->mos_flags & MCS7730) { 716 MOS_DPRINTFN("model: MCS7730"); 717 } else if (sc->mos_flags & MCS7830) { 718 MOS_DPRINTFN("model: MCS7830"); 719 } else if (sc->mos_flags & MCS7832) { 720 MOS_DPRINTFN("model: MCS7832"); 721 } 722 error = uether_ifattach(ue); 723 if (error) { 724 device_printf(dev, "could not attach interface\n"); 725 goto detach; 726 } 727 return (0); 728 729 detach: 730 mos_detach(dev); 731 return (ENXIO); 732 } 733 734 static void 735 mos_attach_post(struct usb_ether *ue) 736 { 737 struct mos_softc *sc = uether_getsc(ue); 738 int err; 739 740 /* Read MAC address, inform the world. */ 741 err = mos_readmac(sc, ue->ue_eaddr); 742 743 if (err) 744 MOS_DPRINTFN("couldn't get MAC address"); 745 746 MOS_DPRINTFN("address: %s", ether_sprintf(ue->ue_eaddr)); 747 748 mos_chip_init(sc); 749 } 750 751 static int 752 mos_detach(device_t dev) 753 { 754 struct mos_softc *sc = device_get_softc(dev); 755 struct usb_ether *ue = &sc->sc_ue; 756 757 usbd_transfer_unsetup(sc->sc_xfer, MOS_ENDPT_MAX); 758 uether_ifdetach(ue); 759 mtx_destroy(&sc->sc_mtx); 760 761 return (0); 762 } 763 764 /* 765 * A frame has been uploaded: pass the resulting mbuf chain up to 766 * the higher level protocols. 767 */ 768 static void 769 mos_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error) 770 { 771 struct mos_softc *sc = usbd_xfer_softc(xfer); 772 struct usb_ether *ue = &sc->sc_ue; 773 if_t ifp = uether_getifp(ue); 774 775 uint8_t rxstat = 0; 776 uint32_t actlen; 777 uint16_t pktlen = 0; 778 struct usb_page_cache *pc; 779 780 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 781 pc = usbd_xfer_get_frame(xfer, 0); 782 783 switch (USB_GET_STATE(xfer)) { 784 case USB_ST_TRANSFERRED: 785 MOS_DPRINTFN("actlen : %d", actlen); 786 if (actlen <= 1) { 787 if_inc_counter(ifp, IFCOUNTER_IERRORS, 1); 788 goto tr_setup; 789 } 790 /* evaluate status byte at the end */ 791 usbd_copy_out(pc, actlen - sizeof(rxstat), &rxstat, 792 sizeof(rxstat)); 793 794 if (rxstat != MOS_RXSTS_VALID) { 795 MOS_DPRINTFN("erroneous frame received"); 796 if (rxstat & MOS_RXSTS_SHORT_FRAME) 797 MOS_DPRINTFN("frame size less than 64 bytes"); 798 if (rxstat & MOS_RXSTS_LARGE_FRAME) { 799 MOS_DPRINTFN("frame size larger than " 800 "1532 bytes"); 801 } 802 if (rxstat & MOS_RXSTS_CRC_ERROR) 803 MOS_DPRINTFN("CRC error"); 804 if (rxstat & MOS_RXSTS_ALIGN_ERROR) 805 MOS_DPRINTFN("alignment error"); 806 if_inc_counter(ifp, IFCOUNTER_IERRORS, 1); 807 goto tr_setup; 808 } 809 /* Remember the last byte was used for the status fields */ 810 pktlen = actlen - 1; 811 if (pktlen < sizeof(struct ether_header)) { 812 MOS_DPRINTFN("error: pktlen %d is smaller " 813 "than ether_header %zd", pktlen, 814 sizeof(struct ether_header)); 815 if_inc_counter(ifp, IFCOUNTER_IERRORS, 1); 816 goto tr_setup; 817 } 818 uether_rxbuf(ue, pc, 0, actlen); 819 /* FALLTHROUGH */ 820 case USB_ST_SETUP: 821 tr_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 default: 827 MOS_DPRINTFN("bulk read error, %s", usbd_errstr(error)); 828 if (error != USB_ERR_CANCELLED) { 829 usbd_xfer_set_stall(xfer); 830 goto tr_setup; 831 } 832 MOS_DPRINTFN("start rx %i", usbd_xfer_max_len(xfer)); 833 return; 834 } 835 } 836 837 /* 838 * A frame was downloaded to the chip. It's safe for us to clean up 839 * the list buffers. 840 */ 841 static void 842 mos_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error) 843 { 844 struct mos_softc *sc = usbd_xfer_softc(xfer); 845 if_t ifp = uether_getifp(&sc->sc_ue); 846 struct usb_page_cache *pc; 847 struct mbuf *m; 848 849 switch (USB_GET_STATE(xfer)) { 850 case USB_ST_TRANSFERRED: 851 MOS_DPRINTFN("transfer of complete"); 852 if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1); 853 /* FALLTHROUGH */ 854 case USB_ST_SETUP: 855 tr_setup: 856 /* 857 * XXX: don't send anything if there is no link? 858 */ 859 m = if_dequeue(ifp); 860 if (m == NULL) 861 return; 862 863 pc = usbd_xfer_get_frame(xfer, 0); 864 usbd_m_copy_in(pc, 0, m, 0, m->m_pkthdr.len); 865 866 usbd_xfer_set_frame_len(xfer, 0, m->m_pkthdr.len); 867 868 /* 869 * if there's a BPF listener, bounce a copy 870 * of this frame to him: 871 */ 872 BPF_MTAP(ifp, m); 873 874 m_freem(m); 875 876 usbd_transfer_submit(xfer); 877 878 if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1); 879 return; 880 default: 881 MOS_DPRINTFN("usb error on tx: %s\n", usbd_errstr(error)); 882 if_inc_counter(ifp, IFCOUNTER_OERRORS, 1); 883 if (error != USB_ERR_CANCELLED) { 884 usbd_xfer_set_stall(xfer); 885 goto tr_setup; 886 } 887 return; 888 } 889 } 890 891 static void 892 mos_tick(struct usb_ether *ue) 893 { 894 struct mos_softc *sc = uether_getsc(ue); 895 struct mii_data *mii = GET_MII(sc); 896 897 MOS_LOCK_ASSERT(sc, MA_OWNED); 898 899 mii_tick(mii); 900 if (!sc->mos_link && mii->mii_media_status & IFM_ACTIVE && 901 IFM_SUBTYPE(mii->mii_media_active) != IFM_NONE) { 902 MOS_DPRINTFN("got link"); 903 sc->mos_link++; 904 mos_start(ue); 905 } 906 } 907 908 static void 909 mos_start(struct usb_ether *ue) 910 { 911 struct mos_softc *sc = uether_getsc(ue); 912 913 /* 914 * start the USB transfers, if not already started: 915 */ 916 usbd_transfer_start(sc->sc_xfer[MOS_ENDPT_TX]); 917 usbd_transfer_start(sc->sc_xfer[MOS_ENDPT_RX]); 918 usbd_transfer_start(sc->sc_xfer[MOS_ENDPT_INTR]); 919 } 920 921 static void 922 mos_init(struct usb_ether *ue) 923 { 924 struct mos_softc *sc = uether_getsc(ue); 925 if_t ifp = uether_getifp(ue); 926 uint8_t rxmode; 927 928 MOS_LOCK_ASSERT(sc, MA_OWNED); 929 930 /* Cancel pending I/O and free all RX/TX buffers. */ 931 mos_reset(sc); 932 933 /* Write MAC address */ 934 mos_writemac(sc, if_getlladdr(ifp)); 935 936 /* Read and set transmitter IPG values */ 937 sc->mos_ipgs[0] = mos_reg_read_1(sc, MOS_IPG0); 938 sc->mos_ipgs[1] = mos_reg_read_1(sc, MOS_IPG1); 939 mos_reg_write_1(sc, MOS_IPG0, sc->mos_ipgs[0]); 940 mos_reg_write_1(sc, MOS_IPG1, sc->mos_ipgs[1]); 941 942 /* 943 * Enable receiver and transmitter, bridge controls speed/duplex 944 * mode 945 */ 946 rxmode = mos_reg_read_1(sc, MOS_CTL); 947 rxmode |= MOS_CTL_RX_ENB | MOS_CTL_TX_ENB | MOS_CTL_BS_ENB; 948 rxmode &= ~(MOS_CTL_SLEEP); 949 950 mos_setpromisc(ue); 951 952 /* XXX: broadcast mode? */ 953 mos_reg_write_1(sc, MOS_CTL, rxmode); 954 955 /* Load the multicast filter. */ 956 mos_setmulti(ue); 957 958 if_setdrvflagbits(ifp, IFF_DRV_RUNNING, 0); 959 mos_start(ue); 960 } 961 962 static void 963 mos_intr_callback(struct usb_xfer *xfer, usb_error_t error) 964 { 965 struct mos_softc *sc = usbd_xfer_softc(xfer); 966 if_t ifp = uether_getifp(&sc->sc_ue); 967 struct usb_page_cache *pc; 968 uint32_t pkt; 969 int actlen; 970 971 if_inc_counter(ifp, IFCOUNTER_OERRORS, 1); 972 973 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 974 MOS_DPRINTFN("actlen %i", actlen); 975 976 switch (USB_GET_STATE(xfer)) { 977 case USB_ST_TRANSFERRED: 978 979 pc = usbd_xfer_get_frame(xfer, 0); 980 usbd_copy_out(pc, 0, &pkt, sizeof(pkt)); 981 /* FALLTHROUGH */ 982 case USB_ST_SETUP: 983 tr_setup: 984 return; 985 default: 986 if (error != USB_ERR_CANCELLED) { 987 usbd_xfer_set_stall(xfer); 988 goto tr_setup; 989 } 990 return; 991 } 992 } 993 994 /* 995 * Stop the adapter and free any mbufs allocated to the 996 * RX and TX lists. 997 */ 998 static void 999 mos_stop(struct usb_ether *ue) 1000 { 1001 struct mos_softc *sc = uether_getsc(ue); 1002 if_t ifp = uether_getifp(ue); 1003 1004 mos_reset(sc); 1005 1006 MOS_LOCK_ASSERT(sc, MA_OWNED); 1007 if_setdrvflagbits(ifp, 0, IFF_DRV_RUNNING); 1008 1009 /* stop all the transfers, if not already stopped */ 1010 usbd_transfer_stop(sc->sc_xfer[MOS_ENDPT_TX]); 1011 usbd_transfer_stop(sc->sc_xfer[MOS_ENDPT_RX]); 1012 usbd_transfer_stop(sc->sc_xfer[MOS_ENDPT_INTR]); 1013 1014 sc->mos_link = 0; 1015 } 1016