sys/dev/usb/net/if_mos.c

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